Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

azimgd · 2023-05-02T14:44:07Z

Details

Adds enter shortcut for KeyboardShortcutsModal so that you can close it by pressing enter. Decrease priority for Enter keys on BaseOptionsSelector and MoneyRequestAmountPage modals.

Fixed Issues

$ #17590
PROPOSAL: #17590 (comment)

Tests

Verify that no errors appear in the JS console

Open "Create Group" modal by pressing CMD+SHIFT+K
Open "Keyboard shortcuts" modal by pressing CMD+J
Pressing Enter should first close "Keyboard shortcuts" modal, pressing enter again should select members on "Create Group" list
Open "Send Money" modal
Open "Keyboard shortcuts" modal by pressing CMD+J
Pressing Enter should first close "Keyboard shortcuts" modal, pressing enter again submit form on "Send Money" modal

Offline tests

Same as Tests.

QA Steps

Verify that no errors appear in the JS console

Same as Tests.

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 (not applicable)
- Android / Chrome (not applicable)
- iOS / native (not applicable)
- iOS / Safari (not applicable)
- 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

Web

Screen.Recording.2023-05-02.at.19.36.55.mov

Mobile Web - Chrome

(not applicable)

Mobile Web - Safari

(not applicable)

Desktop

shortcuts2.mov

iOS

(not applicable)

Android

(not applicable)

…t by pressing enter

MelvinBot · 2023-05-02T14:44:13Z

@robertjchen @mollfpr One of you needs to 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]

azimgd · 2023-05-02T15:22:27Z

@mollfpr Could you please have a look?

mollfpr

Thanks @azimgd for this PR. Just need some clarity.

src/components/KeyboardShortcutsModal.js

src/pages/iou/steps/MoneyRequestAmountPage.js

src/components/KeyboardShortcutsModal.js

azimgd · 2023-05-03T06:27:27Z

Thanks @mollfpr, addressed your comments.

mollfpr · 2023-05-03T06:52:40Z

Thanks @azimgd looks better now! I'll start testing it now.

mollfpr · 2023-05-03T08:36:34Z

mollfpr · 2023-05-03T08:41:14Z

@azimgd There's a regression in the group split bill confirmation list; pressing Enter in the option selection should select/deselect the option, not submit the form.

Go to the group chat
Open action and select Split Bill
Enter an amount
Press the arrow keys to highlight the option and press enter after the option is highlighted

Screen.Recording.2023-05-03.at.15.38.14.mov

mollfpr · 2023-05-03T08:44:11Z

Another issue we already address is the issue about the arrow key in the options list. When the KeyboardShortcutsModal is open, the arrow key shouldn't be usable for traveling the options list.

Screen.Recording.2023-05-03.at.15.41.41.mov

azimgd · 2023-05-03T09:34:01Z

Thank you for your detailed review @mollfpr, fixed both issues.

mollfpr · 2023-05-03T11:19:19Z

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

18273.Web.mov

Mobile Web - Chrome

18273.mWeb.Chrome.mov

Mobile Web - Safari

18273.mWeb.Safari.mp4

Desktop

18273.Desktop.mov

iOS

18273.iOS.mp4

Android

18273.Android.mov

mollfpr

Thanks @azimgd for the quick update!

Just small detail and we will good to go.

mollfpr · 2023-05-03T11:21:19Z

src/components/KeyboardShortcutsModal.js

@@ -40,19 +40,50 @@ class KeyboardShortcutsModal extends React.Component {
            KeyboardShortcutsActions.showKeyboardShortcutModal();
        }, openShortcutModalConfig.descriptionKey, openShortcutModalConfig.modifiers, true);

-        const closeShortcutModalConfig = CONST.KEYBOARD_SHORTCUTS.ESCAPE;
-        this.unsubscribeEscapeModal = KeyboardShortcut.subscribe(closeShortcutModalConfig.shortcutKey, () => {
+        /**


Just small detail, I believe this comments block should use // instead /** in the block comment.

What's your idea behind using inline vs multiline codeblock?

We mainly use multiline code blocks for the JSDoc and the prop-types comment. I couldn't find documentation, but I recall we've reviewed this before.

@robertjchen Could you help confirm this?

I'm okay if we are not strict about it now, just something came up in my mind.

Got you, thanks. Updated.

mollfpr

Thanks @azimgd! LGTM and tests well 👍

All yours @robertjchen

robertjchen

LGTM!

OSBotify · 2023-05-04T06:46:14Z

✋ 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-05-04T16:42:10Z

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.3.10-0 🚀

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

OSBotify · 2023-05-09T04:05:46Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

aldo-expensify · 2023-05-19T20:19:26Z

src/components/KeyboardShortcutsModal.js

+        const closeShortcutEnterModalConfig = CONST.KEYBOARD_SHORTCUTS.ENTER;
+        this.unsubscribeCloseEnterModal = KeyboardShortcut.subscribe(closeShortcutEnterModalConfig.shortcutKey, () => {
+            ModalActions.close();
+            KeyboardShortcutsActions.hideKeyboardShortcutModal();
+        }, closeShortcutEnterModalConfig.descriptionKey, closeShortcutEnterModalConfig.modifiers, true, () => !this.props.isShortcutsModalOpen);
+
+        // Intercept arrow up and down keys to prevent scrolling ArrowKeyFocusManager while this modal is open
+        const arrowUpConfig = CONST.KEYBOARD_SHORTCUTS.ARROW_UP;
+        this.unsubscribeArrowUpKey = KeyboardShortcut.subscribe(arrowUpConfig.shortcutKey, () => {
+        }, arrowUpConfig.descriptionKey, arrowUpConfig.modifiers, true, () => !this.props.isShortcutsModalOpen);
+
+        const arrowDownConfig = CONST.KEYBOARD_SHORTCUTS.ARROW_DOWN;
+        this.unsubscribeArrowDownKey = KeyboardShortcut.subscribe(arrowDownConfig.shortcutKey, () => {
+        }, arrowDownConfig.descriptionKey, arrowDownConfig.modifiers, true, () => !this.props.isShortcutsModalOpen);


Following BugZero checklist: This code caused the regression here: #18420

Add enter shortcut for KeyboardShortcutsModal so that you can close i…

fce62f8

…t by pressing enter

azimgd requested a review from a team as a code owner May 2, 2023 14:44

melvin-bot bot requested review from mollfpr and robertjchen and removed request for a team May 2, 2023 14:44

mollfpr reviewed May 3, 2023

View reviewed changes

src/components/KeyboardShortcutsModal.js Outdated Show resolved Hide resolved

src/pages/iou/steps/MoneyRequestAmountPage.js Outdated Show resolved Hide resolved

src/components/KeyboardShortcutsModal.js Outdated Show resolved Hide resolved

code review fixes

3e31c49

azimgd added 2 commits May 3, 2023 14:03

decrease split bill modal enter key subscriber

f90358a

intercept arrow shortcuts

f1e0c4c

mollfpr suggested changes May 3, 2023

View reviewed changes

Update comment block at KeyboardShortcutsModal

9792d5b

mollfpr approved these changes May 3, 2023

View reviewed changes

robertjchen approved these changes May 4, 2023

View reviewed changes

robertjchen merged commit f524362 into Expensify:main May 4, 2023

OSBotify mentioned this pull request May 4, 2023

Deploy Checklist: New Expensify 2023-05-04 #18411

Closed

32 tasks

Pujan92 mentioned this pull request May 4, 2023

[$1000] [HOLD for payment 2023-05-16] Typing a new line with "SHIFT + ENTER" in the composer doesn't work (neither the arrow keys to move the cursor up or down) #18420

Closed

6 tasks

aldo-expensify mentioned this pull request May 4, 2023

Only subscribe shortcuts when modal is open #18425

Merged

57 tasks

mollfpr mentioned this pull request May 8, 2023

[HOLD for payment 2023-05-16] Unable to use keyboard arrow navigation in the list if open "new chat" #18516

Closed

6 tasks

Beamanator mentioned this pull request May 8, 2023

fix arrow focus priority when multiple arrow listeners are subscribed #18578

Closed

57 tasks

melvin-bot bot mentioned this pull request May 9, 2023

[HOLD for payment 2023-05-16] [$2000] Pressing Enter key still triggers the Create Group while Shortcut modal opens. #17590

Closed

6 tasks

aldo-expensify reviewed May 19, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

azimgd commented May 2, 2023 •

edited

Loading

MelvinBot commented May 2, 2023

azimgd commented May 2, 2023

mollfpr left a comment

azimgd commented May 3, 2023

mollfpr commented May 3, 2023

mollfpr commented May 3, 2023 •

edited

Loading

mollfpr commented May 3, 2023

mollfpr commented May 3, 2023

azimgd commented May 3, 2023

mollfpr commented May 3, 2023

mollfpr left a comment

mollfpr May 3, 2023

azimgd May 3, 2023

mollfpr May 3, 2023

azimgd May 3, 2023

mollfpr left a comment

robertjchen left a comment

OSBotify commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented May 9, 2023

aldo-expensify May 19, 2023

Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

Conversation

azimgd commented May 2, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented May 2, 2023

azimgd commented May 2, 2023

mollfpr left a comment

Choose a reason for hiding this comment

azimgd commented May 3, 2023

mollfpr commented May 3, 2023

mollfpr commented May 3, 2023 • edited Loading

mollfpr commented May 3, 2023

mollfpr commented May 3, 2023

azimgd commented May 3, 2023

mollfpr commented May 3, 2023

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

mollfpr May 3, 2023

Choose a reason for hiding this comment

azimgd May 3, 2023

Choose a reason for hiding this comment

mollfpr May 3, 2023

Choose a reason for hiding this comment

azimgd May 3, 2023

Choose a reason for hiding this comment

mollfpr left a comment

Choose a reason for hiding this comment

robertjchen left a comment

Choose a reason for hiding this comment

OSBotify commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented May 9, 2023

aldo-expensify May 19, 2023

Choose a reason for hiding this comment

azimgd commented May 2, 2023 •

edited

Loading

mollfpr commented May 3, 2023 •

edited

Loading