chore: use official react-compiler-runtime package #51233

piotrski · 2024-10-22T10:02:09Z

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

Tests

Verify that no errors appear in the JS console
Verify Memo✨ badges appear in React DevTools

QA Steps

Verify that no errors appear in the JS console
Verify Memo✨ badges appear in React DevTools

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

Screenshots/Videos

- 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. - Updated references in `package-lock.json` and `package.json` to point to the official package.

… in Jest - 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.

github-actions · 2024-10-22T10:02:22Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

melvin-bot · 2024-10-22T10:02:39Z

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

adhorodyski

🙏

piotrski · 2024-10-22T11:02:45Z

I have read the CLA Document and I hereby sign the CLA

blazejkustra

While working on my PR I was unsure if we should install experimental versions of compiler vs beta version, have you verified which one is correct?

blazejkustra · 2024-10-22T11:17:18Z

babel.config.js

    environment: {
        enableTreatRefLikeIdentifiersAsRefs: true,
    },
+    // We exclude 'tests' directory from compilation, but still compile components imported in test files.
+    sources: (filename) => !filename.includes('tests/'),


Nice one 🙌

blazejkustra · 2024-10-22T11:19:30Z

package.json

@@ -304,7 +304,7 @@
    "prettier": "^2.8.8",
    "pusher-js-mock": "^0.3.3",
    "react-compiler-healthcheck": "^0.0.0-experimental-ab3118d-20240725",
-    "react-compiler-runtime": "file:./lib/react-compiler-runtime",
+    "react-compiler-runtime": "^0.0.0-experimental-8a03594-20241020",


What about react-compiler-healthcheck package? Shouldn't it be bumped too?

Same with eslint-plugin-react-compiler

mountiny · 2024-10-22T11:29:45Z

I believe @blazejkustra will take over these changes

piotrski · 2024-10-22T11:30:26Z

Currently both beta and experimental point to the same version, but we were using experimental one before.

mountiny · 2024-10-23T17:17:37Z

Closing in favour of #51183

piotrski added 2 commits October 22, 2024 11:11

piotrski requested a review from a team as a code owner October 22, 2024 10:02

melvin-bot bot requested review from marcaaron and removed request for a team October 22, 2024 10:02

This was referenced Oct 22, 2024

[$250] [HOLD for payment 2024-11-11] [HOLD for payment 2024-11-07] [DX] Fix hot-reloading for web (and potentially desktop) #49393

Closed

[NoQA] chore: use official react-compiler-runtime package #50491

Closed

kirillzyusko approved these changes Oct 22, 2024

View reviewed changes

adhorodyski approved these changes Oct 22, 2024

View reviewed changes

CLABotify added a commit to Expensify/CLA that referenced this pull request Oct 22, 2024

@piotrski has signed the CLA in Expensify/App#51233

dc1f868

mountiny assigned piotrski Oct 22, 2024

mountiny self-requested a review October 22, 2024 11:17

blazejkustra suggested changes Oct 22, 2024

View reviewed changes

blazejkustra mentioned this pull request Oct 22, 2024

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

Merged

51 tasks

mountiny closed this Oct 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: use official react-compiler-runtime package #51233

chore: use official react-compiler-runtime package #51233

piotrski commented Oct 22, 2024 •

edited by mountiny

Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading

melvin-bot bot commented Oct 22, 2024

adhorodyski left a comment

piotrski commented Oct 22, 2024

blazejkustra left a comment

blazejkustra Oct 22, 2024

blazejkustra Oct 22, 2024

blazejkustra Oct 22, 2024

mountiny commented Oct 22, 2024

piotrski commented Oct 22, 2024

mountiny commented Oct 23, 2024

chore: use official react-compiler-runtime package #51233

chore: use official react-compiler-runtime package #51233

Conversation

piotrski commented Oct 22, 2024 • edited by mountiny Loading

Details

Fixed Issues

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Oct 22, 2024 • edited Loading

melvin-bot bot commented Oct 22, 2024

adhorodyski left a comment

Choose a reason for hiding this comment

piotrski commented Oct 22, 2024

blazejkustra left a comment

Choose a reason for hiding this comment

blazejkustra Oct 22, 2024

Choose a reason for hiding this comment

blazejkustra Oct 22, 2024

Choose a reason for hiding this comment

blazejkustra Oct 22, 2024

Choose a reason for hiding this comment

mountiny commented Oct 22, 2024

piotrski commented Oct 22, 2024

mountiny commented Oct 23, 2024

piotrski commented Oct 22, 2024 •

edited by mountiny

Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading