Merge pull request #6157 from vector-im/feature/adm/ftue-msisdn-confirmation

[FTUE] MSISDN / Phone number confirmation

vector/src/main/java/im/vector/app/core/di/FragmentModule.kt

@@ -110,6 +110,7 @@ import im.vector.app.features.onboarding.ftueauth.FtueAuthLegacyStyleCaptchaFrag
 import im.vector.app.features.onboarding.ftueauth.FtueAuthLegacyWaitForEmailFragment
 import im.vector.app.features.onboarding.ftueauth.FtueAuthLoginFragment
 import im.vector.app.features.onboarding.ftueauth.FtueAuthPersonalizationCompleteFragment
+import im.vector.app.features.onboarding.ftueauth.FtueAuthPhoneConfirmationFragment
 import im.vector.app.features.onboarding.ftueauth.FtueAuthPhoneEntryFragment
 import im.vector.app.features.onboarding.ftueauth.FtueAuthResetPasswordFragment
 import im.vector.app.features.onboarding.ftueauth.FtueAuthResetPasswordMailConfirmationFragment
@@ -515,6 +516,11 @@ interface FragmentModule {
     @FragmentKey(FtueAuthPhoneEntryFragment::class)
     fun bindFtueAuthPhoneEntryFragment(fragment: FtueAuthPhoneEntryFragment): Fragment
 
+    @Binds
+    @IntoMap
+    @FragmentKey(FtueAuthPhoneConfirmationFragment::class)
+    fun bindFtueAuthPhoneConfirmationFragment(fragment: FtueAuthPhoneConfirmationFragment): Fragment
+
     @Binds
     @IntoMap
     @FragmentKey(FtueAuthChooseDisplayNameFragment::class)

vector/src/main/java/im/vector/app/features/onboarding/ftueauth/FtueAuthPhoneConfirmationFragment.kt

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.features.onboarding.ftueauth
+
+import android.os.Bundle
+import android.os.Parcelable
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import com.airbnb.mvrx.args
+import im.vector.app.R
+import im.vector.app.core.extensions.associateContentStateWith
+import im.vector.app.core.extensions.clearErrorOnChange
+import im.vector.app.core.extensions.content
+import im.vector.app.core.extensions.setOnImeDoneListener
+import im.vector.app.databinding.FragmentFtuePhoneConfirmationBinding
+import im.vector.app.features.onboarding.OnboardingAction
+import im.vector.app.features.onboarding.RegisterAction
+import kotlinx.parcelize.Parcelize
+import org.matrix.android.sdk.api.failure.Failure
+import javax.inject.Inject
+
+@Parcelize
+data class FtueAuthPhoneConfirmationFragmentArgument(
+        val msisdn: String
+) : Parcelable
+
+class FtueAuthPhoneConfirmationFragment @Inject constructor() : AbstractFtueAuthFragment<FragmentFtuePhoneConfirmationBinding>() {
+
+    private val params: FtueAuthPhoneConfirmationFragmentArgument by args()
+
+    override fun getBinding(inflater: LayoutInflater, container: ViewGroup?): FragmentFtuePhoneConfirmationBinding {
+        return FragmentFtuePhoneConfirmationBinding.inflate(inflater, container, false)
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+        setupViews()
+    }
+
+    private fun setupViews() {
+        views.phoneConfirmationHeaderSubtitle.text = getString(R.string.ftue_auth_phone_confirmation_subtitle, params.msisdn)
+        views.phoneConfirmationInput.associateContentStateWith(button = views.phoneConfirmationSubmit)
+        views.phoneConfirmationInput.setOnImeDoneListener { submitConfirmationCode() }
+        views.phoneConfirmationInput.clearErrorOnChange(viewLifecycleOwner)
+        views.phoneConfirmationSubmit.debouncedClicks { submitConfirmationCode() }
+        views.phoneConfirmationResend.debouncedClicks { viewModel.handle(OnboardingAction.PostRegisterAction(RegisterAction.SendAgainThreePid)) }
+    }
+
+    private fun submitConfirmationCode() {
+        val code = views.phoneConfirmationInput.content()
+        viewModel.handle(OnboardingAction.PostRegisterAction(RegisterAction.ValidateThreePid(code)))
+    }
+
+    override fun onError(throwable: Throwable) {
+        views.phoneConfirmationInput.error = when (throwable) {
+            // The entered code is not correct
+            is Failure.SuccessError -> getString(R.string.login_validation_code_is_not_correct)
+            else -> errorFormatter.toHumanReadable(throwable)
+        }
+    }
+
+    override fun resetViewModel() {
+        viewModel.handle(OnboardingAction.ResetAuthenticationAttempt)
+    }
+}

vector/src/main/java/im/vector/app/features/onboarding/ftueauth/FtueAuthVariant.kt

@@ -199,12 +199,7 @@ class FtueAuthVariant(
                 openWaitForEmailVerification(viewEvents.email)
             }
             is OnboardingViewEvents.OnSendMsisdnSuccess -> {
-                // Pop the enter Msisdn Fragment
+                openMsisdnConfirmation(viewEvents.msisdn)
-                supportFragmentManager.popBackStack(FRAGMENT_REGISTRATION_STAGE_TAG, FragmentManager.POP_BACK_STACK_INCLUSIVE)
-                addRegistrationStageFragmentToBackstack(
-                        FtueAuthGenericTextInputFormFragment::class.java,
-                        FtueAuthGenericTextInputFormFragmentArgument(TextInputFormFragmentMode.ConfirmMsisdn, true, viewEvents.msisdn),
-                )
             }
             is OnboardingViewEvents.Failure,
             is OnboardingViewEvents.Loading ->
@@ -432,6 +427,20 @@ class FtueAuthVariant(
         }
     }
 
+    private fun openMsisdnConfirmation(msisdn: String) {
+        supportFragmentManager.popBackStack(FRAGMENT_REGISTRATION_STAGE_TAG, FragmentManager.POP_BACK_STACK_INCLUSIVE)
+        when {
+            vectorFeatures.isOnboardingCombinedRegisterEnabled() -> addRegistrationStageFragmentToBackstack(
+                    FtueAuthPhoneConfirmationFragment::class.java,
+                    FtueAuthPhoneConfirmationFragmentArgument(msisdn),
+            )
+            else -> addRegistrationStageFragmentToBackstack(
+                    FtueAuthGenericTextInputFormFragment::class.java,
+                    FtueAuthGenericTextInputFormFragmentArgument(TextInputFormFragmentMode.ConfirmMsisdn, true, msisdn),
+            )
+        }
+    }
+
     private fun onTerms(stage: Stage.Terms) {
         when {
             vectorFeatures.isOnboardingCombinedRegisterEnabled() -> addRegistrationStageFragmentToBackstack(

vector/src/main/res/layout/fragment_ftue_phone_confirmation.xml

@@ -0,0 +1,150 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.core.widget.NestedScrollView xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    style="@style/LoginFormScrollView"
+    android:layout_height="match_parent"
+    android:background="?android:colorBackground"
+    android:fillViewport="true"
+    android:paddingTop="0dp"
+    android:paddingBottom="0dp">
+
+    <androidx.constraintlayout.widget.ConstraintLayout
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content">
+
+        <androidx.constraintlayout.widget.Guideline
+            android:id="@+id/phoneConfirmationGutterStart"
+            android:layout_width="wrap_content"
+            android:layout_height="match_parent"
+            android:orientation="vertical"
+            app:layout_constraintGuide_percent="@dimen/ftue_auth_gutter_start_percent" />
+
+        <androidx.constraintlayout.widget.Guideline
+            android:id="@+id/phoneConfirmationGutterEnd"
+            android:layout_width="wrap_content"
+            android:layout_height="match_parent"
+            android:orientation="vertical"
+            app:layout_constraintGuide_percent="@dimen/ftue_auth_gutter_end_percent" />
+
+        <Space
+            android:id="@+id/headerSpacing"
+            android:layout_width="match_parent"
+            android:layout_height="52dp"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationHeaderIcon"
+            app:layout_constraintTop_toTopOf="parent"
+            app:layout_constraintVertical_bias="0"
+            app:layout_constraintVertical_chainStyle="packed" />
+
+        <ImageView
+            android:id="@+id/phoneConfirmationHeaderIcon"
+            android:layout_width="wrap_content"
+            android:layout_height="0dp"
+            android:adjustViewBounds="true"
+            android:background="@drawable/circle"
+            android:backgroundTint="?colorSecondary"
+            android:contentDescription="@null"
+            android:src="@drawable/ic_ftue_phone"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationHeaderTitle"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintHeight_percent="0.12"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/headerSpacing"
+            app:tint="@color/palette_white" />
+
+        <TextView
+            android:id="@+id/phoneConfirmationHeaderTitle"
+            style="@style/Widget.Vector.TextView.Title.Medium"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:layout_marginTop="16dp"
+            android:gravity="center"
+            android:text="@string/ftue_auth_phone_confirmation_title"
+            android:textColor="?vctr_content_primary"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationHeaderSubtitle"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/phoneConfirmationHeaderIcon" />
+
+        <TextView
+            android:id="@+id/phoneConfirmationHeaderSubtitle"
+            style="@style/Widget.Vector.TextView.Subtitle"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:layout_marginTop="8dp"
+            android:gravity="center"
+            android:textColor="?vctr_content_secondary"
+            app:layout_constraintBottom_toTopOf="@id/titleContentSpacing"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/phoneConfirmationHeaderTitle"
+            tools:text="@string/ftue_auth_phone_confirmation_subtitle" />
+
+        <Space
+            android:id="@+id/titleContentSpacing"
+            android:layout_width="match_parent"
+            android:layout_height="0dp"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationInput"
+            app:layout_constraintHeight_percent="0.03"
+            app:layout_constraintTop_toBottomOf="@id/phoneConfirmationHeaderSubtitle" />
+
+        <com.google.android.material.textfield.TextInputLayout
+            android:id="@+id/phoneConfirmationInput"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:hint="@string/ftue_auth_phone_confirmation_entry_title"
+            app:endIconMode="clear_text"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationResend"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/titleContentSpacing">
+
+            <com.google.android.material.textfield.TextInputEditText
+                android:layout_width="match_parent"
+                android:layout_height="match_parent"
+                android:imeOptions="actionDone"
+                android:inputType="phone"
+                android:maxLines="1" />
+
+        </com.google.android.material.textfield.TextInputLayout>
+
+        <Button
+            android:id="@+id/phoneConfirmationResend"
+            style="@style/Widget.Vector.Button.Text.Login"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:backgroundTint="@color/element_background_light"
+            android:text="@string/ftue_auth_phone_confirmation_resend_code"
+            android:textAllCaps="true"
+            android:textColor="?colorSecondary"
+            app:layout_constraintBottom_toTopOf="@id/entrySpacing"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintHorizontal_bias="1"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/phoneConfirmationInput" />
+
+        <Space
+            android:id="@+id/entrySpacing"
+            android:layout_width="match_parent"
+            android:layout_height="0dp"
+            app:layout_constraintBottom_toTopOf="@id/phoneConfirmationSubmit"
+            app:layout_constraintHeight_percent="0.03"
+            app:layout_constraintTop_toBottomOf="@id/phoneConfirmationResend"
+            app:layout_constraintVertical_bias="0"
+            app:layout_constraintVertical_chainStyle="packed" />
+
+        <Button
+            android:id="@+id/phoneConfirmationSubmit"
+            style="@style/Widget.Vector.Button.Login"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:text="@string/login_set_email_submit"
+            android:textAllCaps="true"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toEndOf="@id/phoneConfirmationGutterEnd"
+            app:layout_constraintStart_toStartOf="@id/phoneConfirmationGutterStart"
+            app:layout_constraintTop_toBottomOf="@id/entrySpacing" />
+
+    </androidx.constraintlayout.widget.ConstraintLayout>
+
+</androidx.core.widget.NestedScrollView>

vector/src/main/res/values/donottranslate.xml

@@ -39,6 +39,7 @@
     <string name="ftue_auth_phone_title">Enter your phone number</string>
     <string name="ftue_auth_phone_subtitle">This will help verify your account and enables password recovery.</string>
     <string name="ftue_auth_phone_entry_title">Phone Number</string>
+    <string name="ftue_auth_phone_confirmation_entry_title">Confirmation code</string>
 
     <string name="ftue_auth_reset_password_email_subtitle">We will send you a verification link.</string>
     <string name="ftue_auth_reset_password_breaker_title">Check your email.</string>
@@ -48,6 +49,11 @@
     <string name="ftue_auth_reset_password">Reset password</string>
     <string name="ftue_auth_sign_out_all_devices">Sign out all devices</string>
 
+    <string name="ftue_auth_phone_confirmation_title">Confirm your phone number</string>
+    <!-- Note for translators, %s is the users international phone number -->
+    <string name="ftue_auth_phone_confirmation_subtitle">We just sent a code to %s. Enter it below to verify it\'s you.</string>
+    <string name="ftue_auth_phone_confirmation_resend_code">Resend code</string>
+
     <string name="ftue_auth_email_verification_title">Check your email to verify.</string>
     <!-- Note for translators, %s is the users email address -->
     <string name="ftue_auth_email_verification_subtitle">To confirm your email address, tap the button in the email we just sent to %s</string>