Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NoQA] Use official react-compiler-runtime package + fix fast refresh not refreshing components on mobile #51183

Merged

Conversation

blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Oct 21, 2024

Details

  • Replaced local react-compiler-runtime with the official npm package.
  • Updated Babel config to target React 18 by changing runtimeModule to target: '18'.
  • Removed local react-compiler-runtime implementation and its dependencies from lib/ directory (including ignore files)

Thanks @piotrski for these two! Previous PR

  • Fixed an issue where components compiled using react-compiler were not being tested in Jest.
  • Updated ReactCompilerConfig to exclude test files from compilation but still compile components imported in tests.

Fixed Issues

$ #49393
PROPOSAL: N/A

Tests

  • Verify that the app works as usual, test general flows in the app (sending messages, logging in, splitting money)
  • Verify (on mobile) that after making a change in the code it is displayed on the screen with Fast Refresh (each time a change is made, not when component is re-rendered)
    • More context can be found here
  • Verify Memo✨ badges appear in React DevTools

Offline tests

N/A

QA Steps

N/A

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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@blazejkustra blazejkustra changed the title Update react-compiler Use official react-compiler-runtime package + fix fast reload not refreshing on mobile issue Oct 22, 2024
@blazejkustra blazejkustra marked this pull request as ready for review October 22, 2024 15:41
@blazejkustra blazejkustra requested a review from a team as a code owner October 22, 2024 15:41
@melvin-bot melvin-bot bot requested a review from ntdiary October 22, 2024 15:41
Copy link

melvin-bot bot commented Oct 22, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team October 22, 2024 15:41
Copy link
Contributor

@WoLewicki WoLewicki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments

src/components/AttachmentPicker/index.tsx Outdated Show resolved Hide resolved
src/components/DragAndDrop/Provider/index.tsx Show resolved Hide resolved
src/components/KYCWall/BaseKYCWall.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@WoLewicki WoLewicki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Left just one comment 🚀

src/hooks/useSubStep/index.ts Show resolved Hide resolved
@mountiny
Copy link
Contributor

@ntdiary what is your eta for the checklist on this one? thanks!

@ntdiary
Copy link
Contributor

ntdiary commented Oct 24, 2024

@ntdiary what is your eta for the checklist on this one? thanks!

@mountiny, I can test it today, yesterday briefly reviewed the changes and just shared a React PR that might help reduce many ESLint comment changes and make this PR more cleaner. 😄

@blazejkustra
Copy link
Contributor Author

I can test it today,

@ntdiary Awesome, let me know when you find any regressions 😄

@ntdiary
Copy link
Contributor

ntdiary commented Oct 24, 2024

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

test.mp4
Android: Native N/A
Android: mWeb Chrome N/A
iOS: Native N/A
iOS: mWeb Safari N/A
MacOS: Chrome / Safari N/A
MacOS: Desktop N/A

@blazejkustra blazejkustra changed the title Use official react-compiler-runtime package + fix fast reload not refreshing on mobile issue Use official react-compiler-runtime package + fix fast refresh not refreshing components on mobile Oct 24, 2024
Copy link

melvin-bot bot commented Oct 24, 2024

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

@blazejkustra
Copy link
Contributor Author

FYI We can ignore Changed files ESLint, as this is already a big PR and I don't want to introduce more changes

@ntdiary
Copy link
Contributor

ntdiary commented Oct 24, 2024

image

Hey, @blazejkustra, could you please try to create a Track expense using Scan on Android?
A few hours ago, when I clicked the Track expense button, there was no response and no error logs, but Manual and Distance worked fine.
I wanted to make sure it wasn't a caching issue with my local build, so I deleted node_modules and rebuild, but now the app is throwing an error when I open it. 😅

image

I'm trying to rebuild again.

@ntdiary
Copy link
Contributor

ntdiary commented Oct 25, 2024

when I clicked the Track expense button, there was no response and no error logs

main.mp4

Ok, I can reproduce it on my main branch, so it's not related to this PR. It might just be caused by the location retrieval problem on my mobile. :)

@ntdiary
Copy link
Contributor

ntdiary commented Oct 25, 2024

@blazejkustra, the prev compilation failure is due to this:
image

it seems that the compiler added import statements to some files in the Inspector dir.
If I exclude this directory in the configuration, the app starts up fine, and HMR works well. :)

test.mp4

@ntdiary
Copy link
Contributor

ntdiary commented Oct 25, 2024

image
it seems that the compiler added import statements to some files in the Inspector dir.

@blazejkustra, I can always reproduce this problem after reseting the cache, if you can reproduce it as well, I think it's worth fixing. 😄

npx react-native start --reset-cache

@blazejkustra
Copy link
Contributor Author

it seems that the compiler added import statements to some files in the Inspector dir.

That is surprising, turns out we didn't exclude node_modules before, which is a major mistake. Please check it one more time 😄

Copy link
Contributor

@ntdiary ntdiary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A great PR, LGTM. 🚀

@mountiny, all yours. :)

babel.config.js Outdated Show resolved Hide resolved
@mountiny mountiny changed the title Use official react-compiler-runtime package + fix fast refresh not refreshing components on mobile [NoQA] Use official react-compiler-runtime package + fix fast refresh not refreshing components on mobile Oct 25, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blazejkustra great work and @ntdiary thanks for testing!

@mountiny
Copy link
Contributor

The lint check is failing as this touches a lot of files but its out of scope to migrate those

@mountiny mountiny merged commit b7c1cfa into Expensify:main Oct 25, 2024
18 of 19 checks passed
Copy link

melvin-bot bot commented Oct 25, 2024

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@mountiny
Copy link
Contributor

Not emergency, explained above

@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants