Fix arrow focus shortcut modal local state (v2.0) #18599

aldo-expensify · 2023-05-08T17:48:16Z

These are the changes from:

We moved the commits to this new PR because @azimgd is gone for the day and we needed to add a few more changes.

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

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

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

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

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-08.at.11.22.38.AM.mov

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

Screen.Recording.2023-05-08.at.11.19.00.AM.mov

iOS

N/A

Android

N/A

melvin-bot · 2023-05-08T17:48:22Z

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

github-actions · 2023-05-08T17:50:01Z

⚠️ ⚠️ 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.

melvin-bot · 2023-05-08T17:55:10Z

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

aldo-expensify · 2023-05-08T18:24:03Z

Tested and added videos for Web and Desktop which is where I think shortcuts matter.

neil-marcellini

Ok, this tests well from what I can see and I think the changes make sense.

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

web.mov

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

desktop.mov

iOS

N/A

Android

N/A

neil-marcellini · 2023-05-08T19:13:40Z

src/components/OptionsSelector/BaseOptionsSelector.js

@@ -360,7 +359,7 @@ class BaseOptionsSelector extends Component {
                                text={defaultConfirmButtonText}
                                onPress={this.props.onConfirmSelection}
                                pressOnEnter
-                                enterKeyEventListenerPriority={2}
+                                enterKeyEventListenerPriority={1}


We lowered this from 2 to 1 because now the priority for the enter key is 0 correct?

I'm guessing that is the case. Do you think we should just leave as 2?

This change came from this PR: #18578

neil-marcellini · 2023-05-08T19:15:11Z

src/components/KeyboardShortcutsModal.js

-        isShortcutsModalOpen: {key: ONYXKEYS.IS_SHORTCUTS_MODAL_OPEN},
+        isShortcutsModalOpen: {
+            key: ONYXKEYS.IS_SHORTCUTS_MODAL_OPEN,
+            initWithStoredValues: false,


Why don't we want to init with the store value?

This is kind of NAB but I would still like to know why we changed this.

Because it was causing problems here: #18578 (comment)

Slack conversation: https://expensify.slack.com/archives/C01GTK53T8Q/p1683563738386549?thread_ts=1683551147.132719&cid=C01GTK53T8Q

I see, ok that works for me. It's definitely not necessary for the keyboard shortcuts modal to persist it's open state between refreshes.

aldo-expensify · 2023-05-08T19:59:51Z

@mollfpr are you going to have time to review this today?

aldo-expensify · 2023-05-08T20:01:13Z

@aldo-expensify this works on only desktop version, not mobile?

@best-lucky1030 I'm not sure I understand the question correctly. Are you asking if this only fixes the problem for desktop and not mobile?

This is about keyboard shortcuts, I'm don't think its possible to use them in Mobile, but correct me I'm wrong about that.

aldo-expensify · 2023-05-08T20:40:15Z

@best-lucky1030 what is the video from here showing? a bug? I'm not understanding the problem. Are you suggesting we should test in mobile the part of the testing steps about the composer and the enter key:

Go to a chat

Type something

Press "SHIFT + ENTER"

Verify that a new line was added

Verify that you can move the cursor up and down by pressing arrow and down keys

…arrow-focus-shortcut-modal-local-state

aldo-expensify · 2023-05-08T21:57:57Z

Merged with main to fix tests

melvin-bot · 2023-05-08T21:57:57Z

@Beamanator @0xmiroslav 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]

aldo-expensify · 2023-05-08T22:04:26Z

I'm going to merge this since I think its working and Neil approved. @mollfpr seems to be offline now.

…shortcut-modal-local-state Fix arrow focus shortcut modal local state (v2.0) (cherry picked from commit 0192b2c)

…-18599 🍒 Cherry pick PR #18599 to staging 🍒

OSBotify · 2023-05-08T23:33:55Z

🚀 Cherry-picked to staging by https://github.com/aldo-expensify in version: 1.3.11-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-15T01:31:09Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-16T18:48:57Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

azimgd and others added 4 commits May 8, 2023 10:33

fixes arrow focus priority when multiple arrow listeners are subscribed

61b98dd

reset keyboard shortcut priorities

4f075e4

Stop keyboard shortcut modal from persisting

793851f

Ignore stored value at start

73bb00e

aldo-expensify requested review from Beamanator, mollfpr and a team May 8, 2023 17:48

aldo-expensify self-assigned this May 8, 2023

melvin-bot bot requested review from sobitneupane and removed request for a team May 8, 2023 17:48

This was referenced May 8, 2023

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

Closed

Stop keyboard shortcut modal from persisting #18595

Closed

aldo-expensify added the CP Staging label May 8, 2023

aldo-expensify requested review from a team and removed request for sobitneupane May 8, 2023 17:55

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team May 8, 2023 17:55

aldo-expensify removed the request for review from abdulrahuman5196 May 8, 2023 17:55

aldo-expensify 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

neil-marcellini self-requested a review May 8, 2023 18:45

neil-marcellini approved these changes May 8, 2023

View reviewed changes

Merge branch 'main' of github.com:Expensify/App into aldo_azimgd_fix-…

6a543bc

…arrow-focus-shortcut-modal-local-state

aldo-expensify requested a review from a team as a code owner May 8, 2023 21:57

melvin-bot bot removed the request for review from a team May 8, 2023 21:57

melvin-bot bot requested a review from 0xmiros May 8, 2023 21:57

aldo-expensify merged commit 0192b2c into main May 8, 2023

aldo-expensify deleted the aldo_azimgd_fix-arrow-focus-shortcut-modal-local-state branch May 8, 2023 22:04

OSBotify pushed a commit that referenced this pull request May 8, 2023

Merge pull request #18599 from Expensify/aldo_azimgd_fix-arrow-focus-…

e0f2624

…shortcut-modal-local-state Fix arrow focus shortcut modal local state (v2.0) (cherry picked from commit 0192b2c)

OSBotify mentioned this pull request May 8, 2023

🍒 Cherry pick PR #18599 to staging 🍒 #18613

Merged

OSBotify added a commit that referenced this pull request May 8, 2023

Merge pull request #18613 from Expensify/OSBotify-cherry-pick-staging…

debb786

…-18599 🍒 Cherry pick PR #18599 to staging 🍒

OSBotify mentioned this pull request May 8, 2023

Deploy Checklist: New Expensify 2023-05-05 #18498

Closed

31 tasks

OSBotify mentioned this pull request May 9, 2023

Deploy Checklist: New Expensify 2023-05-09 #18627

Closed

26 tasks

s77rt mentioned this pull request May 19, 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

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix arrow focus shortcut modal local state (v2.0) #18599

Fix arrow focus shortcut modal local state (v2.0) #18599

aldo-expensify commented May 8, 2023 •

edited

Loading

melvin-bot bot commented May 8, 2023

github-actions bot commented May 8, 2023

melvin-bot bot commented May 8, 2023

aldo-expensify commented May 8, 2023

neil-marcellini left a comment

neil-marcellini May 8, 2023

aldo-expensify May 8, 2023

neil-marcellini May 8, 2023

neil-marcellini May 8, 2023

aldo-expensify May 8, 2023

neil-marcellini May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

melvin-bot bot commented May 8, 2023

aldo-expensify commented May 8, 2023

OSBotify commented May 8, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

Fix arrow focus shortcut modal local state (v2.0) #18599

Fix arrow focus shortcut modal local state (v2.0) #18599

Conversation

aldo-expensify commented May 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 8, 2023

github-actions bot commented May 8, 2023

melvin-bot bot commented May 8, 2023

aldo-expensify commented May 8, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

neil-marcellini May 8, 2023

Choose a reason for hiding this comment

aldo-expensify May 8, 2023

Choose a reason for hiding this comment

neil-marcellini May 8, 2023

Choose a reason for hiding this comment

neil-marcellini May 8, 2023

Choose a reason for hiding this comment

aldo-expensify May 8, 2023

Choose a reason for hiding this comment

neil-marcellini May 8, 2023

Choose a reason for hiding this comment

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

aldo-expensify commented May 8, 2023

melvin-bot bot commented May 8, 2023

aldo-expensify commented May 8, 2023

OSBotify commented May 8, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

aldo-expensify commented May 8, 2023 •

edited

Loading