Skip to content

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

Closed
piotrski wants to merge 2 commits intoExpensify:mainfrom
piotrski:piotr-use-react-compiler-runtime
Closed

[NoQA] chore: use official react-compiler-runtime package#50491
piotrski wants to merge 2 commits intoExpensify:mainfrom
piotrski:piotr-use-react-compiler-runtime

Conversation

@piotrski
Copy link
Copy Markdown

@piotrski piotrski commented Oct 9, 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.
  • Updated references in package-lock.json and package.json to point to the official package.

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

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

- 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.
- Updated `babel-plugin-react-compiler`, `eslint-plugin-react-compiler`, and `react-compiler-healthcheck` to the latest experimental versions.
- Ensured consistency across dependencies in `package.json` to align with the latest experimental updates.
@piotrski piotrski requested a review from a team as a code owner October 9, 2024 07:44
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 9, 2024

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


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


You can retrigger this bot by commenting recheck in this Pull Request

@melvin-bot melvin-bot bot requested review from cead22 and removed request for a team October 9, 2024 07:44
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Oct 9, 2024

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

@piotrski
Copy link
Copy Markdown
Author

piotrski commented Oct 9, 2024

recheck

@piotrski piotrski closed this Oct 9, 2024
@piotrski piotrski reopened this Oct 9, 2024
@kirillzyusko
Copy link
Copy Markdown
Contributor

@piotrski can you please upload screenshots from react-devtools showing that compiler still works (for native and web)?

It should have "Memo ✨" badge next to the component that was auto-memoized.

@piotrski piotrski closed this by deleting the head repository Oct 9, 2024
@piotrski
Copy link
Copy Markdown
Author

@kirillzyusko Currently, there is a bug in Dev Tools where badges are not showing up when using react-compiler-runtime. The React core team is aware of this. I’ve decided to close this for now. :)

@kirillzyusko
Copy link
Copy Markdown
Contributor

@piotrski oh, really? So far so sad, because these badges were showing up if we used custom/our version of react-compiler-runtime 😔

@piotrski
Copy link
Copy Markdown
Author

@kirillzyusko The DevTools issue has been fixed, and here's the new PR #51233. I also managed to resolve the problem with the Jest tests. Based on my testing, react-compiler-runtime also seems to address the HMR issues.

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.

2 participants