[HOLD for payment 2023-12-04] [$500] Chat - Notification preferences page appears again after refreshing the page

[izarutskaya]

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

---

Issue found when executing PR: #31287

Version Number: v1.4.2-0
Reproducible in staging?: Y
Reproducible in production?: N
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: Applause-Internal Team
Slack conversation: @

Action Performed:

1. Navigate to staging.new.expensify.com.
2. Go to chat.
3. Click on the chat header.
4. Click Notify me about new messages.
5. Refresh the page.
6. Click back button.

Expected Result:

After refreshing the page, the page will not appear for the second time.

Actual Result:

After refreshing the page, the page appears for the second time.

Workaround:

Unknown

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

Bug6286955_1700652985722.20231122_193559.1.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~017688084a85a7d457
• Upwork Job ID: 1727294772186648576
• Last Price Increase: 2023-11-22
• Automatic offers:
• abdulrahuman5196 | Reviewer | 27785229
• tienifr | Contributor | 27785233

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~017688084a85a7d457

[melvin-bot]

Triggered auto assignment to @bfitzexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[melvin-bot]

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

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[melvin-bot]

📣 @github-actions[bot]! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[melvin-bot]

Triggered auto assignment to @Julesssss (Engineering), see https://stackoverflow.com/c/expensify/questions/4319 for more details.

[izarutskaya]

Not reproducible on production

20231122_181149.mp4

[tienifr]

I'm available to raise a PR immediately if assigned

Proposal

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

After refreshing the page, the page appears for the second time.

What is the root cause of that problem?

This comes from this PR #28453

The PR will (correctly) make navigate with PUSH type have PUSH type when dispatching the navigation action, see here, so the navigation here thus pushing the screen to the state one more time, because initially the navigation state is already initialized with the initial route. So when going back it will go back to the same screen.

We didn't recognize this issue earlier because we used to convert 'PUSH' to 'NAVIGATE' before dispatching the navigation action.

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

Before navigation in here, check if the current route is the route we're trying to navigate to (by using Navigation.isActiveRoute), if yes skip the navigation.

if (!Navigation.isActiveRoute(route)) {
    Navigation.navigate(route, CONST.NAVIGATION.ACTION_TYPE.PUSH);
}

That navigation is needed in case of user logged out in native device and deep link, after logged in they should be redirected to the deep link. In that case the Navigation.isActiveRoute(route) will be false and it will still navigate.

What alternative solutions did you explore? (Optional)

Straight revert is also an option but the fix for this is quick so I don't think we need to straight revert.

An alternate solution is in navigate, if the type is PUSH, we'll check isActiveRoute before navigating, this will make sure all places that are using navigate with PUSH will work fine.

Or we can remove CONST.NAVIGATION.ACTION_TYPE.PUSH in the navigate here, but I believed it was added for a reason, so not recommended as much as the main solution.

[Julesssss]

Thanks @tienifr, assigning you now

[melvin-bot]

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

Offer link
Upwork job

[tienifr]

@abdulrahuman5196 yes, I've updated

[abdulrahuman5196]

As such, @tienifr's solution is workaround without fixing the root cause

@situchan Why do you think this? Could you provide context?

[situchan]

@abdulrahuman5196 please check slack discussion

[luacmartins]

This seems to be a wider issue with navigation, see #31661. It affects other places in the App and it's also not that sensitive. I'm gonna remove the blocker label.

[abdulrahuman5196]

This seems to be a wider issue with navigation, see #31661. It affects other places in the App and it's also not that sensitive. I'm gonna remove the blocker label.

FYI: I tested just now and the mentioned issue is also fixed by this PR.

[luacmartins]

That's great. Can you link that issue in the PR?

[AmjedNazzal]

Proposal

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

Chat - Notification preferences page appears again after refreshing the page

What is the root cause of that problem?

This issue and other issues are caused by a flaw in our deepLinking and a section of AuthScreens.js code itself, let's start with AuthScreens.js:

So in the below code we are trying to decide whether the app is opening up completely or just refreshing

App/src/libs/Navigation/AppNavigator/AuthScreens.js

Lines 191 to 195 in a273354

	if (shouldGetAllData) {
	App.openApp();
	} else {
	App.reconnectApp(lastUpdateIDAppliedToClient);
	}

As you can see we are deciding this based on shouldGetAllData which is decided by the following const:

App/src/libs/Navigation/AppNavigator/AuthScreens.js

Lines 160 to 161 in a273354

	const isLoggingInAsNewUser = SessionUtils.isLoggingInAsNewUser(currentUrl, session.email);
	const shouldGetAllData = isUsingMemoryOnlyKeys || SessionUtils.didUserLogInDuringSession() || isLoggingInAsNewUser;

And although this looks fine on the surface, there is a problem with SessionUtils.isLoggingInAsNewUser, the issue is in the use of paramsEmail which would be null during refresh preventing the false return and so every time the user refreshes it's like the user has just signed up.

Now to the issue with deepLinking, in Expensify.js we are calling Report.openReportFromDeepLink which in turn calls Navigation.navigate and passes NAVIGATION.ACTION_TYPE.PUSH regardless if the user actually signed in/Signed up or not causing the observed issue.

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

To begin with we need to fix SessionUtils.isLoggingInAsNewUser to make it return false when paramsEmail is null and thus correctly determining whether or not the user has just logged in/ signed up or just refreshed

function isLoggingInAsNewUser(transitionURL: string, sessionEmail: string): boolean {
  .....
  if(!paramsEmail){
    return false;
}

After that we can make use of the same principle used to decide if the user is refreshing while deciding whether or not to call the InteractionManager within Report.openReportFromDeepLink, we can do that by first passing props.session.email to Report.openReportFromDeepLink in Expensify.js, from there we can check inside Report.openReportFromDeepLink if the user logged in or signed up before calling InteractionManager and passing NAVIGATION.ACTION_TYPE.PUSH

function openReportFromDeepLink(url, isAuthenticated, userEmail) {
  ....
  const isLoggingInAsNewUser = SessionUtils.isLoggingInAsNewUser(url, userEmail);
  const didUserLoginOrSignup = SessionUtils.didUserLogInDuringSession() || isLoggingInAsNewUser;

  if(!didUserLoginOrSignup){
    return;
  }

  InteractionManager.runAfterInteractions(() => {
    .....

Result

[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.3-11 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: 31688 Notification preferences page appears again after refreshing the page #31702

If no regressions arise, payment will be issued on 2023-12-04. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

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

• @abdulrahuman5196 requires payment offer (Reviewer)
• @tienifr requires payment 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:

• [@abdulrahuman5196] The PR that introduced the bug has been identified. Link to the PR:
• [@abdulrahuman5196] 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:
• [@abdulrahuman5196] 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:
• [@abdulrahuman5196] Determine if we should create a regression test for this bug.
• [@abdulrahuman5196] 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.
• [@bfitzexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[bfitzexpensify]

Please complete the BZ checklist when you get a moment @abdulrahuman5196 - thank you!

[abdulrahuman5196]

The PR that introduced the bug has been identified. Link to the PR:
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:
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:

Not a direct regression. But from chain of PRs. We already discussed the same in slack.

Determine if we should create a regression test for this bug.
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.

Not required IMO. Since it was already found during regression testing on deployment.

@bfitzexpensify

[bfitzexpensify]

Cool, agreed on all of the above. We're all done here, closing this one out, thanks everyone