[TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #29267

fvlvte · 2023-10-11T08:52:23Z

Details

Migrated useKeyboardState hook and it's dependency to TypeScript.

Fixed Issues

$ #24941
$ #24955
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console
Click on profile icon from the main screen
Open profile
Click on display name
Focus first name field
Click on back arrow
The keyboard is closed by ScreenWrapper that is using useKeyboardState hook.

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
  - 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-ff.mov

Mobile Web - Chrome

web-chrome.mov

Mobile Web - Safari

web-safari.mov

Desktop

electron.mov

iOS

ios17.mov

Android

android.mov

rezkiy37

Left comments.

src/components/withKeyboardState.tsx

Co-authored-by: Michael (Mykhailo) Kravchenko <[email protected]>

src/components/withKeyboardState.tsx

…hoc' into 24955-migrate-withKeyboardState-hoc

src/components/withKeyboardState.tsx

# Conflicts: # src/components/withKeyboardState.tsx # src/hooks/useKeyboardState.js

src/components/withKeyboardState.tsx

melvin-bot · 2023-12-04T08:35:21Z

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

situchan · 2023-12-04T19:48:44Z

Why is this No QA? Keyboard handling is important part of the app. Please add Test/QA step at least for one page affected by this change

fabioh8010 · 2023-12-05T09:21:56Z

@fvlvte Please add test steps for this one!

fvlvte · 2023-12-07T13:04:58Z

Added steps @fabioh8010 @situchan for ScreenWrapper that is basically biggest user of this hook.

fabioh8010 · 2023-12-13T08:56:30Z

@situchan Bump

situchan · 2023-12-13T08:58:57Z

will review today. please merge main

melvin-bot · 2023-12-22T18:35:03Z

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

situchan

Re-approving to get engineer review

VickyStash · 2023-12-28T10:03:16Z

@lakchote kind bump 🙂

mountiny · 2023-12-29T21:08:21Z

@situchan sorry for the bother, could you give this one quick test after @fvlvte syncs with main, its been two weeks since tested so I want to make sure nothing popped up since

situchan · 2023-12-29T21:12:12Z

testing

situchan · 2023-12-29T21:58:00Z

Tests well!

mountiny

@fvlvte One comment, I think the TODO is too generic and also I see that its been in place for couple months so is it indeed still pending?

mountiny · 2023-12-29T22:21:37Z

src/components/withKeyboardState.tsx

+    isKeyboardShown: boolean;
+};
+
+// TODO: Remove - left for backwards compatibility with existing components.


Is this still required, if so, can you link an issue/ PR which is tied to this?

fvlvte · 2023-12-29T22:25:24Z

@fvlvte One comment, I think the TODO is too generic and also I see that its been in place for couple months so is it indeed still pending?

Let me double check

fvlvte · 2023-12-29T22:45:21Z

So yes it's still used in 2 non-migrated JavaScript components

Issues:
#25151
#31981

cc: @mountiny

mountiny · 2023-12-29T22:55:23Z

@fvlvte Can you link #25151 in the comment there please?

fvlvte · 2023-12-29T22:57:27Z

Done @mountiny

mountiny

Appreciate it!

OSBotify · 2023-12-29T23:30:39Z

✋ 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 · 2024-01-02T23:50:52Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.21-0 🚀

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

OSBotify · 2024-01-04T18:53:28Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T19:18:18Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T20:15:45Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

Migrated useKeyboardState.js hook to TypeScript.

8a00e7e

rezkiy37 suggested changes Oct 11, 2023

View reviewed changes

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

Added spacing.

d3d050d

Co-authored-by: Michael (Mykhailo) Kravchenko <[email protected]>

VickyStash reviewed Oct 11, 2023

View reviewed changes

src/components/withKeyboardState.tsx Show resolved Hide resolved

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

fvlvte added 2 commits October 13, 2023 08:29

Prettier applied.

deb4a08

Merge remote-tracking branch 'origin/24955-migrate-withKeyboardState-…

d2f3af9

…hoc' into 24955-migrate-withKeyboardState-hoc

blazejkustra reviewed Oct 16, 2023

View reviewed changes

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

fvlvte added 2 commits November 27, 2023 09:55

Merge branch 'main' into 24955-migrate-withKeyboardState-hoc

2aa423e

# Conflicts: # src/components/withKeyboardState.tsx # src/hooks/useKeyboardState.js

Conflicts & requested changes.

0c5bc5e

VickyStash suggested changes Nov 27, 2023

View reviewed changes

Requested changes.

b4123e2

rezkiy37 reviewed Nov 27, 2023

View reviewed changes

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

Requested change.

ab4bc47

VickyStash suggested changes Nov 27, 2023

View reviewed changes

src/components/withKeyboardState.tsx Show resolved Hide resolved

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

src/components/withKeyboardState.tsx Outdated Show resolved Hide resolved

Requested changes.

7fa124f

fabioh8010 approved these changes Nov 27, 2023

View reviewed changes

blazejkustra approved these changes Nov 30, 2023

View reviewed changes

fvlvte marked this pull request as ready for review December 4, 2023 08:35

fvlvte requested a review from a team as a code owner December 4, 2023 08:35

melvin-bot bot requested review from situchan and removed request for a team December 4, 2023 08:35

Merge branch 'main' into 24955-migrate-withKeyboardState-hoc

5b9a4b5

fvlvte changed the title ~~[No QA][TS migration] Migrate 'useKeyboardState.js' hook to TypeScript~~ [TS migration] Migrate 'useKeyboardState.js' hook to TypeScript Dec 7, 2023

Merge branch 'main' into 24955-migrate-withKeyboardState-hoc

37618a0

situchan approved these changes Dec 22, 2023

View reviewed changes

melvin-bot bot requested a review from lakchote December 22, 2023 18:37

mountiny self-requested a review December 29, 2023 20:57

mountiny assigned fvlvte Dec 29, 2023

Merge branch 'main' into 24955-migrate-withKeyboardState-hoc

d30cc3f

Merge branch 'main' into 24955-migrate-withKeyboardState-hoc

9014148

mountiny previously approved these changes Dec 29, 2023

View reviewed changes

Linked issue.

fd31080

fvlvte dismissed mountiny’s stale review via fd31080 December 29, 2023 22:57

mountiny approved these changes Dec 29, 2023

View reviewed changes

mountiny merged commit b1c6883 into Expensify:main Dec 29, 2023
16 checks passed

fvlvte deleted the 24955-migrate-withKeyboardState-hoc branch December 30, 2023 00:48

github-actions bot mentioned this pull request Jan 2, 2024

Deploy Checklist: New Expensify 2024-01-02 #33855

Closed

58 tasks

This was referenced Jan 4, 2024

[$500] [HOLD for payment 2024-01-11] [TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #24941

Closed

[HOLD for payment 2024-01-11] [TS migration] Migrate 'withKeyboardState.js' HOC to TypeScript #24955

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #29267

[TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #29267

fvlvte commented Oct 11, 2023 •

edited

Loading

rezkiy37 left a comment

melvin-bot bot commented Dec 4, 2023

situchan commented Dec 4, 2023

fabioh8010 commented Dec 5, 2023

fvlvte commented Dec 7, 2023

fabioh8010 commented Dec 13, 2023

situchan commented Dec 13, 2023

melvin-bot bot commented Dec 22, 2023

situchan left a comment

VickyStash commented Dec 28, 2023

mountiny commented Dec 29, 2023

situchan commented Dec 29, 2023

situchan commented Dec 29, 2023

mountiny left a comment

mountiny Dec 29, 2023

fvlvte commented Dec 29, 2023

fvlvte commented Dec 29, 2023 •

edited

Loading

mountiny commented Dec 29, 2023

fvlvte commented Dec 29, 2023

mountiny left a comment

OSBotify commented Dec 29, 2023

OSBotify commented Jan 2, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

[TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #29267

[TS migration] Migrate 'useKeyboardState.js' hook to TypeScript #29267

Conversation

fvlvte commented Oct 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 4, 2023

situchan commented Dec 4, 2023

fabioh8010 commented Dec 5, 2023

fvlvte commented Dec 7, 2023

fabioh8010 commented Dec 13, 2023

situchan commented Dec 13, 2023

melvin-bot bot commented Dec 22, 2023

situchan left a comment

Choose a reason for hiding this comment

VickyStash commented Dec 28, 2023

mountiny commented Dec 29, 2023

situchan commented Dec 29, 2023

situchan commented Dec 29, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Dec 29, 2023

Choose a reason for hiding this comment

fvlvte commented Dec 29, 2023

fvlvte commented Dec 29, 2023 • edited Loading

mountiny commented Dec 29, 2023

fvlvte commented Dec 29, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 29, 2023

OSBotify commented Jan 2, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

fvlvte commented Oct 11, 2023 •

edited

Loading

fvlvte commented Dec 29, 2023 •

edited

Loading