Skip to content
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.

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

[compiler] First cut at dep inference #31386

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import {
inferReactivePlaces,
inferReferenceEffects,
inlineImmediatelyInvokedFunctionExpressions,
inferEffectDependencies,
} from '../Inference';
import {
constantPropagation,
Expand Down Expand Up @@ -357,6 +358,10 @@ function* runWithEnvironment(
});
}

if (env.config.inferEffectDependencies) {
inferEffectDependencies(env, hir);
}

if (env.config.inlineJsxTransform) {
inlineJsxTransform(hir, env.config.inlineJsxTransform);
yield log({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,11 @@ const EnvironmentConfigSchema = z.object({
*/
enableOptionalDependencies: z.boolean().default(true),

/**
* Enables inference and auto-insertion of effect dependencies. Still experimental.
*/
inferEffectDependencies: z.boolean().default(false),

/**
* Enables inlining ReactElement object literals in place of JSX
* An alternative to the standard JSX transform which replaces JSX with React's jsxProd() runtime
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import {
ArrayExpression,
Effect,
Environment,
FunctionExpression,
GeneratedSource,
HIRFunction,
IdentifierId,
Instruction,
isUseEffectHookType,
makeInstructionId,
} from '../HIR';
import {createTemporaryPlace} from '../HIR/HIRBuilder';

/**
* Infers reactive dependencies captured by useEffect lambdas and adds them as
* a second argument to the useEffect call if no dependency array is provided.
*/
export function inferEffectDependencies(
jbrown215 marked this conversation as resolved.
Show resolved Hide resolved
env: Environment,
fn: HIRFunction,
): void {
const fnExpressions = new Map<IdentifierId, FunctionExpression>();

for (const [, block] of fn.body.blocks) {
let rewriteInstrs = new Map();
for (const instr of block.instructions) {
const {value, lvalue} = instr;
if (value.kind === 'FunctionExpression') {
fnExpressions.set(lvalue.identifier.id, value);
} else if (
/*
* This check is not final. Right now we only look for useEffects without a dependency array.
* This is likely not how we will ship this feature, but it is good enough for us to make progress
* on the implementation and test it.
*/
value.kind === 'CallExpression' &&
isUseEffectHookType(value.callee.identifier) &&
value.args.length === 1 &&
value.args[0].kind === 'Identifier'
) {
const fnExpr = fnExpressions.get(value.args[0].identifier.id);
if (fnExpr != null) {
const deps: ArrayExpression = {
kind: 'ArrayExpression',
elements: fnExpr.loweredFunc.dependencies.filter(
place => place.reactive,
),
loc: GeneratedSource,
};

const depsPlace = createTemporaryPlace(env, GeneratedSource);
depsPlace.effect = Effect.Read;
value.args[1] = depsPlace;

const newInstruction: Instruction = {
id: makeInstructionId(0),
loc: GeneratedSource,
lvalue: depsPlace,
value: deps,
};
rewriteInstrs.set(instr.id, newInstruction);
}
}
}
if (rewriteInstrs.size > 0) {
const newInstrs = [];
for (const instr of block.instructions) {
const newInstr = rewriteInstrs.get(instr.id);
if (newInstr != null) {
newInstrs.push(newInstr, instr);
} else {
newInstrs.push(instr);
}
}
block.instructions = newInstrs;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ export {inferMutableRanges} from './InferMutableRanges';
export {inferReactivePlaces} from './InferReactivePlaces';
export {default as inferReferenceEffects} from './InferReferenceEffects';
export {inlineImmediatelyInvokedFunctionExpressions} from './InlineImmediatelyInvokedFunctionExpressions';
export {inferEffectDependencies} from './InferEffectDependencies';
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@

## Input

```javascript
// @inferEffectDependencies
const moduleNonReactive = 0;

function Component({foo, bar}) {
const localNonreactive = 0;
useEffect(() => {
console.log(foo);
console.log(bar);
console.log(moduleNonReactive);
console.log(localNonreactive);
console.log(globalValue);
});

// Optional chains and property accesses
// TODO: we may be able to save bytes by omitting property accesses if the
// object of the member expression is already included in the inferred deps
useEffect(() => {
console.log(bar?.baz);
console.log(bar.qux);
});

function f() {
console.log(foo);
}

// No inferred dep array, the argument is not a lambda
useEffect(f);
}

```

## Code

```javascript
import { c as _c } from "react/compiler-runtime"; // @inferEffectDependencies
const moduleNonReactive = 0;

function Component(t0) {
const $ = _c(7);
const { foo, bar } = t0;
let t1;
if ($[0] !== foo || $[1] !== bar) {
t1 = () => {
console.log(foo);
console.log(bar);
console.log(moduleNonReactive);
console.log(0);
console.log(globalValue);
};
$[0] = foo;
$[1] = bar;
$[2] = t1;
} else {
t1 = $[2];
}
useEffect(t1, [foo, bar]);
let t2;
if ($[3] !== bar) {
t2 = () => {
console.log(bar?.baz);
console.log(bar.qux);
};
$[3] = bar;
$[4] = t2;
} else {
t2 = $[4];
}
useEffect(t2, [bar, bar.qux]);
let t3;
if ($[5] !== foo) {
t3 = function f() {
console.log(foo);
};
$[5] = foo;
$[6] = t3;
} else {
t3 = $[6];
}
const f = t3;

useEffect(f);
}

```

### Eval output
(kind: exception) Fixture not implemented
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// @inferEffectDependencies
const moduleNonReactive = 0;

function Component({foo, bar}) {
const localNonreactive = 0;
useEffect(() => {
console.log(foo);
console.log(bar);
console.log(moduleNonReactive);
console.log(localNonreactive);
console.log(globalValue);
});

// Optional chains and property accesses
// TODO: we may be able to save bytes by omitting property accesses if the
// object of the member expression is already included in the inferred deps
useEffect(() => {
console.log(bar?.baz);
console.log(bar.qux);
});

function f() {
console.log(foo);
}

// No inferred dep array, the argument is not a lambda
useEffect(f);
}
7 changes: 7 additions & 0 deletions compiler/packages/snap/src/compiler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ function makePluginOptions(
importSpecifierName: '$structuralCheck',
};
}

const hookPatternMatch = /@hookPattern:"([^"]+)"/.exec(firstLine);
if (
hookPatternMatch &&
Expand Down Expand Up @@ -210,6 +211,11 @@ function makePluginOptions(
inlineJsxTransform = {elementSymbol: 'react.transitional.element'};
}

let inferEffectDependencies = false;
if (firstLine.includes('@inferEffectDependencies')) {
inferEffectDependencies = true;
}

let logs: Array<{filename: string | null; event: LoggerEvent}> = [];
let logger: Logger | null = null;
if (firstLine.includes('@logger')) {
Expand Down Expand Up @@ -240,6 +246,7 @@ function makePluginOptions(
lowerContextAccess,
validateBlocklistedImports,
inlineJsxTransform,
inferEffectDependencies,
},
compilationMode,
logger,
Expand Down
Loading