Functions: replace InstanceID by Messaging (master) (#6395)

* FIRMessagingInterop introduced

* Typo fix

* Use FIRMessagingInterop in functions

* Functions tests fix

* Delete FUNInstanceIDProxy

* InstanceID cleanup

* ./scripts/style.sh

* Reduce FIRMessagingInterop to required minimum

* Cleanup

* Functions changelog

* Fix FIRMessagingInteropFake.h import

* Update integration tests

* Fix start.sh script

* GHA: add FCM interop to funstions paths

Author: maksymmalyhin

.github/workflows/functions.yml

@@ -6,6 +6,7 @@ on:
     - 'Functions**'
     - '.github/workflows/functions.yml'
     - 'Interop/Auth/Public/*.h'
+    - 'FirebaseMessaging/Sources/Interop/*.h'
     - 'Gemfile'
   schedule:
     # Run every day at 11pm (PST) - cron uses UTC times

FirebaseFunctions.podspec

@@ -27,6 +27,7 @@ Cloud Functions for Firebase.
     'Functions/FirebaseFunctions/**/*',
     'Interop/Auth/Public/*.h',
     'FirebaseCore/Sources/Private/*.h',
+    'FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h',
   ]
   s.public_header_files = 'Functions/FirebaseFunctions/Public/FirebaseFunctions/*.h'
 
@@ -40,13 +41,18 @@ Cloud Functions for Firebase.
   }
 
   s.test_spec 'unit' do |unit_tests|
-    unit_tests.source_files = 'Functions/Example/Test*/*.[mh]', 'SharedTestUtilities/FIRAuthInteropFake*'
+    unit_tests.source_files = [
+      'Functions/Example/Test*/*.[mh]',
+      'SharedTestUtilities/FIRAuthInteropFake*',
+      'SharedTestUtilities/FIRMessagingInteropFake*',
+  ]
   end
 
   s.test_spec 'integration' do |int_tests|
     int_tests.source_files = 'Functions/Example/IntegrationTests/*.[mh]',
                              'Functions/Example/TestUtils/*.[mh]',
                              'SharedTestUtilities/FIRAuthInteropFake*',
+                             'SharedTestUtilities/FIRMessagingInteropFake*',
                              'Functions/Example/GoogleService-Info.plist'
   end
 end

FirebaseMessaging/Sources/FIRMessaging.m

@@ -23,6 +23,7 @@
 #import <FirebaseMessaging/FIRMessaging.h>
 #import <FirebaseMessaging/FIRMessagingExtensionHelper.h>
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
+#import "FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h"
 #import "GoogleUtilities/AppDelegateSwizzler/Private/GULAppDelegateSwizzler.h"
 #import "GoogleUtilities/Reachability/Private/GULReachabilityChecker.h"
 #import "GoogleUtilities/UserDefaults/Private/GULUserDefaults.h"
@@ -161,21 +162,14 @@ @interface FIRMessaging () <FIRMessagingClientDelegate,
 
 @end
 
-// Messaging doesn't provide any functionality to other components,
-// so it provides a private, empty protocol that it conforms to and use it for registration.
-
-@protocol FIRMessagingInstanceProvider
-@end
-
-@interface FIRMessaging () <FIRMessagingInstanceProvider, FIRLibrary>
+@interface FIRMessaging () <FIRMessagingInterop, FIRLibrary>
 @end
 
 @implementation FIRMessaging
 
 + (FIRMessaging *)messaging {
   FIRApp *defaultApp = [FIRApp defaultApp];  // Missing configure will be logged here.
-  id<FIRMessagingInstanceProvider> instance =
-      FIR_COMPONENT(FIRMessagingInstanceProvider, defaultApp.container);
+  id<FIRMessagingInterop> instance = FIR_COMPONENT(FIRMessagingInterop, defaultApp.container);
 
   // We know the instance coming from the container is a FIRMessaging instance, cast it and move on.
   return (FIRMessaging *)instance;
@@ -241,7 +235,7 @@ + (void)load {
     return messaging;
   };
   FIRComponent *messagingProvider =
-      [FIRComponent componentWithProtocol:@protocol(FIRMessagingInstanceProvider)
+      [FIRComponent componentWithProtocol:@protocol(FIRMessagingInterop)
                       instantiationTiming:FIRInstantiationTimingEagerInDefaultApp
                              dependencies:@[ analyticsDep ]
                             creationBlock:creationBlock];

FirebaseMessaging/Sources/Interop/FIRMessagingInterop.h

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** Connector for bridging communication between Firebase SDKs and FIRMessaging API. */
+@protocol FIRMessagingInterop <NSObject>
+
+/**
+ * The FCM registration token is used to identify this device so that FCM can send notifications to
+ * it. It is associated with your APNs token when the APNs token is supplied, so messages sent to
+ * the FCM token will be delivered over APNs.
+ *
+ * The FCM registration token is sometimes refreshed automatically. In your FIRMessaging delegate,
+ * the delegate method `messaging:didReceiveRegistrationToken:` will be called once a token is
+ * available, or has been refreshed. Typically it should be called once per app start, but
+ * may be called more often if the token is invalidated or updated.
+ *
+ * Once you have an FCM registration token, you should send it to your application server, so it can
+ * use the FCM token to send notifications to your device.
+ */
+@property(nonatomic, readonly, nullable) NSString *FCMToken NS_SWIFT_NAME(fcmToken);
+
+@end
+
+NS_ASSUME_NONNULL_END

Functions/Backend/index.js

@@ -52,8 +52,8 @@ exports.tokenTest = functions.https.onRequest((request, response) => {
   response.send({ data: {} });
 });
 
-exports.instanceIdTest = functions.https.onRequest((request, response) => {
-  assert.equal(request.get('Firebase-Instance-ID-Token'), 'iid');
+exports.FCMTokenTest = functions.https.onRequest((request, response) => {
+  assert.equal(request.get('Firebase-Instance-ID-Token'), 'fakeFCMToken');
   assert.deepEqual(request.body, { data: {} });
   response.send({ data: {} });
 });

Functions/Backend/start.sh

@@ -46,7 +46,7 @@ FUNCTIONS_BIN="./node_modules/.bin/functions"
 "${FUNCTIONS_BIN}" deploy dataTest --trigger-http
 "${FUNCTIONS_BIN}" deploy scalarTest --trigger-http
 "${FUNCTIONS_BIN}" deploy tokenTest --trigger-http
-"${FUNCTIONS_BIN}" deploy instanceIdTest --trigger-http
+"${FUNCTIONS_BIN}" deploy FCMTokenTest --trigger-http
 "${FUNCTIONS_BIN}" deploy nullTest --trigger-http
 "${FUNCTIONS_BIN}" deploy missingResultTest --trigger-http
 "${FUNCTIONS_BIN}" deploy unhandledErrorTest --trigger-http

Functions/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v2.8.0
+- [changed] Weak dependency on Instance ID replaced by Firebase Messaging. (#6395)
+
 # v2.7.0
 - [changed] Functionally neutral source reorganization. (#5858)
 

Functions/Example/IntegrationTests/FIRIntegrationTests.m

@@ -17,11 +17,11 @@
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
 #import "FIRAuthInteropFake.h"
-#import "Functions/Example/TestUtils/FUNFakeInstanceID.h"
 #import "Functions/FirebaseFunctions/FIRFunctions+Internal.h"
 #import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRError.h"
 #import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRFunctions.h"
 #import "Functions/FirebaseFunctions/Public/FirebaseFunctions/FIRHTTPSCallable.h"
+#import "SharedTestUtilities/FIRMessagingInteropFake.h"
 
 // Project ID used by these tests.
 static NSString *const kDefaultProjectID = @"functions-integration-test";
@@ -30,6 +30,7 @@ @interface FIRIntegrationTests : XCTestCase {
   FIRFunctions *_functions;
   NSString *_projectID;
   BOOL _useLocalhost;
+  FIRMessagingInteropFake *_messagingFake;
 }
 @end
 
@@ -38,6 +39,8 @@ @implementation FIRIntegrationTests
 - (void)setUp {
   [super setUp];
 
+  _messagingFake = [[FIRMessagingInteropFake alloc] init];
+
   _projectID = kDefaultProjectID;
   _useLocalhost = YES;
 
@@ -51,7 +54,8 @@ - (void)setUp {
   _functions = [[FIRFunctions alloc]
       initWithProjectID:_projectID
                  region:@"us-central1"
-                   auth:[[FIRAuthInteropFake alloc] initWithToken:nil userID:nil error:nil]];
+                   auth:[[FIRAuthInteropFake alloc] initWithToken:nil userID:nil error:nil]
+              messaging:_messagingFake];
   if (_useLocalhost) {
     [_functions useLocalhost];
   }
@@ -101,7 +105,8 @@ - (void)testToken {
   FIRFunctions *functions = [[FIRFunctions alloc]
       initWithProjectID:_projectID
                  region:@"us-central1"
-                   auth:[[FIRAuthInteropFake alloc] initWithToken:@"token" userID:nil error:nil]];
+                   auth:[[FIRAuthInteropFake alloc] initWithToken:@"token" userID:nil error:nil]
+              messaging:_messagingFake];
   if (_useLocalhost) {
     [functions useLocalhost];
   }
@@ -117,9 +122,9 @@ - (void)testToken {
   [self waitForExpectations:@[ expectation ] timeout:10];
 }
 
-- (void)testInstanceID {
+- (void)testFCMToken {
   XCTestExpectation *expectation = [[XCTestExpectation alloc] init];
-  FIRHTTPSCallable *function = [_functions HTTPSCallableWithName:@"instanceIdTest"];
+  FIRHTTPSCallable *function = [_functions HTTPSCallableWithName:@"FCMTokenTest"];
   [function callWithObject:@{}
                 completion:^(FIRHTTPSCallableResult *_Nullable result, NSError *_Nullable error) {
                   XCTAssertNil(error);

Functions/Example/Tests/FIRFunctionsTests.m

@@ -33,7 +33,8 @@ - (void)tearDown {
 - (void)testURLWithName {
   FIRFunctions *functions = [[FIRFunctions alloc] initWithProjectID:@"my-project"
                                                              region:@"my-region"
-                                                               auth:nil];
+                                                               auth:nil
+                                                          messaging:nil];
   NSString *url = [functions URLWithName:@"my-endpoint"];
   XCTAssertEqualObjects(@"https://my-region-my-project.cloudfunctions.net/my-endpoint", url);
 }

Functions/Example/Tests/FUNContextProviderTests.m

@@ -16,22 +16,29 @@
 
 #import "FIRAuthInteropFake.h"
 #import "Functions/FirebaseFunctions/FUNContext.h"
+#import "SharedTestUtilities/FIRMessagingInteropFake.h"
 
 @interface FUNContextProviderTests : XCTestCase
+@property(nonatomic) FIRMessagingInteropFake *messagingFake;
 @end
 
 @implementation FUNContextProviderTests
 
+- (void)setUp {
+  self.messagingFake = [[FIRMessagingInteropFake alloc] init];
+}
+
 - (void)testContextWithAuth {
   FIRAuthInteropFake *auth = [[FIRAuthInteropFake alloc] initWithToken:@"token"
                                                                 userID:@"userID"
                                                                  error:nil];
-  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:(id<FIRAuthInterop>)auth];
+  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:(id<FIRAuthInterop>)auth
+                                                                messaging:self.messagingFake];
   XCTestExpectation *expectation =
       [self expectationWithDescription:@"Context should have auth keys."];
   [provider getContext:^(FUNContext *_Nullable context, NSError *_Nullable error) {
     XCTAssert([context.authToken isEqualToString:@"token"]);
-    XCTAssert([context.instanceIDToken isEqualToString:@"iid"]);
+    XCTAssert([context.FCMToken isEqualToString:self.messagingFake.FCMToken]);
     XCTAssertNil(error);
     [expectation fulfill];
   }];
@@ -44,7 +51,8 @@ - (void)testContextWithAuthError {
   FIRAuthInteropFake *auth = [[FIRAuthInteropFake alloc] initWithToken:nil
                                                                 userID:nil
                                                                  error:authError];
-  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:(id<FIRAuthInterop>)auth];
+  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:(id<FIRAuthInterop>)auth
+                                                                messaging:self.messagingFake];
   XCTestExpectation *expectation =
       [self expectationWithDescription:@"Completion handler should fail with Auth error."];
   [provider getContext:^(FUNContext *_Nullable context, NSError *_Nullable error) {
@@ -57,13 +65,13 @@ - (void)testContextWithAuthError {
 }
 
 - (void)testContextWithoutAuth {
-  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:nil];
+  FUNContextProvider *provider = [[FUNContextProvider alloc] initWithAuth:nil messaging:nil];
   XCTestExpectation *expectation =
       [self expectationWithDescription:@"Completion handler should succeed without Auth."];
   [provider getContext:^(FUNContext *_Nullable context, NSError *_Nullable error) {
     XCTAssertNil(error);
     XCTAssertNil(context.authToken);
-    XCTAssert([context.instanceIDToken isEqualToString:@"iid"]);
+    XCTAssertNil(context.FCMToken);
     [expectation fulfill];
   }];