[No QA] [TS migration] Migrate 'useArrowKeyFocusManager.js' hook to TypeScript by kubabutkiewicz · Pull Request #29328 · Expensify/App

kubabutkiewicz · 2023-10-11T15:02:49Z

Details

Fixed Issues

$ #24947

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click on FAB icon
Select Start chat
Select user which you want to start chat
In new message input type @
Use arrows to navigate through suggestions

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

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

VickyStash · 2023-10-13T12:23:13Z

src/hooks/useArrowKeyFocusManager.ts

    shouldExcludeTextAreaNodes = true,
    isActive,
-}) {
+}: Config): [number, (index: number) => void] {


@kubabutkiewicz, maybe put it into a separate type

blazejkustra · 2023-10-13T14:58:04Z

src/hooks/useArrowKeyFocusManager.ts

- * @param {Boolean} [config.shouldExcludeTextAreaNodes] – Whether arrow keys should have any effect when a TextArea node is focused
- * @param {Boolean} [config.isActive] – Whether the component is ready and should subscribe to KeyboardShortcut
- * @returns {Array}
+ * @param config


This line can be removed

blazejkustra · 2023-10-13T14:59:08Z

src/hooks/useArrowKeyFocusManager.ts

@@ -2,19 +2,29 @@ import {useState, useEffect, useCallback, useMemo} from 'react';
 import useKeyboardShortcut from './useKeyboardShortcut';


Maybe migrate useKeyboardShortcut hook in this PR as well?

@blazejkustra useKeyboardShortcut is migrated in this PR but its blocked by this PR

…s-migration/useArrowKeyFocusManager/hook

melvin-bot · 2023-10-17T09:28:59Z

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

dangrous · 2023-10-17T19:04:37Z

This looks good to me! A couple minor questions, no changes needed I think:

Do we still need a C+ to review this? I will need to figure out how to assign if so
Do we want to wait until the useKeyboardShortcut is migrated too? I'm pretty sure it's not needed but it was brought up so wanted to double check
Is there a way to test this locally just to double check it's all working well?

Thanks!

blazejkustra · 2023-10-18T08:43:24Z

Do we still need a C+ to review this? I will need to figure out how to assign if so

Yes, C+ should do the reviewer checklist

Do we want to wait until the useKeyboardShortcut is migrated too? I'm pretty sure it's not needed but it was brought up so wanted to double check

No need, it can be migrated separately

Is there a way to test this locally just to double check it's all working well?

@kubabutkiewicz Can you add some QA steps?

kubabutkiewicz · 2023-10-18T08:50:09Z

Yes
No its not needed to go further with this PR
Will add QA steps

melvin-bot · 2023-10-18T16:31:43Z

@rushatgabhane @ One of you needs to 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]

dangrous · 2023-10-18T16:32:03Z

Added @rushatgabhane for C+ review, then will take one more look!

rushatgabhane · 2023-10-18T17:19:13Z

thank you

dangrous · 2023-10-20T15:05:55Z

Bump on the review when you have time @rushatgabhane - thank you!

rushatgabhane · 2023-10-25T15:51:47Z

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

Web

Screen.Recording.2023-10-25.at.23.49.40.mov

Mobile Web - Chrome

Mobile Web - Safari

Screen.Recording.2023-10-26.at.00.43.03.mov

Desktop

Screen.Recording.2023-10-26.at.01.45.18.mov

iOS

Android

Screen.Recording.2023-10-26.at.01.46.55.mov

dangrous

Just one question - the default value on new line 30 - onFocusedIndexChange = () => {}, - is that going to pose a problem with the onFocusedIndexChange?: (index: number) => void; type since it doesn't have an index parameter?

If that's fine, though, I'm good to merge this! Thanks.

…s-migration/useArrowKeyFocusManager/hook

kubabutkiewicz · 2023-10-30T08:41:26Z

Just one question - the default value on new line 30 - onFocusedIndexChange = () => {}, - is that going to pose a problem with the onFocusedIndexChange?: (index: number) => void; type since it doesn't have an index parameter?

@dangrous it will not cause any problem since onFocusedIndexChange?: (index: number) => void; is just a type, so defaulting this function with current empty function is fine 😄

dangrous · 2023-10-30T16:32:51Z

I wasn't sure if we would get errors since the default did not match the type. But that would show up on compile so I think we're okay?

OSBotify · 2023-10-30T17:08:02Z

✋ 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-10-31T22:00:37Z

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

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

OSBotify · 2023-11-01T08:52:36Z

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

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

OSBotify · 2023-11-02T10:15:57Z

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

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

OSBotify · 2023-11-02T10:40:47Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.95-0 🚀

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

OSBotify · 2023-11-06T22:10:50Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

ref: moved useArrowKeyFocusManager to TS

598f97f

VickyStash reviewed Oct 13, 2023

View reviewed changes

fix: resolve comment

c102c52

blazejkustra suggested changes Oct 13, 2023

View reviewed changes

kubabutkiewicz added 2 commits October 16, 2023 12:27

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

e38cf7f

…s-migration/useArrowKeyFocusManager/hook

fix: resolved comment

e48b32e

blazejkustra approved these changes Oct 17, 2023

View reviewed changes

kubabutkiewicz marked this pull request as ready for review October 17, 2023 09:28

kubabutkiewicz requested a review from a team as a code owner October 17, 2023 09:28

melvin-bot bot requested review from dangrous and removed request for a team October 17, 2023 09:28

dangrous requested a review from a team October 18, 2023 16:31

melvin-bot bot requested review from rushatgabhane and removed request for a team October 18, 2023 16:31

rushatgabhane approved these changes Oct 25, 2023

View reviewed changes

dangrous reviewed Oct 26, 2023

View reviewed changes

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

84b8076

…s-migration/useArrowKeyFocusManager/hook

dangrous approved these changes Oct 30, 2023

View reviewed changes

dangrous merged commit 72b388a into Expensify:main Oct 30, 2023

OSBotify mentioned this pull request Oct 31, 2023

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

Closed

97 tasks

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

[HOLD for payment 2023-11-09] [TS migration] Migrate 'useArrowKeyFocusManager.js' hook to TypeScript #24947

Closed

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

		@@ -2,19 +2,29 @@ import {useState, useEffect, useCallback, useMemo} from 'react';
		import useKeyboardShortcut from './useKeyboardShortcut';

Conversation

kubabutkiewicz commented Oct 11, 2023 • edited by dangrous Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

VickyStash Oct 13, 2023

Choose a reason for hiding this comment

Uh oh!

blazejkustra Oct 13, 2023

Choose a reason for hiding this comment

Uh oh!

blazejkustra Oct 13, 2023

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz Oct 16, 2023

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 17, 2023

Uh oh!

dangrous commented Oct 17, 2023

Uh oh!

blazejkustra commented Oct 18, 2023

Uh oh!

kubabutkiewicz commented Oct 18, 2023

Uh oh!

melvin-bot bot commented Oct 18, 2023

Uh oh!

dangrous commented Oct 18, 2023

Uh oh!

rushatgabhane commented Oct 18, 2023

Uh oh!

dangrous commented Oct 20, 2023

Uh oh!

rushatgabhane commented Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dangrous left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

dangrous commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 31, 2023

Uh oh!

OSBotify commented Nov 1, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kubabutkiewicz commented Oct 11, 2023 •

edited by dangrous

Loading

rushatgabhane commented Oct 25, 2023 •

edited

Loading

kubabutkiewicz commented Oct 30, 2023 •

edited

Loading