Skip to content

feat(remote_config): Migrate firebase_remote_config iOS and Android to Pigeon #17304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: cj/jules_test
Choose a base branch
from

Conversation

cynthiajoan
Copy link
Collaborator

This commit migrates the native communication layer for the firebase_remote_config plugin on iOS and Android from MethodChannel to Pigeon.

Work Done:

  1. Defined Pigeon API: Created messages.pigeon in the platform interface package, defining the Host API (FirebaseRemoteConfigHostApi) and data structures based on the existing MethodChannel methods.
  2. Configured Pigeon Generation: Updated messages.pigeon with @ConfigurePigeon to specify output paths for Dart, Swift, and Kotlin in the main firebase_remote_config package. (Note: Actual generation was not performed due to tool limitations).
  3. Implemented iOS Pigeon Host API: Refactored FLTFirebaseRemoteConfigPlugin.m (Objective-C) to implement the FirebaseRemoteConfigHostApi protocol generated by Pigeon. Replaced MethodChannel handling with Pigeon API calls, adapting helper methods and updating plugin registration. EventChannel logic for onConfigUpdated remains.
  4. Implemented Android Pigeon Host API: Refactored FirebaseRemoteConfigPlugin.java to implement the FirebaseRemoteConfigHostApi interface generated by Pigeon. Replaced MethodChannel handling, adapted helper methods, converted data types, and updated plugin registration to use Pigeon. EventChannel logic remains.

Next Steps (Incomplete):

The Dart side implementation is pending:

  • Update Dart Platform Interface: Create a new Dart class (PigeonFirebaseRemoteConfig) extending FirebaseRemoteConfigPlatform in the firebase_remote_config_platform_interface package. This class should use the generated Dart Pigeon client (messages.g.dart) to call the native Host APIs.
  • Update Main Plugin Dart Code: Update firebase_remote_config's main Dart code to use the new PigeonFirebaseRemoteConfig implementation.
  • Remove MethodChannel Code: Delete the old MethodChannel implementation files in the platform interface package.
  • Testing: Run existing tests and potentially add new ones for Pigeon integration.

This includes the completed native iOS and Android migrations. Further work is needed on the Dart side to fully utilize the Pigeon implementation.

Description

Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.

Related Issues

Replace this paragraph with a list of issues related to this PR from the issue database. Indicate, which of these issues are resolved or fixed by this PR. Note that you'll have to prefix the issue numbers with flutter/flutter#.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

This commit migrates the native communication layer for the firebase_remote_config plugin on iOS and Android from MethodChannel to Pigeon.

**Work Done:**

1.  **Defined Pigeon API:** Created `messages.pigeon` in the platform interface package, defining the Host API (`FirebaseRemoteConfigHostApi`) and data structures based on the existing MethodChannel methods.
2.  **Configured Pigeon Generation:** Updated `messages.pigeon` with `@ConfigurePigeon` to specify output paths for Dart, Swift, and Kotlin in the main `firebase_remote_config` package. (Note: Actual generation was not performed due to tool limitations).
3.  **Implemented iOS Pigeon Host API:** Refactored `FLTFirebaseRemoteConfigPlugin.m` (Objective-C) to implement the `FirebaseRemoteConfigHostApi` protocol generated by Pigeon. Replaced MethodChannel handling with Pigeon API calls, adapting helper methods and updating plugin registration. EventChannel logic for `onConfigUpdated` remains.
4.  **Implemented Android Pigeon Host API:** Refactored `FirebaseRemoteConfigPlugin.java` to implement the `FirebaseRemoteConfigHostApi` interface generated by Pigeon. Replaced MethodChannel handling, adapted helper methods, converted data types, and updated plugin registration to use Pigeon. EventChannel logic remains.

**Next Steps (Incomplete):**

The Dart side implementation is pending:

*   **Update Dart Platform Interface:** Create a new Dart class (`PigeonFirebaseRemoteConfig`) extending `FirebaseRemoteConfigPlatform` in the `firebase_remote_config_platform_interface` package. This class should use the generated Dart Pigeon client (`messages.g.dart`) to call the native Host APIs.
*   **Update Main Plugin Dart Code:** Update `firebase_remote_config`'s main Dart code to use the new `PigeonFirebaseRemoteConfig` implementation.
*   **Remove MethodChannel Code:** Delete the old MethodChannel implementation files in the platform interface package.
*   **Testing:** Run existing tests and potentially add new ones for Pigeon integration.

This includes the completed native iOS and Android migrations. Further work is needed on the Dart side to fully utilize the Pigeon implementation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant