[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #29338

blazejkustra · 2023-10-11T16:16:12Z

Details

Migration of KeyboardShortcut to Typescript.

Fixed Issues

$ #24920
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Use CMD + J and other keyboard shortcuts, shortcuts should work as before
Click and interact with the app main flows (sending messages, login, request money) - this lib is used everywhere so any regression should be visible immediately

Offline tests

N/A

QA Steps

Use CMD + J and other keyboard shortcuts, shortcuts should work as before
Click and interact with the app main flows (sending messages, login, request money) - this lib is used everywhere so any regression should be visible immediately

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 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
  - 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:
- 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

a-web.mov

Mobile Web - Safari

i-web.mp4

Desktop

dekstop.mov

iOS

ios.mp4

Android

android.mov

kubabutkiewicz

two NABs , but LGTM

src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.native.ts

src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.ts

melvin-bot · 2023-10-13T15:33:00Z

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

blazejkustra · 2023-10-17T10:12:46Z

Hey @abdulrahuman5196, are you able to do the reviewer checklist for this PR?

abdulrahuman5196 · 2023-10-17T10:13:39Z

Yes. Will work on today

abdulrahuman5196 · 2023-10-18T14:34:52Z

Code looks good to me. Need to do some good amount of testing since its a common functionality. Will update here once done.

blazejkustra · 2023-10-23T11:46:46Z

@abdulrahuman5196 Hello! Are you working on the checklist?

abdulrahuman5196 · 2023-10-23T12:11:53Z

@abdulrahuman5196 Hello! Are you working on the checklist?

@BartoszGrajdek Sorry got couple of high priority issues last couple of days. Will be working on checklist today.

abdulrahuman5196 · 2023-10-26T14:21:58Z

Working on testing now.

abdulrahuman5196 · 2023-10-26T18:20:27Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

Android: Native

Screen.Recording.2023-10-26.at.11.45.10.PM.mp4

Android: mWeb Chrome

Screen.Recording.2023-10-26.at.11.27.45.PM.mp4

iOS: Native

Screen.Recording.2023-10-26.at.11.39.05.PM.mp4

iOS: mWeb Safari

Screen.Recording.2023-10-26.at.11.20.48.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-10-26.at.11.15.57.PM.mp4

MacOS: Desktop

Screen.Recording.2023-10-26.at.11.46.38.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours.

🎀 👀 🎀
C+ Reviewed

melvin-bot · 2023-10-26T18:21:28Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #24920 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2023-10-30T08:02:20Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.3.93-0 🚀

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

situchan · 2023-10-30T14:37:12Z

src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.native.ts

+    const displayName = getDisplayName(keyCommandEvent.input, eventModifiers);
+
+    // Loop over all the callbacks
+    Object.values(eventHandlers[displayName]).every((callback) => {


Regression from this PR. Sometimes I get crash:

Any specific flow/screen you're seeing this?

Happens on all platforms

Here's simple repro step:

Screen.Recording.2023-10-30.at.9.12.47.PM.mov

@blazejkustra can you please raise quick PR? This is now deployed to staging

@blazejkustra this is already fixed i think #30602

Yep, I just noticed after merging the newest main, thanks!

OSBotify · 2023-10-31T21:35:29Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

OSBotify · 2023-10-31T22:02:19Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-01T08:54:18Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-02T10:17:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

blazejkustra added 4 commits October 11, 2023 18:15

[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript

800ce65

Revert a typo

36ef1c5

Merge branch 'main' into ts-migration/KeyboardShortcut

267281e

Fix a type x2

c2a4275

BartoszGrajdek approved these changes Oct 12, 2023

View reviewed changes

Fix android

89d2401

kubabutkiewicz approved these changes Oct 13, 2023

View reviewed changes

src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.native.ts Show resolved Hide resolved

src/libs/KeyboardShortcut/bindHandlerToKeydownEvent/index.ts Show resolved Hide resolved

blazejkustra marked this pull request as ready for review October 13, 2023 15:32

blazejkustra requested a review from a team as a code owner October 13, 2023 15:32

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team October 13, 2023 15:32

kubabutkiewicz mentioned this pull request Oct 16, 2023

[No QA] [TS migration] Migrate 'useArrowKeyFocusManager.js' hook to TypeScript #29328

Merged

59 tasks

abdulrahuman5196 approved these changes Oct 26, 2023

View reviewed changes

melvin-bot bot requested a review from rlinoz October 26, 2023 18:21

rlinoz approved these changes Oct 27, 2023

View reviewed changes

rlinoz merged commit 55b4240 into Expensify:main Oct 27, 2023
15 of 18 checks passed

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

situchan reviewed Oct 30, 2023

View reviewed changes

ZhenjaHorbach mentioned this pull request Oct 30, 2023

[$500] [HOLD for payment 2023-11-09] Error thrown when left and right arrow keys pressed #30593

Closed

6 tasks

melvin-bot bot mentioned this pull request Oct 31, 2023

[HOLD for payment 2023-11-07] [TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #24920

Closed

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #29338

[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #29338

blazejkustra commented Oct 11, 2023 •

edited

Loading

kubabutkiewicz left a comment

melvin-bot bot commented Oct 13, 2023

blazejkustra commented Oct 17, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 17, 2023

abdulrahuman5196 commented Oct 18, 2023

blazejkustra commented Oct 23, 2023

abdulrahuman5196 commented Oct 23, 2023

abdulrahuman5196 commented Oct 26, 2023

abdulrahuman5196 commented Oct 26, 2023 •

edited

Loading

abdulrahuman5196 left a comment

melvin-bot bot commented Oct 26, 2023

OSBotify commented Oct 30, 2023

situchan Oct 30, 2023

rlinoz Oct 30, 2023

situchan Oct 30, 2023

situchan Oct 30, 2023

situchan Oct 30, 2023

blazejkustra Oct 31, 2023

getusha Oct 31, 2023

blazejkustra Oct 31, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #29338

[TS migration] Migrate 'KeyboardShortcut' lib to TypeScript #29338

Conversation

blazejkustra commented Oct 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 13, 2023

blazejkustra commented Oct 17, 2023 • edited Loading

abdulrahuman5196 commented Oct 17, 2023

abdulrahuman5196 commented Oct 18, 2023

blazejkustra commented Oct 23, 2023

abdulrahuman5196 commented Oct 23, 2023

abdulrahuman5196 commented Oct 26, 2023

abdulrahuman5196 commented Oct 26, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 26, 2023

OSBotify commented Oct 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Oct 31, 2023

OSBotify commented Oct 31, 2023

OSBotify commented Nov 1, 2023

OSBotify commented Nov 2, 2023

blazejkustra commented Oct 11, 2023 •

edited

Loading

blazejkustra commented Oct 17, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 26, 2023 •

edited

Loading