[navigation-refactor] Use minimal action to navigate inside RHP #21067

adamgrzybowski · 2023-06-19T18:18:28Z

Details

This PR adds the utility getMinimalAction that is used in LinkTo to fix the issue with back button

Additionally, @WoLewicki came up with the idea that this utility can help to resolve the problem with the RHN animation glitch

Fixed Issues

$ #20620
$ #20621
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Test for #20620

Click on 'Profile' avatar
Click on 'Security' link
Click on back icon on the top left section of the RHN
Click on 'About' link
Click on the device's back icon on bottom right section
You should be on the settings_root screen

Test for #20621

Open the app
Press CTRL+K to open search
Press CTRL+shift+K to open a new group menu
Do it a few times and check if there are any glitches

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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 / Chrome
- iOS / native
- iOS / 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

androidWeb.mov

Mobile Web - Safari

iosWeb.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-06-19T18:18:33Z

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

abdulrahuman5196 · 2023-06-19T18:34:29Z

@adamgrzybowski

Kindly add the tests in the author's checklist
Kindly add videos for platforms, currently only web is added. (Even desktop has RHP)

mountiny

Coupld of comments, lets make sure we include clear testing steps and also fill out all the screen recordings

src/libs/Navigation/AppNavigator/Navigators/RightModalNavigator.js

src/libs/Navigation/linkTo.js

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

abdulrahuman5196 · 2023-06-20T19:30:05Z

@adamgrzybowski Could you kindly check this comment and add tests in author's checklist as well?
#21067 (comment)

And there are still some comments pending to addressed?

adamgrzybowski · 2023-06-21T12:19:43Z

@abdulrahuman5196 I am working currently on the part of the documentation to explain better why we need minimal action. I can see that it may be a little confusing.

I got distracted by other urgent issues. I will get back to this PR right after resolving those problems. Thanks for your patience 🙇 !

adamgrzybowski · 2023-06-22T12:45:49Z

Hey, I updated the docs and included tests, let me know if its any clearer now 😄 @abdulrahuman5196 @mountiny

abdulrahuman5196 · 2023-06-22T12:55:15Z

Sure thank you. Will check on this tonight

adamgrzybowski · 2023-06-23T13:58:50Z

Hey, @abdulrahuman5196 quick sanity check 😄 I can see that the lint step is failing but there is no reason for this in the code. Do you think it's possible there is some problem with github actions?

abdulrahuman5196 · 2023-06-23T14:54:59Z

@adamgrzybowski Seems so. Can you try merge from main?

WoLewicki

Added some comments to the md file. Other than that, it looks just fine!

contributingGuides/NAVIGATION.md

abdulrahuman5196 · 2023-06-24T17:11:13Z

I did test the flows by locally changing this #21067 (comment) and the code seems to work fine without any issues.
As the internal engineers commented, the documentation could be improved, since its tricky to follow the code change now and it will become super hard to understand if we look back after sometime. Kindly address the documentation concerns of the internal engineers.
@adamgrzybowski

adamgrzybowski · 2023-06-26T12:21:25Z

Hey, @abdulrahuman5196 I fixed the leftover options and added what @WoLewicki asked for in docs. Can we merge it now?

abdulrahuman5196 · 2023-06-26T15:28:01Z

Thank you @adamgrzybowski . Will work on reviewers checklist and complete it today.

abdulrahuman5196 · 2023-06-26T18:24:41Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

Screen.Recording.2023-06-26.at.11.27.52.PM.mp4

Mobile Web - Chrome

az_recorder_20230626_233717.mp4

Mobile Web - Safari

Untitled.mp4

Desktop

Screen.Recording.2023-06-26.at.11.52.11.PM.mp4

iOS

Screen.Recording.2023-06-26.at.11.40.46.PM.mp4

Android

az_recorder_20230626_234800.mp4

abdulrahuman5196 · 2023-06-26T18:26:40Z

@adamgrzybowski Could you kindly mark the QA steps and Offline tests as "Same as Tests"?

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @mountiny / @WoLewicki

🎀👀🎀
C+ Reviewed

abdulrahuman5196 · 2023-06-30T17:05:32Z

@mountiny / @WoLewicki Could you kindly check on this ? #21067 (review)
waiting for couple of days

WoLewicki · 2023-06-30T19:28:55Z

It's fine by me, but I have no power to merge it 😅

abdulrahuman5196 · 2023-06-30T19:31:54Z

OOPS. Sorry. Will wait for mountiny 😶‍🌫️ 😆

adamgrzybowski · 2023-07-03T15:08:27Z

Hey @mountiny it would be great to merge that. There is some code that will be also modified by PR improving resizing

mountiny

Thanks! Also nice description 🙇

OSBotify · 2023-07-04T17:27:40Z

✋ 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 · 2023-07-05T17:31:17Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.37-0 🚀

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

bondydaa · 2023-07-05T19:55:06Z

looks like this caused a regression here #22289

situchan · 2023-07-05T22:16:38Z

src/libs/Navigation/linkTo.js

+            type: currentAction.type,
+            payload: {
+                name: currentAction.payload.params.screen,
+                params: currentAction.payload.params.params,


Suggested change

params: currentAction.payload.params.params,

params: currentAction.payload.params.params,

path: currentAction.payload.params.path,

path was missing here and it caused regression - #22308

@situchan Can you raise a PR fixing this?

OSBotify · 2023-07-07T10:36:43Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

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

Santhosh-Sellavel · 2023-07-09T19:43:33Z

src/libs/Navigation/linkTo.js

+    let currentAction = action;
+    let currentState = state;
+    let currentTargetKey = null;
+    let targetName = null;


This PR caused a regression, for more details refer this PR

adamgrzybowski added 2 commits June 19, 2023 19:34

remove animation for replace inside RHPStack

102b88b

add minimalAction utility for linkTo

66652df

adamgrzybowski requested a review from a team as a code owner June 19, 2023 18:18

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team June 19, 2023 18:18

adamgrzybowski added 2 commits June 19, 2023 20:20

add prettier adjustments

ebf4c74

add prettier adjustments v2

0c2f8e5

abdulrahuman5196 mentioned this pull request Jun 19, 2023

[HOLD for payment 2023-07-14] [$1000] Animation glitches on CTRL+shift+K shortcut after CTRL+K #20621

Closed

6 tasks

mountiny assigned adamgrzybowski Jun 19, 2023

mountiny reviewed Jun 19, 2023

View reviewed changes

adamgrzybowski and others added 5 commits June 20, 2023 15:04

Update src/libs/Navigation/linkTo.js

ae9c365

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

Update src/libs/Navigation/linkTo.js

7765be3

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

Update src/libs/Navigation/linkTo.js

b9c5e9b

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

Update src/libs/Navigation/linkTo.js

fc1abd5

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

Update src/libs/Navigation/linkTo.js

89701ca

Co-authored-by: Vit Horacek <36083550+mountiny@users.noreply.github.com>

adamgrzybowski added 4 commits June 21, 2023 19:27

add informations about minimal action in docs

3d91b47

make adjustments to the linkTo

7fe01d4

Merge branch 'main' into @swm/navigation-refactor-minimal-action

9e2dbd3

Merge branch 'main' into @swm/navigation-refactor-minimal-action

372be53

adamgrzybowski added 2 commits June 22, 2023 15:05

add break condition inside getMinimalAction

51f5c61

remove defaultModalScreenOptions

93b1938

WoLewicki reviewed Jun 23, 2023

View reviewed changes

modify docs

c9585e9

abdulrahuman5196 approved these changes Jun 26, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny June 26, 2023 18:34

rain2o mentioned this pull request Jun 28, 2023

[$1000] [mweb-Android] click on back button of device navigates to payments page instead of setting page #20681

Closed

5 tasks

adamgrzybowski added 3 commits July 4, 2023 18:13

Merge branch 'main' into @swm/navigation-refactor-minimal-action

9a5fb8e

fix linting error

8df6227

Merge branch 'main' into @swm/navigation-refactor-minimal-action

ab0ee18

mountiny approved these changes Jul 4, 2023

View reviewed changes

mountiny merged commit 7e908b1 into Expensify:main Jul 4, 2023

OSBotify mentioned this pull request Jul 5, 2023

Deploy Checklist: New Expensify 2023-07-05 #22282

Closed

58 tasks

s77rt mentioned this pull request Jul 5, 2023

[HOLD for payment 2023-07-17] [HOLD for payment 2023-07-14] [HOLD FOR PAYMENT - 13th July] User is taken to the first step after changing currency when splitting a bill #22289

Closed

6 tasks

situchan mentioned this pull request Jul 5, 2023

[HOLD for payment 2023-07-17] [HOLD for payment 2023-07-14] [$1000] Contact detail page shows "Hmm... it's not here" after refresh #22308

Closed

6 tasks

situchan reviewed Jul 5, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Jul 7, 2023

[HOLD for payment 2023-07-14] Clicking back from one of the settings option doesn't return user to 'Settings' section #20620

Closed

6 tasks

Santhosh-Sellavel reviewed Jul 9, 2023

View reviewed changes

Santhosh-Sellavel mentioned this pull request Jul 9, 2023

[HOLD for payment 2023-07-17] [HOLD for payment 2023-07-14] Not able to split money on back button #22302

Closed

6 tasks

melvin-bot bot requested a review from mountiny July 20, 2023 11:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[navigation-refactor] Use minimal action to navigate inside RHP #21067

[navigation-refactor] Use minimal action to navigate inside RHP #21067

adamgrzybowski commented Jun 19, 2023 •

edited

Loading

melvin-bot bot commented Jun 19, 2023

abdulrahuman5196 commented Jun 19, 2023

mountiny left a comment

abdulrahuman5196 commented Jun 20, 2023

adamgrzybowski commented Jun 21, 2023

adamgrzybowski commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

adamgrzybowski commented Jun 23, 2023

abdulrahuman5196 commented Jun 23, 2023

WoLewicki left a comment

abdulrahuman5196 commented Jun 24, 2023

adamgrzybowski commented Jun 26, 2023

abdulrahuman5196 commented Jun 26, 2023

abdulrahuman5196 commented Jun 26, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 26, 2023

abdulrahuman5196 left a comment

abdulrahuman5196 commented Jun 30, 2023

WoLewicki commented Jun 30, 2023

abdulrahuman5196 commented Jun 30, 2023

adamgrzybowski commented Jul 3, 2023

mountiny left a comment

OSBotify commented Jul 4, 2023

OSBotify commented Jul 5, 2023

bondydaa commented Jul 5, 2023

situchan Jul 5, 2023

mountiny Jul 6, 2023

OSBotify commented Jul 7, 2023

Santhosh-Sellavel Jul 9, 2023

	params: currentAction.payload.params.params,
	params: currentAction.payload.params.params,
	path: currentAction.payload.params.path,

[navigation-refactor] Use minimal action to navigate inside RHP #21067

[navigation-refactor] Use minimal action to navigate inside RHP #21067

Conversation

adamgrzybowski commented Jun 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 19, 2023

abdulrahuman5196 commented Jun 19, 2023

mountiny left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 20, 2023

adamgrzybowski commented Jun 21, 2023

adamgrzybowski commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

adamgrzybowski commented Jun 23, 2023

abdulrahuman5196 commented Jun 23, 2023

WoLewicki left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 24, 2023

adamgrzybowski commented Jun 26, 2023

abdulrahuman5196 commented Jun 26, 2023

abdulrahuman5196 commented Jun 26, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 commented Jun 26, 2023

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Jun 30, 2023

WoLewicki commented Jun 30, 2023

abdulrahuman5196 commented Jun 30, 2023

adamgrzybowski commented Jul 3, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 4, 2023

OSBotify commented Jul 5, 2023

bondydaa commented Jul 5, 2023

situchan Jul 5, 2023

Choose a reason for hiding this comment

mountiny Jul 6, 2023

Choose a reason for hiding this comment

OSBotify commented Jul 7, 2023

Santhosh-Sellavel Jul 9, 2023

Choose a reason for hiding this comment

adamgrzybowski commented Jun 19, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 26, 2023 •

edited

Loading