Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incorrect navigation when update Report welcome message after visit by direct link #25543

Merged
merged 14 commits into from
Oct 6, 2023

Conversation

hoangzinh
Copy link
Contributor

@hoangzinh hoangzinh commented Aug 20, 2023

Details

Fixed Issues

$ #22041
PROPOSAL: #22041 (comment)

Tests

Test case 1: Report welcome message page
Pre-step: Go to any room that you have permission to update welcome message => Go to Room welcome message paste => Copy the URL => Paste to any chat report

  1. Click on the report welcome message link that you just paste
  2. Update the welcome message
  3. Click save button
  4. Verify that it navigations back to the Report setting page

Test case 2: Workspace invite message page
Pre-step: Go to any Workspace, invite any users => On invite message paste => Copy the URL => Paste to any chat report

  1. Click on the WS invite message link that you just paste
  2. Click back arrow in the top bar
  3. Verify that it navigations back to the WS invite member page
  • Verify that no errors appear in the JS console

Offline tests

Not affected by network

QA Steps

Same as Tests

  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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
Screen.Recording.2023-08-20.at.22.53.04.-.web.mp4

Test ReimbursementAccount - Enabled page

Screen.Recording.2023-10-02.at.06.24.10.-.web.mov
Mobile Web - Chrome
Screen.Recording.2023-08-23.at.17.51.05.-.android.chrome.mov
Mobile Web - Safari
Screen.Recording.2023-08-23.at.17.53.37.-.ios.safari.mov
Desktop
Screen.Recording.2023-08-20.at.23.01.21.-.desktop.mp4
iOS
Screen.Recording.2023-08-23.at.17.54.24.-.ios.mov
Android
Screen.Recording.2023-08-23.at.17.52.20.-.android.mov

@hoangzinh
Copy link
Contributor Author

@situchan when I test the "Test case 2". There is a regression bug if we add fallback route, it's loop navigation if we tap on the arrow back on the top bard on native devices

Screen.Recording.2023-08-22.at.05.57.22.mov

I think we can revert the change for this "Test case 2" and leave as it's. What do you think?

@situchan
Copy link
Contributor

@situchan when I test the "Test case 2". There is a regression bug if we add fallback route, it's loop navigation if we tap on the arrow back on the top bard on native devices

Screen.Recording.2023-08-22.at.05.57.22.mov
I think we can revert the change for this "Test case 2" and leave as it's. What do you think?

Agree, revert this change as it works as expected already

So you fixed 2 pages so far - workspace invite message, welcome message.
Are you sure that no other occurrences throughout the app?

@hoangzinh hoangzinh marked this pull request as ready for review August 23, 2023 10:57
@hoangzinh hoangzinh requested a review from a team as a code owner August 23, 2023 10:57
@melvin-bot melvin-bot bot requested review from situchan and removed request for a team August 23, 2023 10:57
@melvin-bot
Copy link

melvin-bot bot commented Aug 23, 2023

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

@hoangzinh
Copy link
Contributor Author

Are you sure that no other occurrences throughout the app?

I tried to search Navigation.goBack() occurrences through the codebase and found 2 places above. Other places seem expectations with empty fallback route like pop current route out of history.

// Pop the invite message page before navigating to the members page.
Navigation.goBack();
Navigation.navigate(ROUTES.getWorkspaceMembersRoute(this.props.route.params.policyID));

@situchan
Copy link
Contributor

@hoangzinh we should fix all possible cases even though Navigation.goBack is not defined.
HeaderWithBackButton's onBackButtonPress callback returns Navigation.goBack() as default.
i.e.
#22887 was closed in favor of our issue.

@hoangzinh
Copy link
Contributor Author

@situchan I tried to add more places that I think it's missing fallback route. Regarding the bug that you mentioned #22887. I think we can't fix it by filling the fallback route. In that bug, we're in the user profile, refresh the page, we wouldn't know what is the previous page that we visited. We might need to fix that issue by suggestion here https://expensify.slack.com/archives/C01GTK53T8Q/p1691912177038759, the backTo route

@hoangzinh
Copy link
Contributor Author

@situchan bump for code review. Are we good with PR so far?

<FullPageNotFoundView
shouldShow={_.isEmpty(props.report) || ReportUtils.isArchivedRoom(props.report)}
onBackButtonPress={() => Navigation.goBack(ROUTES.getReportRoute(props.report.reportID))}
>
<HeaderWithBackButton
title={props.translate(
Copy link
Contributor

Choose a reason for hiding this comment

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

There are still missing cases.
i.e. Header back button should go to Report Details page

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screen.Recording.2023-08-31.at.19.40.39.mov

If we fallback to navigate to report details page, it will cause regression in group report case.

@situchan
Copy link
Contributor

Please request review when all feedback is addressed.

@hoangzinh we should fix all possible cases even though Navigation.goBack is not defined. HeaderWithBackButton's onBackButtonPress callback returns Navigation.goBack() as default.

I clearly stated that we should find & fix all occurrences of HeaderWithBackButton.

Btw, I am not able to review this sooner so gonna ask another C+ for help

@hoangzinh
Copy link
Contributor Author

Please request review when all feedback is addressed.

@hoangzinh we should fix all possible cases even though Navigation.goBack is not defined. HeaderWithBackButton's onBackButtonPress callback returns Navigation.goBack() as default.

I clearly stated that we should find & fix all occurrences of HeaderWithBackButton.

Btw, I am not able to review this sooner so gonna ask another C+ for help

@situchan just wanna clear that, if some cases that I think we should leave Navigation.goBack as it is, I should call with Navigation.goBack(ROUTES.HOME)

@situchan
Copy link
Contributor

@situchan just wanna clear that, if some cases that I think we should leave Navigation.goBack as it is, I should call with Navigation.goBack(ROUTES.HOME)

I feel more like we should hold this until #24291 is done.

@hoangzinh
Copy link
Contributor Author

hi @situchan, I listed remaining pages that missing onBackButtonPress props + reason why I didn't update them. Could you review them again if I missed any things else.

@hoangzinh
Copy link
Contributor Author

bump @situchan ^

@situchan
Copy link
Contributor

situchan commented Sep 1, 2023

Still inclined to hold this for now. And see how #24291 goes.

@hoangzinh
Copy link
Contributor Author

@situchan Updated with latest main. Could you help to review this PR + my comment here #25543 (comment). Thanks

@situchan
Copy link
Contributor

situchan commented Oct 1, 2023

@situchan Updated with latest main. Could you help to review this PR + my comment here #25543 (comment). Thanks

I am good with #25543 (comment).
WalletStatementPage: https://staging.new.expensify.com/statements/202308

@@ -63,6 +69,7 @@ function EnableStep(props) {
subtitle={props.policyName}
shouldShowGetAssistanceButton
guidesCallTaskID={CONST.GUIDES_CALL_TASK_IDS.WORKSPACE_BANK_ACCOUNT}
onBackButtonPress={() => Navigation.navigate(ROUTES.WORKSPACE_REIMBURSE.getRoute(props.policyID))}
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be handled in parent component (ReimbursementAccountPage)

Suggested change
onBackButtonPress={() => Navigation.navigate(ROUTES.WORKSPACE_REIMBURSE.getRoute(props.policyID))}
onBackButtonPress={props.onBackButtonPress}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion. Updated 4dbdfe2

@situchan
Copy link
Contributor

situchan commented Oct 6, 2023

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 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 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.mov
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

:shipit:

@melvin-bot melvin-bot bot requested a review from Beamanator October 6, 2023 07:09
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

LGTM!

@Beamanator Beamanator merged commit f7ac376 into Expensify:main Oct 6, 2023
14 of 15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 6, 2023

✋ 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
Copy link
Contributor

OSBotify commented Oct 9, 2023

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.80-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.80-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.81-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

2 similar comments
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform result
🤖 android 🤖 skipped 🚫
🖥 desktop 🖥 skipped 🚫
🍎 iOS 🍎 skipped 🚫
🕸 web 🕸 skipped 🚫

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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.

4 participants