FTUE - Choose a display name #5211

ouchadam · 2022-02-11T16:01:33Z

Depends on #5158 Part of #5200

Type of change

WIP Feature
Bugfix
Technical
Other :

Content

Adds a Choose a display name screen to the onboarding personalisation flow, sits behind the FTUE personailzation feature flag.

Motivation and context

To allow the user to personalise their account during the account creation process

Screenshots / GIFs

*the gif animations are odd because the emulator has them turned off

EMPTY	WITH CONTENT	WITH CONTENT AND KEYBOARD

GIF

Tests

Adds unit tests around the OnboardingViewModel (along with the fakes needed to setup the class) to ensure the display name is updated and errors are handled

Tested devices

Physical
Emulator
OS version(s): 32 / Sv2

ouchadam · 2022-02-11T16:25:30Z

vector/src/main/java/im/vector/app/features/onboarding/OnboardingViewModel.kt

@@ -897,6 +899,21 @@ class OnboardingViewModel @AssistedInject constructor(
    fun getFallbackUrl(forSignIn: Boolean, deviceId: String?): String? {
        return authenticationService.getFallbackUrl(forSignIn, deviceId)
    }
+
+    private fun updateDisplayName(displayName: String) {
+        setState { copy(asyncDisplayName = Loading()) }


this uses the same async state mechanism as the other parts of the onboarding state (sign in/register), the login V2 converts this to a simple isLoading: boolean but I've avoided doing the same change here to keep the diff smaller

ouchadam · 2022-02-11T16:26:28Z

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

+    }
+
+    private fun onDisplayNameUpdated() {
+        // TODO go to the real profile picture fragment


this will be the next PR

ouchadam · 2022-02-11T16:27:06Z

vector/src/test/java/im/vector/app/features/crypto/quads/SharedSecureStorageViewModelTest.kt

@@ -102,10 +102,16 @@ class SharedSecureStorageViewModelTest {
            viewModel.handle(SharedSecureStorageAction.UseKey)

            test
-                    .assertState(aViewState(


assertState was removed in favour of a helper to assert all the states (including the initial state)

github-actions · 2022-02-11T16:28:17Z

Unit Test Results

  88 files +  4   88 suites +4 1m 10s ⏱️ +8s
160 tests +  3 160 ✔️ +  3 0 💤 ±0 0 ❌ ±0
516 runs +12 516 ✔️ +12 0 💤 ±0 0 ❌ ±0

Results for commit 16424f7. ± Comparison against base commit b8a0aa7.

♻️ This comment has been updated with latest results.

github-actions · 2022-02-11T18:31:06Z

Matrix SDK

Integration Tests Results:

[org.matrix.android.sdk.session]
passed="25" failures="17" errors="0" skipped="2"
[org.matrix.android.sdk.account]
passed="5" failures="0" errors="0" skipped="2"
[org.matrix.android.sdk.internal]
passed="23" failures="1" errors="0" skipped="3"
[org.matrix.android.sdk.ordering]
passed="16" failures="0" errors="0" skipped="0"
[org.matrix.android.sdk.PermalinkParserTest]
passed="2" failures="0" errors="0" skipped="0"

… introduce the profile picture screen

- cases for the personalisation and display name actions

bmarty

Nice PR, thanks.
Just a quick remark about error management.

bmarty · 2022-02-23T18:04:30Z

...rc/main/java/im/vector/app/features/onboarding/ftueauth/FtueAuthChooseDisplayNameFragment.kt

+
+    override fun onBackPressed(toolbarButton: Boolean): Boolean {
+        viewModel.handle(OnboardingAction.PostViewEvent(OnboardingViewEvents.OnTakeMeHome))
+        return false


return true?

ah 🤦 thought I'd included updates from the previous PR comments, will fix!

updated 8dec4fd

bmarty · 2022-02-23T18:05:47Z

...rc/main/java/im/vector/app/features/onboarding/ftueauth/FtueAuthChooseDisplayNameFragment.kt

+        views.displayNameInput.editText?.addTextChangedListener(object : SimpleTextWatcher() {
+            override fun afterTextChanged(s: Editable) {
+                val newContent = s.toString()
+                views.displayNameSubmit.isEnabled = newContent.isNotEmpty()


Could be nice to reset the error here.
Because the error when setting display name could be displayed in the TextInputLayout. You can trigger an error for instance by setting a display name with @

at the moment errors are coming back in the form of the generic login dialog, I'm not seeing any errors when using @ in the display name though 🤔

I mixed between display name and userId, my bad.

Still it could be nice to display the error in the TextInputLayout. You can do it easily by overidding onError in FtueAuthChooseDisplayNameFragment.

For network error (in airplane mode for instance), it's maybe better if the error is displayed in a dialog (so just call super.onError in this case).

Long display name can be rejected by the homeserver, and other rules may apply, that's why it could be nice to inline the error in such case IMO, instead of

thanks for the screenshot and explanation! I've checked in with product/design, we'd like to do a pass of all the onboarding errors and their copy

I'll create another subtask in #5200 to revisit the error handling here in case there's other types of errors we'd like to capture within the text field instead of dialog and I'll need to track down all the possible error types (and their copy)

bmarty · 2022-02-23T18:07:19Z

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

+            <com.google.android.material.textfield.TextInputEditText
+                android:layout_width="match_parent"
+                android:layout_height="match_parent"
+                android:maxLines="1" />


Could be nice to set an inputType and android:imeOptions="actionDone"

great idea, will do 👍

added 6fb5d05

… viewmodel

bmarty

Thanks for the update.
Note a blocker, but could be nice to handle #5211 (comment)

ouchadam · 2022-03-02T17:58:34Z

thanks for the review 💯 the scope of the errors has increased a bit, I'll merge this in favour of a separate task/PR for the error updates #5211 (comment)

ouchadam mentioned this pull request Feb 11, 2022

Mobile FTUE: Profile Personalisation screens (Android) #5200

Closed

10 tasks

ouchadam commented Feb 11, 2022

View reviewed changes

ouchadam mentioned this pull request Feb 15, 2022

FTUE - Account created screen #5158

Merged

ouchadam force-pushed the feature/adm/choose-display-name branch from cdd121c to 98f1085 Compare February 18, 2022 11:54

Base automatically changed from feature/adm/ftue-post-account-creation to develop February 23, 2022 10:54

ouchadam added 11 commits February 23, 2022 12:44

adding base choose name fragment with UI

0759d52

add click handling for the display name actions

c11fa24

updating real account display name

1fd4011

setting the initial disabled state when the view is created

97862ff

adding header padding which would have been a toolbar

bb98e2e

exiting the flow on display name updated or skipped, the next PR will…

7d6b9af

… introduce the profile picture screen

updating view model state testing to take all emissions into account

83f2f72

adding tests around the onboarding view model

af5e932

- cases for the personalisation and display name actions

using colorSecondary instead of accent as per quality script rule

b2e4020

making use of viewevent delegating action for the back handling

ccd3626

using debounced clicks

4a01193

ouchadam force-pushed the feature/adm/choose-display-name branch from 98f1085 to 4a01193 Compare February 23, 2022 12:50

ouchadam marked this pull request as ready for review February 23, 2022 12:56

ouchadam mentioned this pull request Feb 23, 2022

FTUE - Choose a display picture #5323

Merged

6 tasks

bmarty reviewed Feb 23, 2022

View reviewed changes

ouchadam added 2 commits February 25, 2022 12:01

consuming the back action when existing the display name fragment via…

8dec4fd

… viewmodel

making the keyboard imeDone update the display name

16424f7

ouchadam force-pushed the feature/adm/choose-display-name branch from 6fb5d05 to 16424f7 Compare February 25, 2022 12:26

ouchadam requested a review from bmarty March 2, 2022 12:43

bmarty approved these changes Mar 2, 2022

View reviewed changes

ouchadam merged commit 99e5a8f into develop Mar 2, 2022

ouchadam deleted the feature/adm/choose-display-name branch March 2, 2022 17:59

ouchadam added the Z-FTUE Issue is relevant to the first time use project or experience label Mar 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FTUE - Choose a display name #5211

FTUE - Choose a display name #5211

ouchadam commented Feb 11, 2022 •

edited

Loading

ouchadam Feb 11, 2022

ouchadam Feb 11, 2022

ouchadam Feb 11, 2022

github-actions bot commented Feb 11, 2022 •

edited

Loading

github-actions bot commented Feb 11, 2022 •

edited

Loading

bmarty left a comment

bmarty Feb 23, 2022 •

edited

Loading

ouchadam Feb 23, 2022

ouchadam Feb 25, 2022

bmarty Feb 23, 2022

ouchadam Feb 25, 2022 •

edited

Loading

bmarty Mar 2, 2022

bmarty Mar 2, 2022

ouchadam Mar 2, 2022

bmarty Mar 2, 2022

bmarty Feb 23, 2022

ouchadam Feb 23, 2022

ouchadam Feb 25, 2022

bmarty left a comment •

edited

Loading

ouchadam commented Mar 2, 2022

FTUE - Choose a display name #5211

FTUE - Choose a display name #5211

Conversation

ouchadam commented Feb 11, 2022 • edited Loading

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 11, 2022 • edited Loading

Unit Test Results

github-actions bot commented Feb 11, 2022 • edited Loading

Matrix SDK

Integration Tests Results:

bmarty left a comment

Choose a reason for hiding this comment

bmarty Feb 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ouchadam Feb 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmarty left a comment • edited Loading

Choose a reason for hiding this comment

ouchadam commented Mar 2, 2022

ouchadam commented Feb 11, 2022 •

edited

Loading

github-actions bot commented Feb 11, 2022 •

edited

Loading

github-actions bot commented Feb 11, 2022 •

edited

Loading

bmarty Feb 23, 2022 •

edited

Loading

ouchadam Feb 25, 2022 •

edited

Loading

bmarty left a comment •

edited

Loading