Add getPolicyIDFromNavigationState method #38490
Conversation
| @@ -21,7 +21,7 @@ const startTimer = () => { | |||
|
|
|||
| function BaseSidebarScreen(props) { | |||
| const styles = useThemeStyles(); | |||
| const {activeWorkspaceID} = useActiveWorkspace(); | |||
| const activeWorkspaceID = Navigation.getPolicyIDFromNavigationState(); | |||
There was a problem hiding this comment.
Do we still need the useActiveWorkspace context in the ideal nav v2?
There was a problem hiding this comment.
I think we need, because getting this value from the context should be faster than invoking this new method, because it has complex logic. In this place in code we need to get this value after update immediately but in other cases context should work fine. cc: @adamgrzybowski
There was a problem hiding this comment.
After some thought, I think we should check the following:
- Is this method really slower? This is something that should be easy to check with
console.time. Make sure to do this when the navigation state is big. - If we use this hook somewhere to trigger rerender.
If the answer is no and no then I would consider removing the context. It made sense to have it before ideal-nav-v2. Not sure about the current situation.
Keeping only one method to access policyID of the switcher may prevent confusion in the future.
There was a problem hiding this comment.
@WojtekBoman any update on the comment above? That sounds like a good next step to do.
There was a problem hiding this comment.
Yes, I've checked it in more detail, and the context works faster than this method. Here is necessary because we need to use a new policyID immediately after update, but in other cases it's better to use the context.
const handleStateChange = (state: NavigationState | undefined) => {
if (!state) {
return;
}
const activeWorkspaceID = getPolicyIDFromState(state as NavigationState<RootStackParamList>);
// Performance optimization to avoid context consumers to delay first render
setTimeout(() => {
currentReportIDValue?.updateCurrentReportID(state);
setActiveWorkspaceID(activeWorkspaceID);
}, 0);
parseAndLogRoute(state);
};
This is a method in the NavigationRoot.tsx file that updates the value stored in the context. In this particular case we need to read it faster and we can't wait for the update of this value, so we read it from the navigation state, but in other cases where we don't need to display this value it's fine.
melvin-bot
bot
requested review from
parasharrajat
and removed request for
a team
|
@parasharrajat 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] |
src/libs/Navigation/Navigation.ts
Outdated
| /** | ||
| * Returns the currently selected policy ID stored in the navigation state. | ||
| */ | ||
| function getPolicyIDFromNavigationState() { | ||
| return getPolicyIDFromState(navigationRef.getRootState() as State<RootStackParamList>); | ||
| } |
There was a problem hiding this comment.
This is not the correct place for this function. This lib should only export helpers for navigation. This is a util function related to policy.
There was a problem hiding this comment.
Good point :) I've moved this function to PolicyUtils
Screenshots🔲 iOS / nativeScreen.Recording.2024-03-23.at.1.31.51.AM.mov🔲 iOS / SafariScreen.Recording.2024-03-23.at.1.36.02.AM.mov🔲 MacOS / DesktopScreen.Recording.2024-03-23.at.12.35.23.AM.mov🔲 MacOS / ChromeScreen.Recording.2024-03-23.at.12.34.46.AM.mov🔲 Android / ChromeScreen.Recording.2024-03-23.at.1.34.03.AM.mov🔲 Android / nativeScreen.Recording.2024-03-23.at.1.24.18.AM.mov |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
@techievivek Could you take a look at it when you have time? |
|
@techievivek looks like this was merged without a test passing. Please add a note explaining why this was done and remove the |
|
Reviewer checklist is done by @parasharrajat not sure why it is failing. Also, not an emergency merge, all tests were green. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/techievivek in version: 1.4.59-0 🚀
|
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀
|
Details
This PR introduces a new method
getPolicyIDFromNavigationState. Thanks to this method, it's possible to get the currently selected policyID without any delay.App behaviour after fixing:
Screen.Recording.2024-03-18.at.17.31.37.mov
Fixed Issues
$ #38281
PROPOSAL: N/A
Tests
Offline tests
N/A
QA Steps
Same as tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
MacOS: Chrome / Safari
Screen.Recording.2024-03-18.at.17.31.37.mov
MacOS: Desktop
Screen.Recording.2024-03-18.at.17.50.33.mov