migrated TextInputLabel/index.native.js to functional component #23941

devanshu-josh · 2023-07-31T17:31:31Z

Details

Migrated TextInputLabel/index.native.js to a functional component

Fixed Issues

$ #16207
PROPOSAL: #16207 (comment)

Tests

login to expensify (observe the input and label working perfectly)
wait for magic code
enter magic code
observe input and label working perfectly

Verify that no errors appear in the JS console

Offline tests

same as online steps

QA Steps

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 / 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 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

screen-recording-2023-08-02-at-85852-pm_2SPMwBLo.mp4

Mobile Web - Chrome

Screen.Recording.2023-08-02.at.9.00.47.PM.mov

Mobile Web - Safari

Screen.Recording.2023-08-02.at.9.03.36.PM.mov

Desktop

screen-recording-2023-08-02-at-90848-pm_XuEaqzjx.mp4

iOS

Screen.Recording.2023-08-02.at.9.04.52.PM.mov

Android

Screen.Recording.2023-08-02.at.9.01.39.PM.mov

melvin-bot · 2023-07-31T17:31:35Z

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

melvin-bot · 2023-07-31T17:31:37Z

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

github-actions · 2023-07-31T17:31:47Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

devanshu-josh · 2023-07-31T17:32:06Z

I have read the CLA Document and I hereby sign the CLA

devanshu-josh · 2023-08-01T05:53:23Z

@eVoloshchak Please review the PR

devanshu-josh · 2023-08-02T06:55:05Z

@eVoloshchak gently bump here.

eVoloshchak · 2023-08-02T12:24:50Z

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 / Chrome
- iOS / native
- iOS / 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 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-08-04.at.13.15.54.mov

Mobile Web - Chrome

screen-20230803-234333.mp4

Mobile Web - Safari

Screen.Recording.2023-08-04.at.13.11.33.mov

Desktop

Screen.Recording.2023-08-04.at.13.13.38.mov

iOS

Screen.Recording.2023-08-04.at.13.07.50.mov

Android

screen-20230804-145620.mp4

eVoloshchak · 2023-08-02T12:48:21Z

The code looks good, there are a couple of things that need to be changed with the PR itself

Change PR Details, Migrated ScrollViewWithContext.js to a functional component isn't correct
Magic code input doesn't have a label, so it doesn't use TextInputLabel. Include the screen recordings of text input with a label, also since TextInputLabel is animated, include a screen transition in these screen recordings
Merge with main

devanshu-josh · 2023-08-02T15:43:45Z

@eVoloshchak

fixed PR name
added new videos and tested properly
can't merge with main(will have to make a PR for that), and i think we can move with this only as i have seen this is in practice in most of the PRs and also it is mentioned in guidelines to make a branch on your fork and make a PR from there.

eVoloshchak · 2023-08-03T20:34:38Z

can't merge with main(will have to make a PR for that), and i think we can move with this only as i have seen this is in practice in most of the PRs and also it is mentioned in guidelines to make a branch on your fork and make a PR from there.

I meant pull the latest changes from main into your branch, I should have explained it better😅
No need, I'll do it manually for my tests

devanshu-josh · 2023-08-04T00:46:25Z

Sure! @eVoloshchak
Do let me know if anything is required from my side.

eVoloshchak

LGTM

src/components/TextInput/TextInputLabel/index.native.js

devanshu-josh · 2023-08-06T17:22:36Z

@hayata-suenaga I think we are ready to merge now?

OSBotify · 2023-08-07T13:42:22Z

✋ 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-08-07T18:54:28Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:43:36Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:12:32Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:51:15Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:09:41Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

migrated TextInputLabel/index.native.js to functional component

30d1e23

devanshu-josh requested a review from a team as a code owner July 31, 2023 17:31

melvin-bot bot requested review from eVoloshchak and removed request for a team July 31, 2023 17:31

eVoloshchak approved these changes Aug 4, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga August 4, 2023 12:01

hayata-suenaga reviewed Aug 4, 2023

View reviewed changes

src/components/TextInput/TextInputLabel/index.native.js Show resolved Hide resolved

hayata-suenaga approved these changes Aug 7, 2023

View reviewed changes

hayata-suenaga merged commit 11dda38 into Expensify:main Aug 7, 2023

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

melvin-bot bot mentioned this pull request Aug 9, 2023

[HOLD for payment 2023-08-16] [$250] Migrate TextInputLabel/index.native.js to function component #16207

Closed

1 task

migrated TextInputLabel/index.native.js to functional component #23941

migrated TextInputLabel/index.native.js to functional component #23941

Conversation

devanshu-josh commented Jul 31, 2023 • edited 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!

melvin-bot bot commented Jul 31, 2023

Uh oh!

melvin-bot bot commented Jul 31, 2023

Uh oh!

github-actions bot commented Jul 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

devanshu-josh commented Jul 31, 2023

Uh oh!

devanshu-josh commented Aug 1, 2023

Uh oh!

devanshu-josh commented Aug 2, 2023

Uh oh!

eVoloshchak commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eVoloshchak commented Aug 2, 2023

Uh oh!

devanshu-josh commented Aug 2, 2023

Uh oh!

eVoloshchak commented Aug 3, 2023

Uh oh!

devanshu-josh commented Aug 4, 2023

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

devanshu-josh commented Aug 6, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

devanshu-josh commented Jul 31, 2023 •

edited

Loading

github-actions bot commented Jul 31, 2023 •

edited

Loading

eVoloshchak commented Aug 2, 2023 •

edited

Loading