diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..4be6799 --- /dev/null +++ b/.clang-format @@ -0,0 +1,3 @@ +BasedOnStyle: Google +IndentWidth: 2 +AlwaysBreakTemplateDeclarations: Yes \ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b170eb0 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,11 @@ +# editorconfig +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +quote_type = single \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.md b/.github/ISSUE_TEMPLATE/1_bug_report.md new file mode 100644 index 0000000..0d60ca3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.md @@ -0,0 +1,43 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +# Report a bug +Thank you for using Patapata. This is an issue to report any problems or bugs related to Patapata's features. Please provide the steps to reproduce the issue, the results of those steps, logs, Flutter doctor output, and any sample code if available. + +## Description +- + +### Reproduction Steps +- + +### Reproduction Steps Result +- + +### Environment +- + + +### Logs +- + + +### **Flutter Doctor Result** +- + diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.md b/.github/ISSUE_TEMPLATE/2_feature_request.md new file mode 100644 index 0000000..52a3c93 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +# Feature Request +Thank you for using Patapata. This is an issue for requesting new features for Patapata. Please provide the details of the feature you would like to add to Patapata. + +## Description +- + + +## Similar Features +- + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_other.md b/.github/ISSUE_TEMPLATE/3_other.md new file mode 100644 index 0000000..558e9cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_other.md @@ -0,0 +1,15 @@ +--- +name: Other issue +about: Create regarding other issues +title: '' +labels: '' +assignees: '' + +--- + +# Other Issue +Thank you for using Patapata. This is an issue for reporting bugs, problems, or making suggestions other than adding new features. + +## Description +- + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..917ef9e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + + +# Issue Number +#{IssueNumber} + + +# Summary +- + \ No newline at end of file diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 0000000..2857fb7 --- /dev/null +++ b/.github/workflows/check.yml @@ -0,0 +1,58 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Check + +on: + push: + branches: [main] + pull_request: + branches: [main] + workflow_dispatch: + +jobs: + check: + runs-on: ubuntu-latest + strategy: + matrix: + flutterVersion: + - '3.19.3' + - '3.16.9' + - '3.13.9' + - '3.13.0' + + steps: + - uses: actions/checkout@v3 + + - uses: subosito/flutter-action@v2 + with: + flutter-version: ${{ matrix.flutterVersion }} + channel: 'stable' + cache: true + + - name: Setup Go environment + uses: actions/setup-go@v4.1.0 + + - name: Install dependencies + run: |- + go install github.com/google/addlicense@latest + flutter pub get + dart pub global activate melos + melos bootstrap + + - name: Analyze project source + run: melos run lint:all + + - name: Run tests + run: melos run test:all + + - name: Check license headers + run: melos run check-license-header + + - name: Test building Android + run: melos run build:example_android + + - name: Test building web + run: melos run build:example_web diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..bc3e793 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,32 @@ +name: Upload Codecov + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Flutter + uses: subosito/flutter-action@v2 + with: + channel: 'stable' + + - name: Install dependencies + run: flutter pub get + working-directory: ./packages/patapata_core + + - name: Run tests for coverage + run: flutter test --dart-define=IS_TEST=true --no-pub --coverage + working-directory: ./packages/patapata_core + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1353e81 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +.vscode/* +.DS_Store +**/coverage +pubspec_overrides.yaml +.dart_tool +.melos_tool +.atom +.idea +.packages +.pub +.symlinks +pubspec.lock + +! .vscode/launch.json diff --git a/.swiftformat b/.swiftformat new file mode 100644 index 0000000..6b8f821 --- /dev/null +++ b/.swiftformat @@ -0,0 +1,6 @@ +--indent 2 +--maxwidth 100 +--wrapparameters afterfirst +--disable sortedImports,unusedArguments,wrapMultilineStatementBraces +--exclude Pods,**/MainFlutterWindow.swift,**/AppDelegate.swift,**/.symlinks/** +--swiftversion 5.7 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e4d87c4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Change Log + +All notable changes to this project will be documented in this file. +See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..488e9f8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Contribution to Patapata + +This is a guideline on how to contribute to Patapata. By following these guidelines, anyone can contribute to Patapata. + +## Issues + +If you have any issues related to Patapata, please report them. When you do, use a template from GitHub Issues. + +- Report errors here in this Issue. +- Share your opinions on questions or feature requests related to Patapata here in this Issue. +- For any other questions, please use this Issue. + +## Pull Request + +If you have any modifications related to Patapata, please submit a PR (Pull Request). In this case, please adhere to the following guidelines: + +- Submit the PR against the next branch. +- Fill in the necessary items in the template when creating the PR. +- Assign it an issue number and appropriate labels. +- Ensure it meets the test and coverage requirements with `melos run test:all` or manually with `flutter test --dart-define=IS_TEST=true` for all plugins and core. +- Generally, if you're adding additional Dart files, include their corresponding test code as well. + +## Copyright Notice + +Patapata uses the MIT License. The rights to this open-source software are owned by GREE, Inc., and the company retains these rights even after the software is publicly released. + +Regarding modifications made by individuals other than GREE, Inc., the rights to the modified portions belong to the person who made the modifications. + +When creating source code in languages like Dart, Kotlin, Swift, etc., it is essential to include the MIT License at the beginning of the file. Please follow the formatting guidelines specific to the programming language. Below, I'll provide an example of the license statements that are typically included in Dart, Kotlin, and Swift files managed in Patapata: + +dart + +```dart +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +``` + +Kotlin + +```kotlin +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ +``` + +Swift + +```swift +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +``` + +You can also use the melos command to automatically add the license statement to the file. + +`melos run add-license-header` + +Note that you will need a working go environment with [addlicense](https://github.com/google/addlicense) installed to use this command. + +## Coding Conventions + +- We generally follow the [effective-dart](https://dart.dev/guides/language/effective-dart/style) guidelines. +- We adhere to the [Flutter formatting rules](https://flutter.dev/docs/development/tools/formatting). +- We follow the rules of the [Linter](https://dart-lang.github.io/linter/lints/index.html). + +### Other Coding Conventions + +- Start all local variables with 't,' where 't' stands for temporary. We do this to instantly understand if a variable will affect something outside of the current scope without having to manually looking at the declaration. + +```dart +void main() async { + final App tApp = createApp(); + ... + tApp.run(); +} +``` + +- Iterator-related variables in constructs like `for` loops can remain as 'i' or similar; there's no issue with that. + +```dart + for (var i = 0; i < 10; i++) { + print("count : $i"); + } +``` + +- For internal function names, begin with 'f.' We do this to instantly understand when a function is a local function versus anything else. For example: + +```dart + void exampleFunc() { + fHogeHoge() { + ... + } + + fHogeHoge(); + } +``` + +- Start private static variables with '_s.’ This is to instantly understand that these variables are static and will possibly affect multiple areas of the codebase as well as not being tied to the current instance. + +```dart +static var _sCounter = 0; +``` + +- For constants, begin private ones with '_k' and public ones with 'k.’ + +```dart +const _kMyNum = 1; +const kMyPublicNum = 1; +``` + +- After an 'if (...)' statement, always include curly braces '{}' and a newline. Avoid writing it on a single line without curly braces. For if expressions this is not required. + +```dart +// OK +if (something) { + doThat(); +} + +// NG +if (something) doThat(); + +// OK +final tArray = [ + if (something) 2, +]; +``` + +## Project Management + +Patapata uses [melos](https://melos.invertase.dev/) to manage this monorepository. Please refer to the melos documentation for more information. + +## Quality Assurance + +- Patapata aims to support the latest Flutter version as much as possible. However, there may be times when it cannot be compatible with that version due to Flutter's update changes. +- Patapata strives to achieve as close to 100% test code coverage as possible. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d97508 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +
+

Patapata

+ +
+ +
+ +

+ A collection of best-practices and tools for building applications quickly and reliably. +

+ +

+ Project Homepage +

+ +

+ + GitHub Workflow Status (branch) + + + Pub Popularity + + + Maintained with Melos + + + License + + + + +

+ +
+ +--- + +[[Changelog]](https://github.com/gree/patapata/blob/main/CHANGELOG.md) • [[Packages]](https://pub.dev/publishers/gree.co.jp/packages) + +--- + +Patapata is a framework built on Flutter for creating applications of production quality quickly and reliably. +It provides a collection of best-practices built directly in to the various APIs so you can build apps that are consistent, stable, and performant. + +[Flutter](https://flutter.dev) is Google’s UI toolkit for building beautiful, natively compiled applications for mobile, +web, and desktop from a single codebase. Flutter is used by developers and organizations around the world, and is free +and open source. + +--- + +## Documentation + +**If you just want to jump in and get Patapata working without any plugins or reading the documentation, check out [![patapata_core pub.dev badge](https://img.shields.io/pub/v/patapata_core.svg?label=patapata_core)](https://pub.dev/packages/patapata_core).** + +Most of our documentation is within the [patapata_core](https://github.com/gree/patapata/blob/main/packages/patapata_core/README.md) package, so start there. + +If you want documentation on the various plugins we provide, check out the plugin sections below. + +## Stable Plugins + +| Name | pub.dev | Related Product | Documentation | View Source | Android | iOS | Web | MacOS | Windows | Linux +|------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------:|:-----:|:-----:|:-------:|:-------:|:-------:| +| Apple Push Notifications | [![patapata_apple_push_notifications pub.dev badge](https://img.shields.io/pub/v/patapata_apple_push_notifications.svg)](https://pub.dev/packages/patapata_apple_push_notifications) | [🔗](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) | [📖](https://pub.dev/documentation/patapata_apple_push_notifications/latest/) | [`patapata_apple_push_notifications`](https://github.com/gree/patapata/tree/main/packages/patapata_apple_push_notifications) | ✖︎ | ✔ | ✖︎ | ✔ | ✖︎ | ✖︎ | +| Firebase Analytics | [![patapata_firebase_analytics pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_analytics.svg)](https://pub.dev/packages/patapata_firebase_analytics) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_analytics/latest/) | [`patapata_firebase_analytics`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_analytics) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Firebase Auth | [![patapata_firebase_auth pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_auth.svg)](https://pub.dev/packages/patapata_firebase_auth) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_auth/latest/) | [`patapata_firebase_auth`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_auth) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Firebase Core | [![patapata_firebase_core pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_core.svg)](https://pub.dev/packages/patapata_firebase_core) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_core/latest/) | [`patapata_firebase_core`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_core) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Firebase Crashlytics | [![patapata_firebase_crashlytics pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_crashlytics.svg)](https://pub.dev/packages/patapata_firebase_crashlytics) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_crashlytics/latest/) | [`patapata_firebase_crashlytics`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_crashlytics) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Firebase Messaging | [![patapata_firebase_messaging pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_messaging.svg)](https://pub.dev/packages/patapata_firebase_messaging) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_messaging/latest/) | [`patapata_firebase_messaging`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_messaging) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Firebase Remote Config | [![patapata_firebase_remote_config pub.dev badge](https://img.shields.io/pub/v/patapata_firebase_remote_config.svg)](https://pub.dev/packages/patapata_firebase_remote_config) | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_remote_config/latest/) | [`patapata_firebase_remote_config`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_remote_config) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Sentry | [![patapata_sentry pub.dev badge](https://img.shields.io/pub/v/patapata_sentry.svg)](https://pub.dev/packages/patapata_sentry) | [🔗](https://sentry.io/welcome/) | [📖](https://pub.dev/documentation/patapata_sentry/latest/) | [`patapata_sentry`](https://github.com/gree/patapata/tree/main/packages/patapata_sentry) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Riverpod | [![patapata_riverpod pub.dev badge](https://img.shields.io/pub/v/patapata_riverpod.svg)](https://pub.dev/packages/patapata_riverpod) | [🔗](https://riverpod.dev/) | [📖](https://pub.dev/documentation/patapata_riverpod/latest/) | [`patapata_riverpod`](https://github.com/gree/patapata/tree/main/packages/patapata_riverpod) | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | + +## Unreleased But Useable Plugins +| Name | Related Product | Documentation | View Source | Android | iOS | Web | MacOS | Windows | Linux +|------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------:|:-----:|:-----:|:-------:|:-------:|:-------:| +| Adjust | [🔗](https://www.adjust.com/) | [📖](https://pub.dev/documentation/patapata_adjust/latest/) | [`patapata_adjust`](https://github.com/gree/patapata/tree/main/packages/patapata_adjust) | ✔ | ✔ | ✔ | ✖︎ | ✖︎ | ✖︎ | +| AppsFlyer | [🔗](https://www.appsflyer.com/) | [📖](https://pub.dev/documentation/patapata_apps_flyer/latest/) | [`patapata_apps_flyer`](https://github.com/gree/patapata/tree/main/packages/patapata_apps_flyer) | ✔ | ✔ | ✖︎ | ✖︎ | ✖︎ | ✖︎ | +| Firebase Dynamic Links | [🔗](https://firebase.google.com/docs/flutter/setup) | [📖](https://pub.dev/documentation/patapata_firebase_dynamic_links/latest/) | [`patapata_firebase_dynamic_links`](https://github.com/gree/patapata/tree/main/packages/patapata_firebase_dynamic_links) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Karte Core | [🔗](https://karte.io/) | [📖](https://pub.dev/documentation/patapata_karte_core/latest/) | [`patapata_karte_core`](https://github.com/gree/patapata/tree/main/packages/patapata_karte_core) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | +| Karte Variables | [🔗](https://karte.io/) | [📖](https://pub.dev/documentation/patapata_karte_variables/latest/) | [`patapata_karte_variables`](https://github.com/gree/patapata/tree/main/packages/patapata_karte_variables) | ✔ | ✔ | ✔ | β | ✖︎ | ✖︎ | + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/LICENSE) \ No newline at end of file diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 0000000..87022c7 --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1,8 @@ +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + # Ignore generated files + - '**/*.g.dart' diff --git a/assets/logo_pata2_horizontal.png b/assets/logo_pata2_horizontal.png new file mode 100644 index 0000000..c1b3419 Binary files /dev/null and b/assets/logo_pata2_horizontal.png differ diff --git a/header_template.txt b/header_template.txt new file mode 100644 index 0000000..acb871c --- /dev/null +++ b/header_template.txt @@ -0,0 +1,4 @@ +Copyright (c) GREE, Inc. + +This source code is licensed under the MIT license found in the +LICENSE file in the root directory of this source tree. \ No newline at end of file diff --git a/melos.yaml b/melos.yaml new file mode 100644 index 0000000..33301a7 --- /dev/null +++ b/melos.yaml @@ -0,0 +1,203 @@ +name: patapata + +packages: + - packages/* + - packages/*/example + +scripts: + lint:all: + run: melos run analyze + description: Run all static analysis checks. + + analyze: + run: | + melos exec -c 1 -- \ + dart analyze . --fatal-infos + description: | + Run `dart analyze` in all packages. + - Note: you can also rely on your IDEs Dart Analysis / Issues window. + + test:all: + run: | + melos run test --no-select + description: | + Run all tests available. + + test: + run: | + melos exec -c 6 --fail-fast -- \ + "flutter test --dart-define=IS_TEST=true" + description: Run `flutter test` for a specific package. + packageFilters: + dirExists: + - test + ignore: + - "*web*" + - "*example*" + + coverage: + run: | + melos exec -c 1 --fail-fast -- \ + "flutter test --coverage --dart-define=IS_TEST=true" + description: Run `flutter test --coverage` for a specific package. + packageFilters: + dirExists: + - test + ignore: + - "*web*" + - "*example*" + + build:all: + run: | + melos run build:example_ios --no-select && \ + melos run build:example_android --no-select && \ + melos run build:example_macos --no-select && \ + melos run build:example_web --no-select + description: Build all example apps. + + build:example_android: + run: | + melos exec -c 6 --fail-fast -- \ + "flutter build apk" + description: Build a specific example app for Android. + packageFilters: + dirExists: + - android + scope: "*example*" + + build:example_ios: + run: | + if [ ! -z $(which rbenv) ]; then + eval "$(rbenv init - $(basename $SHELL))" + rbenv shell $(rbenv versions | awk '{ if ($1 == "*") print $2; else print $1; }' | sort -rn | head -n 1) + fi + melos exec -c 6 --fail-fast -- \ + "flutter build ios --no-codesign" + description: Build a specific example app for iOS. + packageFilters: + dirExists: + - ios + scope: "*example*" + + build:example_macos: + run: | + if [ ! -z $(which rbenv) ]; then + eval "$(rbenv init - $(basename $SHELL))" + rbenv shell $(rbenv versions | awk '{ if ($1 == "*") print $2; else print $1; }' | sort -rn | head -n 1) + fi + melos exec -c 6 --fail-fast -- \ + "flutter build macos" + description: | + Build a specific example app for macOS. + packageFilters: + dirExists: + - macos + scope: "*example*" + + build:example_web: + run: | + melos exec -c 6 --fail-fast -- \ + "flutter build web" + description: | + Build a specific example app for web. + packageFilters: + dirExists: + - web + scope: "*example*" + + clean:deep: + run: git clean -x -d -f -q + description: Clean things very deeply, can be used to establish "pristine checkout" status. + + qualitycheck: + run: | + melos run clean:deep && \ + melos clean && \ + melos bootstrap && \ + melos run lint:all && \ + melos run build:all && \ + melos run test:all + description: Run all targets generally expected in CI for a full local quality check. + + # Additional cleanup lifecycle script, executed when `melos clean` is run. + postclean: > + melos exec -c 6 -- "flutter clean" + + add-license-header: + # If you add here another --ignore flag, add it also to + # "check-license-header". + run: | + addlicense -f header_template.txt \ + --ignore "**/*.yml" \ + --ignore "**/*.yaml" \ + --ignore "**/*.xml" \ + --ignore "**/*.g.dart" \ + --ignore "**/*.sh" \ + --ignore "**/*.html" \ + --ignore "**/*.js" \ + --ignore "**/*.ts" \ + --ignore "**/*.g.h" \ + --ignore "**/*.g.m" \ + --ignore "**/*.rb" \ + --ignore "**/*.txt" \ + --ignore "**/*.cmake" \ + --ignore "**/doc/**" \ + --ignore "**/.dart_tool/**" \ + --ignore "**/Runner/MainFlutterWindow.swift" \ + --ignore "**/Runner/Runner-Bridging-Header.h" \ + --ignore "**/Runner/main.m" \ + --ignore "**/runner/main.cpp" \ + --ignore "**/runner/flutter_window.cpp" \ + --ignore "**/runner/resource.h" \ + --ignore "**/FlutterMultiDexApplication.java" \ + --ignore "**/GeneratedPluginRegistrant.swift" \ + --ignore "**/GeneratedPluginRegistrant.java" \ + --ignore "**/GeneratedPluginRegistrant.kotlin" \ + --ignore "**/GeneratedPluginRegistrant.m" \ + --ignore "**/GeneratedPluginRegistrant.h" \ + --ignore "**/Pods/**" \ + --ignore "**/flutter/generated_plugin_registrant.h" \ + --ignore "**/flutter/generated_plugin_registrant.cc" \ + --ignore "**/build/**" \ + . + description: Add a license header to all necessary files. + + check-license-header: + # If you add here another --ignore flag, add it also to + # "add-license-header". + run: | + addlicense -f header_template.txt \ + --check \ + --ignore "**/*.yml" \ + --ignore "**/*.yaml" \ + --ignore "**/*.xml" \ + --ignore "**/*.g.dart" \ + --ignore "**/*.sh" \ + --ignore "**/*.html" \ + --ignore "**/*.js" \ + --ignore "**/*.ts" \ + --ignore "**/*.g.h" \ + --ignore "**/*.g.m" \ + --ignore "**/*.rb" \ + --ignore "**/*.txt" \ + --ignore "**/*.cmake" \ + --ignore "**/doc/**" \ + --ignore "**/.dart_tool/**" \ + --ignore "**/Runner/MainFlutterWindow.swift" \ + --ignore "**/Runner/Runner-Bridging-Header.h" \ + --ignore "**/Runner/main.m" \ + --ignore "**/runner/main.cpp" \ + --ignore "**/runner/flutter_window.cpp" \ + --ignore "**/runner/resource.h" \ + --ignore "**/FlutterMultiDexApplication.java" \ + --ignore "**/GeneratedPluginRegistrant.swift" \ + --ignore "**/GeneratedPluginRegistrant.java" \ + --ignore "**/GeneratedPluginRegistrant.kotlin" \ + --ignore "**/GeneratedPluginRegistrant.m" \ + --ignore "**/GeneratedPluginRegistrant.h" \ + --ignore "**/Pods/**" \ + --ignore "**/flutter/generated_plugin_registrant.h" \ + --ignore "**/flutter/generated_plugin_registrant.cc" \ + --ignore "**/build/**" \ + . + description: Add a license header to all necessary files. diff --git a/melos_patapata.iml b/melos_patapata.iml new file mode 100644 index 0000000..9681559 --- /dev/null +++ b/melos_patapata.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/packages/patapata_adjust/.gitignore b/packages/patapata_adjust/.gitignore new file mode 100644 index 0000000..96486fd --- /dev/null +++ b/packages/patapata_adjust/.gitignore @@ -0,0 +1,30 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +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 +# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock. +/pubspec.lock +**/doc/api/ +.dart_tool/ +.packages +build/ diff --git a/packages/patapata_adjust/.metadata b/packages/patapata_adjust/.metadata new file mode 100644 index 0000000..e11c895 --- /dev/null +++ b/packages/patapata_adjust/.metadata @@ -0,0 +1,33 @@ +# 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. + +version: + revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + channel: unknown + +project_type: plugin + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + base_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + - platform: android + create_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + base_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + - platform: ios + create_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + base_revision: 6928314d505d2bb4777be05e45d7808a5aa91d2a + + # 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/patapata_adjust/CHANGELOG.md b/packages/patapata_adjust/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_adjust/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_adjust/LICENSE b/packages/patapata_adjust/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_adjust/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_adjust/README.md b/packages/patapata_adjust/README.md new file mode 100644 index 0000000..c526c1f --- /dev/null +++ b/packages/patapata_adjust/README.md @@ -0,0 +1,75 @@ +
+

Patapata - Adjust

+

+ Add support for Adjust to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Adjust](https://www.adjust.com/) to your Patapata app. +It will automatically send events to Adjust from Patapata's Analytics system. +It will also integrate with Patapata's User system and automatically send user information to Adjust by setting the Adjust SDK's `user_id` session callback parameter. + +This plugin will only start sending events to Adjust once Patapata's tracking permission has been processed at least once via `getApp().permissions.requestTracking()`. + +This plugin does not support any of the other features of Adjust, such as attribution or push notifications. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```yaml +dependencies: + patapata_adjust: + git: + url: git://github.com/gree/patapata.git + path: packages/patapata_adjust +``` + +2. Import the package + +```dart +import 'package:patapata_adjust/patapata_adjust.dart'; +``` + +3. Activate the plugin + +```dart +/// This Environment takes adjust configuration from environment variables. +/// Pass environment variables to your app using the `--dart-define` flag. +class Environment extends AdjustPluginEnvironment { + const Environment(); + + /// The app token issued when adding the app on Adjust's dashboard. + @override + String get adjustAppToken => const String.fromEnvironment('ADJUST_APP_TOKEN'); + + /// The environment for Adjust. Refer to the values in [AdjustEnvironment]. + @override + String get adjustEnvironment => const String.fromEnvironment('ADJUST_ENVIRONMENT'); + + /// The log level for Adjust. Refer to the values in [AdjustLogLevel]. + @override + String? get adjustLogLevel => const String.fromEnvironment('ADJUST_LOG_LEVEL'); +} + +void main() { + App( + environment: const Environment(), + plugins: [ + AdjustPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_adjust/LICENSE) \ No newline at end of file diff --git a/packages/patapata_adjust/analysis_options.yaml b/packages/patapata_adjust/analysis_options.yaml new file mode 100644 index 0000000..da00fd4 --- /dev/null +++ b/packages/patapata_adjust/analysis_options.yaml @@ -0,0 +1,7 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: diff --git a/packages/patapata_adjust/android/.gitignore b/packages/patapata_adjust/android/.gitignore new file mode 100644 index 0000000..161bdcd --- /dev/null +++ b/packages/patapata_adjust/android/.gitignore @@ -0,0 +1,9 @@ +*.iml +.gradle +/local.properties +/.idea/workspace.xml +/.idea/libraries +.DS_Store +/build +/captures +.cxx diff --git a/packages/patapata_adjust/android/build.gradle b/packages/patapata_adjust/android/build.gradle new file mode 100644 index 0000000..d14268c --- /dev/null +++ b/packages/patapata_adjust/android/build.gradle @@ -0,0 +1,57 @@ +group 'dev.patapata.patapata_adjust' +version '1.0-SNAPSHOT' + +buildscript { + ext.kotlin_version = '1.7.10' + repositories { + google() + mavenCentral() + } + + dependencies { + classpath 'com.android.tools.build:gradle:7.3.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + } +} + +allprojects { + repositories { + google() + mavenCentral() + } +} + +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' + +android { + compileSdkVersion 33 + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + minSdkVersion 21 + } + + buildTypes { + release { + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } +} + +dependencies { + implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1' + implementation 'com.android.installreferrer:installreferrer:2.2' +} \ No newline at end of file diff --git a/packages/patapata_adjust/android/proguard-rules.pro b/packages/patapata_adjust/android/proguard-rules.pro new file mode 100644 index 0000000..fdf28a0 --- /dev/null +++ b/packages/patapata_adjust/android/proguard-rules.pro @@ -0,0 +1,12 @@ +-keep class com.adjust.sdk.** { *; } +-keep class com.google.android.gms.common.ConnectionResult { + int SUCCESS; +} +-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient { + com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context); +} +-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info { + java.lang.String getId(); + boolean isLimitAdTrackingEnabled(); +} +-keep public class com.android.installreferrer.** { *; } \ No newline at end of file diff --git a/packages/patapata_adjust/android/settings.gradle b/packages/patapata_adjust/android/settings.gradle new file mode 100644 index 0000000..7ee612a --- /dev/null +++ b/packages/patapata_adjust/android/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'patapata_adjust' diff --git a/packages/patapata_adjust/android/src/main/AndroidManifest.xml b/packages/patapata_adjust/android/src/main/AndroidManifest.xml new file mode 100644 index 0000000..5730410 --- /dev/null +++ b/packages/patapata_adjust/android/src/main/AndroidManifest.xml @@ -0,0 +1,6 @@ + + + + + diff --git a/packages/patapata_adjust/android/src/main/kotlin/dev/patapata/patapata_adjust/PatapataAdjustPlugin.kt b/packages/patapata_adjust/android/src/main/kotlin/dev/patapata/patapata_adjust/PatapataAdjustPlugin.kt new file mode 100644 index 0000000..0a5d84f --- /dev/null +++ b/packages/patapata_adjust/android/src/main/kotlin/dev/patapata/patapata_adjust/PatapataAdjustPlugin.kt @@ -0,0 +1,34 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_adjust + +import androidx.annotation.NonNull + +import io.flutter.embedding.engine.plugins.FlutterPlugin +import io.flutter.plugin.common.MethodCall +import io.flutter.plugin.common.MethodChannel +import io.flutter.plugin.common.MethodChannel.MethodCallHandler +import io.flutter.plugin.common.MethodChannel.Result + +/** PatapataAdjustPlugin */ +class PatapataAdjustPlugin: FlutterPlugin, MethodCallHandler { + private lateinit var channel : MethodChannel + + override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { + channel = MethodChannel(flutterPluginBinding.binaryMessenger, "patapata_adjust") + channel.setMethodCallHandler(this) + } + + override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) { + result.notImplemented() + } + + override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) { + channel.setMethodCallHandler(null) + } +} diff --git a/packages/patapata_adjust/dartdoc_options.yaml b/packages/patapata_adjust/dartdoc_options.yaml new file mode 100644 index 0000000..2a7e0c3 --- /dev/null +++ b/packages/patapata_adjust/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_adjust \ No newline at end of file diff --git a/packages/patapata_adjust/ios/.gitignore b/packages/patapata_adjust/ios/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_adjust/ios/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_adjust/ios/Assets/.gitkeep b/packages/patapata_adjust/ios/Assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.h b/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.h new file mode 100644 index 0000000..d4ec012 --- /dev/null +++ b/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataAdjustPlugin : NSObject +@end diff --git a/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.m b/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.m new file mode 100644 index 0000000..e952eda --- /dev/null +++ b/packages/patapata_adjust/ios/Classes/PatapataAdjustPlugin.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataAdjustPlugin.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_adjust-Swift.h" +#endif + +@implementation PatapataAdjustPlugin ++ (void)registerWithRegistrar:(NSObject*)registrar { + [SwiftPatapataAdjustPlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_adjust/ios/Classes/SwiftPatapataAdjustPlugin.swift b/packages/patapata_adjust/ios/Classes/SwiftPatapataAdjustPlugin.swift new file mode 100644 index 0000000..9c51127 --- /dev/null +++ b/packages/patapata_adjust/ios/Classes/SwiftPatapataAdjustPlugin.swift @@ -0,0 +1,19 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter +import UIKit + +public class SwiftPatapataAdjustPlugin: NSObject, FlutterPlugin { + public static func register(with registrar: FlutterPluginRegistrar) { + let channel = FlutterMethodChannel(name: "patapata_adjust", binaryMessenger: registrar.messenger()) + let instance = SwiftPatapataAdjustPlugin() + registrar.addMethodCallDelegate(instance, channel: channel) + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + result(nil) + } +} diff --git a/packages/patapata_adjust/ios/patapata_adjust.podspec b/packages/patapata_adjust/ios/patapata_adjust.podspec new file mode 100644 index 0000000..caff5c0 --- /dev/null +++ b/packages/patapata_adjust/ios/patapata_adjust.podspec @@ -0,0 +1,23 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_adjust.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_adjust' + s.version = '0.0.1' + s.summary = 'A new Flutter plugin project.' + s.description = <<-DESC +A new Flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'Flutter' + s.platform = :ios, '9.0' + + # Flutter.framework does not contain a i386 slice. + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_adjust/lib/patapata_adjust.dart b/packages/patapata_adjust/lib/patapata_adjust.dart new file mode 100644 index 0000000..e7d1cf7 --- /dev/null +++ b/packages/patapata_adjust/lib/patapata_adjust.dart @@ -0,0 +1,164 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_adjust; + +import 'dart:async'; + +import 'package:adjust_sdk/adjust.dart'; +import 'package:adjust_sdk/adjust_config.dart'; +import 'package:adjust_sdk/adjust_event.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; + +/// Configuration for [AdjustPlugin]. +mixin AdjustPluginEnvironment { + /// The app token issued when adding the app on Adjust's dashboard. + String get adjustAppToken; + + /// The environment for Adjust. Refer to the values in [AdjustEnvironment]. + String get adjustEnvironment; + + /// The log level for Adjust. Refer to the values in [AdjustLogLevel]. + String? get adjustLogLevel; +} + +/// This is a plugin that provides Adjust functionality. +class AdjustPlugin extends Plugin + with WidgetsBindingObserver { + StreamSubscription? _eventsSubscription; + + /// Initializes the [AdjustPlugin]. + @override + FutureOr init(App app) async { + if (kIsWeb || app.environment is! AdjustPluginEnvironment) { + return false; + } + + await super.init(app); + + if (app.permissions.trackingRequested) { + _start(); + } else { + app.permissions.trackingStream.first.then((_) { + if (!disposed) { + _start(); + } + }); + } + + return true; + } + + AdjustPluginEnvironment get _environment => + app.environment as AdjustPluginEnvironment; + + void _start() { + final tConfig = AdjustConfig( + _environment.adjustAppToken, + AdjustEnvironment.values + .firstWhere((e) => e.name == _environment.adjustEnvironment), + ); + + if (_environment.adjustLogLevel?.isNotEmpty == true) { + tConfig.logLevel = AdjustLogLevel.values + .firstWhere((e) => e.name == _environment.adjustLogLevel); + } + + Adjust.start(tConfig); + + WidgetsBinding.instance.addObserver(this); + + _eventsSubscription = + app.analytics.eventsFor().listen(_onEvent); + app.user.addSynchronousChangeListener(_onUserChanged); + } + + @override + FutureOr dispose() async { + app.user.removeSynchronousChangeListener(_onUserChanged); + _eventsSubscription?.cancel(); + WidgetsBinding.instance.removeObserver(this); + if (await Adjust.isEnabled()) { + Adjust.setEnabled(false); + } + + return super.dispose(); + } + + @override + void didChangeAppLifecycleState(AppLifecycleState state) { + switch (state) { + case AppLifecycleState.resumed: + Adjust.onResume(); + break; + case AppLifecycleState.paused: + Adjust.onPause(); + break; + default: + break; + } + } + + void _onEvent(AnalyticsEvent event) { + final tAdjustEvent = AdjustEvent(event.name); + + if (event is AnalyticsRevenueEvent) { + tAdjustEvent.setRevenue(event.revenue, event.currency ?? 'XXX'); + tAdjustEvent.transactionId = event.orderId; + } + + final tFlatData = event.flatData; + final tParameters = tFlatData != null + ? { + for (var i in tFlatData.entries) + i.key: Analytics.defaultMakeLoggableToNative(i.value), + } + : null; + + final tFinalParameters = { + if (event.navigationInteractionContextData != null) + for (var i in event.navigationInteractionContextData!.entries) + 'nic_${i.key}': Analytics.defaultMakeLoggableToNative(i.value), + }..addAll(tParameters ?? {}); + + for (var i in tFinalParameters.entries) { + final tValue = i.value?.toString() ?? ''; + + if (tValue.isNotEmpty) { + tAdjustEvent.addCallbackParameter(i.key, tValue); + } + } + + Adjust.trackEvent(tAdjustEvent); + } + + String? _lastId; + + FutureOr _onUserChanged(User user, UserChangeData changes) async { + final tId = changes.getIdFor>(); + final tProperties = changes.getPropertiesFor>(); + + if (tId != _lastId) { + _lastId = tId; + if (tId == null) { + Adjust.removeSessionCallbackParameter('user_id'); + } else { + Adjust.addSessionCallbackParameter('user_id', tId); + } + } + + for (var i in tProperties.entries) { + final tValue = i.value?.toString() ?? ''; + + if (tValue.isNotEmpty) { + Adjust.addSessionCallbackParameter(i.key, tValue); + } else { + Adjust.removeSessionCallbackParameter(i.key); + } + } + } +} diff --git a/packages/patapata_adjust/pubspec.yaml b/packages/patapata_adjust/pubspec.yaml new file mode 100644 index 0000000..fc00946 --- /dev/null +++ b/packages/patapata_adjust/pubspec.yaml @@ -0,0 +1,33 @@ +name: patapata_adjust +description: This package is a plugin for Patapata that adds support for Adjust to your Patapata app. +version: 1.0.0 +publish_to: none +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_adjust + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + plugin_platform_interface: ^2.1.5 + + patapata_core: ^1.0.0 + + adjust_sdk: ^4.33.1 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: + plugin: + platforms: + android: + package: dev.patapata.patapata_adjust + pluginClass: PatapataAdjustPlugin + ios: + pluginClass: PatapataAdjustPlugin diff --git a/packages/patapata_adjust/test/patapata_adjust_test.dart b/packages/patapata_adjust/test/patapata_adjust_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_adjust/test/patapata_adjust_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_apple_push_notifications/.gitignore b/packages/patapata_apple_push_notifications/.gitignore new file mode 100644 index 0000000..7c2eea5 --- /dev/null +++ b/packages/patapata_apple_push_notifications/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +.dart_tool/ + +.packages +.pub/ + +build/ + +**/doc/api/ \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/.metadata b/packages/patapata_apple_push_notifications/.metadata new file mode 100644 index 0000000..eb5f3e0 --- /dev/null +++ b/packages/patapata_apple_push_notifications/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: plugin diff --git a/packages/patapata_apple_push_notifications/CHANGELOG.md b/packages/patapata_apple_push_notifications/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_apple_push_notifications/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/LICENSE b/packages/patapata_apple_push_notifications/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_apple_push_notifications/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_apple_push_notifications/README.md b/packages/patapata_apple_push_notifications/README.md new file mode 100644 index 0000000..da6579d --- /dev/null +++ b/packages/patapata_apple_push_notifications/README.md @@ -0,0 +1,48 @@ +
+

Patapata - Apple Push Notifications

+

+ Add support for Apple Push Notifications to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Apple Push Notifications](https://developer.apple.com/documentation/usernotifications) to your Patapata app. +It will automatically integrate with Patapata's RemoteMessaging system and register for push notifications and provide access to APNs tokens. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_apple_push_notifications +``` + +2. Import the package + +```dart +import 'package:patapata_apple_push_notifications/patapata_apple_push_notifications.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + ApplePushNotificationsPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_apple_push_notifications/LICENSE) \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/analysis_options.yaml b/packages/patapata_apple_push_notifications/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_apple_push_notifications/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/dartdoc_options.yaml b/packages/patapata_apple_push_notifications/dartdoc_options.yaml new file mode 100644 index 0000000..61adcd2 --- /dev/null +++ b/packages/patapata_apple_push_notifications/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_apple_push_notifications \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/example/.gitignore b/packages/patapata_apple_push_notifications/example/.gitignore new file mode 100644 index 0000000..0fa6b67 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/.gitignore @@ -0,0 +1,46 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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 +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ + +# Web related +lib/generated_plugin_registrant.dart + +# 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/patapata_apple_push_notifications/example/.metadata b/packages/patapata_apple_push_notifications/example/.metadata new file mode 100644 index 0000000..cb12308 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: app diff --git a/packages/patapata_apple_push_notifications/example/README.md b/packages/patapata_apple_push_notifications/example/README.md new file mode 100644 index 0000000..902faf2 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/README.md @@ -0,0 +1,16 @@ +# patapata_apple_push_notifications_example + +Demonstrates how to use the patapata_apple_push_notifications plugin. + +## Getting Started + +This project is a starting point for a Flutter application. + +A few resources to get you started if this is your first Flutter project: + +- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) +- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) + +For help getting started with Flutter, view our +[online documentation](https://flutter.dev/docs), which offers tutorials, +samples, guidance on mobile development, and a full API reference. diff --git a/packages/patapata_apple_push_notifications/example/analysis_options.yaml b/packages/patapata_apple_push_notifications/example/analysis_options.yaml new file mode 100644 index 0000000..61b6c4d --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/analysis_options.yaml @@ -0,0 +1,29 @@ +# 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-lang.github.io/linter/lints/index.html. + # + # 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/patapata_apple_push_notifications/example/ios/.gitignore b/packages/patapata_apple_push_notifications/example/ios/.gitignore new file mode 100644 index 0000000..7a7f987 --- /dev/null +++ b/packages/patapata_apple_push_notifications/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/patapata_apple_push_notifications/example/ios/Flutter/AppFrameworkInfo.plist b/packages/patapata_apple_push_notifications/example/ios/Flutter/AppFrameworkInfo.plist new file mode 100644 index 0000000..9625e10 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Flutter/AppFrameworkInfo.plist @@ -0,0 +1,26 @@ + + + + + CFBundleDevelopmentRegion + en + CFBundleExecutable + App + CFBundleIdentifier + io.flutter.flutter.app + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + App + CFBundlePackageType + FMWK + CFBundleShortVersionString + 1.0 + CFBundleSignature + ???? + CFBundleVersion + 1.0 + MinimumOSVersion + 11.0 + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Flutter/Debug.xcconfig b/packages/patapata_apple_push_notifications/example/ios/Flutter/Debug.xcconfig new file mode 100644 index 0000000..ec97fc6 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Flutter/Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "Generated.xcconfig" diff --git a/packages/patapata_apple_push_notifications/example/ios/Flutter/Release.xcconfig b/packages/patapata_apple_push_notifications/example/ios/Flutter/Release.xcconfig new file mode 100644 index 0000000..c4855bf --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Flutter/Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "Generated.xcconfig" diff --git a/packages/patapata_apple_push_notifications/example/ios/Podfile b/packages/patapata_apple_push_notifications/example/ios/Podfile new file mode 100644 index 0000000..88359b2 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Podfile @@ -0,0 +1,41 @@ +# Uncomment this line to define a global platform for your project +# platform :ios, '11.0' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_ios_podfile_setup + +target 'Runner' do + use_frameworks! + use_modular_headers! + + flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_ios_build_settings(target) + end +end diff --git a/packages/patapata_apple_push_notifications/example/ios/Podfile.lock b/packages/patapata_apple_push_notifications/example/ios/Podfile.lock new file mode 100644 index 0000000..f0185a9 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Podfile.lock @@ -0,0 +1,60 @@ +PODS: + - connectivity_plus (0.0.1): + - Flutter + - ReachabilitySwift + - device_info_plus (0.0.1): + - Flutter + - Flutter (1.0.0) + - flutter_local_notifications (0.0.1): + - Flutter + - package_info_plus (0.4.5): + - Flutter + - patapata_apple_push_notifications (0.0.1): + - Flutter + - patapata_core + - patapata_core (0.0.1): + - Flutter + - ReachabilitySwift (5.0.0) + +DEPENDENCIES: + - connectivity_plus (from `.symlinks/plugins/connectivity_plus/ios`) + - device_info_plus (from `.symlinks/plugins/device_info_plus/ios`) + - Flutter (from `Flutter`) + - flutter_local_notifications (from `.symlinks/plugins/flutter_local_notifications/ios`) + - package_info_plus (from `.symlinks/plugins/package_info_plus/ios`) + - patapata_apple_push_notifications (from `.symlinks/plugins/patapata_apple_push_notifications/ios`) + - patapata_core (from `.symlinks/plugins/patapata_core/ios`) + +SPEC REPOS: + trunk: + - ReachabilitySwift + +EXTERNAL SOURCES: + connectivity_plus: + :path: ".symlinks/plugins/connectivity_plus/ios" + device_info_plus: + :path: ".symlinks/plugins/device_info_plus/ios" + Flutter: + :path: Flutter + flutter_local_notifications: + :path: ".symlinks/plugins/flutter_local_notifications/ios" + package_info_plus: + :path: ".symlinks/plugins/package_info_plus/ios" + patapata_apple_push_notifications: + :path: ".symlinks/plugins/patapata_apple_push_notifications/ios" + patapata_core: + :path: ".symlinks/plugins/patapata_core/ios" + +SPEC CHECKSUMS: + connectivity_plus: 07c49e96d7fc92bc9920617b83238c4d178b446a + device_info_plus: 7545d84d8d1b896cb16a4ff98c19f07ec4b298ea + Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854 + flutter_local_notifications: 0c0b1ae97e741e1521e4c1629a459d04b9aec743 + package_info_plus: fd030dabf36271f146f1f3beacd48f564b0f17f7 + patapata_apple_push_notifications: d6a9d82ad04d4c1445dafa79f279065ccca3991e + patapata_core: ce5b4c8f74bd32c7c405f0d85d4cbbf25cb75da6 + ReachabilitySwift: 985039c6f7b23a1da463388634119492ff86c825 + +PODFILE CHECKSUM: ef19549a9bc3046e7bb7d2fab4d021637c0c58a3 + +COCOAPODS: 1.12.1 diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.pbxproj b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..4680558 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,542 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXBuildFile section */ + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.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 */; }; + E9DED2C107BF36CB89FCBCF8 /* Pods_Runner.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = FB70CDFBC87CA64226D29D3E /* Pods_Runner.framework */; }; +/* End PBXBuildFile 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 */ + 084A4BDF948E44A12169D4DA /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = ""; }; + 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 = ""; }; + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; + 6DD3E9A57A2B923D5ADA9AA0 /* Pods-Runner.profile.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.profile.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"; 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 = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; + 8ADE9AC30F82395E53769F35 /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.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 = ""; }; + FB70CDFBC87CA64226D29D3E /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 97C146EB1CF9000F007C117D /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + E9DED2C107BF36CB89FCBCF8 /* Pods_Runner.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 4B45FCEAF3151B6A91C5833B /* Pods */ = { + isa = PBXGroup; + children = ( + 084A4BDF948E44A12169D4DA /* Pods-Runner.debug.xcconfig */, + 8ADE9AC30F82395E53769F35 /* Pods-Runner.release.xcconfig */, + 6DD3E9A57A2B923D5ADA9AA0 /* Pods-Runner.profile.xcconfig */, + ); + name = Pods; + path = Pods; + 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 */, + 4B45FCEAF3151B6A91C5833B /* Pods */, + E082E5A20AEDD012371CEEA5 /* Frameworks */, + ); + sourceTree = ""; + }; + 97C146EF1CF9000F007C117D /* Products */ = { + isa = PBXGroup; + children = ( + 97C146EE1CF9000F007C117D /* Runner.app */, + ); + 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 */, + 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */, + ); + path = Runner; + sourceTree = ""; + }; + E082E5A20AEDD012371CEEA5 /* Frameworks */ = { + isa = PBXGroup; + children = ( + FB70CDFBC87CA64226D29D3E /* Pods_Runner.framework */, + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 97C146ED1CF9000F007C117D /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 1790C79EF3F20CB5FB989075 /* [CP] Check Pods Manifest.lock */, + 9740EEB61CF901F6004384FC /* Run Script */, + 97C146EA1CF9000F007C117D /* Sources */, + 97C146EB1CF9000F007C117D /* Frameworks */, + 97C146EC1CF9000F007C117D /* Resources */, + 9705A1C41CF9048500538489 /* Embed Frameworks */, + 3B06AD1E1E4923F5004D2608 /* Thin Binary */, + 69595A6DE13247C482AB8BD6 /* [CP] Embed Pods Frameworks */, + ); + 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 = { + LastUpgradeCheck = 1430; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 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 */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 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 */ + 1790C79EF3F20CB5FB989075 /* [CP] Check Pods Manifest.lock */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + "${PODS_PODFILE_DIR_PATH}/Podfile.lock", + "${PODS_ROOT}/Manifest.lock", + ); + name = "[CP] Check Pods Manifest.lock"; + outputFileListPaths = ( + ); + outputPaths = ( + "$(DERIVED_FILE_DIR)/Pods-Runner-checkManifestLockResult.txt", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; + showEnvVarsInLog = 0; + }; + 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"; + }; + 69595A6DE13247C482AB8BD6 /* [CP] Embed Pods Frameworks */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-input-files.xcfilelist", + ); + name = "[CP] Embed Pods Frameworks"; + outputFileListPaths = ( + "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-output-files.xcfilelist", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh\"\n"; + showEnvVarsInLog = 0; + }; + 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 */ + 97C146EA1CF9000F007C117D /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */, + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase 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; + 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; + 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 = 11.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 = dev.patapata.patapataApplePushNotificationsExample; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Profile; + }; + 97C147031CF9000F007C117D /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + 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; + 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 = 11.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; + 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; + 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 = 11.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; + SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; + 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 = dev.patapata.patapataApplePushNotificationsExample; + 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 = dev.patapata.patapataApplePushNotificationsExample; + 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 */ + 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/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..b52b2e6 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/contents.xcworkspacedata b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..21a3cc1 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,10 @@ + + + + + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/AppDelegate.swift b/packages/patapata_apple_push_notifications/example/ios/Runner/AppDelegate.swift new file mode 100644 index 0000000..0f67170 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner/AppDelegate.swift @@ -0,0 +1,18 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import UIKit +import Flutter + +@UIApplicationMain +@objc class AppDelegate: FlutterAppDelegate { + override func application( + _ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? + ) -> Bool { + GeneratedPluginRegistrant.register(with: self) + return super.application(application, didFinishLaunchingWithOptions: launchOptions) + } +} diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..d36b1fa --- /dev/null +++ b/packages/patapata_apple_push_notifications/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/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png new file mode 100644 index 0000000..dc9ada4 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png new file mode 100644 index 0000000..28c6bf0 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png new file mode 100644 index 0000000..2ccbfd9 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png new file mode 100644 index 0000000..f091b6b Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png new file mode 100644 index 0000000..4cde121 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png new file mode 100644 index 0000000..d0ef06e Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png new file mode 100644 index 0000000..dcdc230 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png new file mode 100644 index 0000000..2ccbfd9 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png new file mode 100644 index 0000000..c8f9ed8 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png new file mode 100644 index 0000000..a6d6b86 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png new file mode 100644 index 0000000..a6d6b86 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png new file mode 100644 index 0000000..75b2d16 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png new file mode 100644 index 0000000..c4df70d Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png new file mode 100644 index 0000000..6a84f41 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png new file mode 100644 index 0000000..d0e1f58 Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json new file mode 100644 index 0000000..0bedcf2 --- /dev/null +++ b/packages/patapata_apple_push_notifications/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/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png differ diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md b/packages/patapata_apple_push_notifications/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md new file mode 100644 index 0000000..89c2725 --- /dev/null +++ b/packages/patapata_apple_push_notifications/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. \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/LaunchScreen.storyboard b/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/LaunchScreen.storyboard new file mode 100644 index 0000000..f2e259c --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/LaunchScreen.storyboard @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/Main.storyboard b/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/Main.storyboard new file mode 100644 index 0000000..f3c2851 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner/Base.lproj/Main.storyboard @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Info.plist b/packages/patapata_apple_push_notifications/example/ios/Runner/Info.plist new file mode 100644 index 0000000..93950f9 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner/Info.plist @@ -0,0 +1,49 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + patapata_apple_push_notifications_example + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleSignature + ???? + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSRequiresIPhoneOS + + UILaunchStoryboardName + LaunchScreen + UIMainStoryboardFile + Main + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UIViewControllerBasedStatusBarAppearance + + CADisableMinimumFrameDurationOnPhone + + UIApplicationSupportsIndirectInputEvents + + + diff --git a/packages/patapata_apple_push_notifications/example/ios/Runner/Runner-Bridging-Header.h b/packages/patapata_apple_push_notifications/example/ios/Runner/Runner-Bridging-Header.h new file mode 100644 index 0000000..308a2a5 --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/ios/Runner/Runner-Bridging-Header.h @@ -0,0 +1 @@ +#import "GeneratedPluginRegistrant.h" diff --git a/packages/patapata_apple_push_notifications/example/lib/main.dart b/packages/patapata_apple_push_notifications/example/lib/main.dart new file mode 100644 index 0000000..3d2827c --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/lib/main.dart @@ -0,0 +1,38 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; + +void main() { + runApp(const MyApp()); +} + +class MyApp extends StatefulWidget { + const MyApp({Key? key}) : super(key: key); + + @override + State createState() => _MyAppState(); +} + +class _MyAppState extends State { + @override + void initState() { + super.initState(); + } + + @override + Widget build(BuildContext context) { + return MaterialApp( + home: Scaffold( + appBar: AppBar( + title: const Text('Plugin example app'), + ), + body: const Center( + child: Text('TODO'), + ), + ), + ); + } +} diff --git a/packages/patapata_apple_push_notifications/example/pubspec.yaml b/packages/patapata_apple_push_notifications/example/pubspec.yaml new file mode 100644 index 0000000..b64751e --- /dev/null +++ b/packages/patapata_apple_push_notifications/example/pubspec.yaml @@ -0,0 +1,84 @@ +name: patapata_apple_push_notifications_example +description: Demonstrates how to use the patapata_apple_push_notifications plugin. + +# 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 + +environment: + sdk: ">=2.12.0 <3.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 + + patapata_apple_push_notifications: + # When depending on this package from a real application you should use: + # patapata_apple_push_notifications: ^x.y.z + # See https://dart.dev/tools/pub/dependencies#version-constraints + # The example app is bundled with the plugin so we use a path dependency on + # the parent directory to use the current plugin's version. + path: ../ + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.2 + +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: ^1.0.0 + +# 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. +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/assets-and-images/#resolution-aware. + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/assets-and-images/#from-packages + + # 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/custom-fonts/#from-packages diff --git a/packages/patapata_apple_push_notifications/ios/.gitignore b/packages/patapata_apple_push_notifications/ios/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_apple_push_notifications/ios/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_apple_push_notifications/ios/Assets/.gitkeep b/packages/patapata_apple_push_notifications/ios/Assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.h b/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.h new file mode 100644 index 0000000..b6cee95 --- /dev/null +++ b/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataApplePushNotificationsPlugin : NSObject +@end diff --git a/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.m b/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.m new file mode 100644 index 0000000..e9d1bef --- /dev/null +++ b/packages/patapata_apple_push_notifications/ios/Classes/PatapataApplePushNotificationsPlugin.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataApplePushNotificationsPlugin.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_apple_push_notifications-Swift.h" +#endif + +@implementation PatapataApplePushNotificationsPlugin ++ (void)registerWithRegistrar:(NSObject*)registrar { + [SwiftPatapataApplePushNotificationsPlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_apple_push_notifications/ios/Classes/SwiftPatapataApplePushNotificationsPlugin.swift b/packages/patapata_apple_push_notifications/ios/Classes/SwiftPatapataApplePushNotificationsPlugin.swift new file mode 100644 index 0000000..75b2223 --- /dev/null +++ b/packages/patapata_apple_push_notifications/ios/Classes/SwiftPatapataApplePushNotificationsPlugin.swift @@ -0,0 +1,175 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter +import UIKit +import patapata_core + +public class SwiftPatapataApplePushNotificationsPlugin: NSObject, FlutterPlugin, UNUserNotificationCenterDelegate, PatapataPlugin { + + public static func register(with registrar: FlutterPluginRegistrar) { + let tInstance = SwiftPatapataApplePushNotificationsPlugin(registrar: registrar) + registrar.registerPatapata(plugin: tInstance) + } + + fileprivate let mChannel: FlutterMethodChannel + fileprivate var mTokenData: String? + fileprivate var mInitialNotification: [String: Any]? + + fileprivate var mEnabled = false + + init(registrar: FlutterPluginRegistrar) { + mChannel = FlutterMethodChannel(name: "dev.patapata.patapata_apple_push_notifications", binaryMessenger: registrar.messenger()) + + super.init() + + registrar.addMethodCallDelegate(self, channel: mChannel) + registrar.addApplicationDelegate(self) + } + + public var patapataName = "dev.patapata.patapata_apple_push_notifications" + + public func patapataEnable() { + guard !mEnabled else { + return + } + + mEnabled = true + + UIApplication.shared.applicationIconBadgeNumber = 0 + UNUserNotificationCenter.current().delegate = self + UIApplication.shared.registerForRemoteNotifications() + + if (mTokenData != nil) { + notifyUpdatedAPNsToken() + } + } + + public func patapataDisable() { + guard mEnabled else { + return + } + + mEnabled = false + mTokenData = nil + UNUserNotificationCenter.current().delegate = nil + UIApplication.shared.unregisterForRemoteNotifications() + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "getToken": + result(mTokenData) + break + case "requestPermission": + requestPermission(result: result) + break + case "getInitialNotification": + getInitialNotification(result: result) + break + default: + result(FlutterMethodNotImplemented) + break + } + } + + private func requestPermission(result: @escaping FlutterResult) { + guard mEnabled else { + result(false) + return + } + + UNUserNotificationCenter.current().requestAuthorization(options: [ + .alert, .badge, .sound + ]) { + succeeded, error in + result(succeeded) + } + } + + private func getInitialNotification(result: @escaping FlutterResult) { + let tInitialNotification = mInitialNotification + mInitialNotification = nil + result(tInitialNotification) + } + + private func dictionaryFromNotificationResponse(notification: UNNotificationResponse) -> [String : Any] { + let tDateFormatter = ISO8601DateFormatter() + let tNotification = notification.notification + + return [ + "actionIdentifier": notification.actionIdentifier, + "notification": [ + "date": tDateFormatter.string(from: tNotification.date), + "request": [ + "identifier": tNotification.request.identifier, + "content": [ + "title": tNotification.request.content.title, + "body": tNotification.request.content.body, + "userInfo": tNotification.request.content.userInfo + ] + ] + ] + ] + } + + private func getTokenString(deviceToken: Data) -> String { + return deviceToken.map { String(format: "%02.2hhx", $0) }.joined() + } + + private func notifyUpdatedAPNsToken() { + guard mEnabled else { + return + } + + mChannel.invokeMethod("updateAPNsToken", arguments: mTokenData) + } + + public func applicationDidBecomeActive(_ application: UIApplication) { + guard mEnabled else { + return + } + + UIApplication.shared.applicationIconBadgeNumber = 0 + } + + public func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { + mTokenData = getTokenString(deviceToken: deviceToken) + notifyUpdatedAPNsToken() + } + + public func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) { + UIApplication.shared.applicationIconBadgeNumber = 0 + } + + public func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) -> Bool { + guard mEnabled else { + return false + } + + if UIApplication.shared.applicationState == .background { + // No need to handle BG data + completionHandler(.newData) + } else { + mChannel.invokeMethod("didReceiveRemoteNotification", arguments: userInfo) + completionHandler(.noData) + } + + return true + } + + public func userNotificationCenter(_ center: UNUserNotificationCenter, + willPresent notification: UNNotification, + withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) { + completionHandler([.alert]) + } + + public func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) { + mInitialNotification = dictionaryFromNotificationResponse(notification: response) + UIApplication.shared.applicationIconBadgeNumber = 0 + mChannel.invokeMethod("didReceiveNotificationResponse", arguments: mInitialNotification) + completionHandler() + } +} diff --git a/packages/patapata_apple_push_notifications/ios/patapata_apple_push_notifications.podspec b/packages/patapata_apple_push_notifications/ios/patapata_apple_push_notifications.podspec new file mode 100644 index 0000000..c2458f1 --- /dev/null +++ b/packages/patapata_apple_push_notifications/ios/patapata_apple_push_notifications.podspec @@ -0,0 +1,25 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_apple_push_notifications.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_apple_push_notifications' + s.version = '0.0.1' + s.summary = 'A new flutter plugin project.' + s.description = <<-DESC +A new flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'Flutter' + s.platform = :ios, '10.0' + + s.dependency 'patapata_core' + + # Flutter.framework does not contain a i386 slice. + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_apple_push_notifications/lib/patapata_apple_push_notifications.dart b/packages/patapata_apple_push_notifications/lib/patapata_apple_push_notifications.dart new file mode 100644 index 0000000..7bb960d --- /dev/null +++ b/packages/patapata_apple_push_notifications/lib/patapata_apple_push_notifications.dart @@ -0,0 +1,187 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_apple_push_notifications; + +import 'package:flutter/services.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +final _logger = Logger('patapata.ApplePushNotificationsPlugin'); +const _channel = + MethodChannel('dev.patapata.patapata_apple_push_notifications'); + +/// A plugin that provides Apple push notification functionality to Patapata. +class ApplePushNotificationsPlugin extends Plugin { + final _messagesController = StreamController.broadcast(); + final _tokensController = StreamController.broadcast(); + + @override + String get name => 'dev.patapata.patapata_apple_push_notifications'; + + /// Initializes the [ApplePushNotificationsPlugin]. + @override + FutureOr init(App app) async { + await super.init(app); + + _channel.setMethodCallHandler(_handleMethodCall); + + return true; + } + + @override + FutureOr dispose() async { + await super.dispose(); + } + + @override + RemoteMessaging createRemoteMessaging() => + ApplePushNotificationsRemoteMessaging(this); + + RemoteMessage _createRemoteMessage(Map response) { + final tNotification = Map.castFrom( + response['notification'] as Map); + final tRequest = Map.castFrom( + tNotification['request'] as Map); + final tContent = Map.castFrom( + tRequest['content'] as Map); + + return RemoteMessage( + messageId: tRequest['identifier'], + data: Map.castFrom( + tContent['userInfo'] as Map), + notification: (tContent['title'] as String?)?.isNotEmpty == true || + (tContent['body'] as String?)?.isNotEmpty == true + ? RemoteMessageNotification( + title: tContent['title'] as String?, + body: tContent['body'] as String?, + ) + : null, + ); + } + + Future _handleMethodCall(MethodCall call) async { + switch (call.method) { + case 'updateAPNsToken': + final tToken = call.arguments as String?; + _logger.info('updateAPNsToken:$tToken'); + _tokensController.add(tToken); + break; + case 'didReceiveRemoteNotification': + final tUserInfo = Map.castFrom( + call.arguments as Map); + _logger.info('didReceiveRemoteNotification:$tUserInfo'); + // _messagesController.add(RemoteMessage( + // messageId: '', + // data: tUserInfo, + // notification: RemoteMessageNotification(), + // )); + break; + case 'didReceiveNotificationResponse': + final tResponse = Map.castFrom( + call.arguments as Map); + _logger.info('didReceiveNotificationResponse:$tResponse'); + + _messagesController.add(_createRemoteMessage(tResponse)); + break; + default: + break; + } + } + + /// A [Stream] that can be listened to for monitoring changes to [RemoteMessage]. + Stream get messages => _messagesController.stream; + + /// A [Stream] that can be used to monitor changes to the token. + Stream get tokenStream => _tokensController.stream; + + /// Returns a Future for the initial Apple notification RemoteMessage. + Future getInitialNotification() async { + final tNotificationResponse = await _channel + .invokeMapMethod('getInitialNotification'); + + return tNotificationResponse != null + ? _createRemoteMessage(tNotificationResponse) + : null; + } + + /// Returns a Future for the token required for the application to use RemoteMessage. + Future getToken() { + return _channel.invokeMethod('getToken'); + } +} + +/// A class for monitoring remote messages of Apple push notifications. +class ApplePushNotificationsRemoteMessaging extends RemoteMessaging { + final ApplePushNotificationsPlugin _instance; + + StreamSubscription? _onMessageSubscription; + StreamSubscription? _onTokensSubscription; + + final _messagesController = StreamController.broadcast(); + final _tokensController = StreamController.broadcast(); + + /// Creates a [ApplePushNotificationsRemoteMessaging]. + ApplePushNotificationsRemoteMessaging(this._instance); + + /// Initializes the [ApplePushNotificationsRemoteMessaging]. + @override + Future init(App app) async { + await super.init(app); + + _onMessageSubscription = _instance.messages.listen(_onMessage); + _onTokensSubscription = _instance.tokenStream.listen(_onToken); + } + + @override + void dispose() { + _onMessageSubscription?.cancel(); + _onMessageSubscription = null; + _onTokensSubscription?.cancel(); + _onTokensSubscription = null; + super.dispose(); + } + + void _onMessage(RemoteMessage message) async { + _logger.info( + '_onMessage:{messageId:${message.messageId} channel:${message.channel}, data:${message.data}}'); + + _messagesController.add(message); + } + + void _onToken(String? token) { + _logger.info('_onToken:$token'); + + _tokensController.add(token); + } + + @override + Future getInitialMessage() async { + return _instance.getInitialNotification(); + } + + @override + Stream get messages => _messagesController.stream; + + @override + Stream get tokens => _tokensController.stream; + + @override + Future getToken() async { + return _instance.getToken(); + } + + @override + // ignore: must_call_super + FutureOr listenChannel(String channel) async { + return false; + } + + @override + // ignore: must_call_super + FutureOr ignoreChannel(String channel) async { + return false; + } +} diff --git a/packages/patapata_apple_push_notifications/melos_patapata_apple_push_notifications.iml b/packages/patapata_apple_push_notifications/melos_patapata_apple_push_notifications.iml new file mode 100644 index 0000000..9fc8ce7 --- /dev/null +++ b/packages/patapata_apple_push_notifications/melos_patapata_apple_push_notifications.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_apple_push_notifications/pubspec.yaml b/packages/patapata_apple_push_notifications/pubspec.yaml new file mode 100644 index 0000000..3f57829 --- /dev/null +++ b/packages/patapata_apple_push_notifications/pubspec.yaml @@ -0,0 +1,26 @@ +name: patapata_apple_push_notifications +description: This package is a plugin for Patapata that adds support for Apple Push Notifications to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_apple_push_notifications + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: + plugin: + platforms: + ios: + pluginClass: PatapataApplePushNotificationsPlugin diff --git a/packages/patapata_apple_push_notifications/test/patapata_apple_push_notifications_test.dart b/packages/patapata_apple_push_notifications/test/patapata_apple_push_notifications_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_apple_push_notifications/test/patapata_apple_push_notifications_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_apps_flyer/.gitignore b/packages/patapata_apps_flyer/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_apps_flyer/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_apps_flyer/.metadata b/packages/patapata_apps_flyer/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_apps_flyer/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_apps_flyer/CHANGELOG.md b/packages/patapata_apps_flyer/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_apps_flyer/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_apps_flyer/LICENSE b/packages/patapata_apps_flyer/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_apps_flyer/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_apps_flyer/README.md b/packages/patapata_apps_flyer/README.md new file mode 100644 index 0000000..679a39f --- /dev/null +++ b/packages/patapata_apps_flyer/README.md @@ -0,0 +1,70 @@ +
+

Patapata - AppsFlyer

+

+ Add support for AppsFlyer to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [AppsFlyer](https://www.appsflyer.com/) to your Patapata app. +It currently only supports setting the user ID for AppsFlyer via the `setCustomerUserId` method, as well as registering for conversion data callbacks. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```yaml +dependencies: + patapata_apps_flyer: + git: + url: git://github.com/gree/patapata.git + path: packages/patapata_apps_flyer +``` + +2. Import the package + +```dart +import 'package:patapata_apps_flyer/patapata_apps_flyer.dart'; +``` + +3. Activate the plugin + +```dart +/// This Environment takes AppsFlyer configuration from environment variables. +/// Pass environment variables to your app using the `--dart-define` flag. +class Environment extends AppsFlyerPluginEnvironment { + const Environment(); + + /// The AppsFlyer devKey. + @override + String get appsFlyerDevKey => const String.fromEnvironment('APPS_FLYER_DEV_KEY'); + + /// AppsFlyer's iOS `appId`. + @override + String get appsFlyerAppIdIOS => const String.fromEnvironment('APPS_FLYER_APP_ID_IOS'); + + /// AppsFlyer's Android `appId`. + @override + String get appsFlyerAppIdAndroid => const String.fromEnvironment('APPS_FLYER_APP_ID_ANDROID'); +} + +void main() { + App( + environment: const Environment(), + plugins: [ + AppsFlyerPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_apps_flyer/LICENSE) \ No newline at end of file diff --git a/packages/patapata_apps_flyer/analysis_options.yaml b/packages/patapata_apps_flyer/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_apps_flyer/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_apps_flyer/dartdoc_options.yaml b/packages/patapata_apps_flyer/dartdoc_options.yaml new file mode 100644 index 0000000..0d35966 --- /dev/null +++ b/packages/patapata_apps_flyer/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_apps_flyer \ No newline at end of file diff --git a/packages/patapata_apps_flyer/ios/.gitignore b/packages/patapata_apps_flyer/ios/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_apps_flyer/ios/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_apps_flyer/ios/Assets/.gitkeep b/packages/patapata_apps_flyer/ios/Assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.h b/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.h new file mode 100644 index 0000000..1b8779c --- /dev/null +++ b/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataAppsFlyerPlugin : NSObject +@end diff --git a/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.m b/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.m new file mode 100644 index 0000000..05c3773 --- /dev/null +++ b/packages/patapata_apps_flyer/ios/Classes/PatapataAppsFlyerPlugin.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataAppsFlyerPlugin.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_apps_flyer-Swift.h" +#endif + +@implementation PatapataAppsFlyerPlugin ++ (void)registerWithRegistrar:(NSObject*)registrar { + [SwiftPatapataAppsFlyerPlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_apps_flyer/ios/Classes/SwiftPatapataAppsFlyerPlugin.swift b/packages/patapata_apps_flyer/ios/Classes/SwiftPatapataAppsFlyerPlugin.swift new file mode 100644 index 0000000..9bc6817 --- /dev/null +++ b/packages/patapata_apps_flyer/ios/Classes/SwiftPatapataAppsFlyerPlugin.swift @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter + +public class SwiftPatapataAppsFlyerPlugin: NSObject, FlutterPlugin { + public static func register(with registrar: FlutterPluginRegistrar) { + let tInstance = SwiftPatapataAppsFlyerPlugin() + } +} diff --git a/packages/patapata_apps_flyer/ios/patapata_apps_flyer.podspec b/packages/patapata_apps_flyer/ios/patapata_apps_flyer.podspec new file mode 100644 index 0000000..478b82c --- /dev/null +++ b/packages/patapata_apps_flyer/ios/patapata_apps_flyer.podspec @@ -0,0 +1,23 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_apps_flyer.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_apps_flyer' + s.version = '0.0.1' + s.summary = 'A new flutter plugin project.' + s.description = <<-DESC +A new flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'Flutter' + s.platform = :ios, '8.0' + + # Flutter.framework does not contain a i386 slice. + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_apps_flyer/lib/patapata_apps_flyer.dart b/packages/patapata_apps_flyer/lib/patapata_apps_flyer.dart new file mode 100644 index 0000000..51b2ff3 --- /dev/null +++ b/packages/patapata_apps_flyer/lib/patapata_apps_flyer.dart @@ -0,0 +1,97 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_apps_flyer; + +import 'dart:async'; + +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:appsflyer_sdk/appsflyer_sdk.dart'; + +/// Configuration for [AppsflyerSdk]. +mixin AppsFlyerPluginEnvironment { + /// AppsFlyer's devKey. + String get appsFlyerDevKey; + + /// AppsFlyer's iOS `appId`. + String get appsFlyerAppIdIOS; + + /// AppsFlyer's Android `appId`. + String get appsFlyerAppIdAndroid; +} + +/// A plugin that provides functionality for AppsFlyer in Patapata. +class AppsFlyerPlugin extends Plugin { + late AppsflyerSdk _sdk; + + /// A reference to the [AppsflyerSdk] instance. + AppsflyerSdk get sdk => _sdk; + + /// Initializes the [AppsFlyerPlugin]. + @override + FutureOr init(App app) async { + if (app.environment is! AppsFlyerPluginEnvironment) { + return false; + } + + final tDevKey = _environment.appsFlyerDevKey; + final tAppId = defaultTargetPlatform == TargetPlatform.iOS + ? _environment.appsFlyerAppIdIOS + : _environment.appsFlyerAppIdAndroid; + + if (tDevKey.isEmpty || tAppId.isEmpty) { + return false; + } + + await super.init(app); + + var tIsDebug = false; + + assert(() { + tIsDebug = true; + return true; + }()); + + _sdk = AppsflyerSdk(AppsFlyerOptions( + afDevKey: tDevKey, + appId: tAppId, + showDebug: tIsDebug, + timeToWaitForATTUserAuthorization: 60.0, + )); + + app.user.addSynchronousChangeListener(_onUserChanged); + if (app.permissions.trackingRequested) { + await initSdk(); + } else { + app.permissions.trackingStream.first.then((_) => initSdk); + } + + return true; + } + + AppsFlyerPluginEnvironment get _environment => + app.environment as AppsFlyerPluginEnvironment; + + @override + FutureOr dispose() { + app.user.removeSynchronousChangeListener(_onUserChanged); + + return super.dispose(); + } + + /// Initializes the [AppsflyerSdk]. + Future initSdk() async { + await _sdk.initSdk( + registerConversionDataCallback: true, + registerOnAppOpenAttributionCallback: false, + registerOnDeepLinkingCallback: false, + ); + } + + FutureOr _onUserChanged(User user, UserChangeData changes) { + _sdk.setCustomerUserId(changes.id ?? ''); + } +} diff --git a/packages/patapata_apps_flyer/pubspec.yaml b/packages/patapata_apps_flyer/pubspec.yaml new file mode 100644 index 0000000..cff6cb1 --- /dev/null +++ b/packages/patapata_apps_flyer/pubspec.yaml @@ -0,0 +1,29 @@ +name: patapata_apps_flyer +description: This package is a plugin for Patapata that adds support for AppsFlyer to your Patapata app. +version: 1.0.0 +publish_to: none +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_apps_flyer + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + appsflyer_sdk: ^6.11.3 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: + plugin: + platforms: + ios: + pluginClass: PatapataAppsFlyerPlugin diff --git a/packages/patapata_apps_flyer/test/patapata_apps_flyer_test.dart b/packages/patapata_apps_flyer/test/patapata_apps_flyer_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_apps_flyer/test/patapata_apps_flyer_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_core/.github/assets/logo_pata2_horizontal.png b/packages/patapata_core/.github/assets/logo_pata2_horizontal.png new file mode 100644 index 0000000..c1b3419 Binary files /dev/null and b/packages/patapata_core/.github/assets/logo_pata2_horizontal.png differ diff --git a/packages/patapata_core/.gitignore b/packages/patapata_core/.gitignore new file mode 100644 index 0000000..36cf1be --- /dev/null +++ b/packages/patapata_core/.gitignore @@ -0,0 +1,79 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/doc/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 +!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages + +# File generated when the golden test fails. +/test/failures diff --git a/packages/patapata_core/.metadata b/packages/patapata_core/.metadata new file mode 100644 index 0000000..616b046 --- /dev/null +++ b/packages/patapata_core/.metadata @@ -0,0 +1,10 @@ +# 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: e6b34c2b5c96bb95325269a29a84e83ed8909b5f + channel: stable + +project_type: package diff --git a/packages/patapata_core/.vscode/launch.json b/packages/patapata_core/.vscode/launch.json new file mode 100644 index 0000000..47f82b8 --- /dev/null +++ b/packages/patapata_core/.vscode/launch.json @@ -0,0 +1,20 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Patapata Example Material App", + "request": "launch", + "type": "dart", + "program": "example/lib/main.dart" + }, + { + "name": "Patapata Example Cupertino App", + "request": "launch", + "type": "dart", + "program": "example/lib/main_cupertino.dart" + } + ] +} \ No newline at end of file diff --git a/packages/patapata_core/.vscode/settings.json b/packages/patapata_core/.vscode/settings.json new file mode 100644 index 0000000..da2017b --- /dev/null +++ b/packages/patapata_core/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "dart.flutterSdkPath": "/Users/jason.parrott/source/flutter-3.7.7" +} \ No newline at end of file diff --git a/packages/patapata_core/CHANGELOG.md b/packages/patapata_core/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_core/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_core/LICENSE b/packages/patapata_core/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_core/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_core/README.md b/packages/patapata_core/README.md new file mode 100644 index 0000000..129a944 --- /dev/null +++ b/packages/patapata_core/README.md @@ -0,0 +1,1006 @@ +
+

Patapata

+ +
+ +
+ +

+ A collection of best-practices and tools for building applications quickly and reliably. +

+ +

+ Project Homepage +

+ +

+ + GitHub Workflow Status (branch) + + + Pub Popularity + + + Maintained with Melos + + + License + + + + +

+ +
+ +--- + +## Table of Contents + - [About](#about) + - [Supported Platforms](#supported-platforms) + - [Getting started](#getting-started) + - [Bootstrap](#bootstrap) + - [Usage](#usage) + - [Environment](#environment) + - [App](#app) + - [App startup flow](#app-startup-flow) + - [Startup Sequence](#startup-sequence) + - [User](#user) + - [Standard App](#standard-app) + - [Internationalization and localization (I18n and L10n)](#internationalization-and-localization-(i18n-and-l10n)) + - [Logging and error handling](#logging-and-error-handling) + - [Notifications](#notifications) + - [Utilities](#utilities) + - [Finite State Machine](#finite-state-machine) + - [Sequential Work Queue](#sequential-work-queue) + - [Fake DateTime](#fake-datetime) + - [Provider Model](#provider-model) + - [Screen Layout](#screen-layout) + - [Platform Dialog](#platform-dialog) + - [Testing your application](#testing-your-application) + - [Testing in the IDE](#testing-in-the-ide) + - [Contributing](#contributing) + - [License](#license) + +## About + +Patapata is a framework built on Flutter for creating applications of production quality quickly and reliably. +It provides a collection of best-practices built directly in to the various APIs so you can build apps that are consistent, stable, and performant. + +Patapata Core is the core framework that provides the basic building blocks for your application. +You will always depend on this package in your application to use Patapata. +In addition, you can use any of the plugins that Patapata provides to add additional functionality to your application. +See the [homepage](https://github.com/gree/patapata) for details. + +### Supported Platforms + +We try to support the newest version of Flutter and will not purposely keep support for older versions if something is deprecated on the Flutter side. + +The Patapata team believes that it is important to keep up to date with the latest version of Flutter as in our expierence with real world applications, old versions of Flutter have trouble supporting the newer versions of Android and especially iOS. + +Currently, we support Flutter 3.13.0 and above, with a minimum Dart version of 3.0.0 up to 4.0.0. + +We officially support Android, iOS fully, and best effort for Web and MacOS. +Windows and Linux are currently not supported. + +## Getting started + +To just get the standard Patapata experience and have an app up and running, execute the following in a terminal: + +```bash +flutter create my_app +cd my_app +flutter pub add patapata_core +dart run patapata_core:bootstrap +``` + +Note that this will change the minimum Android SDK version to 21 and the minimum iOS version to 12.0. + +You should be able to run your application! + +### Bootstrap + +As in the example above, you can use the `bootstrap` command to quickly get started with Patapata. + +This command will: +- Generate an `Environment` file for you with `I18nEnvironment` and `LogEnvironment` setup by default +- Generate a `main.dart` file that will create a `Standard App` for you with default settings for almost all of Patapata's features, and a place to add your own `Provider` models to be accessable throughout your application. +- Generate a `Startup Sequence` that has a splash screen, a fake agreement page, and finally a home page. +- Generate a default error page for when your app encounters a fatal error. +- Generate an error class that supports the `PatapataException` system for your app in it's own namespace. +- Enable [Flutter's deep link system](https://docs.flutter.dev/ui/navigation/deep-linking) that `Standard App` will use for external links to your application +- Setup the `L10n` system (localization) for your application with default yaml files for English (by default) + +## Usage + +Patapata has many different systems that all work together to make an application that is easy to maintain and extend. +Each system of Patapata has [documentation](https://pub.dev/documentation/patapata_core/latest/) that you can read to learn more about it. + +Patapata strives to make not just development, but maintence of your application easy and as automatic as possible. + +Especially if you use the `bootstrap` command setup, you have automatic logging and reporting of errors to any supported 3rd party service, automatic remote configuration of your application, and localization support ready to go (just add text to your yaml files). You have a splash screen and start up sequence with deep linking out of the box, error handling out of the box, standard features that basically all applications use ready to go (such as package information, device information, local configuration, network information, etc). You also have an analytics system that automatically is sending routing events, page data changing events, lifecycle events, and more. + +Developer tools such a Finite State Machine system, a work queue system, a concept of a User, multiple screen size auto layout and more are all available to you. + +Tools such as a fake DateTime system exist to make QA testing and backend testing easier as well. + +Patapata provides a few must have packages that can be easily accessed without manually importing by importing `package:patapata_core/patapata_core_libs.dart`. + +These packages are: +- [provider](https://pub.dev/packages/provider) +- [logging](https://pub.dev/packages/logging) +- [timezone](https://pub.dev/packages/timezone) +- [visibility_detector](https://pub.dev/packages/visibility_detector) +- [flutter_local_notifications](https://pub.dev/packages/flutter_local_notifications) + +### Environment + +The `Environment` class is responsible for setting up the environment for your application. +This class is something you create yourself, and pass to `App` when you create it. + +The concept is that your `Environment` class will mixin multiple `Environment` mixins that are provided by Patapata and plugins. Each of these mixins will setup a different part of your application's environment. + +All of the `Environment` mixins following a naming convention of `NameEnvironment`, where `Name` is the name of the system that it is setting up. + +In general you should try very hard to make your `Environment` class `const` so that it can be used in a `const` context. +This is important so that any tree shaking that Flutter does will remove any code that is not used in your application as well as for performance reasons. + +Also, if you use one of the [String.fromEnvironment](https://api.flutter.dev/flutter/dart-core/String/String.fromEnvironment.html) methods, if you don't use a `const` certain platforms will not function correctly. +The `String.fromEnvironment` and friends can be used to pass in environment variables to your application at build time via the `--dart-define` flag. + +Here is a simple example of an `Environment` class: + +```dart +class Environment + with + I18nEnvironment, + LogEnvironment, + SentryEnvironment { + /// A base URL for your API. + final String apiBaseUrl; + + /// An API key for your API. + final String apiKey; + + /// Set's what locales your application supports. + @override + final List supportedL10ns = const [Locale('en')]; + + /// Set's where your application will look for localization files. + @override + final List l10nPaths = const [ + 'l10n', + ]; + + /// The default log level. + @override + final int logLevel; + + /// Whether or not to print logs to the console. + @override + final bool printLog; + + /// The Sentry DSN to use if for example you are using Sentry. + @override + final String sentryDSN; + + /// A function that will be called to setup Sentry. + @override + final FutureOr Function(SentryFlutterOptions)? sentryOptions = null; + + const MyEnvironment({ + this.apiBaseUrl = const String.fromEnvironment('API_BASE_URL'), + this.apiKey = const String.fromEnvironment('API_KEY'), + this.logLevel = + const int.fromEnvironment('LOG_LEVEL', defaultValue: -kPataInHex), + this.printLog = + const bool.fromEnvironment('PRINT_LOG', defaultValue: kDebugMode), + this.sentryDSN = const String.fromEnvironment('SENTRY_DSN'), + }); +} + +void main() async { + App( + environment: const Environment(), + .... + ) + .run(); +} +``` + +### App + +The [App](https://pub.dev/documentation/patapata_core/latest/patapata_core/App-class.html) class is the main entry point for your application. +It is responsible for setting up all of Patapata's systems and plugins, and then running your application. + +Your entire application will be run inside a special `Zone` that Patapata manages. +When in this `Zone`, you can access the current `App` via the [getApp](https://pub.dev/documentation/patapata_core/latest/patapata_core/getApp.html) function. + +```dart +getApp().environment.apiBaseUrl; +``` + +Your application will also be the child of several `Provider` widgets that are provided by Patapata that allow you to listen to changes via [context.watch](https://pub.dev/documentation/provider/latest/provider/WatchContext/watch.html), [context.select](https://pub.dev/documentation/provider/latest/provider/SelectContext/select.html) and friends. + +```dart +Widget build(BuildContext context) { + final tOnline = context.select( + (v) => v.connectivity != NetworkConnectivity.none + ); + + if (tOnline) { + return const Text('Online'); + } else { + return const Text('Offline'); + } +} +``` + +`App` also exposes `Provider`s for: +- The `App` itself +- The genericly typed `Environment` version of your `App` as `App` +- The `Environment` +- [User](https://pub.dev/documentation/patapata_core/latest/patapata_core/User-class.html) + - A class to manage the concept of a 'user' in your application +- [RemoteConfig](https://pub.dev/documentation/patapata_core/latest/patapata_core/RemoteConfig-class.html) + - A class to access remote configuration data for your application +- [LocalConfig](https://pub.dev/documentation/patapata_core/latest/patapata_core/LocalConfig-class.html) + - A class to access locally stored simple key value data for your application +- [RemoteMessaging](https://pub.dev/documentation/patapata_core/latest/patapata_core/RemoteMessaging-class.html) + - A class to access remote messaging data for your application, such as push notifications. +- [Analytics](https://pub.dev/documentation/patapata_core/latest/patapata_core/Analytics-class.html) + - A class to collect and send analytics data for your application +- The global [AnalyticsContext](https://pub.dev/documentation/patapata_core/latest/patapata_core/AnalyticsContext-class.html) +- [NetworkInformation](https://pub.dev/documentation/patapata_core/latest/patapata_core/NetworkInformation-class.html) as a [StreamProvider](https://pub.dev/documentation/provider/latest/provider/StreamProvider-class.html) +- [PackageInfoPlugin](https://pub.dev/documentation/patapata_core/latest/patapata_core/PackageInfoPlugin-class.html) + - Quick access to all meta information about your application +- [DeviceInfoPlugin](https://pub.dev/documentation/patapata_core/latest/patapata_core/DeviceInfoPlugin-class.html) + - Quick access to all information about the device your application is running on + +Some of which are listenable (and therefore watch and selectable). + +#### App startup flow + +The `App` class goes through a series of steps to setup your application that have specific rules for when things are initialized and when you are allowed to access the various systems of Patapata. + +In general, as a developer who is not customizing with `Plugin`s, you should not have to worry about this and can just use the `App` class as is. + +`App` goes through the steps are defined in [AppStage](https://pub.dev/documentation/patapata_core/latest/patapata_core/AppStage.html). + +1. `setup` - The first stage where the `App` hasn't done any operations and `run` hasn't been executed yet. Nothing is initialized at this point and attempts to access any API except for `the add/remove/hasPlugin` methods will result in undefined behavior. Usually an exception will be thrown. +2. `bootstrap` - This stage is entered upon execution of `run`. Immediately after entering this stage, the following are executed synchronously: + 1. Flutter's services are initialized made useable + 2. The special `Zone` that Patapata manages is created an entered + 3. The [Log](https://pub.dev/documentation/patapata_core/latest/patapata_core/Log-class.html) system becomes useable + 4. Flutter's [ErrorWidget.builder](https://api.flutter.dev/flutter/widgets/ErrorWidget/builder.html) is set to [nonDebugErrorWidgetBuilder](https://pub.dev/documentation/patapata_core/latest/patapata_core/App/nonDebugErrorWidgetBuilder.html) + 5. The callback passed to `run` will be executed in a non-asynchronous manner so you are guaranteed that you are still on the same dart task as when `main` was executed During this stage +3. `initializingPlugins` - The default `Plugin`s and `Plugins`s passed to the `App` are initialized. First, `Plugin`s that have [requireRemoteConfig](https://pub.dev/documentation/patapata_core/latest/patapata_core/Plugin/requireRemoteConfig.html) set to `false` are initialized, allowing for `RemoteConfig` `Plugin`s to be be available and allow remote disabling of `Plugin`s via `RemoteConfig`. If any `Plugin`s fail to initialize, [onInitFailure](https://pub.dev/documentation/patapata_core/latest/patapata_core/App/onInitFailure.html) is called or if null, the error is printed to the console and your app fails to start. +4. `setupRemoteConfig` - The `RemoteConfig` system is initialized and is useable after this point. Patapata will attempt to fetch the newest remote config data with a 2 second timeout. A timeout will not generate an error and will just delay the start of your application by those 2 seconds. +5. `initializingPluginsWithRemoteConfig` - The remaining non-initialized `Plugin`s are initialized and remotely removed `Plugin`s are removed (and are never initialized). If any `Plugin`s fail to initialize, [onInitFailure](https://pub.dev/documentation/patapata_core/latest/patapata_core/App/onInitFailure.html) is called or if null, the error is printed to the console and your app fails to start. +6. `running` - At this stage, all of `Patapata`'s systems are useable. [createAppWidget](https://pub.dev/documentation/patapata_core/latest/patapata_core/App/createAppWidget.html) is wrapped with all the `Provider`s set up by `App`, and wrapped with the `Analytics` system's pointer listener for tracking all pointer events. + +If at any point during the above sequence an unhandled error is thrown, `App` will remove the native splash screen, and attempt to report the error to the logging system. + +### Startup Sequence + +The [StartupSequence](https://pub.dev/documentation/patapata_core/latest/patapata_core/StartupSequence-class.html) class can help you create a startup flow for your application. + +You should almost always use this though it is not required. + +A Startup Sequence would be a list of actions your app _always_ performs on startup. +You can provide conditions for each action to be executed, and provide a flow until the processing of the initial actual 'home' page of your application is ready to be shown (or a deep linked page). + +The most general use case for this is to show a splash screen, then show a terms of service page, then show a login page, then show the home page. + +### User + +The [User](https://pub.dev/documentation/patapata_core/latest/patapata_core/User-class.html) class is a class that represents a user of your application. +It is a `ChangeNotifier` so you can listen to changes to the user's data. + +The `User` class is a generic class that you can use to represent any type of user you want. + +You can extend this class to make a unique user class for your application, and let Patapata know about it by passing the [userFactory](https://pub.dev/documentation/patapata_core/latest/patapata_core/App/userFactory.html) parameter to `App`. + +The `User` is used by the `Analytics` system to track user data, and `Plugin`s can use it to track user data and to provide user specific functionality, log in and out functionality, etc automatically. + +For example, the `patapata_firebase_analytics`, `patapata_firebase_crashlytics`, and `patapata_sentry` plugins all use the `User` class to assign properties to the user in their respective systems. + +### Standard App + +Standard App is an optional, but highly recommended `Plugin` that is enabled by default that you can use to add the concept of a 'page' to your application, and add full support for running an production quality application with very little code. + +To use it, you pass either the [StandardMaterialApp](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/StandardMaterialApp-class.html) or [StandardCupertinoApp](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/StandardMaterialApp-class.html) to your `App`'s `createAppWidget` parameter. + +From there, you define your standard Flutter `MaterialApp` or `CupertinoApp` settings as normal as well as a list of 'pages' that exist in your application. + +Each of these pages is a `StatefulWidget` that extends [StandardPage](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/StandardPage-class.html). + +```dart +void main() { + App( + createAppWidget: (context, app) => StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // This is the landing page for the application. + StandardPageFactory( + create: (_) => HomePage(), + links: { + // An empty deep link means this page will be shown when the app is opened externally without directly specifying a page. + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + // Home will _always_ exist in the navigation stack with this setting. + groupRoot: true, + ), + // This is just an example of another simple page definition. + StandardPageFactory( + create: (_) => SettingsPage(), + links: { + r'settings': (match, uri) {}, + }, + linkGenerator: (pageData) => 'settings', + ), + // This is an example of a page that has a page data object. + StandardPageFactory( + create: (_) => SearchPage(), + links: { + // When 'search' as a deep link is opened, this page will be shown, + // mapping the uri data to the required page data object. + r'search': (match, uri) { + return SearchPageData( + query: uri.queryParameters['q'] ?? '', + reverseSort: uri.queryParameters['r'] == '1', + ); + }, + }, + // This regenerates the deep link for this page based off the current page data. + linkGenerator: (pageData) => Uri( + path: 'search', + queryParameters: { + 'q': pageData.query, + 'r': pageData.reverseSort ? '1' : '0', + }, + ).toString(), + ), + ], + theme: ThemeData( + primarySwatch: Colors.blue, + ), + ), + ) + .run(); +} + +/// This is the simplest page definition. +class HomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'home.title')), + ), + body: Center( + child: Text(l(context, 'home.body')), + ), + ); + } +} + +class SearchPageData { + final String query; + final bool reverseSort; + + const SearchPageData({ + required this.query, + this.reverseSort = false, + }); +} + +/// This is a page that has a page data object. +class SearchPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'search.title')), + ), + body: Center( + // You can access the pageData anywhere. + child: Text(pageData.query), + ), + ); + } +} +``` + +You can also define a page that returns a result to whoever if opened it. + +```dart +void checkWhatUserWants() { + if (await context.goWithResult) { + // The user said yes. + } else { + // The user said no. + } +} + +/// This time use [StandardPageWithResult] instead of [StandardPage]. +/// The final generic type is the return type. +class AskUserPage extends StandardPageWithResult { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + body: Center( + child: Column( + children: [ + Text(l(context, 'ask.body')), + ElevatedButton( + onPressed: () { + // The traditional, not type safe way + Navigator.pop(context, true); + }, + child: Text(l(context, 'ask.yes')), + ), + ElevatedButton( + onPressed: () { + // The new type safe way. + // Set the result any time you want. + pageResult = false; + + // Then remove the current route later. + context.removeRoute(); + // or Navigator.pop(context); + }, + child: Text(l(context, 'ask.no')), + ), + ], + ), + ), + ); + } +} + +void main() { + App( + createAppWidget: (context, app) => StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // Use this factory for result pages. + StandardPageWithResultFactory( + create: (_) => AskUserPage(), + ), + ], + ), + ) + .run(); +} +``` + +Quite often, for example, in a search page, you can change the original page data object and want to update the deep link to the current page. `StandardPage` has a `pageData` property that you can set to update the deep link. The `StandardPage` itself is also set in a provider so you can access it from anywhere in your page's widget tree. This allows child widgets to access the page data as well. + +```dart +class SearchPageData { + final String query; + final bool reverseSort; + + const SearchPageData({ + required this.query, + this.reverseSort = false, + }); +} + +final _logger = Logger('SearchPage'); + +class SearchPage extends StandardPage { + @override + void onPageData() { + // If you want to do something every time the page data changes, + // you can override this method. + _logger.info('pageData changed: $pageData'); + } + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'search.title')), + ), + body: Column( + children: [ + ElevatedButton( + onPressed: () { + // This will update the deep link to the current page. + // As well as fire off related analytics events. + setState(() { + pageData = SearchPageData( + query: pageData.query, + reverseSort: !pageData.reverseSort, + ); + }); + }, + child: Text(l(context, 'search.toggleSort')), + ), + Text('${pageData.query}: ${pageData.reverseSort}'), + ], + ), + ); + } +} +``` + +A `StandardPage` automatically sets up several analytics features related to page navigation and lifecycle events, as well as when page data changes. Watch the flow of analytics events in your debug log to see what is happening. + +You may often want to customize your entire application but need access to `MaterialApp`'s various features such as `Theme`, `MediaQuery` and more. You may also want to provide a global user interface that wraps all of your pages. + +To do all of this, use the [routableBuilder](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/StandardMaterialApp/routableBuilder.html) parameter of `MaterialStandardApp` and `CupertinoStandardApp`. + +```dart +void main() { + App( + createAppWidget: (context, app) => StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // your pages here + ], + routableBuilder: (context, child) { + return Stack( + children: [ + child, + Positioned( + bottom: 0, + right: 0, + width: 100, + child: ElevatedButton( + onPressed: () { + // You can use this context to navigate. + // However, Navigator.of will not work. + // The reason is [child] is the [Navigator]. + context.go(null); + }, + child: Text(l(context, 'mypage')), + ) + ), + ], + ); + }, + ), + ) + .run(); +} +``` + +`StandardPage` also keeps track of your page's active and inactive lifecycle events. +A page is 'active' when it is the top page in the navigation stack. A page is 'inactive' when it is not the top page in the navigation stack. + +```dart +class MyPage extends StandardPage { + @override + void onActive(bool first) { + // This will be called when the page becomes active. + // [first] will be true on the first time a page becomes active. + // Usually that is when the page is first created. + super.onActive(); + } + + @override + void onInactive() { + // This will be called when the page becomes inactive. + super.onInactive(); + } + + @override + void onRefocus() { + // This will be called when the page is already active and is navigated to again. + } +} +``` + +To enable 100% automatic handling of deep links at startup, be sure to use [StartupSequence](https://pub.dev/documentation/patapata_core/latest/patapata_core/StartupSequence-class.html) and enable Flutter's default deep link handling. +All of this is done if you use the `bootstrap` command. + +## Internationalization and localization (I18n and L10n) + +Patapata has a built in system for internationalization and localization. +It will first of all automatially initialize the [timezone](https://pub.dev/packages/timezone) package so you can use all of it's features out of the box. + +As a small feature, Patapata provides an extension to `DateTime` that provides a few common methods for DateTime string formatting commonly used with APIs. +- [toUTCIso8601StringNoMSUS](https://pub.dev/documentation/patapata_core/latest/patapata_core/DateDateTimeExtension/toUTCIso8601StringNoMSUS.html) +- [asDateString](https://pub.dev/documentation/patapata_core/latest/patapata_core/DateDateTimeExtension/asDateString.html) + +The localization system of Patapata is a core feature that every app should heavily be using. +It is based on writing yaml files that contain your localized strings as a tree of key value pairs. + +It supports Flutter's [MessageFormat](https://api.flutter.dev/flutter/message_format/MessageFormat-class.html) system, which is a subset of the ICU MessageFormat syntax that can handle plurals and select statements (for genders, etc), as well just simple string interpolation. + +The yaml files can be hot reloaded and so development is easy and fast. + +You use the system with the [l](https://pub.dev/documentation/patapata_core/latest/patapata_core/l.html) function. + +```dart +Text(l(context, 'page1.title')); +``` + +Languages will change automatically when the user changes the language of their device. + +## Logging and error handling + +Logging is accomplished with dart's standard [logging](https://pub.dev/packages/logging) package. + +Patapata hooks in to the root Logger and provides a 'reporting' system you and plugins can use to filter, transform, and send to 3rd party services. + +```dart +getApp().log.addFilter((report) { + // Only log things that have errors attached. + return switch (report.error) { + null => null, + _ => report, + }; +}); +``` + +```dart +getApp().log.reports.listen((report) { + // Do something with this report. +}); +``` + +Logging to console is automatically disabled in release builds, and Patapata disables debugPrint and print for release builds automatically as well for security reasons. + +Patapata also provides a system for handling errors in your application. + +If you make all of your errors inherit from [PatapataException](https://pub.dev/documentation/patapata_core/latest/patapata_core/PatapataException-class.html), the logging system and various other systems can automatically perform actions when errors occur. They also will use the L10n system to localize errors. +Errors are also namespaced to that each section of your code or each plugin can have it's own error namespace and therefore error code to show to the user for quick user support. + +## Notifications + +Patapata currently uses [flutter_local_notifications](https://pub.dev/packages/flutter_local_notifications) for local notifications. + +Patapata will automatically set up the package for you with decent default settings. +To use it in your application, `import package:patapata_core/patapata_core_libs.dart` and follow the documentation for [flutter_local_notifications](https://pub.dev/packages/flutter_local_notifications) to display notifications. You should be able to jump right in to executing the API to show a notification. + +If you use `StandardApp`, notifications will automatically be wired to open deep links in your application or, if you want to handle a custom notification yourself with `StandardApp`, you can add a [link handler](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/StandardAppPlugin/addLinkHandler.html). + +If you do not use `StandardApp`, you can use the [NotificationPlugin's notification stream](https://pub.dev/documentation/patapata_core/latest/patapata_core/NotificationsPlugin/notifications.html) directly. + +```dart +getApp().getPlugin()?.notifications.listen((notification) { + // Do something with the notification. +}); +``` + +## Utilities + +There are a few utilities that Patapata provides that you can use in your application. + +### Finite State Machine + +Patapata has a [LogicStateMachine](https://pub.dev/documentation/patapata_core/latest/patapata_core/LogicStateMachine-class.html) class that you can use to create a finite state machine for your application. [StartupSequence](https://pub.dev/documentation/patapata_core/latest/patapata_core/StartupSequence-class.html) uses this class to manage it's state. + +### Sequential Work Queue + +Patapata has a [SequentialWorkQueue](https://pub.dev/documentation/patapata_core/latest/patapata_core/SequentialWorkQueue-class.html) class that you can use to create a work queue that will execute jobs in order, one at a time. + +It optionally supports adding jobs that can cancel previous jobs, including stopping the execution of actual dart code with callbacks to allow for cleanup. + +### Fake DateTime + +Patapata exposes a global getter called [now](https://pub.dev/documentation/patapata_core/latest/patapata_core/now.html) that you can use to get the current date and time. + +The definition of 'the current date and time' can be changed by using [setFakeNow](https://pub.dev/documentation/patapata_core/latest/patapata_core/setFakeNow.html), with options to persist the fake time across app restarts as well as having `now` to return the elapsed time since the fake time was set. + +This is useful for testing and debugging, as well as syncing your application to a 'server time'. + +We recommend using `now` instead of `DateTime.now()` for all uses of the current date and time in your application, except for when something relies on the user's actual local device time, or a time that must be accurate to an external source. + +### Provider Model + +Often while designing a model based system in dart, the 'model' needs to execute code asynchroniously to complete a modification to itself. For example, a model that needs to fetch data from a server. + +In these cases, it is very possible for that same model to get another request to update itself again with newer values. + +Sometimes, you want to cancel the previous request and only use the latest request. Sometimes, you want to queue up the requests and execute them in order. While other times, you want to make the second request invalid and not execute it at all. + +Setting up a system like this is error prone and time consuming. + +Patapata provides a class called [ProviderModel](https://pub.dev/documentation/patapata_core/latest/patapata_core/ProviderModel-class.html) that you can use to easily create a model that can handle all of these cases. + +It supports concepts such as 'variables' that are managed and 'transactions' that can be either queued, cancelled, or invalidated. We call these 'transactions' 'batches'. + +```dart +class MyModel extends ProviderModel { + final _key = ProviderLockKey('forUpdating'); + + late final _myVariable = createVariable('defaultValueHere'); + String get myVariable => _myVariable.unsafeValue; + + late final _myCounter = createVariable(0); + int get myCounter => _myCounter.unsafeValue; + + /// Update [myVariable] and [myCounter] 'atomically'. + /// If this is called in succession before the previous + /// execution finishes, the second execution will cancel + /// the first, and only the last value will be committed. + Future updateMyVariable(String newValue) { + return lock( + _key, + (batch) async { + // Increment the counter. + // At this point, we haven't commited the results + // to the model, so any access to [myCounter] will still + // not be updated. + batch.set(_myCounter, batch.get(_myCounter) + 1); + + if (newValue.isEmpty) { + batch.cancel(); + + return; + } + + // We pretend an API will update remote data. + // If it fails, we cancel the batch, and once again + // nothing will be updated locally. + // [blockOverride] is used to prevent the batch from + // being cancelled while in the middle of API execution + // because we don't want the API classes' Zone execution + // stop and not cleanup. + // If this batch was cancelled or overriden it will + // cancel after this API call finishes. + if (!await batch.blockOverride(() => api.updateMyVariable(newValue))) { + batch.cancel(); + + return; + } + + // Set the variable and commit the result to the model. + // On commit, anything listening to this + // variable will be updated. + batch.set(_myVariable, newValue); + batch.commit(); + }, + overridable: true, + override: true, + ); + } + + /// Update [myVariable] and [myCounter] 'atomically'. + /// This one will not cancel the previous execution, + /// but will instead fail immediately if another + /// execution is in progress. + bool updateMyVariableOnlyLocally(String newValue) { + try { + // If another lock is in progress, this will throw immediately. + final tBatch = begin(_key); + + tBatch.set(_myCounter, tBatch.get(_myCounter) + 1); + tBatch.set(_myVariable, newValue); + tBatch.commit(); + + return true; + } catch (e) { + return false; + } + } +} + +Widget build(BuildContext context) { + return Provider( + create: (_) => MyModel(), + child: Selector( + selector: (context, model) => model.myVariable, + builder: (context, myVariable, child) { + return Column( + children: [ + Text(myVariable), + ElevatedButton( + onPressed: () { + context.read().updateMyVariable('new value'); + }, + child: const Text('Update'), + ), + ], + ); + }, + ), + ); +} +``` + +As you can see, this is fairly complex to setup, but once you have it setup, it is both easy to use, and can be very powerful. It is designed to cover that 1% case where users do strange things to your application, and prevent your application from crashing or entering an invalid state or other odd issues. + +### Screen Layout + +Patapata has a helper layout Widget that has the capability to layout all child widgets as if the screen was a certain size. After layout, the child widgets will be scaled to fit the screen. + +This is very useful for applications that want to have a single design for screen sizes based off breakpoints, and want to scale the design instead of reflow the design for different screen sizes. + +See [ScreenLayout](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/ScreenLayout-class.html) for more information. + +### Platform Dialog + +Patapata has a [PlatformDialog](https://pub.dev/documentation/patapata_core/latest/patapata_widgets/PlatformDialog-class.html) widget that you can use to show a platform specific dialog. + +```dart +PlatformDialog.show( + context: context, + title: l(context, 'dialog.title'), + message: l(context, 'dialog.message'), + actions: [ + PlatformDialogAction( + result: () => true, + text: l(context, 'dialog.yes'), + isDefault: true, + ), + PlatformDialogAction( + result: () => false, + text: l(context, 'dialog.no'), + ), + ], +); +``` + +## Testing your application + +Patapata's plugins and features use native APIs and rely on running on real devices to generally work. +In a testing environment, you can't use the native APIs, so you need to mock them. +Patapata itself will automatically mock itself if you set the environment variable `IS_TEST` to true. + +```bash +flutter test --dart-define=IS_TEST=true +``` + +Once you have set this environment variable, you can use a few tools in your own tests to quickly and easily leaverage Patapata's features in your tests. +Typically, you would write a test as follows: + +```dart +void main() { + // These two lines are required to mock the native APIs + // and _must_ be set before any other code is run. + TestWidgetsFlutterBinding.ensureInitialized(); + testSetMockMethodCallHandler = TestDefaultBinaryMessengerBinding + .instance.defaultBinaryMessenger.setMockMethodCallHandler; + + // This StreamHandler is necessary when mocking streams from native APIs, and its responses should be handled + // in the onListen and onCancel methods of a class that inherits from the MockStreamHandler class. + testSetMockStreamHandler = (channel, handler) { + TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .setMockStreamHandler( + channel, + _MockStreamHandler(handler), + ); + }; + + testWidgets('My App should run', (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp(....), + startupSequence: StartupSequence(....), + plugins: [....], + ); + + // It is important to await this, otherwise [App] will not be able + // to initialize correctly. + await tApp.run(); + + // Always run your tests in a [runProcess] block. + // Flutter's test system runs code in a different Zone + // than what you app runs in, and functions like [getApp] or the logging system + // require to be run in a Zone that Patapata is managing. + await tApp.runProcess(() async { + // Always pumpAndSettle to let Patapata finish initializing. + await tester.pumpAndSettle(); + + // Write your tests here. + }); + + // You must call this before executing the next test. + tApp.dispose(); + }); +} + +// This class is necessary when preparing a mock stream handler. +class _MockStreamHandler extends MockStreamHandler { + _MockStreamHandler(this.handler); + + final TestMockStreamHandler? handler; + + @override + void onCancel(Object? arguments) { + // This is where you can handle the onCancel event. + } + + @override + void onListen(Object? arguments, MockStreamHandlerEventSink events) { + // This is where you can handle the onListen event. + } +} +``` + +If you are a `Plugin` developer and want to mock your own plugin, you can do so by overriding `setMockMethodCallHandler` in your plugin. +Currently supported by `App`, `Plugin` and `Config`. + +Example: TestPlugin +```dart +class TestPlugin extends Plugin { + @override + @visibleForTesting + void setMockMethodCallHandler() { + testSetMockMethodCallHandler( + const MethodChannel('com.mock.testplugin'), + (methodCall) async { + methodCallLogs.add(methodCall); + switch (methodCall.method) { + case 'flight': + debugPrint('patapata'); + default: + break; + } + return null; + }, + ); + } +} +``` + +Note that there are no hard dependencies on the Flutter test package in this code. + +Furthermore, when testing events on the custom plugin side, you can conduct tests using the mock event channel `setMockStreamHandler`. +```dart +class TestStreamHandlerPlugin extends Plugin { + @override + @visibleForTesting + void setMockStreamHandler() { + testSetMockStreamHandler( + const EventChannel('com.mock.testplugin'), + _TestMockStreamHandler(), + ); + } +} + +class _TestMockStreamHandler extends TestMockStreamHandler { + @override + void onCancel(Object? arguments) {} + + @override + void onListen(Object? arguments, TestMockStreamHandlerEventSink events) { + events.success('sucess event'); + } +} + +``` + +This can also be written using the inline function `TestMockStreamHandler.inline`. + +Example: TestStreamHandlerInlinePlugin +```dart +class TestStreamHandlerInlinePlugin extends Plugin { + @override + @visibleForTesting + void setMockStreamHandler() { + testSetMockStreamHandler( + const EventChannel('com.mock.testplugin'), + TestMockStreamHandler.inline( + onListen: (_, events) { + events.success('sucess event'); + }, + ), + ); + } +} +``` + +### Testing in the IDE + +If you run tests from an IDE, you can set the environment variable in the IDE's settings. +Example: for .vscode/settings.json +```json +{ + "dart.flutterTestAdditionalArgs": ["--dart-define=IS_TEST=true"] +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_core/LICENSE) \ No newline at end of file diff --git a/packages/patapata_core/analysis_options.yaml b/packages/patapata_core/analysis_options.yaml new file mode 100644 index 0000000..da00fd4 --- /dev/null +++ b/packages/patapata_core/analysis_options.yaml @@ -0,0 +1,7 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: diff --git a/packages/patapata_core/android/.gitignore b/packages/patapata_core/android/.gitignore new file mode 100644 index 0000000..f6dca24 --- /dev/null +++ b/packages/patapata_core/android/.gitignore @@ -0,0 +1,13 @@ +*.iml +.gradle +/local.properties +/.idea/workspace.xml +/.idea/libraries +.DS_Store +/build +/captures +*~ +.externalNativeBuild +.DS_Store +**/ndkHelperBin +**/.cxx \ No newline at end of file diff --git a/packages/patapata_core/android/build.gradle b/packages/patapata_core/android/build.gradle new file mode 100644 index 0000000..a6cb73a --- /dev/null +++ b/packages/patapata_core/android/build.gradle @@ -0,0 +1,76 @@ +group 'dev.patapata.patapata_core' +version '1.0-SNAPSHOT' + +buildscript { + ext.kotlin_version = '1.7.10' + repositories { + google() + mavenCentral() + } + + dependencies { + classpath 'com.android.tools.build:gradle:7.3.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.8.10" + } +} + +rootProject.allprojects { + repositories { + google() + mavenCentral() + } +} + +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' +apply plugin: 'org.jetbrains.dokka' + +android { + compileSdkVersion 33 + + compileOptions { + coreLibraryDesugaringEnabled true + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + minSdkVersion 21 + } + + buildTypes { + release { + // Enables code shrinking, obfuscation, and optimization for only + // your project's release build type. + minifyEnabled true + + // Includes the default ProGuard rules files that are packaged with + // the Android Gradle plugin. To learn more, go to the section about + // R8 configuration files. + proguardFiles getDefaultProguardFile( + 'proguard-android-optimize.txt'), + 'proguard-rules.pro' + } + } +} + +dependencies { + coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5' + + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "androidx.datastore:datastore-preferences:1.0.0" + + // https://github.com/flutter/flutter/issues/110658#issuecomment-1282045767 + // Crash fix for desugaring which is required by local notifications plugin + implementation "androidx.window:window:1.0.0-rc01" + implementation "androidx.window:window-java:1.0.0-rc01" +} diff --git a/packages/patapata_core/android/gradle.properties b/packages/patapata_core/android/gradle.properties new file mode 100644 index 0000000..82dfa36 --- /dev/null +++ b/packages/patapata_core/android/gradle.properties @@ -0,0 +1,4 @@ +org.gradle.jvmargs=-Xmx1536M +android.useAndroidX=true +android.enableJetifier=true +android.builder.sdkDownload=true diff --git a/packages/patapata_core/android/gradle/wrapper/gradle-wrapper.properties b/packages/patapata_core/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..111c25e --- /dev/null +++ b/packages/patapata_core/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-7.4.2-all.zip diff --git a/packages/patapata_core/android/proguard-rules.pro b/packages/patapata_core/android/proguard-rules.pro new file mode 100644 index 0000000..ea6dd79 --- /dev/null +++ b/packages/patapata_core/android/proguard-rules.pro @@ -0,0 +1,32 @@ +##---------------Begin: proguard configuration for Gson ---------- +# Gson uses generic type information stored in a class file when working with fields. Proguard +# removes such information by default, so configure it to keep all of it. +-keepattributes Signature + +# For using GSON @Expose annotation +-keepattributes *Annotation* + +# Gson specific classes +-dontwarn sun.misc.** +#-keep class com.google.gson.stream.** { *; } + +# Application classes that will be serialized/deserialized over Gson +-keep class com.google.gson.examples.android.model.** { ; } + +# Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory, +# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter) +-keep class * extends com.google.gson.TypeAdapter +-keep class * implements com.google.gson.TypeAdapterFactory +-keep class * implements com.google.gson.JsonSerializer +-keep class * implements com.google.gson.JsonDeserializer + +# Prevent R8 from leaving Data object members always null +-keepclassmembers,allowobfuscation class * { + @com.google.gson.annotations.SerializedName ; +} + +# Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher. +-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken +-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken + +##---------------End: proguard configuration for Gson ---------- \ No newline at end of file diff --git a/packages/patapata_core/android/settings.gradle b/packages/patapata_core/android/settings.gradle new file mode 100644 index 0000000..a068de2 --- /dev/null +++ b/packages/patapata_core/android/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'patapata_core' diff --git a/packages/patapata_core/android/src/main/AndroidManifest.xml b/packages/patapata_core/android/src/main/AndroidManifest.xml new file mode 100644 index 0000000..b2c05dc --- /dev/null +++ b/packages/patapata_core/android/src/main/AndroidManifest.xml @@ -0,0 +1,3 @@ + + diff --git a/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/Error.kt b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/Error.kt new file mode 100644 index 0000000..e6f0aa2 --- /dev/null +++ b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/Error.kt @@ -0,0 +1,22 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_core + +fun Throwable.toPatapataMap() : Map { + return mapOf( + "type" to javaClass.name, + "message" to message, + "stackTrace" to stackTrace.map { it.toString() }, + "cause" to cause?.run { toPatapataMap() } + ) +} + +enum class Error { + PPE000, + PPENLC000 +} diff --git a/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/NativeLocalConfig.kt b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/NativeLocalConfig.kt new file mode 100644 index 0000000..b21b798 --- /dev/null +++ b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/NativeLocalConfig.kt @@ -0,0 +1,122 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_core + +import android.content.Context +import androidx.datastore.core.DataStore +import androidx.datastore.preferences.core.* +import androidx.datastore.preferences.preferencesDataStore +import io.flutter.plugin.common.BinaryMessenger +import io.flutter.plugin.common.MethodCall +import io.flutter.plugin.common.MethodChannel +import kotlinx.coroutines.* +import kotlinx.coroutines.flow.* + +private val Context.nativeLocalConfigStore: DataStore by preferencesDataStore(name = "dev.patapata.native_local_config") + +class NativeLocalConfig(private val context: Context, messenger: BinaryMessenger) : PatapataPlugin, MethodChannel.MethodCallHandler { + private val mChannel : MethodChannel = MethodChannel(messenger, "dev.patapata.native_local_config") + private val mMainScope = CoroutineScope(Dispatchers.Main) + private var mJob: Job? = null + + override val patapataName: String + get() = "dev.patapata.native_local_config" + + override fun patapataEnable() { + mChannel.setMethodCallHandler(this) + + mJob = mMainScope.launch { + context.nativeLocalConfigStore.data + .map { + it.asMap().map { entry -> entry.key.name to entry.value }.toMap() + } + .onEach { + withContext(Dispatchers.Main) { + mChannel.invokeMethod("syncAll", it) + } + } + .cancellable() + .catch { + withContext(Dispatchers.Main) { + mChannel.invokeMethod("error", it.toPatapataMap()) + } + } + .collect() + } + } + + override fun patapataDisable() { + mJob?.cancel() + mJob = null + mChannel.setMethodCallHandler(null) + super.patapataDisable() + } + + override fun onMethodCall(call: MethodCall, result: MethodChannel.Result) { + val tExceptionHandler = CoroutineExceptionHandler { _, exception -> + result.error(Error.PPENLC000.name, null, exception.toPatapataMap()) + } + + mMainScope.launch(tExceptionHandler) { + when (call.method) { + "reset" -> context.nativeLocalConfigStore.edit { + // PreferenceKey's equality only checks the name. + it.remove(stringPreferencesKey(call.arguments as String)) + result.success(null) + } + "resetMany" -> context.nativeLocalConfigStore.edit { store -> + (call.arguments as? List<*>)?.forEach { + // PreferenceKey's equality only checks the name. + store.remove(stringPreferencesKey(it as String)) + } + + result.success(null) + } + "resetAll" -> context.nativeLocalConfigStore.edit { + it.clear() + result.success(null) + } + "setBool" -> context.nativeLocalConfigStore.edit { + val tArgs = call.arguments as List<*> + it[booleanPreferencesKey(tArgs[0] as String)] = tArgs[1] as Boolean + result.success(null) + } + "setInt" -> context.nativeLocalConfigStore.edit { + val tArgs = call.arguments as List<*> + it[intPreferencesKey(tArgs[0] as String)] = tArgs[1] as Int + result.success(null) + } + "setDouble" -> context.nativeLocalConfigStore.edit { + val tArgs = call.arguments as List<*> + it[doublePreferencesKey(tArgs[0] as String)] = tArgs[1] as Double + result.success(null) + } + "setString" -> context.nativeLocalConfigStore.edit { + val tArgs = call.arguments as List<*> + it[stringPreferencesKey(tArgs[0] as String)] = tArgs[1] as String + result.success(null) + } + "setMany" -> context.nativeLocalConfigStore.edit { store -> + (call.arguments as? Map<*, *>)?.forEach { + val tKey = it.key + + if (tKey is String) { + when (val tValue = it.value) { + is Boolean -> store[booleanPreferencesKey(tKey)] = tValue + is Int -> store[intPreferencesKey(tKey)] = tValue + is Double -> store[doublePreferencesKey(tKey)] = tValue + is String -> store[stringPreferencesKey(tKey)] = tValue + } + } + } + result.success(null) + } + } + } + } +} diff --git a/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataCorePlugin.kt b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataCorePlugin.kt new file mode 100644 index 0000000..d230cef --- /dev/null +++ b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataCorePlugin.kt @@ -0,0 +1,106 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_core + +import android.util.Log +import androidx.annotation.NonNull +import androidx.annotation.Keep +import io.flutter.embedding.engine.FlutterEngine +import io.flutter.embedding.engine.dart.DartExecutor +import io.flutter.embedding.engine.loader.FlutterLoader + +import io.flutter.embedding.engine.plugins.FlutterPlugin +import io.flutter.plugin.common.BinaryMessenger +import io.flutter.plugin.common.MethodCall +import io.flutter.plugin.common.MethodChannel +import io.flutter.plugin.common.MethodChannel.MethodCallHandler +import io.flutter.plugin.common.MethodChannel.Result +import java.io.File + +private class PatapataPluginContainer(val plugin: PatapataPlugin, val flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) + +private val sPlugins = mutableSetOf() + +/** PatapataCorePlugin */ +class PatapataCorePlugin: FlutterPlugin, MethodCallHandler { + private lateinit var mChannel : MethodChannel + private lateinit var mBinding : FlutterPlugin.FlutterPluginBinding + + override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { + mBinding = flutterPluginBinding + // Lines up with Flutter's override of Dart's Directory.systemTemp directory. + val tNativeLibDirectoryInfoFile = File(flutterPluginBinding.applicationContext.codeCacheDir, "patapataNativeLib") + + if (tNativeLibDirectoryInfoFile.exists()) { + tNativeLibDirectoryInfoFile.delete() + } + + tNativeLibDirectoryInfoFile.writeText(flutterPluginBinding.applicationContext.applicationInfo.nativeLibraryDir) + + mChannel = MethodChannel(flutterPluginBinding.binaryMessenger, "dev.patapata.patapata_core") + mChannel.setMethodCallHandler(this) + + // Register default plugins. + flutterPluginBinding.registerPatapataPlugin(NativeLocalConfig(mBinding.applicationContext, mBinding.binaryMessenger)) + } + + override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) { + when (call.method) { + "enablePlugin" -> { + val tName = call.arguments as? String + + if (tName == null) { + result.error(Error.PPE000.name, "Invalid plugin name passed to enablePlugin", null) + + return + } + + enablePlugin(tName) + result.success(null) + } + "disablePlugin" -> { + val tName = call.arguments as? String + + if (tName == null) { + result.error(Error.PPE000.name, "Invalid plugin name passed to disablePlugin", null) + + return + } + + disablePlugin(tName) + result.success(null) + } + else -> result.notImplemented() + } + } + + override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) { + mChannel.setMethodCallHandler(null) + } + + private fun enablePlugin(pluginName: String) { + sPlugins.firstOrNull { + it.plugin.patapataName == pluginName && it.flutterPluginBinding.binaryMessenger == mBinding.binaryMessenger + }?.plugin?.patapataEnable() + } + + private fun disablePlugin(pluginName: String) { + sPlugins.firstOrNull { + it.plugin.patapataName == pluginName && it.flutterPluginBinding.binaryMessenger == mBinding.binaryMessenger + }?.plugin?.patapataDisable() + } +} + +fun FlutterPlugin.FlutterPluginBinding.registerPatapataPlugin(plugin: PatapataPlugin) { + sPlugins.removeAll { it.plugin == plugin } + sPlugins.add(PatapataPluginContainer(plugin, this)) +} + +fun FlutterPlugin.FlutterPluginBinding.unregisterPatapataPlugin(plugin: PatapataPlugin) { + sPlugins.removeAll { it.plugin == plugin } +} diff --git a/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataPlugin.kt b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataPlugin.kt new file mode 100644 index 0000000..2961f24 --- /dev/null +++ b/packages/patapata_core/android/src/main/kotlin/dev/patapata/patapata_core/PatapataPlugin.kt @@ -0,0 +1,14 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_core + +interface PatapataPlugin { + val patapataName: String + fun patapataEnable() {} + fun patapataDisable() {} +} diff --git a/packages/patapata_core/bin/bootstrap.dart b/packages/patapata_core/bin/bootstrap.dart new file mode 100644 index 0000000..a474147 --- /dev/null +++ b/packages/patapata_core/bin/bootstrap.dart @@ -0,0 +1,999 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:io'; + +import 'package:args/args.dart'; +import 'package:args/command_runner.dart'; +import 'package:dart_style/dart_style.dart'; +import 'package:xml/xml.dart'; +import 'package:yaml_edit/yaml_edit.dart'; + +void main(List arguments) { + late final ArgParser tParser; + + tParser = ArgParser() + ..addSeparator( + 'Bootstrap your Patapata project.', + ) + ..addFlag( + 'help', + abbr: 'h', + help: 'Show this help message.', + negatable: false, + defaultsTo: false, + ) + ..addFlag( + 'force', + abbr: 'f', + help: 'Rewrite existing files.', + negatable: false, + defaultsTo: false, + ) + ..addFlag( + 'i18n', + help: 'Enable I18n support.', + defaultsTo: true, + ) + ..addMultiOption( + 'locale', + abbr: 'l', + help: 'Which locale codes to support.', + defaultsTo: ['en'], + ) + ..addFlag( + 'errors', + help: 'Enable customization of the error handling system.', + defaultsTo: false, + ) + ..addFlag( + 'log', + help: 'Enable customization of the logging system.', + defaultsTo: true, + ) + ..addFlag( + 'notifications', + help: 'Enable customization of the notifications system.', + defaultsTo: false, + ) + ..addFlag( + 'screenlayout', + help: 'Enable customization of ScreenLayout breakpoints.', + defaultsTo: false, + ); + + try { + final tResults = tParser.parse(arguments); + + if (tResults['help'] == true) { + stdout.writeln(tParser.usage); + return; + } + + if (tResults.rest.isNotEmpty) { + throw UsageException( + 'Unexpected arguments: ${tResults.rest.join(', ')}', + tParser.usage, + ); + } + + // Check if an environment.dart file exists. + // And if not, create it with a default Environment class. + _checkEnvironmentFile(tResults); + + // Check if a splash_page.dart file exists. + // And if not, create it with a default SplashPage class. + _checkSplashPageFile(tResults); + + // Check if a agreement_page.dart file exists. + // And if not, create it with a default AgreementPage class. + _checkAgreementPageFile(tResults); + + // Check if a home_page.dart file exists. + // And if not, create it with a default HomePage class. + _checkHomePageFile(tResults); + + // Check if a startup.dart file exists. + // And if not, create it with several default startup sequence states. + _checkStartupFile(tResults); + + // Check if a errors.dart file exists. + // And if not, create it with some default errors. + _checkErrorsFile(tResults); + + // Check if a main.dart file exists. + // And if not, create it with a default main function. + _checkMainFile(tResults); + + // Check if an AndroidManifest.xml file exists. + // And if so, check if it contains the flutter_deeplinking_enabled meta-data. + _checkAndroidManifestFile(tResults); + + // Check if the minimum version of the Android SDK is set to the flutter default, + // And if it is, change it to 21. + _checkAndroidGradleFile(tResults); + + // Check if Info.plist file contains the FlutterDeepLinkingEnabled key. + // And if not, set it to true. + _checkInfoPlistFile(tResults); + + // Check if the minumum version of iOS is unset. + // If it is, set it to 12.0. + _checkPodFile(tResults); + + // Check if the l10n directory exists. + // And if not, create it. + _checkL10nFiles(tResults); + } catch (e) { + switch (e) { + case UsageException(): + stderr.writeln(e.message); + stderr.writeln(e.usage); + exit(64); + case FormatException(): + stderr.writeln(e.message); + stderr.writeln(tParser.usage); + exit(64); + default: + rethrow; + } + } +} + +void _checkEnvironmentFile(ArgResults results) { + stdout.writeln('Checking environment.dart file...'); + + final tFile = File('lib/src/environment.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating environment.dart file...'); + final tMixins = { + if (results['i18n'] == true) 'I18nEnvironment', + if (results['errors'] == true) 'ErrorEnvironment', + if (results['log'] == true) 'LogEnvironment', + if (results['notifications'] == true) 'NotificationsEnvironment', + if (results['screenlayout'] == true) 'ScreenLayoutEnvironment', + }; + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core.dart'; +${tMixins.contains('ScreenLayoutEnvironment') ? ''' +import 'package:patapata_core/patapata_widgets.dart'; +''' : ''} +${tMixins.contains('ScreenLayoutEnvironment') || tMixins.contains('LogEnvironment') ? ''' +import 'package:flutter/widgets.dart'; +''' : ''} + +/// The Environment class for this app. +/// Controls all static settings for the app. +/// Pass this to the [App] constructor. +class Environment${tMixins.isNotEmpty ? ' with\n${tMixins.join(',\n')}' : ''} { + + ${tMixins.contains('I18nEnvironment') ? ''' + @override + final List supportedL10ns = const [ +${[ + for (final tLocale in results['locale'] as List) + "Locale('$tLocale')", + ].join(',\n')} + ]; + + @override + final List l10nPaths = const [ + 'l10n', + ]; + +''' : ''} + ${tMixins.contains('ErrorEnvironment') ? ''' + @override + final Map? errorReplacePrefixMap; + + @override + final Widget Function(PatapataException)? errorDefaultWidget; + + @override + final Future Function(BuildContext, PatapataException)? errorDefaultShowDialog; + +''' : ''} +${tMixins.contains('LogEnvironment') ? ''' + @override + final int logLevel; + + @override + final bool printLog; + +''' : ''} +${tMixins.contains('NotificationsEnvironment') ? ''' + @override + final String notificationsAndroidDefaultIcon; + + @override + final bool notificationsDarwinDefaultPresentAlert; + + @override + final bool notificationsDarwinDefaultPresentSound; + + @override + final bool notificationsDarwinDefaultPresentBadge; + + @override + final bool notificationsDarwinDefaultPresentBanner; + + @override + final bool notificationsDarwinDefaultPresentList; + + @override + final List notificationsAndroidChannels; + + @override + final String notificationsPayloadLocationKey; + +''' : ''} +${tMixins.contains('ScreenLayoutEnvironment') ? ''' + @override + final Map screenLayoutBreakpoints; + +''' : ''} + + const Environment({ + ${tMixins.contains('ErrorEnvironment') ? ''' + this.errorReplacePrefixMap, + this.errorDefaultWidget, + this.errorDefaultShowDialog, +''' : ''} + ${tMixins.contains('LogEnvironment') ? ''' + this.logLevel = const int.fromEnvironment('LOG_LEVEL', defaultValue: -kPataInHex), + this.printLog = const bool.fromEnvironment('PRINT_LOG', defaultValue: kDebugMode), +''' : ''} + ${tMixins.contains('NotificationsEnvironment') ? ''' + this.notificationsAndroidDefaultIcon = '@mipmap/ic_launcher', + this.notificationsDarwinDefaultPresentAlert = true, + this.notificationsDarwinDefaultPresentSound = true, + this.notificationsDarwinDefaultPresentBadge = true, + this.notificationsDarwinDefaultPresentBanner = true, + this.notificationsDarwinDefaultPresentList = true, + this.notificationsAndroidChannels = const [ + NotificationsPlugin.kDefaultAndroidChannel, + ], + this.notificationsPayloadLocationKey = 'location', +''' : ''} + ${tMixins.contains('ScreenLayoutEnvironment') ? ''' + this.screenLayoutBreakpoints = const { + 'normal': ScreenLayoutDefaultBreakpoints.normal, + 'large': ScreenLayoutDefaultBreakpoints.large, + }, +''' : ''} + }); +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkMainFile(ArgResults results) { + stdout.writeln('Checking main.dart file...'); + + final tFile = File('lib/main.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating main.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import 'src/environment.dart'; +import 'src/startup.dart'; +import 'src/pages/error.dart'; +import 'src/pages/splash_page.dart'; +import 'src/pages/agreement_page.dart'; +import 'src/pages/home_page.dart'; + +final _providerKey = GlobalKey(debugLabel: 'AppProviderKey'); + +void main() { + App( + environment: const Environment(), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StartupStateCheckVersion(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StartupStateAgreements(startupSequence), + [], + ), + ], + ), + createAppWidget: (context, app) => StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // Splash screen page. + // This uses a special factory that has good defaults for splash screens. + SplashPageFactory( + create: (_) => SplashPage(), + ), + // Agreement page. + // This uses a special factory that all [StartupSequence] pages should use. + StartupPageFactory( + create: (_) => AgreementPage(), + ), + // Error page. + // This uses a special factory that all full screen error pages should use. + StandardErrorPageFactory( + create: (_) => ErrorPage(), + ), + StandardPageFactory( + create: (_) => HomePage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + routableBuilder: (context, child) { + // Setup [ScreenLayout] + // You may want to move this to the body section of your Scaffold + // or somewhere where it makes sense for your app's design. + child = ScreenLayout(child: child); + + // Wrap the app in a key provided by you + // so you can access your providers from anywhere + // via context.read and context.watch. + child = KeyedSubtree( + key: _providerKey, + child: child, + ); + + // If you want to customize a Theme, you can do it here + // by wrapping the child with a Theme widget. + // You can also wrap anything here and that Widget will + // be available to all pages. + + // Add your [Provider]s here + // child = MultiProvider( + // providers: const [ + // // Provider( + // // create: (_) => YourProvider(), + // // ), + // ], + // child: child, + // ); + + return child; + }, + ), + plugins: [], + providerKey: _providerKey, + ) + ..getPlugin()?.enableStandardAppIntegration() + ..run(() async { + // Do any initialization here + // Here's a good default + + // Set a default orientation of only portrait + await SystemChrome.setPreferredOrientations(const [ + DeviceOrientation.portraitDown, + DeviceOrientation.portraitUp, + ]); + + // Enable Edge-to-Edge mode + await SystemChrome.setEnabledSystemUIMode(SystemUiMode.edgeToEdge); + + // Make the status bars transparent + SystemChrome.setSystemUIOverlayStyle(const SystemUiOverlayStyle( + systemNavigationBarColor: Colors.transparent, + statusBarColor: Colors.transparent, + statusBarBrightness: Brightness.light, + statusBarIconBrightness: Brightness.dark, + )); + + // Set your RemoteConfig defaults here + await getApp().remoteConfig.setDefaults(const {}); + }); +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkSplashPageFile(ArgResults results) { + stdout.writeln('Checking splash_page.dart file...'); + + final tFile = File('lib/src/pages/splash_page.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating splash_page.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class SplashPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return const Center( + child: FlutterLogo( + size: 128, + ), + ); + } +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkAgreementPageFile(ArgResults results) { + stdout.writeln('Checking agreement_page.dart file...'); + + final tFile = File('lib/src/pages/agreement_page.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating agreement_page.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class AgreementPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.agreement.title')), + ), + body: Column( + children: [ + Center( + child: Text( + l(context, 'pages.agreement.body'), + ), + ), + TextButton( + child: Text(l(context, 'pages.agreement.yes')), + onPressed: () { + pageData(null); + }, + ), + TextButton( + child: Text(l(context, 'pages.agreement.no')), + onPressed: () { + getApp().startupSequence?.resetMachine(); + }, + ), + ], + ), + ); + } +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkHomePageFile(ArgResults results) { + stdout.writeln('Checking home_page.dart file...'); + + final tFile = File('lib/src/pages/home_page.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating home_page.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class HomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.home.title')), + ), + body: Center( + child: Text(l(context, 'pages.home.body')), + ), + ); + } +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkStartupFile(ArgResults results) { + stdout.writeln('Checking startup.dart file...'); + + final tFile = File('lib/src/startup.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating startup.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:patapata_core/patapata_core.dart'; + +import 'errors.dart'; +import 'pages/agreement_page.dart'; + +class StartupStateCheckVersion extends StartupState { + StartupStateCheckVersion(StartupSequence startupSequence) : super(startupSequence); + + @override + Future process(Object? data) async { + // Check the version here + // If the version is not supported, throw an exception + // and the app will show the error page. + // If the version is supported, transition to the next state. + final tIsNewestVersion = true; // TODO: Change this with your own logic. + + if (!tIsNewestVersion) { + throw const AppVersionException(); + } + } +} + +class StartupStateAgreements extends StartupState { + /// The version of the agreement. + /// This should be incremented when the agreement changes. + static const kVersion = '1'; + + static const _kAgreementVersionKey = 'agreementVersion'; + + StartupStateAgreements(StartupSequence startupSequence) : super(startupSequence); + + @override + Future process(Object? data) async { + // Check if the user has agreed to the agreement. + // If the user has agreed, return. + if (getApp().localConfig.getString(_kAgreementVersionKey) == kVersion) { + return; + } + + // Show the agreement page here. + // If the user agrees, call pageData(null); + // If the user does not agree, call getApp().startupSequence?.resetMachine(); + // which will reset the startup sequence. + if (await navigateToPage(AgreementPage, (result) {})) { + await getApp().localConfig.setString(_kAgreementVersionKey, kVersion); + } + } +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkErrorsFile(ArgResults results) { + stdout.writeln('Checking errors.dart file...'); + + final tFile = File('lib/src/errors.dart'); + final tFileExists = tFile.existsSync(); + + if (results['force'] == true || !tFileExists) { + stdout.writeln('Creating errors.dart file...'); + + if (!tFileExists) { + tFile.createSync(recursive: true); + } + + tFile.writeAsStringSync(DartFormatter().format(''' +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +abstract base class AppException extends PatapataException { + const AppException({ + super.app, + super.message, + super.original, + super.fingerprint, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + super.fix, + super.logLevel, + super.userLogLevel, + }); + + @override + // TODO: This should be a 3 letter code that is unique to your app. + // TODO: We recommend using a mapping like the first two letters being + // TODO: related to your app, and the last letter being related to the + // TODO: type of error. E for error, W for warning, etc. + String get defaultPrefix => 'APE'; + + @override + String get namespace => 'app'; +} + +/// An exception that is thrown when the app encounters an unknown error. +final class AppUnknownException extends AppException { + const AppUnknownException(); + + @override + String get internalCode => '000'; +} + +/// Thrown when an unsupported version (usually old) of the app is detected. +final class AppVersionException extends AppException { + const AppVersionException() : super(logLevel: Level.INFO); + + @override + String get internalCode => '010'; + + @override + void onReported(ReportRecord record) { + showDialog(getApp().navigatorContext); + } + + @override + Future Function()? get fix => () async { + // Launch the app store. + }; +} +''')); + } + + // Also check and create the ErrorPage. + final tErrorPageFile = File('lib/src/pages/error.dart'); + final tErrorPageFileExists = tErrorPageFile.existsSync(); + + if (results['force'] == true || !tErrorPageFileExists) { + stdout.writeln('Creating error.dart file...'); + + if (!tErrorPageFileExists) { + tErrorPageFile.createSync(recursive: true); + } + + tErrorPageFile.writeAsStringSync(DartFormatter().format(''' +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import '../errors.dart'; + +class ErrorPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + if (pageData.error is AppException) { + return _buildAppExceptionPage(context); + } else { + return _buildUnknownExceptionPage(context); + } + } + + Widget _buildAppExceptionPage(BuildContext context) { + final tAppException = pageData.error as AppException; + + return Scaffold( + appBar: AppBar( + title: Text(tAppException.localizedTitle), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Text(tAppException.localizedMessage), + if (tAppException.hasFix) + TextButton( + child: Text(tAppException.localizedFix), + onPressed: () { + tAppException.fix!(); + }, + ), + ], + ), + ), + ); + } + + Widget _buildUnknownExceptionPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'errors.app.000.title')), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Text(l(context, 'errors.app.000.message')), + ], + ), + ), + ); + } +} +''')); + } + + stdout.writeln('Done.'); +} + +void _checkAndroidManifestFile(ArgResults results) { + stdout.writeln('Checking AndroidManifest.xml file...'); + + // Check if the AndroidManifest.xml file contains an main activity that has + // meta-data of flutter_deeplinking_enabled, and if not, add it. + final tFile = File('android/app/src/main/AndroidManifest.xml'); + final tFileExists = tFile.existsSync(); + + if (!tFileExists) { + stdout.writeln('AndroidManifest.xml file not found.'); + + return; + } + + final tDocument = XmlDocument.parse(tFile.readAsStringSync()); + final tMainActivities = + tDocument.findAllElements('activity').where((element) { + final tIntentFilters = + element.findAllElements('intent-filter').where((element) { + final tActions = element.findAllElements('action').where((element) { + return element.getAttribute('android:name') == + 'android.intent.action.MAIN'; + }); + + final tCategories = element.findAllElements('category').where((element) { + return element.getAttribute('android:name') == + 'android.intent.category.LAUNCHER'; + }); + + return tActions.isNotEmpty && tCategories.isNotEmpty; + }); + + return tIntentFilters.isNotEmpty; + }); + + if (tMainActivities.isEmpty) { + stdout.writeln('No main activity found.'); + + return; + } + + final tMainActivity = tMainActivities.first; + + final tMetaData = tMainActivity.findAllElements('meta-data').where((element) { + return element.getAttribute('android:name') == + 'flutter_deeplinking_enabled'; + }); + + if (tMetaData.isEmpty) { + stdout.writeln( + 'No meta-data found. Adding the Flutter Deep Linking feature.'); + + tMainActivity.children.add(XmlElement( + XmlName('meta-data'), + [ + XmlAttribute(XmlName('android:name'), 'flutter_deeplinking_enabled'), + XmlAttribute(XmlName('android:value'), 'true'), + ], + [], + false, + )); + + tFile.writeAsStringSync(tDocument.toXmlString(pretty: true)); + } +} + +void _checkAndroidGradleFile(ArgResults results) { + stdout.writeln('Checking Android Gradle file...'); + + // Check if the Android Gradle file contains the minimum SDK version of 21. + // And if not, change it to 21. + final tFile = File('android/app/build.gradle'); + final tFileExists = tFile.existsSync(); + + if (!tFileExists) { + stdout.writeln('Android Gradle file not found.'); + + return; + } + + // Replace the minimum SDK version with 21 as plain text + final tDocument = tFile + .readAsStringSync() + .replaceAll('minSdkVersion flutter.minSdkVersion', 'minSdkVersion 21'); + + tFile.writeAsStringSync(tDocument.toString()); +} + +void _checkInfoPlistFile(ArgResults results) { + stdout.writeln('Checking Info.plist file...'); + + // Check if the Info.plist file contains the FlutterDeepLinkingEnabled key. + // And if not, set it to true. + final tFile = File('ios/Runner/Info.plist'); + final tFileExists = tFile.existsSync(); + + if (!tFileExists) { + stdout.writeln('Info.plist file not found.'); + + return; + } + + final tDocument = XmlDocument.parse(tFile.readAsStringSync()); + // This should be the first element under plist. + final tDictElement = tDocument.findAllElements('dict').first; + final tKeys = tDictElement.findAllElements('key').where((element) { + return element.innerText == 'FlutterDeepLinkingEnabled'; + }); + + if (tKeys.isEmpty) { + stdout.writeln( + 'No FlutterDeepLinkingEnabled key found. Adding the Flutter Deep Linking feature.'); + + tDictElement.children.add(XmlElement( + XmlName('key'), + [], + [ + XmlText('FlutterDeepLinkingEnabled'), + ], + false, + )); + + tDictElement.children.add(XmlElement( + XmlName('true'), + [], + [], + true, + )); + + tFile.writeAsStringSync(tDocument.toXmlString(pretty: true)); + } + + stdout.writeln('Done.'); +} + +void _checkPodFile(ArgResults results) { + stdout.writeln('Checking Podfile file...'); + + // Check if the Podfile file contains the minimum version of iOS of 12.0. + // And if not, change it to 12.0. + final tFile = File('ios/Podfile'); + final tFileExists = tFile.existsSync(); + + if (!tFileExists) { + stdout.writeln('Podfile file not found.'); + + return; + } + + // Replace the minimum version of iOS with 12.0 as plain text + // The default setting after flutter create is a commented out line. + // So we remove that whole line and replace it. + // As of writting this code, the default line is: + // # platform :ios, '11.0' + final tDocument = tFile + .readAsStringSync() + .replaceAll('# platform :ios, \'11.0\'', 'platform :ios, \'12.0\''); + + tFile.writeAsStringSync(tDocument.toString()); +} + +void _checkL10nFiles(ArgResults results) { + stdout.writeln('Checking l10n files...'); + + // Check if the l10n directory exists. + // And if not, create it. + final tDirectory = Directory('l10n'); + final tDirectoryExists = tDirectory.existsSync(); + + if (!tDirectoryExists) { + stdout.writeln('l10n directory not found. Creating it.'); + tDirectory.createSync(recursive: true); + } + + // Check if each of the Locales specified in the arguments exists. + // If not, create them. + for (final tLocale in results['locale'] as List) { + final tFile = File('l10n/$tLocale.yaml'); + final tFileExists = tFile.existsSync(); + + if (!tFileExists) { + stdout.writeln('l10n/$tLocale.yaml file not found. Creating it.'); + tFile.createSync(recursive: true); + + tFile.writeAsStringSync(''' +title: App Title +pages: + agreement: + title: Agreement + body: This is the agreement page. Do you accept? + yes: Yes + no: No + home: + title: Home + body: This is the home page. +errors: + app: + '000': + title: Unknown Error + message: An unknown error has occurred. + '010': + title: Unsupported Version + message: This version of the app is no longer supported. + fix: Please update the app. +'''); + } + } + + stdout.writeln('Adding l10n.yaml files to flutter assets in pubspec.yaml...'); + + final tPubspecFile = File('pubspec.yaml'); + final tPubspecFileExists = tPubspecFile.existsSync(); + + if (!tPubspecFileExists) { + stdout.writeln('pubspec.yaml file not found.'); + + return; + } + + final tPubspecDocument = YamlEditor(tPubspecFile.readAsStringSync()); + + tPubspecDocument.parseAt( + ['flutter', 'assets'], + orElse: () { + tPubspecDocument.update([ + 'flutter' + ], { + 'assets': [], + }); + + return tPubspecDocument.parseAt(['flutter', 'assets']); + }, + ); + + for (final tLocale in results['locale'] as List) { + tPubspecDocument.appendToList(['flutter', 'assets'], 'l10n/$tLocale.yaml'); + } + + tPubspecFile.writeAsStringSync(tPubspecDocument.toString()); + + stdout.writeln('Done.'); +} diff --git a/packages/patapata_core/dartdoc_options.yaml b/packages/patapata_core/dartdoc_options.yaml new file mode 100644 index 0000000..ad58258 --- /dev/null +++ b/packages/patapata_core/dartdoc_options.yaml @@ -0,0 +1,15 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + exclude: + - patapata_core_libs + - local_config_finder + - patapata_core_web + - patapata_web_plugin + - web_local_config + - web_local_config_finder + - native_ffi_finder + - native_local_config diff --git a/packages/patapata_core/ios/.gitignore b/packages/patapata_core/ios/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_core/ios/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_core/ios/Assets/.gitkeep b/packages/patapata_core/ios/Assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packages/patapata_core/ios/Classes/NativeLocalConfig.swift b/packages/patapata_core/ios/Classes/NativeLocalConfig.swift new file mode 100644 index 0000000..bce9bda --- /dev/null +++ b/packages/patapata_core/ios/Classes/NativeLocalConfig.swift @@ -0,0 +1,128 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter + +class NativeLocalConfig : PatapataPlugin { + fileprivate let mChannel: FlutterMethodChannel + fileprivate var mOnChangeListener: Any? + fileprivate var mOnSizeLimitExceededListener: Any? + fileprivate let mStore = UserDefaults(suiteName: "\(Bundle.main.bundleIdentifier ?? "unknown").dev.patapata.native_local_config") ?? UserDefaults.standard + + init(registrar: FlutterPluginRegistrar) { + mChannel = FlutterMethodChannel(name: "dev.patapata.native_local_config", binaryMessenger: registrar.messenger()) + } + + public var patapataName: String = "dev.patapata.native_local_config" + + public func patapataEnable() { + mChannel.setMethodCallHandler(handle) + + mOnChangeListener = NotificationCenter.default.addObserver(forName: UserDefaults.didChangeNotification, object: mStore, queue: OperationQueue.main, using: onChange) + + if #available(iOS 9.3, *) { + mOnSizeLimitExceededListener = NotificationCenter.default.addObserver(forName: UserDefaults.sizeLimitExceededNotification, object: mStore, queue: OperationQueue.main, using: onSizeLimitExceeded) + } + + syncStore() + } + + fileprivate func syncStore() { + let tDict = mStore.dictionaryRepresentation().filter { + switch $0.value { + case is Bool: + return true + case is Int: + return true + case is Double: + return true + case is String: + return true + default: + return false + } + } + + mChannel.invokeMethod("syncAll", arguments: tDict) + } + + fileprivate func onChange(_: Notification) { + syncStore() + } + + fileprivate func onSizeLimitExceeded(notification: Notification) { + // mChannel.invokeMethod("error", arguments: <#T##Any?#>) + // Should we send this? It could happen async from a set command + // It could also happen from something not related to patapata at all... + } + + public func patapataDisable() { + mChannel.setMethodCallHandler(nil) + NotificationCenter.default.removeObserver(mOnChangeListener!, name: UserDefaults.didChangeNotification, object: mStore) + mOnChangeListener = nil + + if #available(iOS 9.3, *) { + NotificationCenter.default.removeObserver(mOnSizeLimitExceededListener!, name: UserDefaults.sizeLimitExceededNotification, object: mStore) + mOnSizeLimitExceededListener = nil + } + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "reset": + mStore.removeObject(forKey: call.arguments as! String) + result(nil) + break + case "resetMany": + let tArgs = call.arguments as! Array + + for i in tArgs { + mStore.removeObject(forKey: i) + } + + result(nil) + break + case "resetAll": + for i in mStore.dictionaryRepresentation() { + mStore.removeObject(forKey: i.key) + } + + result(nil) + break + case "setBool": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Bool, forKey: tArgs[0] as! String) + result(nil) + break + case "setInt": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Int, forKey: tArgs[0] as! String) + result(nil) + break + case "setDouble": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Double, forKey: tArgs[0] as! String) + result(nil) + break + case "setString": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! String, forKey: tArgs[0] as! String) + result(nil) + break + case "setMany": + let tArgs = call.arguments as! Dictionary + + for i in tArgs { + mStore.set(i.value, forKey: i.key) + } + + result(nil) + break + default: + result(FlutterMethodNotImplemented) + break + } + } +} diff --git a/packages/patapata_core/ios/Classes/PatapataCorePlugin.swift b/packages/patapata_core/ios/Classes/PatapataCorePlugin.swift new file mode 100644 index 0000000..d36dc26 --- /dev/null +++ b/packages/patapata_core/ios/Classes/PatapataCorePlugin.swift @@ -0,0 +1,128 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter +import UIKit +import AppTrackingTransparency + +fileprivate var sPlugins = Set() + +public class PatapataCorePlugin: NSObject, FlutterPlugin { + let mRegistrar: FlutterPluginRegistrar + let mChannel: FlutterMethodChannel + + init(registrar: FlutterPluginRegistrar) { + mRegistrar = registrar + mChannel = FlutterMethodChannel(name: "dev.patapata.patapata_core", binaryMessenger: registrar.messenger()) + + super.init() + + registrar.addMethodCallDelegate(self, channel: mChannel) + + // Register default plugins. + registrar.registerPatapata(plugin: NativeLocalConfig(registrar: registrar)) + } + + public static func register(with registrar: FlutterPluginRegistrar) { + let _ = PatapataCorePlugin(registrar: registrar) + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "enablePlugin": + guard let tName = call.arguments as? String else { + result(FlutterError(code: "PPE000", message: "Invalid plugin name passed to enablePlugin", details: nil)) + + return + } + + enablePlugin(with: tName) + result(nil) + case "disablePlugin": + guard let tName = call.arguments as? String else { + result(FlutterError(code: "PPE000", message: "Invalid plugin name passed to disablePlugin", details: nil)) + + return + } + + disablePlugin(with: tName) + result(nil) + case "Permissions:requestTracking": + requestTrackingPermission(result) + default: + result(FlutterMethodNotImplemented) + } + } + + public func enablePlugin(with pluginName: String) { + for i in sPlugins { + guard i.plugin.patapataName == pluginName && i.registrar.messenger().hash == mRegistrar.messenger().hash else { + continue + } + + i.plugin.patapataEnable(); + } + } + + public func disablePlugin(with pluginName: String) { + for i in sPlugins { + guard i.plugin.patapataName == pluginName && i.registrar.messenger().hash == mRegistrar.messenger().hash else { + continue + } + + i.plugin.patapataDisable() + } + } + + func requestTrackingPermission(_ result: @escaping FlutterResult) { + if #available(iOS 14, *) { + ATTrackingManager.requestTrackingAuthorization { (status) in + switch status { + case .authorized: + result("authorized") + break + case .denied: + result("denied") + break + case .notDetermined: + result("notDetermined") + break + case .restricted: + result("restricted") + break + default: + result(nil) + } + } + } else { + result(nil) + } + } +} + +fileprivate struct PatapataPluginContainer : Hashable { + let plugin: PatapataPlugin + let registrar: FlutterPluginRegistrar + + static func == (lhs: PatapataPluginContainer, rhs: PatapataPluginContainer) -> Bool { + return lhs.plugin.patapataName == rhs.plugin.patapataName && lhs.registrar.messenger().hash == rhs.registrar.messenger().hash + } + + func hash(into hasher: inout Hasher) { + hasher.combine(plugin.patapataName) + hasher.combine(registrar.messenger().hash) + } +} + + +extension FlutterPluginRegistrar { + public func registerPatapata(plugin: PatapataPlugin) { + sPlugins.insert(PatapataPluginContainer(plugin: plugin, registrar: self)) + } + + public func unregisterPatapata(plugin: PatapataPlugin) { + sPlugins.remove(PatapataPluginContainer(plugin: plugin, registrar: self)) + } +} diff --git a/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.h b/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.h new file mode 100644 index 0000000..c068d98 --- /dev/null +++ b/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataCorePluginBridge : NSObject +@end diff --git a/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.m b/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.m new file mode 100644 index 0000000..951eb16 --- /dev/null +++ b/packages/patapata_core/ios/Classes/PatapataCorePluginBridge.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataCorePluginBridge.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_core-Swift.h" +#endif + +@implementation PatapataCorePluginBridge ++ (void)registerWithRegistrar:(NSObject*)registrar { + [PatapataCorePlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_core/ios/Classes/PatapataPlugin.swift b/packages/patapata_core/ios/Classes/PatapataPlugin.swift new file mode 100644 index 0000000..c9ca8f6 --- /dev/null +++ b/packages/patapata_core/ios/Classes/PatapataPlugin.swift @@ -0,0 +1,16 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + + +public protocol PatapataPlugin { + var patapataName: String { get } + func patapataEnable() + func patapataDisable() +} + +public extension PatapataPlugin { + func patapataEnable() {} + func patapataDisable() {} +} diff --git a/packages/patapata_core/ios/patapata_core.podspec b/packages/patapata_core/ios/patapata_core.podspec new file mode 100644 index 0000000..0d98a49 --- /dev/null +++ b/packages/patapata_core/ios/patapata_core.podspec @@ -0,0 +1,23 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_core.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_core' + s.version = '0.0.1' + s.summary = 'A new flutter plugin project.' + s.description = <<-DESC +A new flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'Flutter' + s.platform = :ios, '8.0' + + # Flutter.framework does not contain a i386 slice. + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_core/lib/finder/local_config_finder.dart b/packages/patapata_core/lib/finder/local_config_finder.dart new file mode 100644 index 0000000..b93a734 --- /dev/null +++ b/packages/patapata_core/lib/finder/local_config_finder.dart @@ -0,0 +1,9 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:patapata_core/patapata_core.dart'; + +LocalConfigFinder getLocalConfigFinder() => + throw UnsupportedError('Cannot create a LocalConfigFinder'); diff --git a/packages/patapata_core/lib/patapata_core.dart b/packages/patapata_core/lib/patapata_core.dart new file mode 100644 index 0000000..4274735 --- /dev/null +++ b/packages/patapata_core/lib/patapata_core.dart @@ -0,0 +1,31 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_core; + +export 'src/util.dart'; +export 'src/sequential_work_queue.dart'; +export 'src/logic_state.dart'; +export 'src/provider_model.dart'; +export 'src/config.dart'; +export 'src/remote_config.dart'; +export 'src/local_config.dart'; +export 'src/remote_messaging.dart'; +export 'src/log.dart'; +export 'src/analytics.dart'; +export 'src/user.dart'; +export 'src/network.dart'; +export 'src/package_info.dart'; +export 'src/device_info.dart'; +export 'src/plugin.dart'; +export 'src/app.dart'; +export 'src/i18n.dart'; +export 'src/permissions.dart'; +export 'src/notifications.dart'; +export 'src/error.dart'; +export 'src/startup.dart'; + +export 'src/native_local_config.dart'; +export 'src/method_channel_test_mixin.dart'; diff --git a/packages/patapata_core/lib/patapata_core_libs.dart b/packages/patapata_core/lib/patapata_core_libs.dart new file mode 100644 index 0000000..ab6cd19 --- /dev/null +++ b/packages/patapata_core/lib/patapata_core_libs.dart @@ -0,0 +1,11 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_core_libs; + +export 'dart:async'; + +export 'package:logging/logging.dart'; +export 'package:timezone/timezone.dart'; diff --git a/packages/patapata_core/lib/patapata_core_web.dart b/packages/patapata_core/lib/patapata_core_web.dart new file mode 100644 index 0000000..047edd7 --- /dev/null +++ b/packages/patapata_core/lib/patapata_core_web.dart @@ -0,0 +1,67 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/services.dart'; +import 'package:flutter_web_plugins/flutter_web_plugins.dart'; +import 'package:patapata_core/web/patapata_web_plugin.dart'; +import 'package:patapata_core/web/web_local_config.dart'; + +var _sPlugins = {}; + +class PatapataCoreWeb { + static void registerWith(Registrar registrar) { + final MethodChannel channel = MethodChannel( + 'dev.patapata.patapata_core', + const StandardMethodCodec(), + registrar, + ); + + final tPluginInstance = PatapataCoreWeb(); + channel.setMethodCallHandler(tPluginInstance.handleMethodCall); + + _sPlugins.add(WebLocalConfig(registrar)); + } + + Future handleMethodCall(MethodCall call) async { + switch (call.method) { + case 'enablePlugin': + var tName = call.arguments as String?; + if (tName == null) { + return; + } + return enablePlugin(tName); + case 'disablePlugin': + var tName = call.arguments as String?; + if (tName == null) { + return; + } + return disablePlugin(tName); + default: + throw PlatformException( + code: 'Unimplemented', + details: + 'patapata_core for web doesn\'t implement \'${call.method}\'', + ); + } + } + + void enablePlugin(String pluginName) { + for (var plugin in _sPlugins) { + if (plugin.patapataName == pluginName) { + plugin.patapataEnable(); + return; + } + } + } + + void disablePlugin(String pluginName) { + for (var plugin in _sPlugins) { + if (plugin.patapataName == pluginName) { + plugin.patapataDisable(); + return; + } + } + } +} diff --git a/packages/patapata_core/lib/patapata_widgets.dart b/packages/patapata_core/lib/patapata_widgets.dart new file mode 100644 index 0000000..01e8eb2 --- /dev/null +++ b/packages/patapata_core/lib/patapata_widgets.dart @@ -0,0 +1,10 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_widgets; + +export 'src/widgets/standard_app.dart'; +export 'src/widgets/screen_layout.dart'; +export 'src/widgets/platform_dialog.dart'; diff --git a/packages/patapata_core/lib/src/analytics.dart b/packages/patapata_core/lib/src/analytics.dart new file mode 100644 index 0000000..6f3ca13 --- /dev/null +++ b/packages/patapata_core/lib/src/analytics.dart @@ -0,0 +1,1291 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:convert'; + +import 'package:collection/collection.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/rendering.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:provider/provider.dart'; +import 'package:provider/single_child_widget.dart'; +import 'package:visibility_detector/visibility_detector.dart'; + +final _logger = Logger('patapata.Analytics'); + +class _AnalyticsGlobalContextRouteKey {} + +/// A mixin for an [App.environment] that can filter [AnalyticsEvent]s. +mixin AnalyticsEventFilterEnvironment { + /// A map of [Type] to a function that takes an [AnalyticsEvent] and returns + /// an [AnalyticsEvent] or null if the event should be filtered. + /// The [Type] is usually a [Plugin] type or another custom type. + /// You can use this to force certain events to only be sent to certain + /// plugins or other types as well as transform the event. + Map + get analyticsEventFilter; +} + +/// An analytics class that notifies and monitors information related to events within the app, +/// user tracking, and more, to external services or within the app itself. +class Analytics { + final _eventStreamController = StreamController.broadcast(); + + /// The stream of [AnalyticsEvent] that are sent via [event], [rawEvent], and other method that send events. + Stream get events => _eventStreamController.stream; + + /// Listen to analytics events. + /// These will be filtered by checking [T] in the + /// [App.environment] if it's a [AnalyticsEventFilterEnvironment] + /// to see if a given event should be sent to that type [T]. + Stream eventsFor() { + return events + .map((event) { + final tEnvironment = + getApp().environmentAs(); + + if (tEnvironment?.analyticsEventFilter.containsKey(T) == true) { + return tEnvironment!.analyticsEventFilter[T]!(event); + } + return event; + }) + .where((event) => event != null) + .map((event) => event!); + } + + late final _globalContext = _MultiAnalyticsContext() + ..add(_globalContextRouteKey, _globalRouteContext); + + /// Analytics Context found in the route. + AnalyticsContext get globalContext => _globalContext; + + /// Adds an [AnalyticsContext] with the [key] name to the global context. + /// Passing null for [context] will remove it from the global context. + /// + /// example: + /// + /// ```dart + /// // If you want to add context information to all events + /// final _key = Object(); + /// getApp().analytics.setGlobalContext(_key, AnalyticsContext( + /// data: { + /// 'key1': 1, + /// }, + /// )); + /// // When you want to remove it + /// getApp().analytics.setGlobalContext(_key, null); + /// ``` + void setGlobalContext(Object key, AnalyticsContext? context) { + _logger.fine('Changing global context: key: $key, context: $context'); + + if (context == null) { + _globalContext.remove(key); + } else { + _globalContext.add(key, context); + } + } + + /// The [AnalyticsContext] that was set with [key] in the global context. + AnalyticsContext? getGlobalContext(Object key) => _globalContext.get(key); + + final _globalContextRouteKey = _AnalyticsGlobalContextRouteKey(); + final _globalRouteContext = _MultiAnalyticsContext(); + + /// Add an [AnalyticsContext] with the [key] name to the global route context. + /// If you pass null for the argument [context] of this function, it will be removed from the global route context. + /// The values set in this Route Context will disappear when transitioning to other pages. + /// example: + /// + /// ```dart + /// final _key = Object(); + /// getApp().analytics.setRouteContext(_key, AnalyticsContext( + /// data: { + /// 'key1': 1, + /// }, + /// )); + /// + /// // When deleting manually + /// getApp().analytics.setRouteContext(_key, null); + /// ``` + void setRouteContext(Object key, AnalyticsContext? context) { + if (context == null) { + _globalRouteContext.remove(key); + } else { + _globalRouteContext.add(key, context); + } + } + + /// The [AnalyticsContext] that was set with [key] in the global route context. + AnalyticsContext? getRouteContext(Object key) => _globalRouteContext.get(key); + + AnalyticsContext? __interactionContext; + Map? _interactionContextData; + + /// A Map of data from the Context of a Widget with the most recently interacted (touched) with Analytics information by the user. + Map? get interactionContextData => _interactionContextData; + set _interactionContext(AnalyticsContext? context) { + if (context != __interactionContext) { + _logger.fine('Changing interaction context: $context'); + __interactionContext = context; + _interactionContextData = context?.resolve(); + } + } + + Map? _navigationInteractionContextData; + + /// A Map of data to retain analytics information for page transitions. + Map? get navigationInteractionContextData => + _navigationInteractionContextData; + + void _promoteInteractionContextToNavigationContext() { + _logger.finer('Promoting interaction context...'); + _navigationInteractionContextData = interactionContextData; + _interactionContext = null; + } + + /// Send analytics for the information in [event]. + /// Used when you want to send custom analytics events. + /// + /// example: + /// + /// ```dart + /// getApp().analytics.rawEvent(AnalyticsEvent( + /// name: 'Custom Hogehoge Event', + /// )); + /// ``` + void rawEvent( + AnalyticsEvent event, { + Level logLevel = Level.INFO, + }) { + event._navigationInteractionContextData = navigationInteractionContextData; + + _logger.log(logLevel, () => '$event'); + _eventStreamController.add(event); + } + + /// Send analytics for the event with the name [name]. + /// When you cannot use Patapata's standard Analytics-related Widget or when you want to manually send events, you can follow this approach. + /// + /// example: + /// + /// ```dart + /// getApp().analytics.event( + /// name: 'Hogehoge Event', + /// ); + /// ``` + void event({ + required String name, + Map? data, + BuildContext? context, + Level logLevel = Level.INFO, + }) { + AnalyticsContext? tAnalyticsContext; + + if (context != null) { + tAnalyticsContext = Provider.of(context, listen: false); + } else { + tAnalyticsContext = globalContext; + } + + final tEvent = AnalyticsEvent( + name: name, + data: data, + context: tAnalyticsContext, + ); + + tEvent._navigationInteractionContextData = navigationInteractionContextData; + + _logger.log(logLevel, () => '$tEvent'); + _eventStreamController.add(tEvent); + } + + /// Send analytics for the [route]. + /// Used when you want to send events related to page transitions. + /// + /// example: + /// + /// ```dart + /// getApp().analytics.routeViewEvent( + /// route: Route.of(context), + /// navigationType: AnalyticsNavigationType.push, + /// ); + /// ``` + void routeViewEvent( + Route route, { + String navigationType = AnalyticsNavigationType.push, + }) { + _promoteInteractionContextToNavigationContext(); + rawEvent( + AnalyticsRouteViewEvent( + analytics: this, + route: route, + navigationType: navigationType, + ), + ); + } + + /// Send analytics for revenue. + /// 'Revenue' refers to numeric values related to sales or earnings. + /// + /// example: + /// + /// ```dart + /// getApp().analytics.revenueEvent( + /// revenue: 100.0, + /// ); + /// ``` + void revenueEvent({ + required double revenue, + String? currency, + String? orderId, + String? receipt, + String? productId, + String? productName, + String? eventName, + Map? data, + AnalyticsContext? context, + Level logLevel = Level.INFO, + }) { + rawEvent( + AnalyticsRevenueEvent( + revenue: revenue, + currency: currency, + orderId: orderId, + receipt: receipt, + productId: productId, + productName: productName, + eventName: eventName, + context: context, + ), + logLevel: logLevel, + ); + } + + /// Convert the data type of [object] to int, double, or String using the default judgment and return it. + /// Additionally, in this function, data for the Analytics system trims the value side of key-value pairs to a maximum of 100 characters. + /// This is because the average length limitation for the value strings of third-party Analytics systems is around 100 characters. + static Object? defaultMakeLoggableToNative(Object? object) { + if (object == null) { + return ''; + } else if (object is int || object is double || object is String) { + if (object is String) { + return object.characters.take(100).toString(); + } + + return object; + } else { + try { + return jsonEncode(object).characters.take(100).toString(); + } catch (_) { + return object.toString(); + } + } + } + + static const _kMaxJsonParameterLength = 100; + + /// Convert [object] into a loggable JSON parameter with the prefix [prefix]. + static Map tryConvertToLoggableJsonParameters( + String prefix, Object? object) { + if (object == null) { + return const {}; + } + + final String tJson; + + if (object is String) { + tJson = object; + } else if (object is int || object is double) { + tJson = object.toString(); + } else { + try { + tJson = jsonEncode(object); + } catch (e) { + return const {}; + } + } + + final tMap = {}; + final tCharacters = tJson.characters; + + var i = 0; + for (;; i++) { + final tPart = tCharacters.getRange( + _kMaxJsonParameterLength * i, _kMaxJsonParameterLength * (i + 1)); + + if (tPart.isEmpty) { + break; + } + + tMap['$prefix${i + 1}'] = tPart.toString(); + } + + return tMap; + } + + @override + String toString() => 'interactionContext:$interactionContextData'; +} + +/// Analytics event class +class AnalyticsEvent { + /// The name of this event. + final String name; + + /// Analytics data. + final Map? data; + + /// A Map created from the AnalyticsContext passed to this event. + final Map? contextData; + + Map? _navigationInteractionContextData; + + /// Data for NavigationInteractionContext. + Map? get navigationInteractionContextData => + _navigationInteractionContextData; + + /// Creates an [AnalyticsEvent]. + /// Specify the name for this [AnalyticsEvent] to be created with [name], and pass the data for this event to [data]. + /// If you provide [context], it will merge the data specified in [context] in to [data] with [data] being prioritized. + AnalyticsEvent({ + required this.name, + this.data, + AnalyticsContext? context, + }) : contextData = context?.resolve(); + + /// A flat map from [contextData] and [data]. + Map? get flatData => {} + ..addAll(contextData ?? const {}) + ..addAll(data ?? const {}) + ..removeWhere((key, value) => value == null); + + @override + String toString() => + 'AnalyticsEvent:$name: data=$data, context=$contextData, navigationInteractionContext=$navigationInteractionContextData'; + + @override + operator ==(Object other) => other is AnalyticsEvent + ? name == other.name && + mapEquals(data, other.data) && + mapEquals(contextData, contextData) + : false; + + @override + int get hashCode => Object.hashAll([ + name, + const MapEquality().hash(data), + const MapEquality().hash(contextData), + ]); +} + +/// Context class for using analytics functionality, +/// to be used in conjunction with [AnalyticsContextProvider]. +class AnalyticsContext { + final Map _data = {}; + AnalyticsContext? _parent; + + /// Creates a [AnalyticsContext] with event data [data]. + AnalyticsContext(Map data) { + _data.addAll(data); + } + + factory AnalyticsContext._withParent( + AnalyticsContext parent, + AnalyticsContext child, + ) => + AnalyticsContext( + Map.from(child._data), + ).._parent = parent; + + /// Recursively examines parent [AnalyticsContext]s, + /// and merges any data from them in to this [AnalyticsContext]'s data and returns the result. + Map resolve() => _parent != null + ? { + ..._parent!.resolve(), + ..._data, + } + : Map.from(_data); + + @override + operator ==(Object other) => other is AnalyticsContext + ? _parent == other._parent && mapEquals(_data, other._data) + : false; + + @override + int get hashCode => Object.hashAll([ + _parent, + const MapEquality().hash(_data), + ]); + + @override + String toString() => 'AnalyticsContext:${resolve()}'; +} + +class _MultiAnalyticsContext implements AnalyticsContext { + @override + AnalyticsContext? _parent; + + @override + Map get _data => { + for (var i in _globalContextMap.values) ...i.resolve(), + }; + + final _globalContextMap = {}; + + void add(Object key, AnalyticsContext value) { + _globalContextMap[key] = value; + } + + void remove(Object key) { + _globalContextMap.remove(key); + } + + void clear() { + _globalContextMap.clear(); + } + + AnalyticsContext? get(Object key) => _globalContextMap[key]; + + @override + Map resolve() => _data; +} + +/// A widget that provides [AnalyticsContext] to it's child widgets via [Provider]. +/// +/// example: +/// +/// ```dart +/// class MyWidget extends StatelessWidget { +/// const MyWidget({super.key}); +/// @override +/// Widget build(BuildContext context) { +/// return AnalyticsContextProvider( +/// analyticsContext: AnalyticsContext({ +/// 'hogehoge': 'fugafuga', +/// }), +/// child: ..., +/// ); +/// } +/// } +/// ``` +class AnalyticsContextProvider extends SingleChildStatelessWidget { + /// This [AnalyticsContext] is passed to child widgets via [Provider]. + final AnalyticsContext analyticsContext; + + /// A flag to reset [analyticsContext]. Default is `false.` + /// If set to true, a new analytics context will be created. + /// If set to false, it will merge with the existing analytics context. + final bool reset; + + /// Creates a AnalyticsContextProvider. + /// Provide an [analyticsContext] and pass the widget to be wrapped as [child]. + /// Optionally, use the [reset] flag to specify whether to reset the [analyticsContext]. + const AnalyticsContextProvider({ + Key? key, + required this.analyticsContext, + required Widget child, + this.reset = false, + }) : super( + key: key, + child: child, + ); + + @override + Widget buildWithChild(BuildContext context, Widget? child) { + final tContext = reset + ? analyticsContext + : AnalyticsContext._withParent( + context.watch(), + analyticsContext, + ); + + return _AnalyticsContextProviderRenderWidget( + analyticsContext: tContext, + child: Provider.value( + value: tContext, + child: child, + ), + ); + } +} + +class _AnalyticsContextProviderRenderWidget + extends SingleChildRenderObjectWidget { + final AnalyticsContext analyticsContext; + + const _AnalyticsContextProviderRenderWidget({ + Key? key, + required this.analyticsContext, + required Widget child, + }) : super( + key: key, + child: child, + ); + + @override + _AnalyticsContextProviderRenderObject createRenderObject( + BuildContext context) => + _AnalyticsContextProviderRenderObject(analyticsContext); + + @override + void updateRenderObject( + BuildContext context, + covariant _AnalyticsContextProviderRenderObject renderObject, + ) { + renderObject.analyticsContext = analyticsContext; + } +} + +class _AnalyticsContextProviderRenderObject extends RenderProxyBox { + AnalyticsContext analyticsContext; + + _AnalyticsContextProviderRenderObject(this.analyticsContext); +} + +/// Class that keeps track of which widgets the user has interacted with. +/// While this class is publicly accessible, it is not typically used directly by an application. +/// @nodoc +class AnalyticsPointerEventListener extends SingleChildRenderObjectWidget { + const AnalyticsPointerEventListener({ + Key? key, + required Widget child, + }) : super( + key: key, + child: child, + ); + + @override + RenderObject createRenderObject(BuildContext context) => + _AnalyticsPointerEventListenerRenderObject(context.read()); + + @override + void updateRenderObject( + BuildContext context, + // ignore: library_private_types_in_public_api + covariant _AnalyticsPointerEventListenerRenderObject renderObject, + ) { + renderObject.analytics = context.read(); + } +} + +class _AnalyticsPointerEventListenerRenderObject extends RenderProxyBox { + Analytics analytics; + + _AnalyticsPointerEventListenerRenderObject(this.analytics); + + @override + bool hitTest(BoxHitTestResult result, {required Offset position}) { + if (hitTestChildren(result, position: position)) { + AnalyticsContext? tContext; + RenderObject? tRenderObject; + + for (var i in result.path) { + if (i.target is RenderObject) { + tRenderObject = i.target as RenderObject; + + break; + } + } + + while (tRenderObject != null) { + if (tRenderObject is _AnalyticsContextProviderRenderObject) { + tContext = tRenderObject.analyticsContext; + + break; + } + + tRenderObject = tRenderObject.parent; + } + + analytics._interactionContext = tContext; + + return true; + } + + return false; + } + + // coverage:ignore-start + @override + bool hitTestSelf(Offset position) => false; + // coverage:ignore-end +} + +/// A widget that sends analytics events when the user taps the widget and releases their finger, +/// in other words, using [Listener.onPointerUp]. +class AnalyticsEventWidget extends StatelessWidget { + /// The name of the analytics event. + final String? name; + + /// Analytics data. + /// If [event] is not set, this property will be used. + final Map? data; + + /// The event to be set for analytics. + final AnalyticsEvent? event; + + /// Widgets to target for analytics. + final Widget? child; + + /// Creates a AnalyticsEventWidget. + /// Specify the widget targeted for analytics operations in [child] and send analytics data. + /// If you want to send a custom event, specify an AnalyticsEvent in [event]. If [event] is not set, + /// send analytics data with the analytics event name specified in [name]. + const AnalyticsEventWidget({ + Key? key, + this.name, + this.data, + this.event, + this.child, + }) : assert(event == null || name == null), + assert(data == null || event == null), + super(key: key); + + @override + Widget build(BuildContext context) { + return Listener( + behavior: HitTestBehavior.deferToChild, + onPointerUp: (_) { + // ignore: todo + // TODO: This event fires even when the child event cancels... + if (event != null) { + context.read().rawEvent(event!); + } else { + context.read().event( + name: name!, + data: data, + context: context, + ); + } + }, + child: child, + ); + } +} + +/// A widget that sends an event only once when the child widget is built. +/// +/// example: +/// +/// ```dart +/// class MyWidget extends StatelessWidget { +/// const MyWidget({super.key}); +/// @override +/// Widget build(BuildContext context) { +/// return AnalyticsSingletonEventWidget( +/// name: 'Hogehoge' +/// child: ..., +/// ); +/// } +/// } +/// ``` +class AnalyticsSingletonEventWidget extends SingleChildStatefulWidget { + /// The name of the analytics event. + final String? name; + + /// Analytics data to be sent. + final Map? data; + + /// The event to be set for analytics. + final AnalyticsEvent? event; + + /// Creates a AnalyticsSingletonEventWidget. + const AnalyticsSingletonEventWidget({ + Key? key, + this.name, + this.data, + this.event, + Widget? child, + }) : assert(event == null || name == null), + assert(data == null || event == null), + super( + key: key, + child: child, + ); + + @override + // ignore: library_private_types_in_public_api + _AnalyticsSingletonEventWidgetState createState() => + _AnalyticsSingletonEventWidgetState(); +} + +class _AnalyticsSingletonEventWidgetState + extends SingleChildState { + @override + void initState() { + super.initState(); + _sendEvent(); + } + + @override + void didUpdateWidget(covariant AnalyticsSingletonEventWidget oldWidget) { + super.didUpdateWidget(oldWidget); + + // Skip the data. + if (widget.event != oldWidget.event || widget.name != oldWidget.name) { + _sendEvent(); + } + } + + @override + Widget buildWithChild(BuildContext context, Widget? child) { + return child ?? const SizedBox.shrink(); + } + + void _sendEvent() { + if (widget.event != null) { + context.read().rawEvent(widget.event!); + } else { + context.read().event( + name: widget.name!, + data: widget.data, + context: context, + ); + } + } +} + +/// A widget that sends analytics when the widget is displayed, i.e., during impressions. +/// When using this widget, if you are adding this to each item in a list of items, it is recommended to set the [batchGenerator] for sending multiple analytics events with batch processing. +/// +/// example: +/// +/// ```dart +/// class AnalyticsHogehogePage extends StandardPage { +/// @override +/// Widget buildPage(BuildContext context) { +/// return ListView.builder( +/// itemCount: 50, +/// itemBuilder: (context, index) { +/// return AnalyticsContextProvider( +/// analyticsContext: AnalyticsContext({ +/// 'section': 'Section $index', +/// }), +/// child: AnalyticsImpressionWidget( +/// visibleThreshold: 0.1, +/// name: 'Analytics Impression', +/// data: { +/// 'name': 'Analytics Page Item $index', +/// }, +/// batchToIgnore: const {'section'}, +/// batchGenerator: (datas, contexts) { +/// return { +/// 'name': datas.map((e) => e['name']).join(','), +/// 'section': +/// contexts.map((e) => e.resolve()['section']).join(','), +/// }; +/// }, +/// child: Text("Impression index : $index"), +/// ), +/// ); +/// }, +/// ); +/// } +/// } +/// ``` +class AnalyticsImpressionWidget extends SingleChildStatefulWidget { + /// The time to wait after displaying before sending + final Duration durationThreshold; + + /// The value of what percentage of the child to be displayed before sending an event. + final double? visibleThreshold; + + /// This is a function that can be set when you want to use your custom logic instead of 'visibleThreshold' to determine whether it should be sent. + final bool Function(VisibilityInfo info)? thresholdCallback; + + /// The name of the analytics event. + final String? name; + + /// Analytics data. + final Map? data; + + /// The event to be set for analytics. + final AnalyticsEvent? event; + + /// Set to `true` to send events only once per lifecycle of this Widget, default is `false`. + final bool once; + + /// This function is used to create batch data. When set, it sends impression information as a batch. + final Map Function( + List> datas, List contexts)? + batchGenerator; + + /// A list of names of analytics context keys to ignore in batch sending. + final Set batchDataToIgnore; + + /// Creates a AnalyticsImpressionWidget. + const AnalyticsImpressionWidget({ + Key? key, + required Widget child, + this.name, + this.data, + this.event, + this.durationThreshold = const Duration( + seconds: 1, + ), + this.visibleThreshold, + this.thresholdCallback, + this.once = false, + this.batchGenerator, + this.batchDataToIgnore = const {}, + }) : assert( + (event == null && name != null) || (name == null && event != null)), + assert(data == null || event == null), + assert(visibleThreshold != null || thresholdCallback != null), + assert(!(event != null && batchGenerator != null)), + super( + key: key, + child: child, + ); + + @override + // ignore: library_private_types_in_public_api + _AnalyticsImpressionWidgetState createState() => + _AnalyticsImpressionWidgetState(); +} + +class _AnalyticsImpressionWidgetState + extends SingleChildState { + final _key = UniqueKey(); + bool _visible = false; + bool _eventSent = false; + Timer? _timer; + Map? _currentData; + + void _copyData() { + _eventSent = false; + _currentData = + widget.data == null ? null : Map.from(widget.data!); + } + + @override + void initState() { + super.initState(); + _copyData(); + } + + @override + void dispose() { + super.dispose(); + _timer?.cancel(); + VisibilityDetectorController.instance.forget(_key); + } + + @override + void didUpdateWidget(covariant AnalyticsImpressionWidget oldWidget) { + super.didUpdateWidget(oldWidget); + + // Ignore the data. + if (widget.event != oldWidget.event || widget.name != oldWidget.name) { + _copyData(); + _schedule(); + } else { + notifyDataChanged(); + } + } + + @override + Widget buildWithChild(BuildContext context, Widget? child) { + return VisibilityDetector( + key: _key, + onVisibilityChanged: _onVisibilityChanged, + child: child!, + ); + } + + void notifyDataChanged() { + if (_visible && !mapEquals(_currentData, widget.data)) { + _copyData(); + _schedule(); + } + } + + void _onVisibilityChanged(VisibilityInfo info) { + if (widget.visibleThreshold != null) { + if (!_visible && info.visibleFraction >= widget.visibleThreshold!) { + _visible = true; + _schedule(); + } else if (_visible && info.visibleFraction < widget.visibleThreshold!) { + _visible = false; + _unschedule(); + } + } else if (widget.thresholdCallback != null) { + if (!_visible && widget.thresholdCallback!(info)) { + _visible = true; + _schedule(); + } else if (_visible && !widget.thresholdCallback!(info)) { + _visible = false; + _unschedule(); + } + } + } + + void _unschedule() { + _timer?.cancel(); + } + + void _schedule() { + if (!mounted || (widget.once && _eventSent)) { + return; + } + + _timer?.cancel(); + _timer = Timer(widget.durationThreshold, _sendEvent); + } + + static final _batches = {}; + static var _batchScheduled = false; + + int _batchHash( + Analytics analytics, + AnalyticsContext context, + String name, + Map Function( + List> datas, List contexts) + generator, + ) { + final tAnalyticsContext = context.resolve() + ..removeWhere((key, value) => widget.batchDataToIgnore.contains(key)); + + return Object.hash( + name, analytics, tAnalyticsContext.toString(), generator); + } + + void _scheduleBatch() { + if (_batchScheduled) { + return; + } + + _batchScheduled = true; + scheduleFunction(_processBatch); + } + + void _processBatch() { + _batchScheduled = false; + final tBatches = Map.of(_batches); + _batches.clear(); + + for (var i in tBatches.values) { + // Force ignored data to null. + final tData = widget.batchDataToIgnore.isNotEmpty + ? { + for (var i in widget.batchDataToIgnore) i: null, + ...i.generator(i.datas, i.contexts), + } + : i.generator(i.datas, i.contexts); + + i.analytics.rawEvent( + AnalyticsEvent( + name: i.name, + data: tData, + context: i.contexts.first, + ), + ); + } + } + + void _sendEvent() { + _eventSent = true; + final tAnalytics = context.read(); + + if (widget.batchGenerator != null) { + final tAnalyticsContext = context.read(); + + _batches.putIfAbsent( + _batchHash(tAnalytics, tAnalyticsContext, widget.name!, + widget.batchGenerator!), + () => _ImpressionBatch( + widget.name!, + tAnalytics, + widget.batchGenerator!, + ), + ) + ..datas.add(widget.data ?? const {}) + ..contexts.add(tAnalyticsContext); + _scheduleBatch(); + } else { + if (widget.event != null) { + tAnalytics.rawEvent(widget.event!); + } else { + tAnalytics.event( + name: widget.name!, + data: widget.data, + context: context, + ); + } + } + } +} + +class _ImpressionBatch { + final datas = >[]; + final contexts = []; + final String name; + final Analytics analytics; + final Map Function( + List> datas, List contexts) + generator; + + _ImpressionBatch( + this.name, + this.analytics, + this.generator, + ); +} + +/// A class representing the names of analytics events as strings. +class AnalyticsEventName { + /// The name of the `routeView` event. + static const String routeView = 'routeView'; + + /// The name of the `revenue` event. + static const String revenue = 'revenue'; +} + +/// A class representing the types of transitions as strings to be used as analytics data for page navigation. +class AnalyticsNavigationType { + /// The string for the `push` navigation type. + static const String push = 'push'; + + /// The string for the `pop` navigation type. + static const String pop = 'pop'; + + /// The string for the `replace` navigation type. + static const String replace = 'replace'; + + /// The string for the `remove` navigation type. + static const String remove = 'remove'; +} + +/// An extension to add [AnalyticsContext] functionality to [BuildContext]. +extension AnalyticsTryGetContext on BuildContext { + /// If [AnalyticsContext] can be retrieved from the widget tree, it returns that context. + AnalyticsContext? maybeGetAnalyticsContext() { + return Provider.of( + this, + listen: false, + ); + } +} + +/// Class for RouteView analytics events. +class AnalyticsRouteViewEvent extends AnalyticsEvent { + /// Flag indicating whether the route is the first (bottom most) route in the navigator's stack. + /// For more details, refer to [Route.isFirst]. + bool get isFirst => data!['isFirst'] as bool; + + /// Arguments passed to this route. + /// For more details, refer to [RouteSettings.arguments]. + String? get arguments => data!['arguments'] as String?; + + /// The name of this route. + /// For more details, refer to [RouteSettings.name]. + String? get routeName => data!['routeName'] as String?; + + /// A string representing the navigation type [AnalyticsNavigationType] during page transitions. + String get navigationType => data!['navigationType'] as String; + + /// Creates a AnalyticsRouteViewEvent + AnalyticsRouteViewEvent({ + required Analytics analytics, + required Route route, + required String navigationType, + }) : super( + name: AnalyticsEventName.routeView, + data: { + 'isFirst': route.isFirst, + if (route.settings.arguments != null) + 'arguments': route.settings.arguments?.toString(), + if (route.settings is StandardPageInterface) ...{ + 'pageData': (route.settings as StandardPageInterface) + .standardPageKey + .currentState != + null + ? (route.settings as StandardPageInterface) + .standardPageKey + .currentState! + .pageData + : route.settings.arguments, + 'pageLink': (route.settings as StandardPageInterface) + .standardPageKey + .currentState != + null + ? (route.settings as StandardPageInterface) + .standardPageKey + .currentState! + .link + : (route.settings as StandardPageInterface) + .factoryObject + .generateLink(route.settings.arguments), + ...Analytics.tryConvertToLoggableJsonParameters( + 'pageDataJson', + (route.settings as StandardPageInterface) + .standardPageKey + .currentState != + null + ? (route.settings as StandardPageInterface) + .standardPageKey + .currentState! + .pageData + : route.settings.arguments), + }, + if (route.settings.name != null) 'routeName': route.settings.name, + 'navigationType': navigationType, + }, + context: route.navigator?.context.maybeGetAnalyticsContext(), + ); +} + +/// The necessary NavigatorObserver for the analytics system to monitor page navigation. +/// While this class is publicly accessible, it is not typically used directly by an application. +/// @nodoc +class AnalyticsNavigatorObserver extends NavigatorObserver { + final Analytics _analytics; + + AnalyticsNavigatorObserver({ + required Analytics analytics, + }) : _analytics = analytics; + + @override + void didPush(Route route, Route? previousRoute) { + if (route.isActive && route.isCurrent) { + _logger.finer('AnalyticsNavigatorObserver:didPush'); + _analytics._globalRouteContext.clear(); + _analytics.routeViewEvent( + route, + navigationType: AnalyticsNavigationType.push, + ); + } + } + + @override + void didPop(Route route, Route? previousRoute) { + if (previousRoute == null) { + return; + } + + if (previousRoute.isActive && previousRoute.isCurrent) { + _logger.finer('AnalyticsNavigatorObserver:didPop'); + _analytics._globalRouteContext.clear(); + _analytics.routeViewEvent( + previousRoute, + navigationType: AnalyticsNavigationType.pop, + ); + } + } + + @override + void didRemove(Route route, Route? previousRoute) { + if (previousRoute == null) { + return; + } + + if (previousRoute.isActive && previousRoute.isCurrent) { + _logger.finer('AnalyticsNavigatorObserver:didRemove'); + + _analytics._globalRouteContext.clear(); + _analytics.routeViewEvent( + previousRoute, + navigationType: AnalyticsNavigationType.remove, + ); + } + } + + @override + void didReplace({Route? newRoute, Route? oldRoute}) { + if (newRoute == null) { + return; + } + + _logger.finer('AnalyticsNavigatorObserver:didReplace'); + _analytics._globalRouteContext.clear(); + _analytics.routeViewEvent( + newRoute, + navigationType: AnalyticsNavigationType.replace, + ); + } + + // coverage:ignore-start + @override + void didStartUserGesture( + Route route, Route? previousRoute) { + _logger.finer('AnalyticsNavigatorObserver:didStartUserGesture'); + } + // coverage:ignore-end + + // coverage:ignore-start + @override + void didStopUserGesture() { + _logger.finer('AnalyticsNavigatorObserver:didStopUserGesture'); + } + // coverage:ignore-end +} + +/// Class for revenue-related analytics events. +class AnalyticsRevenueEvent extends AnalyticsEvent { + /// Constants for data keys related to revenue. + static const kDataKeyRevenue = 'revenue'; + + /// Constants for data keys related to currency. + static const kDataKeyCurrency = 'currency'; + + /// Constants for data keys related to Order ID. + static const kDataKeyOrderId = 'orderId'; + + /// Constants for data keys related to receipt. + static const kDataKeyReceipt = 'receipt'; + + /// Constants for data keys related to product ID. + static const kDataKeyProductId = 'productId'; + + /// Constants for data keys related to product name. + static const kDataKeyProductName = 'productName'; + + /// Value of revenue. + double get revenue => data![kDataKeyRevenue] as double; + + /// The name of the currency. This name is identified by the ISO 4217 currency code. + /// For more details, refer to [ISO Web](https://www.iso.org/iso-4217-currency-codes.html). + String? get currency => data![kDataKeyCurrency] as String?; + + /// Identifier for order. + String? get orderId => data![kDataKeyOrderId] as String?; + + /// Receipt after purchasing a product. + String? get receipt => data![kDataKeyReceipt] as String?; + + /// Identifier for products. + String? get productId => data![kDataKeyProductId] as String?; + + /// Name of the product. + String? get productName => data![kDataKeyProductName] as String?; + + /// Creates a AnalyticsRevenueEvent + AnalyticsRevenueEvent({ + required double revenue, + String? currency, + String? orderId, + String? receipt, + String? productId, + String? productName, + String? eventName, + Map? data, + super.context, + }) : super( + name: eventName ?? AnalyticsEventName.revenue, + data: { + kDataKeyRevenue: revenue, + if (currency?.isNotEmpty == true) kDataKeyCurrency: currency, + if (orderId?.isNotEmpty == true) kDataKeyOrderId: orderId, + if (receipt?.isNotEmpty == true) kDataKeyReceipt: receipt, + if (productId?.isNotEmpty == true) kDataKeyProductId: productId, + if (productName?.isNotEmpty == true) + kDataKeyProductName: productName, + }..addAll(data ?? const {}), + ); +} diff --git a/packages/patapata_core/lib/src/app.dart b/packages/patapata_core/lib/src/app.dart new file mode 100644 index 0000000..222ed35 --- /dev/null +++ b/packages/patapata_core/lib/src/app.dart @@ -0,0 +1,924 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +import 'package:collection/collection.dart' show IterableExtension; +import 'package:flutter/foundation.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter/widgets.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:provider/provider.dart'; + +final _logger = Logger('patapata.App'); + +const _methodChannel = MethodChannel('dev.patapata.patapata_core'); + +/// A value to check if this is running in a test environment. +/// Defined by setting the dart define IS_TEST to true +/// +/// Example: flutter test --dart-define=IS_TEST=true +const bool kIsTest = bool.fromEnvironment('IS_TEST', defaultValue: false); + +/// Defines what stage the [App] is currently in. +enum AppStage { + /// The first stage where the [App] hasn't done any operations + /// and [App.run] hasn't been executed yet. + setup, + + /// Entered after [App.run] executes. + /// Right after changing, the [App.run]'s bootstrapCallback parameter is executed. + /// At this stage, Flutter's services has been initialized via [WidgetsFlutterBinding.ensureInitialized], + /// all code is from now on executed in a guarded [Zone] to catch errors, + /// and the logging system for [App.log] is set up. + bootstrap, + + /// All [Plugin]s that are able to initialize (all requirements are met) + /// are initialized in this stage. + initializingPlugins, + + /// [RemoteConfig] systems from [Plugin.createRemoteConfig] are created + /// and initialized in this stage. + setupRemoteConfig, + + /// [Plugin]s that required a [RemoteConfig] to be set up before initialization + /// are initialized in this stage. + /// It is in this stage where [Plugin]s that should be disabled via [RemoteConfig] + /// are removed. + initializingPluginsWithRemoteConfig, + + /// The main stage of an [App]. After initialization, the [App] will generally be + /// in this stage forever except during rare cases or tests. + running, + + /// Entered upon calling [App.dispose]. + /// In general, this does not happen except during rare cases or tests. + disposed, +} + +/// Returns the [App] for the current [Zone]. +/// In almost all cases in your application, you can use this to +/// grab your [App] instance without a [BuildContext] +/// [T] is not required and will work undefined (as dynamic). +App getApp() => ((kDebugMode && !kIsTest) + ? (Zone.current[#patapataApp] ?? // coverage:ignore-line + _debugAppZone[#patapataApp]) // coverage:ignore-line + : Zone.current[#patapataApp]) as App; + +// https://github.com/flutter/flutter/issues/93676 +late Zone _debugAppZone; // coverage:ignore-line + +/// The main class for a Patapata app. +/// Typically passed to [runApp]. +/// The main class for a Patapata-based application. +class App { + static final StreamController _stageStreamController = + StreamController.broadcast(sync: true); + + /// A [Stream] that can be listened to for global changes to all [App]s that exist. + static Stream get appStageChangeStream => _stageStreamController.stream; + + /// These are [Plugin]s required for the core of Patapata to work. + final _defaultRequiredPlugins = [ + I18nPlugin(), + NativeLocalConfigPlugin(), + NetworkPlugin(), + PackageInfoPlugin(), + DeviceInfoPlugin(), + NotificationsPlugin(), + StandardAppPlugin(), + ]; + + AppStage __stage = AppStage.setup; + + /// The current stage of this [App]. + AppStage get stage => __stage; + set _stage(AppStage value) { + assert(__stage != AppStage.disposed); + + __stage = value; + _logger.fine('Stage ${value.name}'); + _stageStreamController.add(this); + } + + /// The Environment object that will be accessible to all + /// Widgets via a [Provider]. + /// This is also used to customize [Plugin]s usually via a Mixin. + final T environment; + + /// A helper function to attempt to cast [environment] as the given Type [V]. + /// If [environment] is not a [V] this function returns null. + /// Useful for a [Plugin] to check an Environment supports that [Plugin]s Mixin features. + V? environmentAs() => environment is V ? environment as V : null; + + /// Use this to access all the logging features of Patapata. + late final Log log; + + /// A function that can create a custom [User] object or subclass for this [App]. + /// This is usually used to provide custom functions, properties, login methods + /// and such for your own application. + /// + /// For example: + /// ```dart + /// + /// class MyCustomUser extends User { + /// MyCustomUser({super.app}); + /// + /// void login() async { + /// // Contact your server to login. + /// changeId(await _apiLogin()); + /// } + /// } + /// + /// void main() { + /// App( + /// userFactory: (app) => MyCustomUser(app: app), + /// ).run(); + /// } + /// ``` + final User Function(App app) userFactory; + + static User _sDefaultUserFactory(App app) => User(app: app); + + User? _user; + + /// Gets the current [User] and if not yet created, creates one + /// via [userFactory]. If there is no [userFactory] set, creates + /// a default [User]. + User get user => _user ??= userFactory(this); + + final Analytics _analytics = Analytics(); + + /// Use this to access the [Analytics] system for this [App]. + Analytics get analytics => _analytics; + + late final Permissions _permissions = Permissions(app: this); + + /// Use this to access the [Permissions] system for this [App]. + Permissions get permissions => _permissions; + + /// The [Widget] ultimately passed in to flutter's [runApp] function. + /// If you are using the [StandardAppPlugin], you usually return a + /// [StandardMaterialApp] or [StandardCupertinoApp] from this function. + final Widget Function(BuildContext context, App app) createAppWidget; + + /// The error widget to show in a non-debug build when + /// a [FlutterError] occurrs. + /// Default is to show nothing `const SizedBox.shrink()`. + final ErrorWidgetBuilder nonDebugErrorWidgetBuilder; + ErrorWidgetBuilder? _originalErrorWidgetBuilder; + + /// A callback that gets called when this [App] fails to initialize at any stage. + final FutureOr Function(T, dynamic, StackTrace)? onInitFailure; + + final List _plugins = []; + + /// Access to the [RemoteConfig] system. + /// This particular [RemoteConfig] acts as a proxy between + /// all of the [RemoteConfig]s created from all initialized [Plugin]s. + /// + /// When getting a value from this, it will attempt to get the first value + /// that exists from the given key amongst the registered [RemoteConfig]s in [Plugin] + /// registration order. ie, the order that [Plugin]s were passed in to the plugins + /// parameter in the constuctor of this [App] appending anything added via [addPlugin] afterwards. + /// + /// The [RemoteConfig.fetch] called from this [RemoteConfig] is guaranteed to succeed, + /// ignoring all exceptions. + final RemoteConfig remoteConfig = ProxyRemoteConfig(); + ProxyRemoteConfig get _proxyRemoteConfig => remoteConfig as ProxyRemoteConfig; + final Map _pluginToRemoteConfigMap = {}; + + /// Access to the [LocalConfig] system. + /// This particular [LocalConfig] acts as a proxy between + /// all of the [LocalConfig]s created from all initialized [Plugin]s. + /// + /// When getting a value from this, it will attempt to get the first value + /// that exists from the given key amongst the registered [LocalConfig]s in [Plugin] + /// registration order. ie, the order that [Plugin]s were passed in to the plugins + /// parameter in the constuctor of this [App] appending anything added via [addPlugin] afterwards. + /// + /// If no [Plugin]s support [LocalConfig], a default in-memory [LocalConfig] is used with no persistence. + final LocalConfig localConfig = ProxyLocalConfig(); + ProxyLocalConfig get _proxyLocalConfig => localConfig as ProxyLocalConfig; + final Map _pluginToLocalConfigMap = {}; + + /// Access to the [RemoteMessaging] system. + /// This particular [RemoteMessaging] acts as a proxy between + /// all of the [RemoteMessaging]s created from all initialized [Plugin]s. + /// + /// For any get-style methods like [RemoteMessaging.getToken] or [RemoteMessaging.getInitialMessage], + /// only the first registered [RemoteMessaging] in [Plugin] registration order's value is returned. + /// All other methods execute on all registered [RemoteMessaging]. + /// All streams are joined to be accessed via one stream from this object. + final RemoteMessaging remoteMessaging = ProxyRemoteMessaging(); + ProxyRemoteMessaging get _proxyRemoteMessaging => + remoteMessaging as ProxyRemoteMessaging; + final Map _pluginToRemoteMessagingMap = {}; + + /// Access to the [StartupSequence] system. + /// If the app is rendering widgets using the [StandardAppPlugin] system, + /// [StartupSequence.resetMachine] is automatically executed only once when the app is launched. + final StartupSequence? startupSequence; + + bool _loadedFakeNow = false; + + late final Zone _appZone; + + /// Runs [func] in this [App]s error [Zone]. + /// Usually you do not need to use this. However in cases + /// where you are executing code that was in or forked from the + /// root [Zone] you may want to execute your code via this + /// function to allow for Patapata to catch errors, logs, etc correctly. + Future runProcess(FutureOr Function() func) { + final tCompleter = Completer(); + + _appZone.run>(() async { + try { + final tResult = await func(); + tCompleter.complete(tResult); + } catch (error, stackTrace) { + tCompleter.completeError(error, stackTrace); + rethrow; + } + }); + + return tCompleter.future; + } + + final GlobalKey _providerKey; + final bool _customProviderKey; + + /// All providers registered inside of + /// Patapata are accessible from with function, along with all + /// providers above the providerKey given in this [App]'s constructor if provided. + R getProvider() => _providerKey.currentContext!.read(); + + /// Creates a new Patapata [App]. + /// This is generally created in your main.dart files main function. + /// + /// In a normal Flutter application, you will pass your application's main + /// [Widget] in to [runApp]. + /// + /// With Patapata, you create this [App], passing [createAppWidget] which should return + /// a [Widget]. This [Widget] will eventually get passed in to [runApp] after executing [run]. + /// + /// [environment] is a [T] that you use to customize the Environment of your application. + /// [Plugin]s use this object with Mixins to customize how a [Plugin] may behave. + /// + /// Example using [LogEnvironment] to customize the logging system: + /// ```dart + /// class Environment with LogLevelEnvironment { + /// @override + /// final int logLevel; + /// + /// @override + /// final bool printLog; + /// + /// const Environment({ + /// required this.logLevel, + /// required this.printLog, + /// }); + /// } + /// + /// void main() { + /// App({ + /// environment: const Environment({ + /// // Take the value from --dart-define + /// logLevel: int.fromEnvironment('LOG_LEVEL'), + /// printLog: bool.fromEnvironment('PRINT_LOG'), + /// }), + /// }); + /// } + /// ``` + /// + /// [providerKey] can be passed here to declare your own location in the + /// widget hiearchy to allow for adding your own [MultiProvider] or single [Provider] + /// for your own applications purposes. + /// One set, you can use [getProvider] to get access to these providers without access + /// to a [BuildContext]. + /// + /// Example using [StandardAppPlugin] + /// ```dart + /// final _providerKey = GlobalKey(); + /// + /// void main() { + /// App({ + /// providerKey: _providerKey, + /// createAppWidget: (context, app) => StandardMaterialApp( + /// pages: [], + /// routableBuilder: (context, child) => MultiProvider( + /// providers: [ + /// Provider( + /// create: (context) => ClassA(), + /// ), + /// Provider.value( + /// value: context.read() as MyCustomUser, + /// ), + /// ], + /// child: KeyedSubtree( + /// key: _providerKey, + /// child: child, + /// ), + /// ), + /// }); + /// } + /// + /// // (In a different Widget somewhere in your app) + /// getApp().getProvider(); + /// ``` + /// + /// [userFactory] is used to create customized [User] objects. + /// + /// [nonDebugErrorWidgetBuilder] is used to customize the [Widget] + /// shown in place of the standard 'red screen of death' that Flutter + /// shows. Only active in release builds and defaults to a [SizedBox.shrink]. + /// + /// [onInitFailure] will be executed when this [App] fails to run for some reason. + /// + /// [plugins] is a list of [Plugin] instances that you want to enable in this [App]. + App({ + required this.environment, + required this.createAppWidget, + GlobalKey? providerKey, + this.userFactory = _sDefaultUserFactory, + this.nonDebugErrorWidgetBuilder = _defaultNonDebugErrorWidgetBuilder, + this.onInitFailure, + this.startupSequence, + Iterable? plugins, + }) : _customProviderKey = providerKey != null, + _providerKey = + providerKey ?? GlobalKey(debugLabel: 'patapata.App.providerKey') { + _plugins.addAll(_defaultRequiredPlugins); + + if (kIsTest) { + // ignore: invalid_use_of_visible_for_testing_member + permissions.setMockMethodCallHandler(); + } + + if (plugins != null) { + _plugins.addAll(plugins); + } + } + + // coverage:ignore-start + /// The default for non-debug builds is to get rid of the + /// red screen of death. + static Widget _defaultNonDebugErrorWidgetBuilder( + FlutterErrorDetails details) { + return const SizedBox.shrink(); + } + // coverage:ignore-end + + Future _initializePlugin(Plugin plugin) async { + _logger.fine('initializePlugin start: ${plugin.name}'); + + // Initialize. If it returns false, that means the plugin + // wants to silently not enable itself. + if (!await plugin.init(this)) { + _logger.fine('initializePlugin silent fail: ${plugin.name}'); + + return false; + } + + // Register any [LocalConfig]. + final tLocalConfig = plugin.createLocalConfig(); + + if (tLocalConfig != null) { + await _proxyLocalConfig.addLocalConfig(tLocalConfig); + _pluginToLocalConfigMap[plugin] = tLocalConfig; + } + + // Register any [RemoteConfig]. + final tRemoteConfig = plugin.createRemoteConfig(); + + if (tRemoteConfig != null) { + await _proxyRemoteConfig.addRemoteConfig(tRemoteConfig); + _pluginToRemoteConfigMap[plugin] = tRemoteConfig; + } + + // Register any [RemoteMessaging]. + final tRemoteMessaging = plugin.createRemoteMessaging(); + + if (tRemoteMessaging != null) { + await _proxyRemoteMessaging.addRemoteMessaging(tRemoteMessaging); + _pluginToRemoteMessagingMap[plugin] = tRemoteMessaging; + } + + if (!kIsTest) { + // coverage:ignore-start + await _methodChannel.invokeMethod('enablePlugin', plugin.name); + // coverage:ignore-end + } else { + // ignore: invalid_use_of_visible_for_testing_member + plugin.mockPatapataEnable(); + } + + _logger.fine('initializePlugin done: ${plugin.name}'); + + return true; + } + + Future _disposePlugin(Plugin plugin) async { + _logger.fine('disposePlugin start: ${plugin.name}'); + + // Unregister any [RemoteMessaging] + if (_pluginToRemoteMessagingMap.containsKey(plugin)) { + _proxyRemoteMessaging + .removeRemoteMessaging(_pluginToRemoteMessagingMap.remove(plugin)!); + } + + // Unregister any [RemoteConfig] + if (_pluginToRemoteConfigMap.containsKey(plugin)) { + _proxyRemoteConfig + .removeRemoteConfig(_pluginToRemoteConfigMap.remove(plugin)!); + } + + // Unregister any [LocalConfig] + if (_pluginToLocalConfigMap.containsKey(plugin)) { + _proxyLocalConfig + .removeLocalConfig(_pluginToLocalConfigMap.remove(plugin)!); + } + + if (!kIsTest) { + // coverage:ignore-start + await _methodChannel.invokeMethod('disablePlugin', plugin.name); + // coverage:ignore-end + } else { + // ignore: invalid_use_of_visible_for_testing_member + plugin.mockPatapataDisable(); + } + + // Dispose of it + await plugin.dispose(); + + _logger.fine('disposePlugin done: ${plugin.name}'); + } + + /// Adds a plugin to this [App]. + /// + /// The [plugin] will be added to the list of active plugins. + Future addPlugin(Plugin plugin) async { + if (stage.index > AppStage.initializingPluginsWithRemoteConfig.index) { + try { + if (await _initializePlugin(plugin)) { + _plugins.add(plugin); + } + } catch (error) { + // Failed to initialize this plugin at runtime. + // We don't fail the entire app in this case. + // However, we do allow the error system to find out + // what's going on so we rethrow. + rethrow; + } + } else { + _plugins.add(plugin); + } + } + + /// Removes a plugin from this [App]. + Future removePlugin(Plugin plugin) async { + if (!_plugins.remove(plugin)) { + return; + } + + if (!plugin.initialized) { + return; + } + + if (!plugin.disposed) { + try { + await _disposePlugin(plugin); + } catch (error) { + // Allow the error system to find out + // what's going on so we rethrow. + rethrow; + } + } + } + + /// Returns true if the given [Plugin] type is currently registered. + bool hasPlugin(Type type) => _plugins.any((p) => p.runtimeType == type); + + /// Attempts to get the given [P] [Plugin] or null if it doesn't exist. + P? getPlugin

() => _plugins.firstWhereOrNull((p) => p is P) as P?; + + /// Gets a list of [Plugin]s of type [P]. + /// This is usually used to look for [Plugin]s that have a specific Mixin + /// to apply features to them. + List

getPluginsOfType

() => _plugins.whereType

().toList(); + + /// Access to information about the network. + NetworkPlugin get network { + final tNetworkPlugin = getPlugin(); + assert(tNetworkPlugin != null, + 'Default required plugin NetworkPlugin removed.'); + + return tNetworkPlugin!; + } + + /// Access to information about this application's metadata. + PackageInfoPlugin get package { + final tPackageInfoPlugin = getPlugin(); + assert(tPackageInfoPlugin != null, + 'Default required plugin PackageInfoPlugin removed.'); + + return tPackageInfoPlugin!; + } + + /// Access to information about the device that this application is running on. + DeviceInfoPlugin get device { + final tDeviceInfoPlugin = getPlugin(); + assert(tDeviceInfoPlugin != null, + 'Default required plugin DeviceInfoPlugin removed.'); + + return tDeviceInfoPlugin!; + } + + void _onRemoteConfigChange() { + _updateLogLevel(); + } + + void _updateLogLevel() { + log.setLevelByValue(remoteConfig.getInt( + 'patapata_log_level', + defaultValue: -kPataInHex, + )); + } + + late final StartupNavigatorObserver _startupNavigatorObserver = + StartupNavigatorObserver(startupSequence: startupSequence!); + + /// A list of all [NavigatorObserver]s to use in a [Navigator] + /// from all the [Plugin]s registered to this [App]. + /// The [Analytics] and [StartupSequence] system also relies on setting these to any + /// [Navigator]s in the application. + List get navigatorObservers => [ + for (var v in _plugins) ...v.navigatorObservers, + AnalyticsNavigatorObserver(analytics: analytics), + if (startupSequence != null) _startupNavigatorObserver, + ]; + + static const _forceRemoveNativeSplashScreenDuration = + Duration(milliseconds: 5000); + Timer? _forceRemoveNativeSplashScreenTimer; + bool _removedNativeSplashScreen = false; + + /// Remove the native splash screen for this application. + Future removeNativeSplashScreen() async { + if (_removedNativeSplashScreen) { + return; + } + _removedNativeSplashScreen = true; + + if (_forceRemoveNativeSplashScreenTimer?.isActive == true) { + // The timer does not work in the test environment. + // coverage:ignore-start + _forceRemoveNativeSplashScreenTimer?.cancel(); + _forceRemoveNativeSplashScreenTimer = null; + // coverage:ignore-end + } + + // When invokeMethod fails to find the platform plugin, it returns null + // instead of throwing an exception. + await const OptionalMethodChannel('plugin/splash_screen') + .invokeMethod('removeNativeSplashScreen'); + } + + /// Run the app. + /// Returns true if the app was successfully run. + /// + /// This will actually start up Flutter (via [runApp]) and + /// begin running through each of the [AppStage]s. + /// Pass [boostrapCallback] to run a callback after Flutter services are initialized + /// and logging systems are initialized but before anything else during the [AppStage.bootstrap] stage. + Future run([FutureOr Function()? bootstrapCallback]) async { + final tCompleter = Completer(); + + try { + _stageStreamController.add(this); + + // Execute in a guarded Zone to catch all errors correctly. + // This also allows [getApp] to work as we set a zone value for it here. + runZonedGuarded>( + () async { + try { + if (kDebugMode && !kIsTest) { + // coverage:ignore-start + _debugAppZone = Zone.current; + // coverage:ignore-end + } + bool tIsDebug = false; + assert(tIsDebug = true); + + _appZone = Zone.current; + + // Before we do anything, + // make sure the WidgetBindings are up and running so we can execute all of Flutter's APIs. + WidgetsFlutterBinding.ensureInitialized(); + + if (kIsTest) { + removeNativeSplashScreen(); + } else { + // coverage:ignore-start + _forceRemoveNativeSplashScreenTimer ??= Timer( + _forceRemoveNativeSplashScreenDuration, + removeNativeSplashScreen); + // coverage:ignore-end + } + + log = Log(this); + + if (!tIsDebug) { + // coverage:ignore-start + _originalErrorWidgetBuilder = ErrorWidget.builder; + ErrorWidget.builder = nonDebugErrorWidgetBuilder; + // coverage:ignore-end + } + + _stage = AppStage.bootstrap; + + if (bootstrapCallback != null) { + await bootstrapCallback(); + } + + _stage = AppStage.initializingPlugins; + + await _proxyRemoteMessaging.init(this); + + // Initialize plugins that don't require RemoteConfig + final tPluginsCopy = _plugins.toList(growable: false); + + for (var tPlugin in tPluginsCopy) { + if (!tPlugin.requireRemoteConfig) { + if (!await _initializePlugin(tPlugin)) { + _plugins.remove(tPlugin); + } + } + } + + _stage = AppStage.setupRemoteConfig; + + // Update RemoteConfigs + await remoteConfig.init(); + // Allow this fetch to fail like for offline startups. + remoteConfig.addListener(_onRemoteConfigChange); + await remoteConfig + .fetch() + .timeout(const Duration(seconds: 2), onTimeout: () {}); + + _stage = AppStage.initializingPluginsWithRemoteConfig; + + // Now we can remotely disable plugins that need to be. + // Initialize plugins that do require RemoteConfig. + // And remove plugins that should be disabled. + final tPlugins = _plugins.toList(growable: false); + + for (var tPlugin in tPlugins) { + if (!remoteConfig.getBool(tPlugin.remoteConfigEnabledKey, + defaultValue: true)) { + // Remotely disabled, remove it without initializing. + await removePlugin(tPlugin); + + continue; + } + + if (!tPlugin.initialized) { + if (!await _initializePlugin(tPlugin)) { + // Failed or rejected to initialize, remove it. + await removePlugin(tPlugin); + } + } + } + + _stage = AppStage.running; + + runApp( + MultiProvider( + providers: [ + Provider.value( + value: this, + ), + Provider>.value( + value: this, + ), + Provider.value( + value: environment, + ), + ChangeNotifierProvider.value( + value: user, + ), + ChangeNotifierProvider.value( + value: remoteConfig, + ), + ChangeNotifierProvider.value( + value: localConfig, + ), + ChangeNotifierProvider.value( + value: remoteMessaging, + ), + Provider.value( + value: analytics, + ), + Provider.value( + value: analytics.globalContext, + ), + ], + child: AnalyticsPointerEventListener( + child: (() { + Widget tChild = Builder( + builder: (context) { + // Load fake time now and only once. + if (!_loadedFakeNow) { + _loadedFakeNow = true; + loadFakeNow(); + } + + return createAppWidget(context, this); + }, + ); + + if (!_customProviderKey) { + tChild = KeyedSubtree( + key: _providerKey, + child: tChild, + ); + } + + for (var tPlugin in _plugins.reversed) { + tChild = tPlugin.createAppWidgetWrapper(tChild); + } + + return tChild; + })(), + ), + ), + ); + + tCompleter.complete(true); + } catch (e, stackTrace) { + if (onInitFailure != null) { + await onInitFailure!(environment, e, stackTrace); + } else { + // ignore: avoid_print + print(e); + // ignore: avoid_print + print(stackTrace); + } + + tCompleter.complete(false); + // Throw to runZonedGuarded onError. Processing takes place in the App zone. + rethrow; + } + }, + (error, stackTrace) async { + removeNativeSplashScreen(); + + if (kDebugMode) { + // In debug mode, always print errors. + debugPrint(error.toString()); + + try { + debugPrintStack(stackTrace: stackTrace); + } catch (e) { + // coverage:ignore-start + // Sometimes debugPrintStack can't print custom stack traces + debugPrint(stackTrace.toString()); + // coverage:ignore-end + } + } + + final tLevel = (error is PatapataException) + ? (error.logLevel != null && error.logLevel! > Level.SEVERE) + ? error.logLevel! + : Level.SEVERE + : Level.SEVERE; + log.report( + ReportRecord( + level: tLevel, + error: error, + stackTrace: stackTrace, + fingerprint: + (error is PatapataException) ? error.fingerprint : null, + mechanism: Log.kUnhandledErrorMechanism, + ), + ); + }, + zoneValues: { + #patapataApp: this, + }, + ); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // It is possible that AppStage initialization failed or + // runZonedGuarded itself failed to execute. + if (onInitFailure != null) { + await onInitFailure!(environment, e, stackTrace); + } else { + // ignore: avoid_print + print(e); + // ignore: avoid_print + print(stackTrace); + } + tCompleter.complete(false); + // coverage:ignore-end + } + + return tCompleter.future; + } + + /// Should be called when you want to get rid of this [App] + /// and all resources associated with it, including static callbacks. + /// Not usually needed in a real app, but used mostly in test tearDown. + void dispose() { + _stage = AppStage.disposed; + + _forceRemoveNativeSplashScreenTimer?.cancel(); + _forceRemoveNativeSplashScreenTimer = null; + + if (_originalErrorWidgetBuilder != null) { + // coverage:ignore-start + ErrorWidget.builder = _originalErrorWidgetBuilder!; + _originalErrorWidgetBuilder = null; + // coverage:ignore-end + } + + try { + user.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the user. + _logger.fine('Failed to dispose user', e, stackTrace); + // coverage:ignore-end + } + _user = null; + + // Remove all plugins. + final tPlugins = _plugins.toList(growable: false); + for (var i in tPlugins) { + try { + removePlugin(i); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Just try to remove the next one. + _logger.fine('Failed to remove plugin $i', e, stackTrace); + // coverage:ignore-end + } + } + + try { + remoteConfig.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the remoteConfig. + _logger.fine('Failed to dispose remoteConfig', e, stackTrace); + // coverage:ignore-end + } + + try { + localConfig.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the localConfig. + _logger.fine('Failed to dispose localConfig', e, stackTrace); + // coverage:ignore-end + } + + try { + remoteMessaging.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the remoteMessaging. + _logger.fine('Failed to dispose remoteMessaging', e, stackTrace); + // coverage:ignore-end + } + + try { + permissions.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the permissions. + _logger.fine('Failed to dispose permissions', e, stackTrace); + // coverage:ignore-end + } + + try { + log.dispose(); + } catch (e, stackTrace) { + // coverage:ignore-start + // We don't care at this point. + // Some other libraries may have already disposed of the log. + _logger.fine('Failed to dispose log', e, stackTrace); + // coverage:ignore-end + } + } +} diff --git a/packages/patapata_core/lib/src/config.dart b/packages/patapata_core/lib/src/config.dart new file mode 100644 index 0000000..11ce520 --- /dev/null +++ b/packages/patapata_core/lib/src/config.dart @@ -0,0 +1,140 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core.dart'; + +/// A base class that manages the application's Config and +/// provides the functionality to notify changes. +/// +/// When the value of Config is changed, +/// please call [onChange] on the implementation side. +/// +/// See also: +/// +/// [RemoteConfig], [LocalConfig] +abstract class Config extends ChangeNotifier with MethodChannelTestMixin { + /// Default value for configuration items of type String. + /// If a configuration item of type String is not set, this value will be used. + static const defaultValueForString = ''; + + /// Default value for configuration items of type Boolean. + /// If a configuration item of type Boolean is not set, this value will be used. + static const defaultValueForBool = false; + + /// Default value for configuration items of type Integer. + /// If a configuration item of type Integer is not set, this value will be used. + static const defaultValueForInt = 0; + + /// Default value for configuration items of type Double. + /// If a configuration item of type Double is not set, this value will be used. + static const defaultValueForDouble = 0.0; + + bool _initialized = false; + + /// Indicates whether the configuration has been initialized. + bool get initialized => _initialized; + + bool _disposed = false; + + /// Indicates whether the configuration has been disposed. + bool get disposed => _disposed; + + /// Initializes the configuration. + /// + /// If the application is in test mode, it sets the mock method call handler. + /// After initialization, the configuration is marked as initialized and not disposed. + @mustCallSuper + Future init() async { + if (kIsTest) { + setMockMethodCallHandler(); + } + + _initialized = true; + _disposed = false; + } + + /// Disposes the configuration. + /// + /// After disposal, the configuration is marked as not initialized and disposed. + @override + @mustCallSuper + void dispose() { + super.dispose(); + _initialized = false; + _disposed = true; + } + + /// The value of Config has been changed. + @protected + void onChange() { + notifyListeners(); + } +} + +/// Provides an interface to read values from [Config]. +mixin ReadableConfig on Config { + /// Checks if the given [key] exists in the configuration. + bool hasKey(String key); + + /// Returns the value corresponding to the given [key] as a String. + String getString( + String key, { + String defaultValue = Config.defaultValueForString, + }); + + /// Returns the value corresponding to the given [key] as a Boolean. + bool getBool( + String key, { + bool defaultValue = Config.defaultValueForBool, + }); + + /// Returns the value corresponding to the given [key] as an Integer. + int getInt( + String key, { + int defaultValue = Config.defaultValueForInt, + }); + + /// Returns the value corresponding to the given [key] as a Double. + double getDouble( + String key, { + double defaultValue = Config.defaultValueForDouble, + }); + + /// Sets the default values for the configuration. + /// + /// The [defaults] parameter is a map containing the default key-value pairs. + /// These values are used when no other values are specified for the corresponding keys. + Future setDefaults(Map defaults); +} + +/// Provides an interface to write values to [Config]. +mixin WritableConfig on Config { + /// Sets the value of the given [key] to the specified String [value]. + Future setString(String key, String value); + + /// Sets the value of the given [key] to the specified Boolean [value]. + Future setBool(String key, bool value); + + /// Sets the value of the given [key] to the specified Integer [value]. + Future setInt(String key, int value); + + /// Sets the value of the given [key] to the specified Double [value]. + Future setDouble(String key, double value); + + /// Sets the values of multiple keys at once. + /// + /// The [objects] parameter is a map where each key-value pair represents a configuration item. + Future setMany(Map objects); + + /// Resets all configuration items to their default values. + Future resetAll(); + + /// Resets the configuration item corresponding to the given [key] to its default value. + Future reset(String key); + + /// Resets the configuration items corresponding to the given list of [keys] to their default values. + Future resetMany(List keys); +} diff --git a/packages/patapata_core/lib/src/device_info.dart b/packages/patapata_core/lib/src/device_info.dart new file mode 100644 index 0000000..25f6d11 --- /dev/null +++ b/packages/patapata_core/lib/src/device_info.dart @@ -0,0 +1,598 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +// ignore: depend_on_referenced_packages +import 'package:device_info_plus_platform_interface/device_info_plus_platform_interface.dart'; +import 'package:device_info_plus/device_info_plus.dart' as plugin; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter/widgets.dart'; +import 'package:provider/provider.dart'; + +import 'plugin.dart'; +import 'app.dart'; +import 'util.dart'; + +/// Plugin that manages information related to the platform's device. +/// +/// This plugin retrieves information from [DeviceInfoPlatform] during initialization, +/// allowing synchronous access from the application or other plugins. +/// +/// This plugin is automatically created during application initialization +/// and can be accessed from [App.package]. +class DeviceInfoPlugin extends Plugin { + final plugin.DeviceInfoPlugin _deviceInfoPlugin = plugin.DeviceInfoPlugin(); + + plugin.AndroidDeviceInfo? _androidDeviceInfo; + + /// device information for Android. + plugin.AndroidDeviceInfo? get androidDeviceInfo => _androidDeviceInfo; + + plugin.IosDeviceInfo? _iosDeviceInfo; + + /// device information for iOS. + plugin.IosDeviceInfo? get iosDeviceInfo => _iosDeviceInfo; + + plugin.LinuxDeviceInfo? _linuxInfo; + + /// device information for Linux. + plugin.LinuxDeviceInfo? get linuxInfo => _linuxInfo; + + plugin.MacOsDeviceInfo? _macOsInfo; + + /// device information for macOS. + plugin.MacOsDeviceInfo? get macOsInfo => _macOsInfo; + + plugin.WindowsDeviceInfo? _windowsInfo; + + /// device information for Windows. + plugin.WindowsDeviceInfo? get windowsInfo => _windowsInfo; + + plugin.WebBrowserInfo? _webInfo; + + /// device information for WebBrowser. + plugin.WebBrowserInfo? get webInfo => _webInfo; + + @override + FutureOr init(App app) async { + await super.init(app); + + if (debugIsWeb || kIsWeb) { + _webInfo = await _deviceInfoPlugin.webBrowserInfo; + } else { + switch (defaultTargetPlatform) { + case TargetPlatform.android: + _androidDeviceInfo = await _deviceInfoPlugin.androidInfo; + break; + case TargetPlatform.iOS: + _iosDeviceInfo = await _deviceInfoPlugin.iosInfo; + break; + case TargetPlatform.linux: + _linuxInfo = await _deviceInfoPlugin.linuxInfo; + break; + case TargetPlatform.macOS: + _macOsInfo = await _deviceInfoPlugin.macOsInfo; + break; + case TargetPlatform.windows: + _windowsInfo = await _deviceInfoPlugin.windowsInfo; + break; + default: + break; + } + } + + return true; + } + + @override + Widget createAppWidgetWrapper(Widget child) { + return Provider.value( + value: this, + child: child, + ); + } + + /// If your test environment is [TargetPlatform.linux], [TargetPlatform.windows], Web, + /// then it assumes that you want to override and specify [DeviceInfoPlatform.instance], + /// so I'm not considering entering a branch. + /// + /// The functions used to overwrite [DeviceInfoPlatform] in each environment are: + /// [TargetPlatform.linux] ... [DeviceInfoLinuxPlatform.registerWith] + /// [TargetPlatform.windows] ... [DeviceInfoWindowsPlatform.registerWith] + /// Web ... [DeviceInfoWebPlatform.registerWith] + /// Check the lib/test/device_info_test.dart for usage examples. + @override + @visibleForTesting + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + const MethodChannel('dev.fluttercommunity.plus/device_info'), + (methodCall) async { + methodCallLogs.add(methodCall); + switch (methodCall.method) { + case 'getDeviceInfo': + switch (defaultTargetPlatform) { + case TargetPlatform.android: + return mockAndroidDeviceInfoMap; + case TargetPlatform.iOS: + return mockIosDeviceInfoMap; + case TargetPlatform.macOS: + return mockMacosDeviceInfoMap; + default: + break; + } + } + return null; + }, + ); + } + + // Declared in the same order as the source code + // of [AndroidDeviceInfo.fromMap] to make it easier to compare. + static const Map _defaultMockAndroidDeviceInfoMap = + { + 'version': { + 'sdkInt': 16, + 'baseOS': 'baseOS', + 'previewSdkInt': 30, + 'release': 'release', + 'codename': 'codename', + 'incremental': 'incremental', + 'securityPatch': 'securityPatch', + }, + 'board': 'board', + 'bootloader': 'bootloader', + 'brand': 'Google', + 'device': 'device', + 'display': 'display', + 'fingerprint': 'fingerprint', + 'hardware': 'hardware', + 'host': 'host', + 'id': 'id', + 'manufacturer': 'manufacturer', + 'model': 'model', + 'product': 'product', + 'supported32BitAbis': ['x86 (IA-32)', 'MMX'], + 'supported64BitAbis': ['x86-64', 'MMX', 'SSSE3'], + 'supportedAbis': ['arm64-v8a', 'x86', 'x86_64'], + 'tags': 'tags', + 'type': 'type', + 'isPhysicalDevice': true, + 'systemFeatures': ['FEATURE_AUDIO_PRO', 'FEATURE_AUDIO_OUTPUT'], + 'displayMetrics': { + 'widthPx': 1080.0, + 'heightPx': 2220.0, + 'xDpi': 530.0859, + 'yDpi': 529.4639, + }, + 'serialNumber': 'serialNumber', + }; + + @visibleForTesting + static Map mockAndroidDeviceInfoMap = + _defaultMockAndroidDeviceInfoMap; + + /// Mocks [AndroidDeviceInfo] for testing purposes. + @visibleForTesting + static void setMockAndroidDeviceInfo({ + String? id, + String? host, + String? tags, + String? type, + String? model, + String? board, + String? brand, + String? device, + String? product, + String? display, + String? hardware, + bool? isPhysicalDevice, + String? bootloader, + String? fingerprint, + String? manufacturer, + List? supportedAbis, + List? systemFeatures, + Map? version, + List? supported64BitAbis, + List? supported32BitAbis, + Map? displayMetrics, + String? serialNumber, + }) { + mockAndroidDeviceInfoMap = { + 'id': id ?? _defaultMockAndroidDeviceInfoMap['id'], + 'host': host ?? _defaultMockAndroidDeviceInfoMap['host'], + 'tags': tags ?? _defaultMockAndroidDeviceInfoMap['tags'], + 'type': type ?? _defaultMockAndroidDeviceInfoMap['type'], + 'model': model ?? _defaultMockAndroidDeviceInfoMap['model'], + 'board': board ?? _defaultMockAndroidDeviceInfoMap['board'], + 'brand': brand ?? _defaultMockAndroidDeviceInfoMap['brand'], + 'device': device ?? _defaultMockAndroidDeviceInfoMap['device'], + 'product': product ?? _defaultMockAndroidDeviceInfoMap['product'], + 'display': display ?? _defaultMockAndroidDeviceInfoMap['display'], + 'hardware': hardware ?? _defaultMockAndroidDeviceInfoMap['hardware'], + 'isPhysicalDevice': isPhysicalDevice ?? + _defaultMockAndroidDeviceInfoMap['isPhysicalDevice'], + 'bootloader': + bootloader ?? _defaultMockAndroidDeviceInfoMap['bootloader'], + 'fingerprint': + fingerprint ?? _defaultMockAndroidDeviceInfoMap['fingerprint'], + 'manufacturer': + manufacturer ?? _defaultMockAndroidDeviceInfoMap['manufacturer'], + 'supportedAbis': + supportedAbis ?? _defaultMockAndroidDeviceInfoMap['supportedAbis'], + 'systemFeatures': + systemFeatures ?? _defaultMockAndroidDeviceInfoMap['systemFeatures'], + 'version': version ?? _defaultMockAndroidDeviceInfoMap['version'], + 'supported64BitAbis': supported64BitAbis ?? + _defaultMockAndroidDeviceInfoMap['supported64BitAbis'], + 'supported32BitAbis': supported32BitAbis ?? + _defaultMockAndroidDeviceInfoMap['supported32BitAbis'], + 'displayMetrics': + displayMetrics ?? _defaultMockAndroidDeviceInfoMap['displayMetrics'], + 'serialNumber': + serialNumber ?? _defaultMockAndroidDeviceInfoMap['serialNumber'], + }; + } + + @visibleForTesting + static Map mockIosDeviceInfoMap = { + 'name': 'name', + 'model': 'model', + 'utsname': { + 'release': 'release', + 'version': 'version', + 'machine': 'machine', + 'sysname': 'sysname', + 'nodename': 'nodename', + }, + 'systemName': 'systemName', + 'systemVersion': 'systemVersion', + 'isPhysicalDevice': 'true', + 'localizedModel': 'localizedModel', + 'identifierForVendor': 'identifierForVendor', + }; + + /// Mocks [IosDeviceInfo] for testing purposes. + @visibleForTesting + static void setMockIosDeviceInfo({ + String? name, + String? model, + Map? utsname, + String? systemName, + String? systemVersion, + bool? isPhysicalDevice, + String? localizedModel, + String? identifierForVendor, + }) { + mockIosDeviceInfoMap = { + 'name': name ?? mockIosDeviceInfoMap['name'], + 'model': model ?? mockIosDeviceInfoMap['model'], + 'utsname': utsname ?? mockIosDeviceInfoMap['utsname'], + 'systemName': systemName ?? mockIosDeviceInfoMap['systemName'], + 'systemVersion': systemVersion ?? mockIosDeviceInfoMap['systemVersion'], + 'isPhysicalDevice': isPhysicalDevice?.toString() ?? + mockIosDeviceInfoMap['isPhysicalDevice'], + 'localizedModel': + localizedModel ?? mockIosDeviceInfoMap['localizedModel'], + 'identifierForVendor': + identifierForVendor ?? mockIosDeviceInfoMap['identifierForVendor'], + }; + } + + @visibleForTesting + static plugin.LinuxDeviceInfo mockLinuxDeviceInfo = plugin.LinuxDeviceInfo( + name: 'name', + version: 'version', + id: 'id', + idLike: ['idLike'], + versionCodename: 'versionCodename', + versionId: 'versionId', + prettyName: 'prettyName', + buildId: 'buildId', + variant: 'variant', + variantId: 'variantId', + machineId: 'machineId', + ); + + /// Mocks [LinuxDeviceInfo] for testing purposes. + @visibleForTesting + static void setMockLinuxDeviceInfo({ + String? name, + String? version, + String? id, + List? idLike, + String? versionCodename, + String? versionId, + String? prettyName, + String? buildId, + String? variant, + String? variantId, + String? machineId, + }) { + mockLinuxDeviceInfo = plugin.LinuxDeviceInfo( + name: name ?? mockLinuxDeviceInfo.name, + version: version ?? mockLinuxDeviceInfo.version, + id: id ?? mockLinuxDeviceInfo.id, + idLike: idLike ?? mockLinuxDeviceInfo.idLike, + versionCodename: versionCodename ?? mockLinuxDeviceInfo.versionCodename, + versionId: versionId ?? mockLinuxDeviceInfo.versionId, + prettyName: prettyName ?? mockLinuxDeviceInfo.prettyName, + buildId: buildId ?? mockLinuxDeviceInfo.buildId, + variant: variant ?? mockLinuxDeviceInfo.variant, + variantId: variantId ?? mockLinuxDeviceInfo.variantId, + machineId: machineId ?? mockLinuxDeviceInfo.machineId, + ); + } + + @visibleForTesting + static Map mockMacosDeviceInfoMap = { + 'computerName': 'computerName', + 'hostName': 'hostName', + 'arch': 'arch', + 'model': 'model', + 'kernelVersion': 'kernelVersion', + 'osRelease': 'osRelease', + 'majorVersion': 10, + 'minorVersion': 9, + 'patchVersion': 3, + 'activeCPUs': 4, + 'memorySize': 16, + 'cpuFrequency': 2, + 'systemGUID': 'systemGUID', + }; + + /// Mocks [MacOsDeviceInfo] for testing purposes. + @visibleForTesting + static void setMockMacosDeviceInfo({ + String? arch, + String? model, + int? activeCPUs, + int? memorySize, + int? cpuFrequency, + String? hostName, + String? osRelease, + String? computerName, + String? kernelVersion, + String? systemGUID, + int? majorVersion, + int? minorVersion, + int? patchVersion, + }) { + mockMacosDeviceInfoMap = { + 'arch': arch ?? mockMacosDeviceInfoMap['arch'], + 'model': model ?? mockMacosDeviceInfoMap['model'], + 'activeCPUs': activeCPUs ?? mockMacosDeviceInfoMap['activeCPUs'], + 'memorySize': memorySize ?? mockMacosDeviceInfoMap['memorySize'], + 'cpuFrequency': cpuFrequency ?? mockMacosDeviceInfoMap['cpuFrequency'], + 'hostName': hostName ?? mockMacosDeviceInfoMap['hostName'], + 'osRelease': osRelease ?? mockMacosDeviceInfoMap['osRelease'], + 'computerName': computerName ?? mockMacosDeviceInfoMap['computerName'], + 'kernelVersion': kernelVersion ?? mockMacosDeviceInfoMap['kernelVersion'], + 'systemGUID': systemGUID ?? mockMacosDeviceInfoMap['systemGUID'], + 'majorVersion': majorVersion ?? mockMacosDeviceInfoMap['majorVersion'], + 'minorVersion': minorVersion ?? mockMacosDeviceInfoMap['minorVersion'], + 'patchVersion': patchVersion ?? mockMacosDeviceInfoMap['patchVersion'], + }; + } + + @visibleForTesting + static plugin.WindowsDeviceInfo mockWindowsDeviceInfo = + plugin.WindowsDeviceInfo( + computerName: 'computerName', + numberOfCores: 4, + systemMemoryInMegabytes: 16, + userName: 'userName', + majorVersion: 10, + minorVersion: 0, + buildNumber: 10240, + platformId: 1, + csdVersion: 'csdVersion', + servicePackMajor: 1, + servicePackMinor: 0, + suitMask: 1, + productType: 1, + reserved: 1, + buildLab: '22000.co_release.210604-1628', + buildLabEx: '22000.1.amd64fre.co_release.210604-1628', + digitalProductId: Uint8List.fromList([]), + displayVersion: '21H2', + editionId: 'Pro', + installDate: DateTime(2022, 04, 02), + productId: '00000-00000-0000-AAAAA', + productName: 'Windows 10 Pro', + registeredOwner: 'registeredOwner', + releaseId: 'releaseId', + deviceId: 'deviceId', + ); + + /// Mocks [WindowsDeviceInfo] for testing purposes. + @visibleForTesting + static void setMockWindowsDeviceInfo({ + String? computerName, + int? numberOfCores, + int? systemMemoryInMegabytes, + String? userName, + int? majorVersion, + int? minorVersion, + int? buildNumber, + int? platformId, + String? csdVersion, + int? servicePackMajor, + int? servicePackMinor, + int? suitMask, + int? productType, + int? reserved, + String? buildLab, + String? buildLabEx, + Uint8List? digitalProductId, + String? displayVersion, + String? editionId, + DateTime? installDate, + String? productId, + String? productName, + String? registeredOwner, + String? releaseId, + String? deviceId, + }) { + mockWindowsDeviceInfo = plugin.WindowsDeviceInfo( + computerName: computerName ?? mockWindowsDeviceInfo.computerName, + numberOfCores: numberOfCores ?? mockWindowsDeviceInfo.numberOfCores, + systemMemoryInMegabytes: systemMemoryInMegabytes ?? + mockWindowsDeviceInfo.systemMemoryInMegabytes, + userName: userName ?? mockWindowsDeviceInfo.userName, + majorVersion: majorVersion ?? mockWindowsDeviceInfo.majorVersion, + minorVersion: minorVersion ?? mockWindowsDeviceInfo.minorVersion, + buildNumber: buildNumber ?? mockWindowsDeviceInfo.buildNumber, + platformId: platformId ?? mockWindowsDeviceInfo.platformId, + csdVersion: csdVersion ?? mockWindowsDeviceInfo.csdVersion, + servicePackMajor: + servicePackMajor ?? mockWindowsDeviceInfo.servicePackMajor, + servicePackMinor: + servicePackMinor ?? mockWindowsDeviceInfo.servicePackMinor, + suitMask: suitMask ?? mockWindowsDeviceInfo.suitMask, + productType: productType ?? mockWindowsDeviceInfo.productType, + reserved: reserved ?? mockWindowsDeviceInfo.reserved, + buildLab: buildLab ?? mockWindowsDeviceInfo.buildLab, + buildLabEx: buildLabEx ?? mockWindowsDeviceInfo.buildLabEx, + digitalProductId: + digitalProductId ?? mockWindowsDeviceInfo.digitalProductId, + displayVersion: displayVersion ?? mockWindowsDeviceInfo.displayVersion, + editionId: editionId ?? mockWindowsDeviceInfo.editionId, + installDate: installDate ?? mockWindowsDeviceInfo.installDate, + productId: productId ?? mockWindowsDeviceInfo.productId, + productName: productName ?? mockWindowsDeviceInfo.productName, + registeredOwner: registeredOwner ?? mockWindowsDeviceInfo.registeredOwner, + releaseId: releaseId ?? mockWindowsDeviceInfo.releaseId, + deviceId: deviceId ?? mockWindowsDeviceInfo.deviceId, + ); + } + + @visibleForTesting + static Map mockWebBrowserInfoMap = { + 'browserName': plugin.BrowserName.safari, + 'appCodeName': 'appCodeName', + 'appName': 'appName', + 'appVersion': 'appVersion', + 'deviceMemory': 42, + 'language': 'language', + 'languages': ['en', 'es'], + 'platform': 'platform', + 'product': 'product', + 'productSub': 'productSub', + 'userAgent': 'Safari', + 'vendor': 'vendor', + 'vendorSub': 'vendorSub', + 'hardwareConcurrency': 2, + 'maxTouchPoints': 42, + }; + + /// Mocks [WebBrowserInfo] for testing purposes. + @visibleForTesting + static void setMockWebBrowserInfo({ + String? browserName, + String? appCodeName, + String? appName, + String? appVersion, + int? deviceMemory, + String? language, + List? languages, + String? platform, + String? product, + String? productSub, + String? userAgent, + String? vendor, + String? vendorSub, + int? hardwareConcurrency, + int? maxTouchPoints, + }) { + mockWebBrowserInfoMap = { + 'browserName': + browserName?.toBrowserName ?? mockWebBrowserInfoMap['browserName'], + 'appCodeName': appCodeName ?? mockWebBrowserInfoMap['appCodeName'], + 'appName': appName ?? mockWebBrowserInfoMap['appName'], + 'appVersion': appVersion ?? mockWebBrowserInfoMap['appVersion'], + 'deviceMemory': deviceMemory ?? mockWebBrowserInfoMap['deviceMemory'], + 'language': language ?? mockWebBrowserInfoMap['language'], + 'languages': languages ?? mockWebBrowserInfoMap['languages'], + 'platform': platform ?? mockWebBrowserInfoMap['platform'], + 'product': product ?? mockWebBrowserInfoMap['product'], + 'productSub': productSub ?? mockWebBrowserInfoMap['productSub'], + 'userAgent': userAgent ?? mockWebBrowserInfoMap['userAgent'], + 'vendor': vendor ?? mockWebBrowserInfoMap['vendor'], + 'vendorSub': vendorSub ?? mockWebBrowserInfoMap['vendorSub'], + 'hardwareConcurrency': + hardwareConcurrency ?? mockWebBrowserInfoMap['hardwareConcurrency'], + 'maxTouchPoints': + maxTouchPoints ?? mockWebBrowserInfoMap['maxTouchPoints'], + }; + } +} + +@visibleForTesting +bool debugIsWeb = false; + +extension DeviceInfoStringExtension on String { + plugin.BrowserName get toBrowserName { + switch (toLowerCase()) { + case 'firefox': + return plugin.BrowserName.firefox; + case 'samsunginternet': + return plugin.BrowserName.samsungInternet; + case 'opera': + return plugin.BrowserName.opera; + case 'msie': + return plugin.BrowserName.msie; + case 'edge': + return plugin.BrowserName.edge; + case 'chrome': + return plugin.BrowserName.chrome; + case 'safari': + return plugin.BrowserName.safari; + default: + return plugin.BrowserName.unknown; + } + } +} + +@visibleForTesting +class DeviceInfoLinuxPlatform extends DeviceInfoPlatform { + static void registerWith() { + DeviceInfoPlatform.instance = DeviceInfoLinuxPlatform(); + } + + @override + Future deviceInfo() async { + return DeviceInfoPlugin.mockLinuxDeviceInfo; + } +} + +@visibleForTesting +class DeviceInfoWindowsPlatform extends DeviceInfoPlatform { + static void registerWith() { + DeviceInfoPlatform.instance = DeviceInfoWindowsPlatform(); + } + + @override + Future deviceInfo() async { + return DeviceInfoPlugin.mockWindowsDeviceInfo; + } +} + +@visibleForTesting +class DeviceInfoWebPlatform extends DeviceInfoPlatform { + static void registerWith() { + DeviceInfoPlatform.instance = DeviceInfoWebPlatform(); + } + + @override + Future deviceInfo() async { + return plugin.WebBrowserInfo.fromMap( + DeviceInfoPlugin.mockWebBrowserInfoMap, + ); + } +} diff --git a/packages/patapata_core/lib/src/error.dart b/packages/patapata_core/lib/src/error.dart new file mode 100644 index 0000000..256c7d3 --- /dev/null +++ b/packages/patapata_core/lib/src/error.dart @@ -0,0 +1,296 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/widgets.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +/// Settings for [PatapataException] +mixin ErrorEnvironment { + /// Overrides the value of [PatapataException.prefix] by [PatapataException.namespace]. + /// + /// example: + /// When the [PatapataException.namespace] is defined as `patapata`, + /// This would override the value of [PatapataException.prefix] to `APE`. + /// ```dart + /// { + /// 'patapata': 'APE' + /// } + /// ``` + Map? get errorReplacePrefixMap; + + /// Defines the default [PatapataException.widget]. + Widget Function(PatapataException)? get errorDefaultWidget; + + /// Defines the default behavior of [PatapataException.showDialog]. + Future Function(BuildContext, PatapataException)? + get errorDefaultShowDialog; +} + +/// Defines exceptions that occur in applications using patapata. +abstract class PatapataException { + final App? __app; + App? get _app => __app ?? (Zone.current[#patapataApp] as App?); + + /// Error message. + /// This message is for logging and debugging purposes and is not meant to be displayed to the user. + final String? message; + + /// Original error. + final Object? original; + + /// Used to group and deduplicate events with the same fingerprint in the [Log] system. + final List? fingerprint; + + /// Parameters passed in the localization of [localizedTitle]. + /// [prefix] is passed by default. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// + /// dart + /// ```dart + /// { + /// 'body': 'Title', + /// } + /// ``` + /// yaml + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// title: {body}: {prefix}000 + /// ``` + final Map? localeTitleData; + + /// Parameters passed in the localization of [localizedMessage]. + /// [prefix] is passed by default. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// + /// dart + /// ```dart + /// { + /// 'body': 'Message', + /// } + /// ``` + /// yaml + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// message: {body}: {prefix}000 + /// ``` + final Map? localeMessageData; + + /// Parameters passed in the localization of [localizedFix]. + /// [prefix] is passed by default. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// + /// dart + /// ```dart + /// { + /// 'body': 'Fix', + /// } + /// ``` + /// yaml + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// fix: {body}: {prefix}000 + /// ``` + final Map? localeFixData; + + const PatapataException({ + App? app, + this.message, + this.original, + this.fingerprint, + this.localeTitleData, + this.localeMessageData, + this.localeFixData, + this.fix, + this.logLevel, + Level? userLogLevel, + }) : __app = app, + _userLogLevel = userLogLevel; + + /// Prefix for [code] + /// Can be set by [ErrorEnvironment.errorReplacePrefixMap] with [namespace]. + /// If not set, then [defaultPrefix]. + /// + /// Used as a localization key when being localized like in [localizedMessage]. + String get prefix => + _environment?.errorReplacePrefixMap?[namespace] ?? defaultPrefix; + + /// Error code. + /// Usually a string of [prefix] and [internalCode]. + String get code => '$prefix$internalCode'; + + /// Default [prefix] when not set in [ErrorEnvironment.errorReplacePrefixMap]. + @protected + String get defaultPrefix; + + /// Internal error code. + /// Used as a localization key when being localized like in [localizedMessage]. + @protected + String get internalCode; + + /// Defines the namespace of the error. + /// Used in localization keys like in [localizedMessage] and settings in [ErrorEnvironment]. + String get namespace; + + /// You can define a process to recover from the error. + final Future Function()? fix; + + /// true if [fix] is defined. + bool get hasFix => fix != null; + + /// Displays the error title localized by the [L10n] system. + /// + /// The localization key will be `'errors.$namespace.$internalCode.title'`. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// title: ErrorTitle + /// ``` + String get localizedTitle => hasLocalizedTitle + ? _l10n!.lookup( + _localizeTitleKey, + namedParameters: { + 'prefix': prefix, + ...(localeTitleData ?? {}), + }, + ) + : _defaultTitleLocalize; + + /// Displays the error message localized by the [L10n] system. + /// + /// The localization key will be `'errors.$namespace.$internalCode.message'`. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// message: ErrorMessage + /// ``` + String get localizedMessage => hasLocalizedMessage + ? _l10n!.lookup( + _localizeMessageKey, + namedParameters: { + 'prefix': prefix, + ...(localeMessageData ?? {}), + }, + ) + : _defaultMessageLocalize; + + /// Displays the error treatment message localized by the [L10n] system. + /// + /// The localization key will be `'errors.$namespace.$internalCode.fix'`. + /// + /// example: [namespace] is `patapata` and [internalCode] is `000`, then + /// ```yaml + /// errors: + /// patapata: + /// '000': + /// fix: ErrorFix + /// ``` + String get localizedFix => hasLocalizedFix + ? _l10n!.lookup( + _localizeFixKey, + namedParameters: { + 'prefix': prefix, + ...(localeFixData ?? {}), + }, + ) + : _defaultFixLocalize; + + /// true if the localization key for [localizedTitle] is defined. + bool get hasLocalizedTitle => + _l10n?.containsMessageKey(_localizeTitleKey) ?? false; + + /// true if the localization key for [localizedMessage] is defined. + bool get hasLocalizedMessage => + _l10n?.containsMessageKey(_localizeMessageKey) ?? false; + + /// true if the localization key for [localizedFix] is defined. + bool get hasLocalizedFix => + _l10n?.containsMessageKey(_localizeFixKey) ?? false; + + /// Returns ErrorWidget. + /// + /// Return the widget set in [ErrorEnvironment.errorDefaultWidget]. + /// If not set, it returns [Text] displaying [localizedMessage]. + Widget get widget => + _environment?.errorDefaultWidget?.call(this) ?? Text(localizedMessage); + + /// Notification [Level] to the [Log] system. + final Level? logLevel; + + /// Importance from the user's perspective. + /// + /// Even if [logLevel] is [Level.INFO], if it's a significant error that warrants displaying an error page, + /// setting this to [Level.SHOUT] will navigate to the error page during [onReported]. + /// Note that this value is not relayed to the [Log] system, and instead, the value of [logLevel] is reported. + Level? get userLogLevel => _userLogLevel ?? logLevel; + + final Level? _userLogLevel; + + /// Displays a dialog. + /// + /// By default, it calls [PlatformDialog.show] displaying [localizedTitle] and [localizedMessage]. + /// This can be customized by [ErrorEnvironment.errorDefaultShowDialog]. + Future showDialog(BuildContext context) => + _environment?.errorDefaultShowDialog?.call(context, this) ?? + PlatformDialog.show( + context: context, + title: localizedTitle, + message: localizedMessage, + actions: [ + PlatformDialogAction( + result: () => true, + text: 'OK', + ), + ], + ); + + /// Called when this exception is reported by the [Log] system. + /// + /// If using the [StandardAppPlugin] system and [userLogLevel] == [Level.SHOUT], + /// it navigates to the page defined in [StandardErrorPageFactory]. + void onReported(ReportRecord record) { + if (userLogLevel == Level.SHOUT) { + _app?.getPlugin()?.delegate?.goErrorPage(record); + } + } + + String get _localizeTitleKey => 'errors.$namespace.$internalCode.title'; + String get _localizeMessageKey => 'errors.$namespace.$internalCode.message'; + String get _localizeFixKey => 'errors.$namespace.$internalCode.fix'; + + String get _defaultTitleLocalize => 'Error: $code'; + String get _defaultMessageLocalize => '$runtimeType: code=$code'; + String get _defaultFixLocalize => 'OK'; + + L10n? get _l10n => _app?.getPlugin()?.i18n.delegate.l10n; + + /// The current environment. + /// If the current environment is of type [ErrorEnvironment], it is returned, otherwise null is returned. + ErrorEnvironment? get _environment => _app?.environment is ErrorEnvironment + ? _app!.environment as ErrorEnvironment + : null; + + @override + String toString() { + return '$runtimeType: code=$code, message=$message${original != null ? ', original=$original' : ''}'; + } +} diff --git a/packages/patapata_core/lib/src/exception.dart b/packages/patapata_core/lib/src/exception.dart new file mode 100644 index 0000000..f008bd0 --- /dev/null +++ b/packages/patapata_core/lib/src/exception.dart @@ -0,0 +1,83 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// ignore_for_file: constant_identifier_names + +import 'package:patapata_core/patapata_core.dart'; + +/// Error codes for [PatapataCoreException]. +enum PatapataCoreExceptionCode { + /// [LogicStateTransitionNotFound] + PPE101, + + /// [LogicStateTransitionNotAllowed] + PPE102, + + /// [LogicStateAllTransitionsNotAllowed] + PPE103, + + /// [LogicStateNotCurrent] + PPE104, + + /// [ConflictException] + PPE201, + + /// [ResetStartupSequence] + PPE301, + + /// [L10nLoadAssetsException] + PPE401, + + /// [NotificationsInitializationException] + PPE501, +} + +/// Extension to split [PatapataCoreExceptionCode] into +/// [PatapataCoreException.prefix] and [PatapataCoreException.internalCode]. +extension PatapataCoreExceptionCodeExtension on PatapataCoreExceptionCode { + /// Prefix of the error code. + String get prefix => name.substring(0, 3); + + /// Internal code of the error code. + String get internalCode => name.substring(3); +} + +/// `patapata_core` package exception. +/// +/// This exception is thrown when an error occurs in the `patapata_core` package. +/// The error code is defined in [PatapataCoreExceptionCode]. +/// +/// [defaultPrefix] is `PPE`. ([PatapataCoreExceptionCodeExtension.prefix]) +/// [namespace] is `patapata` +/// +/// The value of [prefix] can be overridden by defining +/// [ErrorEnvironment.errorReplacePrefixMap] on the application side. +/// If it is not defined, the value of [defaultPrefix] will be used. +abstract class PatapataCoreException extends PatapataException { + final PatapataCoreExceptionCode _exceptionCode; + + const PatapataCoreException({ + required PatapataCoreExceptionCode code, + super.app, + super.message, + super.original, + super.fingerprint, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + super.fix, + super.logLevel, + super.userLogLevel, + }) : _exceptionCode = code; + + @override + String get defaultPrefix => _exceptionCode.prefix; + + @override + String get internalCode => _exceptionCode.internalCode; + + @override + String get namespace => 'patapata'; +} diff --git a/packages/patapata_core/lib/src/fake_ffi.dart b/packages/patapata_core/lib/src/fake_ffi.dart new file mode 100644 index 0000000..eec5ce7 --- /dev/null +++ b/packages/patapata_core/lib/src/fake_ffi.dart @@ -0,0 +1,13 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +/// This file is for the sole purpose of providing an empty ffi shell for +/// the web. Just to compile things. Not execute. + +class Pointer {} + +class Struct {} + +class Union {} diff --git a/packages/patapata_core/lib/src/i18n.dart b/packages/patapata_core/lib/src/i18n.dart new file mode 100644 index 0000000..8f513f6 --- /dev/null +++ b/packages/patapata_core/lib/src/i18n.dart @@ -0,0 +1,410 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'package:flutter/scheduler.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter/widgets.dart'; +import 'package:flutter_localizations/flutter_localizations.dart'; +import 'package:intl/intl.dart'; +import 'package:intl/message_format.dart'; +import 'package:logging/logging.dart'; +import 'package:patapata_core/src/exception.dart'; +import 'package:patapata_core/src/util.dart'; +import 'package:timezone/data/latest.dart' as tz; +import 'package:yaml/yaml.dart'; + +import 'app.dart'; +import 'plugin.dart'; + +final _logger = Logger('patapata.I18n'); + +bool _reassembling = false; + +/// Language settings of the application. Used in [I18nPlugin]. +mixin I18nEnvironment { + /// List of [Locale] supported by the application (default is `Locale('en')`) + List? get supportedL10ns; + + /// List of paths to directories storing language files (default is `l10n`) + List? get l10nPaths; +} + +/// Returns a localized string using the yaml file when [L10n.lookup] is called. +/// +/// Specify the key set in the yaml file for [key]. +/// If the key does not exist, it will return the [key] string. +/// +/// By passing parameters to [namedParameters], formatting compliant with +/// [MessageFormat] is possible. +/// +/// example: +/// +/// yaml +/// ```yaml +/// example: +/// title: Title +/// ``` +/// dart +/// ```dart +/// l(context, 'example.title'); +/// ``` +String l( + BuildContext context, + String key, [ + Map? namedParameters, +]) => + Localizations.of(context, L10n)?.lookup( + key, + namedParameters: namedParameters, + ) ?? + key; + +/// Provides functionality required to switch the language of the application. +/// +/// This class is automatically created during the initialization of +/// [I18nPlugin] and can be retrieved from the Plugin. +/// +/// By setting [supportedL10ns] and [l10nDelegates] to [WidgetsApp]'s +/// `supportedLocales` and `localizationsDelegates` respectively, a +/// [Localizations] Widget containing the [L10n] suitable for the +/// language in use will be added to the tree. +/// +/// If using [StandardMaterialApp] or [StandardCupertinoApp], +/// it will be set automatically. +class I18n { + final List _l10nPaths = []; + + final List _supportedL10ns = []; + + /// The `supportedLocales` to be set in [WidgetsApp]. + List get supportedL10ns => _supportedL10ns; + + /// The [LocalizationsDelegate] provided by patapata. + late final L10nDelegate delegate = L10nDelegate(this); + + /// The `localizationsDelegates` to be set in [WidgetsApp]. + late final List l10nDelegates = [ + delegate, + GlobalMaterialLocalizations.delegate, + GlobalCupertinoLocalizations.delegate, + GlobalWidgetsLocalizations.delegate, + ]; +} + +/// Plugin that provides localization. +/// The [l] function becomes available. +/// +/// This Plugin is required for the core of Patapata to work. +/// Automatically initialized during the initialization of patapata [App]. +class I18nPlugin extends Plugin { + final _i18n = I18n(); + + /// The [I18n] class. + I18n get i18n => _i18n; + + @override + FutureOr init(App app) async { + await super.init(app); + + tz.initializeTimeZones(); + + final tEnv = app.environment; + if (tEnv is I18nEnvironment) { + final tPaths = tEnv.l10nPaths; + + if (tPaths != null) { + _i18n._l10nPaths.addAll(tPaths); + } else { + _i18n._l10nPaths.add('l10n'); + } + + final tSupported = tEnv.supportedL10ns; + + if (tSupported != null) { + _i18n._supportedL10ns.addAll(tSupported); + } else { + return false; + } + } else { + _i18n._l10nPaths.add('l10n'); + _i18n._supportedL10ns.add(const Locale('en')); + } + + return true; + } + + @override + Widget createAppWidgetWrapper(Widget child) => _L10nAssetReloader( + child: child, + ); +} + +class _L10nAssetReloader extends StatefulWidget { + final Widget child; + + const _L10nAssetReloader({ + Key? key, + required this.child, + }) : super(key: key); + + @override + State<_L10nAssetReloader> createState() => __L10nAssetReloaderState(); +} + +class __L10nAssetReloaderState extends State<_L10nAssetReloader> { + @override + Widget build(BuildContext context) { + return widget.child; + } + + // coverage:ignore-start + @override + void reassemble() { + super.reassemble(); + _reassembling = true; + + SchedulerBinding.instance.addPostFrameCallback((_) { + _reassembling = false; + }); + } + // coverage:ignore-end +} + +class _LoadYamlParcel { + final String source; + final Uri? sourceUri; + + const _LoadYamlParcel( + this.source, + this.sourceUri, + ); +} + +Map _loadYaml(_LoadYamlParcel parcel) { + Map cMap = {}; + + late Function(YamlMap, String?) fProcessMap; + + fProcessMap = (yamlMap, keyBase) { + final tKeys = yamlMap.keys; + + for (final String tKey in tKeys.cast()) { + Object? tValue = yamlMap[tKey]; + + if (tValue is YamlMap) { + fProcessMap(tValue, keyBase == null ? tKey : '$keyBase.$tKey'); + } else if (tValue != null) { + cMap['${keyBase != null ? '$keyBase.' : ''}$tKey'] = tValue; + } + } + }; + + final tYaml = loadYaml( + parcel.source, + sourceUrl: parcel.sourceUri, + ); + + if (tYaml is YamlMap) { + fProcessMap( + tYaml, + null, + ); + } else { + throw ArgumentError.value( + parcel.source, + 'source', + 'The source is not a valid YAML map.', + ); + } + + return cMap; +} + +class _PrepareMapParcel { + final Locale locale; + final Map map; + + _PrepareMapParcel(this.locale, this.map); +} + +Map _prepareMap(_PrepareMapParcel parcel) { + final tMap = parcel.map; + final tLocale = parcel.locale.toLanguageTag(); + + for (final i in tMap.entries) { + if (i.value is String) { + // We format it to parse the blocks for faster lookup later. + tMap[i.key] = MessageFormat(i.value as String, locale: tLocale) + ..format({}); + } + } + + return tMap; +} + +/// Manages resources required for localization. +/// +/// For each [Locale], place the yaml file in the directory specified by +/// [I18nEnvironment.l10nPaths]. +/// The file name becomes the identifier returned by +/// [Locale.toLanguageTag] and is normalized by [Intl.canonicalizedLocale]. +/// +/// This class is automatically created during the load of +/// [L10nDelegate] and loads each resource. +class L10n { + static Future> _loadMapFromAssets( + Locale locale, + AssetBundle assetBundle, + String fileName, + List paths, + ) => + Future.wait([ + for (var i in paths) + assetBundle + .loadString( + '$i/$fileName.yaml', + cache: false, + ) + .catchError((e, stackTrace) { + if (!kIsTest) { + // coverage:ignore-start + _logger.warning( + 'Failed to load l10n file: $i/$fileName.yaml\nDid you configure I18nEnvironment correctly?', + L10nLoadAssetsException(original: e), + stackTrace, + ); + // coverage:ignore-end + } + + return 'patapata_dummy_never: dummy'; + }) + .then>( + (v) => platformCompute( + _loadYaml, + _LoadYamlParcel( + v, + Uri.tryParse('$i/$fileName.yaml'), + ), + debugLabel: 'patapata_core:i18n:loadYaml', + ), + ) + .catchError((e, stackTrace) { + _logger.warning( + 'Failed to parse l10n file: $i/$fileName.yaml', + L10nLoadAssetsException(original: e), + stackTrace, + ); + + return {}; + }), + ]) + .then>( + (maps) => maps.reduce((v, e) => v..addAll(e))) + .then((v) => + platformCompute(_prepareMap, _PrepareMapParcel(locale, v))); + + /// Load the yaml file corresponding to [Locale] from the asset. + /// + /// If [assetBundle] is not passed, it will be loaded from [rootBundle]. + static Future fromAssets({ + required Locale locale, + required List paths, + AssetBundle? assetBundle, + }) async { + return L10n( + locale, + await _loadMapFromAssets( + locale, + assetBundle ??= rootBundle, + Intl.canonicalizedLocale(locale.toLanguageTag()), + paths, + ), + ); + } + + final Locale _locale; + + /// The [Locale] supported by this [L10n]. + Locale get locale => _locale; + + final Map _map; + + const L10n(this._locale, this._map); + + /// Returns a string specified by [key] from the loaded yaml file. + /// + /// By passing parameters to [namedParameters], + /// formatting compliant with [MessageFormat] is possible. + /// + /// This method is called from the [l] method. + String lookup( + String key, { + Map? namedParameters, + }) { + final tValue = _map[key]; + + if (tValue == null) { + return key; + } + + if (tValue is MessageFormat) { + return tValue.format(namedParameters ?? const {}); + } else { + return tValue.toString(); + } + } + + /// Returns true if [key] is defined in the yaml file. + bool containsMessageKey(String key) => _map.containsKey(key); + + /// Returns true if [key] is defined in the yaml file. + static bool containsKey({ + required BuildContext context, + required String key, + }) => + Localizations.of(context, L10n)?.containsMessageKey(key) ?? false; +} + +/// Factory to load resources for [L10n]. +/// Called by the [Localizations] Widget. +class L10nDelegate extends LocalizationsDelegate { + L10nDelegate(this._i18n); + + final I18n _i18n; + + L10n? _l10n; + + /// The loaded [L10n] class. + /// If it hasn't been loaded yet, null. + L10n? get l10n => _l10n; + + @override + bool isSupported(Locale locale) { + return _i18n.supportedL10ns.contains(locale); + } + + @override + Future load(Locale locale) => L10n.fromAssets( + locale: locale, + paths: _i18n._l10nPaths, + assetBundle: mockL10nAssetBundle, + ).then((value) => _l10n = value); + + // coverage:ignore-start + @override + bool shouldReload(LocalizationsDelegate old) => _reassembling; + // coverage:ignore-end +} + +@visibleForTesting +AssetBundle? mockL10nAssetBundle; + +/// Thrown if the loading of an asset in [L10n] fails. +class L10nLoadAssetsException extends PatapataCoreException { + const L10nLoadAssetsException({ + super.original, + }) : super(code: PatapataCoreExceptionCode.PPE401); +} diff --git a/packages/patapata_core/lib/src/local_config.dart b/packages/patapata_core/lib/src/local_config.dart new file mode 100644 index 0000000..c6569fa --- /dev/null +++ b/packages/patapata_core/lib/src/local_config.dart @@ -0,0 +1,339 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; + +import 'config.dart'; + +/// Abstract class for the [LocalConfig]. +/// +/// [Config] for saving data locally. +/// Also, please check the mixin for implementing basic functionality in [MemoryLocalConfig]. +abstract class LocalConfig extends Config with ReadableConfig, WritableConfig {} + +/// Class for managing all [LocalConfig] used by the app. +/// If multiple local configurations are added, the most recently added local configuration is used as the current [LocalConfig]. +/// +/// Access to [LocalConfig] is usually done through this class. +/// +/// example: +/// ```dart +/// tApp.getPlugin()?.getBool('key'); +/// ``` +class ProxyLocalConfig extends LocalConfig { + final List _localConfigs = [ + // Make sure _something_ exists. + MockLocalConfig({}), + ]; + final Map _defaults = {}; + + /// Create a [ProxyLocalConfig] + ProxyLocalConfig(); + + /// This adds the [localConfig] to the [LocalConfig]s managed by this class. + Future addLocalConfig(LocalConfig localConfig) async { + await localConfig.init(); + await localConfig.setDefaults(Map.of(_defaults)); + localConfig.addListener(onChange); + _localConfigs.add(localConfig); + + notifyListeners(); + } + + /// This removes [localConfig] from the [LocalConfig]s managed by this class. + void removeLocalConfig(LocalConfig localConfig) { + if (_localConfigs.remove(localConfig)) { + localConfig.dispose(); + notifyListeners(); + } + } + + @override + void dispose() { + super.dispose(); + for (var v in _localConfigs) { + v.dispose(); + } + _localConfigs.clear(); + } + + LocalConfig get _current => _localConfigs.last; + + /// This class checks whether the current [LocalConfig] managed by it contains a key with the name [key]. + @override + bool hasKey(String key) => _current.hasKey(key); + + /// Retrieves the bool value with the name [key] from the current [LocalConfig]. + /// If it cannot be retrieved, [defaultValue] is returned. + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + if (_current.hasKey(key)) { + return _current.getBool(key, defaultValue: defaultValue); + } + + if (_defaults.containsKey(key) && _defaults[key] is bool) { + return _defaults[key] as bool; + } + + return defaultValue; + } + + /// Retrieves the double value with the name [key] from the current [LocalConfig]. + /// If it cannot be retrieved, [defaultValue] is returned. + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + if (_current.hasKey(key)) { + return _current.getDouble(key, defaultValue: defaultValue); + } + + if (_defaults.containsKey(key) && _defaults[key] is double) { + return _defaults[key] as double; + } + + return defaultValue; + } + + /// Retrieves the int value with the name [key] from the current [LocalConfig]. + /// If it cannot be retrieved, [defaultValue] is returned. + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + if (_current.hasKey(key)) { + return _current.getInt(key, defaultValue: defaultValue); + } + + if (_defaults.containsKey(key) && _defaults[key] is int) { + return _defaults[key] as int; + } + + return defaultValue; + } + + /// Retrieves the String value with the name [key] from the current [LocalConfig]. + /// If it cannot be retrieved, [defaultValue] is returned. + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + if (_current.hasKey(key)) { + return _current.getString(key, defaultValue: defaultValue); + } + + if (_defaults.containsKey(key) && _defaults[key] is String) { + return _defaults[key] as String; + } + + return defaultValue; + } + + /// This sets the default values for all [LocalConfig] managed by this class to the values specified in [defaults]. + /// If values are already set, it overwrites them with the default values. + @override + Future setDefaults(Map defaults) async { + _defaults + ..clear() + ..addAll(defaults); + + // After we add, we hint to the actual + // LocalConfig's about the defaults as well. + // They are expected to only return true for hasKey + // when not using default values. + for (var tConfig in _localConfigs) { + await tConfig.setDefaults(defaults); + } + } + + /// This removes the value with the name [key] from the current [LocalConfig]. + @override + Future reset(String key) async { + await _current.reset(key); + } + + /// This removes all values from the current [LocalConfig]. + @override + Future resetAll() async { + await _current.resetAll(); + } + + /// This removes the values with the names specified in [keys] from the current [LocalConfig]. + @override + Future resetMany(List keys) async { + await _current.resetMany(keys); + } + + /// This sets the bool value [value] with the name [key] to the current [LocalConfig]. + @override + Future setBool(String key, bool value) async { + await _current.setBool(key, value); + } + + /// This sets the double value [value] with the name [key] to the current [LocalConfig]. + @override + Future setDouble(String key, double value) async { + await _current.setDouble(key, value); + } + + /// This sets the int value [value] with the name [key] to the current [LocalConfig]. + @override + Future setInt(String key, int value) async { + await _current.setInt(key, value); + } + + /// This sets the String value [value] with the name [key] to the current [LocalConfig]. + @override + Future setString(String key, String value) async { + await _current.setString(key, value); + } + + /// This sets the key-value pairs specified in the [objects] map of type `Map` to the current [LocalConfig]. + @override + Future setMany(Map objects) async { + await _current.setMany(objects); + } +} + +/// A mixin that implements default functionality in [LocalConfig]. +/// If you don't need to implement special features, you can use this mixin to create a `LocalConfig` +/// +/// example: +/// ```dart +/// class HogehogeLocalConfig extends LocalConfig with MemoryLocalConfig { +/// // Processes you want to add, override, etc... +/// @override +/// bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { +/// return super.getBool(key, defaultValue: false); +/// } +/// ... +/// } +/// ``` +mixin MemoryLocalConfig on LocalConfig { + /// The data managed by this class, in the form of a Map with keys and values. + @protected + final Map store = {}; + + /// The default data for the data managed by this class, in the form of a Map with keys and values. + @protected + final Map defaults = {}; + + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + return store.containsKey(key) && store[key] is bool + ? store[key] as bool + : defaults.containsKey(key) && defaults[key] is bool + ? defaults[key] as bool + : defaultValue; + } + + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + return store.containsKey(key) && store[key] is double + ? store[key] as double + : defaults.containsKey(key) && defaults[key] is double + ? defaults[key] as double + : defaultValue; + } + + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + return store.containsKey(key) && store[key] is int + ? store[key] as int + : defaults.containsKey(key) && defaults[key] is int + ? defaults[key] as int + : defaultValue; + } + + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + return store.containsKey(key) && store[key] is String + ? store[key] as String + : defaults.containsKey(key) && defaults[key] is String + ? defaults[key] as String + : defaultValue; + } + + @override + bool hasKey(String key) { + return store.containsKey(key); + } + + @override + Future setDefaults(Map defaults) async { + this.defaults + ..clear() + ..addAll(defaults); + } + + @override + Future reset(String key) async { + store.remove(key); + notifyListeners(); + } + + @override + Future resetAll() async { + store.clear(); + notifyListeners(); + } + + @override + Future resetMany(List keys) async { + bool tChanged = false; + + for (final k in keys) { + if (store.remove(k) != null) { + tChanged = true; + } + } + + if (tChanged) { + notifyListeners(); + } + } + + @override + Future setBool(String key, bool value) async { + store[key] = value; + notifyListeners(); + } + + @override + Future setDouble(String key, double value) async { + store[key] = value; + notifyListeners(); + } + + @override + Future setInt(String key, int value) async { + store[key] = value; + notifyListeners(); + } + + @override + Future setString(String key, String value) async { + store[key] = value; + notifyListeners(); + } + + @override + Future setMany(Map objects) async { + for (final i in objects.entries) { + store[i.key] = i.value; + } + + notifyListeners(); + } +} + +/// A [LocalConfig] class for mock purposes, used in tests and similar scenarios. +/// It is not intended for use by the application. +/// @nodoc +class MockLocalConfig extends LocalConfig with MemoryLocalConfig { + /// Create a [MockLocalConfig] + /// @nodoc + MockLocalConfig(Map store) { + this.store.addAll(store); + } +} diff --git a/packages/patapata_core/lib/src/log.dart b/packages/patapata_core/lib/src/log.dart new file mode 100644 index 0000000..a988f83 --- /dev/null +++ b/packages/patapata_core/lib/src/log.dart @@ -0,0 +1,988 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/services.dart'; +import 'package:logging/logging.dart'; +import 'package:stack_trace/stack_trace.dart'; + +import 'dart:ffi' if (dart.library.html) 'fake_ffi.dart'; + +import 'app.dart'; +import 'util.dart'; +import 'error.dart'; + +typedef ReportRecordFilter = ReportRecord? Function(ReportRecord record); + +const int _kLineLimit = 1023; + +void _debugLogMuter(String? message, {int? wrapWidth}) {} + +/// Settings for [Log] system +mixin LogEnvironment { + /// The log level ([Level.value]) that patapata processes. + int get logLevel; + + /// If true, outputs the contents of the log to the debug console. + bool get printLog => kDebugMode; +} + +/// Provides an implementation for [Logger.onRecord]. +/// +/// When a message is added to [Logger], [report] is automatically called and +/// [ReportRecord] filtered by [filter] is added to [reports]. +/// +/// Filters can be added with [addFilter] or [ignoreType]. +/// If a filter returns null, that record is ignored. +/// +/// You can add a filter that changes the log level of records that match regular +/// expressions in the remote config (`patapataLogLevelFilters`). +/// +/// Example: Firebase Remote Config +/// ```json +/// { +/// 'foo': 800, +/// 'bar': 1000 +/// } +/// ``` +/// +/// Each filter is processed from the top. +/// +/// The log level to be processed can be set in [LogEnvironment.logLevel] or +/// in the remote config (`patapata_log_level`). +/// (default is [Level.INFO]) +/// +/// If settings are made in both [LogEnvironment.logLevel] and the remote config, +/// the remote config setting takes precedence. +/// +/// This class is automatically initialized during the initialization of +/// patapata [App] and can be accessed from [App.log]. +class Log { + static const String kReportMechanism = 'patapataReport'; + static const String kRootLogMechanism = 'patapataRootLog'; + static const String kUnhandledErrorMechanism = 'patapataUnhandledError'; + static const String kFlutterErrorMechanism = 'patapataFlutterError'; + static const String kNativeMechanism = 'patapataNativeThrowable'; + + static const String kRemoteConfigLevelFilters = 'patapataLogLevelFilters'; + + final App app; + StreamSubscription? _rootLogPrintSubscription; + DebugPrintCallback? _originalDebugPrint; + StreamSubscription? _rootLogDelegateSubscription; + FlutterExceptionHandler? _originalOnFlutterError; + final _filters = []; + final _typeFilters = {}; + + final _duplicateTracker = Expando('patapata.Log'); + + final _reportStreamController = StreamController.broadcast(); + + /// Returns the stream of [ReportRecord] processed by [report]. + Stream get reports => _reportStreamController.stream; + + Log(this.app) { + final tEnvironment = app.environment; + logPrinting = switch (tEnvironment) { + LogEnvironment() => tEnvironment.printLog, + // debugPrint's implementation is actually quite heavy even in release mode. + // So we disable it in release mode. + _ => kDebugMode + }; + setLevelByValue(-kPataInHex); + + _rootLogDelegateSubscription = + Logger.root.onRecord.listen(_onRootLogRecordDelegate); + + _originalOnFlutterError = FlutterError.onError; + FlutterError.onError = _onFlutterError; + + App.appStageChangeStream + .firstWhere((e) => + e == app && e.stage == AppStage.initializingPluginsWithRemoteConfig) + .then((_) { + // When RemoteConfig is ready in our app, start listening + // for RemoteConfig changes and grab and parse our configuration. + _onRemoteConfigChange(); + app.remoteConfig.addListener(_onRemoteConfigChange); + }); + } + + Map? _levelFilters; + String? _remoteConfigLevelFiltersString; + + void _onRemoteConfigChange() { + final tLevelFiltersString = + app.remoteConfig.getString(Log.kRemoteConfigLevelFilters); + + if (_remoteConfigLevelFiltersString == tLevelFiltersString) { + return; + } + + _remoteConfigLevelFiltersString = tLevelFiltersString; + + if (tLevelFiltersString.isEmpty) { + _levelFilters = null; + } else { + try { + final tDecodedLevelFilters = + (jsonDecode(tLevelFiltersString) as Map).cast(); + _levelFilters = { + for (var e in tDecodedLevelFilters.entries) + RegExp(e.key): e.value == null + ? null + : Level.LEVELS.firstWhere((v) => v.value == e.value!, + orElse: () => Level('REMOTE', e.value!)), + }; + } catch (e) { + // Print directly, if this was a bad error that happens + // many many times, the report system won't have a way to + // filter out this message and cause account limit over issues + // all over the place. + _print( + 'Log: RemoteConfig ${Log.kRemoteConfigLevelFilters} parsing failed: $e'); + } + } + } + + /// Releases each resource. + void dispose() { + app.remoteConfig.removeListener(_onRemoteConfigChange); + + _rootLogPrintSubscription?.cancel(); + _rootLogPrintSubscription = null; + + if (_originalDebugPrint != null) { + debugPrint = _originalDebugPrint!; + _originalDebugPrint = null; + } + + _rootLogDelegateSubscription?.cancel(); + _rootLogDelegateSubscription = null; + + if (_originalOnFlutterError != null) { + FlutterError.onError = _originalOnFlutterError; + _originalOnFlutterError = null; + } + + _reportStreamController.close(); + } + + Level _level = Level.INFO; + + set level(Level value) { + _level = value; + Logger.root.level = _level; + } + + /// The level of the log to be processed. + Level get level => _level; + + /// Specifies the level of the log to be processed using [Level.value]. + /// + /// If `-[kPataInHex]` is specified, + /// [LogEnvironment.logLevel] is used. (If not set, it defaults to [Level.INFO]) + void setLevelByValue(int value) { + final tDefaultLogLevel = app.environment is LogEnvironment + ? (app.environment as LogEnvironment).logLevel + : Level.INFO.value; + + if (value == -kPataInHex) { + value = tDefaultLogLevel; + } + + level = Level.LEVELS.firstWhere((v) => v.value == value, + orElse: () => Level('REMOTE', value)); + } + + bool _seenBefore(Object error) { + // From Expando's documentation... + // The object must not be a number, a string, a boolean, `null`, a + // `dart:ffi` pointer, a `dart:ffi` struct, or a `dart:ffi` union. + if (error is num || error is String || error is bool) { + return false; + } + + if (!kIsWeb) { + if (error is Pointer || error is Struct || error is Union) { + return false; + } + } + + if (_duplicateTracker[error] == true) { + return true; + } + + _duplicateTracker[error] = true; + return false; + } + + /// If true, the log contents will be output on the debug console and system log. + bool get logPrinting => _rootLogPrintSubscription != null; + set logPrinting(bool value) { + if (value) { + _rootLogPrintSubscription ??= + Logger.root.onRecord.listen(_onRootLogRecordPrint); + + if (debugPrint == _debugLogMuter) { + debugPrint = _originalDebugPrint!; + } + } else { + _rootLogPrintSubscription?.cancel(); + _rootLogPrintSubscription = null; + + if (debugPrint != _debugLogMuter) { + _originalDebugPrint = debugPrint; + debugPrint = _debugLogMuter; + } + } + } + + void _print(String message) { + if (message.isEmpty == true) { + return; + } + + message.split('\n').forEach((message) { + if (utf8.encode(message).length < 1024) { + debugPrint(message); + return; + } + final tLines = _splitStringByUtf8ByteLength(message); + for (var i = 0; i < tLines.length; i++) { + debugPrint(tLines[i]); + } + }); + } + + List _splitStringByUtf8ByteLength(String message) { + return [ + ...(() sync* { + final tRunes = message.runes.toList(growable: false); + final tRunesLength = tRunes.length; + int tByteLength = 0; + int tStart = 0; + + for (var i = 0; i < tRunesLength; i++) { + final tRune = tRunes[i]; + + if (tRune <= 0xFF) { + if (tByteLength + 1 > _kLineLimit) { + yield message.substring(tStart, i); + tStart = i; + tByteLength = 0; + } + + tByteLength++; + } else { + final tRuneBytesLength = + utf8.encode(String.fromCharCode(tRune)).length; + + if (tByteLength + tRuneBytesLength > _kLineLimit) { + yield message.substring(tStart, i); + tStart = i; + tByteLength = 0; + } + + tByteLength += tRuneBytesLength; + } + } + + if (tStart < tRunesLength) { + yield message.substring(tStart, tRunesLength); + } + })(), + ]; + } + + void _onRootLogRecordPrint(LogRecord record) { + _print(record.toString()); + + final tError = record.error; + + if (tError is FlutterErrorDetails) { + // Flutter errors print stack traces and everything + // needed in the toString() method. So we are already done. + return; + } + + final tErrorString = tError?.toString(); + + if (tErrorString != null && record.message != tErrorString) { + _print(tErrorString); + } + + if (record.stackTrace != null) { + _print(record.stackTrace.toString()); + } + } + + void _onRootLogRecordDelegate(LogRecord record) { + if (record.object is ReportRecord) { + report(record.object as ReportRecord); + } else { + report(ReportRecord.fromLogRecord(record)); + } + } + + void _onFlutterError(FlutterErrorDetails details) { + report( + ReportRecord( + level: Level.SEVERE, + object: details, + error: details.exception, + stackTrace: details.stack, + mechanism: Log.kFlutterErrorMechanism, + ), + ); + + if (_originalOnFlutterError != null) { + _originalOnFlutterError!(details); + } + } + + /// Filters [record] and adds the result to [reports]. + /// If the filter returns null, that record is ignored. + /// + /// This method is automatically called when a message is added to [Logger]. + void report(ReportRecord record) { + if (record.level < level) { + return; + } + + if (record.object != null && _seenBefore(record.object!)) { + return; + } + + if (record.error != null && _seenBefore(record.error!)) { + return; + } + + final tRecord = filter(record); + + if (tRecord == null) { + return; + } + + final tError = tRecord.error; + + if (tError is PatapataException) { + scheduleMicrotask(() { + try { + tError.onReported(tRecord); + } catch (e) { + _print(e.toString()); + } + }); + } + + _reportStreamController.add(tRecord); + } + + ReportRecord? _shouldIgnoreByType(ReportRecord record) => + record.error != null && _typeFilters.contains(record.error.runtimeType) + ? null + : record; + + /// Adds a filter. + /// + /// If the filter returns null, that record is ignored. + void addFilter(ReportRecordFilter test) { + _filters.add(test); + } + + /// Removes the filter added with [addFilter]. + void removeFilter(ReportRecordFilter test) { + _filters.remove(test); + } + + /// Adds a filter to ignore if [ReportRecord.error] matches [type]. + void ignoreType(Type type) { + _typeFilters.add(type); + + if (_typeFilters.length == 1) { + _filters.add(_shouldIgnoreByType); + } + } + + /// Removes the filter added with [ignoreType]. + void unignoreType(Type type) { + _typeFilters.remove(type); + + if (_typeFilters.isEmpty) { + _filters.remove(_shouldIgnoreByType); + } + } + + /// Filters [object] and returns the result. + ReportRecord? filter(ReportRecord object) { + ReportRecord? tObject = object; + + // First check local filters + for (var tFilter in _filters) { + tObject = tFilter(tObject!); + + if (tObject == null) { + return null; + } + } + + // Then check remote filters + tObject = _filterFromRemote(tObject!); + + return tObject; + } + + ReportRecord? _filterFromRemote(ReportRecord record) { + if (_levelFilters == null) { + return record; + } + + for (var i in _levelFilters!.entries) { + if (record.level == i.value) { + continue; + } + + if (record.message.isNotEmpty && i.key.hasMatch(record.message)) { + if (i.value == null) { + return null; + } + + record = record.copyWith(level: i.value); + } + + if (record.error != null) { + final tToCheck = record.error!.toString(); + + if (tToCheck.isNotEmpty && i.key.hasMatch(tToCheck)) { + if (i.value == null) { + return null; + } + + record = record.copyWith(level: i.value); + } + } + + if (record.object != null) { + final tToCheck = record.object!.toString(); + + if (tToCheck.isNotEmpty && i.key.hasMatch(tToCheck)) { + if (i.value == null) { + return null; + } + + record = record.copyWith(level: i.value); + } + } + } + + return record; + } +} + +/// A log entry representation used to propagate information from [Logger] to +/// individual handlers. +/// +/// This class is used by the [Log] system. +/// You can also use this class to send your own reports. +class ReportRecord implements LogRecord { + @override + final Level level; + @override + final String message; + + /// Non-string message passed to Logger. + @override + final Object? object; + + /// Logger where this record is stored. + @override + final String loggerName; + + /// Time when this record was created. + @override + final DateTime time; + + /// Unique sequence number greater than all log records created before it. + @override + final int sequenceNumber; + + /// Associated error (if any) when recording errors messages. + @override + final Object? error; + + /// Associated stackTrace (if any) when recording errors messages. + @override + final StackTrace? stackTrace; + + /// Zone of the calling code which resulted in this LogRecord. + @override + final Zone? zone; + + /// In what way this record was created/collected. + final String mechanism; + + /// Any extra details to send with the report. + final Map? extra; + + /// Used to deduplicate events by grouping ones with the same fingerprint together. + final List? fingerprint; + + /// Creates a new instance of [ReportRecord]. + /// + /// [message] or [object] or [error] must be specified. + /// If [stackTrace] is not specified, it is automatically set to the stack + /// trace of [error]. + /// If [time] is not specified, it is automatically set to the current time. + /// If [sequenceNumber] is not specified, it is automatically set to the + /// sequence number of the [LogRecord] with [Level.INFO] and empty [message]. + /// If [mechanism] is not specified, it is automatically set to + /// [Log.kReportMechanism]. + ReportRecord({ + required this.level, + String? message, + this.object, + this.loggerName = 'report', + DateTime? time, + int? sequenceNumber, + this.error, + StackTrace? stackTrace, + this.zone, + this.mechanism = Log.kReportMechanism, + this.extra, + this.fingerprint, + }) : assert(message != null || object != null || error != null), + time = time ?? DateTime.now(), + sequenceNumber = + sequenceNumber ?? LogRecord(Level.INFO, '', '').sequenceNumber, + message = + message ?? object?.toString() ?? error?.toString() ?? '', + stackTrace = (stackTrace != null && stackTrace != StackTrace.empty + ? stackTrace + : null) ?? + (error is Error && + error.stackTrace != null && + error.stackTrace != StackTrace.empty + ? error.stackTrace + : null); + + /// Creates a new instance of [ReportRecord] from [LogRecord]. + factory ReportRecord.fromLogRecord(LogRecord record) => ReportRecord( + level: record.level, + message: record.message, + object: record.object, + loggerName: record.loggerName, + time: record.time, + sequenceNumber: record.sequenceNumber, + error: record.error, + fingerprint: (record.error is PatapataException) + ? (record.error as PatapataException).fingerprint + : null, + stackTrace: record.stackTrace, + zone: record.zone, + mechanism: Log.kRootLogMechanism, + ); + + @override + String toString() => '[${level.name}] $loggerName: $message'; + + /// Returns a new instance of [ReportRecord] with the specified attributes + /// replaced. + ReportRecord copyWith({ + Level? level, + String? message, + Object? object, + String? loggerName, + DateTime? time, + int? sequenceNumber, + Object? error, + StackTrace? stackTrace, + Zone? zone, + String? mechanism, + Map? extra, + List? fingerprint, + }) { + return ReportRecord( + level: level ?? this.level, + message: message ?? this.message, + object: object ?? this.object, + loggerName: loggerName ?? this.loggerName, + time: time ?? this.time, + sequenceNumber: sequenceNumber ?? this.sequenceNumber, + error: error ?? this.error, + stackTrace: stackTrace ?? this.stackTrace, + zone: zone ?? this.zone, + mechanism: mechanism ?? this.mechanism, + extra: extra ?? this.extra, + fingerprint: fingerprint ?? this.fingerprint, + ); + } +} + +final Map _nativeLoggingMethodChannels = {}; + +final _nativeLogger = Logger('patapata.native'); + +final _nativeLoggerLevelMap = { + 0: Level('EMERGENCY', Level.SHOUT.value), + 1: Level('ALERT', Level.SHOUT.value - 10), + 2: Level('CRITICAL', Level.SHOUT.value - 20), + 3: Level('ERROR', Level.SEVERE.value), + 4: Level.WARNING, + 5: Level('NOTICE', Level.INFO.value + 10), + 6: Level.INFO, + 7: Level('DEBUG', Level.FINE.value), +}; + +Future _nativeLoggingMethodHandler(MethodCall call) async { + if (call.method != 'logging') { + return null; + } + + if (call.arguments is! Map) { + return null; + } + + final tLoggingPackage = (call.arguments as Map).cast(); + + Level tLevel = Level.INFO; + + if (tLoggingPackage['level'] is int && + _nativeLoggerLevelMap.containsKey(tLoggingPackage['level'] as int)) { + tLevel = _nativeLoggerLevelMap[tLoggingPackage['level'] as int]!; + } + + String? tMessage; + + if (tLoggingPackage['message'] is String) { + tMessage = tLoggingPackage['message'] as String?; + } + + DateTime tTimestamp; + + if (tLoggingPackage['timestamp'] is int) { + tTimestamp = DateTime.fromMillisecondsSinceEpoch( + tLoggingPackage['timestamp'] as int, + isUtc: true, + ); + } else { + tTimestamp = DateTime.now(); + } + + Map? tExtra; + + if (tLoggingPackage['metadata'] is String) { + final tMetadata = tLoggingPackage['metadata'] as String?; + + if (tMetadata != null) { + try { + tExtra = (jsonDecode(tMetadata) as Map).cast(); + } catch (e) { + // ignore + } + } + } + + NativeThrowable? tThrowable; + + if (tLoggingPackage['throwable'] is Map) { + tThrowable = NativeThrowable.fromMap( + (tLoggingPackage['throwable'] as Map).cast()); + } + + _nativeLogger.log( + tLevel, + ReportRecord( + level: tLevel, + message: tMessage, + error: tThrowable, + stackTrace: tThrowable?.chain, + time: tTimestamp, + extra: tExtra, + mechanism: Log.kNativeMechanism, + ), + ); + + return null; +} + +/// +/// This is a regular expression to parse and separate a single frame (line) of a +/// Java StackTrace. +/// +/// `(.+?[\.].+?(?=\.))?` Capture if there is a Java package name at the beginning. +/// `([^\.]+?\.[^\.(]+?)` Capture the Java class name and method. +/// `(?:\((.+?)(?::([\d]+?))?\))?` Capture the filename if present, followed by the line number if available. +/// +final RegExp _nativeAndroidFrameParser = RegExp( + r'^(.+?[\.].+?(?=\.))?\.?([^\.]+?\.[^\.(]+?)(?:\((.+?)(?::([\d]+?))?\))?$'); + +/// +/// This is a regular expression to parse and separate a single frame (line) of an +/// iOS StackTrace. +/// +/// `.+?\s+` Drop the leading index. +/// `(.+?)` Capture the iOS Framework part. +/// `\s+.+?\s+` Ignore the memory address. +/// `(.+?)` Capture the function name. +/// `(?:\s+\+\s+(\d+)?)?` If present, capture the line number. +/// +final RegExp _nativeIosFrameParser = + RegExp(r'^.+?\s+(.+?)\s+.+?\s+(.+?)(?:\s+\+\s+(\d+)?)?$'); + +/// Class for exceptions that occurred natively. +/// +/// By registering the MethodChannel with [registerNativeThrowableMethodChannel], +/// you can notify the patapata's [Log] system of exceptions that occurred natively. +/// +/// Currently, this feature only supports Android and iOS. +/// +/// example: Android (Kotlin) +/// +/// dart +/// ```dart +/// NativeThrowable.registerNativeThrowableMethodChannel('patapata/logging') +/// ``` +/// Android +/// ```kotlin +/// val methodChannel = MethodChannel(binding.binaryMessenger, "patapata/logging") +/// +/// methodChannel.invokeMethod( +/// "logging", +/// mapOf( +/// "level" to 3, +/// +/// "message" to "Log message", +/// +/// "metadata" to "{\"foo\": \"bar\"}", +/// +/// "timestamp" to System.currentTimeMillis(), +/// +/// // throwable is Throwable class. +/// // For Android, instead of the below mapOf, toPatapataMap from a Throwable type can be used. +/// "throwable" to mapOf( +/// "type" to throwable.javaClass.name, +/// "message" to throwable.message, +/// "stackTrace" to throwable.stackTrace.map { it.toString() }, +/// "cause" to throwable.cause?.run { throwableToMap(this) } +/// ) +/// ) +/// ) +/// ``` +class NativeThrowable { + /// For Android, it's the javaClassName; for iOS, it's things like the error domain. + final String? type; + + /// Error details. + final String? message; + + /// A chain of stack traces. + /// + /// This property is represented as `stackTrace` in the Map. + final Chain? chain; + + /// Cause of the exception. + final NativeThrowable? cause; + + const NativeThrowable({ + this.type, + this.message, + this.chain, + this.cause, + }); + + /// Registers the MethodChannel with the [name]. + /// + /// In Native, by creating a MethodChannel with the [name] and invoking the + /// `logging` method, you can notify the app's [Log] system. + /// + /// arguments: Type is Map + /// ```json + /// { + /// // Log level + /// // Conforms to syslog severity level. + /// // + /// // This value corresponds to the value of the Level class defined on the dart side. + /// // 0: Level('EMERGENCY', Level.SHOUT.value), + /// // 1: Level('ALERT', Level.SHOUT.value - 10), + /// // 2: Level('CRITICAL', Level.SHOUT.value - 20), + /// // 3: Level('ERROR', Level.SEVERE.value), + /// // 4: Level.WARNING, + /// // 5: Level('NOTICE', Level.INFO.value + 10), + /// // 6: Level.INFO, + /// // 7: Level('DEBUG', Level.FINE.value), + /// // + /// // If omitted, it is treated as 6. + /// "level": 3, + /// + /// + /// // required: Log message + /// "message": "Log message", + /// + /// // json string of extra data + /// // This value is passed to [ReportRecord.extra] on the dart side. + /// "metadata": "{\"foo\": \"bar\"}", + /// + /// // timestamp(Unix time) + /// "timestamp": 1234567890, + /// + /// // Map of Native exception classes converted to this [NativeThrowable] class. + /// // For Android, by calling the `toPatapataMap` that extends the Java's `Throwable` class, + /// // you can convert it to the map of this class. + /// "throwable": Throwable.toPatapataMap() + /// } + /// ``` + /// + static void registerNativeThrowableMethodChannel(String name) { + if (!_nativeLoggingMethodChannels.containsKey(name)) { + _nativeLoggingMethodChannels[name] = MethodChannel(name) + ..setMethodCallHandler(_nativeLoggingMethodHandler); + } + } + + /// Unregisters the MethodChannel. + static void unregisterNativeThrowableMethodChannel(String name) { + if (_nativeLoggingMethodChannels.containsKey(name)) { + _nativeLoggingMethodChannels[name]?.setMethodCallHandler(null); + _nativeLoggingMethodChannels.remove(name); + } + } + + /// Creates a new instance of [NativeThrowable] from the Map. + factory NativeThrowable.fromMap(Map map) { + final tStackTrace = (map['stackTrace'] as List?)?.cast(); + final tCause = map['cause'] is Map + ? NativeThrowable.fromMap((map['cause'] as Map).cast()) + : null; + + late RegExp tMatcher; + late int tPackageGroup; + int? tFileGroup; + late int tMethodGroup; + late int tLineGroup; + + switch (defaultTargetPlatform) { + case TargetPlatform.android: + tMatcher = _nativeAndroidFrameParser; + tPackageGroup = 1; + tFileGroup = 3; + tMethodGroup = 2; + tLineGroup = 4; + break; + case TargetPlatform.iOS: + tMatcher = _nativeIosFrameParser; + tPackageGroup = 1; + tFileGroup = null; + tMethodGroup = 2; + tLineGroup = 3; + break; + default: + // ignore: avoid_print + print('$defaultTargetPlatform not supported for NativeThrowable yet.'); + break; + } + + final tChain = Chain([ + if (tStackTrace != null) + Trace( + tStackTrace.map( + (v) { + try { + final tMatch = tMatcher.firstMatch(v); + + if (tMatch != null) { + final tLine = tMatch.group(tLineGroup); + return Frame( + Uri.file( + '${tMatch.group(tPackageGroup) ?? ''}${(tFileGroup != null ? '/${tMatch.group(tFileGroup)}' : null) ?? '/'}' + .replaceAll(' ', ''), + windows: false), + tLine != null ? int.tryParse(tLine) : null, + null, + tMatch.group(tMethodGroup), + ); + } else { + return Frame.parseFriendly(v); + } + } catch (e) { + return Frame.parseFriendly(v); + } + }, + ), + original: tStackTrace.join('\n'), + ), + ...((NativeThrowable? cause) sync* { + while (cause != null) { + final tTraces = cause.chain?.traces; + + if (tTraces != null) { + for (var tTrace in tTraces) { + yield tTrace; + } + } + + cause = cause.cause; + } + })(tCause), + ]); + + return NativeThrowable( + type: map['type'] as String?, + message: map['message'] as String?, + chain: tChain.traces.isNotEmpty ? tChain : null, + cause: tCause, + ); + } + + /// Converts this class to a Map. + Map toMap() { + final tCause = cause?.toMap(); + final tFrames = + chain?.traces.isNotEmpty == true ? chain?.traces.first.frames : null; + + final tPratformStackTrace = List.generate(tFrames?.length ?? 0, (index) { + final tFrame = tFrames![index]; + try { + switch (defaultTargetPlatform) { + case TargetPlatform.android: + final tLibrary = tFrame.library.split('/'); + final tLine = tFrame.line != null ? ':${tFrame.line}' : ''; + final tPackageGroup = tLibrary[0].replaceAll('', ''); + final tFileGroup = tLibrary[1].replaceAll('', ''); + final tMethodGroup = tFrame.member ?? ''; + + return ('$tPackageGroup${tPackageGroup.isNotEmpty ? '.' : ''}$tMethodGroup($tFileGroup$tLine)') + .replaceAll('', ' '); + case TargetPlatform.iOS: + final tLibrary = tFrame.library.split('/'); + final tLine = tFrame.line != null ? ' + ${tFrame.line}' : ''; + final tPackageGroup = tLibrary[0].replaceAll('', ''); + final tMethodGroup = tFrame.member ?? ''; + + // Dummy since memory address information is lost. + return ('${index + 1} $tPackageGroup 0x0000000000000000 $tMethodGroup$tLine') + .replaceAll('', ' '); + default: + // ignore: avoid_print + print( + '$defaultTargetPlatform not supported for NativeThrowable yet.'); + return tFrame.toString(); + } + } catch (e) { + return tFrame.toString(); + } + }); + + return { + 'type': type, + 'message': message, + 'stackTrace': tPratformStackTrace.isNotEmpty ? tPratformStackTrace : null, + 'cause': tCause, + }; + } +} diff --git a/packages/patapata_core/lib/src/logic_state.dart b/packages/patapata_core/lib/src/logic_state.dart new file mode 100644 index 0000000..b161f3f --- /dev/null +++ b/packages/patapata_core/lib/src/logic_state.dart @@ -0,0 +1,439 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:collection/collection.dart'; +import 'package:flutter/foundation.dart'; + +import 'exception.dart'; + +/// Provides the functionality of a Finite State Machine. +/// +/// The state machine holds multiple [LogicStateFactory] in a list. +/// At the creation of the machine, a [LogicState] is generated from the leading factory, +/// and the process starts. +/// +/// When a [LogicState] completes, the machine fetches the list of [LogicStateTransition] from the +/// [LogicStateFactory] of that state and finds the factory of the next [LogicState] to +/// execute from the top of the list. +/// If the list is empty, [LogicStateMachine.complete] becomes true, +/// and [LogicStateMachine.current] becomes [LogicStateComplete]. +/// +/// example: +/// ```dart +/// LogicStateMachine( +/// [ +/// LogicStateFactory( +/// () => StateA(this), +/// [ +/// LogicStateTransition(), +/// LogicStateTransition(), +/// ], +/// ), +/// LogicStateFactory( +// () => StateB(this), +/// [ +/// LogicStateTransition(), +/// ], +/// ), +/// LogicStateFactory( +/// () => StateC(this), +/// [], +/// ), +/// ], +/// ); +/// ``` +class LogicStateMachine with ChangeNotifier { + final List _factories; + final List<({Type stateType, bool backAllowed})> _stateHistories = []; + LogicState __currentState; + LogicState get _currentState => __currentState; + set _currentState(LogicState value) { + _stateHistories.add(( + stateType: value.runtimeType, + backAllowed: value.backAllowed, + )); + __currentState = value; + } + + LogicStateFactory _currentFactory; + + /// Creates a new [LogicStateMachine]. + /// Starts processing immediately from the top of [factories] upon creation. + LogicStateMachine(List factories, [Object? initialData]) + : assert(factories.isNotEmpty), + _factories = factories, + _currentFactory = factories.first, + __currentState = factories.first.create() { + _stateHistories.add(( + stateType: __currentState.runtimeType, + backAllowed: __currentState.backAllowed, + )); + _initState(initialData); + } + + /// The current state. + /// + /// If all states complete successfully, [LogicStateComplete] is set. + /// + /// If terminated due to a state error, [LogicStateError] is set. + /// This is the same as what is retrieved by [error]. + LogicState get current => _currentState; + + bool _complete = false; + + /// Returns true if the machine's processing is complete. + bool get complete => _complete; + + /// The error details when the machine terminates due to an error. + LogicStateError? get error => (complete && _currentState is LogicStateError) + ? _currentState as LogicStateError + : null; + + void _initState([Object? initialData]) { + final tState = _currentState; + tState._machine = this; + tState.init(initialData); + assert(tState._initialized); + } + + void _completeFinished() { + _complete = true; + _currentState = LogicStateComplete(); + _initState(); + } + + void _completeError(Object error, [StackTrace? stackTrace]) { + _complete = true; + _currentState = LogicStateError(error, stackTrace); + _initState(); + } + + void _notifyListeners() { + notifyListeners(); + } + + @override + String toString() => + 'LogicStateMachine: complete=$_complete, error=$error, current=$current'; +} + +/// Thrown when LogicStateTransition is not found. +class LogicStateTransitionNotFound extends PatapataCoreException { + const LogicStateTransitionNotFound() + : super(code: PatapataCoreExceptionCode.PPE101); +} + +/// Thrown when [current] is not allowed to transition to [next]. +class LogicStateTransitionNotAllowed extends PatapataCoreException { + final LogicState current; + final LogicState next; + + const LogicStateTransitionNotAllowed( + this.current, + this.next, + ) : super(code: PatapataCoreExceptionCode.PPE102); + + @override + String toString() => + 'LogicStateTransitionNotAllowed: $current is not allowed to transition to $next.'; +} + +/// Thrown when [current] is not allowed to transition to anything. +class LogicStateAllTransitionsNotAllowed extends PatapataCoreException { + final LogicState current; + + const LogicStateAllTransitionsNotAllowed( + this.current, + ) : super(code: PatapataCoreExceptionCode.PPE103); + + @override + String toString() => + 'LogicStateAllTransitionsNotAllowed: $current is not allowed to transition to anything.'; +} + +/// Thrown when [current] is not current in [LogicStateMachine]. +class LogicStateNotCurrent extends PatapataCoreException { + final LogicState current; + + const LogicStateNotCurrent( + this.current, + ) : super(code: PatapataCoreExceptionCode.PPE104); + + @override + String toString() => 'LogicStateNotCurrent: $current is not current.'; +} + +typedef LogicStateCompleter = void Function(); + +/// The state to be executed in [LogicStateMachine]. +abstract class LogicState { + bool _initialized = false; + late final LogicStateMachine _machine; + late final _completer = Completer(); + + /// If true, allows going back via [backByType]. (default is false) + bool backAllowed = false; + + /// Returns a Future that waits until the state is complete. + Future get onComplete => _completer.future; + + /// Completes the state and transitions to the next [LogicState]. + /// + /// The next [LogicState] to transition to is found from the [LogicStateTransition] of the + /// [LogicStateFactory] from which it was created. + /// If the [LogicStateTransition] list is empty, the processing of [LogicStateMachine] + /// will be completed. + /// + /// If [LogicStateTransition] exists but all are in a non-transitionable state + /// (for example, if `predicate` returns false for all), + /// [LogicStateAllTransitionsNotAllowed] will be thrown. + /// + /// [complete] and [completeError] can only be called once. + void complete() { + assert(_initialized); + + if (!this()) { + throw LogicStateNotCurrent(this); + } + + final tTransitions = _machine._currentFactory._transitions; + LogicStateFactory? tNextFactory; + LogicState? tNextState; + + for (var tTransition in tTransitions) { + final tNextFactoryCandidate = _machine._factories.firstWhere( + (v) => v.type == tTransition.nextType, + orElse: () => throw const LogicStateTransitionNotFound(), + ); + final tNextStateCandidate = tNextFactoryCandidate.create(); + + if (tTransition._predicate(this, tNextStateCandidate)) { + tNextFactory = tNextFactoryCandidate; + tNextState = tNextStateCandidate; + + break; + } + } + + if (tTransitions.isEmpty) { + _complete(); + _machine._completeFinished(); + } else if (tNextFactory == null || tNextState == null) { + throw LogicStateAllTransitionsNotAllowed(this); + } else { + _complete(); + _machine._currentFactory = tNextFactory; + _machine._currentState = tNextState; + _machine._initState(); + } + } + + /// Completes the state with an error. + /// It will not transition to the next [LogicState], and the + /// [LogicStateMachine] will terminate as an error. + /// + /// [complete] and [completeError] can only be called once. + void completeError(Object error, [StackTrace? stackTrace]) { + assert(_initialized); + + if (!this()) { + throw LogicStateNotCurrent(this); + } + + _complete(error, stackTrace); + } + + /// Goes back to a state that has already been executed, + /// regardless of the value of its own [LogicStateTransition]. + /// + /// If the target state's [backAllowed] is false, or if there's no history, + /// it throws [LogicStateTransitionNotFound]. + void backByType(Type stateType, [Object? data]) { + assert(_initialized); + + if (!this()) { + throw LogicStateNotCurrent(this); + } + + final tHistoryIndex = _machine._stateHistories + .lastIndexWhere((v) => v.stateType == stateType && v.backAllowed); + + if (tHistoryIndex < 0) { + _complete(const LogicStateTransitionNotFound()); + } else { + final tNextFactory = + _machine._factories.firstWhereOrNull((v) => v.type == stateType); + + if (tNextFactory == null) { + // This process will not be executed if the value of _machine._stateHistories is normal. + _complete(const LogicStateTransitionNotFound()); // coverage:ignore-line + } else { + final tNextState = tNextFactory.create(); + + _complete(); + _machine._stateHistories + .removeRange(tHistoryIndex, _machine._stateHistories.length); + _machine._currentFactory = tNextFactory; + _machine._currentState = tNextState; + _machine._initState(data); + } + } + } + + /// Transitions to the state of [stateType]. + /// + /// If the type of [stateType] does not exist in its own [LogicStateTransition], + /// it throws [LogicStateTransitionNotFound]. + /// If it exists but cannot transition (for instance, if `predicate` returns false), + /// it throws [LogicStateTransitionNotAllowed]. + /// + /// [toByType] can only be called once. Also, [complete] will be executed automatically. + void toByType(Type stateType, [Object? data]) { + assert(_initialized); + + if (!this()) { + throw LogicStateNotCurrent(this); + } + + final tTransition = _machine._currentFactory._transitions + .firstWhereOrNull((v) => v.nextType == stateType); + + if (tTransition == null) { + _complete(const LogicStateTransitionNotFound()); + } else { + final tNextFactory = + _machine._factories.firstWhereOrNull((v) => v.type == stateType); + + if (tNextFactory == null) { + _complete(const LogicStateTransitionNotFound()); + } else { + final tNextState = tNextFactory.create(); + + if (!tTransition._predicate(this, tNextState)) { + _complete(LogicStateTransitionNotAllowed( + this, tNextState.._machine = _machine)); + } else { + _complete(); + _machine._currentFactory = tNextFactory; + _machine._currentState = tNextState; + _machine._initState(data); + } + } + } + } + + /// Transitions to the state of type [T]. + /// + /// If the type [T] does not exist in its own [LogicStateTransition], + /// it throws [LogicStateTransitionNotFound]. + /// If it exists but cannot transition (for instance, if `predicate` returns false), + /// it throws [LogicStateTransitionNotAllowed]. + /// + /// [to] can only be called once. Also, [complete] will be executed automatically. + void to([Object? data]) { + toByType(T, data); + } + + void _complete([Object? error, StackTrace? stackTrace]) { + try { + dispose(); + final tHistoryIndex = _machine._stateHistories + .lastIndexWhere((e) => e.stateType == runtimeType); + if (tHistoryIndex >= 0) { + _machine._stateHistories[tHistoryIndex] = + (stateType: runtimeType, backAllowed: backAllowed); + } + } finally { + if (error != null) { + _completer.completeError(error, stackTrace); + _machine._completeError(error, stackTrace); + } else { + _completer.complete(); + } + } + } + + /// Returns true if [LogicStateMachine.current] is itself. + @nonVirtual + bool call() => + !_machine.complete && + !_completer.isCompleted && + _machine._currentState == this; + + /// Executed first when the state is created. + @mustCallSuper + void init(Object? data) { + _initialized = true; + _machine._notifyListeners(); + } + + /// Called when the state processing is completed. + @mustCallSuper + void dispose() {} + + @override + String toString() => + '$runtimeType: initialized=$_initialized, active=${this()}'; +} + +/// Factory for [LogicState]. +class LogicStateFactory { + /// Creates a new [LogicState]. + final T Function() create; + final List> _transitions; + + /// Returns the [Type] of [LogicState]. + Type get type => T; + + /// Creates a new [LogicStateFactory]. + /// + /// Please specify all possible [LogicState]s that can transition from that + /// [LogicState] in [transitions]. + /// When a [LogicState] is completed, it will find the next state to execute + /// from the top of [transitions]. + /// At that time, the method (`predicate`) passed to the constructor of + /// [LogicStateTransition] is executed, and it transitions to the first [LogicState] that returns true. + /// + /// If you leave [transitions] empty, the processing of [LogicStateMachine] + /// will be completed as soon as that state is completed. + const LogicStateFactory( + this.create, + List> transitions, + ) : _transitions = transitions; +} + +/// A class that specifies the types of other [LogicState]s that can transition from a given [LogicState]. +class LogicStateTransition { + final TransitionPredicate _predicate; + + Type get nextType => R; + + /// Creates a new [LogicStateTransition]. + /// + /// If [predicate] returns false, it does not allow transitioning to that [LogicState]. + /// When a [LogicState] is completed, the next state to execute will be the + /// first state for which [predicate] returns true. + LogicStateTransition([TransitionPredicate? predicate]) + : _predicate = predicate ?? ((c, n) => true); +} + +typedef TransitionPredicate = bool Function( + LogicState current, LogicState next); + +/// The state in which [LogicStateMachine] terminated with an error. +class LogicStateError extends LogicState { + /// Error details. + final Object error; + + /// StackTrace + final StackTrace? stackTrace; + + LogicStateError(this.error, this.stackTrace); +} + +/// The state in which [LogicStateMachine] successfully completed. +class LogicStateComplete extends LogicState {} diff --git a/packages/patapata_core/lib/src/method_channel_test_mixin.dart b/packages/patapata_core/lib/src/method_channel_test_mixin.dart new file mode 100644 index 0000000..4de1ddb --- /dev/null +++ b/packages/patapata_core/lib/src/method_channel_test_mixin.dart @@ -0,0 +1,28 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +import 'package:flutter/services.dart'; + +/// A mixin for adding a function to mock processing in a test environment +/// to a class. +mixin MethodChannelTestMixin { + final List methodCallLogs = []; + + /// A function for mocking a MethodChannel. + /// + /// Currently supported by [App], [Plugin] and [Config]. + /// If you override this function in a subclass that inherits from each, + /// the processing described here will be executed + /// when the constructor is called for [App], + /// and when the init function is called for [Plugin] and [Config]. + void setMockMethodCallHandler() {} + + /// A function for mocking a MockStreamHandler. + /// + /// Currently supported by [Plugin]. + /// If you override this function in a subclass that inherits from [Plugin], + /// the processing described here will be executed when the init function + /// for [Plugin] is called. + void setMockStreamHandler() {} +} diff --git a/packages/patapata_core/lib/src/native_ffi_finder.dart b/packages/patapata_core/lib/src/native_ffi_finder.dart new file mode 100644 index 0000000..b3837af --- /dev/null +++ b/packages/patapata_core/lib/src/native_ffi_finder.dart @@ -0,0 +1,59 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:ffi'; +import 'dart:io'; +import 'dart:math'; +import 'package:flutter/foundation.dart'; + +final String _nativeLibDirectory = kIsWeb + ? '' + : defaultTargetPlatform == TargetPlatform.android + ? (() { + // TODO: This path is hardcoding. so cannot use App + final tNativeLibDirTempFile = + File('${Directory.systemTemp.path}/patapataNativeLib'); + + if (tNativeLibDirTempFile.existsSync()) { + try { + return tNativeLibDirTempFile.readAsStringSync(); + } catch (_) { + // ignore + return ''; + } + } else { + return ''; + } + })() + : ''; + +DynamicLibrary safeLoadDynamicLibrary(String library) { + if (_nativeLibDirectory.isNotEmpty) { + try { + return DynamicLibrary.open("$_nativeLibDirectory/lib$library.so"); + } catch (_) { + try { + final tLib = DynamicLibrary.open("lib$library.so"); + + return tLib; + } catch (_) { + // On some (especially old) Android devices, we somehow can't dlopen + // libraries shipped with the apk. We need to find the full path of the + // library and open that one. + // For details, see https://github.com/simolus3/moor/issues/420 + final tAppIdAsBytes = File('/proc/self/cmdline').readAsBytesSync(); + + // app id ends with the first \0 character in here. + final tEndOfAppId = max(tAppIdAsBytes.indexOf(0), 0); + final tAppId = + String.fromCharCodes(tAppIdAsBytes.sublist(0, tEndOfAppId)); + + return DynamicLibrary.open('/data/data/$tAppId/lib/lib$library.so'); + } + } + } else { + return DynamicLibrary.open("lib$library.so"); + } +} diff --git a/packages/patapata_core/lib/src/native_local_config.dart b/packages/patapata_core/lib/src/native_local_config.dart new file mode 100644 index 0000000..093857e --- /dev/null +++ b/packages/patapata_core/lib/src/native_local_config.dart @@ -0,0 +1,34 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'local_config.dart'; +import 'plugin.dart'; + +import '../finder/local_config_finder.dart' + if (dart.library.io) '../src/native_local_config_finder.dart' + if (dart.library.html) '../web/web_local_config_finder.dart'; + +/// This is an abstract class that utilizes conditional import functionality +/// to handle [LocalConfigFinder] in both the app environment and web environment +/// using a common source code. +/// In the app environment, it functions as [NativeLocalConfigFinder], +/// while in the web environment, it functions as [WebLocalConfigFinder]. +/// +/// Please refer to the reference below for information on conditional imports. +/// https://dart.dev/guides/libraries/create-library-packages#conditionally-importing-and-exporting-library-files +abstract class LocalConfigFinder { + factory LocalConfigFinder() => getLocalConfigFinder(); + LocalConfig? getLocalConfig() => null; // coverage:ignore-line +} + +final LocalConfigFinder _finder = LocalConfigFinder(); + +class NativeLocalConfigPlugin extends Plugin { + @override + String get name => 'dev.patapata.native_local_config'; + + @override + LocalConfig? createLocalConfig() => _finder.getLocalConfig(); +} diff --git a/packages/patapata_core/lib/src/native_local_config_finder.dart b/packages/patapata_core/lib/src/native_local_config_finder.dart new file mode 100644 index 0000000..30ba220 --- /dev/null +++ b/packages/patapata_core/lib/src/native_local_config_finder.dart @@ -0,0 +1,212 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/services.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +final _logger = Logger('patapata.NativeLocalConfig'); + +const _methodChannelName = 'dev.patapata.native_local_config'; +const _methodChannel = MethodChannel(_methodChannelName); + +class NativeLocalConfigFinder implements LocalConfigFinder { + @override + LocalConfig? getLocalConfig() => NativeLocalConfig(); +} + +class NativeLocalConfig extends LocalConfig with MemoryLocalConfig { + @visibleForTesting + final Map mockNativeLocalConfigMap = {}; + + @override + Future init() async { + _methodChannel.setMethodCallHandler(_onMethodCall); + await super.init(); + } + + @override + void dispose() async { + _methodChannel.setMethodCallHandler(null); + super.dispose(); + } + + Future _onMethodCall(MethodCall call) async { + switch (call.method) { + case 'syncAll': + _onSyncAll((call.arguments as Map).cast()); + break; + case 'error': + _onError((call.arguments as Map).cast()); + break; + default: + break; + } + } + + void _onSyncAll(Map data) { + store.clear(); + store.addAll(data); + notifyListeners(); + } + + void _onError(Map error) { + final tError = NativeThrowable.fromMap(error); + + _logger.severe(tError.message, tError, tError.chain); + } + + @override + Future reset(String key) async { + await super.reset(key); + await _methodChannel.invokeMethod('reset', key); + } + + @override + Future resetAll() async { + await super.resetAll(); + await _methodChannel.invokeMethod('resetAll'); + } + + @override + Future resetMany(List keys) async { + await super.resetMany(keys); + await _methodChannel.invokeMethod('resetMany', keys); + } + + @override + Future setBool(String key, bool value) async { + super.setBool(key, value); + await _methodChannel.invokeMethod('setBool', [key, value]); + } + + @override + Future setDouble(String key, double value) async { + super.setDouble(key, value); + await _methodChannel.invokeMethod('setDouble', [key, value]); + } + + @override + Future setInt(String key, int value) async { + super.setInt(key, value); + await _methodChannel.invokeMethod('setInt', [key, value]); + } + + @override + Future setString(String key, String value) async { + super.setString(key, value); + await _methodChannel.invokeMethod('setString', [key, value]); + } + + @override + Future setMany(Map objects) async { + super.setMany(objects); + await _methodChannel.invokeMethod('setMany', objects); + } + + @override + Future setDefaults(Map defaults) async { + await super.setDefaults(defaults); + } + + @override + @visibleForTesting + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + _methodChannel, + (methodCall) async { + methodCallLogs.add(methodCall); + switch (methodCall.method) { + case 'reset': + final tKey = methodCall.arguments as String; + mockNativeLocalConfigMap.remove(tKey); + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'resetAll': + mockNativeLocalConfigMap.clear(); + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'resetMany': + final tKeys = List.from(methodCall.arguments); + + for (final tKey in tKeys) { + mockNativeLocalConfigMap.remove(tKey); + } + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + + case 'setBool': + final tArguments = methodCall.arguments as List; + mockNativeLocalConfigMap[tArguments[0] as String] = + tArguments[1] as bool; + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'setDouble': + final tArguments = methodCall.arguments as List; + mockNativeLocalConfigMap[tArguments[0] as String] = + tArguments[1] as double; + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'setInt': + final tArguments = methodCall.arguments as List; + mockNativeLocalConfigMap[tArguments[0] as String] = + tArguments[1] as int; + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'setString': + final tArguments = methodCall.arguments as List; + mockNativeLocalConfigMap[tArguments[0] as String] = + tArguments[1] as String; + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + case 'setMany': + final tArguments = Map.from(methodCall.arguments); + + for (final tKey in tArguments.keys) { + mockNativeLocalConfigMap[tKey] = tArguments[tKey] as Object; + } + _onMethodCall( + MethodCall('syncAll', mockNativeLocalConfigMap), + ); + break; + } + return null; + }, + ); + } + + @visibleForTesting + void sendError() { + _onMethodCall( + MethodCall( + 'error', + { + "type": runtimeType.toString(), + "message": "", + "stackTrace": const [], + "cause": const {}, + }, + ), + ); + } +} + +LocalConfigFinder getLocalConfigFinder() => NativeLocalConfigFinder(); diff --git a/packages/patapata_core/lib/src/network.dart b/packages/patapata_core/lib/src/network.dart new file mode 100644 index 0000000..43c2559 --- /dev/null +++ b/packages/patapata_core/lib/src/network.dart @@ -0,0 +1,230 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:connectivity_plus/connectivity_plus.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter/widgets.dart'; +import 'package:provider/provider.dart'; + +import 'app.dart'; +import 'plugin.dart'; +import 'util.dart'; + +/// This enum describes various states of network connectivity for an app or system +enum NetworkConnectivity { + /// Status representing an unknown network state + unknown, + + /// Status representing a state where there is no network connection + none, + + /// Status representing a state where there is a network connection, but the type is unknown + other, + + /// Status representing a state connected to a mobile network + mobile, + + /// Status representing a state connected to Wi-Fi + wifi, + + /// Status representing a state connected to Ethernet + ethernet, + + /// Status representing a state connected to Bluetooth + bluetooth, + + /// Status representing a state connected to a VPN network + /// + /// Note for iOS and macOS: + /// There is no separate network interface type for [vpn]. + /// It returns [other] on any device (also simulator). + vpn, +} + +/// A class representing the current network status of [App]. +/// +/// This class, within [NetworkPlugin] +/// obtains the network status using [Connectivity]. +class NetworkInformation { + final NetworkConnectivity connectivity; + + const NetworkInformation({ + required this.connectivity, + }); + + factory NetworkInformation.unknown() => const NetworkInformation( + connectivity: NetworkConnectivity.unknown, + ); + + @override + String toString() => 'NetworkInformation:connectivity=${connectivity.name}'; + + NetworkInformation copyWith({ + NetworkConnectivity? connectivity, + }) => + NetworkInformation( + connectivity: connectivity ?? this.connectivity, + ); + + @override + operator ==(Object other) => + other is NetworkInformation && connectivity == other.connectivity; + + @override + int get hashCode => Object.hash('NetworkInformation', connectivity); +} + +/// Plugin for retrieving the network status of [App]. +class NetworkPlugin extends Plugin with WidgetsBindingObserver { + NetworkPlugin(); + + final Connectivity _connectivity = Connectivity(); + + NetworkInformation _currentNetworkInformation = const NetworkInformation( + connectivity: NetworkConnectivity.unknown, + ); + + /// Return the current network status of [App]. + /// + /// ```dart + /// getApp().network.information + /// ``` + NetworkInformation get information => _currentNetworkInformation; + + final _streamController = StreamController.broadcast(); + + /// Stream to get the latest network state of the app + /// + /// Typically accessed through the app's network. + /// + /// /// ```dart + /// getApp().network.informationStream; + /// ``` + Stream get informationStream => _streamController.stream; + + StreamSubscription? _onConnectivityChangedSubscription; + + @override + FutureOr init(App app) async { + await super.init(app); + WidgetsBinding.instance.addObserver(this); + _onConnectivityChangedSubscription = + _connectivity.onConnectivityChanged.listen(_onConnectivityChanged); + _onConnectivityChanged(await _connectivity.checkConnectivity()); + + return true; + } + + @override + FutureOr dispose() async { + await super.dispose(); + WidgetsBinding.instance.removeObserver(this); + _onConnectivityChangedSubscription?.cancel(); + _onConnectivityChangedSubscription = null; + _streamController.close(); + } + + @override + Future didChangeAppLifecycleState(AppLifecycleState state) async { + if (state == AppLifecycleState.resumed) { + // When we move to the foreground, + // get the newest network information. + _onConnectivityChanged(await _connectivity.checkConnectivity()); + } + } + + @override + Widget createAppWidgetWrapper(Widget child) { + return StreamProvider( + create: (context) => informationStream, + initialData: information, + child: child, + ); + } + + void _onConnectivityChanged(ConnectivityResult event) { + NetworkConnectivity tConnectivity = switch (event) { + ConnectivityResult.none => NetworkConnectivity.none, + ConnectivityResult.other => NetworkConnectivity.other, + ConnectivityResult.mobile => NetworkConnectivity.mobile, + ConnectivityResult.wifi => NetworkConnectivity.wifi, + ConnectivityResult.ethernet => NetworkConnectivity.ethernet, + ConnectivityResult.bluetooth => NetworkConnectivity.bluetooth, + ConnectivityResult.vpn => NetworkConnectivity.vpn, + }; + + if (_currentNetworkInformation.connectivity == tConnectivity) { + return; + } + + _currentNetworkInformation = _currentNetworkInformation.copyWith( + connectivity: tConnectivity, + ); + + _streamController.add(_currentNetworkInformation); + } + + @override + @visibleForTesting + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + const MethodChannel('dev.fluttercommunity.plus/connectivity'), + (methodCall) async { + methodCallLogs.add(methodCall); + switch (methodCall.method) { + case 'check': + return testOnConnectivityChangedValue.name; + default: + break; + } + return null; + }, + ); + } + + StreamController? _mockStreamController; + Completer? _testChangeConnectivityCompleter; + + @override + @visibleForTesting + void setMockStreamHandler() { + _mockStreamController = StreamController(); + StreamSubscription? tMockStreamSubscription; + + // ignore: invalid_use_of_visible_for_testing_member + testSetMockStreamHandler( + const EventChannel('dev.fluttercommunity.plus/connectivity_status'), + TestMockStreamHandler.inline( + onListen: (data, sink) { + tMockStreamSubscription = _mockStreamController!.stream.listen((v) { + sink.success(v.name); + _testChangeConnectivityCompleter?.complete(); + _testChangeConnectivityCompleter = null; + }); + }, + onCancel: (_) { + tMockStreamSubscription?.cancel(); + _testChangeConnectivityCompleter?.complete(); + _testChangeConnectivityCompleter = null; + }, + ), + ); + } + + @visibleForTesting + Future testChangeConnectivity(NetworkConnectivity result) { + final tCompleter = _testChangeConnectivityCompleter = Completer(); + testOnConnectivityChangedValue = result; + _mockStreamController?.add(result); + + return tCompleter.future; + } +} + +@visibleForTesting +NetworkConnectivity testOnConnectivityChangedValue = NetworkConnectivity.none; diff --git a/packages/patapata_core/lib/src/notifications.dart b/packages/patapata_core/lib/src/notifications.dart new file mode 100644 index 0000000..71280ea --- /dev/null +++ b/packages/patapata_core/lib/src/notifications.dart @@ -0,0 +1,304 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'dart:convert'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_local_notifications/flutter_local_notifications.dart'; +import 'package:logging/logging.dart'; + +import 'app.dart'; +import 'plugin.dart'; +import 'util.dart'; +import 'exception.dart'; +import 'widgets/standard_app.dart'; + +final _logger = Logger('patapata.Notifications'); + +const _methodChannelName = 'dexterous.com/flutter/local_notifications'; +const _methodChannel = MethodChannel(_methodChannelName); + +/// This is a Mixin for adding variables related to notification settings +/// to the Environment. +/// +/// When initializing [FlutterLocalNotificationsPlugin] with [NotificationsPlugin.init] +/// you can override some settings with the Environment. +mixin NotificationsEnvironment { + String get notificationsAndroidDefaultIcon; + bool get notificationsDarwinDefaultPresentAlert; + bool get notificationsDarwinDefaultPresentSound; + bool get notificationsDarwinDefaultPresentBadge; + bool get notificationsDarwinDefaultPresentBanner; + bool get notificationsDarwinDefaultPresentList; + List get notificationsAndroidChannels; + String get notificationsPayloadLocationKey => 'location'; +} + +/// This is a plugin for performing local notifications. +/// +/// It includes the following features: +/// 1. Ability to initialize FlutterLocalNotificationsPlugin +/// separately for each operating system. +/// 2. Ability to reference the DeepLink included in the notification payload +/// and navigate to any desired screen. +class NotificationsPlugin extends Plugin with StandardAppRoutePluginMixin { + static const AndroidNotificationChannel kDefaultAndroidChannel = + AndroidNotificationChannel( + 'default', + 'Primary Channel', + importance: Importance.max, + enableLights: true, + ); + + // coverage:ignore-start + static void initializeNotificationsForBackgroundIsolate() { + try { + final tPlugin = FlutterLocalNotificationsPlugin(); + tPlugin.initialize( + const InitializationSettings( + android: AndroidInitializationSettings('@mipmap/ic_launcher'), + iOS: DarwinInitializationSettings( + requestAlertPermission: false, + requestBadgePermission: false, + requestSoundPermission: false, + requestCriticalPermission: false, + defaultPresentAlert: true, + defaultPresentSound: true, + defaultPresentBadge: true, + ), + macOS: DarwinInitializationSettings( + requestAlertPermission: false, + requestBadgePermission: false, + requestSoundPermission: false, + requestCriticalPermission: false, + defaultPresentAlert: true, + defaultPresentSound: true, + defaultPresentBadge: true, + ), + ), + ); + } catch (e, stackTrace) { + _logger.warning( + 'Failed to initialize isolate FlutterLocalNotificationsPlugin.', + NotificationsInitializationException(original: e), + stackTrace, + ); + } + } + // coverage:ignore-end + + @override + FutureOr init(App app) async { + if (!await super.init(app)) { + return false; + } + + final tEnvironment = app.environment is NotificationsEnvironment + ? app.environment as NotificationsEnvironment + : null; + + try { + final tPlugin = FlutterLocalNotificationsPlugin(); + tPlugin.initialize( + InitializationSettings( + android: AndroidInitializationSettings( + tEnvironment?.notificationsAndroidDefaultIcon ?? + '@mipmap/ic_launcher'), + iOS: DarwinInitializationSettings( + requestAlertPermission: false, + requestBadgePermission: false, + requestSoundPermission: false, + requestCriticalPermission: false, + requestProvisionalPermission: false, + defaultPresentAlert: + tEnvironment?.notificationsDarwinDefaultPresentAlert ?? true, + defaultPresentSound: + tEnvironment?.notificationsDarwinDefaultPresentSound ?? true, + defaultPresentBadge: + tEnvironment?.notificationsDarwinDefaultPresentBadge ?? true, + defaultPresentBanner: + tEnvironment?.notificationsDarwinDefaultPresentBanner ?? true, + defaultPresentList: + tEnvironment?.notificationsDarwinDefaultPresentList ?? true, + ), + macOS: DarwinInitializationSettings( + requestAlertPermission: false, + requestBadgePermission: false, + requestSoundPermission: false, + requestCriticalPermission: false, + requestProvisionalPermission: false, + defaultPresentAlert: + tEnvironment?.notificationsDarwinDefaultPresentAlert ?? true, + defaultPresentSound: + tEnvironment?.notificationsDarwinDefaultPresentSound ?? true, + defaultPresentBadge: + tEnvironment?.notificationsDarwinDefaultPresentBadge ?? true, + defaultPresentBanner: + tEnvironment?.notificationsDarwinDefaultPresentBanner ?? true, + defaultPresentList: + tEnvironment?.notificationsDarwinDefaultPresentList ?? true, + ), + ), + onDidReceiveNotificationResponse: _onDidReceiveNotificationResponse, + ); + + if (defaultTargetPlatform == TargetPlatform.android) { + final tPlatform = tPlugin.resolvePlatformSpecificImplementation< + AndroidFlutterLocalNotificationsPlugin>()!; + + if (tEnvironment != null) { + for (var i in tEnvironment.notificationsAndroidChannels) { + await tPlatform.createNotificationChannel(i); + } + } else { + await tPlatform.createNotificationChannel(kDefaultAndroidChannel); + } + } + } catch (e, stackTrace) { + // coverage:ignore-start + _logger.warning( + 'Failed to initialize FlutterLocalNotificationsPlugin.', + NotificationsInitializationException(original: e), + stackTrace, + ); + // coverage:ignore-end + } + + return true; + } + + @override + FutureOr dispose() { + _streamController.close(); + + return super.dispose(); + } + + final _streamController = StreamController.broadcast(); + Stream get notifications => _streamController.stream; + + void _onDidReceiveNotificationResponse(NotificationResponse response) { + _logger.info('received notification: $response'); + _streamController.add(response); + } + + String get payloadLocationKey => app.environment is NotificationsEnvironment + ? (app.environment as NotificationsEnvironment) + .notificationsPayloadLocationKey + : 'location'; + + Uri? uriFromPayload(String? payload) { + if (payload?.isNotEmpty != true) { + return null; + } + + try { + final tAsUrl = Uri.tryParse(payload!); + + if (tAsUrl != null) { + return tAsUrl; + } + + final tJsonData = jsonDecode(payload) as Map; + + if (tJsonData.containsKey(payloadLocationKey)) { + return Uri.parse(tJsonData[payloadLocationKey] as String); + } + } catch (e) { + // ignore + } + + return null; + } + + @override + Future getInitialRouteData() async { + final tLaunchNotification = await FlutterLocalNotificationsPlugin() + .getNotificationAppLaunchDetails(); + + if (tLaunchNotification?.notificationResponse != null) { + if (tLaunchNotification!.didNotificationLaunchApp) { + final tPayload = + uriFromPayload(tLaunchNotification.notificationResponse!.payload); + + if (tPayload != null) { + final tRouteData = await app + .getPlugin() + ?.parser + ?.parseRouteInformation(RouteInformation(uri: tPayload)); + + if (tRouteData?.factory != null) { + return tRouteData; + } + } + } + } + + return null; + } + + /// This is a function to enable screen navigation via Deep Link + /// included in the notification payload. + /// + /// To enable this functionality, you need to call this function + /// after creating the [App] instance. + /// For example: + /// ```dart + /// void main() async { + /// final App tApp = App( + /// environment: ..., + /// createAppWidget: ..., + /// ); + /// + /// tApp.getPlugin()?.enableStandardAppIntegration(); + /// + /// tApp.run(); + /// } + /// ``` + void enableStandardAppIntegration() { + notifications.listen((event) { + if (event.payload?.isNotEmpty == true) { + app.getPlugin()?.route(event.payload!); + } + }); + } + + @visibleForTesting + void mockRecieveNotificationResponse(NotificationResponse response) { + _onDidReceiveNotificationResponse(response); + } + + @override + @visibleForTesting + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + _methodChannel, + (methodCall) async { + methodCallLogs.add(methodCall); + switch (methodCall.method) { + case 'initialize': + return true; + case 'getNotificationAppLaunchDetails': + return notificationAppLaunchDetailsMap; + } + return null; + }, + ); + } +} + +@visibleForTesting +Map? notificationAppLaunchDetailsMap; + +/// Throw when exception if an error occurs in initializing [NotificationsPlugin]. +class NotificationsInitializationException extends PatapataCoreException { + const NotificationsInitializationException({ + super.original, + }) : super(code: PatapataCoreExceptionCode.PPE501); +} diff --git a/packages/patapata_core/lib/src/package_info.dart b/packages/patapata_core/lib/src/package_info.dart new file mode 100644 index 0000000..d6933ac --- /dev/null +++ b/packages/patapata_core/lib/src/package_info.dart @@ -0,0 +1,83 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter/material.dart'; +import 'package:provider/provider.dart'; +import 'package:package_info_plus/package_info_plus.dart'; +import 'plugin.dart'; +import 'app.dart'; + +class _MockValues { + static String appName = 'mock_patapata_core'; + static String packageName = 'io.flutter.plugins.mockpatapatacore'; + static String version = '1.0'; + static String buildNumber = '1'; + static String buildSignature = 'patapata_core_build_signature'; + static String? installerStore; +} + +/// Plugin that manages information related to the application's metadata. +/// +/// This plugin calls [PackageInfo.fromPlatform] during initialization, +/// allowing subsequent synchronous access from the application or other plugins. +/// +/// This plugin is automatically created during application initialization +/// and can be accessed from [App.package]. +class PackageInfoPlugin extends Plugin { + late final PackageInfo _info; + + /// Access to information about this application's metadata. + PackageInfo get info => _info; + + /// Mocks [info] for testing purposes. + @visibleForTesting + static void setMockValues({ + required String appName, + required String packageName, + required String version, + required String buildNumber, + required String buildSignature, + String? installerStore, + }) { + _MockValues.appName = appName; + _MockValues.packageName = packageName; + _MockValues.version = version; + _MockValues.buildNumber = buildNumber; + _MockValues.buildSignature = buildSignature; + _MockValues.installerStore = installerStore; + } + + @override + FutureOr init(App app) async { + await super.init(app); + + _info = await PackageInfo.fromPlatform(); + + return true; + } + + @override + Widget createAppWidgetWrapper(Widget child) { + return Provider.value( + value: this, + child: child, + ); + } + + @override + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + PackageInfo.setMockInitialValues( + appName: _MockValues.appName, + packageName: _MockValues.packageName, + version: _MockValues.version, + buildNumber: _MockValues.buildNumber, + buildSignature: _MockValues.buildSignature, + installerStore: _MockValues.installerStore, + ); + } +} diff --git a/packages/patapata_core/lib/src/permissions.dart b/packages/patapata_core/lib/src/permissions.dart new file mode 100644 index 0000000..6ca2ffd --- /dev/null +++ b/packages/patapata_core/lib/src/permissions.dart @@ -0,0 +1,245 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_local_notifications/flutter_local_notifications.dart'; +import 'package:logging/logging.dart'; +import 'package:patapata_core/src/method_channel_test_mixin.dart'; +import 'package:patapata_core/src/util.dart'; + +import 'app.dart'; + +const _methodChannel = MethodChannel('dev.patapata.patapata_core'); + +final _logger = Logger('patapata.Permissions'); + +/// Result of [Permissions.requestTracking]. +enum PermissionTrackingResult { + notSupported, + authorized, + denied, + notDetermined, + restricted, +} + +/// Result of [Permissions.requestNotifications]. +enum PermissionNotificationResult { + authorized, + denied, + notDetermined, +} + +const _kLocalConfigTrackingRequested = 'patapata.Permissions:trackingRequested'; +const _kLocalConfigNotificationsRequested = + 'patapata.Permissions:notificationsRequested'; + +/// Requests permissions from the platform (Android, iOS). +/// +/// This class is automatically created at application initialization +/// and can be accessed from [App.permissions]. +class Permissions with MethodChannelTestMixin { + /// The [App] passed in the constructor. + final App app; + + Permissions({ + required this.app, + }); + + final _trackingStreamController = + StreamController.broadcast(); + final _notificationsStreamController = + StreamController.broadcast(); + + /// Returns a Stream to observe the results of [requestTracking]. + Stream get trackingStream => + _trackingStreamController.stream; + + /// Returns a Stream to observe the results of [requestNotifications]. + Stream get notificationsStream => + _notificationsStreamController.stream; + + /// If true, tracking permissions have already been requested. + bool get trackingRequested => defaultTargetPlatform != TargetPlatform.iOS + ? true + : app.localConfig.getBool(_kLocalConfigTrackingRequested); + + /// If true, notification permissions have already been requested. + bool get notificationsRequested => + app.localConfig.getBool(_kLocalConfigNotificationsRequested); + + // The values ​​of Permissions:requestTracking reflected during testing + PermissionTrackingResult? _mockPermissionTrackingResult; + + // The values ​​of requestPermission and requestPermissions reflected during testing + bool? _mockLocalNotificationsPermission; + + /// Releases each resource. + void dispose() { + _trackingStreamController.close(); + _notificationsStreamController.close(); + } + + @override + @visibleForTesting + void setMockMethodCallHandler() { + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + _methodChannel, + (methodCall) async { + switch (methodCall.method) { + case 'Permissions:requestTracking': + return _mockPermissionTrackingResult?.name; + } + return null; + }, + ); + + // ignore: invalid_use_of_visible_for_testing_member + testSetMockMethodCallHandler( + const MethodChannel('dexterous.com/flutter/local_notifications'), + (methodCall) async { + switch (methodCall.method) { + case 'requestPermission': + return _mockLocalNotificationsPermission; + case 'requestPermissions': + return _mockLocalNotificationsPermission; + } + return null; + }, + ); + } + + /// Mocks [trackingRequested] and [notificationsRequested] for testing purposes. + @visibleForTesting + void testSetRequested({ + bool? trackingRequested, + bool? notificationsRequested, + }) { + app.localConfig.setBool( + _kLocalConfigTrackingRequested, + trackingRequested ?? this.trackingRequested, + ); + + app.localConfig.setBool( + _kLocalConfigNotificationsRequested, + notificationsRequested ?? this.notificationsRequested, + ); + } + + // Mocks return values ​​of Permissions:requestTracking for testing purposes. + @visibleForTesting + void testSetPermissionTrackingResult(PermissionTrackingResult? result) { + _mockPermissionTrackingResult = result; + } + + // Mocks return values ​​of requestPermission and requestPermissions for testing purposes. + @visibleForTesting + void testSetLocalNotificationsPermission(bool? result) { + _mockLocalNotificationsPermission = result; + } + + /// Requests tracking permissions. + /// + /// For iOS, please add `NSUserTrackingUsageDescription` + /// to the application's `Info.plist`. + Future requestTracking() async { + _logger.info('requestTracking'); + + PermissionTrackingResult tTrackingResult = + PermissionTrackingResult.notSupported; + + if (defaultTargetPlatform != TargetPlatform.iOS) { + return tTrackingResult; + } + + await app.localConfig.setBool(_kLocalConfigTrackingRequested, true); + + try { + final tResult = await _methodChannel + .invokeMethod('Permissions:requestTracking'); + + if (tResult == null) { + tTrackingResult = PermissionTrackingResult.notSupported; + } else { + tTrackingResult = PermissionTrackingResult.values + .firstWhere((element) => element.name == tResult); + } + // coverage:ignore-start + } catch (e, stackTrace) { + _logger.warning('requestTracking failed', e, stackTrace); + } + // coverage:ignore-end + + _trackingStreamController.add(tTrackingResult); + + return tTrackingResult; + } + + /// Requests notification permissions. + Future requestNotifications({ + bool sound = false, + bool alert = false, + bool badge = false, + bool critical = false, + }) async { + _logger.info('requestNotifications'); + PermissionNotificationResult tNotificationResult = + PermissionNotificationResult.notDetermined; + + await app.localConfig.setBool(_kLocalConfigNotificationsRequested, true); + + try { + if (kIsWeb) { + return tNotificationResult; + } + + if (defaultTargetPlatform == TargetPlatform.android) { + final tPlatform = FlutterLocalNotificationsPlugin() + .resolvePlatformSpecificImplementation< + AndroidFlutterLocalNotificationsPlugin>()!; + tNotificationResult = (await tPlatform.requestPermission() ?? true) + ? PermissionNotificationResult.authorized + : PermissionNotificationResult.denied; + } else if (defaultTargetPlatform == TargetPlatform.iOS) { + final tPlatform = FlutterLocalNotificationsPlugin() + .resolvePlatformSpecificImplementation< + IOSFlutterLocalNotificationsPlugin>()!; + tNotificationResult = (await tPlatform.requestPermissions( + sound: sound, + alert: alert, + badge: badge, + critical: critical, + ) ?? + false) + ? PermissionNotificationResult.authorized + : PermissionNotificationResult.denied; + } else if (defaultTargetPlatform == TargetPlatform.macOS) { + final tPlatform = FlutterLocalNotificationsPlugin() + .resolvePlatformSpecificImplementation< + MacOSFlutterLocalNotificationsPlugin>()!; + tNotificationResult = (await tPlatform.requestPermissions( + sound: sound, + alert: alert, + badge: badge, + critical: critical, + ) ?? + false) + ? PermissionNotificationResult.authorized + : PermissionNotificationResult.denied; + } + // coverage:ignore-start + } catch (e, stackTrace) { + _logger.warning('requestNotifications failed', e, stackTrace); + } + // coverage:ignore-end + + _notificationsStreamController.add(tNotificationResult); + + return tNotificationResult; + } +} diff --git a/packages/patapata_core/lib/src/plugin.dart b/packages/patapata_core/lib/src/plugin.dart new file mode 100644 index 0000000..ea6194f --- /dev/null +++ b/packages/patapata_core/lib/src/plugin.dart @@ -0,0 +1,257 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/src/method_channel_test_mixin.dart'; + +import 'local_config.dart'; +import 'remote_config.dart'; +import 'remote_messaging.dart'; +import 'app.dart'; + +/// You can inherit from this class to create your own extensions for Patapata. +abstract class Plugin with MethodChannelTestMixin { + late final App _app; + + bool _initialized = false; + bool _disposed = false; + + Plugin(); + + /// Create a [Plugin] that can be used in [App]. + /// If you want to implement a [Plugin] that you can pass directly + /// to [App.plugins], you can use this constructor without having to + /// create your own class. + factory Plugin.inline({ + String name = 'inline', + List dependencies = const [], + bool requireRemoteConfig = false, + FutureOr Function(App app)? init, + FutureOr Function()? dispose, + Widget Function(Widget child)? createAppWidgetWrapper, + RemoteConfig? Function()? createRemoteConfig, + LocalConfig? Function()? createLocalConfig, + RemoteMessaging? Function()? createRemoteMessaging, + List Function()? navigatorObservers, + }) => + InlinePlugin( + name: name, + dependencies: dependencies, + requireRemoteConfig: requireRemoteConfig, + init: init, + dispose: dispose, + createAppWidgetWrapper: createAppWidgetWrapper, + createRemoteConfig: createRemoteConfig, + createLocalConfig: createLocalConfig, + createRemoteMessaging: createRemoteMessaging, + navigatorObservers: navigatorObservers, + ); + + /// The unique name of this [Plugin]. + /// This property is referenced in various situations, such as when enabling or disabling the plugin, + /// and when enabling or disabling the mock, and when communicating with Native code. + String get name => runtimeType.toString(); + + /// The list of other plugins that this plugin depends on. + /// This property should be used to add the types of other plugins that are required for this [Plugin] to work. + /// For example, when using the FirebaseAnalyticsPlugin, you need to include FirebaseCorePlugin. + @protected + List get dependencies => const []; + + /// This property determines whether initialization should occur after the RemoteConfig system has started when set to true, + /// or before it starts when set to false. + bool get requireRemoteConfig => false; + + /// Get the RemoteConfig key name to enable or disable this plugin. + String get remoteConfigEnabledKey => + 'patapata_plugin_${name.replaceAll(RegExp(r'[^a-zA-Z0-9_]'), '_')}_enabled'; + + /// The [App] referenced by the plugin. + @protected + App get app => _app; + + /// Whether this [Plugin] is initialized or not. + @nonVirtual + bool get initialized => _initialized; + + /// Get whether this [Plugin] has been disposed. + @nonVirtual + bool get disposed => _disposed; + + /// Executed when a [PatapataApp] [run]s or when a this [Plugin] is + /// added to the [PatapataApp] after [run]. + /// This may return a [Future] for asynchronous initialization. + /// Always call [super.init] before any other overridden code. + /// + /// If any of the callbacks fail for any reason, + /// the [App] will not continue to execute callbacks + /// and will execute the [onInitFailure] callback if given. + /// Otherwise, it will silently die. (Not do anything) + @mustCallSuper + FutureOr init(App app) async { + if (_initialized) { + throw StateError('$name is already initialized.'); + } + + if (!dependencies.every((t) => app.hasPlugin(t))) { + throw StateError('$name does not have all dependencies satisfied.'); + } + + if (kIsTest) { + setMockMethodCallHandler(); + setMockStreamHandler(); + } + + _app = app; + _initialized = true; + + return true; + } + + /// Disposes this [Plugin]. + /// Always call [super.dispose] before any other overridden code. + /// In general you should not call this method as [App] will do that for you. + @mustCallSuper + FutureOr dispose() async { + if (_disposed) { + throw StateError('$name is already disposed of.'); + } + + _disposed = true; + } + + /// Wraps the [Widget] that will ultimately be passed to Flutter's [runApp] function. + /// This is used when the plugin needs to wrap [App.createAppWidget] to add widgets to the [App]'s widget tree. + Widget createAppWidgetWrapper(Widget child) => child; + + /// Specify the [RemoteConfig] to register with Patapata for this plugin. + RemoteConfig? createRemoteConfig() => null; + + /// Specify the [LocalConfig] to register with Patapata for this plugin. + LocalConfig? createLocalConfig() => null; + + /// Specify the [RemoteMessaging] to register with Patapata for this plugin. + RemoteMessaging? createRemoteMessaging() => null; + + /// Get the list of [NavigatorObserver]s to pass to Patapata for this plugin. + /// This Observers list will ultimately be added to the [App.navigatorObservers] list. + List get navigatorObservers => const []; + + /// This is a function to mock patapataEnable running in native code. + /// It will only be called when [kIsTest] is true. + @visibleForTesting + void mockPatapataEnable() {} + + /// This is a function to mock patapataDisable running in native code. + /// It will only be called when [kIsTest] is true. + @visibleForTesting + void mockPatapataDisable() {} +} + +/// A [Plugin] that can define all methods in the constructor. +class InlinePlugin extends Plugin { + @override + final String name; + @override + final List dependencies; + @override + final bool requireRemoteConfig; + final FutureOr Function(App app)? _init; + final FutureOr Function()? _dispose; + final Widget Function(Widget child)? _createAppWidgetWrapper; + final RemoteConfig? Function()? _createRemoteConfig; + final LocalConfig? Function()? _createLocalConfig; + final RemoteMessaging? Function()? _createRemoteMessaging; + final List Function()? _navigatorObservers; + + /// Creates a [Plugin] that can define all methods in the constructor. + /// See [Plugin]'s various methods for details on each method. + InlinePlugin({ + required this.name, + this.dependencies = const [], + this.requireRemoteConfig = false, + FutureOr Function(App app)? init, + FutureOr Function()? dispose, + Widget Function(Widget child)? createAppWidgetWrapper, + RemoteConfig? Function()? createRemoteConfig, + LocalConfig? Function()? createLocalConfig, + RemoteMessaging? Function()? createRemoteMessaging, + List Function()? navigatorObservers, + }) : _init = init, + _dispose = dispose, + _createAppWidgetWrapper = createAppWidgetWrapper, + _createRemoteConfig = createRemoteConfig, + _createLocalConfig = createLocalConfig, + _createRemoteMessaging = createRemoteMessaging, + _navigatorObservers = navigatorObservers; + + @override + FutureOr init(App app) async { + if (_init != null) { + if (!await _init!(app)) { + return false; + } + } + + return super.init(app); + } + + @override + FutureOr dispose() async { + if (_dispose != null) { + await _dispose!(); + } + + return super.dispose(); + } + + @override + Widget createAppWidgetWrapper(Widget child) { + if (_createAppWidgetWrapper != null) { + return _createAppWidgetWrapper!(child); + } + + return super.createAppWidgetWrapper(child); + } + + @override + RemoteConfig? createRemoteConfig() { + if (_createRemoteConfig != null) { + return _createRemoteConfig!(); + } + + return super.createRemoteConfig(); + } + + @override + LocalConfig? createLocalConfig() { + if (_createLocalConfig != null) { + return _createLocalConfig!(); + } + + return super.createLocalConfig(); + } + + @override + RemoteMessaging? createRemoteMessaging() { + if (_createRemoteMessaging != null) { + return _createRemoteMessaging!(); + } + + return super.createRemoteMessaging(); + } + + @override + List get navigatorObservers { + if (_navigatorObservers != null) { + return _navigatorObservers!(); + } + + return super.navigatorObservers; + } +} diff --git a/packages/patapata_core/lib/src/provider_model.dart b/packages/patapata_core/lib/src/provider_model.dart new file mode 100644 index 0000000..25b19dc --- /dev/null +++ b/packages/patapata_core/lib/src/provider_model.dart @@ -0,0 +1,672 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +import 'exception.dart'; +import 'sequential_work_queue.dart'; + +typedef ProviderModelProcess = FutureOr Function( + ProviderModelBatch batch); + +class _DebugDynamicType { + const _DebugDynamicType(); + + Type get type => T; +} + +/// A variable that can be used in batches and automatically +/// detect changes as to notify listeners when it's +/// value changes. +/// The variable can be 'set' or 'unset' depending on whether +/// it's value has been set or not. +/// If it's value has not been set and it is accessed, an +/// assertion will be thrown. +class ProviderModelVariable with ChangeNotifier { + T? _value; + final ProviderModel _parent; + bool _set; + final bool _nullable; + + /// Whether this variable has been set or not. + bool get set => _set; + + ProviderModelVariable._internalCreate( + this._parent, + this._value, + this._set, + ) : _nullable = null is T; + + @override + String toString() { + return '$T:${set ? unsafeValue : 'NOT SET'}'; + } + + /// The type of this variable. Runtime access to [T]. + Type get type => T; + + /// The value of this variable. If [set] is false, an assertion will be thrown. + /// Usually you should use [getValue] instead of this. + /// + /// Access to this variable via this function may not provide the newest value if it is accessed while a batch is ongoing. + /// This is why it is named 'unsafe' as a reminder to use [getValue] instead or provide getters to access this in safe situations. + T get unsafeValue { + assert(set, 'ProviderModelVariable of type $T was used before it was set.'); + + final tSubscription = Zone.current[#providerModelUseSubscription]; + + if (tSubscription != null) { + (tSubscription as ProviderModelUseSubscription)._variables.add(this); + } + + if (_nullable) { + return _value as T; + } else { + return _value!; + } + } + + bool _setValue(T newValue, [bool notify = true]) { + final tPreviousSet = _set; + _set = true; + + if (_value == newValue) { + if (notify && _set != tPreviousSet) { + notifyListeners(); + + return true; + } + + return false; + } + + _value = newValue; + + if (notify) { + notifyListeners(); + } + + return true; + } + + /// Get the current value of this variable. + /// This will wait until all currently queued batches + /// have completed before returning the value. + /// + /// You cannot call this from inside a [ProviderModel.lock] callback. + Future getValue() async { + if (_parent._lockQueues == null) { + return unsafeValue; + } + + assert( + _parent._lockQueues?.values.every((e) => e.insideSequentialWorkQueue) != + true, + 'getValue() cannot be called inside a lock() callback', + ); + + while (true) { + if (_parent.disposed) { + return unsafeValue; + } + + final tQueuesToWaitFor = + _parent._lockQueues!.values.where((e) => e.isNotEmpty); + + if (tQueuesToWaitFor.isEmpty) { + return unsafeValue; + } + + // Wait until all queues have been finished. + await Future.wait([ + for (var i in tQueuesToWaitFor) i.add(() => null), + ]); + + // But now, after waiting once, there might still be + // more things added to the queues again. + // So we loop back and check all over again. + } + } +} + +/// A batch of changes to a [ProviderModel]. +/// Changes made to [ProviderModelVariable]s will not be reflected until [commit] is called. +/// +/// If [cancel] is called, all changes made to [ProviderModelVariable]s will be discarded. +/// +/// If [commit] is called, all changes made to [ProviderModelVariable]s will be applied, +/// and [notifyListeners] will be called for anyone listening to +/// the [ProviderModel] or any [ProviderModelVariable]s. +/// +/// A batch can be created by calling [ProviderModel.begin] or [ProviderModel.lock]. +class ProviderModelBatch { + ProviderModelBatch._internalCreate(this._model); + + final ProviderModel _model; + final _reserves = {}; + + var _valid = true; + var _completed = false; + var _disabled = false; + + /// Whether this batch is valid or not. + /// A batch is valid from the time it is created forever unless [cancel] is called + /// or the batch was disabled by overridding or other means. + bool get valid => _valid && !_model.disposed; + + /// Whether this batch is complete or not. + /// A batch is completed once [commit] or [cancel] is called. + bool get completed => _completed; + + /// Set the value of a [ProviderModelVariable] in this batch. + /// All subsequent calls to [get] will return [value] instead + /// of the [ProviderModelVariable.unsafeValue] of the variable. + void set(ProviderModelVariable container, T value) { + _reserves[container] = value; + } + + /// Whether a [ProviderModelVariable] has been set itself or in this batch. + bool isSet(ProviderModelVariable container) => + _reserves.containsKey(container) || container.set; + + /// Get the value of a [ProviderModelVariable] in this batch. + /// If the value has not been set in this batch, the actual value of the variable + /// will be returned via [ProviderModelVariable.unsafeValue]. + T get(ProviderModelVariable container) => + _reserves.containsKey(container) + ? _reserves[container] + : container.unsafeValue; + + /// Disable this batch. + /// This is only called externally by [ProviderModel.lock]. + void _disable() { + _valid = false; + _disabled = true; + } + + /// Cancel this batch. + /// Once cancelled, all changes made to [ProviderModelVariable]s will be discarded. + /// + /// Any further calls to [commit], or [cancel] will be ignored. + void cancel() { + if (_completed) { + return; + } + + _valid = false; + _completed = true; + _reserves.clear(); + _model._onBatchComplete(false, false, false); + } + + /// Commit this batch. + /// Once committed, all changes made to [ProviderModelVariable]s will be applied. + /// + /// Any further calls to [commit], or [cancel] will be ignored. + /// + /// If [notify] is null (the default), [notifyListeners] will be called on the [ProviderModel] + /// as well as any [ProviderModelVariable]s whose value changed in this batch. + /// + /// If [notify] is true, [notifyListeners] will be called on the [ProviderModel] + /// as well as all [ProviderModelVariable]s in this batch. + /// + /// If [notify] is false, [notifyListeners] will not be called on the [ProviderModel] nor any [ProviderModelVariable]s. + void commit({ + bool? notify, + }) { + if (_completed) { + return; + } + + _completed = true; + + var tChanged = false; + + if (!_disabled && !_model.disposed) { + for (var i in _reserves.entries) { + tChanged = i.key._setValue(i.value, notify != false) || tChanged; + } + } + + _reserves.clear(); + _model._onBatchComplete(!_disabled, tChanged, !_disabled ? notify : false); + } + + /// Prevent execution of [f] to be overridden and cancelled by a [ProviderModel.lock] call. + /// + /// This is useful when you want to execute a function that executes an + /// external API that doesn't support it's Zone's code all of the sudden being stopped. + /// + /// In general, you should use this when calling network-based or database-based APIs. + Future blockOverride(FutureOr Function() f) async { + final tResult = await runZoned(f); + + // When the lock is overridden, this scheduled microtask will stop execution in our custom Zone. + await Future.microtask(() => null); + + return tResult; + } +} + +/// Use an instance of this class to pass in to [ProviderModel.lock] and [ProviderModel.begin]. +class ProviderLockKey { + ProviderLockKey(this.name, {this.conflictReason}); + + final String name; + final String? conflictReason; +} + +/// Thrown when [ProviderModel.begin] is called while a lock is already in place. +class ConflictException extends PatapataCoreException { + const ConflictException(this.key, this.from) + : super(code: PatapataCoreExceptionCode.PPE201); + + /// The [ProviderLockKey] that was being used when this exception was thrown. + final ProviderLockKey key; + + /// The [ProviderModel] that threw this exception. + final ProviderModel from; + + @override + String toString() { + final tReason = key.conflictReason; + + if (tReason == null) { + return 'ConflictException: ${from.runtimeType}(${key.name}#${key.hashCode}), Reason: Another batch was attempted to be created but lock() was called and commit() or cancel() have not been yet.'; + } + + return 'ConflictException: ${from.runtimeType}(${key.name}#${key.hashCode}), Reason: $tReason'; + } +} + +/// [ProviderModel] is an abstract class that can be extended to create a model for state management +/// and safe logic flow for your application. +/// It uses the [ChangeNotifier] mixin to notify its listeners when changes occur, and therefore +/// can be used with [Provider] via [ChangeNotifierProvider], and anything that can work with [ChangeNotifier] or [Listenable]. +/// +/// It provides methods for creating and managing variables ([ProviderModelVariable]), +/// [lock]ing the model for safe modifications, and subscribing to changes via [addListener] or [use]. +/// +/// The generic parameter [T] should be the type of the class that extends [ProviderModel]. +/// +/// Example usage: +/// ```dart +/// class MyClass extends ProviderModel { +/// late final _myVariable = createVariable(0); +/// +/// int get myVariable => _myVariable.unsafeValue; +/// +/// void increment() { +/// // This will increment _myVariable by 1. +/// // If this function is called multiple times at the same time, +/// // the value will be incremented 1 by 1 sequentially. +/// lock((batch) async { +/// // Do some long running API call. +/// await longApiCall(); +/// batch.set(_myVariable, batch.get(_myVariable) + 1); +/// batch.commit(); +/// }); +/// } +/// } +/// +/// // Some build function of some widget with MyClass being provided +/// // via ChangeNotifierProvider. +/// Widget build(BuildContext context) { +/// final tValue = context.watch().myVariable; +/// +/// return TextButton( +/// onPressed: () { +/// context.read().increment(); +/// }, +/// child: Text('$tValue'), +/// ); +/// } +/// ``` +abstract class ProviderModel with ChangeNotifier { + final ProviderLockKey _defaultLockKey = ProviderLockKey('BatchLockKey'); + + Map? _lockQueues; + final _variables = []; + List>? _useSubscriptions; + + bool _disposed = false; + + /// Whether this [ProviderModel] has been disposed or not. + bool get disposed => _disposed; + + bool? _debugValidType; + + /// Dipose this [ProviderModel]. + /// This will call [dispose] on all [ProviderModelVariable]s created by this [ProviderModel]. + /// This will also cancel all [ProviderModelUseSubscription]s created by this [ProviderModel]. + /// + /// This will also cancel all locks created by this [ProviderModel] asynchronously but as fast as possible. + /// If someone tries to use this model after this point inside a batch, it will throw an exception for new operations + /// and cleanly fail for existing operations by returning false from things like [lock]. + @override + @mustCallSuper + void dispose() { + assert(!_disposed, 'ProviderModel was already disposed.'); + + _disposed = true; + + for (var i in _variables) { + i.dispose(); + } + + final tUseSubscriptions = _useSubscriptions; + + if (tUseSubscriptions != null) { + for (var i in tUseSubscriptions.toList(growable: false)) { + i.cancel(); + } + + _useSubscriptions = null; + } + + super.dispose(); + + // This has no guaruntee to synchronously cancel all locks. + // Therefore we execute this at the end. + // If someone tries to use this model after this point inside a batch, it will throw an exception. + if (_lockQueues != null) { + for (var i in _lockQueues!.values) { + i.clear(); + } + + _lockQueues = null; + } + } + + /// Whether this [ProviderModel] is locked with [lockKey] or not. + bool locked(ProviderLockKey lockKey) { + if (_lockQueues == null) { + return false; + } + + return _lockQueues![lockKey]?.isNotEmpty == true; + } + + /// Create a [ProviderModelVariable] belonging to this [ProviderModel] + /// that can be used in batches and automatically + /// detect changes to notify listeners when it's + /// value changes. + /// + /// [initial] is the initial value that this variable will be set to. + /// + /// Use this function as the value of a late final variable + /// in your class. + /// + /// ```dart + /// class MyClass extends ProviderModel { + /// late final myVariable = createVariable(0); + /// } + /// ``` + @nonVirtual + @protected + ProviderModelVariable createVariable(U initial) { + assert( + _debugValidType ??= T != const _DebugDynamicType().type, + 'ProviderModel\'s T type parameter must be the same as the class that extends it. Currrently it is dynamic or unset.', + ); + + final tContainer = ProviderModelVariable._internalCreate( + this, + initial, + true, + ); + + _variables.add(tContainer); + + return tContainer; + } + + /// Creates an unset [ProviderModelVariable] belonging to this [ProviderModel] + /// that can be used in batches and automatically + /// detect changes to notify listeners when it's + /// value changes. + /// + /// When a variable is 'unset', it's value cannot be accessed + /// until it is set via a [ProviderModelBatch.set] and [ProviderModelBatch.commit] + /// or an assertion with be thrown. + /// + /// Example: + /// ```dart + /// class MyClass extends ProviderModel { + /// late final myVariable = createUnsetVariable(); + /// } + /// + /// final model = MyClass(); + /// + /// model.myVariable.unsafeValue; // assertion error + /// + /// model.begin() + /// ..set(model.myVariable, 3) + /// ..commit(); + /// + /// model.myVariable.unsafeValue; // 3 + /// ``` + @nonVirtual + @protected + ProviderModelVariable createUnsetVariable() { + assert( + _debugValidType ??= T != const _DebugDynamicType().type, + 'ProviderModel\'s T type parameter must be the same as the class that extends it. Currrently it is dynamic or unset.', + ); + + final tContainer = ProviderModelVariable._internalCreate( + this, + null, + false, + ); + + _variables.add(tContainer); + + return tContainer; + } + + void _onBatchComplete(bool committed, bool variablesChanged, bool? notify) { + if (disposed) { + return; + } + + if (committed && notify != false) { + if (variablesChanged || notify == true) { + notifyListeners(); + } + } + } + + /// Create a batch to safely modify this [ProviderModel]'s [ProviderModelVariable] members. + /// + /// A [lockKey] can be passed to prevent multiple batches from being created at the same time + /// with the same [lockKey]. + /// If a batch is already in progress with the same [lockKey], a [ConflictException] will be thrown. + /// Every [ProviderModel] has a default [ProviderLockKey] that this function will default to + /// if [lockKey] is not set. + @nonVirtual + ProviderModelBatch begin([ProviderLockKey? lockKey]) { + assert(!_disposed, 'ProviderModel was already disposed.'); + assert( + Zone.current[#providerModelUseSubscription] == null, + 'begin() cannot be called while a use callback is being executed.', + ); + + lockKey ??= _defaultLockKey; + + if (locked(lockKey)) { + throw ConflictException(lockKey, this); + } + + return ProviderModelBatch._internalCreate(this); + } + + /// Queue up to lock this [ProviderModel] to safely modify it's [ProviderModelVariable] members. + /// The [process] passed here is guarunteed to be executed sequentially and non-parallel to other proccesses passed to [lock]. + /// + /// If [override] is true, all previously queued [lock] calls with [overridable] or [onOverride] set will be cancelled. + /// If not started yet, it will be skipped, if started, it will stop execution on the next asynchronous tick. + /// When cancelled, no notifications will be sent even if [ProviderModelBatch.commit] is executed. + /// if [override] is false, process won't be called until all previous [lock]s have been completed. + /// + /// Returns a bool signifying whether execution of [process] completed without erroring, overriding, or cancelling. + /// + /// A [lockKey] can be passed to prevent multiple batches from being created at the same time + /// with the same [lockKey]. + /// Every [ProviderModel] has a default [ProviderLockKey] that this function will default to + /// if [lockKey] is not set. + @nonVirtual + Future lock( + ProviderModelProcess process, { + ProviderLockKey? lockKey, + bool override = false, + bool overridable = false, + FutureOr Function()? onOverride, + }) async { + assert(!_disposed, 'ProviderModel was already disposed.'); + assert( + Zone.current[#providerModelUseSubscription] == null, + 'lock() cannot be called while a use callback is being executed.', + ); + + lockKey ??= _defaultLockKey; + _lockQueues ??= {}; + + final tQueue = + _lockQueues!.putIfAbsent(lockKey, () => SequentialWorkQueue()); + + if (override) { + tQueue.clear(); + } + + final tBatch = ProviderModelBatch._internalCreate(this); + + return await tQueue.add( + () async { + await process(tBatch); + + return tBatch.valid && !disposed; + }, + () async { + if (onOverride != null) { + tBatch._disable(); + await onOverride(); + + return true; + } else if (overridable) { + tBatch._disable(); + + return true; + } + + return false; + }, + ) == + true; + } + + /// Subscribe to changes to this [ProviderModel]. + /// The [callback] passed here will be called whenever a [ProviderModelVariable] belonging to this [ProviderModel] + /// that was accessed inside the [callback] changes. + /// The [callback] will be called immediately once during execution of this function synchronously. + /// + /// Do not call [use] inside of [callback]. + /// Do not do any sort of asynchronous work inside of [callback]. + /// Do not start any [ProviderModelBatch]es inside of [callback] via [begin] or [lock]. + /// It should be used only to access data and not modify it. + ProviderModelUseSubscription use(void Function(T model) callback) { + assert(!_disposed, 'ProviderModel was already disposed.'); + assert( + Zone.current[#providerModelUseSubscription] == null, + 'use() cannot be called while a use callback is being executed.', + ); + + final tSubscription = ProviderModelUseSubscription._(this, callback); + + (_useSubscriptions ??= >[]) + .add(tSubscription); + + _executeUseSubscription(tSubscription); + + return tSubscription; + } + + void _executeUseSubscription(ProviderModelUseSubscription subscription) { + subscription._clearVariables(); + + runZoned( + () { + subscription.callback(this as T); + }, + zoneValues: { + #providerModelUseSubscription: subscription, + }, + ); + + subscription._listenToVariables(); + } + + void _cancelUseSubscription(ProviderModelUseSubscription subscription) { + subscription._clearVariables(); + _useSubscriptions?.remove(subscription); + } +} + +/// [ProviderModelUseSubscription] is a class that represents a subscription to a [ProviderModel]'s [ProviderModelVariable]s. +/// +/// It keeps track of the variables that the subscription is interested in and calls a callback function whenever any of these variables change. +/// +/// This class is not meant to be instantiated directly. Instead, use [ProviderModel.use]. +/// +/// Example usage: +/// ```dart +/// final subscription = myModel.use((model) { +/// print(model.myVariable.unsafeValue); +/// }); +/// ``` +final class ProviderModelUseSubscription { + final ProviderModel _model; + final _variables = {}; + + /// The callback function to be called whenever any of the variables change. + final void Function(T model) callback; + + bool _scheduled = false; + + /// Private constructor. Use [ProviderModel.use] to create an instance. + ProviderModelUseSubscription._(this._model, this.callback); + + void _clearVariables() { + for (var i in _variables) { + i.removeListener(_onVariablesChanged); + } + + _variables.clear(); + } + + void _listenToVariables() { + for (var i in _variables) { + i.addListener(_onVariablesChanged); + } + } + + void _onVariablesChanged() { + if (!_scheduled) { + _scheduled = true; + + scheduleMicrotask(() { + _scheduled = false; + _model._executeUseSubscription(this); + }); + } + } + + /// Cancels the subscription. + /// Stops listening to all variables and removes the subscription from the [ProviderModel]. + void cancel() { + _model._cancelUseSubscription(this); + } +} diff --git a/packages/patapata_core/lib/src/remote_config.dart b/packages/patapata_core/lib/src/remote_config.dart new file mode 100644 index 0000000..0ed09eb --- /dev/null +++ b/packages/patapata_core/lib/src/remote_config.dart @@ -0,0 +1,340 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'config.dart'; + +/// Abstract class for the [RemoteConfig]. +/// +/// Inherit this class to create the [RemoteConfig] class. +abstract class RemoteConfig extends Config with ReadableConfig { + /// Fetches configuration data from a remote server. + /// + /// [expiration] is the cache expiration time. Default is 5 hours. + /// If [force] is true, it ignores the cache and fetches directly from the server. + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }); +} + +/// Class for managing all [RemoteConfig] used by the app. +/// +/// Access to [RemoteConfig] is usually done through this class. +/// example +/// ```dart +/// getApp().remoteConfig.getBool('key'); +/// ``` +class ProxyRemoteConfig extends RemoteConfig { + /// A list of [RemoteConfig] instances managed by this class. + /// These instances are used to fetch and store configuration data from a remote server. + final List _remoteConfigs = []; + + /// A map of default configuration values. + /// These values are used when no other values are specified for the corresponding keys. + final Map _defaults = {}; + + ProxyRemoteConfig(); + + /// Adds [RemoteConfig] passed as an argument to the list of managed configs. + /// + /// When initializing [Plugin], associated remote configs are added through this function. + /// Please make sure not to add [ProxyRemoteConfig]. + Future addRemoteConfig(RemoteConfig remoteConfig) async { + await remoteConfig.init(); + await remoteConfig.setDefaults(Map.of(_defaults)); + remoteConfig.addListener(onChange); + _remoteConfigs.add(remoteConfig); + + if (initialized) { + await remoteConfig.fetch(); + } + } + + /// Removes [RemoteConfig] passed as an argument from the list of managed configs. + /// + /// When dispose the [Plugin], associated remote configs are removed through this function. + void removeRemoteConfig(RemoteConfig remoteConfig) { + if (_remoteConfigs.remove(remoteConfig)) { + remoteConfig.dispose(); + } + } + + /// Disposes all the [RemoteConfig] instances managed by this class. + @override + void dispose() { + for (var v in _remoteConfigs) { + v.dispose(); + } + _remoteConfigs.clear(); + + super.dispose(); + } + + /// Fetch data from all RemoteConfig's managed by the app. + @override + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }) async { + await Future.wait([ + for (var tConfig in _remoteConfigs) + tConfig.fetch( + expiration: expiration, + force: force, + ), + ]).catchError((e) => const []); + } + + /// Checks if the given [key] exists in any of the [RemoteConfig] instances. + @override + bool hasKey(String key) => _remoteConfigs.any((v) => v.hasKey(key)); + + /// Retrieve a bool value from [RemoteConfig] + /// + /// Gets a bool value from RemoteConfig's managed by [App]. + /// If multiple classes have the same [key], + /// it returns the value from [RemoteConfig] that was added first to [_remoteConfigs]. + /// If the [key] does not exist in any RemoteConfig's, it returns the value in [_defaults]. + /// If that also doesn't exist, it returns the [defaultValue]. + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + for (var tConfig in _remoteConfigs) { + if (tConfig.hasKey(key)) { + return tConfig.getBool(key, defaultValue: defaultValue); + } + } + + if (_defaults.containsKey(key) && _defaults[key] is bool) { + return _defaults[key] as bool; + } + + return defaultValue; + } + + /// Retrieve a double value from [RemoteConfig] + /// + /// Gets a double value from RemoteConfig's managed by [App]. + /// If multiple classes have the same [key], + /// it returns the value from [RemoteConfig] that was added first to [_remoteConfigs]. + /// If the [key] does not exist in any RemoteConfig's, it returns the value in [_defaults]. + /// If that also doesn't exist, it returns the [defaultValue]. + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + for (var tConfig in _remoteConfigs) { + if (tConfig.hasKey(key)) { + return tConfig.getDouble(key, defaultValue: defaultValue); + } + } + + if (_defaults.containsKey(key) && _defaults[key] is double) { + return _defaults[key] as double; + } + + return defaultValue; + } + + /// Retrieve a int value from [RemoteConfig] + /// + /// Gets a int value from RemoteConfig's managed by [App]. + /// If multiple classes have the same [key], + /// it returns the value from [RemoteConfig] that was added first to [_remoteConfigs]. + /// If the [key] does not exist in any RemoteConfig's, it returns the value in [_defaults]. + /// If that also doesn't exist, it returns the [defaultValue]. + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + for (var tConfig in _remoteConfigs) { + if (tConfig.hasKey(key)) { + return tConfig.getInt(key, defaultValue: defaultValue); + } + } + + if (_defaults.containsKey(key) && _defaults[key] is int) { + return _defaults[key] as int; + } + + return defaultValue; + } + + /// Retrieve a String value from [RemoteConfig] + /// + /// Gets a String value from RemoteConfig's managed by [App]. + /// If multiple classes have the same [key], + /// it returns the value from [RemoteConfig] that was added first to [_remoteConfigs]. + /// If the [key] does not exist in any RemoteConfig's, it returns the value in [_defaults]. + /// If that also doesn't exist, it returns the [defaultValue]. + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + for (var tConfig in _remoteConfigs) { + if (tConfig.hasKey(key)) { + return tConfig.getString(key, defaultValue: defaultValue); + } + } + + if (_defaults.containsKey(key) && _defaults[key] is String) { + return _defaults[key] as String; + } + + return defaultValue; + } + + /// Sets the default values for the [RemoteConfig] instances managed by this class. + /// + /// The [defaults] parameter is a map containing the default key-value pairs. + /// These values are used when no other values are specified for the corresponding keys. + /// + /// This method is asynchronous and applies the default values to all [RemoteConfig] instances. + @override + Future setDefaults(Map defaults) async { + _defaults + ..clear() + ..addAll(defaults); + + // After we add, we hint to the actual + // RemoteConfig's about the defaults as well. + // They are expected to only return true for hasKey + // when not using default values. + for (var tConfig in _remoteConfigs) { + await tConfig.setDefaults(defaults); + } + } +} + +/// A [RemoteConfig] that can be used for testing. +/// This class is not intended to be used in production. +/// This [RemoteConfig] also implements [WritableConfig] and therefore +/// can be used to set values for testing. +class MockRemoteConfig extends RemoteConfig implements WritableConfig { + final Map _store; + final Map _defaults = {}; + bool _firstFetch = true; + + /// Creates a [MockRemoteConfig] that can be used for testing. + MockRemoteConfig(Map store) : _store = store; + + @override + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }) async { + if (force || _firstFetch) { + _firstFetch = false; + _store.addAll(_mockfetchValues); + notifyListeners(); + } + } + + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + return _store.containsKey(key) && _store[key] is bool + ? _store[key] as bool + : _defaults.containsKey(key) && _defaults[key] is bool + ? _defaults[key] as bool + : defaultValue; + } + + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + return _store.containsKey(key) && _store[key] is double + ? _store[key] as double + : _defaults.containsKey(key) && _defaults[key] is double + ? _defaults[key] as double + : defaultValue; + } + + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + return _store.containsKey(key) && _store[key] is int + ? _store[key] as int + : _defaults.containsKey(key) && _defaults[key] is int + ? _defaults[key] as int + : defaultValue; + } + + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + return _store.containsKey(key) && _store[key] is String + ? _store[key] as String + : _defaults.containsKey(key) && _defaults[key] is String + ? _defaults[key] as String + : defaultValue; + } + + @override + bool hasKey(String key) { + return _store.containsKey(key); + } + + @override + Future setDefaults(Map defaults) async { + _defaults + ..clear() + ..addAll(defaults); + } + + @override + Future reset(String key) async { + _store.remove(key); + } + + @override + Future resetAll() async { + _store.clear(); + } + + @override + Future resetMany(List keys) async { + for (var tKey in keys) { + _store.remove(tKey); + } + } + + @override + Future setBool(String key, bool value) async { + if (_store[key] != value) { + _store[key] = value; + notifyListeners(); + } + } + + @override + Future setDouble(String key, double value) async { + if (_store[key] != value) { + _store[key] = value; + notifyListeners(); + } + } + + @override + Future setInt(String key, int value) async { + if (_store[key] != value) { + _store[key] = value; + notifyListeners(); + } + } + + @override + Future setString(String key, String value) async { + if (_store[key] != value) { + _store[key] = value; + notifyListeners(); + } + } + + @override + Future setMany(Map objects) async { + _store.addAll(objects); + notifyListeners(); + } + + void testSetMockFetchValues(Map values) { + _mockfetchValues = values; + } + + Map _mockfetchValues = {}; +} diff --git a/packages/patapata_core/lib/src/remote_messaging.dart b/packages/patapata_core/lib/src/remote_messaging.dart new file mode 100644 index 0000000..f5e5e88 --- /dev/null +++ b/packages/patapata_core/lib/src/remote_messaging.dart @@ -0,0 +1,337 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter/foundation.dart'; +import 'package:logging/logging.dart'; + +import 'app.dart'; + +final _logger = Logger('patapata.RemoteMessaging'); + +/// Class that represents remote messages that were displayed in the notification area of the device. +class RemoteMessageNotification { + /// Title of the notification message. + final String? title; + + /// Body of the notification message. + final String? body; + + /// Create a [RemoteMessageNotification] + /// [title] represents the title of the notification, + /// and [body] is the content of the message was shown in the notification. + const RemoteMessageNotification({ + this.title, + this.body, + }); + + @override + String toString() { + return 'RemoteMessageNotification:{title:$title, body:$body}'; + } +} + +/// A class for handling remote messages such as Patapata notifications. +class RemoteMessage { + /// The default channel name used for remote messages. + static const String kRemoteMessageDefaultChannel = 'patapata_default_channel'; + + /// A unique ID to identify the message. + final String? messageId; + + /// The name of the notification channel. + final String channel; + + /// A map of received data in the remote message. + final Map? data; + + /// The remote message for the notification. + final RemoteMessageNotification? notification; + + /// Create a [RemoteMessage] + /// [messageId] is the ID to identify the message, [channel] is the name of the notification channel with the default being [kRemoteMessageDefaultChannel], + /// [data] is the received data, and [notification] is passed for the remote message of the notification. + const RemoteMessage({ + this.messageId, + this.channel = kRemoteMessageDefaultChannel, + this.data, + this.notification, + }); + + /// Strings for the [messageId], [channel], and [data] of the remote message. + @override + String toString() { + return 'RemoteMessage:{messageId:$messageId, channel:$channel, data:$data}'; + } +} + +/// An abstract class that provides the ability to monitor state changes of [RemoteMessage]. +/// For each feature that provides remote messages, create a [RemoteMessaging] that inherits from this class. +abstract class RemoteMessaging extends ChangeNotifier { + static const _kLocalConfigKeyPrefix = 'patapata.RemoteMessaging.listeningTo:'; + + late final App _app; + + /// The [App] referenced by the plugin. + App get app => _app; + + /// Initializes the [RemoteMessaging]. + @mustCallSuper + Future init(App app) async { + _app = app; + } + + /// Disposes of the [RemoteMessaging] object. See [ChangeNotifier.dispose] for details. + @override + @mustCallSuper + void dispose() { + super.dispose(); + } + + /// Future for the message when the app is opened via Remote Message. + Future getInitialMessage(); + + /// A Stream for observing the results of notified messages [messages]. + Stream get messages; + + /// A Stream for observing the results of the notified tokens. + Stream get tokens; + + /// Obtains a token to identify the app's installation. + /// This token can be used when you want to send notifications from other services to your own app. + Future getToken(); + + /// Whether the channel name [channel] is registered to for receiving messages. + @mustCallSuper + FutureOr listenChannel(String channel) async { + if (listeningToChannel(channel)) { + return false; + } + + await _app.localConfig.setBool('$_kLocalConfigKeyPrefix$channel', true); + + return true; + } + + /// Ignore the channel name [channel] to stop receiving messages from this channel. + @mustCallSuper + FutureOr ignoreChannel(String channel) async { + if (!listeningToChannel(channel)) { + return false; + } + + await _app.localConfig.reset('$_kLocalConfigKeyPrefix$channel'); + + return true; + } + + /// Determine whether the channel name [channel] is registered to for receiving messages. + bool listeningToChannel(String channel) => + _app.localConfig.getBool('$_kLocalConfigKeyPrefix$channel'); +} + +/// Class for managing all [RemoteMessaging] used by the app. +/// +/// Access to [RemoteMessaging] is usually done through this class. +/// example +/// ```dart +/// getApp().remoteMessaging.getInitialMessage(); +/// ``` +class ProxyRemoteMessaging extends RemoteMessaging { + final Map> _subscriptions = + {}; + final Map> _tokenSubscriptions = + {}; + final List _remoteMessagings = []; + + final _messagesController = StreamController.broadcast(); + final _tokenController = StreamController.broadcast(); + + /// Create a [ProxyRemoteMessaging] + ProxyRemoteMessaging(); + + /// Add [remoteMessaging] to the [RemoteMessaging]s managed by [ProxyRemoteMessaging]. + Future addRemoteMessaging(RemoteMessaging remoteMessaging) async { + await remoteMessaging.init(_app); + _subscriptions[remoteMessaging] = + remoteMessaging.messages.listen(_onMessage); + _tokenSubscriptions[remoteMessaging] = + remoteMessaging.tokens.listen(_onToken); + _remoteMessagings.add(remoteMessaging); + } + + /// Remove [remoteMessaging] from the [RemoteMessaging]s managed by [ProxyRemoteMessaging]. + void removeRemoteMessaging(RemoteMessaging remoteMessaging) { + if (_remoteMessagings.remove(remoteMessaging)) { + _subscriptions.remove(remoteMessaging)?.cancel(); + _tokenSubscriptions.remove(remoteMessaging)?.cancel(); + remoteMessaging.dispose(); + } + } + + void _onMessage(RemoteMessage message) { + _messagesController.add(message); + } + + void _onToken(String? token) { + _tokenController.add(token); + } + + @override + void dispose() { + for (var v in _remoteMessagings) { + v.dispose(); + } + _remoteMessagings.clear(); + super.dispose(); + } + + /// This function returns the first initial message that can be obtained from the list of managed [RemoteMessage]s. + /// If there were none, this returns null. + @override + Future getInitialMessage() { + // Only get the first message. + return Future.wait( + _remoteMessagings.map>( + (v) => v.getInitialMessage(), + )).then( + (v) => v.firstWhere( + (b) => b != null, + orElse: () => null, + ), + ); + } + + /// The stream of all [RemoteMessage]s managed by this class. + @override + Stream get messages => _messagesController.stream; + + /// The stream of all tokens from all [RemoteMessage]s managed by this class. + @override + Stream get tokens => _tokenController.stream; + + /// Obtains the first token from all [RemoteMessage]s managed by this class. + @override + Future getToken() async { + assert(() { + if (_remoteMessagings.length > 1) { + _logger.fine( + 'Multiple RemoteMessaging registered in ProxyRemoteMessaging. Only returning first one found.'); + } + + return true; + }()); + + if (_remoteMessagings.isNotEmpty) { + try { + return _remoteMessagings.first.getToken(); + // coverage:ignore-start + } catch (e, stackTrace) { + _logger.info('Failed to get token from plugin', e, stackTrace); + } + // coverage:ignore-end + } + + return null; + } + + /// This function registers the [RemoteMessaging] with the specified channel name [channel] in the list of [RemoteMessaging] managed by this class. + /// If there are multiple [RemoteMessaging], it returns true if the first one that matches the channel name [channel] is found. + @override + FutureOr listenChannel(String channel) { + return Future.wait( + _remoteMessagings + .map>((v) async => v.listenChannel(channel)), + ) + .then( + (v) => v.firstWhere( + (b) => b, + orElse: () => false, + ), + ) + .then((v) async { + await super.listenChannel(channel); + return v; + }); + } + + /// This function ignores messages with the specified channel name [channel] from the list managed by this class. + /// If there are multiple [RemoteMessaging], it executes the ignore operation on the first one that matches the channel name [channel]. If the ignore operation is successful, it returns true. + @override + FutureOr ignoreChannel(String channel) { + return Future.wait( + _remoteMessagings + .map>((v) async => v.ignoreChannel(channel)), + ) + .then( + (v) => v.firstWhere( + (b) => b, + orElse: () => false, + ), + ) + .then((v) async { + await super.ignoreChannel(channel); + return v; + }); + } +} + +/// This is a mock class for RemoteMessaging, used for testing purposes. +class MockRemoteMessaging extends RemoteMessaging { + final Future Function()? _getInitialMessage; + final Stream Function()? _messages; + final Stream Function()? _tokens; + final Future Function()? _getToken; + + /// Constructor for the MockRemoteMessaging class. + /// The arguments are functions that return the values you want to + /// return when you call the corresponding functions. + MockRemoteMessaging({ + Future Function()? getInitialMessage, + Stream Function()? messages, + Stream Function()? tokenStream, + Future Function()? getToken, + }) : _getInitialMessage = getInitialMessage, + _messages = messages, + _tokens = tokenStream, + _getToken = getToken; + + @override + Future getInitialMessage() { + if (_getInitialMessage != null) { + return _getInitialMessage!(); + } + + return Future.value(null); + } + + @override + Stream get messages { + if (_messages != null) { + return _messages!(); + } + + return const Stream.empty(); + } + + @override + Stream get tokens { + if (_tokens != null) { + return _tokens!(); + } + + return const Stream.empty(); + } + + @override + Future getToken() { + if (_getToken != null) { + return _getToken!(); + } + + return Future.value(null); + } +} diff --git a/packages/patapata_core/lib/src/sequential_work_queue.dart b/packages/patapata_core/lib/src/sequential_work_queue.dart new file mode 100644 index 0000000..1e3709f --- /dev/null +++ b/packages/patapata_core/lib/src/sequential_work_queue.dart @@ -0,0 +1,472 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'dart:collection'; + +final class _SequentialWorkQueueItem + extends LinkedListEntry<_SequentialWorkQueueItem> { + final Completer completer; + final FutureOr Function() work; + final FutureOr Function()? onCancel; + Completer? cancellingCompleter; + bool cancelled = false; + final asyncQueue = Queue>(); + + _SequentialWorkQueueItem(this.completer, this.work, this.onCancel); +} + +/// A utility class that will process work giving to it +/// in order, without failure. +/// +/// It is guaranteed under a standard Zone that all work +/// will be processed, whether previous works fails or not. +class SequentialWorkQueue { + final _queue = LinkedList<_SequentialWorkQueueItem>(); + + /// Checks whether the current code is running inside this [SequentialWorkQueue] work callback via [add]. + bool get insideSequentialWorkQueue => + Zone.current[#sequentialWorkQueue] == hashCode; + + /// Add [work] to this [SequentialWorkQueue]. + /// It will be executed when all previous [work] + /// registered to the [SequentialWorkQueue] as completed. + /// + /// If the [work] added here throws, the Future returned by + /// this function will error. However future [work] will + /// continue to be processed correctly. + /// + /// [work] is considered complete when the function itself returns, when + /// all [Future]s returned by [work] have completed, and if any asynchronous work + /// scheduled with [Future.microtask], [Future] or [Timer] inside [work] has completed. + /// Similar to how a main function is considered complete when all asynchronous work + /// scheduled within it has completed. + /// + /// If you wish to disable this behavior, you can run the [work] in a separate [Zone] + /// with `zoneValues: {#sequentialWorkQueueNoWaitForAsync: true}` set. + /// + /// You can optionally pass [onCancel] that will be called + /// if something attempts to clear this [SequentialWorkQueue] with methods like [clear]. + /// If [onCancel] returns true, this [work] with either stop executing or not execute all together, and [add] will return null. + /// If [onCancel] returns false, this [work] does not support cancelling, and will continue to execute until completion. + /// If [onCancel] is not passed, the default is the same as if onCancel returned true. + /// + /// When [onCancel] returns true, work that is current running in a separate [Zone] + /// will be allowed to complete. Code directly after the [Zone] execution will not be executed. + /// + /// Example: + /// ```dart + /// final tQueue = SequentialWorkQueue(); + /// + /// await tQueue.add(() async { + /// print('1'); + /// await Future.delayed(Duration(seconds: 1)); + /// print('2'); + /// }); + /// + /// tQueue.add(() async { + /// print('3'); + /// await Future.delayed(Duration(seconds: 1)); + /// print('4'); + /// }); + /// + /// // Just for demo purposees, wait for one tick to allow the print('3') line to execute. + /// // But then it will wait at the next await. + /// await Future.microtask(() => null); + /// + /// // Executing this here means the code beyond print('3') will not execute. + /// await tQueue.clear(); + /// + /// // Prints: 1, 2, 3 + /// ``` + Future add( + FutureOr Function() work, [ + FutureOr Function()? onCancel, + ]) async { + final tCompleter = Completer(); + final tQueueItem = _SequentialWorkQueueItem(tCompleter, work, onCancel); + _queue.add(tQueueItem); + + final tValueCompleter = Completer(); + + Future fFinish( + bool cancel, + T? value, [ + Object? error, + StackTrace? stackTrace, + ]) async { + if (!cancel) { + // This should only be called once. + + // Wait for all async work to complete. + while (tQueueItem.asyncQueue.isNotEmpty) { + await tQueueItem.asyncQueue.removeFirst(); + + if (tQueueItem.cancelled) { + // We got cancelled while waiting. + // Clean up a bit and just return. + // If we are cancelled, that means the cancel condition + // of the above code has already been met and we don't need + // to do anything else. + tQueueItem.asyncQueue.clear(); + + return; + } + } + } + + if (!tCompleter.isCompleted) { + tQueueItem.unlink(); + tCompleter.complete(); + } + + if (!tValueCompleter.isCompleted) { + if (error != null) { + tValueCompleter.completeError(error, stackTrace); + } else { + tValueCompleter.complete(value); + } + } + } + + try { + if (tQueueItem.previous != null) { + await tQueueItem.previous!.completer.future; + + if (tQueueItem.cancelled) { + fFinish(true, null); + return tValueCompleter.future; + } + } + + runZoned( + () { + try { + final tResult = work(); + + if (tResult != null) { + if (tResult is Future) { + tResult.then( + (value) { + fFinish(false, value); + }, + onError: (error, stackTrace) { + fFinish(false, null, error, stackTrace); + }, + ); + } else { + fFinish(false, tResult); + } + } else { + fFinish(false, null); + } + } catch (error, stackTrace) { + fFinish(false, null, error, stackTrace); + } + }, + zoneValues: { + #sequentialWorkQueue: hashCode, + #sequentialWorkQueueItem: tQueueItem.hashCode, + }, + zoneSpecification: ZoneSpecification( + fork: (self, parent, zone, specification, zoneValues) { + return parent.fork( + zone, + specification, + { + ...?zoneValues, + // Keep this so we know if we are inside this queue. + #sequentialWorkQueue: hashCode, + // Reset this so we don't cancel code in this new Zone. + #sequentialWorkQueueItem: 0, + }, + ); + }, + scheduleMicrotask: (self, parent, zone, f) { + late Completer tAsyncCompleter; + + void fCompleteAsync() { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter.complete(); + }); + } + + if (zone[#sequentialWorkQueueItem] != tQueueItem.hashCode) { + var tF = f; + + if (zone[#sequentialWorkQueueNoWaitForAsync] != true) { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + tF = () { + fCompleteAsync(); + f(); + }; + } + + return parent.scheduleMicrotask(zone, tF); + } + + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + parent.scheduleMicrotask(zone, () { + if (!tQueueItem.cancelled) { + if (tQueueItem.cancellingCompleter != null) { + tQueueItem.cancellingCompleter!.future.then((cancelled) { + fCompleteAsync(); + + if (!cancelled) { + f(); + } else { + fFinish(true, null); + } + }); + } else { + fCompleteAsync(); + f(); + } + } else { + fCompleteAsync(); + fFinish(true, null); + } + }); + }, + createTimer: (self, parent, zone, duration, f) { + late Completer tAsyncCompleter; + + void fCompleteAsync() { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter.complete(); + }); + } + + if (zone[#sequentialWorkQueueItem] != tQueueItem.hashCode) { + var tF = f; + + if (zone[#sequentialWorkQueueNoWaitForAsync] != true) { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + tF = () { + fCompleteAsync(); + f(); + }; + } + + return parent.createTimer(zone, duration, tF); + } + + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + return parent.createTimer(zone, duration, () { + if (!tQueueItem.cancelled) { + if (tQueueItem.cancellingCompleter != null) { + tQueueItem.cancellingCompleter!.future.then((cancelled) { + fCompleteAsync(); + + if (!cancelled) { + f(); + } else { + fFinish(true, null); + } + }); + } else { + fCompleteAsync(); + f(); + } + } else { + fCompleteAsync(); + fFinish(true, null); + } + }); + }, + createPeriodicTimer: (self, parent, zone, period, f) { + late Completer tAsyncCompleter; + + void fCompleteAsync() { + if (!tAsyncCompleter.isCompleted) { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter.complete(); + }); + } + } + + if (zone[#sequentialWorkQueueItem] != tQueueItem.hashCode) { + var tF = f; + + if (zone[#sequentialWorkQueueNoWaitForAsync] != true) { + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + tF = (Timer timer) { + fCompleteAsync(); + f(timer); + }; + } + + return parent.createPeriodicTimer(zone, period, tF); + } + + parent.run(Zone.current.parent ?? zone, () { + tAsyncCompleter = Completer(); + tQueueItem.asyncQueue.add(tAsyncCompleter.future); + }); + + late final _PeriodicTimer tTimer; + + final tBackingTimer = + parent.createPeriodicTimer(zone, period, (timer) { + if (!tQueueItem.cancelled) { + if (tQueueItem.cancellingCompleter != null) { + tQueueItem.cancellingCompleter!.future.then((cancelled) { + if (!cancelled) { + f(tTimer); + } else { + tTimer.cancelWithoutCallback(); + fCompleteAsync(); + fFinish(true, null); + } + }); + } else { + f(tTimer); + } + } else { + tTimer.cancelWithoutCallback(); + fCompleteAsync(); + fFinish(true, null); + } + }); + + tTimer = _PeriodicTimer( + tBackingTimer, + // This callback happens when the timer is cancelled. + () { + if (!tAsyncCompleter.isCompleted) { + // Notify that this timer has been cancelled. + // This will let the future for [add] to complete. + fCompleteAsync(); + } + }, + ); + + return tTimer; + }, + ), + ); + } catch (error, stackTrace) { + // If we get here, something went wrong. + // Can't think of a possible realistic code path + // that would cause this to happen, so we will ignore + // this line for coverage. + // coverage:ignore-start + fFinish(false, null, error, stackTrace); + // coverage:ignore-end + } + + return tValueCompleter.future; + } + + /// Clear the queue. + /// This is attempt to cancel all work pending and running. + /// It will return when all work has truly completed or cancelled. + /// + /// Warning. Never call this inside [SequentialWorkQueue.add.work]. + /// An assert will be thrown, or in release mode, ignored. + Future clear() async { + assert(Zone.current[#sequentialWorkQueueItem] == null, + 'Can not clear() a SequentialWorkQueue inside a work callback.'); + + final tQueue = _queue + .where((element) => element.cancellingCompleter == null) + .toList(growable: false); + + for (var i in tQueue) { + i.cancellingCompleter = Completer(); + } + + final tWorkToWaitFor = >[]; + + for (var i in tQueue) { + final tCompleter = i.cancellingCompleter!; + tWorkToWaitFor.add(i.completer.future); + + if (i.onCancel != null) { + try { + final tCancelResult = i.onCancel!(); + + if (tCancelResult == true) { + i.cancelled = true; + tCompleter.complete(true); + } else if (tCancelResult == false) { + i.cancellingCompleter = null; + tCompleter.complete(false); + } else { + final tCancelFinalResult = await tCancelResult; + + if (tCancelFinalResult) { + i.cancelled = true; + tCompleter.complete(true); + } else { + i.cancellingCompleter = null; + tCompleter.complete(false); + } + } + } catch (error, stackTrace) { + // Continue processing the queue. + // We will send this off to the zone unhandled callback. + i.cancellingCompleter = null; + tCompleter.complete(false); + Zone.current.handleUncaughtError(error, stackTrace); + } + } else { + i.cancelled = true; + tCompleter.complete(true); + } + } + + await Future.wait(tWorkToWaitFor); + } + + /// Whether this queue is empty + bool get isEmpty => _queue.isEmpty; + + /// Whether this queue is not empty + bool get isNotEmpty => _queue.isNotEmpty; +} + +class _PeriodicTimer implements Timer { + final Timer backingTimer; + final void Function() onCancel; + + _PeriodicTimer(this.backingTimer, this.onCancel); + + @override + void cancel() { + backingTimer.cancel(); + onCancel(); + } + + void cancelWithoutCallback() { + backingTimer.cancel(); + } + + @override + bool get isActive => backingTimer.isActive; + + @override + int get tick => backingTimer.tick; +} diff --git a/packages/patapata_core/lib/src/startup.dart b/packages/patapata_core/lib/src/startup.dart new file mode 100644 index 0000000..4743f1a --- /dev/null +++ b/packages/patapata_core/lib/src/startup.dart @@ -0,0 +1,395 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:collection/collection.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/widgets.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/src/exception.dart'; + +final _logger = Logger('StartupSequence'); + +/// A factory for states used in the [StartupSequence] system. +class StartupStateFactory { + /// Creates a [StartupState]. + /// [startupSequence] is the [StartupSequence] that generated this state. + final T Function(StartupSequence startupSequence) create; + final List> _transitions; + + const StartupStateFactory( + this.create, + List> transitions, + ) : _transitions = transitions; + + LogicStateFactory _toLogicStateFactory(StartupSequence startupSequence) { + return LogicStateFactory( + () => create(startupSequence)..onComplete.ignore(), + _transitions, + ); + } +} + +typedef StartupPageCompleter = void Function(Object? result); + +/// [LogicState] executed in [StartupSequence]. +abstract class StartupState extends LogicState { + StartupState(this.startupSequence); + + /// The [StartupSequence] that executed this state. + final StartupSequence startupSequence; + + Completer? _navigateCompleter; + + /// Navigate to page. + /// + /// When using [StandardAppPlugin], navigation to the page defined in + /// [StandardMaterialApp.pages] or [StandardCupertinoApp.pages] + /// can be achieved by passing the page's [Type]. + /// If you want custom navigation, implement a [Plugin] that overrides + /// [StartupNavigatorMixin.startupNavigateToPage]. + /// + /// Please pass [completer] to every page navigated to using this method. + /// When using [StandardAppPlugin], this would be [StandardPage.pageData]. + /// + /// By calling [completer] within the page, the internal processes are executed + /// and the [Future] of this method returns true. + /// If another state switches without calling [completer], + /// the [Future] returns false. + Future navigateToPage( + Object page, StartupPageCompleter completer) async { + final tPlugin = startupSequence._startupNavigator; + assert(tPlugin != null); + + await startupSequence.waitForSplash(); + + if (!this()) { + throw LogicStateNotCurrent(this); + } + assert( + _navigateCompleter == null || _navigateCompleter?.isCompleted == true); + final tCompleter = Completer(); + _navigateCompleter = tCompleter; + + backAllowed = true; + tPlugin?.startupNavigateToPage(page, (result) { + if (tCompleter.isCompleted) { + return; + } + + tCompleter.complete(true); + completer(result); + }); + + return tCompleter.future; + } + + @override + @mustCallSuper + void dispose() { + if (_navigateCompleter?.isCompleted == false) { + _navigateCompleter!.complete(false); + } + super.dispose(); + } + + @override + @mustCallSuper + void init(Object? data) { + super.init(data); + + Timer.run(() { + process(data).then((_) { + if (this()) { + complete(); + } + }).catchError((e, stackTrace) { + return startupSequence.waitForSplash().whenComplete(() async { + if (this()) { + completeError(e, stackTrace); + } + }); + }); + }); + } + + /// The process to be executed in the state. + /// When the Future of this method completes, it transitions to the next state. + /// + /// If defined in [LogicStateTransition], you can transition to another state using [to]. + /// In that case, this method does nothing even after completion. + Future process(Object? data); +} + +/// Manages the series of processes from app launch to the display of +/// the initial screen using [LogicStateMachine]. +/// When executing [StartupSequence.resetMachine], it starts execution from +/// the first state provided in the [StartupStateFactory] list. +/// +/// When all states succeed, [StartupSequence] calls [StartupNavigatorMixin.startupProcessInitialRoute]. +/// When using [StandardAppPlugin], this is synonymous with calling +/// [StandardRouterDelegate.processInitialRoute]. In other words, +/// If a deep link was used to start the app, that deep link's page will be displayed. +/// If no deep link was used, the route with a link of nothing (`r''`) will be navigated to. +/// +/// If the app is rendering widgets using the [StandardAppPlugin] system, +/// [StartupSequence.resetMachine] is automatically executed only once when the app is launched. +/// +/// [startupStateFactories] specifies the states to be executed sequentially. +/// This is the same as [LogicState] in [LogicStateMachine]. +/// +/// [waitSplashScreenDuration] specifies the waiting time for the splash screen. +/// [StartupState.navigateToPage] or [StartupNavigatorMixin.startupProcessInitialRoute] +/// will be executed after waiting for this duration to elapse. +/// Also, [removeNativeSplashScreen] is called once this time has passed. +/// (default is 1 second) +class StartupSequence { + StartupSequence({ + required List startupStateFactories, + Duration? waitSplashScreenDuration, + this.onSuccess, + this.onError, + }) : _startupStateFactories = startupStateFactories, + _waitSplashScreenDuration = + waitSplashScreenDuration ?? const Duration(milliseconds: 1000); + + LogicStateMachine? _machine; + final List _startupStateFactories; + + /// Called when all sequence processing is completed. + final void Function()? onSuccess; + + /// Called when an error occurs during the sequence. + /// If null, it will call [Logger.severe] instead. + final void Function(Object error, StackTrace? stackTrace)? onError; + + /// The details of the error that occurred during execution. + LogicStateError? get error => _error; + LogicStateError? _error; + + /// Whether the sequence has completed, successfully or due to an error. + bool get complete => _startupCompleted; + Completer? _startupCompleter; + bool _startupCompleted = false; + + final Duration _waitSplashScreenDuration; + Timer? _waitSplashScreenTimer; + Completer? _splashScreenCompleter; + bool _splashFinished = false; + + /// Whether the time specified by [waitSplashScreenDuration] has elapsed. + bool get splashFinished => _splashFinished; + + StartupNavigatorMixin? get _startupNavigator => + getApp().getPluginsOfType().reversed.firstOrNull; + + List _createLogicStateFactories() { + return [ + for (final factory in _startupStateFactories) + factory._toLogicStateFactory(this) + ]; + } + + /// Starts the sequence processing. + /// If called again, it restarts from the beginning. + /// + /// When using [StandardAppPlugin], upon restart, + /// navigation will be directed to the first page in + /// [StandardMaterialApp.pages] or [StandardCupertinoApp.pages]. + /// To customize this behavior, implement a [Plugin] that overrides + /// [StartupNavigatorMixin.startupOnReset]. + void resetMachine() { + final tIsFirstRun = !(_machine != null || complete); + if (_waitSplashScreenTimer?.isActive == true) { + _waitSplashScreenTimer?.cancel(); + } + + _waitSplashScreenTimer = Timer(_waitSplashScreenDuration, () { + getApp().removeNativeSplashScreen().whenComplete(() { + _splashFinished = true; + _splashScreenCompleter?.complete(); + _waitSplashScreenTimer = null; + }); + }); + + final tPreMachine = _machine; + _machine?.removeListener(_onUpdate); + _error = null; + _splashFinished = false; + _startupCompleted = false; + _machine = LogicStateMachine(_createLogicStateFactories()) + ..addListener(_onUpdate); + + if (!tIsFirstRun) { + if (tPreMachine?.complete == false) { + tPreMachine?.current.completeError(const ResetStartupSequence()); + } + _startupNavigator?.startupOnReset(); + } + } + + /// Waits until the time specified by [waitSplashScreenDuration] has elapsed. + Future waitForSplash() { + if (splashFinished) { + return SynchronousFuture(null); + } + if (_splashScreenCompleter == null || + _splashScreenCompleter?.isCompleted == true) { + _splashScreenCompleter = Completer(); + } + return _splashScreenCompleter!.future; + } + + /// Waits until the process is completed. + Future waitForComplete() { + if (complete) { + if (error != null) { + if (error?.stackTrace != null) { + throw Error.throwWithStackTrace(error!.error, error!.stackTrace!); + } + throw error!.error; + } + return SynchronousFuture(null); + } + if (_startupCompleter == null || _startupCompleter?.isCompleted == true) { + _startupCompleter = Completer(); + } + return _startupCompleter!.future; + } + + void _onUpdate() { + _logger.info(_machine!); + + final tMachine = _machine; + + if (tMachine != null && tMachine.complete) { + tMachine.removeListener(_onUpdate); + + waitForSplash().whenComplete(() { + if (tMachine.hashCode != _machine?.hashCode) { + return; + } + final tError = tMachine.error; + _error = tError; + _machine = null; + _startupCompleted = true; + if (tError != null) { + _startupCompleter?.completeError(tError.error, tError.stackTrace); + + if (onError != null) { + onError?.call(tError.error, tError.stackTrace); + } else { + _logger.severe( + tError.error.toString(), tError.error, tError.stackTrace); + } + } else { + _startupCompleter?.complete(); + + _startupNavigator?.startupProcessInitialRoute(); + onSuccess?.call(); + } + }); + } + } +} + +/// Implements page navigation during [StartupSequence] processing. +/// If you are performing page navigation outside of the [StandardAppPlugin] system, +/// implement a [Plugin] that uses this with a mixin. +mixin StartupNavigatorMixin { + /// Called from [StartupState.navigateToPage]. Implements page navigation. + void startupNavigateToPage(Object page, StartupPageCompleter completer) => + () {}; // coverage:ignore-line + + /// Called when all the processes of [StartupSequence] have successfully completed. + /// Implements the navigation process to the application home. + void startupProcessInitialRoute() => () {}; + + /// Called when [StartupSequence.resetMachine] is invoked during the processing of [StartupSequence]. + void startupOnReset() => () {}; +} + +class StartupNavigatorObserver extends NavigatorObserver { + final StartupSequence _startupSequence; + final Map _routeHashStateMap = {}; + + StartupNavigatorObserver({ + required StartupSequence startupSequence, + }) : _startupSequence = startupSequence; + + @override + void didPush(Route route, Route? previousRoute) { + if (_startupSequence.complete || _startupSequence._machine == null) { + if (_routeHashStateMap.isNotEmpty) { + _routeHashStateMap.clear(); + } + return; + } + + if (route.isActive && route.isCurrent) { + _routeHashStateMap[route] = + _startupSequence._machine!.current.runtimeType; + } + } + + @override + void didPop(Route route, Route? previousRoute) { + if (_startupSequence.complete || _startupSequence._machine == null) { + return; + } + if (previousRoute == null) { + return; + } + + if (previousRoute.isActive && previousRoute.isCurrent) { + final tBackState = _routeHashStateMap[previousRoute]; + if (tBackState != null && + tBackState != _startupSequence._machine?.current.runtimeType) { + _startupSequence._machine!.current.backByType(tBackState); + } + } + } + + @override + void didRemove(Route route, Route? previousRoute) { + if (_startupSequence.complete || _startupSequence._machine == null) { + return; + } + + if (previousRoute == null) { + return; + } + + if (previousRoute.isActive && previousRoute.isCurrent) { + final tBackState = _routeHashStateMap[previousRoute]; + if (tBackState != null && + tBackState != _startupSequence._machine?.current.runtimeType) { + _startupSequence._machine!.current.backByType(tBackState); + } + } + } + + @override + void didReplace({Route? newRoute, Route? oldRoute}) { + if (_startupSequence.complete || _startupSequence._machine == null) { + return; + } + if (newRoute == null) { + return; + } + + if (newRoute.isActive && newRoute.isCurrent) { + _routeHashStateMap[newRoute] = + _startupSequence._machine!.current.runtimeType; + } + } +} + +/// Thrown when [StartupSequence.resetMachine] is called while [StartupSequence] is already running. +class ResetStartupSequence extends PatapataCoreException { + const ResetStartupSequence() : super(code: PatapataCoreExceptionCode.PPE301); +} diff --git a/packages/patapata_core/lib/src/user.dart b/packages/patapata_core/lib/src/user.dart new file mode 100644 index 0000000..69b75de --- /dev/null +++ b/packages/patapata_core/lib/src/user.dart @@ -0,0 +1,497 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'dart:collection'; + +import 'package:collection/collection.dart'; +import 'package:flutter/foundation.dart'; +import 'package:logging/logging.dart'; +import 'app.dart'; +import 'provider_model.dart'; + +final _logger = Logger('patapata.User'); + +class _CompareMap extends MapBase { + final _store = HashMap(); + + _CompareMap([Map store = const {}]) { + _store.addAll(store); + } + + @override + Object? operator [](Object? key) => _store[key]; + + @override + void operator []=(String key, Object? value) { + _store[key] = value; + } + + // coverage:ignore-start + @override + void clear() { + _store.clear(); + } + // coverage:ignore-end + + @override + Iterable get keys => _store.keys; + + // coverage:ignore-start + @override + Object? remove(Object? key) { + _store.remove(key); + return null; + } + // coverage:ignore-end + + @override + operator ==(Object other) => other is Map + ? mapEquals(_store, other is _CompareMap ? other._store : other) + : false; + + // coverage:ignore-start + @override + int get hashCode => const MapEquality().hash(_store); + // coverage:ignore-end +} + +/// User data while attempting to change the [User]. +class UserChangeData { + /// The user id. Corresponds to [User.id]. + /// + /// By using [getIdFor], you can obtain values overridden for each [Type]. + String? id; + + /// The user properties. Corresponds to [User.properties]. + /// + /// By using [getPropertiesFor], you can obtain values overridden for each [Type]. + final Map properties; + + /// The user arbitrary data. Corresponds to [User.getData]. + final Map data; + + /// The user id that has been overridden for each [Type]. + final Map idOverrides; + + /// The user properties that have been overridden for each [Type]. + final Map> propertiesOverrides; + + UserChangeData({ + required this.id, + required this.properties, + required this.data, + required this.idOverrides, + required this.propertiesOverrides, + }); + + /// Retrieves the [id] that has been overridden for each [Type]. + String? getIdFor() => idOverrides.containsKey(T) ? idOverrides[T] : id; + + /// Retrieves the [properties] that have been overridden for each [Type]. + Map getPropertiesFor() => + propertiesOverrides.containsKey(T) + ? (Map.from(properties)..addAll(propertiesOverrides[T]!)) + : Map.from(properties); + + /// Sets all values of properties to null. + void removeAllProperties() { + final tOldProperties = { + for (var i in properties.keys) i: null, + }; + + properties + ..clear() + ..addAll(_CompareMap()..addAll(tOldProperties)); + } +} + +/// User information of the application. +/// +/// This class is automatically created during application initialization +/// and can be accessed from [App.user] or [context.read] or [context.watch]. +class User extends ProviderModel { + /// The [App] that was passed in the constructor. + final App app; + + User({ + required this.app, + }); + + final _key = ProviderLockKey('patapata.UserKey'); + + /// The [ProviderLockKey] used for updating user data. + @protected + ProviderLockKey get key => _key; + + late final ProviderModelVariable _id = createVariable(null); + final Map _idOverrides = {}; + + /// The user id. + /// + /// By using [getIdFor], you can obtain values overridden for each [Type]. + /// + /// The value obtained may not be the latest. + String? get id => _id.unsafeValue; + + /// Retrieves the [id] that has been overridden for each [Type]. + /// + /// The value obtained may not be the latest. + String? getIdFor() => _idOverrides.containsKey(T) ? _idOverrides[T] : id; + + late final ProviderModelVariable<_CompareMap> _properties = + createVariable<_CompareMap>(_CompareMap()); + final Map _propertiesOverrides = {}; + + /// The user properties. + /// + /// This value can be shared outside of the application (such as in external packages). + /// (e.g., Analytics or Sentry) + /// + /// By using [getPropertiesFor], you can obtain values overridden for each [Type]. + /// + /// The value obtained may not be the latest. + Map get properties => Map.from(_properties.unsafeValue); + + /// Retrieves the [properties] that have been overridden for each [Type]. + /// + /// The value obtained may not be the latest. + Map getPropertiesFor() => + _propertiesOverrides.containsKey(T) + ? (properties..addAll(_propertiesOverrides[T]!)) + : properties; + + late final ProviderModelVariable<_CompareMap> _data = + createVariable<_CompareMap>(_CompareMap()); + + final List Function(User user, UserChangeData changes)> + _synchronousChangeListeners = []; + + /// Adds a listener to monitor updates to user data. + /// + /// When user-related data is updating, the [callback] is invoked, + /// and the changed value is set to [changes]. + /// The content of [changes] can be modified within the [callback]. + /// + /// Once all the listener's [callback]s have successfully completed, + /// the final values in [changes] are committed. + /// If any listener returns an error, the changes are discarded. + void addSynchronousChangeListener( + FutureOr Function(User user, UserChangeData changes) + callback) => + _synchronousChangeListeners.add(callback); + + /// Removes the listener that was added using [addSynchronousChangeListener]. + void removeSynchronousChangeListener( + FutureOr Function(User user, UserChangeData changes) + callback) => + _synchronousChangeListeners.remove(callback); + + /// All values of [User]. + /// + /// `[id, properties, data]` + List get variables => [ + _id, + _properties, + _data, + ]; + + /// Sets arbitrary data. + /// + /// This value can be used for data exchange within the application and + /// is not intended to be sent to external packages. + Future setData( + String key, + T value, + ) async { + await lock((batch) { + _logger.fine('setData:$key=$value'); + final tNewData = _CompareMap(batch.get(_data)); + tNewData[key] = value; + batch.set(_data, tNewData); + batch.commit(); + }, lockKey: _key); + } + + /// Retrieves arbitrary data. + /// + /// This value can be used for data exchange within the application and + /// is not intended to be sent to external packages. + Future getData(String key) async { + final tData = await _data.getValue(); + return tData[key] as T?; + } + + /// Synchronous process of [getData] + /// + /// The value obtained may not be the latest. + T? getDataSync(String key) { + return _data.unsafeValue[key] as T?; + } + + /// Removes the data of [key] that was set using [setData] or similar functions. + Future removeData(String key) async { + await lock((batch) { + _logger.fine('removeData:$key'); + final tData = batch.get(_data); + tData.remove(key); + batch.set(_data, _CompareMap(tData)); + batch.commit(); + }, lockKey: _key); + } + + /// Removes all the data that was set using [setData] and similar functions. + Future removeAllData() async { + await lock((batch) { + _logger.fine('removeAllData'); + batch.set(_data, _CompareMap()); + batch.commit(); + }, lockKey: _key); + } + + /// Retrieves the value specified by [key] from [properties]. + /// + /// [defaultValue] will be returned if [key] does not exist. + /// + /// The value obtained may not be the latest. + T? getProperty(String key, [T? defaultValue]) => + _properties.unsafeValue.containsKey(key) + ? _properties.unsafeValue[key] as T? + : defaultValue; + + Future _runSynchronousChangeListeners(ProviderModelBatch lock) async { + final tChangeData = UserChangeData( + id: lock.get(_id), + properties: Map.from(lock.get(_properties)), + data: Map.from(lock.get(_data)), + idOverrides: Map.from(_idOverrides), + propertiesOverrides: Map.from(_propertiesOverrides), + ); + + final tSynchronousChangeListeners = + _synchronousChangeListeners.toList(growable: false); + final tPossibleExternalChanges = tSynchronousChangeListeners.isNotEmpty; + + if (tPossibleExternalChanges) { + await lock.blockOverride(() async { + for (var i in tSynchronousChangeListeners) { + await i(this, tChangeData); + } + }); + + if (_id.unsafeValue != tChangeData.id) { + _logger + .info('Synchronous change listener changed id: ${tChangeData.id}'); + lock.set(_id, tChangeData.id); + } + + if (_properties.unsafeValue != tChangeData.properties) { + _logger.info( + 'Synchronous change listener changed properties: ${tChangeData.properties}'); + lock.set<_CompareMap>(_properties, _CompareMap(tChangeData.properties)); + } + + if (_data.unsafeValue != tChangeData.data) { + _logger.info( + 'Synchronous change listener changed data: ${tChangeData.data}'); + lock.set<_CompareMap>(_data, _CompareMap(tChangeData.data)); + } + + _idOverrides + ..clear() + ..addAll(tChangeData.idOverrides); + _propertiesOverrides + ..clear() + ..addAll(tChangeData.propertiesOverrides + .map((key, value) => MapEntry(key, _CompareMap()..addAll(value)))); + } + } + + /// Sets a property. + /// + /// This value can be shared outside of the application (such as in external packages). + /// (e.g., Analytics or Sentry) + /// + /// With [overrideProperties], you can override property values in any [Type]. + /// Overridden values can be retrieved using [getPropertiesFor]. + Future setProperties( + Map properties, { + Map>? overrideProperties, + }) async { + await lock((batch) async { + _logger.fine('setProperties:$properties'); + + final tProperties = batch.get(_properties); + final tNewProperties = _CompareMap(tProperties); + tNewProperties.addAll(properties); + batch.set(_properties, tNewProperties); + + if (overrideProperties != null) { + for (var i in overrideProperties.entries) { + _propertiesOverrides[i.key] ??= _CompareMap(); + _propertiesOverrides[i.key]!.addAll(i.value); + } + } + + await _runSynchronousChangeListeners(batch); + + await app.remoteConfig.fetch(); + + batch.commit(); + }, lockKey: _key); + } + + /// Sets the user's id and various values. + /// + /// Executing this function will discard the current values of [User.properties]. + /// + /// With [overrideId], you can override the id value in any [Type]. + /// Overridden values can be retrieved using [getIdFor]. + /// + /// With [overrideProperties], you can override property values in any [Type]. + /// Overridden values can be retrieved using [getPropertiesFor]. + Future changeId( + String? id, { + Map? properties, + Map? data, + Map? overrideId, + Map>? overrideProperties, + }) async { + await lock((batch) async { + await changeIdWithBatch( + batch: batch, + id: id, + properties: properties, + data: data, + overrideId: overrideId, + overrideProperties: overrideProperties, + ); + + batch.commit(); + }, lockKey: _key); + } + + /// Sets the user's id and various values using the provided [ProviderModelBatch]. + @protected + Future changeIdWithBatch({ + required ProviderModelBatch batch, + required String? id, + Map? properties, + Map? data, + Map? overrideId, + Map>? overrideProperties, + }) async { + _logger.fine('changeId:$id, $properties, $data'); + + batch.set(_id, id); + + _idOverrides.clear(); + + if (overrideId != null) { + for (var i in overrideId.entries) { + _idOverrides[i.key] = i.value; + } + } + + // notify listeners to remove old properties. + final tOldProperties = { + for (var i in batch.get(_properties).keys) i: null, + }; + + final tProperties = _CompareMap(tOldProperties); + + if (properties != null) { + tProperties.addAll(properties); + } + + batch.set(_properties, tProperties); + + if (data != null) { + batch.set(_data, _CompareMap(data)); + } + + _propertiesOverrides.clear(); + + if (overrideProperties != null) { + for (var i in overrideProperties.entries) { + _propertiesOverrides[i.key] ??= _CompareMap(); + _propertiesOverrides[i.key]!.addAll(i.value); + } + } + + await _runSynchronousChangeListeners(batch); + + await app.remoteConfig.fetch(force: true); + } + + /// Sets the properties and arbitrary data. + /// + /// With [overrideProperties], you can override property values in any [Type]. + /// Overridden values can be retrieved using [getPropertiesFor]. + Future set({ + Map? properties, + Map? data, + Map>? overrideProperties, + }) async { + await lock((batch) async { + await setWithBatch( + batch: batch, + properties: properties, + data: data, + overrideProperties: overrideProperties, + ); + + batch.commit(); + }, lockKey: _key); + } + + /// Sets the properties and arbitrary data using the provided [ProviderModelBatch]. + @protected + Future setWithBatch({ + required ProviderModelBatch batch, + Map? properties, + Map? data, + Map>? overrideProperties, + }) async { + _logger.fine('set:$properties, $data'); + + if (properties != null) { + final tProperties = batch.get(_properties); + final tNewProperties = _CompareMap(tProperties); + tNewProperties.addAll(properties); + batch.set(_properties, tNewProperties); + } + + if (data != null) { + final tData = batch.get(_data); + final tNewData = _CompareMap(tData); + tNewData.addAll(data); + batch.set(_data, tNewData); + } + + if (overrideProperties != null) { + for (var i in overrideProperties.entries) { + _propertiesOverrides[i.key] ??= _CompareMap(); + _propertiesOverrides[i.key]!.addAll(i.value); + } + } + + await _runSynchronousChangeListeners(batch); + + try { + await app.remoteConfig.fetch( + force: batch.get(_id) != _id.unsafeValue, + ); + } catch (e, stackTrace) { + _logger.info('Failed to refresh RemoteConfig.', e, stackTrace); + } + } + + @override + operator ==(Object other) => other is User ? other.id == id : false; + + @override + int get hashCode => Object.hash(null, id.hashCode); +} diff --git a/packages/patapata_core/lib/src/util.dart b/packages/patapata_core/lib/src/util.dart new file mode 100644 index 0000000..7bb2c17 --- /dev/null +++ b/packages/patapata_core/lib/src/util.dart @@ -0,0 +1,289 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:io'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/scheduler.dart'; +import 'package:flutter/services.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +/// A value that can be used as a 32 bit integer. +/// It's value is just `pata` in ascii hexidecimal. +const int kPataInHex = 0x70617461; + +/// Determines if [T] is a subclass of another [S] +bool typeIs() => [] is List; + +/// Set this to execute a callback every time [scheduleFunction] +/// is executed, after a frame has been scheduled, but before the +/// post frame callback is set. +/// Mostly used for testing purposes as a way to pump automatically. +@visibleForTesting +VoidCallback? onPostFrameCallback; + +/// Sets a mock method call handler for the given [MethodChannel] for testing purposes. +/// +/// The mock method call handler is a function that is called when a method call is made on the [MethodChannel]. +/// By default, this function does nothing. +/// However, in testing code, this function should be set to +/// [TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockMethodCallHandler] to allow +/// integration with the testing framework. +/// +/// If you use the [createApp] function defined in patapata_core_test_utils.dart this is done for you. +@visibleForTesting +void Function(MethodChannel, Future? Function(MethodCall)?) + testSetMockMethodCallHandler = (channel, handler) { + // Do nothing by default. +}; + +/// Sets a mock stream handler for the given [EventChannel] for testing purposes. +/// +/// The mock stream handler is a function that is called when an event is sent on the [EventChannel]. +/// By default, this function does nothing. +/// However, in testing code, this function should be set to +/// [TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger.setMockStreamHandler] to allow +/// integration with the testing framework. +/// +/// If you use the [createApp] function defined in patapata_core_test_utils.dart, this is done for you. +// coverage:ignore-start +@visibleForTesting +void Function(EventChannel, TestMockStreamHandler?) testSetMockStreamHandler = + (channel, handler) { + // Do nothing by default. +}; +// coverage:ignore-end + +/// [compute] doesn't work in a test environment or on the web. +/// This function runs compute on supported platforms but on +/// unsupported platforms runs a simple microtask via [scheduleMicrotask]. +FutureOr platformCompute( + ComputeCallback callback, + Q message, { + String? debugLabel, +}) { + if (kIsWeb || !Platform.environment.containsKey('FLUTTER_TEST')) { + // coverage:ignore-start + return compute( + callback, + message, + debugLabel: debugLabel, + ); + // coverage:ignore-end + } else { + final Completer tCompleter = Completer(); + + scheduleMicrotask(() async { + try { + final R tResult = await callback(message); + tCompleter.complete(tResult); + } catch (error, stackTrace) { + tCompleter.completeError(error, stackTrace); + } + }); + + return tCompleter.future; + } +} + +/// Executes [func] asynchronously. +/// If this application is active and rendering, it will use +/// [SchedulerBinding.addPostFrameCallback], ensuring that it will run +/// with a call to [SchedulerBinding.scheduleFrame]. +/// If the application is not active and rendering, ie, in the background, +/// it will simply add a 1ms timer and execute [func] after that time. +void scheduleFunction(VoidCallback func) { + if (SchedulerBinding.instance.framesEnabled == true) { + SchedulerBinding.instance.scheduleFrame(); + // This is here to allow test frameworks to call pump() correctly. + if (onPostFrameCallback != null) { + onPostFrameCallback!(); + } + + SchedulerBinding.instance.addPostFrameCallback((_) { + func(); + }); + + return; + } + // coverage:ignore-start + Timer(const Duration(milliseconds: 1), func); + // coverage:ignore-end +} + +extension DateDateTimeExtension on DateTime { + /// Dart's [DateTime.toIso8601String] function includes milliseconds and microseconds. + /// Many backend systems don't support this, and for the most part, time information + /// stored is fine if stored with second accuracy only. + /// + /// This function returns a [String] in ISO8601 format, in UTC, down to second accuracy. + String toUTCIso8601StringNoMSUS() { + if (!isUtc) { + return toUtc().toUTCIso8601StringNoMSUS(); + } + + String y = (year >= -9999 && year <= 9999) + ? '$year'.padLeft(4, '0') + : '$year'.padLeft(6, '0'); + String m = '$month'.padLeft(2, '0'); + String d = '$day'.padLeft(2, '0'); + String h = '$hour'.padLeft(2, '0'); + String min = '$minute'.padLeft(2, '0'); + String sec = '$second'.padLeft(2, '0'); + + return '$y-$m-${d}T$h:$min:${sec}Z'; + } +} + +const _kFakeNowLocalConfigKey = 'patapataFakeNow'; +DateTime? _now; +final _fakeTimeElapsedSince = Stopwatch(); + +/// Set a fake time that [now] will return. +/// Set to null to return to real time again. +/// +/// If [persist] is set to true, +/// it is persisted between restarts by saving the time to [LocalConfig]. +/// +/// If [elapse] is set to true, the time returned from [now] +/// will be [fakeNow] plus the elapsed time since this function +/// was executed. +/// This allows for syncing time to say, a remote server. +/// +/// Warning: +/// Using [elapse] set to true in combination with [persist] set to true +/// will result in only [fakeNow] being persisted, causing the value +/// loaded on app restart to be exactly [fakeNow] and not any time that +/// has elapsed after it was saved. +void setFakeNow( + DateTime? fakeNow, { + bool persist = true, + bool elapse = false, +}) { + _now = fakeNow; + + if (elapse) { + _fakeTimeElapsedSince + ..reset() + ..start(); + } else { + _fakeTimeElapsedSince.stop(); + } + + if (persist) { + if (fakeNow == null) { + getApp().localConfig.reset(_kFakeNowLocalConfigKey); + } else { + getApp().localConfig.setString( + _kFakeNowLocalConfigKey, fakeNow.toUTCIso8601StringNoMSUS()); + } + } + + _fakeNowStreamController.add(fakeNow); +} + +/// Load the saved fake time from [LocalConfig], previously set by [setFakeNow]. +void loadFakeNow() { + final tFakeNowString = + getApp().localConfig.getString(_kFakeNowLocalConfigKey); + + if (tFakeNowString.isEmpty) { + return; + } + + final tDateTime = DateTime.tryParse(tFakeNowString); + + if (tDateTime == null) { + return; + } + + _now = tDateTime; +} + +/// Whether is fake time is currently set or not via [setFakeNow]. +bool get fakeNowSet => _now != null; + +final _fakeNowStreamController = StreamController.broadcast(); + +/// A stream to listen to when fake now changes. +Stream get fakeNowStream => _fakeNowStreamController.stream; + +/// Get the current [DateTime]. +/// The value returned here can be overriden for +/// debug or testing purposes with [setFakeNow]. +DateTime get now => + (_fakeTimeElapsedSince.isRunning && _now != null + ? _now!.add(_fakeTimeElapsedSince.elapsed) + : _now) ?? + DateTime.now(); + +/// Typedef for the inline onCancel callback. +@visibleForTesting +typedef TestMockStreamHandlerOnCancelCallback = void Function( + Object? arguments); + +/// Typedef for the inline onListen callback. +@visibleForTesting +typedef TestMockStreamHandlerOnListenCallback = void Function( + Object? arguments, TestMockStreamHandlerEventSink events); + +/// Test class for testing stream handlers. +/// The app does not reference this class. +@visibleForTesting +abstract class TestMockStreamHandler { + /// Create a [TestMockStreamHandler]. + TestMockStreamHandler(); + + /// Create a new inline [TestMockStreamHandler] with the given [onListen] and + /// [onCancel] handlers. + factory TestMockStreamHandler.inline({ + required TestMockStreamHandlerOnListenCallback onListen, + TestMockStreamHandlerOnCancelCallback? onCancel, + }) => + _InlineMockStreamHandler(onListen: onListen, onCancel: onCancel); + + /// Handler for the listen event. + void onListen(Object? arguments, TestMockStreamHandlerEventSink events); + + /// Handler for the cancel event. + void onCancel(Object? arguments); +} + +class _InlineMockStreamHandler extends TestMockStreamHandler { + _InlineMockStreamHandler({ + required TestMockStreamHandlerOnListenCallback onListen, + TestMockStreamHandlerOnCancelCallback? onCancel, + }) : _onListenInline = onListen, + _onCancelInline = onCancel; + + final TestMockStreamHandlerOnListenCallback _onListenInline; + final TestMockStreamHandlerOnCancelCallback? _onCancelInline; + + @override + void onListen(Object? arguments, TestMockStreamHandlerEventSink events) => + _onListenInline(arguments, events); + + @override + void onCancel(Object? arguments) => _onCancelInline?.call(arguments); +} + +/// Class for events referenced in [TestMockStreamHandler.onListen]. +/// The app does not reference this class. +@visibleForTesting +abstract class TestMockStreamHandlerEventSink { + /// Send a success event. + void success(Object? event); + + /// Send an error event. + void error({ + required String code, + String? message, + Object? details, + }); + + /// Send an end of stream event. + void endOfStream(); +} diff --git a/packages/patapata_core/lib/src/widgets/platform_dialog.dart b/packages/patapata_core/lib/src/widgets/platform_dialog.dart new file mode 100644 index 0000000..bd1761b --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/platform_dialog.dart @@ -0,0 +1,183 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// ignore_for_file: sort_child_properties_last + +import 'package:flutter/cupertino.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; + +final _queue = SequentialWorkQueue(); + +/// The set of actions that are displayed at the bottom of the dialog. +/// +/// On iOS, [CupertinoDialogAction] is used, and on other platforms, [TextButton] is used. +class PlatformDialogAction { + /// The callback that is called when the button is tapped or otherwise + /// activated. + /// + /// This is called when the dialog is popped, and its return value becomes the + /// return value of [PlatformDialog.show]. + final T Function() result; + + /// The callback that is called when the button is tapped or otherwise + /// activated. + /// + /// This is called after the dialog has been popped. + final VoidCallback? action; + + /// Whether this action destroys an object. + /// + /// This value is effective on iOS only. + final bool isDestructive; + + /// Set to true if button is the default choice in the dialog. + /// + /// This value is effective on iOS only. + final bool isDefault; + + /// Text to display on the button. + /// + /// If [child] is provided, this value is ignored. + final String? text; + + /// Widget to display as a button. + /// + /// If not specified, it displays [text] using the [Text] widget. + final Widget? child; + + const PlatformDialogAction({ + required this.result, + this.action, + this.isDestructive = false, + this.isDefault = false, + this.text, + this.child, + }) : assert(text != null || child != null); +} + +/// By calling [show], a dialog styled according to each platform will be displayed. +/// This wraps Flutter's [showDialog] to match the style of each platform. +/// +/// On iOS, [CupertinoAlertDialog] is used, and on other platforms, [AlertDialog] is used. +class PlatformDialog { + /// Displays a dialog. + /// + /// When the dialog is popped, [PlatformDialogAction.result] is called and its + /// return value becomes the result of the Future. + static Future show({ + required BuildContext context, + required List> actions, + String? title, + String? message, + Widget? content, + bool barrierDismissible = true, + Color? barrierColor = Colors.black54, + String? barrierLabel, + bool useSafeArea = true, + bool useRootNavigator = true, + RouteSettings? routeSettings, + Offset? anchorPoint, + Function()? onClose, + }) async { + assert(content != null || message != null); + + return _queue.add(() { + if (context.owner == null) { + return null; + } + + return showDialog( + context: context, + builder: (context) => _PlatformAlertDialog( + content: content ?? Text(message!), + actions: actions, + title: title, + ), + barrierDismissible: barrierDismissible, + barrierColor: barrierColor, + barrierLabel: barrierLabel, + useSafeArea: useSafeArea, + useRootNavigator: useRootNavigator, + routeSettings: routeSettings, + anchorPoint: anchorPoint, + ); + }); + } +} + +class _PlatformAlertDialog extends StatelessWidget { + const _PlatformAlertDialog({ + Key? key, + required this.content, + required this.actions, + this.title, + }) : super(key: key); + + final String? title; + final Widget content; + final List> actions; + + @override + Widget build(BuildContext context) { + if (defaultTargetPlatform == TargetPlatform.iOS || + defaultTargetPlatform == TargetPlatform.macOS) { + return CupertinoAlertDialog( + title: title != null ? Text(title!) : null, + // Add a Material so you can use Material library Widgets + // as a child. + content: Material( + child: SingleChildScrollView(child: content), + color: Colors.transparent, + ), + actions: actions.map((action) { + return CupertinoDialogAction( + isDefaultAction: action.isDefault, + isDestructiveAction: action.isDestructive, + child: action.child ?? + Text( + action.text!, + textAlign: TextAlign.center, + ), + onPressed: () { + Navigator.pop(context, action.result()); + action.action?.call(); + }, + ); + }).toList(), + ); + } + + final tTheme = Theme.of(context); + + return Theme( + data: ThemeData.from( + colorScheme: tTheme.colorScheme, + useMaterial3: tTheme.useMaterial3, + ), + child: AlertDialog( + title: title != null ? Text(title!) : null, + content: SingleChildScrollView(child: content), + actions: actions.map((action) { + return TextButton( + child: action.child ?? + Text( + action.text!, + textAlign: TextAlign.end, + ), + onPressed: () { + Navigator.pop(context, action.result()); + action.action?.call(); + }, + ); + }).toList(), + titlePadding: const EdgeInsets.fromLTRB(24, 24, 24, 0), + contentPadding: EdgeInsets.fromLTRB(24, title != null ? 16 : 24, 24, 0), + actionsPadding: const EdgeInsets.fromLTRB(24, 24, 24, 16), + ), + ); + } +} diff --git a/packages/patapata_core/lib/src/widgets/screen_layout.dart b/packages/patapata_core/lib/src/widgets/screen_layout.dart new file mode 100644 index 0000000..c42d821 --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/screen_layout.dart @@ -0,0 +1,562 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:math'; + +import 'package:flutter/rendering.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:provider/provider.dart'; + +/// Application screen layout settings. Used in [ScreenLayout.breakpoints]. +mixin ScreenLayoutEnvironment { + /// Map of names and their configuration values for [ScreenLayoutBreakpoints]. + Map get screenLayoutBreakpoints; +} + +/// A class representing breakpoints for screen layout. Breakpoints refer to the widths determined by the application's design. +/// You can set the breakpoints for portrait mode and landscape mode ([portraitStandardBreakpoint], [landscapeStandardBreakpoint]), +/// as well as width constraints for portrait mode and landscape mode ([portraitConstrainedWidth], [landscapeConstrainedWidth]). +/// Additionally, by setting [maxScale], you can limit the scale to prevent the RenderSize of child elements from exceeding it. +/// Pass these settings to [ScreenLayout.breakpoints]. +/// +/// example: +/// ```dart +/// ScreenLayout( +/// breakpoints: const ScreenLayoutBreakpoints( +/// portraitStandardBreakpoint: 375.0, +/// portraitConstrainedWidth: double.infinity, +/// landscapeStandardBreakpoint: 375.0, +/// landscapeConstrainedWidth: double.infinity, +/// maxScale: 1.2, +/// ), +/// child: HogehogeWidget(), +/// ), +/// ``` +class ScreenLayoutBreakpoints { + /// This function creates a breakpoint with the specified [name]. + /// You can specify the portrait breakpoint ([portraitStandardBreakpoint]) and its width constraint ([portraitConstrainedWidth]), + /// as well as the landscape breakpoint ([landscapeStandardBreakpoint]) and its width constraint ([landscapeConstrainedWidth]). + /// The [maxScale] is a value that limits the scale to ensure it does not exceed the RenderSize of the child element. + const ScreenLayoutBreakpoints({ + this.name, + required this.portraitStandardBreakpoint, + required this.portraitConstrainedWidth, + required this.landscapeStandardBreakpoint, + required this.landscapeConstrainedWidth, + required this.maxScale, + }); + + /// Name of the breakpoint + final String? name; + + /// Value of the breakpoint in portrait mode + final double portraitStandardBreakpoint; + + /// Value of the width constraint in portrait mode + final double portraitConstrainedWidth; + + /// Value of the breakpoint in landscape mode + final double landscapeStandardBreakpoint; + + /// Value of the width constraint in landscape mode + final double landscapeConstrainedWidth; + + /// Value to limit the scale to prevent the RenderSize of child elements from exceeding it + final double maxScale; + + /// Partially modifies the properties of the existing [ScreenLayoutBreakpoints]. + /// If a property is not specified, the existing value will be used. + ScreenLayoutBreakpoints copyWith({ + String? name, + double? portraitStandardBreakpoint, + double? portraitConstrainedWidth, + double? landscapeStandardBreakpoint, + double? landscapeConstrainedWidth, + double? maxScale, + }) { + return ScreenLayoutBreakpoints( + name: name ?? this.name, + portraitStandardBreakpoint: + portraitStandardBreakpoint ?? this.portraitStandardBreakpoint, + portraitConstrainedWidth: + portraitConstrainedWidth ?? this.portraitConstrainedWidth, + landscapeStandardBreakpoint: + landscapeStandardBreakpoint ?? this.landscapeStandardBreakpoint, + landscapeConstrainedWidth: + landscapeConstrainedWidth ?? this.landscapeConstrainedWidth, + maxScale: maxScale ?? this.maxScale, + ); + } + + @override + operator ==(Object other) => other is ScreenLayoutBreakpoints + ? name == other.name && + portraitStandardBreakpoint == other.portraitStandardBreakpoint && + portraitConstrainedWidth == other.portraitConstrainedWidth && + landscapeStandardBreakpoint == other.landscapeStandardBreakpoint && + landscapeConstrainedWidth == other.landscapeConstrainedWidth && + maxScale == other.maxScale + : false; + + @override + int get hashCode => Object.hash( + name, + portraitStandardBreakpoint, + portraitConstrainedWidth, + landscapeStandardBreakpoint, + landscapeConstrainedWidth, + maxScale, + ); +} + +/// A class that defines default screen layout breakpoints. +class ScreenLayoutDefaultBreakpoints { + /// A default breakpoint named 'normal'. + /// The breakpoint values for [ScreenLayoutBreakpoints.portraitStandardBreakpoint] and [ScreenLayoutBreakpoints.landscapeStandardBreakpoint] are `375.0`. + /// The constrained width values for [ScreenLayoutBreakpoints.portraitConstrainedWidth] and [ScreenLayoutBreakpoints.landscapeConstrainedWidth] are `482.0`. + /// The maximum scale value for [ScreenLayoutBreakpoints.maxScale] is `1.2`. + static const normal = ScreenLayoutBreakpoints( + name: 'normal', + portraitStandardBreakpoint: 375.0, + portraitConstrainedWidth: 16.0 + 450.0 + 16.0, + landscapeStandardBreakpoint: 375.0, + landscapeConstrainedWidth: 16.0 + 450.0 + 16.0, + maxScale: 1.2, + ); + + /// A default breakpoint named 'large'. + /// The breakpoint values for [ScreenLayoutBreakpoints.portraitStandardBreakpoint] and [ScreenLayoutBreakpoints.landscapeStandardBreakpoint] are `812.0`. + /// The constrained width values for [ScreenLayoutBreakpoints.portraitConstrainedWidth] and [ScreenLayoutBreakpoints.landscapeConstrainedWidth] are `1006.4`. + /// The maximum scale value for [ScreenLayoutBreakpoints.maxScale] is `1.2`. + static const large = ScreenLayoutBreakpoints( + name: 'large', + portraitStandardBreakpoint: 812.0, + portraitConstrainedWidth: 16.0 + 974.4 + 16.0, + landscapeStandardBreakpoint: 812.0, + landscapeConstrainedWidth: 16.0 + 974.4 + 16.0, + maxScale: 1.2, + ); + + /// The Map of default screen layout breakpoints. + static Map toMap() { + return { + 'normal': normal, + 'large': large, + }; + } +} + +/// A widget that will layout [child] at the given size in [breakpoints]. +/// [ScreenLayoutBreakpoints.portraitStandardBreakpoint] while in portrait mode, or +/// [ScreenLayoutBreakpoints.landscapeStandardBreakpoint] while in landscape mode. +/// After laying out at that size, [ScreenLayout] will scale the [child] so as to fix the current screen size, +/// up to a maximum scale ratio of [maxScale], or [ScreenLayoutBreakpoints.portraitConstrainedWidth] while in portrait mode, +/// or [ScreenLayoutBreakpoints.landscapeConstrainedWidth] while in landscape mode. +/// +/// This is useful for when you have a design where the base design is created with a given width, +/// and all UI elements are meant to be shown exactly as the design shows relative to the current device's screen size. +/// In other words, this widget will implement a non-responsive UI that automatically scales children up or down to match the current screen size. +/// It is usually a bad design practice to scale up to fullscreen on devices like a tablet or PC, and you can control the maximum things will scale by using the above-mentioned settings to avoid that and show a more reasonable UI design. +/// +/// example: +/// ```dart +/// ScreenLayout( +/// breakpoints: const ScreenLayoutBreakpoints( +/// portraitStandardBreakpoint: 375.0, +/// portraitConstrainedWidth: double.infinity, +/// landscapeStandardBreakpoint: 375.0, +/// landscapeConstrainedWidth: double.infinity, +/// maxScale: 1.2, +/// ), +/// child: HogehogeWidget(), +/// ), +/// ``` +class ScreenLayout extends SingleChildRenderObjectWidget { + /// Creates a [ScreenLayout] with the name [name] that adjusts the size of the widget specified in [child] based on the configuration in [breakpoints]. + const ScreenLayout({ + super.key, + super.child, + this.breakpoints, + this.name, + }); + + /// Creates a [ScreenLayout] with the name [name] that adjusts the size of the widget specified in [child]. + factory ScreenLayout.named({ + Key? key, + Widget? child, + required String name, + }) { + return ScreenLayout( + key: key, + name: name, + child: child, + ); + } + + /// Breakpoints for adjusting the size of the widget. + final ScreenLayoutBreakpoints? breakpoints; + + /// Name of the [ScreenLayout] widget. + final String? name; + + ScreenLayoutBreakpoints _getTargetBreakpoints(BuildContext context) { + ScreenLayoutBreakpoints? tBreakpoints = breakpoints; + if (tBreakpoints == null && name != null) { + final tEnvironment = context.read().environment; + if (tEnvironment is ScreenLayoutEnvironment) { + // It is assumed that defaults will be overridden. + final tBreakpointsMap = { + ...ScreenLayoutDefaultBreakpoints.toMap(), + ...tEnvironment.screenLayoutBreakpoints, + }; + tBreakpoints = tBreakpointsMap[name]; + } + } + + return tBreakpoints ?? ScreenLayoutDefaultBreakpoints.normal; + } + + @override + RenderObject createRenderObject(BuildContext context) { + return _ScreenLayoutRenderObject( + breakpoints: _getTargetBreakpoints(context), + orientation: MediaQuery.of(context).orientation, + ); + } + + @override + void updateRenderObject( + BuildContext context, + // ignore: library_private_types_in_public_api + covariant _ScreenLayoutRenderObject renderObject, + ) { + renderObject.breakpoints = _getTargetBreakpoints(context); + renderObject.orientation = MediaQuery.of(context).orientation; + } +} + +class _ScreenLayoutRenderObject extends RenderBox + with RenderObjectWithChildMixin { + Orientation _orientation; + set orientation(Orientation value) { + if (_orientation != value) { + _orientation = value; + markNeedsLayout(); + markNeedsPaint(); + } + } + + ScreenLayoutBreakpoints _breakpoints; + set breakpoints(ScreenLayoutBreakpoints value) { + if (_breakpoints != value) { + _breakpoints = value; + markNeedsLayout(); + markNeedsPaint(); + } + } + + late Matrix4 _transform; + late double _scale; + + _ScreenLayoutRenderObject({ + required ScreenLayoutBreakpoints breakpoints, + required Orientation orientation, + }) : _breakpoints = breakpoints, + _orientation = orientation; + + double get standardBreakpoint { + switch (_orientation) { + case Orientation.portrait: + return _breakpoints.portraitStandardBreakpoint; + case Orientation.landscape: + return _breakpoints.landscapeStandardBreakpoint; + } + } + + double get constrainedWidth { + switch (_orientation) { + case Orientation.portrait: + return _breakpoints.portraitConstrainedWidth; + case Orientation.landscape: + return _breakpoints.landscapeConstrainedWidth; + } + } + + @override + bool get alwaysNeedsCompositing => true; + + @override + bool get isRepaintBoundary => false; + + @override + void performLayout() { + final tChild = child; + final tWidth = constraints + .enforce(BoxConstraints.loose(Size(constrainedWidth, double.infinity))) + .constrainWidth(); + + if (tWidth.isInfinite || tWidth == 0) { + _transform = Matrix4.identity(); + _scale = 1.0; + } else { + _scale = min(_breakpoints.maxScale, tWidth / standardBreakpoint); + _transform = Matrix4.identity()..scale(_scale, _scale, _scale); + } + + if (tChild != null) { + tChild.layout( + BoxConstraints( + minWidth: constrainedWidth.isInfinite + ? constraints.minWidth / _scale + : standardBreakpoint, + maxWidth: constrainedWidth.isInfinite + ? constraints.maxWidth / _scale + : standardBreakpoint, + minHeight: constraints.minHeight / _scale, + maxHeight: constraints.maxHeight / _scale, + ), + parentUsesSize: true, + ); + } + + if (tChild is RenderBox) { + size = constraints.constrain(Size(tWidth, tChild.size.height * _scale)); + _transform.translate( + (tWidth - tChild.size.width * _scale) / 2, + (size.height - tChild.size.height * _scale) / 2, + ); + } else { + // coverage:ignore-start + size = constraints.constrain(Size(tWidth, 0)); + // coverage:ignore-end + } + } + + @override + bool hitTest(BoxHitTestResult result, {required Offset position}) { + return hitTestChildren(result, position: position); + } + + @override + bool hitTestChildren(BoxHitTestResult result, {required Offset position}) { + if (child == null) { + return false; + } + + return result.addWithPaintTransform( + transform: _transform, + position: position, + hitTest: (BoxHitTestResult result, Offset position) { + final tChild = child; + + if (tChild is RenderBox) { + return tChild.hitTest(result, position: position); + } + + return false; + }, + ); + } + + @override + void paint(PaintingContext context, Offset offset) { + if (child == null) { + return; + } + + Offset? tChildOffset = MatrixUtils.getAsTranslation(_transform); + + if (tChildOffset == null) { + // if the matrix is singular the children would be compressed to a line or + // single point, instead short-circuit and paint nothing. + final double tDet = _transform.determinant(); + // coverage:ignore-start + if (tDet == 0 || !tDet.isFinite) { + layer = null; + return; + } + // coverage:ignore-end + + layer = context.pushTransform( + needsCompositing, + offset, + _transform, + (context, offset) { + context.paintChild(child!, offset); + }, + oldLayer: layer is TransformLayer ? layer as TransformLayer? : null, + ); + } else { + context.paintChild(child!, offset + tChildOffset); + layer = null; + } + } + + @override + void applyPaintTransform(RenderBox child, Matrix4 transform) { + transform.multiply(_transform); + } +} + +/// A widget that disables the screen layout of the child widget [child]. +class ScreenLayoutDisable extends SingleChildRenderObjectWidget { + /// Create a [ScreenLayoutDisable] + /// [child] is the widget for which the screen layout is to be disabled. + const ScreenLayoutDisable({ + super.key, + super.child, + }); + + @override + RenderObject createRenderObject(BuildContext context) => + _ScreenLayoutDisableRenderObject(); +} + +class _ScreenLayoutDisableRenderObject extends RenderBox + with RenderObjectWithChildMixin { + late Matrix4 _transform; + late double _scale; + + _ScreenLayoutDisableRenderObject(); + + @override + bool get alwaysNeedsCompositing => true; + + @override + bool get isRepaintBoundary => false; + + @override + void performLayout() { + double tParentScale = 1.0; + RenderObject? tNode = parent; + + while (tNode != null) { + if (tNode is _ScreenLayoutRenderObject) { + tParentScale /= tNode._scale; + break; + } + + tNode = tNode.parent; + } + + final tChild = child; + _scale = tParentScale; + _transform = Matrix4.identity()..scale(_scale, _scale, _scale); + + if (tChild != null) { + tChild.layout( + BoxConstraints( + minWidth: constraints.minWidth / _scale, + maxWidth: constraints.maxWidth / _scale, + minHeight: constraints.minHeight / _scale, + maxHeight: constraints.maxHeight / _scale, + ), + parentUsesSize: true, + ); + } + + if (tChild is RenderBox) { + size = constraints.constrain( + Size(tChild.size.width * _scale, tChild.size.height * _scale)); + _transform.translate( + (size.width - tChild.size.width * _scale) / 2, + (size.height - tChild.size.height * _scale) / 2, + ); + } else { + // coverage:ignore-start + size = const Size(0, 0); + // coverage:ignore-end + } + } + + @override + bool hitTest(BoxHitTestResult result, {required Offset position}) { + return hitTestChildren(result, position: position); + } + + @override + bool hitTestChildren(BoxHitTestResult result, {required Offset position}) { + if (child == null) { + return false; + } + + return result.addWithPaintTransform( + transform: _transform, + position: position, + hitTest: (BoxHitTestResult result, Offset position) { + final tChild = child; + + if (tChild is RenderBox) { + return tChild.hitTest(result, position: position); + } + + return false; + }, + ); + } + + @override + void paint(PaintingContext context, Offset offset) { + if (child == null) { + return; + } + + final Offset? tChildOffset = MatrixUtils.getAsTranslation(_transform); + + if (tChildOffset == null) { + // if the matrix is singular the children would be compressed to a line or + // single point, instead short-circuit and paint nothing. + final double tDet = _transform.determinant(); + // coverage:ignore-start + if (tDet == 0 || !tDet.isFinite) { + layer = null; + return; + } + // coverage:ignore-end + + layer = context.pushTransform( + needsCompositing, + offset, + _transform, + (context, offset) { + context.paintChild(child!, offset); + }, + oldLayer: layer is TransformLayer ? layer as TransformLayer? : null, + ); + } else { + context.paintChild(child!, offset + tChildOffset); + layer = null; + } + } + + @override + void applyPaintTransform(RenderBox child, Matrix4 transform) { + transform.multiply(_transform); + } +} + +/// An extension class that adds the screen layout scaling functionality to [BuildContext]. +extension ScreenLayoutContext on BuildContext { + /// The scale value of the screen layout. + double get screenLayoutScale { + double tScale = 1.0; + + visitAncestorElements((element) { + final tRenderObject = element.renderObject; + + if (tRenderObject is _ScreenLayoutRenderObject) { + tScale = tRenderObject._scale; + return false; + } else if (tRenderObject is _ScreenLayoutDisableRenderObject) { + return false; + } + + return true; + }); + + return tScale; + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_app.dart b/packages/patapata_core/lib/src/widgets/standard_app.dart new file mode 100644 index 0000000..85e4e6e --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_app.dart @@ -0,0 +1,528 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:collection/collection.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter/cupertino.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:provider/provider.dart'; + +part 'standard_page.dart'; +part 'standard_page_widget.dart'; +part 'standard_app_mixin.dart'; +part 'standard_material_app.dart'; +part 'standard_cupertino_app.dart'; + +final _logger = Logger('patapata.StandardApp'); + +/// The [BuildContext] directly below [StandardMaterialApp]'s [Navigator] +Element? _findTreeChildElement(List tree) { + final Element? tRoot = WidgetsBinding.instance.rootElement; + Element? tResult; + + if (tRoot == null) { + return null; + } + for (Type tElementType in tree) { + tResult = _findChildElement(tResult ?? tRoot, tElementType); + + if (tResult == null) { + return null; + } + } + + tResult!.visitChildElements((tChild) { + tResult = tChild; + }); + + return tResult; +} + +Element? _findChildElement( + Element element, + Type elementType, +) { + Element? tResult; + + if (element.widget.runtimeType == elementType) { + return element; + } else { + element.visitChildElements((tChild) { + tResult = _findChildElement(tChild, elementType); + }); + + return tResult; + } +} + +/// A typedef for the key of a `LinkHandler` used in [StandardAppPlugin]. +typedef StandardAppPluginLinkHandlerKey = Object; + +/// A plugin that embodies the fundamental concepts of Patapata, +/// which includes rules, pages, and settings for app development, known as `StandardApp`. +/// This plugin is enabled by default. +/// If you want to disable `StandardApp`, you can remove this plugin using [App.removePlugin] +/// or disable it through remote configuration settings after running. +class StandardAppPlugin extends Plugin with StartupNavigatorMixin { + StandardRouterDelegate? _delegate; + + /// The [RouterDelegate] required for Patapata's `Router`. + StandardRouterDelegate? get delegate => _delegate; + + StandardRouteInformationParser? _parser; + + /// The [RouteInformationParser] required for Patapata's `Router`. + StandardRouteInformationParser? get parser => _parser; + + StreamSubscription? _sub; + + @override + FutureOr init(App app) async { + await super.init(app); + + _sub = app.analytics.events.listen((event) { + if (event.name == 'wefwef') { + // do something + } + }); + + return true; + } + + @override + FutureOr dispose() { + _sub?.cancel(); + return super.dispose(); + } + + final _linkHandlers = {}; + + /// Add a callback function [callback] to the plugin's link handlers and return the key that identifies the added link handler. + /// The link handler intercepts the link provided as an argument in [StandardAppRouterContext.route]. + /// It is used when you want to perform additional processing when receiving deep links or external notifications without triggering page navigation. + StandardAppPluginLinkHandlerKey addLinkHandler( + bool Function(Uri link) callback) { + final tKey = StandardAppPluginLinkHandlerKey(); + + _linkHandlers[tKey] = callback; + + return tKey; + } + + /// Remove a link handler from the plugin that matches the specified key [key]. + void removeLinkHandler(StandardAppPluginLinkHandlerKey key) { + _linkHandlers.remove(key); + } + + /// {@template patapata_widgets.StandardAppPlugin.route} + /// Navigate to a page with the specified [link]. + /// [link] is a string set in [StandardPageFactory] under `links`. + /// {@endtemplate} + void route(String link) async { + final tRouteInformation = await parser + ?.parseRouteInformation(RouteInformation(uri: Uri.parse(link))); + + if (tRouteInformation != null) { + delegate?.routeWithConfiguration(tRouteInformation); + } + } + + /// {@template patapata_widgets.StandardAppPlugin.generateLinkWithResult} + /// Retrieve a deep link for the specified [pageData] (when the page that retrieves the deep link returns a value). + /// [P] is the type of the destination page, [R] is the type of page data, and [E] is the data type of the value that the page returns. + /// These should be the same as what you set in your [StandardPageWithResultFactory]. + /// {@endtemplate} + String? generateLinkWithResult

, + R extends Object?, E extends Object?>(R pageData) { + return delegate?.getPageFactory().linkGenerator?.call(pageData); + } + + /// {@template patapata_widgets.StandardAppPlugin.generateLink} + /// Retrieve a deep link for the specified [pageData] (when the page that retrieves the deep link does not return a value). + /// [P] is the type of the destination page, [R] is the type of page data, and they should be consistent with what you have set in your [StandardPage]. + /// {@endtemplate} + String? generateLink

, R extends Object?>( + R pageData) { + return delegate?.getPageFactory().linkGenerator?.call(pageData); + } + + @override + void startupNavigateToPage(Object page, StartupPageCompleter completer) { + assert(page is Type); + + delegate?._getFactoryFromPageType(page as Type).goWithResult(completer); + } + + @override + void startupProcessInitialRoute() { + delegate?.processInitialRoute(); + } + + @override + void startupOnReset() { + delegate?._factoryTypeMap.values.first + .goWithResult(null, StandardPageNavigationMode.removeAll); + } +} + +/// A mixin for enabling integration between the 'Patapata' [Route] system and [Plugin], including routing and initialization processes. +/// The method implemented in this mixin is called within the processing of [StandardRouterDelegate.processInitialRoute] +/// when transitioning to the initial page after the app is launched. +/// +/// In each plugin, please override and implement the following functions as needed. +/// [parseRouteInformation] is responsible for parsing route information and implementing the process to convert it into [StandardRouteData]. This is implemented when you want to return custom routes on the plugin side. +/// [transformRouteInformation] is used to implement the transformation process of route information in the plugin, primarily when you want to handle redirection. +/// [getInitialRouteData] is used to implement the logic for overwriting the data of the Route before processing the initial route. +mixin StandardAppRoutePluginMixin on Plugin { + /// A function that parses the route information [routeInformation] and converts it to [StandardRouteData] for [StandardRouterDelegate]. + /// If the plugin's [parseRouteInformation] is implemented and returns a route, the processing of [transformRouteInformation] is ignored. + Future parseRouteInformation( + RouteInformation routeInformation) => + SynchronousFuture(null); + + /// A function to transform the route information [routeInformation] into another transformed route information [RouteInformation]. + /// This needs to be implemented when you want to redirect from one route to another based on the received route on the plugin side. + Future transformRouteInformation( + RouteInformation routeInformation) => + SynchronousFuture(null); + + /// The process of creating [StandardRouteData] to be passed from the plugin to the screen, and this data is passed to [StandardRouterDelegate.routeWithConfiguration]. + /// If multiple plugins implement [getInitialRouteData], the [getInitialRouteData] of the first found plugin will be executed. + Future getInitialRouteData() => SynchronousFuture(null); + + /// Create a [StandardAppRoutePluginMixin] that can be used in [App.addPlugin]. + /// This takes all the same parameters as [Plugin.inline] as well as all the methods of [StandardAppRoutePluginMixin]. + static StandardAppRoutePluginMixin inline({ + String name = 'inline', + List dependencies = const [], + bool requireRemoteConfig = false, + FutureOr Function(App app)? init, + FutureOr Function()? dispose, + Widget Function(Widget child)? createAppWidgetWrapper, + RemoteConfig? Function()? createRemoteConfig, + LocalConfig? Function()? createLocalConfig, + RemoteMessaging? Function()? createRemoteMessaging, + List Function()? navigatorObservers, + Future Function(RouteInformation routeInformation)? + parseRouteInformation, + Future Function(RouteInformation routeInformation)? + transformRouteInformation, + Future Function()? getInitialRouteData, + }) => + _StandardAppRoutePluginMixinInline( + name: name, + dependencies: dependencies, + requireRemoteConfig: requireRemoteConfig, + init: init, + dispose: dispose, + createAppWidgetWrapper: createAppWidgetWrapper, + createRemoteConfig: createRemoteConfig, + createLocalConfig: createLocalConfig, + createRemoteMessaging: createRemoteMessaging, + navigatorObservers: navigatorObservers, + parseRouteInformation: parseRouteInformation, + transformRouteInformation: transformRouteInformation, + getInitialRouteData: getInitialRouteData, + ); +} + +class _StandardAppRoutePluginMixinInline extends InlinePlugin + with StandardAppRoutePluginMixin { + final Future Function(RouteInformation routeInformation)? + _parseRouteInformation; + final Future Function(RouteInformation routeInformation)? + _transformRouteInformation; + final Future Function()? _getInitialRouteData; + + _StandardAppRoutePluginMixinInline({ + required super.name, + super.dependencies, + super.requireRemoteConfig, + super.init, + super.dispose, + super.createAppWidgetWrapper, + super.createRemoteConfig, + super.createLocalConfig, + super.createRemoteMessaging, + super.navigatorObservers, + Future Function(RouteInformation routeInformation)? + parseRouteInformation, + Future Function(RouteInformation routeInformation)? + transformRouteInformation, + Future Function()? getInitialRouteData, + }) : _parseRouteInformation = parseRouteInformation, + _transformRouteInformation = transformRouteInformation, + _getInitialRouteData = getInitialRouteData; + + @override + Future parseRouteInformation( + RouteInformation routeInformation) => + _parseRouteInformation != null + ? _parseRouteInformation!(routeInformation) + : super.parseRouteInformation(routeInformation); + + @override + Future transformRouteInformation( + RouteInformation routeInformation) => + _transformRouteInformation != null + ? _transformRouteInformation!(routeInformation) + : super.transformRouteInformation(routeInformation); + + @override + Future getInitialRouteData() => + _getInitialRouteData != null + ? _getInitialRouteData!() + : super.getInitialRouteData(); +} + +/// A mixin for allowing a [Plugin] to modify how a [StandardPage] or [StandardPageWithResult] works. +mixin StandardPagePluginMixin on Plugin { + /// A function that allows you to modify the [StandardPage] or [StandardPageWithResult] before it is displayed. + /// It will directly wrap the result of [StandardPage.buildPage] or [StandardPageWithResult.buildPage]. + /// + /// When there are multiple [Plugin]s, each [Plugin] will wrap the result of the previous [Plugin]. + /// In other words, the result of the first [Plugin] will be wrapped by the second [Plugin], and so on. + Widget buildPage(BuildContext context, Widget child); + + /// Create a [StandardPagePluginMixin] that can be used in [App.addPlugin]. + /// This takes all the same parameters as [Plugin.inline] as well as all the methods of [StandardPagePluginMixin]. + static StandardPagePluginMixin inline({ + String name = 'inline', + List dependencies = const [], + bool requireRemoteConfig = false, + FutureOr Function(App app)? init, + FutureOr Function()? dispose, + Widget Function(Widget child)? createAppWidgetWrapper, + RemoteConfig? Function()? createRemoteConfig, + LocalConfig? Function()? createLocalConfig, + RemoteMessaging? Function()? createRemoteMessaging, + List Function()? navigatorObservers, + required Widget Function(BuildContext context, Widget child) buildPage, + }) => + _StandardPagePluginMixinInline( + name: name, + dependencies: dependencies, + requireRemoteConfig: requireRemoteConfig, + init: init, + dispose: dispose, + createAppWidgetWrapper: createAppWidgetWrapper, + createRemoteConfig: createRemoteConfig, + createLocalConfig: createLocalConfig, + createRemoteMessaging: createRemoteMessaging, + navigatorObservers: navigatorObservers, + buildPage: buildPage, + ); +} + +class _StandardPagePluginMixinInline extends InlinePlugin + with StandardPagePluginMixin { + final Widget Function(BuildContext context, Widget child) _buildPage; + + _StandardPagePluginMixinInline({ + required super.name, + super.dependencies, + super.requireRemoteConfig, + super.init, + super.dispose, + super.createAppWidgetWrapper, + super.createRemoteConfig, + super.createLocalConfig, + super.createRemoteMessaging, + super.navigatorObservers, + required Widget Function(BuildContext context, Widget child) buildPage, + }) : _buildPage = buildPage; + + @override + Widget buildPage(BuildContext context, Widget child) { + return _buildPage(context, child); + } +} + +/// An extension class that adds the Router functionality of StandardApp to [Router]. +extension StandardAppRouter on Router { + /// {@macro patapata_widgets.StandardRouteDelegate.pageInstances} + List> get pageInstances { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + + return tDelegate.pageInstances; + } + + /// {@template patapata_widgets.StandardAppRouter.pageChildInstances} + /// Get a List of the actual pages of [Page]. + /// {@endtemplate} + Map>> get pageChildInstances { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + + return tDelegate._pageChildInstances; + } + + /// {@macro patapata_widgets.StandardRouteDelegate.getPageFactory} + StandardPageWithResultFactory getPageFactory< + T extends StandardPageWithResult, + R extends Object?, + E extends Object?>() { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + + return tDelegate.getPageFactory(); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.processInitialRoute} + void processInitialRoute() { + assert(routerDelegate is StandardRouterDelegate); + (routerDelegate as StandardRouterDelegate).processInitialRoute(); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.goWithResult} + Future goWithResult, + R extends Object?, E extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + return tDelegate.goWithResult(pageData, navigationMode); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.go} + Future go, R extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + return tDelegate.go(pageData, navigationMode); + } + + /// {@template patapata_widgets.StandardAppRouter.route} + /// Navigate to a page with the specified [location]. + /// [navigationMode] represents the mode of [StandardPageNavigationMode] to use during navigation (optional). + /// {@endtemplate} + void route(String location, + [StandardPageNavigationMode? navigationMode]) async { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + final tConfiguration = await routeInformationParser + ?.parseRouteInformation(RouteInformation(uri: Uri.parse(location))); + + if (tConfiguration != null) { + tDelegate.routeWithConfiguration(tConfiguration, navigationMode); + } + } + + /// Remove the nearest page in [context], if it exists. Do nothing if it doesn't exist. + void removeRoute(BuildContext context) { + assert(routerDelegate is StandardRouterDelegate); + final tDelegate = routerDelegate as StandardRouterDelegate; + + final tRoute = ModalRoute.of(context); + + if (tRoute == null) { + return; + } + + tDelegate.removeRoute(tRoute, null); + } +} + +/// An extension class that adds the Router functionality of StandardApp to [BuildContext]. +extension StandardAppRouterContext on BuildContext { + /// Retrieves the [Router]. + Router get router => Router.of(this); + + /// {@macro patapata_widgets.StandardRouteDelegate.goWithResult} + Future goWithResult, + R extends Object?, E extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return Router.of(this).goWithResult(pageData, navigationMode); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.go} + Future go, R extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return Router.of(this).go(pageData, navigationMode); + } + + /// {@macro patapata_widgets.StandardAppRouter.route} + void route(String location, [StandardPageNavigationMode? navigationMode]) { + Router.of(this).route(location, navigationMode); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.pageInstances} + List> get pageInstances => Router.of(this).pageInstances; + + /// {@macro patapata_widgets.StandardAppRouter.pageChildInstances} + Map>> get pageChildInstances => + Router.of(this).pageChildInstances; + + /// {@macro patapata_widgets.StandardRouteDelegate.getPageFactory} + StandardPageWithResultFactory getPageFactory< + T extends StandardPageWithResult, + R extends Object?, + E extends Object?>() { + return Router.of(this).getPageFactory(); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.removeRoute} + void removeRoute() { + Router.of(this).removeRoute(this); + } +} + +/// An extension class that adds references to the Router and Plugin functionalities of StandardApp to [App]. +extension StandardAppApp on App { + /// Retrieves [StandardAppPlugin] from the [App]. + StandardAppPlugin get standardAppPlugin { + final tPlugin = getPlugin(); + + assert(tPlugin != null, + 'Could not find StandardApp. Was it removed from the plugins?'); + + return tPlugin!; + } + + /// The BuildContext of the Navigator from [StandardAppPlugin.delegate]. + BuildContext get navigatorContext => + standardAppPlugin.delegate!.navigatorContext; + + /// The Navigator from [StandardAppPlugin.delegate]. + NavigatorState get navigator => standardAppPlugin.delegate!.navigator; + + /// {@macro patapata_widgets.StandardRouteDelegate.goWithResult} + Future goWithResult, + R extends Object?, E extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return navigatorContext.goWithResult(pageData, navigationMode); + } + + /// {@macro patapata_widgets.StandardRouteDelegate.goWithResult} + Future go, R extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return navigatorContext.go(pageData, navigationMode); + } + + /// {@macro patapata_widgets.StandardAppPlugin.route} + void route(String link) async { + return standardAppPlugin.route(link); + } + + /// Pops the Navigator of [StandardAppApp.navigator]. + /// This is used when context is not accessible. + void removeRoute() { + navigator.pop(); + } + + /// {@macro patapata_widgets.StandardAppPlugin.generateLinkWithResult} + String? generateLinkWithResult

, + R extends Object?, E extends Object?>(R pageData) { + return standardAppPlugin.generateLinkWithResult(pageData); + } + + /// {@macro patapata_widgets.StandardAppPlugin.generateLink} + String? generateLink

, R extends Object?>( + R pageData) { + return standardAppPlugin.generateLink(pageData); + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_app_mixin.dart b/packages/patapata_core/lib/src/widgets/standard_app_mixin.dart new file mode 100644 index 0000000..1cbac1c --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_app_mixin.dart @@ -0,0 +1,63 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +part of "standard_app.dart"; + +/// This is a mixin for StatefulWidget that is needed to create a `WidgetsApp.Router` for Patapata. +/// If you want to create your own `WidgetsApp.Router`, you can refer to [StandardMaterialApp] or [StandardCupertinoApp]. +mixin StandardStatefulMixin on StatefulWidget { + ///　A list of [StandardPageWithResultFactory] + List get pages; + + /// Wrap the entire Patapata Navigator-related application, + /// enabling the use of page transition-related functionalities through a function. + Widget Function(BuildContext context, Widget? child)? get routableBuilder; + + /// A function called when the app is attempting to go back to the previous page. + bool Function(Route route, dynamic result)? get willPopPage; +} + +/// This is a mixin for State that is needed to create a `WidgetsApp.Router` for Patapata. +/// If you want to create your own `WidgetsApp.Router`, you can refer to [StandardMaterialApp] or [StandardCupertinoApp]. +mixin StandardWidgetAppMixin on State { + late StandardRouteInformationParser _routeInformationParser; + late StandardRouterDelegate _routerDelegate; + + @override + void initState() { + super.initState(); + + _routerDelegate = StandardRouterDelegate( + context: context, + pageFactories: widget.pages, + routableBuilder: widget.routableBuilder, + willPopPage: widget.willPopPage, + ); + _routeInformationParser = StandardRouteInformationParser( + context: context, + routerDelegate: _routerDelegate, + ); + final tPlugin = context.read().getPlugin(); + tPlugin?._delegate = _routerDelegate; + tPlugin?._parser = _routeInformationParser; + } + + @override + void didUpdateWidget(covariant T oldWidget) { + super.didUpdateWidget(oldWidget); + + if (widget.routableBuilder != oldWidget.routableBuilder) { + _routerDelegate.routableBuilder = widget.routableBuilder; + } + + if (widget.willPopPage != oldWidget.willPopPage) { + _routerDelegate.willPopPage = widget.willPopPage; + } + + if (!const DeepCollectionEquality().equals(widget.pages, oldWidget.pages)) { + _routerDelegate._updatePageFactories(widget.pages); + } + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_cupertino_app.dart b/packages/patapata_core/lib/src/widgets/standard_cupertino_app.dart new file mode 100644 index 0000000..e12ffa0 --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_cupertino_app.dart @@ -0,0 +1,168 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +part of "standard_app.dart"; + +/// This class is used to create applications using Cupertino with Patapata. +/// Widgets that have this class as their parent cannot use widgets intended for use with [MaterialApp]. +/// Properties other than [pages], [routableBuilder], and [willPopPage] are the same as [CupertinoApp]. +class StandardCupertinoApp extends StatefulWidget + with StandardStatefulMixin { + /// {@macro flutter.widgets.widgetsApp.routeInformationProvider} + final RouteInformationProvider? routeInformationProvider; + + /// {@macro flutter.widgets.widgetsApp.backButtonDispatcher} + final BackButtonDispatcher? backButtonDispatcher; + + /// {@macro flutter.widgets.widgetsApp.routerConfig} + final RouterConfig? routerConfig; + + /// {@macro flutter.widgets.widgetsApp.builder} + final TransitionBuilder? builder; + + /// {@macro flutter.widgets.widgetsApp.onGenerateTitle} + final String Function(BuildContext) onGenerateTitle; + + /// A CupertinoThemeData to pass to [theme] of [CupertinoApp.router]. + /// See [CupertinoApp.theme] of [CupertinoApp] for more details. + final CupertinoThemeData? theme; + + /// {@macro flutter.widgets.widgetsApp.color} + final Color? color; + + /// {@macro flutter.widgets.widgetsApp.locale} + final Locale? locale; + + /// {@macro flutter.widgets.widgetsApp.localeListResolutionCallback} + final LocaleListResolutionCallback? localeListResolutionCallback; + + /// {@macro flutter.widgets.LocaleResolutionCallback} + final LocaleResolutionCallback? localeResolutionCallback; + + /// A bool to pass to [showPerformanceOverlay] of [CupertinoApp.router]. + /// See [CupertinoApp.showPerformanceOverlay] of [CupertinoApp] for more details. + final bool showPerformanceOverlay; + + /// A bool to pass to [checkerboardRasterCacheImages] of [CupertinoApp.router]. + /// See [CupertinoApp.checkerboardRasterCacheImages] of [CupertinoApp] for more details. + final bool checkerboardRasterCacheImages; + + /// A bool to pass to [checkerboardOffscreenLayers] of [CupertinoApp.router]. + /// See [CupertinoApp.checkerboardOffscreenLayers] of [CupertinoApp] for more details. + final bool checkerboardOffscreenLayers; + + /// A bool to pass to [showSemanticsDebugger] of [CupertinoApp.router]. + /// See [CupertinoApp.showSemanticsDebugger] of [CupertinoApp] for more details. + final bool showSemanticsDebugger; + + /// {@macro flutter.widgets.widgetsApp.debugShowCheckedModeBanner} + final bool debugShowCheckedModeBanner; + + /// {@macro flutter.widgets.widgetsApp.shortcuts.seeAlso} + final Map? shortcuts; + + /// {@macro flutter.widgets.widgetsApp.actions.seeAlso} + final Map>? actions; + + /// {@macro flutter.widgets.widgetsApp.restorationScopeId} + final String? restorationScopeId; + + /// {@macro flutter.material.materialApp.scrollBehavior} + final ScrollBehavior? scrollBehavior; + + final List _pages; + final Widget Function(BuildContext context, Widget? child)? _routableBuilder; + final bool Function(Route route, dynamic result)? _willPopPage; + + /// A list of pages using the [StandardPageFactory] class implemented with StandardMaterialApp. + /// It is passed to the pageFactories of [StandardRouterDelegate]. + @override + List< + StandardPageWithResultFactory, + Object?, Object?>> get pages => _pages; + + /// Wrap the entire Patapata Navigator-related application, + /// enabling the use of screen transition-related functionalities through a function. + /// It is passed to the routableBuilder of [StandardRouterDelegate]. + @override + Widget Function(BuildContext context, Widget? child)? get routableBuilder => + _routableBuilder; + + /// A function called when the app goes back to the previous page. + /// It is passed to the willPopPage of [StandardRouterDelegate]. + @override + bool Function(Route route, dynamic result)? get willPopPage => + _willPopPage; + + /// Creates a StandardCupertinoApp. + const StandardCupertinoApp({ + Key? key, + this.routeInformationProvider, + this.backButtonDispatcher, + this.routerConfig, + this.builder, + required this.onGenerateTitle, + this.theme, + this.color, + this.locale, + this.localeListResolutionCallback, + this.localeResolutionCallback, + this.showPerformanceOverlay = false, + this.checkerboardRasterCacheImages = false, + this.checkerboardOffscreenLayers = false, + this.showSemanticsDebugger = false, + this.debugShowCheckedModeBanner = true, + this.shortcuts, + this.actions, + this.restorationScopeId, + this.scrollBehavior, + required List pages, + Widget Function(BuildContext context, Widget? child)? routableBuilder, + bool Function(Route route, dynamic result)? willPopPage, + }) : _pages = pages, + _routableBuilder = routableBuilder, + _willPopPage = willPopPage, + super(key: key); + + @override + State createState() => _StandardCupertinoAppState(); +} + +class _StandardCupertinoAppState extends State> + with StandardWidgetAppMixin { + @override + Widget build(BuildContext context) { + return Provider.value( + value: StandardAppType.cupertino, + child: CupertinoApp.router( + routeInformationProvider: widget.routeInformationProvider, + routeInformationParser: _routeInformationParser, + routerDelegate: _routerDelegate, + backButtonDispatcher: widget.backButtonDispatcher, + routerConfig: widget.routerConfig, + builder: widget.builder, + onGenerateTitle: widget.onGenerateTitle, + color: widget.color, + theme: widget.theme, + locale: widget.locale, + localizationsDelegates: + context.read().getPlugin()!.i18n.l10nDelegates, + localeListResolutionCallback: widget.localeListResolutionCallback, + localeResolutionCallback: widget.localeResolutionCallback, + supportedLocales: + context.read().getPlugin()!.i18n.supportedL10ns, + showPerformanceOverlay: widget.showPerformanceOverlay, + checkerboardRasterCacheImages: widget.checkerboardRasterCacheImages, + checkerboardOffscreenLayers: widget.checkerboardOffscreenLayers, + showSemanticsDebugger: widget.showSemanticsDebugger, + debugShowCheckedModeBanner: widget.debugShowCheckedModeBanner, + shortcuts: widget.shortcuts, + actions: widget.actions, + restorationScopeId: widget.restorationScopeId, + scrollBehavior: widget.scrollBehavior, + ), + ); + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_material_app.dart b/packages/patapata_core/lib/src/widgets/standard_material_app.dart new file mode 100644 index 0000000..ed20316 --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_material_app.dart @@ -0,0 +1,204 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +part of "standard_app.dart"; + +/// This class is used to create applications using Material Design with Patapata. +/// Widgets that have this class as their parent cannot use widgets intended for use with [CupertinoApp]. +/// Properties other than [pages], [routableBuilder], and [willPopPage] are properties to be passed to [MaterialApp.router]. +class StandardMaterialApp extends StatefulWidget with StandardStatefulMixin { + /// A GlobalKey to pass to [scaffoldMessengerKey] of [MaterialApp.router]. + /// See [MaterialApp.scaffoldMessengerKey] of [MaterialApp] for more details. + final GlobalKey? scaffoldMessengerKey; + + /// {@macro flutter.widgets.widgetsApp.routeInformationProvider} + final RouteInformationProvider? routeInformationProvider; + + /// {@macro flutter.widgets.widgetsApp.backButtonDispatcher} + final BackButtonDispatcher? backButtonDispatcher; + + /// {@macro flutter.widgets.widgetsApp.builder} + final TransitionBuilder? builder; + + /// {@macro flutter.widgets.widgetsApp.onGenerateTitle} + final String Function(BuildContext) onGenerateTitle; + + /// A ThemeData to pass to [theme] of [MaterialApp.router]. + /// See [MaterialApp.theme] of [MaterialApp] for more details. + final ThemeData? theme; + + /// A ThemeData to pass to [darkTheme] of [MaterialApp.router]. + /// See [MaterialApp.darkTheme] of [MaterialApp] for more details. + final ThemeData? darkTheme; + + /// A ThemeData to pass to [highContrastTheme] of [MaterialApp.router]. + /// See [MaterialApp.highContrastTheme] of [MaterialApp] for more details. + final ThemeData? highContrastTheme; + + /// A ThemeData to pass to [highContrastDarkTheme] of [MaterialApp.router]. + /// See [MaterialApp.highContrastDarkTheme] of [MaterialApp] for more details. + final ThemeData? highContrastDarkTheme; + + /// A ThemeMode to pass to [themeMode] of [MaterialApp.router]. + /// See [MaterialApp.themeMode] of [MaterialApp] for more details. + final ThemeMode? themeMode; + + /// {@macro flutter.widgets.widgetsApp.color} + final Color? color; + + /// {@macro flutter.widgets.widgetsApp.locale} + final Locale? locale; + + /// {@macro flutter.widgets.widgetsApp.localeListResolutionCallback} + final LocaleListResolutionCallback? localeListResolutionCallback; + + /// {@macro flutter.widgets.LocaleResolutionCallback} + final LocaleResolutionCallback? localeResolutionCallback; + + /// A bool to pass to [showPerformanceOverlay] of [MaterialApp.router]. + /// See [MaterialApp.showPerformanceOverlay] of [MaterialApp] for more details. + final bool showPerformanceOverlay; + + /// A bool to pass to [checkerboardRasterCacheImages] of [MaterialApp.router]. + /// See [MaterialApp.checkerboardRasterCacheImages] of [MaterialApp] for more details. + final bool checkerboardRasterCacheImages; + + /// A bool to pass to [checkerboardOffscreenLayers] of [MaterialApp.router]. + /// See [MaterialApp.checkerboardOffscreenLayers] of [MaterialApp] for more details. + final bool checkerboardOffscreenLayers; + + /// A bool to pass to [showSemanticsDebugger] of [MaterialApp.router]. + /// See [MaterialApp.showSemanticsDebugger] of [MaterialApp] for more details. + final bool showSemanticsDebugger; + + /// A bool to pass to [debugShowCheckedModeBanner] of [MaterialApp.router]. + /// See [MaterialApp.debugShowCheckedModeBanner] of [MaterialApp] for more details. + final bool debugShowCheckedModeBanner; + + /// {@macro flutter.widgets.widgetsApp.shortcuts.seeAlso} + final Map? shortcuts; + + /// {@macro flutter.widgets.widgetsApp.actions.seeAlso} + final Map>? actions; + + /// {@macro flutter.widgets.widgetsApp.restorationScopeId} + final String? restorationScopeId; + + /// A ScrollBehavior to pass to [scrollBehavior] of [MaterialApp.router]. + /// See [MaterialApp.scrollBehavior] of [MaterialApp] for more details. + final ScrollBehavior? scrollBehavior; + + /// A bool to pass to [debugShowMaterialGrid] of [MaterialApp.router]. + /// See [MaterialApp.debugShowMaterialGrid] of [MaterialApp] for more details. + final bool debugShowMaterialGrid; + + final List _pages; + final Widget Function(BuildContext context, Widget? child)? _routableBuilder; + final bool Function(Route route, dynamic result)? _willPopPage; + + /// A list of pages using the [StandardPageFactory] class implemented with StandardMaterialApp. + /// It is passed to the pageFactories of [StandardRouterDelegate]. + @override + List< + StandardPageWithResultFactory, + Object?, Object?>> get pages => _pages; + + /// Wrap the entire Patapata Navigator-related application, + /// enabling the use of screen transition-related functionalities through a function. + /// It is passed to the routableBuilder of [StandardRouterDelegate]. + @override + Widget Function(BuildContext context, Widget? child)? get routableBuilder => + _routableBuilder; + + /// See [PopScope] for more details. + /// It is passed to the willPopPage of [StandardRouterDelegate]. + @override + bool Function(Route route, dynamic result)? get willPopPage => + _willPopPage; + + /// BuildContext directly under Navigator of StandardMaterialApp + static Element? get globalNavigatorContext => + _findTreeChildElement([StandardMaterialApp, Navigator]); + + /// Creates a StandardMaterialApp. + const StandardMaterialApp({ + Key? key, + this.scaffoldMessengerKey, + this.routeInformationProvider, + this.backButtonDispatcher, + this.builder, + required this.onGenerateTitle, + this.theme, + this.darkTheme, + this.highContrastTheme, + this.highContrastDarkTheme, + this.themeMode, + this.color, + this.locale, + this.localeListResolutionCallback, + this.localeResolutionCallback, + this.debugShowMaterialGrid = false, + this.showPerformanceOverlay = false, + this.checkerboardRasterCacheImages = false, + this.checkerboardOffscreenLayers = false, + this.showSemanticsDebugger = false, + this.debugShowCheckedModeBanner = true, + this.shortcuts, + this.actions, + this.restorationScopeId, + this.scrollBehavior, + required List pages, + Widget Function(BuildContext context, Widget? child)? routableBuilder, + bool Function(Route route, dynamic result)? willPopPage, + }) : _pages = pages, + _routableBuilder = routableBuilder, + _willPopPage = willPopPage, + super(key: key); + + @override + State> createState() => _StandardMaterialAppState(); +} + +class _StandardMaterialAppState extends State> + with StandardWidgetAppMixin { + @override + Widget build(BuildContext context) { + return Provider.value( + value: StandardAppType.material, + child: MaterialApp.router( + scaffoldMessengerKey: widget.scaffoldMessengerKey, + routeInformationProvider: widget.routeInformationProvider, + routeInformationParser: _routeInformationParser, + routerDelegate: _routerDelegate, + backButtonDispatcher: widget.backButtonDispatcher, + builder: widget.builder, + onGenerateTitle: widget.onGenerateTitle, + color: widget.color, + theme: widget.theme, + darkTheme: widget.darkTheme, + highContrastTheme: widget.highContrastTheme, + highContrastDarkTheme: widget.highContrastDarkTheme, + themeMode: widget.themeMode, + locale: widget.locale, + localizationsDelegates: + context.read().getPlugin()!.i18n.l10nDelegates, + localeListResolutionCallback: widget.localeListResolutionCallback, + localeResolutionCallback: widget.localeResolutionCallback, + supportedLocales: + context.read().getPlugin()!.i18n.supportedL10ns, + debugShowMaterialGrid: widget.debugShowMaterialGrid, + showPerformanceOverlay: widget.showPerformanceOverlay, + checkerboardRasterCacheImages: widget.checkerboardRasterCacheImages, + checkerboardOffscreenLayers: widget.checkerboardOffscreenLayers, + showSemanticsDebugger: widget.showSemanticsDebugger, + debugShowCheckedModeBanner: widget.debugShowCheckedModeBanner, + shortcuts: widget.shortcuts, + actions: widget.actions, + restorationScopeId: widget.restorationScopeId, + scrollBehavior: widget.scrollBehavior, + ), + ); + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_page.dart b/packages/patapata_core/lib/src/widgets/standard_page.dart new file mode 100644 index 0000000..ee6b5aa --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_page.dart @@ -0,0 +1,1952 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +part of "standard_app.dart"; + +const Key _childNavigatorKey = Key('childNavigatorKey'); + +/// Whether to use the Material app or the Cupertino app to design +enum StandardAppType { + /// Use standard material app + material, + + /// Use standard cupertino app + cupertino, +} + +/// Specifies how pages created with [StandardPageFactory] should be navigated +enum StandardPageNavigationMode { + /// Similar to [Navigator.push] used in Flutter's Navigator, it adds the page to the top of the history. + /// However, if there is already a page with the same page key in the history, + /// it moves that page to the top without removing other pages with the same page key from the history + moveToTop, + + /// If the same page exists within the history, all history from that page and up will be removed. + /// Then the page will be added to the top of the history. + /// If the same page does not exist within the history, it behaves the same as [moveToTop]. + removeAbove, + + /// After removing all pages from the history, add the page. + removeAll, + + /// Remove the current page from the history and replace it with the page being navigated to. + replace, +} + +/// A factory class for creating [StandardPageWithResult] instances that returns a value [E]. +/// This class can be added to the `pages` property of [StandardMaterialApp.new] or [StandardCupertinoApp.new]. +/// [T] is the Represents the data type of the destination page, [R] is the Represents the data type of the page data, [E] is the Represents the data type of the value returned by the page. +/// +/// For how to pass and configure this class in [StandardStatefulMixin.pages], please refer to the documentation of [StandardPageFactory]. +/// +/// The key distinction to [StandardPage] is that this class returns a value. +/// For example, a `PageWithResult` is a screen of type `StandardPageWithResult` that returns a result of type String. +/// +/// example: +/// ```dart +/// class PageWithResult extends StandardPageWithResult { +/// @override +/// Widget buildPage(BuildContext context) { +/// return Scaffold( +/// body: Center( +/// child: TextButton( +/// onPressed: () { +/// // Set the result of this StandardPageWithResult to the pageResult. +/// pageResult = 'pageResult'; +/// Navigator.pop(context); +/// }, +/// child: const Text('Navigator Pop Page'), +/// ), +/// ), +/// ); +/// } +/// } +/// ``` +/// +/// You can retrieve the result of `PageWithResult` as shown below, using [goWithResult] for navigation. +/// +/// example: +/// ```dart +/// final tResult = await context.goWithResult(null); +/// ``` +base class StandardPageWithResultFactory, + R extends Object?, E extends Object?> { + /// The default group name set when no group is specified for the page. + static const String defaultGroup = 'StandardPageDefaultGroup'; + + late final StandardRouterDelegate _delegate; + + /// Creates the [T] page that this factory manages. + final T Function(R pageData) create; + final Map _links; + + /// The function to create deep links for this page. + /// The return value must match the keys (regular expressions) passed to links and their corresponding [R] 'pageData' destinations. + final String Function(R pageData)? linkGenerator; + + /// The group name used to manage multiple pages as part of the same group when they exist. + final String? group; + + /// Flag indicating whether to set this page as the root group if a group name is specified. + final bool groupRoot; + + /// Flag indicating whether to stack this page as part of the history or not. + final bool keepHistory; + + /// The method for transitioning to this page from other pages. + /// Please refer to [StandardPageNavigationMode] for navigation modes. + final StandardPageNavigationMode navigationMode; + final LocalKey Function( + R pageData, + )? _pageKey; + + /// A function for creating [StandardPageInterface]. + /// + /// The [pageBuilder] function takes the following parameters + /// `child` : The child widget to be included in the [StandardPageWithResult]. + /// `name` : The name of the page (can be null). + /// `pageData` : The data associated with the page. + /// `pageKey` : A [LocalKey] to identify the page. + /// `restorationId` : A unique ID for state restoration. + /// `standardPageKey` : A [GlobalKey] for the [StandardPageWithResult] widget. + /// `factoryObject` : An instance of [StandardPageWithResultFactory]. + final StandardPageInterface Function( + Widget child, + String? name, + R pageData, + LocalKey pageKey, + String restorationId, + GlobalKey> standardPageKey, + StandardPageWithResultFactory, R, E> + factoryObject, + )? pageBuilder; + + /// A function to generate a replacement value when the pageData passed during navigation is null. + final R Function()? pageDataWhenNull; + + /// The name of this page. + final String? Function()? pageName; + + /// A function for generating a value to pass to [Page.restorationId]. + final String Function( + R pageData, + )? restorationId; + + /// When using nested [Navigator]s, specifies what the parent page [Type] of this child page should be. + final Type? parentPageType; + + /// Create a StandardPageWithResultFactory. + /// Define deep links for navigating to this page using regular expressions, allowing for multiple configurations. + /// Set the page key, with page data being of the type [R]. + /// + /// [create] is a required parameter. Pass a class that extends [StandardPageWithResult] to this argument. + /// Other arguments are optional. + /// + /// [links] define the links to navigate to this page using regular expressions, and [linkGenerator] generates deep links for this page. + /// + /// [group] is the group name used to manage multiple pages as part of the same group. [groupRoot] is a flag within the same group name to specify which page should be the root. The default value is `false`. + /// + /// [keepHistory] is a flag for whether to push history on the Navigator during transitions. The default is `true`. + /// + /// [navigationMode] specifies the NavigationMode when navigating to this page. The default is [StandardPageNavigationMode.moveToTop]. + /// + /// [pageKey] is a [LocalKey] to identify the page. + /// + /// [pageBuilder] is a function that wraps the processing when the page is built. The default is the page of [StandardMaterialPage]. + /// + /// [pageDataWhenNull] is a function that wraps the processing when building when page data is null. + /// + /// [pageName] is the name of this page. + /// + /// [restorationId] is a unique ID for state restoration. + /// + /// [parentPageType] is the page type that specifies which page type to consider as the parent. + StandardPageWithResultFactory({ + required this.create, + Map? links, + this.linkGenerator, + this.groupRoot = false, + this.group = defaultGroup, + this.keepHistory = true, + this.navigationMode = StandardPageNavigationMode.moveToTop, + LocalKey Function( + R pageData, + )? pageKey, + this.pageBuilder, + this.pageDataWhenNull, + this.pageName, + this.restorationId, + this.parentPageType, + }) : assert((links == null && linkGenerator == null) || + (links != null && linkGenerator != null)), + _pageKey = pageKey, + _links = links != null + ? { + for (var i in links.entries) RegExp('^/?${i.key}\$'): i.value, + } + : const {}; + + /// The page type of this page. + Type get pageType => T; + + /// The data type of this page. + Type get dataType => R; + + /// The result type of this page. + Type get resultType => E; + + /// Flag indicating that the type of page data set for this page is nullable. + bool get dataTypeIsNonNullable => [] is List; + + /// Returns the deep link generated by this page given [pageData]. + String? generateLink(Object? pageData) { + if (linkGenerator != null) { + // Dart doesn't allow automatic casting 1st citizen objects who + // have different less than 1st citizen parameters. + // In this case, linkGenerator could be ((MyClass) => String), + // But dart only can see ((Object) => String) and therefore + // can't convert between them. + // We do this trick here from inside the problematic class + // to cast as something that we _know_ to be true. + return linkGenerator!(pageData as R); + } + + return null; + } + + /// Navigate to the [StandardPage] of type [T] with the option to pass [pageData] during navigation. + /// An optional [navigationMode] representing the mode of [StandardPageNavigationMode] to use during navigation can also be provided. + Future goWithResult( + R pageData, [ + StandardPageNavigationMode? navigationMode, + ]) => + _delegate.goWithResult(pageData, navigationMode); + + /// Get the key set for this page, as configured for this page. + LocalKey getPageKey(Object? pageData) { + final tPageData = pageData ?? pageDataWhenNull?.call(); + + if (tPageData is R) { + return (_pageKey ?? _defaultPageKey)(tPageData); + } + + throw Never; + } + + LocalKey _defaultPageKey( + R pageData, + ) => + ValueKey( + '${pageType.toString()}:${linkGenerator != null ? linkGenerator!(pageData) : pageData}'); + + String _defaultRestorationId( + R pageData, + ) => + '${pageType.toString()}:${linkGenerator != null ? linkGenerator!(pageData) : pageData}'; + + StandardPageInterface _defaultPageBuilder( + Widget child, + String? name, + Object? pageData, + LocalKey pageKey, + String restorationId, + GlobalKey> standardPageKey, + StandardPageWithResultFactory, R, E> + factoryObject, + ) => + StandardMaterialPage( + child: child, + name: name, + arguments: pageData, + key: pageKey, + restorationId: restorationId, + standardPageKey: standardPageKey, + factoryObject: factoryObject, + ); + + Completer _createResultCompleter() => Completer(); + + StandardPageInterface _createPage( + LocalKey pageKey, + R pageData, + ) { + if (pageData == null && pageDataWhenNull != null) { + pageData = pageDataWhenNull!(); + } + + final tGlobalKey = GlobalKey>(); + + return (pageBuilder ?? _defaultPageBuilder)( + _StandardPageWidget( + key: tGlobalKey, + factoryObject: this, + pageData: pageData, + ), + pageName?.call() ?? T.toString(), + pageData, + pageKey, + restorationId?.call(pageData) ?? _defaultRestorationId(pageData), + tGlobalKey, + this, + ); + } +} + +/// Factory class for [StandardPage] to be set in the `page` property of [StandardMaterialApp]. +/// [T] is the type of the destination page, and [R] is the type of page data. +/// The following source code is an example of passing [StandardPageFactory] to [StandardMaterialApp.pages]. +/// +/// example: +/// ```dart +/// StandardMaterialApp( +/// onGenerateTitle: (context) => 'sample', +/// pages: [ +/// StandardPageFactory( +/// create: (_) => PageA(), +/// ), +/// StandardPageFactory( +/// create: (_) => PageB(), +/// ), +/// ], +/// ); +/// ``` +/// +/// Page navigation is generally done using `context.go`. +/// You pass the type of the specified page and the page data associated with that type during navigation. +/// For pages like PageA that do not involve data transfer, you can navigate using `context.go(null)`. +/// For screens with PageBData class page data reception, you can navigate using context.go(PageBData());. +/// For pages with PageBData class as page data, you can navigate using `context.go(PageBData());`. +/// +/// There is a concept called "group" that can be configured for each page. +/// If no group is specified, it defaults to [defaultGroup]. +/// When transitioning to a group different from the current page's group, all pages other than the destination group will be removed. +/// +/// You can set deep links for each page. +/// [StandardPageFactory.new]'s `links` allows you to define regular expressions for deep links to navigate to this page. Multiple configurations are possible. +/// [linkGenerator] creates deep links to navigate to this page from the page data's state for this page. +/// +/// example: +/// ```dart +/// StandardPageFactory( +/// create: (_) => PageC(), +/// links: { +/// r'pageC/(\d+)' : (match, uri) => DeepLinkData( +/// id: int.parse(uri.queryParameters([‘id’])!), +/// message: 'this is message', +/// ), +/// }, +/// linkGenerator: (pageC) => 'pageC/${pageC.id}', +/// ), +/// +/// class DeepLinkData { +/// DeepLinkData({ +/// required this.id, +/// required this.message, +/// }); +/// final int id; +/// final String? message; +/// } +/// ``` +/// +/// For each page, you can specify which page class to use as the parent page type using `parentPageType`. +/// This is useful, for example, when implementing applications with multiple footer menus. +/// +/// example: +/// ```dart +/// StandardMaterialApp( +/// onGenerateTitle: (context) => l(context, 'title'), +/// pages: [ +/// // HomePage Menu +/// StandardPageFactory( +/// create: (data) => HomePage(), +/// ), +/// StandardPageFactory( +/// create: (data) => TitlePage(), +/// parentPageType: HomePage, +/// ), +/// StandardPageFactory( +/// create: (data) => TitleDetailsPage(), +/// parentPageType: HomePage, +/// ), +/// // MyPage Menu +/// StandardPageFactory( +/// create: (data) => MyPage(), +/// ), +/// StandardPageFactory( +/// create: (data) => MyFavoritePage(), +/// parentPageType: MyPage, +/// ), +/// ], +/// ); +/// ``` +base class StandardPageFactory, R extends Object?> + extends StandardPageWithResultFactory { + /// Create a StandardPageFactory + StandardPageFactory({ + required super.create, + super.links, + super.linkGenerator, + super.groupRoot, + super.group, + super.keepHistory, + super.navigationMode, + super.pageKey, + super.pageBuilder, + super.pageDataWhenNull, + super.pageName, + super.restorationId, + super.parentPageType, + }); +} + +/// This is a special factory class for creating a splash page after app launch, +/// and it is required to collaborate with the functionality of [StartupSequence]. +base class SplashPageFactory> + extends StandardPageFactory { + /// Create a SplashPageFactory + SplashPageFactory({ + required super.create, + super.pageKey, + super.pageBuilder, + super.pageDataWhenNull, + super.pageName, + super.restorationId, + }) : super( + group: 'splash', + keepHistory: false, + ); +} + +/// A special factory class for creating a page used during a [StartupSequence]. +/// Used for scenarios like creating a consent screen for the user on the first app launch. +base class StartupPageFactory> + extends StandardPageFactory { + /// Create a StartupPageFactory + StartupPageFactory({ + required super.create, + super.groupRoot, + String? group, + super.keepHistory, + super.navigationMode, + super.pageKey, + super.pageBuilder, + super.pageDataWhenNull, + super.pageName, + super.restorationId, + }) : super( + group: 'startup${group?.isNotEmpty == true ? '@$group' : ''}', + ); +} + +/// A special factory class for creating an error page that [PatapataException] can navigate to +/// if an error has a [PatapataException.userLogLevel] of [Level.SHOUT]. +base class StandardErrorPageFactory> + extends StandardPageFactory { + static const String errorGroup = 'error'; + + /// Create a StandardErrorPageFactory + StandardErrorPageFactory({ + required super.create, + Map? links, + super.linkGenerator, + super.groupRoot = false, + super.group = StandardErrorPageFactory.errorGroup, + super.keepHistory = true, + super.navigationMode = StandardPageNavigationMode.removeAll, + super.pageKey, + super.pageBuilder, + super.pageDataWhenNull, + super.pageName, + super.restorationId, + }); +} + +/// A mixin for creating a [Page] that creates [StandardPageWithResult]. +mixin StandardPageInterface + on Page { + /// The page key for the corresponding [StandardPageWithResult]. + GlobalKey> get standardPageKey; + + /// The factory class that created this page. + StandardPageWithResultFactory get factoryObject; +} + +/// Implements functionality to extend [MaterialPage] and create a [StandardPage]. +/// +/// This class includes the [standardPageKey] property for accessing the page's key +/// and the [factoryObject] property for obtaining an object of the StandardPageFactory class. +/// +/// [R] represents the type of the page's result. +/// [E] represents the type of the value that the page returns. +class StandardMaterialPage + extends MaterialPage implements StandardPageInterface { + @override + final GlobalKey> standardPageKey; + + @override + final StandardPageWithResultFactory factoryObject; + + /// Create a StandardMaterialPage + const StandardMaterialPage({ + LocalKey? key, + String? name, + Object? arguments, + String? restorationId, + required this.standardPageKey, + required this.factoryObject, + required Widget child, + }) : super( + key: key, + name: name, + arguments: arguments, + restorationId: restorationId, + child: child, + ); +} + +/// Implements functionality to extend [Page] and create a customized [StandardPageWithResult]. +/// +/// This class includes the [standardPageKey] property for accessing the page's key +/// and the [factoryObject] property for obtaining an object of the StandardPageWithResult class. +/// +/// [R] represents the type of the page's result. +/// [E] represents the type of the value that the page returns. +class StandardCustomPage extends Page + implements StandardPageInterface { + @override + final GlobalKey> standardPageKey; + + @override + final StandardPageWithResultFactory factoryObject; + + /// The content to be shown in the [Route] created by this page. + final Widget child; + + /// Create a StandardCustomPage + const StandardCustomPage({ + LocalKey? key, + String? name, + Object? arguments, + String? restorationId, + this.maintainState = true, + this.barrierDismissible = false, + this.barrierColor, + this.barrierLabel, + this.barrierCurve = Curves.ease, + this.opaque = true, + this.transitionDuration = const Duration(milliseconds: 300), + required this.standardPageKey, + required this.factoryObject, + this.transitionBuilder, + required this.child, + }) : super( + key: key, + name: name, + arguments: arguments, + restorationId: restorationId, + ); + + /// {@macro flutter.widgets.ModalRoute.maintainState} + final bool maintainState; + + /// {@macro flutter.widgets.ModalRoute.barrierDismissible} + final bool barrierDismissible; + + /// {@macro flutter.widgets.ModalRoute.barrierColor} + final Color? barrierColor; + + /// {@macro flutter.widgets.ModalRoute.barrierLabel} + final String? barrierLabel; + + /// {@macro flutter.widgets.ModalRoute.barrierCurve} + final Curve barrierCurve; + + /// {@macro flutter.widgets.ModalRoute.opaque} + final bool opaque; + + /// {@macro flutter.widgets.ModalRoute.transitionDuration} + final Duration transitionDuration; + + /// An animated builder process used when transitioning to this page. + final Widget Function( + BuildContext context, + Animation animation, + Animation secondaryAnimation, + Widget child, + )? transitionBuilder; + + @override + Route createRoute(BuildContext context) { + return _StandardCustomPageRoute(page: this); + } +} + +class _StandardCustomPageRoute extends ModalRoute { + _StandardCustomPageRoute({ + required StandardCustomPage page, + }) : super( + settings: page, + ); + + StandardCustomPage get _page => settings as StandardCustomPage; + + @override + Widget buildPage( + BuildContext context, + Animation animation, + Animation secondaryAnimation, + ) { + return Semantics( + scopesRoute: true, + explicitChildNodes: true, + child: _page.child, + ); + } + + @override + Widget buildTransitions( + BuildContext context, + Animation animation, + Animation secondaryAnimation, + Widget child, + ) { + final tBuilder = _page.transitionBuilder; + + if (tBuilder != null) { + return tBuilder( + context, + animation, + secondaryAnimation, + child, + ); + } + + return child; + } + + @override + bool get maintainState => _page.maintainState; + + @override + Duration get transitionDuration => _page.transitionDuration; + + @override + bool get barrierDismissible => _page.barrierDismissible; + + @override + Color? get barrierColor => _page.barrierColor; + + @override + String? get barrierLabel => _page.barrierLabel; + + @override + Curve get barrierCurve => _page.barrierCurve; + + @override + bool get opaque => _page.opaque; + + @override + String get debugLabel => '${super.debugLabel}(${_page.name})'; +} + +class _StandardPageWidget + extends StatefulWidget { + final StandardPageWithResultFactory, T, E> + factoryObject; + final T pageData; + + const _StandardPageWidget({ + Key? key, + required this.factoryObject, + required this.pageData, + }) : super(key: key); + + @override + State<_StandardPageWidget> createState() => + // ignore: no_logic_in_create_state + factoryObject.create(pageData).._factory = factoryObject; +} + +const _kAnalyticsGlobalContextKey = Object(); + +/// {@template patapata_widgets.StandardPageWithResult} +/// This class is used to create pages that return values when building an application with Patapata. +/// +/// Define page classes that inherit from this class and pass them to [StandardPageWithResultFactory.create]. +/// Pages created with [StandardPageWithResult] must override [buildPage]. +/// [T] represents the type of page data associated with the page +/// {@endtemplate} +/// [E] signifies the type of data that the page returns. +abstract class StandardPageWithResult + extends State<_StandardPageWidget> with RouteAware { + late StandardPageWithResultFactory, T, E> + _factory; + + void _completeResult(Completer completer, dynamic popResult) { + if (completer.isCompleted) { + return; + } + + assert(completer is Completer); + + if (popResult != null && popResult is E) { + (completer as Completer).complete(popResult); + } else { + (completer as Completer).complete(pageResult); + } + } + + bool _pageResultSet = false; + E? _pageResult; + + /// Get the result returned by this page. + E? get pageResult => _pageResultSet ? _pageResult as E : null; + + /// Set the result returned by this page. + set pageResult(E? value) { + _pageResultSet = true; + _pageResult = value; + } + + bool _doPageDataChangedOnReady = false; + late T _pageData; + + /// Get the page data. + T get pageData => _pageData; + + /// Set the page data. + set pageData(T value) { + if (value is Listenable) { + if (_pageData != null) { + (_pageData as Listenable).removeListener(_onPageDataChanged); + } + + value.addListener(_onPageDataChanged); + } + + final tSame = _pageData == value; + _pageData = value; + + // We are dealing with the Listenable check above this + // changed check because with overridden == operators, it's + // likely that the actual object has changed and therefore the listeners + // also need to be reset, but the data part of the object is the same. + // So we just replace the listeners but don't notify of changes. + if (tSame) { + // ignore + return; + } + + _onPageDataChanged(); + } + + Navigator? _navigator; + + /// When [StandardPageWithResultFactory.parentPageType] is set, it retrieves the child [Navigator] widget. + /// This is used when creating applications with features like footer tabs. + /// + /// For example, let's say there's a page called PageA, which is a tab, and it is set as the parentPageType for PageB. + /// ```dart + /// StandardMaterialApp( + /// onGenerateTitle: (context) => l(context, 'tab page'), + /// pages: [ + /// StandardPageFactory( + /// create: (data) => PageA(), + /// ), + /// StandardPageFactory( + /// create: (data) => PageB, + /// parentPageType: PageA, + /// ), + /// ], + /// ); + /// ``` + /// + /// In this case, PageA displays the widget that shows the tab in the footer, + /// but there is no widget to display within it. Therefore, you can use [childNavigator] to retrieve and display the content of PageB + /// ```dart + /// class PageA extends StandardPage { + /// @override + /// Widget buildPage(BuildContext context) { + /// return childNavigator!; // Display the content of PageB + /// } + /// } + /// ``` + Navigator? get childNavigator => _navigator; + + void _onPageDataChanged() { + if (!_ready) { + _doPageDataChangedOnReady = true; + + return; + } + _sendPageDataEvent(); + (Router.of(context).routerDelegate as StandardRouterDelegate?) + ?._updatePages(); + onPageData(); + } + + AnalyticsContext _generateAnalyticsContext() => AnalyticsContext({ + 'pageName': name, + 'pageData': pageData, + 'pageLink': link, + ...Analytics.tryConvertToLoggableJsonParameters( + 'pageDataJson', pageData), + }); + + void _updateRouteAnalyticsContext() { + context.read().setRouteContext( + _kAnalyticsGlobalContextKey, + _generateAnalyticsContext(), + ); + } + + void _sendPageDataEvent() { + _updateRouteAnalyticsContext(); + context.read().event( + name: 'pageDataUpdate', + context: context, + ); + } + + /// Called when the page data is updated. + void onPageData() {} + + /// The name of this page. + String get name => runtimeType.toString(); + + /// Get the deep link for this page. + /// Returns null if [StandardPageFactory.linkGenerator] is not defined for this page. + String? get link => + _factory.linkGenerator != null ? _factory.linkGenerator!(pageData) : null; + + RouteObserver>? _routeObserver; + + bool _ready = false; + + bool _firstActive = true; + bool _active = false; + + /// A flag indicating whether this page is at the top of the history, i.e., whether it's the currently user-interacted page. + bool get active => _active && mounted; + + @protected + AnalyticsEvent? get analyticsSingletonEvent => null; + + @override + @mustCallSuper + void initState() { + super.initState(); + _pageData = widget.pageData; + } + + @override + @mustCallSuper + void didChangeDependencies() { + super.didChangeDependencies(); + + _ready = true; + + _routeObserver ??= context.read>>(); + _routeObserver?.subscribe(this, ModalRoute.of(context)!); + + if (_doPageDataChangedOnReady) { + _doPageDataChangedOnReady = false; + scheduleFunction(_onPageDataChanged); + } + } + + @override + @mustCallSuper + void dispose() { + _routeObserver?.unsubscribe(this); + _routeObserver = null; + + super.dispose(); + } + + @override + @mustCallSuper + void didPopNext() { + _updateActiveStatus(); + } + + @override + @mustCallSuper + void didPush() { + _updateActiveStatus(); + } + + @override + @mustCallSuper + void didPop() { + _updateActiveStatus(); + } + + @override + @mustCallSuper + void didPushNext() { + bool tIgnore = false; + + // We aren't actually popping. + // This is a hack to get access to the most + // recent Route object... + if (mounted) { + Navigator.of(context).popUntil((route) { + if (route is ModalRoute && + !route.opaque && + route.settings is! StandardCustomPage) { + tIgnore = true; + } + + return true; + }); + } + + if (!tIgnore) { + _updateActiveStatus(); + } + } + + void _updateActiveStatus([bool? forcedStatus]) { + // ignore: todo + // TODO: Go up the entire tree to support multiple Navigators. + // We only want to be active if our [Navigator] is also actually in the front. + final tIsCurrentlyActive = _active; + _active = mounted && + (forcedStatus ?? (ModalRoute.of(context)?.isCurrent ?? false)); + + if (_active != tIsCurrentlyActive) { + if (_active) { + _updateRouteAnalyticsContext(); + onActive(_firstActive); + + if (_firstActive) { + _firstActive = false; + } + } else { + onInactive(); + } + } + } + + StandardRouterDelegate? _delegate; + Map>>? _pageChildInstances; + StandardPageWithResultFactory, + Object?, Object?>? _firstPageFactory; + + @protected + @mustCallSuper + void onActive(bool first) { + _delegate = Router.of(context).routerDelegate as StandardRouterDelegate?; + + _pageChildInstances = _delegate?._pageChildInstances; + + final Map>? tStandardPagesMap = + _delegate?._standardPagesMap; + + if (first && _pageChildInstances != null && tStandardPagesMap != null) { + if (tStandardPagesMap.containsKey(_factory.pageType) && + tStandardPagesMap[_factory.pageType]!.isNotEmpty) { + // Create an instance of the first child element to be displayed by default. + var tStandardPageInterface = + ModalRoute.of(context)?.settings as StandardPageInterface; + + final Type tChildPageType; + if (_delegate?._targetFirstChildPage != null) { + tChildPageType = _delegate!._targetFirstChildPage!.pageType; + } else { + tChildPageType = tStandardPagesMap[_factory.pageType]!.first; + } + + _delegate?._standardPageInterfaceToType[tStandardPageInterface]! + .add(tChildPageType); + + _firstPageFactory = _delegate?._addChildFirstPage( + tChildPageType, + tStandardPageInterface, + ); + } + } + } + + @protected + void onInactive() {} + + @protected + void onRefocus() { + final tScrollController = PrimaryScrollController.of(context); + + if (tScrollController.hasClients == true) { + for (var i in tScrollController.positions.where((e) => e.hasPixels)) { + i.animateTo( + 0, + duration: const Duration(milliseconds: 500), + curve: Curves.easeOut, + ); + } + } + } + + @override + @mustCallSuper + Widget build(BuildContext context) { + Widget tChild = Builder(builder: buildPage); + + final tPlugins = context + .read() + .getPluginsOfType() + .where((v) => v.initialized && !v.disposed); + + for (var i in tPlugins) { + tChild = _SingleChildPluginBuilder( + plugin: i, + child: tChild, + ); + } + + final tAnalyticsEvent = analyticsSingletonEvent; + + if (tAnalyticsEvent != null) { + tChild = AnalyticsSingletonEventWidget( + event: tAnalyticsEvent, + child: tChild, + ); + } + + tChild = AnalyticsContextProvider( + analyticsContext: _generateAnalyticsContext(), + child: tChild, + ); + + tChild = Provider.value( + value: this, + child: Provider>.value( + value: this, + child: tChild, + ), + ); + + if (this is StandardPage) { + tChild = Provider.value( + value: this as StandardPage, + child: Provider>.value( + value: this as StandardPage, + child: tChild, + ), + ); + } + + // Build Child Navigator + if (_firstPageFactory != null) { + // Create a Navigator by referencing the parent page instance when _firstPageFactory exists + final tParentPageInstance = + ModalRoute.of(context)?.settings as StandardPageInterface; + + if (_pageChildInstances![tParentPageInstance] != null && + // Countermeasure for an error if the Navigator is empty when + // proceeding from a page with child to a page without child + _pageChildInstances![tParentPageInstance]!.isNotEmpty) { + _navigator = Navigator( + key: _childNavigatorKey, + pages: _pageChildInstances![tParentPageInstance]!, + onPopPage: (route, result) { + if (_delegate?.willPopPage != null) { + if (_delegate!.willPopPage!(route, result)) { + // We return false here because while a _pop_ was handled elsewhere, + // it was not _this_ route whose pop is succeeding. + return false; + } + } + + var tCurrentPage = + _delegate?._pageChildInstances[tParentPageInstance]?.lastOrNull; + if (tCurrentPage != null) { + _delegate?._removePageChildInstance( + tParentPageInstance, tCurrentPage); + } + + if (route.settings is StandardPageInterface) { + return _delegate?.removeRoute(route, result) ?? false; + } + + return false; + }, + ); + + _delegate?._pageChildInstancesUpdater[tParentPageInstance] = () { + setState(() {}); + }; + } + } + + return tChild; + } + + @protected + Widget buildPage(BuildContext context); +} + +class _SingleChildPluginBuilder extends StatelessWidget { + final StandardPagePluginMixin plugin; + final Widget child; + + const _SingleChildPluginBuilder({ + Key? key, + required this.plugin, + required this.child, + }) : super(key: key); + + @override + Widget build(BuildContext context) => plugin.buildPage(context, child); +} + +/// {@macro patapata_widgets.StandardPageWithResult} +abstract class StandardPage + extends StandardPageWithResult {} + +/// A data class to be specified when implementing Patapata's [Router] using [StandardRouterDelegate]. +class StandardRouteData { + /// The factory class for [StandardPage]. + final StandardPageWithResultFactory? factory; + + /// The page data to be passed to [StandardPage]. + final Object? pageData; + + /// Create a StandardRouteData + StandardRouteData({ + required this.factory, + required this.pageData, + }); +} + +/// A class that implements [RouteInformationParser] necessary for Patapata's [Router]. +class StandardRouteInformationParser + extends RouteInformationParser { + /// A handle to the location of a widget in the widget tree. + final BuildContext context; + + /// Delegate for the standard router. + final StandardRouterDelegate routerDelegate; + + /// Create a StandardRouteInformationParser + StandardRouteInformationParser({ + required this.context, + required this.routerDelegate, + }); + + @override + Future parseRouteInformation( + RouteInformation routeInformation) async { + final tApp = context.read(); + final tPlugins = tApp.getPluginsOfType(); + + for (var i in tPlugins) { + final tParsed = await i.parseRouteInformation(routeInformation); + + if (tParsed != null) { + return SynchronousFuture(tParsed); + } + } + + for (var i in tPlugins) { + final tTransformed = await i.transformRouteInformation(routeInformation); + + if (tTransformed != null) { + routeInformation = tTransformed; + } + } + + final tLocation = routeInformation.uri; + final tStandardAppPlugin = tApp.getPlugin(); + + if (tStandardAppPlugin != null) { + for (var i in tStandardAppPlugin._linkHandlers.values) { + try { + if (i(tLocation)) { + // Handled. Return early. + return SynchronousFuture(StandardRouteData( + factory: null, + pageData: null, + )); + } + } catch (e, stackTrace) { + _logger.severe('Error while handling link', e, stackTrace); + } + } + } + + final tRouteData = routerDelegate._getStandardRouteDataForPath(tLocation) ?? + StandardRouteData( + factory: null, + pageData: null, + ); + + return SynchronousFuture(tRouteData); + } + + @override + RouteInformation? restoreRouteInformation(StandardRouteData configuration) { + final tStringLocation = + configuration.factory?.generateLink(configuration.pageData); + + if (tStringLocation != null) { + final tLocation = Uri.tryParse(tStringLocation); + + if (tLocation != null) { + return RouteInformation( + uri: tLocation, + ); + } + } + + return null; + } +} + +/// A class that implements [RouterDelegate] required for Patapata's [Router]. +class StandardRouterDelegate extends RouterDelegate + with ChangeNotifier, PopNavigatorRouterDelegateMixin { + final _navigatorKey = GlobalKey( + debugLabel: 'StandardRouterDelegate:navigatorKey'); + final _multiProviderKey = + GlobalKey(debugLabel: 'StandardRouterDelegate:multiProviderKey'); + + /// Navigator observer that notifies RouteAware of changes in route state. + final RouteObserver> routeObserver = + RouteObserver>(); + + /// A handle to the location of a widget in the widget tree. + final BuildContext context; + List _pageInstances = []; + final Map> _pageChildInstances = {}; + + /// Wrap the entire Patapata Navigator-related application, + /// enabling the use of screen transition-related functionalities through a function. + Widget Function(BuildContext context, Widget? child)? routableBuilder; + + /// A function called when the app goes back to the previous page. + bool Function(Route route, dynamic result)? willPopPage; + final Map> _standardPageInterfaceToType = + {}; + + final _factoryTypeMap = {}; + final _pageInstanceToTypeMap = {}; + final _pageInstanceToRouteData = {}; + final _pageInstanceCompleterMap = {}; + + bool _initialRouteProcessed = false; + + bool _startupSequenceProcessed = false; + + final Map> _standardPagesMap = {}; + + final Map _pageChildInstancesUpdater = + {}; + + StandardPageWithResultFactory, + Object?, Object?>? _targetFirstChildPage; + + /// Create a StandardRouterDelegate + StandardRouterDelegate({ + required this.context, + required List pageFactories, + this.routableBuilder, + this.willPopPage, + }) : assert(pageFactories.isNotEmpty) { + _updatePageFactories(pageFactories); + } + + void _updatePageFactories(List pageFactories) { + // Remove the deleted page from the _factoryTypeMap Map variable during hot reloading + _factoryTypeMap.clear(); + _standardPagesMap.clear(); + + for (var tFactory in pageFactories) { + tFactory._delegate = this; + _factoryTypeMap[tFactory.pageType] = tFactory; + // Create Standard Navigator Map + if (tFactory.parentPageType == null && + !_standardPagesMap.containsKey(tFactory.pageType)) { + _standardPagesMap[tFactory.pageType] = []; + } else if (tFactory.parentPageType != null) { + if (!_standardPagesMap.containsKey(tFactory.parentPageType)) { + _standardPagesMap[tFactory.parentPageType!] = []; + } + _standardPagesMap[tFactory.parentPageType]!.add(tFactory.pageType); + } + } + + if (_pageInstances.isNotEmpty) { + for (var i in _pageInstanceToTypeMap.values) { + if (!_factoryTypeMap.containsKey(i)) { + // The page has been deleted. + // Wipe out everything and start the app over. + _pageInstances = []; + _pageChildInstances.clear(); + _pageInstanceToTypeMap.clear(); + _pageInstanceToRouteData.clear(); + for (var i in _pageInstanceCompleterMap.values) { + if (!i.isCompleted) { + // Basically this only happens during development + // so we will not have an official error code or class. + i.completeError('Page deleted'); + } + } + _pageInstanceCompleterMap.clear(); + break; + } + } + } + + if (_pageInstances.isEmpty) { + StandardPageWithResultFactory, + Object?, Object?> tStandardPage; + if (pageFactories.first.parentPageType == null) { + tStandardPage = pageFactories.first; + } else { + // If the first page of pageFactories has a parentType set, the parent page will be added first. + var tResult = pageFactories.where((element) => + element.pageType == pageFactories.first.parentPageType); + tStandardPage = tResult.first; + } + + final tPageData = tStandardPage.pageDataWhenNull?.call(); + + final tPage = _initializePage( + tStandardPage, + tStandardPage.getPageKey(tPageData), + tPageData, + ); + + _pageInstanceToTypeMap[tPage] = pageFactories.first.pageType; + _pageInstanceToRouteData[tPage] = + StandardRouteData(factory: pageFactories.first, pageData: null); + _pageInstanceCompleterMap[tPage] = + pageFactories.first._createResultCompleter(); + _pageInstances.add(tPage); + } + } + + Page _initializePage(StandardPageWithResultFactory factory, LocalKey pageKey, + Object? pageData) { + final tPage = factory._createPage(pageKey, pageData); + + if (factory.parentPageType == null) { + _pageChildInstances[tPage] = []; + if (_standardPageInterfaceToType[tPage] == null) { + _standardPageInterfaceToType[tPage] = []; + } + _standardPageInterfaceToType[tPage]?.add(factory.pageType); + } + + return tPage; + } + + StandardPageWithResultFactory _getFactory< + T extends StandardPageWithResult, + R extends Object?, + E extends Object?>() { + final tFactory = _getFactoryFromPageType(T); + + assert(tFactory.dataType == R); + + return tFactory as StandardPageWithResultFactory; + } + + StandardPageWithResultFactory _getFactoryFromPageType(Type type) { + final tFactory = _factoryTypeMap[type]; + + assert(tFactory != null); + + return tFactory!; + } + + /// {@template patapata_widgets.StandardRouteDelegate.pageInstances} + /// The current [Page] history. + /// {@endtemplate} + List> get pageInstances => _pageInstances.toList(); + + /// {@template patapata_widgets.StandardRouteDelegate.getPageFactory} + /// Get the factory class [StandardPageWithResultFactory] of [StandardPageWithResult]. + /// [T] is the type of the destination page. [R] is the type of page data. [E] is the data type of the value that the page returns. + /// {@endtemplate} + StandardPageWithResultFactory getPageFactory< + T extends StandardPageWithResult, + R extends Object?, + E extends Object?>() => + _getFactory(); + + /// {@template patapata_widgets.StandardRouteDelegate.goWithResult} + /// Navigate to the [StandardPageWithResult] of type [T] that returns a value, with the option to pass [pageData] during the navigation. + /// [T] is the type of the destination page. [R] is the type of page data. [E] is the data type of the value that the page returns. + /// [navigationMode] is optional and represents the mode of [StandardPageNavigationMode] to use during navigation. + /// {@endtemplate} + Future goWithResult, + R extends Object?, E extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return _goWithFactory(_getFactory(), pageData, navigationMode); + } + + /// {@template patapata_widgets.StandardRouteDelegate.go} + /// Navigate to the [StandardPage] of type [T] with the option to pass [pageData] + /// during navigation. + /// [T] represents the type of the destination page, and [R] signifies the type of page data. + /// {@endtemplate} + Future go, R extends Object?>(R pageData, + [StandardPageNavigationMode? navigationMode]) { + return goWithResult(pageData, navigationMode); + } + + /// {@template patapata_widgets.StandardRouteDelegate.goErrorPage} + /// Navigate to the error page with the option to pass an error log information [record]. + /// [record] represents the error log information of type [ReportRecord] to pass, and [navigationMode] signifies the optional mode of [StandardPageNavigationMode] to use during navigation. + /// {@endtemplate} + void goErrorPage(ReportRecord record, + [StandardPageNavigationMode? navigationMode]) { + final tFactory = _factoryTypeMap.values + .whereType() + .firstOrNull; + + if (tFactory != null) { + _goWithFactory(tFactory, record, navigationMode); + } + } + + /// {@template patapata_widgets.StandardRouteDelegate.routeWithConfiguration} + /// Takes `StandardRouteData` data and performs page navigation. + /// This function is used when a reference to [context] is not available, + /// for example, when navigating from a plugin. + /// [configuration] represents the page data to be passed to [goWithResult], + /// [navigationMode] is an optional mode of [StandardPageNavigationMode] to use during navigation. + /// {@endtemplate} + void routeWithConfiguration(StandardRouteData configuration, + [StandardPageNavigationMode? navigationMode]) { + configuration.factory?.goWithResult(configuration.pageData, navigationMode); + } + + @override + Widget build(BuildContext context) { + Widget tChild = Navigator( + key: _navigatorKey, + restorationScopeId: 'StandardAppNavigator', + observers: [ + ...context.read().navigatorObservers, + routeObserver, + ], + pages: _pageInstances, + onPopPage: _onPopPage, + ); + + if (routableBuilder != null) { + tChild = Builder( + builder: + ((child) => (context) => routableBuilder!(context, child))(tChild), + ); + } + + return MultiProvider( + key: _multiProviderKey, + providers: [ + Provider>>.value( + value: routeObserver, + ), + if (getApp().startupSequence != null) + Provider( + lazy: false, + create: (context) { + final tStartupSequence = getApp().startupSequence!; + if (!_startupSequenceProcessed) { + _startupSequenceProcessed = true; + tStartupSequence.resetMachine(); + } + return tStartupSequence; + }, + ), + ], + child: tChild, + ); + } + + void _updatePages() { + _pageInstances = _pageInstances.toList(); + final tPageChildInstances = _pageChildInstances; + for (var entry in tPageChildInstances.entries) { + _pageChildInstances[entry.key] = _pageChildInstances[entry.key]!.toList(); + } + notifyListeners(); + } + + bool _onPopPage(Route route, dynamic result) { + if (willPopPage != null) { + if (willPopPage!(route, result)) { + // We return false here because while a _pop_ was handled elsewhere, + // it was not _this_ route whose pop is succeeding. + return false; + } + } + + if (route.settings is StandardPageInterface) { + // Remove child navigator page from pageChildInstances only when swiping back + var tParentType = _pageInstanceToTypeMap[route.settings]; + if (tParentType != null) { + final tParentPageInstance = _getStandardPageInterface(tParentType); + + if (tParentPageInstance != null) { + if (_pageChildInstances.containsKey(tParentPageInstance)) { + _pageChildInstances[tParentPageInstance]!.clear(); + } + + _pageChildInstances.remove(tParentPageInstance); + _standardPageInterfaceToType.remove(tParentPageInstance); + _pageChildInstancesUpdater.remove(tParentPageInstance); + } + } + + return removeRoute(route, result); + } + + return false; + } + + /// {@template patapata_widgets.StandardRouteDelegate.removeRoute} + /// Removes the provided [route] from the navigator and returns true if + /// it is successfully removed, or false if not found. + /// If the route is removed successfully, it will trigger [Route.didPop]. + /// [route] represents the removed [Route], and [result] signifies the result passed as an argument to [Route.didPop]. + /// {@endtemplate} + bool removeRoute(Route route, dynamic result) { + _pageInstances.remove(route.settings); + _pageInstanceToTypeMap.remove(route.settings); + _pageInstanceToRouteData.remove(route.settings); + + if (route.settings is StandardPageInterface) { + final tState = (route.settings as StandardPageInterface) + .standardPageKey + .currentState; + final tCompleter = _pageInstanceCompleterMap.remove(route.settings); + + if (tCompleter != null) { + tState?._completeResult(tCompleter, result); + } + + tState?._updateActiveStatus(false); + } + + _updatePages(); + + if (route.didPop(result)) { + return true; + } + + return false; + } + + /// {@template patapata_widgets.StandardRouteDelegate.processInitialRoute} + /// Selects the initial page that the application should display and navigates to that page. + /// If this initialization has already been performed, it does nothing. + /// + /// The priority of what page is shown is as follows: + /// First, if there is a plugin in the [App] that returns data from getInitialRouteData, that data is used to navigate. + /// Next, if there is a link that opened this application, that link is used. + /// If neither of these conditions is met, a link with an empty string in the [StandardMaterialApp.pages] array using [StandardPageFactory.new]'s links is searched for and navigated to. + /// If no page can be found, an assertion error is thrown. + /// {@endtemplate} + void processInitialRoute() async { + if (_initialRouteProcessed) { + return; + } + + _initialRouteProcessed = true; + + final tPlugins = _navigatorKey.currentContext + ?.read() + .getPluginsOfType(); + + if (tPlugins != null) { + for (var i in tPlugins) { + final tRouteData = await i.getInitialRouteData(); + + if (tRouteData != null) { + routeWithConfiguration(tRouteData); + + return; + } + } + } + + final tInitialRouteData = + _initialRouteData ?? _getStandardRouteDataForPath(Uri(path: '')); + _initialRouteData = null; + + assert(tInitialRouteData != null); + + routeWithConfiguration(tInitialRouteData!); + } + + StandardRouteData? _initialRouteData; + + @override + Future setNewRoutePath(StandardRouteData configuration) { + if (!_initialRouteProcessed) { + _initialRouteData = configuration; + + return SynchronousFuture(null); + } + + routeWithConfiguration(configuration); + + return SynchronousFuture(null); + } + + @override + StandardRouteData? get currentConfiguration => _pageInstances.isEmpty + ? null + : _pageInstanceToRouteData[_pageInstances.last]; + + @override + GlobalKey? get navigatorKey => _navigatorKey; + + /// Retrieves the current `Navigator`. + NavigatorState get navigator { + assert(_navigatorKey.currentState != null, + 'Navigator does not exist yet. Wait for the first build to finish before using [navigator].'); + + return _navigatorKey.currentState!; + } + + /// Retrieves the `BuildContext` of the Navigator. + BuildContext get navigatorContext { + assert(_navigatorKey.currentContext != null, + 'Navigator does not exist yet. Wait for the first build to finish before using [navigatorContext].'); + + return _navigatorKey.currentContext!; + } + + StandardRouteData? _getStandardRouteDataForPath(Uri location) { + for (var i in _factoryTypeMap.values) { + for (var j in i._links.entries) { + final tMatch = j.key.firstMatch(location.path); + + if (tMatch != null) { + try { + return StandardRouteData( + factory: i, + pageData: j.value(tMatch, location), + ); + } catch (e, stackTrace) { + _logger.info('Exception during links callback', e, stackTrace); + // But ignore. + } + } + } + } + + return null; + } + + Future _goWithFactory( + StandardPageWithResultFactory factory, + Object? pageData, + StandardPageNavigationMode? navigationMode, + ) { + StandardPageWithResultFactory tFactory = factory; + + var tCurrentPage = _pageInstances.lastOrNull; + StandardPageWithResultFactory, + Object?, Object?>? tParentPageFactory; + + if (factory.parentPageType != null) { + final tParentPageInstance = + _getStandardPageInterface(factory.parentPageType!); + if (tParentPageInstance == null) { + tParentPageFactory = _getFactoryFromPageType(factory.parentPageType!); + _targetFirstChildPage = factory; + } else { + _targetFirstChildPage = null; + } + } else { + _targetFirstChildPage = null; + } + + tFactory = tParentPageFactory ?? factory; + + void fCleanupPage(StandardPageInterface page) { + final tCompleter = _pageInstanceCompleterMap.remove(page); + final tState = page.standardPageKey.currentState; + + if (tCompleter != null) { + tState?._completeResult(tCompleter, null); + } + + tState?._updateActiveStatus(false); + } + + void fRemoveLastPage() { + final tPage = _pageInstances.removeLast(); + _pageInstanceToTypeMap.remove(tPage); + _pageInstanceToRouteData.remove(tPage); + fCleanupPage(tPage as StandardPageInterface); + } + + if (tCurrentPage != null) { + assert(_pageInstanceToTypeMap.containsKey(tCurrentPage)); + + var tCurrentFactory = + _getFactoryFromPageType(_pageInstanceToTypeMap[tCurrentPage]!); + + if (!tCurrentFactory.keepHistory) { + fRemoveLastPage(); + } + + if (tFactory.group != null) { + while (true) { + tCurrentPage = _pageInstances.lastOrNull; + + if (tCurrentPage == null) { + break; + } + + assert(_pageInstanceToTypeMap.containsKey(tCurrentPage)); + + tCurrentFactory = + _getFactoryFromPageType(_pageInstanceToTypeMap[tCurrentPage]!); + + if (tCurrentFactory.group != null) { + break; + } + } + + if (tCurrentPage != null && tCurrentFactory.group != tFactory.group) { + // Different group than the current one. + // Remove all history. + var tReversedPageInstances = _pageInstances.reversed.toList(); + + _pageInstanceToTypeMap.clear(); + _pageInstanceToRouteData.clear(); + _pageInstances.clear(); + for (var tPageInstance in tReversedPageInstances) { + fCleanupPage(tPageInstance as StandardPageInterface); + } + } + } + } + + final tNavigationMode = navigationMode ?? tFactory.navigationMode; + + if (tNavigationMode == StandardPageNavigationMode.removeAll) { + // Remove all history. + var tReversedPageInstances = _pageInstances.reversed.toList(); + + _pageInstanceToTypeMap.clear(); + _pageInstanceToRouteData.clear(); + _pageInstances.clear(); + for (var tPageInstance in tReversedPageInstances) { + fCleanupPage(tPageInstance as StandardPageInterface); + } + } else if (tNavigationMode == StandardPageNavigationMode.replace) { + fRemoveLastPage(); + } + + final tPageKey = tFactory.getPageKey(pageData); + + void fCheckGroupRoot() { + if (!tFactory.groupRoot) { + // Search to see if a group root exists and add it. + final tGroup = tFactory.group; + + for (var i in _factoryTypeMap.entries) { + final tGroupRootFactory = i.value; + + if (tGroupRootFactory.group == tGroup && + tGroupRootFactory.groupRoot) { + // Found one. See if it's already in the history. + if (!_pageInstanceToTypeMap.containsValue(i.key)) { + // There isn't. So add it. + final tGroupRootPageData = + tGroupRootFactory.pageDataWhenNull?.call(); + final tGroupRootPageKey = + tGroupRootFactory.getPageKey(tGroupRootPageData); + final tGroupRootPage = _initializePage( + tGroupRootFactory, tGroupRootPageKey, tGroupRootPageData); + + _pageInstanceToTypeMap[tGroupRootPage] = + tGroupRootFactory.pageType; + _pageInstanceToRouteData[tGroupRootPage] = StandardRouteData( + factory: tGroupRootFactory, + pageData: tGroupRootPageData, + ); + _pageInstanceCompleterMap[tGroupRootPage] = + tGroupRootFactory._createResultCompleter(); + _pageInstances.insert(0, tGroupRootPage); + } + } + } + } + } + + // First check to see if we already have this page's representation + // in the history stack. If we do, modify the history stack and use the old instance. + for (var i = 0, il = _pageInstances.length; i < il; i++) { + if (_pageInstances[i].key == tPageKey) { + switch (tNavigationMode) { + case StandardPageNavigationMode.moveToTop: + case StandardPageNavigationMode.replace: + if (i == il - 1) { + break; + } + + final tLastPage = (_pageInstances.last as StandardPageInterface?) + ?.standardPageKey + .currentState; + tLastPage?._updateActiveStatus(false); + + final tPageToMove = _pageInstances[i]; + + // Shift all instances from this point to the left by one. + // Ignore the last index as we just replace it + for (var j = i; j < il - 1; j++) { + _pageInstances[j] = _pageInstances[j + 1]; + } + + _pageInstances[il - 1] = tPageToMove; + + break; + case StandardPageNavigationMode.removeAbove: + for (var j = il - 1; j > i; j--) { + fRemoveLastPage(); + } + + break; + default: + break; + } + + final tLastPageInstance = _pageInstances.last; + final tLastPage = (tLastPageInstance as StandardPageInterface?) + ?.standardPageKey + .currentState; + + if (tLastPage != null) { + if (tLastPage.pageData != pageData) { + tLastPage.pageData = pageData; + } + + if (tLastPage.active) { + tLastPage.onRefocus(); + } else { + final tRoute = ModalRoute.of(tLastPage.context); + + if (tRoute != null) { + tLastPage.context.read().routeViewEvent( + tRoute, + navigationType: AnalyticsNavigationType.push, + ); + } + tLastPage._updateActiveStatus(true); + } + } + + fCheckGroupRoot(); + + final tCompleter = _pageInstanceCompleterMap[tLastPageInstance]!; + + assert( + tCompleter is Completer, + 'Same PageKey used for pages that have different return types.' + 'This is not allowed. PageKey: $tPageKey', + ); + + final tFuture = (tCompleter as Completer).future; + + _updatePages(); + + return tFuture; + } + } + + final tPage = _initializePage(tFactory, tPageKey, pageData); + + _pageInstanceToTypeMap[tPage] = tFactory.pageType; + _pageInstanceToRouteData[tPage] = StandardRouteData( + factory: tFactory, + pageData: pageData, + ); + final tResultCompleter = _pageInstanceCompleterMap[tPage] = + tFactory._createResultCompleter() as Completer; + + if (factory.parentPageType == null || + (factory.parentPageType != null && tParentPageFactory != null)) { + _pageInstances.add(tPage); + } else { + var tParentStandardPageInterface = + _getStandardPageInterface(factory.parentPageType!); + + if (tParentStandardPageInterface != null) { + _addPageChildInstance(tParentStandardPageInterface, tPage); + + if (_pageChildInstancesUpdater[tParentStandardPageInterface] != null) { + _pageChildInstancesUpdater[tParentStandardPageInterface]!(); + } + } + } + + fCheckGroupRoot(); + + _updatePages(); + + return tResultCompleter.future; + } + + void _addPageChildInstance(Page parentPage, Page page) { + _pageChildInstances[parentPage]?.add(page); + } + + void _removePageChildInstance(Page parentPage, Page page) { + _pageChildInstances[parentPage]?.remove(page); + } + + StandardPageInterface? _getStandardPageInterface(Type pageType) { + // Check the page Type in _standardPageInterfaceToType + // _addPageChildInstance under which parent entity the tPage + // generated by _initializePage isdetermine whether to add + final tStandardPageInterfaceToType = _standardPageInterfaceToType.entries + .firstWhereOrNull((standardPageInterfaceToType) { + final tResult = standardPageInterfaceToType.value + .where((element) => element == pageType); + return tResult.isNotEmpty; + }); + + if (tStandardPageInterfaceToType == null) { + return null; + } + + return tStandardPageInterfaceToType.key; + } + + StandardPageWithResultFactory _addChildFirstPage( + Type pageType, + StandardPageInterface parentPageInstance, + ) { + final tFactory = _getFactoryFromPageType(pageType); + final tPageData = tFactory.pageDataWhenNull?.call(); + final tPageKey = tFactory.getPageKey(tPageData); + + final tPage = _initializePage(tFactory, tPageKey, tPageData); + + _pageInstanceToTypeMap[tPage] = tFactory.pageType; + _pageInstanceToRouteData[tPage] = StandardRouteData( + factory: tFactory, + pageData: tPageData, + ); + _pageInstanceCompleterMap[tPage] = tFactory._createResultCompleter(); + + // If the page to be added belongs to the parent Navigator, add it to _pageChildInstances + if (_pageChildInstances.keys.contains(parentPageInstance)) { + _addPageChildInstance(parentPageInstance, tPage); + } + + return tFactory; + } +} diff --git a/packages/patapata_core/lib/src/widgets/standard_page_widget.dart b/packages/patapata_core/lib/src/widgets/standard_page_widget.dart new file mode 100644 index 0000000..e4b1373 --- /dev/null +++ b/packages/patapata_core/lib/src/widgets/standard_page_widget.dart @@ -0,0 +1,78 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +part of "standard_app.dart"; + +/// A back button specified at the top of the AppBar of a child page, +/// which includes multiple navigators, in both Material and Cupertino Design. +/// +class StandardPageBackButton extends StatelessWidget { + const StandardPageBackButton({ + super.key, + this.color, + this.previousPageTitle, + this.onPressed, + }); + + /// The color to be used for the icon. + /// See [BackButton.color] of [BackButton] for more details. + final Color? color; + + /// The previousPageTitle to be used for the title. + /// See [CupertinoNavigationBarBackButton.previousPageTitle] of [CupertinoNavigationBarBackButton] for more details. + /// Defaults to [CupertinoTheme]'s `primaryColor` if null. + final String? previousPageTitle; + + /// A callback that can be optionally defined and called by the user before popping when the button is tapped. + final VoidCallback? onPressed; + + void _findClosestNavigatorStateCanPop(BuildContext context) { + // Find closest NavigatorState and pop if canPop + context.visitAncestorElements((element) { + if (element is StatefulElement && element.state is NavigatorState) { + NavigatorState tNavigatorState = element.state as NavigatorState; + if (tNavigatorState.canPop()) { + tNavigatorState.pop(); + return false; + } else if (element.widget.key == _childNavigatorKey) { + // Delete the page that exists in pageChildInstances if it could not be popped + final tPage = element.pageInstances.last; + element.pageChildInstances[tPage]!.clear(); + } + } + return true; + }); + } + + @override + Widget build(BuildContext context) { + final StandardAppType tType = context.watch(); + + if (tType == StandardAppType.material) { + assert(debugCheckHasMaterialLocalizations(context)); + return IconButton( + icon: const BackButtonIcon(), + color: color, + tooltip: MaterialLocalizations.of(context).backButtonTooltip, + onPressed: () { + onPressed?.call(); + _findClosestNavigatorStateCanPop(context); + }, + ); + } else if (tType == StandardAppType.cupertino) { + assert(debugCheckHasCupertinoLocalizations(context)); + return CupertinoNavigationBarBackButton( + color: color, + previousPageTitle: previousPageTitle, + onPressed: () { + onPressed?.call(); + _findClosestNavigatorStateCanPop(context); + }, + ); + } else { + return const SizedBox.shrink(); + } + } +} diff --git a/packages/patapata_core/lib/web/patapata_web_plugin.dart b/packages/patapata_core/lib/web/patapata_web_plugin.dart new file mode 100644 index 0000000..ac771f2 --- /dev/null +++ b/packages/patapata_core/lib/web/patapata_web_plugin.dart @@ -0,0 +1,11 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// Interface for Web Plugin +abstract class PatapataPlugin { + String get patapataName; + void patapataEnable() {} + void patapataDisable() {} +} diff --git a/packages/patapata_core/lib/web/web_local_config.dart b/packages/patapata_core/lib/web/web_local_config.dart new file mode 100644 index 0000000..07e8ba7 --- /dev/null +++ b/packages/patapata_core/lib/web/web_local_config.dart @@ -0,0 +1,111 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/services.dart'; +import 'package:flutter_web_plugins/flutter_web_plugins.dart'; +import 'package:patapata_core/web/patapata_web_plugin.dart'; + +import 'dart:html' as html; + +class WebLocalConfig extends PatapataPlugin { + WebLocalConfig(this.registrar); + final Registrar registrar; + + @override + String patapataName = "dev.patapata.native_local_config"; + + @override + void patapataDisable() { + channel?.setMethodCallHandler(null); + } + + MethodChannel? channel; + + @override + void patapataEnable() { + channel = MethodChannel( + patapataName, + const StandardMethodCodec(), + registrar, + ); + + channel?.setMethodCallHandler(handleMethodCall); + + _sync(); + } + + Future handleMethodCall(MethodCall call) async { + switch (call.method) { + case 'reset': + html.window.localStorage.remove(call.arguments as String); + break; + case 'resetMany': + var tArgs = call.arguments as List; + for (var arg in tArgs) { + html.window.localStorage.remove(arg); + } + break; + case 'resetAll': + html.window.localStorage.clear(); + break; + case 'setBool': + var tArgs = call.arguments as List; + html.window.localStorage[tArgs[0] as String] = + 'b${(tArgs[1] as bool) ? '1' : '0'}'; + break; + case 'setInt': + var tArgs = call.arguments as List; + html.window.localStorage[tArgs[0] as String] = 'i${tArgs[1]}'; + break; + case 'setDouble': + var tArgs = call.arguments as List; + html.window.localStorage[tArgs[0] as String] = 'd${tArgs[1]}'; + break; + case 'setString': + var tArgs = call.arguments as List; + html.window.localStorage[tArgs[0] as String] = 's${tArgs[1]}'; + break; + case 'setMany': + var tArgs = (call.arguments as List).cast>(); + for (var arg in tArgs) { + html.window.localStorage[arg[0]] = arg[1]; + } + break; + default: + break; + } + + _sync(); + } + + void _sync() { + channel?.invokeMethod('syncAll', html.window.localStorage.map((key, value) { + Object tValue; + + switch (value[0]) { + case 'b': + tValue = value.substring(1) == '1'; + + break; + case 'i': + tValue = int.tryParse(value.substring(1)) ?? 0; + + break; + case 'd': + tValue = double.tryParse(value.substring(1)) ?? 0.0; + + break; + case 's': + tValue = value.substring(1); + + break; + default: + tValue = ''; + } + + return MapEntry(key, tValue); + })); + } +} diff --git a/packages/patapata_core/lib/web/web_local_config_finder.dart b/packages/patapata_core/lib/web/web_local_config_finder.dart new file mode 100644 index 0000000..98646b2 --- /dev/null +++ b/packages/patapata_core/lib/web/web_local_config_finder.dart @@ -0,0 +1,106 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/services.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +const _methodChannel = MethodChannel('dev.patapata.native_local_config'); + +final _logger = Logger('patapata.NativeLocalConfig'); + +class WebLocalConfigFinder implements LocalConfigFinder { + @override + LocalConfig? getLocalConfig() => WebLocalConfig(); +} + +class WebLocalConfig extends LocalConfig with MemoryLocalConfig { + @override + Future init() async { + _methodChannel.setMethodCallHandler(_onMethodCall); + await super.init(); + } + + @override + void dispose() async { + _methodChannel.setMethodCallHandler(null); + super.dispose(); + } + + Future _onMethodCall(MethodCall call) async { + switch (call.method) { + case 'syncAll': + _onSyncAll((call.arguments as Map).cast()); + break; + case 'error': + _onError((call.arguments as Map).cast()); + break; + default: + break; + } + } + + void _onSyncAll(Map data) { + store.clear(); + store.addAll(data); + notifyListeners(); + } + + void _onError(Map error) { + final tError = NativeThrowable.fromMap(error); + + _logger.severe(tError.message, tError, tError.chain); + } + + @override + Future reset(String key) async { + await super.reset(key); + await _methodChannel.invokeMethod('reset', key); + } + + @override + Future resetAll() async { + await super.resetAll(); + await _methodChannel.invokeMethod('resetAll'); + } + + @override + Future resetMany(List keys) async { + await super.resetMany(keys); + await _methodChannel.invokeMethod('resetMany', keys); + } + + @override + Future setBool(String key, bool value) async { + await _methodChannel.invokeMethod('setBool', [key, value]); + } + + @override + Future setDouble(String key, double value) async { + await _methodChannel.invokeMethod('setDouble', [key, value]); + } + + @override + Future setInt(String key, int value) async { + await _methodChannel.invokeMethod('setInt', [key, value]); + } + + @override + Future setString(String key, String value) async { + await _methodChannel.invokeMethod('setString', [key, value]); + } + + @override + Future setMany(Map objects) async { + await _methodChannel.invokeMethod('setMany', objects); + } + + @override + Future setDefaults(Map defaults) async { + await super.setDefaults(defaults); + } +} + +LocalConfigFinder getLocalConfigFinder() => WebLocalConfigFinder(); diff --git a/packages/patapata_core/macos/.gitignore b/packages/patapata_core/macos/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_core/macos/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_core/macos/Classes/NativeLocalConfig.swift b/packages/patapata_core/macos/Classes/NativeLocalConfig.swift new file mode 100644 index 0000000..655d680 --- /dev/null +++ b/packages/patapata_core/macos/Classes/NativeLocalConfig.swift @@ -0,0 +1,120 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import FlutterMacOS + +class NativeLocalConfig : PatapataPlugin { + fileprivate let mChannel: FlutterMethodChannel + fileprivate var mOnChangeListener: Any? + fileprivate var mOnSizeLimitExceededListener: Any? + fileprivate let mStore = UserDefaults(suiteName: "\(Bundle.main.bundleIdentifier ?? "unknown").dev.patapata.native_local_config") ?? UserDefaults.standard + + init(registrar: FlutterPluginRegistrar) { + mChannel = FlutterMethodChannel(name: "dev.patapata.native_local_config", binaryMessenger: registrar.messenger) + } + + public var patapataName: String = "dev.patapata.native_local_config" + + public func patapataEnable() { + mChannel.setMethodCallHandler(handle) + + mOnChangeListener = NotificationCenter.default.addObserver(forName: UserDefaults.didChangeNotification, object: mStore, queue: OperationQueue.main, using: onChange) + + syncStore() + } + + fileprivate func syncStore() { + let tDict = mStore.dictionaryRepresentation().filter { + switch $0.value { + case is Bool: + return true + case is Int: + return true + case is Double: + return true + case is String: + return true + default: + return false + } + } + + mChannel.invokeMethod("syncAll", arguments: tDict) + } + + fileprivate func onChange(_: Notification) { + syncStore() + } + + fileprivate func onSizeLimitExceeded(notification: Notification) { + // mChannel.invokeMethod("error", arguments: <#T##Any?#>) + // Should we send this? It could happen async from a set command + // It could also happen from something not related to patapata at all... + } + + public func patapataDisable() { + mChannel.setMethodCallHandler(nil) + NotificationCenter.default.removeObserver(mOnChangeListener!, name: UserDefaults.didChangeNotification, object: mStore) + mOnChangeListener = nil + + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "reset": + mStore.removeObject(forKey: call.arguments as! String) + result(nil) + break + case "resetMany": + let tArgs = call.arguments as! Array + + for i in tArgs { + mStore.removeObject(forKey: i) + } + + result(nil) + break + case "resetAll": + for i in mStore.dictionaryRepresentation() { + mStore.removeObject(forKey: i.key) + } + + result(nil) + break + case "setBool": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Bool, forKey: tArgs[0] as! String) + result(nil) + break + case "setInt": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Int, forKey: tArgs[0] as! String) + result(nil) + break + case "setDouble": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! Double, forKey: tArgs[0] as! String) + result(nil) + break + case "setString": + let tArgs = call.arguments as! Array + mStore.set(tArgs[1] as! String, forKey: tArgs[0] as! String) + result(nil) + break + case "setMany": + let tArgs = call.arguments as! Dictionary + + for i in tArgs { + mStore.set(i.value, forKey: i.key) + } + + result(nil) + break + default: + result(FlutterMethodNotImplemented) + break + } + } +} diff --git a/packages/patapata_core/macos/Classes/PatapataCorePlugin.swift b/packages/patapata_core/macos/Classes/PatapataCorePlugin.swift new file mode 100644 index 0000000..031cf48 --- /dev/null +++ b/packages/patapata_core/macos/Classes/PatapataCorePlugin.swift @@ -0,0 +1,100 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Cocoa +import FlutterMacOS + +fileprivate var sPlugins = Set() + +public class PatapataCorePlugin: NSObject, FlutterPlugin { + let mRegistrar: FlutterPluginRegistrar + let mChannel: FlutterMethodChannel + + init(registrar: FlutterPluginRegistrar) { + mRegistrar = registrar + mChannel = FlutterMethodChannel(name: "dev.patapata.patapata_core", binaryMessenger: registrar.messenger) + + super.init() + + registrar.addMethodCallDelegate(self, channel: mChannel) + + // Register default plugins. + registrar.registerPatapata(plugin: NativeLocalConfig(registrar: registrar)) + } + + public static func register(with registrar: FlutterPluginRegistrar) { + let _ = PatapataCorePlugin(registrar: registrar) + } + + public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) { + switch call.method { + case "enablePlugin": + guard let tName = call.arguments as? String else { + result(FlutterError(code: "PPE000", message: "Invalid plugin name passed to enablePlugin", details: nil)) + + return + } + + enablePlugin(with: tName) + result(nil) + case "disablePlugin": + guard let tName = call.arguments as? String else { + result(FlutterError(code: "PPE000", message: "Invalid plugin name passed to disablePlugin", details: nil)) + + return + } + + disablePlugin(with: tName) + result(nil) + default: + result(FlutterMethodNotImplemented) + } + } + + public func enablePlugin(with pluginName: String) { + for i in sPlugins { + guard i.plugin.patapataName == pluginName && i.registrar.messenger.hash == mRegistrar.messenger.hash else { + continue + } + + i.plugin.patapataEnable(); + } + } + + public func disablePlugin(with pluginName: String) { + for i in sPlugins { + guard i.plugin.patapataName == pluginName && i.registrar.messenger.hash == mRegistrar.messenger.hash else { + continue + } + + i.plugin.patapataDisable() + } + } +} + +fileprivate struct PatapataPluginContainer : Hashable { + let plugin: PatapataPlugin + let registrar: FlutterPluginRegistrar + + static func == (lhs: PatapataPluginContainer, rhs: PatapataPluginContainer) -> Bool { + return lhs.plugin.patapataName == rhs.plugin.patapataName && lhs.registrar.messenger.hash == rhs.registrar.messenger.hash + } + + func hash(into hasher: inout Hasher) { + hasher.combine(plugin.patapataName) + hasher.combine(registrar.messenger.hash) + } +} + + +extension FlutterPluginRegistrar { + public func registerPatapata(plugin: PatapataPlugin) { + sPlugins.insert(PatapataPluginContainer(plugin: plugin, registrar: self)) + } + + public func unregisterPatapata(plugin: PatapataPlugin) { + sPlugins.remove(PatapataPluginContainer(plugin: plugin, registrar: self)) + } +} diff --git a/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.h b/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.h new file mode 100644 index 0000000..bdee0d2 --- /dev/null +++ b/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataCorePluginBridge : NSObject +@end diff --git a/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.m b/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.m new file mode 100644 index 0000000..951eb16 --- /dev/null +++ b/packages/patapata_core/macos/Classes/PatapataCorePluginBridge.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataCorePluginBridge.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_core-Swift.h" +#endif + +@implementation PatapataCorePluginBridge ++ (void)registerWithRegistrar:(NSObject*)registrar { + [PatapataCorePlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_core/macos/Classes/PatapataPlugin.swift b/packages/patapata_core/macos/Classes/PatapataPlugin.swift new file mode 100644 index 0000000..c9ca8f6 --- /dev/null +++ b/packages/patapata_core/macos/Classes/PatapataPlugin.swift @@ -0,0 +1,16 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + + +public protocol PatapataPlugin { + var patapataName: String { get } + func patapataEnable() + func patapataDisable() +} + +public extension PatapataPlugin { + func patapataEnable() {} + func patapataDisable() {} +} diff --git a/packages/patapata_core/macos/patapata_core.podspec b/packages/patapata_core/macos/patapata_core.podspec new file mode 100644 index 0000000..de917c8 --- /dev/null +++ b/packages/patapata_core/macos/patapata_core.podspec @@ -0,0 +1,22 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_core.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_core' + s.version = '0.0.1' + s.summary = 'A new flutter plugin project.' + s.description = <<-DESC +A new flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'FlutterMacOS' + + s.platform = :osx, '10.11' + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_core/makefile b/packages/patapata_core/makefile new file mode 100644 index 0000000..8f6138b --- /dev/null +++ b/packages/patapata_core/makefile @@ -0,0 +1,5 @@ +.PHONY: coverage +coverage: + flutter test --coverage --dart-define=IS_TEST=true + genhtml coverage/lcov.info -o coverage/html + open coverage/html/index.html \ No newline at end of file diff --git a/packages/patapata_core/pubspec.yaml b/packages/patapata_core/pubspec.yaml new file mode 100644 index 0000000..4fadd2c --- /dev/null +++ b/packages/patapata_core/pubspec.yaml @@ -0,0 +1,71 @@ +name: patapata_core +description: A collection of best-practices for building applications quickly and reliably. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_core + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +executables: + bootstrap: + +dependencies: + intl: ">=0.17.0 <0.19.0" + timezone: ">=0.9.0 <0.11.0" + + logging: ^1.2.0 + stack_trace: ^1.11.0 + provider: ^6.0.5 + connectivity_plus: ^5.0.0 + visibility_detector: ^0.4.0+2 + collection: ">=1.17.2 <1.19.0" + yaml: ^3.1.1 + package_info_plus: ^4.1.0 + device_info_plus: ^9.0.3 + device_info_plus_platform_interface: ^7.0.0 + flutter_local_notifications: ^15.1.0 + + flutter_web_plugins: + sdk: flutter + + flutter: + sdk: flutter + + flutter_localizations: + sdk: flutter + args: ^2.4.2 + dart_style: ^2.3.2 + xml: ^6.3.0 + yaml_edit: ^2.1.1 + +dev_dependencies: + test: ">=1.20.0" + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + golden_toolkit: ^0.15.0 + mockito: ^5.4.2 + flutter_svg: ^2.0.10+1 + +# For information on the generic Dart part of this file, see the +# following page: https://dart.dev/tools/pub/pubspec + +flutter: + # This section identifies this Flutter project as a plugin project. + # The 'pluginClass' and Android 'package' identifiers should not ordinarily + # be modified. They are used by the tooling to maintain consistency when + # adding or updating assets for this project. + plugin: + platforms: + android: + package: dev.patapata.patapata_core + pluginClass: PatapataCorePlugin + ios: + pluginClass: PatapataCorePluginBridge + macos: + pluginClass: PatapataCorePlugin + web: + pluginClass: PatapataCoreWeb + fileName: patapata_core_web.dart diff --git a/packages/patapata_core/test/analytics_test.dart b/packages/patapata_core/test/analytics_test.dart new file mode 100644 index 0000000..da516f8 --- /dev/null +++ b/packages/patapata_core/test/analytics_test.dart @@ -0,0 +1,1933 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; +import 'package:visibility_detector/visibility_detector.dart'; +import 'utils/patapata_core_test_utils.dart'; + +const String kAnalyticsButton = 'analytics-button'; +const String kAnalyticsHomeScreenButton = 'analytics-home-screen-button'; +const String kAnalyticsSecondScreenButton = 'analytics-second-screen-button'; +const String kAnalyticsSecondRemoveScreenButton = + 'analytics-second-remove-screen-button'; +const String kAnalyticsStandardPageButton = 'analytics-standard-page-button'; +const String kAnalyticsEventButton = 'analytics-event-button'; +const String kAnalyticsRawEventButton = 'analytics-raw-event-button'; +const String kAnalyticsSingletonButton = 'analytics-singleton-button'; +const String kAnalyticsUpdateWidgetButton = 'analytics-update-widget-button'; +const String kAnalyticsNotifyDataChangedButton = + 'analytics-notify-data-changed-button'; +const String kAnalyticsTestFirstPageButton = 'analytics-test-first-page-button'; + +// Analytics Test Environment Configuration Class +class _TestAnalyticsEnviroment extends Environment + with AnalyticsEventFilterEnvironment { + const _TestAnalyticsEnviroment(); + @override + final analyticsEventFilter = + const {}; +} + +// Analytics Test Environment Configuration Class with Filters +class _TestAnalyticsEventFilterEnviroment extends Environment + with AnalyticsEventFilterEnvironment { + _TestAnalyticsEventFilterEnviroment(); + @override + final analyticsEventFilter = + { + // A test filter for treating a specific event as a different RawEvent. + _TestAnalyticsEvent: (AnalyticsEvent event) => + event is _TestAnalyticsEvent ? _TestRawEvent(name: event.name) : event, + }; +} + +// RawEvent for Analytics Testing +class _TestRawEvent extends AnalyticsEvent { + _TestRawEvent({required super.name}); +} + +// AnalyticsEvent for Analytics Testing +class _TestAnalyticsEvent extends AnalyticsEvent { + _TestAnalyticsEvent({required super.name}); +} + +// StandardPage for Analytics Testing +class _TestAnalyticsPage extends StandardPage { + String _interactionContextData = ''; + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView( + children: [ + SizedBox( + child: TextButton( + key: const ValueKey(kAnalyticsStandardPageButton), + onPressed: () { + AnalyticsEvent tAnalyticsEvent = AnalyticsEvent( + name: 'testEvents', + data: { + 'test': 'testData', + }, + context: getApp().analytics.globalContext, + ); + getApp().analytics.rawEvent(tAnalyticsEvent); + + setState(() { + _interactionContextData = + context.read().toString(); + }); + }, + child: const Text('On Tap'), + ), + ), + Text( + "context.read().interactionContextData:$_interactionContextData", + ), + ], + ), + ); + } +} + +class _TestAnalyticsContextProviderPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: AnalyticsContextProvider( + reset: false, + analyticsContext: AnalyticsContext( + { + 'hogehogeName': 'AnalyticsContextParent', + 'hogehogeData': null, + 'hogehgoeLink': 'HogehogeLink', + }, + ), + child: AnalyticsContextProvider( + reset: true, + analyticsContext: AnalyticsContext( + { + 'pageName': 'AnalyticsContextPage', + 'pageData': null, + 'pageLink': 'AnalyticsContextPageLink', + }, + ), + child: const AnalyticsEventWidget( + key: ValueKey(kAnalyticsButton), + name: 'context analytics event', + child: Text('On Tap'), + ), + ), + ), + ); + } +} + +class _TestAnalyticsSingletonEventWidgetPage extends StandardPage { + bool _toggle = false; + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView( + children: [ + const Center( + child: Text('test'), + ), + Column( + children: [ + if (_toggle) + const AnalyticsSingletonEventWidget( + name: 'Event1', + data: {'test': 'testData1'}, + child: Text('Event1'), + ) + else + const AnalyticsSingletonEventWidget( + name: 'Event2', + data: {'test': 'testData2'}, + child: Text('Event2'), + ), + TextButton( + key: const ValueKey(kAnalyticsSingletonButton), + onPressed: () { + setState(() { + _toggle = !_toggle; + }); + }, + child: const Text('Analytics Event'), + ), + ], + ), + ], + ), + ); + } +} + +class _TestAnalyticsImpressionWidgetPage extends StandardPage { + final int _itemCount = 25; + final int _selectedItem = 5; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index == _selectedItem + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + visibleThreshold: 0.5, + name: 'Analytics Impression', + data: { + 'name': 'Analytics Page Item $index', + }, + child: Text("Impression index : $index"), + batchGenerator: (datas, contexts) { + return { + 'name': datas.map((e) => e['name']).join(','), + 'section': contexts + .map((e) => e.resolve()['section']) + .join(','), + }; + }, + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionWidgetNoneBatchPage extends StandardPage { + final int _itemCount = 35; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index % 10 == 0 + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + visibleThreshold: 0.5, + name: 'Analytics Impression', + data: { + 'name': 'Analytics Page Item $index', + }, + child: Text("Impression index : $index"), + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionDidUpdateWidgetPage extends StandardPage { + final int _itemCount = 25; + final int _selectedItem = 5; + late AnalyticsEvent _analyticsEvent; + + @override + void initState() { + _analyticsEvent = AnalyticsEvent( + name: 'Analytics Impression', + data: { + 'name': 'Analytics Page Item', + }, + context: getApp().analytics.globalContext, + ); + + super.initState(); + } + + Widget _getWidget(int index) { + return index == _selectedItem + ? TextButton( + key: const ValueKey(kAnalyticsUpdateWidgetButton), + onPressed: () { + setState(() { + _analyticsEvent = AnalyticsEvent( + name: 'Update Analytics Impression $index', + data: { + 'name': 'Update Analytics Page Item $index', + }, + context: getApp().analytics.globalContext, + ); + }); + }, + child: const Text('test'), + ) + : const Text('test'); + } + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index == _selectedItem + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + visibleThreshold: 0.5, + event: _analyticsEvent, + child: _getWidget(index), + ), + ) + : _getWidget(index), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionNotifyDataChangedPage extends StandardPage { + final int _itemCount = 35; + Map? _data = { + 'name': 'Analytics Page Item', + }; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + if (index != 0 && index % 7 == 0) { + return TextButton( + key: const ValueKey(kAnalyticsNotifyDataChangedButton), + onPressed: () { + setState(() { + _data = { + 'name': 'Analytics Page Item After Setstate $index', + }; + }); + }, + child: Text('On Tap Button $index'), + ); + } + return SizedBox( + height: 100, + child: index % 10 == 0 + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + visibleThreshold: 0.5, + name: 'Analytics Impression', + data: _data, + child: Text("Impression index : $index"), + batchGenerator: (datas, contexts) { + return { + 'name': datas.map((e) => e['name']).join(','), + 'section': contexts + .map((e) => e.resolve()['section']) + .join(','), + }; + }, + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionBatchToIgnorePage extends StandardPage { + final int _itemCount = 35; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index % 10 == 0 + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + 'index': '$index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + name: 'Analytics Impression', + thresholdCallback: (info) { + return true; + }, + batchDataToIgnore: const {'section'}, // 例えばsectionは無視する + child: Text("Impression index : $index"), + batchGenerator: (datas, contexts) { + return {}; + }, + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionVisibilityPage extends StandardPage { + final int _itemCount = 30; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index == 10 + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + }), + child: AnalyticsImpressionWidget( + durationThreshold: Duration.zero, + visibleThreshold: 0.5, + name: 'Analytics Impression $index', + data: { + 'name': 'Analytics Page Item $index', + }, + child: Text("Impression index : $index"), + batchGenerator: (datas, contexts) { + return {}; + }, + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +class _TestAnalyticsImpressionThresholdCallbackPage extends StandardPage { + final int _itemCount = 50; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'title')), + ), + body: ListView.builder( + itemCount: _itemCount, + itemBuilder: (context, index) { + return SizedBox( + height: 100, + child: index % 10 == 0 + ? AnalyticsContextProvider( + analyticsContext: AnalyticsContext({ + 'section': 'Section $index', + 'index': '$index', + }), + child: AnalyticsImpressionWidget( + name: 'Analytics Impression $index', + thresholdCallback: (info) { + return info.visibleFraction >= 0.5; + }, + child: Text("Impression index : $index"), + batchGenerator: (datas, contexts) { + return {}; + }, + ), + ) + : Text("Impression index : $index"), + ); + }, + ), + ); + } +} + +// Other Test Widgets +class _TestAnalyticsHomeScreen extends StatelessWidget { + const _TestAnalyticsHomeScreen({ + Key? key, + }) : super(key: key); + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Test Home Screen'), + ), + body: Center( + child: ElevatedButton( + key: const ValueKey(kAnalyticsHomeScreenButton), + onPressed: () { + Navigator.pushNamed(context, '/second', + arguments: 'Hello from Test Home Screen'); + }, + child: const Text('Go to Test Second Screen'), + ), + ), + ); + } +} + +class _TestAnalyticsSecondScreen extends StatelessWidget { + const _TestAnalyticsSecondScreen({ + Key? key, + }) : super(key: key); + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Test Second Screen'), + ), + body: Center( + child: Column( + children: [ + ElevatedButton( + key: const ValueKey(kAnalyticsSecondScreenButton), + onPressed: () { + Navigator.pop(context); + }, + child: const Text('Go back to Test Home Screen'), + ), + ElevatedButton( + key: const ValueKey(kAnalyticsSecondRemoveScreenButton), + onPressed: () async { + Navigator.removeRoute(context, ModalRoute.of(context)!); + }, + child: const Text('Remove to Test Screen'), + ), + ], + ), + ), + ); + } +} + +class _TestFirstPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Test First Page'), + ), + body: Center( + child: ElevatedButton( + key: const ValueKey(kAnalyticsTestFirstPageButton), + onPressed: () { + context.go<_TestSecondPage, void>(null); + }, + child: const Text('Go to Test Second Page'), + ), + ), + ); + } +} + +class _TestSecondPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('Test Second Page'), + ), + body: const Center( + child: Text('Test Second Page'), + ), + ); + } +} + +void main() { + // widget tests + group('Analytics Wdget Tests', () { + testWidgets("AnalyticsEvent eventsFor test", (WidgetTester tester) async { + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + child: SizedBox(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor<_TestRawEvent>(); + + var tFuture = expectLater( + tEventStream, + emitsInOrder([AnalyticsEvent(name: 'testEvents')]), + ); + + // send analytics event + tAnalytics.rawEvent(AnalyticsEvent(name: 'testEvents')); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsEvent filter event test", + (WidgetTester tester) async { + final App tApp = createApp( + environment: _TestAnalyticsEventFilterEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + child: SizedBox(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor<_TestAnalyticsEvent>(); + + var tFuture = expectLater( + tEventStream, + emitsInOrder([_TestRawEvent(name: 'testEvents')]), + ); + + // send analytics event + tAnalytics.rawEvent(_TestAnalyticsEvent(name: 'testEvents')); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsEvent context test", (WidgetTester tester) async { + final App tApp = createApp( + environment: _TestAnalyticsEventFilterEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + child: SizedBox(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tContextKey = Object(); + final tAnalyticsContext = AnalyticsContext({}); + + tApp.analytics.setGlobalContext(tContextKey, tAnalyticsContext); + expect(tApp.analytics.getGlobalContext(tContextKey), tAnalyticsContext); + + tApp.analytics.setGlobalContext(tContextKey, null); + expect(tApp.analytics.getGlobalContext(tContextKey), isNull); + }); + + tApp.dispose(); + }); + + testWidgets("SetRouteContext test", (WidgetTester tester) async { + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + child: SizedBox(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tKey = Object(); + final tContext = AnalyticsContext({}); + + tApp.analytics.setRouteContext(tKey, tContext); + expect(tApp.analytics.getRouteContext(tKey), tContext); + + tApp.analytics.setRouteContext(tKey, null); + expect(tApp.analytics.getRouteContext(tKey), isNull); + }); + + tApp.dispose(); + }); + + testWidgets("GetRouteContext test navigate page", + (WidgetTester tester) async { + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestFirstPage, void>( + create: (data) => _TestFirstPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + StandardPageFactory<_TestSecondPage, void>( + create: (data) => _TestSecondPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tKey = Object(); + final tContext = AnalyticsContext({}); + + tApp.analytics.setRouteContext(tKey, tContext); + expect(tApp.analytics.getRouteContext(tKey), tContext); + + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsTestFirstPageButton))); + + await tester.pumpAndSettle(); + + expect(tApp.analytics.getRouteContext(tKey), isNull); + }); + + tApp.dispose(); + }); + + testWidgets("Test sending analytics with null context", + (WidgetTester tester) async { + final App tApp = createApp( + environment: _TestAnalyticsEventFilterEnviroment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: Builder(builder: (context) { + return SizedBox.expand( + child: Center( + child: SizedBox( + child: TextButton( + key: const ValueKey(kAnalyticsButton), + onPressed: () { + getApp().analytics.event( + name: 'testEvents', + context: null, + ); + }, + child: const Text('On Tap'), + ), + ), + ), + ); + }), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor<_TestAnalyticsEvent>(); + + var tFuture = expectLater( + tEventStream, + emitsInOrder([AnalyticsEvent(name: 'testEvents')]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics revenueEvent test", (WidgetTester tester) async { + AnalyticsRevenueEvent fConvertAnalyticsRevenueEvent( + AnalyticsEvent event) { + return event as AnalyticsRevenueEvent; + } + + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + child: SizedBox(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream, + emitsInOrder([ + AnalyticsRevenueEvent( + revenue: 100.0, + currency: 'USD', + orderId: '123456', + receipt: 'receipt123', + productId: 'product123', + productName: 'Product 123', + eventName: 'revenueEvent', + context: null, + ), + ]), + ); + + final List tFutureGetPropertyList = [ + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).revenue), + emitsInOrder([100.0]), + ), + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).currency), + emitsInOrder(['USD']), + ), + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).orderId), + emitsInOrder(['123456']), + ), + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).receipt), + emitsInOrder(['receipt123']), + ), + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).productId), + emitsInOrder(['product123']), + ), + expectLater( + tAnalytics.events.asyncMap( + (event) => fConvertAnalyticsRevenueEvent(event).productName), + emitsInOrder(['Product 123']), + ), + ]; + + // send revenue event + tAnalytics.revenueEvent( + revenue: 100.0, + currency: 'USD', + orderId: '123456', + receipt: 'receipt123', + productId: 'product123', + productName: 'Product 123', + eventName: 'revenueEvent', + ); + + await tFuture; + + await Future.wait(tFutureGetPropertyList); + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsEventWidget test", (WidgetTester tester) async { + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + key: ValueKey(kAnalyticsEventButton), + child: AnalyticsEventWidget( + name: 'testEvents', + data: { + 'test': 'testData', + }, + child: Text('On Tap'), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => event.toString(), + ), + emitsInOrder([ + 'AnalyticsEvent:testEvents: data={test: testData}, context={}, navigationInteractionContext=null' + ]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsEventButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsEventWidget raw test", (WidgetTester tester) async { + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.expand( + child: Center( + key: const ValueKey(kAnalyticsRawEventButton), + child: AnalyticsEventWidget( + event: AnalyticsEvent( + name: 'eventRawName', + data: { + 'testRaw': 'testRawData', + }, + ), + child: const Text('On Tap'), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFutureRawEvent = expectLater( + tEventStream.asyncMap( + (event) => event.toString(), + ), + emitsInOrder([ + 'AnalyticsEvent:eventRawName: data={testRaw: testRawData}, context=null, navigationInteractionContext=null' + ]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsRawEventButton))); + + await tester.pumpAndSettle(); + + await tFutureRawEvent; + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsNavigatorObserver test", (WidgetTester tester) async { + final Analytics tAnalytics = Analytics(); + + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: MaterialApp( + navigatorObservers: [ + AnalyticsNavigatorObserver(analytics: tAnalytics), + ], + home: const _TestAnalyticsHomeScreen(), + routes: { + '/second': (context) => const _TestAnalyticsSecondScreen(), + }, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) { + AnalyticsRouteViewEvent tEvent = event as AnalyticsRouteViewEvent; + return { + 'isFirst': tEvent.isFirst, + 'arguments': tEvent.arguments, + 'routeName': tEvent.routeName, + 'navigationType': tEvent.navigationType, + }; + }, + ), + emitsInOrder([ + { + 'isFirst': false, + 'arguments': 'Hello from Test Home Screen', + 'routeName': '/second', + 'navigationType': 'push', + } + ]), + ); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsHomeScreenButton))); + + await tester.pumpAndSettle(); + + await tFuture; + + tFuture = expectLater( + tEventStream.asyncMap( + (event) { + AnalyticsRouteViewEvent tEvent = event as AnalyticsRouteViewEvent; + return { + 'isFirst': tEvent.isFirst, + 'arguments': tEvent.arguments, + 'routeName': tEvent.routeName, + 'navigationType': tEvent.navigationType, + }; + }, + ), + emitsInOrder([ + { + 'isFirst': true, + 'arguments': null, + 'routeName': '/', + 'navigationType': 'pop', + } + ]), + ); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsSecondScreenButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("AnalyticsNavigatorObserver remove route test", + (WidgetTester tester) async { + final Analytics tAnalytics = Analytics(); + + final App tApp = createApp( + environment: const _TestAnalyticsEnviroment(), + appWidget: MaterialApp( + navigatorObservers: [ + AnalyticsNavigatorObserver(analytics: tAnalytics), + ], + home: const _TestAnalyticsHomeScreen(), + routes: { + '/second': (context) => const _TestAnalyticsSecondScreen(), + }, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'isFirst': event.flatData?['isFirst'], + 'routeName': event.flatData?['routeName'], + 'navigationType': event.flatData?['navigationType'], + }, + ), + emitsInOrder([ + { + 'isFirst': false, + 'routeName': '/second', + 'navigationType': 'push', + } + ]), + ); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsHomeScreenButton))); + + await tester.pumpAndSettle(); + + await tFuture; + + tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'isFirst': event.flatData?['isFirst'], + 'routeName': event.flatData?['routeName'], + 'navigationType': event.flatData?['navigationType'], + }, + ), + emitsInOrder([ + { + 'isFirst': true, + 'routeName': '/', + 'navigationType': 'remove', + } + ]), + ); + + await tester.tap( + find.byKey(const ValueKey(kAnalyticsSecondRemoveScreenButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + }); + + // StandardPages tests + group('Analytics Standard Page Tests', () { + testWidgets("Analytics flatData test", (WidgetTester tester) async { + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsPage, void>( + create: (data) => _TestAnalyticsPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + final tAnalytics = tApp.analytics; + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.flatData?['pageName'], + 'pageLink': event.flatData?['pageLink'], + 'test': event.flatData?['test'], + }, + ), + emitsInOrder([ + { + 'pageName': '_TestAnalyticsPage', + 'pageLink': '', + 'test': 'testData', + } + ]), + ); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsStandardPageButton))); + + await tester.pumpAndSettle(); + + await tFuture; + + expect( + find.text( + 'context.read().interactionContextData:interactionContext:{pageName: _TestAnalyticsPage, pageData: null, pageLink: }', + ), + findsOneWidget, + ); + }); + + tApp.dispose(); + }); + + testWidgets("Analytics context provider reset test", + (WidgetTester tester) async { + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsContextProviderPage, void>( + create: (data) => _TestAnalyticsContextProviderPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tAnalytics = tApp.analytics; + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': 'AnalyticsContextPage', + 'pageData': null, + 'pageLink': 'AnalyticsContextPageLink', + }, + ), + emitsInOrder([ + { + 'pageName': 'AnalyticsContextPage', + 'pageData': null, + 'pageLink': 'AnalyticsContextPageLink', + } + ]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics singleton event widget test", + (WidgetTester tester) async { + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsSingletonEventWidgetPage, void>( + create: (data) => _TestAnalyticsSingletonEventWidgetPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tAnalytics = tApp.analytics; + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Event1', + 'eventData': {'test': 'testData1'}, + } + ]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsSingletonButton))); + + await tester.pumpAndSettle(); + + await tFuture; + + tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Event2', + 'eventData': {'test': 'testData2'}, + } + ]), + ); + + await tester.tap(find.byKey(const ValueKey(kAnalyticsSingletonButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression test", (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionWidgetPage, void>( + create: (data) => _TestAnalyticsImpressionWidgetPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Analytics Impression', + 'eventData': { + 'name': 'Analytics Page Item 5', + 'section': 'Section 5' + } + } + ]), + ); + + await tester.drag(find.byType(ListView), const Offset(0, -100)); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression did update widget test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionDidUpdateWidgetPage, + void>( + create: (data) => _TestAnalyticsImpressionDidUpdateWidgetPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + await tester.drag(find.byType(ListView), const Offset(0, -100)); + + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsUpdateWidgetButton))); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Update Analytics Impression 5', + 'eventData': {'name': 'Update Analytics Page Item 5'} + } + ]), + ); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression None batch test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionWidgetNoneBatchPage, + void>( + create: (data) => _TestAnalyticsImpressionWidgetNoneBatchPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Analytics Impression', + 'eventData': {'name': 'Analytics Page Item 30'} + } + ]), + ); + + await tester.drag(find.byType(ListView), const Offset(0, -3000)); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression notify data changed test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionNotifyDataChangedPage, + void>( + create: (data) => _TestAnalyticsImpressionNotifyDataChangedPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + await tester.drag(find.byType(ListView), const Offset(0, -500)); + + await tester.pumpAndSettle(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + 'eventData': event.data, + }, + ), + emitsInOrder([ + { + 'pageName': 'Analytics Impression', + 'eventData': { + 'name': 'Analytics Page Item After Setstate 7', + 'section': 'Section 10' + } + } + ]), + ); + + await tester + .tap(find.byKey(const ValueKey(kAnalyticsNotifyDataChangedButton))); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression batch to ignore data test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionBatchToIgnorePage, + void>( + create: (data) => _TestAnalyticsImpressionBatchToIgnorePage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.flatData?['pageName'], + 'index': event.flatData?['index'], + 'section': event.flatData?['section'], + }, + ), + emitsInOrder([ + { + 'pageName': '_TestAnalyticsImpressionBatchToIgnorePage', + 'index': '30', + 'section': null, + } + ]), + ); + + await tester.drag(find.byType(ListView), const Offset(0, -3000)); + + await tester.pumpAndSettle(); + + await tFuture; + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression visibility test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionVisibilityPage, void>( + create: (data) => _TestAnalyticsImpressionVisibilityPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + }, + ), + emitsInOrder([ + { + 'pageName': 'Analytics Impression 10', + } + ]), + ); + + // If you scroll too quickly, the VisibilityChanged won't be triggered, so scroll slowly. + await tester.timedDrag(find.byType(ListView), const Offset(0, -500), + const Duration(seconds: 1)); + + await tester.pumpAndSettle(); + + // Check the state before scrolling. + expect(find.text('Impression index : 10'), findsOneWidget); + + await tFuture; + + // If you scroll too quickly, the VisibilityChanged won't be triggered, so scroll slowly. + await tester.timedDrag(find.byType(ListView), const Offset(0, -500), + const Duration(seconds: 1)); + + await tester.pumpAndSettle(); + + // Check the state after scrolling. + expect(find.text('Impression index : 10'), findsNothing); + }); + + tApp.dispose(); + }); + + testWidgets("Analytics impression threshold callback test", + (WidgetTester tester) async { + VisibilityDetectorController.instance.updateInterval = Duration.zero; + + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory<_TestAnalyticsImpressionThresholdCallbackPage, + void>( + create: (data) => _TestAnalyticsImpressionThresholdCallbackPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + ], + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final tAnalytics = tApp.analytics; + + await tester.pumpAndSettle(); + + final Stream tEventStream = + tAnalytics.eventsFor(); + + var tFuture = expectLater( + tEventStream.asyncMap( + (event) => { + 'pageName': event.name, + }, + ), + emitsInOrder([ + { + 'pageName': 'Analytics Impression 10', + } + ]), + ); + + // If you scroll too quickly, the VisibilityChanged won't be triggered, so scroll slowly. + await tester.timedDrag(find.byType(ListView), const Offset(0, -500), + const Duration(seconds: 2)); + + await tester.pumpAndSettle(); + + // Check the state before scrolling. + expect(find.text('Impression index : 10'), findsOneWidget); + + // If you scroll too quickly, the VisibilityChanged won't be triggered, so scroll slowly. + await tester.timedDrag(find.byType(ListView), const Offset(0, -800), + const Duration(seconds: 2)); + + await tester.pumpAndSettle(); + + await tFuture; + + // Check the state after scrolling. + expect(find.text('Impression index : 10'), findsNothing); + }); + + tApp.dispose(); + }); + }); + + // unit tests + group('Analytics Unit Tests', () { + // defaultMakeLoggableToNative tests + test('defaultMakeLoggableToNative test with null object', () { + const object = null; + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals('')); + }); + + test('defaultMakeLoggableToNative test with int object', () { + const object = 123; + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals(object)); + }); + + test('defaultMakeLoggableToNative test with double object', () { + const object = 123.456; + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals(object)); + }); + + test('defaultMakeLoggableToNative test with String object', () { + const object = 'This is a test string'; + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals(object.characters.take(100).toString())); + }); + + test('defaultMakeLoggableToNative test with long String object', () { + final object = 'a' * 200; + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals(object.characters.take(100).toString())); + }); + + test('defaultMakeLoggableToNative test with json encodable object', () { + final object = {'key': 'value'}; + final result = Analytics.defaultMakeLoggableToNative(object); + expect( + result, equals(jsonEncode(object).characters.take(100).toString())); + }); + + test('defaultMakeLoggableToNative test with non-json encodable object', () { + final object = Object(); + final result = Analytics.defaultMakeLoggableToNative(object); + expect(result, equals(object.toString())); + }); + + // tryConvertToLoggableJsonParameters tests + test('tryConvertToLoggableJsonParameters test with null object', () { + final result = Analytics.tryConvertToLoggableJsonParameters('', null); + expect(result, equals({})); + }); + + test('tryConvertToLoggableJsonParameters test with String object', () { + const object = 'This is a test string'; + final result = Analytics.tryConvertToLoggableJsonParameters('', object); + expect(result, equals({'1': object})); + }); + + test('tryConvertToLoggableJsonParameters test with int object', () { + const object = 123; + final result = Analytics.tryConvertToLoggableJsonParameters('', object); + expect(result, equals({'1': object.toString()})); + }); + + test('tryConvertToLoggableJsonParameters test with double object', () { + const object = 123.456; + final result = Analytics.tryConvertToLoggableJsonParameters('', object); + expect(result, equals({'1': object.toString()})); + }); + + test('tryConvertToLoggableJsonParameters test with json encodable object', + () { + final object = {'key': 'value'}; + final result = Analytics.tryConvertToLoggableJsonParameters('', object); + expect(result, equals({'1': jsonEncode(object)})); + }); + + test( + 'tryConvertToLoggableJsonParameters test with non-json encodable object', + () { + final object = Object(); + final result = Analytics.tryConvertToLoggableJsonParameters('', object); + expect(result, equals({})); + }); + + // hashcode tests + test('AnalyticsContext hashCode test', () { + final analyticsContext1 = AnalyticsContext({'key': 'value'}); + final analyticsContext2 = AnalyticsContext({'key': 'value'}); + + expect(analyticsContext1.hashCode, equals(analyticsContext2.hashCode)); + + final analyticsContext3 = AnalyticsContext({'key': 'otherValue'}); + + expect(analyticsContext1.hashCode, + isNot(equals(analyticsContext3.hashCode))); + }); + }); +} diff --git a/packages/patapata_core/test/app_test.dart b/packages/patapata_core/test/app_test.dart new file mode 100644 index 0000000..a0a7aff --- /dev/null +++ b/packages/patapata_core/test/app_test.dart @@ -0,0 +1,837 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:flutter/material.dart'; +import 'package:logging/logging.dart'; +import 'package:provider/provider.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +class _EnvironmentBase {} + +class _Environment extends _EnvironmentBase {} + +class ClassA {} + +class TestPluginBase extends Plugin {} + +class TestPluginA extends TestPluginBase {} + +class TestPluginB extends TestPluginBase { + @override + final bool requireRemoteConfig = true; +} + +class TestPluginC extends TestPluginBase {} + +class MyCustomUser extends User { + MyCustomUser(App app) : super(app: app); +} + +class FetchFailsRemoteConfig extends MockRemoteConfig { + FetchFailsRemoteConfig(super.store); + + @override + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }) async { + throw Exception(); + } +} + +class _TestException extends PatapataException { + const _TestException(this._level); + + final Level? _level; + + @override + Level? get logLevel => _level; + + @override + String get defaultPrefix => 'TST'; + + @override + String get internalCode => '000'; + + @override + String get namespace => 'test'; +} + +void main() { + late App<_Environment> tApp; + final tWidgetKey = GlobalKey(); + + group('App initialization test.', () { + setUp(() { + testInitialize(); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + ); + }); + + testWidgets('App run test.', (tester) async { + final tAppStageChangeStream = + App.appStageChangeStream.asyncMap((event) => event.stage); + expectLater( + tAppStageChangeStream, + emitsInOrder([ + AppStage.setup, + AppStage.bootstrap, + AppStage.initializingPlugins, + AppStage.setupRemoteConfig, + AppStage.initializingPluginsWithRemoteConfig, + AppStage.running, + AppStage.disposed, + ]), + ); + + expect(tApp.stage, equals(AppStage.setup)); + + final tResult = await tApp.run(); + + expect(tResult, isTrue); + expect(tApp.stage, equals(AppStage.running)); + + tApp.dispose(); + + expect(tApp.stage, equals(AppStage.disposed)); + }); + + testWidgets('App runProcess and appWidget test.', (tester) async { + await tApp.run(); + + final tResult = await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.stage, equals(AppStage.running)); + expect(tApp.environment, isA<_Environment>()); + expect(tApp.environmentAs<_EnvironmentBase>(), isA<_EnvironmentBase>()); + expect(tApp.environmentAs(), isNull); + expect(find.byKey(tWidgetKey), findsOneWidget); + + return true; + }); + + expect(tResult, isTrue); + expect(tApp.stage, equals(AppStage.running)); + + tApp.dispose(); + }); + + testWidgets('App run bootstrapCallback test.', (tester) async { + late final AppStage tBootstrapCallbackAppStage; + await tApp.run(() { + tBootstrapCallbackAppStage = tApp.stage; + }); + + expect(tBootstrapCallbackAppStage, equals(AppStage.bootstrap)); + expect(tApp.stage, equals(AppStage.running)); + + tApp.dispose(); + }); + + testWidgets('Each required plugins and models is correctly initialized.', + (tester) async { + await tApp.run(); + + // plugins + expect(tApp.network, isA()); + expect(tApp.package, isA()); + expect(tApp.device, isA()); + expect(tApp.getPlugin(), isA()); + expect(tApp.getPlugin(), + isA()); + expect(tApp.getPlugin(), isA()); + expect(tApp.getPlugin(), isA()); + + // models + expect(tApp.log, isA()); + expect(tApp.user, isA()); + expect(tApp.analytics, isA()); + expect(tApp.permissions, isA()); + expect(tApp.remoteConfig, isA()); + expect(tApp.localConfig, isA()); + expect(tApp.remoteMessaging, isA()); + expect(tApp.navigatorObservers.length, equals(1)); + expect(tApp.navigatorObservers.first, isA()); + expect(tApp.startupSequence, isNull); + + tApp.dispose(); + }); + + testWidgets('Each Provider can be obtained with getProvider.', + (tester) async { + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider>(), isA>()); + expect(tApp.getProvider<_Environment>(), isA<_Environment>()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect( + tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + + // Can also be obtained from [context.read]. + final tContext = tWidgetKey.currentContext!; + expect(tContext.read(), isA()); + expect(tContext.read>(), isA>()); + expect(tContext.read<_Environment>(), isA<_Environment>()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + expect(tContext.read(), isA()); + }); + + tApp.dispose(); + }); + + testWidgets('getApp test.', (tester) async { + await tApp.run(); + + // Cannot be obtained outside the Zone of App. + expect(getApp, throwsA(isA())); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(getApp(), equals(tApp)); + }); + + tApp.dispose(); + }); + + testWidgets('addPlugin and removePlugin test.', (tester) async { + final tPluginA = TestPluginA(); + final tPluginB = TestPluginB(); + final tPluginC = TestPluginC(); + + await tApp.addPlugin(tPluginC); + + expect(tApp.hasPlugin(TestPluginC), isTrue); + expect(tApp.getPlugin(), equals(tPluginC)); + expect(tApp.getPluginsOfType(), equals([tPluginC])); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.hasPlugin(TestPluginC), isTrue); + expect(tApp.getPlugin(), equals(tPluginC)); + expect(tApp.getPluginsOfType(), equals([tPluginC])); + + await tApp.addPlugin(tPluginA); + expect(tApp.hasPlugin(TestPluginA), isTrue); + expect(tApp.getPlugin(), equals(tPluginA)); + expect( + tApp.getPluginsOfType(), + equals([tPluginC, tPluginA]), + ); + + await tApp.addPlugin(tPluginB); + expect(tApp.hasPlugin(TestPluginB), isTrue); + expect(tApp.getPlugin(), equals(tPluginB)); + expect( + tApp.getPluginsOfType(), + equals([tPluginC, tPluginA, tPluginB]), + ); + + await tApp.removePlugin(tPluginA); + expect(tApp.hasPlugin(TestPluginA), isFalse); + expect(tApp.getPlugin(), isNull); + expect( + tApp.getPluginsOfType(), + equals([tPluginC, tPluginB]), + ); + + await tApp.removePlugin(tPluginB); + expect(tApp.hasPlugin(TestPluginB), isFalse); + expect(tApp.getPlugin(), isNull); + expect(tApp.getPluginsOfType(), equals([tPluginC])); + + await tApp.removePlugin(tPluginC); + expect(tApp.hasPlugin(TestPluginC), isFalse); + expect(tApp.getPlugin(), isNull); + expect(tApp.getPluginsOfType(), isEmpty); + }); + + tApp.dispose(); + }); + + testWidgets( + 'An Exception raised by runProcess is handled as an unknown error in the App zone and rethrown to the caller.', + (tester) async { + await tApp.run(); + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + }); + + // Check log levels processed within the App zone. + final tStream = tApp.log.reports.asyncMap((event) => event.level); + expectLater( + tStream, + emitsInOrder([ + Level.SHOUT, + Level.SEVERE, + Level.SEVERE, + ]), + ); + + Object? tException; + try { + await tApp.runProcess(() async { + throw const _TestException(Level.SHOUT); + }); + } catch (e) { + tException = e; + } + expect((tException as _TestException).logLevel, equals(Level.SHOUT)); + + // Even if the log level is less than SEVERE, an unknown error in the App zone is handled as Level.SEVERE. + tException = null; + try { + await tApp.runProcess(() async { + throw const _TestException(Level.INFO); + }); + } catch (e) { + tException = e; + } + expect(tException, isA<_TestException>()); + expect((tException as _TestException).logLevel, equals(Level.INFO)); + + // If logLevel is null, it is processed as Level.SEVERE in App zone. + tException = null; + try { + await tApp.runProcess(() async { + throw const _TestException(null); + }); + } catch (e) { + tException = e; + } + expect((tException as _TestException).logLevel, isNull); + + tApp.dispose(); + }); + }); + + group('App initialization test. options', () { + testWidgets('Use providerKey when initializing App.', (tester) async { + testInitialize(); + + final tProviderKey = GlobalKey(); + tApp = App( + environment: _Environment(), + providerKey: tProviderKey, + createAppWidget: (context, app) { + return MultiProvider( + providers: [ + Provider( + create: (context) => ClassA(), + ), + ], + child: KeyedSubtree( + key: tProviderKey, + child: MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ), + ), + ); + }, + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.getProvider(), isA()); + expect(tWidgetKey.currentContext!.read(), isA()); + + // Default providers can also be obtained. + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider>(), isA>()); + expect(tApp.getProvider<_Environment>(), isA<_Environment>()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect( + tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + expect(tApp.getProvider(), isA()); + }); + + tApp.dispose(); + }); + + testWidgets('Use userFactory when initializing App.', (tester) async { + testInitialize(); + + tApp = App( + environment: _Environment(), + userFactory: ((app) => MyCustomUser(app)), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.user, isA()); + }); + + tApp.dispose(); + }); + + testWidgets('Initialization of App using plugins.', (tester) async { + testInitialize(); + + late final AppStage tInitPluginAAppStage; + final tPluginA = Plugin.inline( + name: 'testPluginA', + init: (app) async { + tInitPluginAAppStage = app.stage; + return true; + }, + ); + late final AppStage tInitPluginBAppStage; + final tPluginB = Plugin.inline( + name: 'testPluginB', + init: (app) async { + tInitPluginBAppStage = app.stage; + return true; + }, + ); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + ], + ); + + await tApp.run(); + expect(tApp.stage, equals(AppStage.running)); + expect(tInitPluginAAppStage, equals(AppStage.initializingPlugins)); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.getPlugin(), equals(tPluginA)); + + await tApp.addPlugin(tPluginB); + expect(tInitPluginBAppStage, equals(AppStage.running)); + + expect( + tApp.getPluginsOfType(), + equals([tPluginA, tPluginB]), + ); + + await tApp.removePlugin(tPluginA); + expect(tApp.getPlugin(), equals(tPluginB)); + expect(tApp.getPluginsOfType(), equals([tPluginB])); + }); + + tApp.dispose(); + }); + + testWidgets('Initialization of App using plugins. RemoteConfig required.', + (tester) async { + testInitialize(); + + late final AppStage tInitPluginAAppStage; + final tPluginA = Plugin.inline( + name: 'testPluginA', + init: (app) async { + tInitPluginAAppStage = app.stage; + return true; + }, + ); + late final AppStage tInitPluginBAppStage; + final tPluginB = Plugin.inline( + name: 'testPluginB', + requireRemoteConfig: true, + init: (app) async { + tInitPluginBAppStage = app.stage; + return true; + }, + ); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + tPluginB, + ], + ); + + await tApp.run(); + expect(tApp.stage, equals(AppStage.running)); + expect(tInitPluginAAppStage, equals(AppStage.initializingPlugins)); + expect(tInitPluginBAppStage, + equals(AppStage.initializingPluginsWithRemoteConfig)); + + tApp.dispose(); + }); + + testWidgets( + 'If the plugin init returns false during initialization, the plugin is removed.', + (tester) async { + testInitialize(); + + fCreateApp(List plugins) { + return App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: plugins, + ); + } + + final tPluginA = Plugin.inline( + name: 'testPluginA', + init: (app) async { + return true; + }, + ); + final tPluginFA = Plugin.inline( + name: 'testPluginFA', + init: (app) async { + return false; + }, + ); + final tPluginB = Plugin.inline( + name: 'testPluginB', + requireRemoteConfig: true, + init: (app) async { + return true; + }, + ); + final tPluginFB = Plugin.inline( + name: 'testPluginFB', + requireRemoteConfig: true, + init: (app) async { + return false; + }, + ); + + tApp = fCreateApp([ + tPluginA, + tPluginFA, + ]); + await tApp.run(); + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.getPlugin(), equals(tPluginA)); + expect(tApp.getPluginsOfType(), equals([tPluginA])); + }); + tApp.dispose(); + + tApp = fCreateApp([ + tPluginB, + tPluginFB, + ]); + await tApp.run(); + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.getPlugin(), equals(tPluginB)); + expect(tApp.getPluginsOfType(), equals([tPluginB])); + }); + tApp.dispose(); + }); + + testWidgets( + 'If plugin init throws an exception during initialization, the application will fail to start.', + (tester) async { + testInitialize(); + + fCreateApp(List plugins) { + return App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: plugins, + ); + } + + final tPluginFA = Plugin.inline( + name: 'testPluginFA', + init: (app) async { + throw Exception(); + }, + ); + final tPluginFB = Plugin.inline( + name: 'testPluginFB', + requireRemoteConfig: true, + init: (app) async { + throw Exception(); + }, + ); + + tApp = fCreateApp([ + tPluginFA, + ]); + expect(await tApp.run(), isFalse); + expect(tApp.stage, AppStage.initializingPlugins); + tApp.dispose(); + + tApp = fCreateApp([ + tPluginFB, + ]); + expect(await tApp.run(), isFalse); + expect(tApp.stage, AppStage.initializingPluginsWithRemoteConfig); + tApp.dispose(); + }); + + testWidgets('If App.run fails, onInitFailure is called.', (tester) async { + testInitialize(); + + testInitialize(); + + final tPluginA = Plugin.inline( + name: 'testPluginA', + init: (app) async { + throw const _TestException(Level.SEVERE); + }, + ); + + Object? tException; + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + ], + onInitFailure: (env, e, stackTrace) { + tException = e; + }, + ); + + expect(await tApp.run(), isFalse); + expect(tException, isA<_TestException>()); + + tApp.dispose(); + }); + + testWidgets('Use RemoteMessages.', (tester) async { + testInitialize(); + + const tRemoteMessage = RemoteMessage(); + final tMockRemoteMessaging = MockRemoteMessaging( + getInitialMessage: () async => tRemoteMessage, + ); + final tPluginA = Plugin.inline( + name: 'testPluginA', + createRemoteMessaging: () => tMockRemoteMessaging, + ); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tMessage = await tApp.remoteMessaging.getInitialMessage(); + expect(tMessage, equals(tRemoteMessage)); + }); + + tApp.dispose(); + }); + + testWidgets( + 'Use RemoteConfig. If fetch fails during initialization, the application will still start.', + (tester) async { + testInitialize(); + + final tStoreA = { + 'a': 1, + 'patapata_log_level': Level.INFO.value, + }; + final tStoreB = { + 'b': 2, + }; + final tRemoteConfigA = MockRemoteConfig({}) + ..testSetMockFetchValues(tStoreA); + final tRemoteConfigB = FetchFailsRemoteConfig({}) + ..testSetMockFetchValues(tStoreB); + + final tPluginA = Plugin.inline( + name: 'testPluginA', + createRemoteConfig: () => tRemoteConfigA, + ); + final tPluginB = Plugin.inline( + name: 'testPluginB', + createRemoteConfig: () => tRemoteConfigB, + ); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + tPluginB, + ], + ); + + expect(await tApp.run(), isTrue); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.remoteConfig.getInt('a'), equals(1)); + expect(tApp.remoteConfig.getInt('b'), equals(0)); + expect(tApp.log.level, equals(Level.INFO)); + + tStoreA['a'] = 10; + tStoreA['patapata_log_level'] = Level.SEVERE.value; + tRemoteConfigA.testSetMockFetchValues(tStoreA); + await tApp.remoteConfig.fetch(force: true); + expect(tApp.log.level, equals(Level.SEVERE)); + expect(tApp.remoteConfig.getInt('a'), equals(10)); + expect(tApp.remoteConfig.getInt('b'), equals(0)); + }); + + tApp.dispose(); + }); + + testWidgets('Plugin can be disabled in RemoteConfig.', (tester) async { + testInitialize(); + + final tPluginA = TestPluginA(); + final tPluginB = TestPluginB(); + final tPluginC = TestPluginC(); + + final tRemoteConfigA = MockRemoteConfig({}) + ..testSetMockFetchValues({ + tPluginA.remoteConfigEnabledKey: false, + tPluginB.remoteConfigEnabledKey: false, + tPluginC.remoteConfigEnabledKey: true, + }); + + final tRemoteConfigPlugin = Plugin.inline( + name: 'remoteConfigPlugin', + createRemoteConfig: () => tRemoteConfigA, + ); + + tApp = App( + environment: _Environment(), + createAppWidget: (context, app) { + return MaterialApp( + home: SizedBox.shrink( + key: tWidgetKey, + ), + ); + }, + plugins: [ + tPluginA, + tPluginB, + tPluginC, + tRemoteConfigPlugin, + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.hasPlugin(TestPluginA), isFalse); + expect(tApp.hasPlugin(TestPluginB), isFalse); + expect(tApp.hasPlugin(TestPluginC), isTrue); + }); + + tApp.dispose(); + }); + }); +} diff --git a/packages/patapata_core/test/assets/images/logo.svg b/packages/patapata_core/test/assets/images/logo.svg new file mode 100644 index 0000000..1b811ca --- /dev/null +++ b/packages/patapata_core/test/assets/images/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/patapata_core/test/device_info_test.dart b/packages/patapata_core/test/device_info_test.dart new file mode 100644 index 0000000..a25ef29 --- /dev/null +++ b/packages/patapata_core/test/device_info_test.dart @@ -0,0 +1,540 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +/// TODO: The arguments for "with arguments" +///　will be verified by checking the actual values +///　on the device during the time of going to the office and used as a reference. +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('DeviceInfoPlugin.androidInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugDefaultTargetPlatformOverride = TargetPlatform.android; + }); + + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.androidDeviceInfo != null, isTrue); + expect(deviceInfoPlugin.androidDeviceInfo!.data, + DeviceInfoPlugin.mockAndroidDeviceInfoMap); + }); + + test('setMockAndroidDeviceInfo no arguments', () async { + DeviceInfoPlugin.setMockAndroidDeviceInfo(); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.androidDeviceInfo, isNotNull); + expect(deviceInfoPlugin.androidDeviceInfo!.data, + DeviceInfoPlugin.mockAndroidDeviceInfoMap); + expect(deviceInfoPlugin.androidDeviceInfo!.id, 'id'); + expect(deviceInfoPlugin.androidDeviceInfo!.host, 'host'); + expect(deviceInfoPlugin.androidDeviceInfo!.tags, 'tags'); + expect(deviceInfoPlugin.androidDeviceInfo!.type, 'type'); + expect(deviceInfoPlugin.androidDeviceInfo!.model, 'model'); + expect(deviceInfoPlugin.androidDeviceInfo!.board, 'board'); + expect(deviceInfoPlugin.androidDeviceInfo!.brand, 'Google'); + expect(deviceInfoPlugin.androidDeviceInfo!.device, 'device'); + expect(deviceInfoPlugin.androidDeviceInfo!.product, 'product'); + expect(deviceInfoPlugin.androidDeviceInfo!.display, 'display'); + expect(deviceInfoPlugin.androidDeviceInfo!.hardware, 'hardware'); + expect(deviceInfoPlugin.androidDeviceInfo!.isPhysicalDevice, isTrue); + expect(deviceInfoPlugin.androidDeviceInfo!.bootloader, 'bootloader'); + expect(deviceInfoPlugin.androidDeviceInfo!.fingerprint, 'fingerprint'); + expect(deviceInfoPlugin.androidDeviceInfo!.manufacturer, 'manufacturer'); + expect(deviceInfoPlugin.androidDeviceInfo!.supportedAbis, + ['arm64-v8a', 'x86', 'x86_64']); + expect(deviceInfoPlugin.androidDeviceInfo!.systemFeatures, + ['FEATURE_AUDIO_PRO', 'FEATURE_AUDIO_OUTPUT']); + expect(deviceInfoPlugin.androidDeviceInfo!.version.sdkInt, 16); + expect(deviceInfoPlugin.androidDeviceInfo!.version.baseOS, 'baseOS'); + expect(deviceInfoPlugin.androidDeviceInfo!.version.previewSdkInt, 30); + expect(deviceInfoPlugin.androidDeviceInfo!.version.release, 'release'); + expect(deviceInfoPlugin.androidDeviceInfo!.version.codename, 'codename'); + expect(deviceInfoPlugin.androidDeviceInfo!.version.incremental, + 'incremental'); + expect(deviceInfoPlugin.androidDeviceInfo!.version.securityPatch, + 'securityPatch'); + expect(deviceInfoPlugin.androidDeviceInfo!.supported32BitAbis, + ['x86 (IA-32)', 'MMX']); + expect(deviceInfoPlugin.androidDeviceInfo!.supported64BitAbis, + ['x86-64', 'MMX', 'SSSE3']); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.widthPx, 1080); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.heightPx, 2220); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.xDpi, 530.0859); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.yDpi, 529.4639); + expect(deviceInfoPlugin.androidDeviceInfo!.serialNumber, 'serialNumber'); + }); + + test('setMockAndroidDeviceInfo with arguments', () async { + DeviceInfoPlugin.setMockAndroidDeviceInfo( + id: '', + host: '', + tags: '', + type: '', + model: '', + board: '', + brand: '', + device: '', + product: '', + display: '', + hardware: '', + isPhysicalDevice: false, + bootloader: '', + fingerprint: '', + manufacturer: '', + supportedAbis: [''], + systemFeatures: [''], + version: { + 'sdkInt': 0, + 'baseOS': '', + 'previewSdkInt': 0, + 'release': '', + 'codename': '', + 'incremental': '', + 'securityPatch': '', + }, + supported64BitAbis: [''], + supported32BitAbis: [''], + displayMetrics: { + 'widthPx': 0.0, + 'heightPx': 0.0, + 'xDpi': 0.0, + 'yDpi': 0.0, + }, + serialNumber: '', + ); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.androidDeviceInfo != null, isTrue); + expect(deviceInfoPlugin.androidDeviceInfo!.data, + DeviceInfoPlugin.mockAndroidDeviceInfoMap); + expect(deviceInfoPlugin.androidDeviceInfo!.id, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.host, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.tags, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.type, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.model, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.board, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.brand, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.device, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.product, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.display, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.hardware, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.isPhysicalDevice, isFalse); + expect(deviceInfoPlugin.androidDeviceInfo!.bootloader, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.fingerprint, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.manufacturer, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.supportedAbis, ['']); + expect(deviceInfoPlugin.androidDeviceInfo!.systemFeatures, ['']); + expect(deviceInfoPlugin.androidDeviceInfo!.version.sdkInt, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.version.baseOS, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.version.previewSdkInt, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.version.release, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.version.codename, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.version.incremental, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.version.securityPatch, ''); + expect(deviceInfoPlugin.androidDeviceInfo!.supported32BitAbis, ['']); + expect(deviceInfoPlugin.androidDeviceInfo!.supported64BitAbis, ['']); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.widthPx, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.heightPx, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.xDpi, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.displayMetrics.yDpi, 0); + expect(deviceInfoPlugin.androidDeviceInfo!.serialNumber, ''); + }); + }); + + group('DeviceInfoPlugin.iosInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugDefaultTargetPlatformOverride = TargetPlatform.iOS; + }); + + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.iosDeviceInfo != null, isTrue); + expect(deviceInfoPlugin.iosDeviceInfo!.data, + DeviceInfoPlugin.mockIosDeviceInfoMap); + }); + + test('setMockIosDeviceInfo no arguments', () async { + DeviceInfoPlugin.setMockIosDeviceInfo(); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.iosDeviceInfo != null, isTrue); + expect(deviceInfoPlugin.iosDeviceInfo!.data, + DeviceInfoPlugin.mockIosDeviceInfoMap); + expect(deviceInfoPlugin.iosDeviceInfo!.name, 'name'); + expect(deviceInfoPlugin.iosDeviceInfo!.model, 'model'); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.release, 'release'); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.version, 'version'); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.machine, 'machine'); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.sysname, 'sysname'); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.nodename, 'nodename'); + expect(deviceInfoPlugin.iosDeviceInfo!.systemName, 'systemName'); + expect(deviceInfoPlugin.iosDeviceInfo!.systemVersion, 'systemVersion'); + expect(deviceInfoPlugin.iosDeviceInfo!.localizedModel, 'localizedModel'); + expect(deviceInfoPlugin.iosDeviceInfo!.isPhysicalDevice, isTrue); + expect(deviceInfoPlugin.iosDeviceInfo!.identifierForVendor, + 'identifierForVendor'); + }); + + test('setMockIosDeviceInfo with arguments', () async { + DeviceInfoPlugin.setMockIosDeviceInfo( + name: '', + model: '', + utsname: { + 'release': '', + 'version': '', + 'machine': '', + 'sysname': '', + 'nodename': '', + }, + systemName: '', + systemVersion: '', + isPhysicalDevice: false, + localizedModel: '', + identifierForVendor: '', + ); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.iosDeviceInfo != null, isTrue); + expect(deviceInfoPlugin.iosDeviceInfo!.data, + DeviceInfoPlugin.mockIosDeviceInfoMap); + expect(deviceInfoPlugin.iosDeviceInfo!.name, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.model, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.release, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.version, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.machine, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.sysname, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.utsname.nodename, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.systemName, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.systemVersion, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.localizedModel, ''); + expect(deviceInfoPlugin.iosDeviceInfo!.isPhysicalDevice, isFalse); + expect(deviceInfoPlugin.iosDeviceInfo!.identifierForVendor, ''); + }); + }); + + group('DeviceInfoPlugin.macOsInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugDefaultTargetPlatformOverride = TargetPlatform.macOS; + }); + + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.macOsInfo != null, isTrue); + expect(deviceInfoPlugin.macOsInfo!.data, + DeviceInfoPlugin.mockMacosDeviceInfoMap); + }); + + test('setMockMacosDeviceInfoMap no arguments', () async { + DeviceInfoPlugin.setMockMacosDeviceInfo(); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.macOsInfo != null, isTrue); + expect(deviceInfoPlugin.macOsInfo!.data, + DeviceInfoPlugin.mockMacosDeviceInfoMap); + expect(deviceInfoPlugin.macOsInfo!.arch, 'arch'); + expect(deviceInfoPlugin.macOsInfo!.model, 'model'); + expect(deviceInfoPlugin.macOsInfo!.activeCPUs, 4); + expect(deviceInfoPlugin.macOsInfo!.memorySize, 16); + expect(deviceInfoPlugin.macOsInfo!.cpuFrequency, 2); + expect(deviceInfoPlugin.macOsInfo!.hostName, 'hostName'); + expect(deviceInfoPlugin.macOsInfo!.osRelease, 'osRelease'); + expect(deviceInfoPlugin.macOsInfo!.computerName, 'computerName'); + expect(deviceInfoPlugin.macOsInfo!.kernelVersion, 'kernelVersion'); + expect(deviceInfoPlugin.macOsInfo!.systemGUID, 'systemGUID'); + }); + + test('setMockMacosDeviceInfoMap with arguments', () async { + DeviceInfoPlugin.setMockMacosDeviceInfo( + arch: '', + model: '', + activeCPUs: 0, + memorySize: 0, + cpuFrequency: 0, + hostName: '', + osRelease: '', + computerName: '', + kernelVersion: '', + systemGUID: '', + majorVersion: 1, + minorVersion: 1, + patchVersion: 1, + ); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.macOsInfo != null, isTrue); + expect(deviceInfoPlugin.macOsInfo!.data, + DeviceInfoPlugin.mockMacosDeviceInfoMap); + expect(deviceInfoPlugin.macOsInfo!.arch, ''); + expect(deviceInfoPlugin.macOsInfo!.model, ''); + expect(deviceInfoPlugin.macOsInfo!.activeCPUs, 0); + expect(deviceInfoPlugin.macOsInfo!.memorySize, 0); + expect(deviceInfoPlugin.macOsInfo!.cpuFrequency, 0); + expect(deviceInfoPlugin.macOsInfo!.hostName, ''); + expect(deviceInfoPlugin.macOsInfo!.osRelease, ''); + expect(deviceInfoPlugin.macOsInfo!.computerName, ''); + expect(deviceInfoPlugin.macOsInfo!.kernelVersion, ''); + expect(deviceInfoPlugin.macOsInfo!.systemGUID, ''); + expect(deviceInfoPlugin.macOsInfo!.majorVersion, 1); + expect(deviceInfoPlugin.macOsInfo!.minorVersion, 1); + expect(deviceInfoPlugin.macOsInfo!.patchVersion, 1); + }); + }); + + group('DeviceInfoPlugin.linuxInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + DeviceInfoLinuxPlatform.registerWith(); + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugDefaultTargetPlatformOverride = TargetPlatform.linux; + }); + + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.linuxInfo != null, isTrue); + }); + test('setMockLinuxDeviceInfo no arguments', () async { + DeviceInfoPlugin.setMockLinuxDeviceInfo(); + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.linuxInfo != null, isTrue); + expect(deviceInfoPlugin.linuxInfo!.name, 'name'); + expect(deviceInfoPlugin.linuxInfo!.version, 'version'); + expect(deviceInfoPlugin.linuxInfo!.id, 'id'); + expect(deviceInfoPlugin.linuxInfo!.idLike, ['idLike']); + expect(deviceInfoPlugin.linuxInfo!.versionCodename, 'versionCodename'); + expect(deviceInfoPlugin.linuxInfo!.versionId, 'versionId'); + expect(deviceInfoPlugin.linuxInfo!.prettyName, 'prettyName'); + expect(deviceInfoPlugin.linuxInfo!.buildId, 'buildId'); + expect(deviceInfoPlugin.linuxInfo!.variant, 'variant'); + expect(deviceInfoPlugin.linuxInfo!.variantId, 'variantId'); + expect(deviceInfoPlugin.linuxInfo!.machineId, 'machineId'); + }); + + test('setMockLinuxDeviceInfo with arguments', () async { + DeviceInfoPlugin.setMockLinuxDeviceInfo( + name: '', + version: '', + id: '', + idLike: [''], + versionCodename: '', + versionId: '', + prettyName: '', + buildId: '', + variant: '', + variantId: '', + machineId: '', + ); + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.linuxInfo != null, isTrue); + expect(deviceInfoPlugin.linuxInfo!.name, ''); + expect(deviceInfoPlugin.linuxInfo!.version, ''); + expect(deviceInfoPlugin.linuxInfo!.id, ''); + expect(deviceInfoPlugin.linuxInfo!.idLike, ['']); + expect(deviceInfoPlugin.linuxInfo!.versionCodename, ''); + expect(deviceInfoPlugin.linuxInfo!.versionId, ''); + expect(deviceInfoPlugin.linuxInfo!.prettyName, ''); + expect(deviceInfoPlugin.linuxInfo!.buildId, ''); + expect(deviceInfoPlugin.linuxInfo!.variant, ''); + expect(deviceInfoPlugin.linuxInfo!.variantId, ''); + expect(deviceInfoPlugin.linuxInfo!.machineId, ''); + }); + }); + + group('DeviceInfoPlugin.windowsInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + DeviceInfoWindowsPlatform.registerWith(); + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugDefaultTargetPlatformOverride = TargetPlatform.windows; + }); + + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.windowsInfo != null, isTrue); + }); + + test('setMockWindowsDeviceInfo no arguments', () async { + DeviceInfoPlugin.setMockWindowsDeviceInfo(); + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.windowsInfo != null, isTrue); + expect(deviceInfoPlugin.windowsInfo!.computerName, 'computerName'); + expect(deviceInfoPlugin.windowsInfo!.numberOfCores, 4); + expect(deviceInfoPlugin.windowsInfo!.systemMemoryInMegabytes, 16); + expect(deviceInfoPlugin.windowsInfo!.userName, 'userName'); + expect(deviceInfoPlugin.windowsInfo!.majorVersion, 10); + expect(deviceInfoPlugin.windowsInfo!.minorVersion, 0); + expect(deviceInfoPlugin.windowsInfo!.buildNumber, 10240); + expect(deviceInfoPlugin.windowsInfo!.platformId, 1); + expect(deviceInfoPlugin.windowsInfo!.csdVersion, 'csdVersion'); + expect(deviceInfoPlugin.windowsInfo!.servicePackMajor, 1); + expect(deviceInfoPlugin.windowsInfo!.servicePackMinor, 0); + expect(deviceInfoPlugin.windowsInfo!.suitMask, 1); + expect(deviceInfoPlugin.windowsInfo!.productType, 1); + expect(deviceInfoPlugin.windowsInfo!.reserved, 1); + expect(deviceInfoPlugin.windowsInfo!.buildLab, + '22000.co_release.210604-1628'); + expect(deviceInfoPlugin.windowsInfo!.buildLabEx, + '22000.1.amd64fre.co_release.210604-1628'); + expect(deviceInfoPlugin.windowsInfo!.digitalProductId, + Uint8List.fromList([])); + expect(deviceInfoPlugin.windowsInfo!.displayVersion, '21H2'); + expect(deviceInfoPlugin.windowsInfo!.editionId, 'Pro'); + expect(deviceInfoPlugin.windowsInfo!.installDate, DateTime(2022, 04, 02)); + expect(deviceInfoPlugin.windowsInfo!.productId, '00000-00000-0000-AAAAA'); + expect(deviceInfoPlugin.windowsInfo!.productName, 'Windows 10 Pro'); + expect(deviceInfoPlugin.windowsInfo!.registeredOwner, 'registeredOwner'); + expect(deviceInfoPlugin.windowsInfo!.releaseId, 'releaseId'); + expect(deviceInfoPlugin.windowsInfo!.deviceId, 'deviceId'); + }); + test('setMockWindowsDeviceInfo with arguments', () async { + DeviceInfoPlugin.setMockWindowsDeviceInfo( + computerName: '', + numberOfCores: 0, + systemMemoryInMegabytes: 0, + userName: '', + majorVersion: 0, + minorVersion: 1, + buildNumber: 0, + platformId: 0, + csdVersion: '', + servicePackMajor: 0, + servicePackMinor: 1, + suitMask: 0, + productType: 0, + reserved: 0, + buildLab: '', + buildLabEx: '', + digitalProductId: Uint8List.fromList([]), + displayVersion: '', + editionId: '', + installDate: DateTime(2023, 04, 02), + productId: '', + productName: '', + registeredOwner: '', + releaseId: '', + deviceId: '', + ); + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.windowsInfo != null, isTrue); + expect(deviceInfoPlugin.windowsInfo!.computerName, ''); + expect(deviceInfoPlugin.windowsInfo!.numberOfCores, 0); + expect(deviceInfoPlugin.windowsInfo!.systemMemoryInMegabytes, 0); + expect(deviceInfoPlugin.windowsInfo!.userName, ''); + expect(deviceInfoPlugin.windowsInfo!.majorVersion, 0); + expect(deviceInfoPlugin.windowsInfo!.minorVersion, 1); + expect(deviceInfoPlugin.windowsInfo!.buildNumber, 0); + expect(deviceInfoPlugin.windowsInfo!.platformId, 0); + expect(deviceInfoPlugin.windowsInfo!.csdVersion, ''); + expect(deviceInfoPlugin.windowsInfo!.servicePackMajor, 0); + expect(deviceInfoPlugin.windowsInfo!.servicePackMinor, 1); + expect(deviceInfoPlugin.windowsInfo!.suitMask, 0); + expect(deviceInfoPlugin.windowsInfo!.productType, 0); + expect(deviceInfoPlugin.windowsInfo!.reserved, 0); + expect(deviceInfoPlugin.windowsInfo!.buildLab, ''); + expect(deviceInfoPlugin.windowsInfo!.buildLabEx, ''); + expect(deviceInfoPlugin.windowsInfo!.digitalProductId, + Uint8List.fromList([])); + expect(deviceInfoPlugin.windowsInfo!.displayVersion, ''); + expect(deviceInfoPlugin.windowsInfo!.editionId, ''); + expect(deviceInfoPlugin.windowsInfo!.installDate, DateTime(2023, 04, 02)); + expect(deviceInfoPlugin.windowsInfo!.productId, ''); + expect(deviceInfoPlugin.windowsInfo!.productName, ''); + expect(deviceInfoPlugin.windowsInfo!.registeredOwner, ''); + expect(deviceInfoPlugin.windowsInfo!.releaseId, ''); + expect(deviceInfoPlugin.windowsInfo!.deviceId, ''); + }); + }); + + group('DeviceInfoPlugin.webInfo', () { + late App app; + late DeviceInfoPlugin deviceInfoPlugin; + setUp(() { + DeviceInfoWebPlatform.registerWith(); + app = createApp(); + deviceInfoPlugin = DeviceInfoPlugin(); + debugIsWeb = true; + }); + test('init', () async { + final bool tResult = await deviceInfoPlugin.init(app); + + expect(tResult, isTrue); + expect(deviceInfoPlugin.webInfo != null, isTrue); + expect(deviceInfoPlugin.webInfo!.data, + DeviceInfoPlugin.mockWebBrowserInfoMap); + }); + test('setMockWebBrowserInfoMap no arguments', () async { + DeviceInfoPlugin.setMockWebBrowserInfo(); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.webInfo != null, isTrue); + expect(deviceInfoPlugin.webInfo!.data, + DeviceInfoPlugin.mockWebBrowserInfoMap); + }); + test('setMockWebBrowserInfoMap with arguments', () async { + DeviceInfoPlugin.setMockWebBrowserInfo( + browserName: 'safari', + appCodeName: 'appCodeName', + appName: 'appName', + appVersion: 'appVersion', + deviceMemory: 42, + language: 'language', + languages: ['en', 'es'], + platform: 'platform', + product: 'product', + productSub: 'productSub', + userAgent: 'Safari', + vendor: 'vendor', + vendorSub: 'vendorSub', + hardwareConcurrency: 2, + maxTouchPoints: 42, + ); + await deviceInfoPlugin.init(app); + + expect(deviceInfoPlugin.webInfo != null, isTrue); + expect(deviceInfoPlugin.webInfo!.data, + DeviceInfoPlugin.mockWebBrowserInfoMap); + }); + }); +} diff --git a/packages/patapata_core/test/error_test.dart b/packages/patapata_core/test/error_test.dart new file mode 100644 index 0000000..763daa8 --- /dev/null +++ b/packages/patapata_core/test/error_test.dart @@ -0,0 +1,434 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/src/exception.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +class _ErrorTestEnvironment extends Environment with ErrorEnvironment { + @override + Future Function(BuildContext context, PatapataException error)? + get errorDefaultShowDialog => (context, error) { + return PlatformDialog.show( + context: context, + title: 'custom:${error.localizedTitle}', + message: 'custom:${error.localizedMessage}', + actions: [ + PlatformDialogAction( + result: () {}, + isDefault: true, + text: 'custom:${error.localizedFix}', + ), + ], + ); + }; + + @override + Widget Function(PatapataException p1)? get errorDefaultWidget => (error) { + return Text('custom:${error.localizedMessage}'); + }; + + @override + Map? get errorReplacePrefixMap => {'test': 'CST'}; +} + +class _TestException extends PatapataException { + _TestException({ + super.app, + super.message, + super.original, + super.fingerprint, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + super.logLevel, + super.userLogLevel, + super.fix, + }); + + @override + String get defaultPrefix => 'TST'; + + @override + String get internalCode => '000'; + + @override + String get namespace => 'test'; +} + +class _TestExceptionWithFix extends _TestException { + _TestExceptionWithFix({ + required super.fix, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + }); +} + +class _TestInfoException extends _TestException { + _TestInfoException() + : super( + app: null, + message: null, + original: null, + fingerprint: null, + localeTitleData: null, + localeMessageData: null, + localeFixData: null, + logLevel: Level.INFO, + ); +} + +class _TestShoutException extends _TestException { + _TestShoutException() + : super( + app: null, + message: null, + original: null, + fingerprint: null, + localeTitleData: null, + localeMessageData: null, + localeFixData: null, + logLevel: Level.INFO, + userLogLevel: Level.SHOUT, + ); + + @override + String get defaultPrefix => 'TSS'; + + @override + String get internalCode => '111'; + + @override + String get namespace => 'test.shout'; +} + +class _TestPatapataCoreException extends PatapataCoreException { + _TestPatapataCoreException({required super.code}); +} + +void main() { + testWidgets( + 'Error test.', + (WidgetTester tTester) async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + final App tApp = createApp(); + tApp.run(); + + await tApp.runProcess(() async { + await tTester.pumpAndSettle(); + + final tException = _TestException( + message: 'TestError', + original: 'OriginalError', + localeTitleData: {'data': '111'}, + localeMessageData: {'data': '222'}, + localeFixData: {'data': '333'}, + fingerprint: ['A', 'B', 'C'], + ); + expect(tException.code, 'TST000'); + expect(tException.message, 'TestError'); + expect(tException.original, 'OriginalError'); + expect(tException.logLevel, null); + expect(tException.userLogLevel, null); + expect( + tException.localizedTitle, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.title', + {'prefix': 'TST', 'data': '111'}, + ), + ); + expect( + tException.localizedMessage, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.message', + {'prefix': 'TST', 'data': '222'}, + ), + ); + expect( + tException.localizedFix, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.fix', + {'prefix': 'TST', 'data': '333'}, + ), + ); + expect(tException.hasFix, false); + expect(tException.fingerprint, ['A', 'B', 'C']); + + tException.showDialog(StandardMaterialApp.globalNavigatorContext!); + await tTester.pumpAndSettle(); + expect(find.byType(AlertDialog), findsOneWidget); + expect(find.text(tException.localizedTitle), findsOneWidget); + expect(find.text(tException.localizedMessage), findsOneWidget); + expect(find.text('OK'), findsOneWidget); + await tTester.tap(find.text('OK')); + + await tTester.pumpWidget( + MaterialApp( + home: tException.widget, + ), + ); + expect(find.text(tException.localizedMessage), findsOneWidget); + + expect(tException.toString(), + '_TestException: code=TST000, message=TestError, original=OriginalError'); + + final tExceptionNoMessage = _TestException(); + expect(tExceptionNoMessage.toString(), + '_TestException: code=TST000, message=null'); + }); + + tApp.dispose(); + + debugDefaultTargetPlatformOverride = null; + }, + ); + + test( + 'Tests log level. if userLogLevel is null, then logLevel is the value of logLevel.', + () async { + final tExceptionA = _TestException(); + expect(tExceptionA.logLevel, null); + expect(tExceptionA.userLogLevel, null); + + final tExceptionB = _TestException( + logLevel: Level.FINE, + userLogLevel: Level.SHOUT, + ); + expect(tExceptionB.logLevel, Level.FINE); + expect(tExceptionB.userLogLevel, Level.SHOUT); + + final tExceptionC = _TestException( + userLogLevel: Level.INFO, + ); + expect(tExceptionC.logLevel, null); + expect(tExceptionC.userLogLevel, Level.INFO); + + final tExceptionD = _TestException( + logLevel: Level.SEVERE, + ); + expect(tExceptionD.logLevel, Level.SEVERE); + expect(tExceptionD.userLogLevel, Level.SEVERE); + }, + ); + + testWidgets('Error Fix test.', (WidgetTester tTester) async { + final App tApp = createApp(); + tApp.run(); + + bool tFixed = false; + + await tApp.runProcess(() async { + await tTester.pumpAndSettle(); + + final tException = _TestExceptionWithFix( + localeTitleData: {'data': '111'}, + localeMessageData: {'data': '222'}, + localeFixData: {'data': '333'}, + fix: () async { + tFixed = true; + }); + + expect( + tException.localizedFix, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.fix', + {'prefix': 'TST', 'data': '333'}, + ), + ); + expect(tException.hasFix, true); + expect(tFixed, false); + await tException.fix!(); + expect(tFixed, true); + }); + + tApp.dispose(); + }); + + testWidgets('Error Environment test.', (WidgetTester tTester) async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + final App tApp = createApp( + environment: _ErrorTestEnvironment(), + ); + tApp.run(); + + await tApp.runProcess(() async { + await tTester.pumpAndSettle(); + + final tException = _TestException( + localeTitleData: {'data': '111'}, + localeMessageData: {'data': '222'}, + localeFixData: {'data': '333'}, + ); + expect(tException.code, 'CST000'); + expect( + tException.localizedTitle, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.title', + {'prefix': 'CST', 'data': '111'}, + ), + ); + expect( + tException.localizedMessage, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.message', + {'prefix': 'CST', 'data': '222'}, + ), + ); + expect( + tException.localizedFix, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.fix', + {'prefix': 'CST', 'data': '333'}, + ), + ); + + tException.showDialog(StandardMaterialApp.globalNavigatorContext!); + await tTester.pumpAndSettle(); + expect(find.byType(AlertDialog), findsOneWidget); + expect(find.text('custom:${tException.localizedTitle}'), findsOneWidget); + expect( + find.text('custom:${tException.localizedMessage}'), findsOneWidget); + expect(find.text('custom:${tException.localizedFix}'), findsOneWidget); + await tTester.tap(find.text('custom:${tException.localizedFix}')); + + await tTester.pumpWidget( + MaterialApp( + home: tException.widget, + ), + ); + expect( + find.text('custom:${tException.localizedMessage}'), findsOneWidget); + }); + + tApp.dispose(); + + debugDefaultTargetPlatformOverride = null; + }); + + testWidgets('Error log and navigate test.', (WidgetTester tTester) async { + final tLogger = Logger('errorTest'); + final App tApp = createApp( + environment: _ErrorTestEnvironment(), + ); + tApp.run(); + + await tApp.runProcess(() async { + await tTester.pumpAndSettle(); + + final tException = _TestInfoException(); + expect(tException.logLevel, Level.INFO); + expect(tException.userLogLevel, Level.INFO); + tLogger.info(tException.toString(), tException); + await tTester.pumpAndSettle(); + expect(find.text(tException.localizedMessage), findsNothing); + + final tShoutException = _TestShoutException(); + expect(tShoutException.logLevel, Level.INFO); + expect(tShoutException.userLogLevel, Level.SHOUT); + tLogger.info(tShoutException.toString(), tShoutException); + expect( + tShoutException.localizedMessage, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.shout.111.message', + {'prefix': 'TSS'}, + ), + ); + await tTester.pumpAndSettle(); + expect(find.text(tShoutException.localizedMessage), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets( + 'Error test.(no app zone)', + (WidgetTester tTester) async { + final App tApp = createApp(); + tApp.run(); + await tApp.runProcess(() async { + await tTester.pumpAndSettle(); + }); + + final tException = _TestException( + localeTitleData: {'data': '111'}, + localeMessageData: {'data': '222'}, + localeFixData: {'data': '333'}, + ); + expect( + tException.localizedTitle, + 'Error: TST000', + ); + expect( + tException.localizedMessage, + '_TestException: code=TST000', + ); + expect( + tException.localizedFix, + 'OK', + ); + + final tExceptionWithApp = _TestException( + app: tApp, + localeTitleData: {'data': '111'}, + localeMessageData: {'data': '222'}, + localeFixData: {'data': '333'}, + ); + expect( + tExceptionWithApp.localizedTitle, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.title', + {'prefix': 'TST', 'data': '111'}, + ), + ); + expect( + tExceptionWithApp.localizedMessage, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.message', + {'prefix': 'TST', 'data': '222'}, + ), + ); + expect( + tExceptionWithApp.localizedFix, + l( + StandardMaterialApp.globalNavigatorContext!, + 'errors.test.000.fix', + {'prefix': 'TST', 'data': '333'}, + ), + ); + + tApp.dispose(); + }, + ); + + test('TestPatapataCoreException test.', () { + final tException = _TestPatapataCoreException( + code: PatapataCoreExceptionCode.PPE101, + ); + + expect('patapata', tException.namespace); + expect('PPE', tException.prefix); + expect('PPE101', tException.code); + }); +} diff --git a/packages/patapata_core/test/goldens/ScreenLayout_BreakPoint_CopyTest.png b/packages/patapata_core/test/goldens/ScreenLayout_BreakPoint_CopyTest.png new file mode 100644 index 0000000..368b48b Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_BreakPoint_CopyTest.png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2224.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2224.0).png new file mode 100644 index 0000000..2372e90 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2224.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2388.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2388.0).png new file mode 100644 index 0000000..2b9073f Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1668.0, 2388.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1920.0, 1080.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1920.0, 1080.0).png new file mode 100644 index 0000000..ae45c9c Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(1920.0, 1080.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(2048.0, 2732.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(2048.0, 2732.0).png new file mode 100644 index 0000000..a85e1ff Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(2048.0, 2732.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 667.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 667.0).png new file mode 100644 index 0000000..882aa93 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 667.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 812.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 812.0).png new file mode 100644 index 0000000..2d85678 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(375.0, 812.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 736.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 736.0).png new file mode 100644 index 0000000..fd9defd Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 736.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 896.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 896.0).png new file mode 100644 index 0000000..8b4f6f3 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(414.0, 896.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(768.0, 1024.0).png b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(768.0, 1024.0).png new file mode 100644 index 0000000..029ae7b Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_ChangeBreakPoint_Size(768.0, 1024.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2224.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2224.0).png new file mode 100644 index 0000000..f2aac39 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2224.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2388.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2388.0).png new file mode 100644 index 0000000..3e97d25 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1668.0, 2388.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1920.0, 1080.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1920.0, 1080.0).png new file mode 100644 index 0000000..cf9adb2 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(1920.0, 1080.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(2048.0, 2732.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(2048.0, 2732.0).png new file mode 100644 index 0000000..a3581e2 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(2048.0, 2732.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 667.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 667.0).png new file mode 100644 index 0000000..368b48b Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 667.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 812.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 812.0).png new file mode 100644 index 0000000..9823c1d Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(375.0, 812.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 736.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 736.0).png new file mode 100644 index 0000000..ef7a448 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 736.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 896.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 896.0).png new file mode 100644 index 0000000..e2220be Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(414.0, 896.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(768.0, 1024.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(768.0, 1024.0).png new file mode 100644 index 0000000..1e193a3 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Disable_Size(768.0, 1024.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2224.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2224.0).png new file mode 100644 index 0000000..451874b Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2224.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2388.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2388.0).png new file mode 100644 index 0000000..84e20ce Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(1668.0, 2388.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(1920.0, 1080.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(1920.0, 1080.0).png new file mode 100644 index 0000000..fdd1f66 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(1920.0, 1080.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(2048.0, 2732.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(2048.0, 2732.0).png new file mode 100644 index 0000000..dc4a152 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(2048.0, 2732.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 667.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 667.0).png new file mode 100644 index 0000000..368b48b Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 667.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 812.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 812.0).png new file mode 100644 index 0000000..9823c1d Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(375.0, 812.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 736.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 736.0).png new file mode 100644 index 0000000..0dd0634 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 736.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 896.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 896.0).png new file mode 100644 index 0000000..8cac469 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(414.0, 896.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(667.0, 375.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(667.0, 375.0).png new file mode 100644 index 0000000..e2f788c Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(667.0, 375.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Size(768.0, 1024.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Size(768.0, 1024.0).png new file mode 100644 index 0000000..8d728bc Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Size(768.0, 1024.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Transform_Disable_Size(414.0, 736.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Transform_Disable_Size(414.0, 736.0).png new file mode 100644 index 0000000..6388180 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Transform_Disable_Size(414.0, 736.0).png differ diff --git a/packages/patapata_core/test/goldens/ScreenLayout_Transform_Size(414.0, 736.0).png b/packages/patapata_core/test/goldens/ScreenLayout_Transform_Size(414.0, 736.0).png new file mode 100644 index 0000000..2aa4221 Binary files /dev/null and b/packages/patapata_core/test/goldens/ScreenLayout_Transform_Size(414.0, 736.0).png differ diff --git a/packages/patapata_core/test/i18n_test.dart b/packages/patapata_core/test/i18n_test.dart new file mode 100644 index 0000000..eb47d41 --- /dev/null +++ b/packages/patapata_core/test/i18n_test.dart @@ -0,0 +1,370 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:flutter/widgets.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/src/exception.dart'; + +import 'pages/home_page.dart'; +import 'utils/patapata_core_test_utils.dart'; + +class _Environment { + const _Environment(); +} + +class _I18nEnvironment with I18nEnvironment { + const _I18nEnvironment(this._l10nPaths, this._supportedL10ns); + + final List? _l10nPaths; + + @override + List? get l10nPaths => _l10nPaths; + + final List? _supportedL10ns; + + @override + List? get supportedL10ns => _supportedL10ns; +} + +void main() { + group('class L10n', () { + setUp(() { + testInitialize(); + }); + + test( + 'Create L10n class.', + () async { + const tL10n = L10n( + Locale('en'), + { + 'aaa': 'Test', + }, + ); + + expect(tL10n.locale, equals(const Locale('en'))); + expect(tL10n.containsMessageKey('aaa'), isTrue); + expect(tL10n.lookup('aaa'), equals('Test')); + expect(tL10n.containsMessageKey('bbb'), isFalse); + expect(tL10n.lookup('bbb'), equals('bbb')); + }, + ); + + test( + 'The resource is loaded from assets and the lookup works correctly.', + () async { + final tL10nEn = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['l10n'], + assetBundle: mockL10nAssetBundle, + ); + final tL10nJa = await L10n.fromAssets( + locale: const Locale('ja'), + paths: ['l10n'], + assetBundle: mockL10nAssetBundle, + ); + + // en + expect(tL10nEn.locale, equals(const Locale('en'))); + expect(tL10nEn.lookup('home.title'), equals('HomePage')); + expect(tL10nEn.containsMessageKey('test.title'), isTrue); + expect( + tL10nEn.lookup( + 'test.title', + namedParameters: {'param': 'en'}, + ), + equals('TestMessage:en'), + ); + expect(tL10nEn.containsMessageKey('test2.title'), isFalse); + expect( + tL10nEn.lookup( + 'test2.title', + namedParameters: {'param': 'en'}, + ), + equals('test2.title'), + ); + + // ja + expect(tL10nJa.locale, equals(const Locale('ja'))); + expect(tL10nJa.lookup('home.title'), equals('ホーム')); + expect(tL10nJa.containsMessageKey('test.title'), isTrue); + expect( + tL10nJa.lookup( + 'test.title', + namedParameters: {'param': 'ja'}, + ), + equals('テストメッセージ:ja'), + ); + expect(tL10nJa.containsMessageKey('test2.title'), isFalse); + expect( + tL10nJa.lookup( + 'test2.title', + namedParameters: {'param': 'ja'}, + ), + equals('test2.title'), + ); + }, + ); + + test( + 'If multiple paths are specified, the same key will be overwritten by subsequent files.', + () async { + final tL10nEn = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['l10n', 'l10n2'], + assetBundle: mockL10nAssetBundle, + ); + final tL10nJa = await L10n.fromAssets( + locale: const Locale('ja'), + paths: ['l10n', 'l10n2'], + assetBundle: mockL10nAssetBundle, + ); + + // en + expect(tL10nEn.lookup('home.title'), equals('HomePage2')); + expect(tL10nEn.containsMessageKey('test.title'), isTrue); + expect( + tL10nEn.lookup( + 'test.title', + namedParameters: {'param': 'en'}, + ), + equals('TestMessage:en'), + ); + expect(tL10nEn.containsMessageKey('test2.title'), isTrue); + expect( + tL10nEn.lookup( + 'test2.title', + namedParameters: {'param': 'en'}, + ), + equals('TestMessage2:en'), + ); + + // ja + expect(tL10nJa.lookup('home.title'), equals('ホーム2')); + expect(tL10nJa.containsMessageKey('test.title'), isTrue); + expect( + tL10nJa.lookup( + 'test.title', + namedParameters: {'param': 'ja'}, + ), + equals('テストメッセージ:ja'), + ); + expect(tL10nJa.containsMessageKey('test2.title'), isTrue); + expect( + tL10nJa.lookup( + 'test2.title', + namedParameters: {'param': 'ja'}, + ), + equals('テストメッセージ2:ja'), + ); + }, + ); + test( + 'Load error in assets. The `patapata_dummy_never` is set as dummy.', + () async { + // The path is invalid and will not be loaded. + final tL10nNotFound = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['aaa'], + assetBundle: mockL10nAssetBundle, + ); + + // Languages not supported by the app are not loaded. + final tL10nAr = await L10n.fromAssets( + locale: const Locale('ar'), + paths: ['l10n'], + assetBundle: mockL10nAssetBundle, + ); + + // Since [assetBundle] is not specified, the assets is loaded from [rootBundle], + // but in the test environment, the actual assets does not exist. + final tL10nEn = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['l10n'], + ); + + expect(tL10nNotFound.containsMessageKey('home.title'), isFalse); + expect(tL10nNotFound.lookup('patapata_dummy_never'), 'dummy'); + expect(tL10nAr.containsMessageKey('home.title'), isFalse); + expect(tL10nAr.lookup('patapata_dummy_never'), 'dummy'); + expect(tL10nEn.containsMessageKey('home.title'), isFalse); + expect(tL10nEn.lookup('patapata_dummy_never'), 'dummy'); + }, + ); + + test( + 'Parse error in yaml.', + () async { + Object? tException; + final tLogSubscription = + Logger.root.onRecord.listen((LogRecord record) { + tException = record.error; + }); + + final tL10nError = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['parse_error'], + assetBundle: mockL10nAssetBundle, + ); + + expect(tL10nError.containsMessageKey('home.title'), isFalse); + expect(tL10nError.containsMessageKey('patapata_dummy_never'), isFalse); + expect(tException, isA()); + expect((tException as L10nLoadAssetsException).code, + equals(PatapataCoreExceptionCode.PPE401.name)); + + // Empty yaml file + tException = null; + final tL10nEmpty = await L10n.fromAssets( + locale: const Locale('en'), + paths: ['empty'], + assetBundle: mockL10nAssetBundle, + ); + + expect(tL10nEmpty.containsMessageKey('home.title'), isFalse); + expect(tL10nEmpty.containsMessageKey('patapata_dummy_never'), isFalse); + expect(tException, isA()); + expect((tException as L10nLoadAssetsException).code, + equals(PatapataCoreExceptionCode.PPE401.name)); + + tLogSubscription.cancel(); + }, + ); + }); + + group('Initialize I18nPlugin and load assets.', () { + test( + "If I18nEnvironment is not specified, Locale('en') is read from l10n as default.", + () async { + final tApp = createApp(environment: const _Environment()); + final tI18nPlugin = I18nPlugin(); + const tLocale = Locale('en'); + + final bool tResult = await tI18nPlugin.init(tApp); + expect(tResult, isTrue); + expect(tI18nPlugin.i18n.supportedL10ns, [tLocale]); + expect(tI18nPlugin.i18n.delegate.isSupported(tLocale), isTrue); + expect( + tI18nPlugin.i18n.delegate.isSupported(const Locale('ja')), isFalse); + expect(tI18nPlugin.i18n.delegate.l10n, isNull); + await tI18nPlugin.i18n.delegate.load(tLocale); + expect(tI18nPlugin.i18n.delegate.l10n, isNotNull); + expect(tI18nPlugin.i18n.delegate.l10n!.containsMessageKey('test.title'), + isTrue); + }, + ); + + test( + 'If I18nEnvironment.l10nPaths is not set, `l10n` will be the default.', + () async { + final tApp = createApp( + environment: const _I18nEnvironment(null, [Locale('en')])); + final tI18nPlugin = I18nPlugin(); + const tLocale = Locale('en'); + + final bool tResult = await tI18nPlugin.init(tApp); + expect(tResult, isTrue); + await tI18nPlugin.i18n.delegate.load(tLocale); + expect(tI18nPlugin.i18n.delegate.l10n!.containsMessageKey('test.title'), + isTrue); + }, + ); + + test( + 'If I18nEnvironment.supportedL10ns is required.', + () async { + final tApp = createApp(environment: const _I18nEnvironment(null, null)); + final tI18nPlugin = I18nPlugin(); + + final bool tResult = await tI18nPlugin.init(tApp); + expect(tResult, isFalse); + }, + ); + }); + + group( + 'Widget tests', + () { + late App tApp; + + setUp(() async { + tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => HomePage(), + ), + ], + ), + ); + }); + + testWidgets( + 'l function process correctly.', + (WidgetTester tester) async { + tApp.run(); + + await tApp.runProcess( + () async { + await tester.pumpAndSettle(); + + expect( + l(StandardMaterialApp.globalNavigatorContext!, 'home.title'), + equals('HomePage'), + ); + expect( + l( + StandardMaterialApp.globalNavigatorContext!, + 'test.title', + { + 'param': 'test', + }, + ), + equals('TestMessage:test'), + ); + }, + ); + + tApp.dispose(); + }, + ); + + testWidgets( + 'L10n.containsKey process correctly.', + (WidgetTester tester) async { + tApp.run(); + + await tApp.runProcess( + () async { + await tester.pumpAndSettle(); + + expect( + L10n.containsKey( + context: StandardMaterialApp.globalNavigatorContext!, + key: 'home.title', + ), + isTrue, + ); + expect( + L10n.containsKey( + context: StandardMaterialApp.globalNavigatorContext!, + key: 'test2.title', + ), + isFalse, + ); + }, + ); + + tApp.dispose(); + }, + ); + }, + ); +} diff --git a/packages/patapata_core/test/local_config_plugin_test.dart b/packages/patapata_core/test/local_config_plugin_test.dart new file mode 100644 index 0000000..1af205e --- /dev/null +++ b/packages/patapata_core/test/local_config_plugin_test.dart @@ -0,0 +1,52 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/src/native_local_config_finder.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('LocalConfigFinder', () { + test('factory LocalConfigFinder', () async { + final tLocalConfigFinder = LocalConfigFinder(); + expect(tLocalConfigFinder.runtimeType, NativeLocalConfigFinder); + }); + + test('getLocalConfig', () async { + final tLocalConfigFinder = LocalConfigFinder(); + LocalConfig? tLocalConfig = tLocalConfigFinder.getLocalConfig(); + + expect(tLocalConfig, isNotNull); + expect(tLocalConfig.runtimeType, NativeLocalConfig); + }); + }); + + group('NativeLocalConfigPlugin', () { + test('init | dispose', () async { + final NativeLocalConfigPlugin tNativeLocalConfigPlugin = + NativeLocalConfigPlugin(); + + final tApp = createApp(); + + await tNativeLocalConfigPlugin.init(tApp); + expect(tNativeLocalConfigPlugin.initialized, isTrue); + + tNativeLocalConfigPlugin.dispose(); + expect(tNativeLocalConfigPlugin.disposed, isTrue); + }); + + test('createLocalConfig', () async { + final NativeLocalConfigPlugin tNativeLocalConfigPlugin = + NativeLocalConfigPlugin(); + + final tNativaLocalConfig = tNativeLocalConfigPlugin.createLocalConfig(); + expect(tNativaLocalConfig.runtimeType, NativeLocalConfig); + }); + }); +} diff --git a/packages/patapata_core/test/log_test.dart b/packages/patapata_core/test/log_test.dart new file mode 100644 index 0000000..61681ae --- /dev/null +++ b/packages/patapata_core/test/log_test.dart @@ -0,0 +1,1390 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:intl/intl.dart'; +import 'package:stack_trace/stack_trace.dart'; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +final _logger = Logger('test.log'); + +class TestLogEnvironment with LogEnvironment { + const TestLogEnvironment({ + int? logLevel, + bool? printLog, + }) : _logLevel = logLevel, + _printLog = printLog; + + final int? _logLevel; + final bool? _printLog; + + @override + int get logLevel => _logLevel ?? Level.INFO.value; + + @override + bool get printLog => _printLog ?? super.printLog; +} + +class TestPatapataException extends PatapataException { + const TestPatapataException({ + required void Function(ReportRecord) onReported, + }) : _onReported = onReported; + + final void Function(ReportRecord) _onReported; + + @override + void onReported(ReportRecord record) { + _onReported(record); + } + + @override + String get defaultPrefix => 'LOG'; + + @override + String get internalCode => '000'; + + @override + String get namespace => 'test'; +} + +void main() { + testWidgets('ReportRecord constructor.', (WidgetTester tester) async { + ReportRecord tRecord; + StackTrace? tStackTrace; + try { + throw Exception('dummy'); + } catch (e, stackTrace) { + tStackTrace = stackTrace; + tRecord = ReportRecord( + level: Level.SEVERE, + message: 'message', + error: 'error', + object: 'object', + stackTrace: tStackTrace, + ); + } + expect(tRecord.level, equals(Level.SEVERE)); + expect(tRecord.message, equals('message')); + expect(tRecord.error, equals('error')); + expect(tRecord.object, equals('object')); + expect(tRecord.stackTrace, equals(tStackTrace)); + + // stackTrace from Error. + Error? tError; + try { + // throw Error(); + Object? tObject; + tObject!.toString(); + } catch (e, stackTrace) { + expect(e, isA()); + tError = e as Error; + tStackTrace = stackTrace; + tRecord = ReportRecord( + level: Level.SEVERE, + message: 'message', + error: e, + object: 'object', + ); + } + expect(tRecord.level, equals(Level.SEVERE)); + expect(tRecord.message, equals('message')); + expect(tRecord.error, equals(tError)); + expect(tRecord.object, equals('object')); + expect(tRecord.stackTrace, equals(tStackTrace)); + }); + + testWidgets('ReportRecord copyWith.', (WidgetTester tester) async { + final tRecord = ReportRecord( + level: Level.SEVERE, + message: 'message', + error: 'error', + object: 'object', + ); + + final tRecordClone = tRecord.copyWith(); + + final tRecordCopy = tRecord.copyWith( + level: Level.INFO, + message: 'message2', + error: 'error2', + object: 'object2', + ); + + expect(tRecord, isNot(tRecordClone)); + expect(tRecord, isNot(equals(tRecordCopy))); + + expect(tRecord.level, equals(Level.SEVERE)); + expect(tRecord.message, equals('message')); + expect(tRecord.error, equals('error')); + expect(tRecord.object, equals('object')); + + expect(tRecordClone.level, equals(Level.SEVERE)); + expect(tRecordClone.message, equals('message')); + expect(tRecordClone.error, equals('error')); + expect(tRecordClone.object, equals('object')); + + expect(tRecordCopy.level, equals(Level.INFO)); + expect(tRecordCopy.message, equals('message2')); + expect(tRecordCopy.error, equals('error2')); + expect(tRecordCopy.object, equals('object2')); + }); + + testWidgets('Log Environment correctly.', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + printLog: true, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tApp.log.level, equals(Level.SEVERE)); + expect(tApp.log.logPrinting, isTrue); + }); + + tApp.dispose(); + }); + + testWidgets('level and logPrinting setter', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + tApp.log.level = Level.SEVERE; + tApp.log.logPrinting = true; + expect(tApp.log.level, equals(Level.SEVERE)); + expect(tApp.log.logPrinting, isTrue); + + tApp.log.level = Level.INFO; + tApp.log.logPrinting = false; + expect(tApp.log.level, equals(Level.INFO)); + expect(tApp.log.logPrinting, isFalse); + + tApp.log.setLevelByValue(111); + expect(tApp.log.level.value, equals(111)); + }); + + tApp.dispose(); + }); + + testWidgets('report test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tReportedRecord = + ReportRecord(level: Level.SEVERE, message: 'test'); + final tNotReportedRecord = + ReportRecord(level: Level.INFO, message: 'test'); + expectLater( + tApp.log.reports, + emits(tReportedRecord), + ); + expectLater( + tApp.log.reports, + neverEmits(tNotReportedRecord), + ); + + tApp.log.report(tReportedRecord); + tApp.log.report(tNotReportedRecord); + }); + + tApp.dispose(); + }); + + testWidgets('Logger test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tStream = tApp.log.reports.asyncMap((event) => event.message); + + expectLater( + tStream, + emits(equals('severe')), + ); + expectLater( + tStream, + neverEmits(equals('info')), + ); + + _logger.severe('severe'); + _logger.info('info'); + + _logger.severe(ReportRecord(level: Level.SEVERE, message: 'test')); + }); + + tApp.dispose(); + }); + + testWidgets('Logger object test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tObject = Object(); + final tStream = tApp.log.reports.asyncMap((event) => event.object); + + expectLater( + tStream, + emits(equals(tObject)), + ); + + _logger.severe( + ReportRecord(level: Level.SEVERE, message: 'test', object: tObject)); + }); + + tApp.dispose(); + }); + + testWidgets('logPrinting from Logger', (WidgetTester tester) async { + final App tApp = createApp(); + + final tOriginalDebugPrint = debugPrint; + bool tDebugPrintCalled = false; + debugPrint = (String? message, {int? wrapWidth}) { + tDebugPrintCalled = true; + }; + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + final tStream = tApp.log.reports.asyncMap((event) => event.message); + expectLater( + tStream, + emits(equals('test')), + ); + + tApp.log.logPrinting = true; + _logger.severe('test'); + expect(tDebugPrintCalled, isTrue); + + tDebugPrintCalled = false; + tApp.log.logPrinting = false; + _logger.severe('test'); + expect(tDebugPrintCalled, isFalse); + + tApp.log.logPrinting = true; + _logger.severe('test'); + expect(tDebugPrintCalled, isTrue); + }); + + tApp.dispose(); + + debugPrint = tOriginalDebugPrint; + }); + + testWidgets('duplicate error test', (WidgetTester tester) async { + final App tApp = createApp(); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tExceptionA = Exception('duplicateObject'); + final tExceptionB = Exception('duplicateError'); + + final tStream = tApp.log.reports.asyncMap((event) => event.message); + expectLater( + tStream, + emitsInOrder([ + 'duplicateObject', + tExceptionB.toString(), + emitsDone, + ]), + ); + + try { + try { + throw tExceptionA; + } catch (e, stackTrace) { + _logger.severe('duplicateObject', e, stackTrace); + rethrow; + } + } catch (e, stackTrace) { + _logger.severe('duplicateObject', e, stackTrace); + } + + try { + try { + throw tExceptionB; + } catch (e) { + _logger.severe(e); + rethrow; + } + } catch (e) { + _logger.severe(e); + } + }); + + tApp.dispose(); + }); + + testWidgets('filter test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + printLog: false, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tStream = tApp.log.reports.asyncMap((event) => event.message); + expectLater( + tStream, + emitsInOrder([ + 'severe', + 'removeIgnore', + ]), + ); + expectLater( + tStream, + neverEmits(equals('ignore')), + ); + + fFilter(ReportRecord record) { + if (record.message == 'ignore' || record.message == 'removeIgnore') { + return null; + } + return record; + } + + tApp.log.addFilter(fFilter); + + final tRecord = ReportRecord(level: Level.SEVERE, message: 'severe'); + final tRecordIgnore = + ReportRecord(level: Level.SEVERE, message: 'ignore'); + expect(tApp.log.filter(tRecord), equals(tRecord)); + expect(tApp.log.filter(tRecordIgnore), isNull); + + _logger.severe('severe'); + _logger.severe('ignore'); + + tApp.log.removeFilter(fFilter); + _logger.severe('removeIgnore'); + expect(tApp.log.filter(tRecord), equals(tRecord)); + expect(tApp.log.filter(tRecordIgnore), equals(tRecordIgnore)); + }); + + tApp.dispose(); + }); + + testWidgets('ignoreType test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + printLog: false, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tStream = tApp.log.reports.asyncMap((event) => event.message); + expectLater( + tStream, + emitsInOrder([ + 'severe', + 'removeIgnore', + ]), + ); + expectLater( + tStream, + neverEmits(equals('ignore')), + ); + + tApp.log.ignoreType(int); + + final tRecord = + ReportRecord(level: Level.SEVERE, message: 'severe', error: '1'); + final tRecordIgnore = + ReportRecord(level: Level.SEVERE, message: 'ignore', error: 1); + expect(tApp.log.filter(tRecord), equals(tRecord)); + expect(tApp.log.filter(tRecordIgnore), isNull); + + _logger.severe('severe', '1'); + _logger.severe('ignore', 1); + + tApp.log.unignoreType(int); + _logger.severe('removeIgnore', 1); + expect(tApp.log.filter(tRecord), equals(tRecord)); + expect(tApp.log.filter(tRecordIgnore), equals(tRecordIgnore)); + }); + + tApp.dispose(); + }); + + testWidgets('Report PatapataException test', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + printLog: false, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tStream = tApp.log.reports.asyncMap((event) => event.message); + expectLater( + tStream, + emits(equals('patapataException')), + ); + + bool tOnReportedCalled = false; + + try { + throw TestPatapataException( + onReported: (record) { + tOnReportedCalled = true; + throw 'This exception must not propagate.'; + }, + ); + } catch (e, stackTrace) { + expect(e, isA()); + _logger.severe('patapataException', e, stackTrace); + } + + await tester.pumpAndSettle(); + + expect(tOnReportedCalled, isTrue); + }); + + tApp.dispose(); + }); + + testWidgets('Log FlutterError', (WidgetTester tester) async { + final tOriginalOnError = FlutterError.onError; + bool tOnErrorCalled = false; + FlutterError.onError = (details) { + tOnErrorCalled = true; + }; + + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + printLog: false, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tStream = tApp.log.reports.asyncMap((event) => event.object); + expectLater( + tStream, + emits(isA()), + ); + + // throw FlutterError + await tester.pumpWidget( + MaterialApp( + home: Column( + children: [ + ListView( + children: const [ + Text('Exception!'), + ], + ), + ], + ), + ), + ); + await tester.takeException(); + + expect(tOnErrorCalled, isTrue); + + FlutterError.onError = tOriginalOnError; + }); + + tApp.dispose(); + }); + + testWidgets('RemoteConfig LogLevel test.', (WidgetTester tester) async { + final Map tStore = {}; + final tMockRemoteConfig = MockRemoteConfig(tStore); + + final App tApp = createApp(plugins: [ + Plugin.inline( + createRemoteConfig: () => tMockRemoteConfig, + ), + ]); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tMockRemoteConfig.setInt('patapata_log_level', 111); + await tMockRemoteConfig.fetch(force: true); + + expect(tApp.log.level.value, equals(111)); + }); + + tApp.dispose(); + }); + + testWidgets('RemoteConfig levelFilter test.', (WidgetTester tester) async { + final Map tStore = {}; + final tMockRemoteConfig = MockRemoteConfig(tStore); + + final App tApp = createApp(plugins: [ + Plugin.inline( + createRemoteConfig: () => tMockRemoteConfig, + ), + ]); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tMockRemoteConfig.setString(Log.kRemoteConfigLevelFilters, + '{"info":888, "severe":1111, "fine":500}'); + await tMockRemoteConfig.fetch(force: true); + + final tReportInfo = ReportRecord(level: Level.INFO, message: 'info'); + final tReportSever = ReportRecord(level: Level.INFO, message: 'severe'); + final tReportInfoToFine = + ReportRecord(level: Level.INFO, message: 'fine'); + + final tInfo = tApp.log.filter(tReportInfo); + final tSever = tApp.log.filter(tReportSever); + final tInfoToFine = tApp.log.filter(tReportInfoToFine); + expect(tInfo?.level.value, equals(888)); + expect(tSever?.level.value, equals(1111)); + expect(tInfoToFine?.level, equals(Level.FINE)); + + final tReportObjectInfo = + ReportRecord(level: Level.INFO, message: 'test', error: 'info'); + final tReportErrorInfo = + ReportRecord(level: Level.INFO, message: 'test', object: 'info'); + + final tObjectInfo = tApp.log.filter(tReportObjectInfo); + final tErrorInfo = tApp.log.filter(tReportErrorInfo); + expect(tObjectInfo?.level.value, equals(888)); + expect(tErrorInfo?.level.value, equals(888)); + }); + + tApp.dispose(); + }); + + testWidgets('RemoteConfig levelFilter parsing failed.', + (WidgetTester tester) async { + final tOriginalDebugPrint = debugPrint; + + bool tPrintParsingError = false; + debugPrint = (String? message, {int? wrapWidth}) { + if (message?.contains('RemoteConfig ${Log.kRemoteConfigLevelFilters}') == + true) { + tPrintParsingError = true; + } + }; + + final Map tStore = {}; + final tMockRemoteConfig = MockRemoteConfig(tStore); + + final App tApp = createApp(plugins: [ + Plugin.inline( + createRemoteConfig: () => tMockRemoteConfig, + ), + ]); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + tApp.log.logPrinting = true; + + await tMockRemoteConfig.setString( + Log.kRemoteConfigLevelFilters, '{"info":888,'); + await tMockRemoteConfig.fetch(force: true); + }); + + expect(tPrintParsingError, isTrue); + + tApp.dispose(); + + debugPrint = tOriginalDebugPrint; + }); + + testWidgets('Logger large message print', (WidgetTester tester) async { + // '[SEVERE] test.log: ' + 1007bytes = 1026bytes + const tLargeMessageA = + 'testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttestEND'; + // '[SEVERE] test.log: ' + 1006bytes = 1025bytes + const tLargeMessageB = + 'testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesあいう'; + + final tOriginalDebugPrint = debugPrint; + final List tPrintMessage = []; + debugPrint = (String? message, {int? wrapWidth}) { + tPrintMessage.add(message!); + }; + + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.SEVERE.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + _logger.severe(tLargeMessageA); + + expect(tPrintMessage.length, equals(2)); + expect(tPrintMessage[0].length, equals(1023)); + expect(tPrintMessage[1], equals('END')); + + tPrintMessage.clear(); + + _logger.severe(tLargeMessageB); + expect(tPrintMessage.length, equals(2)); + expect(tPrintMessage[0].length, equals(1022)); + expect(tPrintMessage[1], equals('あいう')); + }); + + tApp.dispose(); + + debugPrint = tOriginalDebugPrint; + }); + + test('NativeThrowble for Android.', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + final tThrowableMap = { + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + 'java.lang.Integer.parseInt(Integer.java:797)', + 'java.lang.Integer.parseInt(Integer.java:915)', + 'dev.patapata.patapata_core_example.MainActivity.configureFlutterEngine\$lambda-1\$lambda-0(MainActivity.kt:27)', + 'dev.patapata.patapata_core_example.MainActivity.\$r8\$lambda\$mgziiATvBKRngKgviCJADp8PLSA(Unknown Source:0)', + 'dev.patapata.patapata_core_example.MainActivity\$\$ExternalSyntheticLambda0.onMethodCall(Unknown Source:2)', + 'io.flutter.plugin.common.MethodChannel\$IncomingMethodCallHandler.onMessage(MethodChannel.java:258)', + 'io.flutter.embedding.engine.dart.DartMessenger.invokeHandler(DartMessenger.java:295)', + 'io.flutter.embedding.engine.dart.DartMessenger.lambda\$dispatchMessageToQueue\$0\$io-flutter-embedding-engine-dart-DartMessenger(DartMessenger.java:322)', + 'io.flutter.embedding.engine.dart.DartMessenger\$\$ExternalSyntheticLambda0.run(Unknown Source:12)', + 'android.os.Handler.handleCallback(Handler.java:942)', + 'android.os.Handler.dispatchMessage(Handler.java:99)', + 'android.os.Looper.loopOnce(Looper.java:346)', + 'android.os.Looper.loop(Looper.java:475)', + 'android.app.ActivityThread.main(ActivityThread.java:7950)', + 'java.lang.reflect.Method.invoke(Native Method)', + 'com.android.internal.os.RuntimeInit\$MethodAndArgsCaller.run(RuntimeInit.java:548)', + 'com.android.internal.os.ZygoteInit.main(ZygoteInit.java:942)', + ], + 'cause': { + 'type': 'java.lang.BBB', + 'message': 'throwbleB', + 'stackTrace': [ + 'java.lang.Integer.parseInt(Integer.java:4)', + 'java.lang.Integer.parseInt(Integer.java:5)', + 'dev.patapata.patapata_core_example.MainActivity.test(MainActivity.kt:6)', + ], + 'cause': null, + }, + }; + final tExpectTraces = [ + Trace( + [ + Frame( + Uri.file('java.lang/Integer.java'), + 797, + null, + 'Integer.parseInt', + ), + Frame( + Uri.file('java.lang/Integer.java'), + 915, + null, + 'Integer.parseInt', + ), + Frame( + Uri.file('dev.patapata.patapata_core_example/MainActivity.kt'), + 27, + null, + 'MainActivity.configureFlutterEngine\$lambda-1\$lambda-0', + ), + Frame( + Uri.file('dev.patapata.patapata_core_example/UnknownSource'), + 0, + null, + 'MainActivity.\$r8\$lambda\$mgziiATvBKRngKgviCJADp8PLSA', + ), + Frame( + Uri.file('dev.patapata.patapata_core_example/UnknownSource'), + 2, + null, + 'MainActivity\$\$ExternalSyntheticLambda0.onMethodCall', + ), + Frame( + Uri.file('io.flutter.plugin.common/MethodChannel.java'), + 258, + null, + 'MethodChannel\$IncomingMethodCallHandler.onMessage', + ), + Frame( + Uri.file('io.flutter.embedding.engine.dart/DartMessenger.java'), + 295, + null, + 'DartMessenger.invokeHandler', + ), + Frame( + Uri.file('io.flutter.embedding.engine.dart/DartMessenger.java'), + 322, + null, + 'DartMessenger.lambda\$dispatchMessageToQueue\$0\$io-flutter-embedding-engine-dart-DartMessenger', + ), + Frame( + Uri.file('io.flutter.embedding.engine.dart/UnknownSource'), + 12, + null, + 'DartMessenger\$\$ExternalSyntheticLambda0.run', + ), + Frame( + Uri.file('android.os/Handler.java'), + 942, + null, + 'Handler.handleCallback', + ), + Frame( + Uri.file('android.os/Handler.java'), + 99, + null, + 'Handler.dispatchMessage', + ), + Frame( + Uri.file('android.os/Looper.java'), + 346, + null, + 'Looper.loopOnce', + ), + Frame( + Uri.file('android.os/Looper.java'), + 475, + null, + 'Looper.loop', + ), + Frame( + Uri.file('android.app/ActivityThread.java'), + 7950, + null, + 'ActivityThread.main', + ), + Frame( + Uri.file('java.lang.reflect/NativeMethod'), + null, + null, + 'Method.invoke', + ), + Frame( + Uri.file('com.android.internal.os/RuntimeInit.java'), + 548, + null, + 'RuntimeInit\$MethodAndArgsCaller.run', + ), + Frame( + Uri.file('com.android.internal.os/ZygoteInit.java'), + 942, + null, + 'ZygoteInit.main', + ), + ], + ), + Trace( + [ + Frame( + Uri.file('java.lang/Integer.java'), + 4, + null, + 'Integer.parseInt', + ), + Frame( + Uri.file('java.lang/Integer.java'), + 5, + null, + 'Integer.parseInt', + ), + Frame( + Uri.file('dev.patapata.patapata_core_example/MainActivity.kt'), + 6, + null, + 'MainActivity.test', + ), + ], + ), + ]; + final tTestNativeThrowable = NativeThrowable.fromMap(tThrowableMap); + final tTestCause = tTestNativeThrowable.cause!; + expect(tTestNativeThrowable.type, equals('java.lang.AAA')); + expect(tTestNativeThrowable.message, equals('throwbleA')); + expect(tTestCause.type, equals('java.lang.BBB')); + expect(tTestCause.message, equals('throwbleB')); + expect(tTestCause.cause, isNull); + + expect(tTestNativeThrowable.chain!.traces.length, equals(2)); + int tTraceIndex = 0; + for (var traces in tTestNativeThrowable.chain!.traces) { + int tFrameIndex = 0; + for (var frame in traces.frames) { + final tExpectFrame = tExpectTraces[tTraceIndex].frames[tFrameIndex]; + expect(frame.uri, equals(tExpectFrame.uri)); + expect(frame.line, equals(tExpectFrame.line)); + expect(frame.column, equals(tExpectFrame.column)); + expect(frame.member, equals(tExpectFrame.member)); + tFrameIndex++; + } + tTraceIndex++; + } + + expect(tTestCause.chain!.traces.length, equals(1)); + int tFrameIndex = 0; + for (var frame in tTestCause.chain!.traces.first.frames) { + final tExpectFrame = tExpectTraces[1].frames[tFrameIndex]; + expect(frame.uri, equals(tExpectFrame.uri)); + expect(frame.line, equals(tExpectFrame.line)); + expect(frame.column, equals(tExpectFrame.column)); + expect(frame.member, equals(tExpectFrame.member)); + tFrameIndex++; + } + tTraceIndex++; + + expect(tTestNativeThrowable.toMap(), equals(tThrowableMap)); + + debugDefaultTargetPlatformOverride = null; + }); + + testWidgets('Native logging level map.', (WidgetTester tester) async { + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.ALL.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // Mock Native logging. + const tChannelName = 'patapata/test/log'; + const tChannel = MethodChannel(tChannelName); + Future fNativeLogging(Map arguments) async { + await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .handlePlatformMessage( + tChannelName, + tChannel.codec.encodeMethodCall( + MethodCall( + 'logging', + arguments, + ), + ), + (data) {}, + ); + } + + NativeThrowable.registerNativeThrowableMethodChannel(tChannelName); + + final tNativeLoggerLevelMap = { + 0: Level('EMERGENCY', Level.SHOUT.value), + 1: Level('ALERT', Level.SHOUT.value - 10), + 2: Level('CRITICAL', Level.SHOUT.value - 20), + 3: Level('ERROR', Level.SEVERE.value), + 4: Level.WARNING, + 5: Level('NOTICE', Level.INFO.value + 10), + 6: Level.INFO, + 7: Level('DEBUG', Level.FINE.value), + }; + + final tStream = tApp.log.reports.asyncMap((event) => event.level.value); + expectLater( + tStream, + emitsInOrder([ + Level.INFO.value, + tNativeLoggerLevelMap[0]!.value, + tNativeLoggerLevelMap[1]!.value, + tNativeLoggerLevelMap[2]!.value, + tNativeLoggerLevelMap[3]!.value, + tNativeLoggerLevelMap[4]!.value, + tNativeLoggerLevelMap[5]!.value, + tNativeLoggerLevelMap[6]!.value, + tNativeLoggerLevelMap[7]!.value, + ]), + ); + + // default level + await fNativeLogging({ + 'message': 'LogMessage', + }); + + // level map + for (var entry in tNativeLoggerLevelMap.entries) { + await fNativeLogging({ + 'level': entry.key, + 'message': 'LogMessage', + }); + } + + NativeThrowable.unregisterNativeThrowableMethodChannel(tChannelName); + }); + + tApp.dispose(); + }); + + testWidgets('Native logging for Android.', (WidgetTester tester) async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.ALL.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // Mock Native logging. + const tChannelName = 'patapata/test/log'; + const tChannel = MethodChannel(tChannelName); + Future fNativeLogging(Map arguments) async { + await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .handlePlatformMessage( + tChannelName, + tChannel.codec.encodeMethodCall( + MethodCall( + 'logging', + arguments, + ), + ), + (data) {}, + ); + } + + NativeThrowable.registerNativeThrowableMethodChannel(tChannelName); + + final tThrowableMap = { + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + 'java.lang.Integer.parseInt(Integer.java:797)', + 'java.lang.Integer.parseInt(Integer.java:915)', + 'dev.patapata.patapata_core_example.MainActivity.configureFlutterEngine\$lambda-1\$lambda-0(MainActivity.kt:27)', + 'dev.patapata.patapata_core_example.MainActivity.\$r8\$lambda\$mgziiATvBKRngKgviCJADp8PLSA(Unknown Source:0)', + 'dev.patapata.patapata_core_example.MainActivity\$\$ExternalSyntheticLambda0.onMethodCall(Unknown Source:2)', + 'io.flutter.plugin.common.MethodChannel\$IncomingMethodCallHandler.onMessage(MethodChannel.java:258)', + 'io.flutter.embedding.engine.dart.DartMessenger.invokeHandler(DartMessenger.java:295)', + 'io.flutter.embedding.engine.dart.DartMessenger.lambda\$dispatchMessageToQueue\$0\$io-flutter-embedding-engine-dart-DartMessenger(DartMessenger.java:322)', + 'io.flutter.embedding.engine.dart.DartMessenger\$\$ExternalSyntheticLambda0.run(Unknown Source:12)', + 'android.os.Handler.handleCallback(Handler.java:942)', + 'android.os.Handler.dispatchMessage(Handler.java:99)', + 'android.os.Looper.loopOnce(Looper.java:346)', + 'android.os.Looper.loop(Looper.java:475)', + 'android.app.ActivityThread.main(ActivityThread.java:7950)', + 'java.lang.reflect.Method.invoke(Native Method)', + 'com.android.internal.os.RuntimeInit\$MethodAndArgsCaller.run(RuntimeInit.java:548)', + 'com.android.internal.os.ZygoteInit.main(ZygoteInit.java:942)', + ], + 'cause': { + 'type': 'java.lang.BBB', + 'message': 'throwbleB', + 'stackTrace': [ + 'java.lang.Integer.parseInt(Integer.java:4)', + 'java.lang.Integer.parseInt(Integer.java:5)', + 'dev.patapata.patapata_core_example.MainActivity.test(MainActivity.kt:6)', + ], + 'cause': null, + }, + }; + + var tStream = tApp.log.reports.first; + + await fNativeLogging({ + 'level': 6, + 'message': 'LogMessage', + 'metadata': '{"foo": "bar"}', + 'timestamp': 1701930530000, + 'throwable': tThrowableMap, + }); + + var tReport = await tStream; + + expect(tReport.level, equals(Level.INFO)); + expect(tReport.message, equals('LogMessage')); + expect(tReport.extra, equals({'foo': 'bar'})); + expect(tReport.time.millisecondsSinceEpoch, equals(1701930530000)); + expect(tReport.object, isNull); + expect(tReport.error, isA()); + expect((tReport.error as NativeThrowable).toMap(), equals(tThrowableMap)); + expect( + tReport.stackTrace, equals((tReport.error as NativeThrowable).chain)); + + NativeThrowable.unregisterNativeThrowableMethodChannel(tChannelName); + }); + + tApp.dispose(); + + debugDefaultTargetPlatformOverride = null; + }); + + test('NativeThrowble for iOS.', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.iOS; + + final tThrowableMap = { + 'type': 'ErrorType', + 'message': 'throwbleA', + 'stackTrace': [ + '1 Runner 0x0000000000000000 \$s6Runner12NativeLoggerC14viewControllerACSo011FlutterViewE0C_tcfcySo0F10MethodCallC_yypSgctcACcfu_yAH_yAIctcfu0_ + 72', + '2 Runner 0x0000000000000000 \$sSo17FlutterMethodCallCypSgIegn_Ieggg_AByXlSgIeyBy_IeyByy_TR + 136', + '3 Flutter 0x0000000000000000 __45-[FlutterMethodChannel setMethodCallHandler:]_block_invoke + 172', + '4 Flutter 0x0000000000000000 ___ZN7flutter25PlatformMessageHandlerIos21HandlePlatformMessageENSt21_LIBCPP_ABI_NAMESPACE10unique_ptrINS_15PlatformMessageENS1_14default_deleteIS3_EEEE_block_invoke + 116', + '5 libdispatch.dylib 0x0000000000000000 959CD6E4-0CE7-3022-B73C-8B36F79F4745 + 7172', + '6 libdispatch.dylib 0x0000000000000000 959CD6E4-0CE7-3022-B73C-8B36F79F4745 + 14672', + '7 libdispatch.dylib 0x0000000000000000 _dispatch_main_queue_callback_4CF + 940', + '8 CoreFoundation 0x0000000000000000 6174789A-E88C-3F5C-BA39-DE2E9EDC0750 + 335076', + '9 CoreFoundation 0x0000000000000000 6174789A-E88C-3F5C-BA39-DE2E9EDC0750 + 48828', + '10 CoreFoundation 0x0000000000000000 CFRunLoopRunSpecific + 600', + '11 GraphicsServices 0x0000000000000000 GSEventRunModal + 164', + '12 UIKitCore 0x0000000000000000 0E2D8679-D5F1-3C03-9010-7F6CE3662789 + 5353660', + '13 UIKitCore 0x0000000000000000 UIApplicationMain + 2124', + '14 Runner 0x0000000000000000 main + 64', + '15 dyld 0x0000000000000000 start + 520', + ], + 'cause': null, + }; + final tExpectTrace = Trace( + [ + Frame( + Uri.file('Runner/'), + 72, + null, + '\$s6Runner12NativeLoggerC14viewControllerACSo011FlutterViewE0C_tcfcySo0F10MethodCallC_yypSgctcACcfu_yAH_yAIctcfu0_', + ), + Frame( + Uri.file('Runner/'), + 136, + null, + '\$sSo17FlutterMethodCallCypSgIegn_Ieggg_AByXlSgIeyBy_IeyByy_TR', + ), + Frame( + Uri.file('Flutter/'), + 172, + null, + '__45-[FlutterMethodChannel setMethodCallHandler:]_block_invoke', + ), + Frame( + Uri.file('Flutter/'), + 116, + null, + '___ZN7flutter25PlatformMessageHandlerIos21HandlePlatformMessageENSt21_LIBCPP_ABI_NAMESPACE10unique_ptrINS_15PlatformMessageENS1_14default_deleteIS3_EEEE_block_invoke', + ), + Frame( + Uri.file('libdispatch.dylib/'), + 7172, + null, + '959CD6E4-0CE7-3022-B73C-8B36F79F4745', + ), + Frame( + Uri.file('libdispatch.dylib/'), + 14672, + null, + '959CD6E4-0CE7-3022-B73C-8B36F79F4745', + ), + Frame( + Uri.file('libdispatch.dylib/'), + 940, + null, + '_dispatch_main_queue_callback_4CF', + ), + Frame( + Uri.file('CoreFoundation/'), + 335076, + null, + '6174789A-E88C-3F5C-BA39-DE2E9EDC0750', + ), + Frame( + Uri.file('CoreFoundation/'), + 48828, + null, + '6174789A-E88C-3F5C-BA39-DE2E9EDC0750', + ), + Frame( + Uri.file('CoreFoundation/'), + 600, + null, + 'CFRunLoopRunSpecific', + ), + Frame( + Uri.file('GraphicsServices/'), + 164, + null, + 'GSEventRunModal', + ), + Frame( + Uri.file('UIKitCore/'), + 5353660, + null, + '0E2D8679-D5F1-3C03-9010-7F6CE3662789', + ), + Frame( + Uri.file('UIKitCore/'), + 2124, + null, + 'UIApplicationMain', + ), + Frame( + Uri.file('Runner/'), + 64, + null, + 'main', + ), + Frame( + Uri.file('dyld/'), + 520, + null, + 'start', + ), + ], + ); + final tTestNativeThrowable = NativeThrowable.fromMap(tThrowableMap); + expect(tTestNativeThrowable.type, equals('ErrorType')); + expect(tTestNativeThrowable.message, equals('throwbleA')); + expect(tTestNativeThrowable.cause, isNull); + + expect(tTestNativeThrowable.chain!.traces.length, equals(1)); + int tFrameIndex = 0; + for (var frame in tTestNativeThrowable.chain!.traces.first.frames) { + final tExpectFrame = tExpectTrace.frames[tFrameIndex]; + expect(frame.uri, equals(tExpectFrame.uri)); + expect(frame.line, equals(tExpectFrame.line)); + expect(frame.column, equals(tExpectFrame.column)); + expect(frame.member, equals(tExpectFrame.member)); + tFrameIndex++; + } + + expect(tTestNativeThrowable.toMap(), equals(tThrowableMap)); + + debugDefaultTargetPlatformOverride = null; + }); + + testWidgets('Native logging for iOS.', (WidgetTester tester) async { + debugDefaultTargetPlatformOverride = TargetPlatform.iOS; + + final App tApp = createApp( + environment: TestLogEnvironment( + logLevel: Level.ALL.value, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // Mock Native logging. + const tChannelName = 'patapata/test/log'; + const tChannel = MethodChannel(tChannelName); + late DateTime tTimestamp; + Future fNativeLogging(Map arguments) async { + await TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .handlePlatformMessage( + tChannelName, + tChannel.codec.encodeMethodCall( + MethodCall( + 'logging', + arguments, + ), + ), + (data) { + tTimestamp = DateTime.now(); + }, + ); + } + + NativeThrowable.registerNativeThrowableMethodChannel(tChannelName); + + final tThrowableMap = { + 'type': 'ErrorType', + 'message': 'throwbleA', + 'stackTrace': [ + '1 Runner 0x0000000000000000 \$s6Runner12NativeLoggerC14viewControllerACSo011FlutterViewE0C_tcfcySo0F10MethodCallC_yypSgctcACcfu_yAH_yAIctcfu0_ + 72', + '2 Runner 0x0000000000000000 \$sSo17FlutterMethodCallCypSgIegn_Ieggg_AByXlSgIeyBy_IeyByy_TR + 136', + '3 Flutter 0x0000000000000000 __45-[FlutterMethodChannel setMethodCallHandler:]_block_invoke + 172', + '4 Flutter 0x0000000000000000 ___ZN7flutter25PlatformMessageHandlerIos21HandlePlatformMessageENSt21_LIBCPP_ABI_NAMESPACE10unique_ptrINS_15PlatformMessageENS1_14default_deleteIS3_EEEE_block_invoke + 116', + '5 libdispatch.dylib 0x0000000000000000 959CD6E4-0CE7-3022-B73C-8B36F79F4745 + 7172', + '6 libdispatch.dylib 0x0000000000000000 959CD6E4-0CE7-3022-B73C-8B36F79F4745 + 14672', + '7 libdispatch.dylib 0x0000000000000000 _dispatch_main_queue_callback_4CF + 940', + '8 CoreFoundation 0x0000000000000000 6174789A-E88C-3F5C-BA39-DE2E9EDC0750 + 335076', + '9 CoreFoundation 0x0000000000000000 6174789A-E88C-3F5C-BA39-DE2E9EDC0750 + 48828', + '10 CoreFoundation 0x0000000000000000 CFRunLoopRunSpecific + 600', + '11 GraphicsServices 0x0000000000000000 GSEventRunModal + 164', + '12 UIKitCore 0x0000000000000000 0E2D8679-D5F1-3C03-9010-7F6CE3662789 + 5353660', + '13 UIKitCore 0x0000000000000000 UIApplicationMain + 2124', + '14 Runner 0x0000000000000000 main + 64', + '15 dyld 0x0000000000000000 start + 520', + ], + 'cause': null, + }; + + var tStream = tApp.log.reports.first; + + await fNativeLogging({ + 'level': 6, + 'message': 'LogMessage', + 'metadata': '{"foo": "bar"}', + 'throwable': tThrowableMap, + }); + + var tReport = await tStream; + + expect(tReport.level, equals(Level.INFO)); + expect(tReport.message, equals('LogMessage')); + expect(tReport.extra, equals({'foo': 'bar'})); + expect(DateFormat('yyyyMMdd').format(tReport.time), + equals(DateFormat('yyyyMMdd').format(tTimestamp))); + expect(tReport.object, isNull); + expect(tReport.error, isA()); + expect((tReport.error as NativeThrowable).toMap(), equals(tThrowableMap)); + expect( + tReport.stackTrace, equals((tReport.error as NativeThrowable).chain)); + + NativeThrowable.unregisterNativeThrowableMethodChannel(tChannelName); + }); + + tApp.dispose(); + + debugDefaultTargetPlatformOverride = null; + }); + + test('NativeThrowble unsupported platform.', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.linux; + + final tThrowableMap = { + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + 'java.lang.Integer.parseInt(Integer.java:4)', + ], + 'cause': null, + }; + final tExpectFrame = + Frame.parseFriendly('java.lang.Integer.parseInt(Integer.java:4)'); + + final tTestNativeThrowable = NativeThrowable.fromMap(tThrowableMap); + + expect(tTestNativeThrowable.type, equals('java.lang.AAA')); + expect(tTestNativeThrowable.message, equals('throwbleA')); + expect(tTestNativeThrowable.cause, isNull); + expect(tTestNativeThrowable.chain!.traces.length, equals(1)); + expect(tTestNativeThrowable.chain!.traces.first.frames.first.toString(), + equals(tExpectFrame.toString())); + expect( + tTestNativeThrowable.toMap(), + equals({ + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + tExpectFrame.toString(), + ], + 'cause': null, + }), + ); + + debugDefaultTargetPlatformOverride = null; + }); + + test('NativeThrowble stackTrace parse error.', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + final tThrowableMap = { + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + 'aaa', + ], + 'cause': null, + }; + final tExpectFrame = Frame.parseFriendly('aaa'); + + final tTestNativeThrowable = NativeThrowable.fromMap(tThrowableMap); + + expect(tTestNativeThrowable.type, equals('java.lang.AAA')); + expect(tTestNativeThrowable.message, equals('throwbleA')); + expect(tTestNativeThrowable.cause, isNull); + expect(tTestNativeThrowable.chain!.traces.length, equals(1)); + expect(tTestNativeThrowable.chain!.traces.first.frames.first.toString(), + equals(tExpectFrame.toString())); + expect( + tTestNativeThrowable.toMap(), + equals({ + 'type': 'java.lang.AAA', + 'message': 'throwbleA', + 'stackTrace': [ + tExpectFrame.toString(), + ], + 'cause': null, + }), + ); + + debugDefaultTargetPlatformOverride = null; + }); +} diff --git a/packages/patapata_core/test/logic_state_test.dart b/packages/patapata_core/test/logic_state_test.dart new file mode 100644 index 0000000..c15db3d --- /dev/null +++ b/packages/patapata_core/test/logic_state_test.dart @@ -0,0 +1,525 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/src/exception.dart'; + +void main() { + test('A new machine should be in the first state after instantiation.', () { + expect( + LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]).current, + isInstanceOf(), + ); + }); + + test('LogicStateMachine.toString', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + tMachine.current.onComplete.ignore(); + + expect(tMachine.toString(), + 'LogicStateMachine: complete=false, error=null, current=${tMachine.current.runtimeType}: initialized=true, active=true'); + + tMachine.current.complete(); + + expect(tMachine.toString(), + 'LogicStateMachine: complete=true, error=null, current=${tMachine.current.runtimeType}: initialized=true, active=false'); + }); + + test('A state can transition to another instance of itself', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + ]); + + final tFirstInstance = tMachine.current; + tMachine.current.complete(); + + expect( + tMachine.current, + isInstanceOf(), + ); + + expect(tMachine.current, isNot(equals(tFirstInstance))); + }); + + test('A machine should be complete when the last state completes', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + + tMachine.current.complete(); + + expect( + tMachine.current, + isInstanceOf(), + ); + + expect(tMachine.complete, isTrue); + }); + + test( + 'A LogicStateTransitionNotFound should be thrown when a state class in a transition is attempted to transition to, where that state does not exist in the machine', + () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + ]); + + expect( + () => tMachine.current.complete(), + throwsA(isA()), + ); + }); + + test('A state can transition to another state', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + ]); + + tMachine.current.complete(); + + expect( + tMachine.current, + isInstanceOf(), + ); + }); + + test('A state can transition to another state, and then another', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateC(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), [ + LogicStateTransition(), + ]), + ]); + + tMachine.current.complete(); + tMachine.current.complete(); + + expect( + tMachine.current, + isInstanceOf(), + ); + }); + + test('A state can fail to transition via delegate failure', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition( + ((LogicState current, LogicState next) => false)), + ]), + LogicStateFactory(() => StateB(), []), + ]); + + expect( + () => tMachine.current.complete(), + throwsA(isA()), + ); + }); + + test('LogicStateAllTransitionsNotAllowed.toString', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition( + ((LogicState current, LogicState next) => false)), + ]), + LogicStateFactory(() => StateB(), []), + ]); + + late LogicStateAllTransitionsNotAllowed tError; + try { + tMachine.current.complete(); + } catch (e) { + tError = e as LogicStateAllTransitionsNotAllowed; + } + + expect( + tError.toString(), + equals( + 'LogicStateAllTransitionsNotAllowed: ${tError.current.toString()} is not allowed to transition to anything.'), + ); + }); + + test('A new machine must have at least one state.', () { + expect(() => LogicStateMachine([]), throwsAssertionError); + }); + + test('A state can transition itself to a specific other state', () { + expect( + LogicStateMachine([ + LogicStateFactory(() => StateXToA(), [ + LogicStateTransition(), + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + LogicStateFactory(() => StateA(), []), + ]).current, + isInstanceOf(), + ); + }); + + test('A state can not transition if it is not the current state', () { + expect( + () => LogicStateMachine([ + LogicStateFactory(() => StateXToAThenB(), [ + LogicStateTransition(), + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + LogicStateFactory(() => StateA(), []), + ]).current, + throwsA(isA()), + ); + }); + + test('LogicStateNotCurrent.toString', () { + late final LogicStateNotCurrent tError; + try { + LogicStateMachine([ + LogicStateFactory(() => StateXToAThenB(), [ + LogicStateTransition(), + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + LogicStateFactory(() => StateA(), []), + ]).current; + } catch (e) { + tError = e as LogicStateNotCurrent; + } + + expect( + tError.toString(), + equals( + 'LogicStateNotCurrent: ${tError.current.toString()} is not current.'), + ); + }); + + testWidgets( + 'A state can asynchronously transition itself to itself', + (tester) async { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateZToZAsync(), [ + LogicStateTransition(), + LogicStateTransition(), + ]), + LogicStateFactory( + () => StateInstantComplete(), []), + ], + 0, + ); + + await tester.pump(const Duration(milliseconds: 5)); + + expect( + tMachine.complete, + isTrue, + ); + }, + timeout: const Timeout(Duration(milliseconds: 10)), + ); + + test('A machine notifies on completion', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + + bool cComplete = false; + tMachine.addListener(() { + cComplete = tMachine.complete; + }); + tMachine.current.complete(); + + expect( + cComplete, + isTrue, + ); + }); + + test('complete. not current state', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + + tMachine.current.onComplete.ignore(); + final tState = tMachine.current; + tMachine.current.complete(); + + expect( + () => tState.complete(), + throwsA(isA()), + ); + }); + + test('Transitions to the state of Type.', () { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + ], + ); + + tMachine.current.toByType(StateB); + + expect( + tMachine.current, + isInstanceOf(), + ); + }); + + test('Transitions to the state of Type. not current state.', () { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + ], + ); + + final tState = tMachine.current; + tMachine.current.toByType(StateB); + + expect( + () => tState.toByType(StateA), + throwsA(isA()), + ); + }); + + test('Transitions to the state of Type. Transition not found.', () { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + ], + ); + tMachine.current.onComplete.ignore(); + tMachine.current.toByType(StateC); + + expect( + tMachine.error?.error, + isInstanceOf(), + ); + }); + + test('Transitions to the state of Type. Factory not found.', () { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), []), + ], + ); + tMachine.current.onComplete.ignore(); + tMachine.current.toByType(StateC); + + expect( + tMachine.error?.error, + isInstanceOf(), + ); + }); + + test('Transitions to the state of Type. not allowed.', () { + final tMachine = LogicStateMachine( + [ + LogicStateFactory(() => StateA(), [ + LogicStateTransition( + (LogicState current, LogicState next) => false), + ]), + LogicStateFactory(() => StateB(), []), + ], + ); + tMachine.current.onComplete.ignore(); + tMachine.current.toByType(StateB); + + expect( + tMachine.error?.error, + isInstanceOf(), + ); + + final tError = tMachine.error?.error as LogicStateTransitionNotAllowed; + expect( + tError.toString(), + equals( + 'LogicStateTransitionNotAllowed: ${tError.current.toString()} is not allowed to transition to ${tError.next.toString()}.'), + ); + }); + + test('A machine notifies on failed completion', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + + Object? cError; + tMachine.addListener(() { + cError = tMachine.error?.error; + }); + tMachine.current.onComplete.ignore(); + tMachine.current.completeError('FakeError'); + + expect( + cError, + equals('FakeError'), + ); + }); + + test('completeError. not current state', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), []), + ]); + + tMachine.current.onComplete.ignore(); + final tState = tMachine.current; + tMachine.current.completeError('FakeError'); + + expect( + () => tState.completeError('FakeError'), + throwsA(isA()), + ); + }); + + test('A state can transition to back state if allowed.', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA()..backAllowed = true, [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateBackA(), []), + ]); + tMachine.current.complete(); + tMachine.current.complete(); + + expect( + tMachine.current, + isInstanceOf(), + ); + }); + + test('A state can not transition to back state', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateBackA(), []), + ]); + tMachine.current.complete(); + tMachine.current.complete(); + + expect( + tMachine.error?.error, + isInstanceOf(), + ); + }); + + test('backByType. not current state.', () { + final tMachine = LogicStateMachine([ + LogicStateFactory(() => StateA(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateB(), [ + LogicStateTransition(), + ]), + LogicStateFactory(() => StateA(), []), + ]); + tMachine.current.complete(); + final tState = tMachine.current; + tMachine.current.complete(); + + expect( + () => tState.backByType(StateA), + throwsA(isA()), + ); + }); + + test('LogicStateTransitionNotFound test', () { + // If const is added, test coverage will not be 100%. + // ignore: prefer_const_constructors + final tError = LogicStateTransitionNotFound(); + + expect( + tError.code, + equals(PatapataCoreExceptionCode.PPE101.name), + ); + }); +} + +class StateA extends LogicState {} + +class StateB extends LogicState {} + +class StateC extends LogicState {} + +class StateXToA extends LogicState { + @override + void init(Object? data) { + super.init(data); + to(); + } +} + +class StateXToAThenB extends LogicState { + @override + void init(Object? data) { + super.init(data); + to(); + to(); + } +} + +class StateZToZAsync extends LogicState { + @override + void init(Object? data) async { + super.init(data); + final tCounter = data as int; + + if (tCounter == 3) { + complete(); + } else { + await Future.delayed(const Duration(milliseconds: 1)); + to(tCounter + 1); + } + } +} + +class StateInstantComplete extends LogicState { + @override + void init(Object? data) { + super.init(data); + complete(); + } +} + +class StateBackA extends LogicState { + @override + void init(Object? data) { + super.init(data); + onComplete.ignore(); + backByType(StateA); + } +} diff --git a/packages/patapata_core/test/native_local_config_test.dart b/packages/patapata_core/test/native_local_config_test.dart new file mode 100644 index 0000000..ca5ab50 --- /dev/null +++ b/packages/patapata_core/test/native_local_config_test.dart @@ -0,0 +1,162 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/src/native_local_config_finder.dart'; + +void main() async { + TestWidgetsFlutterBinding.ensureInitialized(); + + testSetMockMethodCallHandler = TestDefaultBinaryMessengerBinding + .instance.defaultBinaryMessenger.setMockMethodCallHandler; + + const kBoolValueKey = 'kBoolValueKey'; + const kDoubleValueKey = 'kDoubleValueKey'; + const kIntValueKey = 'kIntValueKey'; + const kStringValueKey = 'kStringValueKey'; + + test('check bool value', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + expect( + tNativeLocalConfig.getBool(kBoolValueKey), Config.defaultValueForBool); + + await tNativeLocalConfig.setDefaults({kBoolValueKey: true}); + expect(tNativeLocalConfig.getBool(kBoolValueKey), true); + + await tNativeLocalConfig.setBool(kBoolValueKey, false); + expect(tNativeLocalConfig.getBool(kBoolValueKey), false); + + await tNativeLocalConfig.reset(kBoolValueKey); + expect(tNativeLocalConfig.getBool(kBoolValueKey), true); + }); + + test('check double value', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), + Config.defaultValueForDouble); + + await tNativeLocalConfig.setDefaults({kDoubleValueKey: 1.0}); + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), 1.0); + + await tNativeLocalConfig.setDouble(kDoubleValueKey, 2.0); + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), 2.0); + + await tNativeLocalConfig.reset(kDoubleValueKey); + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), 1.0); + }); + + test('check int value', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + expect(tNativeLocalConfig.getInt(kIntValueKey), Config.defaultValueForInt); + + await tNativeLocalConfig.setDefaults({kIntValueKey: 1}); + expect(tNativeLocalConfig.getInt(kIntValueKey), 1); + + await tNativeLocalConfig.setInt(kIntValueKey, 2); + expect(tNativeLocalConfig.getInt(kIntValueKey), 2); + + await tNativeLocalConfig.reset(kIntValueKey); + expect(tNativeLocalConfig.getInt(kIntValueKey), 1); + }); + + test('check String value', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + expect(tNativeLocalConfig.getString(kStringValueKey), + Config.defaultValueForString); + + await tNativeLocalConfig.setDefaults({kStringValueKey: '1'}); + expect(tNativeLocalConfig.getString(kStringValueKey), '1'); + + await tNativeLocalConfig.setString(kStringValueKey, '2'); + expect(tNativeLocalConfig.getString(kStringValueKey), '2'); + + await tNativeLocalConfig.reset(kStringValueKey); + expect(tNativeLocalConfig.getString(kStringValueKey), '1'); + }); + + test('resetAll', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + await tNativeLocalConfig.setBool(kBoolValueKey, false); + await tNativeLocalConfig.setDouble(kDoubleValueKey, 2.0); + await tNativeLocalConfig.setInt(kIntValueKey, 2); + await tNativeLocalConfig.setString(kStringValueKey, '2'); + + expect(tNativeLocalConfig.getBool(kBoolValueKey), false); + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), 2.0); + expect(tNativeLocalConfig.getInt(kIntValueKey), 2); + expect(tNativeLocalConfig.getString(kStringValueKey), '2'); + + await tNativeLocalConfig.resetAll(); + + expect( + tNativeLocalConfig.getBool(kBoolValueKey), Config.defaultValueForBool); + expect(tNativeLocalConfig.getDouble(kDoubleValueKey), + Config.defaultValueForDouble); + expect(tNativeLocalConfig.getInt(kIntValueKey), Config.defaultValueForInt); + expect(tNativeLocalConfig.getString(kStringValueKey), + Config.defaultValueForString); + }); + + test('resetMany', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + const kIsSetKey1 = 'isSet1'; + const kIsSetKey2 = 'isSet2'; + const kIsNotSetKey1 = 'isNotSet1'; + const kIsNotSetKey2 = 'isNotSet2'; + + await tNativeLocalConfig.setDefaults({ + kIsSetKey1: 1, + kIsSetKey2: 1, + }); + + await tNativeLocalConfig.setInt(kIsSetKey1, 2); + await tNativeLocalConfig.setInt(kIsNotSetKey1, 2); + + await tNativeLocalConfig.resetMany([ + kIsSetKey1, + kIsSetKey2, + kIsNotSetKey1, + kIsNotSetKey2, + ]); + + expect(tNativeLocalConfig.getInt(kIsSetKey1), 1); + expect(tNativeLocalConfig.getInt(kIsSetKey2), 1); + expect(tNativeLocalConfig.getInt(kIsNotSetKey1), Config.defaultValueForInt); + expect(tNativeLocalConfig.getInt(kIsNotSetKey2), Config.defaultValueForInt); + }); + + test('setMany', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + final Map tObjects = { + 'name': 'GREE, Inc.', + }; + + await tNativeLocalConfig.setMany(tObjects); + + expect(tNativeLocalConfig.getString('name'), 'GREE, Inc.'); + }); + + test('sendError', () async { + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + tNativeLocalConfig.sendError(); + }); +} diff --git a/packages/patapata_core/test/network_test.dart b/packages/patapata_core/test/network_test.dart new file mode 100644 index 0000000..07b6016 --- /dev/null +++ b/packages/patapata_core/test/network_test.dart @@ -0,0 +1,227 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/widgets.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + testInitialize(); + + group('NetworkInformation', () { + test('factory unknown', () async { + final tNetworkInformation = NetworkInformation.unknown(); + + expect( + tNetworkInformation.connectivity == NetworkConnectivity.unknown, + isTrue, + ); + }); + + test('toString', () async { + final tNetworkInformation = NetworkInformation.unknown(); + + expect( + tNetworkInformation.toString().isNotEmpty, + isTrue, + ); + }); + + test('copyWith', () async { + NetworkInformation tNetworkInformation = NetworkInformation.unknown(); + tNetworkInformation = tNetworkInformation.copyWith(); + + expect( + tNetworkInformation.connectivity == NetworkConnectivity.unknown, + isTrue, + ); + }); + + test('Operator equals', () async { + NetworkInformation tNetworkInformationMobile1 = const NetworkInformation( + connectivity: NetworkConnectivity.mobile, + ); + + NetworkInformation tNetworkInformationMobile2 = const NetworkInformation( + connectivity: NetworkConnectivity.mobile, + ); + + NetworkInformation tNetworkInformationWifi = const NetworkInformation( + connectivity: NetworkConnectivity.wifi, + ); + + expect( + tNetworkInformationMobile1 == tNetworkInformationMobile2, + isTrue, + ); + + expect( + tNetworkInformationMobile1 == tNetworkInformationWifi, + isFalse, + ); + }); + + test('getter hashCode', () async { + expect( + NetworkInformation.unknown().hashCode != 0, + isTrue, + ); + }); + }); + + group('class NetworkPlugin', () { + test('getter information', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + expect( + tNetwork.information == NetworkInformation.unknown(), + isTrue, + ); + }); + + test('Function init', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + final App tApp = createApp(); + + final bool tResult = await tNetwork.init(tApp); + expect( + tResult, + isTrue, + ); + + tNetwork.dispose(); + }); + + test('getter informationStream', () async { + final App tApp = createApp(); + final tNetwork = NetworkPlugin(); + final tValues = [ + NetworkConnectivity.none, + NetworkConnectivity.other, + NetworkConnectivity.mobile, + NetworkConnectivity.wifi, + NetworkConnectivity.ethernet, + NetworkConnectivity.bluetooth, + NetworkConnectivity.vpn, + ]; + + tNetwork.init(tApp); + + final tFuture = expectLater( + tNetwork.informationStream.asyncMap((event) => event.connectivity), + emitsInOrder(tValues), + ); + + for (var i in tValues) { + await tNetwork.testChangeConnectivity(i); + } + + await tFuture; + + tNetwork.dispose(); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.none', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.none; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.none, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.other', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.other; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.other, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.mobile', + () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.mobile; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.mobile, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.wifi', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.wifi; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.wifi, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.ethernet', + () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.ethernet; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.ethernet, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.bluetooth', + () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.bluetooth; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.bluetooth, + isTrue, + ); + }); + + test('Function _onConnectivityChanged NetworkConnectivity.vpn', () async { + final NetworkPlugin tNetwork = NetworkPlugin(); + + testOnConnectivityChangedValue = NetworkConnectivity.vpn; + await tNetwork.didChangeAppLifecycleState(AppLifecycleState.resumed); + + expect( + tNetwork.information.connectivity == NetworkConnectivity.vpn, + isTrue, + ); + }); + + test('Function dispose', () async { + final App tApp = createApp(); + final NetworkPlugin tNetwork = NetworkPlugin(); + await tNetwork.init(tApp); + await tNetwork.dispose(); + + expect( + tNetwork.disposed, + isTrue, + ); + }); + }); +} diff --git a/packages/patapata_core/test/notifications_test.dart b/packages/patapata_core/test/notifications_test.dart new file mode 100644 index 0000000..27e716b --- /dev/null +++ b/packages/patapata_core/test/notifications_test.dart @@ -0,0 +1,156 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +import 'package:flutter_local_notifications/flutter_local_notifications.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/src/exception.dart'; + +import 'utils/patapata_core_test_utils.dart'; +import 'pages/notification_page.dart'; + +const NotificationResponse notificationResponse = NotificationResponse( + notificationResponseType: NotificationResponseType.selectedNotification, + payload: "notification/", +); + +class _EmptyEnvironment {} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('check init success', () async { + final NotificationsPlugin tNotificationsPlugin = NotificationsPlugin(); + + final App tApp = createApp(environment: _EmptyEnvironment()); + final bool tResult = await tNotificationsPlugin.init(tApp); + + expect( + tResult, + isTrue, + ); + }); + + test('check init success using environment', () async { + final NotificationsPlugin tNotificationsPlugin = NotificationsPlugin(); + + final App tApp = createApp(); + + final bool tResult = await tNotificationsPlugin.init(tApp); + + expect( + tResult, + isTrue, + ); + }); + + test( + 'check notifications', + () async { + final NotificationsPlugin tNotificationsPlugin = NotificationsPlugin(); + + expectLater( + tNotificationsPlugin.notifications.asyncMap((event) => event.payload), + emitsInOrder( + [ + "notification/", + ], + ), + ); + + final App tApp = createApp(); + + await tNotificationsPlugin.init(tApp); + + tNotificationsPlugin.enableStandardAppIntegration(); + + tNotificationsPlugin.mockRecieveNotificationResponse( + notificationResponse, + ); + }, + ); + + test( + 'check locationFromPayload', + () async { + final NotificationsPlugin tNotificationsPlugin = NotificationsPlugin(); + final App tApp = createApp(); + await tNotificationsPlugin.init(tApp); + + expect( + tNotificationsPlugin.uriFromPayload( + null, + ), + isNull, + ); + + expect( + tNotificationsPlugin.uriFromPayload( + "notification/", + ), + Uri.parse("notification/"), + ); + + expect( + tNotificationsPlugin.uriFromPayload( + '{"location": "notification/"}', + ), + Uri.parse("notification/"), + ); + }, + ); + + testWidgets( + 'check getInitialRouteData', + (WidgetTester tester) async { + notificationAppLaunchDetailsMap = { + "notificationLaunchedApp": true, + 'notificationResponse': { + 'notificationResponseType': 0, + 'payload': "notification/", + } + }; + + final App tApp = createApp(); + tApp.run(); + + await tApp.runProcess(() async { + final tNotificationsPlugin = tApp.getPlugin(); + + tApp.getPlugin()?.enableStandardAppIntegration(); + + await tester.pumpAndSettle(); + + final tStandardRouteData = + await tNotificationsPlugin?.getInitialRouteData(); + + expect( + tStandardRouteData?.factory?.pageType, + NotificationPage, + ); + }); + }, + ); + + test('check dispose', () async { + final NotificationsPlugin tNotificationsPlugin = NotificationsPlugin(); + + tNotificationsPlugin.dispose(); + + expect( + tNotificationsPlugin.disposed, + isTrue, + ); + }); + + test('NotificationsInitializationException test', () async { + // ignore: prefer_const_constructors + final tException = NotificationsInitializationException(); + + expect( + tException.code, + equals(PatapataCoreExceptionCode.PPE501.name), + ); + }); +} diff --git a/packages/patapata_core/test/package_info_test.dart b/packages/patapata_core/test/package_info_test.dart new file mode 100644 index 0000000..2075a29 --- /dev/null +++ b/packages/patapata_core/test/package_info_test.dart @@ -0,0 +1,39 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('PackageInfoPlugin', () async { + PackageInfoPlugin.setMockValues( + appName: 'mock_patapata_core', + packageName: 'io.flutter.plugins.mockpatapatacore', + version: '1.0', + buildNumber: '1', + buildSignature: 'patapata_core_build_signature', + installerStore: null, + ); + + final PackageInfoPlugin tPackageInfo = PackageInfoPlugin(); + + final tApp = createApp(); + final bool tResult = await tPackageInfo.init(tApp); + + expect( + tResult, + isTrue, + ); + + expect( + tPackageInfo.info.appName == 'mock_patapata_core', + isTrue, + ); + }); +} diff --git a/packages/patapata_core/test/pages/error_page.dart b/packages/patapata_core/test/pages/error_page.dart new file mode 100644 index 0000000..6bf9041 --- /dev/null +++ b/packages/patapata_core/test/pages/error_page.dart @@ -0,0 +1,23 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class ErrorPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + final tError = pageData.error as PatapataException; + return Scaffold( + appBar: AppBar( + title: Text( + tError.localizedMessage, + ), + ), + body: const SizedBox.shrink(), + ); + } +} diff --git a/packages/patapata_core/test/pages/home_page.dart b/packages/patapata_core/test/pages/home_page.dart new file mode 100644 index 0000000..92695e9 --- /dev/null +++ b/packages/patapata_core/test/pages/home_page.dart @@ -0,0 +1,22 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class HomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, "home.title"), + ), + ), + body: const SizedBox.shrink(), + ); + } +} diff --git a/packages/patapata_core/test/pages/notification_page.dart b/packages/patapata_core/test/pages/notification_page.dart new file mode 100644 index 0000000..899b356 --- /dev/null +++ b/packages/patapata_core/test/pages/notification_page.dart @@ -0,0 +1,21 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class NotificationPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, "notification.title"), + ), + ), + body: const SizedBox.shrink(), + ); + } +} diff --git a/packages/patapata_core/test/pages/startup_page.dart b/packages/patapata_core/test/pages/startup_page.dart new file mode 100644 index 0000000..73e74ad --- /dev/null +++ b/packages/patapata_core/test/pages/startup_page.dart @@ -0,0 +1,232 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class SplashPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'SplashPage', + ), + ), + body: const SizedBox.shrink(), + ); + } +} + +class StartupPageA extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'StartupPageA', + ), + ), + body: ListView( + children: [ + TextButton( + onPressed: () { + pageData(true); + }, + child: const Text('Complete'), + ), + TextButton( + onPressed: () { + getApp().startupSequence?.resetMachine(); + }, + child: const Text('Reset'), + ), + TextButton( + onPressed: () { + Navigator.of(context).push(MaterialPageRoute( + builder: (context) => StartupModalPageA(completer: pageData), + )); + }, + child: const Text('PushModalA'), + ), + ], + ), + ); + } +} + +class StartupPageB extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'StartupPageB', + ), + ), + body: ListView( + children: [ + TextButton( + onPressed: () { + pageData(true); + }, + child: const Text('Complete'), + ), + TextButton( + onPressed: () { + getApp().startupSequence?.resetMachine(); + }, + child: const Text('Reset'), + ), + ], + ), + ); + } +} + +class StartupModalPageA extends StatelessWidget { + const StartupModalPageA({ + super.key, + this.completer, + }); + + final StartupPageCompleter? completer; + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'StartupModalPageA', + ), + ), + body: ListView( + children: [ + TextButton( + onPressed: () { + completer?.call(true); + }, + child: const Text('Complete'), + ), + TextButton( + onPressed: () { + completer?.call(true); + Navigator.of(context).push(MaterialPageRoute( + builder: (context) => const StartupModalPageB(), + )); + }, + child: const Text('CompleteAndPushModaB'), + ), + TextButton( + onPressed: () { + Navigator.of(context).replace( + oldRoute: ModalRoute.of(context)!, + newRoute: MaterialPageRoute( + builder: (context) => StartupModalPageB( + completer: completer, + ), + ), + ); + }, + child: const Text('ReplaceAtoB'), + ), + TextButton( + onPressed: () { + Navigator.of(context).removeRoute(ModalRoute.of(context)!); + }, + child: const Text('Remove'), + ), + TextButton( + onPressed: () { + getApp().startupSequence?.resetMachine(); + }, + child: const Text('Reset'), + ), + ], + ), + ); + } +} + +class StartupModalPageB extends StatelessWidget { + const StartupModalPageB({ + super.key, + this.completer, + }); + + final StartupPageCompleter? completer; + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'StartupModalPageB', + ), + ), + body: ListView( + children: [ + TextButton( + onPressed: () { + completer?.call(true); + Navigator.of(context).push(MaterialPageRoute( + builder: (context) => const StartupModalPageC(), + )); + }, + child: const Text('CompleteAndPushModaC'), + ), + TextButton( + onPressed: () { + Navigator.of(context).removeRoute(ModalRoute.of(context)!); + }, + child: const Text('Remove'), + ), + ], + ), + ); + } +} + +class StartupModalPageC extends StatelessWidget { + const StartupModalPageC({ + super.key, + }); + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'StartupModalPageC', + ), + ), + body: ListView( + children: [ + TextButton( + onPressed: () { + Navigator.of(context).removeRoute(ModalRoute.of(context)!); + }, + child: const Text('Remove'), + ), + ], + ), + ); + } +} + +class TestHomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'HomePage', + ), + ), + body: const SizedBox.shrink(), + ); + } +} diff --git a/packages/patapata_core/test/permission/permissions_for_android_test.dart b/packages/patapata_core/test/permission/permissions_for_android_test.dart new file mode 100644 index 0000000..e2505a5 --- /dev/null +++ b/packages/patapata_core/test/permission/permissions_for_android_test.dart @@ -0,0 +1,115 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import '../utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + debugDefaultTargetPlatformOverride = TargetPlatform.android; + + test('trackingRequested for Android', () async { + late App app; + + app = createApp(); + + expect( + app.permissions.trackingRequested, + true, + ); + + app.dispose(); + }); + + test('notificationsRequested for Android', () async { + late App app; + + app = createApp(); + app.permissions.testSetRequested( + notificationsRequested: true, + ); + + expect( + app.permissions.notificationsRequested, + true, + ); + + app.permissions.testSetRequested( + notificationsRequested: false, + ); + + expect( + app.permissions.notificationsRequested, + false, + ); + + app.dispose(); + }); + + test('requestTracking for Android (notSupported)', () async { + late App app; + + app = createApp(); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.notSupported); + }); + + test('requestNotifications for Android (true)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(true); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.authorized); + + app.dispose(); + }); + + test('requestNotifications for Android (false)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(false); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.denied); + + app.dispose(); + }); + + test('notificationsStream for Android', () async { + late App app; + + app = createApp(); + + final tStreamResultValues = [ + PermissionNotificationResult.authorized, + PermissionNotificationResult.denied, + ]; + + final tFuture = expectLater( + app.permissions.notificationsStream.asyncMap((event) => event), + emitsInOrder(tStreamResultValues), + ); + + app.permissions.testSetLocalNotificationsPermission(true); + await app.permissions.requestNotifications(); + + app.permissions.testSetLocalNotificationsPermission(false); + await app.permissions.requestNotifications(); + + await tFuture; + + app.dispose(); + }); +} diff --git a/packages/patapata_core/test/permission/permissions_for_ios_test.dart b/packages/patapata_core/test/permission/permissions_for_ios_test.dart new file mode 100644 index 0000000..dece75d --- /dev/null +++ b/packages/patapata_core/test/permission/permissions_for_ios_test.dart @@ -0,0 +1,216 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import '../utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + debugDefaultTargetPlatformOverride = TargetPlatform.iOS; + + test('trackingRequested for iOS', () async { + late App app; + + app = createApp(); + app.permissions.testSetRequested( + trackingRequested: true, + ); + + expect( + app.permissions.trackingRequested, + true, + ); + + app.permissions.testSetRequested(trackingRequested: false); + + expect( + app.permissions.trackingRequested, + false, + ); + + app.dispose(); + }); + + test('notificationsRequested for iOS', () async { + late App app; + + app = createApp(); + app.permissions.testSetRequested( + notificationsRequested: true, + ); + + expect( + app.permissions.notificationsRequested, + true, + ); + + app.permissions.testSetRequested(notificationsRequested: false); + + expect( + app.permissions.notificationsRequested, + false, + ); + + app.dispose(); + }); + + test('requestTracking for iOS (notSupported)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetPermissionTrackingResult( + PermissionTrackingResult.notSupported, + ); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.notSupported); + + app.dispose(); + }); + + test('requestTracking for iOS (authorized)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetPermissionTrackingResult( + PermissionTrackingResult.authorized, + ); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.authorized); + + app.dispose(); + }); + + test('requestTracking for iOS (denied)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetPermissionTrackingResult( + PermissionTrackingResult.denied, + ); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.denied); + + app.dispose(); + }); + + test('requestTracking for iOS (notDetermined)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetPermissionTrackingResult( + PermissionTrackingResult.notDetermined, + ); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.notDetermined); + + app.dispose(); + }); + + test('requestTracking for iOS (restricted)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetPermissionTrackingResult( + PermissionTrackingResult.restricted, + ); + + final tResult = await app.permissions.requestTracking(); + + expect(tResult, PermissionTrackingResult.restricted); + + app.dispose(); + }); + + test('trackingStream for iOS', () async { + late App app; + + app = createApp(); + + final tFuture = expectLater( + app.permissions.trackingStream.asyncMap((event) => event), + emitsInOrder(PermissionTrackingResult.values), + ); + + for (PermissionTrackingResult tResult in PermissionTrackingResult.values) { + app.permissions.testSetPermissionTrackingResult( + tResult, + ); + + await app.permissions.requestTracking(); + } + + await tFuture; + + app.dispose(); + }); + + test('requestNotifications for iOS (true)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(true); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.authorized); + + app.dispose(); + }); + + test('requestNotifications for iOS (false)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(false); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.denied); + + app.dispose(); + }); + + test('notificationsStream for iOS', () async { + late App app; + + app = createApp(); + + final tStreamResultValues = [ + PermissionNotificationResult.authorized, + PermissionNotificationResult.denied, + ]; + + final tFuture = expectLater( + app.permissions.notificationsStream.asyncMap((event) => event), + emitsInOrder(tStreamResultValues), + ); + + app.permissions.testSetLocalNotificationsPermission(true); + await app.permissions.requestNotifications(); + + app.permissions.testSetLocalNotificationsPermission(false); + await app.permissions.requestNotifications(); + + await tFuture; + + app.dispose(); + }); +} diff --git a/packages/patapata_core/test/permission/permissions_for_macos_test.dart b/packages/patapata_core/test/permission/permissions_for_macos_test.dart new file mode 100644 index 0000000..7c4af1d --- /dev/null +++ b/packages/patapata_core/test/permission/permissions_for_macos_test.dart @@ -0,0 +1,103 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import '../utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + debugDefaultTargetPlatformOverride = TargetPlatform.macOS; + + test('trackingRequested for macOS', () async { + late App app; + + app = createApp(); + + expect( + app.permissions.trackingRequested, + true, + ); + + app.dispose(); + }); + + test('notificationsRequested for macOS', () async { + late App app; + + app = createApp(); + app.permissions.testSetRequested(notificationsRequested: true); + + expect( + app.permissions.notificationsRequested, + true, + ); + + app.permissions.testSetRequested( + notificationsRequested: false, + ); + + expect( + app.permissions.notificationsRequested, + false, + ); + + app.dispose(); + }); + + test('requestNotifications for macOS (true)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(true); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.authorized); + + app.dispose(); + }); + + test('requestNotifications for macOS (false)', () async { + late App app; + + app = createApp(); + + app.permissions.testSetLocalNotificationsPermission(false); + final tResult = await app.permissions.requestNotifications(); + + expect(tResult, PermissionNotificationResult.denied); + + app.dispose(); + }); + + test('notificationsStream for macOS', () async { + late App app; + + app = createApp(); + + final tStreamResultValues = [ + PermissionNotificationResult.authorized, + PermissionNotificationResult.denied, + ]; + + final tFuture = expectLater( + app.permissions.notificationsStream.asyncMap((event) => event), + emitsInOrder(tStreamResultValues), + ); + + app.permissions.testSetLocalNotificationsPermission(true); + await app.permissions.requestNotifications(); + + app.permissions.testSetLocalNotificationsPermission(false); + await app.permissions.requestNotifications(); + + await tFuture; + + app.dispose(); + }); +} diff --git a/packages/patapata_core/test/platform_dialog_test.dart b/packages/patapata_core/test/platform_dialog_test.dart new file mode 100644 index 0000000..7e18b05 --- /dev/null +++ b/packages/patapata_core/test/platform_dialog_test.dart @@ -0,0 +1,222 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; +import 'dart:math'; + +import 'package:flutter/cupertino.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_localizations/flutter_localizations.dart'; +import 'package:flutter_test/flutter_test.dart'; + +import 'package:patapata_core/src/widgets/platform_dialog.dart'; + +typedef DialogActionBuilder = PlatformDialogAction Function(dynamic result); + +abstract class TestButtonBase { + TestButtonBase({ + required this.expectedResults, + }); + + final T expectedResults; + dynamic actuallyResults; + + Finder createFinder(TargetPlatform? target); + PlatformDialogAction createAction(); + + void defaultAction() { + actuallyResults = expectedResults; + } + + T defaultReturn() { + return expectedResults; + } + + Widget? getTopWidget(Widget widget, TargetPlatform? target) { + if (target == TargetPlatform.iOS || target == TargetPlatform.macOS) { + return widget is CupertinoDialogAction ? widget.child : null; + } + + return widget is TextButton ? widget.child : null; + } +} + +class TestButton1 extends TestButtonBase { + TestButton1({ + required super.expectedResults, + }); + + @override + Finder createFinder(TargetPlatform? target) { + return find.byWidgetPredicate((widget) { + Widget? tChild = getTopWidget(widget, target); + if (tChild != null && tChild is Text) { + if (tChild.data == 'text button') { + return true; + } + } + + return false; + }); + } + + @override + PlatformDialogAction createAction() { + return PlatformDialogAction( + text: 'text button', + action: defaultAction, + result: defaultReturn, + ); + } +} + +class TestButton2 extends TestButtonBase { + TestButton2({ + required super.expectedResults, + }); + + @override + Finder createFinder(TargetPlatform? target) { + return find.byWidgetPredicate((widget) { + Widget? tChild = getTopWidget(widget, target); + if (tChild != null && tChild is SizedBox) { + if (tChild.width == 20 && tChild.height == 20) { + tChild = tChild.child; + if (tChild != null && tChild is ColoredBox) { + if (tChild.color == Colors.red) { + return true; + } + } + } + } + + return false; + }); + } + + @override + PlatformDialogAction createAction() { + return PlatformDialogAction( + child: const SizedBox( + width: 20, + height: 20, + child: ColoredBox( + color: Colors.red, + ), + ), + action: defaultAction, + result: defaultReturn, + ); + } +} + +const _localizationsDelegates = [ + GlobalMaterialLocalizations.delegate, + GlobalCupertinoLocalizations.delegate, + GlobalWidgetsLocalizations.delegate, +]; + +class TestApp { + TestApp({ + required this.targetPlatform, + }); + + final TargetPlatform? targetPlatform; + final appKey = GlobalKey(); + + Widget createApp() { + final tHome = KeyedSubtree( + key: appKey, + child: const SizedBox.shrink(), + ); + + if (targetPlatform == TargetPlatform.iOS || + targetPlatform == TargetPlatform.macOS) { + return CupertinoApp( + home: tHome, + localizationsDelegates: _localizationsDelegates, + ); + } + + return MaterialApp( + home: tHome, + ); + } + + Type? getDialogType() { + if (defaultTargetPlatform == TargetPlatform.iOS || + defaultTargetPlatform == TargetPlatform.macOS) { + return CupertinoAlertDialog; + } + + return AlertDialog; + } +} + +void main() { + final List tTestApps = kIsWeb + ? [ + TestApp(targetPlatform: null), + ] + : [ + TestApp(targetPlatform: TargetPlatform.android), + TestApp(targetPlatform: TargetPlatform.windows), + TestApp(targetPlatform: TargetPlatform.iOS), + TestApp(targetPlatform: TargetPlatform.macOS), + ]; + + final tTestButtons = [ + TestButton1(expectedResults: true), + TestButton2(expectedResults: Random().nextInt(1000)), + ]; + + for (final testApp in tTestApps) { + final tTestMessage = + 'Test PlatformDialog for ${testApp.targetPlatform?.name ?? 'web'}.'; + + group('Guard $tTestMessage', () { + testWidgets(tTestMessage, (WidgetTester tester) async { + if (testApp.targetPlatform != null) { + debugDefaultTargetPlatformOverride = testApp.targetPlatform; + } + + await tester.pumpWidget(testApp.createApp()); + + for (final testButton in tTestButtons) { + Future? tTapTestFuture; + final tResultTestCompleter = Completer(); + + PlatformDialog.show( + context: testApp.appKey.currentContext!, + actions: tTestButtons.map((e) => e.createAction()).toList(), + message: tTestMessage, + ).then((value) async { + await tTapTestFuture; + expect(value, testButton.expectedResults); + expect(value, testButton.actuallyResults); + tResultTestCompleter.complete(); + }); + await tester.pumpAndSettle(); + + // Confirmation of the existence of the Widget. + expect(find.byType(testApp.getDialogType()!), findsOneWidget); + expect(find.text(tTestMessage), findsOneWidget); + for (final e in tTestButtons) { + expect(e.createFinder(testApp.targetPlatform), findsOneWidget); + } + + // Test the behavior when the button1 is pressed. + tTapTestFuture = + tester.tap(testButton.createFinder(testApp.targetPlatform)); + await Future.wait([tTapTestFuture, tResultTestCompleter.future]); + await tester.pumpAndSettle(); + } + + debugDefaultTargetPlatformOverride = null; + }); + }); + } +} diff --git a/packages/patapata_core/test/plugin_test.dart b/packages/patapata_core/test/plugin_test.dart new file mode 100644 index 0000000..ea1b9e6 --- /dev/null +++ b/packages/patapata_core/test/plugin_test.dart @@ -0,0 +1,229 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// ignore_for_file: invalid_use_of_protected_member + +import 'package:flutter/widgets.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + testInitialize(); + + group('Plugin', () { + void doDefaultTests(Plugin Function() createPlugin, String name) { + test('name should return the runtime type as a string', () { + final tPlugin = createPlugin(); + expect(tPlugin.name, equals(name)); + }); + + test('dependencies should return an empty list by default', () { + final tPlugin = createPlugin(); + expect(tPlugin.dependencies, isEmpty); + }); + + test('requireRemoteConfig should return false by default', () { + final tPlugin = createPlugin(); + expect(tPlugin.requireRemoteConfig, isFalse); + }); + + test('remoteConfigEnabledKey should return the correct value', () { + final tPlugin = createPlugin(); + expect(tPlugin.remoteConfigEnabledKey, + equals('patapata_plugin_${name}_enabled')); + }); + + test('app should return the initialized App instance', () async { + final tPlugin = createPlugin(); + final tApp = createApp(); + await tPlugin.init(tApp); + expect(tPlugin.app, equals(tApp)); + }); + + test('initialized should return true after initialization', () async { + final tPlugin = createPlugin(); + final tApp = createApp(); + await tPlugin.init(tApp); + expect(tPlugin.initialized, isTrue); + }); + + test('disposed should return true after disposal', () async { + final tPlugin = createPlugin(); + final tApp = createApp(); + await tPlugin.init(tApp); + await tPlugin.dispose(); + expect(tPlugin.disposed, isTrue); + }); + + test('createAppWidgetWrapper should return the child widget by default', + () { + final tPlugin = createPlugin(); + final tChild = Container(); + final wrapper = tPlugin.createAppWidgetWrapper(tChild); + expect(wrapper, equals(tChild)); + }); + + test('createRemoteConfig should return null by default', () { + final tPlugin = createPlugin(); + final remoteConfig = tPlugin.createRemoteConfig(); + expect(remoteConfig, isNull); + }); + + test('createLocalConfig should return null by default', () { + final tPlugin = createPlugin(); + final localConfig = tPlugin.createLocalConfig(); + expect(localConfig, isNull); + }); + + test('createRemoteMessaging should return null by default', () { + final tPlugin = createPlugin(); + final remoteMessaging = tPlugin.createRemoteMessaging(); + expect(remoteMessaging, isNull); + }); + + test('navigatorObservers should return an empty list by default', () { + final tPlugin = createPlugin(); + final observers = tPlugin.navigatorObservers; + expect(observers, isEmpty); + }); + } + + group('Extended defaults', + () => doDefaultTests(() => _BasePlugin(), '_BasePlugin')); + + group('Inline defaults', + () => doDefaultTests(() => Plugin.inline(), 'inline')); + + group('Extended others', () { + test('init can not be executed multiple times', () async { + final tPlugin = _BasePlugin(); + final tApp = createApp(); + await tPlugin.init(tApp); + + expect( + () async => await tPlugin.init(tApp), throwsA(isA())); + }); + + test('dispose can not be executed multiple times', () async { + final tPlugin = _BasePlugin(); + final tApp = createApp(); + await tPlugin.init(tApp); + await tPlugin.dispose(); + + expect(() async => await tPlugin.dispose(), throwsA(isA())); + }); + + testWidgets('native mock enable/disable calls should be called', + (tester) async { + final tPlugin = _BasePlugin(shouldCall: expectAsync0(() {}, count: 2)); + final tApp = createApp( + plugins: [tPlugin], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tApp.removePlugin(tPlugin); + }); + + tApp.dispose(); + }); + + test('An error should be thrown if dependencies are not satisfied', + () async { + final tPlugin = _DependencyPlugin(); + final tApp = createApp(); + + expect( + () async => await tPlugin.init(tApp), throwsA(isA())); + }); + }); + + group('Inline others', () { + testWidgets('You can make a complete custom inline plugin', + (tester) async { + final tWidgetKey = GlobalKey(); + final tPlugin = Plugin.inline( + name: 'test', + dependencies: [_BasePlugin], + requireRemoteConfig: true, + init: expectAsync1((App app) async => true, count: 1), + dispose: expectAsync0(() {}, count: 1), + createAppWidgetWrapper: (child) => KeyedSubtree( + key: tWidgetKey, + child: child, + ), + createRemoteConfig: () => MockRemoteConfig({ + 'r': 'r', + }), + createLocalConfig: () => MockLocalConfig({ + 'l': 'l', + }), + createRemoteMessaging: () => MockRemoteMessaging( + getToken: () => Future.value('token'), + ), + navigatorObservers: () => [NavigatorObserver()], + ); + + final tApp = createApp( + plugins: [ + _BasePlugin(), + tPlugin, + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(tPlugin.name, equals('test')); + expect(tPlugin.dependencies, equals([_BasePlugin])); + expect(tPlugin.requireRemoteConfig, isTrue); + expect(tPlugin.remoteConfigEnabledKey, + equals('patapata_plugin_test_enabled')); + expect(tPlugin.app, equals(tApp)); + expect(tPlugin.initialized, isTrue); + expect(tPlugin.disposed, isFalse); + expect(tPlugin.navigatorObservers, isNotEmpty); + + expect(find.byKey(tWidgetKey), findsOneWidget); + expect(tApp.remoteConfig.getString('r'), equals('r')); + expect(tApp.localConfig.getString('l'), equals('l')); + expect(tApp.remoteMessaging.getToken(), completion('token')); + }); + + tApp.dispose(); + }); + }); + }); +} + +class _BasePlugin extends Plugin { + final void Function()? shouldCall; + + _BasePlugin({ + this.shouldCall, + }); + + @override + void mockPatapataEnable() { + shouldCall?.call(); + } + + @override + void mockPatapataDisable() { + shouldCall?.call(); + } +} + +class _DependencyPlugin extends Plugin { + @override + final List dependencies = [_BasePlugin]; +} diff --git a/packages/patapata_core/test/provider_model_test.dart b/packages/patapata_core/test/provider_model_test.dart new file mode 100644 index 0000000..4600161 --- /dev/null +++ b/packages/patapata_core/test/provider_model_test.dart @@ -0,0 +1,723 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// ignore_for_file: invalid_use_of_protected_member + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +void main() { + test('You can create a ProviderModel and access all of it\'s variables', () { + expect( + () => _A() + ..intVariable.unsafeValue + ..stringVariable.unsafeValue + ..mapVariable.unsafeValue, + returnsNormally, + ); + }); + + test('You can access correct data from a variable', () { + expect( + _A().intVariable.unsafeValue, + equals(_kIntValue), + ); + }); + + test('You can access correct data from a variable when a Map', () { + expect( + _A().mapVariable.unsafeValue, + equals(_kMapValue), + ); + }); + + test('You can get the type of a ProviderModelVariable', () { + final tA = _A(); + expect(tA.intVariable.type, equals(int)); + }); + + test('You can begin a batch', () { + final tA = _A(); + final tBatch = tA.begin(tA.keyA); + tBatch.commit(); + }); + + test('You can begin a batch when another batch is active with the same key', + () { + final tA = _A(); + tA.begin(tA.keyA); + expect(() => tA.begin(tA.keyA), returnsNormally); + }); + + test( + 'You can begin a batch when another batch is active with a different key', + () { + final tA = _A(); + tA.begin(tA.keyA); + expect(() => tA.begin(tA.keyB), returnsNormally); + }); + + test('You can begin a batch, and set values with it', () { + final tA = _A(); + final tBatch = tA.begin(tA.keyA); + tBatch.set(tA.intVariable, 2); + expect(tBatch.get(tA.intVariable), equals(2)); + expect(tA.intVariable.unsafeValue, equals(_kIntValue)); + tBatch.commit(); + expect(tA.intVariable.unsafeValue, equals(2)); + expect(tBatch.completed, isTrue); + expect(tBatch.valid, isTrue); + }); + + test('You can cancel a batch', () { + final tA = _A(); + final tBatch = tA.begin(tA.keyA); + tBatch.set(tA.intVariable, 2); + expect(tBatch.get(tA.intVariable), equals(2)); + expect(tA.intVariable.unsafeValue, equals(_kIntValue)); + tBatch.cancel(); + expect(tA.intVariable.unsafeValue, _kIntValue); + expect(tBatch.completed, isTrue); + expect(tBatch.valid, isFalse); + }); + + test('When you commit a batch, listeners get notified', () { + final tA = _A(); + + tA.addListener(expectAsync0(() {}, count: 1)); + + final tBatch = tA.begin(tA.keyA); + tBatch.set(tA.intVariable, 2); + tBatch.commit(); + }); + + test('You can cancel a batch, and noone gets notified', () { + final tA = _A(); + + tA.addListener(expectAsync0(() {}, count: 0)); + + final tBatch = tA.begin(tA.keyA); + tBatch.set(tA.intVariable, 2); + tBatch.cancel(); + }); + + test('When you commit a batch with no notify, listeners do not get notified', + () { + final tA = _A(); + + tA.addListener(expectAsync0(() {}, count: 0)); + + final tBatch = tA.begin(tA.keyA); + tBatch.set(tA.intVariable, 2); + tBatch.commit(notify: false); + }); + + test('You can begin multiple batches and the last comitted one wins', () { + final tA = _A(); + final tBA = tA.begin(tA.keyA); + final tBB = tA.begin(tA.keyB); + + tBA.set(tA.intVariable, 3); + tBB.set(tA.intVariable, 4); + + tBB.commit(); + tBA.commit(); + + expect(tA.intVariable.unsafeValue, equals(3)); + }); + + test('You can lock for a batch', () async { + final tA = _A(); + expect( + await tA.lock((batch) => batch.commit()), + equals(true), + ); + }); + + test( + 'You can lock for a batch and the result will be true when the batch is not commited', + () async { + final tA = _A(); + expect( + await tA.lock((batch) {}), + equals(true), + ); + }); + + test('You can lock for a batch and will return false on batch cancel', + () async { + final tA = _A(); + expect( + await tA.lock((batch) => batch.cancel()), + equals(false), + ); + }); + + test('You can lock for a batch, and set values with it', () async { + final tA = _A(); + + expect( + await tA.lock((batch) { + batch.set(tA.intVariable, 2); + expect(batch.get(tA.intVariable), equals(2)); + expect(tA.intVariable.unsafeValue, equals(_kIntValue)); + batch.commit(); + }), + equals(true), + ); + + expect(tA.intVariable.unsafeValue, equals(2)); + }); + + test( + 'You can not begin a batch when another locked batch is active with the same key', + () async { + final tA = _A(); + tA.lock((batch) async => Future.microtask(() => null)); + + try { + tA.begin(); + } catch (error) { + expect(error, isA()); + expect( + error.toString(), startsWith('ConflictException: _A(BatchLockKey')); + } + + tA.lock((batch) async => Future.microtask(() => null), lockKey: tA.keyA); + + try { + tA.begin(tA.keyA); + } catch (error) { + expect(error, isA()); + expect(error.toString(), startsWith('ConflictException: _A(keyA')); + expect(error.toString(), endsWith('Custom Conflict Reason')); + } + }); + + test( + 'You can begin a batch when another locked batch is active with a different key', + () async { + final tA = _A(); + tA.lock( + (batch) async => Future.microtask(() => null), + lockKey: tA.keyA, + ); + expect(() => tA.begin(tA.keyB), returnsNormally); + }); + + test( + 'You can lock multiple times, but will wait and execute in order when using the same key', + () async { + final tA = _A(); + final tFA = tA.lock((batch) { + batch.set(tA.intVariable, 4); + batch.commit(); + }); + + final tFB = tA.lock((batch) { + batch.set(tA.intVariable, 5); + batch.commit(); + }); + + final tFC = tA.lock((batch) { + batch.set(tA.intVariable, 6); + batch.commit(); + }); + + await Future.wait([tFA, tFB, tFC]); + + expect(tA.intVariable.unsafeValue, equals(6)); + }); + + test('If a lock throws, other awaiting locks will execute normally', + () async { + final tA = _A(); + + tA.lock((batch) { + batch.set(tA.intVariable, 4); + batch.commit(); + }); + + tA.lock((batch) async { + throw Error(); + }).catchError((error) => false); + + final tFC = tA.lock((batch) { + batch.set(tA.intVariable, 6); + batch.commit(); + }); + + await tFC; + + expect(tA.intVariable.unsafeValue, equals(6)); + }); + + test( + 'You can have two locks, with various override and overridable settings.', + () async { + const tInputs = [ + [true, true, true, true], + [false, true, true, true], + [true, false, true, true], + [false, false, true, true], + // + [true, true, false, true], + [false, true, false, true], + [true, false, false, true], + [false, false, false, true], + // + [true, true, true, false], + [false, true, true, false], + [true, false, true, false], + [false, false, true, false], + // + [true, true, false, false], + [false, true, false, false], + [true, false, false, false], + [false, false, false, false], + ]; + const tExpects = [ + [1, false, true, 'null1'], + [1, false, true, 'null1'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + // + [2, true, true, 'null01'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + // + [1, false, true, 'null1'], + [1, false, true, 'null1'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + // + [2, true, true, 'null01'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + [2, true, true, 'null01'], + ]; + + for (var i = 0; i < tInputs.length; i++) { + final tInput = tInputs[i]; + final tExpect = tExpects[i]; + final tA = _A(); + tA.addListener(expectAsync0(() {}, count: tExpect[0] as int)); + + final tResultA = tA.lock((batch) async { + batch.set(tA.stringVariable, '${batch.get(tA.stringVariable)}0'); + await Future.microtask(() => null); + batch.commit(); + }, override: tInput[0], overridable: tInput[1]); + + final tResultB = tA.lock((batch) async { + batch.set(tA.stringVariable, '${batch.get(tA.stringVariable)}1'); + await Future.microtask(() => null); + await Future.microtask(() => null); + batch.commit(); + }, override: tInput[2], overridable: tInput[3]); + + expect(await tResultA, equals(tExpect[1] as bool)); + expect(await tResultB, equals(tExpect[2] as bool)); + expect(tA.stringVariable.unsafeValue, tExpect[3] as String); + } + }); + + test('An overriden lock has a chance to revert its changes with onOverride.', + () async { + final tA = _A(); + + var tValue = 0; + + tA.lock( + (batch) { + batch.set(tA.intVariable, 4); + tValue = 1; + batch.commit(); + }, + onOverride: () { + tValue = 2; + }, + ); + + final tFC = tA.lock((batch) { + batch.set(tA.intVariable, 6); + batch.commit(); + }, override: true); + + await tFC; + + expect(tValue, equals(2)); + expect(tA.intVariable.unsafeValue, equals(6)); + }); + + test( + 'An overriden lock has a chance to revert its changes with onOverride asynchronously.', + () async { + final tA = _A(); + + var tValue = 0; + + tA.lock( + (batch) { + batch.set(tA.intVariable, 4); + tValue = 1; + batch.commit(); + }, + onOverride: () async { + await Future.microtask(() => null); + tValue = 2; + }, + ); + + final tFC = tA.lock((batch) { + batch.set(tA.intVariable, 6); + batch.commit(); + }, override: true); + + await tFC; + + expect(tValue, equals(2)); + expect(tA.intVariable.unsafeValue, equals(6)); + }); + + test('You can override multiple times without anything locking up', () async { + final tA = _A(); + + var tValue = 0; + + for (var i = 0; i < 12; i++) { + tA.lock( + (batch) async { + await batch.blockOverride(() => + Future.delayed(const Duration(milliseconds: 45), () => null)); + batch.set(tA.intVariable, 4); + tValue = 1; + batch.commit(); + }, + override: true, + overridable: true, + ); + } + + final tFC = tA.lock((batch) async { + await batch.blockOverride(() => Future.microtask(() => null)); + batch.set(tA.intVariable, 6); + batch.commit(); + }, override: true); + + await tFC; + + expect(tValue, equals(0)); + expect(tA.intVariable.unsafeValue, equals(6)); + }); + + test('You can have a lock in a lock with a different key', () async { + final tA = _A(); + expect( + await tA.lock((batch) async { + final tAS = _A(); + expect( + await tAS.lock((batch) async { + await Future.microtask(() => null); + batch.commit(); + }, lockKey: tAS.keyB), + equals(true), + ); + }, lockKey: tA.keyA), + equals(true), + ); + }); + + test('Listeners are notified when variables change', () { + final tA = _A(); + + tA.intVariable.addListener(expectAsync0(() {}, count: 1)); + tA.addListener(expectAsync0(() {}, count: 1)); + + tA.begin() + ..set(tA.intVariable, 10) + ..commit(); + }); + + test( + 'Listeners are not notified even when variables change if commit\'s notify is false', + () { + final tA = _A(); + + tA.intVariable.addListener(expectAsync0(() {}, count: 0)); + tA.addListener(expectAsync0(() {}, count: 0)); + + tA.begin() + ..set(tA.intVariable, 10) + ..commit(notify: false); + }); + + test( + 'Listeners are always notified even when variables do not change if commit\'s notify is true', + () { + final tA = _A(); + + tA.intVariable.addListener(expectAsync0(() {}, count: 0)); + tA.addListener(expectAsync0(() {}, count: 0)); + + tA.begin() + ..set(tA.intVariable, tA.intVariable.unsafeValue) + ..commit(notify: true); + }); + + test('A variable can be created unset', () { + final tA = _A(); + expect( + () => tA.customUnsetVariable.unsafeValue, + throwsAssertionError, + ); + expect( + tA.customUnsetVariable.toString(), + equals('_CustomType:NOT SET'), + ); + }); + + test('A variable can be created unset, but set later and accessed', () { + final tA = _A(); + tA.begin() + ..set(tA.customUnsetVariable, _CustomType()) + ..commit(); + expect( + tA.customUnsetVariable.unsafeValue, + isNotNull, + ); + expect( + tA.customUnsetVariable.toString(), + equals('_CustomType:CustomType'), + ); + }); + + test( + 'A variable can be created unset or set, and checked in a batch to see if it is set', + () async { + final tA = _A(); + + await tA.lock((batch) { + expect(tA.customUnsetVariable.set, isFalse); + expect(batch.isSet(tA.customUnsetVariable), isFalse); + batch.set(tA.customUnsetVariable, _CustomType()); + expect(batch.isSet(tA.customUnsetVariable), isTrue); + expect(tA.customUnsetVariable.set, isFalse); + batch.commit(); + expect(tA.customUnsetVariable.set, isTrue); + }); + }); + + test('You can get the value asynchronously from a variable', () async { + final tA = _A(); + + expect(await tA.intVariable.getValue(), equals(_kIntValue)); + + final tFuture = tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, 3); + await Future.delayed(const Duration(milliseconds: 1)); + batch.commit(); + }); + + final tValueFuture = tA.intVariable.getValue(); + + await tFuture; + + expect(await tValueFuture, equals(3)); + }); + + test( + 'You can get the value asynchronously from a variable when multiple batches are ongoing', + () async { + final tA = _A(); + + final tFutures = [ + tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, batch.get(tA.intVariable) + 1); + await Future.delayed(const Duration(milliseconds: 1)); + batch.commit(); + }), + tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, batch.get(tA.intVariable) + 1); + await Future.delayed(const Duration(milliseconds: 1)); + batch.commit(); + }), + tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, batch.get(tA.intVariable) + 1); + await Future.delayed(const Duration(milliseconds: 1)); + batch.commit(); + }), + ]; + + final tValueFuture = tA.intVariable.getValue(); + + await Future.wait(tFutures); + + expect(await tValueFuture, equals(4)); + }); + + test('Listeners are notified when an unset variable is set to the same value', + () { + final tA = _A(); + + tA.stringUnsetVariable.addListener(expectAsync0(() {}, count: 1)); + tA.addListener(expectAsync0(() {}, count: 1)); + + tA.begin() + ..set(tA.stringUnsetVariable, null) + ..commit(); + }); + + test('A model can be disposed', () { + final tA = _A(); + + final tSubscription = tA.use((model) => model.ii); + + expect(() => tA.dispose(), returnsNormally); + expect(tA.disposed, isTrue); + expect(() => tA.begin(), throwsAssertionError); + expect(() => tA.lock((_) {}), throwsAssertionError); + expect(() => tA.use((_) {}), throwsAssertionError); + + expect(() => tSubscription.cancel(), returnsNormally); + }); + + test('A model can be disposed while a batch is running', () async { + final tA = _A(); + + final tLockFuture = tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.commit(); + }); + + expect(() => tA.dispose(), returnsNormally); + expect(tA.disposed, isTrue); + expect(await tA.intVariable.getValue(), _kIntValue); + expect(await tLockFuture, isFalse); + }); + + test( + 'A value of a variable will return it\'s value immediately if a model was disposed of during a batch', + () async { + final tA = _A(); + + final tLockFuture = tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, 10); + batch.commit(); + }); + + final tValueFuture = tA.intVariable.getValue(); + + final tLockFuture2 = tA.lock((batch) async { + await Future.delayed(const Duration(milliseconds: 1)); + batch.set(tA.intVariable, 20); + batch.commit(); + }); + + expect(() => tA.dispose(), returnsNormally); + expect(tA.disposed, isTrue); + + expect(await tValueFuture, _kIntValue); + expect(await tLockFuture, isFalse); + expect(await tLockFuture2, isFalse); + }); + + test('A model can be used', () async { + final tA = _A(); + + final tSubscription = tA.use( + expectAsync1( + (_A model) => model.ii, + count: 3, + ), + ); + + await tA.lock((batch) { + batch.set(tA.intVariable, 2); + batch.commit(); + }); + + await tA.lock((batch) { + batch.set(tA.intVariable, 3); + batch.commit(); + }); + + expect(tA.ii, equals(3)); + + tSubscription.cancel(); + + await tA.lock((batch) { + batch.set(tA.intVariable, 4); + batch.commit(); + }); + + expect(tA.ii, equals(4)); + }); + + test('A model can be used but the callback is called asynchronously', + () async { + final tA = _A(); + + final tSubscription = tA.use( + expectAsync1( + (_A model) => model.ii, + count: 2, + ), + ); + + tA.begin() + ..set(tA.intVariable, 2) + ..commit(); + + await tA.lock((batch) { + batch.set(tA.intVariable, 3); + batch.commit(); + }); + + expect(tA.ii, equals(3)); + + tSubscription.cancel(); + }); + + test('use can not be called inside use', () async { + final tA = _A(); + + tA.use( + (_A model) { + expect(() => model.use((_A model) => model.ii), throwsAssertionError); + }, + ); + }); +} + +const int _kIntValue = 1; +const String? _kStringNullValue = null; +const Map _kMapValue = {}; + +class _A extends ProviderModel<_A> { + late final intVariable = createVariable(_kIntValue); + late final stringVariable = createVariable(_kStringNullValue); + late final mapVariable = createVariable>(_kMapValue); + late final customVariable = createVariable<_CustomType>(_CustomType()); + late final customUnsetVariable = createUnsetVariable<_CustomType>(); + late final stringUnsetVariable = createUnsetVariable(); + + int get ii => intVariable.unsafeValue; + + final keyA = + ProviderLockKey('keyA', conflictReason: 'Custom Conflict Reason'); + final keyB = ProviderLockKey('keyB'); +} + +class _CustomType { + @override + String toString() => 'CustomType'; +} diff --git a/packages/patapata_core/test/proxy_local_config_test.dart b/packages/patapata_core/test/proxy_local_config_test.dart new file mode 100644 index 0000000..ca7c519 --- /dev/null +++ b/packages/patapata_core/test/proxy_local_config_test.dart @@ -0,0 +1,196 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/src/native_local_config_finder.dart'; + +void main() async { + TestWidgetsFlutterBinding.ensureInitialized(); + + testSetMockMethodCallHandler = TestDefaultBinaryMessengerBinding + .instance.defaultBinaryMessenger.setMockMethodCallHandler; + + const kBoolValueKey = 'kBoolValueKey'; + const kDoubleValueKey = 'kDoubleValueKey'; + const kIntValueKey = 'kIntValueKey'; + const kStringValueKey = 'kStringValueKey'; + + test('initialized | disposed', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + await tProxyLocalConfig.init(); + expect(tProxyLocalConfig.initialized, isTrue); + + tProxyLocalConfig.dispose(); + expect(tProxyLocalConfig.disposed, isTrue); + }); + + test('hasKey', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + const String kDefaultValueKey = 'defaultValue'; + const String kSetValueKey = 'setValue'; + + expect(tProxyLocalConfig.hasKey(kDefaultValueKey), isFalse); + expect(tProxyLocalConfig.hasKey(kSetValueKey), isFalse); + + await tProxyLocalConfig.setDefaults({kDefaultValueKey: 1}); + + expect(tProxyLocalConfig.hasKey(kDefaultValueKey), isFalse); + expect(tProxyLocalConfig.hasKey(kSetValueKey), isFalse); + + await tProxyLocalConfig.setInt(kSetValueKey, 1); + + expect(tProxyLocalConfig.hasKey(kDefaultValueKey), isFalse); + expect(tProxyLocalConfig.hasKey(kSetValueKey), isTrue); + }); + + test('addLocalConfig | removeLocalConfig', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + NativeLocalConfig tNativeLocalConfig = NativeLocalConfig(); + await tNativeLocalConfig.init(); + + await tProxyLocalConfig.setString(kStringValueKey, 'ProxyLocalConfig'); + expect(tProxyLocalConfig.getString(kStringValueKey), 'ProxyLocalConfig'); + + await tProxyLocalConfig.addLocalConfig(tNativeLocalConfig); + await tNativeLocalConfig.setString(kStringValueKey, 'NativeLocalConfig'); + + expect(tProxyLocalConfig.getString(kStringValueKey), 'NativeLocalConfig'); + + tProxyLocalConfig.removeLocalConfig(tNativeLocalConfig); + expect(tProxyLocalConfig.getString(kStringValueKey), 'ProxyLocalConfig'); + }); + + test('check bool value', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + expect( + tProxyLocalConfig.getBool(kBoolValueKey), Config.defaultValueForBool); + + await tProxyLocalConfig.setDefaults({kBoolValueKey: true}); + expect(tProxyLocalConfig.getBool(kBoolValueKey), true); + + await tProxyLocalConfig.setBool(kBoolValueKey, false); + expect(tProxyLocalConfig.getBool(kBoolValueKey), false); + + await tProxyLocalConfig.reset(kBoolValueKey); + expect(tProxyLocalConfig.getBool(kBoolValueKey), true); + }); + + test('check double value', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), + Config.defaultValueForDouble); + + await tProxyLocalConfig.setDefaults({kDoubleValueKey: 1.0}); + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), 1.0); + + await tProxyLocalConfig.setDouble(kDoubleValueKey, 2.0); + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), 2.0); + + await tProxyLocalConfig.reset(kDoubleValueKey); + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), 1.0); + }); + + test('check int value', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + expect(tProxyLocalConfig.getInt(kIntValueKey), Config.defaultValueForInt); + + await tProxyLocalConfig.setDefaults({kIntValueKey: 1}); + expect(tProxyLocalConfig.getInt(kIntValueKey), 1); + + await tProxyLocalConfig.setInt(kIntValueKey, 2); + expect(tProxyLocalConfig.getInt(kIntValueKey), 2); + + await tProxyLocalConfig.reset(kIntValueKey); + expect(tProxyLocalConfig.getInt(kIntValueKey), 1); + }); + + test('check String value', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + expect(tProxyLocalConfig.getString(kStringValueKey), + Config.defaultValueForString); + + await tProxyLocalConfig.setDefaults({kStringValueKey: '1'}); + expect(tProxyLocalConfig.getString(kStringValueKey), '1'); + + await tProxyLocalConfig.setString(kStringValueKey, '2'); + expect(tProxyLocalConfig.getString(kStringValueKey), '2'); + + await tProxyLocalConfig.reset(kStringValueKey); + expect(tProxyLocalConfig.getString(kStringValueKey), '1'); + }); + + test('resetAll', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + await tProxyLocalConfig.setBool(kBoolValueKey, false); + await tProxyLocalConfig.setDouble(kDoubleValueKey, 2.0); + await tProxyLocalConfig.setInt(kIntValueKey, 2); + await tProxyLocalConfig.setString(kStringValueKey, '2'); + + expect(tProxyLocalConfig.getBool(kBoolValueKey), false); + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), 2.0); + expect(tProxyLocalConfig.getInt(kIntValueKey), 2); + expect(tProxyLocalConfig.getString(kStringValueKey), '2'); + + await tProxyLocalConfig.resetAll(); + + expect( + tProxyLocalConfig.getBool(kBoolValueKey), Config.defaultValueForBool); + expect(tProxyLocalConfig.getDouble(kDoubleValueKey), + Config.defaultValueForDouble); + expect(tProxyLocalConfig.getInt(kIntValueKey), Config.defaultValueForInt); + expect(tProxyLocalConfig.getString(kStringValueKey), + Config.defaultValueForString); + }); + + test('resetMany', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + const kIsSetKey1 = 'isSet1'; + const kIsSetKey2 = 'isSet2'; + const kIsNotSetKey1 = 'isNotSet1'; + const kIsNotSetKey2 = 'isNotSet2'; + + await tProxyLocalConfig.setDefaults({ + kIsSetKey1: 1, + kIsSetKey2: 1, + }); + + await tProxyLocalConfig.setInt(kIsSetKey1, 2); + await tProxyLocalConfig.setInt(kIsNotSetKey1, 2); + + await tProxyLocalConfig.resetMany([ + kIsSetKey1, + kIsSetKey2, + kIsNotSetKey1, + kIsNotSetKey2, + ]); + + expect(tProxyLocalConfig.getInt(kIsSetKey1), 1); + expect(tProxyLocalConfig.getInt(kIsSetKey2), 1); + expect(tProxyLocalConfig.getInt(kIsNotSetKey1), Config.defaultValueForInt); + expect(tProxyLocalConfig.getInt(kIsNotSetKey2), Config.defaultValueForInt); + }); + + test('setMany', () async { + ProxyLocalConfig tProxyLocalConfig = ProxyLocalConfig(); + + final Map tObjects = { + 'name': 'GREE, Inc.', + }; + + await tProxyLocalConfig.setMany(tObjects); + + expect(tProxyLocalConfig.getString('name'), 'GREE, Inc.'); + }); +} diff --git a/packages/patapata_core/test/remote_config_test.dart b/packages/patapata_core/test/remote_config_test.dart new file mode 100644 index 0000000..11d1394 --- /dev/null +++ b/packages/patapata_core/test/remote_config_test.dart @@ -0,0 +1,334 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + const kDefaultBoolKey = 'kDefaultBoolKey'; + const kDefaultDoubleKey = 'kDefaultDoubleKey'; + const kDefaultIntKey = 'kDefaultIntKey'; + const kDefaultStringKey = 'kDefaultStringKey'; + + const kBoolValueKey = 'kBoolValueKey'; + const kDoubleValueKey = 'kDoubleValueKey'; + const kIntValueKey = 'kIntValueKey'; + const kStringValueKey = 'kStringValueKey'; + + late App app; + late MockRemoteConfig mockRemoteConfig; + setUp(() { + mockRemoteConfig = MockRemoteConfig({}); + mockRemoteConfig.testSetMockFetchValues({}); + + final tPlugin = Plugin.inline( + name: 'test', + requireRemoteConfig: true, + createRemoteConfig: () => mockRemoteConfig, + ); + + app = createApp( + plugins: [ + tPlugin, + ], + ); + }); + + tearDown(() { + app.dispose(); + }); + + Future runApp() async { + app.run(); + await App.appStageChangeStream.firstWhere( + (element) { + return element.stage == AppStage.running; + }, + ); + } + + test('Function hasKey.', () async { + await runApp(); + + expect( + app.remoteConfig.hasKey(kBoolValueKey), + false, + ); + + mockRemoteConfig.testSetMockFetchValues({ + kBoolValueKey: true, + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect( + app.remoteConfig.hasKey(kBoolValueKey), + true, + ); + }); + + test('Function setDefaults.', () async { + await runApp(); + + expect(app.remoteConfig.getBool(kDefaultBoolKey), false); + expect(app.remoteConfig.getDouble(kDefaultDoubleKey), 0.0); + expect(app.remoteConfig.getInt(kDefaultIntKey), 0); + expect(app.remoteConfig.getString(kDefaultStringKey), ''); + + await app.remoteConfig.setDefaults({ + kDefaultBoolKey: true, + kDefaultDoubleKey: 1.0, + kDefaultIntKey: 1, + kDefaultStringKey: '1', + }); + + expect(mockRemoteConfig.getBool(kDefaultBoolKey), true); + expect(mockRemoteConfig.getDouble(kDefaultDoubleKey), 1.0); + expect(mockRemoteConfig.getInt(kDefaultIntKey), 1); + expect(mockRemoteConfig.getString(kDefaultStringKey), '1'); + }); + + test('Function reset.', () async { + await runApp(); + mockRemoteConfig.testSetMockFetchValues({ + kBoolValueKey: true, + kDoubleValueKey: 1.0, + kIntValueKey: 1, + kStringValueKey: '1', + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kBoolValueKey), true); + expect(app.remoteConfig.hasKey(kDoubleValueKey), true); + expect(app.remoteConfig.hasKey(kIntValueKey), true); + expect(app.remoteConfig.hasKey(kStringValueKey), true); + + await mockRemoteConfig.reset(kBoolValueKey); + await mockRemoteConfig.reset(kDoubleValueKey); + await mockRemoteConfig.reset(kIntValueKey); + await mockRemoteConfig.reset(kStringValueKey); + + expect(app.remoteConfig.hasKey(kBoolValueKey), false); + expect(app.remoteConfig.hasKey(kDoubleValueKey), false); + expect(app.remoteConfig.hasKey(kIntValueKey), false); + expect(app.remoteConfig.hasKey(kStringValueKey), false); + }); + + test('Function resetAll.', () async { + await runApp(); + mockRemoteConfig.testSetMockFetchValues({ + kBoolValueKey: true, + kDoubleValueKey: 1.0, + kIntValueKey: 1, + kStringValueKey: '1', + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kBoolValueKey), true); + expect(app.remoteConfig.hasKey(kDoubleValueKey), true); + expect(app.remoteConfig.hasKey(kIntValueKey), true); + expect(app.remoteConfig.hasKey(kStringValueKey), true); + + await mockRemoteConfig.resetAll(); + + expect(app.remoteConfig.hasKey(kBoolValueKey), false); + expect(app.remoteConfig.hasKey(kDoubleValueKey), false); + expect(app.remoteConfig.hasKey(kIntValueKey), false); + expect(app.remoteConfig.hasKey(kStringValueKey), false); + }); + + test('Function resetMany.', () async { + await runApp(); + mockRemoteConfig.testSetMockFetchValues({ + kBoolValueKey: true, + kDoubleValueKey: 1.0, + kIntValueKey: 1, + kStringValueKey: '1', + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kBoolValueKey), true); + expect(app.remoteConfig.hasKey(kDoubleValueKey), true); + expect(app.remoteConfig.hasKey(kIntValueKey), true); + expect(app.remoteConfig.hasKey(kStringValueKey), true); + + await mockRemoteConfig.resetMany([ + kBoolValueKey, + kDoubleValueKey, + kIntValueKey, + kStringValueKey, + ]); + + expect(app.remoteConfig.hasKey(kBoolValueKey), false); + expect(app.remoteConfig.hasKey(kDoubleValueKey), false); + expect(app.remoteConfig.hasKey(kIntValueKey), false); + expect(app.remoteConfig.hasKey(kStringValueKey), false); + }); + + test('Function dispose.', () async { + await runApp(); + + expect(app.remoteConfig.disposed, isFalse); + + app.remoteConfig.dispose(); + expect(app.remoteConfig.disposed, isTrue); + }); + + test('Check bool value.', () async { + await runApp(); + + await app.remoteConfig.setDefaults({ + kDefaultBoolKey: true, + }); + expect(app.remoteConfig.getBool(kDefaultBoolKey), true); + + expect(app.remoteConfig.hasKey(kBoolValueKey), isFalse); + expect( + app.remoteConfig.getBool(kBoolValueKey), + Config.defaultValueForBool, + ); + + mockRemoteConfig.testSetMockFetchValues({ + kBoolValueKey: true, + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kBoolValueKey), isTrue); + expect(app.remoteConfig.getBool(kBoolValueKey), true); + + mockRemoteConfig.setBool(kBoolValueKey, false); + expect(app.remoteConfig.getBool(kBoolValueKey), false); + }); + + test('Check double value.', () async { + await runApp(); + + await app.remoteConfig.setDefaults({ + kDefaultDoubleKey: 1.0, + }); + expect(app.remoteConfig.getDouble(kDefaultDoubleKey), 1.0); + + expect(app.remoteConfig.hasKey(kDoubleValueKey), isFalse); + expect( + app.remoteConfig.getDouble(kDoubleValueKey), + Config.defaultValueForDouble, + ); + + mockRemoteConfig.testSetMockFetchValues({ + kDoubleValueKey: 1.0, + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kDoubleValueKey), isTrue); + expect(app.remoteConfig.getDouble(kDoubleValueKey), 1.0); + + mockRemoteConfig.setDouble(kDoubleValueKey, 2.0); + expect(app.remoteConfig.getDouble(kDoubleValueKey), 2.0); + }); + test('Check int value.', () async { + await runApp(); + + await app.remoteConfig.setDefaults({ + kDefaultIntKey: 1, + }); + expect(app.remoteConfig.getInt(kDefaultIntKey), 1); + + expect(app.remoteConfig.hasKey(kIntValueKey), isFalse); + expect( + app.remoteConfig.getInt(kIntValueKey), + Config.defaultValueForInt, + ); + + mockRemoteConfig.testSetMockFetchValues({ + kIntValueKey: 1, + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kIntValueKey), isTrue); + expect(app.remoteConfig.getInt(kIntValueKey), 1); + + mockRemoteConfig.setInt(kIntValueKey, 2); + expect(app.remoteConfig.getInt(kIntValueKey), 2); + }); + + test('Check String value.', () async { + await runApp(); + + await app.remoteConfig.setDefaults({ + kDefaultStringKey: '1', + }); + expect(app.remoteConfig.getString(kDefaultStringKey), '1'); + + expect(app.remoteConfig.hasKey(kStringValueKey), isFalse); + expect( + app.remoteConfig.getString(kStringValueKey), + Config.defaultValueForString, + ); + + mockRemoteConfig.testSetMockFetchValues({ + kStringValueKey: '1', + }); + + await app.remoteConfig.fetch( + force: true, + ); + + expect(app.remoteConfig.hasKey(kStringValueKey), isTrue); + expect(app.remoteConfig.getString(kStringValueKey), '1'); + + mockRemoteConfig.setString(kStringValueKey, '2'); + expect(app.remoteConfig.getString(kStringValueKey), '2'); + }); + + test('Check many value.', () async { + await runApp(); + + expect(app.remoteConfig.hasKey(kBoolValueKey), false); + expect(app.remoteConfig.hasKey(kDoubleValueKey), false); + expect(app.remoteConfig.hasKey(kIntValueKey), false); + expect(app.remoteConfig.hasKey(kStringValueKey), false); + + await mockRemoteConfig.setMany({ + kBoolValueKey: true, + kDoubleValueKey: 1.0, + kIntValueKey: 1, + kStringValueKey: '1', + }); + + expect(app.remoteConfig.hasKey(kBoolValueKey), true); + expect(app.remoteConfig.hasKey(kDoubleValueKey), true); + expect(app.remoteConfig.hasKey(kIntValueKey), true); + expect(app.remoteConfig.hasKey(kStringValueKey), true); + + expect(app.remoteConfig.getBool(kBoolValueKey), true); + expect(app.remoteConfig.getDouble(kDoubleValueKey), 1.0); + expect(app.remoteConfig.getInt(kIntValueKey), 1); + expect(app.remoteConfig.getString(kStringValueKey), '1'); + }); +} diff --git a/packages/patapata_core/test/remote_messaging_test.dart b/packages/patapata_core/test/remote_messaging_test.dart new file mode 100644 index 0000000..6a3934e --- /dev/null +++ b/packages/patapata_core/test/remote_messaging_test.dart @@ -0,0 +1,317 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('RemoteMessageNotification class.', () { + const tTitle = 'title'; + const tBody = 'body'; + + test('Instance (no arguments).', () async { + const tRemoteMessageNotification = RemoteMessageNotification(); + + expect(tRemoteMessageNotification, isA()); + expect(tRemoteMessageNotification.title, isNull); + expect(tRemoteMessageNotification.body, isNull); + }); + + test('Instance (with arguments).', () async { + const tRemoteMessageNotification = RemoteMessageNotification( + title: tTitle, + body: tBody, + ); + + expect(tRemoteMessageNotification, isA()); + expect(tRemoteMessageNotification.title, tTitle); + expect(tRemoteMessageNotification.body, tBody); + expect( + tRemoteMessageNotification.toString(), + 'RemoteMessageNotification:{title:$tTitle, body:$tBody}', + ); + }); + }); + + group('RemoteMessage class.', () { + const tMessageId = 'messageId'; + const tChannel = 'channel'; + const tData = { + 'key': 'value', + }; + const tRemoteMessageNotification = RemoteMessageNotification(); + + test('Instance (no arguments).', () async { + const tRemoteMessage = RemoteMessage(); + + expect(tRemoteMessage, isA()); + expect(tRemoteMessage.messageId, isNull); + expect( + tRemoteMessage.channel, + RemoteMessage.kRemoteMessageDefaultChannel, + ); + expect(tRemoteMessage.data, isNull); + expect(tRemoteMessage.notification, isNull); + }); + + test('Instance (with arguments).', () async { + const tRemoteMessage = RemoteMessage( + messageId: tMessageId, + channel: tChannel, + data: tData, + notification: tRemoteMessageNotification, + ); + + expect(tRemoteMessage, isA()); + expect(tRemoteMessage.messageId, tMessageId); + expect(tRemoteMessage.channel, tChannel); + expect(tRemoteMessage.data, tData); + expect(tRemoteMessage.notification, tRemoteMessageNotification); + expect( + tRemoteMessage.toString(), + 'RemoteMessage:{messageId:$tMessageId, channel:$tChannel, data:$tData}', + ); + }); + }); + + group('ProxyRemoteMessaging class.', () { + test('Getter app.', () async { + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + + expect(tProxyRemoteMessaging.app, tApp); + }); + + test('Function getInitialMessage (no arguments).', () async { + final tMockRemoteMessaging = MockRemoteMessaging(); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + final tInitialMessage = await tProxyRemoteMessaging.getInitialMessage(); + + expect(tInitialMessage, isNull); + }); + + test('Function getInitialMessage (with arguments).', () async { + const tRemoteMessage = RemoteMessage(); + + final tMockRemoteMessaging = MockRemoteMessaging( + getInitialMessage: () async => tRemoteMessage, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + final tInitialMessage = await tProxyRemoteMessaging.getInitialMessage(); + + expect(tInitialMessage, tRemoteMessage); + }); + + test('Function getToken no RemoteConfigs.', () async { + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tResult = await tProxyRemoteMessaging.getToken(); + + expect(tResult, isNull); + }); + + test('Function getToken with RemoteConfig(no token).', () async { + final tMockRemoteMessaging = MockRemoteMessaging(); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + final tResult = await tProxyRemoteMessaging.getToken(); + + expect(tResult, null); + }); + + test('Function getToken with RemoteConfig(with token).', () async { + const tToken = 'token'; + + final tMockRemoteMessaging = MockRemoteMessaging( + getToken: () async => tToken, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + final tResult = await tProxyRemoteMessaging.getToken(); + + expect(tResult, tToken); + }); + + test("Function getToken with RemoteConfig's.", () async { + const tToken1 = 'token'; + const tToken2 = 'token'; + + final tMockRemoteMessaging1 = MockRemoteMessaging( + getToken: () async => tToken1, + ); + final tMockRemoteMessaging2 = MockRemoteMessaging( + getToken: () async => tToken2, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging1); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging2); + + final tResult = await tProxyRemoteMessaging.getToken(); + + expect(tResult, tToken1); + }); + + test('Stream messageStream.', () async { + final tMockMessagesController = StreamController(); + + final tMockRemoteMessaging = MockRemoteMessaging( + messages: () => tMockMessagesController.stream, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + const tRemoteMessage = RemoteMessage(); + + final tMessageValues = [ + tRemoteMessage, + ]; + + final tProxyMessageFuture = expectLater( + tProxyRemoteMessaging.messages, + emitsInOrder(tMessageValues), + ); + + tMockMessagesController.add(tRemoteMessage); + + await tProxyMessageFuture; + }); + + test('Stream messageStream.', () async { + final tMockMessagesController = StreamController(); + + final tMockRemoteMessaging = MockRemoteMessaging( + messages: () => tMockMessagesController.stream, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + const tRemoteMessage = RemoteMessage(); + + final tMessageValues = [ + tRemoteMessage, + ]; + + final tProxyMessageFuture = expectLater( + tProxyRemoteMessaging.messages, + emitsInOrder(tMessageValues), + ); + + tMockMessagesController.add(tRemoteMessage); + + await tProxyMessageFuture; + }); + + test('Test for tokenStream.', () async { + final tMockTokensController = StreamController(); + + final tMockRemoteMessaging = MockRemoteMessaging( + tokenStream: () => tMockTokensController.stream, + ); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + const tToken = 'token'; + + final tTokenValues = [ + tToken, + ]; + + final tProxyTokenFuture = expectLater( + tProxyRemoteMessaging.tokens, + emitsInOrder(tTokenValues), + ); + + tMockTokensController.add(tToken); + + await tProxyTokenFuture; + }); + + test('Function listenChannel.', () async { + final tMockRemoteMessaging = MockRemoteMessaging(); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + const tChannel = 'channel'; + + expect(await tProxyRemoteMessaging.listenChannel(tChannel), true); + expect(await tProxyRemoteMessaging.listenChannel(tChannel), false); + }); + + test('Function ignoreChannel.', () async { + final tMockRemoteMessaging = MockRemoteMessaging(); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + const tChannel = 'channel'; + await tProxyRemoteMessaging.listenChannel(tChannel); + + expect(await tProxyRemoteMessaging.ignoreChannel(tChannel), true); + expect(await tProxyRemoteMessaging.ignoreChannel(tChannel), false); + }); + + test('Function dispose.', () async { + final tMockRemoteMessaging = MockRemoteMessaging(); + + final tProxyRemoteMessaging = ProxyRemoteMessaging(); + final tApp = createApp(); + await tProxyRemoteMessaging.init(tApp); + await tProxyRemoteMessaging.addRemoteMessaging(tMockRemoteMessaging); + + tProxyRemoteMessaging.dispose(); + + // ignore: invalid_use_of_protected_member + expect(tMockRemoteMessaging.hasListeners, false); + }); + }); +} diff --git a/packages/patapata_core/test/screen_layout_test.dart b/packages/patapata_core/test/screen_layout_test.dart new file mode 100644 index 0000000..5e98bf8 --- /dev/null +++ b/packages/patapata_core/test/screen_layout_test.dart @@ -0,0 +1,842 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:io'; +import 'dart:math' as math; +import 'dart:typed_data'; +import 'package:flutter/material.dart'; +import 'package:flutter_svg/svg.dart'; +import 'package:flutter_svg/flutter_svg.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:golden_toolkit/golden_toolkit.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; +import 'utils/patapata_core_test_utils.dart'; + +const String kGetScreenLayoutScaleButton = 'get-screen-layout-scale-button'; +const String kTapGestureDetector = 'tap-gesture-detector'; +const String kRedContainer = 'red-container'; +const String kBlueContainer = 'blue-container'; + +const _testDeviceSizes = [ + Size(375, 667), // iPhone6 + Size(414, 736), // iPhone6Plus + Size(375, 812), // iPhoneX + Size(414, 896), // iPhoneXS MAX + Size(768, 1024), // iPad Air + Size(1668, 2224), // iPad Pro (10.5inch) + Size(1668, 2388), //iPad Pro (11inch) + Size(2048, 2732), // iPad Pro (12.9inch) + Size(1920, 1080), // PC +]; + +late Uint8List _svgBytes; + +class _TestRow extends StatelessWidget { + const _TestRow({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + return Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.end, + children: [ + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + SizedBox( + width: 300, + height: 300, + child: ColoredBox( + color: Colors.deepOrange.shade100, + child: Center( + child: SvgPicture.memory( + _svgBytes, + width: 200, + height: 200, + ), + ), + ), + ), + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + ], + ); + } +} + +class _TestApp extends StatelessWidget { + const _TestApp({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + return const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: _TestScreenLayout(), + ), + ), + ), + ); + } +} + +class _TestScreenLayout extends StatelessWidget { + const _TestScreenLayout({ + Key? key, + this.name, + this.breakpoints, + this.disableScreenLayout = false, + }) : super(key: key); + + final String? name; + final ScreenLayoutBreakpoints? breakpoints; + final bool disableScreenLayout; + + @override + Widget build(BuildContext context) { + return ScreenLayout( + name: name, + breakpoints: breakpoints, + child: disableScreenLayout + ? const ScreenLayoutDisable(child: _TestRow()) + : const _TestRow(), + ); + } +} + +class _AngleChangeNotifier extends ChangeNotifier { + double _angle; + + _AngleChangeNotifier(this._angle); + + double get angle => _angle; + + void rotate() { + _angle -= 90; + if (_angle < 0) { + _angle = 360 - _angle; + } + notifyListeners(); + } +} + +class _TestTransformScreenLayout extends StatelessWidget { + const _TestTransformScreenLayout({ + Key? key, + this.disableScreenLayout = false, + required this.initialRotate, + }) : super(key: key); + + final bool disableScreenLayout; + final double initialRotate; + + Widget _getWidget(_AngleChangeNotifier angleNotifier) { + return Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.end, + children: [ + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + SizedBox( + width: 300, + height: 300, + child: ColoredBox( + color: Colors.deepOrange.shade100, + child: Center( + child: SvgPicture.memory( + _svgBytes, + width: 200, + height: 200, + ), + ), + ), + ), + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + ], + ), + Align( + alignment: Alignment.topRight, + child: GestureDetector( + onTap: () { + angleNotifier.rotate(); + }, + child: angleNotifier.angle == 90 + ? Container( + key: const ValueKey(kRedContainer), + width: 100, + height: 30, + color: Colors.redAccent, + ) + : Container( + key: const ValueKey(kBlueContainer), + width: 100, + height: 30, + color: Colors.blueAccent, + ), + ), + ), + ], + ); + } + + @override + Widget build(BuildContext context) { + return ChangeNotifierProvider( + create: (context) => _AngleChangeNotifier(initialRotate), + child: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: Consumer<_AngleChangeNotifier>( + builder: (context, angleNotifier, child) { + return ScreenLayout( + breakpoints: const ScreenLayoutBreakpoints( + portraitStandardBreakpoint: 375, + portraitConstrainedWidth: double.infinity, + landscapeStandardBreakpoint: 375, + landscapeConstrainedWidth: double.infinity, + maxScale: 1.2, + ), + child: Transform.rotate( + angle: angleNotifier.angle * (math.pi / 180), + child: disableScreenLayout + ? ScreenLayoutDisable( + child: _getWidget(angleNotifier), + ) + : _getWidget(angleNotifier), + ), + ); + }, + ), + ), + ), + ), + ), + ); + } +} + +class _ScreenLayoutEnvironment extends Environment + with ScreenLayoutEnvironment { + const _ScreenLayoutEnvironment(); + @override + Map get screenLayoutBreakpoints => { + 'testBreakPoints': const ScreenLayoutBreakpoints( + name: 'normal', + portraitStandardBreakpoint: 375.0, + portraitConstrainedWidth: double.infinity, + landscapeStandardBreakpoint: 375.0, + landscapeConstrainedWidth: double.infinity, + maxScale: 1.2, + ), + }; +} + +class _ScreenLayoutBreakpointsModel extends ChangeNotifier { + ScreenLayoutBreakpoints? _breakpoints = ScreenLayoutDefaultBreakpoints.normal; + + ScreenLayoutBreakpoints? get breakpoints => _breakpoints; + + void setBreakpoints(ScreenLayoutBreakpoints breakpoints) { + _breakpoints = breakpoints; + notifyListeners(); + } +} + +class _ScaleListenableBuilder extends StatelessWidget { + const _ScaleListenableBuilder({ + required this.tScaleNotifier, + }); + + final ValueNotifier tScaleNotifier; + + @override + Widget build(BuildContext context) { + return Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Builder( + builder: (context) => TextButton( + key: const ValueKey(kGetScreenLayoutScaleButton), + onPressed: () { + tScaleNotifier.value = context.screenLayoutScale; + }, + child: ValueListenableBuilder( + valueListenable: tScaleNotifier, + builder: (context, scale, child) => + Text("Test Data Scale : $scale"), + ), + ), + ), + Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.end, + children: [ + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + SizedBox( + width: 300, + height: 300, + child: ColoredBox( + color: Colors.deepOrange.shade100, + child: Center( + child: SvgPicture.memory( + _svgBytes, + width: 200, + height: 200, + ), + ), + ), + ), + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + ), + ), + ], + ), + ], + ); + } +} + +void main() { + setUp(() async { + File svgFile = File('test/assets/images/logo.svg'); + _svgBytes = await svgFile.readAsBytes(); + }); + + group('ScreenLayoutGoldenTests', () { + for (final size in _testDeviceSizes) { + testGoldens('Test ScreenLayout: $size', (WidgetTester tester) async { + await loadAppFonts(); + await tester.pumpWidgetBuilder(const _TestApp(), surfaceSize: size); + await screenMatchesGolden(tester, 'ScreenLayout_$size'); + }); + } + + testGoldens("ScreenLayoutAppStandardTest", (WidgetTester tester) async { + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[0]; + + final App tApp = createApp( + environment: const _ScreenLayoutEnvironment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: _TestScreenLayout( + name: 'testBreakPoints', + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_$tTestDeviceSize'); + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutAppFactoryMethodTest", + (WidgetTester tester) async { + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[0]; + + final App tApp = createApp( + environment: const _ScreenLayoutEnvironment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: ScreenLayout.named( + name: 'testBreakePoints', + child: const _TestRow(), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_$tTestDeviceSize'); + }); + + tApp.dispose(); + }); + + testGoldens('ScreenLayoutBreakPointCopyTest', (WidgetTester tester) async { + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[0]; + + const tBreakpoints = ScreenLayoutBreakpoints( + name: 'normal', + portraitStandardBreakpoint: 375.0, + portraitConstrainedWidth: 482, + landscapeStandardBreakpoint: 375.0, + landscapeConstrainedWidth: 482, + maxScale: 1.2, + ); + + final tModifiedBreakpoints = tBreakpoints.copyWith( + name: null, + maxScale: null, + ); + + final App tApp = createApp( + environment: const Environment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: _TestScreenLayout( + breakpoints: tModifiedBreakpoints, + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_BreakPoint_CopyTest'); + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutUpdateRotationTest", (WidgetTester tester) async { + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[0]; + + final App tApp = createApp( + environment: const Environment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: _TestScreenLayout(), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_$tTestDeviceSize'); + + tTestDeviceSize = Size(tTestDeviceSize.height, tTestDeviceSize.width); + + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_$tTestDeviceSize'); + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutUpdateBreakpointsTest", + (WidgetTester tester) async { + await loadAppFonts(); + + late _ScreenLayoutBreakpointsModel tProvider = + _ScreenLayoutBreakpointsModel(); + + final App tApp = createApp( + environment: const Environment(), + appWidget: ChangeNotifierProvider<_ScreenLayoutBreakpointsModel>( + create: (BuildContext context) { + return _ScreenLayoutBreakpointsModel(); + }, + child: Builder( + builder: (BuildContext context) { + tProvider = context.watch<_ScreenLayoutBreakpointsModel>(); + return MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: GestureDetector( + key: const ValueKey(kTapGestureDetector), + onTap: () => tProvider.setBreakpoints( + ScreenLayoutDefaultBreakpoints.large, + ), + child: _TestScreenLayout( + breakpoints: tProvider.breakpoints, + ), + ), + ), + ), + ), + ); + }, + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kTapGestureDetector))); + + for (final size in _testDeviceSizes) { + await setTestDeviceSize(tester, size); + + await screenMatchesGolden( + tester, 'ScreenLayout_ChangeBreakPoint_$size'); + } + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutDiableTest", (WidgetTester tester) async { + await loadAppFonts(); + + final App tApp = createApp( + environment: const Environment(), + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: _TestScreenLayout( + disableScreenLayout: true, + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + for (final size in _testDeviceSizes) { + await setTestDeviceSize(tester, size); + + await tester.pumpAndSettle(); + + await screenMatchesGolden(tester, 'ScreenLayout_Disable_$size'); + } + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutApplyPaintTransformTest", + (WidgetTester tester) async { + await loadAppFonts(); + var tTestDeviceSize = _testDeviceSizes[1]; + final App tApp = createApp( + environment: const Environment(), + appWidget: const _TestTransformScreenLayout(initialRotate: 90), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + expect(find.byKey(const ValueKey(kRedContainer)), findsOneWidget); + + await tester.tapAt(const Offset(40, 565)); + + await screenMatchesGolden( + tester, 'ScreenLayout_Transform_$tTestDeviceSize'); + + expect(find.byKey(const ValueKey(kBlueContainer)), findsOneWidget); + }); + + tApp.dispose(); + }); + + testGoldens("ScreenLayoutDisableApplyPaintTransformTest", + (WidgetTester tester) async { + await loadAppFonts(); + var tTestDeviceSize = _testDeviceSizes[1]; + final App tApp = createApp( + environment: const Environment(), + appWidget: const _TestTransformScreenLayout( + disableScreenLayout: true, + initialRotate: 90, + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + expect(find.byKey(const ValueKey(kRedContainer)), findsOneWidget); + + await tester.tapAt(const Offset(58, 567)); + + await screenMatchesGolden( + tester, 'ScreenLayout_Transform_Disable_$tTestDeviceSize'); + + expect(find.byKey(const ValueKey(kBlueContainer)), findsOneWidget); + }); + + tApp.dispose(); + }); + }); + + group('ScreenLayoutWidgetTests', () { + testWidgets("ScreenLayoutGetScreenLayoutScaleTest", + (WidgetTester tester) async { + final ValueNotifier tScaleNotifier = ValueNotifier(-1.0); + + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[4]; + + final App tApp = createApp( + environment: const Environment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: ScreenLayout( + child: _ScaleListenableBuilder( + tScaleNotifier: tScaleNotifier, + ), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kGetScreenLayoutScaleButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Data Scale : 1.2'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("ScreenLayoutDisableGetScreenLayoutScaleTest", + (WidgetTester tester) async { + final ValueNotifier tScaleNotifier = ValueNotifier(-1.0); + + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[4]; + + final App tApp = createApp( + environment: const Environment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: ScreenLayoutDisable( + child: _ScaleListenableBuilder( + tScaleNotifier: tScaleNotifier, + ), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kGetScreenLayoutScaleButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Data Scale : 1.0'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets('ScreenLayout ConstrainedWidth Zero', + (WidgetTester tester) async { + final ValueNotifier tScaleNotifier = ValueNotifier(-1.0); + + await loadAppFonts(); + + var tTestDeviceSize = _testDeviceSizes[4]; + + final App tApp = createApp( + environment: const Environment(), + appWidget: MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + backgroundColor: Colors.white, + body: SizedBox.expand( + child: Center( + child: ScreenLayout( + breakpoints: const ScreenLayoutBreakpoints( + name: 'normal', + portraitStandardBreakpoint: 375.0, + portraitConstrainedWidth: 0, + landscapeStandardBreakpoint: 375.0, + landscapeConstrainedWidth: 0, + maxScale: 1.2, + ), + child: _ScaleListenableBuilder( + tScaleNotifier: tScaleNotifier, + ), + ), + ), + ), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await setTestDeviceSize(tester, tTestDeviceSize); + + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kGetScreenLayoutScaleButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Data Scale : 1.0'), findsOneWidget); + }); + + tApp.dispose(); + }); + }); + + group('ScreenLayoutUnitTests', () { + test('Test for identical hash codes of ScreenLayoutBreakpoints', () { + final breakpoints1 = const ScreenLayoutBreakpoints( + name: 'Test Breakpoint', + portraitStandardBreakpoint: 600.0, + portraitConstrainedWidth: 800.0, + landscapeStandardBreakpoint: 900.0, + landscapeConstrainedWidth: 1200.0, + maxScale: 1.5, + ).hashCode; + + final breakpoints2 = const ScreenLayoutBreakpoints( + name: 'Test Breakpoint', + portraitStandardBreakpoint: 600.0, + portraitConstrainedWidth: 800.0, + landscapeStandardBreakpoint: 900.0, + landscapeConstrainedWidth: 1200.0, + maxScale: 1.5, + ).hashCode; + + expect(breakpoints1, breakpoints2); + }); + }); +} diff --git a/packages/patapata_core/test/sequential_work_queue_test.dart b/packages/patapata_core/test/sequential_work_queue_test.dart new file mode 100644 index 0000000..5fbf041 --- /dev/null +++ b/packages/patapata_core/test/sequential_work_queue_test.dart @@ -0,0 +1,1358 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/src/sequential_work_queue.dart'; + +void main() { + group('SequentialWorkQueue', () { + group('basics', () { + test('should execute work in order', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + }); + + tQueue.add(() { + tResults.add(2); + }); + + await tQueue.add(() async { + tResults.add(3); + }); + + expect(tResults, [1, 2, 3]); + }); + + test('should handle work that throws an error', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + }); + + expect(tQueue.add(() async { + throw Exception('Error'); + }), throwsA(isA())); + + expect(tQueue.add(() { + throw Exception('Error2'); + }), throwsA(isA())); + + await tQueue.add(() async { + tResults.add(3); + }); + + expect(tResults, [1, 3]); + }); + + test('should support cancelling work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await tQueue.add(() async { + tResults.add(1); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(2); + }); + + await tQueue.clear(); + + expect(tResults, [1]); + }); + + test('should execute onCancel callback when cancelling work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(1); + }, () { + tResults.add(0); + return true; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(2); + }); + + await tQueue.clear(); + + expect(tResults, [0]); + }); + + test('should not execute onCancel callback when not cancelling work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(2); + }, () { + tResults.add(0); + return false; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(3); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(4); + }, () { + tResults.add(1); + return false; + }); + + await tQueue.clear(); + + expect(tResults, [0, 1, 2, 4]); + }); + + test('should execute onCancel callback that returns a future', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(1); + }, () async { + tResults.add(0); + await Future.microtask(() => null); + return true; + }); + + tQueue.add(() async { + tResults.add(2); + }); + + await tQueue.clear(); + + expect(tResults, [0]); + }); + + test('should handle work that returns a value', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + int? tValue = await tQueue.add(() async { + tResults.add(1); + return 42; + }); + + expect(tValue, 42); + + tValue = await tQueue.add(() { + tResults.add(2); + return 43; + }); + + expect(tValue, 43); + expect(tResults, [1, 2]); + }); + + test('should handle work that returns a future', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + final tValue = await tQueue.add(() async { + tResults.add(1); + return await Future.microtask(() => 42); + }); + + expect(tResults, [1]); + expect(tValue, 42); + }); + + test('isEmpty should return true when empty', () async { + final tQueue = SequentialWorkQueue(); + + expect(tQueue.isEmpty, isTrue); + + tQueue.add(() async {}); + + expect(tQueue.isEmpty, isFalse); + + await tQueue.add(() async {}); + + expect(tQueue.isEmpty, isTrue); + }); + + test('isNotEmpty should return false when empty', () async { + final tQueue = SequentialWorkQueue(); + + expect(tQueue.isNotEmpty, isFalse); + + tQueue.add(() async {}); + + expect(tQueue.isNotEmpty, isTrue); + + await tQueue.add(() async {}); + + expect(tQueue.isNotEmpty, isFalse); + }); + + test('insideSequentialWorkQueue should return true when inside', + () async { + final tQueue = SequentialWorkQueue(); + + expect(tQueue.insideSequentialWorkQueue, isFalse); + + await tQueue.add(() async { + expect(tQueue.insideSequentialWorkQueue, isTrue); + }); + + expect(tQueue.insideSequentialWorkQueue, isFalse); + + final tFuture = tQueue.add(() async { + expect(tQueue.insideSequentialWorkQueue, isTrue); + }); + + expect(tQueue.insideSequentialWorkQueue, isFalse); + + await tFuture; + }); + + test('can use custom zones inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await tQueue.add(() async { + tResults.add(1); + + await runZonedGuarded( + () async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }, + (error, stackTrace) { + tResults.add(4); + }, + ); + + tResults.add(5); + }); + + expect(tResults, [1, 2, 3, 5]); + }); + + test('can use custom zones inside of work that throws an error', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + expect( + () async => await tQueue.add(() async { + tResults.add(1); + + final tFuture = runZoned(() async { + tResults.add(2); + await Future.microtask(() => null); + throw Exception('Error'); + }); + expect(tFuture, throwsA(isA())); + + await tFuture; + }), + throwsA(isA()), + ); + + expect(tResults, [1, 2]); + }); + + test( + 'can use custom zones and still cancel work. but the zone work should not be cancelled', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await runZonedGuarded( + () async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }, + (error, stackTrace) { + tResults.add(4); + }, + ); + + tResults.add(5); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(6); + }); + + await tQueue.clear(); + + expect(tResults, [1, 2, 3, 5]); + }); + }); + + group('microtasks', () { + test('should be able to create microtasks inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }); + + expect(tResults, [1, 2, 3, 4]); + }); + + test('should be able to create microtasks inside of work that throws', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await expectLater( + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + throw Exception('Error'); + }); + }), + throwsA(isA()), + ); + + expect(tResults, [1, 2]); + }); + + test('should be able to create microtasks, and then cancel work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2]); + }); + + test( + 'should be able to create microtasks in uncancelable work, and then attempt to cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }, () { + return false; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2, 3, 4]); + }); + + test( + 'should be able to create microtasks in future uncancellable work, and then attempt to cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }, () async { + return false; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2, 3, 4]); + }); + + test( + 'should be able to create microtasks in future cancellable work, and then cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }, () async { + return true; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2]); + }); + + test( + 'should be able to create microtasks in future cancellable work, and then cancel the work. Support errors', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + + throw Exception('Error'); + }); + }, () async { + return true; + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2]); + }); + + test( + 'should be able to create microtasks in future errored cancellable work, and then attempt to cancel the work', + () async { + runZonedGuarded(() async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() async { + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + tResults.add(4); + }, () async { + throw Exception('Error'); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 2, 3, 4]); + }, (error, stackTrace) { + expect(error, isA()); + }); + }); + + test( + 'should be able to create microtasks inside microtasks and they should be cancellable', + () async { + final tQueue = SequentialWorkQueue(); + final tShouldCall = expectAsync0(() => null, count: 4); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tValue = 0; + + expectLater( + tQueue.add(() async { + tShouldCall(); + Future.microtask(() async { + tShouldCall(); + // One tick + await Future.microtask(tShouldCall); + + tValue = 1; + + // Another tick + return Future.microtask(tShouldNotCall); + }).then((value) { + tShouldNotCall(); + }); + + tShouldCall(); + }), + completes, + ); + + // One tick + await Future.microtask(() => null); + + // Two tick + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tValue, 1); + }); + }); + }); + + group('timers', () { + test('should be able to create timers inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 1); + + await tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + await Future.microtask(() => null); + tShouldCall(); + }); + + tResults.add(2); + }); + + expect(tResults, [1, 2]); + }); + + test('should be able to create timers inside of work that throws', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldNotCall = expectAsync0(() => null, count: 0); + + runZonedGuarded(() async { + await expectLater( + tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + tResults.add(2); + await Future.microtask(() => null); + throw _TestException('SWQ Error'); + // ignore: dead_code + tShouldNotCall(); + }); + + return 1; + }), + completion(1), + ); + + expect(tResults, [1, 2]); + }, (error, stack) { + if (error is _TestException) { + expect(error.message, 'SWQ Error'); + } else { + Error.throwWithStackTrace(error, stack); + } + }); + }); + + test('should be able to create timers, and then cancel work', () async { + runZonedTimer( + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldNotCall = expectAsync0(() => null, count: 0); + + tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + tResults.add(2); + await Future.microtask(() => null); + tShouldNotCall(); + tResults.add(3); + }); + + tResults.add(4); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(5); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 4, 2]); + }, + ); + }); + + test( + 'should be able to create timers in uncancelable work, and then attempt to cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 1); + final tShouldNotCall = expectAsync0(() => null, count: 0); + + final tFuture = tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() => null); + + Timer.run(() async { + tShouldCall(); + tResults.add(2); + await Future.microtask(() => null); + tResults.add(3); + }); + + await Future.microtask(() => null); + + tResults.add(4); + }, () { + return false; + }); + + tQueue.add(() async { + tResults.add(5); + + Timer.run(() async { + tShouldNotCall(); + tResults.add(6); + await Future.microtask(() => null); + tResults.add(7); + }); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + // One more tick + await Future.microtask(() => null); + + await expectLater(tFuture, completes); + + await tQueue.clear(); + + expect(tResults, [1, 4, 2, 3, 5]); + }); + + test('can use custom zones inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await tQueue.add(() async { + tResults.add(1); + + await runZonedGuarded( + () async { + tResults.add(2); + Timer.run(() { + tResults.add(3); + }); + }, + (error, stackTrace) { + tResults.add(4); + }, + ); + + tResults.add(5); + }); + + expect(tResults, [1, 2, 5, 3]); + }); + + test('can use custom zones inside of work but not wait for async', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + await tQueue.add(() async { + tResults.add(1); + + await runZonedGuarded( + () async { + tResults.add(2); + Timer.run(() { + tResults.add(3); + }); + }, + (error, stackTrace) { + tResults.add(4); + }, + zoneValues: { + #sequentialWorkQueueNoWaitForAsync: true, + }, + ); + + tResults.add(5); + }); + + expect(tResults, [1, 2, 5]); + + await tQueue.clear(); + }); + + test('can use a future to cancel work', () async { + runZonedTimer(() async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 1); + final tShouldNotCall = expectAsync0(() => null, count: 0); + + tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + tShouldNotCall(); + tResults.add(2); + }); + + tResults.add(3); + }, () async { + tResults.add(4); + await Future.microtask(() => null); + tShouldCall(); + return true; + }); + + final tFuture = tQueue.clear(); + // Tick once to let the microtasks run. + await Future.microtask(() => null); + + await tFuture; + + expect(tResults, [1, 3, 4]); + }); + }); + + test('can use a future to not cancel work', () async { + runZonedTimer(() async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 2); + + tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + tShouldCall(); + tResults.add(2); + }); + + tResults.add(3); + }, () async { + tResults.add(4); + await Future.microtask(() => null); + tShouldCall(); + return false; + }); + + final tFuture = tQueue.clear(); + // Tick once to let the microtasks run. + await Future.microtask(() => null); + + await tFuture; + + expect(tResults, [1, 3, 4, 2]); + }); + }); + + test('can use a future to not cancel work with an error', () async { + final tShouldCall = expectAsync0(() => null, count: 4); + final tShouldNotCall = expectAsync0(() => null, count: 0); + + runZonedGuarded(() { + runZonedTimer(() async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + + tQueue.add(() async { + tResults.add(1); + + Timer.run(() async { + tShouldCall(); + throw _TestException('RealError'); + // ignore: dead_code + tResults.add(2); + }); + + tResults.add(3); + }, () async { + tShouldCall(); + tResults.add(4); + await Future.microtask(() => null); + throw _TestException('CancelError'); + // ignore: dead_code + tShouldNotCall(); + return true; + }); + + final tFuture = tQueue.clear(); + // Tick once to let the microtasks run. + await Future.microtask(() => null); + + await tFuture; + + expect(tResults, [1, 3, 4]); + }); + }, (error, stack) { + if (error is _TestException) { + tShouldCall(); + expect(error.message, anyOf('CancelError', 'RealError')); + } else { + Error.throwWithStackTrace(error, stack); + } + }); + }); + }); + + group('periodic timers', () { + test('should be able to create periodic timers inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 3); + int tCounter = 0; + + await runZonedTimer(() async { + await tQueue.add(() async { + tResults.add(1); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + await Future.microtask(() => null); + expect(timer.isActive, isTrue); + expect(timer.tick, isNonZero); + tResults.add(2); + + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + }); + + tResults.add(3); + }); + + expect(tResults, [1, 3, 2, 2, 2]); + }); + }); + + test('should be able to create periodic timers inside of work that throws', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 3); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tCounter = 0; + + runZonedGuarded(() async { + await runZonedTimer(() async { + await expectLater( + tQueue.add(() async { + tResults.add(1); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(2); + throw _TestException('SWQ Error'); + // ignore: dead_code + tShouldNotCall(); + }); + + return 1; + }), + completion(1), + ); + + expect(tResults, [1, 2, 2, 2]); + }); + }, (error, stack) { + if (error is _TestException) { + expect(error.message, 'SWQ Error'); + } else { + Error.throwWithStackTrace(error, stack); + } + }); + }); + + test('should be able to create periodic timers, and then cancel work', + () async { + await runZonedTimer( + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 1); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tCounter = 0; + + tQueue.add(() async { + tResults.add(1); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + tShouldNotCall(); + timer.cancel(); + } + tResults.add(2); + }); + + tResults.add(3); + }); + + tQueue.add(() async { + await Future.microtask(() => null); + tResults.add(4); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + await tQueue.clear(); + + expect(tResults, [1, 3, 2]); + }, + ); + }); + + test( + 'should be able to create periodic timers in uncancelable work, and then attempt to cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 3); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tCounter = 0; + + runZonedTimer(() async { + final tFuture = tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() => null); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(2); + }); + + tResults.add(3); + }, () { + return false; + }); + + tQueue.add(() async { + tResults.add(4); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldNotCall(); + tResults.add(5); + }); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + // One more tick + await Future.microtask(() => null); + + await expectLater(tFuture, completes); + + await tQueue.clear(); + + expect(tResults, [1, 3, 2, 2, 2, 4]); + }); + }); + + test( + 'should be able to create periodic timers in future uncancellable work, and then attempt to cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 3); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tCounter = 0; + + runZonedTimer(() async { + final tFuture = tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() => null); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(2); + }); + + tResults.add(3); + }, () async { + return false; + }); + + tQueue.add(() async { + tResults.add(4); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldNotCall(); + tResults.add(5); + }); + }); + + // Allow one tick to let the microtasks run. + await Future.microtask(() => null); + + // One more tick + await Future.microtask(() => null); + + await expectLater(tFuture, completes); + + await tQueue.clear(); + + expect(tResults, [1, 3, 2, 2, 2, 4]); + }); + }); + + test( + 'should be able to create periodic timers in future cancellable work, and then cancel the work', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 1); + final tShouldNotCall = expectAsync0(() => null, count: 0); + int tCounter = 0; + + await runZonedTimer(() async { + final tFuture = tQueue.add(() async { + tResults.add(1); + + await Future.microtask(() => null); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(2); + }); + + tResults.add(3); + }, () async { + return true; + }); + + tQueue.add(() async { + tResults.add(4); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldNotCall(); + tResults.add(5); + }); + }); + + // Allow two ticks to let the microtasks run. + await Future.microtask(() => null); + await Future.microtask(() => null); + + expectLater(tFuture, completes); + + await tQueue.clear(); + + expect(tResults, [1, 3, 2]); + }); + }); + + test( + 'should be able to create periodic timers in future cancellable work, and then cancel the work. Support errors', + () async { + final tShouldCall = expectAsync0(() => null, count: 5); + final tShouldNotCall = expectAsync0(() => null, count: 0); + + runZonedGuarded(() async { + await runZonedTimer(() async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + int tCounter = 0; + + tQueue.add(() async { + tResults.add(1); + + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(2); + }); + + tResults.add(3); + }, () async { + tShouldCall(); + tResults.add(4); + await Future.microtask(() => null); + throw _TestException('CancelError'); + // ignore: dead_code + tShouldNotCall(); + return true; + }); + + final tFuture = tQueue.clear(); + // Tick once to let the microtasks run. + await Future.microtask(() => null); + + await tFuture; + + expect(tResults, [1, 3, 4, 2, 2, 2]); + }); + }, (error, stack) { + if (error is _TestException) { + tShouldCall(); + expect(error.message, 'CancelError'); + } else { + Error.throwWithStackTrace(error, stack); + } + }); + }); + + test('can use custom zones inside of work', () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 3); + int tCounter = 0; + + runZonedTimer(() async { + await tQueue.add(() async { + tResults.add(1); + + runZoned( + () { + tResults.add(2); + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 3) { + timer.cancel(); + } + tResults.add(3); + }); + }, + ); + + tResults.add(5); + }); + + expect(tResults, [1, 2, 5, 3, 3, 3]); + }); + }); + + test('can use custom zones inside of work but not wait for async', + () async { + final tQueue = SequentialWorkQueue(); + final tResults = []; + final tShouldCall = expectAsync0(() => null, count: 10); + int tCounter = 0; + + runZonedTimer(() async { + await tQueue.add(() async { + tResults.add(1); + + runZoned( + () { + tResults.add(2); + Timer.periodic(const Duration(milliseconds: 1), (timer) async { + tShouldCall(); + tCounter++; + if (tCounter == 10) { + timer.cancel(); + } + tResults.add(3); + }); + }, + zoneValues: { + #sequentialWorkQueueNoWaitForAsync: true, + }, + ); + + tResults.add(5); + }); + + expect(tResults, [1, 2, 5, 3, 3, 3]); + }); + }); + }); +} + +T runZonedTimer(T Function() callback) { + return runZoned( + callback, + zoneSpecification: ZoneSpecification( + createTimer: (self, parent, zone, duration, f) { + // We want to execute asap. + // We aren't going to cancel any timers either. + Zone.root.scheduleMicrotask(f); + + return parent.createTimer(zone, duration, () {}); + }, + createPeriodicTimer: (self, parent, zone, period, f) { + // We want to execute asap. + final tTimer = _TestPeriodicTimer(); + + void fTick() { + tTimer._tick++; + f(tTimer); + + if (tTimer.isActive) { + Zone.root.scheduleMicrotask(() { + if (tTimer.isActive) { + fTick(); + } + }); + } + } + + Zone.root.scheduleMicrotask(() { + if (tTimer.isActive) { + fTick(); + } + }); + + return tTimer; + }, + ), + ); +} + +class _TestException implements Exception { + final String message; + + _TestException(this.message); + + @override + String toString() { + return message; + } +} + +class _TestPeriodicTimer implements Timer { + @override + void cancel() { + _isActive = false; + } + + bool _isActive = true; + + @override + bool get isActive => _isActive; + + int _tick = 0; + + @override + int get tick => _tick; +} diff --git a/packages/patapata_core/test/standard_app_logic_test.dart b/packages/patapata_core/test/standard_app_logic_test.dart new file mode 100644 index 0000000..d43c76e --- /dev/null +++ b/packages/patapata_core/test/standard_app_logic_test.dart @@ -0,0 +1,72 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('StandardPageFactory instantiation test.', () { + expect( + StandardPageWithResultFactory<_TestPageA, void, int>( + create: (data) => _TestPageA(), + ), + isInstanceOf>(), + ); + }); + + test('StandardPageFactory factory getter test.', () { + // void type check + var tFactory = StandardPageWithResultFactory<_TestPageA, void, int>( + create: (data) => _TestPageA(), + ); + + expect(tFactory.pageType, _TestPageA); + expect(tFactory.dataType, isA()); + expect(tFactory.dataTypeIsNonNullable, false); + expect(tFactory.resultType, int); + + // page data type check + tFactory = StandardPageWithResultFactory<_TestPageA, TestPageDataA, int>( + create: (data) => _TestPageA(), + ); + + expect(tFactory.pageType, _TestPageA); + expect(tFactory.dataType, TestPageDataA); + expect(tFactory.dataTypeIsNonNullable, true); + expect(tFactory.resultType, int); + }); +} + +class TestPageDataA { + final String test = 'test'; +} + +class _TestPageA extends StandardPageWithResult { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'title test page A'), + ), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text("test page A"); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_core/test/standard_app_widget_tab_test.dart b/packages/patapata_core/test/standard_app_widget_tab_test.dart new file mode 100644 index 0000000..8fc8a1f --- /dev/null +++ b/packages/patapata_core/test/standard_app_widget_tab_test.dart @@ -0,0 +1,863 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; +import 'utils/patapata_core_test_utils.dart'; + +const String _kTestGoSecondPageButton = 'test-go-second-page-button'; +const String _kTestGoHomePageButton = 'test-go-home-page-button'; +const String _kTestGoTitlePageButton = 'test-go-title-page-button'; +const String _kTestGoTitleDetailsPageButton = + 'test-go-title-details-page-button'; +const String _kTestGoMyPageButton = 'test-go-my-page-button'; +const String _kTestGoMyFavoritePageButton = 'test-go-myfavorite-page-button'; +const String _kTestStandardPageBackButton = 'standard-page-back-button'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + testWidgets("Standard Page Test, Child Page Instances (Standard Material)", + (WidgetTester tester) async { + // Standard Material Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory<_TestFirstPage, void>( + create: (data) => _TestFirstPage(), + ), + StandardPageFactory<_TestSecondPage, void>( + create: (data) => _TestSecondPage(), + ), + StandardPageFactory<_TestHomePage, void>( + create: (data) => _TestHomePage(), + ), + StandardPageFactory<_TestTitlePage, void>( + create: (data) => _TestTitlePage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestTitleDetailsPage, void>( + create: (data) => _TestTitleDetailsPage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestMyPage, void>( + create: (data) => _TestMyPage(), + ), + StandardPageFactory<_TestMyFavoritePage, void>( + create: (data) => _TestMyFavoritePage(), + parentPageType: _TestMyPage, + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show First Page + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + + // Show Second Page + await tester.tap(find.byKey(const ValueKey(_kTestGoSecondPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Second Page'), findsOneWidget); + + // Show Home Tab and Show Title Page + await tester.tap(find.byKey(const ValueKey(_kTestGoHomePageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + + // Show Title Details Page + await tester + .tap(find.byKey(const ValueKey(_kTestGoTitleDetailsPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + + // Show MyPage Tab and Show My Favorite Page + await tester.tap(find.byKey(const ValueKey(_kTestGoMyPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test MyFavorite Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Second Page'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Only Tab App", (WidgetTester tester) async { + // Standard Material Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory<_TestTitlePage, void>( + create: (data) => _TestTitlePage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestHomePage, void>( + create: (data) => _TestHomePage(), + ), + StandardPageFactory<_TestTitleDetailsPage, void>( + create: (data) => _TestTitleDetailsPage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestMyPage, void>( + create: (data) => _TestMyPage(), + ), + StandardPageFactory<_TestMyFavoritePage, void>( + create: (data) => _TestMyFavoritePage(), + parentPageType: _TestMyPage, + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show Home Tab and Show Title Page + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + + // Show Title Details Page + await tester + .tap(find.byKey(const ValueKey(_kTestGoTitleDetailsPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + + // Show MyPage Tab and Show My Favorite Page + await tester.tap(find.byKey(const ValueKey(_kTestGoMyPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test MyFavorite Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Will Pop Page Test", (WidgetTester tester) async { + // Standard Material Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + willPopPage: (route, result) { + return true; + }, + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory<_TestFirstPage, void>( + create: (data) => _TestFirstPage(), + ), + StandardPageFactory<_TestSecondPage, void>( + create: (data) => _TestSecondPage(), + ), + StandardPageFactory<_TestHomePage, void>( + create: (data) => _TestHomePage(), + ), + StandardPageFactory<_TestTitlePage, void>( + create: (data) => _TestTitlePage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestTitleDetailsPage, void>( + create: (data) => _TestTitleDetailsPage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestMyPage, void>( + create: (data) => _TestMyPage(), + ), + StandardPageFactory<_TestMyFavoritePage, void>( + create: (data) => _TestMyFavoritePage(), + parentPageType: _TestMyPage, + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show First Page + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + + // Show Second Page + await tester.tap(find.byKey(const ValueKey(_kTestGoSecondPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Second Page'), findsOneWidget); + + // Show Home Tab and Show Title Page + await tester.tap(find.byKey(const ValueKey(_kTestGoHomePageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + + // Show Title Details Page + await tester + .tap(find.byKey(const ValueKey(_kTestGoTitleDetailsPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + + // GO Back Before Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets( + "Standard Page Test, Child Page Instances (Go To Title Details Pages)", + (WidgetTester tester) async { + // Standard Material Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory<_TestFirstPage, void>( + create: (data) => _TestFirstPage(), + ), + StandardPageFactory<_TestHomePage, void>( + create: (data) => _TestHomePage(), + ), + StandardPageFactory<_TestTitlePage, void>( + create: (data) => _TestTitlePage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestTitleDetailsPage, void>( + create: (data) => _TestTitleDetailsPage(), + parentPageType: _TestHomePage, + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show First Page + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + + // Show Title Details Page + await tester + .tap(find.byKey(const ValueKey(_kTestGoTitleDetailsPageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Details Page'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets( + "Standard Page Test, Child Page Instances (Child page is set first parent page is set after)", + (WidgetTester tester) async { + // Standard Material Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory<_TestFirstPage, void>( + create: (data) => _TestFirstPage(), + ), + StandardPageFactory<_TestTitlePage, void>( + create: (data) => _TestTitlePage(), + parentPageType: _TestHomePage, + ), + StandardPageFactory<_TestHomePage, void>( + create: (data) => _TestHomePage(), + ), + StandardPageFactory<_TestMyFavoritePage, void>( + create: (data) => _TestMyFavoritePage(), + parentPageType: _TestMyPage, + ), + StandardPageFactory<_TestMyPage, void>( + create: (data) => _TestMyPage(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show First Page + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(_kTestGoHomePageButton))); + + // Show Home Tab + await tester.pumpAndSettle(); + + expect(find.text('Test Title Page'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Child Page Instances (Cupertino)", + (WidgetTester tester) async { + // Standard Cupertino Page Test + final App tApp = createApp( + environment: const Environment(), + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // add all pages that inherit from StandardPage here + // not tabs page + StandardPageFactory<_TestCupertinoFirstPage, void>( + create: (data) => _TestCupertinoFirstPage(), + ), + // tabs page + // Home + StandardPageFactory<_TestCupertinoHomePage, void>( + create: (data) => _TestCupertinoHomePage(), + ), + StandardPageFactory<_TestCupertinoTitlePage, void>( + create: (data) => _TestCupertinoTitlePage(), + parentPageType: _TestCupertinoHomePage, + ), + // MyPage + StandardPageFactory<_TestCupertinoMyPage, void>( + create: (data) => _TestCupertinoMyPage(), + ), + StandardPageFactory<_TestCupertinoMyFavoritePage, void>( + create: (data) => _TestCupertinoMyFavoritePage(), + parentPageType: _TestCupertinoMyPage, + ), + ], + routableBuilder: (context, child) { + return CupertinoTheme( + data: CupertinoTheme.of(context) + .copyWith(brightness: Brightness.light), + child: child!, + ); + }, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // Show First Page + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + + // Show Home Page + await tester.tap(find.byKey(const ValueKey(_kTestGoHomePageButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title Cupertino Page'), findsOneWidget); + + // Go Back First Page + await tester + .tap(find.byKey(const ValueKey(_kTestStandardPageBackButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test First Page'), findsOneWidget); + }); + + tApp.dispose(); + }); +} + +// Test Multi Tabs Material Page +class _TestFirstPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'Test First Page'), + ), + ), + body: ListView( + children: [ + TextButton( + key: const ValueKey(_kTestGoSecondPageButton), + child: const Text("Go to Second Page"), + onPressed: () { + context.go<_TestSecondPage, void>(null); + }, + ), + TextButton( + key: const ValueKey(_kTestGoHomePageButton), + child: const Text("Go to Test Home Page"), + onPressed: () { + context.go<_TestHomePage, void>(null); + }, + ), + TextButton( + key: const ValueKey(_kTestGoMyPageButton), + child: const Text("Go to Test My Page"), + onPressed: () { + context.go<_TestMyPage, void>(null); + }, + ), + TextButton( + key: const ValueKey(_kTestGoTitlePageButton), + child: const Text("Go to Title Page"), + onPressed: () { + context.go<_TestTitlePage, void>(null); + }, + ), + TextButton( + key: const ValueKey(_kTestGoTitleDetailsPageButton), + child: const Text("Go to Title Details Page"), + onPressed: () { + context.go<_TestTitleDetailsPage, void>(null); + }, + ), + TextButton( + key: const ValueKey(_kTestGoMyFavoritePageButton), + child: const Text("Go to MyFavorite Page"), + onPressed: () { + context.go<_TestMyFavoritePage, void>(null); + }, + ), + ], + ), + ); + } +} + +class _TestSecondPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'Test Second Page'), + ), + ), + body: ListView( + children: [ + TextButton( + key: const ValueKey(_kTestGoHomePageButton), + child: const Text("Go to Test Home Page"), + onPressed: () { + context.go<_TestHomePage, void>(null); + }, + ), + ], + ), + ); + } +} + +class _TestAppTab extends StatelessWidget { + const _TestAppTab({ + Key? key, + required this.body, + this.appBar, + }) : super(key: key); + + final Widget body; + final PreferredSizeWidget? appBar; + + @override + Widget build(BuildContext context) { + var tInterfacePage = + ModalRoute.of(context)!.settings as StandardPageInterface; + var tType = tInterfacePage.factoryObject.parentPageType; + int tIndex = 0; + if (tType == _TestHomePage) { + tIndex = 0; + } else if (tType == _TestMyPage) { + tIndex = 1; + } + + return Scaffold( + body: body, + appBar: appBar, + bottomNavigationBar: BottomNavigationBar( + onTap: (index) { + switch (index) { + case 0: + context.go<_TestHomePage, void>(null); + break; + case 1: + context.go<_TestMyPage, void>(null); + break; + default: + break; + } + }, + currentIndex: tIndex, + selectedItemColor: Colors.red, + items: const [ + BottomNavigationBarItem(icon: Icon(Icons.home), label: 'home'), + BottomNavigationBarItem(icon: Icon(Icons.favorite), label: 'mypage'), + ], + type: BottomNavigationBarType.fixed, + ), + ); + } +} + +class _TestHomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return childNavigator ?? const SizedBox.shrink(); + } +} + +class _TestTitlePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return _TestAppTab( + appBar: AppBar( + title: const Text("Test Title Page"), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton( + key: ValueKey(_kTestStandardPageBackButton), + ), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text( + "Title Page", + ); + }, + ), + ), + TextButton( + key: const ValueKey(_kTestGoTitleDetailsPageButton), + child: const Text("Go to Test Title Details Page"), + onPressed: () { + context.go<_TestTitleDetailsPage, void>(null); + }, + ), + ], + ), + ); + } +} + +class _TestTitleDetailsPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return _TestAppTab( + appBar: AppBar( + title: const Text("Title Details Page"), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton( + key: ValueKey(_kTestStandardPageBackButton), + ), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text( + "Test Title Details Page", + ); + }, + ), + ), + TextButton( + key: const ValueKey(_kTestGoMyPageButton), + child: const Text("Go to Test My Page"), + onPressed: () { + context.go<_TestMyPage, void>(null); + }, + ), + ], + ), + ); + } +} + +class _TestMyPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return childNavigator ?? const SizedBox.shrink(); + } +} + +class _TestMyFavoritePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return _TestAppTab( + appBar: AppBar( + title: const Text("MyFavorite Page"), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton( + key: ValueKey(_kTestStandardPageBackButton), + ), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text( + "Test MyFavorite Page", + ); + }, + ), + ), + ], + ), + ); + } +} + +// Test Multi Tabs Cupertino Page +class _TestCupertinoFirstPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoPageScaffold( + navigationBar: const CupertinoNavigationBar( + middle: Text('Test First Page'), + ), + child: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text( + l(context, 'plurals.test1', { + 'count': context + .select((v) => v.getInt('counter')) + }), + ); + }, + ), + ), + CupertinoButton( + key: const ValueKey(_kTestGoHomePageButton), + child: const Text("Go to Test Home Page"), + onPressed: () { + context.go<_TestCupertinoHomePage, void>(null); + }, + ), + CupertinoButton( + key: const ValueKey(_kTestGoTitlePageButton), + child: const Text("Go to Test Title Page"), + onPressed: () { + context.go<_TestCupertinoTitlePage, void>(null); + }, + ), + CupertinoButton( + key: const ValueKey(_kTestGoMyPageButton), + child: const Text("Go to Test My Page"), + onPressed: () { + context.go<_TestCupertinoMyPage, void>(null); + }, + ), + CupertinoButton( + key: const ValueKey(_kTestGoMyFavoritePageButton), + child: const Text("Go to Test MyFavorite Page"), + onPressed: () { + context.go<_TestCupertinoMyFavoritePage, void>(null); + }, + ), + ], + ), + ); + } +} + +class _TestCupertinoAppBar extends StatelessWidget { + const _TestCupertinoAppBar({ + Key? key, + required this.body, + this.appBar, + }) : super(key: key); + + final Widget body; + final Widget? appBar; + + @override + Widget build(BuildContext context) { + var tInterfacePage = + ModalRoute.of(context)!.settings as StandardPageInterface; + var tType = tInterfacePage.factoryObject.parentPageType; + int tIndex = 0; + if (tType == _TestCupertinoHomePage) { + tIndex = 0; + } else if (tType == _TestCupertinoMyPage) { + tIndex = 1; + } + + return CupertinoPageScaffold( + navigationBar: CupertinoNavigationBar( + leading: const StandardPageBackButton( + key: ValueKey(_kTestStandardPageBackButton), + ), + middle: tIndex == 0 ? const Text('Home Page') : const Text('My Page'), + ), + child: Column( + children: [ + Expanded( + child: body, + ), + Row( + mainAxisAlignment: MainAxisAlignment.spaceAround, + children: [ + CupertinoButton( + onPressed: () { + context.go<_TestCupertinoHomePage, void>(null); + }, + child: const Icon(CupertinoIcons.home), + ), + CupertinoButton( + onPressed: () { + context.go<_TestCupertinoMyFavoritePage, void>(null); + }, + child: const Icon(CupertinoIcons.heart), + ), + ], + ), + ], + ), + ); + } +} + +class _TestCupertinoHomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return childNavigator ?? const SizedBox.shrink(); + } +} + +class _TestCupertinoTitlePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return _TestCupertinoAppBar( + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text( + "Test Title Cupertino Page", + ); + }, + ), + ), + ], + ), + ); + } +} + +class _TestCupertinoMyPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return childNavigator ?? const SizedBox.shrink(); + } +} + +class _TestCupertinoMyFavoritePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return _TestCupertinoAppBar( + appBar: AppBar( + title: const Text("Test Title Cupertino Page"), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton( + key: ValueKey(_kTestStandardPageBackButton), + ), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text( + "Title Cupertino Page", + ); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_core/test/standard_app_widget_test.dart b/packages/patapata_core/test/standard_app_widget_test.dart new file mode 100644 index 0000000..96c3982 --- /dev/null +++ b/packages/patapata_core/test/standard_app_widget_test.dart @@ -0,0 +1,2167 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:provider/provider.dart'; +import 'utils/patapata_core_test_utils.dart'; +import 'utils/standard_app_widget_test_data.dart'; +import 'pages/startup_page.dart'; + +void main() { + testInitialize(); + + testWidgets("Standard Page Test, Pages added", (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageB(), + ), + StandardPageFactory( + create: (data) => TestPageA(), + ), + ]); + + await tester.pumpAndSettle(); + + // Keep currently active page. + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Pages removed", (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageB(), + ), + ]); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Pages removed in history", + (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + StandardPageFactory( + create: (data) => TestPageC(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kGoPageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + expect(find.text('Test Message C'), findsOneWidget); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageB(), + ), + StandardPageFactory( + create: (data) => TestPageC(), + ), + ]); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Pages swapped", (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageB(), + ), + ]); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Same pages (Not Update)", + (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.pumpAndSettle(); + + // If you do not transition to another page once, + // the array will not be entered in _pageInstances + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ]); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Reverse order pages (Update Pages)", + (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + // If you do not transition to another page once, + // the array will not be entered in _pageInstances + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageB(), + ), + StandardPageFactory( + create: (data) => TestPageA(), + ), + ]); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Test, Did update widgets", + (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // update widget using provider + tProvider.changeTitle('Change Test Title'); + tProvider.changePages( + [ + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ); + tProvider.changeRoutableBuilder((context, child) { + return child!; + }); + tProvider.changeWillPopPage((route, result) { + return false; + }); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + tApp.dispose(); + }); + + testWidgets("Standard Material App global Navigator Context Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Generate Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(StandardMaterialApp.globalNavigatorContext, isNotNull); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Cupertino Page Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Generate Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Context Go Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Generate Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + pageDataWhenNull: () => TestPageData(id: 0, data: 'test page data'), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kGetPageFactoryButton))); + + await tester.pumpAndSettle(); + + // Check Page Factory + expect(pageFactory, isNotNull); + expect(pageFactory, isA>()); + + // Go To Test Page B + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kCheckNavigatorButton))); + + await tester.pumpAndSettle(); + + // Check Navigator Data + expect(navigatorState, isNotNull); + expect(navigatorState, isA()); + expect(navigatorKey, isNotNull); + expect(navigatorKey, isA>()); + expect(navigatorContext, isNotNull); + + // Back Test Page + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + // Go To Test Page B (Router Delegate) + await tester.tap(find.byKey(const ValueKey(kGoToRouterDelegateButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page PageData Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Link Generate Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageC(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kGoPageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Link Data is 10'), findsOneWidget); + + // Press the transition button twice to test onRefocus + await tester.tap(find.byKey(const ValueKey(kGoPageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Link Data is 20'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Link Generator And Change PageData Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Link Generate Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageC(), + links: { + r'testPageData/(\d+)': (match, uri) => TestPageData( + data: 'test page data', + id: int.parse(match.group(1)!), + ), + }, + linkGenerator: (pageData) => 'testPageData/${pageData.id}', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kLinkButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + expect(find.text('Test Message C'), findsOneWidget); + expect(find.text('Test Link Data is 10'), findsOneWidget); + expect( + find.text('Test Generate Link is testPageData/10'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestChangePageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Link Data is 30'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Change Listenable PageData Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Change Listenable PageData Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageE(), + ), + ], + routableBuilder: (context, child) { + return MultiProvider( + providers: [ + ChangeNotifierProvider( + create: (context) => ChangeListenableBool(), + ), + ChangeNotifierProvider( + create: (context) => ChangeListenableNumber(), + ), + ], + child: child, + ); + }, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kGoChangeDataButton))); + + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kChangePageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Data Number : 100'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kChangePageDataButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Data Bool : true'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page PageData Test Before Ready", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageG(), + pageDataWhenNull: () => TestPageData( + data: 'test page data', + id: 76, + ), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('77 overridden test page data'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page On pop page", (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "Standard Page OnPopPage Test Title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + tProvider.changePages([ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ]); + tProvider.changeWillPopPage((route, result) => true); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + expect(find.text('Test Message'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + // here the provider made a change to return true + expect(find.text('Test Title B'), findsOneWidget); + expect(find.text('Test Message B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Custom Standard Page Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardCupertinoApp( + onGenerateTitle: (context) => "Custom Standard Page Test", + pages: [ + StandardPageFactory( + create: (data) => TestPageD(), + pageBuilder: ( + child, + name, + pageData, + pageKey, + restorationId, + standardPageKey, + factoryObject, + ) => + StandardCustomPage( + name: "Test Custom Standard Page", + arguments: TestPageData(id: 10, data: 'test-custom-test-data'), + key: const ValueKey("test-custom-key"), + restorationId: "custom-restorationId", + standardPageKey: standardPageKey, + factoryObject: factoryObject, + opaque: false, + barrierDismissible: true, + barrierColor: Colors.blueAccent, + child: Column( + children: [ + Expanded(child: child), + const Text("add-custom-standard-page-widget"), + ], + ), + transitionDuration: const Duration(milliseconds: 500), + transitionBuilder: + (context, animation, secondaryAnimation, child) { + return SlideTransition( + position: + Tween(begin: const Offset(0, 1), end: Offset.zero) + .animate(animation), + child: child, + ); + }, + ), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Page Id : 10'), findsOneWidget); + expect( + find.text('Test Page Data : test-custom-test-data'), findsOneWidget); + expect(find.text('Test Interface Name : Test Custom Standard Page'), + findsOneWidget); + expect(find.text('Test Interface RestorationId : custom-restorationId'), + findsOneWidget); + expect(find.text('add-custom-standard-page-widget'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page StandardPageNavigationMode Test", + (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageB(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageC(), + navigationMode: StandardPageNavigationMode.removeAll, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + // PageA -[moveToTop]-> PageB -> -[moveToTop]-> PageC -[removeAll] -> PageC + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + }); + + tApp.dispose(); + + // PageA -[moveToTop]-> PageB -> -[moveToTop]-> PageC -[replace] -> PageA + tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageB(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageC(), + navigationMode: StandardPageNavigationMode.replace, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + }); + + tApp.dispose(); + + // duplicate page key check (moveToTop) + LocalKey tLocalKey = const ValueKey("test-page-key"); + tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + navigationMode: StandardPageNavigationMode.moveToTop, + pageKey: (pageData) => tLocalKey, + ), + StandardPageFactory( + create: (data) => TestPageB(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageD(), + navigationMode: StandardPageNavigationMode.moveToTop, + pageKey: (pageData) => tLocalKey, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButtonSecond))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + }); + + tApp.dispose(); + + // duplicate page key check (replace) + tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + navigationMode: StandardPageNavigationMode.moveToTop, + pageKey: (pageData) => tLocalKey, + ), + StandardPageFactory( + create: (data) => TestPageB(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageD(), + navigationMode: StandardPageNavigationMode.replace, + pageKey: (pageData) => tLocalKey, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButtonSecond))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + }); + + tApp.dispose(); + + // duplicate page key check (removeAbove) + tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + navigationMode: StandardPageNavigationMode.moveToTop, + pageKey: (pageData) => tLocalKey, + ), + StandardPageFactory( + create: (data) => TestPageB(), + navigationMode: StandardPageNavigationMode.moveToTop, + ), + StandardPageFactory( + create: (data) => TestPageD(), + navigationMode: StandardPageNavigationMode.removeAbove, + pageKey: (pageData) => tLocalKey, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kTestButtonSecond))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Keep History Test", (WidgetTester tester) async { + late TestChangeNotifierData tProvider; + final App tApp = createApp( + appWidget: ChangeNotifierProvider( + create: (context) => TestChangeNotifierData( + title: "title", + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + keepHistory: false, + ), + StandardPageFactory( + create: (data) => TestPageB(), + keepHistory: false, + ), + ], + ), + child: Builder(builder: (context) { + tProvider = context.watch(); + + return StandardMaterialApp( + onGenerateTitle: (context) => tProvider.title, + pages: tProvider.pages, + routableBuilder: tProvider.routableBuilder, + willPopPage: tProvider.willPopPage, + ); + }), + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Group And GroupRoot Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Group And GroupRoot Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + group: 'test-group', + groupRoot: true, + ), + StandardPageFactory( + create: (data) => TestPageC(), + links: { + r'testPageData/(\d+)': (match, uri) => TestPageData( + data: 'test page data', + id: int.parse(match.group(1)!), + ), + }, + linkGenerator: (pageData) => 'testPageData/${pageData.id}', + group: 'test-group', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // Show Link Page + await tester.tap(find.byKey(const ValueKey(kLinkButton))); + + await tester.pumpAndSettle(); + + // Go Back TestPageB + await tester.tap(find.byKey(const ValueKey(kOnPopButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Analytics Event Test", + (WidgetTester tester) async { + testAnalytics = testAnalytics = TestAnalyticsEvent( + name: "test analytics", + data: {"data": 99999}, + ); + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Analytics Event Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Analytics Event Data : {data: 99999}'), findsOneWidget); + + testAnalytics = null; + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Remove Route Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Analytics Event Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + // Go To Next Test A2 Page + await tester.tap(find.byKey(const ValueKey(kTestButton))); + + await tester.pumpAndSettle(); + + // Remove Route Page + await tester.tap(find.byKey(const ValueKey(kRemoveRouteButton))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page App LinkHandler", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'App LinkHander Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + // add link handler + var tPlugin = tApp.getPlugin(); + tPlugin?.addLinkHandler(onLink); + + await tester.pumpAndSettle(); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(isLinkHander, isTrue); + expect(linkHanderUri, isNotNull); + expect(linkHanderUri!.path, equals('/')); + + // remove link handler + tPlugin?.removeLinkHandler(onLink); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Context StandardAppRouterContext Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StandardAppRouterContext Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kGetStandardAppRouterContext))); + + await tester.pumpAndSettle(); + + expect(buildContext, isNotNull); + expect(buildContext!.router, isNotNull); + expect(buildContext!.getPageFactory(), + isA>()); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page ProcessInitialRoute Test", + (WidgetTester tester) async { + Plugin tPlugin = TestDataPlugin(); + final App tApp = createApp( + plugins: [ + tPlugin, + ], + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'ProcessInitialRoute Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kProcessInitialRouteButton))); + + await tester.pumpAndSettle(); + + final tStandardRouteData = + await tApp.getPlugin()?.getInitialRouteData(); + + await tester.pumpAndSettle(); + + final tTestPageData = tStandardRouteData?.pageData as TestPageData; + + expect(tTestPageData, isNotNull); + expect(tTestPageData.id, 9999); + expect(tTestPageData.data, 'test plugin data'); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page ProcessInitialRoute Null Data Test", + (WidgetTester tester) async { + Plugin tPlugin = TestNullDataPlugin(); + final App tApp = createApp( + plugins: [ + tPlugin, + ], + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'ProcessInitialRoute Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester.tap(find.byKey(const ValueKey(kProcessInitialRouteButton))); + + await tester.pumpAndSettle(); + + final tStandardRouteData = + await tApp.getPlugin()!.getInitialRouteData(); + + await tester.pumpAndSettle(); + + expect(tStandardRouteData, isNull); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Default Route Test", (WidgetTester tester) async { + tester.binding.platformDispatcher.defaultRouteNameTestValue = '/testA'; + + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + links: { + r'testA': (match, uri) => TestPageData( + id: 9999, + data: 'test A', + ), + }, + linkGenerator: (pageData) => r'testA', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + tApp.getPlugin()!.delegate!.processInitialRoute(); + + await tester.pumpAndSettle(); + + expect(find.text('9999 test A'), findsOneWidget); + }); + + tApp.dispose(); + tester.binding.platformDispatcher.clearDefaultRouteNameTestValue(); + }); + + testWidgets("Standard Page Default Route Bad Links Test", + (WidgetTester tester) async { + tester.binding.platformDispatcher.defaultRouteNameTestValue = '/testA'; + + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + links: { + r'testA': (match, uri) => throw Exception('Bad Links Handler'), + }, + linkGenerator: (pageData) => r'testA', + ), + ], + ), + ); + + tApp.run(); + + bool tGotIt = false; + + final tSub = Logger.root.onRecord.listen((record) { + if (record.level == Level.INFO && + record.message == 'Exception during links callback' && + record.error is Exception && + record.error.toString() == 'Exception: Bad Links Handler') { + tGotIt = true; + } + }); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + tApp.getPlugin()!.delegate!.processInitialRoute(); + + await tester.pumpAndSettle(); + + expect(tGotIt, isTrue); + }); + + tApp.dispose(); + tester.binding.platformDispatcher.clearDefaultRouteNameTestValue(); + tSub.cancel(); + }); + + testWidgets("Standard Page OS Extra Route Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + links: { + r'testA': (match, uri) => TestPageData( + id: 9999, + data: 'test A', + ), + }, + linkGenerator: (pageData) => r'testA', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + tApp.getPlugin()!.delegate!.processInitialRoute(); + + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + // https://github.com/flutter/flutter/blob/master/packages/flutter/test/widgets/router_test.dart#L815C14-L815C14 + await tester.binding.defaultBinaryMessenger.handlePlatformMessage( + SystemChannels.navigation.name, + const JSONMethodCodec().encodeMethodCall( + const MethodCall('pushRoute', '/testA'), + ), + (_) {}, + ); + await tester.pump(); + + await tester.pumpAndSettle(); + + expect(find.text('9999 test A'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Plugin Route Test", (WidgetTester tester) async { + final App tApp = createApp( + plugins: [ + TestDataParseRouteInformationPlugin(), + ], + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + ) + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + tApp.getPlugin()!.delegate!.processInitialRoute(); + + await tester.pumpAndSettle(); + + expect(find.text('70 parsed route'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("Standard Page Bad Link Handler Test", + (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageF(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + ) + ], + ), + ); + + tApp.run(); + + bool tGotIt = false; + + final tSub = Logger.root.onRecord.listen((record) { + if (record.level == Level.SEVERE && + record.message == 'Error while handling link' && + record.error is Exception && + record.error.toString() == 'Exception: Bad Link') { + tGotIt = true; + } + }); + + tApp.getPlugin()!.addLinkHandler((link) { + throw Exception('Bad Link'); + }); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(find.text('Test Message F'), findsOneWidget); + + tApp.getPlugin()!.delegate!.processInitialRoute(); + + expect(tGotIt, isTrue); + + await tester.pumpAndSettle(); + }); + + tApp.dispose(); + tSub.cancel(); + }); + + testWidgets("Standard Page App Route Test", (WidgetTester tester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Group And Route Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageC(), + links: { + r'testPageData/(\d+)': (match, uri) => TestPageData( + data: 'test page data', + id: int.parse(match.group(1)!), + ), + }, + linkGenerator: (pageData) => 'testPageData/${pageData.id}', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + await tester + .tap(find.byKey(const ValueKey(kGetStandardAppPluginGenerateLink))); + + await tester.pumpAndSettle(); + + expect( + find.text('generateLink testText testPageData/9999'), findsOneWidget); + + // Show Link Page + await tester.tap(find.byKey(const ValueKey(kGetStandardAppPluginRoute))); + + await tester.pumpAndSettle(); + + expect(find.text('Test Title C'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("StandardAppPlugin with StartupNavigatorMixin Test", + (WidgetTester tester) async { + tester.binding.platformDispatcher.defaultRouteNameTestValue = '/testA'; + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupNavigatorMixin Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestPageH(), + links: { + r'testA': (match, uri) => TestPageData( + id: 9999, + data: 'test A', + ), + }, + linkGenerator: (pageData) => r'testA', + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + final tCompleter = Completer(); + + tApp.getPlugin()?.startupNavigateToPage(StartupPageA, + (result) { + tCompleter.complete(result as bool); + }); + + await tester.pumpAndSettle(); + + await tester.tap(find.text('Complete')); + + final tResult = await tCompleter.future; + + expect(tResult, true); + + tApp.getPlugin()?.startupProcessInitialRoute(); + + await tester.pumpAndSettle(); + + expect(find.text('9999 test A'), findsOneWidget); + + tApp.getPlugin()?.startupOnReset(); + + await tester.pumpAndSettle(); + + expect(find.text('SplashPage'), findsOneWidget); + }); + + tApp.dispose(); + tester.binding.platformDispatcher.clearDefaultRouteNameTestValue(); + }); + + // Test the results system + testWidgets( + 'You can navigate to a StandardPageWithResult and get the result values', + (widgetTester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageContextGoWithResult(), + ), + StandardPageWithResultFactory( + create: (data) => TestPageWithResult(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + // Navigate to the page with results + await widgetTester.tap(find.byKey(const ValueKey(kTestButton))); + + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageWithResult'), findsOneWidget); + + // Tap the button to return the result + await widgetTester.tap(find.byKey(const ValueKey(kTestButton))); + + await widgetTester.pumpAndSettle(); + + // Check that the result is correct + expect(find.text('TestPageContextGoWithResult'), findsOneWidget); + expect(find.text('pageResult'), findsOneWidget); + + // Navigate to the page with results + await widgetTester.tap(find.byKey(const ValueKey(kTestButton))); + + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageWithResult'), findsOneWidget); + + // Tap the button to return the result + await widgetTester.tap(find.byKey(const ValueKey(kTestButtonSecond))); + + await widgetTester.pumpAndSettle(); + + // Check that the result is correct + expect(find.text('TestPageContextGoWithResult'), findsOneWidget); + expect(find.text('popResult'), findsOneWidget); + }); + + tApp.dispose(); + }); + + // Test the StandardAppApp extension on App + testWidgets('StandardAppApp extension on App', (widgetTester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageContextGoWithResult(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + StandardPageWithResultFactory( + create: (data) => TestPageWithResult(), + links: { + r'results': (match, uri) {}, + }, + linkGenerator: (pageData) => 'results', + ), + StandardPageFactory( + create: (data) => TestPageB(), + links: { + r'b': (match, uri) {}, + }, + linkGenerator: (pageData) => 'b', + ), + StandardPageFactory( + create: (data) => TestPageRemoveRoute(), + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + final tApp = getApp(); + + expect(tApp.navigator, isNotNull); + expect(tApp.navigatorContext, isNotNull); + expect(find.text('TestPageContextGoWithResult'), findsOneWidget); + + String? tResult; + + tApp.goWithResult(null).then((value) { + tResult = value; + }); + + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageWithResult'), findsOneWidget); + + // Tap the button to return the result + await widgetTester.tap(find.byKey(const ValueKey(kTestButton))); + + await widgetTester.pumpAndSettle(); + + // Check that the result is correct + expect(find.text('TestPageContextGoWithResult'), findsOneWidget); + expect(tResult, 'pageResult'); + + tApp.go(null); + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + tApp.route('results'); + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageWithResult'), findsOneWidget); + + tApp.removeRoute(); + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + + expect( + tApp.generateLinkWithResult(null), + 'results'); + expect(tApp.generateLink(null), 'b'); + + tApp.go(null); + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageRemoveRoute'), findsOneWidget); + + await widgetTester.tap(find.byKey(const ValueKey(kTestButton))); + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets('You can access navigation APIs from routableBuilder', + (widgetTester) async { + final tCompleter = Completer(); + bool tInited = false; + BuildContext? tContext; + + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageRemoveRoute(), + ), + ], + routableBuilder: (context, child) { + tContext = context; + + if (!tInited) { + tInited = true; + + Future.microtask(() async { + tContext!.go(null); + + await widgetTester.pumpAndSettle(); + + expect(find.text('TestPageRemoveRoute'), findsOneWidget); + + tCompleter.complete(); + }); + } + + return child!; + }, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + await tCompleter.future; + }); + + tApp.dispose(); + }); + + testWidgets('You can wrap the contents of a StandardPage with a Plugin', + (widgetTester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + ], + ), + plugins: [ + StandardPagePluginMixin.inline( + buildPage: (context, child) => Stack( + children: [ + child, + const Text('StandardPagePluginMixin'), + ], + ), + ), + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + expect(find.text('StandardPagePluginMixin'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets('You can override the initial route with a Plugin', + (widgetTester) async { + final tPageBFactory = StandardPageFactory( + create: (data) => TestPageB(), + ); + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + tPageBFactory, + ], + ), + plugins: [ + StandardAppRoutePluginMixin.inline( + getInitialRouteData: () => Future.value( + StandardRouteData( + factory: tPageBFactory, + pageData: null, + ), + ), + ), + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + tApp.standardAppPlugin.delegate!.processInitialRoute(); + + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets('You can override route parsing with a Plugin', + (widgetTester) async { + final tPageBFactory = StandardPageFactory( + create: (data) => TestPageB(), + ); + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + tPageBFactory, + ], + ), + plugins: [ + StandardAppRoutePluginMixin.inline( + parseRouteInformation: (routeInformation) => Future.value( + StandardRouteData( + factory: tPageBFactory, + pageData: null, + ), + ), + ), + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + tApp.standardAppPlugin.delegate!.processInitialRoute(); + + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets('You can transform a route with a Plugin', (widgetTester) async { + final App tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'Test Title', + pages: [ + StandardPageFactory( + create: (data) => TestPageA(), + ), + StandardPageFactory( + create: (data) => TestPageB(), + links: { + r'testB': (match, uri) {}, + }, + linkGenerator: (pageData) => 'testB', + ), + ], + ), + plugins: [ + StandardAppRoutePluginMixin.inline( + transformRouteInformation: (routeInformation) => Future.value( + RouteInformation(uri: Uri(path: '/testB')), + ), + ), + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await widgetTester.pumpAndSettle(); + + tApp.standardAppPlugin.delegate!.processInitialRoute(); + + await widgetTester.pumpAndSettle(); + + expect(find.text('Test Title B'), findsOneWidget); + }); + + tApp.dispose(); + }); +} diff --git a/packages/patapata_core/test/startup_test.dart b/packages/patapata_core/test/startup_test.dart new file mode 100644 index 0000000..e71775d --- /dev/null +++ b/packages/patapata_core/test/startup_test.dart @@ -0,0 +1,1233 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'utils/patapata_core_test_utils.dart'; +import 'pages/startup_page.dart'; + +void main() { + test('StartupNavigatorMixin blank test', () async { + final tPlugin = TestBlankNavigatorPlugin(); + + // No exceptions thrown + tPlugin.startupNavigateToPage(Object, (result) {}); + tPlugin.startupOnReset(); + tPlugin.startupProcessInitialRoute(); + }); + + test('StartupNavigatorMixin test', () async { + final tPlugin = TestNavigatorPlugin(); + + bool tNavigateResult = false; + tPlugin.startupNavigateToPage(StartupPageA, (result) { + tNavigateResult = result as bool; + }); + tPlugin.startupOnReset(); + tPlugin.startupProcessInitialRoute(); + + expect(tPlugin.startupNavigateToPageCalled, true); + expect(tPlugin.navigatedPage, StartupPageA); + expect(tPlugin.startupProcessInitialRouteCalled, true); + expect(tPlugin.startupOnResetCalled, true); + expect(tNavigateResult, true); + }); + + testWidgets("StartupSequence test", (WidgetTester tester) async { + StateA? tStateA; + StateB? tStateB; + StateC? tStateC; + StateD? tStateD; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StartupPageFactory( + create: (data) => StartupPageB(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + waitSplashScreenDuration: const Duration(milliseconds: 2000), + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => tStateA = StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tStateB = StateB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tStateC = StateC(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tStateD = StateD(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + expect(tStateA?.processed, true); + expect(tStateB?.processed, null); + expect(tStateC?.processed, null); + expect(tStateD?.processed, null); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('SplashPage'), findsOneWidget); + expect(tStateB?.processed, true); + expect(tStateB?.navigateResult, false); + expect(tStateB?.pageResult, false); + expect(tStateC?.processed, null); + expect(tStateD?.processed, null); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tStateB?.navigateResult, false); + expect(tStateB?.pageResult, false); + expect(tStateC?.processed, null); + expect(tStateD?.processed, null); + + await tester.tap(find.text('Complete')); + expect(tStateB?.pageResult, true); + + await tester.pumpAndSettle(); + expect(find.text('StartupPageB'), findsOneWidget); + expect(tStateB?.navigateResult, true); + expect(tStateC?.processed, true); + expect(tStateC?.navigateResult, false); + expect(tStateC?.pageResult, false); + + await tester.tap(find.text('Complete')); + expect(tStateC?.pageResult, true); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('HomePage'), findsOneWidget); + expect(tStateD?.processed, true); + expect(tStateC?.navigateResult, true); + }); + + tApp.dispose(); + }); + + testWidgets("waitForComplete and onSuccess test", + (WidgetTester tester) async { + bool tOnSuccess = false; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [], + ), + ], + onSuccess: () => tOnSuccess = true, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + final tWaitForComplete = Completer(); + tApp.startupSequence! + .waitForComplete() + .then((value) => tWaitForComplete.complete()); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + + await tWaitForComplete.future; + + await tester.pumpAndSettle(); + expect(find.text('HomePage'), findsOneWidget); + + // Already Complete. To achieve 100% test coverage. + expect(tApp.startupSequence?.waitForComplete().runtimeType, + SynchronousFuture); + + expect(tOnSuccess, true); + }); + + tApp.dispose(); + }); + + testWidgets("resetMachine test", (WidgetTester tester) async { + StateA? tStateA; + StateB? tStateB; + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => tStateA = StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tStateB = StateB(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tStateA?.processed, true); + expect(tStateB?.processed, true); + expect(tStateB?.navigateResult, false); + expect(tStateB?.pageResult, false); + + final tOldStateA = tStateA; + final tOldStateB = tStateB; + await tester.tap(find.text('Reset')); + + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + expect(tStateA.hashCode, isNot(tOldStateA.hashCode)); + expect(tOldStateB?.navigateResult, false); + expect(tOldStateB?.pageResult, false); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tStateA?.processed, true); + expect(tStateB?.processed, true); + expect(tStateB?.navigateResult, false); + expect(tStateB?.pageResult, false); + expect(tStateB.hashCode, isNot(tOldStateB.hashCode)); + + await tester.tap(find.text('Complete')); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('HomePage'), findsOneWidget); + + expect(tStateB?.navigateResult, true); + expect(tStateB?.pageResult, true); + }); + + tApp.dispose(); + }); + + testWidgets("error from logger test", (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateXB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateC(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + Object? tError; + StreamSubscription tLogLester = + tApp.log.reports.listen((event) { + tError = event.error; + }); + + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsNothing); + + expect(tApp.startupSequence?.error?.error, 'StateXB'); + expect(tError, 'StateXB'); + + tLogLester.cancel(); + }); + + tApp.dispose(); + }); + + testWidgets("waitForComplete cacheError test", (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateXB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateC(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + final tWaitForComplete = Completer(); + tApp.startupSequence!.waitForComplete().catchError((error, stackTrace) { + tWaitForComplete.completeError(error, stackTrace); + }); + + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsNothing); + + expect( + () => tWaitForComplete.future, + throwsA('StateXB'), + ); + + expect(tApp.startupSequence?.error?.error, 'StateXB'); + + // Already Complete. To achieve 100% test coverage. + expect( + () => tApp.startupSequence?.waitForComplete(), + throwsA('StateXB'), + ); + }); + + tApp.dispose(); + }); + + testWidgets("onError test", (WidgetTester tester) async { + Object? tError; + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateXB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateC(startupSequence), + [], + ), + ], + onError: (error, stackTrace) { + tError = error; + }, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + Object? tErrorFromLogger; + StreamSubscription tLogLester = + tApp.log.reports.listen((event) { + tErrorFromLogger = event.error; + }); + + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsNothing); + + expect(tError, 'StateXB'); + expect(tErrorFromLogger, null); + + tLogLester.cancel(); + }); + + tApp.dispose(); + }); + + testWidgets("error resetMachine test", (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateXB(startupSequence), + [], + ), + ], + onError: (e, stackTrace) { + // To avoid extra logging. Already tested. + }, + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + + final tError = tApp.startupSequence!.error!; + expect(tError.error, 'StateXB'); + + tApp.startupSequence!.resetMachine(); + + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + expect(tApp.startupSequence!.error, null); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + + expect(tApp.startupSequence!.error!.error, 'StateXB'); + expect(tApp.startupSequence!.error, isNot(tError)); + }); + + tApp.dispose(); + }); + + testWidgets("navigateToPage throw LogicStateNotCurrent test", + (WidgetTester tester) async { + StateB? tStateB; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StartupPageFactory( + create: (data) => StartupPageB(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tStateB = StateB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StateC(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + await tester.tap(find.text('Complete')); + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + + expect( + () => tStateB!.navigateToPage(StartupPageA, (result) {}), + throwsA(isA()), + ); + }); + + tApp.dispose(); + }); + + testWidgets("resetMachine with splash timer active", + (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + waitSplashScreenDuration: const Duration(milliseconds: 2000), + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateA(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + + tApp.startupSequence!.resetMachine(); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("State is reset during process", (WidgetTester tester) async { + StateDelayed2000ms? tState; + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + waitSplashScreenDuration: const Duration(milliseconds: 16), + startupStateFactories: [ + StartupStateFactory( + (startupSequence) { + final tS = StateDelayed2000ms(startupSequence); + tState ??= tS; + return tS; + }, + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(const Duration(milliseconds: 20)); + + tApp.startupSequence!.resetMachine(); + + expect(() => tState!.onComplete, throwsA(isA())); + + await tester.pumpAndSettle(const Duration(milliseconds: 2000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("complete before process completion", + (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StateCompleteBeforeProcess(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(const Duration(milliseconds: 3000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("completeError before process completion", + (WidgetTester tester) async { + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => + StateCompleteErrorBeforeProcess(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(const Duration(milliseconds: 3000)); + + expect(() => tApp.startupSequence!.waitForComplete(), + throwsA(isA())); + expect(tApp.startupSequence!.error?.error, + 'StateCompleteErrorBeforeProcess'); + }); + + tApp.dispose(); + }); + + testWidgets("back state test", (WidgetTester tester) async { + StateC? tFirstStateC; + StartupState? tCurrentState; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StartupPageFactory( + create: (data) => StartupPageB(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => tCurrentState = StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tCurrentState = StateB(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) { + final tState = StateC(startupSequence); + tFirstStateC ??= tState; + return tCurrentState = tState; + }, + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => tCurrentState = StateD(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + await tester.tap(find.text('Complete')); + + await tester.pumpAndSettle(); + expect(find.text('StartupPageB'), findsOneWidget); + expect(tCurrentState, isA()); + + await tester.tap(find.byType(BackButton)); + await tester.pumpAndSettle(); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tFirstStateC?.processed, true); + expect(tFirstStateC?.navigateResult, false); + expect(tFirstStateC?.pageResult, false); + + await tester.tap(find.text('Complete')); + + await tester.pumpAndSettle(); + expect(find.text('StartupPageB'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tCurrentState, isNot(tFirstStateC)); + + await tester.tap(find.text('Complete')); + expect(tCurrentState, isA()); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("back state test. remove route", (WidgetTester tester) async { + StateB? tFirstStateB; + StartupState? tCurrentState; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => tCurrentState = StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) { + final tState = StateB(startupSequence); + tFirstStateB ??= tState; + return tCurrentState = tState; + }, + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => + tCurrentState = StateDelayed2000ms(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tCurrentState, isA()); + + await tester.tap(find.text('PushModalA')); + await tester.pumpAndSettle(); + expect(find.text('StartupModalPageA'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tFirstStateB?.processed, true); + expect(tFirstStateB?.navigateResult, false); + expect(tFirstStateB?.pageResult, false); + + await tester.tap(find.text('CompleteAndPushModaB')); + await tester.pumpAndSettle(); + expect(tCurrentState, isA()); + expect(tFirstStateB?.navigateResult, true); + expect(tFirstStateB?.pageResult, true); + expect(find.text('StartupModalPageB'), findsOneWidget); + + await tester.tap(find.text('Remove')); + await tester.pumpAndSettle(); + expect(find.text('StartupModalPageA'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tCurrentState, isNot(tFirstStateB)); + + final tTemp = tCurrentState; + await tester.tap(find.text('Remove')); + await tester.pumpAndSettle(); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tCurrentState, equals(tTemp)); + expect(tCurrentState, isNot(tFirstStateB)); + + await tester.tap(find.text('Complete')); + expect(tCurrentState, isA()); + + await tester.pumpAndSettle(const Duration(milliseconds: 2000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); + + testWidgets("back state test. replace route", (WidgetTester tester) async { + StateB? tFirstStateB; + StartupState? tCurrentState; + + final tApp = createApp( + appWidget: StandardMaterialApp( + onGenerateTitle: (context) => 'StartupSequence Test Title', + pages: [ + SplashPageFactory( + create: (data) => SplashPage(), + ), + StartupPageFactory( + create: (data) => StartupPageA(), + ), + StandardPageFactory( + create: (data) => TestHomePage(), + links: { + r'': (match, uri) => TestHomePage(), + }, + linkGenerator: (pageData) => r'', + ), + ], + ), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => tCurrentState = StateA(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) { + final tState = StateB(startupSequence); + tFirstStateB ??= tState; + return tCurrentState = tState; + }, + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => + tCurrentState = StateDelayed2000ms(startupSequence), + [], + ), + ], + ), + ); + + tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + expect(find.text('SplashPage'), findsOneWidget); + + await tester.pumpAndSettle(const Duration(milliseconds: 1000)); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tCurrentState, isA()); + + await tester.tap(find.text('PushModalA')); + await tester.pumpAndSettle(); + expect(find.text('StartupModalPageA'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tFirstStateB?.processed, true); + expect(tFirstStateB?.navigateResult, false); + expect(tFirstStateB?.pageResult, false); + + await tester.tap(find.text('ReplaceAtoB')); + await tester.pumpAndSettle(); + expect(find.text('StartupModalPageB'), findsOneWidget); + + await tester.tap(find.text('CompleteAndPushModaC')); + await tester.pumpAndSettle(); + expect(tCurrentState, isA()); + expect(tFirstStateB?.navigateResult, true); + expect(tFirstStateB?.pageResult, true); + expect(find.text('StartupModalPageC'), findsOneWidget); + + await tester.tap(find.text('Remove')); + await tester.pumpAndSettle(); + expect(find.text('StartupModalPageB'), findsOneWidget); + expect(tCurrentState, isA()); + expect(tCurrentState, isNot(tFirstStateB)); + + final tTemp = tCurrentState; + await tester.tap(find.text('Remove')); + await tester.pumpAndSettle(); + expect(find.text('StartupPageA'), findsOneWidget); + expect(tCurrentState, equals(tTemp)); + expect(tCurrentState, isNot(tFirstStateB)); + + await tester.tap(find.text('Complete')); + expect(tCurrentState, isA()); + + await tester.pumpAndSettle(const Duration(milliseconds: 2000)); + expect(find.text('HomePage'), findsOneWidget); + }); + + tApp.dispose(); + }); +} + +class StateA extends StartupState { + StateA(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + return await Future.delayed(const Duration(milliseconds: 500)); + } +} + +class StateB extends StartupState { + StateB(super.startupSequence); + + bool processed = false; + bool pageResult = false; + bool navigateResult = false; + + @override + Future process(Object? data) async { + processed = true; + navigateResult = await navigateToPage(StartupPageA, (result) { + pageResult = result as bool; + }); + } +} + +class StateXB extends StartupState { + StateXB(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + throw 'StateXB'; + } +} + +class StateC extends StartupState { + StateC(super.startupSequence); + + bool processed = false; + bool pageResult = false; + bool navigateResult = false; + + @override + Future process(Object? data) async { + processed = true; + navigateResult = await navigateToPage(StartupPageB, (result) { + pageResult = result as bool; + }); + } +} + +class StateD extends StartupState { + StateD(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + } +} + +class StateDelayed2000ms extends StartupState { + StateDelayed2000ms(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + return await Future.delayed(const Duration(milliseconds: 2000)); + } +} + +class StateCompleteBeforeProcess extends StartupState { + StateCompleteBeforeProcess(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + complete(); + return await Future.delayed(const Duration(milliseconds: 2000)); + } +} + +class StateCompleteErrorBeforeProcess extends StartupState { + StateCompleteErrorBeforeProcess(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + completeError('StateCompleteErrorBeforeProcess'); + return await Future.delayed(const Duration(milliseconds: 2000)); + } +} + +class StateResetMachine extends StartupState { + StateResetMachine(super.startupSequence); + + bool processed = false; + + @override + Future process(Object? data) async { + processed = true; + startupSequence.resetMachine(); + } +} + +class TestBlankNavigatorPlugin extends Plugin with StartupNavigatorMixin {} + +class TestNavigatorPlugin extends Plugin with StartupNavigatorMixin { + Object? navigatedPage; + bool startupNavigateToPageCalled = false; + bool startupProcessInitialRouteCalled = false; + bool startupOnResetCalled = false; + + @override + void startupNavigateToPage(Object page, StartupPageCompleter completer) { + navigatedPage = page; + startupNavigateToPageCalled = true; + completer(true); + } + + @override + void startupProcessInitialRoute() { + startupProcessInitialRouteCalled = true; + } + + @override + startupOnReset() { + startupOnResetCalled = true; + } +} diff --git a/packages/patapata_core/test/user_test.dart b/packages/patapata_core/test/user_test.dart new file mode 100644 index 0000000..b31ca50 --- /dev/null +++ b/packages/patapata_core/test/user_test.dart @@ -0,0 +1,314 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; + +import 'utils/patapata_core_test_utils.dart'; + +class TestPluginA extends Plugin {} + +class TestPluginB extends Plugin {} + +class FetchExceptionRemoteConfig extends RemoteConfig { + @override + Future fetch( + {Duration expiration = const Duration(hours: 5), bool force = false}) { + throw UnimplementedError(); + } + + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + throw UnimplementedError(); + } + + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + throw UnimplementedError(); + } + + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + throw UnimplementedError(); + } + + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + throw UnimplementedError(); + } + + @override + bool hasKey(String key) { + return false; + } + + @override + Future setDefaults(Map defaults) async {} +} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('changeId test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + const tUserId = 'userId'; + final tProperties = {'propertyKey': 'propertyValue'}; + final tData = {'dataKey': 'dataValue'}; + const tOverrideId = 'overrideId'; + final tOverrideIdMap = {TestPluginA: tOverrideId}; + final tOverrideMap = { + 'propertyKey': 'overrideValue', + 'pluginKey': 'pluginValue', + }; + final tOverrideProperties = {TestPluginA: tOverrideMap}; + + await tUser.changeId( + tUserId, + properties: tProperties, + data: tData, + overrideId: tOverrideIdMap, + overrideProperties: tOverrideProperties, + ); + + expect(tUser.id, equals(tUserId)); + expect(tUser.properties, equals(tProperties)); + expect(await tUser.getData('dataKey'), equals('dataValue')); + expect(tUser.getPropertiesFor(), + equals(tUser.properties..addAll(tOverrideMap))); + expect(tUser.getIdFor(), equals(tOverrideId)); + expect(tUser.getPropertiesFor(), equals(tUser.properties)); + expect(tUser.getIdFor(), equals(tUserId)); + expect(tUser.variables.map((e) => e.unsafeValue), [ + tUserId, + tProperties, + tData, + ]); + + const tUserId2 = 'userId2'; + await tUser.changeId( + tUserId2, + ); + + expect(tUser.id, equals(tUserId2)); + expect(tUser.properties, equals({'propertyKey': null})); + }); + + test('set test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + final tProperties = {'propertyKey': 'propertyValue'}; + final tData = {'dataKey': 'dataValue'}; + final tOverrideMap = { + 'propertyKey': 'overrideValue', + 'pluginKey': 'pluginValue', + }; + final tOverrideProperties = {TestPluginA: tOverrideMap}; + + await tUser.set( + properties: tProperties, + data: tData, + overrideProperties: tOverrideProperties, + ); + + expect(tUser.properties, equals(tProperties)); + expect(await tUser.getData('dataKey'), equals('dataValue')); + expect(tUser.getPropertiesFor(), + equals(tUser.properties..addAll(tOverrideMap))); + expect(tUser.getPropertiesFor(), equals(tUser.properties)); + }); + + test('setProperties test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + const tPropertyKey = 'propertyKey'; + const tPropertyValue = 'propertyValue'; + final tProperties = {tPropertyKey: tPropertyValue}; + final tOverrideMap = { + tPropertyKey: 'overrideValue', + 'pluginKey': 'pluginValue', + }; + final tOverrideProperties = {TestPluginA: tOverrideMap}; + + await tUser.setProperties( + tProperties, + overrideProperties: tOverrideProperties, + ); + expect(tUser.properties, equals(tProperties)); + expect(tUser.getPropertiesFor(), + equals(tUser.properties..addAll(tOverrideMap))); + expect(tUser.getPropertiesFor(), equals(tUser.properties)); + }); + + test('getPropertie defaultValue test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + const tPropertyKey = 'propertyKey'; + const tPropertyValue = 'propertyValue'; + final tProperties = {tPropertyKey: tPropertyValue}; + + await tUser.setProperties(tProperties); + expect(tUser.properties, equals(tProperties)); + expect(tUser.getProperty(tPropertyKey), tPropertyValue); + expect(tUser.getProperty('aaa'), isNull); + expect(tUser.getProperty('aaa', 'default'), 'default'); + }); + + test('setData test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + const tKey = 'testKey'; + const tValue = 'testValue'; + await tUser.setData(tKey, tValue); + + expect(await tUser.getData(tKey), equals(tValue)); + expect(tUser.getDataSync(tKey), equals(tValue)); + expect(await tUser.getData('aaa'), isNull); + }); + + test('removeData test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + final tData = {'dataKey': 'dataValue', 'deleteDataKey': 'deleteDataValue'}; + + await tUser.set( + data: tData, + ); + expect(await tUser.getData('dataKey'), equals('dataValue')); + expect(await tUser.getData('deleteDataKey'), equals('deleteDataValue')); + + await tUser.removeData('deleteDataKey'); + expect(await tUser.getData('dataKey'), equals('dataValue')); + expect(await tUser.getData('deleteDataKey'), isNull); + }); + + test('removeAllData test.', () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + final tData = {'dataKey': 'dataValue', 'deleteDataKey': 'deleteDataValue'}; + + await tUser.set( + data: tData, + ); + expect(await tUser.getData('dataKey'), equals('dataValue')); + expect(await tUser.getData('deleteDataKey'), equals('deleteDataValue')); + + await tUser.removeAllData(); + expect(await tUser.getData('dataKey'), isNull); + expect(await tUser.getData('deleteDataKey'), isNull); + }); + + test('addSynchronousChangeListener and removeSynchronousChangeListener test.', + () async { + final tApp = createApp(); + final tUser = User(app: tApp); + + const tUserId = 'userId'; + final Map tProperties = {'propertyKey': 'propertyValue'}; + final tData = {'dataKey': 'dataValue'}; + const tOverrideId = 'overrideId'; + final tOverrideIdMap = {TestPluginA: tOverrideId}; + final tOverrideMap = { + 'propertyKey': 'overrideValue', + 'pluginKey': 'pluginValue', + }; + final tOverrideProperties = {TestPluginA: tOverrideMap}; + + bool tCallbackCalled = false; + fCallback(User user, UserChangeData data) { + expect(data.id, equals(tUserId)); + expect(data.properties, equals(tProperties)); + expect(data.data, tData); + expect(data.getPropertiesFor(), tOverrideMap); + expect(data.getIdFor(), equals(tOverrideId)); + expect(data.getPropertiesFor(), tProperties); + expect(data.getIdFor(), equals(tUserId)); + + data.id = 'updateId'; + data.removeAllProperties(); + data.data.updateAll((key, value) => 'updateDataValue'); + + tCallbackCalled = true; + } + + tUser.addSynchronousChangeListener(fCallback); + await tUser.changeId( + tUserId, + properties: tProperties, + data: tData, + overrideId: tOverrideIdMap, + overrideProperties: tOverrideProperties, + ); + expect(tCallbackCalled, isTrue); + expect(tUser.id, equals('updateId')); + expect(tUser.properties, equals({'propertyKey': null})); + expect(await tUser.getData('dataKey'), equals('updateDataValue')); + expect( + tUser.getPropertiesFor(), + equals( + { + 'propertyKey': 'overrideValue', + 'pluginKey': 'pluginValue', + }, + ), + ); + expect(tUser.getIdFor(), equals(tOverrideId)); + + tCallbackCalled = false; + tUser.removeSynchronousChangeListener(fCallback); + await tUser.changeId( + tUserId, + properties: tProperties, + data: tData, + overrideId: tOverrideIdMap, + overrideProperties: tOverrideProperties, + ); + expect(tCallbackCalled, isFalse); + }); + + test('equals test.', () async { + final tApp = createApp(); + final tUser1 = User(app: tApp); + final tUser2 = User(app: tApp); + final tUser3 = User(app: tApp); + + const tUserId = 'userId'; + + await tUser1.changeId(tUserId); + await tUser2.changeId(tUserId); + await tUser3.changeId('user3'); + + expect(tUser1, equals(tUser2)); + expect(tUser1, isNot(tUser3)); + expect(tUser1.hashCode, equals(tUser2.hashCode)); + expect(tUser1.hashCode, isNot(tUser3.hashCode)); + expect({tUser1, tUser2, tUser3}.length, equals(2)); + + // ignore: invalid_use_of_protected_member + expect(tUser1.key, isNot(tUser2.key)); + }); + + test('set saves the value even if RemoteConfig fetch fails.', () async { + final tApp = createApp(); + await (tApp.remoteConfig as ProxyRemoteConfig) + .addRemoteConfig(FetchExceptionRemoteConfig()); + final tUser = User(app: tApp); + + final Map tProperties = {'propertyKey': 'propertyValue'}; + + await tUser.set(properties: tProperties); + + expect(tUser.properties, equals(tProperties)); + }); +} diff --git a/packages/patapata_core/test/util_test.dart b/packages/patapata_core/test/util_test.dart new file mode 100644 index 0000000..6010af6 --- /dev/null +++ b/packages/patapata_core/test/util_test.dart @@ -0,0 +1,458 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'utils/patapata_core_test_utils.dart'; +import 'package:timezone/data/latest_all.dart' as tz; +import 'package:timezone/timezone.dart' as tz; + +void main() { + test( + 'A SequentialWorkQueue can add a work item and it will execute', + () async { + final tQueue = SequentialWorkQueue(); + int tValue = 0; + + await tQueue.add(() { + tValue = 1; + }); + + expect( + tValue, + equals(1), + ); + }, + ); + + test( + 'A SequentialWorkQueue can add multiple work items and they will all execute in order', + () async { + final tQueue = SequentialWorkQueue(); + String tValue = ''; + + tQueue.add(() { + tValue += '0'; + }); + + tQueue.add(() { + tValue += '1'; + }); + + await tQueue.add(() { + tValue += '2'; + }); + + expect( + tValue, + equals('012'), + ); + }); + + test( + 'A SequentialWorkQueue completes all work\'s futures successfully, no matter the actual work\'s result', + () async { + final tQueue = SequentialWorkQueue(); + String tValue = ''; + List> tFutures = []; + + tFutures.add(tQueue.add(() { + tValue += '0'; + })); + + tFutures.add(tQueue.add(() async { + throw Error(); + }).catchError((error) => null)); + + tFutures.add(tQueue.add(() { + tValue += '2'; + })); + + await Future.wait(tFutures); + + expect( + tValue, + equals('02'), + ); + }); + + test('A SequentialWorkQueue can have work added to it even inside other work', + () async { + final tQueue = SequentialWorkQueue(); + String tValue = ''; + List> tFutures = []; + + tFutures.add(tQueue.add(() { + tValue += '0'; + + tFutures.add(tQueue.add(() { + tValue += '1'; + })); + })); + + tFutures.add(tQueue.add(() { + tFutures.add(tQueue.add(() { + tValue += '2'; + })); + + tValue += '3'; + })); + + while (tFutures.isNotEmpty) { + final tFuturesCopy = tFutures.toList(); + tFutures.clear(); + await Future.wait(tFuturesCopy); + } + + expect( + tValue, + equals('0132'), + ); + }); + + test( + 'A SequentialWorkQueue can be cleared, cancelling all current work that can be cancelled', + () async { + // No async. + var tQueue = SequentialWorkQueue(); + List> tFutures = []; + String tValue = ''; + + tFutures.add(tQueue.add(() { + tValue += '0'; + }, () => true)); + + tQueue.clear(); + + tFutures.add(tQueue.add(() { + tValue += '1'; + }, () => true)); + + while (tFutures.isNotEmpty) { + final tFuturesCopy = tFutures.toList(); + tFutures.clear(); + await Future.wait(tFuturesCopy); + } + + expect( + tValue, + equals('01'), + reason: 'No async', + ); + + // Async cancelled + tQueue = SequentialWorkQueue(); + tFutures.clear(); + tValue = ''; + + tFutures.add(tQueue.add(() async { + await Future.microtask(() => null); + tValue += '0'; + }, () async => await Future.microtask(() => true))); + + tQueue.clear(); + + tFutures.add(tQueue.add(() { + tValue += '1'; + }, () async => true)); + + while (tFutures.isNotEmpty) { + final tFuturesCopy = tFutures.toList(); + tFutures.clear(); + await Future.wait(tFuturesCopy); + } + + expect( + tValue, + equals('1'), + reason: 'Async cancelled', + ); + + // Async cancelled multiple times + tQueue = SequentialWorkQueue(); + tFutures.clear(); + tValue = ''; + + tFutures.add(tQueue.add(() async { + await Future.microtask(() => null); + tValue += '0'; + }, () async => await Future.microtask(() => true))); + + tFutures.add(tQueue.add(() async { + await Future.microtask(() => null); + tValue += '0'; + }, () async => await Future.microtask(() => true))); + + tQueue.clear(); + + tFutures.add(tQueue.add(() async { + await Future.microtask(() => null); + tValue += '0'; + }, () async => await Future.microtask(() => true))); + + tQueue.clear(); + + tFutures.add(tQueue.add(() { + tValue += '1'; + }, () async => true)); + + while (tFutures.isNotEmpty) { + final tFuturesCopy = tFutures.toList(); + tFutures.clear(); + await Future.wait(tFuturesCopy); + } + + expect( + tValue, + equals('1'), + reason: 'Async cancelled', + ); + + // Async no cancel + tQueue = SequentialWorkQueue(); + tFutures.clear(); + tValue = ''; + + tFutures.add(tQueue.add(() async { + await Future.microtask(() => null); + tValue += '0'; + }, () async => await Future.microtask(() => false))); + + tQueue.clear(); + + tFutures.add(tQueue.add(() { + tValue += '1'; + }, () async => true)); + + while (tFutures.isNotEmpty) { + final tFuturesCopy = tFutures.toList(); + tFutures.clear(); + await Future.wait(tFuturesCopy); + } + + expect( + tValue, + equals('01'), + reason: 'Async no cancel', + ); + }, + ); + + test( + 'typeIs should return true if the type of List is List with the same type', + () { + expect(typeIs(), isTrue); + expect(typeIs(), isTrue); + }); + + test( + 'typeIs should return false if the type of List is List with different types', + () { + expect(typeIs(), isFalse); + expect(typeIs(), isFalse); + }); + + test( + 'now should return the current DateTime', + () { + final tNow = now.toUTCIso8601StringNoMSUS(); + final tCurrentDateTime = DateTime.now().toUTCIso8601StringNoMSUS(); + + expect( + tNow, + equals(tCurrentDateTime), + ); + }, + // In the case of low probability failure, perform several retries. + retry: 5, + ); + + test( + 'platformCompute test', + () async { + const int tData = 5; + + final tResult = await platformCompute( + (input) => input * 2, + tData, + ); + + expect(tResult, 10); + }, + ); + + test( + 'platformCompute throw exception test', + () async { + const int tTestData = 5; + + Future testFunction() async { + await platformCompute( + (input) async => throw Exception('error'), + tTestData, + ); + } + + // Assert check + expect(testFunction, throwsException); + }, + ); + + testWidgets( + 'scheduleFunction should schedule the provided function to be executed after the next frame if frames are enabled', + (WidgetTester tester) async { + bool tExecuted = false; + bool tPostFrameCallbackCalled = false; + onPostFrameCallback = () { + tPostFrameCallbackCalled = true; + }; + + scheduleFunction(() { + tExecuted = true; + }); + + // Test that tExecuted is false before pumping. + expect(tExecuted, false); + + await tester.pump(); + + expect(tExecuted, true); + expect(tPostFrameCallbackCalled, isTrue); + }, + ); + group('timezone test group', () { + late tz.Location tOriginalTimeZone; + setUp(() { + tz.initializeTimeZones(); + tOriginalTimeZone = tz.local; + }); + tearDown(() { + tz.setLocalLocation(tOriginalTimeZone); + }); + test('toUTCIso8601StringNoMSUS should return the date in ISO8601 format', + () { + // I want to test changes from a time zone other than UTC, so I will test with the time zone set to Asia/Tokyo. + final tz.Location tTimeZone = tz.getLocation('Asia/Tokyo'); + + tz.TZDateTime tDateTime = tz.TZDateTime(tTimeZone, 2022, 1, 1, 12, 0, 0); + expect("2022-01-01T03:00:00Z", tDateTime.toUTCIso8601StringNoMSUS()); + + tDateTime = tz.TZDateTime(tTimeZone, 12345, 7, 9, 3, 15, 0, 0); + expect("012345-07-08T18:15:00Z", tDateTime.toUTCIso8601StringNoMSUS()); + + tDateTime = tz.TZDateTime(tTimeZone, 2022, 1, 1, 12, 0, 0); + expect("2022-01-01T03:00:00Z", tDateTime.toUTCIso8601StringNoMSUS()); + }); + }); + + testWidgets("DateTime fake time test", (WidgetTester tester) async { + // Create an instance of the App before calling the setFakeNow function, + // as setFakeNow internally invokes getApp(). + final App tApp = createApp( + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.shrink(), + ), + ), + ); + + await tApp.run(); + + await tApp.runProcess(() async { + final Stream tEventStream = fakeNowStream; + DateTime? tFakeNow; + + var tFutureFakeNow = expectLater( + tEventStream.asyncMap( + (dateTime) => dateTime?.toUTCIso8601StringNoMSUS(), + ), + emitsInOrder([null]), + ); + + setFakeNow(tFakeNow); + + // expect fake test + await tFutureFakeNow; + expect(fakeNowSet, false); + + tFakeNow = DateTime(2022, 1, 1, 12, 0, 0, 0, 0); + + tFutureFakeNow = expectLater( + tEventStream.asyncMap( + (dateTime) => dateTime?.toUTCIso8601StringNoMSUS(), + ), + emitsInOrder([tFakeNow.toUTCIso8601StringNoMSUS()]), + ); + + setFakeNow(tFakeNow); + + await tester.pumpAndSettle(); + + // expect fake test + await tFutureFakeNow; + expect(fakeNowSet, true); + expect(now, tFakeNow); + + tFakeNow = DateTime(2022, 1, 1, 14, 0, 0, 0, 0); + + tFutureFakeNow = expectLater( + tEventStream.asyncMap( + (dateTime) => dateTime?.toUTCIso8601StringNoMSUS(), + ), + emitsInOrder([tFakeNow.toUTCIso8601StringNoMSUS()]), + ); + + int tBeforeMicroseconds = !kIsWeb ? now.microsecondsSinceEpoch : 0; + + setFakeNow(tFakeNow, elapse: true); + + await tester.pumpAndSettle(); + + int tAfterMicroseconds = !kIsWeb ? now.microsecondsSinceEpoch : 0; + + if (!kIsWeb) { + expect(tAfterMicroseconds, isNot(tBeforeMicroseconds)); + } + + tApp.dispose(); + }); + }); + + testWidgets("DateTime load fake now test", (WidgetTester tester) async { + // Create an instance of the App before calling the setFakeNow function, + // as setFakeNow internally invokes getApp(). + final tDateTimeNow = + DateTime(2022, 1, 1, 14, 0, 0, 0, 0).toUTCIso8601StringNoMSUS(); + + final App tApp = createApp( + appWidget: const MaterialApp( + debugShowCheckedModeBanner: false, + home: Scaffold( + body: SizedBox.shrink(), + ), + ), + plugins: [ + Plugin.inline( + createLocalConfig: () => MockLocalConfig({ + 'patapataFakeNow': tDateTimeNow, + }), + ), + ], + ); + + await tApp.run(); + + await tApp.runProcess(() async { + await tester.pumpAndSettle(); + + expect(now.toUTCIso8601StringNoMSUS(), tDateTimeNow); + }); + + tApp.dispose(); + }); +} diff --git a/packages/patapata_core/test/utils/patapata_core_test_utils.dart b/packages/patapata_core/test/utils/patapata_core_test_utils.dart new file mode 100644 index 0000000..8bade57 --- /dev/null +++ b/packages/patapata_core/test/utils/patapata_core_test_utils.dart @@ -0,0 +1,268 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. +import 'dart:convert'; + +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_local_notifications/flutter_local_notifications.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +import '../pages/home_page.dart'; +import '../pages/notification_page.dart'; +import '../pages/error_page.dart'; + +class Environment with I18nEnvironment, NotificationsEnvironment { + const Environment(); + + @override + List? get l10nPaths => [ + 'l10n', + ]; + + @override + List? get supportedL10ns => [ + const Locale('ja'), + const Locale('en'), + ]; + + @override + List get notificationsAndroidChannels => [ + const AndroidNotificationChannel( + 'custom', + 'Patapata Test Channel', + importance: Importance.max, + enableLights: true, + ) + ]; + + @override + String get notificationsAndroidDefaultIcon => 'ic_notification'; + + @override + bool get notificationsDarwinDefaultPresentAlert => false; + + @override + bool get notificationsDarwinDefaultPresentBadge => false; + + @override + bool get notificationsDarwinDefaultPresentSound => false; + + @override + bool get notificationsDarwinDefaultPresentBanner => false; + + @override + bool get notificationsDarwinDefaultPresentList => false; +} + +class MockL10nAssetBundle extends CachingAssetBundle { + @override + Future load(String key) { + final tYamlMap = { + 'l10n/en.yaml': ''' +home: + title: HomePage +notification: + title: NotificationPage +test: + title: TestMessage:{param} +errors: + test: + '000': + title: ErrorTitle:{prefix}{data} + message: ErrorMessage:{prefix}{data} + fix: ErrorFix:{prefix}{data} + shout: + '111': + title: ErrorPageTitle + message: ErrorPageMessage + fix: ErrorPageFix + +''', + 'l10n/ja.yaml': ''' +home: + title: ホーム +notification: + title: 通知 +test: + title: テストメッセージ:{param} +errors: + test: + '000': + title: エラー:{prefix}{data} + message: メッセージ:{prefix}{data} + fix: 修復:{prefix}{data} + shout: + '111': + title: エラーページ:タイトル + message: エラーページ:メッセージ + fix: エラーページ:修復 +''', + 'l10n2/en.yaml': ''' +home: + title: HomePage2 +test2: + title: TestMessage2:{param} +''', + 'l10n2/ja.yaml': ''' +home: + title: ホーム2 +test2: + title: テストメッセージ2:{param} +''', + 'parse_error/en.yaml': ''' +home + title: This message will not be displayed because it will result in a parse error. +''', + 'empty/en.yaml': ''' +''', + }; + + final tCompleter = Completer(); + + try { + final tByteData = ByteData.view( + Uint8List.fromList( + utf8.encode( + tYamlMap[key]!, + ), + ).buffer, + ); + tCompleter.complete(tByteData); + } catch (e, stackTrace) { + tCompleter.completeError(e, stackTrace); + } + + return tCompleter.future; + } +} + +class _MockStreamHandler extends MockStreamHandler { + _MockStreamHandler(this.handler); + + final TestMockStreamHandler? handler; + + @override + void onCancel(Object? arguments) { + handler?.onCancel(arguments); + } + + @override + void onListen(Object? arguments, MockStreamHandlerEventSink events) { + handler?.onListen(arguments, _MockStreamHandlerEventSink(other: events)); + } +} + +class _MockStreamHandlerEventSink extends TestMockStreamHandlerEventSink { + final MockStreamHandlerEventSink other; + + _MockStreamHandlerEventSink({ + required this.other, + }); + + @override + void endOfStream() { + other.endOfStream(); + } + + @override + void error({required String code, String? message, Object? details}) { + other.error(code: code, message: message, details: details); + } + + @override + void success(Object? event) { + other.success(event); + } +} + +bool _testInitialized = false; + +void testInitialize() { + if (_testInitialized) { + return; + } + + _testInitialized = true; + + TestWidgetsFlutterBinding.ensureInitialized(); + + testSetMockMethodCallHandler = TestDefaultBinaryMessengerBinding + .instance.defaultBinaryMessenger.setMockMethodCallHandler; + testSetMockStreamHandler = (channel, handler) { + TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .setMockStreamHandler( + channel, + _MockStreamHandler(handler), + ); + }; + + PackageInfoPlugin.setMockValues( + appName: 'mock_patapata_core', + packageName: 'io.flutter.plugins.mockpatapatacore', + version: '1.0', + buildNumber: '1', + buildSignature: 'patapata_core_build_signature', + installerStore: null, + ); + + mockL10nAssetBundle = MockL10nAssetBundle(); +} + +final _patapataCoreTestKey = GlobalKey(); +App createApp({ + Object? environment, + Widget? appWidget, + StartupSequence? startupSequence, + List? plugins, +}) { + testInitialize(); + + return App( + plugins: plugins, + environment: environment ?? const Environment(), + createAppWidget: (context, app) => + appWidget ?? + StandardMaterialApp( + onGenerateTitle: (context) => 'title', + pages: [ + StandardPageFactory( + create: (data) => HomePage(), + ), + StandardPageFactory( + create: (pageData) => NotificationPage(), + links: {r'notification/': (match, uri) {}}, + linkGenerator: (pageData) => 'notification/', + ), + StandardErrorPageFactory( + create: (pageData) => ErrorPage(), + ), + ], + routableBuilder: (context, child) { + return KeyedSubtree( + key: _patapataCoreTestKey, + child: child!, + ); + }, + ), + startupSequence: startupSequence, + ); +} + +Future setTestDeviceSize( + WidgetTester tester, + Size tTestDeviceSize, { + double devicePixelRatio = 1.0, + double textScaleFactorTestValue = 1.0, +}) async { + // Set the device size to the test device size. + await tester.binding.setSurfaceSize(tTestDeviceSize); + tester.view.physicalSize = tTestDeviceSize; + tester.view.devicePixelRatio = devicePixelRatio; + tester.binding.platformDispatcher.textScaleFactorTestValue = + textScaleFactorTestValue; +} diff --git a/packages/patapata_core/test/utils/standard_app_widget_test_data.dart b/packages/patapata_core/test/utils/standard_app_widget_test_data.dart new file mode 100644 index 0000000..a5c1cb8 --- /dev/null +++ b/packages/patapata_core/test/utils/standard_app_widget_test_data.dart @@ -0,0 +1,670 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:provider/provider.dart'; + +const String kTestChangePageDataButton = 'test-change-page-data-button'; +const String kTestButton = 'test-button'; +const String kTestButtonSecond = 'test-button-second'; +const String kLinkButton = 'link-button'; +const String kOnPopButton = 'on-pop-button'; +const String kGoPageDataButton = 'go-page-data-button'; +const String kGoChangeDataButton = 'go-change-data-button'; +const String kChangePageDataButton = 'change-page-data-button'; +const String kProcessInitialRouteButton = 'process-initial-route-button'; +const String kRemoveRouteButton = 'remove-route-buton'; +const String kCheckNavigatorButton = 'check-navigator-buton'; +const String kGoToRouterDelegateButton = 'go-to-router-delegate-button'; +const String kGetPageFactoryButton = 'get-page-factory-button'; +const String kGetStandardAppRouterContext = 'get-standard-app-router-context'; +const String kGetStandardAppPluginRoute = 'get-standard-app-plugin-route'; +const String kGetStandardAppPluginGenerateLink = + 'get-standard-app-plugin-generate-link'; + +TestAnalyticsEvent? testAnalytics; +GlobalKey? navigatorKey; +NavigatorState? navigatorState; +BuildContext? navigatorContext; +StandardPageWithResultFactory? pageFactory; +bool isLinkHander = false; +Uri? linkHanderUri; +BuildContext? buildContext; + +bool onLink(Uri link) { + isLinkHander = true; + linkHanderUri = link; + return true; +} + +// Test Data +class TestChangeNotifierData extends ChangeNotifier { + TestChangeNotifierData({ + required this.title, + required this.pages, + }); + + String title = ''; + List pages = []; + Widget Function(BuildContext context, Widget? child)? routableBuilder; + bool Function(Route route, dynamic result)? willPopPage; + + void changeTitle(String title) { + this.title = title; + notifyListeners(); + } + + void changePages(List pages) { + this.pages = pages; + notifyListeners(); + } + + void changeRoutableBuilder( + Widget Function(BuildContext context, Widget? child)? routableBuilder, + ) { + this.routableBuilder = routableBuilder; + notifyListeners(); + } + + void changeWillPopPage( + bool Function(Route route, dynamic result)? willPopPage, + ) { + this.willPopPage = willPopPage; + notifyListeners(); + } +} + +// Material Page +class TestPageA extends StandardPage { + @override + AnalyticsEvent? get analyticsSingletonEvent => testAnalytics; + + String testText = ''; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'Test Title'), + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text("Test Message"); + }, + ), + ), + TextButton( + key: const ValueKey(kTestButton), + onPressed: () { + context.go(null); + }, + child: const Text('Go to Test Page B'), + ), + TextButton( + key: const ValueKey(kGoToRouterDelegateButton), + onPressed: () { + // Go To Test Page B for Router Delegate + var routerDelegate = (Router.of(context).routerDelegate + as StandardRouterDelegate); + routerDelegate.go(null); + }, + child: const Text('Go to Test Page B'), + ), + TextButton( + key: const ValueKey(kLinkButton), + onPressed: () { + context.route('testPageData/10'); + }, + child: const Text('Go to Link Page'), + ), + TextButton( + key: const ValueKey(kGoPageDataButton), + onPressed: () { + context.go( + TestPageData(id: 10, data: 'go to test data page data'), + ); + }, + child: const Text('Go to Test TestPage C'), + ), + TextButton( + key: const ValueKey(kGoChangeDataButton), + onPressed: () { + context.go(ChangeListenableBool()); + }, + child: const Text('Go to Test Page E'), + ), + TextButton( + key: const ValueKey(kProcessInitialRouteButton), + onPressed: () { + Router.of(context).processInitialRoute(); + }, + child: const Text('Go to Test Page E'), + ), + TextButton( + key: const ValueKey(kRemoveRouteButton), + onPressed: () { + Router.of(context).removeRoute(context); + }, + child: const Text('Remove Route'), + ), + TextButton( + key: const ValueKey(kGetPageFactoryButton), + onPressed: () { + var routerDelegate = (Router.of(context).routerDelegate + as StandardRouterDelegate); + pageFactory = + routerDelegate.getPageFactory(); + }, + child: const Text('Get Page Factory'), + ), + TextButton( + key: const ValueKey(kGetStandardAppRouterContext), + onPressed: () { + buildContext = context; + }, + child: const Text('Get StandardAppRouter Context'), + ), + TextButton( + key: const ValueKey(kGetStandardAppPluginRoute), + onPressed: () { + getApp() + .getPlugin() + ?.route('testPageData/10'); + }, + child: const Text('Get StandardAppRouter Context'), + ), + if (analyticsSingletonEvent == null) ...[ + TextButton( + key: const ValueKey(kGetStandardAppPluginGenerateLink), + onPressed: () { + testText = context + .read() + .getPlugin()! + .generateLink( + TestPageData(id: 9999, data: 'test page data'), + ) ?? + ''; + setState(() {}); + }, + child: const Text('Get Standard GenerateLink App'), + ), + Center( + child: Text('generateLink testText $testText'), + ), + ], + if (analyticsSingletonEvent != null) + Center( + child: Text( + "Analytics Event Data : ${analyticsSingletonEvent!.data}"), + ), + ], + ), + ), + ); + } +} + +class TestPageB extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text( + 'Test Title B', + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text("Test Message B"); + }, + ), + ), + TextButton( + key: const ValueKey(kTestButton), + onPressed: () { + context.go( + TestPageData(id: 40, data: 'Go to Page C'), + ); + }, + child: const Text('On pop page'), + ), + TextButton( + key: const ValueKey(kOnPopButton), + onPressed: () { + Navigator.maybePop(context); + }, + child: const Text('On pop page'), + ), + TextButton( + key: const ValueKey(kTestButtonSecond), + onPressed: () { + context.go( + null, + ); + }, + child: const Text('Go to Test TestPage D'), + ), + TextButton( + key: const ValueKey(kRemoveRouteButton), + onPressed: () { + Router.of(context).removeRoute(context); + }, + child: const Text('Remove Route'), + ), + TextButton( + key: const ValueKey(kCheckNavigatorButton), + onPressed: () { + navigatorState = (Router.of(context).routerDelegate + as StandardRouterDelegate) + .navigator; + navigatorContext = (Router.of(context).routerDelegate + as StandardRouterDelegate) + .navigatorContext; + navigatorKey = (Router.of(context).routerDelegate + as StandardRouterDelegate) + .navigatorKey; + }, + child: const Text('Set Navigator Key'), + ), + ], + ), + ), + ); + } +} + +class TestPageC extends StandardPage { + @override + Widget buildPage(BuildContext context) { + String? tGenerateLink; + final ModalRoute? tRoute = ModalRoute.of(context); + if (tRoute != null) { + final tInterfacePage = tRoute.settings as StandardPageInterface; + tGenerateLink = tInterfacePage.factoryObject.generateLink(pageData); + } + + return Scaffold( + appBar: AppBar( + title: const Text('Test Title C'), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text("Test Message C"); + }, + ), + ), + Center( + child: Builder( + builder: (context) { + return Text("Test Link Data is ${pageData.id}"); + }, + ), + ), + TextButton( + key: const ValueKey(kGoPageDataButton), + onPressed: () { + context.go( + TestPageData(id: 20, data: 'go to test page data'), + ); + + setState(() {}); + }, + child: const Text('Go to Test TestPageC'), + ), + TextButton( + key: const ValueKey(kTestChangePageDataButton), + onPressed: () { + pageData = TestPageData( + id: 30, data: 'changed test page data by button'); + setState(() {}); + }, + child: const Text('On Change PageData'), + ), + TextButton( + key: const ValueKey(kOnPopButton), + onPressed: () { + Navigator.maybePop(context); + }, + child: const Text('On pop page'), + ), + if (tGenerateLink != null) + Center( + child: Builder( + builder: (context) { + return Text("Test Generate Link is $tGenerateLink"); + }, + ), + ), + ], + ), + ), + ); + } +} + +class TestPageD extends StandardPage { + @override + Widget buildPage(BuildContext context) { + var tModalRoute = ModalRoute.of(context); + var tInterfacePage = tModalRoute?.settings as StandardPageInterface; + var tTestPageData = tInterfacePage.arguments as TestPageData; + + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'Test Title D'), + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Text("Test Page Id : ${tTestPageData.id}"), + Text("Test Page Data : ${tTestPageData.data}"), + Text("Test Interface Name : ${tInterfacePage.name}"), + Text( + "Test Interface RestorationId : ${tInterfacePage.restorationId}"), + ], + ), + ), + ); + } +} + +class TestPageE extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'Test Title'), + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + TextButton( + key: const ValueKey(kChangePageDataButton), + onPressed: () { + if (pageData is ChangeListenableBool) { + pageData = ChangeListenableNumber(); + } else { + pageData = ChangeListenableBool(); + } + setState(() {}); + }, + child: const Text('On Change PageData Bool Type'), + ), + if (pageData is ChangeListenableBool) + Center( + child: Text( + "Test Data Bool : ${context.watch().data}"), + ), + if (pageData is ChangeListenableNumber) + Center( + child: Text( + "Test Data Number : ${context.watch().data}"), + ), + ], + ), + ), + ); + } +} + +// Cupertino Page +class TestPageF extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoPageScaffold( + navigationBar: const CupertinoNavigationBar( + middle: Text('Test title F'), + ), + child: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return const Text("Test Message F"); + }, + ), + ), + ], + ), + ), + ); + } +} + +class TestPageG extends StandardPage { + @override + void initState() { + super.initState(); + + pageData = TestPageData(id: 77, data: 'overridden test page data'); + } + + @override + Widget buildPage(BuildContext context) { + return CupertinoPageScaffold( + navigationBar: const CupertinoNavigationBar( + middle: Text('Test title G'), + ), + child: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return Text('${pageData.id} ${pageData.data}'); + }, + ), + ), + ], + ), + ), + ); + } +} + +class TestPageH extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoPageScaffold( + navigationBar: const CupertinoNavigationBar( + middle: Text('Test title H'), + ), + child: SingleChildScrollView( + child: Column( + children: [ + Center( + child: Builder( + builder: (context) { + return Text('${pageData.id} ${pageData.data}'); + }, + ), + ), + ], + ), + ), + ); + } +} + +class TestPageRemoveRoute extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: const Text('TestPageRemoveRoute'), + ), + body: SingleChildScrollView( + child: Column( + children: [ + TextButton( + key: const ValueKey(kTestButton), + onPressed: () async { + context.removeRoute(); + }, + child: const Text('Remove the route'), + ), + ], + ), + ), + ); + } +} + +class TestPageContextGoWithResult extends StandardPage { + String? _result; + + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'TestPageContextGoWithResult'), + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + TextButton( + key: const ValueKey(kTestButton), + onPressed: () async { + final tResult = await context + .goWithResult(null); + setState(() { + _result = tResult; + }); + }, + child: const Text('Go to Test Page For Result'), + ), + Text(_result ?? ''), + ], + ), + ), + ); + } +} + +class TestPageWithResult extends StandardPageWithResult { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text( + l(context, 'TestPageWithResult'), + ), + ), + body: SingleChildScrollView( + child: Column( + children: [ + TextButton( + key: const ValueKey(kTestButton), + onPressed: () { + pageResult = 'pageResult'; + Navigator.pop(context); + }, + child: const Text('Go to Test Page For Result'), + ), + TextButton( + key: const ValueKey(kTestButtonSecond), + onPressed: () { + Navigator.pop(context, 'popResult'); + }, + child: const Text('On pop page'), + ), + ], + ), + ), + ); + } +} + +// Test Page Data +class TestPageData { + final int id; + final String? data; + + TestPageData({ + required this.id, + required this.data, + }); +} + +class BaseListenable extends ChangeNotifier {} + +class ChangeListenableBool extends BaseListenable { + bool data = true; +} + +class ChangeListenableNumber extends BaseListenable { + int data = 100; +} + +class TestAnalyticsEvent extends AnalyticsEvent { + TestAnalyticsEvent({ + required String name, + Map? data, + }) : super(name: name, data: data); +} + +class TestDataPlugin extends Plugin with StandardAppRoutePluginMixin { + @override + Future getInitialRouteData() async { + return StandardRouteData( + factory: null, + pageData: TestPageData(id: 9999, data: 'test plugin data'), + ); + } +} + +class TestDataParseRouteInformationPlugin extends Plugin + with StandardAppRoutePluginMixin { + @override + Future parseRouteInformation( + RouteInformation routeInformation) async { + return SynchronousFuture(StandardRouteData( + factory: app + .getPlugin()! + .delegate! + .getPageFactory(), + pageData: TestPageData(id: 70, data: 'parsed route'), + )); + } +} + +class TestDataBadLinkHandlerPlugin extends Plugin + with StandardAppRoutePluginMixin { + @override + Future getInitialRouteData() async { + return StandardRouteData( + factory: null, + pageData: TestPageData(id: 9999, data: 'test plugin data'), + ); + } +} + +class TestNullDataPlugin extends Plugin with StandardAppRoutePluginMixin {} diff --git a/packages/patapata_example_app/.gitignore b/packages/patapata_example_app/.gitignore new file mode 100644 index 0000000..4314849 --- /dev/null +++ b/packages/patapata_example_app/.gitignore @@ -0,0 +1,44 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +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 +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ + +# 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 \ No newline at end of file diff --git a/packages/patapata_example_app/.metadata b/packages/patapata_example_app/.metadata new file mode 100644 index 0000000..009f8af --- /dev/null +++ b/packages/patapata_example_app/.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: "efbf63d9c66b9f6ec30e9ad4611189aa80003d31" + channel: "stable" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: android + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: ios + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: linux + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: macos + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: web + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + - platform: windows + create_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + base_revision: efbf63d9c66b9f6ec30e9ad4611189aa80003d31 + + # 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/patapata_example_app/README.md b/packages/patapata_example_app/README.md new file mode 100644 index 0000000..eea85c1 --- /dev/null +++ b/packages/patapata_example_app/README.md @@ -0,0 +1,29 @@ +
+

Patapata - Example App

+

+ Introduction of sample code using Patapata's features. +

+
+ +--- + +## About +This package is a sample application that demonstrates how to use the features of `patapata_core`. The processing begins from the main function in `lib/main.dart`. + +## Getting started +To run the sample application, either execute `lib/main.dart` or run `flutter run`. + +This app also supports the Cupertino design. To run with Cupertino design, either specify `--dart-define=APP_TYPE=cupertino` in the args of `launch.json` or provide `--dart-define=APP_TYPE=cupertino` as an argument with flutter run. +``` +flutter run --dart-define=APP_TYPE=cupertino +``` + +Note that the default is `--dart-define=APP_TYPE=material`, which applies the Material Design when executed. + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/LICENSE) diff --git a/packages/patapata_example_app/analysis_options.yaml b/packages/patapata_example_app/analysis_options.yaml new file mode 100644 index 0000000..0d29021 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/android/.gitignore b/packages/patapata_example_app/android/.gitignore new file mode 100644 index 0000000..6f56801 --- /dev/null +++ b/packages/patapata_example_app/android/.gitignore @@ -0,0 +1,13 @@ +gradle-wrapper.jar +/.gradle +/captures/ +/gradlew +/gradlew.bat +/local.properties +GeneratedPluginRegistrant.java + +# Remember to never publicly share your keystore. +# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app +key.properties +**/*.keystore +**/*.jks diff --git a/packages/patapata_example_app/android/app/build.gradle b/packages/patapata_example_app/android/app/build.gradle new file mode 100644 index 0000000..5d30270 --- /dev/null +++ b/packages/patapata_example_app/android/app/build.gradle @@ -0,0 +1,67 @@ +plugins { + id "com.android.application" + id "kotlin-android" + id "dev.flutter.flutter-gradle-plugin" +} + +def localProperties = new Properties() +def localPropertiesFile = rootProject.file('local.properties') +if (localPropertiesFile.exists()) { + localPropertiesFile.withReader('UTF-8') { reader -> + localProperties.load(reader) + } +} + +def flutterVersionCode = localProperties.getProperty('flutter.versionCode') +if (flutterVersionCode == null) { + flutterVersionCode = '1' +} + +def flutterVersionName = localProperties.getProperty('flutter.versionName') +if (flutterVersionName == null) { + flutterVersionName = '1.0' +} + +android { + namespace "com.example.patapata_example_app" + compileSdkVersion flutter.compileSdkVersion + ndkVersion flutter.ndkVersion + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). + applicationId "com.example.patapata_example_app" + // You can update the following values to match your application needs. + // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration. + minSdkVersion 21 + targetSdkVersion flutter.targetSdkVersion + versionCode flutterVersionCode.toInteger() + versionName flutterVersionName + } + + 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.debug + } + } +} + +flutter { + source '../..' +} + +dependencies {} diff --git a/packages/patapata_example_app/android/app/src/debug/AndroidManifest.xml b/packages/patapata_example_app/android/app/src/debug/AndroidManifest.xml new file mode 100644 index 0000000..399f698 --- /dev/null +++ b/packages/patapata_example_app/android/app/src/debug/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/packages/patapata_example_app/android/app/src/main/AndroidManifest.xml b/packages/patapata_example_app/android/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..b684296 --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/patapata_example_app/android/app/src/main/kotlin/com/example/patapata_example_app/MainActivity.kt b/packages/patapata_example_app/android/app/src/main/kotlin/com/example/patapata_example_app/MainActivity.kt new file mode 100644 index 0000000..04040f2 --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/kotlin/com/example/patapata_example_app/MainActivity.kt @@ -0,0 +1,13 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package com.example.patapata_example_app + +import io.flutter.embedding.android.FlutterActivity + +class MainActivity: FlutterActivity() { +} diff --git a/packages/patapata_example_app/android/app/src/main/res/drawable-v21/launch_background.xml b/packages/patapata_example_app/android/app/src/main/res/drawable-v21/launch_background.xml new file mode 100644 index 0000000..f74085f --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/res/drawable-v21/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/packages/patapata_example_app/android/app/src/main/res/drawable/launch_background.xml b/packages/patapata_example_app/android/app/src/main/res/drawable/launch_background.xml new file mode 100644 index 0000000..304732f --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/res/drawable/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/packages/patapata_example_app/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/packages/patapata_example_app/android/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000..db77bb4 Binary files /dev/null and b/packages/patapata_example_app/android/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/packages/patapata_example_app/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/packages/patapata_example_app/android/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000..17987b7 Binary files /dev/null and b/packages/patapata_example_app/android/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/packages/patapata_example_app/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/packages/patapata_example_app/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000..09d4391 Binary files /dev/null and b/packages/patapata_example_app/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/packages/patapata_example_app/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/packages/patapata_example_app/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000..d5f1c8d Binary files /dev/null and b/packages/patapata_example_app/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/packages/patapata_example_app/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/packages/patapata_example_app/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000..4d6372e Binary files /dev/null and b/packages/patapata_example_app/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/packages/patapata_example_app/android/app/src/main/res/values-night/styles.xml b/packages/patapata_example_app/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 0000000..06952be --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/packages/patapata_example_app/android/app/src/main/res/values/styles.xml b/packages/patapata_example_app/android/app/src/main/res/values/styles.xml new file mode 100644 index 0000000..cb1ef88 --- /dev/null +++ b/packages/patapata_example_app/android/app/src/main/res/values/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/packages/patapata_example_app/android/app/src/profile/AndroidManifest.xml b/packages/patapata_example_app/android/app/src/profile/AndroidManifest.xml new file mode 100644 index 0000000..399f698 --- /dev/null +++ b/packages/patapata_example_app/android/app/src/profile/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/packages/patapata_example_app/android/build.gradle b/packages/patapata_example_app/android/build.gradle new file mode 100644 index 0000000..f7eb7f6 --- /dev/null +++ b/packages/patapata_example_app/android/build.gradle @@ -0,0 +1,31 @@ +buildscript { + ext.kotlin_version = '1.7.10' + repositories { + google() + mavenCentral() + } + + dependencies { + classpath 'com.android.tools.build:gradle:7.3.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + } +} + +allprojects { + repositories { + google() + mavenCentral() + } +} + +rootProject.buildDir = '../build' +subprojects { + project.buildDir = "${rootProject.buildDir}/${project.name}" +} +subprojects { + project.evaluationDependsOn(':app') +} + +tasks.register("clean", Delete) { + delete rootProject.buildDir +} diff --git a/packages/patapata_example_app/android/gradle.properties b/packages/patapata_example_app/android/gradle.properties new file mode 100644 index 0000000..94adc3a --- /dev/null +++ b/packages/patapata_example_app/android/gradle.properties @@ -0,0 +1,3 @@ +org.gradle.jvmargs=-Xmx1536M +android.useAndroidX=true +android.enableJetifier=true diff --git a/packages/patapata_example_app/android/gradle/wrapper/gradle-wrapper.properties b/packages/patapata_example_app/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3c472b9 --- /dev/null +++ b/packages/patapata_example_app/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-7.5-all.zip diff --git a/packages/patapata_example_app/android/settings.gradle b/packages/patapata_example_app/android/settings.gradle new file mode 100644 index 0000000..55c4ca8 --- /dev/null +++ b/packages/patapata_example_app/android/settings.gradle @@ -0,0 +1,20 @@ +pluginManagement { + def flutterSdkPath = { + def properties = new Properties() + file("local.properties").withInputStream { properties.load(it) } + def flutterSdkPath = properties.getProperty("flutter.sdk") + assert flutterSdkPath != null, "flutter.sdk not set in local.properties" + return flutterSdkPath + } + settings.ext.flutterSdkPath = flutterSdkPath() + + includeBuild("${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle") + + plugins { + id "dev.flutter.flutter-gradle-plugin" version "1.0.0" apply false + } +} + +include ":app" + +apply from: "${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle/app_plugin_loader.gradle" diff --git a/packages/patapata_example_app/ios/.gitignore b/packages/patapata_example_app/ios/.gitignore new file mode 100644 index 0000000..7a7f987 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/ios/Flutter/AppFrameworkInfo.plist b/packages/patapata_example_app/ios/Flutter/AppFrameworkInfo.plist new file mode 100644 index 0000000..9625e10 --- /dev/null +++ b/packages/patapata_example_app/ios/Flutter/AppFrameworkInfo.plist @@ -0,0 +1,26 @@ + + + + + CFBundleDevelopmentRegion + en + CFBundleExecutable + App + CFBundleIdentifier + io.flutter.flutter.app + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + App + CFBundlePackageType + FMWK + CFBundleShortVersionString + 1.0 + CFBundleSignature + ???? + CFBundleVersion + 1.0 + MinimumOSVersion + 11.0 + + diff --git a/packages/patapata_example_app/ios/Flutter/Debug.xcconfig b/packages/patapata_example_app/ios/Flutter/Debug.xcconfig new file mode 100644 index 0000000..ec97fc6 --- /dev/null +++ b/packages/patapata_example_app/ios/Flutter/Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "Generated.xcconfig" diff --git a/packages/patapata_example_app/ios/Flutter/Release.xcconfig b/packages/patapata_example_app/ios/Flutter/Release.xcconfig new file mode 100644 index 0000000..c4855bf --- /dev/null +++ b/packages/patapata_example_app/ios/Flutter/Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "Generated.xcconfig" diff --git a/packages/patapata_example_app/ios/Podfile b/packages/patapata_example_app/ios/Podfile new file mode 100644 index 0000000..164df53 --- /dev/null +++ b/packages/patapata_example_app/ios/Podfile @@ -0,0 +1,44 @@ +# Uncomment this line to define a global platform for your project +platform :ios, '12.0' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_ios_podfile_setup + +target 'Runner' do + use_frameworks! + use_modular_headers! + + flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_ios_build_settings(target) + end +end diff --git a/packages/patapata_example_app/ios/Podfile.lock b/packages/patapata_example_app/ios/Podfile.lock new file mode 100644 index 0000000..492e198 --- /dev/null +++ b/packages/patapata_example_app/ios/Podfile.lock @@ -0,0 +1,53 @@ +PODS: + - connectivity_plus (0.0.1): + - Flutter + - ReachabilitySwift + - device_info_plus (0.0.1): + - Flutter + - Flutter (1.0.0) + - flutter_local_notifications (0.0.1): + - Flutter + - package_info_plus (0.4.5): + - Flutter + - patapata_core (0.0.1): + - Flutter + - ReachabilitySwift (5.0.0) + +DEPENDENCIES: + - connectivity_plus (from `.symlinks/plugins/connectivity_plus/ios`) + - device_info_plus (from `.symlinks/plugins/device_info_plus/ios`) + - Flutter (from `Flutter`) + - flutter_local_notifications (from `.symlinks/plugins/flutter_local_notifications/ios`) + - package_info_plus (from `.symlinks/plugins/package_info_plus/ios`) + - patapata_core (from `.symlinks/plugins/patapata_core/ios`) + +SPEC REPOS: + trunk: + - ReachabilitySwift + +EXTERNAL SOURCES: + connectivity_plus: + :path: ".symlinks/plugins/connectivity_plus/ios" + device_info_plus: + :path: ".symlinks/plugins/device_info_plus/ios" + Flutter: + :path: Flutter + flutter_local_notifications: + :path: ".symlinks/plugins/flutter_local_notifications/ios" + package_info_plus: + :path: ".symlinks/plugins/package_info_plus/ios" + patapata_core: + :path: ".symlinks/plugins/patapata_core/ios" + +SPEC CHECKSUMS: + connectivity_plus: bf0076dd84a130856aa636df1c71ccaff908fa1d + device_info_plus: c6fb39579d0f423935b0c9ce7ee2f44b71b9fce6 + Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854 + flutter_local_notifications: 0c0b1ae97e741e1521e4c1629a459d04b9aec743 + package_info_plus: 115f4ad11e0698c8c1c5d8a689390df880f47e85 + patapata_core: ce5b4c8f74bd32c7c405f0d85d4cbbf25cb75da6 + ReachabilitySwift: 985039c6f7b23a1da463388634119492ff86c825 + +PODFILE CHECKSUM: 7be2f5f74864d463a8ad433546ed1de7e0f29aef + +COCOAPODS: 1.12.1 diff --git a/packages/patapata_example_app/ios/Runner.xcodeproj/project.pbxproj b/packages/patapata_example_app/ios/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..fc1a51d --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,617 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXBuildFile section */ + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.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 */; }; + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C807B294A618700263BE5 /* RunnerTests.swift */; }; +/* 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 = ""; }; + 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 = ""; }; + 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 = ""; }; + 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; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 97C146EB1CF9000F007C117D /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 9740EEB11CF90186004384FC /* Flutter */ = { + isa = PBXGroup; + children = ( + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 9740EEB31CF90195004384FC /* Generated.xcconfig */, + ); + name = Flutter; + sourceTree = ""; + }; + 331C8082294A63A400263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C807B294A618700263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + 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 */, + 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 */, + 331C807E294A63A400263BE5 /* Frameworks */, + 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 = 1430; + 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 */, + ); + 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; + 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; + 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 = 11.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)"; + DEVELOPMENT_TEAM = E225A72QFV; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.patapataExampleApp; + 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; + baseConfigurationReference = AE0B7B92F70575B8D7E0D07E /* Pods-RunnerTests.debug.xcconfig */; + 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.patapataExampleApp.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; + baseConfigurationReference = 89B67EB44CE7B6631473024E /* Pods-RunnerTests.release.xcconfig */; + 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.patapataExampleApp.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; + baseConfigurationReference = 640959BDD8F10B91D80A66BE /* Pods-RunnerTests.profile.xcconfig */; + 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.patapataExampleApp.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; + 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; + 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 = 11.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; + 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; + 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 = 11.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)"; + DEVELOPMENT_TEAM = E225A72QFV; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.patapataExampleApp; + 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)"; + DEVELOPMENT_TEAM = E225A72QFV; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.patapataExampleApp; + 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/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/patapata_example_app/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/patapata_example_app/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..87131a0 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/ios/Runner.xcworkspace/contents.xcworkspacedata b/packages/patapata_example_app/ios/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/packages/patapata_example_app/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/packages/patapata_example_app/ios/Runner/AppDelegate.swift b/packages/patapata_example_app/ios/Runner/AppDelegate.swift new file mode 100644 index 0000000..0f67170 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner/AppDelegate.swift @@ -0,0 +1,18 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import UIKit +import Flutter + +@UIApplicationMain +@objc class AppDelegate: FlutterAppDelegate { + override func application( + _ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? + ) -> Bool { + GeneratedPluginRegistrant.register(with: self) + return super.application(application, didFinishLaunchingWithOptions: launchOptions) + } +} diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..d36b1fa --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png new file mode 100644 index 0000000..dc9ada4 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png new file mode 100644 index 0000000..7353c41 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png new file mode 100644 index 0000000..797d452 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png new file mode 100644 index 0000000..6ed2d93 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png new file mode 100644 index 0000000..4cd7b00 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png new file mode 100644 index 0000000..fe73094 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png new file mode 100644 index 0000000..321773c Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png new file mode 100644 index 0000000..797d452 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png new file mode 100644 index 0000000..502f463 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png new file mode 100644 index 0000000..0ec3034 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png new file mode 100644 index 0000000..0ec3034 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png new file mode 100644 index 0000000..e9f5fea Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png new file mode 100644 index 0000000..84ac32a Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png new file mode 100644 index 0000000..8953cba Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png new file mode 100644 index 0000000..0467bf1 Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json new file mode 100644 index 0000000..0bedcf2 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png differ diff --git a/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md b/packages/patapata_example_app/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md new file mode 100644 index 0000000..89c2725 --- /dev/null +++ b/packages/patapata_example_app/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. \ No newline at end of file diff --git a/packages/patapata_example_app/ios/Runner/Base.lproj/LaunchScreen.storyboard b/packages/patapata_example_app/ios/Runner/Base.lproj/LaunchScreen.storyboard new file mode 100644 index 0000000..f2e259c --- /dev/null +++ b/packages/patapata_example_app/ios/Runner/Base.lproj/LaunchScreen.storyboard @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/ios/Runner/Base.lproj/Main.storyboard b/packages/patapata_example_app/ios/Runner/Base.lproj/Main.storyboard new file mode 100644 index 0000000..f3c2851 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner/Base.lproj/Main.storyboard @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/ios/Runner/Info.plist b/packages/patapata_example_app/ios/Runner/Info.plist new file mode 100644 index 0000000..04ba3db --- /dev/null +++ b/packages/patapata_example_app/ios/Runner/Info.plist @@ -0,0 +1,51 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleDisplayName + Patapata Example App + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + patapata_example_app + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleSignature + ???? + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSRequiresIPhoneOS + + UILaunchStoryboardName + LaunchScreen + UIMainStoryboardFile + Main + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + CADisableMinimumFrameDurationOnPhone + + UIApplicationSupportsIndirectInputEvents + + FlutterDeepLinkingEnabled + + + \ No newline at end of file diff --git a/packages/patapata_example_app/ios/Runner/Runner-Bridging-Header.h b/packages/patapata_example_app/ios/Runner/Runner-Bridging-Header.h new file mode 100644 index 0000000..308a2a5 --- /dev/null +++ b/packages/patapata_example_app/ios/Runner/Runner-Bridging-Header.h @@ -0,0 +1 @@ +#import "GeneratedPluginRegistrant.h" diff --git a/packages/patapata_example_app/ios/RunnerTests/RunnerTests.swift b/packages/patapata_example_app/ios/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..4923924 --- /dev/null +++ b/packages/patapata_example_app/ios/RunnerTests/RunnerTests.swift @@ -0,0 +1,17 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +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/patapata_example_app/l10n/ar.yaml b/packages/patapata_example_app/l10n/ar.yaml new file mode 100644 index 0000000..a93827f --- /dev/null +++ b/packages/patapata_example_app/l10n/ar.yaml @@ -0,0 +1,102 @@ +title: عينة نواة تطبيق باتاباتا +plurals: + test1: هذا اختبار بـ {count, plural, other{# عناصر}}. +errors: + app: + '000': + title: خطأ ({prefix}000) + message: خطأ غير معروف. + network: + '404': + title: خطأ ({prefix}404) + message: لا يمكن العثور على المحتوى. + '500': + title: خطأ ({prefix}500) + message: خطأ في الخادم الداخلي. + '503': + title: خطأ ({prefix}503) + message: الخدمة غير متوفرة. يخضع الخادم حاليًا للصيانة. + fix: اذهب إلى الصفحة الرئيسية +pages: + agreement: + title: اتفاق + body: هذه صفحة الاتفاق. هل توافق؟ + yes: نعم + no: لا + top: + title: الصفحة الرئيسية لنموذج باتاباتا + body: هذه هي صفحة البداية العينية لباتاباتا. + go_to_config: نموذج التكوين + go_to_screen_layout: تخطيط الشاشة العيني + go_to_standard_page: نموذج الصفحة القياسي + go_to_device_and_pakage_info: معلومات الجهاز والحزمة العينية + go_to_error: نموذج الخطأ + go_to_tab: نموذج علامة التبويب + config: + title: نموذج التكوين + body: هذه صفحة التكوين العينية. + increment: زيادة العدد + clear: مسح العدد المحلي للتكوين + error: + title: نموذج الخطأ + body: هذه صفحة الخطأ العينية. + example: خطأ عادي + network: خطأ في الشبكة ({prefix}) + maintenance: خطأ الصيانة + maintenance: + title: صيانة الخادم + message: غير متاح حاليًا بسبب صيانة الخادم. الرجوع إلى الصفحة الرئيسية. + device_and_package_info: + title: نموذج معلومات الجهاز والحزمة + body: هذه صفحة عينة لاسترجاع معلومات الجهاز ومعلومات الحزمة. + model: اسم الجهاز + app_name: اسم التطبيق + build_number: رقم البناء + build_signature: توقيع البناء + package_name: اسم الحزمة + version: رقم الإصدار + standard_page: + title: نموذج الصفحة القياسي + body: هذه صفحة عينة من الصفحة القياسية. + go_to_next_standard_page: الانتقال إلى الصفحة القياسية التالية + go_to_custom_standard_page: الانتقال إلى الصفحة القياسية المخصصة + go_to_page_data: الانتقال إلى عينة بيانات الصفحة + page_data_value: "قيمة بيانات الصفحة: {prefix}" + change_page_data: تغيير بيانات الصفحة + page_data_count: "عدد بيانات الصفحة: {prefix}" + change_page_data_type: تغيير نوع بيانات الصفحة + change_page_data_result: "القيمة الحالية لبيانات الصفحة: {prefix}" + tab: + home: + title: الرئيسية + body: هذه علامة التبويب الرئيسية. + title_details: + title: تفاصيل العنوان + body: هذه علامة التبويب تفاصيل العنوان. + my_page: + title: صفحتي + body: هذه علامة التبويب صفحتي. + screen_layout_example: + title: عينة تخطيط الشاشة + body: هذا عينة لتخطيط الشاشة. + sample_a: عينة A + sample_b: عينة B + base_description_before: | + تم تحديد هذا SizedBox بأبعاد 300x300، والSizedBoxes على اليمين واليسار لها عرض 37.5. + قد يظهر هناك هوامش أو ربما Flutter يعرض تحذيرًا بالتجاوز بسبب حجم الشاشة غير الكافي. + عن طريق استخدام نظام ScreenLayout، يتم تكبير أو تصغير RenderSize للطفل بناءً على القيم المحددة في StandardBreakpoint (ولكنه لا يتجاوز أبدًا maxScale). + العينة A هي الكائن الخام دون تطبيق ScreenLayout. + base_description_after: | + العينة B هي نتيجة تطبيق ScreenLayout على العينة A. إذا كان حجم الشاشة الفعلي 450 أو أقل، يجب أن يكون الحجم مثاليًا. + يكون هذا مفيدًا عند إنشاء ويدجت لا ترغب في تغيير مظهرها بشكل جذري بناءً على عرض الشاشة أو عندما ترغب في محاذاة الأحجام النسبية + بين الأجهزة اللوحية والأجهزة غير اللوحية، على سبيل المثال، عند عرض الحوارات. + description_case_equal: بسبب عرض جهازك البالغ {width}، لذلك يتم عرض الودجت بشكل مثالي. (إذا كنت ترغب في اختبار وظيفة ScreenLayout، يرجى تشغيلها على جهاز بعرض مختلف عن 375). + description_case_over: بسبب عرض جهازك البالغ {width}، هناك هوامش على اليسار واليمين. + description_case_other: بسبب عرض جهازك البالغ {width}، يتم عرض تحذير بالتجاوز. + description_sample: | + في المثال السابق، قمنا بتوضيح تكبير RenderSize بناءً على StandardBreakpoint. ومع ذلك، يعتمد حجم الودجت الفعلي على حجم والديها. + ومع ذلك، قد تكون هناك حالات ترغب في فرض قيود على الحجم الفعلي. في مثل هذه الحالات، يمكنك استخدام ConstrainedWidth. + من خلال تحديد ConstrainedWidth، يمكنك تغيير الحجم الفعلي والاستفادة لاحقًا من الحساب التلقائي لـ RenderSize بناءً على StandardBreakpoint. + إنها فعّالة أيضًا لإحاطة ويدجت ScreenLayout بـ ConstrainedBox أو نهج مماثل لتقييد الحجم. + يرجى اختيار النهج المناسب بناءً على الوضع في شجرة الودجت الخاصة بك. + description_example: في المثال أعلاه، تم تعيين قيمة ConstrainedWidth إلى 200. يقوم هذا بتحديد الحجم الفعلي إلى 200، ولكن يمكن ملاحظة الشكل النسبي للمحتوى. diff --git a/packages/patapata_example_app/l10n/en.yaml b/packages/patapata_example_app/l10n/en.yaml new file mode 100644 index 0000000..ae38559 --- /dev/null +++ b/packages/patapata_example_app/l10n/en.yaml @@ -0,0 +1,102 @@ +title: Patapata Core Sample App +plurals: + test1: This is a test with {count, plural, other{# items}}. +errors: + app: + '000': + title: Error ({prefix}000) + message: Unknown Error. + network: + '404': + title: Error ({prefix}404) + message: Contents not found. + '500': + title: Error ({prefix}500) + message: Internal server error. + '503': + title: Error ({prefix}503) + message: Service Unavailable. The server is currently undergoing maintenance. + fix: Go to Top Page +pages: + agreement: + title: Agreement + body: This is the agreement page. Do you accept? + yes: Yes + no: No + top: + title: Patapata Sample Top + body: This is the sample top page of Patapata. + go_to_config: Config Sample + go_to_screen_layout: ScreenLayout Sample + go_to_standard_page: StandardPage Sample + go_to_device_and_pakage_info: Device And PackageInfo Sample + go_to_error: Error Sample + go_to_tab: Tab Sample + config: + title: Config Sample + body: This is the sample page of Config. + increment: Increment Count + clear: Clear Local Config Count + error: + title: Error Sample + body: This is the sample page of Error. + example: Normal Error + network: Network Error({prefix}) + maintenance: Maintenance Error + maintenance: + title: Server Maintenance + message: Currently unavailable due to server maintenance. Returning to the Top Page. + device_and_package_info: + title: Sample of Device and Package Information + body: This is a sample page for retrieving device information and package information. + model: device name + app_name: app name + build_number: build number + build_signature: build signature + package_name: package name + version: version number + standard_page: + title: StandardPage Sample + body: This is a sample page of StandardPage. + go_to_next_standard_page: Go to next StandardPage + go_to_custom_standard_page: Go to Custom StandardPage + go_to_page_data: Go to Page Data Sample + page_data_value: PageData Value:{prefix} + change_page_data: Change PageData + page_data_count: PageData Count:{prefix} + change_page_data_type: Change PageData Type + change_page_data_result: Current PageData Value:{prefix} + tab: + home: + title: Home + body: This is the home tab. + title_details: + title: Title Details + body: This is the title details tab. + my_page: + title: My Page + body: This is the my page tab. + screen_layout_example: + title: ScreenLayout Sample + body: This is a sample of ScreenLayout. + sample_a: Sample A + sample_b: Sample B + base_description_before: | + This SizedBox is specified as 300x300, and the SizedBoxes on the left and right have a Width of 37.5. + Depending on the actual screen size, there may be margins or Flutter may display an overflow warning due to insufficient screen size. + By using the ScreenLayout system, the RenderSize of the child is scaled up or down based on the values set in the StandardBreakpoint (but it never exceeds the maxScale). + Sample A is the raw object without applying ScreenLayout. + base_description_after: | + Sample B is the result of applying ScreenLayout to Sample A. If the actual screen size is 450 or less, it should be the perfect size. + This is useful when creating widgets that you don\'t want to drastically change their appearance based on screen width or when you want to align relative sizes + between tablets and non-tablet devices, for example, when displaying dialogs. + description_case_equal: Due to your device width of {width}, so the widget is displayed perfectly. (If you want to test the functionality of ScreenLayout, please try running it on a device with a width other than 375). + description_case_over: Due to your device width of {width}, there are margins on the left and right. + description_case_other: Due to your device width of {width}, an overflow warning is being displayed. + description_sample: | + In the previous example, we demonstrated scaling the RenderSize based on the StandardBreakpoint. However, the actual widget size depends on the size of its parent. + However, there are cases where you may want to impose restrictions on the actual size. In such cases, you can use ConstrainedWidth. + By specifying ConstrainedWidth, you can change the actual size and still benefit from the automatic calculation of RenderSize based on the StandardBreakpoint. + It is also effective to enclose the ScreenLayout widget with a ConstrainedBox or similar approach to restrict the size. + Please choose the appropriate approach based on the situation in your widget tree. + description_example: In the above example, the value of ConstrainedWidth is set to 200. This limits the actual size to 200, but it can be observed that the relative shape of the content is preserved. \ No newline at end of file diff --git a/packages/patapata_example_app/l10n/ja.yaml b/packages/patapata_example_app/l10n/ja.yaml new file mode 100644 index 0000000..0571293 --- /dev/null +++ b/packages/patapata_example_app/l10n/ja.yaml @@ -0,0 +1,102 @@ +title: Patapata Core サンプルアプリ +plurals: + test1: これは{count, plural, other{#個}}の項目があるテストです。 +errors: + app: + '000': + title: エラー（{prefix}000） + message: 不明エラーが発生しました。 + network: + '404': + title: エラー（{prefix}404） + message: コンテンツが見つかりませんでした。 + '500': + title: エラー（{prefix}500） + message: サーバーエラーが発生しました。 + '503': + title: サーバーメンテナンス + message: 現在サーバーメンテンス中のため利用できません。トップページに戻ります。 + fix: トップ画面へ +pages: + agreement: + title: 同意画面 + body: これは同意画面です。承諾しますか？ + yes: はい + no: いいえ + top: + title: Patapata サンプル トップ + body: ここはPatapataのサンプルトップページです。 + go_to_config: Configのサンプル + go_to_screen_layout: ScreenLayoutのサンプル + go_to_standard_page: StandardPageのサンプル + go_to_device_and_pakage_info: DeviceInfoとPackageInfoのサンプル + go_to_error: Errorのサンプル + go_to_tab: Tabのサンプル + config: + title: Config サンプル + body: ここはConfigのサンプルページです。 + increment: カウントを増やす + clear: Local Configを削除する + error: + title: エラー サンプル + body: ここはエラー機能のサンプルページです。 + example: 通常のエラー + network: ネットワークエラー({prefix}) + maintenance: メンテナンス中エラー + maintenance: + title: サーバーメンテナンス + message: 現在サーバーメンテンス中のため利用できません。トップページに戻ります。 + device_and_package_info: + title: デバイスとパッケージ情報 サンプル + body: ここはデバイス情報とパッケージ情報を取得するサンプルページです。 + model: デバイス名 + app_name: アプリ名 + build_number: ビルド番号 + build_signature: ビルドサイン（build signature） + package_name: パッケージ名 + version: バージョン番号 + standard_page: + title: StandardPage サンプル + body: ここはStandardPageのサンプルページです。 + go_to_next_standard_page: 次のStandardPageへ + go_to_custom_standard_page: カスタムStandardPageへ + go_to_page_data: ページデータのサンプルへ + page_data_value: PageDataの値:{prefix} + change_page_data: PageDataの値を変更する + page_data_count: PageDataのカウント数:{prefix} + change_page_data_type: PageDataの型を変更 + change_page_data_result: 現在のPageDataの値:{prefix} + tab: + home: + title: ホーム + body: ここはホームのタブです。 + title_details: + title: タイトル詳細 + body: ここはタイトル詳細のタブです。 + my_page: + title: マイページ + body: ここはマイページのタブです。 + screen_layout_example: + title: ScreenLayout サンプル + body: ここはScreenLayoutのサンプルページです。 + sample_a: サンプルA + sample_b: サンプルB + base_description_before: | + このSizedBoxは300x300として指定されており、左右のSizedBoxはそれぞれ幅が37.5です。 + 実際の画面サイズに依存して、マージンが発生するか、Flutterが画面サイズが不足しているためにオーバーフローの警告を表示する可能性があります。 + ScreenLayout システムを使用することで、子要素の RenderSize は StandardBreakpoint で設定された値に基づいて拡大または縮小されます（ただし、maxScale を超えることはありません）。 + サンプルAは、ScreenLayoutを適用せずに生のオブジェクトです。 + base_description_after: | + サンプルBは、サンプルAにScreenLayoutを適用した結果です。実際の画面サイズが450以下の場合、これは完璧なサイズになるはずです。 + これは、画面の幅に基づいて外観を急激に変更したくないウィジェットを作成する場合や、 + タブレットと非タブレットのデバイス間で相対的なサイズを整列させたい場合（たとえばダイアログを表示する場合など）に役立ちます。 + description_case_equal: デバイスの幅が{width}であるため、ウィジェットは完璧に表示されます。（ScreenLayoutの機能をテストしたい場合は、幅が375でないデバイスで実行してみてください）。 + description_case_over: デバイスの幅が{width}であるため、左右にマージンがあります。 + description_case_other: デバイスの幅が{width}であるため、オーバーフローの警告が表示されています。 + description_sample: | + 前述の例では、StandardBreakpointに基づいてRenderSizeをスケーリングする方法を示しましたが、実際のウィジェットサイズはその親のサイズに依存します。 + ただし、実際のサイズに制約を加えたい場合があります。そのような場合、ConstrainedWidthを使用できます。 + ConstrainedWidthを指定することで、実際のサイズを変更し、依然としてStandardBreakpointに基づいてRenderSizeを自動計算する利点を得ることができます。 + また、サイズを制約するためにScreenLayoutウィジェットをConstrainedBoxなどで囲むと効果的です。 + ウィジェットツリー内の状況に基づいて適切なアプローチを選択してください。 + description_example: 上記の例では、ConstrainedWidthの値が200に設定されています。これにより、実際のサイズが200に制限されますが、コンテンツの相対的な形状が保持されていることが観察されます。 \ No newline at end of file diff --git a/packages/patapata_example_app/lib/exceptions.dart b/packages/patapata_example_app/lib/exceptions.dart new file mode 100644 index 0000000..95afa50 --- /dev/null +++ b/packages/patapata_example_app/lib/exceptions.dart @@ -0,0 +1,61 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +import '../src/errors.dart'; + +/// This is the exception class that occurs in this sample application. +/// Exceptions generated by an app using Patapata should inherit from [PatapataException]. +/// Please override the necessary members as specified. +base class ExampleException extends AppException { + const ExampleException({ + super.app, + super.message, + super.original, + super.fingerprint, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + super.fix, + super.logLevel, + super.userLogLevel, + }); + + @override + String get internalCode => '000'; +} + +/// This is the exception class for network-related issues that occur in this sample application. +base class ExampleNetworkException extends ExampleException { + final int statusCode; + + const ExampleNetworkException({ + required this.statusCode, + super.fix, + super.logLevel, + super.userLogLevel, + }); + + @override + String get defaultPrefix => 'APN'; + + @override + String get internalCode => '$statusCode'; + + @override + String get namespace => 'app.network'; +} + +/// This is the exception class for maintenance-related issues that occur in this sample application. +final class ExampleMaintenanceException extends ExampleNetworkException { + const ExampleMaintenanceException({ + required super.fix, + }) : super( + statusCode: 503, + userLogLevel: Level.SHOUT, + ); +} diff --git a/packages/patapata_example_app/lib/main.dart b/packages/patapata_example_app/lib/main.dart new file mode 100644 index 0000000..050c59a --- /dev/null +++ b/packages/patapata_example_app/lib/main.dart @@ -0,0 +1,326 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/pages/device_and_package_info_page.dart'; +import 'package:patapata_example_app/src/pages/standard_page_example_page.dart'; +import 'package:provider/provider.dart'; + +import 'page_data.dart'; +import 'src/cupertino/pages/top_page.dart'; +import 'src/cupertino/pages/home_page.dart'; +import 'src/cupertino/pages/my_page.dart'; +import 'src/environment.dart'; +import 'src/pages/config_page.dart'; +import 'src/pages/home_page.dart'; +import 'src/pages/my_page.dart'; +import 'src/pages/screen_layout_example_page.dart'; +import 'src/pages/top_page.dart'; +import 'src/startup.dart'; +import 'src/pages/error_page.dart'; +import 'src/pages/splash_page.dart'; +import 'src/pages/agreement_page.dart'; + +final _providerKey = GlobalKey(debugLabel: 'AppProviderKey'); +final logger = Logger('patapata.example'); + +void main() { + App( + environment: const Environment(), + startupSequence: StartupSequence( + startupStateFactories: [ + StartupStateFactory( + (startupSequence) => StartupStateCheckVersion(startupSequence), + [ + LogicStateTransition(), + ], + ), + StartupStateFactory( + (startupSequence) => StartupStateAgreements(startupSequence), + [], + ), + ], + ), + createAppWidget: _createAppWidget, + plugins: [], + providerKey: _providerKey, + ) + ..getPlugin()?.enableStandardAppIntegration() + ..run(() async { + // Do any initialization here + // Here's a good default + + // Set a default orientation of only portrait + await SystemChrome.setPreferredOrientations(const [ + DeviceOrientation.portraitDown, + DeviceOrientation.portraitUp, + ]); + + // Enable Edge-to-Edge mode + await SystemChrome.setEnabledSystemUIMode(SystemUiMode.edgeToEdge); + + // Make the status bars transparent + SystemChrome.setSystemUIOverlayStyle(const SystemUiOverlayStyle( + systemNavigationBarColor: Colors.transparent, + statusBarColor: Colors.transparent, + statusBarBrightness: Brightness.light, + statusBarIconBrightness: Brightness.dark, + )); + + // Set your RemoteConfig defaults here + await getApp().remoteConfig.setDefaults(const {}); + }); +} + +/// Returns either [StandardMaterialApp] or [StandardCupertinoApp] to be passed to [App.createAppWidget]. +/// The choice between the two depends on [Environment.appType] in [App.environment]. +/// If [flutter run --dart-define=APP_TYPE=cupertino] is used, it uses [StandardCupertinoApp]. +/// Otherwise, it uses [StandardMaterialApp]. +Widget _createAppWidget(BuildContext context, App app) { + if (app.environment.appType == 'cupertino') { + return StandardCupertinoApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // Splash screen page. + // This uses a special factory that has good defaults for splash screens. + SplashPageFactory( + create: (_) => SplashPage(), + ), + // Agreement page. + // This uses a special factory that all StartupSequence pages should use. + StartupPageFactory( + create: (_) => AgreementPage(), + ), + // Cupertino Top Page. + // This is the top page to navigate to after the AgreementPage. + // On this page, there are links to sample pages showcasing various features available in Patapata. + StandardPageFactory( + create: (_) => CupertinoTopPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + // Cupertino Tab and pages. + // CupertinoTitlePage are pages related to the tabs on the CupertinoHomePage. + // The parent of the tabs in Home is the CupertinoHomePage, and the first child page displayed within that tab is the CupertinoTitlePage. + StandardPageFactory( + create: (data) => CupertinoHomePage(), + ), + StandardPageFactory( + create: (data) => CupertinoTitlePage(), + parentPageType: CupertinoHomePage, + ), + // CupertinoMyFavoritePage is a page related to the tabs on CupertinoMyPage. + // The parent of the tabs in CupertinoMyPage is CupertinoMyPage itself, and the first child page displayed within that tab is CupertinoMyFavoritePage. + StandardPageFactory( + create: (data) => CupertinoMyPage(), + ), + StandardPageFactory( + create: (data) => CupertinoMyFavoritePage(), + parentPageType: CupertinoMyPage, + ), + ], + routableBuilder: (context, child) { + // Setup [ScreenLayout] + // You may want to move this to the body section of your Scaffold + // or somewhere where it makes sense for your app's design. + child = ScreenLayout(child: child); + + // Wrap the app in a key provided by you + // so you can access your providers from anywhere + // via context.read and context.watch. + child = KeyedSubtree( + key: _providerKey, + child: child, + ); + + return child; + }, + ); + } else { + return StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + // Splash screen page. + SplashPageFactory( + create: (_) => SplashPage(), + ), + // Agreement page. + StartupPageFactory( + create: (_) => AgreementPage(), + ), + // Error page. + StandardErrorPageFactory( + create: (_) => ErrorPage(), + ), + // Top Page. + StandardPageFactory( + create: (_) => TopPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + groupRoot: true, + ), + // LocalConfig Sample Page. + StandardPageFactory( + create: (_) => ConfigPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + // DeviceInfo and PackageInfo Sample Page. + StandardPageFactory( + create: (_) => DeviceAndPackageInfoPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + // Error Select Page. + StandardPageFactory( + create: (_) => ErrorSelectPage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + // Material Tab and pages. + // TitlePage and TitleDetailsPage are pages related to the tabs on the HomePage. + // The parent of the tabs in Home is the HomePage, + // and the first child page displayed within that tab is the TitlePage. + StandardPageFactory( + create: (data) => HomePage(), + ), + StandardPageFactory( + create: (data) => TitlePage(), + parentPageType: HomePage, + ), + StandardPageFactory( + create: (data) => TitleDetailsPage(), + parentPageType: HomePage, + ), + // MyFavoritePage is a page related to the tabs on MyPage. + // The parent of the tabs in MyPage is MyPage itself, + // and the first child page displayed within that tab is MyFavoritePage. + StandardPageFactory( + create: (data) => MyPage(), + ), + StandardPageFactory( + create: (data) => MyFavoritePage(), + parentPageType: MyPage, + ), + // The page with an example implementation of ScreenLayout. + StandardPageFactory( + create: (data) => ScreenLayoutExamplePage(), + ), + // Error page. + StandardErrorPageFactory( + create: (data) => ErrorPage(), + ), + // StandardPage And PageData Sample Page. + StandardPageFactory( + create: (_) => StandardPageExamplePage(), + links: { + r'': (match, uri) {}, + }, + linkGenerator: (pageData) => '', + ), + // HasDataPage is a page that receives PageData and displays it. + StandardPageFactory( + create: (data) => HasDataPage(), + ), + // CustomStandardPage is a page where the functionality of StandardPage is customized using pageBuilder. + // It customizes things like transition animations during navigation. + StandardPageFactory( + create: (data) => CustomStandardPage(), + pageBuilder: ( + child, + name, + pageData, + pageKey, + restorationId, + standardPageKey, + factoryObject, + ) { + return StandardCustomPage( + name: "Custom Page", + arguments: PageData(), + key: pageKey, + restorationId: restorationId, + standardPageKey: standardPageKey, + factoryObject: factoryObject, + opaque: true, + barrierDismissible: true, + barrierColor: Colors.blueAccent, + child: Column( + children: [ + Expanded(child: child), + const Text("test"), + ], + ), + transitionDuration: const Duration(milliseconds: 500), + transitionBuilder: + (context, animation, secondaryAnimation, child) { + return SlideTransition( + position: + Tween(begin: const Offset(0, 1), end: Offset.zero) + .animate(animation), + child: child, + ); + }, + ); + }, + ), + // ChangeListenablePage is an example where, instead of PageData, + // it can observe changes such as ChangeNotifier. + // BaseListenable inherits from ChangeNotifier. + StandardPageFactory( + create: (data) => ChangeListenablePage(), + ) + ], + routableBuilder: (context, child) { + // Setup [ScreenLayout] + // You may want to move this to the body section of your Scaffold + // or somewhere where it makes sense for your app's design. + child = ScreenLayout(child: child); + + // Wrap the app in a key provided by you + // so you can access your providers from anywhere + // via context.read and context.watch. + child = KeyedSubtree( + key: _providerKey, + child: child, + ); + + // If you want to customize a Theme, you can do it here + // by wrapping the child with a Theme widget. + // You can also wrap anything here and that Widget will + // be available to all pages. + return MultiProvider( + providers: [ + ChangeNotifierProvider( + create: (context) => CountData(), + ), + ChangeNotifierProvider( + create: (context) => ChangeListenableBool(), + ), + ChangeNotifierProvider( + create: (context) => ChangeListenableNumber(), + ), + ], + child: child, + ); + }, + ); + } +} diff --git a/packages/patapata_example_app/lib/page_data.dart b/packages/patapata_example_app/lib/page_data.dart new file mode 100644 index 0000000..25b1491 --- /dev/null +++ b/packages/patapata_example_app/lib/page_data.dart @@ -0,0 +1,34 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// This file contains the bundled PageData used as an example in StandardPage. + +import 'package:flutter/widgets.dart'; + +class PageData { + PageData({ + this.hello = 'hi!', + }); + final String hello; +} + +class CountData extends ChangeNotifier { + int count = 0; + + void increment() { + count = count + 1; + notifyListeners(); + } +} + +class BaseListenable extends ChangeNotifier {} + +class ChangeListenableBool extends BaseListenable { + bool data = false; +} + +class ChangeListenableNumber extends BaseListenable { + int data = 100; +} diff --git a/packages/patapata_example_app/lib/src/cupertino/pages/home_page.dart b/packages/patapata_example_app/lib/src/cupertino/pages/home_page.dart new file mode 100644 index 0000000..de9f998 --- /dev/null +++ b/packages/patapata_example_app/lib/src/cupertino/pages/home_page.dart @@ -0,0 +1,42 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/cupertino/widgets/app_tab.dart'; + +/// This sample transforms the HomePage, designed with Material's design, into Cupertino's design. +/// The structure remains the same as HomePage. +class CupertinoHomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + // When creating an application with features like a footer, please return childNavigator in the buildPage method. + return childNavigator ?? const SizedBox.shrink(); + } +} + +/// This sample transforms the TitlePage, designed with Material's design, into Cupertino's design. +/// The basic structure remains the same as TitlePage, but it uses an AppBar tailored for Cupertino. +class CupertinoTitlePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoAppBar( + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text( + l(context, 'pages.tab.home.body'), + ); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/cupertino/pages/my_page.dart b/packages/patapata_example_app/lib/src/cupertino/pages/my_page.dart new file mode 100644 index 0000000..a9d90b4 --- /dev/null +++ b/packages/patapata_example_app/lib/src/cupertino/pages/my_page.dart @@ -0,0 +1,42 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/cupertino/widgets/app_tab.dart'; + +/// This sample transforms the MyPage, designed with Material's design, into Cupertino's design. +/// The structure remains the same as MyPage. +class CupertinoMyPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + // When creating an application with features like a footer, please return childNavigator in the buildPage method. + return childNavigator ?? const SizedBox.shrink(); + } +} + +/// This sample transforms the MyFavoritePage, designed with Material's design, into Cupertino's design. +/// The basic structure remains the same as MyFavoritePage, but it uses an AppBar tailored for Cupertino. +class CupertinoMyFavoritePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoAppBar( + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text( + l(context, 'pages.tab.my_page.body'), + ); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/cupertino/pages/top_page.dart b/packages/patapata_example_app/lib/src/cupertino/pages/top_page.dart new file mode 100644 index 0000000..214a14b --- /dev/null +++ b/packages/patapata_example_app/lib/src/cupertino/pages/top_page.dart @@ -0,0 +1,33 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import 'home_page.dart'; + +/// Cupertino version of the TopPage. +class CupertinoTopPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return CupertinoPageScaffold( + navigationBar: CupertinoNavigationBar( + middle: Text(l(context, 'pages.top.title')), + ), + child: ListView( + children: [ + Text(l(context, 'pages.top.body')), + CupertinoButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_tab')), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/cupertino/widgets/app_tab.dart b/packages/patapata_example_app/lib/src/cupertino/widgets/app_tab.dart new file mode 100644 index 0000000..09c3584 --- /dev/null +++ b/packages/patapata_example_app/lib/src/cupertino/widgets/app_tab.dart @@ -0,0 +1,69 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/cupertino.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import '../pages/home_page.dart'; +import '../pages/my_page.dart'; + +/// Sample StandardApp for Cupertino with a widget displayed in a tab. +class CupertinoAppBar extends StatelessWidget { + const CupertinoAppBar({ + Key? key, + required this.body, + this.appBar, + }) : super(key: key); + + final Widget body; + final Widget? appBar; + + @override + Widget build(BuildContext context) { + var tInterfacePage = + ModalRoute.of(context)!.settings as StandardPageInterface; + var tType = tInterfacePage.factoryObject.parentPageType; + int tIndex = 0; + if (tType == CupertinoHomePage) { + tIndex = 0; + } else if (tType == CupertinoMyPage) { + tIndex = 1; + } + + return CupertinoPageScaffold( + navigationBar: CupertinoNavigationBar( + leading: const StandardPageBackButton(), + middle: tIndex == 0 + ? Text(l(context, 'pages.tab.home.title')) + : Text(l(context, 'pages.tab.my_page.title')), + ), + child: Column( + children: [ + Expanded( + child: body, + ), + Row( + mainAxisAlignment: MainAxisAlignment.spaceAround, + children: [ + CupertinoButton( + onPressed: () { + context.go(null); + }, + child: const Icon(CupertinoIcons.home), + ), + CupertinoButton( + onPressed: () { + context.go(null); + }, + child: const Icon(CupertinoIcons.heart), + ), + ], + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/environment.dart b/packages/patapata_example_app/lib/src/environment.dart new file mode 100644 index 0000000..7a7c769 --- /dev/null +++ b/packages/patapata_example_app/lib/src/environment.dart @@ -0,0 +1,41 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:flutter/widgets.dart'; + +/// The Environment class for this app. +/// Controls all static settings for the app. +/// Pass this to the [App] constructor. +/// [appType]" is a variable passed as a command-line argument with the name "APP_TYPE" when executed through 'flutter run. +class Environment with I18nEnvironment, LogEnvironment { + @override + final List supportedL10ns = const [ + Locale('en'), + Locale('ja'), + Locale('ar'), + ]; + + @override + final List l10nPaths = const [ + 'l10n', + ]; + + @override + final int logLevel; + + @override + final bool printLog; + + const Environment({ + this.logLevel = + const int.fromEnvironment('LOG_LEVEL', defaultValue: -kPataInHex), + this.printLog = + const bool.fromEnvironment('PRINT_LOG', defaultValue: kDebugMode), + }); + + final String? appType = const String.fromEnvironment('APP_TYPE'); +} diff --git a/packages/patapata_example_app/lib/src/errors.dart b/packages/patapata_example_app/lib/src/errors.dart new file mode 100644 index 0000000..3c41c8c --- /dev/null +++ b/packages/patapata_example_app/lib/src/errors.dart @@ -0,0 +1,56 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +/// This is the abstract class for exceptions that occur in the sample application. +abstract base class AppException extends PatapataException { + const AppException({ + super.app, + super.message, + super.original, + super.fingerprint, + super.localeTitleData, + super.localeMessageData, + super.localeFixData, + super.fix, + super.logLevel, + super.userLogLevel, + }); + + @override + String get defaultPrefix => 'APE'; + + @override + String get namespace => 'app'; +} + +/// An exception that is thrown when the app encounters an unknown error. +final class AppUnknownException extends AppException { + const AppUnknownException(); + + @override + String get internalCode => '000'; +} + +/// Thrown when an unsupported version (usually old) of the app is detected. +final class AppVersionException extends AppException { + const AppVersionException() : super(logLevel: Level.INFO); + + @override + String get internalCode => '010'; + + @override + void onReported(ReportRecord record) { + showDialog(getApp().navigatorContext); + } + + @override + Future Function()? get fix => () async { + // Launch the app store. + }; +} diff --git a/packages/patapata_example_app/lib/src/pages/agreement_page.dart b/packages/patapata_example_app/lib/src/pages/agreement_page.dart new file mode 100644 index 0000000..aa45aab --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/agreement_page.dart @@ -0,0 +1,43 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +/// This is an implementation of a screen where users can agree to the app's terms and conditions. +/// It appears after the splash screen. If the user does not agree, they will be taken back to the splash screen again. +class AgreementPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.agreement.title')), + ), + body: Column( + children: [ + Center( + child: Text( + l(context, 'pages.agreement.body'), + ), + ), + TextButton( + child: Text(l(context, 'pages.agreement.yes')), + onPressed: () { + pageData(null); + }, + ), + TextButton( + child: Text(l(context, 'pages.agreement.no')), + onPressed: () { + // Calling the sequence processing again will resume the sequence from the beginning. + getApp().startupSequence?.resetMachine(); + }, + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/config_page.dart b/packages/patapata_example_app/lib/src/pages/config_page.dart new file mode 100644 index 0000000..010fcf4 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/config_page.dart @@ -0,0 +1,57 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; + +/// This is a page demonstrating how to use LocalConfig. +/// Here, values are being saved, modified, and retrieved for a LocalConfig with the key name counter. +class ConfigPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.config.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l(context, 'pages.config.body')), + ), + Center( + child: Builder( + builder: (context) { + // Retrieve the value of counter from LocalConfig. + return Text( + l(context, 'plurals.test1', { + 'count': context + .select((v) => v.getInt('counter')) + }), + ); + }, + ), + ), + TextButton( + onPressed: () { + // Set the value of counter in LocalConfig. + getApp().localConfig.setInt( + 'counter', getApp().localConfig.getInt('counter') + 1); + }, + child: Text(l(context, 'pages.config.increment')), + ), + TextButton( + onPressed: () { + // Delete the value stored in LocalConfig. + getApp().localConfig.reset('counter'); + }, + child: Text(l(context, 'pages.config.clear')), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/device_and_package_info_page.dart b/packages/patapata_example_app/lib/src/pages/device_and_package_info_page.dart new file mode 100644 index 0000000..243556f --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/device_and_package_info_page.dart @@ -0,0 +1,134 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +/// This is a page demonstrating how to use DeviceInfo and PackageInfo. +class DeviceAndPackageInfoPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + // Get the device model name. + // If the platform is Web, you can retrieve the browser name. + String model = ""; + if (kIsWeb) { + model = getApp().device.webInfo!.browserName.toString(); + } else if (defaultTargetPlatform == TargetPlatform.android) { + model = getApp().device.androidDeviceInfo!.model; + } else if (defaultTargetPlatform == TargetPlatform.iOS) { + model = getApp().device.iosDeviceInfo!.model; + } else if (defaultTargetPlatform == TargetPlatform.windows) { + model = getApp().device.windowsInfo!.computerName; + } else if (defaultTargetPlatform == TargetPlatform.linux) { + model = getApp().device.linuxInfo!.prettyName; + } else if (defaultTargetPlatform == TargetPlatform.macOS) { + model = getApp().device.macOsInfo!.model; + } + + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.device_and_package_info.title')), + ), + body: ListView( + children: [ + Center( + child: Text( + l(context, 'pages.device_and_package_info.body'), + ), + ), + Table( + border: TableBorder.all(), + children: [ + TableRow( + children: [ + TableCell( + child: Center( + child: Text( + l(context, 'pages.device_and_package_info.model')), + ), + ), + TableCell( + child: Center(child: Text(model)), + ), + ], + ), + TableRow( + children: [ + TableCell( + child: Center( + child: Text( + l(context, 'pages.device_and_package_info.app_name')), + ), + ), + TableCell( + // Get the app name from PackageInfo. + child: Center(child: Text(getApp().package.info.appName)), + ), + ], + ), + TableRow( + children: [ + TableCell( + child: Center( + child: Text(l(context, + 'pages.device_and_package_info.build_number'))), + ), + TableCell( + // Get the build number from PackageInfo. + child: + Center(child: Text(getApp().package.info.buildNumber)), + ), + ], + ), + TableRow( + children: [ + TableCell( + child: Center( + child: Text(l(context, + 'pages.device_and_package_info.build_signature'))), + ), + TableCell( + // Get the build signature from PackageInfo. + child: Center( + child: Text(getApp().package.info.buildSignature)), + ), + ], + ), + TableRow( + children: [ + TableCell( + child: Center( + child: Text(l(context, + 'pages.device_and_package_info.package_name'))), + ), + TableCell( + // Get the package name from PackageInfo. + child: + Center(child: Text(getApp().package.info.packageName)), + ), + ], + ), + TableRow( + children: [ + TableCell( + child: Center( + child: Text(l( + context, 'pages.device_and_package_info.version'))), + ), + // Get the app version from PackageInfo. + TableCell( + child: Center(child: Text(getApp().package.info.version)), + ), + ], + ), + ], + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/error_page.dart b/packages/patapata_example_app/lib/src/pages/error_page.dart new file mode 100644 index 0000000..fb4f883 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/error_page.dart @@ -0,0 +1,131 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; + +import '../../exceptions.dart'; +import '../../main.dart'; +import '../errors.dart'; + +/// ErrorPage is a page that is displayed when an error occurs in the application. +class ErrorPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + if (pageData.error is AppException) { + return _buildAppExceptionPage(context); + } else { + return _buildUnknownExceptionPage(context); + } + } + + Widget _buildAppExceptionPage(BuildContext context) { + final tAppException = pageData.error as AppException; + + return Scaffold( + appBar: AppBar( + title: Text(tAppException.localizedTitle), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Text(tAppException.localizedMessage), + if (tAppException.hasFix) + TextButton( + child: Text(tAppException.localizedFix), + onPressed: () { + tAppException.fix!(); + }, + ), + ], + ), + ), + ); + } + + Widget _buildUnknownExceptionPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'errors.app.000.title')), + ), + body: SingleChildScrollView( + child: Column( + children: [ + Text(l(context, 'errors.app.000.message')), + ], + ), + ), + ); + } +} + +/// ErrorSelectPage is a page that allows you to select the type of error to display. +class ErrorSelectPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.error.title')), + ), + body: ListView( + children: [ + // Throw an exception named ExampleException, defined in the sample app, and log it. + TextButton( + onPressed: () { + try { + throw const ExampleException(); + } on PatapataException catch (e) { + e.showDialog(context); + logger.severe(e.toString(), e); + } + }, + child: Text(l(context, 'pages.error.example')), + ), + // Throw a network exception named ExampleNetworkException, defined in the sample app, and log it. + // Specify the network status code in the statusCode argument of ExampleNetworkException. + TextButton( + onPressed: () { + try { + throw const ExampleNetworkException(statusCode: 404); + } on PatapataException catch (e) { + e.showDialog(context); + logger.severe(e.toString(), e); + } + }, + child: Text(l(context, 'pages.error.network', {'prefix': '404'})), + ), + TextButton( + onPressed: () { + try { + throw const ExampleNetworkException(statusCode: 500); + } on PatapataException catch (e) { + e.showDialog(context); + logger.severe(e.toString(), e); + } + }, + child: Text(l(context, 'pages.error.network', {'prefix': '500'})), + ), + // Throw ExampleMaintenanceException, transition to the maintenance page, and navigate to ErrorSelectPage. + TextButton( + onPressed: () { + final tDelegate = context.read().standardAppPlugin.delegate; + try { + throw ExampleMaintenanceException(fix: () async { + tDelegate?.go( + null, StandardPageNavigationMode.removeAll); + }); + } catch (e) { + logger.severe(e.toString(), e); + } + }, + child: Text(l(context, 'pages.error.maintenance')), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/home_page.dart b/packages/patapata_example_app/lib/src/pages/home_page.dart new file mode 100644 index 0000000..3bfdfd6 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/home_page.dart @@ -0,0 +1,77 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/widgets/app_tab.dart'; + +/// [HomePage] is the parent StandardPage for applications with a tabbed footer. +/// This HomePage has two child StandardPages, namely [TitlePage] and [TitleDetailsPage]. +class HomePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + // When creating an application with features like a footer, please return childNavigator in the buildPage method. + return childNavigator ?? const SizedBox.shrink(); + } +} + +/// [TitlePage] is a StandardPage representing the [HomePage] tab in an application with a tabbed footer. +class TitlePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return AppTab( + appBar: AppBar( + title: Text(l(context, 'pages.tab.home.title')), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton(), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text(l(context, 'pages.tab.home.body')); + }, + ), + ), + TextButton( + child: Text(l(context, 'pages.tab.title_details.title')), + onPressed: () { + context.go(null); + }, + ), + ], + ), + ); + } +} + +/// [TitleDetailsPage] is a StandardPage that serves as a child of [TitlePage] in the [HomePage] tab of an application with a tabbed footer. +class TitleDetailsPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return AppTab( + appBar: AppBar( + title: Text(l(context, 'pages.tab.title_details.title')), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton(), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text( + l(context, 'pages.tab.title_details.body'), + ); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/my_page.dart b/packages/patapata_example_app/lib/src/pages/my_page.dart new file mode 100644 index 0000000..157aa64 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/my_page.dart @@ -0,0 +1,46 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/widgets/app_tab.dart'; + +/// [MyPage] is the parent StandardPage for applications with a tabbed footer. +/// This MyPage has one child StandardPage named [MyFavoritePage]. +class MyPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + // When creating an application with features like a footer, please return childNavigator in the buildPage method. + return childNavigator ?? const SizedBox.shrink(); + } +} + +/// [MyPage] is a StandardPage representing the [MyFavoritePage] tab in an application with a tabbed footer. +class MyFavoritePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return AppTab( + appBar: AppBar( + title: Text(l(context, 'pages.tab.my_page.title')), + automaticallyImplyLeading: false, + leading: const StandardPageBackButton(), + ), + body: ListView( + children: [ + Center( + child: Builder( + builder: (context) { + return Text( + l(context, 'pages.tab.my_page.body'), + ); + }, + ), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/screen_layout_example_page.dart b/packages/patapata_example_app/lib/src/pages/screen_layout_example_page.dart new file mode 100644 index 0000000..c3dd288 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/screen_layout_example_page.dart @@ -0,0 +1,143 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +class ScreenLayoutExamplePage extends StandardPage { + final _breakpoints = const ScreenLayoutBreakpoints( + portraitStandardBreakpoint: 375.0, + portraitConstrainedWidth: double.infinity, + landscapeStandardBreakpoint: 375.0, + landscapeConstrainedWidth: double.infinity, + maxScale: 1.2, + ); + + String createSampleDescription(double width) { + String tDescription = + l(context, 'pages.screen_layout_example.base_description_before'); + + if (width == 375) { + tDescription += l( + context, + 'pages.screen_layout_example.description_case_equal', + {'width': widget}, + ); + } else if (width > 375) { + tDescription += l( + context, + 'pages.screen_layout_example.description_case_over', + {'width': widget}, + ); + } else { + tDescription += l( + context, + 'pages.screen_layout_example.description_case_other', + {'width': widget}, + ); + } + + tDescription += + l(context, 'pages.screen_layout_example.base_description_before'); + + return tDescription; + } + + @override + Widget buildPage(BuildContext context) { + Widget fCreateSampleChild() { + return Row( + mainAxisSize: MainAxisSize.max, + mainAxisAlignment: MainAxisAlignment.center, + children: [ + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + child: const Center(child: Text('37.5')), + ), + ), + SizedBox( + width: 300, + height: 300, + child: ColoredBox( + color: Colors.deepOrange.shade100, + child: const Center(child: Text('w300 x h300')), + ), + ), + SizedBox( + width: 37.5, + height: 300, + child: ColoredBox( + color: Colors.blue.shade100, + child: const Center(child: Text('37.5')), + ), + ), + ], + ); + } + + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.screen_layout_example.title')), + ), + body: Center( + child: ListView( + children: [ + Center( + child: Text(l(context, 'pages.screen_layout_example.body')), + ), + Padding( + padding: const EdgeInsets.all(8), + child: Text( + createSampleDescription(MediaQuery.of(context).size.width), + ), + ), + Center( + child: Text( + l(context, 'pages.screen_layout_example.sample_a'), + style: const TextStyle(fontSize: 24), + ), + ), + fCreateSampleChild(), + const SizedBox(height: 32), + Center( + child: Text( + l(context, 'pages.screen_layout_example.sample_b'), + style: const TextStyle(fontSize: 24), + ), + ), + ScreenLayout( + breakpoints: _breakpoints, + child: fCreateSampleChild(), + ), + const SizedBox(height: 32), + Padding( + padding: const EdgeInsets.all(8), + child: + Text(l(context, 'pages.screen_layout_example.description')), + ), + Center( + child: ScreenLayout( + breakpoints: _breakpoints.copyWith( + portraitConstrainedWidth: 200, + ), + child: fCreateSampleChild(), + ), + ), + Padding( + padding: const EdgeInsets.all(8), + child: Text( + l(context, 'pages.screen_layout_example.description_example'), + ), + ), + ], + ), + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/splash_page.dart b/packages/patapata_example_app/lib/src/pages/splash_page.dart new file mode 100644 index 0000000..e167e31 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/splash_page.dart @@ -0,0 +1,19 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +/// This is the page displayed after the app is launched. It shows the Flutter logo. +class SplashPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return const Center( + child: FlutterLogo( + size: 128, + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/standard_page_example_page.dart b/packages/patapata_example_app/lib/src/pages/standard_page_example_page.dart new file mode 100644 index 0000000..59bd5ab --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/standard_page_example_page.dart @@ -0,0 +1,161 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:provider/provider.dart'; + +import '../../page_data.dart'; + +/// The simplest example of StandardPage without holding any PageData. +class StandardPageExamplePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.standard_page.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l(context, 'pages.standard_page.body')), + ), + TextButton( + onPressed: () { + context.go(PageData()); + }, + child: Text( + l(context, 'pages.standard_page.go_to_next_standard_page')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text( + l(context, 'pages.standard_page.go_to_custom_standard_page')), + ), + TextButton( + onPressed: () { + context.go( + ChangeListenableNumber(), + ); + }, + child: Text(l(context, 'pages.standard_page.go_to_page_data')), + ), + ], + ), + ); + } +} + +/// An example of a StandardPage that holds PageData. +/// To create a StandardPage with PageData, specify the type of PageData as the type argument for StandardPage. +/// To access members of this PageData, you can use syntax like pageData.hello. +class HasDataPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.standard_page.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l( + context, + 'pages.standard_page.page_data_value', + // You can access members of PageData like this. + {'prefix': pageData.hello})), + ), + TextButton( + onPressed: () { + // You can change the value of PageData like this. + pageData = PageData(hello: 'change hi!'); + setState(() {}); + }, + child: Text(l(context, 'pages.standard_page.change_page_data')), + ), + ], + ), + ); + } +} + +/// A page to display a customized StandardPage. +class CustomStandardPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.standard_page.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l(context, 'pages.standard_page.body')), + ), + ], + ), + ); + } +} + +/// Example of manipulating or modifying values in PageData and retrieving values through a Provider in StandardPage. +class ChangeListenablePage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.standard_page.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l(context, 'pages.standard_page.body')), + ), + Center( + // Observe changes to the value of CountData set in MultiProvider within routableBuilder. + child: Text(l(context, 'pages.standard_page.page_data_count', + {'prefix': context.watch().count})), + ), + TextButton( + onPressed: () { + // An example of changing the type of pageData to another class that extends ChangeNotifier. + if (pageData is ChangeListenableBool) { + pageData = ChangeListenableNumber(); + } else { + pageData = ChangeListenableBool(); + } + setState(() {}); + }, + child: + Text(l(context, 'pages.standard_page.change_page_data_type')), + ), + if (pageData is ChangeListenableBool) + Center( + child: Text(l( + context, + 'pages.standard_page.change_page_data_result', + {'prefix': context.watch().data})), + ), + if (pageData is ChangeListenableNumber) + Center( + child: Text(l( + context, + 'pages.standard_page.change_page_data_result', + {'prefix': context.watch().data})), + ), + ], + ), + floatingActionButton: FloatingActionButton( + onPressed: () { + context.read().increment(); + }, + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/pages/top_page.dart b/packages/patapata_example_app/lib/src/pages/top_page.dart new file mode 100644 index 0000000..1536065 --- /dev/null +++ b/packages/patapata_example_app/lib/src/pages/top_page.dart @@ -0,0 +1,71 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_example_app/src/pages/device_and_package_info_page.dart'; +import 'package:patapata_example_app/src/pages/error_page.dart'; +import 'package:patapata_example_app/src/pages/standard_page_example_page.dart'; + +import 'config_page.dart'; +import 'screen_layout_example_page.dart'; +import 'home_page.dart'; + +/// Material version of the TopPage. +/// You can navigate to a sample screen demonstrating the features of Patapata from this pages. +class TopPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(l(context, 'pages.top.title')), + ), + body: ListView( + children: [ + Center( + child: Text(l(context, 'pages.top.body')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_config')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_screen_layout')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_standard_page')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_device_and_pakage_info')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_error')), + ), + TextButton( + onPressed: () { + context.go(null); + }, + child: Text(l(context, 'pages.top.go_to_tab')), + ), + ], + ), + ); + } +} diff --git a/packages/patapata_example_app/lib/src/startup.dart b/packages/patapata_example_app/lib/src/startup.dart new file mode 100644 index 0000000..f7fa442 --- /dev/null +++ b/packages/patapata_example_app/lib/src/startup.dart @@ -0,0 +1,53 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:patapata_core/patapata_core.dart'; + +import 'pages/agreement_page.dart'; + +class StartupStateCheckVersion extends StartupState { + StartupStateCheckVersion(StartupSequence startupSequence) + : super(startupSequence); + + @override + Future process(Object? data) async { + // Check the version here + // If the version is not supported, throw an exception + // and the app will show the error page. + // If the version is supported, transition to the next state. + + return Future.delayed(const Duration(milliseconds: 1000)); + } +} + +class StartupStateAgreements extends StartupState { + /// The version of the agreement. + /// This should be incremented when the agreement changes. + static const kVersion = '1'; + + // static const _kAgreementVersionKey = 'agreementVersion'; + + StartupStateAgreements(StartupSequence startupSequence) + : super(startupSequence); + + @override + Future process(Object? data) async { + // Check if the user has agreed to the agreement. + // If the user has agreed, return. + // if (getApp().localConfig.getString(_kAgreementVersionKey) == kVersion) { + // return; + // } + + await navigateToPage(AgreementPage, (result) {}); + + // Show the agreement page here. + // If the user agrees, call pageData(null); + // If the user does not agree, call getApp().startupSequence?.resetMachine(); + // which will reset the startup sequence. + // if (await navigateToPage(AgreementPage, (result) {})) { + // await getApp().localConfig.setString(_kAgreementVersionKey, kVersion); + // } + } +} diff --git a/packages/patapata_example_app/lib/src/widgets/app_tab.dart b/packages/patapata_example_app/lib/src/widgets/app_tab.dart new file mode 100644 index 0000000..0ffd88f --- /dev/null +++ b/packages/patapata_example_app/lib/src/widgets/app_tab.dart @@ -0,0 +1,66 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; + +import '../pages/home_page.dart'; +import '../pages/my_page.dart'; + +/// A sample StandardApp for Material with a widget displayed in a tab. +class AppTab extends StatelessWidget { + const AppTab({ + Key? key, + required this.body, + this.appBar, + }) : super(key: key); + + final Widget body; + final PreferredSizeWidget? appBar; + + @override + Widget build(BuildContext context) { + var tInterfacePage = + ModalRoute.of(context)!.settings as StandardPageInterface; + var tType = tInterfacePage.factoryObject.parentPageType; + int tIndex = 0; + if (tType == HomePage) { + tIndex = 0; + } else if (tType == MyPage) { + tIndex = 1; + } + + return Scaffold( + body: body, + appBar: appBar, + bottomNavigationBar: BottomNavigationBar( + onTap: (index) { + switch (index) { + case 0: + context.go(null); + break; + case 1: + context.go(null); + break; + default: + break; + } + }, + currentIndex: tIndex, + selectedItemColor: Colors.red, + items: [ + BottomNavigationBarItem( + icon: const Icon(Icons.home), + label: l(context, 'pages.tab.home.title')), + BottomNavigationBarItem( + icon: const Icon(Icons.favorite), + label: l(context, 'pages.tab.my_page.title')), + ], + type: BottomNavigationBarType.fixed, + ), + ); + } +} diff --git a/packages/patapata_example_app/linux/.gitignore b/packages/patapata_example_app/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/packages/patapata_example_app/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/packages/patapata_example_app/linux/CMakeLists.txt b/packages/patapata_example_app/linux/CMakeLists.txt new file mode 100644 index 0000000..895fd7d --- /dev/null +++ b/packages/patapata_example_app/linux/CMakeLists.txt @@ -0,0 +1,139 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.10) +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 "patapata_example_app") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.example.patapata_example_app") + +# 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) + +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Define the application target. To change its name, change BINARY_NAME above, +# 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 dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +# 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) + +# 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/patapata_example_app/linux/flutter/CMakeLists.txt b/packages/patapata_example_app/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..d5bd016 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/linux/flutter/generated_plugin_registrant.cc b/packages/patapata_example_app/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..e71a16d --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/linux/flutter/generated_plugin_registrant.h b/packages/patapata_example_app/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..e0f0a47 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/linux/flutter/generated_plugins.cmake b/packages/patapata_example_app/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2e1de87 --- /dev/null +++ b/packages/patapata_example_app/linux/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +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/patapata_example_app/linux/main.cc b/packages/patapata_example_app/linux/main.cc new file mode 100644 index 0000000..800a5ef --- /dev/null +++ b/packages/patapata_example_app/linux/main.cc @@ -0,0 +1,11 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#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/patapata_example_app/linux/my_application.cc b/packages/patapata_example_app/linux/my_application.cc new file mode 100644 index 0000000..b5b2ec1 --- /dev/null +++ b/packages/patapata_example_app/linux/my_application.cc @@ -0,0 +1,109 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#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) + +// 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, "patapata_example_app"); + 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, "patapata_example_app"); + } + + gtk_window_set_default_size(window, 1280, 720); + gtk_widget_show(GTK_WIDGET(window)); + + 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); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), 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 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_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, + "flags", G_APPLICATION_NON_UNIQUE, + nullptr)); +} diff --git a/packages/patapata_example_app/linux/my_application.h b/packages/patapata_example_app/linux/my_application.h new file mode 100644 index 0000000..5dc9ce0 --- /dev/null +++ b/packages/patapata_example_app/linux/my_application.h @@ -0,0 +1,23 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#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/patapata_example_app/macos/.gitignore b/packages/patapata_example_app/macos/.gitignore new file mode 100644 index 0000000..746adbb --- /dev/null +++ b/packages/patapata_example_app/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/packages/patapata_example_app/macos/Flutter/Flutter-Debug.xcconfig b/packages/patapata_example_app/macos/Flutter/Flutter-Debug.xcconfig new file mode 100644 index 0000000..4b81f9b --- /dev/null +++ b/packages/patapata_example_app/macos/Flutter/Flutter-Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/packages/patapata_example_app/macos/Flutter/Flutter-Release.xcconfig b/packages/patapata_example_app/macos/Flutter/Flutter-Release.xcconfig new file mode 100644 index 0000000..5caa9d1 --- /dev/null +++ b/packages/patapata_example_app/macos/Flutter/Flutter-Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/packages/patapata_example_app/macos/Flutter/GeneratedPluginRegistrant.swift b/packages/patapata_example_app/macos/Flutter/GeneratedPluginRegistrant.swift new file mode 100644 index 0000000..6eb1472 --- /dev/null +++ b/packages/patapata_example_app/macos/Flutter/GeneratedPluginRegistrant.swift @@ -0,0 +1,20 @@ +// +// Generated file. Do not edit. +// + +import FlutterMacOS +import Foundation + +import connectivity_plus +import device_info_plus +import flutter_local_notifications +import package_info_plus +import patapata_core + +func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { + ConnectivityPlugin.register(with: registry.registrar(forPlugin: "ConnectivityPlugin")) + DeviceInfoPlusMacosPlugin.register(with: registry.registrar(forPlugin: "DeviceInfoPlusMacosPlugin")) + FlutterLocalNotificationsPlugin.register(with: registry.registrar(forPlugin: "FlutterLocalNotificationsPlugin")) + FPPPackageInfoPlusPlugin.register(with: registry.registrar(forPlugin: "FPPPackageInfoPlusPlugin")) + PatapataCorePlugin.register(with: registry.registrar(forPlugin: "PatapataCorePlugin")) +} diff --git a/packages/patapata_example_app/macos/Podfile b/packages/patapata_example_app/macos/Podfile new file mode 100644 index 0000000..c795730 --- /dev/null +++ b/packages/patapata_example_app/macos/Podfile @@ -0,0 +1,43 @@ +platform :osx, '10.14' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\"" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_macos_podfile_setup + +target 'Runner' do + use_frameworks! + use_modular_headers! + + flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_macos_build_settings(target) + end +end diff --git a/packages/patapata_example_app/macos/Runner.xcodeproj/project.pbxproj b/packages/patapata_example_app/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..0352351 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,695 @@ +// !$*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 /* patapata_example_app.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "patapata_example_app.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 /* patapata_example_app.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 /* patapata_example_app.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1430; + 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.patapataExampleApp.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/patapata_example_app.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/patapata_example_app"; + }; + 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.patapataExampleApp.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/patapata_example_app.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/patapata_example_app"; + }; + 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.patapataExampleApp.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/patapata_example_app.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/patapata_example_app"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + 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; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + 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.14; + 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; + 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; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + 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.14; + 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; + 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; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + 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.14; + 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/patapata_example_app/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_example_app/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_example_app/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/patapata_example_app/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..059d4f1 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/macos/Runner.xcworkspace/contents.xcworkspacedata b/packages/patapata_example_app/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/packages/patapata_example_app/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/packages/patapata_example_app/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/packages/patapata_example_app/macos/Runner/AppDelegate.swift b/packages/patapata_example_app/macos/Runner/AppDelegate.swift new file mode 100644 index 0000000..8ee8c00 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/AppDelegate.swift @@ -0,0 +1,14 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Cocoa +import FlutterMacOS + +@NSApplicationMain +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } +} diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..a2ec33f --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 0000000..82b6f9d Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 0000000..13b35eb Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 0000000..0a3f5fa Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 0000000..bdb5722 Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 0000000..f083318 Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 0000000..326c0e7 Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 0000000..2f1632c Binary files /dev/null and b/packages/patapata_example_app/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/packages/patapata_example_app/macos/Runner/Base.lproj/MainMenu.xib b/packages/patapata_example_app/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 0000000..80e867a --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/macos/Runner/Configs/AppInfo.xcconfig b/packages/patapata_example_app/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 0000000..818ce49 --- /dev/null +++ b/packages/patapata_example_app/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 = patapata_example_app + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = com.example.patapataExampleApp + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2023 com.example. All rights reserved. diff --git a/packages/patapata_example_app/macos/Runner/Configs/Debug.xcconfig b/packages/patapata_example_app/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 0000000..36b0fd9 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/packages/patapata_example_app/macos/Runner/Configs/Release.xcconfig b/packages/patapata_example_app/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 0000000..dff4f49 --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/packages/patapata_example_app/macos/Runner/Configs/Warnings.xcconfig b/packages/patapata_example_app/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 0000000..42bcbf4 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/macos/Runner/DebugProfile.entitlements b/packages/patapata_example_app/macos/Runner/DebugProfile.entitlements new file mode 100644 index 0000000..dddb8a3 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/macos/Runner/Info.plist b/packages/patapata_example_app/macos/Runner/Info.plist new file mode 100644 index 0000000..4789daa --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/macos/Runner/MainFlutterWindow.swift b/packages/patapata_example_app/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 0000000..ca5847a --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +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/patapata_example_app/macos/Runner/Release.entitlements b/packages/patapata_example_app/macos/Runner/Release.entitlements new file mode 100644 index 0000000..852fa1a --- /dev/null +++ b/packages/patapata_example_app/macos/Runner/Release.entitlements @@ -0,0 +1,8 @@ + + + + + com.apple.security.app-sandbox + + + diff --git a/packages/patapata_example_app/macos/RunnerTests/RunnerTests.swift b/packages/patapata_example_app/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..06224b4 --- /dev/null +++ b/packages/patapata_example_app/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,17 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import FlutterMacOS +import Cocoa +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/patapata_example_app/pubspec.yaml b/packages/patapata_example_app/pubspec.yaml new file mode 100644 index 0000000..3518be2 --- /dev/null +++ b/packages/patapata_example_app/pubspec.yaml @@ -0,0 +1,93 @@ +name: patapata_example_app +description: This package is a sample application that demonstrates how to use the features of patapata_core. +# 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 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_example_app + +# 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.1.0 <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 + + patapata_core: ^1.0.0 + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.2 + provider: ^6.0.5 + +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: ^2.0.0 + +# 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: + uses-material-design: true + + assets: + - l10n/ + + # 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/assets-and-images/#resolution-aware + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/assets-and-images/#from-packages + + # 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/custom-fonts/#from-packages diff --git a/packages/patapata_example_app/web/favicon.png b/packages/patapata_example_app/web/favicon.png new file mode 100644 index 0000000..8aaa46a Binary files /dev/null and b/packages/patapata_example_app/web/favicon.png differ diff --git a/packages/patapata_example_app/web/icons/Icon-192.png b/packages/patapata_example_app/web/icons/Icon-192.png new file mode 100644 index 0000000..b749bfe Binary files /dev/null and b/packages/patapata_example_app/web/icons/Icon-192.png differ diff --git a/packages/patapata_example_app/web/icons/Icon-512.png b/packages/patapata_example_app/web/icons/Icon-512.png new file mode 100644 index 0000000..88cfd48 Binary files /dev/null and b/packages/patapata_example_app/web/icons/Icon-512.png differ diff --git a/packages/patapata_example_app/web/icons/Icon-maskable-192.png b/packages/patapata_example_app/web/icons/Icon-maskable-192.png new file mode 100644 index 0000000..eb9b4d7 Binary files /dev/null and b/packages/patapata_example_app/web/icons/Icon-maskable-192.png differ diff --git a/packages/patapata_example_app/web/icons/Icon-maskable-512.png b/packages/patapata_example_app/web/icons/Icon-maskable-512.png new file mode 100644 index 0000000..d69c566 Binary files /dev/null and b/packages/patapata_example_app/web/icons/Icon-maskable-512.png differ diff --git a/packages/patapata_example_app/web/index.html b/packages/patapata_example_app/web/index.html new file mode 100644 index 0000000..61df46e --- /dev/null +++ b/packages/patapata_example_app/web/index.html @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + patapata_example_app + + + + + + + + + + diff --git a/packages/patapata_example_app/web/manifest.json b/packages/patapata_example_app/web/manifest.json new file mode 100644 index 0000000..2926f6d --- /dev/null +++ b/packages/patapata_example_app/web/manifest.json @@ -0,0 +1,35 @@ +{ + "name": "patapata_example_app", + "short_name": "patapata_example_app", + "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/patapata_example_app/windows/.gitignore b/packages/patapata_example_app/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/windows/CMakeLists.txt b/packages/patapata_example_app/windows/CMakeLists.txt new file mode 100644 index 0000000..f69ed51 --- /dev/null +++ b/packages/patapata_example_app/windows/CMakeLists.txt @@ -0,0 +1,102 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(patapata_example_app 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 "patapata_example_app") + +# 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() + +# 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/patapata_example_app/windows/flutter/CMakeLists.txt b/packages/patapata_example_app/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..930d207 --- /dev/null +++ b/packages/patapata_example_app/windows/flutter/CMakeLists.txt @@ -0,0 +1,104 @@ +# 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") + +# === 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" + windows-x64 $ + 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/patapata_example_app/windows/flutter/generated_plugin_registrant.cc b/packages/patapata_example_app/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8777c93 --- /dev/null +++ b/packages/patapata_example_app/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,14 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + +#include + +void RegisterPlugins(flutter::PluginRegistry* registry) { + ConnectivityPlusWindowsPluginRegisterWithRegistrar( + registry->GetRegistrarForPlugin("ConnectivityPlusWindowsPlugin")); +} diff --git a/packages/patapata_example_app/windows/flutter/generated_plugin_registrant.h b/packages/patapata_example_app/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/windows/flutter/generated_plugins.cmake b/packages/patapata_example_app/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..cc1361d --- /dev/null +++ b/packages/patapata_example_app/windows/flutter/generated_plugins.cmake @@ -0,0 +1,24 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + connectivity_plus +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +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/patapata_example_app/windows/runner/CMakeLists.txt b/packages/patapata_example_app/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..394917c --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/windows/runner/Runner.rc b/packages/patapata_example_app/windows/runner/Runner.rc new file mode 100644 index 0000000..fab211a --- /dev/null +++ b/packages/patapata_example_app/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", "patapata_example_app" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "patapata_example_app" "\0" + VALUE "LegalCopyright", "Copyright (C) 2023 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "patapata_example_app.exe" "\0" + VALUE "ProductName", "patapata_example_app" "\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/patapata_example_app/windows/runner/flutter_window.cpp b/packages/patapata_example_app/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..955ee30 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/windows/runner/flutter_window.h b/packages/patapata_example_app/windows/runner/flutter_window.h new file mode 100644 index 0000000..5f56958 --- /dev/null +++ b/packages/patapata_example_app/windows/runner/flutter_window.h @@ -0,0 +1,40 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#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/patapata_example_app/windows/runner/main.cpp b/packages/patapata_example_app/windows/runner/main.cpp new file mode 100644 index 0000000..35e0baf --- /dev/null +++ b/packages/patapata_example_app/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"patapata_example_app", 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/patapata_example_app/windows/runner/resource.h b/packages/patapata_example_app/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/packages/patapata_example_app/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/patapata_example_app/windows/runner/resources/app_icon.ico b/packages/patapata_example_app/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/packages/patapata_example_app/windows/runner/resources/app_icon.ico differ diff --git a/packages/patapata_example_app/windows/runner/runner.exe.manifest b/packages/patapata_example_app/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..a42ea76 --- /dev/null +++ b/packages/patapata_example_app/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/packages/patapata_example_app/windows/runner/utils.cpp b/packages/patapata_example_app/windows/runner/utils.cpp new file mode 100644 index 0000000..3a0c238 --- /dev/null +++ b/packages/patapata_example_app/windows/runner/utils.cpp @@ -0,0 +1,70 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#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(); + } + 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/patapata_example_app/windows/runner/utils.h b/packages/patapata_example_app/windows/runner/utils.h new file mode 100644 index 0000000..7ea5112 --- /dev/null +++ b/packages/patapata_example_app/windows/runner/utils.h @@ -0,0 +1,26 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#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/patapata_example_app/windows/runner/win32_window.cpp b/packages/patapata_example_app/windows/runner/win32_window.cpp new file mode 100644 index 0000000..14de6bd --- /dev/null +++ b/packages/patapata_example_app/windows/runner/win32_window.cpp @@ -0,0 +1,293 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#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/patapata_example_app/windows/runner/win32_window.h b/packages/patapata_example_app/windows/runner/win32_window.h new file mode 100644 index 0000000..aea7be9 --- /dev/null +++ b/packages/patapata_example_app/windows/runner/win32_window.h @@ -0,0 +1,109 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#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/patapata_firebase_analytics/.gitignore b/packages/patapata_firebase_analytics/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_analytics/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_analytics/.metadata b/packages/patapata_firebase_analytics/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_firebase_analytics/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_firebase_analytics/CHANGELOG.md b/packages/patapata_firebase_analytics/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_analytics/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_analytics/LICENSE b/packages/patapata_firebase_analytics/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_analytics/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_analytics/README.md b/packages/patapata_firebase_analytics/README.md new file mode 100644 index 0000000..0b1b49e --- /dev/null +++ b/packages/patapata_firebase_analytics/README.md @@ -0,0 +1,63 @@ +
+

Patapata - Firebase Analytics

+

+ Add support for Firebase Analytics to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Analytics](https://firebase.google.com/docs/analytics/) to your Patapata app. +It will automatically log analytics events to Firebase Analytics from Patapata's Analytics system. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +--- + +Due to a bug in the FlutterFire CLI, the stable version of 0.2.7 (at the time of writing this README) does not write out the required paramaters to run firebase_analytics correctly. + +A temporary workaround is to use the dev version of the cli and run `flutterfire configure` again. +https://github.com/invertase/flutterfire_cli/issues/210#issuecomment-1770505141 + +The above still might not be enough in some cases. +If you are still having issues, try the following: +- Add `classpath 'com.google.gms:google-services:4.3.14'` to `android/build.gradle`. Make sure the version is exactly that. +- Add `apply plugin: 'com.google.gms.google-services'` to `android/app/build.gradle` at the bottom of the file. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_analytics +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_analytics/patapata_firebase_analytics.dart'; +``` + +4. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseAnalyticsPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_analytics/LICENSE) diff --git a/packages/patapata_firebase_analytics/analysis_options.yaml b/packages/patapata_firebase_analytics/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_analytics/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_analytics/dartdoc_options.yaml b/packages/patapata_firebase_analytics/dartdoc_options.yaml new file mode 100644 index 0000000..fd7c0de --- /dev/null +++ b/packages/patapata_firebase_analytics/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_analytics \ No newline at end of file diff --git a/packages/patapata_firebase_analytics/lib/patapata_firebase_analytics.dart b/packages/patapata_firebase_analytics/lib/patapata_firebase_analytics.dart new file mode 100644 index 0000000..e9b3c6c --- /dev/null +++ b/packages/patapata_firebase_analytics/lib/patapata_firebase_analytics.dart @@ -0,0 +1,91 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_analytics; + +import 'dart:async'; + +import 'package:firebase_analytics/firebase_analytics.dart'; +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; + +/// A plugin that provides functionality for Firebase Analytics. +/// This plugin requires adding the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseAnalyticsPlugin extends Plugin { + /// A reference to the [FirebaseAnalytics] instance. + late final FirebaseAnalytics backend; + late final StreamSubscription _eventsSubscription; + + @override + List get dependencies => [FirebaseCorePlugin]; + + /// Initializes the [FirebaseAnalyticsPlugin]. + @override + FutureOr init(App app) async { + await super.init(app); + + backend = FirebaseAnalytics.instance; + _eventsSubscription = + app.analytics.eventsFor().listen(_onEvent); + app.user.addSynchronousChangeListener(_onUserChanged); + + return true; + } + + @override + FutureOr dispose() async { + await super.dispose(); + + app.user.removeSynchronousChangeListener(_onUserChanged); + _eventsSubscription.cancel(); + backend.setAnalyticsCollectionEnabled(false); + } + + @override + List get navigatorObservers => + [FirebaseAnalyticsObserver(analytics: backend)]; + + void _onEvent(AnalyticsEvent event) { + // Firebase only allows int, double, and String as parameter types. + // And no null. However Analytics needs the same keys, so we pass '' in that case. + // For any other types, try to turn it in to JSON. If that fails, return the toString() of it. + final tFlatData = event.flatData; + final tParameters = tFlatData != null + ? { + for (var i in tFlatData.entries) + i.key: Analytics.defaultMakeLoggableToNative(i.value), + } + : null; + + backend.logEvent( + name: event.name, + parameters: { + if (event.navigationInteractionContextData != null) + for (var i in event.navigationInteractionContextData!.entries) + 'nic_${i.key}': Analytics.defaultMakeLoggableToNative(i.value), + }..addAll(tParameters ?? {}), + ); + } + + String? _lastId; + + FutureOr _onUserChanged(User user, UserChangeData changes) async { + final tId = changes.getIdFor(); + final tProperties = changes.getPropertiesFor(); + + if (tId != _lastId) { + _lastId = tId; + await backend.setUserId( + id: tId, + ); + } + + await Future.wait([ + for (var i in tProperties.entries) + backend.setUserProperty(name: i.key, value: i.value?.toString()), + ]); + } +} diff --git a/packages/patapata_firebase_analytics/pubspec.yaml b/packages/patapata_firebase_analytics/pubspec.yaml new file mode 100644 index 0000000..c755067 --- /dev/null +++ b/packages/patapata_firebase_analytics/pubspec.yaml @@ -0,0 +1,26 @@ +name: patapata_firebase_analytics +description: This package is a plugin for Patapata that adds support for Firebase Analytics to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_analytics + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_firebase_core: ^1.0.0 + + firebase_analytics: ^10.4.5 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_firebase_analytics/test/patapata_firebase_analytics_test.dart b/packages/patapata_firebase_analytics/test/patapata_firebase_analytics_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_analytics/test/patapata_firebase_analytics_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_auth/.gitignore b/packages/patapata_firebase_auth/.gitignore new file mode 100644 index 0000000..36cf1be --- /dev/null +++ b/packages/patapata_firebase_auth/.gitignore @@ -0,0 +1,79 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/doc/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 +!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages + +# File generated when the golden test fails. +/test/failures diff --git a/packages/patapata_firebase_auth/.metadata b/packages/patapata_firebase_auth/.metadata new file mode 100644 index 0000000..a8338a2 --- /dev/null +++ b/packages/patapata_firebase_auth/.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. + +version: + revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + channel: stable + +project_type: plugin + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: android + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: ios + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: linux + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: macos + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: web + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + - platform: windows + create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + + # 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/patapata_firebase_auth/CHANGELOG.md b/packages/patapata_firebase_auth/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_auth/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_auth/LICENSE b/packages/patapata_firebase_auth/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_auth/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_auth/README.md b/packages/patapata_firebase_auth/README.md new file mode 100644 index 0000000..462c6aa --- /dev/null +++ b/packages/patapata_firebase_auth/README.md @@ -0,0 +1,63 @@ +
+

Patapata - Firebase Authentication

+

+ Add support for Firebase Authentication to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Authentication](https://firebase.google.com/docs/auth/) to your Patapata app. +It integrates with Firebase Authentication and supports user authentication functionality. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +--- + +Due to a bug in the FlutterFire CLI, the stable version of 0.2.7 (at the time of writing this README) does not write out the required paramaters to run firebase_auth correctly. + +A temporary workaround is to use the dev version of the cli and run `flutterfire configure` again. +https://github.com/invertase/flutterfire_cli/issues/210#issuecomment-1770505141 + +The above still might not be enough in some cases. +If you are still having issues, try the following: +- Add `classpath 'com.google.gms:google-services:4.3.14'` to `android/build.gradle`. Make sure the version is exactly that. +- Add `apply plugin: 'com.google.gms.google-services'` to `android/app/build.gradle` at the bottom of the file. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_auth +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_auth/patapata_firebase_auth.dart'; +``` + +4. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseAuthPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_auth/LICENSE) diff --git a/packages/patapata_firebase_auth/analysis_options.yaml b/packages/patapata_firebase_auth/analysis_options.yaml new file mode 100644 index 0000000..a5744c1 --- /dev/null +++ b/packages/patapata_firebase_auth/analysis_options.yaml @@ -0,0 +1,4 @@ +include: package:flutter_lints/flutter.yaml + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/packages/patapata_firebase_auth/lib/patapata_firebase_auth.dart b/packages/patapata_firebase_auth/lib/patapata_firebase_auth.dart new file mode 100644 index 0000000..d40d41b --- /dev/null +++ b/packages/patapata_firebase_auth/lib/patapata_firebase_auth.dart @@ -0,0 +1,70 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:firebase_auth/firebase_auth.dart' as firebase; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; + +/// A plugin that provides functionality for Firebase Authentication. +/// This plugin requires adding the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseAuthPlugin extends Plugin { + /// A reference to the [firebase.FirebaseAuth] instance. + late final firebase.FirebaseAuth instance; + + /// A StreamSubscription for [firebase.User?] type. + /// This can be used to listen to changes in the user's authentication status. + StreamSubscription? userSubscription; + + /// Initializes the [FirebaseAuthPlugin]. + @override + FutureOr init(App app) async { + await super.init(app); + + instance = firebase.FirebaseAuth.instance; + + enableUserChangesSubscription(); + + return true; + } + + /// Synchronize User.id in App and User.uid logged in Firebase. + /// + /// To enable this functionality, you need to call this function + /// after creating the [App] instance. + /// For example: + /// ```dart + /// void main() async { + /// final App tApp = App( + /// environment: ..., + /// plugins: [ + /// ..., + /// FirebaseAuthPlugin(), + /// ..., + /// ], + /// createAppWidget: ..., + /// ); + /// + /// tApp.run(); + /// } + /// ``` + void enableUserChangesSubscription() async { + userSubscription = instance.userChanges().listen( + (user) { + if (user != null && user.uid != app.user.id) { + app.user.changeId(user.uid); + } + }, + ); + } + + /// Dispose the [FirebaseAuthPlugin]. + @override + FutureOr dispose() async { + await super.dispose(); + + userSubscription?.cancel(); + userSubscription = null; + } +} diff --git a/packages/patapata_firebase_auth/pubspec.yaml b/packages/patapata_firebase_auth/pubspec.yaml new file mode 100644 index 0000000..8742624 --- /dev/null +++ b/packages/patapata_firebase_auth/pubspec.yaml @@ -0,0 +1,24 @@ +name: patapata_firebase_auth +description: This package is a plugin for Patapata that adds support for Firebase Authentication to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_auth + +environment: + sdk: ">=2.12.0 <3.0.0" + flutter: ">=2.0.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + firebase_auth: ^4.2.5 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.1 + +flutter: diff --git a/packages/patapata_firebase_auth/test/patapata_firebase_auth_test.dart b/packages/patapata_firebase_auth/test/patapata_firebase_auth_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_auth/test/patapata_firebase_auth_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_core/.gitignore b/packages/patapata_firebase_core/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_core/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_core/.metadata b/packages/patapata_firebase_core/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_firebase_core/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_firebase_core/CHANGELOG.md b/packages/patapata_firebase_core/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_core/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_core/LICENSE b/packages/patapata_firebase_core/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_core/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_core/README.md b/packages/patapata_firebase_core/README.md new file mode 100644 index 0000000..268ea17 --- /dev/null +++ b/packages/patapata_firebase_core/README.md @@ -0,0 +1,68 @@ +
+

Patapata - Firebase Core

+

+ Add support for Firebase to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase](https://firebase.google.com/) to your Patapata app. + +This plugin itself just initializes Firebase. It does not do anything else itself. You will need to add other plugins to your app to use Firebase features. + +## Getting started + +1. Follow the instructions for your platform to set up Firebase at https://firebase.google.com/docs/flutter/setup, up until just after executing `flutterfire configure`. + +2. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_core +``` + +3. Import the package and the settings from your `firebase_options.dart` file + +```dart +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; +import 'firebase_options.dart'; +``` + +4. Activate the plugin + +```dart +/// This Environment takes Firebase configuration from environment variables. +/// Pass environment variables to your app using the `--dart-define` flag. +class Environment with FirebaseCorePluginEnvironment { + const Environment(); + + /// The options of Firebase to pass to [Firebase.initializeApp]. + /// You can keep this null if you use the old google_services.json method. + /// If you want to support a web project as well, the [FirebaseCorePluginEnvironment.firebaseWebOptions] + /// getter is also available. + @override + Map? get firebaseOptions => { + TargetPlatform.android: DefaultFirebaseOptions.android, + /// etc... + }; +} + +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_core/LICENSE) \ No newline at end of file diff --git a/packages/patapata_firebase_core/analysis_options.yaml b/packages/patapata_firebase_core/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_core/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_core/dartdoc_options.yaml b/packages/patapata_firebase_core/dartdoc_options.yaml new file mode 100644 index 0000000..73b2ecf --- /dev/null +++ b/packages/patapata_firebase_core/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_core \ No newline at end of file diff --git a/packages/patapata_firebase_core/lib/patapata_firebase_core.dart b/packages/patapata_firebase_core/lib/patapata_firebase_core.dart new file mode 100644 index 0000000..20319cf --- /dev/null +++ b/packages/patapata_firebase_core/lib/patapata_firebase_core.dart @@ -0,0 +1,48 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_core; + +import 'dart:async'; + +import 'package:firebase_core/firebase_core.dart'; +import 'package:flutter/foundation.dart'; +import 'package:patapata_core/patapata_core.dart'; + +export 'package:firebase_core/firebase_core.dart' show FirebaseOptions; + +/// Configuration for Firebase in the application, used by [FirebaseCorePlugin]. +mixin FirebaseCorePluginEnvironment { + /// The name of Firebase to pass to [Firebase.initializeApp]. + String? get firebaseName => null; + + /// The options of Firebase to pass to [Firebase.initializeApp]. + Map? get firebaseOptions => null; + + /// The options for the web platform of Firebase to pass to [Firebase.initializeApp]. + FirebaseOptions? get firebaseWebOptions => null; +} + +/// A plugin that provides FirebaseCore functionality. +/// This plugin is required when adding Firebase to an application that uses Patapata. +class FirebaseCorePlugin extends Plugin { + @override + FutureOr init(App app) async { + await super.init(app); + + final tEnvironment = app.environment is FirebaseCorePluginEnvironment + ? app.environment as FirebaseCorePluginEnvironment + : null; + + await Firebase.initializeApp( + name: tEnvironment?.firebaseName, + options: kIsWeb + ? tEnvironment?.firebaseWebOptions + : tEnvironment?.firebaseOptions?[defaultTargetPlatform], + ); + + return true; + } +} diff --git a/packages/patapata_firebase_core/pubspec.yaml b/packages/patapata_firebase_core/pubspec.yaml new file mode 100644 index 0000000..bdd8c95 --- /dev/null +++ b/packages/patapata_firebase_core/pubspec.yaml @@ -0,0 +1,24 @@ +name: patapata_firebase_core +description: This package is a plugin for Patapata that adds support for Firebase to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_core + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + firebase_core: ^2.15.1 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_firebase_core/test/patapata_firebase_core_test.dart b/packages/patapata_firebase_core/test/patapata_firebase_core_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_core/test/patapata_firebase_core_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_crashlytics/.gitignore b/packages/patapata_firebase_crashlytics/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_crashlytics/.metadata b/packages/patapata_firebase_crashlytics/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_firebase_crashlytics/CHANGELOG.md b/packages/patapata_firebase_crashlytics/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_crashlytics/LICENSE b/packages/patapata_firebase_crashlytics/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_crashlytics/README.md b/packages/patapata_firebase_crashlytics/README.md new file mode 100644 index 0000000..5813054 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/README.md @@ -0,0 +1,51 @@ +
+

Patapata - Firebase Crashlytics

+

+ Add support for Firebase Crashlytics to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Crashlytics](https://firebase.google.com/docs/crashlytics/) to your Patapata app. +It will automatically report errors and logs to Firebase Crashlytics from Patapata's Log and Error systems. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_crashlytics +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_crashlytics/patapata_firebase_crashlytics.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseCrashlyticsPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_crashlytics/LICENSE) diff --git a/packages/patapata_firebase_crashlytics/analysis_options.yaml b/packages/patapata_firebase_crashlytics/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_crashlytics/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_crashlytics/dartdoc_options.yaml b/packages/patapata_firebase_crashlytics/dartdoc_options.yaml new file mode 100644 index 0000000..ae9868f --- /dev/null +++ b/packages/patapata_firebase_crashlytics/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_crashlytics \ No newline at end of file diff --git a/packages/patapata_firebase_crashlytics/lib/patapata_firebase_crashlytics.dart b/packages/patapata_firebase_crashlytics/lib/patapata_firebase_crashlytics.dart new file mode 100644 index 0000000..1500a45 --- /dev/null +++ b/packages/patapata_firebase_crashlytics/lib/patapata_firebase_crashlytics.dart @@ -0,0 +1,110 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_crashlytics; + +import 'package:flutter/foundation.dart'; +import 'package:firebase_crashlytics/firebase_crashlytics.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; +import 'package:stack_trace/stack_trace.dart'; + +/// This is a plugin that provides FirebaseCrashlytics functionality to Patapata. +/// To use this plugin, you need to add the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseCrashlyticsPlugin extends Plugin { + static const _exceptionLogPrefix = '[EXCEPTION]'; + StreamSubscription? _onReportSubscription; + + @override + List get dependencies => [FirebaseCorePlugin]; + + /// Initialize [FirebaseCrashlyticsPlugin]. + @override + FutureOr init(App app) async { + if (kIsWeb) { + // It's not working right now. + return false; + } + + await super.init(app); + + _onReportSubscription = app.log.reports.listen(_onReport); + + app.user.addSynchronousChangeListener(_onUserChanged); + + return true; + } + + @override + FutureOr dispose() async { + app.user.removeSynchronousChangeListener(_onUserChanged); + await FirebaseCrashlytics.instance.setCrashlyticsCollectionEnabled(false); + + await super.dispose(); + await _onReportSubscription?.cancel(); + + _onReportSubscription = null; + } + + void _onReport(ReportRecord record) async { + if (record.level < Level.WARNING) { + await FirebaseCrashlytics.instance.log(record.toString()); + + return; + } + + if (record.object is FlutterErrorDetails) { + FirebaseCrashlytics.instance + .recordFlutterError(record.object as FlutterErrorDetails); + + return; + } + + FirebaseCrashlytics.instance.log(_exceptionLogPrefix + record.message); + + StackTrace? tStackTrace = record.stackTrace; + + if (tStackTrace is Chain) { + tStackTrace = tStackTrace.toTrace(); + } + + if (tStackTrace is Trace) { + tStackTrace = tStackTrace.vmTrace; + } + + await FirebaseCrashlytics.instance.recordError( + record.error ?? record.object ?? record.message, + tStackTrace == null || tStackTrace == StackTrace.empty + ? Trace.current(1) + : tStackTrace, + reason: record.message, + printDetails: false, + ); + } + + String? _lastId; + + FutureOr _onUserChanged(User user, UserChangeData changes) async { + final tId = changes.getIdFor(); + final tProperties = changes.getPropertiesFor(); + + if (tId != _lastId) { + _lastId = tId; + await FirebaseCrashlytics.instance.setUserIdentifier(tId ?? ''); + } + + await Future.wait([ + for (var i in tProperties.entries) + FirebaseCrashlytics.instance.setCustomKey(i.key, i.value ?? ''), + ]); + } + + /// Sends unsent crash reports to Firebase. + /// For details, refer to [FirebaseCrashlytics.sendUnsentReports]. + Future sendUnsentReports() async { + await FirebaseCrashlytics.instance.sendUnsentReports(); + } +} diff --git a/packages/patapata_firebase_crashlytics/pubspec.yaml b/packages/patapata_firebase_crashlytics/pubspec.yaml new file mode 100644 index 0000000..e27dbfd --- /dev/null +++ b/packages/patapata_firebase_crashlytics/pubspec.yaml @@ -0,0 +1,27 @@ +name: patapata_firebase_crashlytics +description: This package is a plugin for Patapata that adds support for Firebase Crashlytics to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_crashlytics + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_firebase_core: ^1.0.0 + + firebase_crashlytics: ^3.3.5 + stack_trace: ^1.11.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_firebase_crashlytics/test/patapata_firebase_crashlytics_test.dart b/packages/patapata_firebase_crashlytics/test/patapata_firebase_crashlytics_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_crashlytics/test/patapata_firebase_crashlytics_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_dynamic_links/.gitignore b/packages/patapata_firebase_dynamic_links/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_dynamic_links/.metadata b/packages/patapata_firebase_dynamic_links/.metadata new file mode 100644 index 0000000..11b94d3 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/.metadata @@ -0,0 +1,10 @@ +# 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: 6928314d505d2bb4777be05e45d7808a5aa91d2a + channel: unknown + +project_type: package diff --git a/packages/patapata_firebase_dynamic_links/CHANGELOG.md b/packages/patapata_firebase_dynamic_links/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_dynamic_links/LICENSE b/packages/patapata_firebase_dynamic_links/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_dynamic_links/README.md b/packages/patapata_firebase_dynamic_links/README.md new file mode 100644 index 0000000..94ee82c --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/README.md @@ -0,0 +1,58 @@ +
+

Patapata - Firebase Dynamic Links

+

+ Add support for Firebase Dynamic Links to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/) to your Patapata app. + +It will automatically handle dynamic links from Firebase and send them to Patapata's Link system. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +--- + +***Firebase Dynamic Links is deprecated by Google*** + +Patapata and StandardApp supports features like Apple's Universal Links and Android's App Links, which also provide the ability to open your app from a link. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_dynamic_links +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_dynamic_links/patapata_firebase_dynamic_links.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseDynamicLinksPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_dynamic_links/LICENSE) diff --git a/packages/patapata_firebase_dynamic_links/analysis_options.yaml b/packages/patapata_firebase_dynamic_links/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_dynamic_links/dartdoc_options.yaml b/packages/patapata_firebase_dynamic_links/dartdoc_options.yaml new file mode 100644 index 0000000..ed79305 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_dynamic_links \ No newline at end of file diff --git a/packages/patapata_firebase_dynamic_links/lib/patapata_firebase_dynamic_links.dart b/packages/patapata_firebase_dynamic_links/lib/patapata_firebase_dynamic_links.dart new file mode 100644 index 0000000..711517d --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/lib/patapata_firebase_dynamic_links.dart @@ -0,0 +1,180 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_dynamic_links; + +import 'dart:async'; + +import 'package:firebase_dynamic_links/firebase_dynamic_links.dart'; +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; + +/// This is a plugin that provides functionality for Firebase Dynamic Links. +/// This plugin requires adding the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseDynamicLinksPlugin extends Plugin + with StandardAppRoutePluginMixin { + StreamSubscription? _onLinkSubscription; + PendingDynamicLinkData? _initialData; + + @override + List get dependencies => [FirebaseCorePlugin]; + + /// Initializes the [FirebaseDynamicLinksPlugin]. + /// Please note that Dynamic Links are not supported on the web. + @override + FutureOr init(App app) async { + if (kIsWeb) { + // It's not working right now. + return false; + } + + await super.init(app); + + _initialData = await FirebaseDynamicLinks.instance.getInitialLink(); + _onLinkSubscription = FirebaseDynamicLinks.instance.onLink.listen(_onLink); + + return true; + } + + @override + FutureOr dispose() { + _onLinkSubscription?.cancel(); + _onLinkSubscription = null; + + return super.dispose(); + } + + /// Retrieves the necessary [StandardRouteData] for the initial screen transition to the `Router`. + @override + Future getInitialRouteData() { + if (_initialData == null) { + return SynchronousFuture(null); + } + + final tParser = app.getPlugin()?.parser; + + if (tParser == null) { + return SynchronousFuture(null); + } + + return tParser.parseRouteInformation( + RouteInformation( + uri: _initialData!.link, + ), + ); + } + + void _onLink(PendingDynamicLinkData data) async { + final tPlugin = app.getPlugin(); + + final tParser = tPlugin?.parser; + + if (tParser == null) { + return; + } + + final tConfiguration = await tParser.parseRouteInformation( + RouteInformation( + uri: data.link, + ), + ); + + tPlugin?.delegate?.routeWithConfiguration(tConfiguration); + } + + /// Generates an external link or shortened external link for [FirebaseDynamicLinks]. + Future generateExternalLink({ + required Uri link, + required String uriPrefix, + required String androidPackageName, + required String iOSBundleId, + required String iOSAppStoreId, + String? googleAnalyticsCampaign, + String? googleAnalyticsContent, + String? googleAnalyticsMedium, + String? googleAnalyticsSource, + String? googleAnalyticsTerm, + String? itunesConnectAnalyticsAffiliateToken, + String? itunesConnectAnalyticsCampaignToken, + String? itunesConnectAnalyticsProviderToken, + String? description, + Uri? image, + String? title, + }) async { + var tLink = await FirebaseDynamicLinks.instance.buildLink( + DynamicLinkParameters( + link: link, + uriPrefix: uriPrefix, + androidParameters: AndroidParameters( + packageName: androidPackageName, + ), + iosParameters: IOSParameters( + bundleId: iOSBundleId, + appStoreId: iOSAppStoreId, + ), + googleAnalyticsParameters: GoogleAnalyticsParameters( + campaign: googleAnalyticsCampaign, + content: googleAnalyticsContent, + medium: googleAnalyticsMedium, + source: googleAnalyticsSource, + term: googleAnalyticsTerm, + ), + itunesConnectAnalyticsParameters: ITunesConnectAnalyticsParameters( + affiliateToken: itunesConnectAnalyticsAffiliateToken, + campaignToken: itunesConnectAnalyticsCampaignToken, + providerToken: itunesConnectAnalyticsProviderToken, + ), + navigationInfoParameters: const NavigationInfoParameters( + forcedRedirectEnabled: true, + ), + socialMetaTagParameters: SocialMetaTagParameters( + description: description, + imageUrl: image, + title: title, + ), + ), + ); + + return (await FirebaseDynamicLinks.instance.buildShortLink( + DynamicLinkParameters( + link: link, + uriPrefix: uriPrefix, + longDynamicLink: tLink, + androidParameters: AndroidParameters( + packageName: androidPackageName, + ), + iosParameters: IOSParameters( + bundleId: iOSBundleId, + appStoreId: iOSAppStoreId, + ), + googleAnalyticsParameters: GoogleAnalyticsParameters( + campaign: googleAnalyticsCampaign, + content: googleAnalyticsContent, + medium: googleAnalyticsMedium, + source: googleAnalyticsSource, + term: googleAnalyticsTerm, + ), + itunesConnectAnalyticsParameters: ITunesConnectAnalyticsParameters( + affiliateToken: itunesConnectAnalyticsAffiliateToken, + campaignToken: itunesConnectAnalyticsCampaignToken, + providerToken: itunesConnectAnalyticsProviderToken, + ), + navigationInfoParameters: const NavigationInfoParameters( + forcedRedirectEnabled: true, + ), + socialMetaTagParameters: SocialMetaTagParameters( + description: description, + imageUrl: image, + title: title, + ), + ), + )) + .shortUrl + .toString(); + } +} diff --git a/packages/patapata_firebase_dynamic_links/pubspec.yaml b/packages/patapata_firebase_dynamic_links/pubspec.yaml new file mode 100644 index 0000000..905cd46 --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/pubspec.yaml @@ -0,0 +1,27 @@ +name: patapata_firebase_dynamic_links +description: This package is a plugin for Patapata that adds support for Firebase Dynamic Links to your Patapata app. +version: 1.0.0 +publish_to: none +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_dynamic_links + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_firebase_core: ^1.0.0 + + firebase_dynamic_links: ^5.3.5 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_firebase_dynamic_links/test/patapata_firebase_dynamic_links_test.dart b/packages/patapata_firebase_dynamic_links/test/patapata_firebase_dynamic_links_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_dynamic_links/test/patapata_firebase_dynamic_links_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_messaging/.gitignore b/packages/patapata_firebase_messaging/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_messaging/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_messaging/.metadata b/packages/patapata_firebase_messaging/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_firebase_messaging/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_firebase_messaging/CHANGELOG.md b/packages/patapata_firebase_messaging/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_messaging/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_messaging/LICENSE b/packages/patapata_firebase_messaging/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_messaging/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_messaging/README.md b/packages/patapata_firebase_messaging/README.md new file mode 100644 index 0000000..6e6a34c --- /dev/null +++ b/packages/patapata_firebase_messaging/README.md @@ -0,0 +1,51 @@ +
+

Patapata - Firebase Cloud Messaging

+

+ Add support for Firebase Cloud Messaging to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) to your Patapata app. +It will automatically handle push notifications from Firebase and send them to Patapata's Notification system. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_messaging +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_messaging/patapata_firebase_messaging.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseMessagingPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_messaging/LICENSE) diff --git a/packages/patapata_firebase_messaging/analysis_options.yaml b/packages/patapata_firebase_messaging/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_messaging/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_messaging/android/.gitignore b/packages/patapata_firebase_messaging/android/.gitignore new file mode 100644 index 0000000..c6cbe56 --- /dev/null +++ b/packages/patapata_firebase_messaging/android/.gitignore @@ -0,0 +1,8 @@ +*.iml +.gradle +/local.properties +/.idea/workspace.xml +/.idea/libraries +.DS_Store +/build +/captures diff --git a/packages/patapata_firebase_messaging/android/build.gradle b/packages/patapata_firebase_messaging/android/build.gradle new file mode 100644 index 0000000..7a602f0 --- /dev/null +++ b/packages/patapata_firebase_messaging/android/build.gradle @@ -0,0 +1,51 @@ +group 'dev.patapata.patapata_firebase_messaging' +version '1.0-SNAPSHOT' + +buildscript { + ext.kotlin_version = '1.7.10' + repositories { + google() + mavenCentral() + } + + dependencies { + classpath 'com.android.tools.build:gradle:7.3.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + } +} + +rootProject.allprojects { + repositories { + google() + mavenCentral() + } +} + +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' + +android { + compileSdkVersion 33 + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + minSdkVersion 16 + targetSdkVersion 33 + } +} + +dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" +} diff --git a/packages/patapata_firebase_messaging/android/settings.gradle b/packages/patapata_firebase_messaging/android/settings.gradle new file mode 100644 index 0000000..68d3709 --- /dev/null +++ b/packages/patapata_firebase_messaging/android/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'patapata_firebase_messaging' diff --git a/packages/patapata_firebase_messaging/android/src/main/AndroidManifest.xml b/packages/patapata_firebase_messaging/android/src/main/AndroidManifest.xml new file mode 100644 index 0000000..b2a9ee9 --- /dev/null +++ b/packages/patapata_firebase_messaging/android/src/main/AndroidManifest.xml @@ -0,0 +1,3 @@ + + diff --git a/packages/patapata_firebase_messaging/android/src/main/kotlin/dev/patapata/patapata_firebase_messaging/PatapataFirebaseMessagingPlugin.kt b/packages/patapata_firebase_messaging/android/src/main/kotlin/dev/patapata/patapata_firebase_messaging/PatapataFirebaseMessagingPlugin.kt new file mode 100644 index 0000000..efccb7f --- /dev/null +++ b/packages/patapata_firebase_messaging/android/src/main/kotlin/dev/patapata/patapata_firebase_messaging/PatapataFirebaseMessagingPlugin.kt @@ -0,0 +1,109 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_firebase_messaging + +import android.Manifest +import android.app.Activity +import android.content.pm.PackageManager +import android.os.Build +import androidx.annotation.NonNull +import androidx.core.app.ActivityCompat +import androidx.core.content.ContextCompat + +import io.flutter.embedding.engine.plugins.FlutterPlugin +import io.flutter.embedding.engine.plugins.activity.ActivityAware +import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding +import io.flutter.plugin.common.MethodCall +import io.flutter.plugin.common.MethodChannel +import io.flutter.plugin.common.MethodChannel.MethodCallHandler +import io.flutter.plugin.common.MethodChannel.Result +import io.flutter.plugin.common.PluginRegistry + +/** PatapataFirebaseMessagingPlugin */ +class PatapataFirebaseMessagingPlugin : FlutterPlugin, MethodCallHandler, ActivityAware, PluginRegistry.RequestPermissionsResultListener { + private lateinit var mChannel : MethodChannel + private lateinit var mBinding : FlutterPlugin.FlutterPluginBinding + private lateinit var mActivity : Activity + private lateinit var mPluginBinding : ActivityPluginBinding + private var mResult: Result? = null + + companion object { + const val PERMISSION_REQUEST_CODE = 1001 + } + + override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { + mBinding = flutterPluginBinding + mChannel = MethodChannel(flutterPluginBinding.binaryMessenger, "dev.patapata.patapata_firebase_messaging") + mChannel.setMethodCallHandler(this) + } + + override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) { + when (call.method) { + "requestPermission" -> { + + if (Build.VERSION.SDK_INT < Build.VERSION_CODES.TIRAMISU) { + result.success(true) + } else { + val tResult: Int = ContextCompat.checkSelfPermission( + mBinding.applicationContext, Manifest.permission.POST_NOTIFICATIONS) + + if (tResult == PackageManager.PERMISSION_DENIED) { + ActivityCompat.requestPermissions( + mActivity, + arrayOf(Manifest.permission.POST_NOTIFICATIONS), + PERMISSION_REQUEST_CODE + ) + // このタイミングでユーザが許可したかどうかは判定されないため,onRequestPermissionsResultで実行する + mResult = result + } else { + // 既に通知許可されている場合 + result.success(true) + } + } + } + else -> { + result.notImplemented() + } + } + } + + override fun onRequestPermissionsResult(requestCode: Int, permissions: Array, grantResults: IntArray): Boolean { + // 通知許可のダイアログを出した後、許可・許可しないの選択をした時の処理 + if (requestCode == PERMISSION_REQUEST_CODE) { + val tIsSuccess : Boolean = (grantResults.isNotEmpty() && + grantResults[0] == PackageManager.PERMISSION_GRANTED) + mResult?.success(tIsSuccess) + mResult = null + return tIsSuccess + } + + return false + } + + override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) { + mChannel.setMethodCallHandler(null) + } + + override fun onAttachedToActivity(binding: ActivityPluginBinding) { + mPluginBinding = binding + mActivity = binding.activity + mPluginBinding.addRequestPermissionsResultListener(this) + } + + override fun onDetachedFromActivityForConfigChanges() { + + } + + override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) { + + } + + override fun onDetachedFromActivity() { + mPluginBinding.removeRequestPermissionsResultListener(this) + } +} diff --git a/packages/patapata_firebase_messaging/dartdoc_options.yaml b/packages/patapata_firebase_messaging/dartdoc_options.yaml new file mode 100644 index 0000000..1cad413 --- /dev/null +++ b/packages/patapata_firebase_messaging/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_messaging \ No newline at end of file diff --git a/packages/patapata_firebase_messaging/lib/patapata_firebase_messaging.dart b/packages/patapata_firebase_messaging/lib/patapata_firebase_messaging.dart new file mode 100644 index 0000000..079a65f --- /dev/null +++ b/packages/patapata_firebase_messaging/lib/patapata_firebase_messaging.dart @@ -0,0 +1,472 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_messaging; + +import 'dart:convert'; +import 'dart:io'; +import 'dart:math'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/widgets.dart'; +import 'package:crypto/crypto.dart'; + +import 'package:firebase_messaging/firebase_messaging.dart' as firebase; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; +import 'package:path_provider/path_provider.dart'; +import 'package:flutter_local_notifications/flutter_local_notifications.dart'; + +final _logger = Logger('patapata.FirebaseMessagingPlugin'); + +const int _kLocalNotificationIdBase = kPataInHex; + +/// Generate a random notification ID number to avoid conflicting with any other Intent on the system (hopefully) +/// This has to be less than a 32 bit signed int. +int _generateLocalNotificationId() { + return _kLocalNotificationIdBase + + Random().nextInt(_kLocalNotificationIdBase >> 8); +} + +/// A plugin that provides Firebase Cloud Messaging functionality to Patapata. +/// This plugin requires adding the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseMessagingPlugin extends Plugin with StandardAppRoutePluginMixin { + /// A reference to the [firebase.FirebaseMessaging] instance. + late final firebase.FirebaseMessaging instance; + + final _selectedMessagesController = + StreamController.broadcast(); + + @override + List get dependencies => [ + FirebaseCorePlugin, + NotificationsPlugin, + ]; + + /// Initializes the [FirebaseMessagingPlugin]. + @override + FutureOr init(App app) async { + await super.init(app); + + instance = firebase.FirebaseMessaging.instance; + + if (!await instance.isSupported()) { + _logger.info('Firebase Messaging not supported. Disabling.'); + + return false; + } + + firebase.FirebaseMessaging.onBackgroundMessage(_onBackgroundMessage); + + return true; + } + + @override + FutureOr dispose() async { + await super.dispose(); + + // Can't disable a background message handler it seems. + + instance.setAutoInitEnabled(false); + } + + @override + RemoteMessaging createRemoteMessaging() => + FirebaseMessagingRemoteMessaging(this); + + /// Retrieve the Future of the first Firebase remote message. + Future getInitialMessage() async { + final tFirebaseInitialMessage = await instance.getInitialMessage(); + + return tFirebaseInitialMessage != null + ? FirebaseMessagingRemoteMessagingRemoteMessage.fromFirebase( + tFirebaseInitialMessage) + : null; + } + + @override + Future getInitialRouteData() async { + try { + final tRemoteMessage = await getInitialMessage(); + + if (tRemoteMessage == null) { + return null; + } + + final tLocation = tRemoteMessage + .data?[app.getPlugin()?.payloadLocationKey] + as String?; + + if (tLocation?.isNotEmpty == true) { + final tParser = app.getPlugin()?.parser; + + if (tParser == null) { + return null; + } + + final tLocationUri = Uri.parse(tLocation!); + + return tParser.parseRouteInformation( + RouteInformation( + uri: tLocationUri, + ), + ); + } + } catch (e) { + // ignore + } + + return null; + } + + Stream get _selectedMessages => + _selectedMessagesController.stream; +} + +/// The actual [RemoteMessage] that [FirebaseMessagingRemoteMessaging] uses to exchange messages with Firebase. +class FirebaseMessagingRemoteMessagingRemoteMessage extends RemoteMessage { + /// A reference to the [firebase.RemoteMessage] instance. + final firebase.RemoteMessage firebaseRemoteMessage; + + /// Creates a Firebase remote message for the provided argument [firebaseRemoteMessage]. + /// Optionally, provide [messageId] as a unique ID assigned to each message, [channel] for each message's channel, + /// [data] as a Map for received data, and [notification] of [RemoteMessageNotification] with title and body information when receiving the notification. + const FirebaseMessagingRemoteMessagingRemoteMessage({ + required this.firebaseRemoteMessage, + String? messageId, + String? channel, + Map? data, + RemoteMessageNotification? notification, + }) : super( + messageId: messageId, + data: data, + notification: notification, + ); + + /// A factory class that creates an instance of RemoteMessage from a Firebase remote message [message]. + factory FirebaseMessagingRemoteMessagingRemoteMessage.fromFirebase( + firebase.RemoteMessage message, + ) { + final tNotification = message.notification; + + return FirebaseMessagingRemoteMessagingRemoteMessage( + firebaseRemoteMessage: message, + messageId: message.messageId, + channel: message.from ?? RemoteMessage.kRemoteMessageDefaultChannel, + data: message.data, + notification: tNotification != null + ? RemoteMessageNotification( + title: tNotification.title, + body: tNotification.body, + ) + : null, + ); + } +} + +/// A class for monitoring the remote messages of [FirebaseMessagingRemoteMessagingRemoteMessage]. +class FirebaseMessagingRemoteMessaging extends RemoteMessaging { + final FirebaseMessagingPlugin _instance; + + StreamSubscription? _onMessageSubscription; + StreamSubscription? _onMessageOpenedAppSubscription; + StreamSubscription? _onSelectMessageSubscription; + StreamSubscription? _onTokenRefreshSubscription; + + final _messagesController = StreamController.broadcast(); + final _tokensController = StreamController.broadcast(); + + /// Constructor for [FirebaseMessagingRemoteMessaging]. + FirebaseMessagingRemoteMessaging(this._instance); + + /// Initializes the [FirebaseMessagingRemoteMessaging]. + @override + Future init(App app) async { + await super.init(app); + + _onMessageSubscription = + firebase.FirebaseMessaging.onMessage.listen(_onMessage); + _onMessageOpenedAppSubscription = firebase + .FirebaseMessaging.onMessageOpenedApp + .listen(_onMessageOpenedApp); + _onSelectMessageSubscription = + _instance._selectedMessages.listen(_onSelectMessage); + _onTokenRefreshSubscription = + firebase.FirebaseMessaging.instance.onTokenRefresh.listen(_onToken); + } + + @override + void dispose() { + _onMessageSubscription?.cancel(); + _onMessageSubscription = null; + _onMessageOpenedAppSubscription?.cancel(); + _onMessageOpenedAppSubscription = null; + _onSelectMessageSubscription?.cancel(); + _onSelectMessageSubscription = null; + _onTokenRefreshSubscription?.cancel(); + _onTokenRefreshSubscription = null; + super.dispose(); + } + + void _onSelectMessage(RemoteMessage message) { + _messagesController.add(message); + } + + void _onMessage(firebase.RemoteMessage message) async { + _logger.info( + '_onMessage:{messageId:${message.messageId} from:${message.from}, data:${message.data}}'); + + await _showNotificationFromFirebaseRemoteMessage(message); + } + + void _onMessageOpenedApp(firebase.RemoteMessage message) async { + _logger.info( + '_onMessageOpenedApp:{messageId:${message.messageId} from:${message.from}, data:${message.data}}'); + + final tRemoteMessage = + FirebaseMessagingRemoteMessagingRemoteMessage.fromFirebase(message); + + if (app.hasPlugin(StandardAppPlugin)) { + try { + final tLocation = tRemoteMessage + .data?[app.getPlugin()?.payloadLocationKey] + as String?; + + if (tLocation?.isNotEmpty == true) { + app.getPlugin()!.route(tLocation!); + } + } catch (e) { + // ignore + } + } + + _messagesController.add(tRemoteMessage); + } + + void _onToken(String token) { + _logger.info('_onToken:$token'); + + _tokensController.add(token); + } + + @override + Future getInitialMessage() { + return _instance.getInitialMessage(); + } + + @override + Stream get messages => _messagesController.stream; + + @override + Stream get tokens => _tokensController.stream; + + @override + Future getToken() async { + try { + return _instance.instance.getToken(); + } catch (e, stackTrace) { + _logger.info('Failed get token for Firebase Messaginging', e, stackTrace); + return null; + } + } + + @override + FutureOr listenChannel(String channel) async { + if (!await super.listenChannel(channel)) { + return false; + } + + try { + await _instance.instance.subscribeToTopic(channel); + } catch (e, stackTrace) { + _logger.warning( + 'Could not subscribe to Firebase Messaging topic: $channel', + e, + stackTrace); + + await super.ignoreChannel(channel); + + return false; + } + + return true; + } + + @override + FutureOr ignoreChannel(String channel) async { + if (!await super.ignoreChannel(channel)) { + return false; + } + + try { + await _instance.instance.unsubscribeFromTopic(channel); + } catch (e, stackTrace) { + _logger.warning( + 'Could not unsubscribe Firebase Messaging topic: $channel', + e, + stackTrace); + + return false; + } + + return true; + } +} + +Future?> _getAndroidBitmapFromUrl(String url) async { + HttpClient? tClient; + IOSink? tSync; + + try { + final tDirectory = await getApplicationDocumentsDirectory(); + final tUri = Uri.tryParse(url); + + if (tUri != null && await tDirectory.exists()) { + tClient = HttpClient(); + final tRequest = await tClient.getUrl(tUri); + final tResponse = await tRequest.close(); + + if (tResponse.statusCode == HttpStatus.ok) { + final tFile = File( + '${tDirectory.path}${Platform.pathSeparator}${md5.convert(utf8.encode(url)).toString()}'); + tSync = tFile.openWrite(); + + await tSync.addStream(tResponse); + + return FilePathAndroidBitmap(tFile.path); + } + } + } catch (e, stackTrace) { + _logger.info('Failed to download bitmap for notification.', e, stackTrace); + } finally { + try { + tSync?.close(); + } catch (e) { + // ignore + } + + try { + tClient?.close(); + } catch (e) { + // ignore + } + } + + return null; +} + +Future _showNotificationFromFirebaseRemoteMessage( + firebase.RemoteMessage message, { + bool fromBackground = false, +}) async { + if (fromBackground && defaultTargetPlatform != TargetPlatform.android) { + // Only Android needs to manually make a notification... + return; + } + + final tNotification = message.notification; + final String tPayload; + + if (tNotification != null && fromBackground) { + // Firebase will show it for us. + return; + } + + try { + tPayload = jsonEncode(message.data); + } catch (e, stackTrace) { + _logger.fine('Bad payload', e, stackTrace); + return; + } + + if (tNotification != null) { + final tImageUrl = tNotification.android?.imageUrl; + AndroidBitmap? tImage; + + if (tImageUrl?.isNotEmpty == true) { + tImage = await _getAndroidBitmapFromUrl(tImageUrl!); + } + + await FlutterLocalNotificationsPlugin().show( + _generateLocalNotificationId(), + tNotification.title, + tNotification.body, + NotificationDetails( + android: AndroidNotificationDetails( + tNotification.android?.channelId ?? + NotificationsPlugin.kDefaultAndroidChannel.id, + tNotification.android?.channelId ?? + NotificationsPlugin.kDefaultAndroidChannel.name, + styleInformation: tImage != null + ? BigPictureStyleInformation(tImage) + : BigTextStyleInformation(tNotification.body ?? ''), + largeIcon: tImage, + ), + ), + payload: tPayload, + ); + + if (tImage != null) { + try { + await File(tImage.data).delete(); + } catch (e, stackTrace) { + _logger.info('Failed to delete just created image.', e, stackTrace); + } + } + } else { + // handle an internal project's style... + // ignore: todo + // TODO: Temp... make this generic + final tData = message.data; + + if ((tData['notifyType'] as String?) != 'URL') { + return; + } + + final tImageUrl = tData['mainImageUri'] as String?; + AndroidBitmap? tImage; + + if (tImageUrl?.isNotEmpty == true) { + tImage = await _getAndroidBitmapFromUrl(tImageUrl!); + } + + await FlutterLocalNotificationsPlugin().show( + _generateLocalNotificationId(), + tData['title'] as String?, + tData['text'] as String?, + NotificationDetails( + android: AndroidNotificationDetails( + NotificationsPlugin.kDefaultAndroidChannel.id, + NotificationsPlugin.kDefaultAndroidChannel.name, + styleInformation: tImage != null + ? BigPictureStyleInformation(tImage) + : BigTextStyleInformation((tData['text'] as String?) ?? ''), + largeIcon: tImage, + ticker: tData['tickerText'] as String?, + ), + ), + payload: tPayload, + ); + + if (tImage != null) { + try { + await File(tImage.data).delete(); + } catch (e, stackTrace) { + _logger.info('Failed to delete just created image.', e, stackTrace); + } + } + } +} + +/// This function will be executed in a background isolate +@pragma('vm:entry-point') +Future _onBackgroundMessage(firebase.RemoteMessage message) async { + WidgetsFlutterBinding.ensureInitialized(); + NotificationsPlugin.initializeNotificationsForBackgroundIsolate(); + await _showNotificationFromFirebaseRemoteMessage(message, + fromBackground: true); +} diff --git a/packages/patapata_firebase_messaging/pubspec.yaml b/packages/patapata_firebase_messaging/pubspec.yaml new file mode 100644 index 0000000..6e6efc5 --- /dev/null +++ b/packages/patapata_firebase_messaging/pubspec.yaml @@ -0,0 +1,34 @@ +name: patapata_firebase_messaging +description: This package is a plugin for Patapata that adds support for Firebase Cloud Messaging to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_messaging + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_firebase_core: ^1.0.0 + + firebase_messaging: ^14.6.6 + path_provider: ">=2.0.9 <3.0.0" + crypto: ">=3.0.3 <4.0.0" + flutter_local_notifications: ^15.1.2 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: + plugin: + platforms: + android: + package: dev.patapata.patapata_firebase_messaging + pluginClass: PatapataFirebaseMessagingPlugin diff --git a/packages/patapata_firebase_messaging/test/patapata_firebase_messaging_test.dart b/packages/patapata_firebase_messaging/test/patapata_firebase_messaging_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_messaging/test/patapata_firebase_messaging_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_firebase_remote_config/.gitignore b/packages/patapata_firebase_remote_config/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_firebase_remote_config/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_firebase_remote_config/.metadata b/packages/patapata_firebase_remote_config/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_firebase_remote_config/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_firebase_remote_config/CHANGELOG.md b/packages/patapata_firebase_remote_config/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_firebase_remote_config/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_firebase_remote_config/LICENSE b/packages/patapata_firebase_remote_config/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_firebase_remote_config/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_firebase_remote_config/README.md b/packages/patapata_firebase_remote_config/README.md new file mode 100644 index 0000000..04c149c --- /dev/null +++ b/packages/patapata_firebase_remote_config/README.md @@ -0,0 +1,51 @@ +
+

Patapata - Firebase Remote Config

+

+ Add support for Firebase Remote Config to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Firebase Remote Config](https://firebase.google.com/docs/remote-config/) to your Patapata app. +It will automatically fetch remote config values from Firebase and send them to Patapata's RemoteConfig system. + +This plugin requires the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) plugin to be installed and activated. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_firebase_remote_config +``` + +2. Import the package + +```dart +import 'package:patapata_firebase_remote_config/patapata_firebase_remote_config.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + FirebaseCorePlugin(), + FirebaseRemoteConfigPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_firebase_remote_config/LICENSE) diff --git a/packages/patapata_firebase_remote_config/analysis_options.yaml b/packages/patapata_firebase_remote_config/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_firebase_remote_config/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_firebase_remote_config/dartdoc_options.yaml b/packages/patapata_firebase_remote_config/dartdoc_options.yaml new file mode 100644 index 0000000..0663a69 --- /dev/null +++ b/packages/patapata_firebase_remote_config/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_firebase_remote_config \ No newline at end of file diff --git a/packages/patapata_firebase_remote_config/lib/patapata_firebase_remote_config.dart b/packages/patapata_firebase_remote_config/lib/patapata_firebase_remote_config.dart new file mode 100644 index 0000000..6ed7181 --- /dev/null +++ b/packages/patapata_firebase_remote_config/lib/patapata_firebase_remote_config.dart @@ -0,0 +1,160 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_firebase_remote_config; + +import 'package:firebase_remote_config/firebase_remote_config.dart' + as firebase_remote_config; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:patapata_firebase_core/patapata_firebase_core.dart'; + +final _logger = Logger('patapata.FirebaseRemoteConfigPlugin'); + +/// This is a plugin that provides FirebaseRemoteConfig functionality to Patapata. +/// To use this plugin, you need to add the [patapata_firebase_core](https://pub.dev/packages/patapata_firebase_core) package to your application. +class FirebaseRemoteConfigPlugin extends Plugin { + @override + List get dependencies => [FirebaseCorePlugin]; + + @override + RemoteConfig createRemoteConfig() => + _FirebaseRemoteConfigPluginRemoteConfig(); +} + +class _FirebaseRemoteConfigPluginRemoteConfig extends RemoteConfig { + late firebase_remote_config.FirebaseRemoteConfig _remoteConfig; + StreamSubscription? _subscription; + + @override + Future init() async { + bool tIsDebug = false; + + assert(() { + tIsDebug = true; + return true; + }()); + + _remoteConfig = firebase_remote_config.FirebaseRemoteConfig.instance; + + if (tIsDebug) { + await _remoteConfig.setConfigSettings( + firebase_remote_config.RemoteConfigSettings( + fetchTimeout: const Duration(minutes: 1), + minimumFetchInterval: const Duration(minutes: 1), + ), + ); + _logger.finer('Enabled debug mode. Fetches will be more frequent!'); + } + + _subscription = _remoteConfig.onConfigUpdated.listen(_onRemoteChanged); + await super.init(); + } + + @override + void dispose() { + super.dispose(); + + _subscription?.cancel(); + _subscription = null; + } + + void _onRemoteChanged(firebase_remote_config.RemoteConfigUpdate update) { + onChange(); + } + + @override + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }) async { + _logger.fine('fetch:$expiration'); + + try { + if (force) { + _logger.info('force fetch:$expiration'); + await _remoteConfig.setConfigSettings( + firebase_remote_config.RemoteConfigSettings( + fetchTimeout: const Duration(minutes: 1), + minimumFetchInterval: Duration.zero, + ), + ); + await _remoteConfig.fetchAndActivate(); + await _remoteConfig.setConfigSettings( + firebase_remote_config.RemoteConfigSettings( + fetchTimeout: const Duration(minutes: 1), + minimumFetchInterval: expiration, + ), + ); + } else { + await _remoteConfig.setConfigSettings( + firebase_remote_config.RemoteConfigSettings( + fetchTimeout: const Duration(minutes: 1), + minimumFetchInterval: expiration, + ), + ); + await _remoteConfig.fetchAndActivate(); + } + } catch (e, stackTrace) { + _logger.info('Failed to fetch', e, stackTrace); + } + } + + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + final tValue = _remoteConfig.getValue(key); + + if (tValue.source == firebase_remote_config.ValueSource.valueStatic) { + return defaultValue; + } + + return tValue.asBool(); + } + + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + final tValue = _remoteConfig.getValue(key); + + if (tValue.source == firebase_remote_config.ValueSource.valueStatic) { + return defaultValue; + } + + return tValue.asDouble(); + } + + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + final tValue = _remoteConfig.getValue(key); + + if (tValue.source == firebase_remote_config.ValueSource.valueStatic) { + return defaultValue; + } + + return tValue.asInt(); + } + + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + final tValue = _remoteConfig.getValue(key); + + if (tValue.source == firebase_remote_config.ValueSource.valueStatic) { + return defaultValue; + } + + return tValue.asString(); + } + + @override + bool hasKey(String key) => + _remoteConfig.getValue(key).source == + firebase_remote_config.ValueSource.valueRemote; + + @override + Future setDefaults(Map defaults) async { + await _remoteConfig.setDefaults(defaults); + } +} diff --git a/packages/patapata_firebase_remote_config/pubspec.yaml b/packages/patapata_firebase_remote_config/pubspec.yaml new file mode 100644 index 0000000..3578e74 --- /dev/null +++ b/packages/patapata_firebase_remote_config/pubspec.yaml @@ -0,0 +1,26 @@ +name: patapata_firebase_remote_config +description: This package is a plugin for Patapata that adds support for Firebase Remote Config to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_firebase_remote_config + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_firebase_core: ^1.0.0 + + firebase_remote_config: ^4.2.5 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_firebase_remote_config/test/patapata_firebase_remote_config_test.dart b/packages/patapata_firebase_remote_config/test/patapata_firebase_remote_config_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_firebase_remote_config/test/patapata_firebase_remote_config_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_karte_core/.gitignore b/packages/patapata_karte_core/.gitignore new file mode 100644 index 0000000..7c2eea5 --- /dev/null +++ b/packages/patapata_karte_core/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +.dart_tool/ + +.packages +.pub/ + +build/ + +**/doc/api/ \ No newline at end of file diff --git a/packages/patapata_karte_core/.metadata b/packages/patapata_karte_core/.metadata new file mode 100644 index 0000000..eb5f3e0 --- /dev/null +++ b/packages/patapata_karte_core/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: plugin diff --git a/packages/patapata_karte_core/CHANGELOG.md b/packages/patapata_karte_core/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_karte_core/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_karte_core/LICENSE b/packages/patapata_karte_core/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_karte_core/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_karte_core/README.md b/packages/patapata_karte_core/README.md new file mode 100644 index 0000000..ac316df --- /dev/null +++ b/packages/patapata_karte_core/README.md @@ -0,0 +1,68 @@ +
+

Patapata - Karte Core

+

+ Add support for Karte to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Karte](https://karte.io/) to your Patapata app. +It will automatically send events to Karte from Patapata's Analytics system. +It will also integrate with Patapata's User system and automatically send user information to Karte. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```yaml +dependencies: + patapata_karte_core: + git: + url: git://github.com/gree/patapata.git + path: packages/patapata_karte_core +``` + +2. Add settings to Android +Add a string resource to `android/app/src/main/res/values/strings.xml` with name `patapata_karte_app_key` and value your Karte app key. + +```xml +YOUR_APP_KEY +``` + +3. Add settings to iOS +Add a string resource to `ios/Runner/Info.plist` with name `patapata_karte_app_key` and value your Karte app key. + +```xml +patapata_karte_app_key +YOUR_APP_KEY +``` + +4. Import the package + +```dart +import 'package:patapata_karte_core/patapata_karte_core.dart'; +``` + +5. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + KarteCorePlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_karte_core/LICENSE) \ No newline at end of file diff --git a/packages/patapata_karte_core/analysis_options.yaml b/packages/patapata_karte_core/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_karte_core/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_karte_core/android/.gitignore b/packages/patapata_karte_core/android/.gitignore new file mode 100644 index 0000000..c6cbe56 --- /dev/null +++ b/packages/patapata_karte_core/android/.gitignore @@ -0,0 +1,8 @@ +*.iml +.gradle +/local.properties +/.idea/workspace.xml +/.idea/libraries +.DS_Store +/build +/captures diff --git a/packages/patapata_karte_core/android/build.gradle b/packages/patapata_karte_core/android/build.gradle new file mode 100644 index 0000000..6acaf05 --- /dev/null +++ b/packages/patapata_karte_core/android/build.gradle @@ -0,0 +1,54 @@ +group 'dev.patapata.patapata_karte_core' +version '1.0-SNAPSHOT' + +buildscript { + ext.kotlin_version = '1.7.10' + repositories { + google() + mavenCentral() + } + + dependencies { + classpath 'com.android.tools.build:gradle:7.3.0' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + } +} + +rootProject.allprojects { + repositories { + google() + mavenCentral() + } +} + +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' + +android { + compileSdkVersion 30 + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' + } + + sourceSets { + main.java.srcDirs += 'src/main/kotlin' + } + + defaultConfig { + minSdkVersion 16 + } + + dependencies { + compileOnly findProject(":patapata_core") + } +} + +dependencies { + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" +} diff --git a/packages/patapata_karte_core/android/gradle.properties b/packages/patapata_karte_core/android/gradle.properties new file mode 100644 index 0000000..94adc3a --- /dev/null +++ b/packages/patapata_karte_core/android/gradle.properties @@ -0,0 +1,3 @@ +org.gradle.jvmargs=-Xmx1536M +android.useAndroidX=true +android.enableJetifier=true diff --git a/packages/patapata_karte_core/android/gradle/wrapper/gradle-wrapper.properties b/packages/patapata_karte_core/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3c9d085 --- /dev/null +++ b/packages/patapata_karte_core/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-6.7-all.zip diff --git a/packages/patapata_karte_core/android/settings.gradle b/packages/patapata_karte_core/android/settings.gradle new file mode 100644 index 0000000..727784b --- /dev/null +++ b/packages/patapata_karte_core/android/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'patapata_karte_core' diff --git a/packages/patapata_karte_core/android/src/main/AndroidManifest.xml b/packages/patapata_karte_core/android/src/main/AndroidManifest.xml new file mode 100644 index 0000000..dd88d98 --- /dev/null +++ b/packages/patapata_karte_core/android/src/main/AndroidManifest.xml @@ -0,0 +1,3 @@ + + diff --git a/packages/patapata_karte_core/android/src/main/kotlin/dev/patapata/patapata_karte_core/PatapataKarteCorePlugin.kt b/packages/patapata_karte_core/android/src/main/kotlin/dev/patapata/patapata_karte_core/PatapataKarteCorePlugin.kt new file mode 100644 index 0000000..6c63a32 --- /dev/null +++ b/packages/patapata_karte_core/android/src/main/kotlin/dev/patapata/patapata_karte_core/PatapataKarteCorePlugin.kt @@ -0,0 +1,71 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +package dev.patapata.patapata_karte_core + +import android.util.Log +import androidx.annotation.NonNull +import dev.patapata.patapata_core.PatapataPlugin +import dev.patapata.patapata_core.registerPatapataPlugin +import io.flutter.embedding.engine.plugins.FlutterPlugin +import io.karte.android.KarteApp + +/** PatapataKarteCorePlugin */ +class PatapataKarteCorePlugin: FlutterPlugin, PatapataPlugin { + + private var mIsSetup = false + private var mIsEnabled = false + private var mBinding: FlutterPlugin.FlutterPluginBinding? = null + + override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { + mBinding = flutterPluginBinding + flutterPluginBinding.registerPatapataPlugin(this) + + if (mIsEnabled) { + setup() + } + } + + private fun setup() { + mBinding?.apply { + mIsSetup = true + val tKarteAppKey = applicationContext.resources.getIdentifier("patapata_karte_app_key", "string", applicationContext.packageName) + if (tKarteAppKey != 0) { + //KarteApp.setLogLevel(LogLevel.DEBUG) + KarteApp.setup(applicationContext, applicationContext.getString(tKarteAppKey)) + + if (!mIsEnabled) { + KarteApp.optOut() + } + } + } + } + + override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) { + KarteApp.optOut() + mBinding = null + } + + override fun patapataEnable() { + mIsEnabled = true + + if (!mIsSetup) { + setup() + } + } + + override fun patapataDisable() { + mIsEnabled = false + + if (mIsSetup) { + KarteApp.optOut() + } + } + + override val patapataName: String + get() = "KarteCorePlugin" +} diff --git a/packages/patapata_karte_core/dartdoc_options.yaml b/packages/patapata_karte_core/dartdoc_options.yaml new file mode 100644 index 0000000..1e3a99c --- /dev/null +++ b/packages/patapata_karte_core/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_karte_core \ No newline at end of file diff --git a/packages/patapata_karte_core/ios/.gitignore b/packages/patapata_karte_core/ios/.gitignore new file mode 100644 index 0000000..0c88507 --- /dev/null +++ b/packages/patapata_karte_core/ios/.gitignore @@ -0,0 +1,38 @@ +.idea/ +.vagrant/ +.sconsign.dblite +.svn/ + +.DS_Store +*.swp +profile + +DerivedData/ +build/ +GeneratedPluginRegistrant.h +GeneratedPluginRegistrant.m + +.generated/ + +*.pbxuser +*.mode1v3 +*.mode2v3 +*.perspectivev3 + +!default.pbxuser +!default.mode1v3 +!default.mode2v3 +!default.perspectivev3 + +xcuserdata + +*.moved-aside + +*.pyc +*sync/ +Icon? +.tags* + +/Flutter/Generated.xcconfig +/Flutter/ephemeral/ +/Flutter/flutter_export_environment.sh \ No newline at end of file diff --git a/packages/patapata_karte_core/ios/Assets/.gitkeep b/packages/patapata_karte_core/ios/Assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.h b/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.h new file mode 100644 index 0000000..68894d5 --- /dev/null +++ b/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.h @@ -0,0 +1,11 @@ +/* + * Copyright (c) GREE, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +#import + +@interface PatapataKarteCorePlugin : NSObject +@end diff --git a/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.m b/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.m new file mode 100644 index 0000000..0bc187a --- /dev/null +++ b/packages/patapata_karte_core/ios/Classes/PatapataKarteCorePlugin.m @@ -0,0 +1,20 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +#import "PatapataKarteCorePlugin.h" +#if __has_include() +#import +#else +// Support project import fallback if the generated compatibility header +// is not copied when this plugin is created as a library. +// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816 +#import "patapata_karte_core-Swift.h" +#endif + +@implementation PatapataKarteCorePlugin ++ (void)registerWithRegistrar:(NSObject*)registrar { + [SwiftPatapataKarteCorePlugin registerWithRegistrar:registrar]; +} +@end diff --git a/packages/patapata_karte_core/ios/Classes/SwiftPatapataKarteCorePlugin.swift b/packages/patapata_karte_core/ios/Classes/SwiftPatapataKarteCorePlugin.swift new file mode 100644 index 0000000..25cbce3 --- /dev/null +++ b/packages/patapata_karte_core/ios/Classes/SwiftPatapataKarteCorePlugin.swift @@ -0,0 +1,22 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import Flutter +import UIKit +import KarteCore + +public class SwiftPatapataKarteCorePlugin: NSObject, FlutterPlugin { + public static func register(with registrar: FlutterPluginRegistrar) { + if let tData = Bundle.main.infoDictionary, let tKey = tData["patapata_karte_app_key"] as? String { + // KarteApp.setLogLevel(.debug) + let tEnvironment = ProcessInfo().environment + // Karte fails to setup with a crash in a XCTest environment + if (tEnvironment["XCTestConfigurationFilePath"] == nil) { + KarteApp.setup(appKey: tKey) + KarteApp.optOut() + } + } + } +} diff --git a/packages/patapata_karte_core/ios/patapata_karte_core.podspec b/packages/patapata_karte_core/ios/patapata_karte_core.podspec new file mode 100644 index 0000000..545a89f --- /dev/null +++ b/packages/patapata_karte_core/ios/patapata_karte_core.podspec @@ -0,0 +1,31 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint patapata_karte_core.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'patapata_karte_core' + s.version = '0.0.1' + s.summary = 'A new flutter plugin project.' + s.description = <<-DESC +A new flutter plugin project. + DESC + s.homepage = 'http://example.com' + s.license = { :file => '../LICENSE' } + s.author = { 'Your Company' => 'email@example.com' } + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'Flutter' + s.platform = :ios, '8.0' + + s.dependency 'patapata_core' + s.dependency 'karte_core' + # To handle an sqlite conflict + s.dependency 'KarteUtilities/sqlite-standalone' + + # Karte declares this too, so we have to as well. + s.static_framework = true + + # Flutter.framework does not contain a i386 slice. + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' } + s.swift_version = '5.0' +end diff --git a/packages/patapata_karte_core/lib/patapata_karte_core.dart b/packages/patapata_karte_core/lib/patapata_karte_core.dart new file mode 100644 index 0000000..20b6894 --- /dev/null +++ b/packages/patapata_karte_core/lib/patapata_karte_core.dart @@ -0,0 +1,98 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_karte_core; + +import 'dart:async'; + +import 'package:karte_core/karte_core.dart'; +import 'package:patapata_core/patapata_core.dart'; + +/// A plugin that provides Karte functionality in Patapata. +class KarteCorePlugin extends Plugin { + late final StreamSubscription _eventsSubscription; + + /// Initializes the [KarteCorePlugin]. + @override + FutureOr init(App app) async { + await super.init(app); + + KarteApp.optIn(); + _eventsSubscription = + app.analytics.eventsFor().listen(_onEvent); + app.user.addSynchronousChangeListener(_onUserChanged); + + return true; + } + + @override + FutureOr dispose() async { + app.user.removeSynchronousChangeListener(_onUserChanged); + + await super.dispose(); + + KarteApp.optOut(); + _eventsSubscription.cancel(); + } + + void _onEvent(AnalyticsEvent event) { + final tFlatData = event.flatData; + final tParameters = tFlatData != null + ? { + for (var i in tFlatData.entries) + i.key: Analytics.defaultMakeLoggableToNative(i.value), + } + : null; + + final tContextData = event.navigationInteractionContextData; + final Map tContextParameters = tContextData != null + ? { + for (var i in tContextData.entries) + i.key: Analytics.defaultMakeLoggableToNative(i.value), + } + : {}; + + if (event is AnalyticsRouteViewEvent) { + Tracker.view( + event.routeName ?? '', + event.routeName, + { + 'navigationInteractionContext': tContextParameters, + }..addAll(tParameters ?? {}), + ); + } else { + Tracker.track( + event.name, + { + 'navigationInteractionContext': tContextParameters, + }..addAll(tParameters ?? {}), + ); + } + } + + String? _lastId; + + FutureOr _onUserChanged(User user, UserChangeData changes) { + final tId = changes.getIdFor(); + final tProperties = changes.getPropertiesFor(); + + if (tId != _lastId) { + _lastId = tId; + + if (tId == null) { + KarteApp.renewVisitorId(); + } + + Tracker.identify({ + 'user_id': tId, + for (var i in tProperties.entries) i.key: i.value, + }); + } else { + Tracker.identify({ + for (var i in tProperties.entries) i.key: i.value, + }); + } + } +} diff --git a/packages/patapata_karte_core/melos_patapata_karte_core.iml b/packages/patapata_karte_core/melos_patapata_karte_core.iml new file mode 100644 index 0000000..9fc8ce7 --- /dev/null +++ b/packages/patapata_karte_core/melos_patapata_karte_core.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/patapata_karte_core/pubspec.yaml b/packages/patapata_karte_core/pubspec.yaml new file mode 100644 index 0000000..e49e101 --- /dev/null +++ b/packages/patapata_karte_core/pubspec.yaml @@ -0,0 +1,33 @@ +name: patapata_karte_core +description: This package is a plugin for Patapata that adds support for Karte to your Patapata app. +version: 1.0.0 +publish_to: none +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_karte_core + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + karte_core: ^1.2.1 + karte_in_app_messaging: ^1.2.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: + plugin: + platforms: + android: + package: dev.patapata.patapata_karte_core + pluginClass: PatapataKarteCorePlugin + ios: + pluginClass: PatapataKarteCorePlugin diff --git a/packages/patapata_karte_core/test/patapata_karte_core_test.dart b/packages/patapata_karte_core/test/patapata_karte_core_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_karte_core/test/patapata_karte_core_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_karte_variables/.gitignore b/packages/patapata_karte_variables/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_karte_variables/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_karte_variables/.metadata b/packages/patapata_karte_variables/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_karte_variables/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_karte_variables/CHANGELOG.md b/packages/patapata_karte_variables/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_karte_variables/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_karte_variables/LICENSE b/packages/patapata_karte_variables/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_karte_variables/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_karte_variables/README.md b/packages/patapata_karte_variables/README.md new file mode 100644 index 0000000..e4fbbb3 --- /dev/null +++ b/packages/patapata_karte_variables/README.md @@ -0,0 +1,55 @@ +
+

Patapata - Karte Variables

+

+ Add support for Karte Variables to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Karte Variables](https://pub.dev/packages/karte_variables) to your Patapata app. +It will automatically fetch variables from Karte and make them available in your app via Patapata's RemoteConfig system. + +This plugin requires [Patapata Karte Core](https://github.com/gree/patapata/packages/patapata_karte_core) to be installed and configured. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```yaml +dependencies: + patapata_karte_variables: + git: + url: git://github.com/gree/patapata.git + path: packages/patapata_karte_variables +``` + +2. Import the package + +```dart +import 'package:patapata_karte_variables/patapata_karte_variables.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + KarteCorePlugin(), + KarteVariablesPlugin(), + ], + ) + .run(); +} +``` + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_karte_variables/LICENSE) \ No newline at end of file diff --git a/packages/patapata_karte_variables/analysis_options.yaml b/packages/patapata_karte_variables/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_karte_variables/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_karte_variables/dartdoc_options.yaml b/packages/patapata_karte_variables/dartdoc_options.yaml new file mode 100644 index 0000000..b2b045c --- /dev/null +++ b/packages/patapata_karte_variables/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_karte_variables \ No newline at end of file diff --git a/packages/patapata_karte_variables/lib/patapata_karte_variables.dart b/packages/patapata_karte_variables/lib/patapata_karte_variables.dart new file mode 100644 index 0000000..959ecec --- /dev/null +++ b/packages/patapata_karte_variables/lib/patapata_karte_variables.dart @@ -0,0 +1,216 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_karte_variables; + +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:karte_variables/karte_variables.dart'; +import 'package:patapata_karte_core/patapata_karte_core.dart'; + +final _logger = Logger('patapata.KarteVariablesPlugin'); + +/// A plugin that provides KarteVariables functionality. For information about KarteVariables, please refer to the [official documentation](https://pub.dev/packages/karte_variables). +/// To use this plugin, you need to add the [patapata_karte_core](https://pub.dev/packages/patapata_karte_core) package to your application. +class KarteVariablesPlugin extends Plugin { + @override + List get dependencies => [KarteCorePlugin]; + + @override + RemoteConfig createRemoteConfig() => _KarteVariablesPluginRemoteConfig(); +} + +class _KarteVariablesPluginRemoteConfig extends RemoteConfig { + Map _defaults = {}; + final Map _variables = {}; + bool _updating = false; + bool _fetching = false; + + Future _updateVariablesFromDefaults() async { + _updating = true; + + try { + _variables.clear(); + + for (var tKey in _defaults.keys) { + final tDefaultValue = _defaults[tKey]; + + switch (tDefaultValue?.runtimeType) { + case int: + await _updateVariable(tKey, tDefaultValue as int); + break; + case double: + await _updateVariable(tKey, tDefaultValue as double); + break; + case String: + await _updateVariable(tKey, tDefaultValue as String); + break; + case bool: + await _updateVariable(tKey, tDefaultValue as bool); + break; + default: + break; + } + } + + _updating = false; + + if (_defaults.isNotEmpty) { + onChange(); + } + } catch (e, stackTrace) { + _updating = false; + _logger.warning('Failed to update Variables', e, stackTrace); + } + } + + Future _updateVariable(String key, T defaultValue) async { + final tVariable = await Variables.get(key); + dynamic tValue; + + switch (T) { + case int: + tValue = await tVariable.getInteger(defaultValue as int); + break; + case double: + tValue = await tVariable.getDouble(defaultValue as double); + break; + case String: + tValue = await tVariable.getString(defaultValue as String); + break; + case bool: + tValue = await tVariable.getBoolean(defaultValue as bool); + break; + default: + break; + } + + _variables[key] = tValue; + + return tValue; + } + + @override + Future fetch({ + Duration expiration = const Duration(hours: 5), + bool force = false, + }) async { + if (_fetching) { + return; + } + + _fetching = true; + + try { + await Variables.fetch(); + // ignore: todo + // TODO: Expiration. Just make a timer. + } catch (e, stackTrace) { + _logger.warning('Failed to fetch Variables', e, stackTrace); + } + + if (_updating) { + return; + } + + // Karte Flutter version doesn't support getting variables + // synchronously. So we cheat and use the defaults as a hint + // that these are going to get getted. + // If something unexpected not in defaults comes along... + // we get it async and use onChange to tell people + // it updated while returning the default value before that. + // Not a great solution but yeah... + await _updateVariablesFromDefaults(); + + _fetching = false; + } + + @override + bool getBool(String key, {bool defaultValue = Config.defaultValueForBool}) { + if (_variables.containsKey(key)) { + final tVariable = _variables[key]; + + return tVariable is bool ? tVariable : defaultValue; + } else { + // We got an unexpected get. Update it. + _updateVariable(key, defaultValue).then((v) { + onChange(); + }); + + // Until that's done we have to return the default value. + return defaultValue; + } + } + + @override + double getDouble(String key, + {double defaultValue = Config.defaultValueForDouble}) { + if (_variables.containsKey(key)) { + final tVariable = _variables[key]; + + return tVariable is double ? tVariable : defaultValue; + } else { + // We got an unexpected get. Update it. + _updateVariable(key, defaultValue).then((v) { + onChange(); + }); + + // Until that's done we have to return the default value. + return defaultValue; + } + } + + @override + int getInt(String key, {int defaultValue = Config.defaultValueForInt}) { + if (_variables.containsKey(key)) { + final tVariable = _variables[key]; + + return tVariable is int ? tVariable : defaultValue; + } else { + // We got an unexpected get. Update it. + _updateVariable(key, defaultValue).then((v) { + onChange(); + }); + + // Until that's done we have to return the default value. + return defaultValue; + } + } + + @override + String getString(String key, + {String defaultValue = Config.defaultValueForString}) { + if (_variables.containsKey(key)) { + final tVariable = _variables[key]; + + return tVariable is String ? tVariable : defaultValue; + } else { + // We got an unexpected get. Update it. + _updateVariable(key, defaultValue).then((v) { + onChange(); + }); + + // Until that's done we have to return the default value. + return defaultValue; + } + } + + @override + bool hasKey(String key) { + // This is not 100% correct. + // This will return a false positive when + // a _defaults value that was saved in + // _variables exists (most of the time...) + // However Karte doesn't provide a way to know + // if a key exists or not so we do the best we can. + return _variables.containsKey(key); + } + + @override + Future setDefaults(Map defaults) async { + _defaults = Map.of(defaults); + await _updateVariablesFromDefaults(); + } +} diff --git a/packages/patapata_karte_variables/pubspec.yaml b/packages/patapata_karte_variables/pubspec.yaml new file mode 100644 index 0000000..57792d4 --- /dev/null +++ b/packages/patapata_karte_variables/pubspec.yaml @@ -0,0 +1,27 @@ +name: patapata_karte_variables +description: This package is a plugin for Patapata that adds support for Karte Variables to your Patapata app. +version: 1.0.0 +publish_to: none +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_karte_variables + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + patapata_karte_core: ^1.0.0 + + karte_variables: ^1.3.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_karte_variables/test/patapata_karte_variables_test.dart b/packages/patapata_karte_variables/test/patapata_karte_variables_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_karte_variables/test/patapata_karte_variables_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/packages/patapata_riverpod/.gitignore b/packages/patapata_riverpod/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_riverpod/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_riverpod/.metadata b/packages/patapata_riverpod/.metadata new file mode 100644 index 0000000..6176c00 --- /dev/null +++ b/packages/patapata_riverpod/.metadata @@ -0,0 +1,10 @@ +# 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: "d211f42860350d914a5ad8102f9ec32764dc6d06" + channel: "stable" + +project_type: package diff --git a/packages/patapata_riverpod/CHANGELOG.md b/packages/patapata_riverpod/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_riverpod/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_riverpod/LICENSE b/packages/patapata_riverpod/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_riverpod/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_riverpod/README.md b/packages/patapata_riverpod/README.md new file mode 100644 index 0000000..4654883 --- /dev/null +++ b/packages/patapata_riverpod/README.md @@ -0,0 +1,51 @@ +
+

Patapata - Riverpod

+

+ Add support for Riverpod to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Riverpod](https://pub.dev/packages/riverpod) to your Patapata app. + +It will automatically inject your app's environment into your Riverpod providers. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_riverpod +``` + +2. Import the package + +```dart +import 'package:patapata_riverpod/patapata_riverpod.dart'; +``` + +3. Activate the plugin + +```dart +void main() { + App( + environment: const Environment(), + plugins: [ + RiverpodPlugin(), + ], + ) + .run(); +} +``` + +4. See the providers you can use by reading the [API documentation](https://pub.dev/documentation/patapata_riverpod/latest/patapata_riverpod/patapata_riverpod-library.html). + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_riverpod/LICENSE) \ No newline at end of file diff --git a/packages/patapata_riverpod/analysis_options.yaml b/packages/patapata_riverpod/analysis_options.yaml new file mode 100644 index 0000000..cade7bd --- /dev/null +++ b/packages/patapata_riverpod/analysis_options.yaml @@ -0,0 +1,11 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + plugins: + - custom_lint + exclude: + - example/** diff --git a/packages/patapata_riverpod/lib/patapata_riverpod.dart b/packages/patapata_riverpod/lib/patapata_riverpod.dart new file mode 100644 index 0000000..3a20ef5 --- /dev/null +++ b/packages/patapata_riverpod/lib/patapata_riverpod.dart @@ -0,0 +1,9 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_riverpod; + +export 'src/riverpod_plugin.dart'; +export 'src/providers.dart'; diff --git a/packages/patapata_riverpod/lib/src/providers.dart b/packages/patapata_riverpod/lib/src/providers.dart new file mode 100644 index 0000000..ef4e2d3 --- /dev/null +++ b/packages/patapata_riverpod/lib/src/providers.dart @@ -0,0 +1,198 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/foundation.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:riverpod_annotation/riverpod_annotation.dart'; + +part 'providers.g.dart'; + +/// The [App] instance. +@riverpod +App app(AppRef ref) { + return getApp(); +} + +/// The current [User]. +/// Whenever [User] changes, this provider will be updated. +@riverpod +Raw user(UserRef ref) { + return ref.disposeAndListenChangeNotifier(ref.read(appProvider).user); +} + +/// Access to [RemoteConfig]. +/// Whenever [RemoteConfig] changes, this provider will be updated. +@riverpod +Raw remoteConfig(RemoteConfigRef ref) { + return ref.disposeAndListenChangeNotifier(ref.read(appProvider).remoteConfig); +} + +/// Gets a [RemoteConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +String remoteConfigString(RemoteConfigStringRef ref, String key, + [String defaultValue = Config.defaultValueForString]) { + return ref.watch(remoteConfigProvider + .select((v) => v.getString(key, defaultValue: defaultValue))); +} + +/// Gets a [RemoteConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +int remoteConfigInt(RemoteConfigIntRef ref, String key, + [int defaultValue = Config.defaultValueForInt]) { + return ref.watch(remoteConfigProvider + .select((v) => v.getInt(key, defaultValue: defaultValue))); +} + +/// Gets a [RemoteConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +double remoteConfigDouble(RemoteConfigDoubleRef ref, String key, + [double defaultValue = Config.defaultValueForDouble]) { + return ref.watch(remoteConfigProvider + .select((v) => v.getDouble(key, defaultValue: defaultValue))); +} + +/// Gets a [RemoteConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +bool remoteConfigBool(RemoteConfigBoolRef ref, String key, + [bool defaultValue = Config.defaultValueForBool]) { + return ref.watch(remoteConfigProvider + .select((v) => v.getBool(key, defaultValue: defaultValue))); +} + +/// Access to [LocalConfig]. +/// Whenever [LocalConfig] changes, this provider will be updated. +@riverpod +Raw localConfig(LocalConfigRef ref) { + return ref.disposeAndListenChangeNotifier(ref.read(appProvider).localConfig); +} + +/// Gets a [LocalConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +String localConfigString(LocalConfigStringRef ref, String key, + [String defaultValue = Config.defaultValueForString]) { + return ref.watch(localConfigProvider + .select((v) => v.getString(key, defaultValue: defaultValue))); +} + +/// Gets a [LocalConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +int localConfigInt(LocalConfigIntRef ref, String key, + [int defaultValue = Config.defaultValueForInt]) { + return ref.watch(localConfigProvider + .select((v) => v.getInt(key, defaultValue: defaultValue))); +} + +/// Gets a [LocalConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +double localConfigDouble(LocalConfigDoubleRef ref, String key, + [double defaultValue = Config.defaultValueForDouble]) { + return ref.watch(localConfigProvider + .select((v) => v.getDouble(key, defaultValue: defaultValue))); +} + +/// Gets a [LocalConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +@riverpod +bool localConfigBool(LocalConfigBoolRef ref, String key, + [bool defaultValue = Config.defaultValueForBool]) { + return ref.watch(localConfigProvider + .select((v) => v.getBool(key, defaultValue: defaultValue))); +} + +/// Access to [RemoteMessaging]. +/// Whenever [RemoteMessaging] changes, this provider will be updated. +@riverpod +Raw remoteMessaging(RemoteMessagingRef ref) { + return ref + .disposeAndListenChangeNotifier(ref.read(appProvider).remoteMessaging); +} + +/// Access to [RemoteMessaging.messages]. +/// Whenever a new [RemoteMessage] is receieved via [RemoteMessaging.messages], this provider will be updated. +/// The first execution of this will return the initial message from [RemoteMessaging.getInitialMessage]. +@riverpod +Stream remoteMessagingMessages( + RemoteMessagingMessagesRef ref) async* { + final tRemoteMessaging = ref.watch(remoteMessagingProvider); + + final tInitialMessage = await tRemoteMessaging.getInitialMessage(); + + if (tInitialMessage != null) { + yield tInitialMessage; + } + + yield* tRemoteMessaging.messages; +} + +/// Access to [RemoteMessaging.tokens]. +/// Whenever a new token is receieved via [RemoteMessaging.tokens], this provider will be updated. +/// The first execution of this will return the current token from [RemoteMessaging.getToken]. +@riverpod +Stream remoteMessagingTokens(RemoteMessagingTokensRef ref) async* { + final tRemoteMessaging = ref.watch(remoteMessagingProvider); + + yield await tRemoteMessaging.getToken(); + yield* tRemoteMessaging.tokens; +} + +/// Access to [Analytics]. +@riverpod +Analytics analytics(AnalyticsRef ref) { + return ref.read(appProvider).analytics; +} + +/// Access to the global [AnalyticsContext] from [Analytics.globalContext]. +@riverpod +AnalyticsContext globalAnalyticsContext(GlobalAnalyticsContextRef ref) { + return ref.read(analyticsProvider).globalContext; +} + +/// Access to a stream of [NetworkInformation]. +/// Whenever [NetworkInformation] changes, this provider will be updated. +@riverpod +NetworkInformation networkInformation(NetworkInformationRef ref) { + final tNetworkPlugin = ref.read(appProvider).getPlugin()!; + + final tSubscription = tNetworkPlugin.informationStream.listen((event) { + ref.invalidateSelf(); + }); + + ref.onDispose(tSubscription.cancel); + + return tNetworkPlugin.information; +} + +/// Access to [PackageInfo]. +@riverpod +PackageInfoPlugin packageInfo(PackageInfoRef ref) { + return ref.read(appProvider).package; +} + +/// Access to [DeviceInfo]. +@riverpod +DeviceInfoPlugin deviceInfo(DeviceInfoRef ref) { + return ref.read(appProvider).device; +} + +extension _Disposeable on Ref { + // We can move the previous logic to a Ref extension. + // This enables reusing the logic between providers + T disposeAndListenChangeNotifier(T notifier) { + onDispose(() { + notifier.removeListener(notifyListeners); + }); + notifier.addListener(notifyListeners); + // We return the notifier to ease the usage a bit + return notifier; + } +} diff --git a/packages/patapata_riverpod/lib/src/providers.g.dart b/packages/patapata_riverpod/lib/src/providers.g.dart new file mode 100644 index 0000000..924666e --- /dev/null +++ b/packages/patapata_riverpod/lib/src/providers.g.dart @@ -0,0 +1,1560 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'providers.dart'; + +// ************************************************************************** +// RiverpodGenerator +// ************************************************************************** + +String _$appHash() => r'b221fc2a0f1007056310f6ab8af4b3bdb50f2ecc'; + +/// The [App] instance. +/// +/// Copied from [app]. +@ProviderFor(app) +final appProvider = AutoDisposeProvider.internal( + app, + name: r'appProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$appHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AppRef = AutoDisposeProviderRef; +String _$userHash() => r'185492973048a3679bb21cb6e2bf4ce15012ec7e'; + +/// The current [User]. +/// Whenever [User] changes, this provider will be updated. +/// +/// Copied from [user]. +@ProviderFor(user) +final userProvider = AutoDisposeProvider>.internal( + user, + name: r'userProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$userHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef UserRef = AutoDisposeProviderRef>; +String _$remoteConfigHash() => r'8e75aba0bc4b5c62efcad5a0d20aba8538c17cd3'; + +/// Access to [RemoteConfig]. +/// Whenever [RemoteConfig] changes, this provider will be updated. +/// +/// Copied from [remoteConfig]. +@ProviderFor(remoteConfig) +final remoteConfigProvider = AutoDisposeProvider>.internal( + remoteConfig, + name: r'remoteConfigProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$remoteConfigHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RemoteConfigRef = AutoDisposeProviderRef>; +String _$remoteConfigStringHash() => + r'd3defab5f7870a383673f72bbe259deb968ff000'; + +/// Copied from Dart SDK +class _SystemHash { + _SystemHash._(); + + static int combine(int hash, int value) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + value); + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x0007ffff & hash) << 10)); + return hash ^ (hash >> 6); + } + + static int finish(int hash) { + // ignore: parameter_assignments + hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3)); + // ignore: parameter_assignments + hash = hash ^ (hash >> 11); + return 0x1fffffff & (hash + ((0x00003fff & hash) << 15)); + } +} + +/// Gets a [RemoteConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigString]. +@ProviderFor(remoteConfigString) +const remoteConfigStringProvider = RemoteConfigStringFamily(); + +/// Gets a [RemoteConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigString]. +class RemoteConfigStringFamily extends Family { + /// Gets a [RemoteConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigString]. + const RemoteConfigStringFamily(); + + /// Gets a [RemoteConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigString]. + RemoteConfigStringProvider call( + String key, [ + String defaultValue = Config.defaultValueForString, + ]) { + return RemoteConfigStringProvider( + key, + defaultValue, + ); + } + + @override + RemoteConfigStringProvider getProviderOverride( + covariant RemoteConfigStringProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'remoteConfigStringProvider'; +} + +/// Gets a [RemoteConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigString]. +class RemoteConfigStringProvider extends AutoDisposeProvider { + /// Gets a [RemoteConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigString]. + RemoteConfigStringProvider( + String key, [ + String defaultValue = Config.defaultValueForString, + ]) : this._internal( + (ref) => remoteConfigString( + ref as RemoteConfigStringRef, + key, + defaultValue, + ), + from: remoteConfigStringProvider, + name: r'remoteConfigStringProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteConfigStringHash, + dependencies: RemoteConfigStringFamily._dependencies, + allTransitiveDependencies: + RemoteConfigStringFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + RemoteConfigStringProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final String defaultValue; + + @override + Override overrideWith( + String Function(RemoteConfigStringRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: RemoteConfigStringProvider._internal( + (ref) => create(ref as RemoteConfigStringRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RemoteConfigStringProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is RemoteConfigStringProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RemoteConfigStringRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + String get defaultValue; +} + +class _RemoteConfigStringProviderElement + extends AutoDisposeProviderElement with RemoteConfigStringRef { + _RemoteConfigStringProviderElement(super.provider); + + @override + String get key => (origin as RemoteConfigStringProvider).key; + @override + String get defaultValue => + (origin as RemoteConfigStringProvider).defaultValue; +} + +String _$remoteConfigIntHash() => r'102555b16644b3768133e933fbb7e6b4e84efe61'; + +/// Gets a [RemoteConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigInt]. +@ProviderFor(remoteConfigInt) +const remoteConfigIntProvider = RemoteConfigIntFamily(); + +/// Gets a [RemoteConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigInt]. +class RemoteConfigIntFamily extends Family { + /// Gets a [RemoteConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigInt]. + const RemoteConfigIntFamily(); + + /// Gets a [RemoteConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigInt]. + RemoteConfigIntProvider call( + String key, [ + int defaultValue = Config.defaultValueForInt, + ]) { + return RemoteConfigIntProvider( + key, + defaultValue, + ); + } + + @override + RemoteConfigIntProvider getProviderOverride( + covariant RemoteConfigIntProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'remoteConfigIntProvider'; +} + +/// Gets a [RemoteConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigInt]. +class RemoteConfigIntProvider extends AutoDisposeProvider { + /// Gets a [RemoteConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigInt]. + RemoteConfigIntProvider( + String key, [ + int defaultValue = Config.defaultValueForInt, + ]) : this._internal( + (ref) => remoteConfigInt( + ref as RemoteConfigIntRef, + key, + defaultValue, + ), + from: remoteConfigIntProvider, + name: r'remoteConfigIntProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteConfigIntHash, + dependencies: RemoteConfigIntFamily._dependencies, + allTransitiveDependencies: + RemoteConfigIntFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + RemoteConfigIntProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final int defaultValue; + + @override + Override overrideWith( + int Function(RemoteConfigIntRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: RemoteConfigIntProvider._internal( + (ref) => create(ref as RemoteConfigIntRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RemoteConfigIntProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is RemoteConfigIntProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RemoteConfigIntRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + int get defaultValue; +} + +class _RemoteConfigIntProviderElement extends AutoDisposeProviderElement + with RemoteConfigIntRef { + _RemoteConfigIntProviderElement(super.provider); + + @override + String get key => (origin as RemoteConfigIntProvider).key; + @override + int get defaultValue => (origin as RemoteConfigIntProvider).defaultValue; +} + +String _$remoteConfigDoubleHash() => + r'f7cf93febfff6eab6e48c05bb7aa177e31aaf84b'; + +/// Gets a [RemoteConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigDouble]. +@ProviderFor(remoteConfigDouble) +const remoteConfigDoubleProvider = RemoteConfigDoubleFamily(); + +/// Gets a [RemoteConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigDouble]. +class RemoteConfigDoubleFamily extends Family { + /// Gets a [RemoteConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigDouble]. + const RemoteConfigDoubleFamily(); + + /// Gets a [RemoteConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigDouble]. + RemoteConfigDoubleProvider call( + String key, [ + double defaultValue = Config.defaultValueForDouble, + ]) { + return RemoteConfigDoubleProvider( + key, + defaultValue, + ); + } + + @override + RemoteConfigDoubleProvider getProviderOverride( + covariant RemoteConfigDoubleProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'remoteConfigDoubleProvider'; +} + +/// Gets a [RemoteConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigDouble]. +class RemoteConfigDoubleProvider extends AutoDisposeProvider { + /// Gets a [RemoteConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigDouble]. + RemoteConfigDoubleProvider( + String key, [ + double defaultValue = Config.defaultValueForDouble, + ]) : this._internal( + (ref) => remoteConfigDouble( + ref as RemoteConfigDoubleRef, + key, + defaultValue, + ), + from: remoteConfigDoubleProvider, + name: r'remoteConfigDoubleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteConfigDoubleHash, + dependencies: RemoteConfigDoubleFamily._dependencies, + allTransitiveDependencies: + RemoteConfigDoubleFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + RemoteConfigDoubleProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final double defaultValue; + + @override + Override overrideWith( + double Function(RemoteConfigDoubleRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: RemoteConfigDoubleProvider._internal( + (ref) => create(ref as RemoteConfigDoubleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RemoteConfigDoubleProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is RemoteConfigDoubleProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RemoteConfigDoubleRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + double get defaultValue; +} + +class _RemoteConfigDoubleProviderElement + extends AutoDisposeProviderElement with RemoteConfigDoubleRef { + _RemoteConfigDoubleProviderElement(super.provider); + + @override + String get key => (origin as RemoteConfigDoubleProvider).key; + @override + double get defaultValue => + (origin as RemoteConfigDoubleProvider).defaultValue; +} + +String _$remoteConfigBoolHash() => r'13a9e5417b965b88f843d5fa69b7cb03cb9fea95'; + +/// Gets a [RemoteConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigBool]. +@ProviderFor(remoteConfigBool) +const remoteConfigBoolProvider = RemoteConfigBoolFamily(); + +/// Gets a [RemoteConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigBool]. +class RemoteConfigBoolFamily extends Family { + /// Gets a [RemoteConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigBool]. + const RemoteConfigBoolFamily(); + + /// Gets a [RemoteConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigBool]. + RemoteConfigBoolProvider call( + String key, [ + bool defaultValue = Config.defaultValueForBool, + ]) { + return RemoteConfigBoolProvider( + key, + defaultValue, + ); + } + + @override + RemoteConfigBoolProvider getProviderOverride( + covariant RemoteConfigBoolProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'remoteConfigBoolProvider'; +} + +/// Gets a [RemoteConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [remoteConfigBool]. +class RemoteConfigBoolProvider extends AutoDisposeProvider { + /// Gets a [RemoteConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [remoteConfigBool]. + RemoteConfigBoolProvider( + String key, [ + bool defaultValue = Config.defaultValueForBool, + ]) : this._internal( + (ref) => remoteConfigBool( + ref as RemoteConfigBoolRef, + key, + defaultValue, + ), + from: remoteConfigBoolProvider, + name: r'remoteConfigBoolProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteConfigBoolHash, + dependencies: RemoteConfigBoolFamily._dependencies, + allTransitiveDependencies: + RemoteConfigBoolFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + RemoteConfigBoolProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final bool defaultValue; + + @override + Override overrideWith( + bool Function(RemoteConfigBoolRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: RemoteConfigBoolProvider._internal( + (ref) => create(ref as RemoteConfigBoolRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _RemoteConfigBoolProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is RemoteConfigBoolProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin RemoteConfigBoolRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + bool get defaultValue; +} + +class _RemoteConfigBoolProviderElement extends AutoDisposeProviderElement + with RemoteConfigBoolRef { + _RemoteConfigBoolProviderElement(super.provider); + + @override + String get key => (origin as RemoteConfigBoolProvider).key; + @override + bool get defaultValue => (origin as RemoteConfigBoolProvider).defaultValue; +} + +String _$localConfigHash() => r'2d0900f1e1f41f25456b738fcc2a18d4fd7cca59'; + +/// Access to [LocalConfig]. +/// Whenever [LocalConfig] changes, this provider will be updated. +/// +/// Copied from [localConfig]. +@ProviderFor(localConfig) +final localConfigProvider = AutoDisposeProvider>.internal( + localConfig, + name: r'localConfigProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$localConfigHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef LocalConfigRef = AutoDisposeProviderRef>; +String _$localConfigStringHash() => r'5d87800e6aa2139e9129dba2d78145a941927fc5'; + +/// Gets a [LocalConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigString]. +@ProviderFor(localConfigString) +const localConfigStringProvider = LocalConfigStringFamily(); + +/// Gets a [LocalConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigString]. +class LocalConfigStringFamily extends Family { + /// Gets a [LocalConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigString]. + const LocalConfigStringFamily(); + + /// Gets a [LocalConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigString]. + LocalConfigStringProvider call( + String key, [ + String defaultValue = Config.defaultValueForString, + ]) { + return LocalConfigStringProvider( + key, + defaultValue, + ); + } + + @override + LocalConfigStringProvider getProviderOverride( + covariant LocalConfigStringProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'localConfigStringProvider'; +} + +/// Gets a [LocalConfig] value as a [String]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigString]. +class LocalConfigStringProvider extends AutoDisposeProvider { + /// Gets a [LocalConfig] value as a [String]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigString]. + LocalConfigStringProvider( + String key, [ + String defaultValue = Config.defaultValueForString, + ]) : this._internal( + (ref) => localConfigString( + ref as LocalConfigStringRef, + key, + defaultValue, + ), + from: localConfigStringProvider, + name: r'localConfigStringProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$localConfigStringHash, + dependencies: LocalConfigStringFamily._dependencies, + allTransitiveDependencies: + LocalConfigStringFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + LocalConfigStringProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final String defaultValue; + + @override + Override overrideWith( + String Function(LocalConfigStringRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: LocalConfigStringProvider._internal( + (ref) => create(ref as LocalConfigStringRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _LocalConfigStringProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is LocalConfigStringProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LocalConfigStringRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + String get defaultValue; +} + +class _LocalConfigStringProviderElement + extends AutoDisposeProviderElement with LocalConfigStringRef { + _LocalConfigStringProviderElement(super.provider); + + @override + String get key => (origin as LocalConfigStringProvider).key; + @override + String get defaultValue => (origin as LocalConfigStringProvider).defaultValue; +} + +String _$localConfigIntHash() => r'4050a4918e2d6b5b05931444019231f0dd3def14'; + +/// Gets a [LocalConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigInt]. +@ProviderFor(localConfigInt) +const localConfigIntProvider = LocalConfigIntFamily(); + +/// Gets a [LocalConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigInt]. +class LocalConfigIntFamily extends Family { + /// Gets a [LocalConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigInt]. + const LocalConfigIntFamily(); + + /// Gets a [LocalConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigInt]. + LocalConfigIntProvider call( + String key, [ + int defaultValue = Config.defaultValueForInt, + ]) { + return LocalConfigIntProvider( + key, + defaultValue, + ); + } + + @override + LocalConfigIntProvider getProviderOverride( + covariant LocalConfigIntProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'localConfigIntProvider'; +} + +/// Gets a [LocalConfig] value as a [int]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigInt]. +class LocalConfigIntProvider extends AutoDisposeProvider { + /// Gets a [LocalConfig] value as a [int]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigInt]. + LocalConfigIntProvider( + String key, [ + int defaultValue = Config.defaultValueForInt, + ]) : this._internal( + (ref) => localConfigInt( + ref as LocalConfigIntRef, + key, + defaultValue, + ), + from: localConfigIntProvider, + name: r'localConfigIntProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$localConfigIntHash, + dependencies: LocalConfigIntFamily._dependencies, + allTransitiveDependencies: + LocalConfigIntFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + LocalConfigIntProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final int defaultValue; + + @override + Override overrideWith( + int Function(LocalConfigIntRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: LocalConfigIntProvider._internal( + (ref) => create(ref as LocalConfigIntRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _LocalConfigIntProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is LocalConfigIntProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LocalConfigIntRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + int get defaultValue; +} + +class _LocalConfigIntProviderElement extends AutoDisposeProviderElement + with LocalConfigIntRef { + _LocalConfigIntProviderElement(super.provider); + + @override + String get key => (origin as LocalConfigIntProvider).key; + @override + int get defaultValue => (origin as LocalConfigIntProvider).defaultValue; +} + +String _$localConfigDoubleHash() => r'177c15a70d201d5ec197ec3569a654193b6297fb'; + +/// Gets a [LocalConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigDouble]. +@ProviderFor(localConfigDouble) +const localConfigDoubleProvider = LocalConfigDoubleFamily(); + +/// Gets a [LocalConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigDouble]. +class LocalConfigDoubleFamily extends Family { + /// Gets a [LocalConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigDouble]. + const LocalConfigDoubleFamily(); + + /// Gets a [LocalConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigDouble]. + LocalConfigDoubleProvider call( + String key, [ + double defaultValue = Config.defaultValueForDouble, + ]) { + return LocalConfigDoubleProvider( + key, + defaultValue, + ); + } + + @override + LocalConfigDoubleProvider getProviderOverride( + covariant LocalConfigDoubleProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'localConfigDoubleProvider'; +} + +/// Gets a [LocalConfig] value as a [double]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigDouble]. +class LocalConfigDoubleProvider extends AutoDisposeProvider { + /// Gets a [LocalConfig] value as a [double]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigDouble]. + LocalConfigDoubleProvider( + String key, [ + double defaultValue = Config.defaultValueForDouble, + ]) : this._internal( + (ref) => localConfigDouble( + ref as LocalConfigDoubleRef, + key, + defaultValue, + ), + from: localConfigDoubleProvider, + name: r'localConfigDoubleProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$localConfigDoubleHash, + dependencies: LocalConfigDoubleFamily._dependencies, + allTransitiveDependencies: + LocalConfigDoubleFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + LocalConfigDoubleProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final double defaultValue; + + @override + Override overrideWith( + double Function(LocalConfigDoubleRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: LocalConfigDoubleProvider._internal( + (ref) => create(ref as LocalConfigDoubleRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _LocalConfigDoubleProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is LocalConfigDoubleProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LocalConfigDoubleRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + double get defaultValue; +} + +class _LocalConfigDoubleProviderElement + extends AutoDisposeProviderElement with LocalConfigDoubleRef { + _LocalConfigDoubleProviderElement(super.provider); + + @override + String get key => (origin as LocalConfigDoubleProvider).key; + @override + double get defaultValue => (origin as LocalConfigDoubleProvider).defaultValue; +} + +String _$localConfigBoolHash() => r'45ff874a484e20c2ae29d4113d77914e6cf46696'; + +/// Gets a [LocalConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigBool]. +@ProviderFor(localConfigBool) +const localConfigBoolProvider = LocalConfigBoolFamily(); + +/// Gets a [LocalConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigBool]. +class LocalConfigBoolFamily extends Family { + /// Gets a [LocalConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigBool]. + const LocalConfigBoolFamily(); + + /// Gets a [LocalConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigBool]. + LocalConfigBoolProvider call( + String key, [ + bool defaultValue = Config.defaultValueForBool, + ]) { + return LocalConfigBoolProvider( + key, + defaultValue, + ); + } + + @override + LocalConfigBoolProvider getProviderOverride( + covariant LocalConfigBoolProvider provider, + ) { + return call( + provider.key, + provider.defaultValue, + ); + } + + static const Iterable? _dependencies = null; + + @override + Iterable? get dependencies => _dependencies; + + static const Iterable? _allTransitiveDependencies = null; + + @override + Iterable? get allTransitiveDependencies => + _allTransitiveDependencies; + + @override + String? get name => r'localConfigBoolProvider'; +} + +/// Gets a [LocalConfig] value as a [bool]. +/// Whenever this [key] changes, this provider will be updated. +/// +/// Copied from [localConfigBool]. +class LocalConfigBoolProvider extends AutoDisposeProvider { + /// Gets a [LocalConfig] value as a [bool]. + /// Whenever this [key] changes, this provider will be updated. + /// + /// Copied from [localConfigBool]. + LocalConfigBoolProvider( + String key, [ + bool defaultValue = Config.defaultValueForBool, + ]) : this._internal( + (ref) => localConfigBool( + ref as LocalConfigBoolRef, + key, + defaultValue, + ), + from: localConfigBoolProvider, + name: r'localConfigBoolProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') + ? null + : _$localConfigBoolHash, + dependencies: LocalConfigBoolFamily._dependencies, + allTransitiveDependencies: + LocalConfigBoolFamily._allTransitiveDependencies, + key: key, + defaultValue: defaultValue, + ); + + LocalConfigBoolProvider._internal( + super._createNotifier, { + required super.name, + required super.dependencies, + required super.allTransitiveDependencies, + required super.debugGetCreateSourceHash, + required super.from, + required this.key, + required this.defaultValue, + }) : super.internal(); + + final String key; + final bool defaultValue; + + @override + Override overrideWith( + bool Function(LocalConfigBoolRef provider) create, + ) { + return ProviderOverride( + origin: this, + override: LocalConfigBoolProvider._internal( + (ref) => create(ref as LocalConfigBoolRef), + from: from, + name: null, + dependencies: null, + allTransitiveDependencies: null, + debugGetCreateSourceHash: null, + key: key, + defaultValue: defaultValue, + ), + ); + } + + @override + AutoDisposeProviderElement createElement() { + return _LocalConfigBoolProviderElement(this); + } + + @override + bool operator ==(Object other) { + return other is LocalConfigBoolProvider && + other.key == key && + other.defaultValue == defaultValue; + } + + @override + int get hashCode { + var hash = _SystemHash.combine(0, runtimeType.hashCode); + hash = _SystemHash.combine(hash, key.hashCode); + hash = _SystemHash.combine(hash, defaultValue.hashCode); + + return _SystemHash.finish(hash); + } +} + +mixin LocalConfigBoolRef on AutoDisposeProviderRef { + /// The parameter `key` of this provider. + String get key; + + /// The parameter `defaultValue` of this provider. + bool get defaultValue; +} + +class _LocalConfigBoolProviderElement extends AutoDisposeProviderElement + with LocalConfigBoolRef { + _LocalConfigBoolProviderElement(super.provider); + + @override + String get key => (origin as LocalConfigBoolProvider).key; + @override + bool get defaultValue => (origin as LocalConfigBoolProvider).defaultValue; +} + +String _$remoteMessagingHash() => r'3202165a9ba8b104810ce6db9ab4a689b08397f3'; + +/// Access to [RemoteMessaging]. +/// Whenever [RemoteMessaging] changes, this provider will be updated. +/// +/// Copied from [remoteMessaging]. +@ProviderFor(remoteMessaging) +final remoteMessagingProvider = + AutoDisposeProvider>.internal( + remoteMessaging, + name: r'remoteMessagingProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteMessagingHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RemoteMessagingRef = AutoDisposeProviderRef>; +String _$remoteMessagingMessagesHash() => + r'cceead0236a21e44607e4fdd1fb2e064ec52f6ae'; + +/// Access to [RemoteMessaging.messages]. +/// Whenever a new [RemoteMessage] is receieved via [RemoteMessaging.messages], this provider will be updated. +/// The first execution of this will return the initial message from [RemoteMessaging.getInitialMessage]. +/// +/// Copied from [remoteMessagingMessages]. +@ProviderFor(remoteMessagingMessages) +final remoteMessagingMessagesProvider = + AutoDisposeStreamProvider.internal( + remoteMessagingMessages, + name: r'remoteMessagingMessagesProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteMessagingMessagesHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RemoteMessagingMessagesRef + = AutoDisposeStreamProviderRef; +String _$remoteMessagingTokensHash() => + r'b336b909e5704473fc7b36dfa176063c7a9c66c2'; + +/// Access to [RemoteMessaging.tokens]. +/// Whenever a new token is receieved via [RemoteMessaging.tokens], this provider will be updated. +/// The first execution of this will return the current token from [RemoteMessaging.getToken]. +/// +/// Copied from [remoteMessagingTokens]. +@ProviderFor(remoteMessagingTokens) +final remoteMessagingTokensProvider = + AutoDisposeStreamProvider.internal( + remoteMessagingTokens, + name: r'remoteMessagingTokensProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$remoteMessagingTokensHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef RemoteMessagingTokensRef = AutoDisposeStreamProviderRef; +String _$analyticsHash() => r'1fd69a6ec7906d89d0ebaf111bed072b736dc3f3'; + +/// Access to [Analytics]. +/// +/// Copied from [analytics]. +@ProviderFor(analytics) +final analyticsProvider = AutoDisposeProvider.internal( + analytics, + name: r'analyticsProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$analyticsHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef AnalyticsRef = AutoDisposeProviderRef; +String _$globalAnalyticsContextHash() => + r'0f4421d75f4445217509cff50843e89797133fce'; + +/// Access to the global [AnalyticsContext] from [Analytics.globalContext]. +/// +/// Copied from [globalAnalyticsContext]. +@ProviderFor(globalAnalyticsContext) +final globalAnalyticsContextProvider = + AutoDisposeProvider.internal( + globalAnalyticsContext, + name: r'globalAnalyticsContextProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$globalAnalyticsContextHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef GlobalAnalyticsContextRef = AutoDisposeProviderRef; +String _$networkInformationHash() => + r'13d7cae849d6733c528c329d79f79e1a43d5f53c'; + +/// Access to a stream of [NetworkInformation]. +/// Whenever [NetworkInformation] changes, this provider will be updated. +/// +/// Copied from [networkInformation]. +@ProviderFor(networkInformation) +final networkInformationProvider = + AutoDisposeProvider.internal( + networkInformation, + name: r'networkInformationProvider', + debugGetCreateSourceHash: const bool.fromEnvironment('dart.vm.product') + ? null + : _$networkInformationHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef NetworkInformationRef = AutoDisposeProviderRef; +String _$packageInfoHash() => r'bb4b207e4e72b204cb2ce57645ec41ad09115b53'; + +/// Access to [PackageInfo]. +/// +/// Copied from [packageInfo]. +@ProviderFor(packageInfo) +final packageInfoProvider = AutoDisposeProvider.internal( + packageInfo, + name: r'packageInfoProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$packageInfoHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef PackageInfoRef = AutoDisposeProviderRef; +String _$deviceInfoHash() => r'737aa403f7f02cb999e488554c1110ae3b2f03d2'; + +/// Access to [DeviceInfo]. +/// +/// Copied from [deviceInfo]. +@ProviderFor(deviceInfo) +final deviceInfoProvider = AutoDisposeProvider.internal( + deviceInfo, + name: r'deviceInfoProvider', + debugGetCreateSourceHash: + const bool.fromEnvironment('dart.vm.product') ? null : _$deviceInfoHash, + dependencies: null, + allTransitiveDependencies: null, +); + +typedef DeviceInfoRef = AutoDisposeProviderRef; +// ignore_for_file: type=lint +// ignore_for_file: subtype_of_sealed_class, invalid_use_of_internal_member, invalid_use_of_visible_for_testing_member diff --git a/packages/patapata_riverpod/lib/src/riverpod_plugin.dart b/packages/patapata_riverpod/lib/src/riverpod_plugin.dart new file mode 100644 index 0000000..011e52f --- /dev/null +++ b/packages/patapata_riverpod/lib/src/riverpod_plugin.dart @@ -0,0 +1,15 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:patapata_core/patapata_core.dart'; + +class RiverpodPlugin extends Plugin { + @override + Widget createAppWidgetWrapper(Widget child) { + return ProviderScope(child: child); + } +} diff --git a/packages/patapata_riverpod/pubspec.yaml b/packages/patapata_riverpod/pubspec.yaml new file mode 100644 index 0000000..975481e --- /dev/null +++ b/packages/patapata_riverpod/pubspec.yaml @@ -0,0 +1,28 @@ +name: patapata_riverpod +description: This package is a plugin for Patapata that adds support for Riverpod to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_riverpod + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + flutter_riverpod: ^2.4.6 + patapata_core: ^1.0.0 + riverpod_annotation: ^2.3.1 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + riverpod_generator: ^2.3.6 + build_runner: ^2.4.6 + custom_lint: ^0.5.6 + riverpod_lint: ^2.3.4 + +flutter: diff --git a/packages/patapata_riverpod/test/patapata_riverpod_test.dart b/packages/patapata_riverpod/test/patapata_riverpod_test.dart new file mode 100644 index 0000000..b099faa --- /dev/null +++ b/packages/patapata_riverpod/test/patapata_riverpod_test.dart @@ -0,0 +1,659 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'dart:async'; + +import 'package:flutter/widgets.dart'; +import 'package:flutter_riverpod/flutter_riverpod.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_widgets.dart'; +import 'package:patapata_riverpod/patapata_riverpod.dart'; + +class Environment {} + +App createApp([void Function(WidgetRef ref)? callback, Plugin? plugin]) { + return App( + environment: Environment(), + createAppWidget: (context, app) => StandardMaterialApp( + onGenerateTitle: (context) => l(context, 'title'), + pages: [ + StandardPageFactory( + create: (data) => TesterPage(), + pageDataWhenNull: () => TesterPageData(callback), + ), + ], + ), + plugins: [ + RiverpodPlugin(), + if (plugin != null) plugin, + ], + ); +} + +Future doRefTest( + WidgetTester tester, { + void Function(WidgetRef ref)? buildCallback, + FutureOr Function(WidgetTester tester, App app)? testCallback, + Plugin? plugin, +}) async { + final tApp = createApp(buildCallback, plugin); + + await tApp.run(); + + await tApp.runProcess(() async { + // Always pumpAndSettle to let Patapata finish initializing. + await tester.pumpAndSettle(); + + if (testCallback != null) { + await testCallback(tester, tApp); + } + }); + + tApp.dispose(); +} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + testSetMockMethodCallHandler = TestDefaultBinaryMessengerBinding + .instance.defaultBinaryMessenger.setMockMethodCallHandler; + testSetMockStreamHandler = (channel, handler) { + TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger + .setMockStreamHandler( + channel, + _MockStreamHandler(handler), + ); + }; + + testWidgets('App can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(appProvider), getApp()); + }, + ); + }); + + testWidgets('User can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(userProvider), getApp().user); + }, + ); + }); + + testWidgets('User detects changes', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + String? tId; + + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.watch(userProvider).id, tId); + tShouldCall(); + }, + testCallback: (tester, app) async { + tId = 'tt2'; + await app.user.changeId('tt2'); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('RemoteConfig can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + String tValue = 'value1'; + final tConfig = MockRemoteConfig({ + 'string': tValue, + 'int': 1, + 'double': 1.0, + 'bool': true, + }); + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteConfigProvider); + expect(tRef, getApp().remoteConfig); + expect(tRef.getString('string'), tConfig.getString('string')); + expect(tRef.getString('string'), tValue); + tShouldCall(); + }, + testCallback: (tester, app) async { + tValue = 'value2'; + await tConfig.setString('string', tValue); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('remoteConfigString can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockRemoteConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteConfigStringProvider('string')); + expect(tRef, tMap['string']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setString('string', tMap['string'] as String); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('remoteConfigInt can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockRemoteConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteConfigIntProvider('int')); + expect(tRef, tMap['int']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setInt('int', tMap['int'] as int); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('remoteConfigDouble can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockRemoteConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteConfigDoubleProvider('double')); + expect(tRef, tMap['double']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setDouble('double', tMap['double'] as double); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('remoteConfigBool can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockRemoteConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteConfigBoolProvider('bool')); + expect(tRef, tMap['bool']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setBool('bool', tMap['bool'] as bool); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('LocalConfig can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockLocalConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createLocalConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(localConfigProvider); + expect(tRef, getApp().localConfig); + + expect(tRef.getString('string'), tConfig.getString('string')); + expect(tRef.getString('string'), tMap['string']); + + expect(tRef.getInt('int'), tConfig.getInt('int')); + expect(tRef.getInt('int'), tMap['int']); + + expect(tRef.getDouble('double'), tConfig.getDouble('double')); + expect(tRef.getDouble('double'), tMap['double']); + + expect(tRef.getBool('bool'), tConfig.getBool('bool')); + expect(tRef.getBool('bool'), tMap['bool']); + + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setMany(tMap); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('localConfigString can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockLocalConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createLocalConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(localConfigStringProvider('string')); + expect(tRef, tMap['string']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setString('string', tMap['string'] as String); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('localConfigInt can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockLocalConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createLocalConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(localConfigIntProvider('int')); + expect(tRef, tMap['int']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setInt('int', tMap['int'] as int); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('localConfigDouble can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockLocalConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createLocalConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(localConfigDoubleProvider('double')); + expect(tRef, tMap['double']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setDouble('double', tMap['double'] as double); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('localConfigBool can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + var tMap = { + 'string': 'value1', + 'int': 1, + 'double': 1.0, + 'bool': true, + }; + final tConfig = MockLocalConfig(tMap); + + await doRefTest( + tester, + plugin: Plugin.inline( + createLocalConfig: () => tConfig, + ), + buildCallback: (ref) { + final tRef = ref.watch(localConfigBoolProvider('bool')); + expect(tRef, tMap['bool']); + tShouldCall(); + }, + testCallback: (tester, app) async { + tMap = { + 'string': 'value2', + 'int': 2, + 'double': 2.0, + 'bool': false, + }; + await tConfig.setBool('bool', tMap['bool'] as bool); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('remoteMessaging can be accessed and watched', (tester) async { + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteMessaging: () => MockRemoteMessaging( + messages: () async* { + yield const RemoteMessage( + notification: RemoteMessageNotification( + title: 'title', + body: 'body', + ), + ); + }, + tokenStream: () => Stream.value('token2'), + getToken: () => Future.value('token1'), + ), + ), + buildCallback: (ref) { + final tRef = ref.watch(remoteMessagingProvider); + expect(tRef, getApp().remoteMessaging); + }, + ); + }); + + testWidgets('remoteMessagingMessages can be accessed and watched', + (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + final tStreamController = StreamController(); + RemoteMessage? tMessage; + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteMessaging: () => MockRemoteMessaging( + messages: () => tStreamController.stream, + ), + ), + buildCallback: (ref) { + tShouldCall(); + final tRef = ref.watch(remoteMessagingMessagesProvider); + + if (tMessage == null) { + expect(tRef.hasValue, isFalse); + expect(tRef.isLoading, isTrue); + } else { + expect(tRef.hasValue, isTrue); + expect(tRef.requireValue.notification!.title, equals('title')); + } + }, + testCallback: (tester, app) async { + tMessage = const RemoteMessage( + notification: RemoteMessageNotification( + title: 'title', + body: 'body', + ), + ); + tStreamController.add(tMessage!); + await tester.pumpAndSettle(); + }, + ); + + tStreamController.close(); + }); + + testWidgets('remoteMessagingTokens can be accessed and watched', + (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2, max: 3); + final tStreamController = StreamController(); + String? tToken = 'token1'; + + await doRefTest( + tester, + plugin: Plugin.inline( + createRemoteMessaging: () => MockRemoteMessaging( + tokenStream: () => tStreamController.stream, + getToken: () => Future.value('token1'), + ), + ), + buildCallback: (ref) { + tShouldCall(); + final tRef = ref.watch(remoteMessagingTokensProvider); + + if (tRef.isLoading) { + return; + } + + expect(tRef.hasValue, isTrue); + expect(tRef.requireValue, equals(tToken)); + }, + testCallback: (tester, app) async { + tToken = 'token2'; + tStreamController.add(tToken); + await tester.pumpAndSettle(); + }, + ); + + tStreamController.close(); + }); + + testWidgets('analytics can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(analyticsProvider), getApp().analytics); + }, + ); + }); + + testWidgets('globalAnalyticsContext can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(globalAnalyticsContextProvider), + getApp().analytics.globalContext); + }, + ); + }); + + testWidgets('networkInformation can be accessed and watched', (tester) async { + final tShouldCall = expectAsync0(() => null, count: 2); + NetworkConnectivity tConnectivity = NetworkConnectivity.none; + + await doRefTest( + tester, + buildCallback: (ref) { + tShouldCall(); + final tRef = ref.watch(networkInformationProvider); + + expect(tRef.connectivity, equals(tConnectivity)); + }, + testCallback: (tester, app) async { + tConnectivity = NetworkConnectivity.wifi; + await app.network.testChangeConnectivity(tConnectivity); + await tester.pumpAndSettle(); + }, + ); + }); + + testWidgets('packageInfo can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(packageInfoProvider), getApp().package); + }, + ); + }); + + testWidgets('deviceInfo can be accessed', (tester) async { + await doRefTest( + tester, + buildCallback: (ref) { + expect(ref.read(deviceInfoProvider), getApp().device); + }, + ); + }); +} + +class TesterPageData { + final void Function(WidgetRef ref)? callback; + + TesterPageData(this.callback); +} + +class TesterPage extends StandardPage { + @override + Widget buildPage(BuildContext context) { + return Consumer(builder: (context, ref, child) { + if (pageData.callback != null) { + pageData.callback!(ref); + } + + return const SizedBox.expand(); + }); + } +} + +class _MockStreamHandler extends MockStreamHandler { + _MockStreamHandler(this.handler); + + final TestMockStreamHandler? handler; + + @override + void onCancel(Object? arguments) { + handler?.onCancel(arguments); + } + + @override + void onListen(Object? arguments, MockStreamHandlerEventSink events) { + handler?.onListen(arguments, _MockStreamHandlerEventSink(other: events)); + } +} + +class _MockStreamHandlerEventSink extends TestMockStreamHandlerEventSink { + final MockStreamHandlerEventSink other; + + _MockStreamHandlerEventSink({ + required this.other, + }); + + @override + void endOfStream() { + other.endOfStream(); + } + + @override + void error({required String code, String? message, Object? details}) { + other.error(code: code, message: message, details: details); + } + + @override + void success(Object? event) { + other.success(event); + } +} diff --git a/packages/patapata_sentry/.gitignore b/packages/patapata_sentry/.gitignore new file mode 100644 index 0000000..a247422 --- /dev/null +++ b/packages/patapata_sentry/.gitignore @@ -0,0 +1,75 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# 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/ +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +build/ + +# Android related +**/android/**/gradle-wrapper.jar +**/android/.gradle +**/android/captures/ +**/android/gradlew +**/android/gradlew.bat +**/android/local.properties +**/android/**/GeneratedPluginRegistrant.java + +# iOS/XCode related +**/ios/**/*.mode1v3 +**/ios/**/*.mode2v3 +**/ios/**/*.moved-aside +**/ios/**/*.pbxuser +**/ios/**/*.perspectivev3 +**/ios/**/*sync/ +**/ios/**/.sconsign.dblite +**/ios/**/.tags* +**/ios/**/.vagrant/ +**/ios/**/DerivedData/ +**/ios/**/Icon? +**/ios/**/Pods/ +**/ios/**/.symlinks/ +**/ios/**/profile +**/ios/**/xcuserdata +**/ios/.generated/ +**/ios/Flutter/App.framework +**/ios/Flutter/Flutter.framework +**/ios/Flutter/Flutter.podspec +**/ios/Flutter/Generated.xcconfig +**/ios/Flutter/ephemeral +**/ios/Flutter/app.flx +**/ios/Flutter/app.zip +**/ios/Flutter/flutter_assets/ +**/ios/Flutter/flutter_export_environment.sh +**/ios/ServiceDefinitions.json +**/ios/Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!**/ios/**/default.mode1v3 +!**/ios/**/default.mode2v3 +!**/ios/**/default.pbxuser +!**/ios/**/default.perspectivev3 diff --git a/packages/patapata_sentry/.metadata b/packages/patapata_sentry/.metadata new file mode 100644 index 0000000..4311ca2 --- /dev/null +++ b/packages/patapata_sentry/.metadata @@ -0,0 +1,10 @@ +# 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: 3595343e20a61ff16d14e8ecc25f364276bb1b8b + channel: stable + +project_type: package diff --git a/packages/patapata_sentry/CHANGELOG.md b/packages/patapata_sentry/CHANGELOG.md new file mode 100644 index 0000000..3a10bc5 --- /dev/null +++ b/packages/patapata_sentry/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- initial release \ No newline at end of file diff --git a/packages/patapata_sentry/LICENSE b/packages/patapata_sentry/LICENSE new file mode 100644 index 0000000..ed4e6a9 --- /dev/null +++ b/packages/patapata_sentry/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 GREE, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/patapata_sentry/README.md b/packages/patapata_sentry/README.md new file mode 100644 index 0000000..23b9965 --- /dev/null +++ b/packages/patapata_sentry/README.md @@ -0,0 +1,74 @@ +
+

Patapata - Sentry

+

+ Add support for Sentry to your Patapata app. +

+
+ +--- + +## About +This package is a plugin for [Patapata](https://pub.dev/packages/patapata_core) that adds support for [Sentry](https://sentry.io) to your Patapata app. + +It will integrate with the Patapata error handling and log systems and automatically report errors to Sentry. +It will also integrate with Patapata's User system and automatically send user information to Sentry. + +## Getting started + +1. Add the dependency to your `pubspec.yaml` file + +```sh +flutter pub add patapata_sentry +``` + +2. Import the package + +```dart +import 'package:patapata_sentry/patapata_sentry.dart'; +``` + +3. Activate the plugin + +```dart +/// This Environment takes sentry configuration from environment variables. +/// Pass environment variables to your app using the `--dart-define` flag. +class Environment with SentryPluginEnvironment { + const Environment(); + + /// This is the DSN for the Sentry project you want to send errors to. + @override + String get sentryDSN => const String.fromEnvironment('SENTRY_DSN'); + + /// Just as an example, we're using environment variables to configure + /// Sentry's environment and dist. You can modify any of the options. + @override + FutureOr Function(SentryFlutterOptions)? get sentryOptions => + (options) => options + ..environment = const String.fromEnvironment('SENTRY_ENVIRONMENT') + ..dist = const String.fromEnvironment('SENTRY_DIST'); +} + +void main() { + App( + environment: const Environment(), + plugins: [ + SentryPlugin(), + ], + ) + .run(); +} +``` + +## Extra configuration + +You can change the traces sample rate and and sample rate via RemoteConfig by setting the following keys: +- `patapata_sentry_plugin_tracessamplerate`: (`SentryOptions.tracesSampleRate`)[https://pub.dev/documentation/sentry_flutter/latest/sentry_flutter/SentryOptions/tracesSampleRate.html] +- `patapata_sentry_plugin_samplerate`: (`SentryOptions.sampleRate`)[https://pub.dev/documentation/sentry_flutter/latest/sentry_flutter/SentryOptions/sampleRate.html] + +## Contributing + +Check out the [CONTRIBUTING](https://github.com/gree/patapata/blob/main/CONTRIBUTING.md) guide to get started. + +## License + +[See the LICENSE file](https://github.com/gree/patapata/blob/main/packages/patapata_sentry/LICENSE) \ No newline at end of file diff --git a/packages/patapata_sentry/analysis_options.yaml b/packages/patapata_sentry/analysis_options.yaml new file mode 100644 index 0000000..193e69d --- /dev/null +++ b/packages/patapata_sentry/analysis_options.yaml @@ -0,0 +1,9 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: + avoid_dynamic_calls: true + +analyzer: + exclude: + - example/** \ No newline at end of file diff --git a/packages/patapata_sentry/dartdoc_options.yaml b/packages/patapata_sentry/dartdoc_options.yaml new file mode 100644 index 0000000..309c133 --- /dev/null +++ b/packages/patapata_sentry/dartdoc_options.yaml @@ -0,0 +1,8 @@ +# Copyright (c) GREE, Inc. +# +# This source code is licensed under the MIT license found in the +# LICENSE file in the root directory of this source tree. + +dartdoc: + include: + - patapata_sentry \ No newline at end of file diff --git a/packages/patapata_sentry/lib/patapata_sentry.dart b/packages/patapata_sentry/lib/patapata_sentry.dart new file mode 100644 index 0000000..ef3efd6 --- /dev/null +++ b/packages/patapata_sentry/lib/patapata_sentry.dart @@ -0,0 +1,266 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +library patapata_sentry; + +import 'package:flutter/widgets.dart'; +import 'package:patapata_core/patapata_core.dart'; +import 'package:patapata_core/patapata_core_libs.dart'; +import 'package:sentry_flutter/sentry_flutter.dart'; + +/// Configuration for [SentryPlugin]. +mixin SentryPluginEnvironment { + /// Destination for sending events to Sentry. + String get sentryDSN; + + /// Options to set for Sentry SDK. + FutureOr Function(SentryFlutterOptions)? get sentryOptions; +} + +/// This plugin provides functionality for Sentry, which monitors application errors. +class SentryPlugin extends Plugin { + StreamSubscription? _onReportSubscription; + + @override + bool get requireRemoteConfig => true; + + SentryPluginEnvironment get _environment => + app.environment as SentryPluginEnvironment; + + /// Initializes the [SentryPlugin]. + @override + FutureOr init(App app) async { + if (app.environment is! SentryPluginEnvironment) { + return false; + } + + await super.init(app); + + if (_environment.sentryDSN.isEmpty) { + return false; + } + + await SentryFlutter.init( + (options) { + options + ..dsn = _environment.sentryDSN + ..debug = false + ..enableBreadcrumbTrackingForCurrentPlatform() + ..tracesSampleRate = app.remoteConfig.getDouble( + 'patapata_sentry_plugin_tracessamplerate', + defaultValue: 1.0, + ) + ..sampleRate = app.remoteConfig.getDouble( + 'patapata_sentry_plugin_samplerate', + defaultValue: 1.0, + ) + ..beforeSend = _beforeSend + ..beforeBreadcrumb = _beforeBreadcrumb + ..enablePrintBreadcrumbs = false; + + options.sdk.addIntegration('patapata'); + + if (_environment.sentryOptions != null) { + _environment.sentryOptions!(options); + } + }, + ); + + _onReportSubscription = app.log.reports.listen(_onReport); + + app.user.addSynchronousChangeListener(_onUserChanged); + + return true; + } + + @override + FutureOr dispose() async { + app.user.removeSynchronousChangeListener(_onUserChanged); + + await super.dispose(); + await _onReportSubscription!.cancel(); + + _onReportSubscription = null; + } + + SentryEvent? _beforeSend(SentryEvent event, {dynamic hint}) { + if (disposed) { + // Don't send if we are disabled. + return null; + } + + // Align the Sentry logging level to the app logging level. + if (_sentryLevelToLoggingLevel(event.level!) < app.log.level) { + return null; + } + + return event; + } + + Breadcrumb? _beforeBreadcrumb(Breadcrumb? breadcrumb, {dynamic hint}) { + if (breadcrumb == null || disposed) { + // Don't send if we are disabled. + return null; + } + + // Align the Sentry logging level to the app logging level. + if (_sentryLevelToLoggingLevel(breadcrumb.level!) < app.log.level) { + return null; + } + + return breadcrumb; + } + + @override + List get navigatorObservers => [SentryNavigatorObserver()]; + + FutureOr _onUserChanged(User user, UserChangeData changes) { + final tId = changes.getIdFor(); + final tProperties = changes.getPropertiesFor(); + + Sentry.configureScope((scope) { + scope.setUser(SentryUser( + id: tId ?? '', + username: scope.user?.username, + email: scope.user?.email, + ipAddress: scope.user?.ipAddress, + data: tProperties, + )); + }); + } + + Level _sentryLevelToLoggingLevel(SentryLevel sentryLevel) { + switch (sentryLevel) { + case SentryLevel.fatal: + return Level.SHOUT; + case SentryLevel.error: + return Level.SEVERE; + case SentryLevel.warning: + return Level.WARNING; + case SentryLevel.info: + return Level.INFO; + case SentryLevel.debug: + default: + return Level.FINE; + } + } + + SentryLevel _loggingLevelToSentryLevel(Level level) { + if (level >= Level.SHOUT) { + return SentryLevel.fatal; + } else if (level >= Level.SEVERE) { + return SentryLevel.error; + } else if (level >= Level.WARNING) { + return SentryLevel.warning; + } else if (level >= Level.INFO) { + return SentryLevel.info; + } else { + return SentryLevel.debug; + } + } + + void _onReport(ReportRecord record) async { + if (record.mechanism == Log.kFlutterErrorMechanism) { + // Sentry does it by itself, automatically. + return; + } + + final tSentryLevel = _loggingLevelToSentryLevel(record.level); + final Map tExtra = record.extra != null + ? Map.from( + record.extra!.map((key, value) => MapEntry(key, value ?? ''))) + : {}; + SentryException? tException; + final tMechanism = Mechanism(type: record.mechanism, handled: true); + final tError = record.error; + + tExtra['patapataReportRecord'] = record; + + if (record.mechanism == Log.kNativeMechanism && tError is NativeThrowable) { + tException = SentryException( + type: tError.type ?? 'patapata.NativeThrowable', + value: tError.message ?? tError.toString(), + mechanism: tMechanism, + stackTrace: SentryStackTrace( + frames: List.of( + ((NativeThrowable? nativeThrowable) sync* { + while (nativeThrowable != null) { + bool tProcessedFirst = false; + + if (nativeThrowable.chain != null) { + for (var tTrace in nativeThrowable.chain!.traces) { + for (var tFrame in tTrace.frames) { + yield SentryStackFrame( + package: tFrame.library, + lineNo: tFrame.line, + colNo: tFrame.column, + native: true, + function: tFrame.member, + absPath: tFrame.uri.toString(), + ); + } + + if (!tProcessedFirst) { + tProcessedFirst = true; + yield SentryStackFrame(absPath: ''); + } + } + } + + nativeThrowable = nativeThrowable.cause; + + if (nativeThrowable != null) { + yield SentryStackFrame(absPath: ''); + } + } + })(tError))), + ); + } + + tExtra.addAll({ + if (record.object != null) 'LogRecord.object': record.object!.toString(), + 'LogRecord.sequenceNumber': record.sequenceNumber, + }); + + if (record.level >= Level.WARNING) { + final tEvent = SentryEvent( + level: tSentryLevel, + timestamp: record.time.toUtc(), + fingerprint: record.fingerprint != null + ? [SentryEvent.defaultFingerprint, ...record.fingerprint!] + : null, + logger: record.loggerName, + message: SentryMessage(record.message), + throwable: tError, + exceptions: tException != null ? [tException] : null, + ); + + await Sentry.captureEvent( + tEvent, + stackTrace: record.stackTrace, + hint: Hint.withMap(tExtra), + ); + } else { + tExtra.addAll({ + if (tError != null) 'LogRecord.error': tError.toString(), + if (record.stackTrace != null) + 'LogRecord.stackTrace': record.stackTrace!, + 'LogRecord.loggerName': record.loggerName, + }); + + Sentry.addBreadcrumb( + Breadcrumb( + level: tSentryLevel, + timestamp: record.time.toUtc(), + message: record.message, + data: tExtra, + category: record.loggerName, + type: tError != null ? 'error' : null, + ), + hint: Hint.withMap(tExtra), + ); + } + } +} diff --git a/packages/patapata_sentry/pubspec.yaml b/packages/patapata_sentry/pubspec.yaml new file mode 100644 index 0000000..a30abcc --- /dev/null +++ b/packages/patapata_sentry/pubspec.yaml @@ -0,0 +1,25 @@ +name: patapata_sentry +description: This package is a plugin for Patapata that adds support for Sentry to your Patapata app. +version: 1.0.0 +homepage: https://github.com/gree/patapata +repository: https://github.com/gree/patapata/packages/patapata_sentry + +environment: + sdk: ">=3.0.0 <4.0.0" + flutter: ">=3.13.0" + +dependencies: + flutter: + sdk: flutter + + patapata_core: ^1.0.0 + + sentry_flutter: ^7.9.0 + sentry: ^7.9.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.2 + +flutter: diff --git a/packages/patapata_sentry/test/patapata_sentry_test.dart b/packages/patapata_sentry/test/patapata_sentry_test.dart new file mode 100644 index 0000000..0efedcd --- /dev/null +++ b/packages/patapata_sentry/test/patapata_sentry_test.dart @@ -0,0 +1,12 @@ +// Copyright (c) GREE, Inc. +// +// This source code is licensed under the MIT license found in the +// LICENSE file in the root directory of this source tree. + +import 'package:flutter_test/flutter_test.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + test('Empty test pass', () {}); +} diff --git a/pubspec.lock b/pubspec.lock new file mode 100644 index 0000000..ea3a502 --- /dev/null +++ b/pubspec.lock @@ -0,0 +1,317 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + ansi_styles: + dependency: transitive + description: + name: ansi_styles + sha256: "9c656cc12b3c27b17dd982b2cc5c0cfdfbdabd7bc8f3ae5e8542d9867b47ce8a" + url: "https://pub.dev" + source: hosted + version: "0.3.2+1" + args: + dependency: transitive + description: + name: args + sha256: eef6c46b622e0494a36c5a12d10d77fb4e855501a91c1b9ef9339326e58f0596 + url: "https://pub.dev" + source: hosted + version: "2.4.2" + async: + dependency: transitive + description: + name: async + sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c" + url: "https://pub.dev" + source: hosted + version: "2.11.0" + boolean_selector: + dependency: transitive + description: + name: boolean_selector + sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66" + url: "https://pub.dev" + source: hosted + version: "2.1.1" + charcode: + dependency: transitive + description: + name: charcode + sha256: fb98c0f6d12c920a02ee2d998da788bca066ca5f148492b7085ee23372b12306 + url: "https://pub.dev" + source: hosted + version: "1.3.1" + cli_launcher: + dependency: transitive + description: + name: cli_launcher + sha256: "5e7e0282b79e8642edd6510ee468ae2976d847a0a29b3916e85f5fa1bfe24005" + url: "https://pub.dev" + source: hosted + version: "0.3.1" + cli_util: + dependency: transitive + description: + name: cli_util + sha256: c05b7406fdabc7a49a3929d4af76bcaccbbffcbcdcf185b082e1ae07da323d19 + url: "https://pub.dev" + source: hosted + version: "0.4.1" + collection: + dependency: transitive + description: + name: collection + sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a + url: "https://pub.dev" + source: hosted + version: "1.18.0" + conventional_commit: + dependency: transitive + description: + name: conventional_commit + sha256: dec15ad1118f029c618651a4359eb9135d8b88f761aa24e4016d061cd45948f2 + url: "https://pub.dev" + source: hosted + version: "0.6.0+1" + file: + dependency: transitive + description: + name: file + sha256: "5fc22d7c25582e38ad9a8515372cd9a93834027aacf1801cf01164dac0ffa08c" + url: "https://pub.dev" + source: hosted + version: "7.0.0" + glob: + dependency: transitive + description: + name: glob + sha256: "0e7014b3b7d4dac1ca4d6114f82bf1782ee86745b9b42a92c9289c23d8a0ab63" + url: "https://pub.dev" + source: hosted + version: "2.1.2" + graphs: + dependency: transitive + description: + name: graphs + sha256: aedc5a15e78fc65a6e23bcd927f24c64dd995062bcd1ca6eda65a3cff92a4d19 + url: "https://pub.dev" + source: hosted + version: "2.3.1" + http: + dependency: transitive + description: + name: http + sha256: "759d1a329847dd0f39226c688d3e06a6b8679668e350e2891a6474f8b4bb8525" + url: "https://pub.dev" + source: hosted + version: "1.1.0" + http_parser: + dependency: transitive + description: + name: http_parser + sha256: "2aa08ce0341cc9b354a498388e30986515406668dbcc4f7c950c3e715496693b" + url: "https://pub.dev" + source: hosted + version: "4.0.2" + io: + dependency: transitive + description: + name: io + sha256: "2ec25704aba361659e10e3e5f5d672068d332fc8ac516421d483a11e5cbd061e" + url: "https://pub.dev" + source: hosted + version: "1.0.4" + json_annotation: + dependency: transitive + description: + name: json_annotation + sha256: b10a7b2ff83d83c777edba3c6a0f97045ddadd56c944e1a23a3fdf43a1bf4467 + url: "https://pub.dev" + source: hosted + version: "4.8.1" + matcher: + dependency: transitive + description: + name: matcher + sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e" + url: "https://pub.dev" + source: hosted + version: "0.12.16" + melos: + dependency: "direct dev" + description: + name: melos + sha256: "7266e9fc9fee5f4a0c075e5cec375c00736dfc944358f533b740b93b3d8d681e" + url: "https://pub.dev" + source: hosted + version: "4.1.0" + meta: + dependency: transitive + description: + name: meta + sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e + url: "https://pub.dev" + source: hosted + version: "1.10.0" + mustache_template: + dependency: transitive + description: + name: mustache_template + sha256: a46e26f91445bfb0b60519be280555b06792460b27b19e2b19ad5b9740df5d1c + url: "https://pub.dev" + source: hosted + version: "2.0.0" + path: + dependency: transitive + description: + name: path + sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917" + url: "https://pub.dev" + source: hosted + version: "1.8.3" + platform: + dependency: transitive + description: + name: platform + sha256: "12220bb4b65720483f8fa9450b4332347737cf8213dd2840d8b2c823e47243ec" + url: "https://pub.dev" + source: hosted + version: "3.1.4" + pool: + dependency: transitive + description: + name: pool + sha256: "20fe868b6314b322ea036ba325e6fc0711a22948856475e2c2b6306e8ab39c2a" + url: "https://pub.dev" + source: hosted + version: "1.5.1" + process: + dependency: transitive + description: + name: process + sha256: "21e54fd2faf1b5bdd5102afd25012184a6793927648ea81eea80552ac9405b32" + url: "https://pub.dev" + source: hosted + version: "5.0.2" + prompts: + dependency: transitive + description: + name: prompts + sha256: "3773b845e85a849f01e793c4fc18a45d52d7783b4cb6c0569fad19f9d0a774a1" + url: "https://pub.dev" + source: hosted + version: "2.0.0" + pub_semver: + dependency: transitive + description: + name: pub_semver + sha256: "40d3ab1bbd474c4c2328c91e3a7df8c6dd629b79ece4c4bd04bee496a224fb0c" + url: "https://pub.dev" + source: hosted + version: "2.1.4" + pub_updater: + dependency: transitive + description: + name: pub_updater + sha256: "54e8dc865349059ebe7f163d6acce7c89eb958b8047e6d6e80ce93b13d7c9e60" + url: "https://pub.dev" + source: hosted + version: "0.4.0" + pubspec: + dependency: transitive + description: + name: pubspec + sha256: f534a50a2b4d48dc3bc0ec147c8bd7c304280fff23b153f3f11803c4d49d927e + url: "https://pub.dev" + source: hosted + version: "2.3.0" + quiver: + dependency: transitive + description: + name: quiver + sha256: b1c1ac5ce6688d77f65f3375a9abb9319b3cb32486bdc7a1e0fdf004d7ba4e47 + url: "https://pub.dev" + source: hosted + version: "3.2.1" + source_span: + dependency: transitive + description: + name: source_span + sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" + url: "https://pub.dev" + source: hosted + version: "1.10.0" + stack_trace: + dependency: transitive + description: + name: stack_trace + sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b" + url: "https://pub.dev" + source: hosted + version: "1.11.1" + stream_channel: + dependency: transitive + description: + name: stream_channel + sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7 + url: "https://pub.dev" + source: hosted + version: "2.1.2" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde" + url: "https://pub.dev" + source: hosted + version: "1.2.0" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 + url: "https://pub.dev" + source: hosted + version: "1.2.1" + test_api: + dependency: transitive + description: + name: test_api + sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b" + url: "https://pub.dev" + source: hosted + version: "0.6.1" + typed_data: + dependency: transitive + description: + name: typed_data + sha256: facc8d6582f16042dd49f2463ff1bd6e2c9ef9f3d5da3d9b087e244a7b564b3c + url: "https://pub.dev" + source: hosted + version: "1.3.2" + uri: + dependency: transitive + description: + name: uri + sha256: "889eea21e953187c6099802b7b4cf5219ba8f3518f604a1033064d45b1b8268a" + url: "https://pub.dev" + source: hosted + version: "1.0.0" + yaml: + dependency: transitive + description: + name: yaml + sha256: "75769501ea3489fca56601ff33454fe45507ea3bfb014161abc3b43ae25989d5" + url: "https://pub.dev" + source: hosted + version: "3.1.2" + yaml_edit: + dependency: transitive + description: + name: yaml_edit + sha256: "1579d4a0340a83cf9e4d580ea51a16329c916973bffd5bd4b45e911b25d46bfd" + url: "https://pub.dev" + source: hosted + version: "2.1.1" +sdks: + dart: ">=3.0.0 <4.0.0" diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 0000000..1d1ef84 --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,6 @@ +name: patapata_workspace + +environment: + sdk: ">=2.18.0 <4.0.0" +dev_dependencies: + melos: ^4.1.0 diff --git a/tools/dartdoc_all.sh b/tools/dartdoc_all.sh new file mode 100755 index 0000000..7a1956b --- /dev/null +++ b/tools/dartdoc_all.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +for i in $(ls packages) ; do + pushd packages/"$i" + + dart doc . + + popd +done + +pushd packages/patapata_core/android + +gradle clean + +./gradlew dokkaHtml + +popd + +pushd packages/patapata_core/ios + +swift doc generate . --base-url http://localhost:8080/ --module-name patapata_core --output doc --format html + +popd \ No newline at end of file diff --git a/tools/pub_get_all.sh b/tools/pub_get_all.sh new file mode 100755 index 0000000..78d99c6 --- /dev/null +++ b/tools/pub_get_all.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +for i in $(ls packages) ; do + pushd packages/"$i" + + flutter pub get + + popd +done diff --git a/tools/pub_upgrade_all.sh b/tools/pub_upgrade_all.sh new file mode 100755 index 0000000..5290667 --- /dev/null +++ b/tools/pub_upgrade_all.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +for i in $(ls packages) ; do + pushd packages/"$i" + + flutter pub upgrade + + popd +done diff --git a/tools/test_all.sh b/tools/test_all.sh new file mode 100755 index 0000000..4861f3d --- /dev/null +++ b/tools/test_all.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +for i in $(ls packages) ; do + pushd packages/"$i" + + flutter test + + popd +done