Allow keyboard shortcuts to work on native devices #14168

azimgd · 2023-01-10T00:42:41Z

Details

Fixed Issues

$ 6883
PROPOSAL: 6883

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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 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 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 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.
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 · 2023-01-10T00:43:10Z

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

luacmartins · 2023-01-10T20:06:37Z

We'll need to change this PR to imported the scoped @expensify/react-native-key-command package!

azimgd · 2023-01-11T07:42:08Z

waiting for the package to be published.

parasharrajat · 2023-01-11T08:59:38Z

I am on flaky internet till 15 JAN so my reviews can be delayed. I see we are waiting on the final package also. let's get everything ready on this PR.

Test steps for all platforms.
QA steps for all platforms.
Offline steps.
Videos.

luacmartins · 2023-01-12T00:41:29Z

Sorry, I didn't get to this one today. I'll get back to it tomorrow!

luacmartins · 2023-01-13T17:25:58Z

@azimgd left a comment about publishing the package to npm

azimgd · 2023-01-16T14:50:39Z

@luacmartins wrapping up my PR and will un-publish the package tomorrow.

luacmartins · 2023-01-16T18:02:54Z

Ok, let me know when it's done and I'll work on publishing it from our end. Thanks!

parasharrajat · 2023-01-16T19:24:17Z

I am up with the speed now and I will test it once you are done with package changes.

luacmartins · 2023-01-19T16:34:22Z

@azimgd did you get a chance to unpublish the package?

azimgd · 2023-01-19T16:40:46Z

yes. 👍

luacmartins · 2023-01-19T22:40:07Z

Ok, I tried publishing but it seems like there's a 24h wait period. I'll try again tomorrow!

403 Forbidden - PUT https://registry.npmjs.org/react-native-key-command - react-native-key-command cannot be republished until 24 hours have passed.

luacmartins · 2023-01-20T16:56:26Z

Package published!

luacmartins · 2023-01-23T19:25:10Z

@azimgd what's the latest update on this one?

azimgd · 2023-01-24T13:09:12Z

Android commands:
CTRL+K: adb shell "input keyevent 113 && input keyevent 39"
CTRL+SHIFT+K: adb shell "input keyevent 113 && input keyevent 39 && input keyevent 59"
CTRL+I: adb shell "input keyevent 113 && input keyevent 37"
ESC: adb shell "input keyevent 111"

azimgd · 2023-01-26T16:45:27Z

Let's start with the code review when you get a chance. I would like to know if you have any comments on the approach.

Overall just couple of things are missing there:

Using priority argument
Debug cmd + enter shortcut

Tested on:

web
ios
android

https://github.com/Expensify/App/pull/14168/files

parasharrajat · 2023-01-30T20:06:05Z

@azimgd Let's merge main in this first.

azimgd · 2023-01-30T21:50:50Z

@parasharrajat merged

ios/Podfile.lock

src/libs/KeyboardShortcut/index.js

ios/Podfile.lock

parasharrajat

BUG: The web shortcut CTRL+ I does not work on firefox and chrome. It is working on staging.

Pressing CTRL+ I opens page info dialog on this branch.

Same for CTRL + K & CTRL + SHIFT + K.

azimgd · 2023-01-30T22:27:27Z

Mac ?

parasharrajat · 2023-01-30T22:29:14Z

It does not matter if the platform is Mac or not. It is the web so it should work everywhere. I will test on Mac as well. Give me 10 mins.

azimgd · 2023-01-30T22:36:10Z

I'm well aware of the fact that it should work on any platform. I asked you which platform are you testing on.

parasharrajat · 2023-01-30T22:36:41Z

Ok, Mac works.
On Mac, I am using CMD+ I but on Linux ctrl+ I does not work. Same for chrome.

azimgd · 2023-01-30T23:53:55Z

updated.

azimgd · 2023-01-31T16:23:09Z

@parasharrajat any more feedback?

parasharrajat · 2023-01-31T16:25:18Z

Testing it again in a few minutes.

azimgd · 2023-01-31T19:47:00Z

Have you had a chance to test ?

parasharrajat · 2023-01-31T22:46:06Z

src/styles/styles.js


    keyboardShortcutModalContainer: {
        maxHeight: '100%',
-        flex: '0 0 auto',


Let's revert this change which is unnecessary to this PR.

RN doesn't support '0 0 auto'.

Ok, I am seeing a bad design for the keyboard shortcut Modal. So let's fix that as well.

The modal height is not correct. This is not present on staging.

fixed by removing flexGrow on CONST.MODAL.MODAL_TYPE.CENTERED_UNSWIPEABLE.

That is being used at:

KeyboardShortcutsModal

AttachmentModal

Tested against production, results look coorect.

src/components/KeyboardShortcutsModal.js

src/libs/KeyboardShortcut/index.js

parasharrajat

What are the future plans for this PR? I see that priority is not yet implemented. Why is this still in draft mode?

Can you please add details of the logical changes in the PR description?

parasharrajat · 2023-02-01T16:35:35Z

src/CONST.js

+    KEYCOMMAND_LIBRARY_SPECIFIC_KEYS: [
+        [['CTRL'], {
+            DEFAULT: KeyCommand.constants.keyModifierControl,
+            [PLATFORM_OS_MACOS]: KeyCommand.constants.keyModifierCommand,
+        }],
+        [['CTRL', 'SHIFT'], {
+            DEFAULT: KeyCommand.constants.keyModifierControlShift,
+            [PLATFORM_OS_MACOS]: KeyCommand.constants.keyModifierShiftCommand,
+        }],
+    ],


@luacmartins Do you think it's readable? Do you have any suggestions for this?

Can we try to keep it more in line with what we have here?

May be use CONST to map the platform keys and then map the correct combinations to the keyCommand consts in the function itself.

parasharrajat · 2023-02-01T16:36:11Z

src/libs/KeyboardShortcut/index.js

    }

-    return () => unsubscribe(displayName, callbackID);
+    return () => {};


How are we controlling the unsubscribing now?

azimgd · 2023-02-02T19:14:03Z

Closing this in favor of #14767

azimgd added 4 commits January 10, 2023 05:38

temporarily add test rnkeycommand npm dependency

04c396a

remove obsolete flex: none style, this doesn't work on RN

cc72071

fix KeyboardShortcutModal view on RN native

11fa517

add react-native-key-command package support for ios

0f0d52c

azimgd requested a review from a team as a code owner January 10, 2023 00:42

melvin-bot bot requested review from techievivek and removed request for a team January 10, 2023 00:43

azimgd marked this pull request as draft January 10, 2023 00:44

luacmartins requested review from luacmartins and parasharrajat January 10, 2023 19:31

npm dependency update

de035c5

azimgd added 3 commits January 24, 2023 22:02

add android installation

8fe2af7

update package to the latest version

d7558bc

update podfile

23ba672

azimgd mentioned this pull request Jan 30, 2023

[HOLD for payment 2023-05-03] [HOLD for payment 2023-04-26] [$32,000] Allow keyboard shortcuts to work on native devices #6883

Closed

merge main

d379e62

parasharrajat reviewed Jan 30, 2023

View reviewed changes

ios/Podfile.lock Outdated Show resolved Hide resolved

rollback googleutils

79b0812

parasharrajat suggested changes Jan 30, 2023

View reviewed changes

src/libs/KeyboardShortcut/index.js Outdated Show resolved Hide resolved

src/libs/KeyboardShortcut/index.js Outdated Show resolved Hide resolved

rollback googleutils

1141206

parasharrajat reviewed Jan 30, 2023

View reviewed changes

ios/Podfile.lock Outdated Show resolved Hide resolved

code-review

621ebbf

parasharrajat suggested changes Jan 30, 2023

View reviewed changes

add ctrl support on non-apple devices

012ee6e

parasharrajat suggested changes Jan 31, 2023

View reviewed changes

parasharrajat reviewed Jan 31, 2023

View reviewed changes

src/libs/KeyboardShortcut/index.js Outdated Show resolved Hide resolved

azimgd added 2 commits February 1, 2023 05:08

fix keyboard shortcuts modal on web

573e7f6

extract getLibraryAdjustedModifiers to const

a232100

parasharrajat suggested changes Feb 1, 2023

View reviewed changes

azimgd closed this Feb 2, 2023

azimgd mentioned this pull request Feb 9, 2023

Allow keyboard shortcuts to work on native devices #14767

Merged

54 tasks

Allow keyboard shortcuts to work on native devices #14168

Allow keyboard shortcuts to work on native devices #14168

Uh oh!

Conversation

azimgd commented Jan 10, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jan 10, 2023

Uh oh!

luacmartins commented Jan 10, 2023

Uh oh!

azimgd commented Jan 11, 2023

Uh oh!

parasharrajat commented Jan 11, 2023

Uh oh!

luacmartins commented Jan 12, 2023

Uh oh!

luacmartins commented Jan 13, 2023

Uh oh!

azimgd commented Jan 16, 2023

Uh oh!

luacmartins commented Jan 16, 2023

Uh oh!

parasharrajat commented Jan 16, 2023

Uh oh!

luacmartins commented Jan 19, 2023

Uh oh!

azimgd commented Jan 19, 2023

Uh oh!

luacmartins commented Jan 19, 2023

Uh oh!

luacmartins commented Jan 20, 2023

Uh oh!

luacmartins commented Jan 23, 2023

Uh oh!

azimgd commented Jan 24, 2023

Uh oh!

azimgd commented Jan 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parasharrajat commented Jan 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azimgd commented Jan 30, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

parasharrajat left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azimgd commented Jan 30, 2023

Uh oh!

parasharrajat commented Jan 30, 2023

Uh oh!

azimgd commented Jan 30, 2023

Uh oh!

parasharrajat commented Jan 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azimgd commented Jan 30, 2023

Uh oh!

azimgd commented Jan 31, 2023

Uh oh!

parasharrajat commented Jan 31, 2023

Uh oh!

azimgd commented Jan 31, 2023

Uh oh!

parasharrajat Jan 31, 2023

Choose a reason for hiding this comment

Uh oh!

azimgd Jan 31, 2023

azimgd commented Jan 26, 2023 •

edited

Loading

parasharrajat commented Jan 30, 2023 •

edited

Loading

parasharrajat left a comment •

edited

Loading

parasharrajat commented Jan 30, 2023 •

edited

Loading

parasharrajat Jan 31, 2023 •

edited

Loading