Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make onboarding continue from last visited onboarding page #47472

Merged
merged 4 commits into from
Aug 27, 2024

Conversation

tsa321
Copy link
Contributor

@tsa321 tsa321 commented Aug 15, 2024

Details

Fixed Issues

$ #46104
PROPOSAL: #46104 (comment)

Tests

  1. Sign in as a new user -> Join
  2. Verify that the onboarding modal is displayed.
  3. Select Manage my team's expenses.
  4. Change the URL to a random URL after .com, for example, /aaa (for desktop, enter the URL in the browser as new-expensify:/aaa and press Enter).
  5. Verify that the onboarding modal work page is displayed.
  6. Change the URL after .com to /settings/profile (for desktop, enter the URL in the browser as new-expensify:/settings/profile and press Enter).
  7. Verify that the onboarding modal work page is displayed.
  8. Fill in the business name and click Continue.
  9. Complete the onboarding flow.
  10. Verify that the explanation modal appears properly.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Sign in as a new user -> Join
  2. Verify that the onboarding modal is displayed.
  3. Select Manage my team's expenses.
  4. Change the URL to a random URL after .com, for example, /aaa (for desktop, enter the URL in the browser as new-expensify:/aaa and press Enter).
  5. Verify that the onboarding modal work page is displayed.
  6. Change the URL after .com to /settings/profile (for desktop, enter the URL in the browser as new-expensify:/settings/profile and press Enter).
  7. Verify that the onboarding modal work page is displayed.
  8. Fill in the business name and click Continue.
  9. Complete the onboarding flow.
  10. Verify that the explanation modal appears properly.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
android-native-d.mp4
Android: mWeb Chrome
android-mweb_d.mp4
iOS: Native
ios-native_d.mp4
iOS: mWeb Safari
ios-msfari_d.mp4
MacOS: Chrome / Safari
macos-web-d.mp4
MacOS: Desktop
macos-desktop_d.mp4

@tsa321 tsa321 requested a review from a team as a code owner August 15, 2024 02:49
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team August 15, 2024 02:49
Copy link

melvin-bot bot commented Aug 15, 2024

@mollfpr Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 15, 2024

@mollfpr In android and ios native, the LAST_VISITED_PATH is always cleared when starting the app:

App/src/setup/index.ts

Lines 42 to 43 in 57ef25c

// Always open the home route on app startup for native platforms by clearing the lastVisitedPath
[ONYXKEYS.LAST_VISITED_PATH]: initializeLastVisitedPath(),

The initializeLastVisitedPath() function returns an empty string for native. The Android and iOS video tests I attached above were conducted after I removed that line.

To address this, should we create a new Onyx key, lastVisitedOnboardingPath, and update it near updateLastVisitedPath when the path starts with /onboarding?

Comment on lines 70 to 69
const {adaptedState} = getAdaptedStateFromPath(ROUTES.ONBOARDING_ROOT.route, linkingConfig.config);
navigationRef.resetRoot(adaptedState);
Navigation.resetToHome();
Navigation.navigate(Welcome.getInitialOnboardingPath());
Copy link
Contributor Author

@tsa321 tsa321 Aug 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am changing this line to Navigation.resetHome because it causes some bugs when I use the same code in welcome of Report.openReportFromDeepLink:

Back to personal details
back_to_personal_detaisl-d.mp4
Click next on purpose back to purpose:
click_next_back_to_purpose-d.mp4

Welcome.isOnboardingFlowCompleted({onNotCompleted: () => Navigation.navigate(ROUTES.ONBOARDING_ROOT.getRoute())});
Welcome.isOnboardingFlowCompleted({
onNotCompleted: () => {
Navigation.resetToHome();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fix the issue where a random URL leads to a "not-found" screen and the onboarding modal will disappears after clicking "next" on the purpose page, as mentioned in the issue.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 15, 2024

@mollfpr, there is also a bug in the main: when a user fills out the work page/business name, clicks "continue" to go to the personal details page, then refreshes the page and clicks the back button, the purpose page is displayed instead of the work page. So I think this is out of scope.

back to purpose instead of work page:
back_to_purpose.mp4

@mollfpr
Copy link
Contributor

mollfpr commented Aug 18, 2024

Sorry for the delay 🙏

To address this, should we create a new Onyx key, lastVisitedOnboardingPath, and update it near updateLastVisitedPath when the path starts with /onboarding?

Yes! I think we can implement the original proposal.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 19, 2024

@mollfpr I have added the onboarding last visited path on onyx.

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay! Mostly the changes and the result look good, but I have an issue after signing up the onboarding modal is not showing until I refresh the page.

Screen.Recording.2024-08-22.at.21.10.52.mp4

}

onboardingInitialPath = value.substring(1);
Onyx.disconnect(onboardingLastVisitedPathConnection);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to disconnect here?

Copy link
Contributor Author

@tsa321 tsa321 Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we only need the initial value when the user opens the app or URL. I have tested it, the onboarding is triggered from bottomTabBar and openReportFromDeepLink, leading to navigation changes that affect the lastVisitedPath and will open incorrect page.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 22, 2024

Sorry for the delay! Mostly the changes and the result look good, but I have an issue after signing up the onboarding modal is not showing until I refresh the page.
Screen.Recording.2024-08-22.at.21.10.52.mp4

I tested mostly on legacy mode.
I will try in strict mode.

@tsa321

This comment was marked as outdated.

@mollfpr
Copy link
Contributor

mollfpr commented Aug 22, 2024

Thanks for the investigation @tsa321!

Sure, I'll give it a try! Just wondering if this will be the production build or not.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 22, 2024

@mollfpr The double mount is in Dev mode, more info in: PR
In production, the double mount won't be happening.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 24, 2024

@mollfpr Please disregard my previous comment here.

The correct way to disable strict mode is, in this line:

USE_REACT_STRICT_MODE: true,

Change the value to false.

I have squashed all the commits to make the history cleaner.
Could you review this PR again? Thank you...

@tsa321 tsa321 requested a review from mollfpr August 24, 2024 16:56
@tsa321

This comment was marked as outdated.

Navigation.dismissModal();
// Navigate to HOME instead of dismissModal, because there is bug in small screen
// where the onboarding puropose page will be disaplayed briefly
Navigation.navigate(ROUTES.HOME);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am changing dismissModal to navigate HOME because there is a bug:

Onboarding purpose disaplyed briefly:
home-instead-of-dismiss-d.mp4

@@ -180,6 +202,11 @@ function completeHybridAppOnboarding() {
API.write(WRITE_COMMANDS.COMPLETE_HYBRID_APP_ONBOARDING, {}, {optimisticData, failureData});
}

function startOnboardingFlow() {
const {adaptedState} = getAdaptedStateFromPath(getOnboardingInitialPath(), linkingConfig.config, false);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really need to add an optional parameter to getAdaptedStateFromPath because it is causing this bug:

The path is being appended to the URL inserted by the user:

Incorrect URL path:
incorrect-path-d.mp4

onCompleted?.();
} else {
} else if (!isOnboardingInProgress) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prevents multiple onboarding flow running causing navigation issue.

@@ -365,7 +365,7 @@ function getAdaptedState(state: PartialState<NavigationState<RootStackParamList>
};
}

const getAdaptedStateFromPath: GetAdaptedStateFromPath = (path, options) => {
const getAdaptedStateFromPath: GetAdaptedStateFromPath = (path, options, shouldReplacePathInNestedState = true) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am adding an optional parameter here, I really need it, more info here.

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 25, 2024

@mollfpr, PR is ready for review again. Just a reminder:

To test, disable strict mode on this line:

USE_REACT_STRICT_MODE: true,

Change the value to false. This is what we will see in staging/production.

@mollfpr
Copy link
Contributor

mollfpr commented Aug 27, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
47472.Android.mp4
Android: mWeb Chrome
47472.mWeb-Chrome.mp4
iOS: Native
47472.iOS.mov
iOS: mWeb Safari
47472.Safari.mov
MacOS: Chrome / Safari
47472.Web.mp4
MacOS: Desktop
47472.Desktop.mp4

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Also, the result on web still good under the strict mode true.

@melvin-bot melvin-bot bot requested a review from chiragsalian August 27, 2024 19:04
@chiragsalian
Copy link
Contributor

I had to revert this PR since it caused a number of workflow failures. Please create another PR and ensure you are up to date so that GH actions runs on the latest code 🙂

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.0.26-1 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@tsa321
Copy link
Contributor Author

tsa321 commented Aug 30, 2024

@kavimuru, yes, this was reverted by #48135 due to lint and typecheck errors during merging.

Maybe next time, we might want to change the title to No QA Reverted?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants