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 - display the home route when the app restarts on mobile platforms #36637

Conversation

HezekielT
Copy link
Contributor

Details

Opens the home route on app startup for native platforms by clearing the lastVisitedPath

Fixed Issues

$ #35927
PROPOSAL: #35927 (comment)

Tests

For IOS native and Android native

  1. Launch the app.
  2. Open any report.
  3. Close the app and kill it(make sure it is not running in the background).
  4. Launch the app.
  5. Verify that the Home route is displayed instead of the report opened on step two.

For Other platforms( Web, mobile chrome, safari, desktop)

  1. Open the expensify app.
  2. Open any report(chat).
  3. Close the tab(for web) or close the desktop app.
  4. Open the expensify app again( launch the desktop app).
  5. Verify that the report opened on step two is displayed.
  • 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: 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
restartFromHomeRoute.mov
Android: mWeb Chrome
mweb_RestartFromHomeRoute.mov
iOS: Native
ios_restartFromHomeRoute.mov
iOS: mWeb Safari
safari_restartFromHomeroute.mov
MacOS: Chrome / Safari
Web_RestartFromHomeRoute.mov
MacOS: Desktop
desktop_RestartFromHomeRoute.mov

@HezekielT HezekielT marked this pull request as ready for review February 15, 2024 21:56
@HezekielT HezekielT requested a review from a team as a code owner February 15, 2024 21:56
@melvin-bot melvin-bot bot requested review from rushatgabhane and removed request for a team February 15, 2024 21:56
Copy link

melvin-bot bot commented Feb 15, 2024

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

@@ -8,6 +9,13 @@ import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import platformSetup from './platformSetup';

function initializeLastVisitedPath(): string | undefined {
if (!(getPlatform() === CONST.PLATFORM.ANDROID || getPlatform() === CONST.PLATFORM.IOS)) {
Copy link
Member

@rushatgabhane rushatgabhane Feb 16, 2024

Choose a reason for hiding this comment

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

@HezekielT please use platform specific files for this function.
Nothing wrong with inline platform checks, but we want to be consistent with the codestyle

@rushatgabhane
Copy link
Member

rushatgabhane commented Feb 16, 2024

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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-02-16.at.20.19.11.mov
Android: mWeb Chrome
Screen.Recording.2024-02-16.at.20.00.57.mov
iOS: Native
Screen.Recording.2024-02-16.at.19.54.54.mov
iOS: mWeb Safari
Screen.Recording.2024-02-16.at.20.01.44.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-16.at.19.50.16.mov
MacOS: Desktop
Screen.Recording.2024-02-16.at.20.21.53.mov

@rushatgabhane
Copy link
Member

rushatgabhane commented Feb 16, 2024

@hayata-suenaga @HezekielT this works as expected on native, web and desktop.

But for me on mWeb, the app always restarts at home screen. I tried clearing cache and did a clean login.
Maybe something is wrong with my device because for @HezekielT the app starts on the last visitied screen.

I think we should merge 👍

@HezekielT
Copy link
Contributor Author

HezekielT commented Feb 16, 2024

@rushatgabhane You're right about the app always starting on home screen for mweb but the issue is also happening on the latest main. It seems a recent PR has broken the lastVisitedPath logic on main. I tested on staging as well and got the same result on mweb(the lastVisitedPath is not working anymore for mweb). What should we do?

I haven't tested production but this could be a deploy blocker.

@HezekielT
Copy link
Contributor Author

Staging:

staging.mov

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Feb 16, 2024

You're right about the app always starting on home screen for mweb but the issue is also happening on the latest main.

@HezekielT Does this issue only happen on mweb?
I tested on desktop Chrome but I couldn't reproduce.

@HezekielT
Copy link
Contributor Author

@hayata-suenaga Yes, it's reproducible only on mobile chrome.

@rushatgabhane
Copy link
Member

rushatgabhane commented Feb 16, 2024

Nice find! it's unrelated to the PR. So let's do nothing?

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Feb 16, 2024

@HezekielT @rushatgabhane I filed a bug report

I suggest we hold this PR until the bug is identified and fixed.

@rushatgabhane
Copy link
Member

rushatgabhane commented Feb 16, 2024

@hayata-suenaga should we hold on merging? because this PR is needed for e2e tests to run. And the bug is unrelated, it's about correctly setting the lastVisitedPath before the app is closed.

What do you think?

https://expensify.slack.com/archives/C05LX9D6E07/p1708015299306599?thread_ts=1708015218.455719&cid=C05LX9D6E07

@hayata-suenaga
Copy link
Contributor

by the way, QA codes for Ad Hoc builds will be posted on this PR soon because I was planning to test the issue with mweb. But as we now know that the issue is already present on staging, please ignore the ad hoc builds 🙇

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/36637/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/36637/NewExpensify.dmg https://36637.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@hayata-suenaga
Copy link
Contributor

@hayata-suenaga should we hold on merging? because this PR is needed for e2e tests to run. And the bug is unrelated, it's about correctly setting the lastVisitedPath before the app is closed.

you made a good point, especially on the broken E2E tests. I was trying to be cautious about merging before we can test this fully on all platforms, but I can see the argument that the discovered bug is not related to this PR.

I'd say... let's merge 🚀

Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

🟢

@hayata-suenaga hayata-suenaga merged commit c70f2d9 into Expensify:main Feb 16, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.43-0 🚀

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

@kbecciv
Copy link

kbecciv commented Feb 20, 2024

@HezekielT
This PR is failing because of issue #36926
The issue is reproducible in: IOS/Safari and Android/Chrome

Bug6385905_1708447709787.BRYO7003.mp4

@hayata-suenaga
Copy link
Contributor

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.43-20 🚀

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

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

Successfully merging this pull request may close these issues.

5 participants