Skip to content

Fix: On tapping device back button to close troubleshoot box from LHN, navigated out of site #58608

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

Merged
merged 18 commits into from
May 8, 2025

Conversation

nyomanjyotisa
Copy link
Contributor

@nyomanjyotisa nyomanjyotisa commented Mar 18, 2025

Explanation of Change

Fixed Issues

$ #58383
PROPOSAL: #58383 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open the test tool modal with Command + D or a four-finger gesture on mobile.
  2. Tap the browser back button or the device's back button.
  3. Verify that the test tool modal is closed.
  4. Open the search modal with Command + K or tap the search icon at the top.
  5. Tap the browser back button or the device's back button.
  6. Verify that the search modal is closed.
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Android-Native.mp4
Android: mWeb Chrome
Android-mWeb.Chrome.mp4
iOS: Native
iOS-Native.mp4
iOS: mWeb Safari
iOS-mWeb.Safari.mp4
MacOS: Chrome / Safari
MacOS-Chrome.mp4
MacOS: Desktop
MacOS-Desktop.mp4

@nyomanjyotisa nyomanjyotisa marked this pull request as ready for review March 18, 2025 04:42
@nyomanjyotisa nyomanjyotisa requested a review from a team as a code owner March 18, 2025 04:42
@melvin-bot melvin-bot bot requested a review from hungvu193 March 18, 2025 04:42
Copy link

melvin-bot bot commented Mar 18, 2025

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

@hungvu193
Copy link
Contributor

hungvu193 commented Mar 18, 2025

Everything is working well 🎉. The only concern here is that after the TestToolModal or SearchDialog are dismissed, the forward button does nothing, it's because we pushed an empty URL state here, to pop it when the user presses back later. And then when the modal hides, we pop that empty state here, which makes forward enabled.

if ((window.history.state as WindowState)?.shouldGoBack) {
window.history.back();
}

I think that's the reason why we only use shouldHandleNavigationBack with mobile browser:

Screen.Recording.2025-03-18.at.14.18.28.mov

@hungvu193
Copy link
Contributor

What do you think about the comment about? Do you have any idea to fix it?

@nyomanjyotisa
Copy link
Contributor Author

I noticed that the shouldHandleNavigationBack flag is also set to true in several modal

Should we address this issue in the current PR or handle it in a separate one?

I think we could add a new function to manage the forward click, which would reopen the modal. Will check further if we need to handle that case on this PR

@hungvu193
Copy link
Contributor

If a generic solution can be applied for all other places then I think Yes.

@nyomanjyotisa
Copy link
Contributor Author

Alright, I will look into that issue further. I'll let you know if we can use that approach

@hungvu193
Copy link
Contributor

Any luck? @nyomanjyotisa

@hungvu193
Copy link
Contributor

I'm thinking about the modal screen:
https://reactnavigation.org/docs/modal/

I think we also have a plan to convert all the current modal to screen (not sure what the latest decision is), but let me know your opinion.

@nyomanjyotisa
Copy link
Contributor Author

Unfortunately, I encountered some issues when implementing the approach to re-open the modal when the forward button is clicked

I'm thinking about the modal screen:
https://reactnavigation.org/docs/modal/

I think we also have a plan to convert all the current modal to screen (not sure what the latest decision is), but let me know your opinion.

Sure, let me try this approach

@hungvu193
Copy link
Contributor

Any updates here? Let me know anything that I can help

@hungvu193
Copy link
Contributor

Still in progress.

@hungvu193
Copy link
Contributor

Hey @nyomanjyotisa, any updates here?

If the modal screen solution doesn't work and you don't have any other solution to resolve the issue, then I think we should open this issue for proposals again.

@nyomanjyotisa nyomanjyotisa requested a review from a team as a code owner April 15, 2025 09:58
@nyomanjyotisa
Copy link
Contributor Author

@hungvu193 Sorry for the slow update here, could you please check the updated code? Thanks!

@hungvu193
Copy link
Contributor

Can you also update all the screenshots/videos please?

@nyomanjyotisa
Copy link
Contributor Author

Sure, I'll create a Slack post about overlay on native as soon as possible

@hungvu193
Copy link
Contributor

Checked on main, same behavior we can go ahead with current solution

I’m not sure whether CMD+K in the native app should open the Search modal, but it didn’t open anything in the latest main The same goes for CMD+D, it didn’t open the Test Tools modal in the latest main

OK, let me investigate this one. In the meantime, can you create a slack post to get help with the overlay on native please?

@@ -67,6 +68,11 @@ function PublicScreens() {
component={PublicRightModalNavigator}
options={rootNavigatorScreenOptions.rightModalNavigator}
/>
<RootStack.Screen
name={NAVIGATORS.TEST_TOOLS_MODAL_NAVIGATOR}
options={rootNavigatorScreenOptions.basicModalNavigator}
Copy link
Contributor

Choose a reason for hiding this comment

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

We can create a custom screen options here with the native option for the native to enable the overlay:

Suggested change
options={rootNavigatorScreenOptions.basicModalNavigator}
options={{
...rootNavigatorScreenOptions.basicModalNavigator,
native: {
contentStyle: {
backgroundColor: theme.overlay
}
}
}}

We can confirm the backdrop color with design team later:

Screen.Recording.2025-05-05.at.10.22.22.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

Now we have another thing to address. Click on overlay to dismiss the modal. You can see the references here:
https://reactnavigation.org/docs/stack-navigator/#transparent-modals

If you want to further customize how the dialog animates, or want to close the screen when tapping the overlay etc., you can use the useCardAnimation hook to customize elements inside your screen.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated the PR and addressed this issue as well

Click on overlay to dismiss the modal

Could you please review it again?

contentStyle: {
backgroundColor: theme.overlay,
},
animation: InternalPlatformAnimations.SLIDE_FROM_BOTTOM,
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's use FADE here for smoother animation

Suggested change
animation: InternalPlatformAnimations.SLIDE_FROM_BOTTOM,
animation: InternalPlatformAnimations.FADE,

@hungvu193
Copy link
Contributor

hungvu193 commented May 7, 2025

Hi @Expensify/design team, we plan to migrate the current TestTools modal to Modal Screen. Could you please review the UI below and give us feedback? Thank you

With slide from bottom animation:

push.from.bottom.mov

With fade animation:

fade.mov

Chrome:

Screen.Recording.2025-05-07.at.09.34.10.mov

@dubielzyk-expensify
Copy link
Contributor

Desktop looks fine to me, but the mobile versions don't have a transparent scrim/overlay. You can't see the content behind the modal:

CleanShot 2025-05-07 at 13 54 32@2x
CleanShot 2025-05-07 at 13 56 20@2x

It should be slightly transparent like the rest of our modals and what we see on desktop 👍

@nyomanjyotisa
Copy link
Contributor Author

The PR has been updated to address the native overlay issue. Here’s how it looks now:

iOS-Native.mp4

@dannymcclain
Copy link
Contributor

Good shout Jon. Also, not sure how much we want to mess with this, but on mobile I would expect the overlay to fade in and the modal to slide up—that's how our other modal/bottom sheets work. (But I realize getting this perfect might not be our top priority.)

@hungvu193
Copy link
Contributor

So I think #58608 (comment) will look correctly

@hungvu193
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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
Android.mov
Android: mWeb Chrome
mAndroid.mov
iOS: HybridApp
fade.mov
push.from.bottom.mov
Screen.Recording.2025-05-08.at.16.26.52.mov
iOS: mWeb Safari
Safari.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Desktop.mov

Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

Looks good, nice work!

@blimpich blimpich merged commit a957d55 into Expensify:main May 8, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented May 8, 2025

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

francoisl added a commit that referenced this pull request May 13, 2025
This reverts commit a957d55, reversing
changes made to cefd53a.
luacmartins added a commit that referenced this pull request May 13, 2025
Revert "Merge pull request #58608 from nyomanjyotisa/issue-58383"
OSBotify pushed a commit that referenced this pull request May 13, 2025
Revert "Merge pull request #58608 from nyomanjyotisa/issue-58383"

(cherry picked from commit 6569995)

(cherry-picked to staging by francoisl)
@hungvu193
Copy link
Contributor

@kavimuru yes. This PR was reverted to fix few blockers

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