[CP Stg] Replace ReportScreenIDSetter with useLastAccessedReportID

[roryabraham]

Details

Some discussion in slack: https://expensify.slack.com/archives/C01GTK53T8Q/p1719427166028799

TL;DR:

• react-navigation assumes that you'll use the navigation prop in response to user actions. We are using navigation.setParams to set initial params for a screen. The preferred way to do that is with initialParams.
• I'm not 100% sure it's necessary, but I think it might be possible that there's a race condition between useLastAccessedReportID (i.e: useOnyx/useSyncExternalStore) and react-navigation mounting the navigator. So in some cases the ReportScreen might fully mount before useLastAccessedReportID returns the value computed from Onyx. To cover our bases there, we add a useEffect in ReportScreen that sets the reportID route param to lastAccessedReportID if it's not present
• Removed the unnecessary ReportScreenWrapper and ReportScreenIDSetter (no-op) components from the view hierarchy.

Less TL;DR version:

• Previously, we were using withOnyx in ReportScreenIDSetter to calculate the lastAccessedReportID, and if we did not have a reportID in the URL, we would use navigation.setParams to set the reportID to lastAccessedReportID. The final effect was that we "re-route" from r/ to r/$lastAccessedReportID
• Little did we know, this only worked because the render-blocking behavior of withOnyx delayed the call to navigation.setParams enough that it gave time for the navigation tree to finish mounting
• When we used useOnyx (which uses useSyncExternalStore under the hood), ReportScreenIDSetter became much faster and the render-blocking behavior was removed. As a result navigation.setParams was being called before the navigation tree was finished mounting. This did not work as expected because the react-navigation docs assume that you'll be calling navigate and/or setParams in response to user actions, and after the navigation tree had finished mounting.
• The solution to that problem was to:
  • move the logic that calculates lastAccessedReportID up the tree to AuthScreens
  • pass {reportID: lastAccessedReportID} to initialParams for the ReportScreen, if there wasn't already a reportID in the route
• However, that revealed another interesting side-effect of our previous design. ReportScreenIDSetter was a no-op component that only contained a useEffect and returned null. Therefore, we didn't notice (and perhaps it didn't matter) that it would re-render any time any of its Onyx data changes (any report, reportMetadata, policy, etc...). When we moved this to AuthScreens, it created problems. Not only would this likely have been a performance regression to re-render AuthScreens so aggressively, but also it put us in an infinite loop (in the test environment, anyways...)
  1. AuthScreens mounts
  2. ReportScreen mounts and sets reportMetadata.lastVisitTime for the report
  3. (new) AuthScreens re-renders because reportMetadata changed
  4. ReportScreen remounts because the navigator it lives in re-rendered
  5. it sets reportMetadata.lastVisitTime, and we go back to step C
• To fix that issue, I ended up coming up with custom solution. It's a new pattern, but it worked well for our needs in this case... It uses useSyncExternalStore and Onyx.connect to subscribe to all the keys needed to compute lastAccessedReportID, and then computes the lastAccessedReportID property in getSnapshot. The result is that even though we still access and respond to all that big Onyx data (reports, reportMetadata, policies, etc...), useLastAccessedReportID will only trigger a re-render if lastAccessedReportID changes

Fixed Issues

$ #44442
PROPOSAL: https://expensify.slack.com/archives/C01GTK53T8Q/p1719506066435689?thread_ts=1719427166.028799&cid=C01GTK53T8Q

Tests / QA Steps

1. Open any report
2. Open the New Chat page
3. Select a few members of a group, then press Next
4. Refresh the page.
5. Verify that the report you had open loads in the background.

• Verify that no errors appear in the JS console

Offline tests

None - can't refresh the page offline because our site isn't set up with ServiceWorkers.

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

[melvin-bot]

@c3024 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]

[c3024]

Tests well on Chrome and Desktop but when I open a report on iOS, I am seeing a continuous loading of the page on iOS and Android.

Screen.Recording.2024-06-27.at.11.31.19.PM.mov

This issue is not there on main.

[mountiny]

Looks good, only NAB comments

[c3024]

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

Screen.Recording.2024-06-28.at.2.04.18.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-06-28.at.2.04.18.AM.mov

iOS: Native

Screen.Recording.2024-06-28.at.1.59.23.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-06-28.at.2.05.38.AM.mov

MacOS: Chrome / Safari

centerReportChrome.mov

MacOS: Desktop

centerReportDesktop.mov

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/44559/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/44559/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/44559/NewExpensify.dmg	https://44559.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[c3024]

On refreshing the page with Start Chat RHP open, the center pane report keeps loading with a skeleton loader.

Screen.Recording.2024-06-28.at.2.26.23.AM.mov

It works fine in the adhoc build.

[c3024]

@mountiny can you please run the build again now that all changes (hopefully) are done?

[luacmartins]

LGTM

[c3024]

Tests well!

[melvin-bot]

@Gonals 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]

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/roryabraham in version: 9.0.2-8 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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