Fix: Dynamically update shortcuts list #28979

tienifr · 2023-10-06T05:50:22Z

Details

The shortcuts list was retrieved from a static file. Thus any changes from other files are not reflected. This PR creates a hook to dynamically update & retrieve it.

Fixed Issues

$ #27964
PROPOSAL: #27964 (comment)

Tests

Logout
Login
Toggle Keyboard shortcuts modal:
3a. Large screens (Three-pane layout): Immediately after login and while the LHN is still skeleton, Press CMD + J to toggle Keyboard shortcuts modal
3b. Small screens: Immediately after pressing a LHN item and while the chat is still skeleton, Press CMD + J to toggle Keyboard shortcuts modal
Verify that when LHN & the chat finish loading, CMD + C shorcuts appear in the modal
Press ESC
Verify that ESC does not disappear before modal is closed

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Logout
Login
Toggle Keyboard shortcuts modal:
3a. Large screens (Three-pane layout): Immediately after login and while the LHN is still skeleton, Press CMD + J to toggle Keyboard shortcuts modal
3b. Small screens: Immediately after pressing a LHN item and while the chat is still skeleton, Press CMD + J to toggle Keyboard shortcuts modal
Verify that when LHN & the chat finish loading, CMD + C shorcuts appear in the modal
Press ESC
Verify that ESC does not disappear before modal is closed

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

shortcuts-web-compressed.mov

Mobile Web - Chrome

Screenrecording_20231010_001156.mp4

Mobile Web - Safari

shortcuts-safari-compressed.mov

Desktop

Screen.Recording.2023-10-10.at.00.29.47.mov

iOS

shortcuts-ios-compressed.mov

Android

Screenrecording_20231010_002359.mp4

# Conflicts: # src/components/KeyboardShortcutsModal.js # src/libs/KeyboardShortcut/index.js

This reverts commit 9197143.

melvin-bot · 2023-10-09T17:31:19Z

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

tienifr · 2023-10-10T02:24:24Z

src/components/KeyboardShortcutsModal.js

+
+    /**
+     * Unsubscribe all shortcuts that were subscribed when the modal opened
+     * Call only when modal DID close


Otherwise, the modal shortcuts (i.e. ESC) would disappear while the modal hiding animation is still ongoing.

robertKozik · 2023-10-10T10:04:42Z

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: mWeb Chrome
- iOS: Native
- 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 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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

robertKozik

LGTM

cead22 · 2023-10-10T23:42:59Z

I know this the approved proposal, but this solution seems janky still, and looks like something we'll eventually change, cause we don't want thing jumping after that modal is open imo.

Given that, is there a reason we're showing the shortcuts only after they're registered (or whatever condition we're waiting for)? Can we simple list all the short cuts that will be available, and if the user uses CMD + C somewhere where that doesn't work, that's fine?

tienifr · 2023-10-11T21:20:34Z

@robertKozik What do you think of the above ^?

... is there a reason we're showing the shortcuts only after they're registered (or whatever condition we're waiting for)? Can we simple list all the short cuts that will be available, and if the user uses CMD + C somewhere where that doesn't work

Seems like the team has already decided to implement it here: #29063.

robertKozik · 2023-10-12T08:15:28Z

@tienifr In the light of the PR you linked, your changes are no longer relevant. I cannot reproduce this issue with newer implementation

cc. @cead22

cead22 · 2023-10-13T17:43:54Z

Should we close this then?

robertKozik · 2023-10-16T09:41:18Z

Yes @cead22 I think we can't proceed further with this as now shortcuts modal became separate page

tienifr added 16 commits August 21, 2023 19:51

fix: 25448

ef36aad

Merge branch 'main' into fix/25448

772d86c

fix: add listener approach

cd5458a

fix: add comment

f895285

fix: remove listener

b149efe

fix: remove hook

0ddc3f4

Merge branch 'fix/25448' into fix/27964

6687971

# Conflicts: # src/components/KeyboardShortcutsModal.js # src/libs/KeyboardShortcut/index.js

fix: dynamically update shortcuts list

ef3a03a

Merge branch 'main' of https://github.com/tienifr/App into fix/27964

e0a6383

fix lint

d48404f

unsubscribe open modal shorcuts only when modal did close

b5fd1fa

fix: 29060

9197143

Revert "fix: 29060"

2dd92d3

This reverts commit 9197143.

Merge branch 'main' of https://github.com/tienifr/App

2c7c9a9

Merge branch 'main' of https://github.com/tienifr/App into fix/27964

7d1112c

Merge branch 'main' of https://github.com/tienifr/App into fix/27964

809126e

tienifr marked this pull request as ready for review October 9, 2023 17:31

tienifr requested a review from a team as a code owner October 9, 2023 17:31

melvin-bot bot requested review from robertKozik and removed request for a team October 9, 2023 17:31

tienifr mentioned this pull request Oct 9, 2023

[$250] DEV: CMD + C does not show in Keyboard shortcuts modal immediately after login #27964

Closed

6 tasks

tienifr commented Oct 10, 2023

View reviewed changes

robertKozik approved these changes Oct 10, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 October 10, 2023 10:09

tienifr added 2 commits October 12, 2023 03:54

Merge branch 'main' of https://github.com/tienifr/App into fix/27964

b96b62e

Merge branch 'main' into fix/27964

580e929

cead22 closed this Oct 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Dynamically update shortcuts list #28979

Fix: Dynamically update shortcuts list #28979

tienifr commented Oct 6, 2023 •

edited

Loading

melvin-bot bot commented Oct 9, 2023

tienifr Oct 10, 2023 •

edited

Loading

robertKozik commented Oct 10, 2023 •

edited

Loading

robertKozik left a comment

cead22 commented Oct 10, 2023 •

edited

Loading

tienifr commented Oct 11, 2023 •

edited

Loading

robertKozik commented Oct 12, 2023

cead22 commented Oct 13, 2023

robertKozik commented Oct 16, 2023

Fix: Dynamically update shortcuts list #28979

Fix: Dynamically update shortcuts list #28979

Conversation

tienifr commented Oct 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 9, 2023

tienifr Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

robertKozik commented Oct 10, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

robertKozik left a comment

Choose a reason for hiding this comment

cead22 commented Oct 10, 2023 • edited Loading

tienifr commented Oct 11, 2023 • edited Loading

robertKozik commented Oct 12, 2023

cead22 commented Oct 13, 2023

robertKozik commented Oct 16, 2023

tienifr commented Oct 6, 2023 •

edited

Loading

tienifr Oct 10, 2023 •

edited

Loading

robertKozik commented Oct 10, 2023 •

edited

Loading

cead22 commented Oct 10, 2023 •

edited

Loading

tienifr commented Oct 11, 2023 •

edited

Loading