feat(firebase_auth): implement support for useEmulator (#4263)

Co-authored-by: Mike Hardy <[email protected]>
Co-authored-by: Mike Diarmid <[email protected]>

.github/workflows/firebase_auth.yaml

@@ -9,7 +9,7 @@ on:
     branches:
       - master
     paths-ignore:
-    - "docs/**"
+      - "docs/**"
 
 env:
   FLUTTERFIRE_PLUGIN_SCOPE: "*firebase_auth*"
@@ -27,9 +27,13 @@ jobs:
       - name: "Install Flutter"
         run: ./.github/workflows/scripts/install-flutter.sh stable
       - name: "Install Tools"
-        run: ./.github/workflows/scripts/install-tools.sh
+        run: |
+          ./.github/workflows/scripts/install-tools.sh
+          sudo npm i -g firebase-tools
       - name: "Build Example"
         run: ./.github/workflows/scripts/build-example.sh android
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         uses: reactivecircus/android-emulator-runner@v2
         with:
@@ -51,9 +55,12 @@ jobs:
       - name: "Install Tools"
         run: |
           ./.github/workflows/scripts/install-tools.sh
+          sudo npm i -g firebase-tools
           flutter config --enable-macos-desktop
       - name: "Build iOS Example"
         run: ./.github/workflows/scripts/build-example.sh ios
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive iOS Example"
         run: ./.github/workflows/scripts/drive-example.sh ios
       - name: "Build MacOS Example"
@@ -62,7 +69,9 @@ jobs:
         run: ./.github/workflows/scripts/drive-example.sh macos
 
   web:
-    runs-on: ubuntu-latest
+    # Using macos instead of ubuntu as Web app can't connect to Firebase emulator
+    # when running on ubuntu.
+    runs-on: macos-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v1
@@ -74,5 +83,8 @@ jobs:
         run: |
           ./.github/workflows/scripts/install-tools.sh
           flutter config --enable-web
+          sudo npm i -g firebase-tools
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         run: ./.github/workflows/scripts/drive-example.sh web

.github/workflows/firebase_firestore.yaml

@@ -32,8 +32,8 @@ jobs:
           sudo npm i -g firebase-tools
       - name: "Build Example"
         run: ./.github/workflows/scripts/build-example.sh android
-      - name: Start Firestore Emulator
-        run: cd ./.github/workflows/scripts && ./start-firestore-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         uses: reactivecircus/android-emulator-runner@v2
         with:
@@ -61,8 +61,8 @@ jobs:
           flutter config --enable-macos-desktop
       - name: "Build iOS Example"
         run: ./.github/workflows/scripts/build-example.sh ios
-      - name: Start Firestore Emulator
-        run: cd ./.github/workflows/scripts && ./start-firestore-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive iOS Example"
         run: ./.github/workflows/scripts/drive-example.sh ios
       - name: "Build MacOS Example"
@@ -73,7 +73,7 @@ jobs:
         run: ./.github/workflows/scripts/drive-example.sh macos
 
   web:
-    # Using macos instead of ubuntu as Web app can't connect to Firebase Firestore emulator
+    # Using macos instead of ubuntu as Web app can't connect to Firebase emulator
     # when running on ubuntu.
     runs-on: macos-latest
     timeout-minutes: 15
@@ -88,7 +88,7 @@ jobs:
           ./.github/workflows/scripts/install-tools.sh
           sudo npm i -g firebase-tools
           flutter config --enable-web
-      - name: Start Firestore Emulator
-        run: cd ./.github/workflows/scripts && ./start-firestore-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         run: ./.github/workflows/scripts/drive-example.sh web

.github/workflows/firebase_functions.yaml

@@ -31,8 +31,8 @@ jobs:
           sudo npm i -g firebase-tools
       - name: "Build Example"
         run: ./.github/workflows/scripts/build-example.sh android
-      - name: Start Functions Emulator
-        run: cd ./.github/workflows/scripts && ./start-functions-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         uses: reactivecircus/android-emulator-runner@v2
         with:
@@ -60,8 +60,8 @@ jobs:
           sudo npm i -g firebase-tools
       - name: "Build iOS Example"
         run: ./.github/workflows/scripts/build-example.sh ios
-      - name: Start Functions Emulator
-        run: cd ./.github/workflows/scripts && ./start-functions-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive iOS Example"
         run: ./.github/workflows/scripts/drive-example.sh ios
       - name: "Build MacOS Example"
@@ -70,7 +70,7 @@ jobs:
         run: ./.github/workflows/scripts/drive-example.sh macos
 
   web:
-    # Using macos instead of ubuntu as Web app can't connect to Firebase Functions emulator
+    # Using macos instead of ubuntu as Web app can't connect to Firebase emulator
     # when running on ubuntu.
     runs-on: macos-latest
     timeout-minutes: 15
@@ -85,7 +85,7 @@ jobs:
           ./.github/workflows/scripts/install-tools.sh
           flutter config --enable-web
           sudo npm i -g firebase-tools
-      - name: Start Functions Emulator
-        run: cd ./.github/workflows/scripts && ./start-functions-emulator.sh
+      - name: Start Firebase Emulator
+        run: cd ./.github/workflows/scripts && ./start-firebase-emulator.sh
       - name: "Drive Example"
         run: ./.github/workflows/scripts/drive-example.sh web

.github/workflows/scripts/firebase.json

@@ -9,8 +9,12 @@
     "firestore": {
       "port": "8080"
     },
+    "auth": {
+      "port": "9099"
+    },
     "ui": {
-      "enabled": false
+      "enabled": true,
+      "port": 4000
     }
   }
 }

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

@@ -19,14 +19,16 @@ if [[ ! -d "functions/node_modules" ]]; then
   cd functions && npm i && cd ..
 fi
 
+EMU_START_COMMAND="firebase emulators:start --only auth,firestore,functions --project react-native-firebase-testing"
+
 IS_CI="${CI}${CONTINUOUS_INTEGRATION}${BUILD_NUMBER}${RUN_ID}"
 if [[ -n "${IS_CI}" ]]; then
-  firebase emulators:start --only functions &
-  until curl --output /dev/null --head --silent http://localhost:5001; do
-    echo "Waiting for Functions emulator to come online..."
+  $EMU_START_COMMAND &
+  until curl --output /dev/null --silent --fail http://localhost:8080; do
+    echo "Waiting for Firebase emulator to come online..."
     sleep 2
   done
-  echo "Functions emulator is online!"
+  echo "Firebase emulator is online!"
 else
-  firebase emulators:start --only functions
+  $EMU_START_COMMAND
 fi

packages/firebase_auth/firebase_auth/android/src/main/java/io/flutter/plugins/firebase/auth/Constants.java

@@ -77,4 +77,6 @@ public class Constants {
   public static final String HANDLE_CODE_IN_APP = "handleCodeInApp";
   public static final String ACTION_CODE_SETTINGS = "actionCodeSettings";
   public static final String AUTO_RETRIEVED_SMS_CODE_FOR_TESTING = "autoRetrievedSmsCodeForTesting";
+  public static final String HOST = "host";
+  public static final String PORT = "port";
 }

packages/firebase_auth/firebase_auth/android/src/main/java/io/flutter/plugins/firebase/auth/FlutterFirebaseAuthPlugin.java

@@ -764,6 +764,18 @@ private Task<Void> signOut(Map<String, Object> arguments) {
         });
   }
 
+  private Task<Void> useEmulator(Map<String, Object> arguments) {
+    return Tasks.call(
+        cachedThreadPool,
+        () -> {
+          FirebaseAuth firebaseAuth = getAuth(arguments);
+          String host = (String) arguments.get(Constants.HOST);
+          int port = (int) arguments.get(Constants.PORT);
+          firebaseAuth.useEmulator(host, port);
+          return null;
+        });
+  }
+
   private Task<Map<String, Object>> verifyPasswordResetCode(Map<String, Object> arguments) {
     return Tasks.call(
         cachedThreadPool,
@@ -1196,6 +1208,9 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
       case "Auth#signOut":
         methodCallTask = signOut(call.arguments());
         break;
+      case "Auth#useEmulator":
+        methodCallTask = useEmulator(call.arguments());
+        break;
       case "Auth#verifyPasswordResetCode":
         methodCallTask = verifyPasswordResetCode(call.arguments());
         break;

packages/firebase_auth/firebase_auth/example/android/app/src/main/AndroidManifest.xml

@@ -9,6 +9,7 @@
          additional functionality it is fine to subclass or reimplement
          FlutterApplication and put your custom class here. -->
     <application
+        android:usesCleartextTraffic="true"
         android:name="io.flutter.app.FlutterApplication"
         android:label="firebaseauthexample"
         android:icon="@mipmap/ic_launcher">

packages/firebase_auth/firebase_auth/example/ios/Runner/Info.plist

@@ -41,6 +41,11 @@
 	<string>$(FLUTTER_BUILD_NUMBER)</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
+	<key>NSAppTransportSecurity</key>
+	<dict>
+		<key>NSAllowsArbitraryLoads</key>
+		<true/>
+	</dict>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIMainStoryboardFile</key>

packages/firebase_auth/firebase_auth/example/lib/main.dart

@@ -12,6 +12,8 @@ import './signin_page.dart';
 Future<void> main() async {
   WidgetsFlutterBinding.ensureInitialized();
   await Firebase.initializeApp();
+  // Uncomment this to use the auth emulator for testing
+  // await FirebaseAuth.instance.useEmulator('http://localhost:9099');
   runApp(AuthExampleApp());
 }
 
@@ -22,11 +24,12 @@ class AuthExampleApp extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-        title: 'Firebase Example App',
-        theme: ThemeData.dark(),
-        home: Scaffold(
-          body: AuthTypeSelector(),
-        ));
+      title: 'Firebase Example App',
+      theme: ThemeData.dark(),
+      home: Scaffold(
+        body: AuthTypeSelector(),
+      ),
+    );
   }
 }
 
@@ -43,30 +46,30 @@ class AuthTypeSelector extends StatelessWidget {
   Widget build(BuildContext context) {
     return Scaffold(
       appBar: AppBar(
-        title: Text("Firebase Example App"),
+        title: const Text('Firebase Example App'),
       ),
       body: Column(
         crossAxisAlignment: CrossAxisAlignment.start,
         children: <Widget>[
           Container(
+            padding: const EdgeInsets.all(16),
+            alignment: Alignment.center,
             child: SignInButtonBuilder(
               icon: Icons.person_add,
               backgroundColor: Colors.indigo,
               text: 'Registration',
               onPressed: () => _pushPage(context, RegisterPage()),
             ),
-            padding: const EdgeInsets.all(16),
-            alignment: Alignment.center,
           ),
           Container(
+            padding: const EdgeInsets.all(16),
+            alignment: Alignment.center,
             child: SignInButtonBuilder(
               icon: Icons.verified_user,
               backgroundColor: Colors.orange,
               text: 'Sign In',
               onPressed: () => _pushPage(context, SignInPage()),
             ),
-            padding: const EdgeInsets.all(16),
-            alignment: Alignment.center,
           ),
         ],
       ),

packages/firebase_auth/firebase_auth/example/test_driver/firebase_auth_e2e.dart

@@ -5,6 +5,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:drive/drive.dart' as drive;
+//import 'package:firebase_auth/firebase_auth.dart'; // only needed if you use the Auth Emulator
 import 'package:firebase_core/firebase_core.dart';
 import 'package:flutter_test/flutter_test.dart';
 
@@ -17,6 +18,13 @@ bool USE_EMULATOR = false;
 void testsMain() {
   setUpAll(() async {
     await Firebase.initializeApp();
+
+    // Configure the Auth test suite to use the Auth Emulator
+    // This may not be enabled until the test suite is ported to:
+    //  - have ability to create disabled users
+    //  - have ability to fetch OOB and SMS verification codes
+    // JS implementation to port to dart here: https://github.com/invertase/react-native-firebase/pull/4552/commits/4c688413cb6516ecfdbd4ea325103d0d8d8d84a8#diff-44ccd5fb03b0d9e447820032866f2494c5a400a52873f0f65518d06aedafe302
+    // await FirebaseAuth.instance.useEmulator('http://localhost:9099');
   });
 
   runInstanceTests();

packages/firebase_auth/firebase_auth/ios/Classes/FLTFirebaseAuthPlugin.m

@@ -212,6 +212,8 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)flutter
     [self signInWithEmailLink:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Auth#signOut" isEqualToString:call.method]) {
     [self signOut:call.arguments withMethodCallResult:methodCallResult];
+  } else if ([@"Auth#useEmulator" isEqualToString:call.method]) {
+    [self useEmulator:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Auth#verifyPasswordResetCode" isEqualToString:call.method]) {
     [self verifyPasswordResetCode:call.arguments withMethodCallResult:methodCallResult];
   } else if ([@"Auth#verifyPhoneNumber" isEqualToString:call.method]) {
@@ -552,6 +554,12 @@ - (void)signOut:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallResult
   }
 }
 
+- (void)useEmulator:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
+  FIRAuth *auth = [self getFIRAuthFromArguments:arguments];
+  [auth useEmulatorWithHost:arguments[@"host"] port:[arguments[@"port"] integerValue]];
+  result.success(nil);
+}
+
 - (void)verifyPasswordResetCode:(id)arguments
            withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
   FIRAuth *auth = [self getFIRAuthFromArguments:arguments];

packages/firebase_auth/firebase_auth/lib/firebase_auth.dart

@@ -9,6 +9,7 @@ import 'dart:async';
 import 'package:firebase_core_platform_interface/firebase_core_platform_interface.dart';
 import 'package:firebase_auth_platform_interface/firebase_auth_platform_interface.dart';
 import 'package:firebase_core/firebase_core.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:meta/meta.dart';