fix: consistent order of keyboard shortcuts #19305

allroundexperts · 2023-05-19T18:15:54Z

Details

This PR makes the order in which keyboard shortcuts appear in the modal consistent.

Fixed Issues

$ #18542
PROPOSAL: #18542 (comment)

Tests

Open the ND app in Google Chrome and press CMD + J.
Note the order of the shortcuts that appear in the modal.
Open the ND app in Safari and press CMD + J

Verify that the order of shortcuts in the modal remains the same.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open the ND app in Google Chrome and press CMD + J.
Note the order of the shortcuts that appear in the modal.
Open the ND app in Safari and press CMD + J

Verify that the order of shortcuts in the modal remains the same.

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 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 correct English and 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-19.at.11.06.08.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-05-19.at.11.06.53.PM.mov

iOS

Android

melvin-bot · 2023-05-19T18:16:00Z

@marcaaron @eVoloshchak 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]

eVoloshchak · 2023-05-22T17:22:35Z

@allroundexperts, the PR looks good to me, but I'm a little bit confused about the steps

Open ND and press CMD + J.

Note the order of the shortcuts that appear in the modal.

Close the modal and reopen it, this time from the Settings -> About -> Keyboard Shortcuts page.

I can't reproduce this without the fix, order is always the same no matter where from I open the modal.
Original issue stated it's inconsistent across different browsers, which I can reproduce. Could you change the steps please? Or am I missing something when trying to reproduce it using your steps?

allroundexperts · 2023-05-22T17:24:13Z

@allroundexperts, the PR looks good to me, but I'm a little bit confused about the steps

Open ND and press CMD + J.

Note the order of the shortcuts that appear in the modal.

Close the modal and reopen it, this time from the Settings -> About -> Keyboard Shortcuts page.

I can't reproduce this without the fix, order is always the same no matter where from I open the modal.

Original issue stated it's inconsistent across different browsers, which I can reproduce. Could you change the steps please? Or am I missing something when trying to reproduce it using your steps?

This was happening for me on the same browser as well. If it's happening on different browsers for you, then I'll just change the steps.

eVoloshchak · 2023-05-22T17:31:42Z

This was happening for me on the same browser as well. If it's happening on different browsers for you, then I'll just change the steps.

Ok, thank you. Let's change the steps in accordance with #18542

Also, there is a shortcuts modal on mobile/IOS/Android, please include screenshots for those too

eVoloshchak · 2023-05-22T17:31:53Z

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

Screen.Recording.2023-05-22.at.20.42.03.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-05-22.at.20.45.23.mov

iOS

Android

allroundexperts · 2023-05-22T19:31:27Z

@eVoloshchak Updated the steps.

eVoloshchak

Looks good to me
cc: @marcaaron

marcaaron

LGTM! 🙇

marcaaron · 2023-05-23T00:53:33Z

src/libs/KeyboardShortcut/index.js

@@ -18,7 +18,7 @@ const documentedShortcuts = {};
 * @returns {Array}
 */
 function getDocumentedShortcuts() {
-    return _.values(documentedShortcuts);
+    return _.sortBy(_.values(documentedShortcuts), 'displayName');


actually... I think sortBy() works on objects so there's no need to call values()

I just tested and saw this:

marcaaron · 2023-05-23T00:55:09Z

Gonna merge as is because I'm going OOO and it's not worth introducing a delay over

OSBotify · 2023-05-23T01:00: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-05-25T00:35:27Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:08:59Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-25T01:30:55Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.18-0 🚀

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

OSBotify · 2023-05-26T07:08:07Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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

fix: consistent order of keyboard shortcuts

988c509

allroundexperts requested a review from a team as a code owner May 19, 2023 18:15

melvin-bot bot requested review from eVoloshchak and marcaaron and removed request for a team May 19, 2023 18:15

allroundexperts mentioned this pull request May 19, 2023

[HOLD for payment 2023-06-02] [$1000] The ordering of the last two keyboard shortcuts is not consistent across different browsers #18542

Closed

6 tasks

eVoloshchak approved these changes May 22, 2023

View reviewed changes

marcaaron approved these changes May 23, 2023

View reviewed changes

marcaaron reviewed May 23, 2023

View reviewed changes

marcaaron merged commit 846d593 into Expensify:main May 23, 2023

marcaaron assigned allroundexperts May 23, 2023

OSBotify mentioned this pull request May 25, 2023

Deploy Checklist: New Expensify 2023-05-25 #19565

Closed

53 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: consistent order of keyboard shortcuts #19305

fix: consistent order of keyboard shortcuts #19305

allroundexperts commented May 19, 2023 •

edited

Loading

melvin-bot bot commented May 19, 2023

eVoloshchak commented May 22, 2023

allroundexperts commented May 22, 2023

eVoloshchak commented May 22, 2023 •

edited

Loading

eVoloshchak commented May 22, 2023 •

edited

Loading

allroundexperts commented May 22, 2023

eVoloshchak left a comment

marcaaron left a comment

marcaaron May 23, 2023

marcaaron May 23, 2023

marcaaron commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

fix: consistent order of keyboard shortcuts #19305

fix: consistent order of keyboard shortcuts #19305

Conversation

allroundexperts commented May 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 19, 2023

eVoloshchak commented May 22, 2023

allroundexperts commented May 22, 2023

eVoloshchak commented May 22, 2023 • edited Loading

eVoloshchak commented May 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts commented May 22, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron May 23, 2023

Choose a reason for hiding this comment

marcaaron May 23, 2023

Choose a reason for hiding this comment

marcaaron commented May 23, 2023

OSBotify commented May 23, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

allroundexperts commented May 19, 2023 •

edited

Loading

eVoloshchak commented May 22, 2023 •

edited

Loading

eVoloshchak commented May 22, 2023 •

edited

Loading