Skip to content

fix: pop all reports after screen resize#21312

Merged
mountiny merged 8 commits into
Expensify:mainfrom
adamgrzybowski:@swm/navigation-refactor-pop-on-resize
Jul 4, 2023
Merged

fix: pop all reports after screen resize#21312
mountiny merged 8 commits into
Expensify:mainfrom
adamgrzybowski:@swm/navigation-refactor-pop-on-resize

Conversation

@WoLewicki

@WoLewicki WoLewicki commented Jun 22, 2023

Copy link
Copy Markdown
Contributor

Details

After the screen resizes to small, and we already navigated through some reports, we still want the back button of report's header to go to LHN, so we pop all of the chats in order to do it. We also don't want to replicate that after user starts navigating deeper while stying on the small-sized screen.

Fixed Issues

$ #20370

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Start with wide screen and navigate through some reports on wide screen
  2. Resize it to a small one and click report's back button
  3. Confirm you are on LHN and there is a last visited report visible when you resize to a big screen

  1. Start with small screen and go through some reports
  2. Press report's back button
  3. Confirm you pop only one report

  1. Start with small screen and go through some reports
  2. Resize the screen to wide and back to small
  3. Press report's back button
  4. Confirm you are on LHN and there is a last visited report visible when you resize to a big screen
  • 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
nav1.mp4
nav2.mp4
nav3.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@WoLewicki WoLewicki requested a review from a team as a code owner June 22, 2023 13:19
@melvin-bot melvin-bot Bot requested review from s77rt and removed request for a team June 22, 2023 13:19
@melvin-bot

melvin-bot Bot commented Jun 22, 2023

Copy link
Copy Markdown

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

Comment thread src/pages/ValidateLoginPage/index.js Outdated
// If already signed in, do not show the validate code if not on web,
// because we don't want to block the user with the interstitial page.
Navigation.goBack(false);
Navigation.goBack();

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This false was here for no reason also so I removed it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's added for a reason, to unset the fallback and call navigationRef.current.goBack() instead of navigate(fallbackRoute, 'UP')

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it doesn't work that way, the first argument is the route to go back to:

function goBack(fallbackRoute = ROUTES.HOME, shouldEnforceFallback = false) {
, or am I missing something?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but the fallback is not necessary. In this line we used to disable the fallback so the second condition won't be true (not to call navigate(fallbackRoute, 'UP')) and continue with the third option (navigationRef.current.goBack()).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I get it now, thanks!

Comment thread src/libs/Navigation/Navigation.js Outdated
* @param {Bool} shouldPopToTop - Should we navigate to LHN on back press
*/
function goBack(fallbackRoute = ROUTES.HOME, shouldEnforceFallback = false) {
function goBack(fallbackRoute = ROUTES.HOME, shouldPopToTop = false) {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We did not use the shouldEnforceFallback anywhere so I just changed it to a new prop

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do use shouldEnforceFallback e.g. here

Navigation.goBack(ROUTES.getMoneyRequestRoute(this.iouType, this.reportID), true);
. Can you add this prop back?

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @s77rt thanks for testing in advance

Comment on lines +22 to +26
let shouldPopAllStateOnUP = false;

function setShouldPopAllStateOnUP() {
shouldPopAllStateOnUP = true;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we might want to add some comment here too

@s77rt

s77rt commented Jun 22, 2023

Copy link
Copy Markdown
Member

Limited availability today but will get to this asap

Comment thread src/libs/Navigation/Navigation.js Outdated
* @param {Bool} shouldPopToTop - Should we navigate to LHN on back press
*/
function goBack(fallbackRoute = ROUTES.HOME, shouldEnforceFallback = false) {
function goBack(fallbackRoute = ROUTES.HOME, shouldPopToTop = false) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do use shouldEnforceFallback e.g. here

Navigation.goBack(ROUTES.getMoneyRequestRoute(this.iouType, this.reportID), true);
. Can you add this prop back?

Comment thread src/pages/ValidateLoginPage/index.js Outdated
// If already signed in, do not show the validate code if not on web,
// because we don't want to block the user with the interstitial page.
Navigation.goBack(false);
Navigation.goBack();

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's added for a reason, to unset the fallback and call navigationRef.current.goBack() instead of navigate(fallbackRoute, 'UP')

Comment thread src/pages/home/ReportScreen.js Outdated
<HeaderView
reportID={reportID}
onNavigationMenuButtonClicked={() => Navigation.goBack(ROUTES.HOME)}
onNavigationMenuButtonClicked={() => Navigation.goBack(ROUTES.HOME, false, true)}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ReportScreen may return HeaderView or MoneyRequestHeader. We need to apply same logic for MoneyRequestHeader

onBackButtonPress={() => Navigation.goBack(ROUTES.HOME)}

@s77rt

s77rt commented Jun 24, 2023

Copy link
Copy Markdown
Member

Using device's back button or browser back button does not work as expected. Should we handle this here? cc @mountiny

This is similar to this reported bug #21356

Kooha-2023-06-24-22-38-25.mp4

@WoLewicki

Copy link
Copy Markdown
Contributor Author

@s77rt as mentioned here: #20370 (comment), the browser back button will work like this and I would be very hesitant from trying to change that behavior, but cc @parasharrajat since @mountiny is ooo iirc.

@s77rt

s77rt commented Jun 26, 2023

Copy link
Copy Markdown
Member

@s77rt

s77rt commented Jun 27, 2023

Copy link
Copy Markdown
Member

Looks we are okay to move with this. @WoLewicki Can you please resolve the conflicts?

@WoLewicki

Copy link
Copy Markdown
Contributor Author

@s77rt done, thanks.

@s77rt

s77rt commented Jun 27, 2023

Copy link
Copy Markdown
Member

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
web.mp4
Mobile Web - Chrome
Mobile Web - Safari
Desktop
desktop.mp4
iOS
Android

@s77rt s77rt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot Bot requested a review from mountiny June 27, 2023 11:34

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks everyone for patience when I was ooo and working on this!

@mountiny mountiny merged commit 3e0d7dd into Expensify:main Jul 4, 2023
@Julesssss

Copy link
Copy Markdown
Contributor

firstRenderRef.current = false;
return;
}
if (!props.isSmallScreenWidth) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This props have been deprecated since we are using the windows hook now to get the value so we need to update this

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow up is here #22191

@OSBotify

OSBotify commented Jul 5, 2023

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

OSBotify commented Jul 7, 2023

Copy link
Copy Markdown
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants