feat(android, emulator): add firebase.json config element to bypass localhost remap (#5852)

* add flag
* Remove unnecessary log, simplify mock object
* Add flag to documentation

Author: Hübner Krisztián

jest.setup.ts

@@ -28,6 +28,7 @@ jest.doMock('react-native', () => {
               options: {},
             },
           ],
+          FIREBASE_RAW_JSON: '{}',
           addListener: jest.fn(),
           eventsAddListener: jest.fn(),
           eventsNotifyReady: jest.fn(),

packages/app/firebase-schema.json

@@ -105,6 +105,10 @@
         "android_background_activity_names": {
           "description": "The names (as returned by `getShortClassName()` of Activities used outside the context of react native.\nThese are ignored when determining if the app is in foreground for purposes of calling javascript background handlers",
           "type": "array"
+        },
+        "android_bypass_emulator_url_remap": {
+          "description": "On android devices, the urls of firebase emulators will be remapped from localhost to 10.0.2.2. If you don't need this behaviour set this fleg to `true`.",
+          "type": "boolean"
         }
       }
     }

packages/auth/lib/index.js

@@ -360,19 +360,22 @@ class FirebaseAuthModule extends FirebaseModule {
     }
 
     let _url = url;
-    if (isAndroid && _url) {
+    const androidBypassEmulatorUrlRemap =
+      typeof this.firebaseJson.android_bypass_emulator_url_remap === 'boolean' &&
+      this.firebaseJson.android_bypass_emulator_url_remap;
+    if (!androidBypassEmulatorUrlRemap && isAndroid && _url) {
       if (_url.startsWith('http://localhost')) {
         _url = _url.replace('http://localhost', 'http://10.0.2.2');
         // eslint-disable-next-line no-console
         console.log(
-          'Mapping auth host "localhost" to "10.0.2.2" for android emulators. Use real IP on real devices.',
+          'Mapping auth host "localhost" to "10.0.2.2" for android emulators. Use real IP on real devices. You can bypass this behaviour with "android_bypass_emulator_url_remap" flag.',
         );
       }
       if (_url.startsWith('http://127.0.0.1')) {
         _url = _url.replace('http://127.0.0.1', 'http://10.0.2.2');
         // eslint-disable-next-line no-console
         console.log(
-          'Mapping auth host "127.0.0.1" to "10.0.2.2" for android emulators. Use real IP on real devices.',
+          'Mapping auth host "127.0.0.1" to "10.0.2.2" for android emulators. Use real IP on real devices. You can bypass this behaviour with "android_bypass_emulator_url_remap" flag.',
         );
       }
     }

packages/firestore/lib/index.js

@@ -101,12 +101,15 @@ class FirebaseFirestoreModule extends FirebaseModule {
       throw new Error('firebase.firestore().useEmulator() takes a non-empty host and port');
     }
     let _host = host;
-    if (isAndroid && _host) {
+    const androidBypassEmulatorUrlRemap =
+      typeof this.firebaseJson.android_bypass_emulator_url_remap === 'boolean' &&
+      this.firebaseJson.android_bypass_emulator_url_remap;
+    if (!androidBypassEmulatorUrlRemap && isAndroid && _host) {
       if (_host === 'localhost' || _host === '127.0.0.1') {
         _host = '10.0.2.2';
         // eslint-disable-next-line no-console
         console.log(
-          'Mapping firestore host to "10.0.2.2" for android emulators. Use real IP on real devices.',
+          'Mapping firestore host to "10.0.2.2" for android emulators. Use real IP on real devices. You can bypass this behaviour with "android_bypass_emulator_url_remap" flag.',
         );
       }
     }

packages/functions/lib/index.js

@@ -93,19 +93,22 @@ class FirebaseFunctionsModule extends FirebaseModule {
 
   useFunctionsEmulator(origin) {
     let _origin = origin;
-    if (isAndroid && _origin) {
+    const androidBypassEmulatorUrlRemap =
+      typeof this.firebaseJson.android_bypass_emulator_url_remap === 'boolean' &&
+      this.firebaseJson.android_bypass_emulator_url_remap;
+    if (!androidBypassEmulatorUrlRemap && isAndroid && _origin) {
       if (_origin.startsWith('http://localhost')) {
         _origin = _origin.replace('http://localhost', 'http://10.0.2.2');
         // eslint-disable-next-line no-console
         console.log(
-          'Mapping functions host "localhost" to "10.0.2.2" for android emulators. Use real IP on real devices.',
+          'Mapping functions host "localhost" to "10.0.2.2" for android emulators. Use real IP on real devices. You can bypass this behaviour with "android_bypass_emulator_url_remap" flag.',
         );
       }
       if (_origin.startsWith('http://127.0.0.1')) {
         _origin = _origin.replace('http://127.0.0.1', 'http://10.0.2.2');
         // eslint-disable-next-line no-console
         console.log(
-          'Mapping functions host "127.0.0.1" to "10.0.2.2" for android emulators. Use real IP on real devices.',
+          'Mapping functions host "127.0.0.1" to "10.0.2.2" for android emulators. Use real IP on real devices. You can bypass this behaviour with "android_bypass_emulator_url_remap" flag.',
         );
       }
     }

tests/firebase.json

@@ -34,6 +34,7 @@
 
     "android_task_executor_maximum_pool_size": 10,
     "android_task_executor_keep_alive_seconds": 3,
+    "android_bypass_emulator_url_remap": false,
 
     "rnfirebase_json_testing_string": "abc",
     "rnfirebase_json_testing_boolean_false": false,