Allow keyboard shortcuts to work on native devices

[azimgd]

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/6883 PROPOSAL: https://github.com/Expensify/App/issues/6883

Tests

• [x] Verify that no errors appear in the JS console

Offline tests

Same as QA Steps.

QA Steps

Note: you need to connect hardware keyboard to test mobile keyboard shortcuts on iOS and Android.

1. Press CMD + K to open "search" sidebar
2. Press CMD + SHIFT + K to open "newGroup" sidebar
3. Press CMD + I to open "shortcut" dialog
4. Press ESC to close any sidebar or dialog
5. Press ENTER to submit attachment dialog

https://github.com/Expensify/App/blob/ef6937c38197da7124341faefd2218260da7effe/src/CONST.js#L231-L282 All of the shortcuts here should work on Web.

List of known issues on Android and iOS: https://github.com/Expensify/App/pull/14767#issuecomment-1494158230 which are not counted as regressions.

• [x] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
• [x] 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)
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

https://user-images.githubusercontent.com/4882133/217061211-7b10e95f-ca0c-46b1-bec7-64d143e0df37.mov

Mobile Web - Chrome

https://user-images.githubusercontent.com/4882133/228418338-0c398127-98ba-43c6-a8f8-217a0ede50a6.mov

Mobile Web - Safari

https://user-images.githubusercontent.com/4882133/228415502-02486d6c-e8a6-4e30-92bb-2ebd9260064d.mp4

Desktop

https://user-images.githubusercontent.com/4882133/217061108-29148272-46de-4c5d-ae54-c5107f1d8927.mov

iOS

https://user-images.githubusercontent.com/4882133/228414893-628d999f-0e2c-4de5-82ba-2b30dbb5734c.mp4

Android

https://user-images.githubusercontent.com/4882133/216602144-6bc2ee7f-80f3-4578-bd92-cda60d071d29.MOV

[melvin-bot[bot]]

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

[parasharrajat]

Please correct the linking

Directly paste the link to the issue after the dollar

$ https://github.com/Expensify/App/issues/6883

[azimgd]

@luacmartins @parasharrajat I kept original structure of KeyboardShortcut and added RNKeyCommand integration on top of that.

We also need to merge https://github.com/Expensify/react-native-key-command/pull/15 and update version here.

[azimgd]

FYI: arrow up/down is broken on main: https://expensify.slack.com/archives/C049HHMV9SM/p1675634800267959

[azimgd]

Electron desktop fix (tested): https://github.com/Expensify/react-native-key-command/pull/17. This fix needs to be deployed before Electron is tested.

[azimgd]

Tested on Android and Web. Everything is ready for review.

[luacmartins]

Electron desktop fix (tested): https://github.com/Expensify/react-native-key-command/pull/17. This fix needs to be deployed before Electron is tested.

0.7.0 is published!

[azimgd]

@parasharrajat have you started to review this ?

[parasharrajat]

Yup. A little busy with some stuff but I will share updates today.

[parasharrajat]

I will share the update in some time. I am currently AFK.

[azimgd]

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

[parasharrajat]

I am back now. Give me 20 mins and I will continue on this issue. Hope that works for you.

[azimgd]

Thanks, I will be available for the next 5-6h.

[parasharrajat]

Checking now.

[parasharrajat]

So the question is do we need a close icon on the modal on native? Normally, all of our native modal/popover are bottom docked. But I agree it is a little different. Let me try a few different variants first.

[parasharrajat]

BUG: Android: Escape key does not close the Search page opened via shortcuts in Native. Does it have different behavior on native?

Steps:

1. Open the app on Android.
2. Press Ctrl + K to open the search page from the hardware keyboard.
3. Press Escape to close it.

BUG: Android: Arrow keys are not traversing the search page list.

Steps:

1. Open the app on Android.
2. Press Ctrl + K to open the search page from the hardware keyboard.
3. Use the Arrow keys.

[azimgd]

BUG: Escape key does not close the Search page opened via shortcuts in Native. Does it have different behavior on native?

Which device, hardware keyboard ?

[parasharrajat]

Added more details. I am running the app on a real android device with keyboard attached with OTG.

[azimgd]

BUG: Android: Arrow keys are not traversing the search page list.

FYI: arrow up/down is broken on main: https://expensify.slack.com/archives/C049HHMV9SM/p1675634800267959

[parasharrajat]

This is working on the web on this branch and staging for me. May be desktop has some problem. haven't tested it yet.

[azimgd]

BUG: Android: Escape key does not close the Search page opened via shortcuts in Native. Does it have different behavior on native?

Just tested this and this is working for me: https://user-images.githubusercontent.com/4882133/216602144-6bc2ee7f-80f3-4578-bd92-cda60d071d29.MOV

[azimgd]

BUG: Android: Arrow keys are not traversing the search page list.

Fixed

[azimgd]

Make sure to "unfocus" from text input by pressing enter, when testing Arrow keys.

[parasharrajat]

Can you please update the about page to also show the option for View keyboard shortcuts on native?

[azimgd]

Please rephrase, "about page" you mean the popup triggered on CTRL+K ?

[parasharrajat]

Go to Settings > About menu > there you will see View keyboard shortcuts on web. https://staging.new.expensify.com/settings/about

[azimgd]

done.

[parasharrajat]

Make sure to "unfocus" from text input by pressing enter, when testing the Arrow keys.

Android: The arrow keys are not working reliably. They only select one user and then does not work. If I press Tab once, then the arrow keys select one more user. I can repeat Tab and arrow down pattern a few times.

[parasharrajat]

Before I continue, can you please complete the checklist? And fix the videos.

[azimgd]

Reproduction steps please:

• press ctrl + k
• press tab
• press arrow down
• press enter

doesn’t work ?

[azimgd]

Before I continue, can you please complete the checklist? And fix the videos.

I’m not able to test on ios device, waiting for @luacmartins to deploy.

could we clear everything except ios today please?

[azimgd]

If any new file was added I verified that:

Only 2 new files were added into bindHandlerToKeydownEvent folder, and are self explanatory with comments on top, so I'm going to check this as well.

Everything else except iOS is checked in the "PR Author Checklist".

[parasharrajat]

Talked to azim 1-1 to explain him the arrow key problem. It seems to be working fine for me. I will try to get better reproduction steps tomorrow.

FYI @azimgd, tests are failing too.

[parasharrajat]

Continuing testing now.

[parasharrajat]

There was a further discussion today on this PR. We are still stuck on the Arrow key issue. I will post the videos for these tomorrow and do some digging from my side. Hopefully, those are just setup issues and we will be good to close this in the next few days.

[parasharrajat]

Here is the video of the bug report.

https://user-images.githubusercontent.com/24370807/218328082-0af932a5-2316-454a-af43-63c07e16678e.mp4

[parasharrajat]

@azimgd Please merge the main as well. There are some breaking changes for react-native-reanimated.

[azimgd]

That's the side effect of communication over bridge while it's overfilled + RN is busy with other calculations (Onyx, Component updates etc.). There are no other improvements I can do to speed this up for your case, beside adding JSI support. Please try production build which should be much better than this. cc @luacmartins

[parasharrajat]

Ok, let me test the production build.

[parasharrajat]

Could you merge main into this?

[azimgd]

I will merge main right after full testing/review cycle is accomplished and I get a complete feedback list with everything you found in one batch. I'm positive that this PR doesn't interfere with reanimated update. I don't currently have a capacity to merge and retest until we decide on the current state for this PR as this was supposed to get done a while ago.

[azimgd]

Can I get a status update ?

[parasharrajat]

No update for now. But there will be one soon.

[parasharrajat]

I am traveling today so can't share any updates. Surely, I will be able to do it tomorrow. let's get this wrapped up.

[azimgd]

Can I get an update please ?

[parasharrajat]

Hoping to do it today. Can you please merge the main into this? Apologies for the delay, travelling is tiring.

[azimgd]

https://github.com/Expensify/App/pull/14767#issuecomment-1430283541

Rajat, I can spend time and keep merging main if you can keep your estimates intact. So far most of your estimates were delayed for days / weeks.

@luacmartins May I ask for some involvement from your side as well here? How can we improve this process?

[parasharrajat]

Yes, For long and time taking issues, I think it should be expected. There were multiple PRs. I understand that you have two tasks at your hand and you want them to be completed asap. But as this issue is open for me for a long time, priorities have been shifted many times.

There have been times when I was available but you were not. There have been also delays during previous PRs. I understand that you might be busy with other stuff but I expect the same from you as well.

The last update was https://github.com/Expensify/App/pull/14767#issuecomment-1430202337 a week before from me. But due to other important work being pushed in, I had to manage.

Hopefully, if things are working well, it should be approved soon. I have been trying iOS for some time but no luck on the simulator.

How can we improve this process?

• You can make sure that things are working perfecting in before the review is started on the PR and enough details are added to the PR description for making it easier for the reviewer to understand this quickly.

• I can make sure to post complete testing in one go so that you don't have to work on the PR multiple times.

[parasharrajat]

So, I think if you can merge the main into this and add tests, It will also help.

[parasharrajat]

Screenshots

:black_square_button: iOS / native

No luck.

:black_square_button: iOS / Safari

:black_square_button: MacOS / Desktop

https://user-images.githubusercontent.com/24370807/221195712-406a566a-dabf-4297-aa3a-116af83c1edc.mp4

:black_square_button: MacOS / Chrome

https://user-images.githubusercontent.com/24370807/221189489-20caeb05-7f8c-4ba8-a0f7-b1bf683ba1aa.mp4

:black_square_button: Android / Chrome

:black_square_button: Android / native