Add helper functions in getMatchingCentralPaneRouteForState #36397

WojtekBoman · 2024-02-13T09:16:46Z

Details

This PR fixes the issue that appears when we change the selected screen in the settings tab, switch to the chat tab and return to the settings. Then in this tab we should see the previously opened screen, but currently the Profile screen here is always displayed as the initial one.

Fixed Issues

$ #35613
PROPOSAL: N/A

Tests

Open the settings tab.
Select any screen other than Profile on this tab.
Open the chat tab.
Go back to the settings tab and verify that the screen selected earlier is currently displayed.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests.

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

This issue doesn't occur on the small screen size, so the videos are attached only for:

MacOS: Chrome / Safari
MacOS: Desktop

MacOS: Chrome / Safari

Screen.Recording.2024-02-13.at.13.08.14.mov

MacOS: Desktop

Screen.Recording.2024-02-13.at.13.10.23.mov

melvin-bot · 2024-02-13T15:04:26Z

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

hayata-suenaga · 2024-02-16T21:42:35Z

@cubuspl42 -> #35613 (comment)
please review this PR when you have time 🙇

cubuspl42 · 2024-02-19T10:34:47Z

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts

@@ -31,8 +31,45 @@ const getTopMostReportIDFromRHP = (state: State): string => {
    return '';
 };

+// Function that checks if the given route has a policyID equal to the id provided in the function params


When commenting functions, we don't focus on the fact that they're functions. We either write "Do something such and such" or "Does something and something".

cubuspl42 · 2024-02-19T10:36:21Z

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts

+    // If one of the screen from WORKSPACES_SCREENS is now in the navigation state, we can decide which screen we should display.
+    // A screen from the navigation state can be pushed to the navigation state again only if it has a matching policyID with the currently selected workspace.
+    // Otherwise, when we switch the workspace, we want to display the initial screen in the settings tab.
+    const WORKSPACES_SCREENS = TAB_TO_CENTRAL_PANE_MAPPING[SCREENS.WORKSPACE.INITIAL].concat(TAB_TO_CENTRAL_PANE_MAPPING[SCREENS.ALL_SETTINGS]);


All local variables in the project are named using lower camel case convention.

But why is this local, if this doesn't depend on function arguments?

cubuspl42 · 2024-02-19T10:55:45Z

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts

+        route?.params &&
+        'params' in route?.params &&
+        route.params.params &&
+        'policyID' in (route.params.params as Record<string, string | undefined>) &&


Please don't type assert this twice, extract a local variable of desired target type.

cubuspl42 · 2024-02-19T10:57:33Z

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts

+    const WORKSPACES_SCREENS = TAB_TO_CENTRAL_PANE_MAPPING[SCREENS.WORKSPACE.INITIAL].concat(TAB_TO_CENTRAL_PANE_MAPPING[SCREENS.ALL_SETTINGS]);
+
+    const alreadyOpenedSettingsTab = rootState.routes
+        .filter((item) => item.params && 'screen' in item.params && WORKSPACES_SCREENS.includes(item.params.screen as keyof CentralPaneNavigatorParamList))


There's a lot of type assertion going on (here and in other places). I gave it a quick look and I couldn't come up with any quick fixes. Do you have any ideas how we could at least reduce the number of type assertions (something as SomeType)?

Hmm, I am trying to figure it out, but it's not easy because the screen is unknown and when we want to use this variable we need to have a type for it. I'll try to solve it somehow, but I don't know if we can avoid using type assertions here. Could you take a look at the latest update in this PR? It should resolve the comments above :)

cubuspl42 · 2024-02-22T12:42:24Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

go-back-to-settings-page-web-converted.mp4

MacOS: Desktop

go-back-to-settings-page-desktop-converted.mp4

cubuspl42

I also checked Native/mWeb, and they seem to be unaffected, as expected.

hayata-suenaga

thanks everyone for great work!

OSBotify · 2024-02-22T15:48:03Z

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

situchan

Please consider this potential regression: #36162 (comment)

hayata-suenaga · 2024-02-23T22:15:37Z

@cubuspl42 could you check if the regression situchan linked is reproducible and was caused by this PR?

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts

OSBotify · 2024-02-26T21:07:11Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.44-0 🚀

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

OSBotify · 2024-02-28T23:55:47Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

WojtekBoman added 2 commits February 13, 2024 10:14

Add helper functions in getMatchingCentralPaneRouteForState

833ea1f

Refactor getMatchingCentralPaneRouteForState

7d18914

WojtekBoman marked this pull request as ready for review February 13, 2024 15:04

WojtekBoman requested a review from a team as a code owner February 13, 2024 15:04

melvin-bot bot removed the request for review from a team February 13, 2024 15:04

melvin-bot bot requested a review from thesahindia February 13, 2024 15:04

hayata-suenaga requested review from cubuspl42 and removed request for thesahindia February 16, 2024 21:42

cubuspl42 suggested changes Feb 19, 2024

View reviewed changes

hayata-suenaga self-requested a review February 19, 2024 16:39

WojtekBoman added 2 commits February 21, 2024 09:15

Merge branch 'main' into ideal-nav/go-back-to-settings-page

49049a5

Refactor hasRouteMatchingPolicyID and getAlreadyOpenedSettingsScreen

b21f8d7

cubuspl42 approved these changes Feb 22, 2024

View reviewed changes

hayata-suenaga approved these changes Feb 22, 2024

View reviewed changes

hayata-suenaga merged commit 687bac0 into Expensify:main Feb 22, 2024
16 of 17 checks passed

esh-g mentioned this pull request Feb 23, 2024

Fix workspace switcher creating new workspace #36162

Merged

50 tasks

situchan reviewed Feb 23, 2024

View reviewed changes

cubuspl42 reviewed Feb 26, 2024

View reviewed changes

src/libs/Navigation/linkingConfig/getMatchingCentralPaneRouteForState.ts Show resolved Hide resolved

github-actions bot mentioned this pull request Feb 26, 2024

Deploy Checklist: New Expensify 2024-02-26 #37224

Closed

DylanDylann mentioned this pull request Aug 6, 2024

[Ideal nav] Fix getAlreadyOpenedSettingsScreen #46885

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add helper functions in getMatchingCentralPaneRouteForState #36397

Add helper functions in getMatchingCentralPaneRouteForState #36397

WojtekBoman commented Feb 13, 2024 •

edited

Loading

melvin-bot bot commented Feb 13, 2024

hayata-suenaga commented Feb 16, 2024

cubuspl42 Feb 19, 2024

cubuspl42 Feb 19, 2024

cubuspl42 Feb 19, 2024

cubuspl42 Feb 19, 2024

cubuspl42 Feb 19, 2024

WojtekBoman Feb 21, 2024 •

edited

Loading

cubuspl42 commented Feb 22, 2024

cubuspl42 left a comment

hayata-suenaga left a comment

OSBotify commented Feb 22, 2024

situchan left a comment

hayata-suenaga commented Feb 23, 2024

OSBotify commented Feb 26, 2024

OSBotify commented Feb 28, 2024

Add helper functions in getMatchingCentralPaneRouteForState #36397

Add helper functions in getMatchingCentralPaneRouteForState #36397

Conversation

WojtekBoman commented Feb 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 13, 2024

hayata-suenaga commented Feb 16, 2024

cubuspl42 Feb 19, 2024

Choose a reason for hiding this comment

cubuspl42 Feb 19, 2024

Choose a reason for hiding this comment

cubuspl42 Feb 19, 2024

Choose a reason for hiding this comment

cubuspl42 Feb 19, 2024

Choose a reason for hiding this comment

cubuspl42 Feb 19, 2024

Choose a reason for hiding this comment

WojtekBoman Feb 21, 2024 • edited Loading

Choose a reason for hiding this comment

cubuspl42 commented Feb 22, 2024

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 22, 2024

situchan left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Feb 23, 2024

OSBotify commented Feb 26, 2024

OSBotify commented Feb 28, 2024

WojtekBoman commented Feb 13, 2024 •

edited

Loading

WojtekBoman Feb 21, 2024 •

edited

Loading