FTUE - Homeserver sign in/up deeplinks #6036

ouchadam · 2022-05-12T14:03:22Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Adds missing deeplink handling to the new FTUE combined login/registration screens
Fixes offline errors when attempting to sign in being treated as an invalid homeserver selection
- Introduces a helper for inferring if the device has an active connection, if not we can further breakdown unknown host errors and infer that the failure is caused by being offline rather than the homeserver being unavailable
Lifts the invalid homeserver error dialog to the Activity(/FtueVariant) with a retry action passed from the ViewModel

Motivation and context

Fixes #6023

Screenshots / GIFs

Legacy flows

WITH FTUE DISABLED	GET STARTED WITH FTUE DISABLED	LEGACY RESETTING DEEPLINK

FTUE flows

SIGN UP	SIGN IN

SIGN UP	SIGN IN

Offline deeplink

BEFORE	AFTER

Tests

Open the app via valid and invalid deeplinks
- Invalid - https://mobile.element.io/?hs_url=matrix.example.com&is_url=identity.example.com
- Valid with registration disabled - https://mobile.element.io/?hs_url=iswell.cool&is_url=identity.example.com
Sign in or sign up
Notice homeserver is preselected or an error to choose a different homeserver is shown

Tested devices

Physical
Emulator
OS version(s): 28

ouchadam · 2022-05-12T14:04:08Z

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

+
+    @Provides
+    @Singleton
+    fun providesBuildMeta() = BuildMeta()


Introduces a build meta abstraction to allow for providing Build version overrides for unit tests

Awesome idea!

ouchadam · 2022-05-12T14:05:43Z

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

-        }
-    }
-
-    private fun LoginConfig?.toHomeserverConfig(): HomeServerConnectionConfig? {


no longer needed as the SelectHomeserver will read from the deeplink or default to matrix.org

ouchadam · 2022-05-12T14:06:23Z

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

+                onHomeServerSelected(config, serverTypeOverride, authResult)
+            }
            is OnboardingAction.HomeServerChange.EditHomeServer   -> {
-                when (awaitState().onboardingFlow) {


the when clauses of when (trigger) have been extracted to their own functions

ouchadam · 2022-05-12T14:08:16Z

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

+            }
+            OnboardingFlow.SignIn -> {
                updateServerSelection(config, serverTypeOverride, authResult)
-                _viewEvents.post(OnboardingViewEvents.OnLoginFlowRetrieved)


this case was a legacy flow which has been removed by providing stronger typing to onAuthenticationStartedSuccess( trigger: OnboardingAction.HomeServerChange)instead of the baseOnboardingAction`

ouchadam · 2022-05-12T14:08:45Z

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

        // Nothing to do
    }
-
-    override fun onError(throwable: Throwable) {


this is now handled by the activity(/FtueVariant)

ouchadam · 2022-05-12T14:09:27Z

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

 import org.matrix.android.sdk.api.network.ssl.Fingerprint

 sealed interface OnboardingAction : VectorViewModelAction {
-    data class OnGetStarted(val resetLoginConfig: Boolean, val onboardingFlow: OnboardingFlow) : OnboardingAction


resetLoginConfig has become a dedicated reset action ResetDeeplinkConfig

github-actions · 2022-05-12T14:49:33Z

Unit Test Results

124 files ±0 124 suites ±0 2m 17s ⏱️ ±0s
221 tests +1 221 ✔️ +1 0 💤 ±0 0 ❌ ±0
730 runs +4 730 ✔️ +4 0 💤 ±0 0 ❌ ±0

Results for commit 096db6c. ± Comparison against base commit 0675b7c.

♻️ This comment has been updated with latest results.

…erver - also fixes the usecase screen becoming stuck with an invalid homeserver deeplink

…s with breaking down UnknownHost exceptioncauses and shouldn't be used for checking offline status

- the viewmodel is now responsible for inferring connectivity errors and providing a retry action

…uild version checks

ouchadam · 2022-05-25T16:33:15Z

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

        // Nothing to do
    }
-
-    override fun onError(throwable: Throwable) {


handled by the FtueVariant -> OnboardingViewEvents observer

ericdecanini

LGTM

ericdecanini · 2022-05-26T08:29:34Z

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

+
+    @Provides
+    @Singleton
+    fun providesBuildMeta() = BuildMeta()


Awesome idea!

onurays · 2022-05-26T13:41:31Z

vector/src/main/java/im/vector/app/core/extensions/Context.kt

+ */
+@Suppress("deprecation")
+@SuppressLint("NewApi") // false positive
+fun Context.inferNoConnectivity(buildMeta: BuildMeta): Boolean {


Should we add a description about buildMeta parameter?

will add some java doc 👍

onurays · 2022-05-26T13:46:27Z

vector/src/main/java/im/vector/app/core/extensions/Context.kt

+            networkCapabilities?.hasTransport(NetworkCapabilities.TRANSPORT_CELLULAR) == true -> false
+            networkCapabilities?.hasTransport(NetworkCapabilities.TRANSPORT_WIFI) == true     -> false
+            networkCapabilities?.hasTransport(NetworkCapabilities.TRANSPORT_VPN) == true      -> false
+            else                                                                              -> true


This might be a silly question/use case but should we check the internet connection over TRANSPORT_ETHERNET and TRANSPORT_BLUETOOTH?

good catch! I will double check if hasTransport considers bluetooth as an internet provider or simply if a bluetooth connection is present

onurays

LGTM, just one remark.

ouchadam · 2022-05-31T08:31:04Z

ahh sorry @onurays I merged too soon, I will address your comments in another PR

github-actions · 2022-05-31T09:08:40Z

Matrix SDK

Integration Tests Results:

[org.matrix.android.sdk.session]
= passed=20 failures=0 errors=0 skipped=3
[org.matrix.android.sdk.account]
= passed=3 failures=0 errors=0 skipped=2
[org.matrix.android.sdk.internal]
= passed=20 failures=1 errors=0 skipped=1
[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

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

ouchadam commented May 12, 2022

View reviewed changes

ouchadam mentioned this pull request May 13, 2022

FTUE - Sign up analytics #6042

Merged

6 tasks

ouchadam force-pushed the feature/adm/ftue-sign-in branch 2 times, most recently from a0fcef6 to 8c44c98 Compare May 25, 2022 09:30

ouchadam added 10 commits May 25, 2022 13:34

providing dedicated reset action for resetting invalid deeplink homes…

690fda1

…erver - also fixes the usecase screen becoming stuck with an invalid homeserver deeplink

extracting server selection branches to their own functions

b8418f9

downscoping the possible action types when selecting homeservers

59afb5c

adding helper for inferring if the device has connectivity, this help…

100aa24

…s with breaking down UnknownHost exceptioncauses and shouldn't be used for checking offline status

lifting unavailable homeserver rendering to the activity/ftuevariant

ea7df9b

- the viewmodel is now responsible for inferring connectivity errors and providing a retry action

creating a build meta abstraction for allowing testing classes with b…

797e0ee

…uild version checks

adding test case around invalid deeplinks within the onboarding flow

75d038b

adding changelog entry

73c9395

removing extra line

f6190b1

formatting

86c9e60

ouchadam force-pushed the feature/adm/ftue-deeplinks branch from 48f0303 to 86c9e60 Compare May 25, 2022 12:36

Base automatically changed from feature/adm/ftue-sign-in to develop May 25, 2022 16:30

ouchadam marked this pull request as ready for review May 25, 2022 16:30

ouchadam commented May 25, 2022

View reviewed changes

giving arugment a proper name

096db6c

ouchadam requested review from a team, ericdecanini and onurays and removed request for a team May 25, 2022 16:34

ericdecanini approved these changes May 26, 2022

View reviewed changes

onurays reviewed May 26, 2022

View reviewed changes

onurays approved these changes May 26, 2022

View reviewed changes

ouchadam merged commit 7fdf138 into develop May 31, 2022

ouchadam deleted the feature/adm/ftue-deeplinks branch May 31, 2022 08:30

ouchadam mentioned this pull request May 31, 2022

Configure link to define custom homeserver/identity server automatically from https://app.element.io/mobile_guide/ does not work (mobile.element.io) #5748

Closed

FTUE - Homeserver sign in/up deeplinks #6036

FTUE - Homeserver sign in/up deeplinks #6036

Uh oh!

Conversation

ouchadam commented May 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of change

Content

Motivation and context

Screenshots / GIFs

Legacy flows

FTUE flows

Offline deeplink

Tests

Tested devices

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ericdecanini left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

onurays left a comment

Choose a reason for hiding this comment

Uh oh!

ouchadam commented May 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 31, 2022

Matrix SDK

Integration Tests Results:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ouchadam commented May 12, 2022 •

edited

Loading

github-actions bot commented May 12, 2022 •

edited

Loading

ouchadam commented May 31, 2022 •

edited

Loading