Rewrite to functional component #26079

MaciejSWM · 2023-08-28T13:00:43Z

Details

Fixed Issues

$ #16222
PROPOSAL: #16222 (comment)

Tests

Verify that no errors appear in the JS console
Navigate throughout the app. withLocalize is used 'everywhere' so if everything is working correctly, it means the migration went well.
Switch to English/Spanish and navigate throughout the app as well.

Offline tests

Same as Tests

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

Screen.Recording.2023-09-12.at.10.08.27.mov

Desktop

Screen.Recording.2023-09-12.at.11.03.23.mov

iOS

Screen.Recording.2023-09-12.at.11.24.23.mov

Android

Screen.Recording.2023-09-12.at.10.56.57.mov

Chrome

Safari

Screen.Recording.2023-09-12.at.11.28.44.mov

melvin-bot · 2023-08-29T10:17:32Z

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

roryabraham · 2023-08-31T09:35:12Z

FWIW I think we should close this PR and the associated issue. We have a useLocalize hook so withLocalize should just deprecate this component and leave it as a class component in the meantime

roryabraham

Actually, I was a little quick to close this – can we please refactor this to separate the LocaleContextProvider from the withLocalize HOC and put them in separate files?

We can and should implement LocaleContextProvider as a functional component, but we don't need to worry about migrating the withLocalize HOC unless it's trivial to do so. Long-term we should look to remove withLocalize from the codebase entirely once everything has been converted to functional components.

marcaaron · 2023-09-05T18:29:36Z

I believe this PR was raised to address this issue -> #16222

Assigned @MaciejSWM and everyone else involved in this review, but in the future please confirm with someone first so we can avoid duplicate assignment. Thanks for the PR and excited for the changes!

…ejs-to-function-component

MaciejSWM · 2023-09-06T15:13:11Z

I split to separate file. Ready for review @roryabraham

roryabraham

LGTM, will wait for C+ review 👍🏼

roryabraham · 2023-09-11T06:17:21Z

@abdulrahuman5196 if you could test this one that would be great 🙇🏼

abdulrahuman5196 · 2023-09-11T18:13:15Z

Code looks fine to me as well.

@MaciejSWM In author's checklist,

Only 4 platforms are present, 2 platforms (safari and chrome) are missing.
And its best to record videos on these PRs. The changes could affect throughout the app as mentioned in the test steps. It would be required to record videos of surfing the app and adding it to authors checklist
For Offline Test and QA Tests, kindly add Same as Tests

MaciejSWM · 2023-09-12T09:36:47Z

Thanks @abdulrahuman5196, I made all the adjustments and all is ready for re-review!

roryabraham · 2023-09-15T07:24:29Z

bump for re-review @abdulrahuman5196

abdulrahuman5196 · 2023-09-15T17:20:50Z

Hi, It seems we have merge conflicts on this PR. Let me know once that is fixed. I will take this issue as priority.

…ejs-to-function-component

src/components/withLocalize.js

blazejkustra · 2023-09-18T12:53:06Z

@abdulrahuman5196 Maciej is OOO this week, @WoLewicki will take over the PR.

roryabraham

Also, I was thinking that the createLocaleContext should be called LocaleContextProvider, because that's the component that we're creating in the file

WoLewicki · 2023-09-20T12:55:33Z

OK I updated the PR, could you recheck it @roryabraham @abdulrahuman5196 ?

roryabraham

Code looks good, waiting for C+ to test and approve

roryabraham · 2023-09-25T15:11:26Z

@abdulrahuman5196 friendly bump for review 🙂

abdulrahuman5196 · 2023-09-27T05:17:15Z

Sorry for delay, came back from OOO. Will complete review today

abdulrahuman5196 · 2023-09-27T10:14:57Z

Reviewing now

abdulrahuman5196 · 2023-09-27T13:44:14Z

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 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-09-27.at.7.12.09.PM.mp4

Mobile Web - Chrome

az_recorder_20230927_191854.mp4

Mobile Web - Safari

Screen.Recording.2023-09-27.at.7.16.27.PM.mp4

Desktop

Screen.Recording.2023-09-27.at.7.24.58.PM.mp4

iOS

Screen.Recording.2023-09-27.at.7.20.26.PM.mp4

Android

Screen.Recording.2023-09-27.at.8.08.49.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @roryabraham

🎀 👀 🎀
C+ Reviewed

…ejs-to-function-component

OSBotify · 2023-09-29T07:45:24Z

✋ 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-02T17:47:40Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.76-0 🚀

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

kavimuru · 2023-10-02T20:10:25Z

@roryabraham @abdulrahuman5196 can you please help with this step?

Navigate throughout the app. withLocalize is used 'everywhere' so if everything is working correctly, it means the migration went well.

roryabraham · 2023-10-02T23:07:09Z

@kavimuru seems like just regression tests should be fine here, because the component is used in many places. Make sure to test that changing the locale updates the language in the UI correctly, then feel free to check this off

OSBotify · 2023-10-03T15:48:37Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

OSBotify · 2023-10-03T16:13:18Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.77-0 🚀

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

OSBotify · 2023-10-05T00:20:08Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

MaciejSWM added 2 commits August 28, 2023 15:00

Rewrite to functional component

08e20a9

Run prettier

bde2831

MaciejSWM marked this pull request as ready for review August 29, 2023 10:17

MaciejSWM requested a review from a team as a code owner August 29, 2023 10:17

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team August 29, 2023 10:17

roryabraham closed this Aug 31, 2023

roryabraham reopened this Aug 31, 2023

roryabraham requested changes Aug 31, 2023

View reviewed changes

marcaaron self-requested a review September 5, 2023 18:27

MaciejSWM added 3 commits September 6, 2023 16:34

Extract LocaleContext to separate file

0d9a79a

Missing semicolon

a4f1f06

Merge branch 'main' into maciejdobosz/exp-170-250-migrate-withlocaliz…

4684335

…ejs-to-function-component

roryabraham previously approved these changes Sep 11, 2023

View reviewed changes

Merge branch 'main' into maciejdobosz/exp-170-250-migrate-withlocaliz…

e56eb81

…ejs-to-function-component

MaciejSWM dismissed roryabraham’s stale review via e56eb81 September 15, 2023 18:16

MaciejSWM commented Sep 15, 2023

View reviewed changes

src/components/withLocalize.js Show resolved Hide resolved

roryabraham requested changes Sep 19, 2023

View reviewed changes

feat: add React memo

a994d76

roryabraham previously approved these changes Sep 20, 2023

View reviewed changes

fix: dont memo the whole function

6d1f82f

WoLewicki dismissed roryabraham’s stale review via 6d1f82f September 21, 2023 11:51

fix: easier impl

b216223

abdulrahuman5196 approved these changes Sep 27, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham September 27, 2023 15:03

MaciejSWM added 2 commits September 28, 2023 13:27

Merge branch 'main' into maciejdobosz/exp-170-250-migrate-withlocaliz…

5118fa8

…ejs-to-function-component

Return function instead of direct value

f5b12d2

roryabraham approved these changes Sep 29, 2023

View reviewed changes

roryabraham merged commit 334523e into Expensify:main Sep 29, 2023
11 checks passed

MaciejSWM deleted the maciejdobosz/exp-170-250-migrate-withlocalizejs-to-function-component branch October 2, 2023 10:37

OSBotify mentioned this pull request Oct 2, 2023

Deploy Checklist: New Expensify 2023-10-02 #28635

Closed

melvin-bot bot mentioned this pull request Oct 3, 2023

[HOLD for payment 2023-10-10] [$250] Migrate withLocalize.js to function component #16222

Closed

1 task

OSBotify mentioned this pull request Oct 3, 2023

Deploy Checklist: New Expensify 2023-10-03 #28727

Closed

abdulrahuman5196 mentioned this pull request Oct 12, 2023

[No QA][TS migration] Migrate 'Welcome.js' lib to TypeScript #28381

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite to functional component #26079

Rewrite to functional component #26079

MaciejSWM commented Aug 28, 2023 •

edited

Loading

melvin-bot bot commented Aug 29, 2023

roryabraham commented Aug 31, 2023

roryabraham left a comment

marcaaron commented Sep 5, 2023 •

edited

Loading

MaciejSWM commented Sep 6, 2023

roryabraham left a comment

roryabraham commented Sep 11, 2023

abdulrahuman5196 commented Sep 11, 2023

MaciejSWM commented Sep 12, 2023 •

edited

Loading

roryabraham commented Sep 15, 2023

abdulrahuman5196 commented Sep 15, 2023

blazejkustra commented Sep 18, 2023

roryabraham left a comment

WoLewicki commented Sep 20, 2023

roryabraham left a comment

roryabraham commented Sep 25, 2023

abdulrahuman5196 commented Sep 27, 2023

abdulrahuman5196 commented Sep 27, 2023

abdulrahuman5196 commented Sep 27, 2023 •

edited

Loading

abdulrahuman5196 left a comment

OSBotify commented Sep 29, 2023

OSBotify commented Oct 2, 2023

kavimuru commented Oct 2, 2023

roryabraham commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

Rewrite to functional component #26079

Rewrite to functional component #26079

Conversation

MaciejSWM commented Aug 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 29, 2023

roryabraham commented Aug 31, 2023

roryabraham left a comment

Choose a reason for hiding this comment

marcaaron commented Sep 5, 2023 • edited Loading

MaciejSWM commented Sep 6, 2023

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Sep 11, 2023

abdulrahuman5196 commented Sep 11, 2023

MaciejSWM commented Sep 12, 2023 • edited Loading

roryabraham commented Sep 15, 2023

abdulrahuman5196 commented Sep 15, 2023

blazejkustra commented Sep 18, 2023

roryabraham left a comment

Choose a reason for hiding this comment

WoLewicki commented Sep 20, 2023

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Sep 25, 2023

abdulrahuman5196 commented Sep 27, 2023

abdulrahuman5196 commented Sep 27, 2023

abdulrahuman5196 commented Sep 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 29, 2023

OSBotify commented Oct 2, 2023

kavimuru commented Oct 2, 2023

roryabraham commented Oct 2, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 3, 2023

OSBotify commented Oct 5, 2023

MaciejSWM commented Aug 28, 2023 •

edited

Loading

marcaaron commented Sep 5, 2023 •

edited

Loading

MaciejSWM commented Sep 12, 2023 •

edited

Loading

abdulrahuman5196 commented Sep 27, 2023 •

edited

Loading