Implemented custom password reset link (#1850)

Author: laurentiu-git

CHANGELOG.md

@@ -1,3 +1,4 @@
 - Add ability to always skip provider choice (#1825) (contributed by @ubragg)
 - Fix a bug with `isNewUser` for some providers (#1737) (contributed by @laurentiu-git)
 - Add ability to lock the Orientation (#1834) (contributed by @laurentiu-git)
+- Add ability to customize password reset (#1747) (contributed by @laurentiu-git)

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

@@ -1211,6 +1211,7 @@ private abstract class AuthIntentBuilder<T extends AuthIntentBuilder> {
         boolean mEnableCredentials = true;
         boolean mEnableHints = true;
         AuthMethodPickerLayout mAuthMethodPickerLayout = null;
+        ActionCodeSettings mPasswordSettings = null;
 
         /**
          * Specifies the theme to use for the application flow. If no theme is specified, a
@@ -1406,6 +1407,17 @@ public T setLockOrientation(boolean lockOrientation) {
             return (T) this;
         }
 
+        /**
+         * Set custom settings for the RecoverPasswordActivity.
+         *
+         * @param passwordSettings to allow additional state via a continue URL.
+         */
+        @NonNull
+        public T setResetPasswordSettings(ActionCodeSettings passwordSettings) {
+            mPasswordSettings = passwordSettings;
+            return (T) this;
+        }
+
         @CallSuper
         @NonNull
         public Intent build() {
@@ -1485,6 +1497,7 @@ protected FlowParameters getFlowParams() {
                     mAlwaysShowProviderChoice,
                     mLockOrientation,
                     mEmailLink,
+                    mPasswordSettings,
                     mAuthMethodPickerLayout);
         }
     }

auth/src/main/java/com/firebase/ui/auth/data/model/FlowParameters.java

@@ -22,6 +22,7 @@
 import com.firebase.ui.auth.AuthUI.IdpConfig;
 import com.firebase.ui.auth.util.ExtraConstants;
 import com.firebase.ui.auth.util.Preconditions;
+import com.google.firebase.auth.ActionCodeSettings;
 
 import java.util.Collections;
 import java.util.List;
@@ -55,6 +56,7 @@ public FlowParameters createFromParcel(Parcel in) {
             boolean alwaysShowProviderChoice = in.readInt() != 0;
             boolean lockOrientation = in.readInt() != 0;
             String emailLink = in.readString();
+            ActionCodeSettings passwordResetSettings = in.readParcelable(ActionCodeSettings.class.getClassLoader());
             AuthMethodPickerLayout customLayout = in.readParcelable(AuthMethodPickerLayout.class.getClassLoader());
 
             return new FlowParameters(
@@ -71,6 +73,7 @@ public FlowParameters createFromParcel(Parcel in) {
                     alwaysShowProviderChoice,
                     lockOrientation,
                     emailLink,
+                    passwordResetSettings,
                     customLayout);
         }
 
@@ -104,6 +107,9 @@ public FlowParameters[] newArray(int size) {
     @Nullable
     public String emailLink;
 
+    @Nullable
+    public final ActionCodeSettings passwordResetSettings;
+
     public final boolean enableCredentials;
     public final boolean enableHints;
     public final boolean enableAnonymousUpgrade;
@@ -127,6 +133,7 @@ public FlowParameters(
             boolean alwaysShowProviderChoice,
             boolean lockOrientation,
             @Nullable String emailLink,
+            @Nullable ActionCodeSettings passwordResetSettings,
             @Nullable AuthMethodPickerLayout authMethodPickerLayout) {
         this.appName = Preconditions.checkNotNull(appName, "appName cannot be null");
         this.providers = Collections.unmodifiableList(
@@ -142,6 +149,7 @@ public FlowParameters(
         this.alwaysShowProviderChoice = alwaysShowProviderChoice;
         this.lockOrientation = lockOrientation;
         this.emailLink = emailLink;
+        this.passwordResetSettings = passwordResetSettings;
         this.authMethodPickerLayout = authMethodPickerLayout;
     }
 
@@ -167,6 +175,7 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeInt(alwaysShowProviderChoice ? 1 : 0);
         dest.writeInt(lockOrientation ? 1 : 0);
         dest.writeString(emailLink);
+        dest.writeParcelable(passwordResetSettings, flags);
         dest.writeParcelable(authMethodPickerLayout, flags);
     }
 

auth/src/main/java/com/firebase/ui/auth/ui/email/RecoverPasswordActivity.java

@@ -34,6 +34,7 @@
 import com.firebase.ui.auth.viewmodel.ResourceObserver;
 import com.firebase.ui.auth.viewmodel.email.RecoverPasswordHandler;
 import com.google.android.material.textfield.TextInputLayout;
+import com.google.firebase.auth.ActionCodeSettings;
 import com.google.firebase.auth.FirebaseAuthInvalidCredentialsException;
 import com.google.firebase.auth.FirebaseAuthInvalidUserException;
 
@@ -118,10 +119,18 @@ public void onClick(View view) {
     @Override
     public void onDonePressed() {
         if (mEmailFieldValidator.validate(mEmailEditText.getText())) {
-            mHandler.startReset(mEmailEditText.getText().toString());
+            if (getFlowParams().passwordResetSettings != null) {
+                resetPassword(mEmailEditText.getText().toString(), getFlowParams().passwordResetSettings);
+            }
+            else {
+                resetPassword(mEmailEditText.getText().toString(), null);
+            }
         }
     }
 
+    private void resetPassword(String email, @Nullable ActionCodeSettings passwordResetSettings) {
+        mHandler.startReset(email, passwordResetSettings);
+    }
     private void showEmailSentDialog(String email) {
         new AlertDialog.Builder(this)
                 .setTitle(R.string.fui_title_confirm_recover_password)

auth/src/main/java/com/firebase/ui/auth/viewmodel/email/RecoverPasswordHandler.java

@@ -6,8 +6,10 @@
 import com.firebase.ui.auth.viewmodel.AuthViewModelBase;
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.android.gms.tasks.Task;
+import com.google.firebase.auth.ActionCodeSettings;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import androidx.annotation.RestrictTo;
 
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
@@ -16,10 +18,13 @@ public RecoverPasswordHandler(Application application) {
         super(application);
     }
 
-    public void startReset(@NonNull final String email) {
+    public void startReset(@NonNull final String email, @Nullable ActionCodeSettings actionCodeSettings) {
         setResult(Resource.<String>forLoading());
-        getAuth().sendPasswordResetEmail(email)
-                .addOnCompleteListener(new OnCompleteListener<Void>() {
+        Task<Void> reset = actionCodeSettings != null
+                ? getAuth().sendPasswordResetEmail(email, actionCodeSettings)
+                : getAuth().sendPasswordResetEmail(email);
+
+        reset.addOnCompleteListener(new OnCompleteListener<Void>() {
                     @Override
                     public void onComplete(@NonNull Task<Void> task) {
                         Resource<String> resource = task.isSuccessful()

auth/src/test/java/com/firebase/ui/auth/testhelpers/TestHelper.java

@@ -168,6 +168,7 @@ public static FlowParameters getFlowParameters(Collection<String> providerIds,
                 false,
                 true,
                 null,
+                null,
                 customLayout);
     }
 

auth/src/test/java/com/firebase/ui/auth/viewmodel/RecoverPasswordHandlerTest.java

@@ -9,6 +9,7 @@
 import com.firebase.ui.auth.testhelpers.TestConstants;
 import com.firebase.ui.auth.testhelpers.TestHelper;
 import com.firebase.ui.auth.viewmodel.email.RecoverPasswordHandler;
+import com.google.firebase.auth.ActionCodeSettings;
 import com.google.firebase.auth.EmailAuthProvider;
 import com.google.firebase.auth.FirebaseAuth;
 
@@ -39,6 +40,8 @@ public class RecoverPasswordHandlerTest {
 
     private RecoverPasswordHandler mHandler;
 
+    private ActionCodeSettings mPasswordResetSettings;
+
     @Before
     public void setUp() {
         TestHelper.initialize();
@@ -49,6 +52,12 @@ public void setUp() {
         FlowParameters testParams = TestHelper.getFlowParameters(Collections.singletonList(
                 EmailAuthProvider.PROVIDER_ID));
         mHandler.initializeForTesting(testParams, mMockAuth, null, null);
+
+        mPasswordResetSettings = ActionCodeSettings.newBuilder()
+                .setAndroidPackageName("com.firebase.uidemo", true, null)
+                .setHandleCodeInApp(true)
+                .setUrl("https://google.com")
+                .build();
     }
 
     @Test
@@ -59,7 +68,7 @@ public void testReset_sendsRecoverEmail() {
 
         // Begin observation, then send the email
         mHandler.getOperation().observeForever(mObserver);
-        mHandler.startReset(TestConstants.EMAIL);
+        mHandler.startReset(TestConstants.EMAIL, null);
 
         // Should get in-progress resource
         verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isLoading()));
@@ -79,7 +88,7 @@ public void testReset_propagatesFailure() {
 
         // Begin observation, then send the email
         mHandler.getOperation().observeForever(mObserver);
-        mHandler.startReset(TestConstants.EMAIL);
+        mHandler.startReset(TestConstants.EMAIL, null);
 
         // Should get in-progress resource
         verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isLoading()));
@@ -91,4 +100,43 @@ public void testReset_propagatesFailure() {
         verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isFailure()));
     }
 
+    @Test
+    public void testReset_sendsCustomRecoverEmail() {
+        // Send password email succeeds
+        when(mMockAuth.sendPasswordResetEmail(TestConstants.EMAIL, mPasswordResetSettings ))
+                .thenReturn(AutoCompleteTask.<Void>forSuccess(null));
+
+        // Begin observation, then send the email
+        mHandler.getOperation().observeForever(mObserver);
+        mHandler.startReset(TestConstants.EMAIL, mPasswordResetSettings);
+
+        // Should get in-progress resource
+        verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isLoading()));
+
+        // Firebase auth should be called
+        verify(mMockAuth).sendPasswordResetEmail(TestConstants.EMAIL, mPasswordResetSettings);
+
+        // Should get the success resource
+        verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isSuccess()));
+    }
+
+    @Test
+    public void testCustomReset_propagatesFailure() {
+        // Send password email fails
+        when(mMockAuth.sendPasswordResetEmail(TestConstants.EMAIL, mPasswordResetSettings))
+                .thenReturn(AutoCompleteTask.<Void>forFailure(new Exception("FAILED")));
+
+        // Begin observation, then send the email
+        mHandler.getOperation().observeForever(mObserver);
+        mHandler.startReset(TestConstants.EMAIL, mPasswordResetSettings);
+
+        // Should get in-progress resource
+        verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isLoading()));
+
+        // Firebase auth should be called
+        verify(mMockAuth).sendPasswordResetEmail(TestConstants.EMAIL, mPasswordResetSettings);
+
+        // Should get the success resource
+        verify(mObserver).onChanged(argThat(ResourceMatchers.<String>isFailure()));
+    }
 }