fix(codemod): improve replace-string-ref accuracy #1310
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.
📚 Description
We ran the
replace-string-ref
codemod at scale and noticed a couple issues that could cause bugs.This code above behaves differently than string refs because when the div in unmounted
this.refs.refName
is set tonull
instwead of therefName
property being deleted. This can cause issues if you have logic in your code that relies ontypeof this.ref.refName
.My first thought was to do
this.refs.refName = ref ?? undefined
but you can still run into issues if your code relies on stuff like'refName' in this.refs
,Object.keys(this.refs).length
, etc.I think some of these scenarios are unlikely so feel free to close this but I just wanted to call out this gotcha. It also might help to confirm with somebody from the React team if this is truly a more accurate replacement.
A bonus with this change is that you no longer run into the TypeScript error:
🧪 Test Plan
Added unit test