diff --git a/.github/workflows/dashboard.yaml b/.github/workflows/dashboard.yaml index e800a893..cdc368dc 100644 --- a/.github/workflows/dashboard.yaml +++ b/.github/workflows/dashboard.yaml @@ -26,18 +26,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get --offline + run: flutter pub get --offline continue-on-error: true - name: Run dashboard tests run: echo "Dashboard tests skipped - external dependencies unavailable in CI" diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 5f4d28c1..ab51f9fc 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -20,6 +20,8 @@ jobs: # This job uses the common publish workflow provided by the ecosystem. # See https://github.com/dart-lang/ecosystem/wiki/Publishing-automation uses: dart-lang/ecosystem/.github/workflows/publish.yaml@main + with: + use-flutter: true permissions: id-token: write pull-requests: write diff --git a/.github/workflows/stem.yaml b/.github/workflows/stem.yaml index 3c2b2d7f..976a65d6 100644 --- a/.github/workflows/stem.yaml +++ b/.github/workflows/stem.yaml @@ -26,18 +26,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev lcov - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem package tests working-directory: packages/stem run: dart test --exclude-tags soak --coverage=coverage diff --git a/.github/workflows/stem_cli.yaml b/.github/workflows/stem_cli.yaml index 3472fd83..f018a09a 100644 --- a/.github/workflows/stem_cli.yaml +++ b/.github/workflows/stem_cli.yaml @@ -30,18 +30,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev lcov - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem_cli tests working-directory: packages/stem_cli run: dart test --coverage=coverage diff --git a/.github/workflows/stem_flutter.yaml b/.github/workflows/stem_flutter.yaml new file mode 100644 index 00000000..6f8b7c91 --- /dev/null +++ b/.github/workflows/stem_flutter.yaml @@ -0,0 +1,42 @@ +name: stem_flutter + +on: + push: + branches: + - master + - main + paths: + - 'packages/stem_flutter/**' + - 'packages/stem/**' + - 'pubspec.yaml' + pull_request: + paths: + - 'packages/stem_flutter/**' + - 'packages/stem/**' + - 'pubspec.yaml' + workflow_dispatch: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: subosito/flutter-action@v2 + with: + channel: stable + cache: true + - name: Get Dart packages cache + uses: actions/cache@v4 + with: + path: ~/.pub-cache + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} + restore-keys: | + ${{ runner.os }}-pub- + - name: Install dependencies + run: flutter pub get + - name: Analyze stem_flutter + working-directory: packages/stem_flutter + run: flutter analyze + - name: Run stem_flutter tests + working-directory: packages/stem_flutter + run: flutter test diff --git a/.github/workflows/stem_flutter_sqlite.yaml b/.github/workflows/stem_flutter_sqlite.yaml new file mode 100644 index 00000000..af3efb3e --- /dev/null +++ b/.github/workflows/stem_flutter_sqlite.yaml @@ -0,0 +1,50 @@ +name: stem_flutter_sqlite + +on: + push: + branches: + - master + - main + paths: + - 'packages/stem_flutter_sqlite/**' + - 'packages/stem_flutter/**' + - 'packages/stem_sqlite/**' + - 'packages/stem/**' + - 'pubspec.yaml' + pull_request: + paths: + - 'packages/stem_flutter_sqlite/**' + - 'packages/stem_flutter/**' + - 'packages/stem_sqlite/**' + - 'packages/stem/**' + - 'pubspec.yaml' + workflow_dispatch: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y sqlite3 libsqlite3-dev + - uses: subosito/flutter-action@v2 + with: + channel: stable + cache: true + - name: Get Dart packages cache + uses: actions/cache@v4 + with: + path: ~/.pub-cache + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} + restore-keys: | + ${{ runner.os }}-pub- + - name: Install dependencies + run: flutter pub get + - name: Analyze stem_flutter_sqlite + working-directory: packages/stem_flutter_sqlite + run: flutter analyze + - name: Run stem_flutter_sqlite tests + working-directory: packages/stem_flutter_sqlite + run: flutter test diff --git a/.github/workflows/stem_memory.yaml b/.github/workflows/stem_memory.yaml index 2ed4f49a..9ddc67e9 100644 --- a/.github/workflows/stem_memory.yaml +++ b/.github/workflows/stem_memory.yaml @@ -23,18 +23,19 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem_memory tests working-directory: packages/stem_memory run: dart test --coverage=coverage --fail-fast diff --git a/.github/workflows/stem_postgres.yaml b/.github/workflows/stem_postgres.yaml index d82f5e79..505d464d 100644 --- a/.github/workflows/stem_postgres.yaml +++ b/.github/workflows/stem_postgres.yaml @@ -28,18 +28,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev lcov - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem_postgres tests working-directory: packages/stem_postgres run: dart test --coverage=coverage diff --git a/.github/workflows/stem_redis.yaml b/.github/workflows/stem_redis.yaml index 88b2e53c..2a79a745 100644 --- a/.github/workflows/stem_redis.yaml +++ b/.github/workflows/stem_redis.yaml @@ -28,18 +28,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev lcov - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem_redis tests working-directory: packages/stem_redis run: dart test --coverage=coverage diff --git a/.github/workflows/stem_sqlite.yaml b/.github/workflows/stem_sqlite.yaml index ac2b6b37..4c20e39c 100644 --- a/.github/workflows/stem_sqlite.yaml +++ b/.github/workflows/stem_sqlite.yaml @@ -28,18 +28,19 @@ jobs: sudo apt-get update sudo apt-get install -y sqlite3 libsqlite3-dev lcov - uses: ./.github/actions/setup-test-services - - uses: dart-lang/setup-dart@v1 + - uses: subosito/flutter-action@v2 with: - sdk: stable + channel: stable + cache: true - name: Get Dart packages cache uses: actions/cache@v4 with: path: ~/.pub-cache - key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.lock') }} + key: ${{ runner.os }}-pub-${{ hashFiles('**/pubspec.yaml') }} restore-keys: | ${{ runner.os }}-pub- - name: Install dependencies - run: dart pub get + run: flutter pub get - name: Run stem_sqlite tests working-directory: packages/stem_sqlite run: dart test --coverage=coverage diff --git a/.gitignore b/.gitignore index c6470752..d7c1f300 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ .packages pubspec.lock build/ +**/.flutter-plugins-dependencies textwrap/ examples/microservice/certs/ examples/security/*/certs/ diff --git a/README.md b/README.md index 96c60a4a..f88097d2 100644 --- a/README.md +++ b/README.md @@ -136,12 +136,14 @@ Future main() async { |---------|-------------|---------| | [`stem`](./packages/stem) | Core runtime: contracts, worker, scheduler, in-memory adapters, signals, Canvas, workflows | [![pub](https://img.shields.io/pub/v/stem.svg)](https://pub.dev/packages/stem) | | [`stem_cli`](./packages/stem_cli) | Command-line tooling (`stem` executable) and CLI utilities | [![pub](https://img.shields.io/pub/v/stem_cli.svg)](https://pub.dev/packages/stem_cli) | +| [`stem_memory`](./packages/stem_memory) | In-memory adapter package (broker/backend/workflow/scheduler factories) | [![pub](https://img.shields.io/pub/v/stem_memory.svg)](https://pub.dev/packages/stem_memory) | +| [`stem_sqlite`](./packages/stem_sqlite) | SQLite broker and result backend for local dev/testing | [![pub](https://img.shields.io/pub/v/stem_sqlite.svg)](https://pub.dev/packages/stem_sqlite) | | [`stem_redis`](./packages/stem_redis) | Redis Streams broker, result backend, and watchdog helpers | [![pub](https://img.shields.io/pub/v/stem_redis.svg)](https://pub.dev/packages/stem_redis) | | [`stem_postgres`](./packages/stem_postgres) | Postgres broker, result backend, and scheduler stores | [![pub](https://img.shields.io/pub/v/stem_postgres.svg)](https://pub.dev/packages/stem_postgres) | -| [`stem_sqlite`](./packages/stem_sqlite) | SQLite broker and result backend for local dev/testing | [![pub](https://img.shields.io/pub/v/stem_sqlite.svg)](https://pub.dev/packages/stem_sqlite) | +| [`stem_flutter`](./packages/stem_flutter) | Adapter-neutral Flutter helpers for mobile worker isolates and queue monitoring | [![pub](https://img.shields.io/pub/v/stem_flutter.svg)](https://pub.dev/packages/stem_flutter) | +| [`stem_flutter_sqlite`](./packages/stem_flutter_sqlite) | Flutter SQLite runtime/storage helpers for mobile Stem apps | [![pub](https://img.shields.io/pub/v/stem_flutter_sqlite.svg)](https://pub.dev/packages/stem_flutter_sqlite) | | [`stem_builder`](./packages/stem_builder) | Build-time code generator for annotated tasks and workflows | [![pub](https://img.shields.io/pub/v/stem_builder.svg)](https://pub.dev/packages/stem_builder) | | [`stem_adapter_tests`](./packages/stem_adapter_tests) | Shared contract test suites for adapter implementations | [![pub](https://img.shields.io/pub/v/stem_adapter_tests.svg)](https://pub.dev/packages/stem_adapter_tests) | -| [`stem_memory`](./packages/stem_memory) | In-memory adapter package (broker/backend/workflow/scheduler factories) | [![pub](https://img.shields.io/pub/v/stem_memory.svg)](https://pub.dev/packages/stem_memory) | | [`stem_dashboard`](./packages/dashboard) | Hotwire-based operations dashboard (experimental) | — | --- diff --git a/packages/stem/CHANGELOG.md b/packages/stem/CHANGELOG.md index 9f8db792..22295b62 100644 --- a/packages/stem/CHANGELOG.md +++ b/packages/stem/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## 0.2.1-wip +## 0.2.1 - Guarded worker and example process signal registration so Windows only installs supported shutdown watchers, avoiding unsupported `SIGTERM` / diff --git a/packages/stem/README.md b/packages/stem/README.md index 3c215742..4be43c05 100644 --- a/packages/stem/README.md +++ b/packages/stem/README.md @@ -14,7 +14,21 @@ Stem is a Dart-first background job and workflow platform: enqueue work, run wor For full docs, API references, and in-depth guides, visit https://kingwill101.github.io/stem. - +## Packages + +| Package | Description | pub.dev | +|---------|-------------|---------| +| [`stem`](https://github.com/kingwill101/stem/tree/master/packages/stem) | Core runtime: contracts, worker, scheduler, in-memory adapters, signals, Canvas, workflows | [![pub](https://img.shields.io/pub/v/stem.svg)](https://pub.dev/packages/stem) | +| [`stem_cli`](https://github.com/kingwill101/stem/tree/master/packages/stem_cli) | Command-line tooling (`stem` executable) and CLI utilities | [![pub](https://img.shields.io/pub/v/stem_cli.svg)](https://pub.dev/packages/stem_cli) | +| [`stem_memory`](https://github.com/kingwill101/stem/tree/master/packages/stem_memory) | In-memory adapter package (broker/backend/workflow/scheduler factories) | [![pub](https://img.shields.io/pub/v/stem_memory.svg)](https://pub.dev/packages/stem_memory) | +| [`stem_sqlite`](https://github.com/kingwill101/stem/tree/master/packages/stem_sqlite) | SQLite broker and result backend for local dev/testing | [![pub](https://img.shields.io/pub/v/stem_sqlite.svg)](https://pub.dev/packages/stem_sqlite) | +| [`stem_redis`](https://github.com/kingwill101/stem/tree/master/packages/stem_redis) | Redis Streams broker, result backend, and watchdog helpers | [![pub](https://img.shields.io/pub/v/stem_redis.svg)](https://pub.dev/packages/stem_redis) | +| [`stem_postgres`](https://github.com/kingwill101/stem/tree/master/packages/stem_postgres) | Postgres broker, result backend, and scheduler stores | [![pub](https://img.shields.io/pub/v/stem_postgres.svg)](https://pub.dev/packages/stem_postgres) | +| [`stem_flutter`](https://github.com/kingwill101/stem/tree/master/packages/stem_flutter) | Adapter-neutral Flutter helpers for mobile worker isolates and queue monitoring | [![pub](https://img.shields.io/pub/v/stem_flutter.svg)](https://pub.dev/packages/stem_flutter) | +| [`stem_flutter_sqlite`](https://github.com/kingwill101/stem/tree/master/packages/stem_flutter_sqlite) | Flutter SQLite runtime/storage helpers for mobile Stem apps | [![pub](https://img.shields.io/pub/v/stem_flutter_sqlite.svg)](https://pub.dev/packages/stem_flutter_sqlite) | +| [`stem_builder`](https://github.com/kingwill101/stem/tree/master/packages/stem_builder) | Build-time code generator for annotated tasks and workflows | [![pub](https://img.shields.io/pub/v/stem_builder.svg)](https://pub.dev/packages/stem_builder) | +| [`stem_adapter_tests`](https://github.com/kingwill101/stem/tree/master/packages/stem_adapter_tests) | Shared contract test suites for adapter implementations | [![pub](https://img.shields.io/pub/v/stem_adapter_tests.svg)](https://pub.dev/packages/stem_adapter_tests) | +| [`stem_dashboard`](https://github.com/kingwill101/stem/tree/master/packages/dashboard) | Hotwire-based operations dashboard (experimental) | — | ## Features diff --git a/packages/stem/example/email_service/lib/stem_email_service_example.dart b/packages/stem/example/email_service/lib/stem_email_service_example.dart new file mode 100644 index 00000000..6d9c7dc5 --- /dev/null +++ b/packages/stem/example/email_service/lib/stem_email_service_example.dart @@ -0,0 +1,11 @@ +/// Email notification service example built on top of Stem. +/// +/// This package is an application-style example rather than a reusable +/// library. Use `dart run bin/enqueuer.dart` to start the HTTP enqueue API and +/// `dart run bin/worker.dart` to start the worker that delivers messages via +/// SMTP. +/// +/// The surrounding package assets, including `routing.yaml`, +/// `docker-compose.yml`, and `.env.example`, demonstrate how to connect the +/// example to Redis and MailHog for local development. +library; diff --git a/packages/stem/example/encrypted_payload/enqueuer/lib/stem_encrypted_enqueuer.dart b/packages/stem/example/encrypted_payload/enqueuer/lib/stem_encrypted_enqueuer.dart new file mode 100644 index 00000000..5a788dcc --- /dev/null +++ b/packages/stem/example/encrypted_payload/enqueuer/lib/stem_encrypted_enqueuer.dart @@ -0,0 +1,6 @@ +/// Enqueues encrypted payloads before handing them to Stem. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to publish encrypted tasks into the example +/// workflow. +library; diff --git a/packages/stem/example/encrypted_payload/worker/lib/stem_encrypted_worker.dart b/packages/stem/example/encrypted_payload/worker/lib/stem_encrypted_worker.dart new file mode 100644 index 00000000..6bbbd9e8 --- /dev/null +++ b/packages/stem/example/encrypted_payload/worker/lib/stem_encrypted_worker.dart @@ -0,0 +1,6 @@ +/// Worker that decrypts payloads after pulling from the broker. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to process encrypted tasks inside the example +/// workflow. +library; diff --git a/packages/stem/example/flutter_stem_example/.gitignore b/packages/stem/example/flutter_stem_example/.gitignore new file mode 100644 index 00000000..ebcb3d9b --- /dev/null +++ b/packages/stem/example/flutter_stem_example/.gitignore @@ -0,0 +1,46 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.build/ +.buildlog/ +.history +.svn/ +.swiftpm/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ +/coverage/ +flutter_*.png + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/packages/stem/example/flutter_stem_example/.metadata b/packages/stem/example/flutter_stem_example/.metadata new file mode 100644 index 00000000..51c0bb52 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/.metadata @@ -0,0 +1,45 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "db50e20168db8fee486b9abf32fc912de3bc5b6a" + channel: "stable" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: android + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: ios + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: linux + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: macos + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: web + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + - platform: windows + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/packages/stem/example/flutter_stem_example/README.md b/packages/stem/example/flutter_stem_example/README.md new file mode 100644 index 00000000..351cf15c --- /dev/null +++ b/packages/stem/example/flutter_stem_example/README.md @@ -0,0 +1,90 @@ +# Flutter Stem Example + +This example shows a mobile-oriented way to use `stem` with the generic +`stem_flutter` package plus the SQLite adapter package `stem_flutter_sqlite`. + +## What It Demonstrates + +- the Flutter UI acts only as a producer and publishes jobs into a SQLite + broker +- the worker runs in a separate Dart isolate instead of sharing the UI isolate +- task status is monitored by polling the SQLite result backend +- the broker and result backend use separate SQLite files to reduce write + contention on mobile devices +- the generic Flutter layer is separated from the SQLite adapter layer + +## Why This Layout Is Better For Mobile + +SQLite is a good fit for a single-device demo, but mobile apps are sensitive to +main-isolate stalls and abrupt restarts. + +This example applies the main recommendations for a smoother mobile demo: + +- keep the producer off the result backend +- keep the worker off the UI isolate +- avoid using one SQLite file for both broker and backend +- use `getApplicationSupportDirectory()` so the databases live in an app-owned + location +- use shorter broker sweep and visibility intervals so hot restart recovery is + easier to observe during development + +## Runtime Model + +1. The UI isolate uses `stem_flutter_sqlite` to open the broker database and + create a `Stem` producer. +2. The UI uses `stem_flutter_sqlite` to build the SQLite bootstrap payload and + `stem_flutter` to supervise the worker isolate. +3. The worker isolate opens its own broker handle and its own result backend. +4. Pressing `Push Job` enqueues work into the broker. +5. The UI polls the backend with `listTaskStatuses()` and polls the broker for + pending and inflight counts. + +Jobs may briefly appear as `local pending` in the UI before the worker has +written their first status row to the backend. That state means the job was +published successfully, but the backend does not yet have a tracked status +record for it. + +## Why Jobs Can Look "Stuck" + +This example intentionally separates observation from execution: + +- the UI polls queue and status state +- the worker isolate actually consumes and executes jobs + +So if a job appears queued for longer than expected, the first questions are: + +- is the worker isolate running? +- is the task currently inflight but still within the visibility timeout? +- did SQLite hit temporary lock contention? + +Polling does not wake the worker up. It only reports what the broker and +backend currently say. + +## Run + +```bash +cd packages/stem/example/flutter_stem_example +flutter pub get +flutter run -d android +``` + +Other Dart VM Flutter targets such as Linux, macOS, and iOS also work with the +same structure. + +## Troubleshooting + +- `SqliteResultBackend.watch(taskId)` is process-local. For cross-isolate or + cross-process monitoring, poll `getTaskStatus()` or `listTaskStatuses()` + instead. +- If the app is hot-restarted while a task is inflight, the broker may need one + visibility-timeout cycle before the task is claimable again. This example + keeps that timeout short to make development behavior easier to understand. +- The example enables Stem logs during startup. If the worker says `stopped` or + never reports `ready`, the logs are the fastest way to see whether isolate + bootstrap failed. +- Separate broker and backend files reduce SQLite contention, but they do not + remove it completely. Short-lived `database is locked` errors still indicate + concurrent file pressure, not a broken polling loop. +- If you adapt this example for production, treat the UI isolate as a producer + and status surface. Keep actual task execution in a worker isolate or another + process. diff --git a/packages/stem/example/flutter_stem_example/analysis_options.yaml b/packages/stem/example/flutter_stem_example/analysis_options.yaml new file mode 100644 index 00000000..0d290213 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/analysis_options.yaml @@ -0,0 +1,28 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at https://dart.dev/lints. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/packages/stem/example/flutter_stem_example/android/.gitignore b/packages/stem/example/flutter_stem_example/android/.gitignore new file mode 100644 index 00000000..be3943c9 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/.gitignore @@ -0,0 +1,14 @@ +gradle-wrapper.jar +/.gradle +/captures/ +/gradlew +/gradlew.bat +/local.properties +GeneratedPluginRegistrant.java +.cxx/ + +# Remember to never publicly share your keystore. +# See https://flutter.dev/to/reference-keystore +key.properties +**/*.keystore +**/*.jks diff --git a/packages/stem/example/flutter_stem_example/android/app/build.gradle.kts b/packages/stem/example/flutter_stem_example/android/app/build.gradle.kts new file mode 100644 index 00000000..31e54a7e --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/build.gradle.kts @@ -0,0 +1,44 @@ +plugins { + id("com.android.application") + id("kotlin-android") + // The Flutter Gradle Plugin must be applied after the Android and Kotlin Gradle plugins. + id("dev.flutter.flutter-gradle-plugin") +} + +android { + namespace = "com.example.flutter_stem_example" + compileSdk = flutter.compileSdkVersion + ndkVersion = flutter.ndkVersion + + compileOptions { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 + } + + kotlinOptions { + jvmTarget = JavaVersion.VERSION_17.toString() + } + + defaultConfig { + // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). + applicationId = "com.example.flutter_stem_example" + // You can update the following values to match your application needs. + // For more information, see: https://flutter.dev/to/review-gradle-config. + minSdk = flutter.minSdkVersion + targetSdk = flutter.targetSdkVersion + versionCode = flutter.versionCode + versionName = flutter.versionName + } + + buildTypes { + release { + // TODO: Add your own signing config for the release build. + // Signing with the debug keys for now, so `flutter run --release` works. + signingConfig = signingConfigs.getByName("debug") + } + } +} + +flutter { + source = "../.." +} diff --git a/packages/stem/example/flutter_stem_example/android/app/src/debug/AndroidManifest.xml b/packages/stem/example/flutter_stem_example/android/app/src/debug/AndroidManifest.xml new file mode 100644 index 00000000..399f6981 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/debug/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/AndroidManifest.xml b/packages/stem/example/flutter_stem_example/android/app/src/main/AndroidManifest.xml new file mode 100644 index 00000000..05ef6cf1 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/kotlin/com/example/flutter_stem_example/MainActivity.kt b/packages/stem/example/flutter_stem_example/android/app/src/main/kotlin/com/example/flutter_stem_example/MainActivity.kt new file mode 100644 index 00000000..23e381c2 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/kotlin/com/example/flutter_stem_example/MainActivity.kt @@ -0,0 +1,5 @@ +package com.example.flutter_stem_example + +import io.flutter.embedding.android.FlutterActivity + +class MainActivity : FlutterActivity() diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable-v21/launch_background.xml b/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable-v21/launch_background.xml new file mode 100644 index 00000000..f74085f3 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable-v21/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable/launch_background.xml b/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable/launch_background.xml new file mode 100644 index 00000000..304732f8 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/res/drawable/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 00000000..db77bb4b Binary files /dev/null and b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 00000000..17987b79 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 00000000..09d43914 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 00000000..d5f1c8d3 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 00000000..4d6372ee Binary files /dev/null and b/packages/stem/example/flutter_stem_example/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/values-night/styles.xml b/packages/stem/example/flutter_stem_example/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 00000000..06952be7 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/main/res/values/styles.xml b/packages/stem/example/flutter_stem_example/android/app/src/main/res/values/styles.xml new file mode 100644 index 00000000..cb1ef880 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/main/res/values/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/android/app/src/profile/AndroidManifest.xml b/packages/stem/example/flutter_stem_example/android/app/src/profile/AndroidManifest.xml new file mode 100644 index 00000000..399f6981 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/app/src/profile/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/packages/stem/example/flutter_stem_example/android/build.gradle.kts b/packages/stem/example/flutter_stem_example/android/build.gradle.kts new file mode 100644 index 00000000..dbee657b --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/build.gradle.kts @@ -0,0 +1,24 @@ +allprojects { + repositories { + google() + mavenCentral() + } +} + +val newBuildDir: Directory = + rootProject.layout.buildDirectory + .dir("../../build") + .get() +rootProject.layout.buildDirectory.value(newBuildDir) + +subprojects { + val newSubprojectBuildDir: Directory = newBuildDir.dir(project.name) + project.layout.buildDirectory.value(newSubprojectBuildDir) +} +subprojects { + project.evaluationDependsOn(":app") +} + +tasks.register("clean") { + delete(rootProject.layout.buildDirectory) +} diff --git a/packages/stem/example/flutter_stem_example/android/gradle.properties b/packages/stem/example/flutter_stem_example/android/gradle.properties new file mode 100644 index 00000000..9d9048ef --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/gradle.properties @@ -0,0 +1,2 @@ +org.gradle.jvmargs=-Xmx4G -XX:MaxMetaspaceSize=2G -XX:ReservedCodeCacheSize=512m -XX:+HeapDumpOnOutOfMemoryError +android.useAndroidX=true diff --git a/packages/stem/example/flutter_stem_example/android/gradle/wrapper/gradle-wrapper.properties b/packages/stem/example/flutter_stem_example/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..e4ef43fb --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-all.zip diff --git a/packages/stem/example/flutter_stem_example/android/settings.gradle.kts b/packages/stem/example/flutter_stem_example/android/settings.gradle.kts new file mode 100644 index 00000000..ca7fe065 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/android/settings.gradle.kts @@ -0,0 +1,26 @@ +pluginManagement { + val flutterSdkPath = + run { + val properties = java.util.Properties() + file("local.properties").inputStream().use { properties.load(it) } + val flutterSdkPath = properties.getProperty("flutter.sdk") + require(flutterSdkPath != null) { "flutter.sdk not set in local.properties" } + flutterSdkPath + } + + includeBuild("$flutterSdkPath/packages/flutter_tools/gradle") + + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +plugins { + id("dev.flutter.flutter-plugin-loader") version "1.0.0" + id("com.android.application") version "8.11.1" apply false + id("org.jetbrains.kotlin.android") version "2.2.20" apply false +} + +include(":app") diff --git a/packages/stem/example/flutter_stem_example/ios/.gitignore b/packages/stem/example/flutter_stem_example/ios/.gitignore new file mode 100644 index 00000000..7a7f9873 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/.gitignore @@ -0,0 +1,34 @@ +**/dgph +*.mode1v3 +*.mode2v3 +*.moved-aside +*.pbxuser +*.perspectivev3 +**/*sync/ +.sconsign.dblite +.tags* +**/.vagrant/ +**/DerivedData/ +Icon? +**/Pods/ +**/.symlinks/ +profile +xcuserdata +**/.generated/ +Flutter/App.framework +Flutter/Flutter.framework +Flutter/Flutter.podspec +Flutter/Generated.xcconfig +Flutter/ephemeral/ +Flutter/app.flx +Flutter/app.zip +Flutter/flutter_assets/ +Flutter/flutter_export_environment.sh +ServiceDefinitions.json +Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!default.mode1v3 +!default.mode2v3 +!default.pbxuser +!default.perspectivev3 diff --git a/packages/stem/example/flutter_stem_example/ios/Flutter/AppFrameworkInfo.plist b/packages/stem/example/flutter_stem_example/ios/Flutter/AppFrameworkInfo.plist new file mode 100644 index 00000000..391a902b --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Flutter/AppFrameworkInfo.plist @@ -0,0 +1,24 @@ + + + + + CFBundleDevelopmentRegion + en + CFBundleExecutable + App + CFBundleIdentifier + io.flutter.flutter.app + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + App + CFBundlePackageType + FMWK + CFBundleShortVersionString + 1.0 + CFBundleSignature + ???? + CFBundleVersion + 1.0 + + diff --git a/packages/stem/example/flutter_stem_example/ios/Flutter/Debug.xcconfig b/packages/stem/example/flutter_stem_example/ios/Flutter/Debug.xcconfig new file mode 100644 index 00000000..592ceee8 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Flutter/Debug.xcconfig @@ -0,0 +1 @@ +#include "Generated.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/ios/Flutter/Release.xcconfig b/packages/stem/example/flutter_stem_example/ios/Flutter/Release.xcconfig new file mode 100644 index 00000000..592ceee8 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Flutter/Release.xcconfig @@ -0,0 +1 @@ +#include "Generated.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.pbxproj b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.pbxproj new file mode 100644 index 00000000..b43e6f27 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,620 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXBuildFile section */ + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C807B294A618700263BE5 /* RunnerTests.swift */; }; + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; }; + 7884E8682EC3CC0700C636F2 /* SceneDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */; }; + 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; + 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; }; + 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C8085294A63A400263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 97C146E61CF9000F007C117D /* Project object */; + proxyType = 1; + remoteGlobalIDString = 97C146ED1CF9000F007C117D; + remoteInfo = Runner; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 9705A1C41CF9048500538489 /* Embed Frameworks */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Embed Frameworks"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; + 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; + 331C807B294A618700263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 331C8081294A63A400263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; + 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = ""; }; + 74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = ""; }; + 9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = ""; }; + 97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; }; + 97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; + 97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; + 97C147001CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = ""; }; + 97C147021CF9000F007C117D /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 97C146EB1CF9000F007C117D /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C8082294A63A400263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C807B294A618700263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 9740EEB11CF90186004384FC /* Flutter */ = { + isa = PBXGroup; + children = ( + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 9740EEB31CF90195004384FC /* Generated.xcconfig */, + ); + name = Flutter; + sourceTree = ""; + }; + 97C146E51CF9000F007C117D = { + isa = PBXGroup; + children = ( + 9740EEB11CF90186004384FC /* Flutter */, + 97C146F01CF9000F007C117D /* Runner */, + 97C146EF1CF9000F007C117D /* Products */, + 331C8082294A63A400263BE5 /* RunnerTests */, + ); + sourceTree = ""; + }; + 97C146EF1CF9000F007C117D /* Products */ = { + isa = PBXGroup; + children = ( + 97C146EE1CF9000F007C117D /* Runner.app */, + 331C8081294A63A400263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 97C146F01CF9000F007C117D /* Runner */ = { + isa = PBXGroup; + children = ( + 97C146FA1CF9000F007C117D /* Main.storyboard */, + 97C146FD1CF9000F007C117D /* Assets.xcassets */, + 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */, + 97C147021CF9000F007C117D /* Info.plist */, + 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */, + 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */, + 74858FAE1ED2DC5600515810 /* AppDelegate.swift */, + 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */, + 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */, + ); + path = Runner; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C8080294A63A400263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C807D294A63A400263BE5 /* Sources */, + 331C807F294A63A400263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C8086294A63A400263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C8081294A63A400263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 97C146ED1CF9000F007C117D /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 9740EEB61CF901F6004384FC /* Run Script */, + 97C146EA1CF9000F007C117D /* Sources */, + 97C146EB1CF9000F007C117D /* Frameworks */, + 97C146EC1CF9000F007C117D /* Resources */, + 9705A1C41CF9048500538489 /* Embed Frameworks */, + 3B06AD1E1E4923F5004D2608 /* Thin Binary */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = Runner; + productName = Runner; + productReference = 97C146EE1CF9000F007C117D /* Runner.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 97C146E61CF9000F007C117D /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C8080294A63A400263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 97C146ED1CF9000F007C117D; + }; + 97C146ED1CF9000F007C117D = { + CreatedOnToolsVersion = 7.3.1; + LastSwiftMigration = 1100; + }; + }; + }; + buildConfigurationList = 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 97C146E51CF9000F007C117D; + productRefGroup = 97C146EF1CF9000F007C117D /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 97C146ED1CF9000F007C117D /* Runner */, + 331C8080294A63A400263BE5 /* RunnerTests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C807F294A63A400263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 97C146EC1CF9000F007C117D /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */, + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */, + 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */, + 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3B06AD1E1E4923F5004D2608 /* Thin Binary */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}", + ); + name = "Thin Binary"; + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin"; + }; + 9740EEB61CF901F6004384FC /* Run Script */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + ); + name = "Run Script"; + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" build"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C807D294A63A400263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 97C146EA1CF9000F007C117D /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */, + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */, + 7884E8682EC3CC0700C636F2 /* SceneDelegate.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C8086294A63A400263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 97C146ED1CF9000F007C117D /* Runner */; + targetProxy = 331C8085294A63A400263BE5 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 97C146FA1CF9000F007C117D /* Main.storyboard */ = { + isa = PBXVariantGroup; + children = ( + 97C146FB1CF9000F007C117D /* Base */, + ); + name = Main.storyboard; + sourceTree = ""; + }; + 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */ = { + isa = PBXVariantGroup; + children = ( + 97C147001CF9000F007C117D /* Base */, + ); + name = LaunchScreen.storyboard; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 249021D3217E4FDB00AE95B9 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; + TARGETED_DEVICE_FAMILY = "1,2"; + VALIDATE_PRODUCT = YES; + }; + name = Profile; + }; + 249021D4217E4FDB00AE95B9 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Profile; + }; + 331C8088294A63A400263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Debug; + }; + 331C8089294A63A400263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Release; + }; + 331C808A294A63A400263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Profile; + }; + 97C147031CF9000F007C117D /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = iphoneos; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 97C147041CF9000F007C117D /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + TARGETED_DEVICE_FAMILY = "1,2"; + VALIDATE_PRODUCT = YES; + }; + name = Release; + }; + 97C147061CF9000F007C117D /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Debug; + }; + 97C147071CF9000F007C117D /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C8088294A63A400263BE5 /* Debug */, + 331C8089294A63A400263BE5 /* Release */, + 331C808A294A63A400263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 97C147031CF9000F007C117D /* Debug */, + 97C147041CF9000F007C117D /* Release */, + 249021D3217E4FDB00AE95B9 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 97C147061CF9000F007C117D /* Debug */, + 97C147071CF9000F007C117D /* Release */, + 249021D4217E4FDB00AE95B9 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 97C146E61CF9000F007C117D /* Project object */; +} diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 00000000..919434a6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 00000000..18d98100 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 00000000..f9b0d7c5 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 00000000..e3773d42 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,101 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/contents.xcworkspacedata b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 00000000..1d526a16 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 00000000..18d98100 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 00000000..f9b0d7c5 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/AppDelegate.swift b/packages/stem/example/flutter_stem_example/ios/Runner/AppDelegate.swift new file mode 100644 index 00000000..c30b367e --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/AppDelegate.swift @@ -0,0 +1,16 @@ +import Flutter +import UIKit + +@main +@objc class AppDelegate: FlutterAppDelegate, FlutterImplicitEngineDelegate { + override func application( + _ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? + ) -> Bool { + return super.application(application, didFinishLaunchingWithOptions: launchOptions) + } + + func didInitializeImplicitFlutterEngine(_ engineBridge: FlutterImplicitEngineBridge) { + GeneratedPluginRegistrant.register(with: engineBridge.pluginRegistry) + } +} diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 00000000..d36b1fab --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,122 @@ +{ + "images" : [ + { + "size" : "20x20", + "idiom" : "iphone", + "filename" : "Icon-App-20x20@2x.png", + "scale" : "2x" + }, + { + "size" : "20x20", + "idiom" : "iphone", + "filename" : "Icon-App-20x20@3x.png", + "scale" : "3x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@1x.png", + "scale" : "1x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@2x.png", + "scale" : "2x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@3x.png", + "scale" : "3x" + }, + { + "size" : "40x40", + "idiom" : "iphone", + "filename" : "Icon-App-40x40@2x.png", + "scale" : "2x" + }, + { + "size" : "40x40", + "idiom" : "iphone", + "filename" : "Icon-App-40x40@3x.png", + "scale" : "3x" + }, + { + "size" : "60x60", + "idiom" : "iphone", + "filename" : "Icon-App-60x60@2x.png", + "scale" : "2x" + }, + { + "size" : "60x60", + "idiom" : "iphone", + "filename" : "Icon-App-60x60@3x.png", + "scale" : "3x" + }, + { + "size" : "20x20", + "idiom" : "ipad", + "filename" : "Icon-App-20x20@1x.png", + "scale" : "1x" + }, + { + "size" : "20x20", + "idiom" : "ipad", + "filename" : "Icon-App-20x20@2x.png", + "scale" : "2x" + }, + { + "size" : "29x29", + "idiom" : "ipad", + "filename" : "Icon-App-29x29@1x.png", + "scale" : "1x" + }, + { + "size" : "29x29", + "idiom" : "ipad", + "filename" : "Icon-App-29x29@2x.png", + "scale" : "2x" + }, + { + "size" : "40x40", + "idiom" : "ipad", + "filename" : "Icon-App-40x40@1x.png", + "scale" : "1x" + }, + { + "size" : "40x40", + "idiom" : "ipad", + "filename" : "Icon-App-40x40@2x.png", + "scale" : "2x" + }, + { + "size" : "76x76", + "idiom" : "ipad", + "filename" : "Icon-App-76x76@1x.png", + "scale" : "1x" + }, + { + "size" : "76x76", + "idiom" : "ipad", + "filename" : "Icon-App-76x76@2x.png", + "scale" : "2x" + }, + { + "size" : "83.5x83.5", + "idiom" : "ipad", + "filename" : "Icon-App-83.5x83.5@2x.png", + "scale" : "2x" + }, + { + "size" : "1024x1024", + "idiom" : "ios-marketing", + "filename" : "Icon-App-1024x1024@1x.png", + "scale" : "1x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png new file mode 100644 index 00000000..dc9ada47 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png new file mode 100644 index 00000000..7353c41e Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png new file mode 100644 index 00000000..797d452e Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png new file mode 100644 index 00000000..6ed2d933 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png new file mode 100644 index 00000000..4cd7b009 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png new file mode 100644 index 00000000..fe730945 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png new file mode 100644 index 00000000..321773cd Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png new file mode 100644 index 00000000..797d452e Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png new file mode 100644 index 00000000..502f463a Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png new file mode 100644 index 00000000..0ec30343 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png new file mode 100644 index 00000000..0ec30343 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png new file mode 100644 index 00000000..e9f5fea2 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png new file mode 100644 index 00000000..84ac32ae Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png new file mode 100644 index 00000000..8953cba0 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png new file mode 100644 index 00000000..0467bf12 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json new file mode 100644 index 00000000..0bedcf2f --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json @@ -0,0 +1,23 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "LaunchImage.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "filename" : "LaunchImage@2x.png", + "scale" : "2x" + }, + { + "idiom" : "universal", + "filename" : "LaunchImage@3x.png", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png new file mode 100644 index 00000000..9da19eac Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png new file mode 100644 index 00000000..9da19eac Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png new file mode 100644 index 00000000..9da19eac Binary files /dev/null and b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png differ diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md new file mode 100644 index 00000000..b5b843ad --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md @@ -0,0 +1,5 @@ +# Launch Screen Assets + +You can customize the launch screen with your own desired assets by replacing the image files in this directory. + +You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images. diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/LaunchScreen.storyboard b/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/LaunchScreen.storyboard new file mode 100644 index 00000000..f2e259c7 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/LaunchScreen.storyboard @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/Main.storyboard b/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/Main.storyboard new file mode 100644 index 00000000..f3c28516 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Base.lproj/Main.storyboard @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Info.plist b/packages/stem/example/flutter_stem_example/ios/Runner/Info.plist new file mode 100644 index 00000000..c7520ff6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Info.plist @@ -0,0 +1,70 @@ + + + + + CADisableMinimumFrameDurationOnPhone + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleDisplayName + Flutter Stem Example + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + flutter_stem_example + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleSignature + ???? + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSRequiresIPhoneOS + + UIApplicationSceneManifest + + UIApplicationSupportsMultipleScenes + + UISceneConfigurations + + UIWindowSceneSessionRoleApplication + + + UISceneClassName + UIWindowScene + UISceneConfigurationName + flutter + UISceneDelegateClassName + $(PRODUCT_MODULE_NAME).SceneDelegate + UISceneStoryboardFile + Main + + + + + UIApplicationSupportsIndirectInputEvents + + UILaunchStoryboardName + LaunchScreen + UIMainStoryboardFile + Main + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + + diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/Runner-Bridging-Header.h b/packages/stem/example/flutter_stem_example/ios/Runner/Runner-Bridging-Header.h new file mode 100644 index 00000000..308a2a56 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/Runner-Bridging-Header.h @@ -0,0 +1 @@ +#import "GeneratedPluginRegistrant.h" diff --git a/packages/stem/example/flutter_stem_example/ios/Runner/SceneDelegate.swift b/packages/stem/example/flutter_stem_example/ios/Runner/SceneDelegate.swift new file mode 100644 index 00000000..b9ce8ea2 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/Runner/SceneDelegate.swift @@ -0,0 +1,6 @@ +import Flutter +import UIKit + +class SceneDelegate: FlutterSceneDelegate { + +} diff --git a/packages/stem/example/flutter_stem_example/ios/RunnerTests/RunnerTests.swift b/packages/stem/example/flutter_stem_example/ios/RunnerTests/RunnerTests.swift new file mode 100644 index 00000000..86a7c3b1 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/ios/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Flutter +import UIKit +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/packages/stem/example/flutter_stem_example/lib/main.dart b/packages/stem/example/flutter_stem_example/lib/main.dart new file mode 100644 index 00000000..c89399d3 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/lib/main.dart @@ -0,0 +1,743 @@ +import 'dart:async'; +import 'dart:isolate'; + +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +const String _queueName = 'mobile-demo'; +const String _taskName = 'demo.sleep_echo'; +const String _workerId = 'mobile-worker'; +const Duration _workerHeartbeatInterval = Duration(seconds: 2); +const Duration _monitorPollInterval = Duration(seconds: 1); +const Duration _brokerPollInterval = Duration(milliseconds: 250); +const Duration _brokerSweepInterval = Duration(seconds: 2); +const Duration _brokerVisibilityTimeout = Duration(seconds: 6); +const Duration _producerMaintenanceInterval = Duration.zero; +const Duration _monitorCleanupInterval = Duration(days: 3650); + +Future _sleepEchoTask( + TaskInvocationContext context, + Map args, +) async { + final label = args['label'] as String? ?? 'job'; + final delayMs = args['delayMs'] as int? ?? 1500; + + await Future.delayed(Duration(milliseconds: delayMs)); + + return 'Completed $label at ${DateTime.now().toIso8601String()}'; +} + +List> _taskHandlers() { + return >[ + FunctionTaskHandler.inline( + name: _taskName, + entrypoint: _sleepEchoTask, + options: const TaskOptions(queue: _queueName), + metadata: const TaskMetadata( + description: 'SQLite-backed mobile demo task.', + tags: ['flutter', 'sqlite', 'mobile'], + ), + ), + ]; +} + +Future main() async { + WidgetsFlutterBinding.ensureInitialized(); + configureStemLogging( + level: Level.debug, + format: StemLogFormat.plain, + enableConsole: true, + ); + stemLogger.info('Flutter example booting'); + runApp(const StemFlutterExampleApp()); +} + +class StemFlutterExampleApp extends StatelessWidget { + const StemFlutterExampleApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'Stem Flutter Example', + theme: ThemeData( + colorScheme: ColorScheme.fromSeed( + seedColor: const Color(0xFF0F766E), + brightness: Brightness.light, + ), + ), + home: const QueueMonitorPage(), + ); + } +} + +class QueueMonitorPage extends StatefulWidget { + const QueueMonitorPage({super.key}); + + @override + State createState() => _QueueMonitorPageState(); +} + +class _QueueMonitorPageState extends State { + StemFlutterSqliteRuntime? _runtime; + StemFlutterWorkerHost? _workerHost; + StemFlutterQueueMonitor? _monitor; + StreamSubscription? _monitorSub; + + bool _isBooting = true; + String? _bootError; + int _jobCounter = 0; + StemFlutterQueueSnapshot _snapshot = const StemFlutterQueueSnapshot(); + + @override + void initState() { + super.initState(); + unawaited(_bootstrap()); + } + + @override + void dispose() { + unawaited(_shutdownResources()); + super.dispose(); + } + + Future _bootstrap() async { + try { + stemLogger.info('Resolving mobile storage layout'); + final layout = await StemFlutterStorageLayout.applicationSupport( + directoryName: 'stem_flutter_example', + ); + stemLogger.info( + 'Opening producer/runtime stores', + stemLogContext( + component: 'flutter_example', + subsystem: 'bootstrap', + fields: { + 'brokerPath': layout.brokerFile.path, + 'backendPath': layout.backendFile.path, + }, + ), + ); + + final runtime = await StemFlutterSqliteRuntime.open( + layout: layout, + tasks: _taskHandlers(), + brokerVisibilityTimeout: _brokerVisibilityTimeout, + brokerPollInterval: _brokerPollInterval, + producerSweeperInterval: _producerMaintenanceInterval, + backendCleanupInterval: _monitorCleanupInterval, + ); + stemLogger.info('Producer runtime ready'); + + final rootToken = RootIsolateToken.instance; + if (rootToken == null) { + throw StateError('RootIsolateToken.instance was null.'); + } + + final workerHost = await StemFlutterSqliteWorkerLauncher.spawn( + entrypoint: _workerIsolateMain, + layout: layout, + rootIsolateToken: rootToken, + brokerPollInterval: _brokerPollInterval, + brokerSweeperInterval: _brokerSweepInterval, + brokerVisibilityTimeout: _brokerVisibilityTimeout, + ); + stemLogger.info('Worker isolate spawned'); + + final monitor = StemFlutterQueueMonitor( + backend: runtime.backend, + broker: runtime.broker, + queueName: _queueName, + workerId: _workerId, + pollInterval: _monitorPollInterval, + heartbeatInterval: _workerHeartbeatInterval, + ); + await monitor.bindWorkerSignals(workerHost.signals); + + final monitorSub = monitor.snapshots.listen((snapshot) { + if (!mounted) return; + setState(() { + _snapshot = snapshot; + }); + }); + + if (!mounted) { + await monitorSub.cancel(); + await monitor.dispose(); + await workerHost.dispose(); + await runtime.close(); + return; + } + + await monitor.start(); + + if (!mounted) { + await monitorSub.cancel(); + await monitor.dispose(); + await workerHost.dispose(); + await runtime.close(); + return; + } + + setState(() { + _runtime = runtime; + _workerHost = workerHost; + _monitor = monitor; + _monitorSub = monitorSub; + _isBooting = false; + }); + } catch (error, stackTrace) { + stemLogger.error('Flutter example bootstrap failed: $error', stackTrace); + if (!mounted) return; + setState(() { + _bootError = '$error\n$stackTrace'; + _isBooting = false; + }); + } + } + + Future _shutdownResources() async { + await _monitorSub?.cancel(); + await _monitor?.dispose(); + await _workerHost?.dispose(); + await _runtime?.close(); + + _workerHost = null; + _monitor = null; + _runtime = null; + _monitorSub = null; + } + + Future _enqueueJob() async { + final producer = _runtime?.stem; + if (producer == null) return; + + final nextJobNumber = _jobCounter + 1; + final label = 'Job $nextJobNumber'; + + setState(() { + _jobCounter = nextJobNumber; + }); + + final taskId = await producer.enqueue( + _taskName, + args: { + 'label': label, + 'delayMs': 1200 + (nextJobNumber % 3) * 600, + }, + meta: {'label': label}, + options: const TaskOptions(queue: _queueName), + ); + stemLogger.info( + 'Queued demo task', + stemLogContext( + component: 'flutter_example', + subsystem: 'producer', + fields: {'taskId': taskId, 'label': label}, + ), + ); + + await _monitor?.refresh(); + } + + @override + Widget build(BuildContext context) { + final textTheme = Theme.of(context).textTheme; + final workerDetail = _snapshot.workerDetailPreview; + + return Scaffold( + appBar: AppBar(title: const Text('Stem Queue Monitor')), + body: SafeArea( + child: Padding( + padding: const EdgeInsets.fromLTRB(12, 12, 12, 0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Container( + width: double.infinity, + padding: const EdgeInsets.all(14), + decoration: BoxDecoration( + color: const Color(0xFFECFDF5), + borderRadius: BorderRadius.circular(18), + border: Border.all(color: const Color(0xFF99F6E4)), + ), + child: Column( + children: [ + Row( + children: [ + Expanded( + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Text( + 'Worker', + style: textTheme.titleMedium?.copyWith( + fontWeight: FontWeight.w700, + ), + ), + const SizedBox(height: 4), + Text( + workerDetail == null || workerDetail.isEmpty + ? 'Waiting for worker updates' + : workerDetail, + maxLines: 2, + overflow: TextOverflow.ellipsis, + style: textTheme.bodySmall?.copyWith( + color: const Color(0xFF475569), + ), + ), + ], + ), + ), + const SizedBox(width: 12), + _WorkerStateChip(state: _snapshot.workerStatus), + ], + ), + const SizedBox(height: 12), + Wrap( + spacing: 8, + runSpacing: 8, + children: [ + _MetricTile( + label: 'pending', + value: '${_snapshot.pendingCount ?? 0}', + ), + _MetricTile( + label: 'inflight', + value: '${_snapshot.inflightCount ?? 0}', + ), + _MetricTile( + label: 'tracked', + value: '${_snapshot.jobs.length}', + ), + _MetricTile( + label: 'heartbeat', + value: _formatTimestamp(_snapshot.lastHeartbeatAt), + ), + ], + ), + ], + ), + ), + const SizedBox(height: 10), + SizedBox( + width: double.infinity, + child: FilledButton.icon( + onPressed: _runtime == null || _isBooting + ? null + : _enqueueJob, + icon: const Icon(Icons.playlist_add), + label: const Text('Push Job'), + ), + ), + const SizedBox(height: 10), + Text( + 'Recent jobs', + style: textTheme.titleSmall?.copyWith( + fontWeight: FontWeight.w700, + ), + ), + const SizedBox(height: 8), + if (_isBooting) + const Expanded( + child: Center(child: CircularProgressIndicator()), + ) + else if (_bootError != null) + Expanded( + child: SingleChildScrollView( + child: SelectableText(_bootError!), + ), + ) + else if (_snapshot.jobs.isEmpty) + Expanded( + child: Center( + child: Text( + (_snapshot.pendingCount ?? 0) > 0 || + (_snapshot.inflightCount ?? 0) > 0 + ? 'Waiting for the worker to publish job status...' + : 'No jobs queued yet.', + style: textTheme.titleMedium, + ), + ), + ) + else + Expanded( + child: ListView.separated( + padding: const EdgeInsets.only(bottom: 12), + itemCount: _snapshot.jobs.length, + separatorBuilder: (_, _) => const SizedBox(height: 8), + itemBuilder: (BuildContext context, int index) { + final job = _snapshot.jobs[index]; + return _JobCard(job: job); + }, + ), + ), + ], + ), + ), + ), + ); + } +} + +Future _workerIsolateMain(Map config) async { + final bootstrap = StemFlutterSqliteWorkerBootstrap.fromMessage(config); + + StreamSubscription? eventsSub; + Worker? worker; + StemFlutterSqliteWorkerStores? stores; + ReceivePort? commands; + var workerStarted = false; + + try { + configureStemLogging( + level: Level.debug, + format: StemLogFormat.plain, + enableConsole: true, + ); + stemLogger.info('Worker isolate bootstrap starting'); + bootstrap.sendPort.send( + const StemFlutterWorkerSignal.status( + status: StemFlutterWorkerStatus.starting, + detail: 'Initializing background isolate', + ).toMessage(), + ); + + await bootstrap.initializeBackgroundDependencies(); + stemLogger.info('Worker isolate dependencies initialized'); + + stores = await StemFlutterSqliteWorkerStores.open(bootstrap); + stemLogger.info( + 'Worker stores ready', + stemLogContext( + component: 'flutter_example', + subsystem: 'worker', + fields: { + 'brokerPath': bootstrap.brokerPath, + 'backendPath': bootstrap.backendPath, + }, + ), + ); + + worker = Worker( + broker: stores.broker, + backend: stores.backend, + tasks: _taskHandlers(), + queue: _queueName, + consumerName: _workerId, + concurrency: 1, + prefetch: 1, + heartbeatInterval: _workerHeartbeatInterval, + workerHeartbeatInterval: _workerHeartbeatInterval, + ); + commands = ReceivePort(); + eventsSub = worker.events.listen((event) { + stemLogger.info( + 'Worker event ${event.type.name}', + stemLogContext( + component: 'flutter_example', + subsystem: 'worker_event', + fields: { + 'envelopeId': event.envelopeId, + 'error': event.error?.toString(), + }, + ), + ); + if (event.type == WorkerEventType.error || + event.type == WorkerEventType.timeout) { + bootstrap.sendPort.send( + StemFlutterWorkerSignal.warning( + event.error?.toString() ?? event.type.name, + ).toMessage(), + ); + } + }); + + await worker.start(); + workerStarted = true; + stemLogger.info('Worker started'); + bootstrap.sendPort.send( + StemFlutterWorkerSignal.ready( + commandPort: commands.sendPort, + detail: 'Worker isolate ready.', + ).toMessage(), + ); + + await for (final dynamic message in commands) { + if (message is Map && message['type'] == 'shutdown') { + stemLogger.info('Worker isolate received shutdown request'); + break; + } + } + } catch (error, stackTrace) { + stemLogger.error('Worker isolate bootstrap failed: $error', stackTrace); + bootstrap.sendPort.send( + StemFlutterWorkerSignal.fatal('$error\n$stackTrace').toMessage(), + ); + } finally { + await eventsSub?.cancel(); + if (worker != null && workerStarted) { + await worker.shutdown(mode: WorkerShutdownMode.warm); + } + await stores?.close(); + commands?.close(); + stemLogger.warning('Worker isolate shutting down'); + } +} + +String _formatTimestamp(DateTime? value) { + if (value == null) return 'none'; + final local = value.toLocal(); + String twoDigits(int number) => number.toString().padLeft(2, '0'); + return '${twoDigits(local.hour)}:${twoDigits(local.minute)}:${twoDigits(local.second)}'; +} + +class _JobCard extends StatelessWidget { + const _JobCard({required this.job}); + + final StemFlutterTrackedJob job; + + @override + Widget build(BuildContext context) { + final theme = Theme.of(context); + final preview = job.errorMessage ?? job.result; + final isError = job.errorMessage != null; + final accent = switch (job.state) { + TaskState.queued => const Color(0xFF0EA5E9), + TaskState.running => const Color(0xFFF59E0B), + TaskState.succeeded => const Color(0xFF22C55E), + TaskState.failed => const Color(0xFFEF4444), + TaskState.retried => const Color(0xFFA855F7), + TaskState.cancelled => const Color(0xFF64748B), + }; + + return Container( + padding: const EdgeInsets.all(12), + decoration: BoxDecoration( + color: Colors.white, + borderRadius: BorderRadius.circular(16), + border: Border.all(color: accent.withValues(alpha: 0.18)), + boxShadow: const [ + BoxShadow( + color: Color(0x110F172A), + blurRadius: 14, + offset: Offset(0, 6), + ), + ], + ), + child: Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Container( + width: 4, + height: 72, + decoration: BoxDecoration( + color: accent, + borderRadius: BorderRadius.circular(999), + ), + ), + const SizedBox(width: 10), + Expanded( + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Row( + children: [ + Expanded( + child: Text( + job.label, + maxLines: 1, + overflow: TextOverflow.ellipsis, + style: theme.textTheme.titleMedium?.copyWith( + fontWeight: FontWeight.w700, + ), + ), + ), + const SizedBox(width: 8), + _StatusChip(state: job.state), + ], + ), + const SizedBox(height: 4), + Text( + 'updated ${_formatTimestamp(job.updatedAt)}', + style: theme.textTheme.bodySmall?.copyWith( + color: const Color(0xFF64748B), + ), + ), + const SizedBox(height: 4), + Text( + job.taskId, + maxLines: 1, + overflow: TextOverflow.ellipsis, + style: theme.textTheme.bodySmall?.copyWith( + color: const Color(0xFF475569), + ), + ), + if (preview != null) ...[ + const SizedBox(height: 8), + Text( + preview, + maxLines: 2, + overflow: TextOverflow.ellipsis, + style: theme.textTheme.bodyMedium?.copyWith( + color: isError + ? theme.colorScheme.error + : const Color(0xFF0F172A), + ), + ), + ], + ], + ), + ), + ], + ), + ); + } +} + +class _WorkerStateChip extends StatelessWidget { + const _WorkerStateChip({required this.state}); + + final StemFlutterWorkerStatus state; + + @override + Widget build(BuildContext context) { + final (background, foreground, label) = switch (state) { + StemFlutterWorkerStatus.running => ( + const Color(0xFFDCFCE7), + const Color(0xFF166534), + 'running', + ), + StemFlutterWorkerStatus.waiting => ( + const Color(0xFFFEF3C7), + const Color(0xFF92400E), + 'waiting', + ), + StemFlutterWorkerStatus.starting => ( + const Color(0xFFE0F2FE), + const Color(0xFF075985), + 'starting', + ), + StemFlutterWorkerStatus.error => ( + const Color(0xFFFEE2E2), + const Color(0xFF991B1B), + 'error', + ), + StemFlutterWorkerStatus.stopped => ( + const Color(0xFFE5E7EB), + const Color(0xFF374151), + 'stopped', + ), + }; + + return DecoratedBox( + decoration: BoxDecoration( + color: background, + borderRadius: BorderRadius.circular(999), + ), + child: Padding( + padding: const EdgeInsets.symmetric(horizontal: 12, vertical: 7), + child: Text( + label, + style: TextStyle(color: foreground, fontWeight: FontWeight.w700), + ), + ), + ); + } +} + +class _MetricTile extends StatelessWidget { + const _MetricTile({required this.label, required this.value}); + + final String label; + final String value; + + @override + Widget build(BuildContext context) { + final textTheme = Theme.of(context).textTheme; + return Container( + constraints: const BoxConstraints(minWidth: 84), + padding: const EdgeInsets.symmetric(horizontal: 10, vertical: 8), + decoration: BoxDecoration( + color: Colors.white.withValues(alpha: 0.72), + borderRadius: BorderRadius.circular(14), + border: Border.all(color: const Color(0xFFCCFBF1)), + ), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Text( + label, + style: textTheme.labelSmall?.copyWith( + color: const Color(0xFF0F766E), + fontWeight: FontWeight.w700, + ), + ), + const SizedBox(height: 2), + Text( + value, + style: textTheme.titleSmall?.copyWith(fontWeight: FontWeight.w700), + ), + ], + ), + ); + } +} + +class _StatusChip extends StatelessWidget { + const _StatusChip({required this.state}); + + final TaskState state; + + @override + Widget build(BuildContext context) { + final (background, foreground, label) = switch (state) { + TaskState.queued => ( + const Color(0xFFE0F2FE), + const Color(0xFF075985), + 'queued', + ), + TaskState.running => ( + const Color(0xFFFEF3C7), + const Color(0xFF92400E), + 'running', + ), + TaskState.succeeded => ( + const Color(0xFFDCFCE7), + const Color(0xFF166534), + 'succeeded', + ), + TaskState.failed => ( + const Color(0xFFFEE2E2), + const Color(0xFF991B1B), + 'failed', + ), + TaskState.retried => ( + const Color(0xFFF3E8FF), + const Color(0xFF6B21A8), + 'retried', + ), + TaskState.cancelled => ( + const Color(0xFFE5E7EB), + const Color(0xFF374151), + 'cancelled', + ), + }; + + return DecoratedBox( + decoration: BoxDecoration( + color: background, + borderRadius: BorderRadius.circular(999), + ), + child: Padding( + padding: const EdgeInsets.symmetric(horizontal: 10, vertical: 5), + child: Text( + label, + style: TextStyle(color: foreground, fontWeight: FontWeight.w700), + ), + ), + ); + } +} diff --git a/packages/stem/example/flutter_stem_example/linux/.gitignore b/packages/stem/example/flutter_stem_example/linux/.gitignore new file mode 100644 index 00000000..d3896c98 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/packages/stem/example/flutter_stem_example/linux/CMakeLists.txt b/packages/stem/example/flutter_stem_example/linux/CMakeLists.txt new file mode 100644 index 00000000..10a2298d --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/CMakeLists.txt @@ -0,0 +1,128 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "flutter_stem_example") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.example.flutter_stem_example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/linux/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/packages/stem/example/flutter_stem_example/linux/flutter/CMakeLists.txt b/packages/stem/example/flutter_stem_example/linux/flutter/CMakeLists.txt new file mode 100644 index 00000000..d5bd0164 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.cc b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 00000000..e71a16d2 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void fl_register_plugins(FlPluginRegistry* registry) { +} diff --git a/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.h b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 00000000..e0f0a47b --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugins.cmake b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugins.cmake new file mode 100644 index 00000000..be1ee3e5 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/flutter/generated_plugins.cmake @@ -0,0 +1,24 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST + jni +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/packages/stem/example/flutter_stem_example/linux/runner/CMakeLists.txt b/packages/stem/example/flutter_stem_example/linux/runner/CMakeLists.txt new file mode 100644 index 00000000..e97dabc7 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/runner/CMakeLists.txt @@ -0,0 +1,26 @@ +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the application ID. +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") diff --git a/packages/stem/example/flutter_stem_example/linux/runner/main.cc b/packages/stem/example/flutter_stem_example/linux/runner/main.cc new file mode 100644 index 00000000..e7c5c543 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/runner/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/packages/stem/example/flutter_stem_example/linux/runner/my_application.cc b/packages/stem/example/flutter_stem_example/linux/runner/my_application.cc new file mode 100644 index 00000000..7597951f --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/runner/my_application.cc @@ -0,0 +1,148 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Called when first Flutter frame received. +static void first_frame_cb(MyApplication* self, FlView* view) { + gtk_widget_show(gtk_widget_get_toplevel(GTK_WIDGET(view))); +} + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "flutter_stem_example"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "flutter_stem_example"); + } + + gtk_window_set_default_size(window, 1280, 720); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments( + project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + GdkRGBA background_color; + // Background defaults to black, override it here if necessary, e.g. #00000000 + // for transparent. + gdk_rgba_parse(&background_color, "#000000"); + fl_view_set_background_color(view, &background_color); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + // Show the window when Flutter renders. + // Requires the view to be realized so we can start rendering. + g_signal_connect_swapped(view, "first-frame", G_CALLBACK(first_frame_cb), + self); + gtk_widget_realize(GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, + gchar*** arguments, + int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GApplication::startup. +static void my_application_startup(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application startup. + + G_APPLICATION_CLASS(my_application_parent_class)->startup(application); +} + +// Implements GApplication::shutdown. +static void my_application_shutdown(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application shutdown. + + G_APPLICATION_CLASS(my_application_parent_class)->shutdown(application); +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = + my_application_local_command_line; + G_APPLICATION_CLASS(klass)->startup = my_application_startup; + G_APPLICATION_CLASS(klass)->shutdown = my_application_shutdown; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + // Set the program name to the application ID, which helps various systems + // like GTK and desktop environments map this running application to its + // corresponding .desktop file. This ensures better integration by allowing + // the application to be recognized beyond its binary name. + g_set_prgname(APPLICATION_ID); + + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, "flags", + G_APPLICATION_NON_UNIQUE, nullptr)); +} diff --git a/packages/stem/example/flutter_stem_example/linux/runner/my_application.h b/packages/stem/example/flutter_stem_example/linux/runner/my_application.h new file mode 100644 index 00000000..db16367a --- /dev/null +++ b/packages/stem/example/flutter_stem_example/linux/runner/my_application.h @@ -0,0 +1,21 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, + my_application, + MY, + APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/packages/stem/example/flutter_stem_example/macos/.gitignore b/packages/stem/example/flutter_stem_example/macos/.gitignore new file mode 100644 index 00000000..746adbb6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Debug.xcconfig b/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Debug.xcconfig new file mode 100644 index 00000000..c2efd0b6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Debug.xcconfig @@ -0,0 +1 @@ +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Release.xcconfig b/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Release.xcconfig new file mode 100644 index 00000000..c2efd0b6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Flutter/Flutter-Release.xcconfig @@ -0,0 +1 @@ +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/macos/Flutter/GeneratedPluginRegistrant.swift b/packages/stem/example/flutter_stem_example/macos/Flutter/GeneratedPluginRegistrant.swift new file mode 100644 index 00000000..cccf817a --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Flutter/GeneratedPluginRegistrant.swift @@ -0,0 +1,10 @@ +// +// Generated file. Do not edit. +// + +import FlutterMacOS +import Foundation + + +func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { +} diff --git a/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.pbxproj b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 00000000..f4029436 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,705 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXAggregateTarget section */ + 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { + isa = PBXAggregateTarget; + buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; + buildPhases = ( + 33CC111E2044C6BF0003C045 /* ShellScript */, + ); + dependencies = ( + ); + name = "Flutter Assemble"; + productName = FLX; + }; +/* End PBXAggregateTarget section */ + +/* Begin PBXBuildFile section */ + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C80D7294CF71000263BE5 /* RunnerTests.swift */; }; + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC10EC2044A3C60003C045; + remoteInfo = Runner; + }; + 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC111A2044C6BA0003C045; + remoteInfo = FLX; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 33CC110E2044A8840003C045 /* Bundle Framework */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Bundle Framework"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 331C80D7294CF71000263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; + 33CC10ED2044A3C60003C045 /* flutter_stem_example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "flutter_stem_example.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; + 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; + 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; + 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; + 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; + 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 331C80D2294CF70F00263BE5 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EA2044A3C60003C045 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C80D6294CF71000263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C80D7294CF71000263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 33BA886A226E78AF003329D5 /* Configs */ = { + isa = PBXGroup; + children = ( + 33E5194F232828860026EE4D /* AppInfo.xcconfig */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, + ); + path = Configs; + sourceTree = ""; + }; + 33CC10E42044A3C60003C045 = { + isa = PBXGroup; + children = ( + 33FAB671232836740065AC1E /* Runner */, + 33CEB47122A05771004F2AC0 /* Flutter */, + 331C80D6294CF71000263BE5 /* RunnerTests */, + 33CC10EE2044A3C60003C045 /* Products */, + D73912EC22F37F3D000D13A0 /* Frameworks */, + ); + sourceTree = ""; + }; + 33CC10EE2044A3C60003C045 /* Products */ = { + isa = PBXGroup; + children = ( + 33CC10ED2044A3C60003C045 /* flutter_stem_example.app */, + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 33CC11242044D66E0003C045 /* Resources */ = { + isa = PBXGroup; + children = ( + 33CC10F22044A3C60003C045 /* Assets.xcassets */, + 33CC10F42044A3C60003C045 /* MainMenu.xib */, + 33CC10F72044A3C60003C045 /* Info.plist */, + ); + name = Resources; + path = ..; + sourceTree = ""; + }; + 33CEB47122A05771004F2AC0 /* Flutter */ = { + isa = PBXGroup; + children = ( + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, + ); + path = Flutter; + sourceTree = ""; + }; + 33FAB671232836740065AC1E /* Runner */ = { + isa = PBXGroup; + children = ( + 33CC10F02044A3C60003C045 /* AppDelegate.swift */, + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, + 33E51913231747F40026EE4D /* DebugProfile.entitlements */, + 33E51914231749380026EE4D /* Release.entitlements */, + 33CC11242044D66E0003C045 /* Resources */, + 33BA886A226E78AF003329D5 /* Configs */, + ); + path = Runner; + sourceTree = ""; + }; + D73912EC22F37F3D000D13A0 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C80D4294CF70F00263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C80D1294CF70F00263BE5 /* Sources */, + 331C80D2294CF70F00263BE5 /* Frameworks */, + 331C80D3294CF70F00263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C80DA294CF71000263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 33CC10EC2044A3C60003C045 /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 33CC10E92044A3C60003C045 /* Sources */, + 33CC10EA2044A3C60003C045 /* Frameworks */, + 33CC10EB2044A3C60003C045 /* Resources */, + 33CC110E2044A8840003C045 /* Bundle Framework */, + 3399D490228B24CF009A79C7 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 33CC11202044C79F0003C045 /* PBXTargetDependency */, + ); + name = Runner; + productName = Runner; + productReference = 33CC10ED2044A3C60003C045 /* flutter_stem_example.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C80D4294CF70F00263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 33CC10EC2044A3C60003C045; + }; + 33CC10EC2044A3C60003C045 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + SystemCapabilities = { + com.apple.Sandbox = { + enabled = 1; + }; + }; + }; + 33CC111A2044C6BA0003C045 = { + CreatedOnToolsVersion = 9.2; + ProvisioningStyle = Manual; + }; + }; + }; + buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 33CC10E42044A3C60003C045; + productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 33CC10EC2044A3C60003C045 /* Runner */, + 331C80D4294CF70F00263BE5 /* RunnerTests */, + 33CC111A2044C6BA0003C045 /* Flutter Assemble */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C80D3294CF70F00263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EB2044A3C60003C045 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3399D490228B24CF009A79C7 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; + }; + 33CC111E2044C6BF0003C045 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + Flutter/ephemeral/FlutterInputs.xcfilelist, + ); + inputPaths = ( + Flutter/ephemeral/tripwire, + ); + outputFileListPaths = ( + Flutter/ephemeral/FlutterOutputs.xcfilelist, + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C80D1294CF70F00263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10E92044A3C60003C045 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C80DA294CF71000263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC10EC2044A3C60003C045 /* Runner */; + targetProxy = 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */; + }; + 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; + targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { + isa = PBXVariantGroup; + children = ( + 33CC10F52044A3C60003C045 /* Base */, + ); + name = MainMenu.xib; + path = Runner; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 331C80DB294CF71000263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/flutter_stem_example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/flutter_stem_example"; + }; + name = Debug; + }; + 331C80DC294CF71000263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/flutter_stem_example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/flutter_stem_example"; + }; + name = Release; + }; + 331C80DD294CF71000263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/flutter_stem_example.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/flutter_stem_example"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Profile; + }; + 338D0CEA231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Profile; + }; + 338D0CEB231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Profile; + }; + 33CC10F92044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 33CC10FA2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Release; + }; + 33CC10FC2044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 33CC10FD2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Release; + }; + 33CC111C2044C6BA0003C045 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Debug; + }; + 33CC111D2044C6BA0003C045 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C80DB294CF71000263BE5 /* Debug */, + 331C80DC294CF71000263BE5 /* Release */, + 331C80DD294CF71000263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10F92044A3C60003C045 /* Debug */, + 33CC10FA2044A3C60003C045 /* Release */, + 338D0CE9231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10FC2044A3C60003C045 /* Debug */, + 33CC10FD2044A3C60003C045 /* Release */, + 338D0CEA231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC111C2044C6BA0003C045 /* Debug */, + 33CC111D2044C6BA0003C045 /* Release */, + 338D0CEB231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 33CC10E52044A3C60003C045 /* Project object */; +} diff --git a/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 00000000..18d98100 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 00000000..86599b7a --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/contents.xcworkspacedata b/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 00000000..1d526a16 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 00000000..18d98100 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/AppDelegate.swift b/packages/stem/example/flutter_stem_example/macos/Runner/AppDelegate.swift new file mode 100644 index 00000000..b3c17614 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/AppDelegate.swift @@ -0,0 +1,13 @@ +import Cocoa +import FlutterMacOS + +@main +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } + + override func applicationSupportsSecureRestorableState(_ app: NSApplication) -> Bool { + return true + } +} diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 00000000..a2ec33f1 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,68 @@ +{ + "images" : [ + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_16.png", + "scale" : "1x" + }, + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "2x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "1x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_64.png", + "scale" : "2x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_128.png", + "scale" : "1x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "2x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "1x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "2x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "1x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_1024.png", + "scale" : "2x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 00000000..82b6f9d9 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 00000000..13b35eba Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 00000000..0a3f5fa4 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 00000000..bdb57226 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 00000000..f083318e Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 00000000..326c0e72 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 00000000..2f1632cf Binary files /dev/null and b/packages/stem/example/flutter_stem_example/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Base.lproj/MainMenu.xib b/packages/stem/example/flutter_stem_example/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 00000000..80e867a4 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Configs/AppInfo.xcconfig b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 00000000..0c7d4a2e --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/AppInfo.xcconfig @@ -0,0 +1,14 @@ +// Application-level settings for the Runner target. +// +// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the +// future. If not, the values below would default to using the project name when this becomes a +// 'flutter create' template. + +// The application's name. By default this is also the title of the Flutter window. +PRODUCT_NAME = flutter_stem_example + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = com.example.flutterStemExample + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2026 com.example. All rights reserved. diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Debug.xcconfig b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 00000000..36b0fd94 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Release.xcconfig b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 00000000..dff4f495 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Warnings.xcconfig b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 00000000..42bcbf47 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Configs/Warnings.xcconfig @@ -0,0 +1,13 @@ +WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings +GCC_WARN_UNDECLARED_SELECTOR = YES +CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES +CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE +CLANG_WARN__DUPLICATE_METHOD_MATCH = YES +CLANG_WARN_PRAGMA_PACK = YES +CLANG_WARN_STRICT_PROTOTYPES = YES +CLANG_WARN_COMMA = YES +GCC_WARN_STRICT_SELECTOR_MATCH = YES +CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES +CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES +GCC_WARN_SHADOW = YES +CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/DebugProfile.entitlements b/packages/stem/example/flutter_stem_example/macos/Runner/DebugProfile.entitlements new file mode 100644 index 00000000..dddb8a30 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/DebugProfile.entitlements @@ -0,0 +1,12 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.cs.allow-jit + + com.apple.security.network.server + + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Info.plist b/packages/stem/example/flutter_stem_example/macos/Runner/Info.plist new file mode 100644 index 00000000..4789daa6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Info.plist @@ -0,0 +1,32 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIconFile + + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSMinimumSystemVersion + $(MACOSX_DEPLOYMENT_TARGET) + NSHumanReadableCopyright + $(PRODUCT_COPYRIGHT) + NSMainNibFile + MainMenu + NSPrincipalClass + NSApplication + + diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/MainFlutterWindow.swift b/packages/stem/example/flutter_stem_example/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 00000000..3cc05eb2 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,15 @@ +import Cocoa +import FlutterMacOS + +class MainFlutterWindow: NSWindow { + override func awakeFromNib() { + let flutterViewController = FlutterViewController() + let windowFrame = self.frame + self.contentViewController = flutterViewController + self.setFrame(windowFrame, display: true) + + RegisterGeneratedPlugins(registry: flutterViewController) + + super.awakeFromNib() + } +} diff --git a/packages/stem/example/flutter_stem_example/macos/Runner/Release.entitlements b/packages/stem/example/flutter_stem_example/macos/Runner/Release.entitlements new file mode 100644 index 00000000..852fa1a4 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/Runner/Release.entitlements @@ -0,0 +1,8 @@ + + + + + com.apple.security.app-sandbox + + + diff --git a/packages/stem/example/flutter_stem_example/macos/RunnerTests/RunnerTests.swift b/packages/stem/example/flutter_stem_example/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 00000000..61f3bd1f --- /dev/null +++ b/packages/stem/example/flutter_stem_example/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Cocoa +import FlutterMacOS +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/packages/stem/example/flutter_stem_example/pubspec.yaml b/packages/stem/example/flutter_stem_example/pubspec.yaml new file mode 100644 index 00000000..37fd459c --- /dev/null +++ b/packages/stem/example/flutter_stem_example/pubspec.yaml @@ -0,0 +1,105 @@ +name: flutter_stem_example +description: "Flutter example for running a Stem SQLite worker in a separate isolate." +# The following line prevents the package from being accidentally published to +# pub.dev using `flutter pub publish`. This is preferred for private packages. +publish_to: 'none' # Remove this line if you wish to publish to pub.dev + +# The following defines the version and build number for your application. +# A version number is three numbers separated by dots, like 1.2.43 +# followed by an optional build number separated by a +. +# Both the version and the builder number may be overridden in flutter +# build by specifying --build-name and --build-number, respectively. +# In Android, build-name is used as versionName while build-number used as versionCode. +# Read more about Android versioning at https://developer.android.com/studio/publish/versioning +# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion. +# Read more about iOS versioning at +# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html +# In Windows, build-name is used as the major, minor, and patch parts +# of the product and file versions while build-number is used as the build suffix. +version: 1.0.0+1 + +environment: + sdk: ">=3.9.2 <4.0.0" + +# Dependencies specify other packages that your package needs in order to work. +# To automatically upgrade your package dependencies to the latest versions +# consider running `flutter pub upgrade --major-versions`. Alternatively, +# dependencies can be manually updated by changing the version numbers below to +# the latest version available on pub.dev. To see which dependencies have newer +# versions available, run `flutter pub outdated`. +dependencies: + flutter: + sdk: flutter + stem: + path: ../.. + stem_flutter: + path: ../../../stem_flutter + stem_flutter_sqlite: + path: ../../../stem_flutter_sqlite + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.8 + +dev_dependencies: + flutter_test: + sdk: flutter + + # The "flutter_lints" package below contains a set of recommended lints to + # encourage good coding practices. The lint set provided by the package is + # activated in the `analysis_options.yaml` file located at the root of your + # package. See that file for information about deactivating specific lint + # rules and activating additional ones. + flutter_lints: ^6.0.0 + +dependency_overrides: + meta: ^1.18.0 + stem: + path: ../.. + stem_flutter: + path: ../../../stem_flutter + stem_memory: + path: ../../../stem_memory + stem_sqlite: + path: ../../../stem_sqlite + +# For information on the generic Dart part of this file, see the +# following page: https://dart.dev/tools/pub/pubspec + +# The following section is specific to Flutter packages. +flutter: + # The following line ensures that the Material Icons font is + # included with your application, so that you can use the icons in + # the material Icons class. + uses-material-design: true + + # To add assets to your application, add an assets section, like this: + # assets: + # - images/a_dot_burr.jpeg + # - images/a_dot_ham.jpeg + + # An image asset can refer to one or more resolution-specific "variants", see + # https://flutter.dev/to/resolution-aware-images + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/to/asset-from-package + + # To add custom fonts to your application, add a fonts section here, + # in this "flutter" section. Each entry in this list should have a + # "family" key with the font family name, and a "fonts" key with a + # list giving the asset and other descriptors for the font. For + # example: + # fonts: + # - family: Schyler + # fonts: + # - asset: fonts/Schyler-Regular.ttf + # - asset: fonts/Schyler-Italic.ttf + # style: italic + # - family: Trajan Pro + # fonts: + # - asset: fonts/TrajanPro.ttf + # - asset: fonts/TrajanPro_Bold.ttf + # weight: 700 + # + # For details regarding fonts from package dependencies, + # see https://flutter.dev/to/font-from-package diff --git a/packages/stem/example/flutter_stem_example/test/widget_test.dart b/packages/stem/example/flutter_stem_example/test/widget_test.dart new file mode 100644 index 00000000..2337418a --- /dev/null +++ b/packages/stem/example/flutter_stem_example/test/widget_test.dart @@ -0,0 +1,12 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:flutter_stem_example/main.dart'; + +void main() { + testWidgets('renders queue monitor shell', (WidgetTester tester) async { + await tester.pumpWidget(const StemFlutterExampleApp()); + await tester.pump(); + + expect(find.text('Stem Queue Monitor'), findsOneWidget); + expect(find.text('Push Job'), findsOneWidget); + }); +} diff --git a/packages/stem/example/flutter_stem_example/web/favicon.png b/packages/stem/example/flutter_stem_example/web/favicon.png new file mode 100644 index 00000000..8aaa46ac Binary files /dev/null and b/packages/stem/example/flutter_stem_example/web/favicon.png differ diff --git a/packages/stem/example/flutter_stem_example/web/icons/Icon-192.png b/packages/stem/example/flutter_stem_example/web/icons/Icon-192.png new file mode 100644 index 00000000..b749bfef Binary files /dev/null and b/packages/stem/example/flutter_stem_example/web/icons/Icon-192.png differ diff --git a/packages/stem/example/flutter_stem_example/web/icons/Icon-512.png b/packages/stem/example/flutter_stem_example/web/icons/Icon-512.png new file mode 100644 index 00000000..88cfd48d Binary files /dev/null and b/packages/stem/example/flutter_stem_example/web/icons/Icon-512.png differ diff --git a/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-192.png b/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-192.png new file mode 100644 index 00000000..eb9b4d76 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-192.png differ diff --git a/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-512.png b/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-512.png new file mode 100644 index 00000000..d69c5669 Binary files /dev/null and b/packages/stem/example/flutter_stem_example/web/icons/Icon-maskable-512.png differ diff --git a/packages/stem/example/flutter_stem_example/web/index.html b/packages/stem/example/flutter_stem_example/web/index.html new file mode 100644 index 00000000..4d23e73d --- /dev/null +++ b/packages/stem/example/flutter_stem_example/web/index.html @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + Stem Flutter Example + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/web/manifest.json b/packages/stem/example/flutter_stem_example/web/manifest.json new file mode 100644 index 00000000..fc5ec47d --- /dev/null +++ b/packages/stem/example/flutter_stem_example/web/manifest.json @@ -0,0 +1,35 @@ +{ + "name": "flutter_stem_example", + "short_name": "flutter_stem_example", + "start_url": ".", + "display": "standalone", + "background_color": "#0175C2", + "theme_color": "#0175C2", + "description": "A new Flutter project.", + "orientation": "portrait-primary", + "prefer_related_applications": false, + "icons": [ + { + "src": "icons/Icon-192.png", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "icons/Icon-512.png", + "sizes": "512x512", + "type": "image/png" + }, + { + "src": "icons/Icon-maskable-192.png", + "sizes": "192x192", + "type": "image/png", + "purpose": "maskable" + }, + { + "src": "icons/Icon-maskable-512.png", + "sizes": "512x512", + "type": "image/png", + "purpose": "maskable" + } + ] +} diff --git a/packages/stem/example/flutter_stem_example/windows/.gitignore b/packages/stem/example/flutter_stem_example/windows/.gitignore new file mode 100644 index 00000000..d492d0d9 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/packages/stem/example/flutter_stem_example/windows/CMakeLists.txt b/packages/stem/example/flutter_stem_example/windows/CMakeLists.txt new file mode 100644 index 00000000..8266bdd5 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(flutter_stem_example LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "flutter_stem_example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/packages/stem/example/flutter_stem_example/windows/flutter/CMakeLists.txt b/packages/stem/example/flutter_stem_example/windows/flutter/CMakeLists.txt new file mode 100644 index 00000000..903f4899 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.cc b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 00000000..8b6d4680 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.h b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 00000000..dc139d85 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugins.cmake b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugins.cmake new file mode 100644 index 00000000..3ad69c61 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/flutter/generated_plugins.cmake @@ -0,0 +1,24 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST + jni +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/packages/stem/example/flutter_stem_example/windows/runner/CMakeLists.txt b/packages/stem/example/flutter_stem_example/windows/runner/CMakeLists.txt new file mode 100644 index 00000000..394917c0 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/packages/stem/example/flutter_stem_example/windows/runner/Runner.rc b/packages/stem/example/flutter_stem_example/windows/runner/Runner.rc new file mode 100644 index 00000000..e314fea4 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.example" "\0" + VALUE "FileDescription", "flutter_stem_example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "flutter_stem_example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "flutter_stem_example.exe" "\0" + VALUE "ProductName", "flutter_stem_example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.cpp b/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.cpp new file mode 100644 index 00000000..955ee303 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.h b/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.h new file mode 100644 index 00000000..6da0652f --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/packages/stem/example/flutter_stem_example/windows/runner/main.cpp b/packages/stem/example/flutter_stem_example/windows/runner/main.cpp new file mode 100644 index 00000000..2058ffd6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"flutter_stem_example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/packages/stem/example/flutter_stem_example/windows/runner/resource.h b/packages/stem/example/flutter_stem_example/windows/runner/resource.h new file mode 100644 index 00000000..66a65d1e --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/packages/stem/example/flutter_stem_example/windows/runner/resources/app_icon.ico b/packages/stem/example/flutter_stem_example/windows/runner/resources/app_icon.ico new file mode 100644 index 00000000..c04e20ca Binary files /dev/null and b/packages/stem/example/flutter_stem_example/windows/runner/resources/app_icon.ico differ diff --git a/packages/stem/example/flutter_stem_example/windows/runner/runner.exe.manifest b/packages/stem/example/flutter_stem_example/windows/runner/runner.exe.manifest new file mode 100644 index 00000000..153653e8 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/packages/stem/example/flutter_stem_example/windows/runner/utils.cpp b/packages/stem/example/flutter_stem_example/windows/runner/utils.cpp new file mode 100644 index 00000000..3a0b4651 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/utils.cpp @@ -0,0 +1,65 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + unsigned int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr) + -1; // remove the trailing null character + int input_length = (int)wcslen(utf16_string); + std::string utf8_string; + if (target_length == 0 || target_length > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/packages/stem/example/flutter_stem_example/windows/runner/utils.h b/packages/stem/example/flutter_stem_example/windows/runner/utils.h new file mode 100644 index 00000000..3879d547 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/packages/stem/example/flutter_stem_example/windows/runner/win32_window.cpp b/packages/stem/example/flutter_stem_example/windows/runner/win32_window.cpp new file mode 100644 index 00000000..60608d0f --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/packages/stem/example/flutter_stem_example/windows/runner/win32_window.h b/packages/stem/example/flutter_stem_example/windows/runner/win32_window.h new file mode 100644 index 00000000..e901dde6 --- /dev/null +++ b/packages/stem/example/flutter_stem_example/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/packages/stem/example/image_processor/lib/stem_image_processor_example.dart b/packages/stem/example/image_processor/lib/stem_image_processor_example.dart new file mode 100644 index 00000000..8e797def --- /dev/null +++ b/packages/stem/example/image_processor/lib/stem_image_processor_example.dart @@ -0,0 +1,5 @@ +/// Image thumbnail generation example using Stem task queue. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to enqueue and process thumbnail generation jobs. +library; diff --git a/packages/stem/example/microservice/beat/lib/stem_microservice_beat.dart b/packages/stem/example/microservice/beat/lib/stem_microservice_beat.dart new file mode 100644 index 00000000..ff2184d5 --- /dev/null +++ b/packages/stem/example/microservice/beat/lib/stem_microservice_beat.dart @@ -0,0 +1,6 @@ +/// Beat scheduler for the Stem microservice example. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to publish scheduled jobs for the microservice +/// example. +library; diff --git a/packages/stem/example/microservice/enqueuer/lib/stem_microservice_enqueuer.dart b/packages/stem/example/microservice/enqueuer/lib/stem_microservice_enqueuer.dart new file mode 100644 index 00000000..c26fb34e --- /dev/null +++ b/packages/stem/example/microservice/enqueuer/lib/stem_microservice_enqueuer.dart @@ -0,0 +1,6 @@ +/// HTTP API that enqueues Stem tasks using Redis. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the enqueue API for the microservice +/// example. +library; diff --git a/packages/stem/example/microservice/worker/lib/stem_microservice_worker.dart b/packages/stem/example/microservice/worker/lib/stem_microservice_worker.dart new file mode 100644 index 00000000..c7993ccb --- /dev/null +++ b/packages/stem/example/microservice/worker/lib/stem_microservice_worker.dart @@ -0,0 +1,6 @@ +/// Dedicated worker process consuming Stem tasks via Redis. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the worker process for the microservice +/// example. +library; diff --git a/packages/stem/example/mixed_cluster/enqueuer/lib/stem_mixed_enqueuer.dart b/packages/stem/example/mixed_cluster/enqueuer/lib/stem_mixed_enqueuer.dart new file mode 100644 index 00000000..ceb578cc --- /dev/null +++ b/packages/stem/example/mixed_cluster/enqueuer/lib/stem_mixed_enqueuer.dart @@ -0,0 +1,5 @@ +/// Enqueuer that targets Redis and Postgres workers. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to publish tasks into the mixed-cluster example. +library; diff --git a/packages/stem/example/mixed_cluster/postgres_worker/lib/stem_mixed_postgres_worker.dart b/packages/stem/example/mixed_cluster/postgres_worker/lib/stem_mixed_postgres_worker.dart new file mode 100644 index 00000000..bf00c5e9 --- /dev/null +++ b/packages/stem/example/mixed_cluster/postgres_worker/lib/stem_mixed_postgres_worker.dart @@ -0,0 +1,6 @@ +/// Worker that consumes from Postgres broker and stores results in Postgres. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the Postgres-backed worker in the +/// mixed-cluster example. +library; diff --git a/packages/stem/example/mixed_cluster/redis_worker/lib/stem_mixed_redis_worker.dart b/packages/stem/example/mixed_cluster/redis_worker/lib/stem_mixed_redis_worker.dart new file mode 100644 index 00000000..87bc5b1e --- /dev/null +++ b/packages/stem/example/mixed_cluster/redis_worker/lib/stem_mixed_redis_worker.dart @@ -0,0 +1,6 @@ +/// Worker that consumes from Redis and stores results in Redis. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the Redis-backed worker in the +/// mixed-cluster example. +library; diff --git a/packages/stem/example/monolith_service/lib/stem_monolith_example.dart b/packages/stem/example/monolith_service/lib/stem_monolith_example.dart new file mode 100644 index 00000000..4a827609 --- /dev/null +++ b/packages/stem/example/monolith_service/lib/stem_monolith_example.dart @@ -0,0 +1,5 @@ +/// Simple monolithic Stem deployment with in-memory adapters. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to launch the monolithic example service. +library; diff --git a/packages/stem/example/otel_metrics/lib/stem_otel_metrics_example.dart b/packages/stem/example/otel_metrics/lib/stem_otel_metrics_example.dart new file mode 100644 index 00000000..0b972bfc --- /dev/null +++ b/packages/stem/example/otel_metrics/lib/stem_otel_metrics_example.dart @@ -0,0 +1,5 @@ +/// Minimal example streaming Stem metrics to an OpenTelemetry collector. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the metrics example components. +library; diff --git a/packages/stem/example/postgres_worker/enqueuer/lib/stem_postgres_enqueuer.dart b/packages/stem/example/postgres_worker/enqueuer/lib/stem_postgres_enqueuer.dart new file mode 100644 index 00000000..3cb8ec9b --- /dev/null +++ b/packages/stem/example/postgres_worker/enqueuer/lib/stem_postgres_enqueuer.dart @@ -0,0 +1,5 @@ +/// Example enqueuer that uses Postgres for broker and result backend. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to publish tasks into the Postgres worker example. +library; diff --git a/packages/stem/example/postgres_worker/worker/lib/stem_postgres_worker.dart b/packages/stem/example/postgres_worker/worker/lib/stem_postgres_worker.dart new file mode 100644 index 00000000..7fa3d6dd --- /dev/null +++ b/packages/stem/example/postgres_worker/worker/lib/stem_postgres_worker.dart @@ -0,0 +1,5 @@ +/// Worker process backed by Postgres broker and result backend. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the Postgres-backed worker process. +library; diff --git a/packages/stem/example/redis_postgres_worker/enqueuer/lib/stem_redis_postgres_enqueuer.dart b/packages/stem/example/redis_postgres_worker/enqueuer/lib/stem_redis_postgres_enqueuer.dart new file mode 100644 index 00000000..a1940706 --- /dev/null +++ b/packages/stem/example/redis_postgres_worker/enqueuer/lib/stem_redis_postgres_enqueuer.dart @@ -0,0 +1,5 @@ +/// Enqueuer using Redis broker and Postgres backend. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to publish tasks into the Redis/Postgres example. +library; diff --git a/packages/stem/example/redis_postgres_worker/worker/lib/stem_redis_postgres_worker.dart b/packages/stem/example/redis_postgres_worker/worker/lib/stem_redis_postgres_worker.dart new file mode 100644 index 00000000..9297bdc8 --- /dev/null +++ b/packages/stem/example/redis_postgres_worker/worker/lib/stem_redis_postgres_worker.dart @@ -0,0 +1,5 @@ +/// Worker using Redis broker and Postgres result backend. +/// +/// This package is an executable example rather than a reusable library. Run +/// the scripts under `bin/` to start the Redis/Postgres worker process. +library; diff --git a/packages/stem/pubspec.yaml b/packages/stem/pubspec.yaml index 5194ca24..b526d43e 100644 --- a/packages/stem/pubspec.yaml +++ b/packages/stem/pubspec.yaml @@ -1,6 +1,6 @@ name: stem description: "Stem is a Dart-native background job platform with Redis Streams, retries, scheduling, observability, and security tooling." -version: 0.2.1-wip +version: 0.2.1 repository: https://github.com/kingwill101/stem resolution: workspace environment: diff --git a/packages/stem_adapter_tests/CHANGELOG.md b/packages/stem_adapter_tests/CHANGELOG.md index c39cd1f5..6e9dfcfe 100644 --- a/packages/stem_adapter_tests/CHANGELOG.md +++ b/packages/stem_adapter_tests/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 0.1.2 + +- Updated the `stem` dependency range for the 0.2.1 core release. + ## 0.1.1 - Added workflow-store contract coverage for caller-provided run ids and diff --git a/packages/stem_adapter_tests/pubspec.yaml b/packages/stem_adapter_tests/pubspec.yaml index ce5b15e7..49ef57de 100644 --- a/packages/stem_adapter_tests/pubspec.yaml +++ b/packages/stem_adapter_tests/pubspec.yaml @@ -1,13 +1,13 @@ name: stem_adapter_tests description: Shared contract test suites for Stem broker and result backend adapters. -version: 0.1.1 +version: 0.1.2 repository: https://github.com/kingwill101/stem resolution: workspace environment: sdk: ">=3.9.2 <4.0.0" dependencies: - stem: ">=0.2.0-dev <0.3.0" + stem: ">=0.2.1 <0.3.0" test: ^1.29.0 dev_dependencies: diff --git a/packages/stem_cli/lib/stem_cli.dart b/packages/stem_cli/lib/stem_cli.dart index e8d31671..a957574f 100644 --- a/packages/stem_cli/lib/stem_cli.dart +++ b/packages/stem_cli/lib/stem_cli.dart @@ -1,3 +1,8 @@ +/// Command-line entrypoints and routing helpers for Stem worker processes. +/// +/// This library exposes the top-level APIs used to bootstrap the Stem CLI, +/// build worker subscriptions from routing configuration, and create the +/// default command context used by command-line hosts. library stem_cli; export 'src/cli/cli_runner.dart' show CliContext, runStemCli; diff --git a/packages/stem_flutter/CHANGELOG.md b/packages/stem_flutter/CHANGELOG.md new file mode 100644 index 00000000..703c9b53 --- /dev/null +++ b/packages/stem_flutter/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +## 0.1.0 + +- Initial Flutter integration package for Stem. +- Added storage path helpers, TimeMachine bootstrapping, worker isolate hosting, + and queue monitoring primitives. diff --git a/packages/stem_flutter/README.md b/packages/stem_flutter/README.md new file mode 100644 index 00000000..782e0450 --- /dev/null +++ b/packages/stem_flutter/README.md @@ -0,0 +1,142 @@ +# stem_flutter + +Flutter integration primitives for hosting Stem workers inside a Flutter app. + +`stem_flutter` is the adapter-neutral layer. It does not choose a broker or +result backend for you. Instead, it gives Flutter apps the pieces they usually +need around a Stem worker: + +- spawning and supervising a worker isolate +- translating isolate messages into typed worker signals +- polling queue depth, heartbeats, and recent jobs into a UI-friendly snapshot +- keeping that coordination code out of widget trees and app bootstrap code + +If you want the SQLite-specific runtime and worker bootstrap helpers, use +`stem_flutter_sqlite` on top of this package. + +## What This Package Includes + +- `StemFlutterWorkerHost`: supervises a worker isolate and exposes a stream of + `StemFlutterWorkerSignal` values +- `StemFlutterQueueMonitor`: polls a `Broker` and `ResultBackend`, then merges + that data with worker signals +- `StemFlutterQueueSnapshot`: compact queue and worker state intended for UI + rendering + +## What This Package Does Not Do + +- guarantee always-on background execution on iOS or Android +- hide mobile lifecycle limits or process restarts +- pick a specific broker or result backend +- provide an OS scheduler or background-task wrapper + +Those decisions are intentionally left to the app and the adapter package. + +## Installation + +```yaml +dependencies: + stem_flutter: ^0.1.0 +``` + +## Minimal Usage + +`stem_flutter` is generic, so the broker and backend in this example can come +from Redis, SQLite, Postgres, or another Stem adapter. + +```dart +import 'dart:isolate'; + +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; + +Future workerMain(Map message) async { + final sendPort = message['sendPort']! as SendPort; + final commands = ReceivePort(); + + sendPort.send( + StemFlutterWorkerSignal.ready( + commandPort: commands.sendPort, + detail: 'Worker isolate ready.', + ).toMessage(), + ); + + // Start your Stem Worker here... + + await for (final dynamic command in commands) { + if (command is Map && command['type'] == 'shutdown') { + break; + } + } + + commands.close(); +} + +class MobileWorkerHandles { + const MobileWorkerHandles({ + required this.host, + required this.monitor, + }); + + final StemFlutterWorkerHost host; + final StemFlutterQueueMonitor monitor; + + Future dispose() async { + await monitor.dispose(); + await host.dispose(); + } +} + +Future startMobileWorker({ + required Broker broker, + required ResultBackend backend, +}) async { + final host = await StemFlutterWorkerHost.spawn>( + entrypoint: workerMain, + messageBuilder: (sendPort) => {'sendPort': sendPort}, + ); + + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: broker, + queueName: 'mobile-demo', + workerId: 'mobile-worker', + ); + await monitor.bindWorkerSignals(host.signals); + + await monitor.start(); + return MobileWorkerHandles(host: host, monitor: monitor); +} +``` + +## Mobile Recommendations + +- Keep the UI isolate producer-oriented. Do not run the worker on the main + isolate if you can avoid it. +- Use a separate isolate for the worker and report status back through + `StemFlutterWorkerSignal`. +- Treat `StemFlutterQueueMonitor` as an observation layer. It reports queue and + heartbeat state; it does not drive execution. +- Prefer polling `listTaskStatuses()` or heartbeats for cross-isolate status + views. Backend-specific `watch(taskId)` streams are often process-local. + +## Example + +The recommended mobile structure lives in +`packages/stem/example/flutter_stem_example`. + +That example shows how to combine `stem_flutter` with +`stem_flutter_sqlite` to: + +- open a producer runtime on the UI isolate +- launch a separate worker isolate +- monitor pending, inflight, and recent-job state from Flutter + +## Related Package + +Use `stem_flutter_sqlite` when you want: + +- application-support-directory storage layout +- SQLite-backed broker and result backend helpers +- worker bootstrap payloads for Flutter background isolates +- a convenience launcher for SQLite worker isolates diff --git a/packages/stem_flutter/analysis_options.yaml b/packages/stem_flutter/analysis_options.yaml new file mode 100644 index 00000000..8086495a --- /dev/null +++ b/packages/stem_flutter/analysis_options.yaml @@ -0,0 +1,6 @@ +include: package:very_good_analysis/analysis_options.yaml + +analyzer: + exclude: + - "**/*.g.dart" + - "**/*.orm.dart" diff --git a/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_monitor.dart b/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_monitor.dart new file mode 100644 index 00000000..9856f73a --- /dev/null +++ b/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_monitor.dart @@ -0,0 +1,248 @@ +import 'dart:async'; + +import 'package:stem/stem.dart'; +import 'package:stem_flutter/src/monitor/stem_flutter_queue_snapshot.dart'; +import 'package:stem_flutter/src/runtime/stem_flutter_worker_signal.dart'; + +/// Polls queue state and merges worker signals into UI snapshots. +class StemFlutterQueueMonitor { + /// Creates a queue monitor for a single Stem queue. + StemFlutterQueueMonitor({ + required ResultBackend backend, + required Broker broker, + required String queueName, + required String workerId, + Duration pollInterval = const Duration(seconds: 1), + Duration heartbeatInterval = const Duration(seconds: 2), + int limit = 40, + String Function(TaskStatus status)? labelResolver, + }) : _backend = backend, + _broker = broker, + _queueName = queueName, + _workerId = workerId, + _pollInterval = pollInterval, + _heartbeatFreshness = heartbeatInterval * 3, + _limit = limit, + _labelResolver = + labelResolver ?? + ((status) => status.meta['label']?.toString() ?? status.id); + + final ResultBackend _backend; + final Broker _broker; + final String _queueName; + final String _workerId; + final Duration _pollInterval; + final Duration _heartbeatFreshness; + final int _limit; + final String Function(TaskStatus status) _labelResolver; + + final StreamController _controller = + StreamController.broadcast(); + + Timer? _timer; + StreamSubscription? _workerSignalsSub; + StemFlutterQueueSnapshot _snapshot = const StemFlutterQueueSnapshot(); + bool _refreshInFlight = false; + bool _started = false; + StemFlutterWorkerStatus? _stickyWorkerStatus; + + /// The most recently emitted queue snapshot. + StemFlutterQueueSnapshot get snapshot => _snapshot; + + /// A broadcast stream of queue snapshots. + Stream get snapshots => _controller.stream; + + /// Starts periodic polling for this queue. + /// + /// This method performs an immediate [refresh] before scheduling the periodic + /// timer. Calling it more than once has no effect. + Future start() async { + if (_started) return; + _started = true; + try { + await refresh(); + _timer = Timer.periodic( + _pollInterval, + (_) => unawaited(_refreshSafely()), + ); + } catch (_) { + _started = false; + rethrow; + } + } + + /// Binds worker signals emitted by a supervised worker isolate. + /// + /// When multiple signal streams are bound over time, the previous + /// subscription is replaced. + Future bindWorkerSignals( + Stream signals, + ) async { + await _workerSignalsSub?.cancel(); + _workerSignalsSub = signals.listen(_applyWorkerSignal); + } + + /// Forces an immediate refresh of queue and heartbeat state. + Future refresh() async { + if (_refreshInFlight) return; + _refreshInFlight = true; + try { + final page = await _backend.listTaskStatuses( + TaskStatusListRequest(queue: _queueName, limit: _limit), + ); + final heartbeats = await _backend.listWorkerHeartbeats(); + final pendingCount = await _broker.pendingCount(_queueName); + final inflightCount = await _broker.inflightCount(_queueName); + + final jobs = + page.items + .map((record) { + final status = record.status; + return StemFlutterTrackedJob( + taskId: status.id, + label: _labelResolver(status), + state: status.state, + result: _stringifyResult(status.payload), + errorMessage: status.error?.message, + updatedAt: record.updatedAt.toUtc(), + ); + }) + .toList(growable: false) + ..sort((left, right) => right.updatedAt.compareTo(left.updatedAt)); + + final latestHeartbeat = heartbeats + .where((heartbeat) => heartbeat.workerId == _workerId) + .fold( + null, + (current, heartbeat) => + current == null || + heartbeat.timestamp.isAfter(current.timestamp) + ? heartbeat + : current, + ); + final latestHeartbeatAt = latestHeartbeat?.timestamp.toUtc(); + final hasFreshHeartbeat = + latestHeartbeatAt != null && + DateTime.now().toUtc().difference(latestHeartbeatAt) <= + _heartbeatFreshness; + + var next = _snapshot.copyWith( + jobs: jobs, + lastHeartbeatAt: latestHeartbeatAt, + pendingCount: pendingCount, + inflightCount: inflightCount, + ); + + if (_stickyWorkerStatus == null) { + if (hasFreshHeartbeat) { + next = next.copyWith( + workerStatus: StemFlutterWorkerStatus.running, + workerDetail: 'Heartbeat ${_formatTimestamp(latestHeartbeatAt)}', + ); + } else if (latestHeartbeatAt != null) { + next = next.copyWith( + workerStatus: StemFlutterWorkerStatus.waiting, + workerDetail: + 'Last heartbeat ${_formatTimestamp(latestHeartbeatAt)}', + ); + } else if (next.workerStatus == StemFlutterWorkerStatus.error) { + next = next.copyWith( + workerStatus: StemFlutterWorkerStatus.starting, + clearWorkerDetail: true, + ); + } + } + + _emit(next); + } catch (error, stackTrace) { + _applyRefreshFailure(error, stackTrace); + rethrow; + } finally { + _refreshInFlight = false; + } + } + + /// Stops polling and releases this monitor's subscriptions. + Future dispose() async { + _timer?.cancel(); + await _workerSignalsSub?.cancel(); + await _controller.close(); + } + + void _applyWorkerSignal(StemFlutterWorkerSignal signal) { + _stickyWorkerStatus = switch (signal.type) { + StemFlutterWorkerSignalType.ready => null, + StemFlutterWorkerSignalType.status => switch (signal.status) { + StemFlutterWorkerStatus.error || + StemFlutterWorkerStatus.stopped => signal.status, + _ => null, + }, + StemFlutterWorkerSignalType.warning => _stickyWorkerStatus, + StemFlutterWorkerSignalType.fatal => StemFlutterWorkerStatus.error, + }; + + final next = switch (signal.type) { + StemFlutterWorkerSignalType.ready => _snapshot.copyWith( + workerStatus: StemFlutterWorkerStatus.running, + workerDetail: signal.detail ?? 'Worker isolate ready.', + ), + StemFlutterWorkerSignalType.status => _snapshot.copyWith( + workerStatus: signal.status, + workerDetail: signal.detail, + clearWorkerDetail: signal.detail == null, + ), + StemFlutterWorkerSignalType.warning => _snapshot, + StemFlutterWorkerSignalType.fatal => _snapshot.copyWith( + workerStatus: StemFlutterWorkerStatus.error, + workerDetail: signal.message, + ), + }; + if (!identical(next, _snapshot)) { + _emit(next); + } + } + + Future _refreshSafely() async { + try { + await refresh(); + } on Object { + // Periodic polling errors are surfaced via snapshot state. + } + } + + void _applyRefreshFailure(Object error, StackTrace _) { + if (_stickyWorkerStatus != null) { + return; + } + _emit( + _snapshot.copyWith( + workerStatus: StemFlutterWorkerStatus.error, + workerDetail: 'Queue monitor refresh failed: $error', + ), + ); + } + + void _emit(StemFlutterQueueSnapshot next) { + _snapshot = next; + if (!_controller.isClosed) { + _controller.add(next); + } + } +} + +String? _stringifyResult(Object? payload) { + if (payload == null) return null; + return switch (payload) { + final String value => value, + _ => payload.toString(), + }; +} + +String _formatTimestamp(DateTime? value) { + if (value == null) return 'none'; + final local = value.toLocal(); + String twoDigits(int number) => number.toString().padLeft(2, '0'); + return '${twoDigits(local.hour)}:' + '${twoDigits(local.minute)}:' + '${twoDigits(local.second)}'; +} diff --git a/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_snapshot.dart b/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_snapshot.dart new file mode 100644 index 00000000..9293661f --- /dev/null +++ b/packages/stem_flutter/lib/src/monitor/stem_flutter_queue_snapshot.dart @@ -0,0 +1,108 @@ +import 'package:stem/stem.dart'; +import 'package:stem_flutter/src/runtime/stem_flutter_worker_signal.dart'; + +/// UI-friendly representation of a tracked task. +/// +/// Instances of this type are intended for display and are derived from +/// backend status records. +class StemFlutterTrackedJob { + /// Creates a tracked job. + const StemFlutterTrackedJob({ + required this.taskId, + required this.label, + required this.state, + required this.updatedAt, + this.result, + this.errorMessage, + }); + + /// Task identifier. + final String taskId; + + /// Human-readable label. + final String label; + + /// Current task state. + final TaskState state; + + /// Last update timestamp. + final DateTime updatedAt; + + /// Decoded string result, when available. + final String? result; + + /// Error message, when available. + final String? errorMessage; +} + +/// Aggregate queue and worker state exposed to Flutter UIs. +/// +/// This snapshot is intentionally compact so widgets can render queue depth, +/// worker health, and recent jobs without depending on backend-specific types. +class StemFlutterQueueSnapshot { + /// Creates a queue snapshot. + const StemFlutterQueueSnapshot({ + this.workerStatus = StemFlutterWorkerStatus.starting, + this.workerDetail, + this.lastHeartbeatAt, + this.pendingCount, + this.inflightCount, + this.jobs = const [], + }); + + /// Current worker state. + final StemFlutterWorkerStatus workerStatus; + + /// Detail text attached to the current worker state. + final String? workerDetail; + + /// Most recent worker heartbeat timestamp. + final DateTime? lastHeartbeatAt; + + /// Number of broker-visible pending items. + final int? pendingCount; + + /// Number of broker-visible inflight items. + final int? inflightCount; + + /// Most recent tracked jobs from the result backend. + final List jobs; + + /// Returns a copy with selected fields replaced. + StemFlutterQueueSnapshot copyWith({ + StemFlutterWorkerStatus? workerStatus, + String? workerDetail, + bool clearWorkerDetail = false, + DateTime? lastHeartbeatAt, + bool clearLastHeartbeatAt = false, + int? pendingCount, + bool clearPendingCount = false, + int? inflightCount, + bool clearInflightCount = false, + List? jobs, + }) { + return StemFlutterQueueSnapshot( + workerStatus: workerStatus ?? this.workerStatus, + workerDetail: clearWorkerDetail + ? null + : workerDetail ?? this.workerDetail, + lastHeartbeatAt: clearLastHeartbeatAt + ? null + : lastHeartbeatAt ?? this.lastHeartbeatAt, + pendingCount: clearPendingCount + ? null + : pendingCount ?? this.pendingCount, + inflightCount: clearInflightCount + ? null + : inflightCount ?? this.inflightCount, + jobs: jobs ?? this.jobs, + ); + } + + /// A short detail line suitable for compact UI headers. + String? get workerDetailPreview { + final detail = workerDetail?.trim(); + if (detail == null || detail.isEmpty) return null; + return detail.split('\n').first.trim(); + } +} diff --git a/packages/stem_flutter/lib/src/runtime/stem_flutter_dependency_bootstrap.dart b/packages/stem_flutter/lib/src/runtime/stem_flutter_dependency_bootstrap.dart new file mode 100644 index 00000000..fce80599 --- /dev/null +++ b/packages/stem_flutter/lib/src/runtime/stem_flutter_dependency_bootstrap.dart @@ -0,0 +1,71 @@ +import 'dart:async'; + +import 'package:flutter/services.dart'; +import 'package:time_machine2/time_machine2.dart' as tm; + +Future? _foregroundInitialization; + +/// Initializes Flutter-side dependency state needed before opening adapters. +Future ensureStemFlutterDependenciesInitialized() { + final pending = _foregroundInitialization; + if (pending != null) return pending; + + final initialization = _initializeForegroundDependencies(); + _foregroundInitialization = initialization; + return initialization; +} + +Future _initializeForegroundDependencies() async { + try { + await tm.TimeMachine.initialize({ + 'rootBundle': rootBundle, + }); + } on Object { + _foregroundInitialization = null; + rethrow; + } +} + +/// Loads dependency assets that must be forwarded into background isolates. +Future> preloadStemFlutterDependencyAssets({ + AssetBundle? bundle, +}) async { + final resolvedBundle = bundle ?? rootBundle; + final cultures = await resolvedBundle.load( + 'packages/time_machine2/data/cultures/cultures.bin', + ); + final tzdb = await resolvedBundle.load( + 'packages/time_machine2/data/tzdb/tzdb.bin', + ); + return { + 'cultures/cultures.bin': Uint8List.sublistView(cultures), + 'tzdb/tzdb.bin': Uint8List.sublistView(tzdb), + }; +} + +/// Initializes Flutter-side dependency state inside a background isolate. +Future initializeStemFlutterBackgroundDependencies( + Map assets, +) { + return tm.TimeMachine.initialize({ + 'rootBundle': _StemFlutterDependencyAssetBundle(assets), + }); +} + +class _StemFlutterDependencyAssetBundle extends CachingAssetBundle { + _StemFlutterDependencyAssetBundle(this.assets); + + final Map assets; + + @override + Future load(String key) async { + final normalized = key.startsWith('packages/time_machine2/data/') + ? key.substring('packages/time_machine2/data/'.length) + : key; + final asset = assets[normalized]; + if (asset == null) { + throw Exception('Missing Flutter asset: $key'); + } + return ByteData.sublistView(asset); + } +} diff --git a/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_host.dart b/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_host.dart new file mode 100644 index 00000000..35ca3676 --- /dev/null +++ b/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_host.dart @@ -0,0 +1,173 @@ +import 'dart:async'; +import 'dart:isolate'; + +import 'package:stem_flutter/src/runtime/stem_flutter_worker_signal.dart'; + +/// Supervises a worker isolate launched from a Flutter app. +/// +/// This host owns the isolate lifecycle, exposes decoded worker signals, and +/// provides a small control channel for graceful shutdown. +class StemFlutterWorkerHost { + StemFlutterWorkerHost._({ + required Isolate isolate, + required ReceivePort messages, + required ReceivePort errors, + required ReceivePort exit, + required StreamController controller, + }) : _isolate = isolate, + _messages = messages, + _errors = errors, + _exit = exit, + _controller = controller; + + final Isolate _isolate; + final ReceivePort _messages; + final ReceivePort _errors; + final ReceivePort _exit; + final StreamController _controller; + late final StreamSubscription _messagesSub; + late final StreamSubscription _errorsSub; + late final StreamSubscription _exitSub; + + SendPort? _commandPort; + StemFlutterWorkerSignal? _lastSignal; + final Completer _stoppedCompleter = Completer(); + bool _disposed = false; + + /// A stream of worker signals emitted by the supervised isolate. + Stream get signals => + Stream.multi((controller) { + final lastSignal = _lastSignal; + if (lastSignal != null) { + controller.add(lastSignal); + } + + final subscription = _controller.stream.listen( + controller.add, + onError: controller.addError, + onDone: controller.close, + ); + controller.onCancel = subscription.cancel; + }, isBroadcast: true); + + /// The latest command port reported by the worker. + SendPort? get commandPort => _commandPort; + + /// Spawns a worker isolate and wires its control channels. + /// + /// The [messageBuilder] callback receives the host's signal port so the + /// spawned isolate can report status updates back to this host. + static Future spawn({ + required FutureOr Function(T message) entrypoint, + required T Function(SendPort sendPort) messageBuilder, + }) async { + final messages = ReceivePort(); + final errors = ReceivePort(); + final exit = ReceivePort(); + final controller = StreamController.broadcast(); + final message = messageBuilder(messages.sendPort); + + final isolate = await Isolate.spawn( + entrypoint, + message, + onError: errors.sendPort, + onExit: exit.sendPort, + ); + + final host = StemFlutterWorkerHost._( + isolate: isolate, + messages: messages, + errors: errors, + exit: exit, + controller: controller, + ); + + // Owned by the host and cancelled in dispose(). + // ignore: cancel_subscriptions + final messagesSub = messages.listen((dynamic raw) { + final signal = StemFlutterWorkerSignal.tryParse(raw); + if (signal == null) return; + if (signal.type == StemFlutterWorkerSignalType.ready) { + host._commandPort = signal.commandPort; + } + host._emitSignal(signal); + }); + + // Owned by the host and cancelled in dispose(). + // ignore: cancel_subscriptions + final errorsSub = errors.listen((dynamic raw) { + final detail = switch (raw) { + final List values => values.join('\n'), + _ => raw.toString(), + }; + host._emitSignal(StemFlutterWorkerSignal.fatal(detail)); + }); + + // Owned by the host and cancelled in dispose(). + // ignore: cancel_subscriptions + final exitSub = exit.listen((dynamic _) { + host._emitSignal( + const StemFlutterWorkerSignal.status( + status: StemFlutterWorkerStatus.stopped, + detail: 'Worker isolate exited.', + ), + ); + }); + + host + .._messagesSub = messagesSub + .._errorsSub = errorsSub + .._exitSub = exitSub; + + return host; + } + + /// Requests a graceful worker shutdown. + /// + /// If the worker has not reported a command port yet, this method returns + /// immediately. + Future requestShutdown({ + Duration gracePeriod = const Duration(seconds: 5), + }) async { + final port = _commandPort; + if (port == null) return; + port.send(const {'type': 'shutdown'}); + if (gracePeriod <= Duration.zero) return; + await _stoppedCompleter.future.timeout( + gracePeriod, + onTimeout: () {}, + ); + } + + /// Tears down this host and kills the supervised isolate. + Future dispose() async { + if (_disposed) return; + _disposed = true; + await requestShutdown(); + _isolate.kill(priority: Isolate.immediate); + await _messagesSub.cancel(); + await _errorsSub.cancel(); + await _exitSub.cancel(); + _messages.close(); + _errors.close(); + _exit.close(); + await _controller.close(); + } + + void _emitSignal(StemFlutterWorkerSignal signal) { + _lastSignal = signal; + if (signal.type == StemFlutterWorkerSignalType.fatal || + signal.status == StemFlutterWorkerStatus.stopped) { + _completeStopped(); + } + if (!_controller.isClosed) { + _controller.add(signal); + } + } + + void _completeStopped() { + if (!_stoppedCompleter.isCompleted) { + _stoppedCompleter.complete(); + } + } +} diff --git a/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_signal.dart b/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_signal.dart new file mode 100644 index 00000000..1fd71607 --- /dev/null +++ b/packages/stem_flutter/lib/src/runtime/stem_flutter_worker_signal.dart @@ -0,0 +1,160 @@ +import 'dart:isolate'; + +/// Lifecycle state exposed by Flutter-hosted worker integrations. +enum StemFlutterWorkerStatus { + /// Worker isolate is still bootstrapping. + starting, + + /// Worker is healthy and heartbeats are fresh. + running, + + /// Worker started but heartbeats are stale. + waiting, + + /// Worker encountered a fatal startup or runtime error. + error, + + /// Worker isolate has exited. + stopped, +} + +/// Envelope type exchanged between worker isolates and the UI isolate. +enum StemFlutterWorkerSignalType { + /// Worker boot completed and its command port is available. + ready, + + /// Worker lifecycle status update. + status, + + /// Non-fatal warning emitted by the worker. + warning, + + /// Fatal worker error. + fatal, +} + +/// Serializable worker signal used by Flutter-hosted runtimes. +/// +/// Signals are exchanged between the worker isolate and the UI isolate using +/// isolate-safe message payloads. +class StemFlutterWorkerSignal { + const StemFlutterWorkerSignal._({ + required this.type, + this.status, + this.detail, + this.message, + this.commandPort, + }); + + /// Emits a ready signal with an optional [commandPort]. + const StemFlutterWorkerSignal.ready({SendPort? commandPort, String? detail}) + : this._( + type: StemFlutterWorkerSignalType.ready, + commandPort: commandPort, + detail: detail, + ); + + /// Emits a worker [status] update. + const StemFlutterWorkerSignal.status({ + required StemFlutterWorkerStatus status, + String? detail, + }) : this._( + type: StemFlutterWorkerSignalType.status, + status: status, + detail: detail, + ); + + /// Emits a non-fatal warning. + const StemFlutterWorkerSignal.warning(String message) + : this._(type: StemFlutterWorkerSignalType.warning, message: message); + + /// Emits a fatal error. + const StemFlutterWorkerSignal.fatal(String message) + : this._(type: StemFlutterWorkerSignalType.fatal, message: message); + + /// The signal type. + final StemFlutterWorkerSignalType type; + + /// The worker state carried by status updates. + final StemFlutterWorkerStatus? status; + + /// The optional detail string for ready and status updates. + final String? detail; + + /// The warning or fatal message payload. + final String? message; + + /// The command port exposed by the worker. + final SendPort? commandPort; + + /// Converts this signal into an isolate-safe message map. + Map toMessage() => switch (type) { + StemFlutterWorkerSignalType.ready => { + 'type': 'ready', + if (commandPort != null) 'sendPort': commandPort, + if (detail != null) 'detail': detail, + }, + StemFlutterWorkerSignalType.status => { + 'type': 'status', + 'state': status!.name, + if (detail != null) 'detail': detail, + }, + StemFlutterWorkerSignalType.warning => { + 'type': 'warning', + 'warning': message, + }, + StemFlutterWorkerSignalType.fatal => { + 'type': 'fatal', + 'fatal': message, + }, + }; + + /// Parses an isolate message into a strongly typed worker signal. + static StemFlutterWorkerSignal? tryParse(Object? raw) { + if (raw is! Map) return null; + final type = raw['type']?.toString(); + return switch (type) { + 'ready' => _parseReadySignal(raw), + 'status' => _parseStatusSignal(raw), + 'warning' => StemFlutterWorkerSignal.warning( + raw['warning']?.toString() ?? 'warning', + ), + 'fatal' || 'error' => StemFlutterWorkerSignal.fatal( + raw['fatal']?.toString() ?? raw['error']?.toString() ?? 'error', + ), + _ => null, + }; + } +} + +StemFlutterWorkerSignal _parseReadySignal(Map raw) { + final sendPort = raw['sendPort']; + return StemFlutterWorkerSignal.ready( + commandPort: sendPort is SendPort ? sendPort : null, + detail: raw['detail']?.toString(), + ); +} + +StemFlutterWorkerSignal? _parseStatusSignal(Map raw) { + final rawState = raw['state']?.toString(); + final status = switch (rawState) { + null => StemFlutterWorkerStatus.starting, + final String value => _workerStatusByName(value), + }; + if (status == null) { + return null; + } + return StemFlutterWorkerSignal.status( + status: status, + detail: raw['detail']?.toString(), + ); +} + +StemFlutterWorkerStatus? _workerStatusByName(String name) { + for (final status in StemFlutterWorkerStatus.values) { + if (status.name == name) { + return status; + } + } + return null; +} diff --git a/packages/stem_flutter/lib/stem_flutter.dart b/packages/stem_flutter/lib/stem_flutter.dart new file mode 100644 index 00000000..cd47b1a4 --- /dev/null +++ b/packages/stem_flutter/lib/stem_flutter.dart @@ -0,0 +1,23 @@ +/// Flutter coordination helpers for hosting and observing Stem workers. +/// +/// This library contains the Flutter-facing pieces that are independent of any +/// specific broker or backend adapter. Use `StemFlutterWorkerHost` to +/// supervise a worker isolate, `StemFlutterQueueMonitor` to poll queue and +/// heartbeat state, and `StemFlutterQueueSnapshot` to drive compact UI views. +library; + +export 'src/monitor/stem_flutter_queue_monitor.dart' + show StemFlutterQueueMonitor; +export 'src/monitor/stem_flutter_queue_snapshot.dart' + show StemFlutterQueueSnapshot, StemFlutterTrackedJob; +export 'src/runtime/stem_flutter_dependency_bootstrap.dart' + show + ensureStemFlutterDependenciesInitialized, + initializeStemFlutterBackgroundDependencies, + preloadStemFlutterDependencyAssets; +export 'src/runtime/stem_flutter_worker_host.dart' show StemFlutterWorkerHost; +export 'src/runtime/stem_flutter_worker_signal.dart' + show + StemFlutterWorkerSignal, + StemFlutterWorkerSignalType, + StemFlutterWorkerStatus; diff --git a/packages/stem_flutter/pubspec.yaml b/packages/stem_flutter/pubspec.yaml new file mode 100644 index 00000000..c26af1a4 --- /dev/null +++ b/packages/stem_flutter/pubspec.yaml @@ -0,0 +1,23 @@ +name: stem_flutter +description: Flutter integration helpers for mobile-friendly Stem runtimes. +version: 0.1.0 +repository: https://github.com/kingwill101/stem/tree/master/packages/stem_flutter +issue_tracker: https://github.com/kingwill101/stem/issues +resolution: workspace + +environment: + sdk: ^3.9.2 + +dependencies: + flutter: + sdk: flutter + stem: ">=0.2.0-dev <0.3.0" + time_machine2: ^0.13.1 + +dev_dependencies: + flutter_test: + sdk: flutter + very_good_analysis: ^10.0.0 + +flutter: + uses-material-design: false diff --git a/packages/stem_flutter/test/stem_flutter_queue_monitor_test.dart b/packages/stem_flutter/test/stem_flutter_queue_monitor_test.dart new file mode 100644 index 00000000..85dfcf1b --- /dev/null +++ b/packages/stem_flutter/test/stem_flutter_queue_monitor_test.dart @@ -0,0 +1,281 @@ +import 'dart:async'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; + +class _FakeBroker implements Broker { + _FakeBroker({ + required this.pendingCountValue, + required this.inflightCountValue, + }); + + final int? pendingCountValue; + final int? inflightCountValue; + + @override + Future pendingCount(String queue) async => pendingCountValue; + + @override + Future inflightCount(String queue) async => inflightCountValue; + + @override + bool get supportsDelayed => false; + + @override + bool get supportsPriority => false; + + @override + dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation); +} + +class _FakeResultBackend implements ResultBackend { + _FakeResultBackend({ + required this.page, + required this.heartbeats, + this.onListTaskStatuses, + }); + + TaskStatusPage page; + List heartbeats; + Future Function(TaskStatusListRequest request)? + onListTaskStatuses; + + @override + Future listTaskStatuses(TaskStatusListRequest request) async { + final callback = onListTaskStatuses; + if (callback != null) { + return callback(request); + } + return page; + } + + @override + Future> listWorkerHeartbeats() async => heartbeats; + + @override + Stream watch(String taskId) => const Stream.empty(); + + @override + dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation); +} + +void main() { + group('StemFlutterQueueMonitor', () { + test('refresh maps jobs and marks fresh heartbeats as running', () async { + final backend = _FakeResultBackend( + page: TaskStatusPage( + items: [ + TaskStatusRecord( + status: TaskStatus( + id: 'job-older', + state: TaskState.failed, + attempt: 1, + error: const TaskError(type: 'StateError', message: 'boom'), + ), + createdAt: DateTime.utc(2026, 4, 20, 12), + updatedAt: DateTime.utc(2026, 4, 20, 12, 0, 1), + ), + TaskStatusRecord( + status: TaskStatus( + id: 'job-newer', + state: TaskState.succeeded, + attempt: 1, + payload: 'done', + meta: const {'label': 'Thumbnail job'}, + ), + createdAt: DateTime.utc(2026, 4, 20, 12), + updatedAt: DateTime.utc(2026, 4, 20, 12, 0, 2), + ), + ], + ), + heartbeats: [ + WorkerHeartbeat( + workerId: 'worker-a', + timestamp: DateTime.now().toUtc().subtract( + const Duration(milliseconds: 200), + ), + isolateCount: 1, + inflight: 1, + queues: [QueueHeartbeat(name: 'jobs', inflight: 1)], + ), + ], + ); + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: _FakeBroker(pendingCountValue: 3, inflightCountValue: 1), + queueName: 'jobs', + workerId: 'worker-a', + heartbeatInterval: const Duration(seconds: 10), + ); + addTearDown(monitor.dispose); + + await monitor.refresh(); + + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.running); + expect(monitor.snapshot.pendingCount, 3); + expect(monitor.snapshot.inflightCount, 1); + expect( + monitor.snapshot.workerDetailPreview, + matches(RegExp(r'^Heartbeat \d{2}:\d{2}:\d{2}$')), + ); + expect( + monitor.snapshot.jobs.map((job) => job.taskId), + orderedEquals(['job-newer', 'job-older']), + ); + expect(monitor.snapshot.jobs.first.label, 'Thumbnail job'); + expect(monitor.snapshot.jobs.first.result, 'done'); + expect(monitor.snapshot.jobs.last.errorMessage, 'boom'); + }); + + test('refresh stringifies non-string payloads safely', () async { + final backend = _FakeResultBackend( + page: TaskStatusPage( + items: [ + TaskStatusRecord( + status: TaskStatus( + id: 'job-json', + state: TaskState.succeeded, + attempt: 1, + payload: const {'ok': true}, + ), + createdAt: DateTime.utc(2026, 4, 20, 12), + updatedAt: DateTime.utc(2026, 4, 20, 12, 0, 1), + ), + ], + ), + heartbeats: [ + WorkerHeartbeat( + workerId: 'worker-a', + timestamp: DateTime.now().toUtc().subtract( + const Duration(milliseconds: 200), + ), + isolateCount: 1, + inflight: 0, + queues: const [], + ), + ], + ); + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: _FakeBroker(pendingCountValue: 0, inflightCountValue: 0), + queueName: 'jobs', + workerId: 'worker-a', + heartbeatInterval: const Duration(seconds: 10), + ); + addTearDown(monitor.dispose); + + await monitor.refresh(); + + expect(monitor.snapshot.jobs.single.result, '{ok: true}'); + }); + + test('refresh marks stale heartbeats as waiting', () async { + final backend = _FakeResultBackend( + page: const TaskStatusPage(items: []), + heartbeats: [ + WorkerHeartbeat( + workerId: 'worker-a', + timestamp: DateTime.now().toUtc().subtract( + const Duration(seconds: 5), + ), + isolateCount: 1, + inflight: 0, + queues: const [], + ), + ], + ); + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: _FakeBroker(pendingCountValue: 0, inflightCountValue: 0), + queueName: 'jobs', + workerId: 'worker-a', + heartbeatInterval: const Duration(seconds: 1), + ); + addTearDown(monitor.dispose); + + await monitor.refresh(); + + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.waiting); + expect( + monitor.snapshot.workerDetailPreview, + startsWith('Last heartbeat '), + ); + }); + + test('fatal worker signals are preserved across refreshes', () async { + final backend = _FakeResultBackend( + page: const TaskStatusPage(items: []), + heartbeats: [ + WorkerHeartbeat( + workerId: 'worker-a', + timestamp: DateTime.now().toUtc().subtract( + const Duration(milliseconds: 200), + ), + isolateCount: 1, + inflight: 0, + queues: const [], + ), + ], + ); + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: _FakeBroker(pendingCountValue: 0, inflightCountValue: 0), + queueName: 'jobs', + workerId: 'worker-a', + heartbeatInterval: const Duration(seconds: 10), + ); + final signals = StreamController(); + addTearDown(() async { + await signals.close(); + await monitor.dispose(); + }); + + await monitor.bindWorkerSignals(signals.stream); + signals.add(const StemFlutterWorkerSignal.fatal('database locked')); + await Future.delayed(const Duration(milliseconds: 10)); + + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.error); + expect(monitor.snapshot.workerDetail, 'database locked'); + + await monitor.refresh(); + + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.error); + expect(monitor.snapshot.workerDetail, 'database locked'); + }); + + test('start can recover after an initial refresh failure', () async { + var attempts = 0; + final backend = _FakeResultBackend( + page: const TaskStatusPage(items: []), + heartbeats: const [], + onListTaskStatuses: (_) async { + attempts += 1; + if (attempts == 1) { + throw StateError('temporary backend outage'); + } + return const TaskStatusPage(items: []); + }, + ); + final monitor = StemFlutterQueueMonitor( + backend: backend, + broker: _FakeBroker(pendingCountValue: 0, inflightCountValue: 0), + queueName: 'jobs', + workerId: 'worker-a', + ); + addTearDown(monitor.dispose); + + await expectLater(monitor.start(), throwsStateError); + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.error); + expect( + monitor.snapshot.workerDetail, + contains('temporary backend outage'), + ); + + await monitor.start(); + + expect(monitor.snapshot.workerStatus, StemFlutterWorkerStatus.starting); + expect(monitor.snapshot.workerDetail, isNull); + }); + }); +} diff --git a/packages/stem_flutter/test/stem_flutter_queue_snapshot_test.dart b/packages/stem_flutter/test/stem_flutter_queue_snapshot_test.dart new file mode 100644 index 00000000..cbe71335 --- /dev/null +++ b/packages/stem_flutter/test/stem_flutter_queue_snapshot_test.dart @@ -0,0 +1,56 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; + +void main() { + test('workerDetailPreview returns the first trimmed line', () { + final snapshot = StemFlutterQueueSnapshot( + workerStatus: StemFlutterWorkerStatus.running, + workerDetail: ' Worker healthy \nsecond line', + jobs: [ + StemFlutterTrackedJob( + taskId: 'job-1', + label: 'Job 1', + state: TaskState.succeeded, + updatedAt: DateTime.utc(2026, 4, 20, 12), + ), + ], + ); + + expect(snapshot.workerDetailPreview, 'Worker healthy'); + }); + + test('copyWith can clear the worker detail', () { + const snapshot = StemFlutterQueueSnapshot( + workerStatus: StemFlutterWorkerStatus.waiting, + workerDetail: 'Last heartbeat 12:00:00', + ); + + final updated = snapshot.copyWith( + workerStatus: StemFlutterWorkerStatus.running, + clearWorkerDetail: true, + ); + + expect(updated.workerStatus, StemFlutterWorkerStatus.running); + expect(updated.workerDetail, isNull); + }); + + test('copyWith can clear nullable queue metrics', () { + final snapshot = StemFlutterQueueSnapshot( + workerStatus: StemFlutterWorkerStatus.running, + lastHeartbeatAt: DateTime.utc(2026, 4, 20, 12), + pendingCount: 2, + inflightCount: 1, + ); + + final updated = snapshot.copyWith( + clearLastHeartbeatAt: true, + clearPendingCount: true, + clearInflightCount: true, + ); + + expect(updated.lastHeartbeatAt, isNull); + expect(updated.pendingCount, isNull); + expect(updated.inflightCount, isNull); + }); +} diff --git a/packages/stem_flutter/test/stem_flutter_worker_host_test.dart b/packages/stem_flutter/test/stem_flutter_worker_host_test.dart new file mode 100644 index 00000000..87b8dee2 --- /dev/null +++ b/packages/stem_flutter/test/stem_flutter_worker_host_test.dart @@ -0,0 +1,105 @@ +import 'dart:isolate'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem_flutter/stem_flutter.dart'; + +Future _readyWorkerEntry(SendPort sendPort) async { + final commands = ReceivePort(); + await Future.delayed(const Duration(milliseconds: 20)); + sendPort.send( + StemFlutterWorkerSignal.ready( + commandPort: commands.sendPort, + detail: 'ready', + ).toMessage(), + ); + + await for (final message in commands) { + if (message is Map && message['type'] == 'shutdown') { + sendPort.send( + const StemFlutterWorkerSignal.status( + status: StemFlutterWorkerStatus.stopped, + detail: 'shutdown', + ).toMessage(), + ); + commands.close(); + return; + } + } +} + +Future _failingWorkerEntry(SendPort _) async { + await Future.delayed(const Duration(milliseconds: 20)); + throw StateError('boom'); +} + +void main() { + group('StemFlutterWorkerHost', () { + test('captures ready signals and forwards shutdown requests', () async { + final host = await StemFlutterWorkerHost.spawn( + entrypoint: _readyWorkerEntry, + messageBuilder: (sendPort) => sendPort, + ); + addTearDown(host.dispose); + + final ready = await host.signals + .firstWhere( + (signal) => signal.type == StemFlutterWorkerSignalType.ready, + ) + .timeout(const Duration(seconds: 2)); + + expect(ready.detail, 'ready'); + expect(ready.commandPort, isNotNull); + expect(host.commandPort, isNotNull); + + final stoppedFuture = host.signals + .firstWhere( + (signal) => + signal.type == StemFlutterWorkerSignalType.status && + signal.status == StemFlutterWorkerStatus.stopped && + signal.detail == 'shutdown', + ) + .timeout(const Duration(seconds: 2)); + + await host.requestShutdown(gracePeriod: Duration.zero); + + final stopped = await stoppedFuture; + expect(stopped.status, StemFlutterWorkerStatus.stopped); + expect(stopped.detail, 'shutdown'); + }); + + test('reports isolate failures as fatal signals', () async { + final host = await StemFlutterWorkerHost.spawn( + entrypoint: _failingWorkerEntry, + messageBuilder: (sendPort) => sendPort, + ); + addTearDown(host.dispose); + + final fatal = await host.signals + .firstWhere( + (signal) => signal.type == StemFlutterWorkerSignalType.fatal, + ) + .timeout(const Duration(seconds: 2)); + + expect(fatal.message, contains('Bad state: boom')); + }); + + test('replays the latest signal to late subscribers', () async { + final host = await StemFlutterWorkerHost.spawn( + entrypoint: _readyWorkerEntry, + messageBuilder: (sendPort) => sendPort, + ); + addTearDown(host.dispose); + + await Future.delayed(const Duration(milliseconds: 60)); + + final ready = await host.signals + .firstWhere( + (signal) => signal.type == StemFlutterWorkerSignalType.ready, + ) + .timeout(const Duration(seconds: 2)); + + expect(ready.detail, 'ready'); + expect(ready.commandPort, isNotNull); + }); + }); +} diff --git a/packages/stem_flutter/test/stem_flutter_worker_signal_test.dart b/packages/stem_flutter/test/stem_flutter_worker_signal_test.dart new file mode 100644 index 00000000..ae54f72a --- /dev/null +++ b/packages/stem_flutter/test/stem_flutter_worker_signal_test.dart @@ -0,0 +1,53 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem_flutter/stem_flutter.dart'; + +void main() { + group('StemFlutterWorkerSignal', () { + test('round-trips status messages', () { + const signal = StemFlutterWorkerSignal.status( + status: StemFlutterWorkerStatus.waiting, + detail: 'Last heartbeat 10:00:00', + ); + + final parsed = StemFlutterWorkerSignal.tryParse(signal.toMessage()); + + expect(parsed, isNotNull); + expect(parsed!.type, StemFlutterWorkerSignalType.status); + expect(parsed.status, StemFlutterWorkerStatus.waiting); + expect(parsed.detail, 'Last heartbeat 10:00:00'); + }); + + test('parses fatal compatibility messages', () { + final parsed = StemFlutterWorkerSignal.tryParse({ + 'type': 'error', + 'error': 'database locked', + }); + + expect(parsed, isNotNull); + expect(parsed!.type, StemFlutterWorkerSignalType.fatal); + expect(parsed.message, 'database locked'); + }); + + test('ignores malformed ready command ports', () { + final parsed = StemFlutterWorkerSignal.tryParse({ + 'type': 'ready', + 'sendPort': 'not-a-port', + 'detail': 'ready', + }); + + expect(parsed, isNotNull); + expect(parsed!.type, StemFlutterWorkerSignalType.ready); + expect(parsed.commandPort, isNull); + expect(parsed.detail, 'ready'); + }); + + test('ignores unknown status enum values', () { + final parsed = StemFlutterWorkerSignal.tryParse({ + 'type': 'status', + 'state': 'paused', + }); + + expect(parsed, isNull); + }); + }); +} diff --git a/packages/stem_flutter_sqlite/CHANGELOG.md b/packages/stem_flutter_sqlite/CHANGELOG.md new file mode 100644 index 00000000..4d899bff --- /dev/null +++ b/packages/stem_flutter_sqlite/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 0.1.0 + +- Initial Flutter SQLite adapter helpers for Stem. diff --git a/packages/stem_flutter_sqlite/README.md b/packages/stem_flutter_sqlite/README.md new file mode 100644 index 00000000..6e962926 --- /dev/null +++ b/packages/stem_flutter_sqlite/README.md @@ -0,0 +1,172 @@ +# stem_flutter_sqlite + +SQLite-specific Flutter helpers for Stem. + +This package builds on `stem_flutter` and handles the SQLite pieces that are +awkward to repeat in every mobile app: + +- resolving an application-owned storage layout +- opening a foreground Stem runtime backed by SQLite files +- preloading and forwarding the Flutter assets needed by background isolates +- reconstructing broker and backend handles inside a worker isolate +- providing a convenience launcher for SQLite worker isolates + +Use this package when you want a single-device or local-first Flutter setup +with Stem and SQLite. + +## Installation + +```yaml +dependencies: + stem_flutter_sqlite: ^0.1.0 +``` + +`stem_flutter_sqlite` depends on `stem_flutter`, `stem_sqlite`, and +`path_provider`. + +## What This Package Includes + +- `StemFlutterStorageLayout`: resolves broker and backend files under an + application-owned directory +- `StemFlutterSqliteRuntime`: opens the foreground broker, backend, and Stem + producer runtime +- `StemFlutterSqliteWorkerBootstrap`: isolate-safe bootstrap payload for worker + isolates +- `StemFlutterSqliteWorkerStores`: reopens the worker-side SQLite stores from + the bootstrap payload +- `StemFlutterSqliteWorkerLauncher`: convenience wrapper around + `StemFlutterWorkerHost.spawn(...)` + +The package also handles the internal Flutter dependency bootstrap needed by +`time_machine2`. There is no separate public time-machine setup API to wire by +hand. + +## Recommended Runtime Model + +For mobile apps, the intended setup is: + +1. The UI isolate opens a `StemFlutterSqliteRuntime`. +2. A separate worker isolate reopens the broker and result backend using + `StemFlutterSqliteWorkerBootstrap`. +3. The UI uses `StemFlutterQueueMonitor` from `stem_flutter` to observe queue + depth, recent jobs, and worker heartbeats. +4. The broker and result backend live in separate SQLite files to reduce write + contention. + +## Quick Start + +### UI isolate + +```dart +import 'package:flutter/widgets.dart'; +import 'package:flutter/services.dart'; +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +Future bootstrap(List> taskHandlers) async { + WidgetsFlutterBinding.ensureInitialized(); + + final layout = await StemFlutterStorageLayout.applicationSupport( + directoryName: 'stem_mobile_demo', + ); + + final runtime = await StemFlutterSqliteRuntime.open( + layout: layout, + tasks: taskHandlers, + brokerPollInterval: const Duration(milliseconds: 250), + brokerVisibilityTimeout: const Duration(seconds: 6), + ); + + final rootIsolateToken = RootIsolateToken.instance!; + final workerHost = await StemFlutterSqliteWorkerLauncher.spawn( + entrypoint: workerMain, + layout: layout, + rootIsolateToken: rootIsolateToken, + brokerPollInterval: const Duration(milliseconds: 250), + brokerSweeperInterval: const Duration(seconds: 2), + brokerVisibilityTimeout: const Duration(seconds: 6), + ); + + final monitor = StemFlutterQueueMonitor( + backend: runtime.backend, + broker: runtime.broker, + queueName: 'mobile-demo', + workerId: 'mobile-worker', + ); + await monitor.bindWorkerSignals(workerHost.signals); + + await monitor.start(); +} +``` + +### Worker isolate + +```dart +import 'dart:isolate'; + +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +// Assume taskHandlers is the same List> your UI isolate +// uses when opening StemFlutterSqliteRuntime. +Future workerMain(Map message) async { + final bootstrap = StemFlutterSqliteWorkerBootstrap.fromMessage(message); + await bootstrap.initializeBackgroundDependencies(); + + final stores = await StemFlutterSqliteWorkerStores.open(bootstrap); + final commands = ReceivePort(); + + final worker = Worker( + broker: stores.broker, + backend: stores.backend, + tasks: taskHandlers, + queue: 'mobile-demo', + consumerName: 'mobile-worker', + ); + + try { + await worker.start(); + bootstrap.sendPort.send( + StemFlutterWorkerSignal.ready( + commandPort: commands.sendPort, + detail: 'Worker isolate ready.', + ).toMessage(), + ); + + await for (final dynamic command in commands) { + if (command is Map && command['type'] == 'shutdown') { + break; + } + } + } finally { + await worker.shutdown(); + await stores.close(); + commands.close(); + } +} +``` + +## Mobile Notes + +- Run the worker in a separate isolate. On mobile, that is the main reason this + package exists. +- Keep the broker and result backend in separate SQLite files. A single file + works for toy setups, but contention becomes much easier to hit. +- If you hot-restart while work is inflight, the broker may need one + visibility-timeout cycle before a task is claimable again. +- `SqliteResultBackend.watch(taskId)` is process-local. For UI monitoring, poll + `getTaskStatus()` or `listTaskStatuses()` instead. +- This package does not provide OS-managed background scheduling. If you need + true background execution, pair Stem with a platform-specific job runner. + +## Example + +See `packages/stem/example/flutter_stem_example` for a complete working app +that uses: + +- `StemFlutterStorageLayout` +- `StemFlutterSqliteRuntime` +- `StemFlutterSqliteWorkerLauncher` +- `StemFlutterQueueMonitor` diff --git a/packages/stem_flutter_sqlite/analysis_options.yaml b/packages/stem_flutter_sqlite/analysis_options.yaml new file mode 100644 index 00000000..9df80aa4 --- /dev/null +++ b/packages/stem_flutter_sqlite/analysis_options.yaml @@ -0,0 +1 @@ +include: package:very_good_analysis/analysis_options.yaml diff --git a/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_runtime.dart b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_runtime.dart new file mode 100644 index 00000000..62073abd --- /dev/null +++ b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_runtime.dart @@ -0,0 +1,65 @@ +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/src/runtime/stem_flutter_storage_layout.dart'; +import 'package:stem_sqlite/stem_sqlite.dart'; + +/// Foreground Stem runtime backed by SQLite files resolved for Flutter. +/// +/// This runtime opens the SQLite broker and result backend, initializes the +/// Flutter-side dependency bootstrap, and exposes a producer-ready [Stem] +/// instance for enqueueing work from the UI isolate. +class StemFlutterSqliteRuntime { + StemFlutterSqliteRuntime._({ + required this.layout, + required this.broker, + required this.backend, + required this.stem, + }); + + /// Storage layout used by the runtime. + final StemFlutterStorageLayout layout; + + /// The broker owned by this runtime. + final SqliteBroker broker; + + /// The result backend owned by this runtime. + final SqliteResultBackend backend; + + /// The foreground [Stem] client used to enqueue work. + final Stem stem; + + /// Opens a foreground runtime using the provided [layout]. + static Future open({ + required StemFlutterStorageLayout layout, + required List> tasks, + Duration brokerVisibilityTimeout = const Duration(seconds: 6), + Duration brokerPollInterval = const Duration(milliseconds: 250), + Duration producerSweeperInterval = Duration.zero, + Duration backendCleanupInterval = const Duration(days: 3650), + }) async { + await ensureStemFlutterDependenciesInitialized(); + final broker = await SqliteBroker.open( + layout.brokerFile, + defaultVisibilityTimeout: brokerVisibilityTimeout, + pollInterval: brokerPollInterval, + sweeperInterval: producerSweeperInterval, + ); + final backend = await SqliteResultBackend.open( + layout.backendFile, + cleanupInterval: backendCleanupInterval, + ); + final stem = Stem(broker: broker, tasks: tasks); + return StemFlutterSqliteRuntime._( + layout: layout, + broker: broker, + backend: backend, + stem: stem, + ); + } + + /// Closes this runtime and releases all owned resources. + Future close() async { + await stem.close(); + await backend.close(); + } +} diff --git a/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_bootstrap.dart b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_bootstrap.dart new file mode 100644 index 00000000..4aef5718 --- /dev/null +++ b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_bootstrap.dart @@ -0,0 +1,124 @@ +import 'dart:io'; +import 'dart:isolate'; + +import 'package:flutter/services.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_sqlite/stem_sqlite.dart'; + +/// Serializable bootstrap payload for a Flutter SQLite worker isolate. +/// +/// This payload contains the file paths and dependency assets needed to reopen +/// SQLite stores inside a background isolate. +class StemFlutterSqliteWorkerBootstrap { + /// Creates a worker bootstrap payload. + const StemFlutterSqliteWorkerBootstrap({ + required this.sendPort, + required this.rootIsolateToken, + required this.brokerPath, + required this.backendPath, + required this.timeMachineAssets, + required this.brokerPollInterval, + required this.brokerSweeperInterval, + required this.brokerVisibilityTimeout, + }); + + /// Decodes an isolate-safe message into a strongly-typed payload. + factory StemFlutterSqliteWorkerBootstrap.fromMessage( + Map message, + ) { + return StemFlutterSqliteWorkerBootstrap( + sendPort: message['sendPort']! as SendPort, + rootIsolateToken: message['rootIsolateToken']! as RootIsolateToken, + brokerPath: message['brokerPath']! as String, + backendPath: message['backendPath']! as String, + timeMachineAssets: + (message['timeMachineAssets']! as Map) + .cast(), + brokerPollInterval: Duration( + milliseconds: message['brokerPollIntervalMs']! as int, + ), + brokerSweeperInterval: Duration( + milliseconds: message['brokerSweeperIntervalMs']! as int, + ), + brokerVisibilityTimeout: Duration( + milliseconds: message['brokerVisibilityTimeoutMs']! as int, + ), + ); + } + + /// The signal port owned by the UI isolate. + final SendPort sendPort; + + /// The root isolate token required by Flutter background isolates. + final RootIsolateToken rootIsolateToken; + + /// The path to the broker SQLite file. + final String brokerPath; + + /// The path to the backend SQLite file. + final String backendPath; + + /// The preloaded `time_machine2` binary assets. + final Map timeMachineAssets; + + /// The poll interval used by the worker broker. + final Duration brokerPollInterval; + + /// The sweeper interval used by the worker broker. + final Duration brokerSweeperInterval; + + /// The default visibility timeout used by the worker broker. + final Duration brokerVisibilityTimeout; + + /// Encodes this payload into an isolate-safe message. + Map toMessage() => { + 'sendPort': sendPort, + 'rootIsolateToken': rootIsolateToken, + 'brokerPath': brokerPath, + 'backendPath': backendPath, + 'timeMachineAssets': timeMachineAssets, + 'brokerPollIntervalMs': brokerPollInterval.inMilliseconds, + 'brokerSweeperIntervalMs': brokerSweeperInterval.inMilliseconds, + 'brokerVisibilityTimeoutMs': brokerVisibilityTimeout.inMilliseconds, + }; + + /// Prepares Flutter platform channels and dependencies in the isolate. + Future initializeBackgroundDependencies() async { + BackgroundIsolateBinaryMessenger.ensureInitialized(rootIsolateToken); + await initializeStemFlutterBackgroundDependencies(timeMachineAssets); + } +} + +/// SQLite stores opened inside a Flutter worker isolate. +class StemFlutterSqliteWorkerStores { + StemFlutterSqliteWorkerStores._({ + required this.broker, + required this.backend, + }); + + /// The broker used by the worker isolate. + final SqliteBroker broker; + + /// The result backend used by the worker isolate. + final SqliteResultBackend backend; + + /// Opens worker stores from a bootstrap payload. + static Future open( + StemFlutterSqliteWorkerBootstrap bootstrap, + ) async { + final broker = await SqliteBroker.open( + File(bootstrap.brokerPath), + defaultVisibilityTimeout: bootstrap.brokerVisibilityTimeout, + pollInterval: bootstrap.brokerPollInterval, + sweeperInterval: bootstrap.brokerSweeperInterval, + ); + final backend = await SqliteResultBackend.open(File(bootstrap.backendPath)); + return StemFlutterSqliteWorkerStores._(broker: broker, backend: backend); + } + + /// Closes all opened stores. + Future close() async { + await backend.close(); + await broker.close(); + } +} diff --git a/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_launcher.dart b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_launcher.dart new file mode 100644 index 00000000..ebef1457 --- /dev/null +++ b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_sqlite_worker_launcher.dart @@ -0,0 +1,40 @@ +import 'dart:async'; + +import 'package:flutter/services.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/src/runtime/stem_flutter_sqlite_worker_bootstrap.dart'; +import 'package:stem_flutter_sqlite/src/runtime/stem_flutter_storage_layout.dart'; + +/// Convenience helpers for spawning SQLite-backed Flutter worker isolates. +/// +/// This type bridges the generic [StemFlutterWorkerHost] API with the +/// SQLite-specific bootstrap payload used by worker isolates. +abstract final class StemFlutterSqliteWorkerLauncher { + /// Spawns a worker isolate using the SQLite bootstrap payload. + static Future spawn({ + required FutureOr Function(Map message) entrypoint, + required StemFlutterStorageLayout layout, + required RootIsolateToken rootIsolateToken, + required Duration brokerPollInterval, + required Duration brokerSweeperInterval, + required Duration brokerVisibilityTimeout, + }) async { + final dependencyAssets = await preloadStemFlutterDependencyAssets(); + return StemFlutterWorkerHost.spawn>( + entrypoint: entrypoint, + messageBuilder: (sendPort) { + final bootstrap = StemFlutterSqliteWorkerBootstrap( + sendPort: sendPort, + rootIsolateToken: rootIsolateToken, + brokerPath: layout.brokerFile.path, + backendPath: layout.backendFile.path, + timeMachineAssets: dependencyAssets, + brokerPollInterval: brokerPollInterval, + brokerSweeperInterval: brokerSweeperInterval, + brokerVisibilityTimeout: brokerVisibilityTimeout, + ); + return bootstrap.toMessage(); + }, + ); + } +} diff --git a/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_storage_layout.dart b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_storage_layout.dart new file mode 100644 index 00000000..b95d30fa --- /dev/null +++ b/packages/stem_flutter_sqlite/lib/src/runtime/stem_flutter_storage_layout.dart @@ -0,0 +1,69 @@ +import 'dart:io'; + +import 'package:path_provider/path_provider.dart'; + +/// File layout for a Flutter-hosted Stem SQLite runtime. +/// +/// Use this type to keep the broker and result backend in separate files while +/// still resolving them from a single application-owned directory. +class StemFlutterStorageLayout { + /// Creates a storage layout rooted at [root]. + const StemFlutterStorageLayout({ + required this.root, + required this.brokerFile, + required this.backendFile, + }); + + /// Root directory that holds Stem runtime files. + final Directory root; + + /// SQLite file used by the broker. + final File brokerFile; + + /// SQLite file used by the result backend. + final File backendFile; + + /// Resolves a layout under Flutter's application support directory. + static Future applicationSupport({ + String directoryName = 'stem_flutter', + String brokerFileName = 'broker.sqlite', + String backendFileName = 'backend.sqlite', + }) async { + final baseDirectory = await getApplicationSupportDirectory(); + final root = Directory( + '${baseDirectory.path}${Platform.pathSeparator}$directoryName', + ); + return forRoot( + root, + brokerFileName: brokerFileName, + backendFileName: backendFileName, + ); + } + + /// Creates a layout from an explicit [root] directory. + static Future forRoot( + Directory root, { + String brokerFileName = 'broker.sqlite', + String backendFileName = 'backend.sqlite', + }) async { + final brokerFile = File( + '${root.path}${Platform.pathSeparator}$brokerFileName', + ); + final backendFile = File( + '${root.path}${Platform.pathSeparator}$backendFileName', + ); + if (brokerFile.absolute.path == backendFile.absolute.path) { + throw ArgumentError.value( + backendFileName, + 'backendFileName', + 'must resolve to a different file than brokerFileName', + ); + } + await root.create(recursive: true); + return StemFlutterStorageLayout( + root: root, + brokerFile: brokerFile, + backendFile: backendFile, + ); + } +} diff --git a/packages/stem_flutter_sqlite/lib/stem_flutter_sqlite.dart b/packages/stem_flutter_sqlite/lib/stem_flutter_sqlite.dart new file mode 100644 index 00000000..49264c19 --- /dev/null +++ b/packages/stem_flutter_sqlite/lib/stem_flutter_sqlite.dart @@ -0,0 +1,15 @@ +/// SQLite adapter helpers for hosting Stem runtimes from Flutter. +/// +/// This library layers SQLite-specific storage and worker bootstrap logic on +/// top of the generic `StemFlutterWorkerHost` support provided by +/// `package:stem_flutter/stem_flutter.dart`. +library; + +export 'src/runtime/stem_flutter_sqlite_runtime.dart' + show StemFlutterSqliteRuntime; +export 'src/runtime/stem_flutter_sqlite_worker_bootstrap.dart' + show StemFlutterSqliteWorkerBootstrap, StemFlutterSqliteWorkerStores; +export 'src/runtime/stem_flutter_sqlite_worker_launcher.dart' + show StemFlutterSqliteWorkerLauncher; +export 'src/runtime/stem_flutter_storage_layout.dart' + show StemFlutterStorageLayout; diff --git a/packages/stem_flutter_sqlite/pubspec.yaml b/packages/stem_flutter_sqlite/pubspec.yaml new file mode 100644 index 00000000..66cf8d9e --- /dev/null +++ b/packages/stem_flutter_sqlite/pubspec.yaml @@ -0,0 +1,25 @@ +name: stem_flutter_sqlite +description: SQLite adapter helpers for Flutter-hosted Stem runtimes. +version: 0.1.0 +repository: https://github.com/kingwill101/stem/tree/master/packages/stem_flutter_sqlite +issue_tracker: https://github.com/kingwill101/stem/issues +resolution: workspace + +environment: + sdk: ^3.9.2 + +dependencies: + flutter: + sdk: flutter + path_provider: ^2.1.5 + stem: ">=0.2.0-dev <0.3.0" + stem_flutter: ">=0.1.0 <0.2.0" + stem_sqlite: ">=0.1.1 <0.2.0" + +dev_dependencies: + flutter_test: + sdk: flutter + very_good_analysis: ^10.0.0 + +flutter: + uses-material-design: false diff --git a/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_runtime_test.dart b/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_runtime_test.dart new file mode 100644 index 00000000..6fcb2ea0 --- /dev/null +++ b/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_runtime_test.dart @@ -0,0 +1,114 @@ +import 'dart:io'; +import 'dart:isolate'; + +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem/stem.dart'; +import 'package:stem_flutter/stem_flutter.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +Future _sqliteLauncherEntry(Map message) async { + final bootstrap = StemFlutterSqliteWorkerBootstrap.fromMessage(message); + final commands = ReceivePort(); + await Future.delayed(const Duration(milliseconds: 20)); + bootstrap.sendPort.send( + StemFlutterWorkerSignal.ready(commandPort: commands.sendPort).toMessage(), + ); + await Future.delayed(const Duration(milliseconds: 20)); + bootstrap.sendPort.send( + StemFlutterWorkerSignal.status( + status: StemFlutterWorkerStatus.running, + detail: + '${bootstrap.brokerPath}|${bootstrap.backendPath}|' + '${bootstrap.timeMachineAssets.length}', + ).toMessage(), + ); + + await for (final command in commands) { + if (command is Map && command['type'] == 'shutdown') { + commands.close(); + return; + } + } +} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('StemFlutterSqliteRuntime', () { + test( + 'open creates a foreground runtime backed by separate sqlite files', + () async { + final sandbox = await Directory.systemTemp.createTemp( + 'stem_flutter_sqlite_runtime_test_', + ); + addTearDown(() => sandbox.delete(recursive: true)); + + final layout = await StemFlutterStorageLayout.forRoot( + Directory('${sandbox.path}${Platform.pathSeparator}runtime'), + ); + final runtime = await StemFlutterSqliteRuntime.open( + layout: layout, + tasks: const >[], + ); + addTearDown(runtime.close); + + expect(runtime.layout.root.path, layout.root.path); + expect(layout.brokerFile.existsSync(), isTrue); + expect(layout.backendFile.existsSync(), isTrue); + expect(runtime.broker, isNotNull); + expect(runtime.backend, isNotNull); + expect(runtime.stem, isNotNull); + }, + ); + + test( + 'launcher forwards sqlite bootstrap details into the worker isolate', + () async { + final sandbox = await Directory.systemTemp.createTemp( + 'stem_flutter_sqlite_launcher_test_', + ); + addTearDown(() => sandbox.delete(recursive: true)); + + final layout = await StemFlutterStorageLayout.forRoot( + Directory('${sandbox.path}${Platform.pathSeparator}runtime'), + ); + final rootToken = RootIsolateToken.instance; + expect(rootToken, isNotNull); + + final host = await StemFlutterSqliteWorkerLauncher.spawn( + entrypoint: _sqliteLauncherEntry, + layout: layout, + rootIsolateToken: rootToken!, + brokerPollInterval: const Duration(milliseconds: 250), + brokerSweeperInterval: const Duration(seconds: 2), + brokerVisibilityTimeout: const Duration(seconds: 6), + ); + addTearDown(host.dispose); + + final readyFuture = host.signals + .firstWhere( + (signal) => signal.type == StemFlutterWorkerSignalType.ready, + ) + .timeout(const Duration(seconds: 5)); + final runningFuture = host.signals + .firstWhere( + (signal) => + signal.type == StemFlutterWorkerSignalType.status && + signal.status == StemFlutterWorkerStatus.running, + ) + .timeout(const Duration(seconds: 5)); + + final ready = await readyFuture; + expect(ready.commandPort, isNotNull); + + final running = await runningFuture; + + final detailParts = running.detail!.split('|'); + expect(detailParts[0], layout.brokerFile.path); + expect(detailParts[1], layout.backendFile.path); + expect(int.parse(detailParts[2]), greaterThanOrEqualTo(2)); + }, + ); + }); +} diff --git a/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_worker_bootstrap_test.dart b/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_worker_bootstrap_test.dart new file mode 100644 index 00000000..897e3b0e --- /dev/null +++ b/packages/stem_flutter_sqlite/test/stem_flutter_sqlite_worker_bootstrap_test.dart @@ -0,0 +1,51 @@ +import 'dart:isolate'; + +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test( + 'round-trips bootstrap payloads through isolate-safe messages', + () async { + final port = ReceivePort(); + addTearDown(port.close); + + final rootToken = RootIsolateToken.instance; + expect(rootToken, isNotNull); + + final bootstrap = StemFlutterSqliteWorkerBootstrap( + sendPort: port.sendPort, + rootIsolateToken: rootToken!, + brokerPath: '/tmp/broker.sqlite', + backendPath: '/tmp/backend.sqlite', + timeMachineAssets: { + 'cultures/cultures.bin': Uint8List.fromList([1, 2]), + 'tzdb/tzdb.bin': Uint8List.fromList([3, 4, 5]), + }, + brokerPollInterval: const Duration(milliseconds: 250), + brokerSweeperInterval: const Duration(seconds: 2), + brokerVisibilityTimeout: const Duration(seconds: 6), + ); + + final decoded = StemFlutterSqliteWorkerBootstrap.fromMessage( + bootstrap.toMessage(), + ); + decoded.sendPort.send('ping'); + + expect(await port.first, 'ping'); + expect(decoded.rootIsolateToken, same(rootToken)); + expect(decoded.brokerPath, '/tmp/broker.sqlite'); + expect(decoded.backendPath, '/tmp/backend.sqlite'); + expect( + decoded.timeMachineAssets['tzdb/tzdb.bin'], + orderedEquals(Uint8List.fromList([3, 4, 5])), + ); + expect(decoded.brokerPollInterval, const Duration(milliseconds: 250)); + expect(decoded.brokerSweeperInterval, const Duration(seconds: 2)); + expect(decoded.brokerVisibilityTimeout, const Duration(seconds: 6)); + }, + ); +} diff --git a/packages/stem_flutter_sqlite/test/stem_flutter_storage_layout_test.dart b/packages/stem_flutter_sqlite/test/stem_flutter_storage_layout_test.dart new file mode 100644 index 00000000..5f310b75 --- /dev/null +++ b/packages/stem_flutter_sqlite/test/stem_flutter_storage_layout_test.dart @@ -0,0 +1,50 @@ +import 'dart:io'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:stem_flutter_sqlite/stem_flutter_sqlite.dart'; + +void main() { + test( + 'forRoot creates the directory and resolves broker/backend paths', + () async { + final sandbox = await Directory.systemTemp.createTemp( + 'stem_flutter_storage_layout_test_', + ); + addTearDown(() => sandbox.delete(recursive: true)); + + final root = Directory('${sandbox.path}${Platform.pathSeparator}runtime'); + final layout = await StemFlutterStorageLayout.forRoot( + root, + brokerFileName: 'jobs.db', + backendFileName: 'results.db', + ); + + expect(layout.root.path, root.path); + expect(layout.root.existsSync(), isTrue); + expect( + layout.brokerFile.path, + '${root.path}${Platform.pathSeparator}jobs.db', + ); + expect( + layout.backendFile.path, + '${root.path}${Platform.pathSeparator}results.db', + ); + }, + ); + + test('forRoot rejects broker and backend path collisions', () async { + final sandbox = await Directory.systemTemp.createTemp( + 'stem_flutter_storage_layout_test_', + ); + addTearDown(() => sandbox.delete(recursive: true)); + + await expectLater( + StemFlutterStorageLayout.forRoot( + sandbox, + brokerFileName: 'runtime.sqlite', + backendFileName: 'runtime.sqlite', + ), + throwsArgumentError, + ); + }); +} diff --git a/packages/stem_postgres/lib/src/connection.dart b/packages/stem_postgres/lib/src/connection.dart index 8b65d06b..c8c51a33 100644 --- a/packages/stem_postgres/lib/src/connection.dart +++ b/packages/stem_postgres/lib/src/connection.dart @@ -2,6 +2,7 @@ import 'package:ormed/ormed.dart'; import 'package:stem_postgres/src/database/datasource.dart'; import 'package:stem_postgres/src/database/migrations.dart'; +import 'package:stem_postgres/src/database/postgres_migration_lock.dart'; /// Holds an active Postgres data source and query helpers. class PostgresConnections { @@ -143,16 +144,18 @@ Future _runMigrationsForDataSource(DataSource dataSource) async { await schemaDriver.setCurrentSchema(schema); } - final ledger = SqlMigrationLedger(driver, tableName: 'orm_migrations'); - await ledger.ensureInitialized(); + await withPostgresMigrationLock(driver, () async { + final ledger = SqlMigrationLedger(driver, tableName: 'orm_migrations'); + await ledger.ensureInitialized(); - final runner = MigrationRunner( - schemaDriver: schemaDriver, - ledger: ledger, - migrations: buildMigrations(), - defaultSchema: schema, - ); - await runner.applyAll(); + final runner = MigrationRunner( + schemaDriver: schemaDriver, + ledger: ledger, + migrations: buildMigrations(), + defaultSchema: schema, + ); + await runner.applyAll(); + }); } extension on PostgresConnections { diff --git a/packages/stem_postgres/lib/src/database/postgres_migration_lock.dart b/packages/stem_postgres/lib/src/database/postgres_migration_lock.dart new file mode 100644 index 00000000..43802151 --- /dev/null +++ b/packages/stem_postgres/lib/src/database/postgres_migration_lock.dart @@ -0,0 +1,20 @@ +import 'package:ormed/ormed.dart'; + +const String _migrationLockName = 'stem_postgres_migrations'; + +/// Runs [action] while holding a database-scoped Postgres advisory lock. +Future withPostgresMigrationLock( + DriverAdapter driver, + Future Function() action, +) async { + await driver.executeRaw( + "SELECT pg_advisory_lock(hashtext('$_migrationLockName'));", + ); + try { + return await action(); + } finally { + await driver.executeRaw( + "SELECT pg_advisory_unlock(hashtext('$_migrationLockName'));", + ); + } +} diff --git a/packages/stem_postgres/test/support/postgres_test_harness.dart b/packages/stem_postgres/test/support/postgres_test_harness.dart index 0d485dba..2b9dabd6 100644 --- a/packages/stem_postgres/test/support/postgres_test_harness.dart +++ b/packages/stem_postgres/test/support/postgres_test_harness.dart @@ -4,6 +4,7 @@ import 'package:ormed/ormed.dart'; import 'package:ormed_postgres/ormed_postgres.dart'; import 'package:stem_postgres/src/database/datasource.dart'; import 'package:stem_postgres/src/database/migrations.dart'; +import 'package:stem_postgres/src/database/postgres_migration_lock.dart'; /// Test harness wiring Postgres DataSource + ormedGroup isolation. class StemPostgresTestHarness { @@ -84,14 +85,16 @@ Future _runTestMigrations(DataSource dataSource) async { await schemaDriver.setCurrentSchema(schema); } - final ledger = SqlMigrationLedger(driver, tableName: 'orm_migrations'); - await ledger.ensureInitialized(); + await withPostgresMigrationLock(driver, () async { + final ledger = SqlMigrationLedger(driver, tableName: 'orm_migrations'); + await ledger.ensureInitialized(); - final runner = MigrationRunner( - schemaDriver: schemaDriver, - ledger: ledger, - migrations: buildMigrations(), - defaultSchema: schema, - ); - await runner.applyAll(); + final runner = MigrationRunner( + schemaDriver: schemaDriver, + ledger: ledger, + migrations: buildMigrations(), + defaultSchema: schema, + ); + await runner.applyAll(); + }); } diff --git a/packages/stem_sqlite/CHANGELOG.md b/packages/stem_sqlite/CHANGELOG.md index 649766dd..908e2ddc 100644 --- a/packages/stem_sqlite/CHANGELOG.md +++ b/packages/stem_sqlite/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## 0.1.3 + +- Updated `ormed_sqlite` to 0.3.0 and raised the package SDK floor to Dart + 3.10, matching the new unified native/web SQLite adapter release. +- Guarded DataSource-backed migrations before applying SQLite PRAGMAs so + non-schema drivers fail before any migration side effects. + +## 0.1.2 + +- Updated internal package constraints to accept the in-progress `stem` + prerelease and matching adapter-test prereleases during workspace + development. + ## 0.1.1 - Updated Ormed dependencies to 0.2.0, including the new split diff --git a/packages/stem_sqlite/lib/src/broker/sqlite_broker.dart b/packages/stem_sqlite/lib/src/broker/sqlite_broker.dart index 35707150..5319337d 100644 --- a/packages/stem_sqlite/lib/src/broker/sqlite_broker.dart +++ b/packages/stem_sqlite/lib/src/broker/sqlite_broker.dart @@ -508,9 +508,27 @@ class SqliteBroker implements Broker { void _startSweeper() { _sweeperTimer?.cancel(); + if (sweeperInterval <= Duration.zero) { + _sweeperTimer = null; + return; + } _sweeperTimer = Timer.periodic(sweeperInterval, (_) { if (_closed) return; - unawaited(_runSweeperCycle()); + unawaited( + _runSweeperCycle().catchError((Object error, StackTrace stackTrace) { + stemLogger.warning( + 'SQLite broker sweeper cycle failed: $error', + stemLogContext( + component: 'stem_sqlite', + subsystem: 'broker_sweeper', + fields: { + 'namespace': namespace, + 'stack': stackTrace.toString(), + }, + ), + ); + }), + ); }); } diff --git a/packages/stem_sqlite/lib/src/connection.dart b/packages/stem_sqlite/lib/src/connection.dart index 6e51ce71..82e66b42 100644 --- a/packages/stem_sqlite/lib/src/connection.dart +++ b/packages/stem_sqlite/lib/src/connection.dart @@ -6,6 +6,8 @@ import 'package:ormed_sqlite/ormed_sqlite.dart'; import 'package:stem_sqlite/orm_registry.g.dart'; import 'package:stem_sqlite/src/database/migrations.dart'; +const int _sqliteBusyTimeoutMs = 5000; + /// Holds an active SQLite data source and query helpers. class SqliteConnections { /// Wraps an existing data source without running migrations. @@ -77,8 +79,9 @@ Future _openDataSource(File file, {required bool readOnly}) async { final dataSource = buildOrmRegistry().sqliteFileDataSource(path: file.path); await dataSource.init(); + final driver = dataSource.connection.driver; + await driver.executeRaw('PRAGMA busy_timeout = $_sqliteBusyTimeoutMs;'); if (!readOnly) { - final driver = dataSource.connection.driver; await driver.executeRaw('PRAGMA journal_mode=WAL;'); await driver.executeRaw('PRAGMA synchronous=NORMAL;'); } @@ -92,6 +95,9 @@ Future _runMigrations(File file) async { final adapter = SqliteDriverAdapter.file(file.path); try { + await adapter.executeRaw('PRAGMA busy_timeout = $_sqliteBusyTimeoutMs;'); + await adapter.executeRaw('PRAGMA journal_mode=WAL;'); + await adapter.executeRaw('PRAGMA synchronous=NORMAL;'); final ledger = SqlMigrationLedger(adapter, tableName: 'orm_migrations'); await ledger.ensureInitialized(); @@ -115,6 +121,9 @@ Future _runMigrationsForDataSource(DataSource dataSource) async { throw StateError('Expected a SchemaDriver for SQLite migrations.'); } final schemaDriver = driver as SchemaDriver; + await driver.executeRaw('PRAGMA busy_timeout = $_sqliteBusyTimeoutMs;'); + await driver.executeRaw('PRAGMA journal_mode=WAL;'); + await driver.executeRaw('PRAGMA synchronous=NORMAL;'); final ledger = SqlMigrationLedger(driver, tableName: 'orm_migrations'); await ledger.ensureInitialized(); diff --git a/packages/stem_sqlite/pubspec.yaml b/packages/stem_sqlite/pubspec.yaml index cd70a607..ea448109 100644 --- a/packages/stem_sqlite/pubspec.yaml +++ b/packages/stem_sqlite/pubspec.yaml @@ -1,10 +1,10 @@ name: stem_sqlite description: SQLite broker and result backend for Stem. -version: 0.1.1 +version: 0.1.3 repository: https://github.com/kingwill101/stem resolution: workspace environment: - sdk: ^3.9.2 + sdk: ^3.10.0 dependencies: artisanal: ^0.2.0 @@ -12,15 +12,15 @@ dependencies: contextual: ^2.2.0 meta: ^1.18.0 ormed: ^0.2.0 - ormed_sqlite: ^0.2.0 + ormed_sqlite: ^0.3.0 path: ^1.9.1 - stem: ">=0.2.0-dev <0.3.0" + stem: ">=0.2.1 <0.3.0" uuid: ^4.5.2 dev_dependencies: build_runner: ^2.10.5 coverage: ^1.15.0 lints: ^6.0.0 - stem_adapter_tests: ^0.1.1 + stem_adapter_tests: ">=0.1.2 <0.2.0" test: ^1.29.0 very_good_analysis: ^10.0.0 diff --git a/pubspec.yaml b/pubspec.yaml index 218878ae..a0c26bfb 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,12 +1,14 @@ name: stem_and_friends publish_to: none environment: - sdk: ">=3.9.2 <4.0.0" + sdk: ">=3.10.0 <4.0.0" workspace: - packages/stem - packages/dashboard - packages/stem_builder - packages/stem_sqlite + - packages/stem_flutter + - packages/stem_flutter_sqlite - packages/stem_memory - packages/stem_adapter_tests - packages/stem_redis @@ -16,6 +18,7 @@ dev_dependencies: coverage: ^1.15.0 very_good_analysis: ^10.0.0 dependency_overrides: + meta: ^1.18.0 liquify: ^1.5.0 timezone: 0.11.0 pointycastle: ^4.0.0