migration from class to functional component #23911

burczu · 2023-07-31T08:11:04Z

Details

Simple migration of the class component into the functional component with some minor improvement like moving translateY variable outside the component because it does not change anywhere.

Fixed Issues

$ #16154
PROPOSAL:

Tests

Log in to the App
Go to Settings -> Payments
Click "Add payment method" button
Choose PayPal.me
Provide PayPal username (might be just "test" or smth)
Click "Add PayPal account" button
Observe, if the toast message appears and then, after few seconds, disappears

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

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

23911-web.mp4

Mobile Web - Chrome

23911-android-web.mp4

Mobile Web - Safari

23911-ios-web.mp4

Desktop

23911-desktop.mp4

iOS

23911-ios.mp4

Android

23911-android.mp4

src/components/GrowlNotification/index.js

melvin-bot · 2023-07-31T10:27:39Z

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

robertKozik

Could you please take one more look at the show function, as for now, it's not working properly? Also, please update the screenshots/videos accordingly, as this component is used in the app.

robertKozik · 2023-07-31T13:04:07Z

src/components/GrowlNotification/index.js

+
+        fling(0);
+        setTimeout(() => {
+            fling(INACTIVE_POSITION_Y);


As INACTIVE_POSITION_Y is also a default value for this function, can't we just fling() ?

Yes, make sense!

src/components/GrowlNotification/index.js

burczu · 2023-08-01T10:15:13Z

@robertKozik All your comments are now addressed, and the PR description is now updated with screen recordings.

robertKozik · 2023-08-01T10:53:37Z

Thanks @burczu will check this PR shortly

pac-guerreiro · 2023-08-01T11:15:05Z

src/components/GrowlNotification/index.js

@@ -29,24 +29,12 @@ const types = {
 const INACTIVE_POSITION_Y = -255;

 const PressableWithoutFeedback = Pressables.PressableWithoutFeedback;
+const translateY = new Animated.Value(INACTIVE_POSITION_Y);


This value should be preserved in the internal state of the component

Why? It isn't changed anywhere. In react-native docs they store it in ref... 🤔

This value changes when you apply Animated.spring(...) and is passed to GrowNotificationContainer as a prop

The translateY is defined outside the functional component, which means that it will be shared across all instances of this component and will only be defined once, during the initialization of the module. If this value needs to be preserved for each individual instance of the component, it should be managed within the component's internal state or with a useRef hook. This approach ensures that the lifecycle of the translateY value is properly tied to each instance of the component, which allow more predictable behavior and avoiding potential bugs.

@ArekChr that's an excellent explanation 😄

ok then - it makes sense! so I'll use useRef here as they do in docs

pac-guerreiro · 2023-08-01T11:17:12Z

src/components/GrowlNotification/index.js


    /**
     * Animate growl notification
     *
     * @param {Number} val
     */
-    fling(val = INACTIVE_POSITION_Y) {
-        Animated.spring(this.state.translateY, {
+    const fling = useCallback((val = INACTIVE_POSITION_Y) => {


~~No child component is wrapped with memo, so useCallback won't do any optimization between renders~~

Nvm, this is necessary! Thanks @gedu 😄

It is being used in the useEffect so it must be a stable function, so it needs the useCallback

Good point! I think this should be mentioned on React core docs

src/components/GrowlNotification/index.js

robertKozik · 2023-08-01T12:23:48Z

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

web.mov

Mobile Web - Chrome

android.-.web.mov

Mobile Web - Safari

iOS.-.web.mov

Desktop

desktop.mov

iOS

iOS.-.native.mov

Android

android.-.native.mov

robertKozik · 2023-08-01T12:28:39Z

@burczu if you could add the test steps for this PR. I forgot to mention it when asking for videos. Sorry for inconvenience

burczu · 2023-08-01T12:32:38Z

@robertKozik Added test steps

robertKozik · 2023-08-01T12:33:34Z

One thing during testing:

BUG: Clicking on growl notification makes it stay visible forever - WEB (CHROME)
VIDEO:

Screen.Recording.2023-08-01.at.14.31.38.mov

burczu · 2023-08-01T12:37:12Z

@robertKozik I'll check it but I don't think it's related with this issue, and not even sure if its a bug or rather a feature ;)

burczu · 2023-08-01T12:39:27Z

@robertKozik ok - checked on new.expensify.com and clicking on the toast should close it immediately - I'll try to fix it then

burczu · 2023-08-01T12:47:28Z

@robertKozik fixed

robertKozik

Test Well, let's push this forward

mountiny

Thanks guys!

OSBotify · 2023-08-03T08:19:33Z

✋ 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-03T17:41:13Z

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

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

OSBotify · 2023-08-07T18:29:33Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

OSBotify · 2023-08-07T18:56:46Z

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

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

OSBotify · 2023-08-09T08:45:54Z

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

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

migration from class to functional component

679fb2d

burczu commented Jul 31, 2023

View reviewed changes

src/components/GrowlNotification/index.js Show resolved Hide resolved

burczu marked this pull request as ready for review July 31, 2023 10:27

burczu requested a review from a team as a code owner July 31, 2023 10:27

melvin-bot bot requested review from robertKozik and removed request for a team July 31, 2023 10:27

mountiny assigned burczu Jul 31, 2023

robertKozik suggested changes Jul 31, 2023

View reviewed changes

burczu added 2 commits August 1, 2023 11:20

exposing the show method via ref

a64d2b5

unnecessary variable passing removed

d5df95c

pac-guerreiro suggested changes Aug 1, 2023

View reviewed changes

gedu reviewed Aug 1, 2023

View reviewed changes

src/components/GrowlNotification/index.js Show resolved Hide resolved

burczu added 2 commits August 1, 2023 13:59

storing translateY animated value in ref

23cc6a0

simplified onPress handler assignment

37facb5

fling on press reverted to be called explicitly

1b0d6ea

robertKozik approved these changes Aug 1, 2023

View reviewed changes

melvin-bot bot requested a review from mountiny August 1, 2023 13:08

mountiny approved these changes Aug 3, 2023

View reviewed changes

mountiny merged commit 157abce into Expensify:main Aug 3, 2023
11 checks passed

OSBotify mentioned this pull request Aug 3, 2023

Deploy Checklist: New Expensify 2023-08-03 #24121

Closed

86 tasks

OSBotify mentioned this pull request Aug 7, 2023

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

Closed

98 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

migration from class to functional component #23911

migration from class to functional component #23911

burczu commented Jul 31, 2023 •

edited

Loading

melvin-bot bot commented Jul 31, 2023

robertKozik left a comment

robertKozik Jul 31, 2023

burczu Aug 1, 2023

burczu Aug 1, 2023

burczu commented Aug 1, 2023 •

edited

Loading

robertKozik commented Aug 1, 2023

pac-guerreiro Aug 1, 2023

burczu Aug 1, 2023 •

edited

Loading

pac-guerreiro Aug 1, 2023

ArekChr Aug 1, 2023 •

edited

Loading

pac-guerreiro Aug 1, 2023

burczu Aug 1, 2023

burczu Aug 1, 2023

pac-guerreiro Aug 1, 2023 •

edited

Loading

gedu Aug 1, 2023

pac-guerreiro Aug 1, 2023

robertKozik commented Aug 1, 2023 •

edited

Loading

robertKozik commented Aug 1, 2023

burczu commented Aug 1, 2023

robertKozik commented Aug 1, 2023

burczu commented Aug 1, 2023

burczu commented Aug 1, 2023

burczu commented Aug 1, 2023

robertKozik left a comment

mountiny left a comment

OSBotify commented Aug 3, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

migration from class to functional component #23911

migration from class to functional component #23911

Conversation

burczu commented Jul 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 31, 2023

robertKozik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

burczu commented Aug 1, 2023 • edited Loading

robertKozik commented Aug 1, 2023

Choose a reason for hiding this comment

burczu Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArekChr Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pac-guerreiro Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertKozik commented Aug 1, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

robertKozik commented Aug 1, 2023

burczu commented Aug 1, 2023

robertKozik commented Aug 1, 2023

burczu commented Aug 1, 2023

burczu commented Aug 1, 2023

burczu commented Aug 1, 2023

robertKozik left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 3, 2023

OSBotify commented Aug 3, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

burczu commented Jul 31, 2023 •

edited

Loading

burczu commented Aug 1, 2023 •

edited

Loading

burczu Aug 1, 2023 •

edited

Loading

ArekChr Aug 1, 2023 •

edited

Loading

pac-guerreiro Aug 1, 2023 •

edited

Loading

robertKozik commented Aug 1, 2023 •

edited

Loading