feat(storage): support storage.useEmulator, and md5hash metadata on upload

.github/workflows/scripts/firebase.json

@@ -6,6 +6,9 @@
   "database": {
     "rules": "database.rules"
   },
+  "storage": {
+    "rules": "storage.rules"
+  },
   "emulators": {
     "auth": {
       "port": "9099"
@@ -16,6 +19,9 @@
     "firestore": {
       "port": "8080"
     },
+    "storage": {
+      "port": "9199"
+    },
     "ui": {
       "enabled": true,
       "port": 4000

.github/workflows/scripts/start-firebase-emulator.sh

@@ -4,7 +4,7 @@ if ! [ -x "$(command -v firebase)" ]; then
   exit 1
 fi
 
-EMU_START_COMMAND="firebase emulators:start --only auth,database,firestore --project react-native-firebase-testing"
+EMU_START_COMMAND="firebase emulators:start --only auth,database,firestore,storage --project react-native-firebase-testing"
 #EMU_START_COMMAND="sleep 120"
 MAX_RETRIES=3
 MAX_CHECKATTEMPTS=60
@@ -38,4 +38,4 @@ while [ $RETRIES -le $MAX_RETRIES ]; do
 
 done
 echo "Firebase Emulator Suite did not come online after $MAX_RETRIES attempts."
-exit 1
+exit 1

.github/workflows/scripts/storage.rules

@@ -0,0 +1,17 @@
+rules_version = '2';
+service firebase.storage {
+  match /b/{bucket}/o {
+    match /{document=**} {
+      allow read, write: if false;
+    }
+
+    match /writeOnly.txt {
+      allow read: if false;
+      allow write: if true;
+    }
+
+    match /react-native-tests/{document=**} {
+      allow read, write: if true;
+    }
+  }
+}

jest.setup.ts

@@ -49,6 +49,9 @@ jest.doMock('react-native', () => {
           settings: jest.fn(),
         },
         RNFBPerfModule: {},
+        RNFBStorageModule: {
+          useEmulator: jest.fn(),
+        },
       },
     },
     ReactNative,

packages/app/lib/index.d.ts

@@ -338,6 +338,7 @@ export namespace Utils {
      * Traditionally this is an SD card, but it may also be implemented as built-in storage on a device.
      *
      * Returns null if no external storage directory found, e.g. removable media has been ejected by the user.
+     * Requires special permission granted by Play Store review team on Android, is unlikely to be a valid path.
      *
      * ```js
      * firebase.utils.FilePath.EXTERNAL_STORAGE_DIRECTORY;
@@ -349,6 +350,7 @@ export namespace Utils {
 
     /**
      * Returns an absolute path to a directory in which to place pictures that are available to the user.
+     * Requires special permission granted by Play Store review team on Android, is unlikely to be a valid path.
      *
      * ```js
      * firebase.utils.FilePath.PICTURES_DIRECTORY;
@@ -358,6 +360,7 @@ export namespace Utils {
 
     /**
      * Returns an absolute path to a directory in which to place movies that are available to the user.
+     * Requires special permission granted by Play Store review team on Android, is unlikely to be a valid path.
      *
      * ```js
      * firebase.utils.FilePath.MOVIES_DIRECTORY;

packages/app/lib/internal/constants.js

@@ -20,7 +20,6 @@ export const APP_NATIVE_MODULE = 'RNFBAppModule';
 export const DEFAULT_APP_NAME = '[DEFAULT]';
 
 export const KNOWN_NAMESPACES = [
-  'admob',
   'auth',
   'analytics',
   'remoteConfig',
@@ -29,7 +28,6 @@ export const KNOWN_NAMESPACES = [
   'inAppMessaging',
   'firestore',
   'functions',
-  'iid',
   'indexing',
   'storage',
   'dynamicLinks',

packages/storage/__tests__/storage.test.ts

@@ -0,0 +1,46 @@
+import storage, { firebase } from '../lib';
+
+describe('Storage', function () {
+  describe('namespace', function () {
+    it('accessible from firebase.app()', function () {
+      const app = firebase.app();
+      expect(app.storage).toBeDefined();
+      expect(app.storage().useEmulator).toBeDefined();
+    });
+  });
+
+  describe('useEmulator()', function () {
+    it('useEmulator requires a string host', function () {
+      // @ts-ignore because we pass an invalid argument...
+      expect(() => storage().useEmulator()).toThrow(
+        'firebase.storage().useEmulator() takes a non-empty host',
+      );
+      expect(() => storage().useEmulator('', -1)).toThrow(
+        'firebase.storage().useEmulator() takes a non-empty host',
+      );
+      // @ts-ignore because we pass an invalid argument...
+      expect(() => storage().useEmulator(123)).toThrow(
+        'firebase.storage().useEmulator() takes a non-empty host',
+      );
+    });
+
+    it('useEmulator requires a host and port', function () {
+      expect(() => storage().useEmulator('', 9000)).toThrow(
+        'firebase.storage().useEmulator() takes a non-empty host and port',
+      );
+      // No port
+      // @ts-ignore because we pass an invalid argument...
+      expect(() => storage().useEmulator('localhost')).toThrow(
+        'firebase.storage().useEmulator() takes a non-empty host and port',
+      );
+    });
+
+    it('useEmulator -> remaps Android loopback to host', function () {
+      const foo = storage().useEmulator('localhost', 9000);
+      expect(foo).toEqual(['10.0.2.2', 9000]);
+
+      const bar = storage().useEmulator('127.0.0.1', 9000);
+      expect(bar).toEqual(['10.0.2.2', 9000]);
+    });
+  });
+});

packages/storage/android/src/main/AndroidManifest.xml

@@ -4,7 +4,4 @@
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-    <!-- TODO(salakar) Not sure if this should be part of the package manifest or leave to users app manifest code? -->
-    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 </manifest>

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

@@ -224,6 +224,17 @@ public void setMaxUploadRetryTime(String appName, double milliseconds, Promise p
     promise.resolve(null);
   }
 
+  /**
+   * @link https://firebase.google.com/docs/reference/js/firebase.storage.Storage#useEmulator
+   */
+  @ReactMethod
+  public void useEmulator(String appName, String host, int port, Promise promise) {
+    FirebaseApp firebaseApp = FirebaseApp.getInstance(appName);
+    FirebaseStorage firebaseStorage = FirebaseStorage.getInstance(firebaseApp);
+    firebaseStorage.useEmulator(host, port);
+    promise.resolve(null);
+  }
+
   /**
    * @link https://firebase.google.com/docs/reference/js/firebase.storage.Reference#writeToFile
    */