Conversation
Add detailed plan for making the React Compiler fault-tolerant by accumulating errors across all passes instead of stopping at the first error. This enables reporting multiple compilation errors at once.
Add error accumulation methods to the Environment class: - #errors field to accumulate CompilerErrors across passes - recordError() to record a single diagnostic (throws if Invariant) - recordErrors() to record all diagnostics from a CompilerError - hasErrors() to check if any errors have been recorded - aggregateErrors() to retrieve the accumulated CompilerError - tryRecord() to wrap callbacks and catch CompilerErrors
…erance - Change runWithEnvironment/run/compileFn to return Result<CodegenFunction, CompilerError> - Wrap all pipeline passes in env.tryRecord() to catch and record CompilerErrors - Record inference pass errors via env.recordErrors() instead of throwing - Handle codegen Result explicitly, returning Err on failure - Add final error check: return Err(env.aggregateErrors()) if any errors accumulated - Update tryCompileFunction and retryCompileFunction in Program.ts to handle Result - Keep lint-only passes using env.logErrors() (non-blocking) - Update 52 test fixture expectations that now report additional errors This is the core integration that enables fault tolerance: errors are caught, recorded, and the pipeline continues to discover more errors.
…rs on env Update 9 validation passes to record errors directly on fn.env instead of returning Result<void, CompilerError>: - validateHooksUsage - validateNoCapitalizedCalls (also changed throwInvalidReact to recordError) - validateUseMemo - dropManualMemoization - validateNoRefAccessInRender - validateNoSetStateInRender - validateNoImpureFunctionsInRender - validateNoFreezingKnownMutableFunctions - validateExhaustiveDependencies Each pass now calls fn.env.recordErrors() instead of returning errors.asResult(). Pipeline.ts call sites updated to remove tryRecord() wrappers and .unwrap().
… tolerance Update remaining validation passes to record errors on env: - validateMemoizedEffectDependencies - validatePreservedManualMemoization - validateSourceLocations (added env parameter) - validateContextVariableLValues (changed throwTodo to recordError) - validateLocalsNotReassignedAfterRender (changed throw to recordError) - validateNoDerivedComputationsInEffects (changed throw to recordError) Update inference passes: - inferMutationAliasingEffects: return void, errors on env - inferMutationAliasingRanges: return Array<AliasingEffect> directly, errors on env Update codegen: - codegenFunction: return CodegenFunction directly, errors on env - codegenReactiveFunction: same pattern Update Pipeline.ts to call all passes directly without tryRecord/unwrap. Also update AnalyseFunctions.ts which called inferMutationAliasingRanges.
Add test fixture demonstrating fault tolerance: the compiler now reports both a mutation error and a ref access error in the same function, where previously only one would be reported before bailing out. Update plan doc to mark all phases as complete.
Greptile SummaryThis PR introduces fault tolerance to the React Compiler pipeline so that compilation runs all passes and reports all errors at once, rather than stopping at the first error encountered.
Confidence Score: 4/5
Important Files Changed
Last reviewed commit: 39b5e7c |
| const errors = new CompilerError(); | ||
| visitReactiveFunction(fn, new Visitor(), errors); | ||
| return errors.asResult(); | ||
| fn.env.recordErrors(errors); |
There was a problem hiding this comment.
Unconditional recordErrors call
Most other validation passes in this PR guard with if (errors.hasAnyErrors()) before calling recordErrors (e.g., ValidateHooksUsage, ValidateExhaustiveDependencies, ValidateNoSetStateInRender). Here recordErrors is called unconditionally. While functionally harmless (iterating an empty details array is a no-op), this is inconsistent with the pattern used elsewhere. The same applies to ValidateNoDerivedComputationsInEffects, ValidatePreservedManualMemoization, and ValidateSourceLocations.
| fn.env.recordErrors(errors); | |
| if (errors.hasAnyErrors()) { | |
| fn.env.recordErrors(errors); | |
| } |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Prompt To Fix With AI
This is a comment left during a code review.
Path: compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateMemoizedEffectDependencies.ts
Line: 54
Comment:
**Unconditional `recordErrors` call**
Most other validation passes in this PR guard with `if (errors.hasAnyErrors())` before calling `recordErrors` (e.g., `ValidateHooksUsage`, `ValidateExhaustiveDependencies`, `ValidateNoSetStateInRender`). Here `recordErrors` is called unconditionally. While functionally harmless (iterating an empty `details` array is a no-op), this is inconsistent with the pattern used elsewhere. The same applies to `ValidateNoDerivedComputationsInEffects`, `ValidatePreservedManualMemoization`, and `ValidateSourceLocations`.
```suggestion
if (errors.hasAnyErrors()) {
fn.env.recordErrors(errors);
}
```
<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>
How can I resolve this? If you propose a fix, please make it concise.| let reactiveFunction!: ReactiveFunction; | ||
| env.tryRecord(() => { | ||
| reactiveFunction = buildReactiveFunction(hir); | ||
| }); |
There was a problem hiding this comment.
Definite assignment on fallible tryRecord
The definite assignment assertion (!) on reactiveFunction tells TypeScript the variable will always be assigned. However, if buildReactiveFunction throws a non-invariant CompilerError, tryRecord catches it and reactiveFunction remains undefined at runtime. Subsequent code (line 547 logging, line 550 assertWellFormedBreakTargets) would then crash with a TypeError accessing properties of undefined, not a CompilerError — which would propagate as an unexpected exception rather than a recorded compilation error.
In practice buildReactiveFunction likely only throws invariants (which re-throw from tryRecord), so this may not be reachable today. But the pattern is fragile — consider initializing with a sentinel value or guarding downstream usage with an env.hasErrors() early return.
Prompt To Fix With AI
This is a comment left during a code review.
Path: compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Pipeline.ts
Line: 540-543
Comment:
**Definite assignment on fallible `tryRecord`**
The definite assignment assertion (`!`) on `reactiveFunction` tells TypeScript the variable will always be assigned. However, if `buildReactiveFunction` throws a non-invariant `CompilerError`, `tryRecord` catches it and `reactiveFunction` remains `undefined` at runtime. Subsequent code (line 547 logging, line 550 `assertWellFormedBreakTargets`) would then crash with a `TypeError` accessing properties of `undefined`, not a `CompilerError` — which would propagate as an unexpected exception rather than a recorded compilation error.
In practice `buildReactiveFunction` likely only throws invariants (which re-throw from `tryRecord`), so this may not be reachable today. But the pattern is fragile — consider initializing with a sentinel value or guarding downstream usage with an `env.hasErrors()` early return.
How can I resolve this? If you propose a fix, please make it concise.|
Upstream PR was closed or merged. Code is synced via branch mirror. |
Mirror of facebook/react#35836
Original author: josephsavona
Stack created with Sapling. Best reviewed with ReviewStack.