fix arrow focus priority when multiple arrow listeners are subscribed

[azimgd]

Details

Fixes keyboard arrow navigation in the list if open "new chat". Keyboard arrow listeners priority was reset to highest value.

Key priority was initially lowered (to 1), to disable arrow up / down events from triggering when KeyboardShortcutsModal is open. #18425 has updated event subscription approach to event lifecycle hence we need to reset it back to highest priority when new modal is opened.

Fixed Issues

$ #18516
PROPOSAL: #18516

Tests

• Verify that no errors appear in the JS console

1. Click on "+" FAB menu icon
2. Click on "New chat"
3. Press CMD+K
4. Press up/down arrows keys in the keyboard to navigate in the chat list

---

1. Go to a chat
2. Type something
3. Press "SHIFT + ENTER"
4. Verify that a new line was added
5. Verify that you can move the cursor up and down by pressing arrow and down keys

---

1. Open "Create Group" modal by pressing CMD+SHIFT+K
2. Open "Keyboard shortcuts" modal by pressing CMD+J
3. Pressing Enter should first close "Keyboard shortcuts" modal, pressing enter again should select members on "Create Group" list
4. Open "Send Money" modal
5. Open "Keyboard shortcuts" modal by pressing CMD+J
6. 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
  • 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[melvin-bot]

@Beamanator @mananjadhav 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]

[Beamanator]

@azimgd thanks for the quick fix! However we want to make sure this doesn't break the other related PRs:

• Only subscribe shortcuts when modal is open #18425
• Fix pressing Enter key still triggers the Create Group while Shortcut modal opens. #18273

So can you make sure to test that those still work, and add the tests from those PRs here? 🙏

[Beamanator]

@mollfpr tagging you in as C+ since I know you're available now & we want to get this deploy blocker fixed quick 👍

[github-actions]

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

[azimgd]

"Tests" section was updated to include suite from 3 linked issues / pr's.

[mollfpr]

@azimgd I found another issue related to Enter key pressed on the new group chat selection is submitting the form. I remember this issue was already resolved in your PR previously, but it's raised again.

Step:

1. Open search page with command or click on the search icon
2. Open new group chat page with command CMD+Shift+K
3. Press enter

It's not selecting the option.

Screen.Recording.2023-05-08.at.21.00.33.mov

[azimgd]

@mollfpr could you have a look again please.

[mollfpr]

It's fixing the previous issue and the OP issue, but I'm able to use the arrow key in the new group chat page and can't close the keyboard shortcut modal after refreshing the page.

Screen.Recording.2023-05-08.at.21.15.36.mov

[azimgd]

That only happens if you refresh the page, correct?

[mollfpr]

@azimgd Correct!

[azimgd]

@Beamanator I'm out of time, and got to go for today. It seems like this is the only issue left:

• Open "New Group" modal (cmd + shift + k)
• Open keyboard shortcuts modal (cmd + j)
• refresh page
• arrow up / down events should not affect "New Group" modal

The reason this is happening is because CONST.KEYBOARD_SHORTCUTS.ARROW_UP in KeyboardShortcutsModal.js subscribes earlier (during component lifecycle) than the one in ArrowKeyFocusManager.js.

I suggest that we don't persist the state of visibility for KeyboardShortcutsModal hence refreshing will not show it, which makes most sense for me.

Let me know what do you think.

[Beamanator]

@azimgd Thanks for getting us this far & good ideas where to look next 👍

I have noticed that I'm not able to reproduce the bug when the keyboard shortcuts menu is showing over the "Search" page, but I AM able to reproduce when opening the keyboard shortcuts over the "group" chat & "individual" chat pages

[Beamanator]

I suggest that we don't persist the state of visibility for KeyboardShortcutsModal hence refreshing will not show it, which makes most sense for me.

This makes the most sense to me, but I'll try to check in with people who implemented that

[aldo-expensify]

I suggest that we don't persist the state of visibility for KeyboardShortcutsModal hence refreshing will not show it, which makes most sense for me.

Removing that state from Onyx makes sense to me. I don't know why we would like to keep it open if the user refresh the page.
This is the PR that added this modal: #6833

@roryabraham , do you know why we put the state ONYXKEYS.IS_SHORTCUTS_MODAL_OPEN in Onyx and not in a local state of the component? (just asking you because you are assigned to this issue)

[Beamanator]

Agreed @aldo-expensify 👍 asked in slack

[Beamanator]

Boom we're in agreement that the modal's visibility doesn't need to persist 💪

[aldo-expensify]

Moved the commits to this PR: #18599 so we can continue. cc @mollfpr we will need your review there :)