Enables Firebase Messaging push notification function on watch only and independent watch app (#4016)

Author: charlotteliang

.travis.yml

@@ -370,16 +370,22 @@ jobs:
 env:
  - PROJECT=GoogleUtilities METHOD=pod-lib-lint
 script:
- - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb GoogleUtilities.podspec
+ - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --platforms=ios
+ - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --platforms=tvos
+ - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --platforms=macos
 
  - stage: test
 if: type = cron
 env:
  - PROJECT=GoogleUtilitiesCron METHOD=pod-lib-lint
 script:
 
- - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-libraries
- - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-modular-headers
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-libraries --platforms=ios
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-libraries --platforms=tvos
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-libraries --platforms=macos
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-modular-headers --platforms=ios
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-modular-headers --platforms=tvos
+ - travis_retry ./scripts/pod_lib_lint.rb GoogleUtilities.podspec --use-modular-headers --platforms=macos
 
  - stage: test
 env:

Example/Messaging/Tests/FIRMessagingInstanceTest.swift

@@ -27,14 +27,6 @@ class FIRMessagingInstanceTest: XCTestCase {
 FirebaseApp.configure(options: options)
 letoriginal=Messaging.messaging()
 
- // Ensure the client is set up as expected.
-guardlet isOrigClientSetup = original.value(forKey:"isClientSetup")as?Boolelse{
-XCTFail("Could not get internal Messaging variable `isClientSetup`.")
-return
-}
-
-XCTAssertTrue(isOrigClientSetup,"Property `isClientSetup` should be true after creation.")
-
  // Get and delete the default app.
 guardlet defaultApp =FirebaseApp.app()else{
 XCTFail("Default app was not configured properly.")
@@ -54,13 +46,5 @@ class FIRMessagingInstanceTest: XCTestCase {
  // Get another instance of Messaging, make sure it's not the same instance.
 letpostDelete=Messaging.messaging()
 XCTAssertNotEqual(original, postDelete)
-
- // Ensure the new client is set up as expected.
-guardlet isClientSetup = postDelete.value(forKey:"isClientSetup")as?Boolelse{
-XCTFail("Could not get internal Messaging variable `isClientSetup`.")
-return
-}
-
-XCTAssertTrue(isClientSetup,"Property `isClientSetup` should be true after creation.")
 }
 }

Firebase/Core/FIRApp.m

@@ -887,16 +887,16 @@ - (void)sendLogsWithServiceName:(NSString *)serviceName
 - (void)subscribeForAppDidBecomeActiveNotifications {
 #if TARGET_OS_IOS || TARGET_OS_TV
 NSNotificationName notificationName = UIApplicationDidBecomeActiveNotification;
-#endif
-
-#if TARGET_OS_OSX
+#elif TARGET_OS_OSX
 NSNotificationName notificationName = NSApplicationDidBecomeActiveNotification;
 #endif
 
+#if !TARGET_OS_WATCH
  [[NSNotificationCenterdefaultCenter] addObserver:self
 selector:@selector(appDidBecomeActive:)
 name:notificationName
 object:nil];
+#endif
 }
 
 - (void)appDidBecomeActive:(NSNotification *)notification {

Firebase/InstanceID/FIRInstanceID.m

@@ -60,12 +60,12 @@
 // change.
 NSIntegerconstkMaxRetryCountForDefaultToken = 5;
 
-#if TARGET_OS_IOS || TARGET_OS_TV
+#if TARGET_OS_IOS || TARGET_OS_TV || TARGET_OS_WATCH
 staticNSString *constkEntitlementsAPSEnvironmentKey = @"Entitlements.aps-environment";
 #else
-staticNSString *constkEntitlementsAPSEnvironmentKey = @"com.apple.developer.aps-environment";
+staticNSString *constkEntitlementsAPSEnvironmentKey =
+@"Entitlements.com.apple.developer.aps-environment";
 #endif
-staticNSString *constkEntitlementsKeyForMac = @"Entitlements";
 staticNSString *constkAPSEnvironmentDevelopmentValue = @"development";
 /// FIRMessaging selector that returns the current FIRMessaging auto init
 /// enabled flag.
@@ -617,10 +617,14 @@ - (void)configureInstanceIDWithOptions:(FIROptions *)options {
  [selfupdateFirebaseInstallationID];
 
 // FCM generates a FCM token during app start for sending push notification to device.
-// This is not needed for app extension.
+// This is not needed for app extension except for watch.
+#if TARGET_OS_WATCH
+ [selfdidCompleteConfigure];
+#else
 if (![GULAppEnvironmentUtil isAppExtension]) {
  [selfdidCompleteConfigure];
  }
+#endif
 }
 
 // This is used to start any operations when we receive FirebaseSDK setup notification
@@ -978,7 +982,7 @@ - (BOOL)isProductionApp {
 // Apps distributed via AppStore or TestFlight use the Production APNS certificates.
 return defaultAppTypeProd;
  }
-#if TARGET_OS_IOS || TARGET_OS_TV
+#if TARGET_OS_IOS || TARGET_OS_TV || TARGET_OS_WATCH
 NSString *path = [[[NSBundlemainBundle] bundlePath]
 stringByAppendingPathComponent:@"embedded.mobileprovision"];
 #elif TARGET_OS_OSX
@@ -1061,13 +1065,7 @@ - (BOOL)isProductionApp {
 @"most likely a Dev profile.");
  }
 
-#if TARGET_OS_IOS || TARGET_OS_TV
 NSString *apsEnvironment = [plistMap valueForKeyPath:kEntitlementsAPSEnvironmentKey];
-#elif TARGET_OS_OSX
-NSDictionary *entitlements = [plistMap valueForKey:kEntitlementsKeyForMac];
-NSString *apsEnvironment = [entitlements valueForKey:kEntitlementsAPSEnvironmentKey];
-#endif
-
 NSString *debugString __unused =
  [NSStringstringWithFormat:@"APNS Environment in profile: %@", apsEnvironment];
 FIRInstanceIDLoggerDebug(kFIRInstanceIDMessageCodeInstanceID013, @"%@", debugString);

Firebase/InstanceID/FIRInstanceIDAuthKeyChain.m

@@ -91,7 +91,7 @@ - (NSMutableDictionary *)keychainQueryForService:(NSString *)service account:(NS
 // FIRInstanceIDKeychain should only take a query and return a result, will handle the query here.
 NSArray *passwordInfos =
 CFBridgingRelease([[FIRInstanceIDKeychain sharedInstance] itemWithQuery:keychainQuery]);
-#elif TARGET_OS_OSX
+#elif TARGET_OS_OSX || TARGET_OS_WATCH
  keychainQuery[(__bridge id)kSecMatchLimit] = (__bridge id)kSecMatchLimitOne;
 NSData *passwordInfos =
 CFBridgingRelease([[FIRInstanceIDKeychain sharedInstance] itemWithQuery:keychainQuery]);
@@ -120,7 +120,7 @@ - (NSMutableDictionary *)keychainQueryForService:(NSString *)service account:(NS
  [results addObject:passwordInfo[(__bridge id)kSecValueData]];
  }
  }
-#elif TARGET_OS_OSX
+#elif TARGET_OS_OSX || TARGET_OS_WATCH
  [results addObject:passwordInfos];
 #endif
 // We query the keychain because it didn't exist in cache, now query is done, update the result in

Firebase/InstanceID/FIRInstanceIDUtilities.m

@@ -78,16 +78,29 @@ int64_t FIRInstanceIDCurrentTimestampInMilliseconds() {
 return version;
 }
 
+NSString *FIRInstanceIDBundleIDByRemovingLastPartFrom(NSString *bundleID) {
+NSString *bundleIDComponentsSeparator = @".";
+
+NSMutableArray<NSString *> *bundleIDComponents =
+ [[bundleID componentsSeparatedByString:bundleIDComponentsSeparator] mutableCopy];
+ [bundleIDComponents removeLastObject];
+
+return [bundleIDComponents componentsJoinedByString:bundleIDComponentsSeparator];
+}
+
 NSString *FIRInstanceIDAppIdentifier() {
-NSString *bundleIdentifier = [[NSBundlemainBundle] bundleIdentifier];
-if (!bundleIdentifier.length) {
+NSString *bundleID = [[NSBundlemainBundle] bundleIdentifier];
+if (!bundleID.length) {
 FIRInstanceIDLoggerError(kFIRInstanceIDMessageCodeUtilitiesMissingBundleIdentifier,
 @"The mainBundle's bundleIdentifier returned '%@'. Bundle identifier "
 @"expected to be non-empty.",
-bundleIdentifier);
+bundleID);
 return@"";
  }
-return bundleIdentifier;
+#if TARGET_OS_WATCH
+returnFIRInstanceIDBundleIDByRemovingLastPartFrom(bundleID);
+#endif
+return bundleID;
 }
 
 NSString *FIRInstanceIDFirebaseAppID() {
@@ -111,7 +124,7 @@ int64_t FIRInstanceIDCurrentTimestampInMilliseconds() {
 NSString *FIRInstanceIDOperatingSystemVersion() {
 #if TARGET_OS_IOS || TARGET_OS_TV
 return [UIDevice currentDevice].systemVersion;
-#elif TARGET_OS_OSX
+#elif TARGET_OS_OSX || TARGET_OS_WATCH
 return [NSProcessInfoprocessInfo].operatingSystemVersionString;
 #endif
 }

Firebase/Messaging/FIRMessaging.m

@@ -145,8 +145,6 @@ @interface FIRMessaging ()<FIRMessagingClientDelegate, FIRMessagingReceiverDeleg
 
 @property(nonatomic, readwrite, strong) FIRInstanceID *instanceID;
 
-@property(nonatomic, readwrite, assign) BOOL isClientSetup;
-
 @property(nonatomic, readwrite, strong) FIRMessagingClient *client;
 @property(nonatomic, readwrite, strong) GULReachabilityChecker *reachability;
 @property(nonatomic, readwrite, strong) FIRMessagingDataMessageManager *dataMessageManager;
@@ -270,6 +268,10 @@ - (void)configureNotificationSwizzlingIfEnabled {
 }
 
 - (void)start {
+ [selfsetupFileManagerSubDirectory];
+ [selfsetupNotificationListeners];
+
+#if !TARGET_OS_WATCH
 // Print the library version for logging.
 NSString *currentLibraryVersion = FIRMessagingCurrentLibraryVersion();
 FIRMessagingLoggerInfo(kFIRMessagingMessageCodeMessagingPrintLibraryVersion,
@@ -283,16 +285,14 @@ - (void)start {
 withHost:hostname];
  [self.reachability start];
 
- [selfsetupFileManagerSubDirectory];
 // setup FIRMessaging objects
  [selfsetupRmqManager];
  [selfsetupClient];
  [selfsetupSyncMessageManager];
  [selfsetupDataMessageManager];
  [selfsetupTopics];
 
- self.isClientSetup = YES;
- [selfsetupNotificationListeners];
+#endif
 }
 
 - (void)setupFileManagerSubDirectory {
@@ -373,7 +373,6 @@ - (void)teardown {
  self.rmq2Manager = nil;
  self.dataMessageManager = nil;
  self.client = nil;
- self.isClientSetup = NO;
 FIRMessagingLoggerDebug(kFIRMessagingMessageCodeMessaging001, @"Did successfully teardown");
 }
 
@@ -687,7 +686,7 @@ - (BOOL)isDirectChannelEstablished {
 }
 
 - (BOOL)shouldBeConnectedAutomatically {
-#if TARGET_OS_OSX
+#if TARGET_OS_OSX || TARGET_OS_WATCH
 returnNO;
 #else
 // We require a token from Instance ID

Firebase/Messaging/FIRMessagingExtensionHelper.m

@@ -36,7 +36,7 @@ - (void)populateNotificationContent:(UNMutableNotificationContent *)content
  self.bestAttemptContent = content;
 
 // The `userInfo` property isn't available on newer versions of tvOS.
-#if TARGET_OS_IOS || TARGET_OS_OSX
+#if TARGET_OS_IOS || TARGET_OS_OSX || TARGET_OS_WATCH
 NSString *currentImageURL = content.userInfo[kPayloadOptionsName][kPayloadOptionsImageURLName];
 if (!currentImageURL) {
  [selfdeliverNotification];
@@ -59,7 +59,7 @@ - (void)populateNotificationContent:(UNMutableNotificationContent *)content
 #endif
 }
 
-#if TARGET_OS_IOS || TARGET_OS_OSX
+#if TARGET_OS_IOS || TARGET_OS_OSX || TARGET_OS_WATCH
 - (void)loadAttachmentForURL:(NSURL *)attachmentURL
 completionHandler:(void (^)(UNNotificationAttachment *))completionHandler {
  __block UNNotificationAttachment *attachment = nil;

Firebase/Messaging/FIRMessagingUtilities.m

@@ -149,8 +149,27 @@ int64_t FIRMessagingCurrentTimestampInMilliseconds(void) {
 return version;
 }
 
+
+NSString * FIRMessagingBundleIDByRemovingLastPartFrom(NSString *bundleID) {
+NSString *bundleIDComponentsSeparator = @".";
+
+NSMutableArray<NSString *> *bundleIDComponents =
+ [[bundleID componentsSeparatedByString:bundleIDComponentsSeparator] mutableCopy];
+ [bundleIDComponents removeLastObject];
+
+return [bundleIDComponents componentsJoinedByString:bundleIDComponentsSeparator];
+}
+
 NSString *FIRMessagingAppIdentifier(void) {
-return [[NSBundlemainBundle] bundleIdentifier];
+NSString *bundleID = [[NSBundlemainBundle] bundleIdentifier];
+#if TARGET_OS_WATCH
+// The code is running in watchKit extension target but the actually bundleID is in the watchKit
+// target. So we need to remove the last part of the bundle ID in watchKit extension to match
+// the one in watchKit target.
+returnFIRMessagingBundleIDByRemovingLastPartFrom(bundleID);
+#else
+return bundleID;
+#endif
 }
 
 uint64_tFIRMessagingGetFreeDiskSpaceInMB(void) {

FirebaseAnalyticsInterop.podspec

@@ -24,6 +24,8 @@ Pod::Spec.new do |s|
 s.ios.deployment_target='8.0'
 s.osx.deployment_target='10.11'
 s.tvos.deployment_target='10.0'
+s.watchos.deployment_target='6.0'
+
 s.source_files='Interop/Analytics/**/*.h'
 s.public_header_files='Interop/Analytics/Public/*.h'
 end

FirebaseCore.podspec

@@ -19,6 +19,7 @@ Firebase Core includes FIRApp and FIROptions which provide central configuration
 s.ios.deployment_target='8.0'
 s.osx.deployment_target='10.11'
 s.tvos.deployment_target='10.0'
+s.watchos.deployment_target='6.0'
 
 s.cocoapods_version='>= 1.4.0'
 s.static_framework=true
@@ -43,6 +44,7 @@ Firebase Core includes FIRApp and FIROptions which provide central configuration
 'OTHER_CFLAGS'=>'-fno-autolink'
 }
 s.test_spec'unit'do |unit_tests|
+unit_tests.platforms={:ios=>'8.0',:osx=>'10.11',:tvos=>'10.0'}
 unit_tests.source_files='Example/Core/Tests/**/*.[mh]'
 unit_tests.requires_app_host=true
 unit_tests.dependency'OCMock'

FirebaseCoreDiagnostics.podspec

@@ -21,6 +21,7 @@ non-Cocoapod integration. This library also respects the Firebase global data co
 s.ios.deployment_target='8.0'
 s.osx.deployment_target='10.11'
 s.tvos.deployment_target='10.0'
+s.watchos.deployment_target='6.0'
 
 s.cocoapods_version='>= 1.4.0'
 s.static_framework=true
@@ -51,6 +52,7 @@ non-Cocoapod integration. This library also respects the Firebase global data co
 s.dependency'nanopb','~> 0.3.901'
 
 s.test_spec'unit'do |unit_tests|
+unit_tests.platforms={:ios=>'8.0',:osx=>'10.11',:tvos=>'10.0'}
 unit_tests.dependency'GoogleUtilities/UserDefaults','~> 6.2'
 unit_tests.dependency'OCMock'
 unit_tests.source_files='Example/CoreDiagnostics/Tests/**/*.[mh]'

FirebaseCoreDiagnosticsInterop.podspec

@@ -24,6 +24,7 @@ Pod::Spec.new do |s|
 s.ios.deployment_target='8.0'
 s.osx.deployment_target='10.11'
 s.tvos.deployment_target='10.0'
+s.watchos.deployment_target='6.0'
 s.source_files='Interop/CoreDiagnostics/**/*.h'
 s.public_header_files='Interop/CoreDiagnostics/Public/*.h'
 end

FirebaseInstallations.podspec

@@ -19,6 +19,7 @@ Pod::Spec.new do |s|
 s.ios.deployment_target='8.0'
 s.osx.deployment_target='10.11'
 s.tvos.deployment_target='10.0'
+s.watchos.deployment_target='6.0'
 
 s.cocoapods_version='>= 1.4.0'
 s.static_framework=true
@@ -54,6 +55,7 @@ Pod::Spec.new do |s|
 end
 
 s.test_spec'integration'do |int_tests|
+int_tests.platforms={:ios=>'8.0',:osx=>'10.11',:tvos=>'10.0'}
 int_tests.source_files=base_dir + 'Tests/Integration/**/*.[mh]'
 int_tests.resources=base_dir + 'Tests/Resources/**/*'
 ifENV['FIS_INTEGRATION_TESTS_REQUIRED'] && ENV['FIS_INTEGRATION_TESTS_REQUIRED'] == '1'then

FirebaseInstallations/Source/Library/IIDMigration/FIRInstallationsIIDTokenStore.m

@@ -83,7 +83,10 @@ - (instancetype)initWithGCMSenderID:(NSString *)GCMSenderID {
  unarchiver = [[NSKeyedUnarchiveralloc] initForReadingFromData:data error:&archiverError];
  } else {
 @try {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
  unarchiver = [[NSKeyedUnarchiveralloc] initForReadingWithData:data];
+#pragma clang diagnostic pop
  } @catch (NSException *exception) {
  archiverError = [FIRInstallationsErrorUtil keyedArchiverErrorWithException:exception];
  }

FirebaseInstallations/Source/Library/SecureStorage/FIRSecureStorage.m

@@ -203,7 +203,10 @@ - (nullable NSData *)archiveDataForObject:(id<NSSecureCoding>)object error:(NSEr
  } else {
 @try {
 NSMutableData *data = [NSMutableDatadata];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
 NSKeyedArchiver *archiver = [[NSKeyedArchiveralloc] initForWritingWithMutableData:data];
+#pragma clang diagnostic pop
  archiver.requiresSecureCoding = YES;
 
  [archiver encodeObject:object forKey:NSKeyedArchiveRootObjectKey];
@@ -232,7 +235,10 @@ - (nullable id)unarchivedObjectOfClass:(Class)class
  }
  } else {
 @try {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
 NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiveralloc] initForReadingWithData:data];
+#pragma clang diagnostic pop
  unarchiver.requiresSecureCoding = YES;
 
  object = [unarchiver decodeObjectOfClass:class forKey:NSKeyedArchiveRootObjectKey];