Only subscribe shortcuts when modal is open #18425

aldo-expensify · 2023-05-04T18:16:45Z

Details

The shortcut modal subscribe some shortcuts to block them from working while its open.
The previous implementation ended up blocking some key functions in the composer because we end up calling this event.preventDefault() here:

App/src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.js

Lines 46 to 48 in 2437e37

    
           if (callback.shouldPreventDefault) { 
        
               event.preventDefault(); 
        
           }

Some more details: #18420 (comment)

Fixed Issues

$ #18420
PROPOSAL: Option 1 from #18420 (comment)

Tests

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

Follow the testing steps of this other PR: #18273

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Follow the testing steps of this other PR: #18273

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-04.at.11.41.14.AM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

Screen.Recording.2023-05-04.at.11.59.23.AM.mov

iOS

Android

Screen.Recording.2023-05-04.at.12.03.34.PM.mov

MelvinBot · 2023-05-04T18:23:16Z

@flodnv @s77rt 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]

s77rt

Some slight suggestions

Move the subscribe(s) block to a new method
Call that new method on component did mount as well if we initially rendered the modal as open
Call the new method on component did update (as you currently do)

marcaaron

Testing now but looks good

marcaaron · 2023-05-04T18:29:28Z

src/components/KeyboardShortcutsModal.js

+            if (this.unsubscribeArrowDownKey) {
+                this.unsubscribeArrowDownKey();
+                this.unsubscribeArrowDownKey = undefined;
+            }


NAB, but this makes me wonder if we should be hooking these into the render of something like the modal content. Seems kind of weird to have these listeners all getting created or removed as a side effect of the prop changing instead of the mount/unmount. But maybe we can do something about it here.

Agreed, I thought of creating a class component that would be rendered inside the modal only when prop.isShortcutsModalOpen = true. That way we could have used mount/unmount which is a bit cleaner I think.

I didn't continue because we are supposed to migrate everything to hooks, so it would have to be redone anyway.

azimgd · 2023-05-04T18:33:04Z

Just tested, LGTM.

marcaaron · 2023-05-04T18:33:09Z

Since this is a deploy blocker I think we should follow up with anything like this later:

Move the subscribe(s) block to a new method
Call that new method on component did mount as well if we initially rendered the modal as open
Call the new method on component did update (as you currently do)

aldo-expensify · 2023-05-04T18:39:29Z

I updated the code to handle this: #18425 (review)

If you refresh with the modal open, the modal appears open and the shortcuts were not subscribed.

src/components/KeyboardShortcutsModal.js

github-actions · 2023-05-04T18:51:24Z

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

s77rt · 2023-05-04T19:02:28Z

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.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

s77rt

LGTM! 🚀

aldo-expensify · 2023-05-04T19:10:06Z

I'm having trouble testing in the android simulator and IOS simulator. Does that matter?

ping @marcaaron if you can review the latest changes 🙏

marcaaron

Just one small style comment as we prefer underscore to array methods still.

src/components/KeyboardShortcutsModal.js

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

aldo-expensify · 2023-05-04T19:40:12Z

Updated the .forEach to _.each. Retested.

…ng-s77rt-proposal Only subscribe shortcuts when modal is open (cherry picked from commit dc644fd)

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

OSBotify · 2023-05-04T21:17:49Z

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

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:15Z

🚀 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:49:03Z

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

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

Only subscribe shortcuts when modal is open

f07e3ad

aldo-expensify self-assigned this May 4, 2023

aldo-expensify 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 marked this pull request as ready for review May 4, 2023 18:23

aldo-expensify requested a review from a team as a code owner May 4, 2023 18:23

melvin-bot bot requested review from flodnv and s77rt and removed request for a team May 4, 2023 18:23

s77rt suggested changes May 4, 2023

View reviewed changes

marcaaron reviewed May 4, 2023

View reviewed changes

marcaaron previously approved these changes May 4, 2023

View reviewed changes

Refactor / register shortcuts if modal starts open

a834ca0

aldo-expensify dismissed marcaaron’s stale review via a834ca0 May 4, 2023 18:34

s77rt suggested changes May 4, 2023

View reviewed changes

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

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

Make function name more consistent

4650155

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

aldo-expensify mentioned this pull request May 4, 2023

Exclude from capturing event from TEXTAREA (composer) #18422

Closed

57 tasks

s77rt previously approved these changes May 4, 2023

View reviewed changes

marcaaron requested changes May 4, 2023

View reviewed changes

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

Use _.each instead of .forEach

3258a1e

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

aldo-expensify dismissed s77rt’s stale review via 3258a1e May 4, 2023 19:28

Call unsubscribe correctly

1bb8817

aldo-expensify requested a review from marcaaron May 4, 2023 19:40

marcaaron approved these changes May 4, 2023

View reviewed changes

aldo-expensify requested a review from s77rt May 4, 2023 19:44

aldo-expensify merged commit dc644fd into main May 4, 2023

aldo-expensify deleted the aldo_fix-fix-enter-not-working-s77rt-proposal branch May 4, 2023 19:44

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

Merge pull request #18425 from Expensify/aldo_fix-fix-enter-not-worki…

c34e817

…ng-s77rt-proposal Only subscribe shortcuts when modal is open (cherry picked from commit dc644fd)

OSBotify mentioned this pull request May 4, 2023

🍒 Cherry pick PR #18425 to staging 🍒 #18438

Merged

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

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

19a753b

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

OSBotify mentioned this pull request May 4, 2023

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

Closed

32 tasks

OSBotify mentioned this pull request May 5, 2023

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

Closed

31 tasks

azimgd 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

hoangzinh mentioned this pull request May 8, 2023

[$1000] Hover options are stuck when we close the reaction emoji picker using ESC #18217

Closed

6 tasks

aldo-expensify mentioned this pull request May 8, 2023

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

Merged

57 tasks

dukenv0307 mentioned this pull request May 12, 2023

[$1000] ESC key focuses the input field in emoji picker before closing it #18559

Closed

6 tasks

OSBotify mentioned this pull request Jun 15, 2023

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

Closed

mollfpr mentioned this pull request Aug 23, 2023

[HOLD for payment 2023-09-21] [$1000] dev: ESC keyboard shortcut shows up in modal on second render on login page #25448

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Only subscribe shortcuts when modal is open #18425

Only subscribe shortcuts when modal is open #18425

aldo-expensify commented May 4, 2023 •

edited

Loading

MelvinBot commented May 4, 2023

s77rt left a comment

marcaaron left a comment

marcaaron May 4, 2023

aldo-expensify May 4, 2023

azimgd commented May 4, 2023

marcaaron commented May 4, 2023

aldo-expensify commented May 4, 2023

github-actions bot commented May 4, 2023

s77rt commented May 4, 2023

s77rt left a comment

aldo-expensify commented May 4, 2023

marcaaron left a comment

aldo-expensify commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

	if (callback.shouldPreventDefault) {
	event.preventDefault();
	}

Only subscribe shortcuts when modal is open #18425

Only subscribe shortcuts when modal is open #18425

Conversation

aldo-expensify commented May 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented May 4, 2023

s77rt left a comment

Choose a reason for hiding this comment

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron May 4, 2023

Choose a reason for hiding this comment

aldo-expensify May 4, 2023

Choose a reason for hiding this comment

azimgd commented May 4, 2023

marcaaron commented May 4, 2023

aldo-expensify commented May 4, 2023

github-actions bot commented May 4, 2023

s77rt commented May 4, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

aldo-expensify commented May 4, 2023

marcaaron left a comment

Choose a reason for hiding this comment

aldo-expensify commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

aldo-expensify commented May 4, 2023 •

edited

Loading