Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page by Charan-hs · Pull Request #26809 · Expensify/App

Charan-hs · 2023-09-05T16:51:26Z

Details

Fixed Issues

Tests

Sign out if you are logged in
Refresh the page
Press cmd+j to open the shortcut modal
Now you can observe escape key has been added
Close and open it again to verify.

Note for testing in native please use a physical Keyboard to open the modal.
We can't refresh in Navtive (Android, iOS) so please close and reopen the app i.e. step 2.

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Sign out if you are logged in
Refresh the page
Press cmd+j to open the shortcut modal
Now you can observe escape key has been added
Close and open it again to verify.

Note for testing in native please use a physical Keyboard to open the modal.
We can't refresh in Navtive (Android, iOS) so please close and reopen the app i.e. step 2.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

keyboard.shortcut.modal.fix.mp4

Mobile Web - Chrome

WhatsApp.Video.2023-09-08.at.12.00.10.PM.mp4

Mobile Web - Safari

Screen.Recording.2023-09-08.at.11.46.06.AM.mov

Desktop

keyboard.desktop.mp4

iOS

Screen.Recording.2023-09-08.at.11.47.19.AM.mov

Android

WhatsApp.Video.2023-09-08.at.1.26.18.PM.mp4

melvin-bot · 2023-09-05T16:51:31Z

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

mollfpr · 2023-09-06T04:43:12Z

@Charan-hs Add the test step, please.

mollfpr

Mostly looks good, just couple of comment.

mollfpr · 2023-09-07T03:31:32Z

        // We only want this to run on mount
        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
+    }, [KeyboardShortcut.getDocumentedShortcuts]);


Are we still depending on KeyboardShortcut.getDocumentedShortcuts? The comment says that this useEffect only runs on mount.

mollfpr · 2023-09-07T03:32:11Z

        // subscribeOpenModalShortcuts and unsubscribeOpenModalShortcuts functions are not added as dependencies since they don't change between renders
        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [isShortcutsModalOpen]);
+    }, [isShortcutsModalOpen, KeyboardShortcut.getDocumentedShortcuts]);


Same as the above, what is the reason for adding the dependency?

removing those deps

mollfpr · 2023-09-07T03:39:41Z

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

26809.Web.mov

Mobile Web - Chrome

26809.mWeb.Chrome.mp4

Mobile Web - Safari

26809.mWeb.Safari.mp4

Desktop

26809.Desktop.mov

iOS

26809.iOS.mp4

Android

26809.Android.mp4

mollfpr · 2023-09-07T03:45:19Z

@Charan-hs I see that you commented on #26829, Will the issue be fixed in this PR? I tried the steps in this PR, but the issue is still reproduced. Logically, that issue will be fixed with your solution. Could you check? Thanks!

Charan-hs · 2023-09-07T04:04:49Z

Yes we can fix this #26829 issue but here #25448 (comment) it mentioned to mark it as a separate bug, If you want I can fix issue with same PR

mollfpr · 2023-09-07T04:10:02Z

@Charan-hs I see your suggestion for fixing the unsubscribe here. Is that all you need to fix #26829, and this PR is also part of the fix? If yes, we should keep it separate so the original issue won't be out of scope and it easier to track the issue.

Charan-hs · 2023-09-07T04:22:18Z

@mollfpr, yes with this we can fix #26829, here for pointer number two, we are fixing it with this PR. it's a dupe of #25448
yes, we can keep it as a separate issue.

mollfpr · 2023-09-07T04:32:20Z

Thanks @Charan-hs

Since #26829 it's already put external, we should fix the issue there. Feel free to post the proposal there, or you could ask them to wait for this PR to be merged to get a better result.

Charan-hs · 2023-09-07T05:00:01Z

My proposal already posted here #26829 (comment)

mollfpr

LGTM and tests well 👍

refresh the page
@Charan-hs Could you add a note here for the test on native platforms?

Like refresh the page (for iOS and Android you need to close and reopen the app)?

arosiclair · 2023-09-08T21:20:20Z

Merge freeze ends on Monday. I'll merge then

mollfpr · 2023-09-11T12:40:33Z

Hi @Charan-hs, the freeze season is past! Before we get this merge, could we pull the latest main and retest the PR? Thanks!

Charan-hs · 2023-09-12T14:36:28Z

Hi @mollfpr, I was wondering if you could let me know why this hasn't been merged yet? I would really appreciate it.

mollfpr · 2023-09-12T14:39:17Z

@arosiclair I tested it again with the latest commit, which still tests well. We can get this merged.

Sorry @Charan-hs, I can't merge any PR. Only the internal engineer can do it.

OSBotify · 2023-09-12T15:31:06Z

✋ 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-09-13T09:14:02Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.3.69-0 🚀

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

OSBotify · 2023-09-14T10:28:16Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.69-2 🚀

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

OSBotify · 2023-09-14T10:55:19Z

🚀 Deployed to staging by https://github.com/arosiclair in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:13:18Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

state for shortcuts

fcf6bff

Charan-hs requested a review from a team as a code owner September 5, 2023 16:51

melvin-bot Bot requested review from mollfpr and removed request for a team September 5, 2023 16:51

mollfpr reviewed Sep 6, 2023

View reviewed changes

Comment thread src/components/KeyboardShortcutsModal.js Resolved

Setting State in subscribeOpenModalShortcuts

b9bbd11

Charan-hs changed the title ~~state for shortcuts~~ Fix: 25448 state for shortcuts Sep 6, 2023

Charan-hs changed the title ~~Fix: 25448 state for shortcuts~~ Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page Sep 6, 2023

mollfpr reviewed Sep 7, 2023

View reviewed changes

removed dep

29f9310

Charan-hs mentioned this pull request Sep 7, 2023

[HOLD for payment 2023-10-09] [$500] After Logout, using CMD + J only generates 2 shortcuts in the pop-up (instead of the full list) #26829

Closed

1 of 6 tasks

Charan-hs requested a review from mollfpr September 8, 2023 03:49

mollfpr reviewed Sep 8, 2023

View reviewed changes

Comment thread src/components/KeyboardShortcutsModal.js Resolved

Charan-hs requested a review from mollfpr September 8, 2023 07:57

mollfpr approved these changes Sep 8, 2023

View reviewed changes

melvin-bot Bot requested a review from arosiclair September 8, 2023 12:01

arosiclair approved these changes Sep 8, 2023

View reviewed changes

arosiclair changed the title ~~Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page~~ [HOLD 9/11] Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page Sep 8, 2023

Merge branch 'Expensify:main' into 25448-ESC-keyboard-shortcut

5e74153

Merge branch 'Expensify:main' into 25448-ESC-keyboard-shortcut

94485be

arosiclair changed the title ~~[HOLD 9/11] Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page~~ Fix: 25448 ESC keyboard shortcut shows up in modal on second render on login page Sep 12, 2023

arosiclair merged commit 106abf2 into Expensify:main Sep 12, 2023

OSBotify mentioned this pull request Sep 13, 2023

Deploy Checklist: New Expensify 2023-09-13 #27313

Closed

72 tasks done

melvin-bot Bot mentioned this pull request Sep 14, 2023

[HOLD for payment 2023-09-21] [$1000] dev: ESC keyboard shortcut shows up in modal on second render on login page #25448

Closed

1 of 6 tasks

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

Conversation

Charan-hs commented Sep 5, 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 Sep 5, 2023

Uh oh!

mollfpr commented Sep 6, 2023

Uh oh!

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

Charan-hs Sep 7, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr commented Sep 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr commented Sep 7, 2023

Uh oh!

Charan-hs commented Sep 7, 2023

Uh oh!

mollfpr commented Sep 7, 2023

Uh oh!

Charan-hs commented Sep 7, 2023

Uh oh!

mollfpr commented Sep 7, 2023

Uh oh!

Charan-hs commented Sep 7, 2023

Uh oh!

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

arosiclair commented Sep 8, 2023

Uh oh!

mollfpr commented Sep 11, 2023

Uh oh!

Charan-hs commented Sep 12, 2023

Uh oh!

mollfpr commented Sep 12, 2023

Uh oh!

OSBotify commented Sep 12, 2023

Uh oh!

OSBotify commented Sep 13, 2023

Uh oh!

OSBotify commented Sep 14, 2023

Uh oh!

OSBotify commented Sep 14, 2023

Uh oh!

OSBotify commented Sep 18, 2023

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Charan-hs commented Sep 5, 2023 •

edited

Loading

mollfpr commented Sep 7, 2023 •

edited

Loading