[compiler] Treat ref-like named objects as refs#29916
Merged
gsathya merged 1 commit intofacebook:mainfrom Jun 18, 2024
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
CLA Signed
React Core Team
compiler/packages/babel-plugin-react-compiler/src/TypeInference/InferTypes.ts
Outdated
Show resolved
Hide resolved
...kages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/ref-like-name-as-refs-3.js
Show resolved
Hide resolved
Member
josephsavona
left a comment
josephsavona
left a comment
There was a problem hiding this comment.
Nice! Thoughts on checking that other properties (besides .current) are not accessed? If they are it's a good indication that the value wasn't actually a ref.
If a component uses the `useRef` hook directly then we type it's return value as a ref. But if it's wrapped in a custom hook then we lose out on this type information as the compiler doesn't look at the hook definition. This has resulted in some false positives in our analysis like the ones reported in facebook#29160 and facebook#29196. This PR will treat objects named as `ref` or if their names end with the substring `Ref`, and contain a property named `current`, as React refs. ``` const ref = useMyRef(); const myRef = useMyRef2(); useEffect(() => { ref.current = ...; myRef.current = ...; }) ``` In the above example, `ref` and `myRef` will be treated as React refs.
Contributor
Author
There's still going to be false positives in either case, I'm not sure if this worth the extra complexity? Lets land this and try it on our codebase to see if there are false positives? |
|
Comparing: 92219ff...4bb18bd Critical size changesIncludes critical production bundles, as well as any change greater than 2%:
Significant size changesIncludes any change greater than 0.2%: Expand to show
|
josephsavona
approved these changes
Jun 18, 2024
Member
josephsavona
left a comment
josephsavona
left a comment
There was a problem hiding this comment.
That's fair, lets try it out
54 tasks
This was referenced Jul 25, 2024
This was referenced Aug 20, 2024
4 tasks
This was referenced Nov 13, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
If a component uses the
useRefhook directly then we type it's return value as a ref. But if it's wrapped in a custom hook then we lose out on this type information as the compiler doesn't look at the hook definition. This has resulted in some false positives in our analysis like the ones reported in #29160 and #29196.This PR will treat objects named as
refor if their names end with the substringRef, and contain a property namedcurrent, as React refs.In the above example,
refandmyRefwill be treated as React refs.