[NoQA] Improved initial state setting by calling initial setter only once #29630

sebryu · 2023-10-14T21:17:08Z

Details

Optimized setting initial state in functional components
Problem:
The code we put in initial state is invoked on each render, even if only first invocation is used for setting initial state.
Explained in React docs: https://react.dev/reference/react/useState#avoiding-recreating-the-initial-state

Fixed Issues

$ #30209

Tests

Verify that no errors appear in the JS console

Offline tests

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

Android: Native

and-app-3.mov

Android: mWeb Chrome

and-brow-3_H.264.mp4

iOS: Native

ios-app-3.mov

iOS: mWeb Safari

ios-brow-3.mov

MacOS: Chrome / Safari

web-3.mov

MacOS: Desktop

desk-3.mov

melvin-bot · 2023-10-14T21:17:12Z

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

kidroca

LGTM!

kidroca · 2023-10-16T09:45:10Z

src/pages/iou/ReceiptSelector/NavigationAwareCamera.native.js

@@ -20,7 +20,7 @@ const propTypes = {
 function NavigationAwareCamera({cameraTabIndex, forwardedRef, isInTabNavigator, ...props}) {
    // Get navigation to get initial isFocused value (only needed once during init!)
    const navigation = useNavigation();
-    const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused());
+    const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused);


💡 Suggestion: It looks like you're assigning the isFocused method directly to useState. Be cautious when doing this, as the method might depend on the context of this from the navigation object. To preserve the context, consider using a function within useState like this:

Suggested change

const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused);

const [isCameraActive, setIsCameraActive] = useState(() => navigation.isFocused());

This way, you ensure that isFocused is called in the context it was defined in, avoiding any potential issues with losing this context.

PS: Isn't ESLint flagging this behavior with a warning? I've noticed warnings about potentially losing the context of this in similar scenarios. It could be specific to my editor setup (I'm using WebStorm), but it might be worth double-checking.

I'm aware that sometimes we can lose this context, but I was not sure if that happens here (I've planned to test that). But I agree that it's better to be safe in this case, so I will change it to arrow function.
I don't recall seeing ESlint warning for such case in my setup (VScode)

kidroca · 2023-10-16T09:56:00Z

src/pages/home/report/ReportActionItemMessageEdit.js

-    const [selection, setSelection] = useState(getInitialSelection());
+    const [selection, setSelection] = useState(getInitialSelection);


👍 Kudos: Your change optimizes performance by preventing unnecessary parsing during each render cycle. This could result in a measurable improvement.

melvin-bot · 2023-10-23T21:03:37Z

@0xmiroslav 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]

mountiny · 2023-10-24T16:17:37Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny

Seems to be working well, thank you!

OSBotify · 2023-10-24T20:06:54Z

✋ 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-25T17:00:08Z

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

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

OSBotify · 2023-10-26T22:42:09Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

kidroca approved these changes Oct 16, 2023

View reviewed changes

sebryu force-pushed the Sebryu-performance-initial-state-optimization branch 2 times, most recently from b391fe3 to 78cbb04 Compare October 23, 2023 20:36

sebryu added 2 commits October 23, 2023 22:39

Improved initial state setting by calling initial setter only once

ef9fe6e

Prettier fix & using arrow function to prevent losing this context

42d4127

sebryu force-pushed the Sebryu-performance-initial-state-optimization branch from 78cbb04 to 42d4127 Compare October 23, 2023 20:39

sebryu mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-11-02] [Performance] Optimize setting initial state in functional components #30209

Closed

6 tasks

sebryu marked this pull request as ready for review October 23, 2023 21:03

sebryu requested a review from a team as a code owner October 23, 2023 21:03

melvin-bot bot requested review from 0xmiros and removed request for a team October 23, 2023 21:03

mountiny assigned sebryu Oct 24, 2023

mountiny self-requested a review October 24, 2023 14:44

mountiny changed the title ~~Improved initial state setting by calling initial setter only once~~ [NoQA] Improved initial state setting by calling initial setter only once Oct 24, 2023

mountiny removed the request for review from 0xmiros October 24, 2023 16:17

mountiny approved these changes Oct 24, 2023

View reviewed changes

mountiny merged commit 373647c into Expensify:main Oct 24, 2023

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Improved initial state setting by calling initial setter only once #29630

[NoQA] Improved initial state setting by calling initial setter only once #29630

sebryu commented Oct 14, 2023 •

edited

Loading

melvin-bot bot commented Oct 14, 2023

kidroca left a comment

kidroca Oct 16, 2023

sebryu Oct 18, 2023

kidroca Oct 16, 2023

melvin-bot bot commented Oct 23, 2023

mountiny commented Oct 24, 2023 •

edited

Loading

mountiny left a comment

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

	const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused);
	const [isCameraActive, setIsCameraActive] = useState(() => navigation.isFocused());

		const [selection, setSelection] = useState(getInitialSelection());
		const [selection, setSelection] = useState(getInitialSelection);

[NoQA] Improved initial state setting by calling initial setter only once #29630

[NoQA] Improved initial state setting by calling initial setter only once #29630

Conversation

sebryu commented Oct 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 14, 2023

kidroca left a comment

Choose a reason for hiding this comment

kidroca Oct 16, 2023

Choose a reason for hiding this comment

sebryu Oct 18, 2023

Choose a reason for hiding this comment

kidroca Oct 16, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Oct 23, 2023

mountiny commented Oct 24, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

sebryu commented Oct 14, 2023 •

edited

Loading

mountiny commented Oct 24, 2023 •

edited

Loading