Skip to content

[compiler] propagate declaration locations through HIR pipeline #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nathanmarks wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[compiler] propagate declaration locations through HIR pipeline #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ function lowerStatement(
kind: InstructionKind.Let,
place,
},
loc: id.node.loc ?? GeneratedSource,
loc: stmt.node.loc ?? GeneratedSource,
});
} else {
const typeAnnotation = id.get('typeAnnotation');
Expand All @@ -952,7 +952,7 @@ function lowerStatement(
place,
},
type,
loc: id.node.loc ?? GeneratedSource,
loc: stmt.node.loc ?? GeneratedSource,
});
}
}
Expand Down
1 change: 1 addition & 0 deletions compiler/packages/babel-plugin-react-compiler/src/HIR/HIR.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1649,6 +1649,7 @@ export type ReactiveScopeDependencies = Set<ReactiveScopeDependency>;
export type ReactiveScopeDeclaration = {
identifier: Identifier;
scope: ReactiveScope; // the scope in which the variable was originally declared
loc: SourceLocation;
};

const opaquePropertyLiteral = Symbol();
Expand Down
11 changes: 11 additions & 0 deletions compiler/packages/babel-plugin-react-compiler/src/HIR/PropagateScopeDependenciesHIR.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
LoadContext,
TInstruction,
FunctionExpression,
SourceLocation,
ObjectMethod,
PropertyLiteral,
convertHoistedLValueKind,
Expand Down Expand Up @@ -393,6 +394,7 @@ function getProperty(
type Decl = {
id: InstructionId;
scope: Stack<ReactiveScope>;
loc: SourceLocation;
};

export class DependencyCollectionContext {
Expand Down Expand Up @@ -602,6 +604,7 @@ export class DependencyCollectionContext {
scope.declarations.set(maybeDependency.identifier.id, {
identifier: maybeDependency.identifier,
scope: originalDeclaration.scope.value!,
loc: originalDeclaration.loc,
});
}
});
Expand Down Expand Up @@ -686,6 +689,7 @@ export function handleInstruction(
context.declare(lvalue.identifier, {
id,
scope: context.currentScope,
loc: instr.loc,
});
if (
context.isDeferredDependency({kind: HIRValue.Instruction, value: instr})
Expand All @@ -702,6 +706,7 @@ export function handleInstruction(
context.declare(value.lvalue.place.identifier, {
id,
scope: context.currentScope,
loc: instr.loc,
});
} else if (value.kind === 'DeclareLocal' || value.kind === 'DeclareContext') {
/*
Expand All @@ -718,6 +723,7 @@ export function handleInstruction(
context.declare(value.lvalue.place.identifier, {
id,
scope: context.currentScope,
loc: instr.loc,
});
}
} else if (value.kind === 'Destructure') {
Expand All @@ -729,6 +735,7 @@ export function handleInstruction(
context.declare(place.identifier, {
id,
scope: context.currentScope,
loc: instr.loc,
});
}
} else if (value.kind === 'StoreContext') {
Expand All @@ -745,6 +752,7 @@ export function handleInstruction(
context.declare(value.lvalue.place.identifier, {
id,
scope: context.currentScope,
loc: instr.loc,
});
}

Expand Down Expand Up @@ -775,11 +783,13 @@ function collectDependencies(
context.declare(param.identifier, {
id: makeInstructionId(0),
scope: empty(),
loc: param.identifier.loc,
});
} else {
context.declare(param.place.identifier, {
id: makeInstructionId(0),
scope: empty(),
loc: param.place.loc,
});
}
}
Expand Down Expand Up @@ -812,6 +822,7 @@ function collectDependencies(
context.declare(instr.lvalue.identifier, {
id: instr.id,
scope: context.currentScope,
loc: instr.loc,
});
/**
* Recursively visit the inner function to extract dependencies there
Expand Down
2 changes: 2 additions & 0 deletions compiler/packages/babel-plugin-react-compiler/src/Inference/InferEffectDependencies.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,7 @@ function inferDependencies(
context.declare(dep.identifier, {
id: makeInstructionId(0),
scope: empty(),
loc: dep.identifier.loc,
});
}
const placeholderScope: ReactiveScope = {
Expand Down Expand Up @@ -694,6 +695,7 @@ function inferDependenciesInFn(
context.declare(instr.lvalue.identifier, {
id: instr.id,
scope: context.currentScope,
loc: instr.loc,
});
/**
* Recursively visit the inner function to extract dependencies
Expand Down
1 change: 1 addition & 0 deletions compiler/packages/babel-plugin-react-compiler/src/Optimization/InlineJsxTransform.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ export function inlineJsxTransform(
scope.declarations.set(decl.identifier.id, {
identifier: newDecl,
scope: decl.scope,
loc: decl.loc,
});
}
}
Expand Down
8 changes: 5 additions & 3 deletions compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/CodegenReactiveFunction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,8 +675,8 @@ function codegenReactiveScope(
}
let firstOutputIndex: number | null = null;

for (const [, {identifier}] of [...scope.declarations].sort(([, a], [, b]) =>
compareScopeDeclaration(a, b),
for (const [, {identifier, loc}] of [...scope.declarations].sort(
([, a], [, b]) => compareScopeDeclaration(a, b),
)) {
const index = cx.nextCacheIndex;
if (firstOutputIndex === null) {
Expand All @@ -702,7 +702,9 @@ function codegenReactiveScope(
outputComments.push(name.name);
if (!cx.hasDeclared(identifier)) {
statements.push(
t.variableDeclaration('let', [createVariableDeclarator(name, null)]),
createVariableDeclaration(loc, 'let', [
createVariableDeclarator(name, null),
]),
);
}
cacheLoads.push({name, index, value: wrapCacheDep(cx, name)});
Expand Down
1 change: 1 addition & 0 deletions compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/PropagateEarlyReturns.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ class Transform extends ReactiveFunctionTransform<State> {
scopeBlock.scope.declarations.set(earlyReturnValue.value.id, {
identifier: earlyReturnValue.value,
scope: scopeBlock.scope,
loc: earlyReturnValue.loc,
});

const instructions = scopeBlock.instructions;
Expand Down
28 changes: 1 addition & 27 deletions ...r/src/__tests__/fixtures/compiler/error.todo-missing-source-locations.expect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function Component({prop1, prop2}) {
## Error

```
Found 25 errors:
Found 23 errors:
Todo: Important source location missing in generated code
Expand All @@ -69,19 +69,6 @@ error.todo-missing-source-locations.ts:4:9
Todo: Important source location missing in generated code
Source location for VariableDeclaration is missing in the generated output. This can cause coverage instrumentation to fail to track this code properly, resulting in inaccurate coverage reports..
error.todo-missing-source-locations.ts:9:2
7 | const arr = [x, y];
8 | const obj = {x, y};
> 9 | let destA, destB;
| ^^^^^^^^^^^^^^^^^
10 | if (y > 5) {
11 | [destA, destB] = arr;
12 | }
Todo: Important source location missing in generated code
Source location for ExpressionStatement is missing in the generated output. This can cause coverage instrumentation to fail to track this code properly, resulting in inaccurate coverage reports..
error.todo-missing-source-locations.ts:11:4
Expand Down Expand Up @@ -121,19 +108,6 @@ error.todo-missing-source-locations.ts:15:15
Todo: Important source location missing in generated code
Source location for VariableDeclaration is missing in the generated output. This can cause coverage instrumentation to fail to track this code properly, resulting in inaccurate coverage reports..
error.todo-missing-source-locations.ts:16:2
14 | const [a, b] = arr;
15 | const {x: c, y: d} = obj;
> 16 | let sound;
| ^^^^^^^^^^
17 |
18 | if (y > 10) {
19 | sound = 'woof';
Todo: Important source location missing in generated code
Source location for ExpressionStatement is missing in the generated output. This can cause coverage instrumentation to fail to track this code properly, resulting in inaccurate coverage reports..
error.todo-missing-source-locations.ts:19:4
Expand Down
Loading