@react-native-firebase/storage 14.11.1 → 15.0.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [15.0.0](https://github.com/invertase/react-native-firebase/compare/v14.11.1...v15.0.0) (2022-06-20)
+
+### Bug Fixes
+
+- **storage, ios:** correct storage metadata update / delete ([2dcb079](https://github.com/invertase/react-native-firebase/commit/2dcb0790c1812a33100cceea9dcb407d6a64cb87))
+- **storage, ios:** surface underlying reason for unknown errors if possible ([6cd53ea](https://github.com/invertase/react-native-firebase/commit/6cd53eaca16ef52c52a28a7b209a7c8313fef08b))
+
+- fix(storage, android)!: android now updates customMetadata as a group ([d602436](https://github.com/invertase/react-native-firebase/commit/d602436795bfb78f24bc69c42880133505738c00))
+
+### BREAKING CHANGES
+
+- android works like web+iOS now: customMetadata if passed in will be
+  updated as a single atomic unit, all keys at once. Any key you want to keep in customMetadata
+  must be passed in during update; any missing keys will be removed. Set customMetadata to null
+  in order to remove customMetadata entirely, omit it during update to leave it unchanged.
+
 ## [14.11.1](https://github.com/invertase/react-native-firebase/compare/v14.11.0...v14.11.1) (2022-06-17)
 
 **Note:** Version bump only for package @react-native-firebase/storage

package/android/src/main/java/io/invertase/firebase/storage/ReactNativeFirebaseStorageCommon.java

@@ -36,9 +36,9 @@ import com.google.firebase.storage.StorageReference;
 import com.google.firebase.storage.StorageTask;
 import io.invertase.firebase.app.ReactNativeFirebaseApp;
 import io.invertase.firebase.common.SharedUtils;
+import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
-import java.util.Objects;
 import javax.annotation.Nullable;
 
 class ReactNativeFirebaseStorageCommon {
@@ -93,15 +93,40 @@ class ReactNativeFirebaseStorageCommon {
   }
 
   /** Converts a RN ReadableMap into a StorageMetadata instance */
-  static StorageMetadata buildMetadataFromMap(ReadableMap metadataMap, @Nullable Uri file) {
+  static StorageMetadata buildMetadataFromMap(
+      ReadableMap metadataMap, @Nullable Uri file, @Nullable StorageMetadata existingMetadata) {
     StorageMetadata.Builder metadataBuilder = new StorageMetadata.Builder();
 
     if (metadataMap != null) {
-      if (metadataMap.hasKey(KEY_CUSTOM_META)) {
-        ReadableMap customerMetaMap = Objects.requireNonNull(metadataMap.getMap(KEY_CUSTOM_META));
-        Map<String, Object> customMeta = customerMetaMap.toHashMap();
-        for (Map.Entry<String, Object> entry : customMeta.entrySet()) {
+      if (metadataMap.hasKey(KEY_CUSTOM_META) || (existingMetadata != null)) {
+
+        Map<String, Object> customMetadata = new HashMap<>();
+        ReadableMap freshCustomMetadata = metadataMap.getMap(KEY_CUSTOM_META);
+        Map<String, Object> existingCustomMetadata = new HashMap<>();
+
+        // Our baseline will be any existing custom metadata if it exists
+        if (existingMetadata != null) {
+          for (String existingKey : existingMetadata.getCustomMetadataKeys()) {
+            customMetadata.put(existingKey, existingMetadata.getCustomMetadata(existingKey));
+            existingCustomMetadata.put(
+                existingKey, existingMetadata.getCustomMetadata(existingKey));
+          }
+        }
+
+        // Clobber with any fresh custom metadata if it exists
+        if (freshCustomMetadata != null) {
+          customMetadata.putAll(freshCustomMetadata.toHashMap());
+        }
+
+        for (Map.Entry<String, Object> entry : customMetadata.entrySet()) {
           metadataBuilder.setCustomMetadata(entry.getKey(), (String) entry.getValue());
+
+          // API contract updates custom metadata as a group but android SDK has key granularity
+          // So if freshCustomMetadata exists, for any key that in our merged map but not in
+          // freshCustomMetadata, set to null to clear
+          if (freshCustomMetadata == null || !freshCustomMetadata.hasKey(entry.getKey())) {
+            metadataBuilder.setCustomMetadata(entry.getKey(), null);
+          }
         }
       }
 
@@ -167,20 +192,24 @@ class ReactNativeFirebaseStorageCommon {
     if (storageMetadata.getCacheControl() != null
         && storageMetadata.getCacheControl().length() > 0) {
       metadata.putString(KEY_CACHE_CONTROL, storageMetadata.getCacheControl());
-    } else {
-      metadata.putNull(KEY_CACHE_CONTROL);
     }
 
     if (storageMetadata.getContentLanguage() != null
         && storageMetadata.getContentLanguage().length() > 0) {
       metadata.putString(KEY_CONTENT_LANG, storageMetadata.getContentLanguage());
-    } else {
-      metadata.putNull(KEY_CONTENT_LANG);
     }
 
-    metadata.putString(KEY_CONTENT_DISPOSITION, storageMetadata.getContentDisposition());
-    metadata.putString(KEY_CONTENT_ENCODING, storageMetadata.getContentEncoding());
-    metadata.putString(KEY_CONTENT_TYPE, storageMetadata.getContentType());
+    if (storageMetadata.getContentDisposition() != null
+        && storageMetadata.getContentDisposition().length() > 0) {
+      metadata.putString(KEY_CONTENT_DISPOSITION, storageMetadata.getContentDisposition());
+    }
+    if (storageMetadata.getContentEncoding() != null
+        && storageMetadata.getContentEncoding().length() > 0) {
+      metadata.putString(KEY_CONTENT_ENCODING, storageMetadata.getContentEncoding());
+    }
+    if (storageMetadata.getContentType() != null && storageMetadata.getContentType().length() > 0) {
+      metadata.putString(KEY_CONTENT_TYPE, storageMetadata.getContentType());
+    }
 
     if (storageMetadata.getCustomMetadataKeys().size() > 0) {
       WritableMap customMetadata = Arguments.createMap();
@@ -188,8 +217,6 @@ class ReactNativeFirebaseStorageCommon {
         customMetadata.putString(key, storageMetadata.getCustomMetadata(key));
       }
       metadata.putMap(KEY_CUSTOM_META, customMetadata);
-    } else {
-      metadata.putNull(KEY_CUSTOM_META);
     }
 
     return metadata;

package/android/src/main/java/io/invertase/firebase/storage/ReactNativeFirebaseStorageModule.java

@@ -169,6 +169,24 @@ public class ReactNativeFirebaseStorageModule extends ReactNativeFirebaseModule
     }
   }
 
+  // Useful for development / debugging
+  private void dumpMetadata(StorageMetadata metadata) {
+    System.err.println("STORAGE dumping metadata contents");
+    System.err.println("STORAGE - cacheControl " + metadata.getCacheControl());
+    System.err.println("STORAGE - contentDisposition " + metadata.getContentDisposition());
+    System.err.println("STORAGE - contentEncoding " + metadata.getContentEncoding());
+    System.err.println("STORAGE - contentLanguage " + metadata.getContentLanguage());
+    System.err.println("STORAGE - contentType " + metadata.getContentType());
+    for (String customKey : metadata.getCustomMetadataKeys()) {
+      System.err.println(
+          "STORAGE - customMetadata: '"
+              + customKey
+              + "' / '"
+              + metadata.getCustomMetadata(customKey)
+              + "'");
+    }
+  }
+
   /**
    * @link https://firebase.google.com/docs/reference/js/firebase.storage.Reference#updateMetadata
    */
@@ -177,17 +195,35 @@ public class ReactNativeFirebaseStorageModule extends ReactNativeFirebaseModule
       String appName, String url, ReadableMap metadataMap, final Promise promise) {
     try {
       StorageReference reference = getReferenceFromUrl(url, appName);
-      StorageMetadata metadata = buildMetadataFromMap(metadataMap, null);
 
       reference
-          .updateMetadata(metadata)
+          .getMetadata()
           .addOnCompleteListener(
               getExecutor(),
-              task -> {
-                if (task.isSuccessful()) {
-                  promise.resolve(getMetadataAsMap(task.getResult()));
+              getTask -> {
+                if (getTask.isSuccessful()) {
+
+                  // dumpMetadata(getTask.getResult());
+                  StorageMetadata metadata =
+                      buildMetadataFromMap(metadataMap, null, getTask.getResult());
+                  // dumpMetadata(metadata);
+
+                  reference
+                      .updateMetadata(metadata)
+                      .addOnCompleteListener(
+                          getExecutor(),
+                          updateTask -> {
+                            if (updateTask.isSuccessful()) {
+                              // dumpMetadata(updateTask.getResult());
+                              promise.resolve(getMetadataAsMap(updateTask.getResult()));
+                            } else {
+                              updateTask.getException().printStackTrace();
+                              promiseRejectStorageException(promise, updateTask.getException());
+                            }
+                          });
+
                 } else {
-                  promiseRejectStorageException(promise, task.getException());
+                  promiseRejectStorageException(promise, getTask.getException());
                 }
               });
     } catch (Exception e) {

package/android/src/main/java/io/invertase/firebase/storage/ReactNativeFirebaseStorageUploadTask.java

@@ -186,7 +186,7 @@ class ReactNativeFirebaseStorageUploadTask extends ReactNativeFirebaseStorageTas
 
   /** Put String or Data from JavaScript */
   void begin(ExecutorService executor, String string, String format, ReadableMap metadataMap) {
-    StorageMetadata metadata = buildMetadataFromMap(metadataMap, null);
+    StorageMetadata metadata = buildMetadataFromMap(metadataMap, null, null);
     uploadTask = storageReference.putBytes(uploadStringToByteArray(string, format), metadata);
     setStorageTask(uploadTask);
     addEventListeners(executor);
@@ -195,7 +195,7 @@ class ReactNativeFirebaseStorageUploadTask extends ReactNativeFirebaseStorageTas
   /** Put File from JavaScript */
   void begin(ExecutorService executor, String localFilePath, ReadableMap metadataMap) {
     Uri fileUri = SharedUtils.getUri(localFilePath);
-    StorageMetadata metadata = buildMetadataFromMap(metadataMap, fileUri);
+    StorageMetadata metadata = buildMetadataFromMap(metadataMap, fileUri, null);
     uploadTask = storageReference.putFile(fileUri, metadata);
     setStorageTask(uploadTask);
     addEventListeners(executor);

package/ios/RNFBStorage/RNFBStorageCommon.h

@@ -56,7 +56,8 @@
 
 + (NSString *)getTaskStatus:(FIRStorageTaskStatus)status;
 
-+ (FIRStorageMetadata *)buildMetadataFromMap:(NSDictionary *)metadata;
++ (FIRStorageMetadata *)buildMetadataFromMap:(NSDictionary *)metadata
+                            existingMetadata:(FIRStorageMetadata *)existingMetadata;
 
 + (NSArray *)getErrorCodeMessage:(NSError *)error;
 

package/ios/RNFBStorage/RNFBStorageCommon.m

@@ -392,9 +392,64 @@
   }
 }
 
-+ (FIRStorageMetadata *)buildMetadataFromMap:(NSDictionary *)metadata {
-  FIRStorageMetadata *storageMetadata = [[FIRStorageMetadata alloc] initWithDictionary:metadata];
-  storageMetadata.customMetadata = [metadata[@"customMetadata"] mutableCopy];
++ (FIRStorageMetadata *)buildMetadataFromMap:(NSDictionary *)metadata
+                            existingMetadata:(nullable FIRStorageMetadata *)existingMetadata {
+  // If an existing metadata was passed in, modify it with our map, otherwise init a fresh copy
+  FIRStorageMetadata *storageMetadata = existingMetadata;
+  if (storageMetadata == nil) {
+    storageMetadata = [[FIRStorageMetadata alloc] init];
+  }
+
+  if (metadata[@"cacheControl"] == [NSNull null]) {
+    storageMetadata.cacheControl = nil;
+  } else {
+    storageMetadata.cacheControl = metadata[@"cacheControl"];
+  }
+
+  if (metadata[@"contentLanguage"] == [NSNull null]) {
+    storageMetadata.contentLanguage = nil;
+  } else {
+    storageMetadata.contentLanguage = metadata[@"contentLanguage"];
+  }
+
+  if (metadata[@"contentEncoding"] == [NSNull null]) {
+    storageMetadata.contentEncoding = nil;
+  } else {
+    storageMetadata.contentEncoding = metadata[@"contentEncoding"];
+  }
+
+  if (metadata[@"contentDisposition"] == [NSNull null]) {
+    storageMetadata.contentDisposition = nil;
+  } else {
+    storageMetadata.contentDisposition = metadata[@"contentDisposition"];
+  }
+
+  if (metadata[@"contentType"] == [NSNull null]) {
+    storageMetadata.contentType = nil;
+  } else {
+    storageMetadata.contentType = metadata[@"contentType"];
+  }
+
+  if (metadata[@"customMetadata"] == [NSNull null]) {
+    storageMetadata.customMetadata = @{};
+  } else {
+    NSMutableDictionary *customMetadata = [metadata[@"customMetadata"] mutableCopy];
+    for (NSString *key in customMetadata.allKeys) {
+      if (customMetadata[key] == [NSNull null] || customMetadata[key] == nil) {
+        [customMetadata removeObjectForKey:key];
+      }
+    }
+    storageMetadata.customMetadata = customMetadata;
+  }
+
+  // md5hash may be settable but is not update-able, so just test for existence and carry it in
+  // FIXME this will need a fix related to
+  // https://github.com/firebase/firebase-ios-sdk/issues/9849#issuecomment-1159292592 if
+  // (metadata[@"md5hash"]) {
+  //   NSLog(@"STORAGE md5hash was set");
+  //   storageMetadata.md5Hash = metadata[@"md5hash"];
+  // }
+
   return storageMetadata;
 }
 
@@ -417,7 +472,13 @@
         code = @"invalid-device-file-path";
         message = @"The specified device file path is invalid or is restricted.";
       } else {
-        message = @"An unknown error has occurred.";
+        if (userInfo[@"ResponseBody"]) {
+          message =
+              [NSString stringWithFormat:@"An unknown error has occurred. (underlying reason '%@')",
+                                         userInfo[@"ResponseBody"]];
+        } else {
+          message = @"An unknown error has occurred.";
+        }
       }
       break;
     case FIRStorageErrorCodeObjectNotFound:

package/ios/RNFBStorage/RNFBStorageModule.m

@@ -143,17 +143,26 @@ RCT_EXPORT_METHOD(updateMetadata
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
   FIRStorageReference *storageReference = [self getReferenceFromUrl:url app:firebaseApp];
-  FIRStorageMetadata *storageMetadata = [RNFBStorageCommon buildMetadataFromMap:metadata];
 
-  [storageReference
-      updateMetadata:storageMetadata
-          completion:^(FIRStorageMetadata *_Nullable metadata, NSError *_Nullable error) {
-            if (error != nil) {
-              [self promiseRejectStorageException:reject error:error];
-            } else {
-              resolve([RNFBStorageCommon metadataToDict:metadata]);
-            }
-          }];
+  [storageReference metadataWithCompletion:^(FIRStorageMetadata *_Nullable fetchedMetadata,
+                                             NSError *_Nullable error) {
+    if (error != nil) {
+      [self promiseRejectStorageException:reject error:error];
+    } else {
+      FIRStorageMetadata *storageMetadata =
+          [RNFBStorageCommon buildMetadataFromMap:metadata existingMetadata:fetchedMetadata];
+
+      [storageReference updateMetadata:storageMetadata
+                            completion:^(FIRStorageMetadata *_Nullable updatedMetadata,
+                                         NSError *_Nullable error) {
+                              if (error != nil) {
+                                [self promiseRejectStorageException:reject error:error];
+                              } else {
+                                resolve([RNFBStorageCommon metadataToDict:updatedMetadata]);
+                              }
+                            }];
+    }
+  }];
 }
 
 /**
@@ -391,7 +400,8 @@ RCT_EXPORT_METHOD(putFile
                   : (nonnull NSNumber *)taskId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  FIRStorageMetadata *storageMetadata = [RNFBStorageCommon buildMetadataFromMap:metadata];
+  FIRStorageMetadata *storageMetadata = [RNFBStorageCommon buildMetadataFromMap:metadata
+                                                               existingMetadata:nil];
   FIRStorageReference *storageReference = [self getReferenceFromUrl:url app:firebaseApp];
 
   [RNFBStorageCommon
@@ -462,7 +472,8 @@ RCT_EXPORT_METHOD(putString
                   : (nonnull NSNumber *)taskId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  FIRStorageMetadata *storageMetadata = [RNFBStorageCommon buildMetadataFromMap:metadata];
+  FIRStorageMetadata *storageMetadata = [RNFBStorageCommon buildMetadataFromMap:metadata
+                                                               existingMetadata:nil];
   FIRStorageReference *storageReference = [self getReferenceFromUrl:url app:firebaseApp];
 
   __block FIRStorageUploadTask *uploadTask;

package/lib/index.d.ts

@@ -323,7 +323,7 @@ export namespace FirebaseStorageTypes {
     /**
      * Additional user-defined custom metadata for this storage object.
      *
-     * String values only are supported for custom metadata property values.
+     * All values must be strings. Set to null to delete all. Any keys ommitted during update will be removed.
      *
      * #### Example
      *

package/lib/utils.js

@@ -88,9 +88,9 @@ export function validateMetadata(metadata, update = true) {
           `firebase.storage.SettableMetadata invalid property '${key}' should be a string or null value.`,
         );
       }
-    } else if (!isObject(value)) {
+    } else if (!isObject(value) && !isNull(value)) {
       throw new Error(
-        'firebase.storage.SettableMetadata.customMetadata must be an object of keys and string values.',
+        'firebase.storage.SettableMetadata.customMetadata must be an object of keys and string values or null value.',
       );
     }
   }

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '14.11.1';
+module.exports = '15.0.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/storage",
-  "version": "14.11.1",
+  "version": "15.0.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration with Cloud Storage, providing support to upload and download files directly from your device and from your Firebase Cloud Storage bucket.",
   "main": "lib/index.js",
@@ -29,10 +29,10 @@
     "download"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "14.11.1"
+    "@react-native-firebase/app": "15.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b1a430bbf36a41076b33550fec113fa0e44583b4"
+  "gitHead": "7bb975c8c099083911a81e28050a2a5b50af2ee6"
 }