compiler: allow mutating refs in certain components

[kirillzyusko]

Details

For react anyValue.current doesn't mean that the anyValue is produced by useRef hook and because of that compiler throws exception:

Mutating a value returned from a function whose return value should not be mutated

The fix was added in facebook/react#29916 - the suggested way is to append Ref postfix (what I did in this PR).

After enabling enableTreatRefLikeIdentifiersAsRefs and modifying several files the compile can optimize +4 more files (1081 vs 1077):

This is a first PR in a series of PR that will align more files to react-compiler rules.

Fixed Issues

$ N/A
PROPOSAL: N/A

Tests

• Verify that video works as before;
• Verify auto-focus to the input works as before;

Offline tests

N/A

QA Steps

• Verify that video works as before;
• Verify auto-focus to the input works as before;

Tests

• Verify that video works as before;
• Verify auto-focus to the input works as before;

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

[melvin-bot]

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

[dangrous]

This looks fine to me! But I don't hugely know what I'm talking about haha. @kirillzyusko is there anyone else you think should take a look at this one before merging?

[kirillzyusko]

@kirillzyusko is there anyone else you think should take a look at this one before merging?

I would ask @mountiny to have a look as well 👀

[dangrous]

I can handle the checklist BTW once @mountiny takes a look; there are a number of console errors but I'm pretty sure they're unrelated. In the meantime @kirillzyusko would you have a chance to take some screencasts of the videos working?

[mountiny]

Lets get a C+ for this checklist

[mountiny]

@kirillzyusko can you also please merge main?

[mountiny]

Changes look good to me too @allgandalf will do the testing and checklist

@kirillzyusko how do we make sure that no new cases of this are added? Can you add some automated check for this that would fail on GH action?

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the android build failed	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/45464/NewExpensify.dmg	https://45464.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[allgandalf]

@kirillzyusko any particular testing steps for this one or do you just want me to play round with the composer and video player? can you update the testing steps accordingly

[kirillzyusko]

would you have a chance to take some screencasts of the videos working?

@dangrous done, I attached screenshots.

[kirillzyusko]

can you also please merge main?

@mountiny done 👀

[kirillzyusko]

how do we make sure that no new cases of this are added? Can you add some automated check for this that would fail on GH action?

@mountiny There is kind of small problem, that healthcheck doesn't distinguish which values being mutated, i. e. was it a Ref mutation of a mutation of a SharedValue. So if we search for Mutating a value returned from a function whose return value should not be mutated wording in output we may get new such warning if new code with shared value was added.

One thing that I can do is adding a job, that will compare an amount of compiled files from main branch and amount of compiled files from current PR branch. In case it the amount of files was decreased it means, that a violation of react-compiler rules happened and it needs to be fixed (I also can compare not only the number of the files but their names as well).

What do you think? Will such approach work or not? 🤔

[kirillzyusko]

any particular testing steps for this one or do you just want me to play round with the composer and video player? can you update the testing steps accordingly

@allgandalf just play around 👀

[allgandalf]

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-07-22.at.2.23.04.PM.mov

Screen.Recording.2024-07-22.at.2.21.58.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-07-22.at.2.51.02.PM.mov

iOS: Native

Screen.Recording.2024-07-22.at.11.25.33.AM.mov

Screen.Recording.2024-07-22.at.11.24.03.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-22.at.1.46.06.PM.mov

Screen.Recording.2024-07-22.at.1.45.04.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-20.at.2.25.30.AM.mov

MacOS: Desktop

Screen.Recording.2024-07-22.at.1.49.52.PM.mov

Screen.Recording.2024-07-22.at.1.47.41.PM.mov

[mountiny]

@allgandalf what is your ETA for the review? thanks!

[allgandalf]

Had some problem like you had building iOS but that is fixed, should complete the checklist in an hour

[allgandalf]

just realised the App crashes on development if we make the video full screen when we have strict mode enabled, @mountiny you might want to report that to SWM?

Screen.Recording.2024-07-20.at.2.20.48.AM.mov

[mountiny]

@allgandalf please report it in open source

One thing that I can do is adding a job, that will compare an amount of compiled files from main branch and amount of compiled files from current PR branch. In case it the amount of files was decreased it means, that a violation of react-compiler rules happened and it needs to be fixed (I also can compare not only the number of the files but their names as well).

What do you think? Will such approach work or not? 🤔

I think we should start adding something like this; however, we might still allow new files to not adhere to the health check.

OR we should create some guidelines on how to resolve various cases where we disable lint rules and how to avoid them before we disallow adding new "not-compatible" code

[mountiny]

@allgandalf how is it looking with the checklist?

[allgandalf]

Completing now, my iOS build was failing so couldn't complete, sorry about that

[allgandalf]

Changes LGTM, tests well on all platform, I checked with composer and uploading/pausing and muting videos. Hopefully clears QA too

[melvin-bot]

🎯 @allgandalf, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #45879.

[allgandalf]

@kirillzyusko can you update the testing steps for the QA please

[kirillzyusko]

can you update the testing steps for the QA please

@allgandalf done!

[dangrous]

Seems like we're ready to merge here?

[OSBotify]

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

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.11-0 🚀

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

[OSBotify]

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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