feat(auth, multi-tenant): add multi-tenant (tenantID) support

.github/workflows/tests_e2e.yml

@@ -300,6 +300,7 @@ jobs:
           export SKIP_BUNDLING=1
           export RCT_NO_LAUNCH_PACKAGER=1
           cd tests
+          set -o pipefail
           ./node_modules/.bin/detox build --configuration ios.ci
         shell: bash
 

packages/auth/__tests__/auth.test.ts

@@ -43,4 +43,23 @@ describe('Auth', function () {
       expect(bar).toEqual(['10.0.2.2', 9099]);
     });
   });
+
+  describe('tenantId', function () {
+    it('should be able to set tenantId ', function () {
+      const auth = firebase.app().auth();
+      auth.setTenantId('test-id').then(() => {
+        expect(auth.tenantId).toBe('test-id');
+      });
+    });
+
+    it('should throw error when tenantId is a non string object ', async function () {
+      try {
+        await firebase.app().auth().setTenantId(Object());
+        return Promise.reject('It should throw an error');
+      } catch (e) {
+        expect(e.message).toBe("firebase.auth().setTenantId(*) expected 'tenantId' to be a string");
+        return Promise.resolve('Error catched');
+      }
+    });
+  });
 });

packages/auth/android/src/main/java/io/invertase/firebase/auth/ReactNativeFirebaseAuthModule.java

@@ -1627,6 +1627,19 @@ public void setLanguageCode(String appName, String code) {
     }
   }
 
+  /**
+   * setTenantId
+   *
+   * @param appName
+   * @param tenantId
+   */
+  @ReactMethod
+  public void setTenantId(String appName, String tenantId) {
+    FirebaseApp firebaseApp = FirebaseApp.getInstance(appName);
+    FirebaseAuth firebaseAuth = FirebaseAuth.getInstance(firebaseApp);
+    firebaseAuth.setTenantId(tenantId);
+  }
+
   /**
    * useDeviceLanguage
    *
@@ -1957,6 +1970,7 @@ private WritableMap firebaseUserToMap(FirebaseUser user) {
     final String provider = user.getProviderId();
     final boolean verified = user.isEmailVerified();
     final String phoneNumber = user.getPhoneNumber();
+    final String tenantId = user.getTenantId();
 
     userMap.putString("uid", uid);
     userMap.putString("providerId", provider);
@@ -1987,6 +2001,12 @@ private WritableMap firebaseUserToMap(FirebaseUser user) {
       userMap.putNull("phoneNumber");
     }
 
+    if (tenantId != null && !"".equals(tenantId)) {
+      userMap.putString("tenantId", tenantId);
+    } else {
+      userMap.putNull("tenantId");
+    }
+
     userMap.putArray("providerData", convertProviderData(user.getProviderData(), user));
 
     WritableMap metadataMap = Arguments.createMap();

packages/auth/e2e/auth.e2e.js

@@ -1071,4 +1071,25 @@ describe('auth()', function () {
       }
     });
   });
+
+  describe('setTenantId()', function () {
+    it('should return null if tenantId unset', function () {
+      should.not.exist(firebase.auth().tenantId);
+    });
+
+    // multi-tenant is not supported by the firebase auth emulator, and requires a valid multi-tenant tenantid
+    // After setting this, next user creation will result in internal error on emulator, or auth/invalid-tenant-id live
+    // it('should return tenantId correctly after setting', async function () {
+    //   await firebase.auth().setTenantId('testTenantId');
+    //   firebase.auth().tenantId.should.equal('testTenantId');
+    // });
+    // it('user should have tenant after setting tenantId', async function () {
+    //   await firebase.auth().setTenantId('userTestTenantId');
+    //   firebase.auth().tenantId.should.equal('userTestTenantId');
+    //   const random = Utils.randString(12, '#a');
+    //   const email = `${random}@${random}.com`;
+    //   const userCredential = await firebase.auth().createUserWithEmailAndPassword(email, random);
+    //   userCredential.user.tenantId.should.equal('userTestTenantId');
+    // });
+  });
 });

packages/auth/ios/RNFBAuth/RNFBAuthModule.m

@@ -900,6 +900,13 @@ - (void)invalidate {
 
 }
 
+RCT_EXPORT_METHOD(setTenantId:
+  (FIRApp *) firebaseApp
+    :(NSString *) tenantID
+) {
+    [FIRAuth authWithApp:firebaseApp].tenantID = tenantID;
+}
+
 RCT_EXPORT_METHOD(useDeviceLanguage:
   (FIRApp *) firebaseApp
 ) {
@@ -1203,6 +1210,7 @@ - (NSDictionary *)firebaseUserToDict:(FIRUser *)user {
       @"providerData": [self convertProviderData:user.providerData],
       keyProviderId: [user.providerID lowercaseString],
       @"refreshToken": user.refreshToken,
+      @"tenantId": user.tenantID ? (id) user.tenantID : [NSNull null],
       keyUid: user.uid
   };
 }

packages/auth/lib/User.js

@@ -52,6 +52,10 @@ export default class User {
     return this._user.phoneNumber || null;
   }
 
+  get tenantId() {
+    return this._user.tenantId || null;
+  }
+
   get photoURL() {
     return this._user.photoURL || null;
   }

packages/auth/lib/index.d.ts

@@ -397,6 +397,10 @@ export namespace FirebaseAuthTypes {
      * Returns the unique identifier of the provider type that this instance corresponds to.
      */
     providerId: string;
+    /**
+     * Returns a string representing the multi-tenant tenant id. This is null if the user is not associated with a tenant.
+     */
+    tenantId?: string;
     /**
      * Returns a user identifier as specified by the authentication provider.
      */
@@ -1201,6 +1205,16 @@ export namespace FirebaseAuthTypes {
    * TODO @salakar missing updateCurrentUser
    */
   export class Module extends FirebaseModule {
+    /**
+     * Returns the current tenant Id or null if it has never been set
+     *
+     * #### Example
+     *
+     * ```js
+     * const tenantId = firebase.auth().tenantId;
+     * ```
+     */
+    tenantId: string | null;
     /**
      * Returns the current language code.
      *
@@ -1228,6 +1242,19 @@ export namespace FirebaseAuthTypes {
      * > It is recommended to use {@link auth#onAuthStateChanged} to track whether the user is currently signed in.
      */
     currentUser: User | null;
+    /**
+     * Sets the tenant id.
+     *
+     * #### Example
+     *
+     * ```js
+     * await firebase.auth().setTenantId('tenant-123');
+     * ```
+     *
+     * @error auth/invalid-tenant-id if the tenant id is invalid for some reason
+     * @param tenantId the tenantID current app bind to.
+     */
+    setTenantId(tenantId: string): Promise<void>;
     /**
      * Sets the language code.
      *

packages/auth/lib/index.js

@@ -69,6 +69,7 @@ class FirebaseAuthModule extends FirebaseModule {
     this._settings = null;
     this._authResult = false;
     this._languageCode = this.native.APP_LANGUAGE[this.app._name];
+    this._tenantId = null;
 
     if (!this.languageCode) {
       this._languageCode = this.native.APP_LANGUAGE['[DEFAULT]'];
@@ -101,6 +102,10 @@ class FirebaseAuthModule extends FirebaseModule {
     return this._languageCode;
   }
 
+  get tenantId() {
+    return this._tenantId;
+  }
+
   get settings() {
     if (!this._settings) {
       this._settings = new Settings(this);
@@ -150,6 +155,14 @@ class FirebaseAuthModule extends FirebaseModule {
     }
   }
 
+  async setTenantId(tenantId) {
+    if (!isString(tenantId)) {
+      throw new Error("firebase.auth().setTenantId(*) expected 'tenantId' to be a string");
+    }
+    this._tenantId = tenantId;
+    await this.native.setTenantId(tenantId);
+  }
+
   _parseListener(listenerOrObserver) {
     return typeof listenerOrObserver === 'object'
       ? listenerOrObserver.next.bind(listenerOrObserver)

tests/package.json

@@ -52,15 +52,15 @@
     "configurations": {
       "ios.sim.debug": {
         "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/testing.app",
-        "build": "xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES -quiet | xcpretty -k",
+        "build": "set -o pipefail && xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES -quiet | xcpretty -k",
         "type": "ios.simulator",
         "device": {
           "type": "iPhone 8"
         }
       },
       "ios.ci": {
         "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/testing.app",
-        "build": "xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES | xcpretty -k",
+        "build": "set -o pipefail && xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES | xcpretty -k",
         "type": "ios.simulator",
         "device": {
           "type": "iPhone 11"
@@ -76,7 +76,7 @@
       },
       "ios.sim.release": {
         "binaryPath": "ios/build/Build/Products/Release-iphonesimulator/testing.app",
-        "build": "export RCT_NO_LAUNCH_PACKAGER=true && xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Release -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES -quiet | xcpretty -k",
+        "build": "set -o pipefail && export RCT_NO_LAUNCH_PACKAGER=true && xcodebuild -workspace ios/testing.xcworkspace -scheme testing -configuration Release -sdk iphonesimulator -derivedDataPath ios/build -UseModernBuildSystem=YES -quiet | xcpretty -k",
         "type": "ios.simulator",
         "device": {
           "type": "iPhone X"