fix: dont pop RHP when shortcuts modal is open #21114

WoLewicki · 2023-06-20T12:41:27Z

Details

PR moving the esc shortcut support to SidebarLinks since we want this listener to be added only once, and earlier it was in ScreenWrapper, so it was added each time we pushed a new report. It resulted in firing the callback and Navigation.dismissModal(); for each of those reports instead of only once.

Fixed Issues

$ #20615

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open Settings
Click CMD+J to open modal
Press Esc and see that only modal is dismissed and Settings are still there

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

Only including screenshots for web as that is where the ESC shortcut is used and its same as desktop

Web

Nagranie.z.ekranu.2023-06-20.o.14.42.46.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-20T12:41:32Z

@aimane-chnaif 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]

aimane-chnaif · 2023-06-20T15:38:37Z

SidebarLinks is fine for now as no modals in login pages but isn't it better to move this to Expensify.js? similar to KeyboardShortcutsModal

aimane-chnaif · 2023-06-20T16:49:25Z

Nvm, RHP is only after login and SidebarLinks should always be mounted if RHP is shown

@WoLewicki please add Tests step

WoLewicki · 2023-06-20T17:00:06Z

Added test step

aimane-chnaif · 2023-06-20T17:10:48Z

Mobile Chrome bug: ESC closes RHP instead of shortcut modal.
This happens on main/production. @mountiny should this bug be reported and fixed?

mchrome.mov

aimane-chnaif · 2023-06-20T17:12:49Z

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.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

Android

WoLewicki · 2023-06-20T17:14:07Z

Hmm seems like this check https://github.com/Expensify/App/pull/21114/files#diff-dd7de4cc8cf99cd14ad8b5168c24c75a12d25aca423502eaaaccedd71c31cb1cR132 is not true there for some reason. So it only happens on mobile chrome? That seems even weirder.

aimane-chnaif · 2023-06-20T17:16:40Z

Hmm seems like this check https://github.com/Expensify/App/pull/21114/files#diff-dd7de4cc8cf99cd14ad8b5168c24c75a12d25aca423502eaaaccedd71c31cb1cR132 is not true there for some reason. So it only happens on mobile chrome? That seems even weirder.

yes correct.
it's difficult to test on real device. External keyboard should be connected.
It's definitely bug but that's why I asked if it's worth fixing.

WoLewicki · 2023-06-20T17:19:24Z

We can check to be sure that this check if wrong for some reason and debug why it happens, but since you need an external keyboard to be able to reproduce it, it doesn't seem like an urgent issue. I am on chrome on my laptop and it works just ok here, so it seems to be connected to the mobile chrome only.

aimane-chnaif · 2023-06-20T17:20:49Z

We can check to be sure that this check if wrong for some reason and debug why it happens, but since you need an external keyboard to be able to reproduce it, it doesn't seem like an urgent issue. I am on chrome on my laptop and it works just ok here, so it seems to be connected to the mobile chrome only.

You can still easily test on android emulator, iOS simulator as hardware keyboard is connected already.

mountiny · 2023-06-20T17:49:21Z

You can still easily test on android emulator, iOS simulator as hardware keyboard is connected already.

Does it work fine in chrome if you change the layout to mobile width?

aimane-chnaif · 2023-06-20T18:10:31Z

You can still easily test on android emulator, iOS simulator as hardware keyboard is connected already.

Does it work fine in chrome if you change the layout to mobile width?

yes fine

mountiny

Alright, thanks everyone. In that case I think we can go ahead and @aimane-chnaif ~~I will create a new bug for this to investigate as part of the navigation refactor follow-ups.~~ Actually I think this is not really required. This is edge case and I am not sure if we support the keyboard events on mobile.

OSBotify · 2023-06-20T19:29:52Z

✋ 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 · 2023-06-21T02:26:19Z

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

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

aimane-chnaif · 2023-06-22T14:45:35Z

This is edge case and I am not sure if we support the keyboard events on mobile.

yes we do. This feature was implemented for $40k in #6883

OSBotify · 2023-06-22T16:53:57Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.30-5 🚀

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

mountiny · 2023-07-04T19:01:10Z

@aimane-chnaif hah you are right, if this has not been raised yet, do you want to raise it as a bug in the bugs channel?

fix: dont pop RHP when shortcuts modal is open

0a83930

WoLewicki requested a review from a team as a code owner June 20, 2023 12:41

melvin-bot bot requested review from aimane-chnaif and removed request for a team June 20, 2023 12:41

mountiny assigned WoLewicki Jun 20, 2023

mountiny self-requested a review June 20, 2023 15:26

aimane-chnaif approved these changes Jun 20, 2023

View reviewed changes

mountiny approved these changes Jun 20, 2023

View reviewed changes

mountiny merged commit 8e7eaab into Expensify:main Jun 20, 2023

OSBotify mentioned this pull request Jun 21, 2023

Deploy Checklist: New Expensify 2023-06-21 #21172

Closed

67 tasks

melvin-bot bot mentioned this pull request Jun 22, 2023

[HOLD for payment 2023-06-29] [$1000] When overlay modal is open, ESC should close only such modal - attachement or keyboard shortcuts #20615

Closed

6 tasks

fix: dont pop RHP when shortcuts modal is open #21114

fix: dont pop RHP when shortcuts modal is open #21114

Uh oh!

Conversation

WoLewicki commented Jun 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

WoLewicki commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

WoLewicki commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

WoLewicki commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

mountiny commented Jun 20, 2023

Uh oh!

aimane-chnaif commented Jun 20, 2023

Uh oh!

mountiny left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 20, 2023

Uh oh!

OSBotify commented Jun 21, 2023

Uh oh!

aimane-chnaif commented Jun 22, 2023

Uh oh!

OSBotify commented Jun 22, 2023

Uh oh!

mountiny commented Jul 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WoLewicki commented Jun 20, 2023 •

edited

Loading

mountiny left a comment •

edited

Loading