feat(cloud_firestore): Move Snapshot handling into a EventChannel

packages/cloud_firestore/cloud_firestore/example/ios/Podfile

@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-platform :ios, '9.0'
+# platform :ios, '9.0'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'
@@ -10,76 +10,31 @@ project 'Runner', {
   'Release' => :release,
 }
 
-def parse_KV_file(file, separator='=')
-  file_abs_path = File.expand_path(file)
-  if !File.exists? file_abs_path
-    return [];
+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
-  generated_key_values = {}
-  skip_line_start_symbols = ["#", "/"]
-  File.foreach(file_abs_path) do |line|
-    next if skip_line_start_symbols.any? { |symbol| line =~ /^\s*#{symbol}/ }
-    plugin = line.split(pattern=separator)
-    if plugin.length == 2
-      podname = plugin[0].strip()
-      path = plugin[1].strip()
-      podpath = File.expand_path("#{path}", file_abs_path)
-      generated_key_values[podname] = podpath
-    else
-      puts "Invalid plugin specification: #{line}"
-    end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
   end
-  generated_key_values
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get"
 end
 
-target 'Runner' do
-  # Flutter Pod
-  copied_flutter_dir = File.join(__dir__, 'Flutter')
-  copied_framework_path = File.join(copied_flutter_dir, 'Flutter.framework')
-  copied_podspec_path = File.join(copied_flutter_dir, 'Flutter.podspec')
-  unless File.exist?(copied_framework_path) && File.exist?(copied_podspec_path)
-    # Copy Flutter.framework and Flutter.podspec to Flutter/ to have something to link against if the xcode backend script has not run yet.
-    # That script will copy the correct debug/profile/release version of the framework based on the currently selected Xcode configuration.
-    # CocoaPods will not embed the framework on pod install (before any build phases can generate) if the dylib does not exist.
-
-    generated_xcode_build_settings_path = File.join(copied_flutter_dir, 'Generated.xcconfig')
-    unless File.exist?(generated_xcode_build_settings_path)
-      raise "Generated.xcconfig must exist. If you're running pod install manually, make sure flutter pub get is executed first"
-    end
-    generated_xcode_build_settings = parse_KV_file(generated_xcode_build_settings_path)
-    cached_framework_dir = generated_xcode_build_settings['FLUTTER_FRAMEWORK_DIR'];
-
-    unless File.exist?(copied_framework_path)
-      FileUtils.cp_r(File.join(cached_framework_dir, 'Flutter.framework'), copied_flutter_dir)
-    end
-    unless File.exist?(copied_podspec_path)
-      FileUtils.cp(File.join(cached_framework_dir, 'Flutter.podspec'), copied_flutter_dir)
-    end
-  end
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
 
-  # Keep pod path relative so it can be checked into Podfile.lock.
-  pod 'Flutter', :path => 'Flutter'
+flutter_ios_podfile_setup
 
-  # Plugin Pods
+target 'Runner' do
+  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
 
-  # Prepare symlinks folder. We use symlinks to avoid having Podfile.lock
-  # referring to absolute paths on developers' machines.
-  system('rm -rf .symlinks')
-  system('mkdir -p .symlinks/plugins')
-  plugin_pods = parse_KV_file('../.flutter-plugins')
-  plugin_pods.each do |name, path|
-    symlink = File.join('.symlinks', 'plugins', name)
-    File.symlink(path, symlink)
-    pod name, :path => File.join(symlink, 'ios')
-  end
   pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => '6.33.0'
 end
 
-
 post_install do |installer|
   installer.pods_project.targets.each do |target|
-    target.build_configurations.each do |config|
-      config.build_settings['ENABLE_BITCODE'] = 'NO'
-    end
+    flutter_additional_ios_build_settings(target)
   end
 end

packages/cloud_firestore/cloud_firestore/example/ios/Runner.xcodeproj/project.pbxproj

@@ -147,7 +147,6 @@
 			buildPhases = (
 				AB1344B0443C71CD721E1BB7 /* [CP] Check Pods Manifest.lock */,
 				9740EEB61CF901F6004384FC /* Run Script */,
-				6EA2AFC772200E017D392E90 /* [CP] Prepare Artifacts */,
 				97C146EA1CF9000F007C117D /* Sources */,
 				97C146EB1CF9000F007C117D /* Frameworks */,
 				97C146EC1CF9000F007C117D /* Resources */,
@@ -248,37 +247,13 @@
 			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-resources.sh\"\n";
 			showEnvVarsInLog = 0;
 		};
-		6EA2AFC772200E017D392E90 /* [CP] Prepare Artifacts */ = {
-			isa = PBXShellScriptBuildPhase;
-			buildActionMask = 2147483647;
-			files = (
-			);
-			inputPaths = (
-				"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-artifacts.sh",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/abseil.xcframework",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/BoringSSL-GRPC.xcframework",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/FirebaseFirestore.xcframework",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/gRPC-C++.xcframework",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/gRPC-Core.xcframework",
-				"${PODS_ROOT}/FirebaseFirestore/FirebaseFirestore/leveldb-library.xcframework",
-			);
-			name = "[CP] Prepare Artifacts";
-			outputPaths = (
-				"${BUILT_PRODUCTS_DIR}/cocoapods-artifacts-${CONFIGURATION}.txt",
-			);
-			runOnlyForDeploymentPostprocessing = 0;
-			shellPath = /bin/sh;
-			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-artifacts.sh\"\n";
-			showEnvVarsInLog = 0;
-		};
 		95BB15E9E1769C0D146AA592 /* [CP] Embed Pods Frameworks */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
 			);
 			inputPaths = (
 				"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh",
-				"${BUILT_PRODUCTS_DIR}/cocoapods-artifacts-${CONFIGURATION}.txt",
 				"${PODS_ROOT}/../Flutter/Flutter.framework",
 			);
 			name = "[CP] Embed Pods Frameworks";
@@ -449,7 +424,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */;
 			buildSettings = {
-				ARCHS = arm64;
+				ARCHS = "$(ARCHS_STANDARD)";
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ENABLE_BITCODE = NO;
 				FRAMEWORK_SEARCH_PATHS = (
@@ -471,7 +446,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */;
 			buildSettings = {
-				ARCHS = arm64;
+				ARCHS = "$(ARCHS_STANDARD)";
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				ENABLE_BITCODE = NO;
 				FRAMEWORK_SEARCH_PATHS = (

packages/cloud_firestore/cloud_firestore/example/pubspec.yaml

@@ -12,6 +12,8 @@ dependencies:
 dependency_overrides:
   firebase_core:
     path: ../../../firebase_core/firebase_core
+  cloud_firestore_platform_interface:
+    path: ../../cloud_firestore_platform_interface
 
 dev_dependencies:
   pedantic: ^1.8.0

packages/cloud_firestore/cloud_firestore/ios/Classes/FLTDocumentSnapshotStreamHandler.m

@@ -0,0 +1,64 @@
+//
+//  FLTDocumentSnapshotStreamHandler.m
+//  cloud_firestore
+//
+//  Created by Sebastian Roth on 24/11/2020.
+//
+
+#import <Firebase/Firebase.h>
+#import <firebase_core/FLTFirebasePluginRegistry.h>
+
+#import "Private/FLTDocumentSnapshotStreamHandler.h"
+#import "Private/FLTFirebaseFirestoreUtils.h"
+
+@implementation FLTDocumentSnapshotStreamHandler {
+  NSMutableDictionary<NSNumber *, id<FIRListenerRegistration>> *_listeners;
+}
+
+- (FlutterError *_Nullable)onListenWithArguments:(id _Nullable)arguments
+                                       eventSink:(nonnull FlutterEventSink)events {
+
+  NSNumber *handle = arguments[@"handle"];
+  NSNumber *includeMetadataChanges = arguments[@"includeMetadataChanges"];
+
+  FIRDocumentReference *document = arguments[@"reference"];
+
+  id listener = ^(FIRDocumentSnapshot *snapshot, NSError *_Nullable error) {
+    if (error != nil) {
+      NSArray *codeAndMessage = [FLTFirebaseFirestoreUtils ErrorCodeAndMessageFromNSError:error];
+
+      events(@{
+        @"handle" : handle,
+        @"error" : @{@"code" : codeAndMessage[0], @"message" : codeAndMessage[1]},
+      });
+    } else if (snapshot != nil) {
+      events(@{
+        @"handle" : handle,
+        @"snapshot" : snapshot,
+      });
+    }
+  };
+
+  id<FIRListenerRegistration> listenerRegistration =
+      [document addSnapshotListenerWithIncludeMetadataChanges:includeMetadataChanges.boolValue
+                                                     listener:listener];
+
+  @synchronized(_listeners) {
+    _listeners[handle] = listenerRegistration;
+  }
+
+  return nil;
+}
+
+- (FlutterError *_Nullable)onCancelWithArguments:(id _Nullable)arguments {
+  NSNumber *handle = arguments[@"handle"];
+
+  @synchronized(_listeners) {
+    [_listeners[handle] remove];
+    [_listeners removeObjectForKey:handle];
+  }
+
+  return nil;
+}
+
+@end

packages/cloud_firestore/cloud_firestore/ios/Classes/FLTFirebaseFirestorePlugin.m

@@ -6,9 +6,15 @@
 #import <firebase_core/FLTFirebasePluginRegistry.h>
 
 #import "Private/FLTFirebaseFirestoreUtils.h"
+#import "Private/FLTDocumentSnapshotStreamHandler.h"
+#import "Private/FLTQuerySnapshotStreamHandler.h"
 #import "Public/FLTFirebaseFirestorePlugin.h"
 
 NSString *const kFLTFirebaseFirestoreChannelName = @"plugins.flutter.io/firebase_firestore";
+NSString *const kFLTFirebaseFirestoreQuerySnapshotEventChannelName =
+    @"plugins.flutter.io/firebase_firestore/query";
+NSString *const kFLTFirebaseFirestoreDocumentSnapshotEventChannelName =
+    @"plugins.flutter.io/firebase_firestore/document";
 
 @interface FLTFirebaseFirestorePlugin ()
 @property(nonatomic, retain) FlutterMethodChannel *channel;
@@ -55,6 +61,24 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
   FLTFirebaseFirestorePlugin *instance = [FLTFirebaseFirestorePlugin sharedInstance];
   instance.channel = channel;
   [registrar addMethodCallDelegate:instance channel:channel];
+
+  FlutterEventChannel *querySnapshotChannel =
+      [FlutterEventChannel eventChannelWithName:kFLTFirebaseFirestoreQuerySnapshotEventChannelName
+                                binaryMessenger:registrar.messenger
+                                          codec:[FlutterStandardMethodCodec
+                                                    codecWithReaderWriter:firestoreReaderWriter]];
+
+  [querySnapshotChannel setStreamHandler:[[FLTQuerySnapshotStreamHandler alloc] init]];
+
+  FlutterEventChannel *documentSnapshotChannel =
+      [FlutterEventChannel eventChannelWithName:kFLTFirebaseFirestoreDocumentSnapshotEventChannelName
+                                binaryMessenger:registrar.messenger
+                                          codec:[FlutterStandardMethodCodec
+                                                    codecWithReaderWriter:firestoreReaderWriter]];
+
+  [documentSnapshotChannel setStreamHandler:[[FLTDocumentSnapshotStreamHandler alloc] init]];
+
+
 #if TARGET_OS_OSX
 // TODO(Salakar): Publish does not exist on MacOS version of FlutterPluginRegistrar.
 #else
@@ -141,10 +165,6 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)flutter
     [self documentDelete:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"DocumentReference#get" isEqualToString:call.method]) {
     [self documentGet:call.arguments withMethodCallResult:methodCallResult];
-  } else if ([@"Query#addSnapshotListener" isEqualToString:call.method]) {
-    [self queryAddSnapshotListener:call.arguments withMethodCallResult:methodCallResult];
-  } else if ([@"DocumentReference#addSnapshotListener" isEqualToString:call.method]) {
-    [self documentAddSnapshotListener:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Query#get" isEqualToString:call.method]) {
     [self queryGet:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Firestore#removeListener" isEqualToString:call.method]) {
@@ -438,87 +458,6 @@ - (void)documentGet:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallRes
   [document getDocumentWithSource:source completion:completion];
 }
 
-- (void)queryAddSnapshotListener:(id)arguments
-            withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
-  __weak __typeof__(self) weakSelf = self;
-  FIRQuery *query = arguments[@"query"];
-
-  if (query == nil) {
-    result.error(@"sdk-error",
-                 @"An error occurred while parsing query arguments, see native logs for more "
-                 @"information. Please report this issue.",
-                 nil, nil);
-    return;
-  }
-
-  NSNumber *handle = arguments[@"handle"];
-  NSNumber *includeMetadataChanges = arguments[@"includeMetadataChanges"];
-
-  id listener = ^(FIRQuerySnapshot *_Nullable snapshot, NSError *_Nullable error) {
-    if (error != nil) {
-      NSArray *codeAndMessage = [FLTFirebaseFirestoreUtils ErrorCodeAndMessageFromNSError:error];
-      [weakSelf.channel
-          invokeMethod:@"QuerySnapshot#error"
-             arguments:@{
-               @"handle" : handle,
-               @"error" : @{@"code" : codeAndMessage[0], @"message" : codeAndMessage[1]},
-             }];
-    } else if (snapshot != nil) {
-      [weakSelf.channel invokeMethod:@"QuerySnapshot#event"
-                           arguments:@{
-                             @"handle" : handle,
-                             @"snapshot" : snapshot,
-                           }];
-    }
-  };
-
-  id<FIRListenerRegistration> listenerRegistration =
-      [query addSnapshotListenerWithIncludeMetadataChanges:includeMetadataChanges.boolValue
-                                                  listener:listener];
-
-  @synchronized(_listeners) {
-    _listeners[handle] = listenerRegistration;
-  }
-  result.success(nil);
-}
-
-- (void)documentAddSnapshotListener:(id)arguments
-               withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
-  __weak __typeof__(self) weakSelf = self;
-
-  NSNumber *handle = arguments[@"handle"];
-  NSNumber *includeMetadataChanges = arguments[@"includeMetadataChanges"];
-
-  FIRDocumentReference *document = arguments[@"reference"];
-
-  id listener = ^(FIRDocumentSnapshot *snapshot, NSError *_Nullable error) {
-    if (error != nil) {
-      NSArray *codeAndMessage = [FLTFirebaseFirestoreUtils ErrorCodeAndMessageFromNSError:error];
-      [weakSelf.channel
-          invokeMethod:@"DocumentSnapshot#error"
-             arguments:@{
-               @"handle" : handle,
-               @"error" : @{@"code" : codeAndMessage[0], @"message" : codeAndMessage[1]},
-             }];
-    } else if (snapshot != nil) {
-      [weakSelf.channel invokeMethod:@"DocumentSnapshot#event"
-                           arguments:@{
-                             @"handle" : handle,
-                             @"snapshot" : snapshot,
-                           }];
-    }
-  };
-
-  id<FIRListenerRegistration> listenerRegistration =
-      [document addSnapshotListenerWithIncludeMetadataChanges:includeMetadataChanges.boolValue
-                                                     listener:listener];
-
-  @synchronized(_listeners) {
-    _listeners[handle] = listenerRegistration;
-  }
-  result.success(nil);
-}
-
 - (void)queryGet:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
   FIRQuery *query = arguments[@"query"];