ci: added a job for `react-compiler` checks 🧬 #45998

kirillzyusko · 2024-07-23T10:37:33Z

Details

Added a job that compares compilable files between main and current branch. We fail action only when old file (in main) was compiled successfully, but now it fails to compile. If file was removed, then we don't fail the action.

Fixed Issues

$ #44384
PROPOSAL: #45464 (comment)

Tests

add file that violates rules of react-compiler;
check that action fail PR (dd1ee50)
revert your changes;
verify CI is green again (8eae14c);

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

…s or not

…ion works or not" This reverts commit 122c876.

…ther action works or not"" This reverts commit df0850a.

… see whether action works or not""" This reverts commit dd1ee50.

melvin-bot · 2024-07-24T11:54:30Z

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

kirillzyusko · 2024-07-24T12:20:57Z

@mountiny this PR is ready for review 👀

dangrous

This makes sense to me! Will hold for review from @mountiny

mountiny · 2024-07-25T16:01:29Z

.github/actions/javascript/checkReactCompiler/checkReactCompiler.ts

+
+    if (errors.length > 0) {
+        errors.forEach((error) => console.error(error));
+        throw new Error('Some files could be compiled with react-compiler before successfully, but now they can not be compiled.');


Can we also include some information about what to do next? I think it would be good to create some md file in the guidelines explaining the various failures or reasons why the compilation does not succeed and how to avoid them/ resolve them.

The way how its done now I am sure would cause lots of confusion and questions in Slack so better to try to mitigate it with some guidelines even if people would come and ask.

The guideline should also say how they can test this locally

@mountiny done 🙌 Would you mind to review these changes again? 👀

dangrous

Documentation is helpful and thorough! This looks good to me, but will defer to @mountiny

One NAB for grammar, but not a huge deal

contributingGuides/REACT_COMPILER.md

dangrous · 2024-07-31T13:04:04Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

kirillzyusko · 2024-08-01T08:52:44Z

@mountiny would you mind to have a look again?

dangrous · 2024-08-06T14:42:25Z

Looks like @mountiny will be back on Friday... I think I'd be fine with merging this now, if you feel like we should push earlier? But if it's fine to wait we can do that too.

kirillzyusko · 2024-08-06T14:55:08Z

Looks like @mountiny will be back on Friday... I think I'd be fine with merging this now, if you feel like we should push earlier?

Well, I would do that, if possible. A new version of react-compiler was released 12 days ago, so I think it could be a great use case to test this CI job and see the difference in amount of compiled files 👀

dangrous · 2024-08-06T19:07:01Z

Okay cool, I'll dismiss his review and merge - since it was just about documentation, we can always update later if needed!

In order to move forward with merging while he's OOO

OSBotify · 2024-08-06T19:19:36Z

✋ 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-08-07T22:11:51Z

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.18-0 🚀

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

OSBotify · 2024-08-12T10:03:05Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.18-10 🚀

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

kirillzyusko force-pushed the ci/react-compiler-check branch from f392b99 to ceb1fae Compare July 23, 2024 11:04

mountiny mentioned this pull request Jul 23, 2024

[NoQA] fix: don't truncate output from healthcheck #46003

Merged

48 tasks

kirillzyusko force-pushed the ci/react-compiler-check branch 3 times, most recently from 410f899 to b52158a Compare July 24, 2024 08:59

kirillzyusko added 17 commits July 24, 2024 11:10

ci: added a job for react-compiler checks

466fa84

fix: convert json output to single-line output

2220f95

fix: redirect spinner output to stderr and ignore it

a49676f

fix: let's debug step by step and see what is wrong

629722b

fix: single output from the core

cf5c218

fix: patch not found error

05c2411

fix: simplify branching switching

6f9a675

fix: don't apply patch

b9cf9d9

fix: backport changes to old code

6b5ac7b

fix: don't reinstall deps (temporarily), CI should be green now

f29821f

refactor: re-organize patches after rebase

116a7d3

fix: setup node after branch switch

907b628

fix: scan files in target first, and then switch to current branch

d4b8483

fix: don't cast JSON to number :)

fd1332d

feat: implement actual check

849e306

check: add intentionally uncompilable code to see whether action work…

b7feb93

…s or not

Revert "check: add intentionally uncompilable code to see whether act…

df0850a

…ion works or not" This reverts commit 122c876.

kirillzyusko force-pushed the ci/react-compiler-check branch from b52158a to df0850a Compare July 24, 2024 09:11

kirillzyusko added 4 commits July 24, 2024 11:37

fix: eslint, script logic

f1201ad

fix: recompile script

884f90e

Revert "Revert "check: add intentionally uncompilable code to see whe…

dd1ee50

…ther action works or not"" This reverts commit df0850a.

Revert "Revert "Revert "check: add intentionally uncompilable code to…

8eae14c

… see whether action works or not""" This reverts commit dd1ee50.

kirillzyusko marked this pull request as ready for review July 24, 2024 11:53

kirillzyusko requested a review from a team as a code owner July 24, 2024 11:53

melvin-bot bot removed the request for review from a team July 24, 2024 11:54

melvin-bot bot requested a review from dangrous July 24, 2024 11:54

dangrous previously approved these changes Jul 24, 2024

View reviewed changes

mountiny previously requested changes Jul 25, 2024

View reviewed changes

feat: added documentation

26da3b5

kirillzyusko dismissed dangrous’s stale review via 26da3b5 July 26, 2024 14:10

fix: modify text content

0991129

dangrous previously approved these changes Jul 29, 2024

View reviewed changes

contributingGuides/REACT_COMPILER.md Outdated Show resolved Hide resolved

docs: change problems -> problem

0b78359

kirillzyusko dismissed dangrous’s stale review via 0b78359 July 31, 2024 09:06

dangrous approved these changes Jul 31, 2024

View reviewed changes

dangrous merged commit 0700854 into Expensify:main Aug 6, 2024
18 of 20 checks passed

github-actions bot mentioned this pull request Aug 7, 2024

Deploy Checklist: New Expensify 2024-08-07 #47006

Closed

88 tasks

melvin-bot bot mentioned this pull request Aug 12, 2024

[HOLD for payment 2024-08-19] Investigate improvements of the react-compiler #44384

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: added a job for `react-compiler` checks 🧬 #45998

ci: added a job for `react-compiler` checks 🧬 #45998

kirillzyusko commented Jul 23, 2024 •

edited

Loading

melvin-bot bot commented Jul 24, 2024

kirillzyusko commented Jul 24, 2024

dangrous left a comment

mountiny Jul 25, 2024

kirillzyusko Jul 26, 2024

dangrous left a comment

dangrous commented Jul 31, 2024 •

edited

Loading

kirillzyusko commented Aug 1, 2024

dangrous commented Aug 6, 2024

kirillzyusko commented Aug 6, 2024

dangrous commented Aug 6, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 12, 2024

ci: added a job for react-compiler checks 🧬 #45998

ci: added a job for react-compiler checks 🧬 #45998

Conversation

kirillzyusko commented Jul 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 24, 2024

kirillzyusko commented Jul 24, 2024

dangrous left a comment

Choose a reason for hiding this comment

mountiny Jul 25, 2024

Choose a reason for hiding this comment

kirillzyusko Jul 26, 2024

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Jul 31, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

kirillzyusko commented Aug 1, 2024

dangrous commented Aug 6, 2024

kirillzyusko commented Aug 6, 2024

dangrous commented Aug 6, 2024

OSBotify commented Aug 6, 2024

OSBotify commented Aug 7, 2024

OSBotify commented Aug 12, 2024

ci: added a job for `react-compiler` checks 🧬 #45998

ci: added a job for `react-compiler` checks 🧬 #45998

kirillzyusko commented Jul 23, 2024 •

edited

Loading

dangrous commented Jul 31, 2024 •

edited

Loading