[compiler] Don't validate when effect cleanup function depends on effect localized setState state derived values

This commit is contained in:
Jorge Cabiedes Acosta
2025-10-30 15:07:46 -07:00
parent a3149fbfa2
commit d1f01a789b
3 changed files with 142 additions and 0 deletions
@@ -462,6 +462,7 @@ function buildDataFlowTree(
context: ValidationContext,
propsSet: Set<string>,
stateSet: Set<string>,
allSetStateDeps: Set<IdentifierId>,
): string {
const sourceMetadata = context.derivationCache.cache.get(sourceId);
if (!sourceMetadata || !sourceMetadata.place.identifier.name?.value) {
@@ -480,6 +481,8 @@ function buildDataFlowTree(
let result = `${prefix}${sourceName}`;
allSetStateDeps.add(sourceMetadata.place.identifier.id);
if (isOriginal) {
let typeLabel: string;
if (sourceMetadata.typeOfValue === 'fromProps') {
@@ -506,6 +509,7 @@ function buildDataFlowTree(
context,
propsSet,
stateSet,
allSetStateDeps,
);
if (childTree) {
result += childTree + '\n';
@@ -517,6 +521,23 @@ function buildDataFlowTree(
return result;
}
function getFnGlobalDeps(
fn: FunctionExpression | undefined,
deps: Set<IdentifierId>,
) {
if (!fn) {
return;
}
for (const [, block] of fn.loweredFunc.func.body.blocks) {
for (const instr of block.instructions) {
if (instr.value.kind === 'LoadLocal') {
deps.add(instr.value.place.identifier.id);
}
}
}
}
function validateEffect(
effectFunction: HIRFunction,
context: ValidationContext,
@@ -535,8 +556,24 @@ function validateEffect(
Set<SourceLocation>
> = new Map();
const cleanUpFunctionDeps: Set<IdentifierId> = new Set();
const globals: Set<IdentifierId> = new Set();
for (const block of effectFunction.body.blocks.values()) {
/*
* if the block is in an effect and is of type return then its an effect's cleanup function
* if the cleanup function depends on a value from which effect-set state is derived then
* we can't validate
*/
if (
block.terminal.kind === 'return' &&
block.terminal.returnVariant === 'Explicit'
) {
getFnGlobalDeps(
context.functions.get(block.terminal.value.identifier.id),
cleanUpFunctionDeps,
);
}
for (const pred of block.preds) {
if (!seenBlocks.has(pred)) {
// skip if block has a back edge
@@ -626,6 +663,7 @@ function validateEffect(
const allSourceIds = Array.from(derivedSetStateCall.sourceIds);
const propsSet = new Set<string>();
const stateSet = new Set<string>();
const allSetStateDeps = new Set<IdentifierId>();
const trees = allSourceIds
.map((id, index) =>
@@ -636,10 +674,17 @@ function validateEffect(
context,
propsSet,
stateSet,
allSetStateDeps,
),
)
.filter(Boolean);
for (const dep of allSetStateDeps) {
if (cleanUpFunctionDeps.has(dep)) {
return;
}
}
const propsArr = Array.from(propsSet);
const stateArr = Array.from(stateSet);
@@ -0,0 +1,76 @@
## Input
```javascript
// @validateNoDerivedComputationsInEffects_exp @loggerTestOnly
import {useEffect, useState} from 'react';
function Component(file: File) {
const [imageUrl, setImageUrl] = useState(null);
/*
* Cleaning up the variable or a source of the variable used to setState
* inside the effect communicates that we always need to clean up something
* which is a valid use case for useEffect. In which case we want to
* avoid an throwing
*/
useEffect(() => {
const imageUrlPrepared = URL.createObjectURL(file);
setImageUrl(imageUrlPrepared);
return () => URL.revokeObjectURL(imageUrlPrepared);
}, [file]);
return <Image src={imageUrl} xstyle={styles.imageSizeLimits} />;
}
```
## Code
```javascript
import { c as _c } from "react/compiler-runtime"; // @validateNoDerivedComputationsInEffects_exp @loggerTestOnly
import { useEffect, useState } from "react";
function Component(file) {
const $ = _c(5);
const [imageUrl, setImageUrl] = useState(null);
let t0;
let t1;
if ($[0] !== file) {
t0 = () => {
const imageUrlPrepared = URL.createObjectURL(file);
setImageUrl(imageUrlPrepared);
return () => URL.revokeObjectURL(imageUrlPrepared);
};
t1 = [file];
$[0] = file;
$[1] = t0;
$[2] = t1;
} else {
t0 = $[1];
t1 = $[2];
}
useEffect(t0, t1);
let t2;
if ($[3] !== imageUrl) {
t2 = <Image src={imageUrl} xstyle={styles.imageSizeLimits} />;
$[3] = imageUrl;
$[4] = t2;
} else {
t2 = $[4];
}
return t2;
}
```
## Logs
```
{"kind":"CompileSuccess","fnLoc":{"start":{"line":5,"column":0,"index":108},"end":{"line":21,"column":1,"index":700},"filename":"effect-with-cleanup-function-depending-on-derived-computation-value.ts"},"fnName":"Component","memoSlots":5,"memoBlocks":2,"memoValues":3,"prunedMemoBlocks":0,"prunedMemoValues":0}
```
### Eval output
(kind: exception) Fixture not implemented
@@ -0,0 +1,21 @@
// @validateNoDerivedComputationsInEffects_exp @loggerTestOnly
import {useEffect, useState} from 'react';
function Component(file: File) {
const [imageUrl, setImageUrl] = useState(null);
/*
* Cleaning up the variable or a source of the variable used to setState
* inside the effect communicates that we always need to clean up something
* which is a valid use case for useEffect. In which case we want to
* avoid an throwing
*/
useEffect(() => {
const imageUrlPrepared = URL.createObjectURL(file);
setImageUrl(imageUrlPrepared);
return () => URL.revokeObjectURL(imageUrlPrepared);
}, [file]);
return <Image src={imageUrl} xstyle={styles.imageSizeLimits} />;
}