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: app goes to workspace initial page when back from not found page #49226

Merged
merged 19 commits into from
Nov 7, 2024

Conversation

dominictb
Copy link
Contributor

@dominictb dominictb commented Sep 15, 2024

Details

Fixed Issues

$ #46646
PROPOSAL: #46646 (comment)

Tests

[Native only]

  1. Send a workspace settings link with invalid ID in a report (e.g., /settings/workspaces/1/more-features)
  2. Open the link
  3. Swipe back from not found page (Do not press Back button)

Verify app goes back to workspaces list page

  1. Open the link in step 1 by deep linking
  2. Swipe back from not found page (Do not press Back button)

Verify app goes back to workspaces list page

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

[Native only]

  1. Send a workspace settings link with invalid ID in a report (e.g., /settings/workspaces/1/more-features)
  2. Open the link
  3. Swipe back from not found page (Do not press Back button)

Verify app goes back to workspaces list page

  1. Open the link in step 1 by deep linking
  2. Swipe back from not found page (Do not press Back button)

Verify app goes back to workspaces list page

  • 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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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

Android: Native
Screen.Recording.2024-09-16.at.16.21.46.mov
Android: mWeb Chrome
Screen.Recording.2024-09-16.at.02.46.07.mov
iOS: Native
Screen.Recording.2024-09-16.at.02.40.23.mov
iOS: mWeb Safari
Screen.Recording.2024-09-16.at.02.42.38.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-16.at.02.41.18.mov
MacOS: Desktop
Screen.Recording.2024-09-16.at.03.10.07.mov

@dominictb dominictb marked this pull request as ready for review September 15, 2024 20:11
@dominictb dominictb requested a review from a team as a code owner September 15, 2024 20:11
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team September 15, 2024 20:11
Copy link

melvin-bot bot commented Sep 15, 2024

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

@dominictb
Copy link
Contributor Author

@shubham1206agra Plz hold up your review. This issue is not fixed when deep linking. Will tell you once it's resolved.

@shubham1206agra
Copy link
Contributor

@adamgrzybowski Tagging you here for additional review.

return CommonActions.reset({
...state,
routes,
index: routes.length < state.routes.length ? state.index - 1 : state.index,
Copy link
Contributor

Choose a reason for hiding this comment

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

index: routes.length - 1 should be enough. The index for the stack points to the last element of the array.

BTW the current implementation for calculating the index would break if there is more than one screen with given name. It's not possible for the workspace initial but it is possible for other screens.

Maybe we should limit this function to filter out just the last found route with this name? It may make sense even with fixed index implementation to limit this function.

Also maybe we don't have to call reset if we haven't removed any route?

Copy link
Contributor Author

@dominictb dominictb Sep 24, 2024

Choose a reason for hiding this comment

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

After testing, I found this function does not work properly since the Workspace_Initial is always inside FullScreenNavigator, so we cannot filter out the Workspace_Initial by using state.routes?.filter((item) => item.name !== screen). It prevents the app from working properly when deep linking.

@adamgrzybowski
Copy link
Contributor

I left some small comments, but overall I think it's good 🚀

@dominictb
Copy link
Contributor Author

@adamgrzybowski I left a comment here. Still working to fix that.

@dominictb
Copy link
Contributor Author

@adamgrzybowski Idk why the RESET action has no effects in this case even though the filtered routes is correct. Do you have any clue?

@adamgrzybowski
Copy link
Contributor

@dominictb I can look into this 👁️ 👁️

@adamgrzybowski
Copy link
Contributor

hey @dominictb what reproduction steps should trigger the removeScreenFromNavigationState function?

@dominictb
Copy link
Contributor Author

@adamgrzybowski Navigating to an invalid workspace ID link by deep liking:

  1. Open iOS Simulator
  2. Run npx uri-scheme open new-expensify://settings/workspaces/1/more-features -i

@adamgrzybowski
Copy link
Contributor

Okay, I found the problem. The Reset action works but the isLoadingReportData in the CustomFullScreenRouter isn't updated so adaptIfNecessary adds the workspace initial screen once again.

I made it work with some refs etc but I don't think we should use hooks in the CustomFullScreenRouter. It's not really a component.

There should be a way to get this information without using hooks.

cc: @dominictb @shubham1206agra

@dominictb
Copy link
Contributor Author

Sorry this is quite complicated. I need time for thorough investigation. Will provide update tomorrow.

@shubham1206agra
Copy link
Contributor

@dominictb Can you convert this PR to draft?

@dominictb
Copy link
Contributor Author

I moved isLoadingReportData to PolicyUtils and fixed the issue in deep linking case. We can continue.

@shubham1206agra
Copy link
Contributor

@dominictb Bump here

@dominictb
Copy link
Contributor Author

The deep linking scenario has many cases to handle. This requires very careful testing. I'll provide update today.

@dominictb
Copy link
Contributor Author

@shubham1206agra I fixed both the wide screen and deep linking issues. You can retest now.

@dominictb
Copy link
Contributor Author

@shubham1206agra How's it going?

@shubham1206agra
Copy link
Contributor

@dominictb I think the initial screen is getting popped out incorrectly.

Screen.Recording.2024-11-07.at.11.21.31.AM.mov

@shubham1206agra
Copy link
Contributor

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Screen.Recording.2024-11-07.at.12.21.49.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-11-07.at.11.26.34.AM.mov
iOS: Native
Screen.Recording.2024-11-07.at.12.13.53.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-11-07.at.11.09.50.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-07.at.11.03.59.AM.mov
MacOS: Desktop
Screen.Recording.2024-11-07.at.11.34.23.AM.mov

@melvin-bot melvin-bot bot requested a review from lakchote November 7, 2024 07:06
@shubham1206agra
Copy link
Contributor

@lakchote Please wait for @dominictb's confirmation for #49226 (comment) on main.

@dominictb
Copy link
Contributor Author

dominictb commented Nov 7, 2024

@shubham1206agra @lakchote My testing indicates that the problem happens on main as well, not related to this PR.

@lakchote
Copy link
Contributor

lakchote commented Nov 7, 2024

@dominictb I think the initial screen is getting popped out incorrectly.

@Expensify/design what do you think?

@lakchote lakchote merged commit f05be95 into Expensify:main Nov 7, 2024
17 checks passed
@shawnborton
Copy link
Contributor

Hmm yeah that does feel like it's not working as expected. I'm not too familiar with how the Android back button works but I would expect it to just take you back to the previous page you were on.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 7, 2024

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

Copy link
Contributor

github-actions bot commented Nov 7, 2024

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.59-0 🚀

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

@Julesssss
Copy link
Contributor

Hey @lakchote are you able to verify this on staging to check it off the checklist please? QA aren't able to currently.

@lakchote
Copy link
Contributor

@Julesssss it works correctly on staging:

ScreenRecording_11-11-2024.09-18-38_1.MP4

@shubham1206agra why did you create a revert PR?

@shubham1206agra
Copy link
Contributor

Just to test a deploy blocker. I will close it.

Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.59-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫

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.

7 participants