Add useEmulator() to Storage (#7379)

Author: schmidt-sebastian

FirebaseStorage/CHANGELOG.md

@@ -1,4 +1,6 @@
 # 8.0.0
+- [added] Added `FirebaseStorage.useEmulator()`, which allows the Storage SDK to
+  connect to the Cloud Storage for Firebase emulator.
 - [added] Added abuse reduction features. (#7928)
 
 # 7.4.0

FirebaseStorage/Sources/FIRStorage.m

@@ -84,6 +84,7 @@ + (GTMSessionFetcherService *)fetcherServiceForApp:(FIRApp *)app
       fetcherService = [[GTMSessionFetcherService alloc] init];
       [fetcherService setRetryEnabled:YES];
       [fetcherService setRetryBlock:_retryWhenOffline];
+      [fetcherService setAllowLocalhostRequest:YES];
       FIRStorageTokenAuthorizer *authorizer =
           [[FIRStorageTokenAuthorizer alloc] initWithGoogleAppID:app.options.googleAppID
                                                   fetcherService:fetcherService
@@ -160,11 +161,11 @@ - (instancetype)initWithApp:(FIRApp *)app
     _auth = auth;
     _appCheck = appCheck;
     _storageBucket = bucket;
+    _host = kFIRStorageHost;
+    _scheme = kFIRStorageScheme;
+    _port = @(kFIRStoragePort);
+    _fetcherServiceForApp = nil;  // Configured in `ensureConfigured()`
     _dispatchQueue = dispatch_queue_create("com.google.firebase.storage", DISPATCH_QUEUE_SERIAL);
-    _fetcherServiceForApp = [FIRStorage fetcherServiceForApp:_app
-                                                      bucket:bucket
-                                                        auth:auth
-                                                    appCheck:appCheck];
     _maxDownloadRetryTime = 600.0;
     _maxDownloadRetryInterval =
         [FIRStorageUtils computeRetryIntervalFromRetryTime:_maxDownloadRetryTime];
@@ -271,11 +272,15 @@ - (NSTimeInterval)maxOperationRetryTime {
 #pragma mark - Public methods
 
 - (FIRStorageReference *)reference {
+  [self ensureConfigured];
+
   FIRStoragePath *path = [[FIRStoragePath alloc] initWithBucket:_storageBucket object:nil];
   return [[FIRStorageReference alloc] initWithStorage:self path:path];
 }
 
 - (FIRStorageReference *)referenceForURL:(NSString *)string {
+  [self ensureConfigured];
+
   FIRStoragePath *path = [FIRStoragePath pathFromString:string];
 
   // If no default bucket exists (empty string), accept anything.
@@ -302,13 +307,37 @@ - (FIRStorageReference *)referenceWithPath:(NSString *)string {
 }
 
 - (dispatch_queue_t)callbackQueue {
+  [self ensureConfigured];
   return _fetcherServiceForApp.callbackQueue;
 }
 
 - (void)setCallbackQueue:(dispatch_queue_t)callbackQueue {
+  [self ensureConfigured];
   _fetcherServiceForApp.callbackQueue = callbackQueue;
 }
 
+- (void)useEmulatorWithHost:(NSString *)host port:(NSInteger)port {
+  if (host.length == 0) {
+    [NSException raise:NSInvalidArgumentException format:@"Cannot connect to nil or empty host."];
+  }
+
+  if (port < 0) {
+    [NSException raise:NSInvalidArgumentException
+                format:@"Port must be greater than or equal to zero."];
+  }
+
+  if (_fetcherServiceForApp != nil) {
+    [NSException raise:NSInternalInconsistencyException
+                format:@"Cannot connect to emulator after Storage SDK initialization. "
+                       @"Call useEmulator(host:port:) before creating a Storage "
+                       @"reference or trying to load data."];
+  }
+
+  _scheme = @"http";
+  _host = host;
+  _port = @(port);
+}
+
 #pragma mark - Background tasks
 
 + (void)enableBackgroundTasks:(BOOL)isEnabled {
@@ -325,4 +354,13 @@ + (void)enableBackgroundTasks:(BOOL)isEnabled {
   return nil;
 }
 
+- (void)ensureConfigured {
+  if (!_fetcherServiceForApp) {
+    _fetcherServiceForApp = [FIRStorage fetcherServiceForApp:_app
+                                                      bucket:_storageBucket
+                                                        auth:_auth
+                                                    appCheck:_appCheck];
+  }
+}
+
 @end

FirebaseStorage/Sources/FIRStorageConstants.m

@@ -25,6 +25,7 @@
 
 NSString *const kFIRStorageScheme = @"https";
 NSString *const kFIRStorageHost = @"firebasestorage.googleapis.com";
+NSInteger const kFIRStoragePort = 443;
 NSString *const kFIRStorageVersionPath = @"v0";
 NSString *const kFIRStorageBucketPathFormat = @"b/%@";
 NSString *const kFIRStorageObjectPathFormat = @"o/%@";

FirebaseStorage/Sources/FIRStorageConstants_Private.h

@@ -29,6 +29,7 @@ FOUNDATION_EXPORT NSString *const kGCSObjectPathFormat;
 
 FOUNDATION_EXPORT NSString *const kFIRStorageScheme;
 FOUNDATION_EXPORT NSString *const kFIRStorageHost;
+FOUNDATION_EXPORT NSInteger const kFIRStoragePort;
 FOUNDATION_EXPORT NSString *const kFIRStorageVersionPath;
 FOUNDATION_EXPORT NSString *const kFIRStorageBucketPathFormat;
 FOUNDATION_EXPORT NSString *const kFIRStorageObjectPathFormat;

FirebaseStorage/Sources/FIRStorageGetDownloadURLTask.m

@@ -15,6 +15,7 @@
 #import "FirebaseStorage/Sources/FIRStorageGetDownloadURLTask.h"
 
 #import "FirebaseStorage/Sources/FIRStorageTask_Private.h"
+#import "FirebaseStorage/Sources/FIRStorage_Private.h"
 
 @implementation FIRStorageGetDownloadURLTask {
  @private
@@ -39,7 +40,7 @@ - (void)dealloc {
   [_fetcher stopFetching];
 }
 
-+ (NSURL *)downloadURLFromMetadataDictionary:(NSDictionary *)dictionary {
+- (NSURL *)downloadURLFromMetadataDictionary:(NSDictionary *)dictionary {
   NSString *downloadTokens = dictionary[kFIRStorageMetadataDownloadTokens];
 
   if (downloadTokens && downloadTokens.length > 0) {
@@ -50,8 +51,9 @@ + (NSURL *)downloadURLFromMetadataDictionary:(NSDictionary *)dictionary {
                                                     [FIRStorageUtils GCSEscapedString:path]];
 
     NSURLComponents *components = [[NSURLComponents alloc] init];
-    components.scheme = kFIRStorageScheme;
-    components.host = kFIRStorageHost;
+    components.scheme = self.reference.storage.scheme;
+    components.host = self.reference.storage.host;
+    components.port = self.reference.storage.port;
     components.percentEncodedPath = fullPath;
 
     // The backend can return an arbitrary number of download tokens, but we only expose the first
@@ -72,7 +74,6 @@ - (void)enqueue {
 
   [self dispatchAsync:^() {
     FIRStorageGetDownloadURLTask *strongSelf = weakSelf;
-
     if (!strongSelf) {
       return;
     }
@@ -97,8 +98,7 @@ - (void)enqueue {
       } else {
         NSDictionary *responseDictionary = [NSDictionary frs_dictionaryFromJSONData:data];
         if (responseDictionary != nil) {
-          downloadURL =
-              [FIRStorageGetDownloadURLTask downloadURLFromMetadataDictionary:responseDictionary];
+          downloadURL = [strongSelf downloadURLFromMetadataDictionary:responseDictionary];
           if (!downloadURL) {
             self.error =
                 [FIRStorageErrors errorWithCustomMessage:@"Failed to retrieve a download URL."];

FirebaseStorage/Sources/FIRStorageGetDownloadURLTask_Private.h

@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FIRStorageGetDownloadURLTask ()
 
 /** Extracts a download URL from the StorageMetadata dictonary representation. */
-+ (nullable NSURL *)downloadURLFromMetadataDictionary:(NSDictionary *)dictionary;
+- (nullable NSURL *)downloadURLFromMetadataDictionary:(NSDictionary *)dictionary;
 
 @end
 

FirebaseStorage/Sources/FIRStorageListTask.m

@@ -78,10 +78,9 @@ - (void)enqueue {
       queryParams[@"pageToken"] = strongSelf->_previousPageToken;
     }
 
-    FIRStoragePath *basePath = [[FIRStoragePath alloc] initWithBucket:self.reference.bucket
-                                                               object:nil];
+    FIRStorageReference *root = self.reference.root;
     NSMutableURLRequest *request =
-        [[FIRStorageUtils defaultRequestForPath:basePath queryParams:queryParams] mutableCopy];
+        [[FIRStorageUtils defaultRequestForReference:root queryParams:queryParams] mutableCopy];
 
     request.HTTPMethod = @"GET";
     request.timeoutInterval = strongSelf.reference.storage.maxOperationRetryTime;

FirebaseStorage/Sources/FIRStoragePath.m

@@ -59,27 +59,23 @@ + (nullable FIRStoragePath *)pathFromHTTPURL:(NSString *)aURLString {
   NSURL *httpsURL = [NSURL URLWithString:aURLString];
   NSArray *pathComponents = httpsURL.pathComponents;  // [/, v0, b, <bucket>, o, <objects/...>]
 
-  if ([httpsURL.host isEqual:kFIRStorageHost]) {
-    // Have a bucket name
-    if ([pathComponents count] > 3) {
-      bucketName = pathComponents[3];
-    }
-
-    // Have an object name
-    if ([pathComponents count] > 5) {
-      NSRange objectRange = NSMakeRange(5, [pathComponents count] - 5);
-      objectName = [[pathComponents subarrayWithRange:objectRange] componentsJoinedByString:@"/"];
-    }
-  }
-
-  if (bucketName.length == 0) {
+  if ([pathComponents count] <= 3 || ![pathComponents[1] isEqual:@"v0"] ||
+      ![pathComponents[2] isEqual:@"b"]) {
     [NSException raise:NSInternalInconsistencyException
                 format:@"URL must be in the form of "
-                       @"http[s]://firebasestorage.googleapis.com/v0/b/<bucket>/o/<path/to/"
+                       @"http[s]://<host>/v0/b/<bucket>/o/<path/to/"
                        @"object>[?token=signed_url_params]"];
     return nil;
   }
 
+  bucketName = pathComponents[3];
+
+  // Have an object name
+  if ([pathComponents count] > 5) {
+    NSRange objectRange = NSMakeRange(5, [pathComponents count] - 5);
+    objectName = [[pathComponents subarrayWithRange:objectRange] componentsJoinedByString:@"/"];
+  }
+
   if (objectName.length == 0) {
     objectName = nil;
   }

FirebaseStorage/Sources/FIRStorageTask.m

@@ -43,7 +43,7 @@ - (instancetype)initWithReference:(FIRStorageReference *)reference
   self = [super init];
   if (self) {
     _reference = reference;
-    _baseRequest = [FIRStorageUtils defaultRequestForPath:reference.path];
+    _baseRequest = [FIRStorageUtils defaultRequestForReference:reference];
     _fetcherService = service;
     _fetcherService.maxRetryInterval = _reference.storage.maxOperationRetryInterval;
     _dispatchQueue = queue;

FirebaseStorage/Sources/FIRStorageUtils.h

@@ -17,6 +17,7 @@
 #import <Foundation/Foundation.h>
 
 @class FIRStoragePath;
+@class FIRStorageReference;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -53,20 +54,20 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Returns a base NSURLRequest used by all tasks.
- * @param path The FIRStoragePath to create a request for.
+ * @param reference The FIRStorageReference to create a request for.
  * @return Returns a properly formatted NSURLRequest of the form:
  * scheme://host/version/b/<bucket>/o[/path/to/object]
  */
-+ (NSURLRequest *)defaultRequestForPath:(FIRStoragePath *)path;
++ (NSURLRequest *)defaultRequestForReference:(FIRStorageReference *)reference;
 
 /**
  * Returns a base NSURLRequest with custom query parameters.
- * @param path The FIRStoragePath to create a request for.
+ * @param reference The FIRStorageReference to create a request for.
  * @param queryParams A key/value dictionary with query parameters.
  * @return Returns a formatted NSURLRequest
  */
-+ (NSURLRequest *)defaultRequestForPath:(FIRStoragePath *)path
-                            queryParams:(NSDictionary<NSString *, NSString *> *)queryParams;
++ (NSURLRequest *)defaultRequestForReference:(FIRStorageReference *)reference
+                                 queryParams:(NSDictionary<NSString *, NSString *> *)queryParams;
 
 /**
  * Creates the appropriate GCS percent escaped path for a given FIRStoragePath.