Add support for Auth Emulator (#1854)

Author: samtstern

.gitignore

@@ -10,3 +10,4 @@ google-services.json
 
 crashlytics-build.properties
 auth/src/main/res/values/com_crashlytics_export_strings.xml
+*.log

CHANGELOG.md

@@ -1,2 +1,3 @@
-- Update all dependencies to latest major version.
+- [All] Update all dependencies to latest major version.
 - [Auth] Remove SupportVectorDrawablesButton (#1860) (contributed by @AryanNajafi)
+- [Auth] Add `AuthUI#useEmulator()` method  to use FirebaseUI with the Firebase Auth Emulator (#1849)

app/src/main/AndroidManifest.xml

@@ -16,7 +16,8 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme"
-        tools:ignore="GoogleAppIndexingWarning">
+        tools:ignore="GoogleAppIndexingWarning,UnusedAttribute"
+        android:usesCleartextTraffic="true">
 
         <activity android:name=".ChooserActivity">
             <intent-filter>

app/src/main/java/com/firebase/uidemo/auth/AuthUiActivity.java

@@ -109,6 +109,7 @@ public class AuthUiActivity extends AppCompatActivity {
     @BindView(R.id.hint_selector_enabled) CheckBox mEnableHintSelector;
     @BindView(R.id.allow_new_email_accounts) CheckBox mAllowNewEmailAccounts;
     @BindView(R.id.require_name) CheckBox mRequireName;
+    @BindView(R.id.use_auth_emulator) CheckBox mUseEmulator;
 
     @NonNull
     public static Intent createIntent(@NonNull Context context) {
@@ -189,6 +190,17 @@ public void onCheckedChanged(CompoundButton compoundButton, boolean checked) {
             }
         });
 
+        // useEmulator can't be reversed until the FirebaseApp is cleared, so we make this
+        // checkbox "sticky" until the app is restarted
+        mUseEmulator.setOnCheckedChangeListener(new OnCheckedChangeListener() {
+            @Override
+            public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {
+                if (isChecked) {
+                    mUseEmulator.setEnabled(false);
+                }
+            }
+        });
+
         if (ConfigurationUtils.isGoogleMisconfigured(this)
                 || ConfigurationUtils.isFacebookMisconfigured(this)) {
             showSnackbar(R.string.configuration_required);
@@ -232,9 +244,19 @@ public void signInWithEmailLink(@Nullable String link) {
         startActivityForResult(buildSignInIntent(link), RC_SIGN_IN);
     }
 
+    @NonNull
+    public AuthUI getAuthUI() {
+        AuthUI authUI = AuthUI.getInstance();
+        if (mUseEmulator.isChecked()) {
+            authUI.useEmulator("10.0.2.2", 9099);
+        }
+
+        return authUI;
+    }
+
     @NonNull
     public Intent buildSignInIntent(@Nullable String link) {
-        AuthUI.SignInIntentBuilder builder = AuthUI.getInstance().createSignInIntentBuilder()
+        AuthUI.SignInIntentBuilder builder = getAuthUI().createSignInIntentBuilder()
                 .setTheme(getSelectedTheme())
                 .setLogo(getSelectedLogo())
                 .setAvailableProviders(getSelectedProviders())
@@ -274,7 +296,7 @@ public Intent buildSignInIntent(@Nullable String link) {
 
     @OnClick(R.id.sign_in_silent)
     public void silentSignIn() {
-        AuthUI.getInstance().silentSignIn(this, getSelectedProviders())
+        getAuthUI().silentSignIn(this, getSelectedProviders())
                 .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
                     @Override
                     public void onComplete(@NonNull Task<AuthResult> task) {

app/src/main/res/layout/auth_ui_layout.xml

@@ -347,6 +347,13 @@
                 android:checked="true"
                 android:text="@string/options_require_name" />
 
+            <CheckBox
+                android:id="@+id/use_auth_emulator"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:checked="false"
+                android:text="@string/options_use_auth_emulator" />
+
         </LinearLayout>
 
     </ScrollView>

app/src/main/res/values/strings.xml

@@ -68,6 +68,7 @@
     <string name="options_enable_hint_selector">Enable Smart Lock\'s hint selector</string>
     <string name="options_allow_new_email_acccount">Allow new account creation</string>
     <string name="options_require_name">Require first/last name with email accounts.</string>
+    <string name="options_use_auth_emulator">Connect to auth emulator (localhost:9099).</string>
 
     <string name="configuration_required">Configuration required - see README.md</string>
     <string name="google_label_missing_config">Google configuration missing</string>

auth/src/main/java/com/firebase/ui/auth/AuthUI.java

@@ -109,7 +109,6 @@ public final class AuthUI {
     public static final String YAHOO_PROVIDER = "yahoo.com";
     public static final String APPLE_PROVIDER = "apple.com";
 
-
     /**
      * Default value for logo resource, omits the logo from the {@link AuthMethodPickerActivity}.
      */
@@ -161,6 +160,9 @@ public final class AuthUI {
     private final FirebaseApp mApp;
     private final FirebaseAuth mAuth;
 
+    private String mEmulatorHost = null;
+    private int mEmulatorPort = -1;
+
     private AuthUI(FirebaseApp app) {
         mApp = app;
         mAuth = FirebaseAuth.getInstance(mApp);
@@ -196,6 +198,16 @@ public static AuthUI getInstance() {
         return getInstance(FirebaseApp.getInstance());
     }
 
+    /**
+     * Retrieves the {@link AuthUI} instance associated the the specified app name.
+     *
+     * @throws IllegalStateException if the app is not initialized.
+     */
+    @NonNull
+    public static AuthUI getInstance(@NonNull String appName) {
+        return getInstance(FirebaseApp.getInstance(appName));
+    }
+
     /**
      * Retrieves the {@link AuthUI} instance associated the the specified app.
      */
@@ -223,6 +235,18 @@ public static AuthUI getInstance(@NonNull FirebaseApp app) {
         return authUi;
     }
 
+    @NonNull
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseApp getApp() {
+        return mApp;
+    }
+
+    @NonNull
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public FirebaseAuth getAuth() {
+        return mAuth;
+    }
+
     /**
      * Returns true if AuthUI can handle the intent.
      * <p>
@@ -460,6 +484,34 @@ public Task<Void> then(@NonNull Task<Void> task) {
         });
     }
 
+    /**
+     * Connect to the Firebase Authentication emulator.
+     * @see FirebaseAuth#useEmulator(String, int)
+     */
+    public void useEmulator(@NonNull String host, int port) {
+        Preconditions.checkArgument(port >= 0, "Port must be >= 0");
+        Preconditions.checkArgument(port <= 65535, "Port must be <= 65535");
+        mEmulatorHost = host;
+        mEmulatorPort = port;
+
+        mAuth.useEmulator(host, port);
+    }
+
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public boolean isUseEmulator() {
+        return mEmulatorHost != null && mEmulatorPort >= 0;
+    }
+
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public String getEmulatorHost() {
+        return mEmulatorHost;
+    }
+
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    public int getEmulatorPort() {
+        return mEmulatorPort;
+    }
+
     private Task<Void> signOutIdps(@NonNull Context context) {
         if (ProviderAvailability.IS_FACEBOOK_AVAILABLE) {
             LoginManager.getInstance().logOut();
@@ -1160,9 +1212,9 @@ public YahooBuilder() {
          */
         public static class GenericOAuthProviderBuilder extends Builder {
 
-            GenericOAuthProviderBuilder(@NonNull String providerId,
-                                        @NonNull String providerName,
-                                        int buttonId) {
+            public GenericOAuthProviderBuilder(@NonNull String providerId,
+                                               @NonNull String providerName,
+                                               int buttonId) {
                 super(providerId);
 
                 Preconditions.checkNotNull(providerId, "The provider ID cannot be null.");

auth/src/main/java/com/firebase/ui/auth/IdpResponse.java

@@ -381,6 +381,7 @@ public IdpResponse build() {
             }
 
             String providerId = mUser.getProviderId();
+
             if (AuthUI.SOCIAL_PROVIDERS.contains(providerId) && TextUtils.isEmpty(mToken)) {
                 throw new IllegalStateException(
                         "Token cannot be null when using a non-email provider.");
@@ -390,6 +391,7 @@ public IdpResponse build() {
                 throw new IllegalStateException(
                         "Secret cannot be null when using the Twitter provider.");
             }
+
             return new IdpResponse(mUser, mToken, mSecret, mPendingCredential, mIsNewUser);
         }
     }

auth/src/main/java/com/firebase/ui/auth/data/remote/AnonymousSignInHandler.java

@@ -23,13 +23,13 @@
 
 
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-public class AnonymousSignInHandler extends ProviderSignInBase<FlowParameters> {
+public class AnonymousSignInHandler extends SingleProviderSignInHandler<FlowParameters> {
 
     @VisibleForTesting
     public FirebaseAuth mAuth;
 
     public AnonymousSignInHandler(Application application) {
-        super(application);
+        super(application, AuthUI.ANONYMOUS_PROVIDER);
     }
 
     @Override
@@ -38,7 +38,9 @@ protected void onCreate() {
     }
 
     @Override
-    public void startSignIn(@NonNull HelperActivityBase activity) {
+    public void startSignIn(@NonNull FirebaseAuth auth,
+                            @NonNull HelperActivityBase activity,
+                            @NonNull String providerId) {
         setResult(Resource.<IdpResponse>forLoading());
 
         // Calling signInAnonymously() will always return the same anonymous user if already
@@ -74,14 +76,6 @@ private IdpResponse initResponse(boolean isNewUser) {
     // TODO: We need to centralize the auth logic. ProviderSignInBase classes were originally
     // meant to only retrieve remote provider data.
     private FirebaseAuth getAuth() {
-        FirebaseApp app = FirebaseApp.getInstance(getArguments().appName);
-        return FirebaseAuth.getInstance(app);
-    }
-
-    @Override
-    public void startSignIn(@NonNull FirebaseAuth auth,
-                            @NonNull HelperActivityBase activity,
-                            @NonNull String providerId) {
-        startSignIn(activity);
+        return AuthUI.getInstance(getArguments().appName).getAuth();
     }
 }

auth/src/main/java/com/firebase/ui/auth/data/remote/EmailSignInHandler.java

@@ -3,6 +3,7 @@
 import android.app.Application;
 import android.content.Intent;
 
+import com.firebase.ui.auth.AuthUI;
 import com.firebase.ui.auth.ErrorCodes;
 import com.firebase.ui.auth.IdpResponse;
 import com.firebase.ui.auth.data.model.Resource;
@@ -11,20 +12,24 @@
 import com.firebase.ui.auth.ui.email.EmailActivity;
 import com.firebase.ui.auth.viewmodel.ProviderSignInBase;
 import com.firebase.ui.auth.viewmodel.RequestCodes;
+import com.google.firebase.auth.EmailAuthCredential;
+import com.google.firebase.auth.EmailAuthProvider;
 import com.google.firebase.auth.FirebaseAuth;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.RestrictTo;
 
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-public class EmailSignInHandler extends ProviderSignInBase<Void> {
+public class EmailSignInHandler extends SingleProviderSignInHandler<Void> {
     public EmailSignInHandler(Application application) {
-        super(application);
+        super(application, EmailAuthProvider.PROVIDER_ID);
     }
 
     @Override
-    public void startSignIn(@NonNull HelperActivityBase activity) {
+    public void startSignIn(@NonNull FirebaseAuth auth,
+                            @NonNull HelperActivityBase activity,
+                            @NonNull String providerId) {
         activity.startActivityForResult(
                 EmailActivity.createIntent(activity, activity.getFlowParams()),
                 RequestCodes.EMAIL_FLOW);
@@ -43,11 +48,4 @@ public void onActivityResult(int requestCode, int resultCode, @Nullable Intent d
             }
         }
     }
-
-    @Override
-    public void startSignIn(@NonNull FirebaseAuth auth,
-                            @NonNull HelperActivityBase activity,
-                            @NonNull String providerId) {
-        startSignIn(activity);
-    }
 }