Allow Bundle IDs that have a valid prefix - strict validation (#2515)

Allow Bundle IDs that have a valid prefix - strict validation

Author: maksymmalyhin

Example/Core/Tests/FIRBundleUtilTest.m

@@ -15,6 +15,7 @@
 #import "FIRTestCase.h"
 
 #import <FirebaseCore/FIRBundleUtil.h>
+#import <GoogleUtilities/GULAppEnvironmentUtil.h>
 
 static NSString *const kResultPath = @"resultPath";
 static NSString *const kResourceName = @"resourceName";
@@ -69,16 +70,53 @@ - (void)testFindOptionsDictionaryPath_secondBundle {
 - (void)testBundleIdentifierExistsInBundles {
   NSString *bundleID = @"com.google.test";
   [OCMStub([self.mockBundle bundleIdentifier]) andReturn:bundleID];
-  XCTAssertTrue([FIRBundleUtil hasBundleIdentifier:bundleID inBundles:@[ self.mockBundle ]]);
+  XCTAssertTrue([FIRBundleUtil hasBundleIdentifierPrefix:bundleID inBundles:@[ self.mockBundle ]]);
 }
 
 - (void)testBundleIdentifierExistsInBundles_notExist {
   [OCMStub([self.mockBundle bundleIdentifier]) andReturn:@"com.google.test"];
-  XCTAssertFalse([FIRBundleUtil hasBundleIdentifier:@"not-exist" inBundles:@[ self.mockBundle ]]);
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"not-exist"
+                                                inBundles:@[ self.mockBundle ]]);
 }
 
 - (void)testBundleIdentifierExistsInBundles_emptyBundlesArray {
-  XCTAssertFalse([FIRBundleUtil hasBundleIdentifier:@"com.google.test" inBundles:@[]]);
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.test" inBundles:@[]]);
+}
+
+- (void)testBundleIdentifierHasPrefixInBundlesForExtension {
+  id environmentUtilsMock = [OCMockObject mockForClass:[GULAppEnvironmentUtil class]];
+  [[[environmentUtilsMock stub] andReturnValue:@(YES)] isAppExtension];
+
+  [OCMStub([self.mockBundle bundleIdentifier]) andReturn:@"com.google.test"];
+  XCTAssertTrue([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.test.someextension"
+                                               inBundles:@[ self.mockBundle ]]);
+
+  [environmentUtilsMock stopMocking];
+}
+
+- (void)testBundleIdentifierHasPrefixInBundlesNotValidExtension {
+  id environmentUtilsMock = [OCMockObject mockForClass:[GULAppEnvironmentUtil class]];
+  [[[environmentUtilsMock stub] andReturnValue:@(YES)] isAppExtension];
+
+  [OCMStub([self.mockBundle bundleIdentifier]) andReturn:@"com.google.test"];
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.test.someextension.some"
+                                                inBundles:@[ self.mockBundle ]]);
+
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.testsomeextension"
+                                                inBundles:@[ self.mockBundle ]]);
+
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.testsomeextension.some"
+                                                inBundles:@[ self.mockBundle ]]);
+
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"not-exist"
+                                                inBundles:@[ self.mockBundle ]]);
+
+  // Should be NO, since if @"com.google.tests" is an app extension identifier, then the app bundle
+  // identifier is @"com.google"
+  XCTAssertFalse([FIRBundleUtil hasBundleIdentifierPrefix:@"com.google.tests"
+                                                inBundles:@[ self.mockBundle ]]);
+
+  [environmentUtilsMock stopMocking];
 }
 
 @end

Firebase/Core/FIRApp.m

@@ -525,8 +525,8 @@ - (void)checkExpectedBundleID {
   NSString *expectedBundleID = [self expectedBundleID];
   // The checking is only done when the bundle ID is provided in the serviceInfo dictionary for
   // backward compatibility.
-  if (expectedBundleID != nil && ![FIRBundleUtil hasBundleIdentifier:expectedBundleID
-                                                           inBundles:bundles]) {
+  if (expectedBundleID != nil && ![FIRBundleUtil hasBundleIdentifierPrefix:expectedBundleID
+                                                                 inBundles:bundles]) {
     FIRLogError(kFIRLoggerCore, @"I-COR000008",
                 @"The project's Bundle ID is inconsistent with "
                 @"either the Bundle ID in '%@.%@', or the Bundle ID in the options if you are "

Firebase/Core/FIRBundleUtil.m

@@ -14,6 +14,8 @@
 
 #import "Private/FIRBundleUtil.h"
 
+#import <GoogleUtilities/GULAppEnvironmentUtil.h>
+
 @implementation FIRBundleUtil
 
 + (NSArray *)relevantBundles {
@@ -45,13 +47,29 @@ + (NSArray *)relevantURLSchemes {
   return result;
 }
 
-+ (BOOL)hasBundleIdentifier:(NSString *)bundleIdentifier inBundles:(NSArray *)bundles {
++ (BOOL)hasBundleIdentifierPrefix:(NSString *)bundleIdentifier inBundles:(NSArray *)bundles {
   for (NSBundle *bundle in bundles) {
-    if ([bundle.bundleIdentifier isEqualToString:bundleIdentifier]) {
+    // This allows app extensions that have the app's bundle as their prefix to pass this test.
+    NSString *applicationBundleIdentifier =
+        [GULAppEnvironmentUtil isAppExtension]
+            ? [self bundleIdentifierByRemovingLastPartFrom:bundleIdentifier]
+            : bundleIdentifier;
+
+    if ([applicationBundleIdentifier isEqualToString:bundle.bundleIdentifier]) {
       return YES;
     }
   }
   return NO;
 }
 
++ (NSString *)bundleIdentifierByRemovingLastPartFrom:(NSString *)bundleIdentifier {
+  NSString *bundleIDComponentsSeparator = @".";
+
+  NSMutableArray<NSString *> *bundleIDComponents =
+      [[bundleIdentifier componentsSeparatedByString:bundleIDComponentsSeparator] mutableCopy];
+  [bundleIDComponents removeLastObject];
+
+  return [bundleIDComponents componentsJoinedByString:bundleIDComponentsSeparator];
+}
+
 @end

Firebase/Core/Private/FIRBundleUtil.h

@@ -45,8 +45,9 @@
 + (NSArray *)relevantURLSchemes;
 
 /**
- * Checks if the bundle identifier exists in the given bundles.
+ * Checks if any of the given bundles have a matching bundle identifier prefix (removing extension
+ * suffixes).
  */
-+ (BOOL)hasBundleIdentifier:(NSString *)bundleIdentifier inBundles:(NSArray *)bundles;
++ (BOOL)hasBundleIdentifierPrefix:(NSString *)bundleIdentifier inBundles:(NSArray *)bundles;
 
 @end

FirebaseCore.podspec

@@ -28,6 +28,7 @@ Firebase Core includes FIRApp and FIROptions which provide central configuration
   s.public_header_files = 'Firebase/Core/Public/*.h', 'Firebase/Core/Private/*.h'
   s.private_header_files = 'Firebase/Core/Private/*.h'
   s.framework = 'Foundation'
+  s.dependency 'GoogleUtilities/Environment', '~> 5.2'
   s.dependency 'GoogleUtilities/Logger', '~> 5.2'
   s.pod_target_xcconfig = {
     'GCC_C_LANGUAGE_STANDARD' => 'c99',