Allow keyboard shortcuts to work on native devices #14767
Conversation
melvin-bot
bot
requested review from
AndrewGable
and removed request for
a team
|
@AndrewGable 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] |
|
Please correct the linking Directly paste the link to the issue after the dollar |
|
@luacmartins @parasharrajat I kept original structure of KeyboardShortcut and added RNKeyCommand integration on top of that. We also need to merge Expensify/react-native-key-command#15 and update version here. |
src/libs/KeyboardShortcut/index.js
Outdated
| _.each(CONST.KEYBOARD_SHORTCUTS, (shortcut) => { | ||
| KeyCommand.addListener( | ||
| shortcut.trigger[operatingSystem] || shortcut.trigger.DEFAULT, | ||
| (keycommandEvent, event) => bindHandlerToKeydownEvent(getDisplayName, eventHandlers, keycommandEvent, event), | ||
| ); | ||
| }); |
There was a problem hiding this comment.
I think this is wrong. We are not supposed to attach handlers for all the shortcuts here.
There was a problem hiding this comment.
This is the same as:
App/src/libs/KeyboardShortcut/index.js
Lines 106 to 107 in 117e030
There was a problem hiding this comment.
I don't think it is the same. We should only subscribe to the event when there is at least one callback registered. Here we are attaching handlers for all the shortcuts what if user never subscribed to a key combination?
In the old code, there is one global listener which was easiest to keep active and then we handled the events based on the key combinations.
So instead of attaching the listener for all the shortcuts in the CONST file, only attach it when the user really subscribes to it.
There was a problem hiding this comment.
We have 2 level of callback handlers:
- System level callback subscriptions
document.addEventListenerfor webkeycommand.subscribefor native
- Application level callbacks
KeyboardShortcut.subscribe
System level callbacks don't support attaching multiple listeners to the same topic (e.g. Ctrl + I), which is a requirement. This is used to have same subscription topic (e.g. Esc) to be used in multiple pages and add priority argument support.
The code above is used for the first level and is definitely aligned to existing pattern used in KeyboardShortcut/index.js.
There was a problem hiding this comment.
Ok. We are attaching handlers for all the shortcuts what if the user never subscribes to a key combination? Even if there is no callback added, we will still have an event handle specific to that key combination. I am not seeing how this is better.
Can't we call the KeyCommand.addListener( logic inside subscribe when the first callback is registered or first subscribe is called. And then for the next call skip calling KeyCommand.addListener( as there is already a listener.
Are there any drawbacks of this?
There was a problem hiding this comment.
We are attaching handlers for all the shortcuts
We are attaching a "system-level" shortcuts defined in CONST file.
what if the user never subscribes to a key combination
Nothing happens, those are not attached at the application level hence won't affect React side.
Can't call the KeyCommand.addListener( logic inside subscribe when the first callback is registered or first subscribe is called.
Can't. Web has document.addEventListener which is attached for every key event, where library gets only 1 per key-command. Overall this will complicate the code and doesn't bring any benefits. We have tried this pattern in #14168.
There was a problem hiding this comment.
Ok, let me get this tested first and then we can look into this further.
There was a problem hiding this comment.
I mean, let me check first that everything is working and then we can decide if a refactor is needed.
|
FYI: arrow up/down is broken on main: https://expensify.slack.com/archives/C049HHMV9SM/p1675634800267959 |
|
Electron desktop fix (tested): Expensify/react-native-key-command#17. This fix needs to be deployed before Electron is tested. |
|
Tested on Android and Web. Everything is ready for review. |
0.7.0 is published! |
|
@parasharrajat have you started to review this ? |
|
Yup. A little busy with some stuff but I will share updates today. |
|
I will share the update in some time. I am currently AFK. |
|
@parasharrajat Can we set an exact timeframe and stick to this please ? Given dates are missed over and over again. We can agree upon a schedule that suits you and work together if you would like. Happy to help so we can get this finished asap. |
|
I am back now. Give me 20 mins and I will continue on this issue. Hope that works for you. |
|
Native builds are crashing from the above links as there was an issue on the main which is just fixed. @azimgd Can you please merge the main again 🙏 ? Meanwhile, I can test
|
|
@luacmartins Can you please trigger new builds? |
|
Adding two more bugs to the bugs list for mweb chrome. |
|
Triggered new builds. Links should be ready in ~1h |
Screenshots🔲 iOS / nativeWhatsApp.Video.2023-04-15.at.10.58.40.PM.mp4🔲 iOS / SafariWhatsApp.Video.2023-04-15.at.10.58.54.PM.mp4🔲 MacOS / Desktopscreen-2023-04-14_23.02.01.mp4🔲 MacOS / Chromescreen-2023-04-14_20.36.39.mp4🔲 Android / ChromeScreenrecorder-2023-04-14-21-09-37-327.mp4🔲 Android / nativeScreenrecorder-2023-04-14-21-03-23-9.mp4 |
|
🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪 |
|
I will have to wait for 8 hours to test and post the rest of the videos. I currently don't have the testing iPhone with me for 8 hours. Apologies for that. |
|
Iphone has been tested and approved by @luacmartins, and nothing has changed since then I believe? Should we be good to get this merged? |
|
Technically, yes. But I am doing a final checkup of everything. let's see what Carlos has to say about it. |
There was a problem hiding this comment.
There is a total of 13 bugs reported on this PR #14767 (comment). I am going to approve it based on the comment #14767 (comment).
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 correct English and approved by marketing by adding the
Waiting for Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
Gonna merge this one before we get more conflicts. Created the followup issue to fix there bugs - #17499 |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.1-0 🚀
|
1 similar comment
|
🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.1-0 🚀
|
|
@azimgd FYI we are reverting this PR due to the following issue with App Store Connect, which blocks our App from being deployed to production (the latest staging build is missing already). We use all of those selectors in
|
|
Oh, damn. |
|
surprise 🎉 |
|
🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀
|
Details
Fixed Issues
$ #6883
PROPOSAL: #6883
Tests
Offline tests
Same as QA Steps.
QA Steps
Note: you need to connect hardware keyboard to test mobile keyboard shortcuts on iOS and Android.
App/src/CONST.js
Lines 231 to 282 in ef6937c
All of the shortcuts here should work on Web.
List of known issues on Android and iOS: #14767 (comment) which are not counted as regressions.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.Screenshots/Videos
Web
KEY_WEB.mov
Mobile Web - Chrome
android.mov
Mobile Web - Safari
Simulator.Screen.Recording.-.iPhone.13.-.2023-03-29.at.07.59.54.mp4
Desktop
key_desktop.mov
iOS
Simulator.Screen.Recording.-.iPhone.13.-.2023-03-29.at.07.55.18.mp4
Android
IMG_2466.MOV