diff --git a/compiler/CLAUDE.md b/compiler/CLAUDE.md index db19d2cb8a86..460df2df5531 100644 --- a/compiler/CLAUDE.md +++ b/compiler/CLAUDE.md @@ -229,20 +229,19 @@ Would enable the `enableJsxOutlining` feature and disable the `enableNameAnonymo 3. Look for `Impure`, `Render`, `Capture` effects on instructions 4. Check the pass ordering in Pipeline.ts to understand when effects are populated vs validated -## Error Handling for Unsupported Features +## Error Handling and Fault Tolerance -When the compiler encounters an unsupported but known pattern, use `CompilerError.throwTodo()` instead of `CompilerError.invariant()`. Todo errors cause graceful bailouts in production; Invariant errors are hard failures indicating unexpected/invalid states. +The compiler is fault-tolerant: it runs all passes and accumulates errors on the `Environment` rather than throwing on the first error. This lets users see all compilation errors at once. -```typescript -// Unsupported but expected pattern - graceful bailout -CompilerError.throwTodo({ - reason: `Support [description of unsupported feature]`, - loc: terminal.loc, -}); - -// Invariant is for truly unexpected/invalid states - hard failure -CompilerError.invariant(false, { - reason: `Unexpected [thing]`, - loc: terminal.loc, -}); -``` +**Recording errors** — Passes record errors via `env.recordError(diagnostic)`. Errors are accumulated on `Environment.#errors` and checked at the end of the pipeline via `env.hasErrors()` / `env.aggregateErrors()`. + +**`tryRecord()` wrapper** — In Pipeline.ts, validation passes are wrapped in `env.tryRecord(() => pass(hir))` which catches thrown `CompilerError`s (non-invariant) and records them. Infrastructure/transformation passes are NOT wrapped in `tryRecord()` because later passes depend on their output being structurally valid. + +**Error categories:** +- `CompilerError.throwTodo()` — Unsupported but known pattern. Graceful bailout. Can be caught by `tryRecord()`. +- `CompilerError.invariant()` — Truly unexpected/invalid state. Always throws immediately, never caught by `tryRecord()`. +- Non-`CompilerError` exceptions — Always re-thrown. + +**Key files:** `Environment.ts` (`recordError`, `tryRecord`, `hasErrors`, `aggregateErrors`), `Pipeline.ts` (pass orchestration), `Program.ts` (`tryCompileFunction` handles the `Result`). + +**Test fixtures:** `__tests__/fixtures/compiler/fault-tolerance/` contains multi-error fixtures verifying all errors are reported. diff --git a/compiler/packages/babel-plugin-react-compiler/docs/passes/README.md b/compiler/packages/babel-plugin-react-compiler/docs/passes/README.md index 0f6b4183b07d..9e99265392f0 100644 --- a/compiler/packages/babel-plugin-react-compiler/docs/passes/README.md +++ b/compiler/packages/babel-plugin-react-compiler/docs/passes/README.md @@ -302,6 +302,15 @@ yarn snap minimize yarn snap -u ``` +## Fault Tolerance + +The pipeline is fault-tolerant: all passes run to completion, accumulating errors on `Environment` rather than aborting on the first error. + +- **Validation passes** are wrapped in `env.tryRecord()` in Pipeline.ts, which catches non-invariant `CompilerError`s and records them. If a validation pass throws, compilation continues. +- **Infrastructure/transformation passes** (enterSSA, eliminateRedundantPhi, inferMutationAliasingEffects, codegen, etc.) are NOT wrapped in `tryRecord()` because subsequent passes depend on their output being structurally valid. If they fail, compilation aborts. +- **`lower()` (BuildHIR)** always produces an `HIRFunction`, recording errors on `env` instead of returning `Err`. Unsupported constructs (e.g., `var`) are lowered best-effort. +- At the end of the pipeline, `env.hasErrors()` determines whether to return `Ok(codegen)` or `Err(aggregatedErrors)`. + ## Further Reading - [MUTABILITY_ALIASING_MODEL.md](../../src/Inference/MUTABILITY_ALIASING_MODEL.md): Detailed aliasing model docs diff --git a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts index e7818f82afba..c0576c7521f1 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts @@ -252,6 +252,7 @@ export type LoggerEvent = | CompileErrorEvent | CompileDiagnosticEvent | CompileSkipEvent + | CompileUnexpectedThrowEvent | PipelineErrorEvent | TimingEvent; @@ -286,6 +287,11 @@ export type PipelineErrorEvent = { fnLoc: t.SourceLocation | null; data: string; }; +export type CompileUnexpectedThrowEvent = { + kind: 'CompileUnexpectedThrow'; + fnLoc: t.SourceLocation | null; + data: string; +}; export type TimingEvent = { kind: 'Timing'; measurement: PerformanceMeasure; diff --git a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Pipeline.ts b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Pipeline.ts index 90651818c777..a0cd02817828 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Pipeline.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Pipeline.ts @@ -9,6 +9,8 @@ import {NodePath} from '@babel/traverse'; import * as t from '@babel/types'; import prettyFormat from 'pretty-format'; import {CompilerOutputMode, Logger, ProgramContext} from '.'; +import {CompilerError} from '../CompilerError'; +import {Err, Ok, Result} from '../Utils/Result'; import { HIRFunction, ReactiveFunction, @@ -89,7 +91,6 @@ import {validateNoJSXInTryStatement} from '../Validation/ValidateNoJSXInTryState import {propagateScopeDependenciesHIR} from '../HIR/PropagateScopeDependenciesHIR'; import {outlineJSX} from '../Optimization/OutlineJsx'; import {optimizePropsMethodCalls} from '../Optimization/OptimizePropsMethodCalls'; -import {validateNoImpureFunctionsInRender} from '../Validation/ValidateNoImpureFunctionsInRender'; import {validateStaticComponents} from '../Validation/ValidateStaticComponents'; import {validateNoFreezingKnownMutableFunctions} from '../Validation/ValidateNoFreezingKnownMutableFunctions'; import {inferMutationAliasingEffects} from '../Inference/InferMutationAliasingEffects'; @@ -118,7 +119,7 @@ function run( logger: Logger | null, filename: string | null, code: string | null, -): CodegenFunction { +): Result { const contextIdentifiers = findContextIdentifiers(func); const env = new Environment( func.scope, @@ -149,21 +150,21 @@ function runWithEnvironment( t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression >, env: Environment, -): CodegenFunction { +): Result { const log = (value: CompilerPipelineValue): void => { env.logger?.debugLogIRs?.(value); }; - const hir = lower(func, env).unwrap(); + const hir = lower(func, env); log({kind: 'hir', name: 'HIR', value: hir}); pruneMaybeThrows(hir); log({kind: 'hir', name: 'PruneMaybeThrows', value: hir}); validateContextVariableLValues(hir); - validateUseMemo(hir).unwrap(); + validateUseMemo(hir); if (env.enableDropManualMemoization) { - dropManualMemoization(hir).unwrap(); + dropManualMemoization(hir); log({kind: 'hir', name: 'DropManualMemoization', value: hir}); } @@ -196,10 +197,10 @@ function runWithEnvironment( if (env.enableValidations) { if (env.config.validateHooksUsage) { - validateHooksUsage(hir).unwrap(); + validateHooksUsage(hir); } if (env.config.validateNoCapitalizedCalls) { - validateNoCapitalizedCalls(hir).unwrap(); + validateNoCapitalizedCalls(hir); } } @@ -209,13 +210,8 @@ function runWithEnvironment( analyseFunctions(hir); log({kind: 'hir', name: 'AnalyseFunctions', value: hir}); - const mutabilityAliasingErrors = inferMutationAliasingEffects(hir); + inferMutationAliasingEffects(hir); log({kind: 'hir', name: 'InferMutationAliasingEffects', value: hir}); - if (env.enableValidations) { - if (mutabilityAliasingErrors.isErr()) { - throw mutabilityAliasingErrors.unwrapErr(); - } - } if (env.outputMode === 'ssr') { optimizeForSSR(hir); @@ -228,28 +224,23 @@ function runWithEnvironment( pruneMaybeThrows(hir); log({kind: 'hir', name: 'PruneMaybeThrows', value: hir}); - const mutabilityAliasingRangeErrors = inferMutationAliasingRanges(hir, { + inferMutationAliasingRanges(hir, { isFunctionExpression: false, }); log({kind: 'hir', name: 'InferMutationAliasingRanges', value: hir}); if (env.enableValidations) { - if (mutabilityAliasingRangeErrors.isErr()) { - throw mutabilityAliasingRangeErrors.unwrapErr(); - } validateLocalsNotReassignedAfterRender(hir); - } - if (env.enableValidations) { if (env.config.assertValidMutableRanges) { assertValidMutableRanges(hir); } if (env.config.validateRefAccessDuringRender) { - validateNoRefAccessInRender(hir).unwrap(); + validateNoRefAccessInRender(hir); } if (env.config.validateNoSetStateInRender) { - validateNoSetStateInRender(hir).unwrap(); + validateNoSetStateInRender(hir); } if ( @@ -269,11 +260,7 @@ function runWithEnvironment( env.logErrors(validateNoJSXInTryStatement(hir)); } - if (env.config.validateNoImpureFunctionsInRender) { - validateNoImpureFunctionsInRender(hir).unwrap(); - } - - validateNoFreezingKnownMutableFunctions(hir).unwrap(); + validateNoFreezingKnownMutableFunctions(hir); } inferReactivePlaces(hir); @@ -285,7 +272,7 @@ function runWithEnvironment( env.config.validateExhaustiveEffectDependencies ) { // NOTE: this relies on reactivity inference running first - validateExhaustiveDependencies(hir).unwrap(); + validateExhaustiveDependencies(hir); } } @@ -399,6 +386,7 @@ function runWithEnvironment( }); assertTerminalSuccessorsExist(hir); assertTerminalPredsExist(hir); + propagateScopeDependenciesHIR(hir); log({ kind: 'hir', @@ -511,20 +499,20 @@ function runWithEnvironment( env.config.enablePreserveExistingMemoizationGuarantees || env.config.validatePreserveExistingMemoizationGuarantees ) { - validatePreservedManualMemoization(reactiveFunction).unwrap(); + validatePreservedManualMemoization(reactiveFunction); } const ast = codegenFunction(reactiveFunction, { uniqueIdentifiers, fbtOperands, - }).unwrap(); + }); log({kind: 'ast', name: 'Codegen', value: ast}); for (const outlined of ast.outlined) { log({kind: 'ast', name: 'Codegen (outlined)', value: outlined.fn}); } if (env.config.validateSourceLocations) { - validateSourceLocations(func, ast).unwrap(); + validateSourceLocations(func, ast, env); } /** @@ -536,7 +524,10 @@ function runWithEnvironment( throw new Error('unexpected error'); } - return ast; + if (env.hasErrors()) { + return Err(env.aggregateErrors()); + } + return Ok(ast); } export function compileFn( @@ -550,7 +541,7 @@ export function compileFn( logger: Logger | null, filename: string | null, code: string | null, -): CodegenFunction { +): Result { return run( func, config, diff --git a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Program.ts b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Program.ts index 038cf60385bd..2880e9283c77 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Program.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Program.ts @@ -697,20 +697,36 @@ function tryCompileFunction( } try { - return { - kind: 'compile', - compiledFn: compileFn( - fn, - programContext.opts.environment, - fnType, - outputMode, - programContext, - programContext.opts.logger, - programContext.filename, - programContext.code, - ), - }; + const result = compileFn( + fn, + programContext.opts.environment, + fnType, + outputMode, + programContext, + programContext.opts.logger, + programContext.filename, + programContext.code, + ); + if (result.isOk()) { + return {kind: 'compile', compiledFn: result.unwrap()}; + } else { + return {kind: 'error', error: result.unwrapErr()}; + } } catch (err) { + /** + * A pass incorrectly threw instead of recording the error. + * Log for detection in development. + */ + if ( + err instanceof CompilerError && + err.details.every(detail => detail.category !== ErrorCategory.Invariant) + ) { + programContext.logEvent({ + kind: 'CompileUnexpectedThrow', + fnLoc: fn.node.loc ?? null, + data: err.toString(), + }); + } return {kind: 'error', error: err}; } } diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts index f43b3dd70157..8f44594c0031 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts @@ -11,10 +11,10 @@ import invariant from 'invariant'; import { CompilerDiagnostic, CompilerError, + CompilerErrorDetail, CompilerSuggestionOperation, ErrorCategory, } from '../CompilerError'; -import {Err, Ok, Result} from '../Utils/Result'; import {assertExhaustive, hasNode} from '../Utils/utils'; import {Environment} from './Environment'; import { @@ -75,7 +75,7 @@ export function lower( // Bindings captured from the outer function, in case lower() is called recursively (for lambdas) bindings: Bindings | null = null, capturedRefs: Map = new Map(), -): Result { +): HIRFunction { const builder = new HIRBuilder(env, { bindings, context: capturedRefs, @@ -106,7 +106,7 @@ export function lower( if (param.isIdentifier()) { const binding = builder.resolveIdentifier(param); if (binding.kind !== 'Identifier') { - builder.errors.pushDiagnostic( + builder.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Invariant, reason: 'Could not find binding', @@ -170,7 +170,7 @@ export function lower( 'Assignment', ); } else { - builder.errors.pushDiagnostic( + builder.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Todo, reason: `Handle ${param.node.type} parameters`, @@ -201,7 +201,7 @@ export function lower( lowerStatement(builder, body); directives = body.get('directives').map(d => d.node.value.value); } else { - builder.errors.pushDiagnostic( + builder.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Syntax, reason: `Unexpected function body kind`, @@ -218,16 +218,14 @@ export function lower( if (id != null) { const idResult = validateIdentifierName(id); if (idResult.isErr()) { - builder.errors.merge(idResult.unwrapErr()); + for (const detail of idResult.unwrapErr().details) { + builder.recordError(detail); + } } else { validatedId = idResult.unwrap().value; } } - if (builder.errors.hasAnyErrors()) { - return Err(builder.errors); - } - builder.terminate( { kind: 'return', @@ -244,23 +242,24 @@ export function lower( null, ); - return Ok({ + const hirBody = builder.build(); + + return { id: validatedId, nameHint: null, params, fnType: bindings == null ? env.fnType : 'Other', returnTypeAnnotation: null, // TODO: extract the actual return type node if present returns: createTemporaryPlace(env, func.node.loc ?? GeneratedSource), - body: builder.build(), + body: hirBody, context, generator: func.node.generator === true, async: func.node.async === true, loc: func.node.loc ?? GeneratedSource, env, - effects: null, aliasingEffects: null, directives, - }); + }; } // Helper to lower a statement @@ -281,13 +280,15 @@ function lowerStatement( * for control-flow and is generally considered an anti-pattern. we can likely * just not support this pattern, unless it really becomes necessary for some reason. */ - builder.errors.push({ - reason: - '(BuildHIR::lowerStatement) Support ThrowStatement inside of try/catch', - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + '(BuildHIR::lowerStatement) Support ThrowStatement inside of try/catch', + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); } const terminal: ThrowTerminal = { kind: 'throw', @@ -469,22 +470,26 @@ function lowerStatement( } else if (binding.path.isFunctionDeclaration()) { kind = InstructionKind.HoistedFunction; } else if (!binding.path.isVariableDeclarator()) { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: 'Unsupported declaration type for hoisting', - description: `variable "${binding.identifier.name}" declared with ${binding.path.type}`, - suggestions: null, - loc: id.parentPath.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: 'Unsupported declaration type for hoisting', + description: `variable "${binding.identifier.name}" declared with ${binding.path.type}`, + suggestions: null, + loc: id.parentPath.node.loc ?? GeneratedSource, + }), + ); continue; } else { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: 'Handle non-const declarations for hoisting', - description: `variable "${binding.identifier.name}" declared with ${binding.kind}`, - suggestions: null, - loc: id.parentPath.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: 'Handle non-const declarations for hoisting', + description: `variable "${binding.identifier.name}" declared with ${binding.kind}`, + suggestions: null, + loc: id.parentPath.node.loc ?? GeneratedSource, + }), + ); continue; } @@ -555,16 +560,42 @@ function lowerStatement( const initBlock = builder.enter('loop', _blockId => { const init = stmt.get('init'); - if (!init.isVariableDeclaration()) { - builder.errors.push({ - reason: - '(BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement', - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, + if (init.node == null) { + /* + * No init expression (e.g., `for (; ...)`), add a placeholder to avoid + * invariant about empty blocks + */ + lowerValueToTemporary(builder, { + kind: 'Primitive', + value: undefined, + loc: stmt.node.loc ?? GeneratedSource, }); return { - kind: 'unsupported', + kind: 'goto', + block: testBlock.id, + variant: GotoVariant.Break, + id: makeInstructionId(0), + loc: stmt.node.loc ?? GeneratedSource, + }; + } + if (!init.isVariableDeclaration()) { + builder.recordError( + new CompilerErrorDetail({ + reason: + '(BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement', + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); + // Lower the init expression as best-effort and continue + if (init.isExpression()) { + lowerExpressionToTemporary(builder, init as NodePath); + } + return { + kind: 'goto', + block: testBlock.id, + variant: GotoVariant.Break, id: makeInstructionId(0), loc: init.node?.loc ?? GeneratedSource, }; @@ -629,12 +660,31 @@ function lowerStatement( const test = stmt.get('test'); if (test.node == null) { - builder.errors.push({ - reason: `(BuildHIR::lowerStatement) Handle empty test in ForStatement`, - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerStatement) Handle empty test in ForStatement`, + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); + // Treat `for(;;)` as `while(true)` to keep the builder state consistent + builder.terminateWithContinuation( + { + kind: 'branch', + test: lowerValueToTemporary(builder, { + kind: 'Primitive', + value: true, + loc: stmt.node.loc ?? GeneratedSource, + }), + consequent: bodyBlock, + alternate: continuationBlock.id, + fallthrough: continuationBlock.id, + id: makeInstructionId(0), + loc: stmt.node.loc ?? GeneratedSource, + }, + continuationBlock, + ); } else { builder.terminateWithContinuation( { @@ -780,12 +830,14 @@ function lowerStatement( const testExpr = case_.get('test'); if (testExpr.node == null) { if (hasDefault) { - builder.errors.push({ - reason: `Expected at most one \`default\` branch in a switch statement, this code should have failed to parse`, - category: ErrorCategory.Syntax, - loc: case_.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected at most one \`default\` branch in a switch statement, this code should have failed to parse`, + category: ErrorCategory.Syntax, + loc: case_.node.loc ?? null, + suggestions: null, + }), + ); break; } hasDefault = true; @@ -852,16 +904,20 @@ function lowerStatement( const stmt = stmtPath as NodePath; const nodeKind: t.VariableDeclaration['kind'] = stmt.node.kind; if (nodeKind === 'var') { - builder.errors.push({ - reason: `(BuildHIR::lowerStatement) Handle ${nodeKind} kinds in VariableDeclaration`, - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); - return; + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerStatement) Handle ${nodeKind} kinds in VariableDeclaration`, + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); + // Treat `var` as `let` so references to the variable don't break } const kind = - nodeKind === 'let' ? InstructionKind.Let : InstructionKind.Const; + nodeKind === 'let' || nodeKind === 'var' + ? InstructionKind.Let + : InstructionKind.Const; for (const declaration of stmt.get('declarations')) { const id = declaration.get('id'); const init = declaration.get('init'); @@ -880,12 +936,14 @@ function lowerStatement( } else if (id.isIdentifier()) { const binding = builder.resolveIdentifier(id); if (binding.kind !== 'Identifier') { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Could not find binding for declaration.`, - category: ErrorCategory.Invariant, - loc: id.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Could not find binding for declaration.`, + category: ErrorCategory.Invariant, + loc: id.node.loc ?? null, + suggestions: null, + }), + ); } else { const place: Place = { effect: Effect.Unknown, @@ -897,19 +955,21 @@ function lowerStatement( if (builder.isContextIdentifier(id)) { if (kind === InstructionKind.Const) { const declRangeStart = declaration.parentPath.node.start!; - builder.errors.push({ - reason: `Expect \`const\` declaration not to be reassigned`, - category: ErrorCategory.Syntax, - loc: id.node.loc ?? null, - suggestions: [ - { - description: 'Change to a `let` declaration', - op: CompilerSuggestionOperation.Replace, - range: [declRangeStart, declRangeStart + 5], // "const".length - text: 'let', - }, - ], - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expect \`const\` declaration not to be reassigned`, + category: ErrorCategory.Syntax, + loc: id.node.loc ?? null, + suggestions: [ + { + description: 'Change to a `let` declaration', + op: CompilerSuggestionOperation.Replace, + range: [declRangeStart, declRangeStart + 5], // "const".length + text: 'let', + }, + ], + }), + ); } lowerValueToTemporary(builder, { kind: 'DeclareContext', @@ -943,13 +1003,15 @@ function lowerStatement( } } } else { - builder.errors.push({ - reason: `Expected variable declaration to be an identifier if no initializer was provided`, - description: `Got a \`${id.type}\``, - category: ErrorCategory.Syntax, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected variable declaration to be an identifier if no initializer was provided`, + description: `Got a \`${id.type}\``, + category: ErrorCategory.Syntax, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); } } return; @@ -1050,12 +1112,14 @@ function lowerStatement( const testBlock = builder.reserve('loop'); if (stmt.node.await) { - builder.errors.push({ - reason: `(BuildHIR::lowerStatement) Handle for-await loops`, - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerStatement) Handle for-await loops`, + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); return; } @@ -1278,21 +1342,25 @@ function lowerStatement( const handlerPath = stmt.get('handler'); if (!hasNode(handlerPath)) { - builder.errors.push({ - reason: `(BuildHIR::lowerStatement) Handle TryStatement without a catch clause`, - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerStatement) Handle TryStatement without a catch clause`, + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); return; } if (hasNode(stmt.get('finalizer'))) { - builder.errors.push({ - reason: `(BuildHIR::lowerStatement) Handle TryStatement with a finalizer ('finally') clause`, - category: ErrorCategory.Todo, - loc: stmt.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerStatement) Handle TryStatement with a finalizer ('finally') clause`, + category: ErrorCategory.Todo, + loc: stmt.node.loc ?? null, + suggestions: null, + }), + ); } const handlerBindingPath = handlerPath.get('param'); @@ -1379,13 +1447,15 @@ function lowerStatement( return; } case 'WithStatement': { - builder.errors.push({ - reason: `JavaScript 'with' syntax is not supported`, - description: `'with' syntax is considered deprecated and removed from JavaScript standards, consider alternatives`, - category: ErrorCategory.UnsupportedSyntax, - loc: stmtPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `JavaScript 'with' syntax is not supported`, + description: `'with' syntax is considered deprecated and removed from JavaScript standards, consider alternatives`, + category: ErrorCategory.UnsupportedSyntax, + loc: stmtPath.node.loc ?? null, + suggestions: null, + }), + ); lowerValueToTemporary(builder, { kind: 'UnsupportedNode', loc: stmtPath.node.loc ?? GeneratedSource, @@ -1399,13 +1469,15 @@ function lowerStatement( * and complex enough to support that we don't anticipate supporting anytime soon. Developers * are encouraged to lift classes out of component/hook declarations. */ - builder.errors.push({ - reason: 'Inline `class` declarations are not supported', - description: `Move class declarations outside of components/hooks`, - category: ErrorCategory.UnsupportedSyntax, - loc: stmtPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: 'Inline `class` declarations are not supported', + description: `Move class declarations outside of components/hooks`, + category: ErrorCategory.UnsupportedSyntax, + loc: stmtPath.node.loc ?? null, + suggestions: null, + }), + ); lowerValueToTemporary(builder, { kind: 'UnsupportedNode', loc: stmtPath.node.loc ?? GeneratedSource, @@ -1428,13 +1500,15 @@ function lowerStatement( case 'ImportDeclaration': case 'TSExportAssignment': case 'TSImportEqualsDeclaration': { - builder.errors.push({ - reason: - 'JavaScript `import` and `export` statements may only appear at the top level of a module', - category: ErrorCategory.Syntax, - loc: stmtPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + 'JavaScript `import` and `export` statements may only appear at the top level of a module', + category: ErrorCategory.Syntax, + loc: stmtPath.node.loc ?? null, + suggestions: null, + }), + ); lowerValueToTemporary(builder, { kind: 'UnsupportedNode', loc: stmtPath.node.loc ?? GeneratedSource, @@ -1443,13 +1517,15 @@ function lowerStatement( return; } case 'TSNamespaceExportDeclaration': { - builder.errors.push({ - reason: - 'TypeScript `namespace` statements may only appear at the top level of a module', - category: ErrorCategory.Syntax, - loc: stmtPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + 'TypeScript `namespace` statements may only appear at the top level of a module', + category: ErrorCategory.Syntax, + loc: stmtPath.node.loc ?? null, + suggestions: null, + }), + ); lowerValueToTemporary(builder, { kind: 'UnsupportedNode', loc: stmtPath.node.loc ?? GeneratedSource, @@ -1494,9 +1570,6 @@ function lowerObjectMethod( ): InstructionValue { const loc = property.node.loc ?? GeneratedSource; const loweredFunc = lowerFunction(builder, property); - if (!loweredFunc) { - return {kind: 'UnsupportedNode', node: property.node, loc: loc}; - } return { kind: 'ObjectMethod', @@ -1533,12 +1606,14 @@ function lowerObjectPropertyKey( }; } - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Expected Identifier, got ${key.type} key in ObjectExpression`, - category: ErrorCategory.Todo, - loc: key.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Expected Identifier, got ${key.type} key in ObjectExpression`, + category: ErrorCategory.Todo, + loc: key.node.loc ?? null, + suggestions: null, + }), + ); return null; } @@ -1590,12 +1665,14 @@ function lowerExpression( } const valuePath = propertyPath.get('value'); if (!valuePath.isExpression()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${valuePath.type} values in ObjectExpression`, - category: ErrorCategory.Todo, - loc: valuePath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${valuePath.type} values in ObjectExpression`, + category: ErrorCategory.Todo, + loc: valuePath.node.loc ?? null, + suggestions: null, + }), + ); continue; } const value = lowerExpressionToTemporary(builder, valuePath); @@ -1616,12 +1693,14 @@ function lowerExpression( }); } else if (propertyPath.isObjectMethod()) { if (propertyPath.node.kind !== 'method') { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${propertyPath.node.kind} functions in ObjectExpression`, - category: ErrorCategory.Todo, - loc: propertyPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${propertyPath.node.kind} functions in ObjectExpression`, + category: ErrorCategory.Todo, + loc: propertyPath.node.loc ?? null, + suggestions: null, + }), + ); continue; } const method = lowerObjectMethod(builder, propertyPath); @@ -1637,12 +1716,14 @@ function lowerExpression( key: loweredKey, }); } else { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${propertyPath.type} properties in ObjectExpression`, - category: ErrorCategory.Todo, - loc: propertyPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${propertyPath.type} properties in ObjectExpression`, + category: ErrorCategory.Todo, + loc: propertyPath.node.loc ?? null, + suggestions: null, + }), + ); continue; } } @@ -1670,12 +1751,14 @@ function lowerExpression( ); elements.push({kind: 'Spread', place}); } else { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${element.type} elements in ArrayExpression`, - category: ErrorCategory.Todo, - loc: element.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${element.type} elements in ArrayExpression`, + category: ErrorCategory.Todo, + loc: element.node.loc ?? null, + suggestions: null, + }), + ); continue; } } @@ -1689,13 +1772,15 @@ function lowerExpression( const expr = exprPath as NodePath; const calleePath = expr.get('callee'); if (!calleePath.isExpression()) { - builder.errors.push({ - reason: `Expected an expression as the \`new\` expression receiver (v8 intrinsics are not supported)`, - description: `Got a \`${calleePath.node.type}\``, - category: ErrorCategory.Syntax, - loc: calleePath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected an expression as the \`new\` expression receiver (v8 intrinsics are not supported)`, + description: `Got a \`${calleePath.node.type}\``, + category: ErrorCategory.Syntax, + loc: calleePath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } const callee = lowerExpressionToTemporary(builder, calleePath); @@ -1716,12 +1801,14 @@ function lowerExpression( const expr = exprPath as NodePath; const calleePath = expr.get('callee'); if (!calleePath.isExpression()) { - builder.errors.push({ - reason: `Expected Expression, got ${calleePath.type} in CallExpression (v8 intrinsics not supported). This error is likely caused by a bug in React Compiler. Please file an issue`, - category: ErrorCategory.Todo, - loc: calleePath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected Expression, got ${calleePath.type} in CallExpression (v8 intrinsics not supported). This error is likely caused by a bug in React Compiler. Please file an issue`, + category: ErrorCategory.Todo, + loc: calleePath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } if (calleePath.isMemberExpression()) { @@ -1750,24 +1837,28 @@ function lowerExpression( const expr = exprPath as NodePath; const leftPath = expr.get('left'); if (!leftPath.isExpression()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Expected Expression, got ${leftPath.type} lval in BinaryExpression`, - category: ErrorCategory.Todo, - loc: leftPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Expected Expression, got ${leftPath.type} lval in BinaryExpression`, + category: ErrorCategory.Todo, + loc: leftPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } const left = lowerExpressionToTemporary(builder, leftPath); const right = lowerExpressionToTemporary(builder, expr.get('right')); const operator = expr.node.operator; if (operator === '|>') { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Pipe operator not supported`, - category: ErrorCategory.Todo, - loc: leftPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Pipe operator not supported`, + category: ErrorCategory.Todo, + loc: leftPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } return { @@ -1791,12 +1882,14 @@ function lowerExpression( last = lowerExpressionToTemporary(builder, item); } if (last === null) { - builder.errors.push({ - reason: `Expected sequence expression to have at least one expression`, - category: ErrorCategory.Syntax, - loc: expr.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected sequence expression to have at least one expression`, + category: ErrorCategory.Syntax, + loc: expr.node.loc ?? null, + suggestions: null, + }), + ); } else { lowerValueToTemporary(builder, { kind: 'StoreLocal', @@ -2002,13 +2095,15 @@ function lowerExpression( * OptionalMemberExpressions as the left side of an AssignmentExpression are Stage 1 and * not supported by React Compiler yet. */ - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Unsupported syntax on the left side of an AssignmentExpression`, - description: `Expected an LVal, got: ${left.type}`, - category: ErrorCategory.Todo, - loc: left.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Unsupported syntax on the left side of an AssignmentExpression`, + description: `Expected an LVal, got: ${left.type}`, + category: ErrorCategory.Todo, + loc: left.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } } @@ -2031,12 +2126,14 @@ function lowerExpression( }; const binaryOperator = operators[operator]; if (binaryOperator == null) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${operator} operators in AssignmentExpression`, - category: ErrorCategory.Todo, - loc: expr.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${operator} operators in AssignmentExpression`, + category: ErrorCategory.Todo, + loc: expr.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } const left = expr.get('left'); @@ -2130,12 +2227,14 @@ function lowerExpression( } } default: { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Expected Identifier or MemberExpression, got ${expr.type} lval in AssignmentExpression`, - category: ErrorCategory.Todo, - loc: expr.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Expected Identifier or MemberExpression, got ${expr.type} lval in AssignmentExpression`, + category: ErrorCategory.Todo, + loc: expr.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } } @@ -2169,12 +2268,14 @@ function lowerExpression( continue; } if (!attribute.isJSXAttribute()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${attribute.type} attributes in JSXElement`, - category: ErrorCategory.Todo, - loc: attribute.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${attribute.type} attributes in JSXElement`, + category: ErrorCategory.Todo, + loc: attribute.node.loc ?? null, + suggestions: null, + }), + ); continue; } const namePath = attribute.get('name'); @@ -2182,13 +2283,15 @@ function lowerExpression( if (namePath.isJSXIdentifier()) { propName = namePath.node.name; if (propName.indexOf(':') !== -1) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Unexpected colon in attribute name \`${propName}\``, - category: ErrorCategory.Todo, - loc: namePath.node.loc ?? null, - suggestions: null, - }); - } + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Unexpected colon in attribute name \`${propName}\``, + category: ErrorCategory.Todo, + loc: namePath.node.loc ?? null, + suggestions: null, + }), + ); + } } else { CompilerError.invariant(namePath.isJSXNamespacedName(), { reason: 'Refinement', @@ -2210,22 +2313,26 @@ function lowerExpression( }); } else { if (!valueExpr.isJSXExpressionContainer()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${valueExpr.type} attribute values in JSXElement`, - category: ErrorCategory.Todo, - loc: valueExpr.node?.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${valueExpr.type} attribute values in JSXElement`, + category: ErrorCategory.Todo, + loc: valueExpr.node?.loc ?? null, + suggestions: null, + }), + ); continue; } const expression = valueExpr.get('expression'); if (!expression.isExpression()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${expression.type} expressions in JSXExpressionContainer within JSXElement`, - category: ErrorCategory.Todo, - loc: valueExpr.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${expression.type} expressions in JSXExpressionContainer within JSXElement`, + category: ErrorCategory.Todo, + loc: valueExpr.node.loc ?? null, + suggestions: null, + }), + ); continue; } value = lowerExpressionToTemporary(builder, expression); @@ -2276,18 +2383,20 @@ function lowerExpression( }); for (const [name, locations] of Object.entries(fbtLocations)) { if (locations.length > 1) { - CompilerError.throwDiagnostic({ - category: ErrorCategory.Todo, - reason: 'Support duplicate fbt tags', - description: `Support \`<${tagName}>\` tags with multiple \`<${tagName}:${name}>\` values`, - details: locations.map(loc => { - return { - kind: 'error', - message: `Multiple \`<${tagName}:${name}>\` tags found`, - loc, - }; + builder.recordError( + new CompilerDiagnostic({ + category: ErrorCategory.Todo, + reason: 'Support duplicate fbt tags', + description: `Support \`<${tagName}>\` tags with multiple \`<${tagName}:${name}>\` values`, + details: locations.map(loc => { + return { + kind: 'error' as const, + message: `Multiple \`<${tagName}:${name}>\` tags found`, + loc, + }; + }), }), - }); + ); } } } @@ -2335,13 +2444,15 @@ function lowerExpression( case 'TaggedTemplateExpression': { const expr = exprPath as NodePath; if (expr.get('quasi').get('expressions').length !== 0) { - builder.errors.push({ - reason: - '(BuildHIR::lowerExpression) Handle tagged template with interpolations', - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + '(BuildHIR::lowerExpression) Handle tagged template with interpolations', + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } CompilerError.invariant(expr.get('quasi').get('quasis').length == 1, { @@ -2351,13 +2462,15 @@ function lowerExpression( }); const value = expr.get('quasi').get('quasis').at(0)!.node.value; if (value.raw !== value.cooked) { - builder.errors.push({ - reason: - '(BuildHIR::lowerExpression) Handle tagged template where cooked value is different from raw value', - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + '(BuildHIR::lowerExpression) Handle tagged template where cooked value is different from raw value', + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } @@ -2374,22 +2487,26 @@ function lowerExpression( const quasis = expr.get('quasis'); if (subexprs.length !== quasis.length - 1) { - builder.errors.push({ - reason: `Unexpected quasi and subexpression lengths in template literal`, - category: ErrorCategory.Syntax, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Unexpected quasi and subexpression lengths in template literal`, + category: ErrorCategory.Syntax, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } if (subexprs.some(e => !e.isExpression())) { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle TSType in TemplateLiteral.`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle TSType in TemplateLiteral.`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } @@ -2426,8 +2543,26 @@ function lowerExpression( }; } } else { - builder.errors.push({ - reason: `Only object properties can be deleted`, + builder.recordError( + new CompilerErrorDetail({ + reason: `Only object properties can be deleted`, + category: ErrorCategory.Syntax, + loc: expr.node.loc ?? null, + suggestions: [ + { + description: 'Remove this line', + range: [expr.node.start!, expr.node.end!], + op: CompilerSuggestionOperation.Remove, + }, + ], + }), + ); + return {kind: 'UnsupportedNode', node: expr.node, loc: exprLoc}; + } + } else if (expr.node.operator === 'throw') { + builder.recordError( + new CompilerErrorDetail({ + reason: `Throw expressions are not supported`, category: ErrorCategory.Syntax, loc: expr.node.loc ?? null, suggestions: [ @@ -2437,22 +2572,8 @@ function lowerExpression( op: CompilerSuggestionOperation.Remove, }, ], - }); - return {kind: 'UnsupportedNode', node: expr.node, loc: exprLoc}; - } - } else if (expr.node.operator === 'throw') { - builder.errors.push({ - reason: `Throw expressions are not supported`, - category: ErrorCategory.Syntax, - loc: expr.node.loc ?? null, - suggestions: [ - { - description: 'Remove this line', - range: [expr.node.start!, expr.node.end!], - op: CompilerSuggestionOperation.Remove, - }, - ], - }); + }), + ); return {kind: 'UnsupportedNode', node: expr.node, loc: exprLoc}; } else { return { @@ -2562,20 +2683,24 @@ function lowerExpression( }; } if (!argument.isIdentifier()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle UpdateExpression with ${argument.type} argument`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle UpdateExpression with ${argument.type} argument`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } else if (builder.isContextIdentifier(argument)) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle UpdateExpression to variables captured within lambdas.`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle UpdateExpression to variables captured within lambdas.`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } const lvalue = lowerIdentifierForAssignment( @@ -2589,22 +2714,26 @@ function lowerExpression( * lowerIdentifierForAssignment should have already reported an error if it returned null, * we check here just in case */ - if (!builder.errors.hasAnyErrors()) { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Found an invalid UpdateExpression without a previously reported error`, - category: ErrorCategory.Invariant, - loc: exprLoc, - suggestions: null, - }); + if (!builder.environment.hasErrors()) { + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Found an invalid UpdateExpression without a previously reported error`, + category: ErrorCategory.Invariant, + loc: exprLoc, + suggestions: null, + }), + ); } return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } else if (lvalue.kind === 'Global') { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Support UpdateExpression where argument is a global`, - category: ErrorCategory.Todo, - loc: exprLoc, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Support UpdateExpression where argument is a global`, + category: ErrorCategory.Todo, + loc: exprLoc, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } const value = lowerIdentifier(builder, argument); @@ -2654,21 +2783,25 @@ function lowerExpression( }; } - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle MetaProperty expressions other than import.meta`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle MetaProperty expressions other than import.meta`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } default: { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${exprPath.type} expressions`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${exprPath.type} expressions`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; } } @@ -2958,12 +3091,14 @@ function lowerReorderableExpression( expr: NodePath, ): Place { if (!isReorderableExpression(builder, expr, true)) { - builder.errors.push({ - reason: `(BuildHIR::node.lowerReorderableExpression) Expression type \`${expr.type}\` cannot be safely reordered`, - category: ErrorCategory.Todo, - loc: expr.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::node.lowerReorderableExpression) Expression type \`${expr.type}\` cannot be safely reordered`, + category: ErrorCategory.Todo, + loc: expr.node.loc ?? null, + suggestions: null, + }), + ); } return lowerExpressionToTemporary(builder, expr); } @@ -3160,12 +3295,14 @@ function lowerArguments( } else if (argPath.isExpression()) { args.push(lowerExpressionToTemporary(builder, argPath)); } else { - builder.errors.push({ - reason: `(BuildHIR::lowerExpression) Handle ${argPath.type} arguments in CallExpression`, - category: ErrorCategory.Todo, - loc: argPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerExpression) Handle ${argPath.type} arguments in CallExpression`, + category: ErrorCategory.Todo, + loc: argPath.node.loc ?? null, + suggestions: null, + }), + ); } } return args; @@ -3195,12 +3332,14 @@ function lowerMemberExpression( } else if (propertyNode.isNumericLiteral()) { property = makePropertyLiteral(propertyNode.node.value); } else { - builder.errors.push({ - reason: `(BuildHIR::lowerMemberExpression) Handle ${propertyNode.type} property`, - category: ErrorCategory.Todo, - loc: propertyNode.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerMemberExpression) Handle ${propertyNode.type} property`, + category: ErrorCategory.Todo, + loc: propertyNode.node.loc ?? null, + suggestions: null, + }), + ); return { object, property: propertyNode.toString(), @@ -3216,12 +3355,14 @@ function lowerMemberExpression( return {object, property, value}; } else { if (!propertyNode.isExpression()) { - builder.errors.push({ - reason: `(BuildHIR::lowerMemberExpression) Expected Expression, got ${propertyNode.type} property`, - category: ErrorCategory.Todo, - loc: propertyNode.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerMemberExpression) Expected Expression, got ${propertyNode.type} property`, + category: ErrorCategory.Todo, + loc: propertyNode.node.loc ?? null, + suggestions: null, + }), + ); return { object, property: propertyNode.toString(), @@ -3274,13 +3415,15 @@ function lowerJsxElementName( const name = exprPath.node.name.name; const tag = `${namespace}:${name}`; if (namespace.indexOf(':') !== -1 || name.indexOf(':') !== -1) { - builder.errors.push({ - reason: `Expected JSXNamespacedName to have no colons in the namespace or name`, - description: `Got \`${namespace}\` : \`${name}\``, - category: ErrorCategory.Syntax, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected JSXNamespacedName to have no colons in the namespace or name`, + description: `Got \`${namespace}\` : \`${name}\``, + category: ErrorCategory.Syntax, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); } const place = lowerValueToTemporary(builder, { kind: 'Primitive', @@ -3289,12 +3432,14 @@ function lowerJsxElementName( }); return place; } else { - builder.errors.push({ - reason: `(BuildHIR::lowerJsxElementName) Handle ${exprPath.type} tags`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerJsxElementName) Handle ${exprPath.type} tags`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); return lowerValueToTemporary(builder, { kind: 'UnsupportedNode', node: exprNode, @@ -3383,12 +3528,14 @@ function lowerJsxElement( }); return place; } else { - builder.errors.push({ - reason: `(BuildHIR::lowerJsxElement) Unhandled JsxElement, got: ${exprPath.type}`, - category: ErrorCategory.Todo, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerJsxElement) Unhandled JsxElement, got: ${exprPath.type}`, + category: ErrorCategory.Todo, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); const place = lowerValueToTemporary(builder, { kind: 'UnsupportedNode', node: exprNode, @@ -3468,9 +3615,6 @@ function lowerFunctionToValue( const exprNode = expr.node; const exprLoc = exprNode.loc ?? GeneratedSource; const loweredFunc = lowerFunction(builder, expr); - if (!loweredFunc) { - return {kind: 'UnsupportedNode', node: exprNode, loc: exprLoc}; - } return { kind: 'FunctionExpression', name: loweredFunc.func.id, @@ -3489,7 +3633,7 @@ function lowerFunction( | t.FunctionDeclaration | t.ObjectMethod >, -): LoweredFunction | null { +): LoweredFunction { const componentScope: Scope = builder.environment.parentFunction.scope; const capturedContext = gatherCapturedContext(expr, componentScope); @@ -3501,19 +3645,12 @@ function lowerFunction( * This isn't a problem in practice because use Babel's scope analysis to * identify the correct references. */ - const lowering = lower( + const loweredFunc = lower( expr, builder.environment, builder.bindings, new Map([...builder.context, ...capturedContext]), ); - let loweredFunc: HIRFunction; - if (lowering.isErr()) { - const functionErrors = lowering.unwrapErr(); - builder.errors.merge(functionErrors); - return null; - } - loweredFunc = lowering.unwrap(); return { func: loweredFunc, }; @@ -3565,14 +3702,16 @@ function lowerIdentifier( } default: { if (binding.kind === 'Global' && binding.name === 'eval') { - builder.errors.push({ - reason: `The 'eval' function is not supported`, - description: - 'Eval is an anti-pattern in JavaScript, and the code executed cannot be evaluated by React Compiler', - category: ErrorCategory.UnsupportedSyntax, - loc: exprPath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `The 'eval' function is not supported`, + description: + 'Eval is an anti-pattern in JavaScript, and the code executed cannot be evaluated by React Compiler', + category: ErrorCategory.UnsupportedSyntax, + loc: exprPath.node.loc ?? null, + suggestions: null, + }), + ); } return lowerValueToTemporary(builder, { kind: 'LoadGlobal', @@ -3623,27 +3762,31 @@ function lowerIdentifierForAssignment( return {kind: 'Global', name: path.node.name}; } else { // Else its an internal error bc we couldn't find the binding - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Could not find binding for declaration.`, - category: ErrorCategory.Invariant, - loc: path.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Could not find binding for declaration.`, + category: ErrorCategory.Invariant, + loc: path.node.loc ?? null, + suggestions: null, + }), + ); return null; } } else if ( binding.bindingKind === 'const' && kind === InstructionKind.Reassign ) { - builder.errors.push({ - reason: `Cannot reassign a \`const\` variable`, - category: ErrorCategory.Syntax, - loc: path.node.loc ?? null, - description: - binding.identifier.name != null - ? `\`${binding.identifier.name.value}\` is declared as const` - : null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Cannot reassign a \`const\` variable`, + category: ErrorCategory.Syntax, + loc: path.node.loc ?? null, + description: + binding.identifier.name != null + ? `\`${binding.identifier.name.value}\` is declared as const` + : null, + }), + ); return null; } @@ -3692,12 +3835,14 @@ function lowerAssignment( let temporary; if (builder.isContextIdentifier(lvalue)) { if (kind === InstructionKind.Const && !isHoistedIdentifier) { - builder.errors.push({ - reason: `Expected \`const\` declaration not to be reassigned`, - category: ErrorCategory.Syntax, - loc: lvalue.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Expected \`const\` declaration not to be reassigned`, + category: ErrorCategory.Syntax, + loc: lvalue.node.loc ?? null, + suggestions: null, + }), + ); } if ( @@ -3706,12 +3851,14 @@ function lowerAssignment( kind !== InstructionKind.Let && kind !== InstructionKind.Function ) { - builder.errors.push({ - reason: `Unexpected context variable kind`, - category: ErrorCategory.Syntax, - loc: lvalue.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `Unexpected context variable kind`, + category: ErrorCategory.Syntax, + loc: lvalue.node.loc ?? null, + suggestions: null, + }), + ); temporary = lowerValueToTemporary(builder, { kind: 'UnsupportedNode', node: lvalueNode, @@ -3775,24 +3922,28 @@ function lowerAssignment( loc, }); } else { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle ${property.type} properties in MemberExpression`, - category: ErrorCategory.Todo, - loc: property.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle ${property.type} properties in MemberExpression`, + category: ErrorCategory.Todo, + loc: property.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: lvalueNode, loc}; } return {kind: 'LoadLocal', place: temporary, loc: temporary.loc}; } else { if (!property.isExpression()) { - builder.errors.push({ - reason: - '(BuildHIR::lowerAssignment) Expected private name to appear as a non-computed property', - category: ErrorCategory.Todo, - loc: property.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: + '(BuildHIR::lowerAssignment) Expected private name to appear as a non-computed property', + category: ErrorCategory.Todo, + loc: property.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: lvalueNode, loc}; } const propertyPlace = lowerExpressionToTemporary(builder, property); @@ -3853,12 +4004,14 @@ function lowerAssignment( if (identifier === null) { continue; } else if (identifier.kind === 'Global') { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: - 'Expected reassignment of globals to enable forceTemporaries', - loc: element.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: + 'Expected reassignment of globals to enable forceTemporaries', + loc: element.node.loc ?? GeneratedSource, + }), + ); continue; } items.push({ @@ -3892,12 +4045,14 @@ function lowerAssignment( if (identifier === null) { continue; } else if (identifier.kind === 'Global') { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: - 'Expected reassignment of globals to enable forceTemporaries', - loc: element.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: + 'Expected reassignment of globals to enable forceTemporaries', + loc: element.node.loc ?? GeneratedSource, + }), + ); continue; } items.push(identifier); @@ -3965,12 +4120,14 @@ function lowerAssignment( if (property.isRestElement()) { const argument = property.get('argument'); if (!argument.isIdentifier()) { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle ${argument.node.type} rest element in ObjectPattern`, - category: ErrorCategory.Todo, - loc: argument.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle ${argument.node.type} rest element in ObjectPattern`, + category: ErrorCategory.Todo, + loc: argument.node.loc ?? null, + suggestions: null, + }), + ); continue; } if ( @@ -3997,12 +4154,14 @@ function lowerAssignment( if (identifier === null) { continue; } else if (identifier.kind === 'Global') { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: - 'Expected reassignment of globals to enable forceTemporaries', - loc: property.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: + 'Expected reassignment of globals to enable forceTemporaries', + loc: property.node.loc ?? GeneratedSource, + }), + ); continue; } properties.push({ @@ -4013,21 +4172,25 @@ function lowerAssignment( } else { // TODO: this should always be true given the if/else if (!property.isObjectProperty()) { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle ${property.type} properties in ObjectPattern`, - category: ErrorCategory.Todo, - loc: property.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle ${property.type} properties in ObjectPattern`, + category: ErrorCategory.Todo, + loc: property.node.loc ?? null, + suggestions: null, + }), + ); continue; } if (property.node.computed) { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern`, - category: ErrorCategory.Todo, - loc: property.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern`, + category: ErrorCategory.Todo, + loc: property.node.loc ?? null, + suggestions: null, + }), + ); continue; } const loweredKey = lowerObjectPropertyKey(builder, property); @@ -4036,12 +4199,14 @@ function lowerAssignment( } const element = property.get('value'); if (!element.isLVal()) { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Expected object property value to be an LVal, got: ${element.type}`, - category: ErrorCategory.Todo, - loc: element.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Expected object property value to be an LVal, got: ${element.type}`, + category: ErrorCategory.Todo, + loc: element.node.loc ?? null, + suggestions: null, + }), + ); continue; } if ( @@ -4059,12 +4224,14 @@ function lowerAssignment( if (identifier === null) { continue; } else if (identifier.kind === 'Global') { - builder.errors.push({ - category: ErrorCategory.Todo, - reason: - 'Expected reassignment of globals to enable forceTemporaries', - loc: element.node.loc ?? GeneratedSource, - }); + builder.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: + 'Expected reassignment of globals to enable forceTemporaries', + loc: element.node.loc ?? GeneratedSource, + }), + ); continue; } properties.push({ @@ -4208,12 +4375,14 @@ function lowerAssignment( ); } default: { - builder.errors.push({ - reason: `(BuildHIR::lowerAssignment) Handle ${lvaluePath.type} assignments`, - category: ErrorCategory.Todo, - loc: lvaluePath.node.loc ?? null, - suggestions: null, - }); + builder.recordError( + new CompilerErrorDetail({ + reason: `(BuildHIR::lowerAssignment) Handle ${lvaluePath.type} assignments`, + category: ErrorCategory.Todo, + loc: lvaluePath.node.loc ?? null, + suggestions: null, + }), + ); return {kind: 'UnsupportedNode', node: lvalueNode, loc}; } } diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/CollectOptionalChainDependencies.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/CollectOptionalChainDependencies.ts index f78598ec3c6a..ece62bf56a27 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/HIR/CollectOptionalChainDependencies.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/HIR/CollectOptionalChainDependencies.ts @@ -310,16 +310,13 @@ function traverseOptionalBlock( * - a optional base block with a separate nested optional-chain (e.g. a(c?.d)?.d) */ const testBlock = context.blocks.get(maybeTest.terminal.fallthrough)!; - if (testBlock!.terminal.kind !== 'branch') { - /** - * Fallthrough of the inner optional should be a block with no - * instructions, terminating with Test($) - */ - CompilerError.throwTodo({ - reason: `Unexpected terminal kind \`${testBlock.terminal.kind}\` for optional fallthrough block`, - loc: maybeTest.terminal.loc, - }); + /** + * Fallthrough of the inner optional should be a block with no + * instructions, terminating with Test($) + */ + if (testBlock.terminal.kind !== 'branch') { + return null; } /** * Recurse into inner optional blocks to collect inner optional-chain diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts index ba224d352506..98cf1ed57d9f 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/HIR/Environment.ts @@ -8,7 +8,12 @@ import * as t from '@babel/types'; import {ZodError, z} from 'zod/v4'; import {fromZodError} from 'zod-validation-error/v4'; -import {CompilerError} from '../CompilerError'; +import { + CompilerDiagnostic, + CompilerError, + CompilerErrorDetail, + ErrorCategory, +} from '../CompilerError'; import {CompilerOutputMode, Logger, ProgramContext} from '../Entrypoint'; import {Err, Ok, Result} from '../Utils/Result'; import { @@ -545,6 +550,12 @@ export class Environment { #flowTypeEnvironment: FlowTypeEnv | null; + /** + * Accumulated compilation errors. Passes record errors here instead of + * throwing, so the pipeline can continue and report all errors at once. + */ + #errors: CompilerError = new CompilerError(); + constructor( scope: BabelScope, fnType: ReactFunctionType, @@ -702,6 +713,52 @@ export class Environment { } } + /** + * Record a single diagnostic or error detail on this environment. + * If the error is an Invariant, it is immediately thrown since invariants + * represent internal bugs that cannot be recovered from. + * Otherwise, the error is accumulated and optionally logged. + */ + recordError(error: CompilerDiagnostic | CompilerErrorDetail): void { + if (error.category === ErrorCategory.Invariant) { + const compilerError = new CompilerError(); + if (error instanceof CompilerDiagnostic) { + compilerError.pushDiagnostic(error); + } else { + compilerError.pushErrorDetail(error); + } + throw compilerError; + } + if (error instanceof CompilerDiagnostic) { + this.#errors.pushDiagnostic(error); + } else { + this.#errors.pushErrorDetail(error); + } + } + + /** + * Record all diagnostics from a CompilerError onto this environment. + */ + recordErrors(error: CompilerError): void { + for (const detail of error.details) { + this.recordError(detail); + } + } + + /** + * Returns true if any errors have been recorded during compilation. + */ + hasErrors(): boolean { + return this.#errors.hasAnyErrors(); + } + + /** + * Returns the accumulated CompilerError containing all recorded diagnostics. + */ + aggregateErrors(): CompilerError { + return this.#errors; + } + isContextIdentifier(node: t.Identifier): boolean { return this.#contextIdentifiers.has(node); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/HIR/HIRBuilder.ts b/compiler/packages/babel-plugin-react-compiler/src/HIR/HIRBuilder.ts index ab92904243c5..71874b0afb1d 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/HIR/HIRBuilder.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/HIR/HIRBuilder.ts @@ -7,7 +7,12 @@ import {Binding, NodePath} from '@babel/traverse'; import * as t from '@babel/types'; -import {CompilerError, ErrorCategory} from '../CompilerError'; +import { + CompilerError, + CompilerDiagnostic, + CompilerErrorDetail, + ErrorCategory, +} from '../CompilerError'; import {Environment} from './Environment'; import { BasicBlock, @@ -110,7 +115,6 @@ export default class HIRBuilder { #bindings: Bindings; #env: Environment; #exceptionHandlerStack: Array = []; - errors: CompilerError = new CompilerError(); /** * Traversal context: counts the number of `fbt` tag parents * of the current babel node. @@ -148,6 +152,10 @@ export default class HIRBuilder { this.#current = newBlock(this.#entry, options?.entryBlockKind ?? 'block'); } + recordError(error: CompilerDiagnostic | CompilerErrorDetail): void { + this.#env.recordError(error); + } + currentBlockKind(): BlockKind { return this.#current.kind; } @@ -308,34 +316,28 @@ export default class HIRBuilder { resolveBinding(node: t.Identifier): Identifier { if (node.name === 'fbt') { - CompilerError.throwDiagnostic({ - category: ErrorCategory.Todo, - reason: 'Support local variables named `fbt`', - description: - 'Local variables named `fbt` may conflict with the fbt plugin and are not yet supported', - details: [ - { - kind: 'error', - message: 'Rename to avoid conflict with fbt plugin', - loc: node.loc ?? GeneratedSource, - }, - ], - }); + this.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.Todo, + reason: 'Support local variables named `fbt`', + description: + 'Local variables named `fbt` may conflict with the fbt plugin and are not yet supported', + loc: node.loc ?? GeneratedSource, + suggestions: null, + }), + ); } if (node.name === 'this') { - CompilerError.throwDiagnostic({ - category: ErrorCategory.UnsupportedSyntax, - reason: '`this` is not supported syntax', - description: - 'React Compiler does not support compiling functions that use `this`', - details: [ - { - kind: 'error', - message: '`this` was used here', - loc: node.loc ?? GeneratedSource, - }, - ], - }); + this.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.UnsupportedSyntax, + reason: '`this` is not supported syntax', + description: + 'React Compiler does not support compiling functions that use `this`', + loc: node.loc ?? GeneratedSource, + suggestions: null, + }), + ); } const originalName = node.name; let name = originalName; @@ -381,12 +383,15 @@ export default class HIRBuilder { instr => instr.value.kind === 'FunctionExpression', ) ) { - CompilerError.throwTodo({ - reason: `Support functions with unreachable code that may contain hoisted declarations`, - loc: block.instructions[0]?.loc ?? block.terminal.loc, - description: null, - suggestions: null, - }); + this.recordError( + new CompilerErrorDetail({ + reason: `Support functions with unreachable code that may contain hoisted declarations`, + loc: block.instructions[0]?.loc ?? block.terminal.loc, + description: null, + suggestions: null, + category: ErrorCategory.Todo, + }), + ); } } ir.blocks = rpoBlocks; diff --git a/compiler/packages/babel-plugin-react-compiler/src/Inference/AnalyseFunctions.ts b/compiler/packages/babel-plugin-react-compiler/src/Inference/AnalyseFunctions.ts index 77a2bdcde596..09637dc3af18 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Inference/AnalyseFunctions.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Inference/AnalyseFunctions.ts @@ -54,7 +54,7 @@ function lowerWithMutationAliasing(fn: HIRFunction): void { deadCodeElimination(fn); const functionEffects = inferMutationAliasingRanges(fn, { isFunctionExpression: true, - }).unwrap(); + }); rewriteInstructionKindsBasedOnReassignment(fn); inferReactiveScopeVariables(fn); fn.aliasingEffects = functionEffects; diff --git a/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts b/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts index a6d680755c72..90acd83ea59f 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts @@ -31,7 +31,6 @@ import { makeInstructionId, } from '../HIR'; import {createTemporaryPlace, markInstructionIds} from '../HIR/HIRBuilder'; -import {Result} from '../Utils/Result'; type ManualMemoCallee = { kind: 'useMemo' | 'useCallback'; @@ -294,7 +293,7 @@ function extractManualMemoizationArgs( instr: TInstruction | TInstruction, kind: 'useCallback' | 'useMemo', sidemap: IdentifierSidemap, - errors: CompilerError, + env: Environment, ): { fnPlace: Place; depsList: Array | null; @@ -304,7 +303,7 @@ function extractManualMemoizationArgs( Place | SpreadPattern | undefined >; if (fnPlace == null || fnPlace.kind !== 'Identifier') { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: `Expected a callback function to be passed to ${kind}`, @@ -336,7 +335,7 @@ function extractManualMemoizationArgs( ? sidemap.maybeDepsLists.get(depsListPlace.identifier.id) : null; if (maybeDepsList == null) { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: `Expected the dependency list for ${kind} to be an array literal`, @@ -355,7 +354,7 @@ function extractManualMemoizationArgs( for (const dep of maybeDepsList.deps) { const maybeDep = sidemap.maybeDeps.get(dep.identifier.id); if (maybeDep == null) { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: `Expected the dependency list to be an array of simple expressions (e.g. \`x\`, \`x.y.z\`, \`x?.y?.z\`)`, @@ -389,10 +388,7 @@ function extractManualMemoizationArgs( * This pass also validates that useMemo callbacks return a value (not void), ensuring that useMemo * is only used for memoizing values and not for running arbitrary side effects. */ -export function dropManualMemoization( - func: HIRFunction, -): Result { - const errors = new CompilerError(); +export function dropManualMemoization(func: HIRFunction): void { const isValidationEnabled = func.env.config.validatePreserveExistingMemoizationGuarantees || func.env.config.validateNoSetStateInRender || @@ -439,7 +435,7 @@ export function dropManualMemoization( instr as TInstruction | TInstruction, manualMemo.kind, sidemap, - errors, + func.env, ); if (memoDetails == null) { @@ -467,7 +463,7 @@ export function dropManualMemoization( * is rare and likely sketchy. */ if (!sidemap.functions.has(fnPlace.identifier.id)) { - errors.pushDiagnostic( + func.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: `Expected the first argument to be an inline function expression`, @@ -552,8 +548,6 @@ export function dropManualMemoization( markInstructionIds(func.body); } } - - return errors.asResult(); } function findOptionalPlaces(fn: HIRFunction): Set { diff --git a/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts b/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts index 0fb2cf9823c7..1b2a72271127 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts @@ -45,7 +45,7 @@ import { eachTerminalOperand, eachTerminalSuccessor, } from '../HIR/visitors'; -import {Ok, Result} from '../Utils/Result'; + import { assertExhaustive, getOrInsertDefault, @@ -100,7 +100,7 @@ export function inferMutationAliasingEffects( {isFunctionExpression}: {isFunctionExpression: boolean} = { isFunctionExpression: false, }, -): Result { +): void { const initialState = InferenceState.empty(fn.env, isFunctionExpression); // Map of blocks to the last (merged) incoming state that was processed @@ -220,7 +220,7 @@ export function inferMutationAliasingEffects( } } } - return Ok(undefined); + return; } function findHoistedContextDeclarations( diff --git a/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingRanges.ts b/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingRanges.ts index b8c5eeaa8e23..6d584806a4f3 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingRanges.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingRanges.ts @@ -20,13 +20,14 @@ import { Place, isPrimitiveType, } from '../HIR/HIR'; +import {Environment} from '../HIR/Environment'; import { eachInstructionLValue, eachInstructionValueOperand, eachTerminalOperand, } from '../HIR/visitors'; import {assertExhaustive, getOrInsertWith} from '../Utils/utils'; -import {Err, Ok, Result} from '../Utils/Result'; + import {AliasingEffect, MutationReason} from './AliasingEffects'; /** @@ -74,7 +75,7 @@ import {AliasingEffect, MutationReason} from './AliasingEffects'; export function inferMutationAliasingRanges( fn: HIRFunction, {isFunctionExpression}: {isFunctionExpression: boolean}, -): Result, CompilerError> { +): Array { // The set of externally-visible effects const functionEffects: Array = []; @@ -107,7 +108,7 @@ export function inferMutationAliasingRanges( let index = 0; - const errors = new CompilerError(); + const shouldRecordErrors = !isFunctionExpression && fn.env.enableValidations; for (const param of [...fn.params, ...fn.context, fn.returns]) { const place = param.kind === 'Identifier' ? param : param.place; @@ -200,7 +201,9 @@ export function inferMutationAliasingRanges( effect.kind === 'MutateGlobal' || effect.kind === 'Impure' ) { - errors.pushDiagnostic(effect.error); + if (shouldRecordErrors) { + fn.env.recordError(effect.error); + } functionEffects.push(effect); } else if (effect.kind === 'Render') { renders.push({index: index++, place: effect.place}); @@ -245,11 +248,15 @@ export function inferMutationAliasingRanges( mutation.kind, mutation.place.loc, mutation.reason, - errors, + shouldRecordErrors ? fn.env : null, ); } for (const render of renders) { - state.render(render.index, render.place.identifier, errors); + state.render( + render.index, + render.place.identifier, + shouldRecordErrors ? fn.env : null, + ); } for (const param of [...fn.context, ...fn.params]) { const place = param.kind === 'Identifier' ? param : param.place; @@ -498,7 +505,6 @@ export function inferMutationAliasingRanges( * would be transitively mutated needs a capture relationship. */ const tracked: Array = []; - const ignoredErrors = new CompilerError(); for (const param of [...fn.params, ...fn.context, fn.returns]) { const place = param.kind === 'Identifier' ? param : param.place; tracked.push(place); @@ -513,7 +519,7 @@ export function inferMutationAliasingRanges( MutationKind.Conditional, into.loc, null, - ignoredErrors, + null, ); for (const from of tracked) { if ( @@ -547,19 +553,17 @@ export function inferMutationAliasingRanges( } } - if (errors.hasAnyErrors() && !isFunctionExpression) { - return Err(errors); - } - return Ok(functionEffects); + return functionEffects; } -function appendFunctionErrors(errors: CompilerError, fn: HIRFunction): void { +function appendFunctionErrors(env: Environment | null, fn: HIRFunction): void { + if (env == null) return; for (const effect of fn.aliasingEffects ?? []) { switch (effect.kind) { case 'Impure': case 'MutateFrozen': case 'MutateGlobal': { - errors.pushDiagnostic(effect.error); + env.recordError(effect.error); break; } } @@ -660,7 +664,7 @@ class AliasingState { } } - render(index: number, start: Identifier, errors: CompilerError): void { + render(index: number, start: Identifier, env: Environment | null): void { const seen = new Set(); const queue: Array = [start]; while (queue.length !== 0) { @@ -674,7 +678,7 @@ class AliasingState { continue; } if (node.value.kind === 'Function') { - appendFunctionErrors(errors, node.value.function); + appendFunctionErrors(env, node.value.function); } for (const [alias, when] of node.createdFrom) { if (when >= index) { @@ -706,7 +710,7 @@ class AliasingState { startKind: MutationKind, loc: SourceLocation, reason: MutationReason | null, - errors: CompilerError, + env: Environment | null, ): void { const seen = new Map(); const queue: Array<{ @@ -738,7 +742,7 @@ class AliasingState { node.transitive == null && node.local == null ) { - appendFunctionErrors(errors, node.value.function); + appendFunctionErrors(env, node.value.function); } if (transitive) { if (node.transitive == null || node.transitive.kind < kind) { diff --git a/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/BuildReactiveFunction.ts b/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/BuildReactiveFunction.ts index f5b2a654ec4f..f53f7d15e0cb 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/BuildReactiveFunction.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/BuildReactiveFunction.ts @@ -1007,11 +1007,10 @@ class Driver { const test = this.visitValueBlock(testBlockId, loc); const testBlock = this.cx.ir.blocks.get(test.block)!; if (testBlock.terminal.kind !== 'branch') { - CompilerError.throwTodo({ - reason: `Unexpected terminal kind \`${testBlock.terminal.kind}\` for ${terminalKind} test block`, - description: null, + CompilerError.invariant(false, { + reason: `Expected a branch terminal for ${terminalKind} test block`, + description: `Got \`${testBlock.terminal.kind}\``, loc: testBlock.terminal.loc, - suggestions: null, }); } return { diff --git a/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/CodegenReactiveFunction.ts b/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/CodegenReactiveFunction.ts index c44e3b83fefd..486773d5eb91 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/CodegenReactiveFunction.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/CodegenReactiveFunction.ts @@ -13,7 +13,11 @@ import { pruneUnusedLabels, renameVariables, } from '.'; -import {CompilerError, ErrorCategory} from '../CompilerError'; +import { + CompilerError, + CompilerErrorDetail, + ErrorCategory, +} from '../CompilerError'; import {Environment, ExternalFunction} from '../HIR'; import { ArrayPattern, @@ -46,7 +50,7 @@ import { } from '../HIR/HIR'; import {printIdentifier, printInstruction, printPlace} from '../HIR/PrintHIR'; import {eachPatternOperand} from '../HIR/visitors'; -import {Err, Ok, Result} from '../Utils/Result'; + import {GuardKind} from '../Utils/RuntimeDiagnosticConstants'; import {assertExhaustive} from '../Utils/utils'; import {buildReactiveFunction} from './BuildReactiveFunction'; @@ -111,7 +115,7 @@ export function codegenFunction( uniqueIdentifiers: Set; fbtOperands: Set; }, -): Result { +): CodegenFunction { const cx = new Context( fn.env, fn.id ?? '[[ anonymous ]]', @@ -141,11 +145,7 @@ export function codegenFunction( }; } - const compileResult = codegenReactiveFunction(cx, fn); - if (compileResult.isErr()) { - return compileResult; - } - const compiled = compileResult.unwrap(); + const compiled = codegenReactiveFunction(cx, fn); const hookGuard = fn.env.config.enableEmitHookGuards; if (hookGuard != null && fn.env.outputMode === 'client') { @@ -273,7 +273,7 @@ export function codegenFunction( emitInstrumentForget.globalGating, ); if (assertResult.isErr()) { - return assertResult; + fn.env.recordErrors(assertResult.unwrapErr()); } } @@ -323,20 +323,17 @@ export function codegenFunction( ), reactiveFunction, ); - if (codegen.isErr()) { - return codegen; - } - outlined.push({fn: codegen.unwrap(), type}); + outlined.push({fn: codegen, type}); } compiled.outlined = outlined; - return compileResult; + return compiled; } function codegenReactiveFunction( cx: Context, fn: ReactiveFunction, -): Result { +): CodegenFunction { for (const param of fn.params) { const place = param.kind === 'Identifier' ? param : param.place; cx.temp.set(place.identifier.declarationId, null); @@ -354,14 +351,10 @@ function codegenReactiveFunction( } } - if (cx.errors.hasAnyErrors()) { - return Err(cx.errors); - } - const countMemoBlockVisitor = new CountMemoBlockVisitor(fn.env); visitReactiveFunction(fn, countMemoBlockVisitor, undefined); - return Ok({ + return { type: 'CodegenFunction', loc: fn.loc, id: fn.id !== null ? t.identifier(fn.id) : null, @@ -376,7 +369,7 @@ function codegenReactiveFunction( prunedMemoBlocks: countMemoBlockVisitor.prunedMemoBlocks, prunedMemoValues: countMemoBlockVisitor.prunedMemoValues, outlined: [], - }); + }; } class CountMemoBlockVisitor extends ReactiveFunctionVisitor { @@ -427,7 +420,6 @@ class Context { */ #declarations: Set = new Set(); temp: Temporaries; - errors: CompilerError = new CompilerError(); objectMethods: Map = new Map(); uniqueIdentifiers: Set; fbtOperands: Set; @@ -446,6 +438,11 @@ class Context { this.fbtOperands = fbtOperands; this.temp = temporaries !== null ? new Map(temporaries) : new Map(); } + + recordError(error: CompilerErrorDetail): void { + this.env.recordError(error); + } + get nextCacheIndex(): number { return this.#nextCacheIndex++; } @@ -782,12 +779,15 @@ function codegenTerminal( loc: terminal.init.loc, }); if (terminal.init.instructions.length !== 2) { - CompilerError.throwTodo({ - reason: 'Support non-trivial for..in inits', - description: null, - loc: terminal.init.loc, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: 'Support non-trivial for..in inits', + category: ErrorCategory.Todo, + loc: terminal.init.loc, + suggestions: null, + }), + ); + return t.emptyStatement(); } const iterableCollection = terminal.init.instructions[0]; const iterableItem = terminal.init.instructions[1]; @@ -802,12 +802,15 @@ function codegenTerminal( break; } case 'StoreContext': { - CompilerError.throwTodo({ - reason: 'Support non-trivial for..in inits', - description: null, - loc: terminal.init.loc, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: 'Support non-trivial for..in inits', + category: ErrorCategory.Todo, + loc: terminal.init.loc, + suggestions: null, + }), + ); + return t.emptyStatement(); } default: CompilerError.invariant(false, { @@ -877,12 +880,15 @@ function codegenTerminal( loc: terminal.test.loc, }); if (terminal.test.instructions.length !== 2) { - CompilerError.throwTodo({ - reason: 'Support non-trivial for..of inits', - description: null, - loc: terminal.init.loc, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: 'Support non-trivial for..of inits', + category: ErrorCategory.Todo, + loc: terminal.init.loc, + suggestions: null, + }), + ); + return t.emptyStatement(); } const iterableItem = terminal.test.instructions[1]; let lval: t.LVal; @@ -896,12 +902,15 @@ function codegenTerminal( break; } case 'StoreContext': { - CompilerError.throwTodo({ - reason: 'Support non-trivial for..of inits', - description: null, - loc: terminal.init.loc, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: 'Support non-trivial for..of inits', + category: ErrorCategory.Todo, + loc: terminal.init.loc, + suggestions: null, + }), + ); + return t.emptyStatement(); } default: CompilerError.invariant(false, { @@ -1665,7 +1674,7 @@ function codegenInstructionValue( cx.temp, ), reactiveFunction, - ).unwrap(); + ); /* * ObjectMethod builder must be backwards compatible with older versions of babel. @@ -1864,7 +1873,7 @@ function codegenInstructionValue( cx.temp, ), reactiveFunction, - ).unwrap(); + ); if (instrValue.type === 'ArrowFunctionExpression') { let body: t.BlockStatement | t.Expression = fn.body; @@ -1960,22 +1969,26 @@ function codegenInstructionValue( } else { if (t.isVariableDeclaration(stmt)) { const declarator = stmt.declarations[0]; - cx.errors.push({ - reason: `(CodegenReactiveFunction::codegenInstructionValue) Cannot declare variables in a value block, tried to declare '${ - (declarator.id as t.Identifier).name - }'`, - category: ErrorCategory.Todo, - loc: declarator.loc ?? null, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: `(CodegenReactiveFunction::codegenInstructionValue) Cannot declare variables in a value block, tried to declare '${ + (declarator.id as t.Identifier).name + }'`, + category: ErrorCategory.Todo, + loc: declarator.loc ?? null, + suggestions: null, + }), + ); return t.stringLiteral(`TODO handle ${declarator.id}`); } else { - cx.errors.push({ - reason: `(CodegenReactiveFunction::codegenInstructionValue) Handle conversion of ${stmt.type} to expression`, - category: ErrorCategory.Todo, - loc: stmt.loc ?? null, - suggestions: null, - }); + cx.recordError( + new CompilerErrorDetail({ + reason: `(CodegenReactiveFunction::codegenInstructionValue) Handle conversion of ${stmt.type} to expression`, + category: ErrorCategory.Todo, + loc: stmt.loc ?? null, + suggestions: null, + }), + ); return t.stringLiteral(`TODO handle ${stmt.type}`); } } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateContextVariableLValues.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateContextVariableLValues.ts index a0d14ab16ba4..933a10f5c676 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateContextVariableLValues.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateContextVariableLValues.ts @@ -5,7 +5,9 @@ * LICENSE file in the root directory of this source tree. */ -import {CompilerError} from '..'; +import {CompilerDiagnostic, CompilerError} from '..'; +import {ErrorCategory} from '../CompilerError'; +import {Environment} from '../HIR/Environment'; import {HIRFunction, IdentifierId, Place} from '../HIR'; import {printPlace} from '../HIR/PrintHIR'; import {eachInstructionValueLValue, eachPatternOperand} from '../HIR/visitors'; @@ -17,12 +19,13 @@ import {eachInstructionValueLValue, eachPatternOperand} from '../HIR/visitors'; */ export function validateContextVariableLValues(fn: HIRFunction): void { const identifierKinds: IdentifierKinds = new Map(); - validateContextVariableLValuesImpl(fn, identifierKinds); + validateContextVariableLValuesImpl(fn, identifierKinds, fn.env); } function validateContextVariableLValuesImpl( fn: HIRFunction, identifierKinds: IdentifierKinds, + env: Environment, ): void { for (const [, block] of fn.body.blocks) { for (const instr of block.instructions) { @@ -30,30 +33,30 @@ function validateContextVariableLValuesImpl( switch (value.kind) { case 'DeclareContext': case 'StoreContext': { - visit(identifierKinds, value.lvalue.place, 'context'); + visit(identifierKinds, value.lvalue.place, 'context', env); break; } case 'LoadContext': { - visit(identifierKinds, value.place, 'context'); + visit(identifierKinds, value.place, 'context', env); break; } case 'StoreLocal': case 'DeclareLocal': { - visit(identifierKinds, value.lvalue.place, 'local'); + visit(identifierKinds, value.lvalue.place, 'local', env); break; } case 'LoadLocal': { - visit(identifierKinds, value.place, 'local'); + visit(identifierKinds, value.place, 'local', env); break; } case 'PostfixUpdate': case 'PrefixUpdate': { - visit(identifierKinds, value.lvalue, 'local'); + visit(identifierKinds, value.lvalue, 'local', env); break; } case 'Destructure': { for (const lvalue of eachPatternOperand(value.lvalue.pattern)) { - visit(identifierKinds, lvalue, 'destructure'); + visit(identifierKinds, lvalue, 'destructure', env); } break; } @@ -62,18 +65,24 @@ function validateContextVariableLValuesImpl( validateContextVariableLValuesImpl( value.loweredFunc.func, identifierKinds, + env, ); break; } default: { for (const _ of eachInstructionValueLValue(value)) { - CompilerError.throwTodo({ - reason: - 'ValidateContextVariableLValues: unhandled instruction variant', - loc: value.loc, - description: `Handle '${value.kind} lvalues`, - suggestions: null, - }); + fn.env.recordError( + CompilerDiagnostic.create({ + category: ErrorCategory.Todo, + reason: + 'ValidateContextVariableLValues: unhandled instruction variant', + description: `Handle '${value.kind} lvalues`, + }).withDetails({ + kind: 'error', + loc: value.loc, + message: null, + }), + ); } } } @@ -90,6 +99,7 @@ function visit( identifiers: IdentifierKinds, place: Place, kind: 'local' | 'context' | 'destructure', + env: Environment, ): void { const prev = identifiers.get(place.identifier.id); if (prev !== undefined) { @@ -97,12 +107,18 @@ function visit( const isContext = kind === 'context'; if (wasContext !== isContext) { if (prev.kind === 'destructure' || kind === 'destructure') { - CompilerError.throwTodo({ - reason: `Support destructuring of context variables`, - loc: kind === 'destructure' ? place.loc : prev.place.loc, - description: null, - suggestions: null, - }); + env.recordError( + CompilerDiagnostic.create({ + category: ErrorCategory.Todo, + reason: `Support destructuring of context variables`, + description: null, + }).withDetails({ + kind: 'error', + loc: kind === 'destructure' ? place.loc : prev.place.loc, + message: null, + }), + ); + return; } CompilerError.invariant(false, { diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts index 54aacb45c9ec..e8a64a624aad 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateExhaustiveDependencies.ts @@ -44,7 +44,6 @@ import { eachInstructionValueOperand, eachTerminalOperand, } from '../HIR/visitors'; -import {Result} from '../Utils/Result'; import {retainWhere} from '../Utils/utils'; const DEBUG = false; @@ -88,9 +87,7 @@ const DEBUG = false; * When we go to compute the dependencies, we then think that the user's manual dep * logic is part of what the memo computation logic. */ -export function validateExhaustiveDependencies( - fn: HIRFunction, -): Result { +export function validateExhaustiveDependencies(fn: HIRFunction): void { const env = fn.env; const reactive = collectReactiveIdentifiersHIR(fn); @@ -105,7 +102,6 @@ export function validateExhaustiveDependencies( loc: place.loc, }); } - const error = new CompilerError(); let startMemo: StartMemoize | null = null; function onStartMemoize( @@ -146,7 +142,7 @@ export function validateExhaustiveDependencies( 'all', ); if (diagnostic != null) { - error.pushDiagnostic(diagnostic); + fn.env.recordError(diagnostic); } } @@ -211,13 +207,12 @@ export function validateExhaustiveDependencies( effectReportMode, ); if (diagnostic != null) { - error.pushDiagnostic(diagnostic); + fn.env.recordError(diagnostic); } }, }, false, // isFunctionExpression ); - return error.asResult(); } function validateDependencies( diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateHooksUsage.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateHooksUsage.ts index 7259041ec29a..a243929ddefd 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateHooksUsage.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateHooksUsage.ts @@ -6,13 +6,9 @@ */ import * as t from '@babel/types'; -import { - CompilerError, - CompilerErrorDetail, - ErrorCategory, -} from '../CompilerError'; +import {CompilerErrorDetail, ErrorCategory} from '../CompilerError'; import {computeUnconditionalBlocks} from '../HIR/ComputeUnconditionalBlocks'; -import {isHookName} from '../HIR/Environment'; +import {Environment, isHookName} from '../HIR/Environment'; import { HIRFunction, IdentifierId, @@ -26,7 +22,6 @@ import { eachTerminalOperand, } from '../HIR/visitors'; import {assertExhaustive} from '../Utils/utils'; -import {Result} from '../Utils/Result'; /** * Represents the possible kinds of value which may be stored at a given Place during @@ -88,20 +83,17 @@ function joinKinds(a: Kind, b: Kind): Kind { * may not appear as the callee of a conditional call. * See the note for Kind.PotentialHook for sources of potential hooks */ -export function validateHooksUsage( - fn: HIRFunction, -): Result { +export function validateHooksUsage(fn: HIRFunction): void { const unconditionalBlocks = computeUnconditionalBlocks(fn); - const errors = new CompilerError(); const errorsByPlace = new Map(); - function recordError( + function trackError( loc: SourceLocation, errorDetail: CompilerErrorDetail, ): void { if (typeof loc === 'symbol') { - errors.pushErrorDetail(errorDetail); + fn.env.recordError(errorDetail); } else { errorsByPlace.set(loc, errorDetail); } @@ -121,7 +113,7 @@ export function validateHooksUsage( * If that same place is also used as a conditional call, upgrade the error to a conditonal hook error */ if (previousError === undefined || previousError.reason !== reason) { - recordError( + trackError( place.loc, new CompilerErrorDetail({ category: ErrorCategory.Hooks, @@ -137,7 +129,7 @@ export function validateHooksUsage( const previousError = typeof place.loc !== 'symbol' ? errorsByPlace.get(place.loc) : undefined; if (previousError === undefined) { - recordError( + trackError( place.loc, new CompilerErrorDetail({ category: ErrorCategory.Hooks, @@ -154,7 +146,7 @@ export function validateHooksUsage( const previousError = typeof place.loc !== 'symbol' ? errorsByPlace.get(place.loc) : undefined; if (previousError === undefined) { - recordError( + trackError( place.loc, new CompilerErrorDetail({ category: ErrorCategory.Hooks, @@ -399,7 +391,7 @@ export function validateHooksUsage( } case 'ObjectMethod': case 'FunctionExpression': { - visitFunctionExpression(errors, instr.value.loweredFunc.func); + visitFunctionExpression(fn.env, instr.value.loweredFunc.func); break; } default: { @@ -424,18 +416,17 @@ export function validateHooksUsage( } for (const [, error] of errorsByPlace) { - errors.pushErrorDetail(error); + fn.env.recordError(error); } - return errors.asResult(); } -function visitFunctionExpression(errors: CompilerError, fn: HIRFunction): void { +function visitFunctionExpression(env: Environment, fn: HIRFunction): void { for (const [, block] of fn.body.blocks) { for (const instr of block.instructions) { switch (instr.value.kind) { case 'ObjectMethod': case 'FunctionExpression': { - visitFunctionExpression(errors, instr.value.loweredFunc.func); + visitFunctionExpression(env, instr.value.loweredFunc.func); break; } case 'MethodCall': @@ -446,7 +437,7 @@ function visitFunctionExpression(errors: CompilerError, fn: HIRFunction): void { : instr.value.property; const hookKind = getHookKind(fn.env, callee.identifier); if (hookKind != null) { - errors.pushErrorDetail( + env.recordError( new CompilerErrorDetail({ category: ErrorCategory.Hooks, reason: diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateLocalsNotReassignedAfterRender.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateLocalsNotReassignedAfterRender.ts index 0bdb48357005..77b921512aa1 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateLocalsNotReassignedAfterRender.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateLocalsNotReassignedAfterRender.ts @@ -7,6 +7,7 @@ import {CompilerDiagnostic, CompilerError, Effect} from '..'; import {ErrorCategory} from '../CompilerError'; +import {Environment} from '../HIR/Environment'; import {HIRFunction, IdentifierId, Place} from '../HIR'; import { eachInstructionLValue, @@ -27,15 +28,15 @@ export function validateLocalsNotReassignedAfterRender(fn: HIRFunction): void { contextVariables, false, false, + fn.env, ); if (reassignment !== null) { - const errors = new CompilerError(); const variable = reassignment.identifier.name != null && reassignment.identifier.name.kind === 'named' ? `\`${reassignment.identifier.name.value}\`` : 'variable'; - errors.pushDiagnostic( + fn.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Immutability, reason: 'Cannot reassign variable after render completes', @@ -46,7 +47,6 @@ export function validateLocalsNotReassignedAfterRender(fn: HIRFunction): void { message: `Cannot reassign ${variable} after render completes`, }), ); - throw errors; } } @@ -55,6 +55,7 @@ function getContextReassignment( contextVariables: Set, isFunctionExpression: boolean, isAsync: boolean, + env: Environment, ): Place | null { const reassigningFunctions = new Map(); for (const [, block] of fn.body.blocks) { @@ -68,6 +69,7 @@ function getContextReassignment( contextVariables, true, isAsync || value.loweredFunc.func.async, + env, ); if (reassignment === null) { // If the function itself doesn't reassign, does one of its dependencies? @@ -84,13 +86,12 @@ function getContextReassignment( // if the function or its depends reassign, propagate that fact on the lvalue if (reassignment !== null) { if (isAsync || value.loweredFunc.func.async) { - const errors = new CompilerError(); const variable = reassignment.identifier.name !== null && reassignment.identifier.name.kind === 'named' ? `\`${reassignment.identifier.name.value}\`` : 'variable'; - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Immutability, reason: 'Cannot reassign variable in async function', @@ -102,7 +103,7 @@ function getContextReassignment( message: `Cannot reassign ${variable}`, }), ); - throw errors; + return null; } reassigningFunctions.set(lvalue.identifier.id, reassignment); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoCapitalizedCalls.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoCapitalizedCalls.ts index db8e454f4c1d..c0c6b6d9f9af 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoCapitalizedCalls.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoCapitalizedCalls.ts @@ -5,15 +5,12 @@ * LICENSE file in the root directory of this source tree. */ -import {CompilerError, EnvironmentConfig} from '..'; +import {CompilerErrorDetail, EnvironmentConfig} from '..'; import {ErrorCategory} from '../CompilerError'; import {HIRFunction, IdentifierId} from '../HIR'; import {DEFAULT_GLOBALS} from '../HIR/Globals'; -import {Result} from '../Utils/Result'; -export function validateNoCapitalizedCalls( - fn: HIRFunction, -): Result { +export function validateNoCapitalizedCalls(fn: HIRFunction): void { const envConfig: EnvironmentConfig = fn.env.config; const ALLOW_LIST = new Set([ ...DEFAULT_GLOBALS.keys(), @@ -23,7 +20,6 @@ export function validateNoCapitalizedCalls( return ALLOW_LIST.has(name); }; - const errors = new CompilerError(); const capitalLoadGlobals = new Map(); const capitalizedProperties = new Map(); const reason = @@ -48,13 +44,16 @@ export function validateNoCapitalizedCalls( const calleeIdentifier = value.callee.identifier.id; const calleeName = capitalLoadGlobals.get(calleeIdentifier); if (calleeName != null) { - CompilerError.throwInvalidReact({ - category: ErrorCategory.CapitalizedCalls, - reason, - description: `${calleeName} may be a component`, - loc: value.loc, - suggestions: null, - }); + fn.env.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.CapitalizedCalls, + reason, + description: `${calleeName} may be a component`, + loc: value.loc, + suggestions: null, + }), + ); + continue; } break; } @@ -72,18 +71,19 @@ export function validateNoCapitalizedCalls( const propertyIdentifier = value.property.identifier.id; const propertyName = capitalizedProperties.get(propertyIdentifier); if (propertyName != null) { - errors.push({ - category: ErrorCategory.CapitalizedCalls, - reason, - description: `${propertyName} may be a component`, - loc: value.loc, - suggestions: null, - }); + fn.env.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.CapitalizedCalls, + reason, + description: `${propertyName} may be a component`, + loc: value.loc, + suggestions: null, + }), + ); } break; } } } } - return errors.asResult(); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoDerivedComputationsInEffects.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoDerivedComputationsInEffects.ts index a80f1efc636e..380f24433178 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoDerivedComputationsInEffects.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoDerivedComputationsInEffects.ts @@ -6,7 +6,7 @@ */ import {CompilerError, SourceLocation} from '..'; -import {ErrorCategory} from '../CompilerError'; +import {CompilerErrorDetail, ErrorCategory} from '../CompilerError'; import { ArrayExpression, BlockId, @@ -20,6 +20,7 @@ import { eachInstructionValueOperand, eachTerminalOperand, } from '../HIR/visitors'; +import {Environment} from '../HIR/Environment'; /** * Validates that useEffect is not used for derived computations which could/should @@ -49,8 +50,6 @@ export function validateNoDerivedComputationsInEffects(fn: HIRFunction): void { const functions: Map = new Map(); const locals: Map = new Map(); - const errors = new CompilerError(); - for (const block of fn.body.blocks.values()) { for (const instr of block.instructions) { const {lvalue, value} = instr; @@ -90,22 +89,19 @@ export function validateNoDerivedComputationsInEffects(fn: HIRFunction): void { validateEffect( effectFunction.loweredFunc.func, dependencies, - errors, + fn.env, ); } } } } } - if (errors.hasAnyErrors()) { - throw errors; - } } function validateEffect( effectFunction: HIRFunction, effectDeps: Array, - errors: CompilerError, + env: Environment, ): void { for (const operand of effectFunction.context) { if (isSetStateType(operand.identifier)) { @@ -219,13 +215,15 @@ function validateEffect( } for (const loc of setStateLocations) { - errors.push({ - category: ErrorCategory.EffectDerivationsOfState, - reason: - 'Values derived from props and state should be calculated during render, not in an effect. (https://react.dev/learn/you-might-not-need-an-effect#updating-state-based-on-props-or-state)', - description: null, - loc, - suggestions: null, - }); + env.recordError( + new CompilerErrorDetail({ + category: ErrorCategory.EffectDerivationsOfState, + reason: + 'Values derived from props and state should be calculated during render, not in an effect. (https://react.dev/learn/you-might-not-need-an-effect#updating-state-based-on-props-or-state)', + description: null, + loc, + suggestions: null, + }), + ); } } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoFreezingKnownMutableFunctions.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoFreezingKnownMutableFunctions.ts index 0c5b5a9a3193..3fc28ffb9e76 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoFreezingKnownMutableFunctions.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoFreezingKnownMutableFunctions.ts @@ -5,7 +5,7 @@ * LICENSE file in the root directory of this source tree. */ -import {CompilerDiagnostic, CompilerError, Effect} from '..'; +import {CompilerDiagnostic, Effect} from '..'; import {ErrorCategory} from '../CompilerError'; import { HIRFunction, @@ -18,7 +18,6 @@ import { eachTerminalOperand, } from '../HIR/visitors'; import {AliasingEffect} from '../Inference/AliasingEffects'; -import {Result} from '../Utils/Result'; /** * Validates that functions with known mutations (ie due to types) cannot be passed @@ -43,10 +42,7 @@ import {Result} from '../Utils/Result'; * This pass detects functions with *known* mutations (Store or Mutate, not ConditionallyMutate) * that are passed where a frozen value is expected and rejects them. */ -export function validateNoFreezingKnownMutableFunctions( - fn: HIRFunction, -): Result { - const errors = new CompilerError(); +export function validateNoFreezingKnownMutableFunctions(fn: HIRFunction): void { const contextMutationEffects: Map< IdentifierId, Extract @@ -63,7 +59,7 @@ export function validateNoFreezingKnownMutableFunctions( place.identifier.name.kind === 'named' ? `\`${place.identifier.name.value}\`` : 'a local variable'; - errors.pushDiagnostic( + fn.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Immutability, reason: 'Cannot modify local variables after render completes', @@ -162,5 +158,4 @@ export function validateNoFreezingKnownMutableFunctions( visitOperand(operand); } } - return errors.asResult(); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoImpureFunctionsInRender.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoImpureFunctionsInRender.ts index ca0612d80ce2..ba089fbd1bc4 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoImpureFunctionsInRender.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoImpureFunctionsInRender.ts @@ -5,11 +5,10 @@ * LICENSE file in the root directory of this source tree. */ -import {CompilerDiagnostic, CompilerError} from '..'; +import {CompilerDiagnostic} from '..'; import {ErrorCategory} from '../CompilerError'; import {HIRFunction} from '../HIR'; import {getFunctionCallSignature} from '../Inference/InferMutationAliasingEffects'; -import {Result} from '../Utils/Result'; /** * Checks that known-impure functions are not called during render. Examples of invalid functions to @@ -20,10 +19,7 @@ import {Result} from '../Utils/Result'; * this in several of our validation passes and should unify those analyses into a reusable helper * and use it here. */ -export function validateNoImpureFunctionsInRender( - fn: HIRFunction, -): Result { - const errors = new CompilerError(); +export function validateNoImpureFunctionsInRender(fn: HIRFunction): void { for (const [, block] of fn.body.blocks) { for (const instr of block.instructions) { const value = instr.value; @@ -35,7 +31,7 @@ export function validateNoImpureFunctionsInRender( callee.identifier.type, ); if (signature != null && signature.impure === true) { - errors.pushDiagnostic( + fn.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Purity, reason: 'Cannot call impure function during render', @@ -55,5 +51,4 @@ export function validateNoImpureFunctionsInRender( } } } - return errors.asResult(); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoRefAccessInRender.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoRefAccessInRender.ts index 97ac4b31d291..c49c51024bc9 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoRefAccessInRender.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoRefAccessInRender.ts @@ -27,7 +27,6 @@ import { eachPatternOperand, eachTerminalOperand, } from '../HIR/visitors'; -import {Err, Ok, Result} from '../Utils/Result'; import {retainWhere} from '../Utils/utils'; /** @@ -120,12 +119,14 @@ class Env { } } -export function validateNoRefAccessInRender( - fn: HIRFunction, -): Result { +export function validateNoRefAccessInRender(fn: HIRFunction): void { const env = new Env(); collectTemporariesSidemap(fn, env); - return validateNoRefAccessInRenderImpl(fn, env).map(_ => undefined); + const errors = new CompilerError(); + validateNoRefAccessInRenderImpl(fn, env, errors); + for (const detail of errors.details) { + fn.env.recordError(detail); + } } function collectTemporariesSidemap(fn: HIRFunction, env: Env): void { @@ -305,7 +306,8 @@ function joinRefAccessTypes(...types: Array): RefAccessType { function validateNoRefAccessInRenderImpl( fn: HIRFunction, env: Env, -): Result { + errors: CompilerError, +): RefAccessType { let returnValues: Array = []; let place; for (const param of fn.params) { @@ -336,7 +338,6 @@ function validateNoRefAccessInRenderImpl( env.resetChanged(); returnValues = []; const safeBlocks: Array<{block: BlockId; ref: RefId}> = []; - const errors = new CompilerError(); for (const [, block] of fn.body.blocks) { retainWhere(safeBlocks, entry => entry.block !== block.id); for (const phi of block.phis) { @@ -432,13 +433,15 @@ function validateNoRefAccessInRenderImpl( case 'FunctionExpression': { let returnType: RefAccessType = {kind: 'None'}; let readRefEffect = false; + const innerErrors = new CompilerError(); const result = validateNoRefAccessInRenderImpl( instr.value.loweredFunc.func, env, + innerErrors, ); - if (result.isOk()) { - returnType = result.unwrap(); - } else if (result.isErr()) { + if (!innerErrors.hasAnyErrors()) { + returnType = result; + } else { readRefEffect = true; } env.set(instr.lvalue.identifier.id, { @@ -729,7 +732,7 @@ function validateNoRefAccessInRenderImpl( } if (errors.hasAnyErrors()) { - return Err(errors); + return {kind: 'None'}; } } @@ -738,10 +741,8 @@ function validateNoRefAccessInRenderImpl( loc: GeneratedSource, }); - return Ok( - joinRefAccessTypes( - ...returnValues.filter((env): env is RefAccessType => env !== undefined), - ), + return joinRefAccessTypes( + ...returnValues.filter((env): env is RefAccessType => env !== undefined), ); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoSetStateInRender.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoSetStateInRender.ts index 28a1de4235ae..43db75110798 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoSetStateInRender.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoSetStateInRender.ts @@ -13,7 +13,6 @@ import { import {HIRFunction, IdentifierId, isSetStateType} from '../HIR'; import {computeUnconditionalBlocks} from '../HIR/ComputeUnconditionalBlocks'; import {eachInstructionValueOperand} from '../HIR/visitors'; -import {Result} from '../Utils/Result'; /** * Validates that the given function does not have an infinite update loop @@ -43,17 +42,21 @@ import {Result} from '../Utils/Result'; * y(); * ``` */ -export function validateNoSetStateInRender( - fn: HIRFunction, -): Result { +export function validateNoSetStateInRender(fn: HIRFunction): void { const unconditionalSetStateFunctions: Set = new Set(); - return validateNoSetStateInRenderImpl(fn, unconditionalSetStateFunctions); + const errors = validateNoSetStateInRenderImpl( + fn, + unconditionalSetStateFunctions, + ); + for (const detail of errors.details) { + fn.env.recordError(detail); + } } function validateNoSetStateInRenderImpl( fn: HIRFunction, unconditionalSetStateFunctions: Set, -): Result { +): CompilerError { const unconditionalBlocks = computeUnconditionalBlocks(fn); let activeManualMemoId: number | null = null; const errors = new CompilerError(); @@ -92,7 +95,7 @@ function validateNoSetStateInRenderImpl( validateNoSetStateInRenderImpl( instr.value.loweredFunc.func, unconditionalSetStateFunctions, - ).isErr() + ).hasAnyErrors() ) { // This function expression unconditionally calls a setState unconditionalSetStateFunctions.add(instr.lvalue.identifier.id); @@ -183,5 +186,5 @@ function validateNoSetStateInRenderImpl( } } - return errors.asResult(); + return errors; } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidatePreservedManualMemoization.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidatePreservedManualMemoization.ts index 5591a6a29c8d..99085872f48f 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidatePreservedManualMemoization.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidatePreservedManualMemoization.ts @@ -27,6 +27,7 @@ import { ScopeId, SourceLocation, } from '../HIR'; +import {Environment} from '../HIR/Environment'; import {printIdentifier, printManualMemoDependency} from '../HIR/PrintHIR'; import { eachInstructionValueLValue, @@ -37,7 +38,6 @@ import { ReactiveFunctionVisitor, visitReactiveFunction, } from '../ReactiveScopes/visitors'; -import {Result} from '../Utils/Result'; import {getOrInsertDefault} from '../Utils/utils'; /** @@ -47,15 +47,12 @@ import {getOrInsertDefault} from '../Utils/utils'; * This can occur if a value's mutable range somehow extended to include a hook and * was pruned. */ -export function validatePreservedManualMemoization( - fn: ReactiveFunction, -): Result { +export function validatePreservedManualMemoization(fn: ReactiveFunction): void { const state = { - errors: new CompilerError(), + env: fn.env, manualMemoState: null, }; visitReactiveFunction(fn, new Visitor(), state); - return state.errors.asResult(); } const DEBUG = false; @@ -113,7 +110,7 @@ type ManualMemoBlockState = { }; type VisitorState = { - errors: CompilerError; + env: Environment; manualMemoState: ManualMemoBlockState | null; }; @@ -233,7 +230,7 @@ function validateInferredDep( temporaries: Map, declsWithinMemoBlock: Set, validDepsInMemoBlock: Array, - errorState: CompilerError, + env: Environment, memoLocation: SourceLocation, ): void { let normalizedDep: ManualMemoDependency; @@ -283,7 +280,7 @@ function validateInferredDep( errorDiagnostic = merge(errorDiagnostic ?? compareResult, compareResult); } } - errorState.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.PreserveManualMemo, reason: 'Existing memoization could not be preserved', @@ -429,7 +426,7 @@ class Visitor extends ReactiveFunctionVisitor { this.temporaries, state.manualMemoState.decls, state.manualMemoState.depsFromSource, - state.errors, + state.env, state.manualMemoState.loc, ); } @@ -532,7 +529,7 @@ class Visitor extends ReactiveFunctionVisitor { !this.scopes.has(identifier.scope.id) && !this.prunedScopes.has(identifier.scope.id) ) { - state.errors.pushDiagnostic( + state.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.PreserveManualMemo, reason: 'Existing memoization could not be preserved', @@ -578,7 +575,7 @@ class Visitor extends ReactiveFunctionVisitor { for (const identifier of decls) { if (isUnmemoized(identifier, this.scopes)) { - state.errors.pushDiagnostic( + state.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.PreserveManualMemo, reason: 'Existing memoization could not be preserved', diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateSourceLocations.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateSourceLocations.ts index 24804386aac8..50f4c0e16038 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateSourceLocations.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateSourceLocations.ts @@ -7,9 +7,9 @@ import {NodePath} from '@babel/traverse'; import * as t from '@babel/types'; -import {CompilerDiagnostic, CompilerError, ErrorCategory} from '..'; +import {CompilerDiagnostic, ErrorCategory} from '..'; import {CodegenFunction} from '../ReactiveScopes'; -import {Result} from '../Utils/Result'; +import {Environment} from '../HIR/Environment'; /** * IMPORTANT: This validation is only intended for use in unit tests. @@ -123,9 +123,8 @@ export function validateSourceLocations( t.FunctionDeclaration | t.ArrowFunctionExpression | t.FunctionExpression >, generatedAst: CodegenFunction, -): Result { - const errors = new CompilerError(); - + env: Environment, +): void { /* * Step 1: Collect important locations from the original source * Note: Multiple node types can share the same location (e.g. VariableDeclarator and Identifier) @@ -240,7 +239,7 @@ export function validateSourceLocations( loc: t.SourceLocation, nodeType: string, ): void => { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Todo, reason: 'Important source location missing in generated code', @@ -260,7 +259,7 @@ export function validateSourceLocations( expectedType: string, actualTypes: Set, ): void => { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.Todo, reason: @@ -308,6 +307,4 @@ export function validateSourceLocations( } } } - - return errors.asResult(); } diff --git a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateUseMemo.ts b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateUseMemo.ts index 2bccda3a2e93..87c6ebd1a2a4 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateUseMemo.ts +++ b/compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateUseMemo.ts @@ -16,14 +16,13 @@ import { IdentifierId, SourceLocation, } from '../HIR'; +import {Environment} from '../HIR/Environment'; import { eachInstructionValueOperand, eachTerminalOperand, } from '../HIR/visitors'; -import {Result} from '../Utils/Result'; -export function validateUseMemo(fn: HIRFunction): Result { - const errors = new CompilerError(); +export function validateUseMemo(fn: HIRFunction): void { const voidMemoErrors = new CompilerError(); const useMemos = new Set(); const react = new Set(); @@ -91,7 +90,7 @@ export function validateUseMemo(fn: HIRFunction): Result { firstParam.kind === 'Identifier' ? firstParam.loc : firstParam.place.loc; - errors.pushDiagnostic( + fn.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: 'useMemo() callbacks may not accept parameters', @@ -107,7 +106,7 @@ export function validateUseMemo(fn: HIRFunction): Result { } if (body.loweredFunc.func.async || body.loweredFunc.func.generator) { - errors.pushDiagnostic( + fn.env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: @@ -123,7 +122,7 @@ export function validateUseMemo(fn: HIRFunction): Result { ); } - validateNoContextVariableAssignment(body.loweredFunc.func, errors); + validateNoContextVariableAssignment(body.loweredFunc.func, fn.env); if (fn.env.config.validateNoVoidUseMemo) { if (!hasNonVoidReturn(body.loweredFunc.func)) { @@ -177,12 +176,11 @@ export function validateUseMemo(fn: HIRFunction): Result { } } fn.env.logErrors(voidMemoErrors.asResult()); - return errors.asResult(); } function validateNoContextVariableAssignment( fn: HIRFunction, - errors: CompilerError, + env: Environment, ): void { const context = new Set(fn.context.map(place => place.identifier.id)); for (const block of fn.body.blocks.values()) { @@ -191,7 +189,7 @@ function validateNoContextVariableAssignment( switch (value.kind) { case 'StoreContext': { if (context.has(value.lvalue.place.identifier.id)) { - errors.pushDiagnostic( + env.recordError( CompilerDiagnostic.create({ category: ErrorCategory.UseMemo, reason: diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/ecma/error.reserved-words.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/ecma/error.reserved-words.expect.md index deb87c9d8a0c..a6ee8a798b58 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/ecma/error.reserved-words.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/ecma/error.reserved-words.expect.md @@ -24,18 +24,9 @@ function useThing(fn) { ``` Found 1 error: -Compilation Skipped: `this` is not supported syntax - -React Compiler does not support compiling functions that use `this`. - -error.reserved-words.ts:8:28 - 6 | - 7 | if (ref.current === null) { -> 8 | ref.current = function (this: unknown, ...args) { - | ^^^^^^^^^^^^^ `this` was used here - 9 | return fnRef.current.call(this, ...args); - 10 | }; - 11 | } +Error: Expected a non-reserved identifier name + +`this` is a reserved word in JavaScript and cannot be used as an identifier name. ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error._todo.computed-lval-in-destructure.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error._todo.computed-lval-in-destructure.expect.md index 2d633a3d0fdd..026b9f2f1101 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error._todo.computed-lval-in-destructure.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error._todo.computed-lval-in-destructure.expect.md @@ -17,16 +17,17 @@ function Component(props) { ``` Found 1 error: -Todo: (BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern +Invariant: [InferMutationAliasingEffects] Expected value kind to be initialized -error._todo.computed-lval-in-destructure.ts:3:9 - 1 | function Component(props) { - 2 | const computedKey = props.key; -> 3 | const {[computedKey]: x} = props.val; - | ^^^^^^^^^^^^^^^^ (BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern + x$8. + +error._todo.computed-lval-in-destructure.ts:5:9 + 3 | const {[computedKey]: x} = props.val; 4 | - 5 | return x; +> 5 | return x; + | ^ this is uninitialized 6 | } + 7 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.expect.md new file mode 100644 index 000000000000..e66e99524fad --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.expect.md @@ -0,0 +1,60 @@ + +## Input + +```javascript +// @validateRefAccessDuringRender +/** + * This fixture tests fault tolerance: the compiler should report + * multiple independent errors rather than stopping at the first one. + * + * Error 1: Ref access during render (ref.current) + * Error 2: Mutation of frozen value (props) + */ +function Component(props) { + const ref = useRef(null); + + // Error: reading ref during render + const value = ref.current; + + // Error: mutating frozen value (props, which is frozen after hook call) + props.items = []; + + return
{value}
; +} + +``` + + +## Error + +``` +Found 2 errors: + +Error: This value cannot be modified + +Modifying component props or hook arguments is not allowed. Consider using a local variable instead. + +error.fault-tolerance-reports-multiple-errors.ts:16:2 + 14 | + 15 | // Error: mutating frozen value (props, which is frozen after hook call) +> 16 | props.items = []; + | ^^^^^ value cannot be modified + 17 | + 18 | return
{value}
; + 19 | } + +Error: Cannot access refs during render + +React refs are values that are not needed for rendering. Refs should only be accessed outside of render, such as in event handlers or effects. Accessing a ref value (the `current` property) during render can cause your component not to update as expected (https://react.dev/reference/react/useRef). + +error.fault-tolerance-reports-multiple-errors.ts:13:16 + 11 | + 12 | // Error: reading ref during render +> 13 | const value = ref.current; + | ^^^^^^^^^^^ Cannot access ref value during render + 14 | + 15 | // Error: mutating frozen value (props, which is frozen after hook call) + 16 | props.items = []; +``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.js new file mode 100644 index 000000000000..f478540250ed --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.fault-tolerance-reports-multiple-errors.js @@ -0,0 +1,19 @@ +// @validateRefAccessDuringRender +/** + * This fixture tests fault tolerance: the compiler should report + * multiple independent errors rather than stopping at the first one. + * + * Error 1: Ref access during render (ref.current) + * Error 2: Mutation of frozen value (props) + */ +function Component(props) { + const ref = useRef(null); + + // Error: reading ref during render + const value = ref.current; + + // Error: mutating frozen value (props, which is frozen after hook call) + props.items = []; + + return
{value}
; +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.hook-call-freezes-captured-memberexpr.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.hook-call-freezes-captured-memberexpr.expect.md index c57d55e29a3d..a7f36aac18bb 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.hook-call-freezes-captured-memberexpr.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.hook-call-freezes-captured-memberexpr.expect.md @@ -29,7 +29,7 @@ export const FIXTURE_ENTRYPOINT = { ## Error ``` -Found 1 error: +Found 2 errors: Error: This value cannot be modified @@ -43,6 +43,32 @@ error.hook-call-freezes-captured-memberexpr.ts:13:2 14 | return ; 15 | } 16 | + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `x` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.hook-call-freezes-captured-memberexpr.ts:9:25 + 7 | * After this custom hook call, it's no longer valid to mutate x. + 8 | */ +> 9 | const cb = useIdentity(() => { + | ^^^^^^^ +> 10 | x.value++; + | ^^^^^^^^^^^^^^ +> 11 | }); + | ^^^^ This function may (indirectly) reassign or modify `x` after render + 12 | + 13 | x.value += count; + 14 | return ; + +error.hook-call-freezes-captured-memberexpr.ts:10:4 + 8 | */ + 9 | const cb = useIdentity(() => { +> 10 | x.value++; + | ^ This modifies `x` + 11 | }); + 12 | + 13 | x.value += count; ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-ReactUseMemo-async-callback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-ReactUseMemo-async-callback.expect.md index 4aac70a93327..be7732333e01 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-ReactUseMemo-async-callback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-ReactUseMemo-async-callback.expect.md @@ -15,7 +15,7 @@ function component(a, b) { ## Error ``` -Found 1 error: +Found 3 errors: Error: useMemo() callbacks may not be async or generator functions @@ -32,6 +32,37 @@ error.invalid-ReactUseMemo-async-callback.ts:2:24 5 | return x; 6 | } 7 | + +Error: Found missing memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. + +error.invalid-ReactUseMemo-async-callback.ts:3:10 + 1 | function component(a, b) { + 2 | let x = React.useMemo(async () => { +> 3 | await a; + | ^ Missing dependency `a` + 4 | }, []); + 5 | return x; + 6 | } + +Inferred dependencies: `[a]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `a`, but the source dependencies were []. Inferred dependency not present in source. + +error.invalid-ReactUseMemo-async-callback.ts:2:24 + 1 | function component(a, b) { +> 2 | let x = React.useMemo(async () => { + | ^^^^^^^^^^^^^ +> 3 | await a; + | ^^^^^^^^^^^^ +> 4 | }, []); + | ^^^^ Could not preserve existing manual memoization + 5 | return x; + 6 | } + 7 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-conditional-setState-in-useMemo.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-conditional-setState-in-useMemo.expect.md index e4a94249623b..ee2c56fe223d 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-conditional-setState-in-useMemo.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-conditional-setState-in-useMemo.expect.md @@ -22,7 +22,7 @@ function Component({item, cond}) { ## Error ``` -Found 2 errors: +Found 3 errors: Error: Calling setState from useMemo may trigger an infinite loop @@ -49,6 +49,39 @@ error.invalid-conditional-setState-in-useMemo.ts:8:6 9 | } 10 | }, [cond, key, init]); 11 | + +Error: Found missing/extra memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. Extra dependencies can cause a value to update more often than it should, resulting in performance problems such as excessive renders or effects firing too often. + +error.invalid-conditional-setState-in-useMemo.ts:7:18 + 5 | useMemo(() => { + 6 | if (cond) { +> 7 | setPrevItem(item); + | ^^^^ Missing dependency `item` + 8 | setState(0); + 9 | } + 10 | }, [cond, key, init]); + +error.invalid-conditional-setState-in-useMemo.ts:10:12 + 8 | setState(0); + 9 | } +> 10 | }, [cond, key, init]); + | ^^^ Unnecessary dependency `key`. Values declared outside of a component/hook should not be listed as dependencies as the component will not re-render if they change + 11 | + 12 | return state; + 13 | } + +error.invalid-conditional-setState-in-useMemo.ts:10:17 + 8 | setState(0); + 9 | } +> 10 | }, [cond, key, init]); + | ^^^^ Unnecessary dependency `init`. Values declared outside of a component/hook should not be listed as dependencies as the component will not re-render if they change + 11 | + 12 | return state; + 13 | } + +Inferred dependencies: `[cond, item]` ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-mutation-in-closure.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-mutation-in-closure.expect.md index 62792df4d857..bd0d587f554d 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-mutation-in-closure.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-mutation-in-closure.expect.md @@ -16,7 +16,7 @@ function useInvalidMutation(options) { ## Error ``` -Found 1 error: +Found 2 errors: Error: This value cannot be modified @@ -30,6 +30,27 @@ error.invalid-mutation-in-closure.ts:4:4 5 | } 6 | return test; 7 | } + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `options` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-mutation-in-closure.ts:6:9 + 4 | options.foo = 'bar'; + 5 | } +> 6 | return test; + | ^^^^ This function may (indirectly) reassign or modify `options` after render + 7 | } + 8 | + +error.invalid-mutation-in-closure.ts:4:4 + 2 | function test() { + 3 | foo(options.foo); // error should not point on this line +> 4 | options.foo = 'bar'; + | ^^^^^^^ This modifies `options` + 5 | } + 6 | return test; + 7 | } ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-in-hook-return-value.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-in-hook-return-value.expect.md index 6379515a057d..8eb3f6ce6e6d 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-in-hook-return-value.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-in-hook-return-value.expect.md @@ -15,7 +15,7 @@ function useFoo() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -29,6 +29,31 @@ error.invalid-reassign-local-in-hook-return-value.ts:4:4 5 | }; 6 | } 7 | + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `x` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-reassign-local-in-hook-return-value.ts:3:9 + 1 | function useFoo() { + 2 | let x = 0; +> 3 | return value => { + | ^^^^^^^^^^ +> 4 | x = value; + | ^^^^^^^^^^^^^^ +> 5 | }; + | ^^^^ This function may (indirectly) reassign or modify `x` after render + 6 | } + 7 | + +error.invalid-reassign-local-in-hook-return-value.ts:4:4 + 2 | let x = 0; + 3 | return value => { +> 4 | x = value; + | ^ This modifies `x` + 5 | }; + 6 | } + 7 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-effect.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-effect.expect.md index 368b312022ff..1f87cf411bef 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-effect.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-effect.expect.md @@ -47,7 +47,7 @@ function Component() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -61,6 +61,32 @@ error.invalid-reassign-local-variable-in-effect.ts:7:4 8 | }; 9 | 10 | const onMount = newValue => { + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `local` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-reassign-local-variable-in-effect.ts:33:12 + 31 | }; + 32 | +> 33 | useEffect(() => { + | ^^^^^^^ +> 34 | onMount(); + | ^^^^^^^^^^^^^^ +> 35 | }, [onMount]); + | ^^^^ This function may (indirectly) reassign or modify `local` after render + 36 | + 37 | return 'ok'; + 38 | } + +error.invalid-reassign-local-variable-in-effect.ts:7:4 + 5 | + 6 | const reassignLocal = newValue => { +> 7 | local = newValue; + | ^^^^^ This modifies `local` + 8 | }; + 9 | + 10 | const onMount = newValue => { ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-hook-argument.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-hook-argument.expect.md index 8c7973377d87..61b8ef46c56b 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-hook-argument.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-hook-argument.expect.md @@ -48,7 +48,7 @@ function Component() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -62,6 +62,32 @@ error.invalid-reassign-local-variable-in-hook-argument.ts:8:4 9 | }; 10 | 11 | const callback = newValue => { + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `local` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-reassign-local-variable-in-hook-argument.ts:34:14 + 32 | }; + 33 | +> 34 | useIdentity(() => { + | ^^^^^^^ +> 35 | callback(); + | ^^^^^^^^^^^^^^^ +> 36 | }); + | ^^^^ This function may (indirectly) reassign or modify `local` after render + 37 | + 38 | return 'ok'; + 39 | } + +error.invalid-reassign-local-variable-in-hook-argument.ts:8:4 + 6 | + 7 | const reassignLocal = newValue => { +> 8 | local = newValue; + | ^^^^^ This modifies `local` + 9 | }; + 10 | + 11 | const callback = newValue => { ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-jsx-callback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-jsx-callback.expect.md index 3ecbcc97c32f..feb3449befb3 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-jsx-callback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-reassign-local-variable-in-jsx-callback.expect.md @@ -41,7 +41,7 @@ function Component() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -55,6 +55,27 @@ error.invalid-reassign-local-variable-in-jsx-callback.ts:5:4 6 | }; 7 | 8 | const onClick = newValue => { + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `local` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-reassign-local-variable-in-jsx-callback.ts:31:26 + 29 | }; + 30 | +> 31 | return ; + | ^^^^^^^ This function may (indirectly) reassign or modify `local` after render + 32 | } + 33 | + +error.invalid-reassign-local-variable-in-jsx-callback.ts:5:4 + 3 | + 4 | const reassignLocal = newValue => { +> 5 | local = newValue; + | ^^^^^ This modifies `local` + 6 | }; + 7 | + 8 | const onClick = newValue => { ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-setState-in-useMemo-indirect-useCallback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-setState-in-useMemo-indirect-useCallback.expect.md index e284a9367fbc..b245c5324f3f 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-setState-in-useMemo-indirect-useCallback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-setState-in-useMemo-indirect-useCallback.expect.md @@ -26,7 +26,7 @@ function useKeyedState({key, init}) { ## Error ``` -Found 1 error: +Found 3 errors: Error: Calling setState from useMemo may trigger an infinite loop @@ -40,6 +40,61 @@ error.invalid-setState-in-useMemo-indirect-useCallback.ts:13:4 14 | }, [key, init]); 15 | 16 | return state; + +Error: Found missing memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. + +error.invalid-setState-in-useMemo-indirect-useCallback.ts:9:13 + 7 | const fn = useCallback(() => { + 8 | setPrevKey(key); +> 9 | setState(init); + | ^^^^ Missing dependency `init` + 10 | }); + 11 | + 12 | useMemo(() => { + +error.invalid-setState-in-useMemo-indirect-useCallback.ts:8:15 + 6 | + 7 | const fn = useCallback(() => { +> 8 | setPrevKey(key); + | ^^^ Missing dependency `key` + 9 | setState(init); + 10 | }); + 11 | + +Error: Found missing/extra memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. Extra dependencies can cause a value to update more often than it should, resulting in performance problems such as excessive renders or effects firing too often. + +error.invalid-setState-in-useMemo-indirect-useCallback.ts:13:4 + 11 | + 12 | useMemo(() => { +> 13 | fn(); + | ^^ Missing dependency `fn` + 14 | }, [key, init]); + 15 | + 16 | return state; + +error.invalid-setState-in-useMemo-indirect-useCallback.ts:14:6 + 12 | useMemo(() => { + 13 | fn(); +> 14 | }, [key, init]); + | ^^^ Unnecessary dependency `key` + 15 | + 16 | return state; + 17 | } + +error.invalid-setState-in-useMemo-indirect-useCallback.ts:14:11 + 12 | useMemo(() => { + 13 | fn(); +> 14 | }, [key, init]); + | ^^^^ Unnecessary dependency `init` + 15 | + 16 | return state; + 17 | } + +Inferred dependencies: `[fn]` ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-async-callback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-async-callback.expect.md index 7146a57869f4..922119f1f1df 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-async-callback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-async-callback.expect.md @@ -15,7 +15,7 @@ function component(a, b) { ## Error ``` -Found 1 error: +Found 3 errors: Error: useMemo() callbacks may not be async or generator functions @@ -32,6 +32,37 @@ error.invalid-useMemo-async-callback.ts:2:18 5 | return x; 6 | } 7 | + +Error: Found missing memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. + +error.invalid-useMemo-async-callback.ts:3:10 + 1 | function component(a, b) { + 2 | let x = useMemo(async () => { +> 3 | await a; + | ^ Missing dependency `a` + 4 | }, []); + 5 | return x; + 6 | } + +Inferred dependencies: `[a]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `a`, but the source dependencies were []. Inferred dependency not present in source. + +error.invalid-useMemo-async-callback.ts:2:18 + 1 | function component(a, b) { +> 2 | let x = useMemo(async () => { + | ^^^^^^^^^^^^^ +> 3 | await a; + | ^^^^^^^^^^^^ +> 4 | }, []); + | ^^^^ Could not preserve existing manual memoization + 5 | return x; + 6 | } + 7 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-callback-args.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-callback-args.expect.md index 933315073f13..9bbf4ac8cd37 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-callback-args.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.invalid-useMemo-callback-args.expect.md @@ -13,7 +13,7 @@ function component(a, b) { ## Error ``` -Found 1 error: +Found 3 errors: Error: useMemo() callbacks may not accept parameters @@ -26,6 +26,32 @@ error.invalid-useMemo-callback-args.ts:2:18 3 | return x; 4 | } 5 | + +Error: Found missing memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. + +error.invalid-useMemo-callback-args.ts:2:23 + 1 | function component(a, b) { +> 2 | let x = useMemo(c => a, []); + | ^ Missing dependency `a` + 3 | return x; + 4 | } + 5 | + +Inferred dependencies: `[a]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `a`, but the source dependencies were []. Inferred dependency not present in source. + +error.invalid-useMemo-callback-args.ts:2:18 + 1 | function component(a, b) { +> 2 | let x = useMemo(c => a, []); + | ^^^^^^ Could not preserve existing manual memoization + 3 | return x; + 4 | } + 5 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.mutable-range-shared-inner-outer-function.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.mutable-range-shared-inner-outer-function.expect.md index 337b9dd30c08..b0a1a6712305 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.mutable-range-shared-inner-outer-function.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.mutable-range-shared-inner-outer-function.expect.md @@ -32,7 +32,7 @@ export const FIXTURE_ENTRYPOINT = { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -46,6 +46,28 @@ error.mutable-range-shared-inner-outer-function.ts:8:6 9 | b = []; 10 | } else { 11 | a = {}; + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `a` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.mutable-range-shared-inner-outer-function.ts:17:23 + 15 | b.push(false); + 16 | }; +> 17 | return
; + | ^ This function may (indirectly) reassign or modify `a` after render + 18 | } + 19 | + 20 | export const FIXTURE_ENTRYPOINT = { + +error.mutable-range-shared-inner-outer-function.ts:8:6 + 6 | const f = () => { + 7 | if (cond) { +> 8 | a = {}; + | ^ This modifies `a` + 9 | b = []; + 10 | } else { + 11 | a = {}; ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-allow-assigning-to-inferred-ref-prop-in-callback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-allow-assigning-to-inferred-ref-prop-in-callback.expect.md index ec187f6bc23b..757e038c676b 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-allow-assigning-to-inferred-ref-prop-in-callback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-allow-assigning-to-inferred-ref-prop-in-callback.expect.md @@ -29,7 +29,7 @@ function useHook(parentRef) { ## Error ``` -Found 1 error: +Found 2 errors: Error: This value cannot be modified @@ -43,6 +43,27 @@ error.todo-allow-assigning-to-inferred-ref-prop-in-callback.ts:15:8 16 | } 17 | } 18 | }; + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `parentRef` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.todo-allow-assigning-to-inferred-ref-prop-in-callback.ts:19:9 + 17 | } + 18 | }; +> 19 | return handler; + | ^^^^^^^ This function may (indirectly) reassign or modify `parentRef` after render + 20 | } + 21 | + +error.todo-allow-assigning-to-inferred-ref-prop-in-callback.ts:15:8 + 13 | } else { + 14 | // So this assignment fails since we don't know its a ref +> 15 | parentRef.current = instance; + | ^^^^^^^^^ This modifies `parentRef` + 16 | } + 17 | } + 18 | }; ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-function-expression-references-later-variable-declaration.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-function-expression-references-later-variable-declaration.expect.md index a88d43b35282..0cd493836b69 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-function-expression-references-later-variable-declaration.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-function-expression-references-later-variable-declaration.expect.md @@ -17,7 +17,7 @@ function Component() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -31,6 +31,27 @@ error.todo-function-expression-references-later-variable-declaration.ts:3:4 4 | }; 5 | let onClick; 6 | + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `onClick` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.todo-function-expression-references-later-variable-declaration.ts:7:23 + 5 | let onClick; + 6 | +> 7 | return
; + | ^^^^^^^^ This function may (indirectly) reassign or modify `onClick` after render + 8 | } + 9 | + +error.todo-function-expression-references-later-variable-declaration.ts:3:4 + 1 | function Component() { + 2 | let callback = () => { +> 3 | onClick = () => {}; + | ^^^^^^^ This modifies `onClick` + 4 | }; + 5 | let onClick; + 6 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-hoisted-function-in-unreachable-code.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-hoisted-function-in-unreachable-code.expect.md index c9152496f2de..6cd0945d74d5 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-hoisted-function-in-unreachable-code.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-hoisted-function-in-unreachable-code.expect.md @@ -18,15 +18,18 @@ function Component() { ``` Found 1 error: -Todo: Support functions with unreachable code that may contain hoisted declarations +Invariant: [InferMutationAliasingEffects] Expected value kind to be initialized -error.todo-hoisted-function-in-unreachable-code.ts:6:2 + Foo$0. + +error.todo-hoisted-function-in-unreachable-code.ts:3:10 + 1 | // @compilationMode:"infer" + 2 | function Component() { +> 3 | return ; + | ^^^ this is uninitialized 4 | 5 | // This is unreachable from a control-flow perspective, but it gets hoisted -> 6 | function Foo() {} - | ^^^^^^^^^^^^^^^^^ Support functions with unreachable code that may contain hoisted declarations - 7 | } - 8 | + 6 | function Foo() {} ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-kitchensink.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-kitchensink.expect.md index 32db5b2e7caa..60fbf9637ff4 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-kitchensink.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-kitchensink.expect.md @@ -79,43 +79,11 @@ let moduleLocal = false; ## Error ``` -Found 10 errors: - -Todo: (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration - -error.todo-kitchensink.ts:3:2 - 1 | function foo([a, b], {c, d, e = 'e'}, f = 'f', ...args) { - 2 | let i = 0; -> 3 | var x = []; - | ^^^^^^^^^^^ (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration - 4 | - 5 | class Bar { - 6 | #secretSauce = 42; - -Compilation Skipped: Inline `class` declarations are not supported - -Move class declarations outside of components/hooks. - -error.todo-kitchensink.ts:5:2 - 3 | var x = []; - 4 | -> 5 | class Bar { - | ^^^^^^^^^^^ -> 6 | #secretSauce = 42; - | ^^^^^^^^^^^^^^^^^^^^^^ -> 7 | constructor() { - | ^^^^^^^^^^^^^^^^^^^^^^ -> 8 | console.log(this.#secretSauce); - | ^^^^^^^^^^^^^^^^^^^^^^ -> 9 | } - | ^^^^^^^^^^^^^^^^^^^^^^ -> 10 | } - | ^^^^ Inline `class` declarations are not supported - 11 | - 12 | const g = {b() {}, c: () => {}}; - 13 | const {z, aa = 'aa'} = useCustom(); - -Todo: (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement +Found 1 error: + +Invariant: Expected a variable declaration + +Got ExpressionStatement. error.todo-kitchensink.ts:20:2 18 | const j = function bar([quz, qux], ...args) {}; @@ -125,103 +93,10 @@ error.todo-kitchensink.ts:20:2 > 21 | x.push(i); | ^^^^^^^^^^^^^^ > 22 | } - | ^^^^ (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement + | ^^^^ Expected a variable declaration 23 | for (; i < 3; ) { 24 | break; 25 | } - -Todo: (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement - -error.todo-kitchensink.ts:23:2 - 21 | x.push(i); - 22 | } -> 23 | for (; i < 3; ) { - | ^^^^^^^^^^^^^^^^^ -> 24 | break; - | ^^^^^^^^^^ -> 25 | } - | ^^^^ (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement - 26 | for (;;) { - 27 | break; - 28 | } - -Todo: (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement - -error.todo-kitchensink.ts:26:2 - 24 | break; - 25 | } -> 26 | for (;;) { - | ^^^^^^^^^^ -> 27 | break; - | ^^^^^^^^^^ -> 28 | } - | ^^^^ (BuildHIR::lowerStatement) Handle non-variable initialization in ForStatement - 29 | - 30 | graphql` - 31 | ${g} - -Todo: (BuildHIR::lowerStatement) Handle empty test in ForStatement - -error.todo-kitchensink.ts:26:2 - 24 | break; - 25 | } -> 26 | for (;;) { - | ^^^^^^^^^^ -> 27 | break; - | ^^^^^^^^^^ -> 28 | } - | ^^^^ (BuildHIR::lowerStatement) Handle empty test in ForStatement - 29 | - 30 | graphql` - 31 | ${g} - -Todo: (BuildHIR::lowerExpression) Handle tagged template with interpolations - -error.todo-kitchensink.ts:30:2 - 28 | } - 29 | -> 30 | graphql` - | ^^^^^^^^ -> 31 | ${g} - | ^^^^^^^^ -> 32 | `; - | ^^^^ (BuildHIR::lowerExpression) Handle tagged template with interpolations - 33 | - 34 | graphql`\\t\n`; - 35 | - -Todo: (BuildHIR::lowerExpression) Handle tagged template where cooked value is different from raw value - -error.todo-kitchensink.ts:34:2 - 32 | `; - 33 | -> 34 | graphql`\\t\n`; - | ^^^^^^^^^^^^^^ (BuildHIR::lowerExpression) Handle tagged template where cooked value is different from raw value - 35 | - 36 | for (c of [1, 2]) { - 37 | } - -Todo: (BuildHIR::node.lowerReorderableExpression) Expression type `MemberExpression` cannot be safely reordered - -error.todo-kitchensink.ts:57:9 - 55 | case foo(): { - 56 | } -> 57 | case x.y: { - | ^^^ (BuildHIR::node.lowerReorderableExpression) Expression type `MemberExpression` cannot be safely reordered - 58 | } - 59 | default: { - 60 | } - -Todo: (BuildHIR::node.lowerReorderableExpression) Expression type `BinaryExpression` cannot be safely reordered - -error.todo-kitchensink.ts:53:9 - 51 | - 52 | switch (i) { -> 53 | case 1 + 1: { - | ^^^^^ (BuildHIR::node.lowerReorderableExpression) Expression type `BinaryExpression` cannot be safely reordered - 54 | } - 55 | case foo(): { - 56 | } ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-optional-call-chain-in-optional.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-optional-call-chain-in-optional.expect.md deleted file mode 100644 index 6551bb8d40fd..000000000000 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-optional-call-chain-in-optional.expect.md +++ /dev/null @@ -1,39 +0,0 @@ - -## Input - -```javascript -function useFoo(props: {value: {x: string; y: string} | null}) { - const value = props.value; - return createArray(value?.x, value?.y)?.join(', '); -} - -function createArray(...args: Array): Array { - return args; -} - -export const FIXTURE_ENTRYPONT = { - fn: useFoo, - props: [{value: null}], -}; - -``` - - -## Error - -``` -Found 1 error: - -Todo: Unexpected terminal kind `optional` for optional fallthrough block - -error.todo-optional-call-chain-in-optional.ts:3:21 - 1 | function useFoo(props: {value: {x: string; y: string} | null}) { - 2 | const value = props.value; -> 3 | return createArray(value?.x, value?.y)?.join(', '); - | ^^^^^^^^ Unexpected terminal kind `optional` for optional fallthrough block - 4 | } - 5 | - 6 | function createArray(...args: Array): Array { -``` - - \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-reassign-const.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-reassign-const.expect.md index 4b8ee0e4ed96..e594880ef92f 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-reassign-const.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-reassign-const.expect.md @@ -21,7 +21,7 @@ function Component({foo}) { ## Error ``` -Found 1 error: +Found 3 errors: Todo: Support destructuring of context variables @@ -29,10 +29,34 @@ error.todo-reassign-const.ts:3:20 1 | import {Stringify} from 'shared-runtime'; 2 | > 3 | function Component({foo}) { - | ^^^ Support destructuring of context variables + | ^^^ 4 | let bar = foo.bar; 5 | return ( 6 | 3 | function Component({foo}) { + | ^^^ + 4 | let bar = foo.bar; + 5 | return ( + 6 | { +> 8 | foo = true; + | ^^^ `foo` cannot be modified + 9 | }} + 10 | /> + 11 | ); ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.useMemo-callback-generator.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.useMemo-callback-generator.expect.md index b96648b00f5c..a3aae8768031 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.useMemo-callback-generator.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.useMemo-callback-generator.expect.md @@ -18,7 +18,7 @@ function component(a, b) { ## Error ``` -Found 1 error: +Found 2 errors: Todo: (BuildHIR::lowerExpression) Handle YieldExpression expressions @@ -30,6 +30,23 @@ error.useMemo-callback-generator.ts:6:4 7 | }, []); 8 | return x; 9 | } + +Error: useMemo() callbacks may not be async or generator functions + +useMemo() callbacks are called once and must synchronously return a value. + +error.useMemo-callback-generator.ts:5:18 + 3 | // useful for now, but adding this test in case we do + 4 | // add support for generators in the future. +> 5 | let x = useMemo(function* () { + | ^^^^^^^^^^^^^^ +> 6 | yield a; + | ^^^^^^^^^^^^ +> 7 | }, []); + | ^^^^ Async and generator functions are not supported + 8 | return x; + 9 | } + 10 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-deps.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-deps.expect.md index 2c864f56aff7..567d59e4546e 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-deps.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-exhaustive-deps.expect.md @@ -51,7 +51,7 @@ function Component({x, y, z}) { ## Error ``` -Found 4 errors: +Found 6 errors: Error: Found missing/extra memoization dependencies @@ -157,6 +157,48 @@ error.invalid-exhaustive-deps.ts:37:13 40 | }, []); Inferred dependencies: `[ref]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `x.y.z.a.b`, but the source dependencies were [x?.y.z.a?.b.z]. Inferred different dependency than source. + +error.invalid-exhaustive-deps.ts:14:20 + 12 | // ok, not our job to type check nullability + 13 | }, [x.y.z.a]); +> 14 | const c = useMemo(() => { + | ^^^^^^^ +> 15 | return x?.y.z.a?.b; + | ^^^^^^^^^^^^^^^^^^^^^^^ +> 16 | // error: too precise + | ^^^^^^^^^^^^^^^^^^^^^^^ +> 17 | }, [x?.y.z.a?.b.z]); + | ^^^^ Could not preserve existing manual memoization + 18 | const d = useMemo(() => { + 19 | return x?.y?.[(console.log(y), z?.b)]; + 20 | // ok + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `ref`, but the source dependencies were []. Inferred dependency not present in source. + +error.invalid-exhaustive-deps.ts:35:21 + 33 | const ref2 = useRef(null); + 34 | const ref = z ? ref1 : ref2; +> 35 | const cb = useMemo(() => { + | ^^^^^^^ +> 36 | return () => { + | ^^^^^^^^^^^^^^^^^^ +> 37 | return ref.current; + | ^^^^^^^^^^^^^^^^^^ +> 38 | }; + | ^^^^^^^^^^^^^^^^^^ +> 39 | // error: ref is a stable type but reactive + | ^^^^^^^^^^^^^^^^^^ +> 40 | }, []); + | ^^^^ Could not preserve existing manual memoization + 41 | return ; + 42 | } + 43 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-missing-nonreactive-dep-unmemoized.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-missing-nonreactive-dep-unmemoized.expect.md index bb991d17dadb..626240b1ae8d 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-missing-nonreactive-dep-unmemoized.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/exhaustive-deps/error.invalid-missing-nonreactive-dep-unmemoized.expect.md @@ -22,7 +22,7 @@ function useHook() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Found missing memoization dependencies @@ -38,6 +38,19 @@ error.invalid-missing-nonreactive-dep-unmemoized.ts:11:31 14 | Inferred dependencies: `[object]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `object`, but the source dependencies were []. Inferred dependency not present in source. + +error.invalid-missing-nonreactive-dep-unmemoized.ts:11:24 + 9 | useIdentity(); + 10 | object.x = 0; +> 11 | const array = useMemo(() => [object], []); + | ^^^^^^^^^^^^^^ Could not preserve existing manual memoization + 12 | return array; + 13 | } + 14 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.expect.md new file mode 100644 index 000000000000..750f35d7eb95 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.expect.md @@ -0,0 +1,66 @@ + +## Input + +```javascript +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + // Error: try/finally (Todo from BuildHIR) + try { + doWork(); + } finally { + doCleanup(); + } + + // Error: mutating frozen props + props.value = 1; + + return
{props.value}
; +} + +``` + + +## Error + +``` +Found 2 errors: + +Todo: (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + +error.try-finally-and-mutation-of-props.ts:9:2 + 7 | function Component(props) { + 8 | // Error: try/finally (Todo from BuildHIR) +> 9 | try { + | ^^^^^ +> 10 | doWork(); + | ^^^^^^^^^^^^^ +> 11 | } finally { + | ^^^^^^^^^^^^^ +> 12 | doCleanup(); + | ^^^^^^^^^^^^^ +> 13 | } + | ^^^^ (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + 14 | + 15 | // Error: mutating frozen props + 16 | props.value = 1; + +Error: This value cannot be modified + +Modifying component props or hook arguments is not allowed. Consider using a local variable instead. + +error.try-finally-and-mutation-of-props.ts:16:2 + 14 | + 15 | // Error: mutating frozen props +> 16 | props.value = 1; + | ^^^^^ value cannot be modified + 17 | + 18 | return
{props.value}
; + 19 | } +``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.js new file mode 100644 index 000000000000..a26724daf68c --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-mutation-of-props.js @@ -0,0 +1,19 @@ +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + // Error: try/finally (Todo from BuildHIR) + try { + doWork(); + } finally { + doCleanup(); + } + + // Error: mutating frozen props + props.value = 1; + + return
{props.value}
; +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.expect.md new file mode 100644 index 000000000000..45b637f104e5 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.expect.md @@ -0,0 +1,69 @@ + +## Input + +```javascript +// @validateRefAccessDuringRender +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + */ +function Component() { + const ref = useRef(null); + + // Error: try/finally (Todo from BuildHIR) + try { + doSomething(); + } finally { + cleanup(); + } + + // Error: reading ref during render + const value = ref.current; + + return
{value}
; +} + +``` + + +## Error + +``` +Found 2 errors: + +Todo: (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + +error.try-finally-and-ref-access.ts:12:2 + 10 | + 11 | // Error: try/finally (Todo from BuildHIR) +> 12 | try { + | ^^^^^ +> 13 | doSomething(); + | ^^^^^^^^^^^^^^^^^^ +> 14 | } finally { + | ^^^^^^^^^^^^^^^^^^ +> 15 | cleanup(); + | ^^^^^^^^^^^^^^^^^^ +> 16 | } + | ^^^^ (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + 17 | + 18 | // Error: reading ref during render + 19 | const value = ref.current; + +Error: Cannot access refs during render + +React refs are values that are not needed for rendering. Refs should only be accessed outside of render, such as in event handlers or effects. Accessing a ref value (the `current` property) during render can cause your component not to update as expected (https://react.dev/reference/react/useRef). + +error.try-finally-and-ref-access.ts:19:16 + 17 | + 18 | // Error: reading ref during render +> 19 | const value = ref.current; + | ^^^^^^^^^^^ Cannot access ref value during render + 20 | + 21 | return
{value}
; + 22 | } +``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.js new file mode 100644 index 000000000000..3d247c2c0b7c --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-and-ref-access.js @@ -0,0 +1,22 @@ +// @validateRefAccessDuringRender +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + */ +function Component() { + const ref = useRef(null); + + // Error: try/finally (Todo from BuildHIR) + try { + doSomething(); + } finally { + cleanup(); + } + + // Error: reading ref during render + const value = ref.current; + + return
{value}
; +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.expect.md new file mode 100644 index 000000000000..a21c72635b3a --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.expect.md @@ -0,0 +1,86 @@ + +## Input + +```javascript +// @validateRefAccessDuringRender +/** + * Fault tolerance test: three independent errors should all be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + * Error 3 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + const ref = useRef(null); + + // Error: try/finally (Todo from BuildHIR) + try { + doWork(); + } finally { + cleanup(); + } + + // Error: reading ref during render + const value = ref.current; + + // Error: mutating frozen props + props.items = []; + + return
{value}
; +} + +``` + + +## Error + +``` +Found 3 errors: + +Todo: (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + +error.try-finally-ref-access-and-mutation.ts:13:2 + 11 | + 12 | // Error: try/finally (Todo from BuildHIR) +> 13 | try { + | ^^^^^ +> 14 | doWork(); + | ^^^^^^^^^^^^^ +> 15 | } finally { + | ^^^^^^^^^^^^^ +> 16 | cleanup(); + | ^^^^^^^^^^^^^ +> 17 | } + | ^^^^ (BuildHIR::lowerStatement) Handle TryStatement without a catch clause + 18 | + 19 | // Error: reading ref during render + 20 | const value = ref.current; + +Error: This value cannot be modified + +Modifying component props or hook arguments is not allowed. Consider using a local variable instead. + +error.try-finally-ref-access-and-mutation.ts:23:2 + 21 | + 22 | // Error: mutating frozen props +> 23 | props.items = []; + | ^^^^^ value cannot be modified + 24 | + 25 | return
{value}
; + 26 | } + +Error: Cannot access refs during render + +React refs are values that are not needed for rendering. Refs should only be accessed outside of render, such as in event handlers or effects. Accessing a ref value (the `current` property) during render can cause your component not to update as expected (https://react.dev/reference/react/useRef). + +error.try-finally-ref-access-and-mutation.ts:20:16 + 18 | + 19 | // Error: reading ref during render +> 20 | const value = ref.current; + | ^^^^^^^^^^^ Cannot access ref value during render + 21 | + 22 | // Error: mutating frozen props + 23 | props.items = []; +``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.js new file mode 100644 index 000000000000..f25a59c7653b --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.try-finally-ref-access-and-mutation.js @@ -0,0 +1,26 @@ +// @validateRefAccessDuringRender +/** + * Fault tolerance test: three independent errors should all be reported. + * + * Error 1 (BuildHIR): `try/finally` is not supported + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + * Error 3 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + const ref = useRef(null); + + // Error: try/finally (Todo from BuildHIR) + try { + doWork(); + } finally { + cleanup(); + } + + // Error: reading ref during render + const value = ref.current; + + // Error: mutating frozen props + props.items = []; + + return
{value}
; +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.expect.md new file mode 100644 index 000000000000..ecb65622d432 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.expect.md @@ -0,0 +1,54 @@ + +## Input + +```javascript +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `var` declarations are not supported (treated as `let`) + * Error 2 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + // Error: var declaration (Todo from BuildHIR) + var items = props.items; + + // Error: mutating frozen props (detected during inference) + props.items = []; + + return
{items.length}
; +} + +``` + + +## Error + +``` +Found 2 errors: + +Todo: (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration + +error.var-declaration-and-mutation-of-props.ts:9:2 + 7 | function Component(props) { + 8 | // Error: var declaration (Todo from BuildHIR) +> 9 | var items = props.items; + | ^^^^^^^^^^^^^^^^^^^^^^^^ (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration + 10 | + 11 | // Error: mutating frozen props (detected during inference) + 12 | props.items = []; + +Error: This value cannot be modified + +Modifying component props or hook arguments is not allowed. Consider using a local variable instead. + +error.var-declaration-and-mutation-of-props.ts:12:2 + 10 | + 11 | // Error: mutating frozen props (detected during inference) +> 12 | props.items = []; + | ^^^^^ value cannot be modified + 13 | + 14 | return
{items.length}
; + 15 | } +``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.js new file mode 100644 index 000000000000..c0fd6a34fb8f --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-mutation-of-props.js @@ -0,0 +1,15 @@ +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `var` declarations are not supported (treated as `let`) + * Error 2 (InferMutationAliasingEffects): Mutation of frozen props + */ +function Component(props) { + // Error: var declaration (Todo from BuildHIR) + var items = props.items; + + // Error: mutating frozen props (detected during inference) + props.items = []; + + return
{items.length}
; +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.expect.md new file mode 100644 index 000000000000..c86e6ffe6ab6 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.expect.md @@ -0,0 +1,62 @@ + +## Input + +```javascript +// @validateRefAccessDuringRender +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `var` declarations are not supported (treated as `let`) + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + */ +function Component() { + const ref = useRef(null); + + // Error: var declaration (Todo from BuildHIR) + var items = [1, 2, 3]; + + // Error: reading ref during render + const value = ref.current; + + return ( +
+ {value} + {items.length} +
+ ); +} + +``` + + +## Error + +``` +Found 2 errors: + +Todo: (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration + +error.var-declaration-and-ref-access.ts:12:2 + 10 | + 11 | // Error: var declaration (Todo from BuildHIR) +> 12 | var items = [1, 2, 3]; + | ^^^^^^^^^^^^^^^^^^^^^^ (BuildHIR::lowerStatement) Handle var kinds in VariableDeclaration + 13 | + 14 | // Error: reading ref during render + 15 | const value = ref.current; + +Error: Cannot access refs during render + +React refs are values that are not needed for rendering. Refs should only be accessed outside of render, such as in event handlers or effects. Accessing a ref value (the `current` property) during render can cause your component not to update as expected (https://react.dev/reference/react/useRef). + +error.var-declaration-and-ref-access.ts:15:16 + 13 | + 14 | // Error: reading ref during render +> 15 | const value = ref.current; + | ^^^^^^^^^^^ Cannot access ref value during render + 16 | + 17 | return ( + 18 |
+``` + + \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.js b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.js new file mode 100644 index 000000000000..60a14ecec3d9 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fault-tolerance/error.var-declaration-and-ref-access.js @@ -0,0 +1,23 @@ +// @validateRefAccessDuringRender +/** + * Fault tolerance test: two independent errors should both be reported. + * + * Error 1 (BuildHIR): `var` declarations are not supported (treated as `let`) + * Error 2 (ValidateNoRefAccessInRender): reading ref.current during render + */ +function Component() { + const ref = useRef(null); + + // Error: var declaration (Todo from BuildHIR) + var items = [1, 2, 3]; + + // Error: reading ref during render + const value = ref.current; + + return ( +
+ {value} + {items.length} +
+ ); +} diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-fbt-as-local.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-fbt-as-local.expect.md index bb86d3bc42e0..c2cc0a19506c 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-fbt-as-local.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-fbt-as-local.expect.md @@ -50,7 +50,7 @@ export const FIXTURE_ENTRYPOINT = { ## Error ``` -Found 1 error: +Found 4 errors: Todo: Support local variables named `fbt` @@ -60,10 +60,49 @@ error.todo-fbt-as-local.ts:18:19 16 | 17 | function Foo(props) { > 18 | const getText1 = fbt => - | ^^^ Rename to avoid conflict with fbt plugin + | ^^^ Support local variables named `fbt` 19 | fbt( 20 | `Hello, ${fbt.param('(key) name', identity(props.name))}!`, 21 | '(description) Greeting' + +Todo: Support local variables named `fbt` + +Local variables named `fbt` may conflict with the fbt plugin and are not yet supported. + +error.todo-fbt-as-local.ts:18:19 + 16 | + 17 | function Foo(props) { +> 18 | const getText1 = fbt => + | ^^^ Support local variables named `fbt` + 19 | fbt( + 20 | `Hello, ${fbt.param('(key) name', identity(props.name))}!`, + 21 | '(description) Greeting' + +Todo: Support local variables named `fbt` + +Local variables named `fbt` may conflict with the fbt plugin and are not yet supported. + +error.todo-fbt-as-local.ts:18:19 + 16 | + 17 | function Foo(props) { +> 18 | const getText1 = fbt => + | ^^^ Support local variables named `fbt` + 19 | fbt( + 20 | `Hello, ${fbt.param('(key) name', identity(props.name))}!`, + 21 | '(description) Greeting' + +Todo: Support local variables named `fbt` + +Local variables named `fbt` may conflict with the fbt plugin and are not yet supported. + +error.todo-fbt-as-local.ts:24:19 + 22 | ); + 23 | +> 24 | const getText2 = fbt => + | ^^^ Support local variables named `fbt` + 25 | fbt( + 26 | `Goodbye, ${fbt.param('(key) name', identity(props.name))}!`, + 27 | '(description) Greeting2' ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-locally-require-fbt.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-locally-require-fbt.expect.md index 62605e5896ce..2847ad9d5a29 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-locally-require-fbt.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/fbt/error.todo-locally-require-fbt.expect.md @@ -16,17 +16,15 @@ function Component(props) { ``` Found 1 error: -Todo: Support local variables named `fbt` +Invariant: tags should be module-level imports -Local variables named `fbt` may conflict with the fbt plugin and are not yet supported. - -error.todo-locally-require-fbt.ts:2:8 - 1 | function Component(props) { -> 2 | const fbt = require('fbt'); - | ^^^ Rename to avoid conflict with fbt plugin +error.todo-locally-require-fbt.ts:4:10 + 2 | const fbt = require('fbt'); 3 | - 4 | return {'Text'}; +> 4 | return {'Text'}; + | ^^^ tags should be module-level imports 5 | } + 6 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-reassign-local-variable-in-jsx-callback.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-reassign-local-variable-in-jsx-callback.expect.md index babb4e896975..5cd2cf7b9798 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-reassign-local-variable-in-jsx-callback.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-reassign-local-variable-in-jsx-callback.expect.md @@ -42,7 +42,7 @@ function Component() { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot reassign variable after render completes @@ -56,6 +56,27 @@ error.invalid-reassign-local-variable-in-jsx-callback.ts:6:4 7 | }; 8 | 9 | const onClick = newValue => { + +Error: Cannot modify local variables after render completes + +This argument is a function which may reassign or mutate `local` after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead. + +error.invalid-reassign-local-variable-in-jsx-callback.ts:32:26 + 30 | }; + 31 | +> 32 | return ; + | ^^^^^^^ This function may (indirectly) reassign or modify `local` after render + 33 | } + 34 | + +error.invalid-reassign-local-variable-in-jsx-callback.ts:6:4 + 4 | + 5 | const reassignLocal = newValue => { +> 6 | local = newValue; + | ^^^^^ This modifies `local` + 7 | }; + 8 | + 9 | const onClick = newValue => { ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-referencing-frozen-hoisted-storecontext-const.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-referencing-frozen-hoisted-storecontext-const.expect.md index d78e4becec78..d50943f67784 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-referencing-frozen-hoisted-storecontext-const.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/new-mutability/error.invalid-referencing-frozen-hoisted-storecontext-const.expect.md @@ -31,7 +31,7 @@ function Component({content, refetch}) { ## Error ``` -Found 1 error: +Found 2 errors: Error: Cannot access variable before it is declared @@ -52,6 +52,18 @@ Error: Cannot access variable before it is declared 20 | 21 | return ; 22 | } + +Error: Found missing memoization dependencies + +Missing dependencies can cause a value to update less often than it should, resulting in stale UI. + + 9 | // TDZ violation! + 10 | const onRefetch = useCallback(() => { +> 11 | refetch(data); + | ^^^^ Missing dependency `data` + 12 | }, [refetch]); + 13 | + 14 | // The context variable gets frozen here since it's passed to a hook ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/preserve-memo-validation/error.useMemo-unrelated-mutation-in-depslist.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/preserve-memo-validation/error.useMemo-unrelated-mutation-in-depslist.expect.md index fe0bf6c22f66..c311f862128a 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/preserve-memo-validation/error.useMemo-unrelated-mutation-in-depslist.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/preserve-memo-validation/error.useMemo-unrelated-mutation-in-depslist.expect.md @@ -30,7 +30,7 @@ function useFoo(input1) { ## Error ``` -Found 1 error: +Found 2 errors: Error: Found missing memoization dependencies @@ -46,6 +46,23 @@ error.useMemo-unrelated-mutation-in-depslist.ts:18:14 21 | } Inferred dependencies: `[x, y]` + +Compilation Skipped: Existing memoization could not be preserved + +React Compiler has skipped optimizing this component because the existing manual memoization could not be preserved. The inferred dependencies did not match the manually specified dependencies, which could cause the value to change more or less frequently than expected. The inferred dependency was `input1`, but the source dependencies were [y]. Inferred different dependency than source. + +error.useMemo-unrelated-mutation-in-depslist.ts:16:27 + 14 | const x = {}; + 15 | const y = [input1]; +> 16 | const memoized = useMemo(() => { + | ^^^^^^^ +> 17 | return [y]; + | ^^^^^^^^^^^^^^^ +> 18 | }, [(mutate(x), y)]); + | ^^^^ Could not preserve existing manual memoization + 19 | + 20 | return [x, memoized]; + 21 | } ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/error.todo-optional-call-chain-in-optional.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/error.todo-optional-call-chain-in-optional.expect.md deleted file mode 100644 index 5da7122c76fe..000000000000 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/error.todo-optional-call-chain-in-optional.expect.md +++ /dev/null @@ -1,40 +0,0 @@ - -## Input - -```javascript -// @enablePropagateDepsInHIR -function useFoo(props: {value: {x: string; y: string} | null}) { - const value = props.value; - return createArray(value?.x, value?.y)?.join(', '); -} - -function createArray(...args: Array): Array { - return args; -} - -export const FIXTURE_ENTRYPONT = { - fn: useFoo, - props: [{value: null}], -}; - -``` - - -## Error - -``` -Found 1 error: - -Todo: Unexpected terminal kind `optional` for optional fallthrough block - -error.todo-optional-call-chain-in-optional.ts:4:21 - 2 | function useFoo(props: {value: {x: string; y: string} | null}) { - 3 | const value = props.value; -> 4 | return createArray(value?.x, value?.y)?.join(', '); - | ^^^^^^^^ Unexpected terminal kind `optional` for optional fallthrough block - 5 | } - 6 | - 7 | function createArray(...args: Array): Array { -``` - - \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/todo-optional-call-chain-in-optional.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/todo-optional-call-chain-in-optional.expect.md new file mode 100644 index 000000000000..af046d58b713 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/todo-optional-call-chain-in-optional.expect.md @@ -0,0 +1,54 @@ + +## Input + +```javascript +// @enablePropagateDepsInHIR +function useFoo(props: {value: {x: string; y: string} | null}) { + const value = props.value; + return createArray(value?.x, value?.y)?.join(', '); +} + +function createArray(...args: Array): Array { + return args; +} + +export const FIXTURE_ENTRYPONT = { + fn: useFoo, + props: [{value: null}], +}; + +``` + +## Code + +```javascript +import { c as _c } from "react/compiler-runtime"; // @enablePropagateDepsInHIR +function useFoo(props) { + const $ = _c(3); + const value = props.value; + let t0; + if ($[0] !== value?.x || $[1] !== value?.y) { + t0 = createArray(value?.x, value?.y)?.join(", "); + $[0] = value?.x; + $[1] = value?.y; + $[2] = t0; + } else { + t0 = $[2]; + } + return t0; +} + +function createArray(...t0) { + const args = t0; + return args; +} + +export const FIXTURE_ENTRYPONT = { + fn: useFoo, + props: [{ value: null }], +}; + +``` + +### Eval output +(kind: exception) Fixture not implemented \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/error.todo-optional-call-chain-in-optional.ts b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/todo-optional-call-chain-in-optional.ts similarity index 100% rename from compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/error.todo-optional-call-chain-in-optional.ts rename to compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/propagate-scope-deps-hir-fork/todo-optional-call-chain-in-optional.ts diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/rules-of-hooks/error.invalid-hook-for.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/rules-of-hooks/error.invalid-hook-for.expect.md index 84db054148e4..cd05dccfe6dd 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/rules-of-hooks/error.invalid-hook-for.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/rules-of-hooks/error.invalid-hook-for.expect.md @@ -16,29 +16,24 @@ function Component(props) { ## Error ``` -Found 2 errors: +Found 1 error: -Error: Hooks must always be called in a consistent order, and may not be called conditionally. See the Rules of Hooks (https://react.dev/warnings/invalid-hook-call-warning) +Invariant: Unexpected empty block with `goto` terminal -error.invalid-hook-for.ts:4:9 - 2 | let i = 0; - 3 | for (let x = 0; useHook(x) < 10; useHook(i), x++) { -> 4 | i += useHook(x); - | ^^^^^^^ Hooks must always be called in a consistent order, and may not be called conditionally. See the Rules of Hooks (https://react.dev/warnings/invalid-hook-call-warning) - 5 | } - 6 | return i; - 7 | } +Block bb5 is empty. -Error: Hooks must always be called in a consistent order, and may not be called conditionally. See the Rules of Hooks (https://react.dev/warnings/invalid-hook-call-warning) - -error.invalid-hook-for.ts:3:35 +error.invalid-hook-for.ts:3:2 1 | function Component(props) { 2 | let i = 0; > 3 | for (let x = 0; useHook(x) < 10; useHook(i), x++) { - | ^^^^^^^ Hooks must always be called in a consistent order, and may not be called conditionally. See the Rules of Hooks (https://react.dev/warnings/invalid-hook-call-warning) - 4 | i += useHook(x); - 5 | } + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +> 4 | i += useHook(x); + | ^^^^^^^^^^^^^^^^^^^^ +> 5 | } + | ^^^^ Unexpected empty block with `goto` terminal 6 | return i; + 7 | } + 8 | ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo-optional-call-chain-in-optional.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo-optional-call-chain-in-optional.expect.md new file mode 100644 index 000000000000..c9d71a8c3b79 --- /dev/null +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo-optional-call-chain-in-optional.expect.md @@ -0,0 +1,53 @@ + +## Input + +```javascript +function useFoo(props: {value: {x: string; y: string} | null}) { + const value = props.value; + return createArray(value?.x, value?.y)?.join(', '); +} + +function createArray(...args: Array): Array { + return args; +} + +export const FIXTURE_ENTRYPONT = { + fn: useFoo, + props: [{value: null}], +}; + +``` + +## Code + +```javascript +import { c as _c } from "react/compiler-runtime"; +function useFoo(props) { + const $ = _c(3); + const value = props.value; + let t0; + if ($[0] !== value?.x || $[1] !== value?.y) { + t0 = createArray(value?.x, value?.y)?.join(", "); + $[0] = value?.x; + $[1] = value?.y; + $[2] = t0; + } else { + t0 = $[2]; + } + return t0; +} + +function createArray(...t0) { + const args = t0; + return args; +} + +export const FIXTURE_ENTRYPONT = { + fn: useFoo, + props: [{ value: null }], +}; + +``` + +### Eval output +(kind: exception) Fixture not implemented \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-optional-call-chain-in-optional.ts b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo-optional-call-chain-in-optional.ts similarity index 100% rename from compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/error.todo-optional-call-chain-in-optional.ts rename to compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo-optional-call-chain-in-optional.ts diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo.error.object-pattern-computed-key.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo.error.object-pattern-computed-key.expect.md index 7bc1e49069b6..930be997fad8 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo.error.object-pattern-computed-key.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/todo.error.object-pattern-computed-key.expect.md @@ -23,16 +23,18 @@ export const FIXTURE_ENTRYPOINT = { ``` Found 1 error: -Todo: (BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern +Invariant: [InferMutationAliasingEffects] Expected value kind to be initialized -todo.error.object-pattern-computed-key.ts:5:9 - 3 | const SCALE = 2; + value$3. + +todo.error.object-pattern-computed-key.ts:6:9 4 | function Component(props) { -> 5 | const {[props.name]: value} = props; - | ^^^^^^^^^^^^^^^^^^^ (BuildHIR::lowerAssignment) Handle computed properties in ObjectPattern - 6 | return value; + 5 | const {[props.name]: value} = props; +> 6 | return value; + | ^^^^^ this is uninitialized 7 | } 8 | + 9 | export const FIXTURE_ENTRYPOINT = { ``` \ No newline at end of file diff --git a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/use-no-forget-multiple-with-eslint-suppression.expect.md b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/use-no-forget-multiple-with-eslint-suppression.expect.md index 22386c5205af..b46d71fdf488 100644 --- a/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/use-no-forget-multiple-with-eslint-suppression.expect.md +++ b/compiler/packages/babel-plugin-react-compiler/src/__tests__/fixtures/compiler/use-no-forget-multiple-with-eslint-suppression.expect.md @@ -25,6 +25,7 @@ export const FIXTURE_ENTRYPOINT = { ## Code ```javascript +import { c as _c } from "react/compiler-runtime"; import { useRef } from "react"; const useControllableState = (options) => {}; diff --git a/compiler/packages/eslint-plugin-react-compiler/__tests__/NoCapitalizedCallsRule-test.ts b/compiler/packages/eslint-plugin-react-compiler/__tests__/NoCapitalizedCallsRule-test.ts index 5b45a70fa1d3..0c75ef968adc 100644 --- a/compiler/packages/eslint-plugin-react-compiler/__tests__/NoCapitalizedCallsRule-test.ts +++ b/compiler/packages/eslint-plugin-react-compiler/__tests__/NoCapitalizedCallsRule-test.ts @@ -64,6 +64,9 @@ testRule( makeTestCaseError( 'Capitalized functions are reserved for components', ), + makeTestCaseError( + 'Capitalized functions are reserved for components', + ), ], }, ], diff --git a/compiler/packages/eslint-plugin-react-compiler/__tests__/PluginTest-test.ts b/compiler/packages/eslint-plugin-react-compiler/__tests__/PluginTest-test.ts index e9fe8e001b2e..fe9f12d255cd 100644 --- a/compiler/packages/eslint-plugin-react-compiler/__tests__/PluginTest-test.ts +++ b/compiler/packages/eslint-plugin-react-compiler/__tests__/PluginTest-test.ts @@ -57,7 +57,6 @@ testRule('plugin-recommended', TestRecommendedRules, { ], invalid: [ { - // TODO: actually return multiple diagnostics in this case name: 'Multiple diagnostic kinds from the same function are surfaced', code: normalizeIndent` import Child from './Child'; @@ -70,6 +69,7 @@ testRule('plugin-recommended', TestRecommendedRules, { `, errors: [ makeTestCaseError('Hooks must always be called in a consistent order'), + makeTestCaseError('Capitalized functions are reserved for components'), ], }, { @@ -128,6 +128,7 @@ testRule('plugin-recommended', TestRecommendedRules, { makeTestCaseError( 'Calling setState from useMemo may trigger an infinite loop', ), + makeTestCaseError('Found extra memoization dependencies'), ], }, ], diff --git a/compiler/packages/snap/src/compiler.ts b/compiler/packages/snap/src/compiler.ts index 1ad2b81ef328..0ee2ee0945b0 100644 --- a/compiler/packages/snap/src/compiler.ts +++ b/compiler/packages/snap/src/compiler.ts @@ -378,6 +378,17 @@ export async function transformFixtureInput( msg: 'Expected nothing to be compiled (from `// @expectNothingCompiled`), but some functions compiled or errored', }; } + const unexpectedThrows = logs.filter( + log => log.event.kind === 'CompileUnexpectedThrow', + ); + if (unexpectedThrows.length > 0) { + return { + kind: 'err', + msg: + `Compiler pass(es) threw instead of recording errors:\n` + + unexpectedThrows.map(l => (l.event as any).data).join('\n'), + }; + } return { kind: 'ok', value: {