[TS migration] Migrate 'AmountTextInput' component to TypeScript #33955

WojtekBoman · 2024-01-04T13:40:00Z

Details

Migration of AmountTextInput to Typescript.

Fixed Issues

$ #24999
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console.
Test setting the custom clear time of status (check overall whether the input behaviour is correct).
Test the flow of requesting money, mainly the input behaviour.

Offline tests

N/A

QA Steps

Same as tests

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 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(theme.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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-05.at.10.52.16.mov

Android: mWeb Chrome

Screen.Recording.2024-01-05.at.11.01.21.mov

iOS: Native

Screen.Recording.2024-01-05.at.10.31.29.mov

iOS: mWeb Safari

Screen.Recording.2024-01-05.at.10.41.27.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-05.at.10.37.10.mov

MacOS: Desktop

Screen.Recording.2024-01-05.at.10.47.36.mov

melvin-bot · 2024-01-04T13:40:04Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

blazejkustra · 2024-01-04T14:12:39Z

src/components/AmountTextInput.tsx

+import useThemeStyles from '@hooks/useThemeStyles';
+import CONST from '@src/CONST';
+import type TextInputSelection from '@src/types/utils/TextInputSelection';
+import TextInputComponent from './TextInput';


Suggested change

import TextInputComponent from './TextInput';

import TextInput from './TextInput';

blazejkustra · 2024-01-04T14:12:59Z

src/components/AmountTextInput.tsx

@@ -0,0 +1,74 @@
+import type {ForwardedRef} from 'react';
+import React from 'react';
+import type {StyleProp, TextInput, TextStyle, ViewStyle} from 'react-native';


Suggested change

import type {StyleProp, TextInput, TextStyle, ViewStyle} from 'react-native';

import type {StyleProp, TextInput as TextInputRN, TextStyle, ViewStyle} from 'react-native';

blazejkustra · 2024-01-04T14:14:40Z

src/components/AmountTextInput.tsx

+    formattedAmount: string;
+
+    /** A ref to forward to amount text input */
+    forwardedRef?: ForwardedRef<TextInput>;


Remove forwardedRef and instead add a second argument to AmountTextInput component (check out how it's done in TextInput)

blazejkustra · 2024-01-04T14:15:25Z

src/components/AmountTextInput.tsx

+
+function AmountTextInput({
+    formattedAmount,
+    forwardedRef = undefined,


No need for undefined default values, same for {} and () => {} (instead use ?. and ?? operators)

blazejkustra · 2024-01-04T14:16:40Z

src/types/utils/TextInputSelection.ts

@@ -0,0 +1,6 @@
+type TextInputSelection = {


You can leave it in src/libs/ComposerUtils/index.ts and export it from there instead

BartoszGrajdek

Aside from Błażej's comments, LGTM!

kubabutkiewicz

lgtm!

melvin-bot · 2024-01-08T09:50:50Z

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

c3024 · 2024-01-08T10:50:07Z

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(theme.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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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

Android: mWeb Chrome

amountAndroidNative-compressed.mp4

iOS: Native

amountTSiOSNative.mp4

iOS: mWeb Safari

amountTSiOSSafari.mp4

MacOS: Chrome / Safari

amountTSChrome.mp4

MacOS: Desktop

amountTSDesktop.mp4

c3024 · 2024-01-08T17:04:36Z

Found an issue already existing in production unrelated to this PR. The colon/numbers do not align correctly.

c3024

LGTM

melvin-bot · 2024-01-08T17:05:06Z

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

blimpich

LGTM! Nice job!

OSBotify · 2024-01-08T17:40:13Z

✋ 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-09T05:38:12Z

🚀 Deployed to staging by https://github.com/blimpich in version: 1.4.23-0 🚀

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

OSBotify · 2024-01-10T06:05:27Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀

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

WojtekBoman added 2 commits January 4, 2024 14:36

Migrate AmountTextInput to TS

e250e22

Fix type imports

ddce776

blazejkustra suggested changes Jan 4, 2024

View reviewed changes

BartoszGrajdek approved these changes Jan 4, 2024

View reviewed changes

WojtekBoman added 2 commits January 4, 2024 17:27

Refactor AmountTextInput types

09b88e3

Remove TextInputSelection type

7e75160

blazejkustra approved these changes Jan 5, 2024

View reviewed changes

kubabutkiewicz approved these changes Jan 8, 2024

View reviewed changes

Merge branch 'main' into ts-amount-text-input

242113c

WojtekBoman marked this pull request as ready for review January 8, 2024 09:50

WojtekBoman requested a review from a team as a code owner January 8, 2024 09:50

melvin-bot bot removed the request for review from a team January 8, 2024 09:50

melvin-bot bot requested a review from c3024 January 8, 2024 09:50

c3024 approved these changes Jan 8, 2024

View reviewed changes

melvin-bot bot requested a review from blimpich January 8, 2024 17:07

blimpich approved these changes Jan 8, 2024

View reviewed changes

blimpich merged commit 30a91a7 into Expensify:main Jan 8, 2024
15 checks passed

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

Deploy Checklist: New Expensify 2024-01-09 #34121

Closed

87 tasks

melvin-bot bot mentioned this pull request Jan 10, 2024

[$500] [HOLD for payment 2024-01-17] [TS migration] Migrate 'AmountTextInput.js' component to TypeScript #24999

Closed

WoLewicki mentioned this pull request Jan 24, 2024

Enable Fabric and TurboModules on iOS & Android #13767

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'AmountTextInput' component to TypeScript #33955

[TS migration] Migrate 'AmountTextInput' component to TypeScript #33955

WojtekBoman commented Jan 4, 2024 •

edited

Loading

melvin-bot bot commented Jan 4, 2024

blazejkustra Jan 4, 2024

blazejkustra Jan 4, 2024

blazejkustra Jan 4, 2024

blazejkustra Jan 4, 2024

blazejkustra Jan 4, 2024

BartoszGrajdek left a comment

kubabutkiewicz left a comment

melvin-bot bot commented Jan 8, 2024

c3024 commented Jan 8, 2024 •

edited

Loading

c3024 commented Jan 8, 2024

c3024 left a comment

melvin-bot bot commented Jan 8, 2024

blimpich left a comment

OSBotify commented Jan 8, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

	import TextInputComponent from './TextInput';
	import TextInput from './TextInput';

	import type {StyleProp, TextInput, TextStyle, ViewStyle} from 'react-native';
	import type {StyleProp, TextInput as TextInputRN, TextStyle, ViewStyle} from 'react-native';

[TS migration] Migrate 'AmountTextInput' component to TypeScript #33955

[TS migration] Migrate 'AmountTextInput' component to TypeScript #33955

Conversation

WojtekBoman commented Jan 4, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 4, 2024

blazejkustra Jan 4, 2024

Choose a reason for hiding this comment

blazejkustra Jan 4, 2024

Choose a reason for hiding this comment

blazejkustra Jan 4, 2024

Choose a reason for hiding this comment

blazejkustra Jan 4, 2024

Choose a reason for hiding this comment

blazejkustra Jan 4, 2024

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

kubabutkiewicz left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 8, 2024

c3024 commented Jan 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

c3024 commented Jan 8, 2024

c3024 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jan 8, 2024

blimpich left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 8, 2024

OSBotify commented Jan 9, 2024

OSBotify commented Jan 10, 2024

WojtekBoman commented Jan 4, 2024 •

edited

Loading

c3024 commented Jan 8, 2024 •

edited

Loading