final "on my own" flow updates #10892

thanksameeelian · 2023-06-22T14:32:51Z

Summary

final updates to "on my own" flow: in concert with recently-merged BE changes, this PR introduces specific behavior for "on my own" users upon exiting the setup wizard - "on my own" users will now be redirected right to Learn > Library and greeted by a welcome message once there (just as they were previously greeted by a welcome modal when they were redirected to Device after completing setup).

Before - redirected to `Learn` > `Home` with no welcome modal

(before very recent & related BE changes, would redirect to Device with welcome modal)

before-learn-home.mov

After - redirected to `Learn` > `Library` with customized message in welcome modal

after-learn-library-redirect.mov

References

closes #10760 (in combination with #11019, which is already merged)

Reviewer guidance

start a fresh kolibri instance
progress through the setup wizard as an "on my own" user
once setup has finalized, expect to be redirected to Learn > Library & greeted by a dismissable welcome modal
once dismissed, the welcome modal should not re-render upon navigating to Device for the first time, on subsequent re-visits to Library, or in any other scenarios.

Testing checklist

Contributor has fully tested the PR manually
If there are any front-end changes, before/after screenshots are included

PR process

PR has the correct target branch and milestone
PR has 'needs review' or 'work-in-progress' label
If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')

Reviewer checklist

Automated test coverage is satisfactory
PR is fully functional
PR has been tested for accessibility regressions
External dependency files were updated if necessary (yarn and pip)
Documentation is updated
Contributor is in AUTHORS.md

github-actions · 2023-06-22T15:06:50Z

Build Artifacts

Asset type	Download link
PEX file	kolibri-0.16.0b2.dev0_git.10.g86e84d1c.pex
Windows Installer (EXE)	kolibri-0.16.0b2.dev0+git.10.g86e84d1c-unsigned.exe
Debian Package	kolibri_0.16.0b2.dev0+git.10.g86e84d1c-0ubuntu1_all.deb
Mac Installer (DMG)	kolibri-0.16.0b2.dev0+git.10.g86e84d1c-0.3.0.dmg
TAR file	kolibri-0.16.0b2.dev0+git.10.g86e84d1c.tar.gz
WHL file	kolibri-0.16.0b2.dev0+git.10.g86e84d1c-py2.py3-none-any.whl

rtibbles

I think I'd prefer a cleaner approach here that relied more on internal behaviour within plugins rather than cross plugin redirects.

kolibri/plugins/learn/assets/src/app.js

kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue

rtibbles

All seems to be working as intended, just some suggestions for cleanup.

rtibbles · 2023-08-02T22:29:20Z

kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue

      this.search();
+      if (window.sessionStorage.getItem(welcomeDimissalKey) !== 'true') {


This could be used directly in the vuex initial state to set the value.

rtibbles · 2023-08-02T22:30:51Z

kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue

@@ -507,7 +507,12 @@
      },
    },
    created() {
+      const welcomeDimissalKey = 'DEVICE_WELCOME_MODAL_DISMISSED';


I'd suggest moving this constant into a common file, maybe in kolibri-common (for reuse across device, learn, and setup wizard plugins).

It is called DEVICE_WELCOME_MODAL_DISMISSED not COMMON_... though 🤣

Now that I've actually gone and tested the fix I realize the silliness of my previous comment 😬 😆

rtibbles · 2023-08-02T22:32:04Z

kolibri/plugins/learn/assets/src/views/LearnIndex.vue

@@ -16,17 +23,30 @@
  import NotificationsRoot from 'kolibri.coreVue.components.NotificationsRoot';
  import plugin_data from 'plugin_data';
  import { PageNames } from '../constants';
+  import PostSetupModalGroup from '../../../../device/assets/src/views/PostSetupModalGroup.vue';


Ideally, I'd want to move this to kolibri-common rather than have so many .. - but we can also move all this cleanup to a follow up if you'd prefer.

kolibri/plugins/learn/assets/src/views/LearnIndex.vue

nucleogenesis

I did some local testing on this and worked as expected so LGTM, the code looks good as well.

I'll leave the approval to Richard re: the follow-up business moving things to kolibri-common.

nucleogenesis · 2023-08-03T05:17:16Z

kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue

@@ -507,7 +507,12 @@
      },
    },
    created() {
+      const welcomeDimissalKey = 'DEVICE_WELCOME_MODAL_DISMISSED';


It is called DEVICE_WELCOME_MODAL_DISMISSED not COMMON_... though 🤣

nucleogenesis · 2023-08-03T05:32:33Z

kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue

@@ -507,7 +507,12 @@
      },
    },
    created() {
+      const welcomeDimissalKey = 'DEVICE_WELCOME_MODAL_DISMISSED';


Now that I've actually gone and tested the fix I realize the silliness of my previous comment 😬 😆

rtibbles

Code changes make sense, and my suggestions only made things break, so let's move forward with this!

github-actions bot added APP: Learn Re: Learn App (content, quizzes, lessons, etc.) APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) SIZE: small labels Jun 22, 2023

rtibbles reviewed Jun 22, 2023

View reviewed changes

kolibri/plugins/learn/assets/src/app.js Outdated Show resolved Hide resolved

kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue Outdated Show resolved Hide resolved

thanksameeelian force-pushed the final-on-my-own-flow-updates branch from 9a88ff3 to a48084b Compare July 26, 2023 21:13

github-actions bot added SIZE: very small and removed APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) labels Jul 26, 2023

thanksameeelian force-pushed the final-on-my-own-flow-updates branch from a48084b to a4d830b Compare July 28, 2023 08:45

github-actions bot added the APP: Device Re: Device App (content import/export, facility-syncing, user permissions, etc.) label Jul 28, 2023

thanksameeelian removed APP: Device Re: Device App (content import/export, facility-syncing, user permissions, etc.) SIZE: very small labels Jul 28, 2023

thanksameeelian requested review from rtibbles, nucleogenesis and marcellamaki July 28, 2023 09:31

thanksameeelian added this to the Kolibri 0.16 Release: Bugs and Regressions milestone Jul 28, 2023

thanksameeelian added the TODO: needs review Waiting for review label Jul 28, 2023

thanksameeelian marked this pull request as ready for review July 28, 2023 09:33

rtibbles changed the base branch from develop to release-v0.16.x August 2, 2023 19:10

rtibbles reviewed Aug 2, 2023

View reviewed changes

nucleogenesis reviewed Aug 3, 2023

View reviewed changes

thanksameeelian force-pushed the final-on-my-own-flow-updates branch from a4d830b to d30b940 Compare August 15, 2023 19:14

github-actions bot added DEV: backend Python, databases, networking, filesystem... APP: Device Re: Device App (content import/export, facility-syncing, user permissions, etc.) APP: Coach Re: Coach App (lessons, quizzes, groups, reports, etc.) SIZE: very large labels Aug 15, 2023

thanksameeelian added 3 commits August 16, 2023 09:53

add channel length condition to learn root redirect

5ee6d0f

add functional welcome modal to learn

14ef9c4

introduce useSessionStorage

f6075a8

thanksameeelian force-pushed the final-on-my-own-flow-updates branch from d30b940 to f6075a8 Compare August 16, 2023 16:19

github-actions bot removed DEV: backend Python, databases, networking, filesystem... APP: Coach Re: Coach App (lessons, quizzes, groups, reports, etc.) labels Aug 16, 2023

correct typo in welcomeDismissalKey variable name

1ac19b8

github-actions bot added the APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) label Aug 16, 2023

thanksameeelian removed APP: Device Re: Device App (content import/export, facility-syncing, user permissions, etc.) APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) SIZE: very large labels Aug 16, 2023

github-actions bot added APP: Device Re: Device App (content import/export, facility-syncing, user permissions, etc.) APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) labels Aug 17, 2023

revert to using window session storage

171c18a

thanksameeelian force-pushed the final-on-my-own-flow-updates branch from ff1da7e to 171c18a Compare August 17, 2023 16:29

rtibbles approved these changes Aug 17, 2023

View reviewed changes

rtibbles merged commit 3206e21 into learningequality:release-v0.16.x Aug 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

final "on my own" flow updates #10892

final "on my own" flow updates #10892

thanksameeelian commented Jun 22, 2023 •

edited

Loading

github-actions bot commented Jun 22, 2023 •

edited

Loading

rtibbles left a comment

rtibbles left a comment

rtibbles Aug 2, 2023

rtibbles Aug 2, 2023

nucleogenesis Aug 3, 2023

nucleogenesis Aug 3, 2023

rtibbles Aug 2, 2023

nucleogenesis left a comment

nucleogenesis Aug 3, 2023

nucleogenesis Aug 3, 2023

rtibbles left a comment

		this.search();
		if (window.sessionStorage.getItem(welcomeDimissalKey) !== 'true') {

final "on my own" flow updates #10892

final "on my own" flow updates #10892

Conversation

thanksameeelian commented Jun 22, 2023 • edited Loading

Summary

Before - redirected to Learn > Home with no welcome modal

After - redirected to Learn > Library with customized message in welcome modal

References

Reviewer guidance

Testing checklist

PR process

Reviewer checklist

github-actions bot commented Jun 22, 2023 • edited Loading

rtibbles left a comment

Choose a reason for hiding this comment

rtibbles 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

nucleogenesis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtibbles left a comment

Choose a reason for hiding this comment

thanksameeelian commented Jun 22, 2023 •

edited

Loading

Before - redirected to `Learn` > `Home` with no welcome modal

After - redirected to `Learn` > `Library` with customized message in welcome modal

github-actions bot commented Jun 22, 2023 •

edited

Loading