as-test 0.1.7 → 0.1.8

package/transform/src/coverage.ts

@@ -0,0 +1,581 @@
+import {
+  Source,
+  Statement,
+  Token,
+  BinaryExpression,
+  CommaExpression,
+  ParenthesizedExpression,
+  ParameterNode,
+  BlockStatement,
+  ExpressionStatement,
+  FunctionDeclaration,
+  IfStatement,
+  MethodDeclaration,
+  ReturnStatement,
+  SwitchCase,
+  TernaryExpression,
+  NodeKind,
+  ArrowKind,
+  Node,
+} from "assemblyscript/dist/assemblyscript.js";
+
+import { BaseVisitor, SimpleParser } from "visitor-as/dist/index.js";
+import { RangeTransform } from "visitor-as/dist/transformRange.js";
+import { isStdlib } from "visitor-as/dist/utils.js";
+
+enum CoverType {
+  Function,
+  Expression,
+  Block,
+}
+
+class CoverPoint {
+  public file: string = "";
+  public hash: string = "";
+  public line: number = 0;
+  public column: number = 0;
+  public type!: CoverType;
+  public executed: boolean = false;
+}
+
+export class CoverageTransform extends BaseVisitor {
+  public mustImport: boolean = false;
+  public points: Map<string, CoverPoint> = new Map<string, CoverPoint>();
+  public globalStatements: Statement[] = [];
+  visitBinaryExpression(node: BinaryExpression): void {
+    super.visitBinaryExpression(node);
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    const path = node.range.source.normalizedPath;
+
+    switch (node.operator) {
+      case Token.Bar_Bar:
+      case Token.Ampersand_Ampersand: {
+        const right = node.right;
+        const rightLc = getLineCol(node);
+
+        const point = new CoverPoint();
+        point.line = rightLc?.line!;
+        point.column = rightLc?.column!;
+        point.file = path;
+        point.type = CoverType.Expression;
+
+        point.hash = hash(point);
+
+        const replacer = new RangeTransform(node);
+        const registerStmt = SimpleParser.parseTopLevelStatement(
+          `__REGISTER({
+                        file: "${point.file}",
+                        hash: "${point.hash}",
+                        line: ${point.line},
+                        column: ${point.column},
+                        type: "Expression",
+                        executed: false
+                    });`,
+        );
+        replacer.visit(registerStmt);
+
+        let coverExpression = SimpleParser.parseExpression(
+          `(__COVER("${point.hash}"), $$REPLACE_ME)`,
+        ) as ParenthesizedExpression;
+        replacer.visit(coverExpression);
+
+        (coverExpression.expression as CommaExpression).expressions[1] = right;
+
+        node.right = coverExpression;
+
+        this.globalStatements.push(registerStmt);
+
+        break;
+      }
+    }
+  }
+  visitMethodDeclaration(node: MethodDeclaration): void {
+    super.visitMethodDeclaration(node);
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    if (node.body) {
+      // @ts-ignore
+      if (node.body.visited) return;
+      // @ts-ignore
+      node.body.visited = true;
+      const path = node.range.source.normalizedPath;
+      const funcLc = getLineCol(node);
+
+      const point = new CoverPoint();
+      point.line = funcLc?.line!;
+      point.column = funcLc?.column!;
+      point.file = path;
+      point.type = CoverType.Function;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(node);
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Function",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverStmt = SimpleParser.parseStatement(
+        `__COVER("${point.hash}")`,
+        true,
+      );
+      replacer.visit(coverStmt);
+
+      const bodyBlock = node.body as BlockStatement;
+      bodyBlock.statements.unshift(coverStmt);
+
+      this.globalStatements.push(registerStmt);
+    }
+  }
+  visitParameter(node: ParameterNode): void {
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    const path = node.range.source.normalizedPath;
+    if (node.initializer) {
+      // @ts-ignore
+      if (node.initializer.visited) return;
+      // @ts-ignore
+      node.initializer.visited = true;
+      super.visitParameter(node);
+      const paramLc = getLineCol(node.initializer);
+
+      const point = new CoverPoint();
+      point.line = paramLc?.line!;
+      point.column = paramLc?.column!;
+      point.file = path;
+      point.type = CoverType.Expression;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(node);
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Expression",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverExpression = SimpleParser.parseExpression(
+        `(__COVER("${point.hash}"), $$REPLACE_ME)`,
+      ) as ParenthesizedExpression;
+      replacer.visit(coverExpression);
+
+      (coverExpression.expression as CommaExpression).expressions[1] =
+        node.initializer;
+
+      node.initializer = coverExpression;
+
+      this.globalStatements.push(registerStmt);
+    }
+  }
+  visitFunctionDeclaration(
+    node: FunctionDeclaration,
+    isDefault?: boolean | undefined,
+  ): void {
+    super.visitFunctionDeclaration(node, isDefault);
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    if (node.body) {
+      // @ts-ignore
+      if (node.body.visited) return;
+      // @ts-ignore
+      node.body.visited = true;
+
+      const path = node.range.source.normalizedPath;
+      const funcLc = getLineCol(node);
+      const point = new CoverPoint();
+      point.line = funcLc?.line!;
+      point.column = funcLc?.column!;
+      point.file = path;
+      point.type = CoverType.Function;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(node);
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Function",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      this.globalStatements.push(registerStmt);
+
+      if (node.body.kind === NodeKind.Export) {
+        const coverStmt = SimpleParser.parseStatement(`{
+                __COVER("${point.hash}")
+                return $$REPLACE_ME
+            }`) as BlockStatement;
+        replacer.visit(coverStmt);
+
+        const bodyReturn = coverStmt.statements[1] as ReturnStatement;
+        const body = node.body as ExpressionStatement;
+        node.arrowKind = ArrowKind.Single;
+        bodyReturn.value = body.expression;
+        node.body = body;
+      } else {
+        const coverStmt = SimpleParser.parseStatement(
+          `__COVER("${point.hash}")`,
+          true,
+        );
+        replacer.visit(coverStmt);
+
+        if (node.body instanceof BlockStatement) {
+          node.body.statements.unshift(coverStmt);
+        } else if (node.body instanceof ExpressionStatement) {
+          const expression = (node.body as ExpressionStatement).expression;
+          node.body = Node.createBlockStatement(
+            [Node.createReturnStatement(expression, expression.range)],
+            expression.range,
+          );
+
+          const bodyBlock = node.body as BlockStatement;
+          bodyBlock.statements.unshift(coverStmt);
+        }
+      }
+    }
+  }
+  visitIfStatement(node: IfStatement): void {
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    let visitIfTrue = false;
+    let visitIfFalse = false;
+
+    const ifTrue = node.ifTrue;
+    const ifFalse = node.ifFalse;
+
+    const path = node.range.source.normalizedPath;
+
+    if (ifTrue.kind !== NodeKind.Block) {
+      const trueLc = getLineCol(ifTrue);
+      const point = new CoverPoint();
+
+      point.line = trueLc?.line!;
+      point.column = trueLc?.column!;
+      point.file = path;
+      point.type = CoverType.Expression;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(ifTrue);
+
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Expression",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverStmt = SimpleParser.parseStatement(
+        `{__COVER("${point.hash}")};`,
+        true,
+      ) as BlockStatement;
+      replacer.visit(coverStmt);
+
+      coverStmt.statements.push(ifTrue);
+      node.ifTrue = coverStmt;
+
+      this.globalStatements.push(registerStmt);
+
+      visitIfTrue = true;
+      visitIfFalse = !!ifFalse;
+    }
+
+    if (ifFalse && ifFalse.kind !== NodeKind.Block) {
+      const falseLc = getLineCol(ifFalse);
+      const point = new CoverPoint();
+
+      point.line = falseLc?.line!;
+      point.column = falseLc?.column!;
+      point.file = path;
+      point.type = CoverType.Expression;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(ifTrue);
+
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Expression",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverStmt = SimpleParser.parseStatement(
+        `{__COVER("${point.hash}")};`,
+        true,
+      ) as BlockStatement;
+      replacer.visit(coverStmt);
+
+      coverStmt.statements.push(ifFalse);
+      node.ifFalse = coverStmt;
+
+      this.globalStatements.push(registerStmt);
+
+      visitIfTrue = true;
+      visitIfFalse = true;
+    }
+    if (visitIfTrue || visitIfFalse) {
+      if (visitIfTrue) {
+        // @ts-ignore
+        if (ifTrue.visited) return;
+        // @ts-ignore
+        ifTrue.visited = true;
+        this._visit(ifTrue);
+      }
+      if (visitIfFalse) {
+        // @ts-ignore
+        if (ifFalse.visited) return;
+        // @ts-ignore
+        ifFalse.visited = true;
+        this._visit(ifFalse!);
+      }
+    } else {
+      super.visitIfStatement(node);
+    }
+  }
+  visitTernaryExpression(node: TernaryExpression): void {
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    super.visitTernaryExpression(node);
+
+    const trueExpression = node.ifThen;
+    const falseExpression = node.ifElse;
+
+    const path = node.range.source.normalizedPath;
+    {
+      const trueLc = getLineCol(trueExpression);
+      const point = new CoverPoint();
+      point.line = trueLc?.line!;
+      point.column = trueLc?.column!;
+      point.file = path;
+      point.type = CoverType.Expression;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(trueExpression);
+
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Expression",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverExpression = SimpleParser.parseExpression(
+        `(__COVER("${point.hash}"), $$REPLACE_ME)`,
+      ) as ParenthesizedExpression;
+      replacer.visit(coverExpression);
+
+      (coverExpression.expression as CommaExpression).expressions[1] =
+        trueExpression;
+      node.ifThen = coverExpression;
+
+      this.globalStatements.push(registerStmt);
+    }
+    {
+      const falseLc = getLineCol(falseExpression);
+      const point = new CoverPoint();
+      point.line = falseLc?.line!;
+      point.column = falseLc?.column!;
+      point.file = path;
+      point.type = CoverType.Expression;
+
+      point.hash = hash(point);
+
+      const replacer = new RangeTransform(falseExpression);
+
+      const registerStmt = SimpleParser.parseTopLevelStatement(
+        `__REGISTER({
+                    file: "${point.file}",
+                    hash: "${point.hash}",
+                    line: ${point.line},
+                    column: ${point.column},
+                    type: "Expression",
+                    executed: false
+                })`,
+      );
+      replacer.visit(registerStmt);
+
+      const coverExpression = SimpleParser.parseExpression(
+        `(__COVER("${point.hash}"), $$REPLACE_ME)`,
+      ) as ParenthesizedExpression;
+      replacer.visit(coverExpression);
+
+      (coverExpression.expression as CommaExpression).expressions[1] =
+        falseExpression;
+      node.ifElse = coverExpression;
+      this.globalStatements.push(registerStmt);
+    }
+  }
+  visitSwitchCase(node: SwitchCase): void {
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    const path = node.range.source.normalizedPath;
+    const caseLc = getLineCol(node);
+
+    const point = new CoverPoint();
+    point.line = caseLc?.line!;
+    point.column = caseLc?.column!;
+    point.file = path;
+    point.type = CoverType.Block;
+
+    point.hash = hash(point);
+
+    const replacer = new RangeTransform(node);
+
+    const registerStmt = SimpleParser.parseTopLevelStatement(
+      `__REGISTER({
+                file: "${point.file}",
+                hash: "${point.hash}",
+                line: ${point.line},
+                column: ${point.column},
+                type: "Block",
+                executed: false
+            })`,
+    );
+    replacer.visit(registerStmt);
+
+    const coverStmt = SimpleParser.parseStatement(`__COVER("${point.hash}")`);
+    replacer.visit(coverStmt);
+
+    this.globalStatements.push(registerStmt);
+    super.visitSwitchCase(node);
+    node.statements.unshift(coverStmt);
+  }
+  visitBlockStatement(node: BlockStatement): void {
+    // @ts-ignore
+    if (node.visited) return;
+    // @ts-ignore
+    node.visited = true;
+    const path = node.range.source.normalizedPath;
+
+    const blockLc = getLineCol(node);
+
+    const point = new CoverPoint();
+    point.line = blockLc?.line!;
+    point.column = blockLc?.column!;
+    point.file = path;
+    point.type = CoverType.Block;
+
+    point.hash = hash(point);
+
+    const replacer = new RangeTransform(node);
+
+    const registerStmt = SimpleParser.parseTopLevelStatement(
+      `__REGISTER({
+                file: "${point.file}",
+                hash: "${point.hash}",
+                line: ${point.line},
+                column: ${point.column},
+                type: "Block",
+                executed: false
+            })`,
+    );
+    replacer.visit(registerStmt);
+
+    const coverStmt = SimpleParser.parseStatement(`__COVER("${point.hash}")`);
+    replacer.visit(coverStmt);
+
+    this.globalStatements.push(registerStmt);
+    super.visitBlockStatement(node);
+    node.statements.unshift(coverStmt);
+  }
+  visitSource(node: Source): void {
+    if (node.isLibrary) return;
+    if (node.simplePath === "coverage") return;
+    // Ignore all lib and std. Visit everything else.
+    if (isStdlib(node)) return;
+    super.visitSource(node);
+  }
+}
+
+/**
+ * A simple djb2hash that returns a hash of a given string. See http://www.cse.yorku.ca/~oz/hash.html
+ * for implementation details.
+ *
+ * @param {string} str - The string to be hashed
+ * @returns {number} The hash of the string
+ */
+function djb2Hash(str: string): number {
+  const points = Array.from(str);
+  let h = 5381;
+  for (let p = 0; p < points.length; p++)
+    // h = (h * 31 + c) | 0;
+    h = ((h << 5) - h + points[p]!.codePointAt(0)!) | 0;
+  return h;
+}
+
+function hash(point: CoverPoint): string {
+  const hsh = djb2Hash(
+    point.file +
+      point.line.toString() +
+      point.column.toString() +
+      point.type.toString(),
+  );
+  if (hsh < 0) {
+    const out = hsh.toString(16);
+    return "3" + out.slice(1);
+  } else {
+    return hsh.toString(16);
+  }
+}
+
+class LineColumn {
+  public line!: number;
+  public column!: number;
+}
+
+function getLineCol(node: Node): LineColumn {
+  return {
+    line: node.range.source.lineAt(node.range.start),
+    column: node.range.source.columnAt(),
+  };
+}