{"body":"This lets us treat global references differently from captured references.","commit":{"authorName":"Sathya Gunasekaran","authoredAt":"2023-02-02T14:05:34+00:00","subject":"[λ] Store and define captured bindings as context","authorEmail":"gsathya.ceg@gmail.com","revision":"0522d5233bc1bd5a98ba5c266bfa4c08dc7eaa72","shortRevision":"0522d5233b"},"files":[{"status":"M","path":"compiler\/forget\/src\/HIR\/BuildHIR.ts"},{"status":"M","path":"compiler\/forget\/src\/HIR\/HIR.ts"},{"status":"M","path":"compiler\/forget\/src\/HIR\/HIRBuilder.ts"},{"status":"M","path":"compiler\/forget\/src\/Inference\/AnalyseFunctions.ts"},{"status":"M","path":"compiler\/forget\/src\/Inference\/InferReferenceEffects.ts"},{"status":"M","path":"compiler\/forget\/src\/SSA\/EnterSSA.ts"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.expect.md"},{"status":"R100","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.js","previousPath":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.js"},{"status":"A","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.expect.md"},{"status":"M","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js"},{"status":"D","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.expect.md"}],"patch":"diff --git a\/compiler\/forget\/src\/HIR\/BuildHIR.ts b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\nindex cdb1680f80..39246a7bec 100644\n--- a\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n@@ -49,10 +49,21 @@ import HIRBuilder, { Environment } from \".\/HIRBuilder\";\n * grained reactivity.\n *\/\n export function lower(\n- func: NodePath\n+ func: NodePath,\n+ capturedRefs?: t.Identifier[]\n ): Result {\n const env = new Environment();\n const builder = new HIRBuilder(env);\n+ const context: Place[] = [];\n+\n+ for (const ref of capturedRefs ?? []) {\n+ context.push({\n+ kind: \"Identifier\",\n+ identifier: builder.resolveBinding(ref),\n+ effect: Effect.Unknown,\n+ loc: GeneratedSource,\n+ });\n+ }\n \n \/\/ Internal babel is on an older version that does not have hasNode (v7.17)\n \/\/ See https:\/\/github.com\/babel\/babel\/pull\/13940\/files for impl\n@@ -125,6 +136,7 @@ export function lower(\n id,\n params,\n body: builder.build(),\n+ context,\n generator: func.node.generator === true,\n async: func.node.async === true,\n loc: func.node.loc ?? GeneratedSource,\n@@ -1300,12 +1312,8 @@ function lowerExpression(\n name = expr.get(\"id\")?.node?.name ?? null;\n }\n const componentScope: Scope = expr.scope.parent.getFunctionParent()!;\n- const dependencies: Array = gatherCapturedDeps(\n- builder,\n- expr,\n- componentScope\n- );\n- const lowering = lower(expr);\n+ const captured = gatherCapturedDeps(builder, expr, componentScope);\n+ const lowering = lower(expr, captured.identifiers);\n let loweredFunc: HIRFunction;\n if (lowering.isErr()) {\n lowering\n@@ -1340,7 +1348,7 @@ function lowerExpression(\n name,\n params,\n loweredFunc,\n- dependencies,\n+ dependencies: captured.refs,\n mutatedDeps: [],\n expr: expr.node,\n loc: exprLoc,\n@@ -1919,8 +1927,9 @@ function gatherCapturedDeps(\n builder: HIRBuilder,\n fn: NodePath,\n componentScope: Scope\n-): Array {\n- const captured: Set = new Set();\n+): { identifiers: t.Identifier[]; refs: Place[] } {\n+ const capturedIds: Set = new Set();\n+ const capturedRefs: Set = new Set();\n \n \/\/ Capture all the scopes from the parent of this function up to and including\n \/\/ the component scope.\n@@ -1946,9 +1955,10 @@ function gatherCapturedDeps(\n }\n \n path.skip();\n- captured.add(lowerExpressionToPlace(builder, path));\n+ capturedIds.add(binding.identifier);\n+ capturedRefs.add(lowerExpressionToPlace(builder, path));\n },\n });\n \n- return [...captured];\n+ return { identifiers: [...capturedIds], refs: [...capturedRefs] };\n }\ndiff --git a\/compiler\/forget\/src\/HIR\/HIR.ts b\/compiler\/forget\/src\/HIR\/HIR.ts\nindex 779cd611ff..04997055e3 100644\n--- a\/compiler\/forget\/src\/HIR\/HIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIR.ts\n@@ -184,6 +184,7 @@ export type HIRFunction = {\n id: Identifier | null;\n env: Environment;\n params: Array;\n+ context: Array;\n body: HIR;\n generator: boolean;\n async: boolean;\ndiff --git a\/compiler\/forget\/src\/HIR\/HIRBuilder.ts b\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\nindex 4b97fa27fb..b06cdba3eb 100644\n--- a\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\n@@ -172,6 +172,11 @@ export default class HIRBuilder {\n const node =\n path.scope.getBindingIdentifier(originalName) ??\n getOrAddGlobal(originalName);\n+ return this.resolveBinding(node);\n+ }\n+\n+ resolveBinding(node: t.Identifier) {\n+ const originalName = node.name;\n let name = originalName;\n let index = 0;\n while (true) {\ndiff --git a\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts b\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts\nindex 93dcf1e6c1..6ca02a107f 100644\n--- a\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts\n+++ b\/compiler\/forget\/src\/Inference\/AnalyseFunctions.ts\n@@ -1,11 +1,4 @@\n-import {\n- Effect,\n- HIRFunction,\n- Identifier,\n- mergeConsecutiveBlocks,\n- Place,\n-} from \"..\/HIR\";\n-import { eachInstructionOperand } from \"..\/HIR\/visitors\";\n+import { HIRFunction, Identifier, mergeConsecutiveBlocks, Place } from \"..\/HIR\";\n import { constantPropagation } from \"..\/Optimization\";\n import { eliminateRedundantPhi, enterSSA } from \"..\/SSA\";\n import { inferTypes } from \"..\/TypeInference\";\n@@ -116,18 +109,13 @@ function analyzeMutatedPlaces(func: HIRFunction): Array {\n ) {\n mutations.push(...analyzeMutatedPlaces(instr.value.loweredFunc));\n }\n-\n- for (const operand of eachInstructionOperand(instr)) {\n- if (isMutated(operand)) {\n- mutations.push(operand);\n- }\n- }\n }\n }\n \n+ mutations.push(...func.context.filter((dep) => isMutated(dep.identifier)));\n return mutations;\n }\n \n-function isMutated(place: Place): boolean {\n- return place.effect === Effect.Mutate || place.effect === Effect.Store;\n+function isMutated(id: Identifier) {\n+ return id.mutableRange.end - id.mutableRange.start > 1;\n }\ndiff --git a\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts b\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\nindex 40fdaddfc9..fdf2a03f08 100644\n--- a\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\n+++ b\/compiler\/forget\/src\/Inference\/InferReferenceEffects.ts\n@@ -93,6 +93,17 @@ export default function inferReferenceEffects(fn: HIRFunction) {\n initialEnvironment.define(id, value);\n }\n \n+ for (const ref of fn.context) {\n+ \/\/ TODO(gsn): This is a hack.\n+ const value: InstructionValue = {\n+ kind: \"ObjectExpression\",\n+ properties: null,\n+ loc: ref.loc,\n+ };\n+ initialEnvironment.initialize(value, ValueKind.Mutable);\n+ initialEnvironment.define(ref, value);\n+ }\n+\n for (const param of fn.params) {\n const value: InstructionValue = {\n kind: \"Primitive\",\ndiff --git a\/compiler\/forget\/src\/SSA\/EnterSSA.ts b\/compiler\/forget\/src\/SSA\/EnterSSA.ts\nindex 0f6f9ec5c1..c404abed68 100644\n--- a\/compiler\/forget\/src\/SSA\/EnterSSA.ts\n+++ b\/compiler\/forget\/src\/SSA\/EnterSSA.ts\n@@ -195,6 +195,7 @@ export default function enterSSA(func: HIRFunction) {\n builder.startBlock(block);\n \n if (func.body.entry === blockId) {\n+ func.context = func.context.map((p) => builder.definePlace(p));\n func.params = func.params.map((p) => builder.definePlace(p));\n }\n \ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.expect.md\nnew file mode 100644\nindex 0000000000..3a4cadfef2\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.expect.md\n@@ -0,0 +1,97 @@\n+\n+## Input\n+\n+```javascript\n+function getNativeLogFunction(level) {\n+ return function () {\n+ let str;\n+ if (arguments.length === 1 && typeof arguments[0] === \"string\") {\n+ str = arguments[0];\n+ } else {\n+ str = Array.prototype.map\n+ .call(arguments, function (arg) {\n+ return inspect(arg, {\n+ depth: 10,\n+ });\n+ })\n+ .join(\", \");\n+ }\n+ const firstArg = arguments[0];\n+ let logLevel = level;\n+ if (\n+ typeof firstArg === \"string\" &&\n+ firstArg.slice(0, 9) === \"Warning: \" &&\n+ logLevel >= LOG_LEVELS.error\n+ ) {\n+ logLevel = LOG_LEVELS.warn;\n+ }\n+ if (global.__inspectorLog) {\n+ global.__inspectorLog(\n+ INSPECTOR_LEVELS[logLevel],\n+ str,\n+ [].slice.call(arguments),\n+ INSPECTOR_FRAMES_TO_SKIP\n+ );\n+ }\n+ if (groupStack.length) {\n+ str = groupFormat(\"\", str);\n+ }\n+ global.nativeLoggingHook(str, logLevel);\n+ };\n+}\n+\n+```\n+\n+## Code\n+\n+```javascript\n+function getNativeLogFunction(level) {\n+ const $ = React.useMemoCache();\n+ const c_0 = $[0] !== level;\n+ let t1;\n+ if (c_0) {\n+ t1 = function () {\n+ let str;\n+ if (arguments.length === 1 && typeof arguments[0] === \"string\") {\n+ str = arguments[0];\n+ } else {\n+ str = Array.prototype.map\n+ .call(arguments, function (arg) {\n+ return inspect(arg, {\n+ depth: 10,\n+ });\n+ })\n+ .join(\", \");\n+ }\n+ const firstArg = arguments[0];\n+ let logLevel = level;\n+ if (\n+ typeof firstArg === \"string\" &&\n+ firstArg.slice(0, 9) === \"Warning: \" &&\n+ logLevel >= LOG_LEVELS.error\n+ ) {\n+ logLevel = LOG_LEVELS.warn;\n+ }\n+ if (global.__inspectorLog) {\n+ global.__inspectorLog(\n+ INSPECTOR_LEVELS[logLevel],\n+ str,\n+ [].slice.call(arguments),\n+ INSPECTOR_FRAMES_TO_SKIP\n+ );\n+ }\n+ if (groupStack.length) {\n+ str = groupFormat(\"\", str);\n+ }\n+ global.nativeLoggingHook(str, logLevel);\n+ };\n+ $[0] = level;\n+ $[1] = t1;\n+ } else {\n+ t1 = $[1];\n+ }\n+ return t1;\n+}\n+\n+```\n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.js\nsimilarity index 100%\nrename from compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.js\nrename to compiler\/forget\/src\/__tests__\/fixtures\/hir\/capture-param-mutate.js\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.expect.md\nnew file mode 100644\nindex 0000000000..66c380ceec\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.expect.md\n@@ -0,0 +1,38 @@\n+\n+## Input\n+\n+```javascript\n+function component(a) {\n+ let y = { b: { a } };\n+ let x = function () {\n+ y.b.a = 2;\n+ };\n+ x();\n+ return x;\n+}\n+\n+```\n+\n+## Code\n+\n+```javascript\n+function component(a) {\n+ const $ = React.useMemoCache();\n+ const c_0 = $[0] !== a;\n+ let x;\n+ if (c_0) {\n+ const y = { b: { a: a } };\n+ x = function () {\n+ y.b.a = 2;\n+ };\n+ x();\n+ $[0] = a;\n+ $[1] = x;\n+ } else {\n+ x = $[1];\n+ }\n+ return x;\n+}\n+\n+```\n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js\nindex 9ad43aeb80..f1ba1cd25f 100644\n--- a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/capturing-func-mutate-nested.js\n@@ -1,5 +1,3 @@\n-\/\/ @skip\n-\/\/ TODO(gsn): This doesn't seem to work correctly. Need to debug more.\n function component(a) {\n let y = { b: { a } };\n let x = function () {\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.expect.md\ndeleted file mode 100644\nindex 58336c9051..0000000000\n--- a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error._bug_fbsource_pokes_infer_reference_effects.expect.md\n+++ \/dev\/null\n@@ -1,52 +0,0 @@\n-\n-## Input\n-\n-```javascript\n-function getNativeLogFunction(level) {\n- return function () {\n- let str;\n- if (arguments.length === 1 && typeof arguments[0] === \"string\") {\n- str = arguments[0];\n- } else {\n- str = Array.prototype.map\n- .call(arguments, function (arg) {\n- return inspect(arg, {\n- depth: 10,\n- });\n- })\n- .join(\", \");\n- }\n- const firstArg = arguments[0];\n- let logLevel = level;\n- if (\n- typeof firstArg === \"string\" &&\n- firstArg.slice(0, 9) === \"Warning: \" &&\n- logLevel >= LOG_LEVELS.error\n- ) {\n- logLevel = LOG_LEVELS.warn;\n- }\n- if (global.__inspectorLog) {\n- global.__inspectorLog(\n- INSPECTOR_LEVELS[logLevel],\n- str,\n- [].slice.call(arguments),\n- INSPECTOR_FRAMES_TO_SKIP\n- );\n- }\n- if (groupStack.length) {\n- str = groupFormat(\"\", str);\n- }\n- global.nativeLoggingHook(str, logLevel);\n- };\n-}\n-\n-```\n-\n-\n-## Error\n-\n-```\n-[ReactForget] Invariant: InferReferenceEffects::kind: Expected at least one value at ' logLevel$85:TPrimitive' (20:20)\n-```\n- \n- \n\\ No newline at end of file\n","parents":["8a0d3169fdb526ac68567ed9b3d6cd7b67d2ded3"]}

dillon1000/react

Files changed