Add small improvements related to introducing React strict mode by Kicu · Pull Request #44155 · Expensify/App

Kicu · 2024-06-21T13:00:25Z

Details

this PR is related to introducing react concurrent mode and StrictMode in here: Enable React concurrent mode #42592
in the original PR there were some cleanups that I believe to be useful to make code cleaner, but are not strictly necessary for the strict mode and concurrency to work, so I moved them here (read this: Enable React concurrent mode #42592 (comment))
Ideally this should be merged before: Enable React concurrent mode #42592
this changed no feature so I provide no screenshots, there is 1 thing to verify and the rest is just code changes

changes:

ReportScreenIDSetter - moving forward we want to use only useOnyx, as a test I rewritten this one screen to useOnyx for safety and performance; old withOnyx is not fully safe to use with concurrent react
removed import 'shim-keyboard-event-key - Internet Explorer is not supported by MS since 2022, and I believe we should not be supporting "dead" browsers
removed forwardRef because it was not used

Fixed Issues

$ #33531
PROPOSAL:

Tests

enter a report and make sure report screen works and switching between reports also works

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-06-21T13:00:29Z

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

melvin-bot · 2024-06-21T13:02:18Z

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

Kicu · 2024-06-21T13:02:51Z

@mountiny FYI this is the PR with less important changes from the other PR like we discussed

shubham1206agra · 2024-06-21T13:12:26Z

I think @rayane-djouah should review this.

Kicu · 2024-06-21T13:14:49Z

Sounds like a good idea, perhaps someone from Expensify could re-assign the reviewers.

rayane-d · 2024-06-21T13:23:57Z

I will start the review in a few hours, I need to read through the issue to get context

rayane-d · 2024-06-24T12:09:35Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

Screen.Recording.2024-06-24.at.4.48.56.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-06-24.at.4.44.30.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-06-24.at.16.53.58.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-06-24.at.14.17.28.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-06-24.at.1.06.52.PM.mov

MacOS: Desktop

Screen.Recording.2024-06-24.at.4.56.05.PM.mov

mountiny

Looks good to me @rayane-djouah can you please prioritize this review and make sure the changes from the reportScreenIDSetter do not cause any regressions? thanks!

rayane-d

Works good!

rayane-d · 2024-06-24T16:18:07Z

@Kicu - Can you please fill out Offline tests, QA Steps, and Screenshots/Videos sections in the author checklist? Thanks!

Kicu · 2024-06-24T18:12:01Z

@rayane-djouah since this PR introduces no specific feature only cleans up some unused code and refactors 1 screen without any logic changes, Im not sure what Im supposed to put into those categories?
Do you have anything specific in mind? can QA steps be the same thing as "Tests"?

rayane-d · 2024-06-24T18:36:56Z

Can QA steps be the same thing as "Tests"?

Yes, you can type "Same as tests" in these sections to make it clear for QA team

roryabraham · 2024-06-24T21:16:52Z

src/libs/Navigation/AppNavigator/ReportScreenIDSetter.ts

+    const [reports] = useOnyx(ONYXKEYS.COLLECTION.REPORT, {allowStaleData: true});
+    const [policies] = useOnyx(ONYXKEYS.COLLECTION.POLICY, {allowStaleData: true});
+    const [personalDetails] = useOnyx(ONYXKEYS.PERSONAL_DETAILS_LIST);
+    const [isFirstTimeNewExpensifyUser] = useOnyx(ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER, {initialValue: false});


NAB but you initialValue is kind of outdated for useOnyx. IMO this is a clearer way to achieve the same thing, and the resultant type is boolean instead of boolean | undefined.

Suggested change

const [isFirstTimeNewExpensifyUser] = useOnyx(ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER, {initialValue: false});

const [isFirstTimeNewExpensifyUser = false] = useOnyx(ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER);

hey thanks, I will keep this in mind moving forward.
This was an experiment in rewriting, so I wanted to be very 1-to-1 in regards to withOnyx -> useOnyx

OSBotify · 2024-06-24T21:28:03Z

✋ 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-06-25T20:10:25Z

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

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

…current-react-preparing" This reverts commit 569505e, reversing changes made to 3ef375f.

OSBotify · 2024-07-03T19:40:03Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

OSBotify · 2024-07-10T10:58:56Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

Add small improvements related to introducing React strict mode

af02cb4

Kicu marked this pull request as ready for review June 21, 2024 13:02

Kicu requested a review from a team as a code owner June 21, 2024 13:02

melvin-bot bot removed the request for review from a team June 21, 2024 13:02

melvin-bot bot requested a review from shubham1206agra June 21, 2024 13:02

Kicu mentioned this pull request Jun 21, 2024

Enable React concurrent mode #42592

Merged

48 tasks

mountiny approved these changes Jun 24, 2024

View reviewed changes

rayane-d approved these changes Jun 24, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham June 24, 2024 16:14

roryabraham approved these changes Jun 24, 2024

View reviewed changes

roryabraham merged commit 569505e into Expensify:main Jun 24, 2024

github-actions bot mentioned this pull request Jun 25, 2024

Deploy Checklist: New Expensify 2024-06-25 #44406

Closed

92 tasks

flodnv mentioned this pull request Jun 26, 2024

[HOLD for payment 2024-07-10] [$250] Chat - Report in the background loads infinitely after refreshing group confirmation page #44442

Closed

6 tasks

Kicu mentioned this pull request Jun 26, 2024

Refactor ReportScreenIDSetter to using withOnyx instead of a hook #44463

Closed

48 tasks

MonilBhavsar mentioned this pull request Jun 27, 2024

Revert "Add small improvements related to introducing React strict mode" #44546

Closed

MonilBhavsar added a commit that referenced this pull request Jun 27, 2024

Revert "Merge pull request #44155 from software-mansion-labs/kicu/con…

cb45773

…current-react-preparing" This reverts commit 569505e, reversing changes made to 3ef375f.

melvin-bot bot mentioned this pull request Jul 3, 2024

[HOLD for payment 2024-07-22] LOW: Enable Concurrent React Features #33531

Closed

Kicu deleted the kicu/concurrent-react-preparing branch July 24, 2024 14:52

	const [isFirstTimeNewExpensifyUser] = useOnyx(ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER, {initialValue: false});
	const [isFirstTimeNewExpensifyUser = false] = useOnyx(ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER);

Conversation

Kicu commented Jun 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

changes:

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 21, 2024

Uh oh!

melvin-bot bot commented Jun 21, 2024

Uh oh!

Kicu commented Jun 21, 2024

Uh oh!

shubham1206agra commented Jun 21, 2024

Uh oh!

Kicu commented Jun 21, 2024

Uh oh!

rayane-d commented Jun 21, 2024

Uh oh!

rayane-d commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

rayane-d left a comment

Choose a reason for hiding this comment

Uh oh!

rayane-d commented Jun 24, 2024

Uh oh!

Kicu commented Jun 24, 2024

Uh oh!

rayane-d commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roryabraham Jun 24, 2024

Choose a reason for hiding this comment

Uh oh!

Kicu Jun 25, 2024

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 24, 2024

Uh oh!

OSBotify commented Jun 25, 2024

Uh oh!

OSBotify commented Jul 3, 2024

Uh oh!

OSBotify commented Jul 10, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Kicu commented Jun 21, 2024 •

edited

Loading

rayane-d commented Jun 24, 2024 •

edited

Loading

rayane-d commented Jun 24, 2024 •

edited

Loading