[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [$500] [Guided Setup] Refreshing the page with the onboarding flow closes it and never shows it again

[mountiny]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number:
Reproducible in staging?:
Reproducible in production?:
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @yuwenmemon
Slack conversation: internal https://expensify.slack.com/archives/C036QM0SLJK/p1718140438433339

Action Performed:

Break down in numbered steps

1. Sign up with fresh new account
2. Verify you can see the onboarding modal
3. Refresh the browser tab

Expected Result:

Describe what you think should've happened

The onboarding modal is shown until you complete it, you cannot skip it

Actual Result:

Describe what actually happened

The onboarding modal was closed and does not show up again

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

Kapture.2024-06-11.at.14.13.17.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01b7cc757137685065
• Upwork Job ID: 1800874213746714078
• Last Price Increase: 2024-06-12
• Automatic offers:
• hungvu193 | Reviewer | 102710630
• ishpaul777 | Contributor | 102710631

Issue Owner

Current Issue Owner: @johncschuster

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01b7cc757137685065

[melvin-bot]

Triggered auto assignment to @johncschuster (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @hungvu193 (External)

[melvin-bot]

Upwork job price has been updated to $500

[ishpaul777]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Refreshing the page with the onboarding flow closes it and never shows it again

What is the root cause of that problem?

In here we are deem hasCompletedGuidedSetupFlow to be true when its undefined.

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Line 28 in 4d8d46c

selector: (onboarding) => !Array.isArray(onboarding) && (onboarding?.hasCompletedGuidedSetupFlow ?? true),

here we navigate if hasCompletedGuidedSetupFlow is true

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Lines 31 to 41 in 4d8d46c

	useEffect(() => {
	if (!hasCompletedGuidedSetupFlow) {
	return;
	}
	Navigation.isNavigationReady().then(() => {
	// Need to go back to previous route and then redirect to Concierge,
	// otherwise going back on Concierge will go to onboarding and then redirected to Concierge again
	Navigation.goBack();
	Report.navigateToConciergeChat();
	});
	}, [hasCompletedGuidedSetupFlow]);

What changes do you think we should make in order to solve the problem?

we should not default hasCompletedGuidedSetupFlow to true, we need to update selector for hasCompletedGuidedSetupFlow like below, for old accounts NVP_ONBOARDING will be array so we consider hasCompletedGuidedSetupFlow to be true always.

const [hasCompletedGuidedSetupFlow] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {
        selector: (onboarding) => {
            if (Array.isArray(onboarding)) {
                return true;
            }

            return onboarding?.hasCompletedGuidedSetupFlow;
        }
    });

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Line 28 in 4d8d46c

selector: (onboarding) => !Array.isArray(onboarding) && (onboarding?.hasCompletedGuidedSetupFlow ?? true),

Video:

Screen.Recording.2024-06-12.at.6.58.28.PM.mov

What alternative solutions did you explore? (Optional)

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[cretadn22]

Proposal

Please re-state the problem that we are trying to solve in this issue.

What is the root cause of that problem?

We implement logic to hide the onboarding modal if users complete it

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Lines 31 to 38 in 4d8d46c

	useEffect(() => {
	if (!hasCompletedGuidedSetupFlow) {
	return;
	}
	Navigation.isNavigationReady().then(() => {
	// Need to go back to previous route and then redirect to Concierge,
	// otherwise going back on Concierge will go to onboarding and then redirected to Concierge again
	Navigation.goBack();

But we set default value for hasCompletedGuidedSetupFlow if the data in ONYX isn't available

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Lines 27 to 29 in 4d8d46c

	const [hasCompletedGuidedSetupFlow] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {
	selector: (onboarding) => !Array.isArray(onboarding) && (onboarding?.hasCompletedGuidedSetupFlow ?? true),
	});

What changes do you think we should make in order to solve the problem?

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Lines 35 to 40 in 4d8d46c

	Navigation.isNavigationReady().then(() => {
	// Need to go back to previous route and then redirect to Concierge,
	// otherwise going back on Concierge will go to onboarding and then redirected to Concierge again
	Navigation.goBack();
	Report.navigateToConciergeChat();
	});

Here, we'll navigate to the CentralPaneNavigator. Then, I propose implementing a logic to redirect to the onboarding modal if the hasCompletedGuidedSetupFlow is false (after the onyx field is available)

Let's add this logic in the BaseCentralPaneNavigator.

    const [hasCompletedGuidedSetupFlow] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {
        selector: (onboarding) => !Array.isArray(onboarding) && (onboarding?.hasCompletedGuidedSetupFlow ?? true),
    });
  
    useEffect(() => {
            if (!hasCompletedGuidedSetupFlow) {
                Navigation.navigate(ROUTES.ONBOARDING_PURPOSE);
            }
    
    }, [hasCompletedGuidedSetupFlow]);

What alternative solutions did you explore? (Optional)

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[ishpaul777]

this was a close one @cretadn22 😃

[hungvu193]

We can go with @ishpaul777 's proposal

🎀👀🎀 C+ reviewed

[melvin-bot]

Current assignee @mountiny is eligible for the choreEngineerContributorManagement assigner, not assigning anyone new.

[cretadn22]

Both proposal is posted in the same time. @hungvu193 Should we split payment for me and @ishpaul777 and I will create PR for this one? It will be a more harmonious for both. @ishpaul777 What do you think about this suggestion?

[mountiny]

@ishpaul777 if we do your changes, the onboarding flow will show up for old accounts or accounts created in Olddot. They do not have the onboarding?.hasCompletedGuidedSetupFlow defined and we should not show them the onboarding flow

[hungvu193]

What's its default value for new account? If it's false then we can add an extra condition to handle that case.

[cretadn22]

@hungvu193 Updated proposal

[hungvu193]

I'm having trouble while testing account that was created from old dot. I'll try again in a while...

Screen.Recording.2024-06-12.at.22.21.17.mov

[ishpaul777]

@mountiny sorry for delay. here it says that old accounts have the array for nvp_onboarding and i tested that for olddot it is also a array so it works just fine 🤔

App/src/ONYXKEYS.ts

Lines 599 to 600 in 06bdf11

	// NVP_ONBOARDING is an array for old users.
	[ONYXKEYS.NVP_ONBOARDING]: Onboarding | [];

we have this !Array.isArray(onboarding) which will prevent it for opening for those accounts

App/src/libs/Navigation/AppNavigator/Navigators/OnboardingModalNavigator.tsx

Line 28 in 79e619a

selector: (onboarding) => !Array.isArray(onboarding) && (onboarding?.hasCompletedGuidedSetupFlow ?? true),

[hungvu193]

With old account, !Array.isArray(onboarding) is true and onboarding?.hasCompletedGuideSetupFlow will be false if we remove ?? true.
So it will make hasCompletedGuideSetupFlow return false and popup will open.

[ishpaul777]

Ah i got it! then we can just change this condition like below:

const [hasCompletedGuidedSetupFlow] = useOnyx(ONYXKEYS.NVP_ONBOARDING, {
        selector: (onboarding) => {
            if (Array.isArray(onboarding)) {
                return true;
            }

            return onboarding?.hasCompletedGuidedSetupFlow;
        }
    });

New Account:

Screen.Recording.2024-06-12.at.10.08.53.PM.mov

Old Account:

Screen.Recording.2024-06-12.at.10.12.35.PM.mov

[ishpaul777]

@hungvu193 I have updated my proposal

[melvin-bot]

📣 @ishpaul777 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[mountiny]

@ishpaul777 alright, I think that works, please raise the pr when you can, thanks

[ishpaul777]

Thanks for assigning Vit, I'll raise a Pr in ~2 hours

[ishpaul777]

@hungvu193 PR ^ is ready for your review!

[hungvu193]

Cool. I'll review it today

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.84-3 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fixes "Refreshing the page with the onboarding flow closes it and never shows it again" #43648

If no regressions arise, payment will be issued on 2024-06-24. 🎊

For reference, here are some details about the assignees on this issue:

• @hungvu193 requires payment automatic offer (Reviewer)
• @ishpaul777 requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@hungvu193 / @ishpaul777] The PR that introduced the bug has been identified. Link to the PR:
• [@hungvu193 / @ishpaul777] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@hungvu193 / @ishpaul777] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@hungvu193 / @ishpaul777] Determine if we should create a regression test for this bug.
• [@hungvu193 / @ishpaul777] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@johncschuster] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.85-7 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fixes "Refreshing the page with the onboarding flow closes it and never shows it again" #43648

If no regressions arise, payment will be issued on 2024-06-28. 🎊

For reference, here are some details about the assignees on this issue:

• @hungvu193 requires payment automatic offer (Reviewer)
• @ishpaul777 requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@hungvu193 / @ishpaul777] The PR that introduced the bug has been identified. Link to the PR:
• [@hungvu193 / @ishpaul777] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@hungvu193 / @ishpaul777] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@hungvu193 / @ishpaul777] Determine if we should create a regression test for this bug.
• [@hungvu193 / @ishpaul777] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@johncschuster] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[johncschuster]

@hungvu193 / @ishpaul777 can you address the BZ Checklist when you get a moment? Thank you!

[hungvu193]

• The PR that introduced the bug has been identified. Link to the PR: https://github.com/Expensify/App/pull/42087/files
• The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: https://github.com/Expensify/App/pull/42087/files#r1651206632
• A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: N/A
• Determine if we should create a regression test for this bug: Yes

Regression test:

1. Sign up with fresh new account.
2. Verify you can see the onboarding modal.
3. Refresh the browser tab.
4. Verify that on boarding modal will show up.

Do we 👍 or 👎 ?

[johncschuster]

Payment has been issued. Thanks for your contributions! 🎉