Expose upload URLs so that perf can stop instrumenting these URLs. (#7064)

jeremyjiang-dev · web-flow · commit 781c8b842e61 · 2020-12-02T09:08:02.000-05:00
* Expose upload URLs.

* Remove code duplication.

* Fix style.

* Make url dictionary local static and dispatch once.

* Fix style.

* Add a local dictionary and return value from it.

* Update CHANGELOG.md

* Update CHANGELOG.md
diff --git a/GoogleDataTransport/CHANGELOG.md b/GoogleDataTransport/CHANGELOG.md
@@ -1,4 +1,5 @@
-# v8.0.2
+# Unreleased (v8.1.0)
+- Expose upload URLs which FirebasePerformance will depend upon.
 - Fix out-of-memory crash for a big amount of pending events. (#6995)
 
 # v8.0.1
diff --git a/GoogleDataTransport/GDTCCTLibrary/GDTCCTUploader.m b/GoogleDataTransport/GDTCCTLibrary/GDTCCTUploader.m
@@ -81,6 +81,7 @@ @interface GDTCCTUploader () <NSURLSessionDelegate>
 @implementation GDTCCTUploader
 
 @synthesize uploaderSession = _uploaderSession;
+static NSURL *_testServerURL = nil;
 
 + (void)load {
   GDTCCTUploader *uploader = [GDTCCTUploader sharedInstance];
@@ -99,28 +100,15 @@ + (instancetype)sharedInstance {
   return sharedInstance;
 }
 
-- (instancetype)init {
-  self = [super init];
-  if (self) {
-    _uploaderQueue = dispatch_queue_create("com.google.GDTCCTUploader", DISPATCH_QUEUE_SERIAL);
-  }
-  return self;
++ (void)setTestServerURL:(NSURL *_Nullable)serverURL {
+  _testServerURL = serverURL;
 }
 
-- (NSURLSession *)uploaderSession {
-  if (_uploaderSession == nil) {
-    NSURLSessionConfiguration *config = [NSURLSessionConfiguration ephemeralSessionConfiguration];
-    _uploaderSession = [NSURLSession sessionWithConfiguration:config
-                                                     delegate:self
-                                                delegateQueue:nil];
-  }
-  return _uploaderSession;
++ (NSURL *_Nullable)testServerURL {
+  return _testServerURL;
 }
 
-/**
- *
- */
-- (nullable NSURL *)serverURLForTarget:(GDTCORTarget)target {
++ (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;
@@ -170,31 +158,46 @@ - (nullable NSURL *)serverURLForTarget:(GDTCORTarget)target {
                           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
 
-  switch (target) {
-    case kGDTCORTargetCCT:
-      return CCTServerURL;
-
-    case kGDTCORTargetFLL:
-      return FLLServerURL;
-
-    case kGDTCORTargetCSH:
-      return CSHServerURL;
+  NSDictionary<NSNumber *, NSURL *> *uploadURLs = [self uploadURLs];
+  return uploadURLs[@(target)];
+}
 
-    case kGDTCORTargetINT:
-      return [NSURL URLWithString:kINTServerURL];
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    _uploaderQueue = dispatch_queue_create("com.google.GDTCCTUploader", DISPATCH_QUEUE_SERIAL);
+  }
+  return self;
+}
 
-    default:
-      GDTCORLogDebug(@"GDTCCTUploader doesn't support target %ld", (long)target);
-      return nil;
-      break;
+- (NSURLSession *)uploaderSession {
+  if (_uploaderSession == nil) {
+    NSURLSessionConfiguration *config = [NSURLSessionConfiguration ephemeralSessionConfiguration];
+    _uploaderSession = [NSURLSession sessionWithConfiguration:config
+                                                     delegate:self
+                                                delegateQueue:nil];
   }
+  return _uploaderSession;
 }
 
 - (NSString *)FLLAndCSHandINTAPIKey {
@@ -597,7 +600,7 @@ - (nullable NSURLRequest *)constructRequestForTarget:(GDTCORTarget)target data:(
     GDTCORLogDebug(@"There was no data to construct a request for target %ld.", (long)target);
     return nil;
   }
-  NSURL *URL = [self serverURLForTarget:target];
+  NSURL *URL = [[self class] serverURLForTarget:target];
   NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
   NSString *targetString;
   switch (target) {
@@ -709,7 +712,7 @@ - (void)URLSession:(NSURLSession *)session
     return;
   }
   if (response.statusCode == 302 || response.statusCode == 301) {
-    if ([request.URL isEqual:[self serverURLForTarget:kGDTCORTargetFLL]]) {
+    if ([request.URL isEqual:[[self class] serverURLForTarget:kGDTCORTargetFLL]]) {
       NSURLRequest *newRequest = [self constructRequestForTarget:kGDTCORTargetCCT
                                                             data:task.originalRequest.HTTPBody];
       completionHandler(newRequest);
diff --git a/GoogleDataTransport/GDTCCTLibrary/Private/GDTCCTUploader.h b/GoogleDataTransport/GDTCCTLibrary/Private/GDTCCTUploader.h
@@ -28,6 +28,10 @@ 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;
 
@@ -45,7 +49,7 @@ extern NSNotificationName const GDTCCTUploadCompleteNotification;
 
 #if !NDEBUG
 /** An upload URL used across all targets. For testing only. */
-@property(nullable, nonatomic) NSURL *testServerURL;
+@property(class, nullable, nonatomic) NSURL *testServerURL;
 
 #endif  // !NDEBUG
 
diff --git a/GoogleDataTransport/GDTCCTTests/Unit/GDTCCTUploaderTest.m b/GoogleDataTransport/GDTCCTTests/Unit/GDTCCTUploaderTest.m
@@ -60,7 +60,8 @@ - (void)setUp {
   XCTAssertTrue(self.testServer.isRunning);
 
   self.uploader = [[GDTCCTUploader alloc] init];
-  self.uploader.testServerURL = [self.testServer.serverURL URLByAppendingPathComponent:@"logBatch"];
+  GDTCCTUploader.testServerURL =
+      [self.testServer.serverURL URLByAppendingPathComponent:@"logBatch"];
 }
 
 - (void)tearDown {
@@ -72,6 +73,17 @@ - (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);
@@ -283,7 +295,8 @@ - (void)testUploadTarget_WhenThereAreBothStoredBatchAndEvents_ThenRemoveBatchAnd
 }
 
 - (void)testUploadTarget_WhenThereAreNoEventsFirstThenEventsAdded_ThenUploadNewEvent {
-  self.uploader.testServerURL = [self.testServer.serverURL URLByAppendingPathComponent:@"logBatch"];
+  GDTCCTUploader.testServerURL =
+      [self.testServer.serverURL URLByAppendingPathComponent:@"logBatch"];
 
   // 1. Test stored batch upload.
   // 1.1. Set up expectations.
@@ -710,4 +723,76 @@ - (void)assertUploadTargetRespectsNextRequestWaitTime:(NSTimeInterval)nextReques
   [self waitForUploadOperationsToFinish:self.uploader];
 }
 
+- (nullable NSURL *)serverURLForTarget:(GDTCORTarget)target {
+  // These strings should be interleaved to construct the real URL. This is just to (hopefully)
+  // fool github URL scanning bots.
+  static NSURL *CCTServerURL;
+  static NSString *const kINTServerURL =
+      @"https://dummyapiverylong-dummy.dummy.com/dummy/api/very/long";
+  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]];
+  });
+
+  switch (target) {
+    case kGDTCORTargetCCT:
+      return CCTServerURL;
+
+    case kGDTCORTargetFLL:
+      return FLLServerURL;
+
+    case kGDTCORTargetCSH:
+      return CSHServerURL;
+
+    case kGDTCORTargetINT:
+      return [NSURL URLWithString:kINTServerURL];
+
+    default:
+      return nil;
+      break;
+  }
+}
+
 @end
