{"patch":"diff --git a\/compiler\/forget\/src\/CompilerError.ts b\/compiler\/forget\/src\/CompilerError.ts\nnew file mode 100644\nindex 0000000000..c3863a8a50\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/CompilerError.ts\n@@ -0,0 +1,34 @@\n+import { SourceLocation } from \".\/HIR\";\n+import type { ExtractClassProperties } from \".\/Utils\/types\";\n+\n+export enum ErrorSeverity {\n+ InvalidInput = \"InvalidInput\",\n+ Todo = \"Todo\",\n+}\n+\n+export type CompilerErrorOptions = ExtractClassProperties;\n+\n+export class CompilerError {\n+ severity: ErrorSeverity;\n+ reason: string;\n+ source: string | null;\n+ loc: SourceLocation | null;\n+\n+ constructor(options: CompilerErrorOptions) {\n+ this.severity = options.severity;\n+ this.reason = options.reason;\n+ this.source = options.source;\n+ this.loc = options.loc;\n+ }\n+\n+ toString(): string {\n+ const buffer = [`[${this.severity.toUpperCase()}] ${this.reason}`];\n+ if (this.loc != null && typeof this.loc != \"symbol\") {\n+ buffer.push(` on lines ${this.loc.start.line}:${this.loc.end.line}`);\n+ }\n+ if (this.source != null) {\n+ buffer.push(`\\n${this.source}`);\n+ }\n+ return `Forget Error: ${buffer.join(\"\")}`;\n+ }\n+}\ndiff --git a\/compiler\/forget\/src\/CompilerPipeline.ts b\/compiler\/forget\/src\/CompilerPipeline.ts\nindex 44cfc54bd5..7751605b1c 100644\n--- a\/compiler\/forget\/src\/CompilerPipeline.ts\n+++ b\/compiler\/forget\/src\/CompilerPipeline.ts\n@@ -44,7 +44,12 @@ export function* run(\n ): Iterator {\n const env = new Environment();\n \n- const hir = lower(func, env);\n+ const lowering = lower(func, env).orElse((errors) => {\n+ const msg = errors.map((error) => error.toString()).join(\"\\n\\n\");\n+ throw new Error(msg);\n+ });\n+\n+ const hir = lowering.unwrap();\n yield log({ kind: \"hir\", name: \"HIR\", value: hir });\n \n mergeConsecutiveBlocks(hir);\ndiff --git a\/compiler\/forget\/src\/HIR\/BuildHIR.ts b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\nindex 273ad8e140..c486f3b50a 100644\n--- a\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n@@ -8,6 +8,8 @@\n import { NodePath, Scope } from \"@babel\/traverse\";\n import * as t from \"@babel\/types\";\n import invariant from \"invariant\";\n+import { CompilerError, ErrorSeverity } from \"..\/CompilerError\";\n+import { Err, Ok, Result } from \"..\/lib\/Result\";\n import todo, { todoInvariant } from \"..\/Utils\/todo\";\n import { assertExhaustive } from \"..\/Utils\/utils\";\n import {\n@@ -64,7 +66,7 @@ function getOrAddGlobal(identifierName: string): t.Identifier {\n export function lower(\n func: NodePath,\n env: Environment\n-): HIRFunction {\n+): Result {\n const builder = new HIRBuilder(env);\n \n const id =\n@@ -73,35 +75,63 @@ export function lower(\n : null;\n \n const params: Array = [];\n- func.node.params.forEach((param) => {\n- todoInvariant(t.isIdentifier(param), \"todo: support non-identifier params\");\n- const identifier = builder.resolveIdentifier(param);\n- const place: Place = {\n- kind: \"Identifier\",\n- identifier,\n- effect: Effect.Unknown,\n- loc: param.loc ?? GeneratedSource,\n- };\n- params.push(place);\n- });\n+ for (const param of func.get(\"params\")) {\n+ if (param.isIdentifier()) {\n+ const identifier = builder.resolveIdentifier(param.node);\n+ const place: Place = {\n+ kind: \"Identifier\",\n+ identifier,\n+ effect: Effect.Unknown,\n+ loc: param.node.loc ?? GeneratedSource,\n+ };\n+ params.push(place);\n+ } else {\n+ builder.pushError({\n+ reason: `Support non-identifier params: ${param.node.type}`,\n+ severity: ErrorSeverity.Todo,\n+ \/\/ 1. We can't use NodePath.toString() because we're using @babel\/traverse directly, see\n+ \/\/ https:\/\/fburl.com\/45x18dcm for details.\n+ \/\/ 2. Only NodePaths override toString to print the source, so if you tried this with\n+ \/\/ Node.toString() you'd just get [object Object].\n+ \/\/ 3. You will see this in other calls to builder.pushError in this file.\n+ source: func.toString(),\n+ loc: param.node.loc ?? null,\n+ });\n+ continue;\n+ }\n+ }\n \n const body = func.get(\"body\");\n if (body.isExpression()) {\n- todoInvariant(false, \"TODO handle arrow functions\");\n+ builder.pushError({\n+ reason: \"Support arrow functions\",\n+ severity: ErrorSeverity.Todo,\n+ source: func.toString(),\n+ loc: body.node.loc ?? null,\n+ });\n } else if (body.isBlockStatement()) {\n lowerStatement(builder, body);\n } else {\n- invariant(false, \"Unexpected function body kind\");\n+ builder.pushError({\n+ reason: `Unexpected function body kind: ${body.type}}`,\n+ severity: ErrorSeverity.InvalidInput,\n+ source: func.toString(),\n+ loc: body.node.loc ?? null,\n+ });\n+ }\n+\n+ if (builder.hasErrors()) {\n+ return Err(builder.errors);\n }\n \n- return {\n+ return Ok({\n id,\n params,\n body: builder.build(),\n generator: func.node.generator === true,\n async: func.node.async === true,\n loc: func.node.loc ?? GeneratedSource,\n- };\n+ });\n }\n \n \/**\n@@ -323,11 +353,16 @@ function lowerStatement(\n const continuationBlock = builder.reserve();\n \n const initBlock = builder.enter(\"value\", (blockId) => {\n- const init = stmt.get(\"init\") as NodePath;\n- todoInvariant(\n- t.isVariableDeclaration(init.node),\n- \"handle non variable initialization in for\"\n- );\n+ const init = stmt.get(\"init\");\n+ if (!init.isVariableDeclaration()) {\n+ builder.pushError({\n+ reason: \"Support non-variable initialization in for\",\n+ severity: ErrorSeverity.Todo,\n+ source: stmt.toString(),\n+ loc: init.node?.loc ?? null,\n+ });\n+ return { kind: \"error\", id: makeInstructionId(0) };\n+ }\n lowerStatement(builder, init);\n return {\n kind: \"goto\",\n@@ -339,10 +374,16 @@ function lowerStatement(\n \n const updateBlock = builder.enter(\"value\", (blockId) => {\n const update = stmt.get(\"update\");\n- todoInvariant(update.hasNode(), \"Handle empty for updater\");\n- if (update.hasNode()) {\n- lowerExpressionToVoid(builder, update);\n+ if (!update.hasNode()) {\n+ builder.pushError({\n+ reason: \"Handle empty for updater\",\n+ severity: ErrorSeverity.Todo,\n+ source: stmt.toString(),\n+ loc: null,\n+ });\n+ return { kind: \"error\", id: makeInstructionId(0) };\n }\n+ lowerExpressionToVoid(builder, update);\n return {\n kind: \"goto\",\n block: testBlock.id,\n@@ -378,19 +419,27 @@ function lowerStatement(\n );\n \n const test = stmt.get(\"test\");\n- todoInvariant(test.hasNode(), \"ForStatement without test\");\n- builder.terminateWithContinuation(\n- \"value\",\n- {\n- kind: \"if\",\n- test: lowerExpressionToPlace(builder, test),\n- consequent: bodyBlock,\n- alternate: continuationBlock.id,\n- fallthrough: continuationBlock.id,\n- id: makeInstructionId(0),\n- },\n- continuationBlock\n- );\n+ if (!test.hasNode()) {\n+ builder.pushError({\n+ reason: \"ForStatement without test\",\n+ severity: ErrorSeverity.Todo,\n+ source: stmt.toString(),\n+ loc: null,\n+ });\n+ } else {\n+ builder.terminateWithContinuation(\n+ \"value\",\n+ {\n+ kind: \"if\",\n+ test: lowerExpressionToPlace(builder, test),\n+ consequent: bodyBlock,\n+ alternate: continuationBlock.id,\n+ fallthrough: continuationBlock.id,\n+ id: makeInstructionId(0),\n+ },\n+ continuationBlock\n+ );\n+ }\n return;\n }\n case \"DoWhileStatement\": {\n@@ -458,19 +507,27 @@ function lowerStatement(\n * to evaluate whether to enter the loop or bypass to the continuation.\n *\/\n const loc = stmt.node.loc;\n- invariant(loc, \"while statement must have a location\");\n- builder.terminateWithContinuation(\n- \"block\",\n- {\n- kind: \"while\",\n- loc,\n- test: conditionalBlock.id,\n- loop: loopBlock,\n- fallthrough: continuationBlock.id,\n- id: makeInstructionId(0),\n- },\n- conditionalBlock\n- );\n+ if (loc == null) {\n+ builder.pushError({\n+ reason: \"while statement must have a location\",\n+ severity: ErrorSeverity.InvalidInput,\n+ source: stmt.toString(),\n+ loc: null,\n+ });\n+ } else {\n+ builder.terminateWithContinuation(\n+ \"block\",\n+ {\n+ kind: \"while\",\n+ loc,\n+ test: conditionalBlock.id,\n+ loop: loopBlock,\n+ fallthrough: continuationBlock.id,\n+ id: makeInstructionId(0),\n+ },\n+ conditionalBlock\n+ );\n+ }\n \/**\n * The conditional block is empty and exists solely as conditional for\n * (re)entering or exiting the loop\n@@ -544,10 +601,16 @@ function lowerStatement(\n const case_: NodePath = stmt.get(\"cases\")[ii];\n const test = case_.get(\"test\");\n if (!test.hasNode()) {\n- invariant(\n- !hasDefault,\n- \"Expected at most one `default` branch, this code should have failed to parse\"\n- );\n+ if (hasDefault) {\n+ builder.pushError({\n+ reason:\n+ \"Expected at most one `default` branch, this code should have failed to parse\",\n+ severity: ErrorSeverity.InvalidInput,\n+ source: stmt.toString(),\n+ loc: case_.node.loc ?? null,\n+ });\n+ break;\n+ }\n hasDefault = true;\n }\n const block = builder.enter(\"block\", (_blockId) => {\n@@ -623,10 +686,16 @@ function lowerStatement(\n case \"VariableDeclaration\": {\n const stmt = stmtPath as NodePath;\n const nodeKind: string = stmt.node.kind;\n- invariant(\n- nodeKind === \"let\" || nodeKind === \"const\",\n- \"`var` declarations are not supported, use let or const\"\n- );\n+ if (nodeKind === \"var\") {\n+ builder.pushError({\n+ reason: \"`var` declarations are not supported, use let or const\",\n+ severity: ErrorSeverity.Todo,\n+ source: stmt.toString(),\n+ loc: stmt.node.loc ?? null,\n+ });\n+ \/\/ TODO: should we lower this to an error variant\n+ return;\n+ }\n const kind =\n nodeKind === \"let\" ? InstructionKind.Let : InstructionKind.Const;\n for (const declaration of stmt.get(\"declarations\")) {\ndiff --git a\/compiler\/forget\/src\/HIR\/HIR.ts b\/compiler\/forget\/src\/HIR\/HIR.ts\nindex 8ca75dd57e..99b4297bdb 100644\n--- a\/compiler\/forget\/src\/HIR\/HIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIR.ts\n@@ -167,6 +167,7 @@ export type BasicBlock = {\n * for-of, if-else, return, etc.\n *\/\n export type Terminal =\n+ | ErrorTerminal\n | ThrowTerminal\n | ReturnTerminal\n | GotoTerminal\n@@ -180,7 +181,8 @@ export type Terminal =\n * Terminal nodes allowed for a value block\n *\/\n export type ValueTerminal = IfTerminal | GotoTerminal;\n-\n+\/\/ A terminal that couldn't be lowered correctly.\n+export type ErrorTerminal = { kind: \"error\"; id: InstructionId };\n export type ThrowTerminal = { kind: \"throw\"; value: Place; id: InstructionId };\n \n export type ReturnTerminal = {\ndiff --git a\/compiler\/forget\/src\/HIR\/HIRBuilder.ts b\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\nindex 42186e8d42..c625e90806 100644\n--- a\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIRBuilder.ts\n@@ -7,6 +7,7 @@\n \n import * as t from \"@babel\/types\";\n import invariant from \"invariant\";\n+import { CompilerError, CompilerErrorOptions } from \"..\/CompilerError\";\n import { logHIR } from \"..\/Utils\/logger\";\n import { assertExhaustive } from \"..\/Utils\/utils\";\n import {\n@@ -83,6 +84,7 @@ export default class HIRBuilder {\n #scopes: Array = [];\n #bindings: Map = new Map();\n #env: Environment;\n+ errors: CompilerError[] = [];\n \n get nextIdentifierId() {\n return this.#env.nextIdentifierId;\n@@ -365,6 +367,16 @@ export default class HIRBuilder {\n }\n invariant(false, \"Expected a loop to be in scope\");\n }\n+\n+ pushError(options: CompilerErrorOptions): CompilerError {\n+ const error = new CompilerError(options);\n+ this.errors.push(error);\n+ return error;\n+ }\n+\n+ hasErrors(): boolean {\n+ return this.errors.length > 0;\n+ }\n }\n \n \/**\n@@ -515,6 +527,9 @@ export function reversePostorderBlocks(func: HIR): void {\n visit(terminal.init);\n break;\n }\n+ case \"error\": {\n+ break;\n+ }\n default: {\n assertExhaustive(\n terminal,\ndiff --git a\/compiler\/forget\/src\/HIR\/HIRTreeVisitor.ts b\/compiler\/forget\/src\/HIR\/HIRTreeVisitor.ts\nindex cfe91654fe..35b6d1322d 100644\n--- a\/compiler\/forget\/src\/HIR\/HIRTreeVisitor.ts\n+++ b\/compiler\/forget\/src\/HIR\/HIRTreeVisitor.ts\n@@ -485,6 +485,8 @@ class Driver<\n }\n break;\n }\n+ case \"error\":\n+ break;\n default: {\n assertExhaustive(terminal, \"Unexpected terminal\");\n }\ndiff --git a\/compiler\/forget\/src\/HIR\/PrintHIR.ts b\/compiler\/forget\/src\/HIR\/PrintHIR.ts\nindex 163f03a075..6c2725a87a 100644\n--- a\/compiler\/forget\/src\/HIR\/PrintHIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/PrintHIR.ts\n@@ -82,6 +82,7 @@ export function printMixedHIR(\n case \"throw\":\n case \"while\":\n case \"for\":\n+ case \"error\":\n case \"goto\": {\n const terminal = printTerminal(value);\n if (Array.isArray(terminal)) {\n@@ -179,6 +180,10 @@ export function printTerminal(terminal: Terminal): Array | string {\n value = `[${terminal.id}] For init=bb${terminal.init} test=bb${terminal.test} loop=bb${terminal.loop} update=bb${terminal.update} fallthrough=bb${terminal.fallthrough}`;\n break;\n }\n+ case \"error\": {\n+ value = `Error`;\n+ break;\n+ }\n default: {\n assertExhaustive(\n terminal,\ndiff --git a\/compiler\/forget\/src\/HIR\/visitors.ts b\/compiler\/forget\/src\/HIR\/visitors.ts\nindex b06d87b632..bb795cb38e 100644\n--- a\/compiler\/forget\/src\/HIR\/visitors.ts\n+++ b\/compiler\/forget\/src\/HIR\/visitors.ts\n@@ -292,6 +292,9 @@ export function mapTerminalSuccessors(\n id: makeInstructionId(0),\n };\n }\n+ case \"error\": {\n+ return terminal;\n+ }\n default: {\n assertExhaustive(\n terminal,\n@@ -341,6 +344,8 @@ export function* eachTerminalSuccessor(terminal: Terminal): Iterable {\n yield terminal.init;\n break;\n }\n+ case \"error\":\n+ break;\n default: {\n assertExhaustive(\n terminal,\n@@ -379,7 +384,8 @@ export function mapTerminalOperands(\n case \"logical\":\n case \"while\":\n case \"for\":\n- case \"goto\": {\n+ case \"goto\":\n+ case \"error\": {\n \/\/ no-op\n break;\n }\n@@ -418,7 +424,8 @@ export function* eachTerminalOperand(terminal: Terminal): Iterable {\n case \"logical\":\n case \"while\":\n case \"for\":\n- case \"goto\": {\n+ case \"goto\":\n+ case \"error\": {\n \/\/ no-op\n break;\n }\ndiff --git a\/compiler\/forget\/src\/Utils\/VisualizeHIRMermaid.ts b\/compiler\/forget\/src\/Utils\/VisualizeHIRMermaid.ts\nindex 01a9db7398..57fb2cd4c2 100644\n--- a\/compiler\/forget\/src\/Utils\/VisualizeHIRMermaid.ts\n+++ b\/compiler\/forget\/src\/Utils\/VisualizeHIRMermaid.ts\n@@ -105,6 +105,9 @@ function printTerminalLabel(terminal: Terminal): string {\n case \"for\":\n buffer.push(\"For\");\n break;\n+ case \"error\": {\n+ break;\n+ }\n default:\n assertExhaustive(terminal, `unhandled terminal ${terminal}`);\n }\n@@ -168,7 +171,8 @@ function printTerminalArrows(blockId: BlockId, terminal: Terminal): string {\n break;\n }\n case \"throw\":\n- case \"return\": {\n+ case \"return\":\n+ case \"error\": {\n break;\n }\n default:\ndiff --git a\/compiler\/forget\/src\/Utils\/types.d.ts b\/compiler\/forget\/src\/Utils\/types.d.ts\nnew file mode 100644\nindex 0000000000..957c14a909\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/Utils\/types.d.ts\n@@ -0,0 +1,3 @@\n+export type ExtractClassProperties = {\n+ [K in keyof C as C[K] extends Function ? never : K]: C[K];\n+};\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md\nnew file mode 100644\nindex 0000000000..59b87b225d\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md\n@@ -0,0 +1,106 @@\n+\n+## Input\n+\n+```javascript\n+function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3; ) {}\n+ for (;;) {}\n+}\n+\n+```\n+\n+\n+## Error\n+\n+```\n+Forget Error: [TODO] Support non-identifier params: ArrayPattern on lines 1:1\n+function foo([a, b], {\n+ c,\n+ d,\n+ e = \"e\"\n+}, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3;) {}\n+ for (;;) {}\n+}\n+\n+Forget Error: [TODO] Support non-identifier params: ObjectPattern on lines 1:1\n+function foo([a, b], {\n+ c,\n+ d,\n+ e = \"e\"\n+}, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3;) {}\n+ for (;;) {}\n+}\n+\n+Forget Error: [TODO] Support non-identifier params: AssignmentPattern on lines 1:1\n+function foo([a, b], {\n+ c,\n+ d,\n+ e = \"e\"\n+}, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3;) {}\n+ for (;;) {}\n+}\n+\n+Forget Error: [TODO] Support non-identifier params: RestElement on lines 1:1\n+function foo([a, b], {\n+ c,\n+ d,\n+ e = \"e\"\n+}, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3;) {}\n+ for (;;) {}\n+}\n+\n+Forget Error: [TODO] `var` declarations are not supported, use let or const on lines 3:3\n+var x = [];\n+\n+Forget Error: [TODO] Support non-variable initialization in for\n+for (; i < 3; i += 1) {\n+ x.push(i);\n+}\n+\n+Forget Error: [TODO] Support non-variable initialization in for\n+for (; i < 3;) {}\n+\n+Forget Error: [TODO] Handle empty for updater\n+for (; i < 3;) {}\n+\n+Forget Error: [TODO] Support non-variable initialization in for\n+for (;;) {}\n+\n+Forget Error: [TODO] Handle empty for updater\n+for (;;) {}\n+\n+Forget Error: [TODO] ForStatement without test\n+for (;;) {}\n+```\n+ \n+ \n\\ No newline at end of file\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.js b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.js\nnew file mode 100644\nindex 0000000000..00726d7b46\n--- \/dev\/null\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.js\n@@ -0,0 +1,10 @@\n+function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ let i = 0;\n+ var x = [];\n+\n+ for (; i < 3; i += 1) {\n+ x.push(i);\n+ }\n+ for (; i < 3; ) {}\n+ for (;;) {}\n+}\n","body":"Remove invariants and collect all errors","commit":{"authorName":"Lauren Tan","authorEmail":"poteto@users.noreply.github.com","revision":"7c65f62c27921f4dc887f6e83eab433a0a39d956","subject":"Collect bailouts in BuildHIR::lowerStatement","shortRevision":"7c65f62c27","authoredAt":"2023-01-13T16:14:07-05:00"},"parents":["73f09248fb9f6642f89580e3de7cfcb37b605186"],"files":[{"path":"compiler\/forget\/src\/CompilerError.ts","status":"A"},{"path":"compiler\/forget\/src\/CompilerPipeline.ts","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\/HIR\/HIRTreeVisitor.ts","status":"M"},{"path":"compiler\/forget\/src\/HIR\/PrintHIR.ts","status":"M"},{"path":"compiler\/forget\/src\/HIR\/visitors.ts","status":"M"},{"path":"compiler\/forget\/src\/Utils\/VisualizeHIRMermaid.ts","status":"M"},{"path":"compiler\/forget\/src\/Utils\/types.d.ts","status":"A"},{"path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md","status":"A"},{"path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.js","status":"A"}]}

dillon1000/react

Files changed