FTUE - Sign up analytics #6042

ouchadam · 2022-05-13T08:12:21Z

Type of change

WIP Feature
Bugfix
Technical
Other :

Content

Fixes #5285

Adds SignUp event tracking after the user creates an account AND consents to tracking.

Creates an AuthenticationDescription abstraction and also sets the ground work for tracking sign in in the future.
Chains the AuthenticationDescription through to the HomeActivity in order to be tracked

Motivation and context

To enable the collection of sign up metrics (and sign up type)

Screenshots / GIFs

No UI changes

D/Analytics: capture(Signup(authenticationType=Password))

Tests

With the combined login feature flag enabled
Create an account
Notice the SignUp tracking event in posthog

Tested devices

Physical
Emulator
OS version(s): 28

github-actions · 2022-05-13T08:46:28Z

Unit Test Results

146 files ±0 146 suites ±0 2m 41s ⏱️ +9s
236 tests ±0 236 ✔️ ±0 0 💤 ±0 0 ❌ ±0
788 runs ±0 788 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit db3cb42. ± Comparison against base commit e6beb73.

♻️ This comment has been updated with latest results.

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

…he id

…n up after the user has consented to tracking

…tivity arguments

ouchadam · 2022-06-01T12:50:44Z

vector/src/main/java/im/vector/app/features/home/HomeActivityViewModel.kt

@@ -113,9 +121,31 @@ class HomeActivityViewModel @AssistedInject constructor(
                        }
                    }
                    .launchIn(viewModelScope)
+
+            initialState.authenticationDescription?.let { recentAuthentication ->


the view model handles the account sign up tracking (and potentially sign in in the future), if a authenticationDescription has been passed to the HomeActivity

ouchadam · 2022-06-01T12:51:34Z

vector/src/main/java/im/vector/app/features/login/LoginFragment.kt

@@ -202,11 +203,11 @@ class LoginFragment @Inject constructor() : AbstractSSOLoginFragment<FragmentLog
                views.loginSocialLoginContainer.isVisible = true
                views.loginSocialLoginButtons.ssoIdentityProviders = state.loginMode.ssoIdentityProviders?.sorted()
                views.loginSocialLoginButtons.listener = object : SocialLoginButtonsView.InteractionListener {
-                    override fun onProviderSelected(id: String?) {
+                    override fun onProviderSelected(provider: SsoIdentityProvider?) {


we need to know the SsoIdentityProvider in order to provide a tracking value (only used by the FTUE classes)

ouchadam · 2022-06-01T12:54:17Z

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

@@ -745,8 +754,12 @@ class OnboardingViewModel @AssistedInject constructor(
        return loginConfig?.homeServerUrl
    }

-    fun getSsoUrl(redirectUrl: String, deviceId: String?, providerId: String?): String? {
-        return authenticationService.getSsoUrl(redirectUrl, deviceId, providerId)
+    fun getSsoUrl(redirectUrl: String, deviceId: String?, provider: SsoIdentityProvider?): String? {


I wasn't sure about adding a side effect to store the current SSO Provider here but the activity results and web redirects lose the information about the currently selected SSO Provider

Interestingly I think changing the name fetchSsoUrl would justify the side effect, since fetch communicates that it's more than just a simple getter

agreed! db3cb42

bmarty

LGTM, just a few feedback.

bmarty · 2022-06-02T10:58:22Z

vector/src/main/java/im/vector/app/features/home/HomeActivityViewModel.kt

@@ -113,9 +121,31 @@ class HomeActivityViewModel @AssistedInject constructor(
                        }
                    }
                    .launchIn(viewModelScope)
+
+            initialState.authenticationDescription?.let { recentAuthentication ->


Maybe remove this line and add null -> Unit case in the when below.

bmarty · 2022-06-02T10:59:37Z

vector/src/main/java/im/vector/app/features/home/HomeActivityViewModel.kt

@@ -395,7 +425,7 @@ class HomeActivityViewModel @AssistedInject constructor(
            HomeActivityViewActions.PushPromptHasBeenReviewed -> {
                vectorPreferences.setDidAskUserToEnableSessionPush()
            }
-            HomeActivityViewActions.ViewStarted               -> {
+            is HomeActivityViewActions.ViewStarted            -> {


This change is not necessary I think.

good catch! 6fcbd24 (originally the authentication description was held in the ViewStarted but develop moved the state to the initialState)

bmarty · 2022-06-02T11:04:39Z

vector/src/main/java/im/vector/app/features/login/LoginActivity.kt

-                    this,
-                    accountCreation = loginViewState.signMode == SignMode.SignUp
-            )
+            val intent = HomeActivity.newIntent(this)


Just to be sure to understand, why don't we pass a value for authenticationDescription param here?
Applicable to all HomeActivity.newIntent invocation.

it's because the sign up tracking has only been implemented for the FTUE flow, the previous accountCreation was unused , although now I can see that develop has changed make use of the flag for secure backup/cross signing

will look to reintroduce

ericdecanini

LGTM!

ericdecanini · 2022-06-03T10:56:08Z

vector/src/main/java/im/vector/app/features/analytics/extensions/SignUpExt.kt

+    AuthenticationDescription.AuthenticationType.Github   -> Signup.AuthenticationType.GitHub
+    AuthenticationDescription.AuthenticationType.Gitlab   -> Signup.AuthenticationType.GitLab


Super optional nitpick

Suggested change

AuthenticationDescription.AuthenticationType.Github -> Signup.AuthenticationType.GitHub

AuthenticationDescription.AuthenticationType.Gitlab -> Signup.AuthenticationType.GitLab

AuthenticationDescription.AuthenticationType.GitHub -> Signup.AuthenticationType.GitHub

AuthenticationDescription.AuthenticationType.GitLab -> Signup.AuthenticationType.GitLab

ericdecanini · 2022-06-03T13:03:52Z

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

@@ -745,8 +754,12 @@ class OnboardingViewModel @AssistedInject constructor(
        return loginConfig?.homeServerUrl
    }

-    fun getSsoUrl(redirectUrl: String, deviceId: String?, providerId: String?): String? {
-        return authenticationService.getSsoUrl(redirectUrl, deviceId, providerId)
+    fun getSsoUrl(redirectUrl: String, deviceId: String?, provider: SsoIdentityProvider?): String? {


Interestingly I think changing the name fetchSsoUrl would justify the side effect, since fetch communicates that it's more than just a simple getter

…tains any data - it's part of the initialstate instead

…uth description from the sign mode - the type is set to other as the legacy viewmodel doesn't support tracking the sso provider

github-actions · 2022-06-06T13:26:33Z

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=3 failures=0 errors=0 skipped=2
[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 13, 2022

ouchadam force-pushed the feature/adm/ftue-analytics branch from 5391402 to 0999306 Compare May 17, 2022 09:46

ouchadam mentioned this pull request May 24, 2022

Track "Signup" event on Posthog #5841

Closed

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-deeplinks to develop May 31, 2022 08:30

ouchadam force-pushed the feature/adm/ftue-analytics branch 2 times, most recently from aea4d5e to 9878747 Compare May 31, 2022 10:01

ouchadam marked this pull request as ready for review May 31, 2022 10:01

ouchadam added 8 commits June 1, 2022 09:09

lifting unavailable homeserver rendering to the activity/ftuevariant

9110fe8

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

providing the full SSOProvider instead of selection instead of just t…

e89f9ea

…he id

chaining the current authentication type into the onboarding state

ac89495

passing the authentication state from the onboarding and tracking sig…

2805048

…n up after the user has consented to tracking

adding changelog entry

1576516

aligning the with develop to use the initial state for reading the ac…

70c3530

…tivity arguments

removing unused imports

8d3c70f

removing unused imports

d002ab6

ouchadam force-pushed the feature/adm/ftue-analytics branch from 62d9f72 to d002ab6 Compare June 1, 2022 08:11

ouchadam requested review from a team, bmarty and ericdecanini and removed request for a team June 1, 2022 08:11

ouchadam commented Jun 1, 2022

View reviewed changes

bmarty approved these changes Jun 2, 2022

View reviewed changes

ericdecanini approved these changes Jun 3, 2022

View reviewed changes

ouchadam added 3 commits June 6, 2022 10:22

including null case in the authentication when

5d0d177

reverting instance check, no longer needed as the event no longer con…

6fcbd24

…tains any data - it's part of the initialstate instead

handling the legacy onboarding complete navigation by inferring the a…

4993077

…uth description from the sign mode - the type is set to other as the legacy viewmodel doesn't support tracking the sso provider

ouchadam added 2 commits June 6, 2022 11:39

correctly casing github/gitlab

06e67a3

renaming getter to imply the function does more than simply get a value

db3cb42

ouchadam merged commit a5f404f into develop Jun 6, 2022

ouchadam deleted the feature/adm/ftue-analytics branch June 6, 2022 12:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FTUE - Sign up analytics #6042

FTUE - Sign up analytics #6042

ouchadam commented May 13, 2022 •

edited

github-actions bot commented May 13, 2022 •

edited

ouchadam Jun 1, 2022

ouchadam Jun 1, 2022 •

edited

ouchadam Jun 1, 2022 •

edited

ericdecanini Jun 3, 2022

ouchadam Jun 6, 2022

bmarty left a comment

bmarty Jun 2, 2022

ouchadam Jun 6, 2022

bmarty Jun 2, 2022

ouchadam Jun 6, 2022

bmarty Jun 2, 2022

ouchadam Jun 6, 2022

ouchadam Jun 6, 2022

ericdecanini left a comment

ericdecanini Jun 3, 2022

ouchadam Jun 6, 2022

ericdecanini Jun 3, 2022

github-actions bot commented Jun 6, 2022

		AuthenticationDescription.AuthenticationType.Github -> Signup.AuthenticationType.GitHub
		AuthenticationDescription.AuthenticationType.Gitlab -> Signup.AuthenticationType.GitLab

FTUE - Sign up analytics #6042

FTUE - Sign up analytics #6042

Conversation

ouchadam commented May 13, 2022 • edited

Type of change

Content

Motivation and context

Screenshots / GIFs

Tests

Tested devices

github-actions bot commented May 13, 2022 • edited

Unit Test Results

Choose a reason for hiding this comment

ouchadam Jun 1, 2022 • edited

Choose a reason for hiding this comment

ouchadam Jun 1, 2022 • edited

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

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

ericdecanini left a 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

github-actions bot commented Jun 6, 2022

Matrix SDK

Integration Tests Results:

ouchadam commented May 13, 2022 •

edited

github-actions bot commented May 13, 2022 •

edited

ouchadam Jun 1, 2022 •

edited

ouchadam Jun 1, 2022 •

edited