[No QA] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #29226

kubabutkiewicz · 2023-10-10T19:42:18Z

Details

Fixed Issues

$ #24942

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Login into app
Use shortcut CMD + J
Use shortcut CMD + K
Use shortcut CMD + SHIFT + K
Check if every keyboard shortcut is working

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…s-migration/useKeyboardShortcut/hook

src/hooks/useKeyboardShortcut.ts

VickyStash · 2023-10-31T11:12:45Z

src/libs/KeyboardShortcut/index.ts

@@ -130,12 +132,12 @@ function subscribe(
    key: string,
    callback: () => void,
    descriptionKey: string,
-    modifiers: string[] = ['shift'],
+    modifiers: ShortcutModifiers = ['CTRL'],


@kubabutkiewicz Why did you change the default value?

@VickyStash Because modifiers are declared here and there is no shortcut with only shift key modifier so it doesn't make sense to default it to that key

VickyStash · 2023-11-03T13:24:45Z

src/libs/KeyboardShortcut/index.ts

    captureOnInputs = false,
    shouldBubble = false,
    priority = 0,
    shouldPreventDefault = true,
-    excludedNodes = [],
+    excludedNodes: string[] | readonly never[] = [],


@kubabutkiewicz Could you please clarify why readonly never[] is necessary?

@VickyStash It because of that

we are setting default value which comes from CONST and its basically an empty array but kt comes from CONST thats why its need to be typed as readonly never[]

barttom · 2023-11-03T13:34:09Z

src/hooks/useKeyboardShortcut.ts

+            excludedNodes,
+        );
+
+        return () => {


or return unsubscribe;
also i think taht should work - little bit shorter version

return KeyboardShortcut.subscribe( shortcut.shortcutKey, callback, shortcut.descriptionKey ?? '', shortcut.modifiers, captureOnInputs, shouldBubble, priority, shouldPreventDefault, excludedNodes, );

I would prefer no changing it to be sure to not introduce regressions, theoretically there shouldn't be be we never know 😅

blazejkustra

Only small remarks! LGTM

blazejkustra · 2023-11-07T09:14:37Z

src/libs/KeyboardShortcut/index.ts

    captureOnInputs = false,
    shouldBubble = false,
    priority = 0,
    shouldPreventDefault = true,
-    excludedNodes = [],
+    excludedNodes: string[] | readonly never[] = [],


Suggested change

excludedNodes: string[] | readonly never[] = [],

excludedNodes: string[] = [],

blazejkustra · 2023-11-07T09:14:43Z

src/libs/KeyboardShortcut/index.ts

@@ -151,7 +153,7 @@ function subscribe(
        captureOnInputs,
        shouldPreventDefault,
        shouldBubble,
-        excludedNodes,
+        excludedNodes: [...excludedNodes],


Suggested change

excludedNodes: [...excludedNodes],

excludedNodes,

blazejkustra · 2023-11-07T09:14:58Z

src/libs/KeyboardShortcut/index.ts

    return keys.map((key) => {
        if (!(key in CONST.PLATFORM_SPECIFIC_KEYS)) {
            return key;
        }

-        const platformModifiers = CONST.PLATFORM_SPECIFIC_KEYS[key as keyof typeof CONST.PLATFORM_SPECIFIC_KEYS];
+        const platformModifiers = CONST.PLATFORM_SPECIFIC_KEYS[key];


Nice one 👍

blazejkustra · 2023-11-07T09:16:32Z

src/hooks/useKeyboardShortcut.ts

+            shouldBubble,
+            priority,
+            shouldPreventDefault,
+            excludedNodes,


Suggested change

excludedNodes,

excludedNodes as string[],

blazejkustra · 2023-11-07T09:17:05Z

src/hooks/useKeyboardShortcut.ts

+/**
+ * Register a keyboard shortcut handler.
+ * Recommendation: To ensure stability, wrap the `callback` function with the useCallback hook before using it with this hook.
+ *


Suggested change

*

…s-migration/useKeyboardShortcut/hook

melvin-bot · 2023-11-07T15:33:25Z

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

…s-migration/useKeyboardShortcut/hook

chiragsalian

Code LGTM, but would you be able to investigate the failed perf-tests GH action.

…s-migration/useKeyboardShortcut/hook

kubabutkiewicz · 2023-11-08T11:31:20Z

@chiragsalian perf test now passing

OSBotify · 2023-11-08T17:52:48Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-11-10T15:42:54Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.97-7 🚀

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

OSBotify · 2023-11-10T16:00:48Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:54:15Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

aimane-chnaif · 2023-12-13T16:29:31Z

src/hooks/useKeyboardShortcut.js

-        // Hence the use of CONST.EMPTY_ARRAY.
-        excludedNodes = CONST.EMPTY_ARRAY,
-        isActive = true,
-        shouldStopPropagation = false,


Coming from #31689:
There was bad merge. This property was missing in new TS file.
Here's fix: https://github.com/Expensify/App/pull/32176/files

kubabutkiewicz added 2 commits October 10, 2023 16:11

ref: move useKeyboardShortcut to TS

4966d2f

Merge branch 'main' into ts-migration/useKeyboardShortcut/hook

9220d46

kubabutkiewicz mentioned this pull request Oct 16, 2023

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

Merged

59 tasks

kubabutkiewicz added 4 commits October 30, 2023 12:27

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

8ba4a08

…s-migration/useKeyboardShortcut/hook

fix: type issues

52ffc1e

fix: types issues

e065a1d

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

d7b1479

…s-migration/useKeyboardShortcut/hook

VickyStash reviewed Oct 31, 2023

View reviewed changes

fix: add props comments

01a14f4

VickyStash reviewed Nov 3, 2023

View reviewed changes

barttom reviewed Nov 3, 2023

View reviewed changes

VickyStash approved these changes Nov 3, 2023

View reviewed changes

blazejkustra approved these changes Nov 7, 2023

View reviewed changes

kubabutkiewicz added 3 commits November 7, 2023 16:28

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

03d858f

…s-migration/useKeyboardShortcut/hook

fix: resolve comments

ff032c6

fix: fixed typo

f45c0a5

kubabutkiewicz marked this pull request as ready for review November 7, 2023 15:32

kubabutkiewicz requested a review from a team as a code owner November 7, 2023 15:32

melvin-bot bot requested review from chiragsalian and removed request for a team November 7, 2023 15:33

kubabutkiewicz added 2 commits November 7, 2023 18:53

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

9d3d11e

…s-migration/useKeyboardShortcut/hook

fix: types

9c1200b

chiragsalian approved these changes Nov 7, 2023

View reviewed changes

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

ba5fb64

…s-migration/useKeyboardShortcut/hook

chiragsalian merged commit 130ce1c into Expensify:main Nov 8, 2023
11 checks passed

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-08 #31077

Closed

melvin-bot bot mentioned this pull request Nov 10, 2023

[HOLD for payment 2023-11-17] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #24942

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

mkhutornyi mentioned this pull request Nov 22, 2023

[HOLD for payment 2023-12-12] [$500] Personal details - No green check mark and the year is not selected using Enter key #31689

Closed

6 tasks

aimane-chnaif reviewed Dec 13, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #29226

[No QA] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #29226

kubabutkiewicz commented Oct 10, 2023 •

edited

Loading

VickyStash Oct 31, 2023

kubabutkiewicz Oct 31, 2023

VickyStash Nov 3, 2023

kubabutkiewicz Nov 3, 2023

barttom Nov 3, 2023

kubabutkiewicz Nov 3, 2023

blazejkustra left a comment

blazejkustra Nov 7, 2023

blazejkustra Nov 7, 2023

blazejkustra Nov 7, 2023

blazejkustra Nov 7, 2023

blazejkustra Nov 7, 2023

melvin-bot bot commented Nov 7, 2023

chiragsalian left a comment

kubabutkiewicz commented Nov 8, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

aimane-chnaif Dec 13, 2023

	excludedNodes: string[] \| readonly never[] = [],
	excludedNodes: string[] = [],

[No QA] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #29226

[No QA] [TS migration] Migrate 'useKeyboardShortcut.js' hook to TypeScript #29226

Conversation

kubabutkiewicz commented Oct 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

blazejkustra left a 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

melvin-bot bot commented Nov 7, 2023

chiragsalian left a comment

Choose a reason for hiding this comment

kubabutkiewicz commented Nov 8, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

Choose a reason for hiding this comment

kubabutkiewicz commented Oct 10, 2023 •

edited

Loading