chore: Method Channel to Pigeon

Author: MichaelVerdon

packages/firebase_database/firebase_database/android/src/main/kotlin/io/flutter/plugins/firebase/database/GeneratedAndroidFirebaseDatabase.g.kt

@@ -5,6 +5,7 @@
 import 'package:firebase_core/firebase_core.dart';
 import 'package:firebase_database_platform_interface/firebase_database_platform_interface.dart';
 import 'package:firebase_database_platform_interface/src/method_channel/utils/utils.dart';
+import 'package:firebase_database_platform_interface/src/pigeon/messages.pigeon.dart' as pigeon;
 import 'package:flutter/services.dart';
 
 import 'method_channel_database_reference.dart';
@@ -106,6 +107,22 @@ class MethodChannelDatabase extends DatabasePlatform {
   static const MethodChannel channel =
       MethodChannel('plugins.flutter.io/firebase_database');
 
+  /// The pigeon channel instance to communicate through.
+  static final pigeon.FirebaseDatabaseHostApi pigeonChannel = pigeon.FirebaseDatabaseHostApi();
+
+  /// FirebaseApp pigeon instance
+  pigeon.FirebaseApp get pigeonFirebaseApp {
+    return pigeon.FirebaseApp(
+      appName: app!.name,
+      databaseURL: databaseURL,
+      persistenceEnabled: _persistenceEnabled,
+      cacheSizeBytes: _cacheSizeBytes,
+      loggingEnabled: _loggingEnabled,
+      emulatorHost: _emulatorHost,
+      emulatorPort: _emulatorPort,
+    );
+  }
+
   @override
   void useDatabaseEmulator(String host, int port) {
     _emulatorHost = host;
@@ -138,10 +155,7 @@ class MethodChannelDatabase extends DatabasePlatform {
   @override
   Future<void> goOnline() {
     try {
-      return channel.invokeMethod<void>(
-        'FirebaseDatabase#goOnline',
-        getChannelArguments(),
-      );
+      return pigeonChannel.goOnline(pigeonFirebaseApp);
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -152,10 +166,7 @@ class MethodChannelDatabase extends DatabasePlatform {
   @override
   Future<void> goOffline() {
     try {
-      return channel.invokeMethod<void>(
-        'FirebaseDatabase#goOffline',
-        getChannelArguments(),
-      );
+      return pigeonChannel.goOffline(pigeonFirebaseApp);
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -174,10 +185,7 @@ class MethodChannelDatabase extends DatabasePlatform {
   @override
   Future<void> purgeOutstandingWrites() {
     try {
-      return channel.invokeMethod<void>(
-        'FirebaseDatabase#purgeOutstandingWrites',
-        getChannelArguments(),
-      );
+      return pigeonChannel.purgeOutstandingWrites(pigeonFirebaseApp);
     } catch (e, s) {
       convertPlatformException(e, s);
     }

packages/firebase_database/firebase_database/ios/firebase_database/Sources/firebase_database/FirebaseDatabaseMessages.g.swift

@@ -4,6 +4,7 @@
 
 import 'package:firebase_database_platform_interface/firebase_database_platform_interface.dart';
 import 'package:firebase_database_platform_interface/src/method_channel/utils/utils.dart';
+import 'package:firebase_database_platform_interface/src/pigeon/messages.pigeon.dart' as pigeon;
 
 import 'method_channel_database.dart';
 import 'method_channel_on_disconnect.dart';
@@ -12,14 +13,6 @@ import 'method_channel_transaction_result.dart';
 import 'utils/exception.dart';
 import 'utils/push_id_generator.dart';
 
-import 'package:firebase_database_platform_interface/src/pigeon/messages.dart';
-import 'package:firebase_database_platform_interface/src/pigeon/messages.pigeon.dart';
-
-extension DatabaseReferencePlatformExtension on DatabaseReferencePlatform {
-  Future<void> set(Object? value) async {
-    await FirebaseDatabaseHostApi.set(value);
-  }
-}
 
 /// DatabaseReference represents a particular location in your Firebase
 /// Database and can be used for reading or writing data to that location.
@@ -84,13 +77,10 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
   @override
   Future<void> set(Object? value) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'DatabaseReference#set',
-        database.getChannelArguments({
-          'path': path,
-          if (value != null) 'value': transformValue(value),
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.set(pigeon.SetOptions(
+        path: path,
+        value: value != null ? transformValue(value) : null,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -99,14 +89,11 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
   @override
   Future<void> setWithPriority(Object? value, Object? priority) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'DatabaseReference#setWithPriority',
-        database.getChannelArguments({
-          'path': path,
-          if (value != null) 'value': transformValue(value),
-          if (priority != null) 'priority': priority,
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.setWithPriority(pigeon.SetOptions(
+        path: path,
+        value: value != null ? transformValue(value) : null,
+        priority: priority,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -115,13 +102,10 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
   @override
   Future<void> update(Map<String, Object?> value) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'DatabaseReference#update',
-        database.getChannelArguments({
-          'path': path,
-          'value': transformValue(value),
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.update(pigeon.UpdateOptions(
+        path: path,
+        value: transformValue(value) as Map<String, Object?>,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -130,13 +114,10 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
   @override
   Future<void> setPriority(Object? priority) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'DatabaseReference#setPriority',
-        database.getChannelArguments({
-          'path': path,
-          if (priority != null) 'priority': priority,
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.setPriority(pigeon.SetPriorityOptions(
+        path: path,
+        priority: priority!,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -159,14 +140,11 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
     MethodChannelDatabase.transactions[key] = transactionHandler;
 
     try {
-      final result = await channel.invokeMethod(
-        'DatabaseReference#runTransaction',
-        database.getChannelArguments({
-          'path': path,
-          'transactionApplyLocally': applyLocally,
-          'transactionKey': key,
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.runTransaction(pigeon.TransactionOptions(
+        path: path,
+        transactionHandler: pigeon.TransactionHandler(transactionKey: key),
+        applyLocally: applyLocally,
+      ));
 
       // We store Dart only errors that occur inside users handlers - to avoid
       // serializing the error and sending it to native only to have to send it
@@ -176,6 +154,17 @@ class MethodChannelDatabaseReference extends MethodChannelQuery
         throw possibleError;
       }
 
+      // For now, we'll need to keep the old method channel for transaction results
+      // until we can fully migrate the transaction handling
+      final result = await channel.invokeMethod(
+        'DatabaseReference#runTransaction',
+        database.getChannelArguments({
+          'path': path,
+          'transactionApplyLocally': applyLocally,
+          'transactionKey': key,
+        }),
+      );
+
       return MethodChannelTransactionResult(
         result!['committed'] as bool,
         this,

packages/firebase_database/firebase_database/windows/messages.g.cpp

@@ -4,6 +4,7 @@
 
 import 'package:firebase_database_platform_interface/firebase_database_platform_interface.dart';
 import 'package:firebase_database_platform_interface/src/method_channel/utils/utils.dart';
+import 'package:firebase_database_platform_interface/src/pigeon/messages.pigeon.dart' as pigeon;
 
 import 'method_channel_database.dart';
 import 'utils/exception.dart';
@@ -19,13 +20,10 @@ class MethodChannelOnDisconnect extends OnDisconnectPlatform {
   @override
   Future<void> set(Object? value) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'OnDisconnect#set',
-        database.getChannelArguments({
-          'path': ref.path,
-          if (value != null) 'value': transformValue(value),
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.onDisconnectSet(pigeon.OnDisconnectOptions(
+        path: ref.path,
+        value: value != null ? transformValue(value) : null,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -34,16 +32,11 @@ class MethodChannelOnDisconnect extends OnDisconnectPlatform {
   @override
   Future<void> setWithPriority(Object? value, Object? priority) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'OnDisconnect#setWithPriority',
-        database.getChannelArguments(
-          {
-            'path': ref.path,
-            if (value != null) 'value': transformValue(value),
-            if (priority != null) 'priority': priority,
-          },
-        ),
-      );
+      await MethodChannelDatabase.pigeonChannel.onDisconnectSetWithPriority(pigeon.OnDisconnectOptions(
+        path: ref.path,
+        value: value != null ? transformValue(value) : null,
+        priority: priority,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -55,10 +48,9 @@ class MethodChannelOnDisconnect extends OnDisconnectPlatform {
   @override
   Future<void> cancel() async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'OnDisconnect#cancel',
-        database.getChannelArguments({'path': ref.path}),
-      );
+      await MethodChannelDatabase.pigeonChannel.onDisconnectCancel(pigeon.DatabaseReference(
+        path: ref.path,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }
@@ -67,13 +59,10 @@ class MethodChannelOnDisconnect extends OnDisconnectPlatform {
   @override
   Future<void> update(Map<String, Object?> value) async {
     try {
-      await MethodChannelDatabase.channel.invokeMethod<void>(
-        'OnDisconnect#update',
-        database.getChannelArguments({
-          'path': ref.path,
-          'value': transformValue(value),
-        }),
-      );
+      await MethodChannelDatabase.pigeonChannel.onDisconnectUpdate(pigeon.UpdateOptions(
+        path: ref.path,
+        value: transformValue(value) as Map<String, Object?>,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }

packages/firebase_database/firebase_database/windows/messages.g.h

@@ -4,6 +4,7 @@
 
 import 'package:_flutterfire_internals/_flutterfire_internals.dart';
 import 'package:firebase_database_platform_interface/firebase_database_platform_interface.dart';
+import 'package:firebase_database_platform_interface/src/pigeon/messages.pigeon.dart' as pigeon;
 import 'package:flutter/services.dart';
 
 import 'method_channel_data_snapshot.dart';
@@ -37,24 +38,21 @@ class MethodChannelQuery extends QueryPlatform {
     QueryModifiers modifiers,
     DatabaseEventType eventType,
   ) async* {
-    const channel = MethodChannelDatabase.channel;
     List<Map<String, Object?>> modifierList = modifiers.toList();
     // Create a unique event channel naming prefix using path, app name,
     // databaseUrl, event type and ordered modifier list
     String eventChannelNamePrefix =
         '$path-${database.app!.name}-${database.databaseURL}-$eventType-$modifierList';
 
     // Create the EventChannel on native.
-    final channelName = await channel.invokeMethod<String>(
-      'Query#observe',
-      database.getChannelArguments({
-        'path': path,
-        'modifiers': modifierList,
-        'eventChannelNamePrefix': eventChannelNamePrefix,
-      }),
-    );
+    final channelName = await MethodChannelDatabase.pigeonChannel.observe(pigeon.EventObserver(
+      path: path,
+      eventType: eventTypeToString(eventType),
+      eventChannelNamePrefix: eventChannelNamePrefix,
+      modifiers: modifierList,
+    ));
 
-    yield* EventChannel(channelName!).receiveGuardedBroadcastStream(
+    yield* EventChannel(channelName).receiveGuardedBroadcastStream(
       arguments: <String, Object?>{'eventType': eventTypeToString(eventType)},
       onError: convertPlatformException,
     ).map(
@@ -67,16 +65,13 @@ class MethodChannelQuery extends QueryPlatform {
   @override
   Future<DataSnapshotPlatform> get(QueryModifiers modifiers) async {
     try {
-      final result = await channel.invokeMapMethod(
-        'Query#get',
-        database.getChannelArguments({
-          'path': path,
-          'modifiers': modifiers.toList(),
-        }),
-      );
+      final result = await MethodChannelDatabase.pigeonChannel.get(pigeon.GetOptions(
+        path: path,
+        modifiers: modifiers.toList(),
+      ));
       return MethodChannelDataSnapshot(
         ref,
-        Map<String, dynamic>.from(result!['snapshot']),
+        Map<String, dynamic>.from(result.snapshot),
       );
     } catch (e, s) {
       convertPlatformException(e, s);
@@ -99,12 +94,11 @@ class MethodChannelQuery extends QueryPlatform {
   @override
   Future<void> keepSynced(QueryModifiers modifiers, bool value) async {
     try {
-      await channel.invokeMethod<void>(
-        'Query#keepSynced',
-        database.getChannelArguments(
-          {'path': path, 'modifiers': modifiers.toList(), 'value': value},
-        ),
-      );
+      await MethodChannelDatabase.pigeonChannel.keepSynced(pigeon.KeepSyncedOptions(
+        path: path,
+        modifiers: modifiers.toList(),
+        value: value,
+      ));
     } catch (e, s) {
       convertPlatformException(e, s);
     }