Make the URLs used by Google Data Transport available in a Public API. (#7167)

Author: visumickey

FirebasePerformance.podspec

@@ -28,6 +28,7 @@ Firebase Performance library to measure performance of Mobile and Web Apps.
     base_dir + 'ProtoSupport/**/*.[mh]',
     'FirebaseCore/Sources/Private/*.h',
     'FirebaseRemoteConfig/Sources/Private/*.h',
+    'GoogleDataTransport/GDTCORLibrary/Internal/*.h',
     'GoogleUtilities/ISASwizzler/Private/*.h',
     'GoogleUtilities/MethodSwizzler/Private/*.h',
     'GoogleUtilities/Environment/Private/*.h',
@@ -58,7 +59,7 @@ Firebase Performance library to measure performance of Mobile and Web Apps.
   s.dependency 'FirebaseCore', '~> 7.0'
   s.dependency 'FirebaseInstallations', '~> 7.0'
   s.dependency 'FirebaseRemoteConfig', '~> 7.0'
-  s.dependency 'GoogleDataTransport', '~> 8.1'
+  s.dependency 'GoogleDataTransport', '~> 8.2'
   s.dependency 'GTMSessionFetcher/Core', '~> 1.1'
   s.dependency 'GoogleToolboxForMac/Logger', '~> 2.1'
   s.dependency 'GoogleUtilities/Environment', '~> 7.0'

FirebasePerformance/Sources/FPRURLFilter.m

@@ -17,7 +17,7 @@
 
 #import "FirebasePerformance/Sources/FPRConsoleLogger.h"
 
-#import "GoogleDataTransport/GDTCCTLibrary/Private/GDTCCTUploader.h"
+#import "GoogleDataTransport/GDTCORLibrary/Internal/GoogleDataTransportInternal.h"
 
 /** The expected key of the domain allowlist array. */
 static NSString *const kFPRAllowlistDomainsKey = @"FPRWhitelistedDomains";
@@ -44,9 +44,9 @@ typedef NS_ENUM(NSInteger, FPRURLAllowlistStatus) {
   static NSSet *denylist = nil;
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
-    NSDictionary<NSNumber *, NSURL *> *URLs = [GDTCCTUploader uploadURLs];
     denylist = [[NSSet alloc] initWithArray:@[
-      URLs[@(kGDTCORTargetCCT)].absoluteString, URLs[@(kGDTCORTargetFLL)].absoluteString
+      [[GDTCOREndpoints uploadURLForTarget:kGDTCORTargetCCT] absoluteString],
+      [[GDTCOREndpoints uploadURLForTarget:kGDTCORTargetFLL] absoluteString]
     ]];
   });
   return denylist;

FirebasePerformance/Tests/Unit/FPRURLFilterTests.m

@@ -19,7 +19,7 @@
 
 #import "FirebasePerformance/Tests/Unit/Fakes/NSBundleFake.h"
 
-#import "GoogleDataTransport/GDTCCTLibrary/Private/GDTCCTUploader.h"
+#import "GoogleDataTransport/GDTCORLibrary/Internal/GoogleDataTransportInternal.h"
 
 @interface FPRURLFilterTest : XCTestCase
 
@@ -39,16 +39,14 @@ - (void)testClearcutURLAllowed {
 
 /** Tests that the Clearcut upload URL is denied. */
 - (void)testFllClearcutURLDenied {
-  NSDictionary<NSNumber *, NSURL *> *uploadURLs = [GDTCCTUploader uploadURLs];
   XCTAssertFalse([[FPRURLFilter sharedInstance]
-      shouldInstrumentURL:uploadURLs[@(kGDTCORTargetCCT)].absoluteString]);
+      shouldInstrumentURL:[GDTCOREndpoints uploadURLForTarget:kGDTCORTargetCCT].absoluteString]);
 }
 
 /** Tests that the FLL upload URL is denied. */
 - (void)testFllServiceURLDenied {
-  NSDictionary<NSNumber *, NSURL *> *uploadURLs = [GDTCCTUploader uploadURLs];
   XCTAssertFalse([[FPRURLFilter sharedInstance]
-      shouldInstrumentURL:uploadURLs[@(kGDTCORTargetFLL)].absoluteString]);
+      shouldInstrumentURL:[GDTCOREndpoints uploadURLForTarget:kGDTCORTargetFLL].absoluteString]);
 }
 
 /** Tests shouldInstrument when the plist file is not being used. */

GoogleDataTransport.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'GoogleDataTransport'
-  s.version          = '8.1.0'
+  s.version          = '8.2.0'
   s.summary          = 'Google iOS SDK data transport.'
 
   s.description      = <<-DESC

GoogleDataTransport/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v8.2.0
+- Expose upload URLs as a public API for Firebase Performance to use for denying instrumentation those URLs.
+
 # v8.1.0
 - Expose upload URLs which FirebasePerformance will depend upon.
 - Fix out-of-memory crash for a big amount of pending events. (#6995)

GoogleDataTransport/GDTCCTLibrary/GDTCCTUploader.m

@@ -20,6 +20,7 @@
 #import "GoogleDataTransport/GDTCORLibrary/Internal/GDTCORRegistrar.h"
 #import "GoogleDataTransport/GDTCORLibrary/Internal/GDTCORStorageProtocol.h"
 #import "GoogleDataTransport/GDTCORLibrary/Public/GoogleDataTransport/GDTCORConsoleLogger.h"
+#import "GoogleDataTransport/GDTCORLibrary/Public/GoogleDataTransport/GDTCOREndpoints.h"
 #import "GoogleDataTransport/GDTCORLibrary/Public/GoogleDataTransport/GDTCOREvent.h"
 
 #import <nanopb/pb.h>
@@ -50,9 +51,6 @@
 /** */
 static NSString *const kLibraryDataFLLNextUploadTimeKey = @"GDTCCTUploaderFLLNextUploadTimeKey";
 
-static NSString *const kINTServerURL =
-    @"https://dummyapiverylong-dummy.dummy.com/dummy/api/very/long";
-
 #if !NDEBUG
 NSNotificationName const GDTCCTUploadCompleteNotification = @"com.GDTCCTUploader.UploadComplete";
 #endif  // #if !NDEBUG
@@ -108,78 +106,14 @@ + (NSURL *_Nullable)testServerURL {
   return _testServerURL;
 }
 
-+ (NSDictionary<NSNumber *, NSURL *> *)uploadURLs {
-  // These strings should be interleaved to construct the real URL. This is just to (hopefully)
-  // fool github URL scanning bots.
-  static NSURL *CCTServerURL;
-  static dispatch_once_t CCTOnceToken;
-  dispatch_once(&CCTOnceToken, ^{
-    const char *p1 = "hts/frbslgiggolai.o/0clgbth";
-    const char *p2 = "tp:/ieaeogn.ogepscmvc/o/ac";
-    const char URL[54] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
-                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
-                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
-                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
-                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
-                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], '\0'};
-    CCTServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
-  });
-
-  static NSURL *FLLServerURL;
-  static dispatch_once_t FLLOnceToken;
-  dispatch_once(&FLLOnceToken, ^{
-    const char *p1 = "hts/frbslgigp.ogepscmv/ieo/eaybtho";
-    const char *p2 = "tp:/ieaeogn-agolai.o/1frlglgc/aclg";
-    const char URL[69] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
-                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
-                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
-                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
-                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
-                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], p2[26],
-                          p1[27], p2[27], p1[28], p2[28], p1[29], p2[29], p1[30], p2[30], p1[31],
-                          p2[31], p1[32], p2[32], p1[33], p2[33], '\0'};
-    FLLServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
-  });
-
-  static NSURL *CSHServerURL;
-  static dispatch_once_t CSHOnceToken;
-  dispatch_once(&CSHOnceToken, ^{
-    // These strings should be interleaved to construct the real URL. This is just to (hopefully)
-    // fool github URL scanning bots.
-    const char *p1 = "hts/cahyiseot-agolai.o/1frlglgc/aclg";
-    const char *p2 = "tp:/rsltcrprsp.ogepscmv/ieo/eaybtho";
-    const char URL[72] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
-                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
-                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
-                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
-                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
-                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], p2[26],
-                          p1[27], p2[27], p1[28], p2[28], p1[29], p2[29], p1[30], p2[30], p1[31],
-                          p2[31], p1[32], p2[32], p1[33], p2[33], p1[34], p2[34], p1[35], '\0'};
-    CSHServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
-  });
-  static NSDictionary<NSNumber *, NSURL *> *uploadURLs;
-  static dispatch_once_t URLOnceToken;
-  dispatch_once(&URLOnceToken, ^{
-    uploadURLs = @{
-      @(kGDTCORTargetCCT) : CCTServerURL,
-      @(kGDTCORTargetFLL) : FLLServerURL,
-      @(kGDTCORTargetCSH) : CSHServerURL,
-      @(kGDTCORTargetINT) : [NSURL URLWithString:kINTServerURL]
-    };
-  });
-  return uploadURLs;
-}
-
 + (nullable NSURL *)serverURLForTarget:(GDTCORTarget)target {
 #if !NDEBUG
   if (_testServerURL) {
     return _testServerURL;
   }
 #endif  // !NDEBUG
 
-  NSDictionary<NSNumber *, NSURL *> *uploadURLs = [self uploadURLs];
-  return uploadURLs[@(target)];
+  return [GDTCOREndpoints uploadURLForTarget:target];
 }
 
 - (instancetype)init {

GoogleDataTransport/GDTCCTLibrary/Private/GDTCCTUploader.h

@@ -28,10 +28,6 @@ extern NSNotificationName const GDTCCTUploadCompleteNotification;
 /** Class capable of uploading events to the CCT backend. */
 @interface GDTCCTUploader : NSObject <GDTCORUploader>
 
-/** Returns the server URL for target.*/
-// TODO: create a separate public header (e.g. GDTCCTUploadURL.h) to make it a public API.
-+ (NSDictionary<NSNumber *, NSURL *> *)uploadURLs;
-
 /** The queue on which all CCT uploading will occur. */
 @property(nonatomic, readonly) dispatch_queue_t uploaderQueue;
 

GoogleDataTransport/GDTCCTTests/Unit/GDTCCTUploaderTest.m

@@ -73,17 +73,6 @@ - (void)tearDown {
 
 #pragma mark - Upload flow tests
 
-- (void)testUploadURLsAreCorrect {
-  GDTCCTUploader.testServerURL = nil;
-  NSDictionary<NSNumber *, NSURL *> *URLs = GDTCCTUploader.uploadURLs;
-  XCTAssertEqualObjects(URLs[@(kGDTCORTargetCCT)], [self serverURLForTarget:kGDTCORTargetCCT]);
-  XCTAssertEqualObjects(URLs[@(kGDTCORTargetFLL)], [self serverURLForTarget:kGDTCORTargetFLL]);
-  XCTAssertEqualObjects(URLs[@(kGDTCORTargetCSH)], [self serverURLForTarget:kGDTCORTargetCSH]);
-  XCTAssertEqualObjects(URLs[@(kGDTCORTargetINT)], [self serverURLForTarget:kGDTCORTargetINT]);
-  GDTCCTUploader.testServerURL =
-      [self.testServer.serverURL URLByAppendingPathComponent:@"logBatch"];
-}
-
 - (void)testUploadTargetWhenThereAreEventsToUpload {
   // 0. Generate test events.
   id<GDTCORStorageProtocol> storage = GDTCORStorageInstanceForTarget(kGDTCORTargetTest);

GoogleDataTransport/GDTCORLibrary/GDTCOREndpoints.m

@@ -0,0 +1,92 @@
+/*
+ * 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 "GoogleDataTransport/GDTCORLibrary/Public/GoogleDataTransport/GDTCOREndpoints.h"
+
+static NSString *const kINTServerURL =
+    @"https://dummyapiverylong-dummy.dummy.com/dummy/api/very/long";
+
+@implementation GDTCOREndpoints
+
++ (NSDictionary<NSNumber *, NSURL *> *)uploadURLs {
+  // These strings should be interleaved to construct the real URL. This is just to (hopefully)
+  // fool github URL scanning bots.
+  static NSURL *CCTServerURL;
+  static dispatch_once_t CCTOnceToken;
+  dispatch_once(&CCTOnceToken, ^{
+    const char *p1 = "hts/frbslgiggolai.o/0clgbth";
+    const char *p2 = "tp:/ieaeogn.ogepscmvc/o/ac";
+    const char URL[54] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
+                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
+                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
+                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
+                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
+                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], '\0'};
+    CCTServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
+  });
+
+  static NSURL *FLLServerURL;
+  static dispatch_once_t FLLOnceToken;
+  dispatch_once(&FLLOnceToken, ^{
+    const char *p1 = "hts/frbslgigp.ogepscmv/ieo/eaybtho";
+    const char *p2 = "tp:/ieaeogn-agolai.o/1frlglgc/aclg";
+    const char URL[69] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
+                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
+                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
+                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
+                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
+                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], p2[26],
+                          p1[27], p2[27], p1[28], p2[28], p1[29], p2[29], p1[30], p2[30], p1[31],
+                          p2[31], p1[32], p2[32], p1[33], p2[33], '\0'};
+    FLLServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
+  });
+
+  static NSURL *CSHServerURL;
+  static dispatch_once_t CSHOnceToken;
+  dispatch_once(&CSHOnceToken, ^{
+    // These strings should be interleaved to construct the real URL. This is just to (hopefully)
+    // fool github URL scanning bots.
+    const char *p1 = "hts/cahyiseot-agolai.o/1frlglgc/aclg";
+    const char *p2 = "tp:/rsltcrprsp.ogepscmv/ieo/eaybtho";
+    const char URL[72] = {p1[0],  p2[0],  p1[1],  p2[1],  p1[2],  p2[2],  p1[3],  p2[3],  p1[4],
+                          p2[4],  p1[5],  p2[5],  p1[6],  p2[6],  p1[7],  p2[7],  p1[8],  p2[8],
+                          p1[9],  p2[9],  p1[10], p2[10], p1[11], p2[11], p1[12], p2[12], p1[13],
+                          p2[13], p1[14], p2[14], p1[15], p2[15], p1[16], p2[16], p1[17], p2[17],
+                          p1[18], p2[18], p1[19], p2[19], p1[20], p2[20], p1[21], p2[21], p1[22],
+                          p2[22], p1[23], p2[23], p1[24], p2[24], p1[25], p2[25], p1[26], p2[26],
+                          p1[27], p2[27], p1[28], p2[28], p1[29], p2[29], p1[30], p2[30], p1[31],
+                          p2[31], p1[32], p2[32], p1[33], p2[33], p1[34], p2[34], p1[35], '\0'};
+    CSHServerURL = [NSURL URLWithString:[NSString stringWithUTF8String:URL]];
+  });
+  static NSDictionary<NSNumber *, NSURL *> *uploadURLs;
+  static dispatch_once_t URLOnceToken;
+  dispatch_once(&URLOnceToken, ^{
+    uploadURLs = @{
+      @(kGDTCORTargetCCT) : CCTServerURL,
+      @(kGDTCORTargetFLL) : FLLServerURL,
+      @(kGDTCORTargetCSH) : CSHServerURL,
+      @(kGDTCORTargetINT) : [NSURL URLWithString:kINTServerURL]
+    };
+  });
+  return uploadURLs;
+}
+
++ (nullable NSURL *)uploadURLForTarget:(GDTCORTarget)target {
+  NSDictionary<NSNumber *, NSURL *> *URLs = [self uploadURLs];
+  return [URLs objectForKey:@(target)];
+}
+
+@end

GoogleDataTransport/GDTCORLibrary/Private/GDTCOREndpoints_Private.h

@@ -0,0 +1,27 @@
+/*
+ * 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 "GoogleDataTransport/GDTCORLibrary/Public/GoogleDataTransport/GDTCOREndpoints.h"
+
+@interface GDTCOREndpoints ()
+
+/** Returns the list of all the upload URLs used by the transport library.
+ *
+ *  @return Map of the transport target and the URL used for uploading the events for that target.
+ */
++ (NSDictionary<NSNumber *, NSURL *> *)uploadURLs;
+
+@end