[HOLD for payment 2023-08-28] [HOLD] [$1000] Web - Clicking on the browser back button takes user from chat page to assign task page

[kbecciv]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Action Performed:

1. Open a chat
2. Click on the plus icon
3. Click on assign task
4. Give a title and click next
5. Confirm the task
6. From the chat screen click the browser back button

Expected Result:

App should not open the assign task side panel

Actual Result:

App takes user to the assign task screen

Workaround:

Unknown

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.47-2
Reproducible in staging?: y
Reproducible in production?: y
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
Notes/Photos/Videos: Any additional supporting documentation

Expensify/Expensify Issue URL:
Issue reported by: @Nathan-Mulugeta
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690536196870419

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01dd04525ab1095d86
• Upwork Job ID: 1685016837327048704
2023-07-28
• Automatic offers:
• daordonez11 | Contributor | 25816261
• Nathan-Mulugeta | Reporter | 25816263

[melvin-bot]

Triggered auto assignment to @michaelhaxhiu (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

[daordonez11]

Proposal

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

Pressing the back button sends to task detail instead of parent report

What is the root cause of that problem?

The dismissModal method in Nagivation.js is using the type REPLACE hence in this special case the parent is replaced with the child so going back does not send to the parent report.

App/src/libs/Navigation/Navigation.js

Lines 166 to 171 in ec1ccf8

	if (targetReportID && targetReportID !== getTopmostReportId(rootState)) {
	const state = getStateFromPath(ROUTES.getReportRoute(targetReportID));
	const action = getActionFromState(state, linkingConfig.config);
	action.type = 'REPLACE';
	navigationRef.current.dispatch(action);

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

There is 2 ways of solving it:

1. I removed the line and normal navigate type is working as expected. Tested in 4 different modals and was working fine.
2. Use REPLACE when the targetReport is not a child/thread/task of the topmost report. In pseudocode something like:

if(!targetReportID.isChild(getTopmostReportId(rootState)))
{
    action.type = 'REPLACE';
}

Video of solution working:

WithoutReplace.webm

What alternative solutions did you explore? (Optional)

If the action is executed correctly remove previous steps from navigation stack but seems too complex code for something so simple. Something like: Clean steps, navigate to parent, navigate to child.

[melvin-bot]

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

[melvin-bot]

Current assignee @michaelhaxhiu is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[mountiny]

Stepping in since its related to navigation

@daordonez11 I think your proposal looks good, but I would go with the option 2. I think we needed the replace there for some other reasons

[melvin-bot]

📣 @eVoloshchak Please request via NewDot manual requests for the Reviewer role ($1000)

[melvin-bot]

📣 @daordonez11 🎉 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 📖

[melvin-bot]

📣 @Nathan-Mulugeta 🎉 An offer has been automatically sent to your Upwork account for the Reporter role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[mountiny]

@adamgrzybowski @WoLewicki do you remember why we had the replace there? I though it was for this exact reason so I am confused that the dismis modal does not work here

[daordonez11]

Got it @mountiny will test the cases! There are 33 usages of dismissModal so probably step 2 is the best way to go, will check if there is any util to validate if it is a child of the report and will test deeply the scenarios. If any of you guys remember the origin of why replace is there would be even better to narrow the validation, specially @WoLewicki I think the first appearance of it is in the commit: d2b8e2 feat: first look on RHP Navigation created by Wojciech.

[mountiny]

@daordonez11 Can you please raise a PR? Thank you 🙇

[WoLewicki]

Hmm this topic consists of two parts.

First is the react-navigation state. Here in all those RHP flows such as Request money or Assign task, we want the RHP to disappear after ending the flow and also we want to navigate to the new report immediately after it too. Since RHP is at at the root of the navigation stack, and new report is also there, we just replace the RHP with new report, that's why this code is there and should work correctly (the RHP disappears from navigation tree and new report appears).

Second thing is browser history. All those flows worked with browser buttons as long as they were a single url. It was done with the steps concept, where we navigated between the parts of the RHP flow with simple animations, but we did not change the url in different steps. I created this solution when those flows looked like this. It was just fine then since when calling replace action from react-navigation, we also call replace in browser stack, and since those flows were a single url, we just replaced the last url with the new one, making the back button lead to the previous report.

It changed when those flows started to be different urls. While the react-navigation state still works correctly, the browser history "remembers" all the previous urls, so we just replace the last page of those flows, and clicking back button leads us to the previous page of the flow.

We already found a solution to drop all the entries of history associated with the nested stacks when they are dropped in the react-navigation's browser API integration and @adamgrzybowski should post a PR with it soon. While it will work in our case, we are unsure if it is the behavior most users of react-navigation library would expect, since browser history just follows the urls as the source of truth, so it might be tricky to have it merged upstream imo.

Is it clear enough? Or should I explain something better?

Another thing is that I am not sure why simply navigating in such case works correctly. @daordonez11 could you check if RHP really disappears from the navigation stack if you do not drop it explicitly? Or am I missing something?

[mountiny]

You are right, I have missed that this flow got refactored since then, great explanation, thank you very much

[daordonez11]

Thanks for the detailed explanation! @WoLewicki ita clear why it worked and why it's failing in this case! Let me implement a log to check the status after navigating. To be clear it works because usually dismissing the modal sends back to the same report in that case navigating or replacing does the same! Navigate works because it finds the report in the stack and goes back, and replace just sends directly. Let me do some tests. @mountiny didn't raise PR because was waiting for some context to build the validation, also couldn't find an existing util to validate if one report is parent of the other.

[michaelhaxhiu]

Note: I'm preparing to go OOO for ~2 weeks, but rather than re-assigning this to another BZ, I'm going to keep it assigned. If this sees quick progress while I'm away, please feel free to remove my assignment and re-apply the Bug label to assign a new BZ.

[mountiny]

This is on HOLD for react navigation fix so that can take long, making it monthly

[adamgrzybowski]

Hey, this should be fixed by this PR

[mountiny]

@michaelhaxhiu could you please confirm this issue is resolved in staging? If yes, then we can close it

[Nathan-Mulugeta]

Payment has not been processed yet though. Am I not eligible for reporting bonus?

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[melvin-bot]

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

• [navigation-refactor] Fix browser history for complex navigation actions #24165

If no regressions arise, payment will be issued on 2023-08-28. 🎊

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:

• @eVoloshchak does not require payment (Eligible for Manual Requests)
• @WoLewicki does not require payment (Contractor)
• @Nathan-Mulugeta requires payment offer (Reporter)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[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:

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

[michaelhaxhiu]

The bug is resolved!

I paid the bug reporter just now @Nathan-Mulugeta

Special shout out to @daordonez11 for his preliminary efforts in resolving this, it's much appreciated and hope to see you involved in more jobs in the future. 🙏