Merge pull request #11 from piotr-oles/fix/asc-options

Fix passing options to AssemblyScript

Author: piotr-oles

.github/workflows/main.yml

@@ -80,8 +80,11 @@ jobs:
         name: lib
         path: lib
 
-    - name: Run tests
-      run: yarn test
+    - name: Run unit tests
+      run: yarn test unit
+
+    - name: Run e2e tests
+      run: yarn test e2e
 
   release:
     runs-on: ubuntu-latest

README.md

@@ -14,7 +14,8 @@
 
 ## Installation
 
-This loader requires minimum AssemblyScript 0.18, Node.js 10 and webpack 4 or webpack 5
+This loader requires minimum [AssemblyScript  0.18](https://github.com/AssemblyScript/assemblyscript), 
+Node.js 10 and [webpack 4 or webpack 5](https://github.com/webpack/webpack)
 
 ```sh
 # with npm

src/error.ts

@@ -1,9 +1,13 @@
 import path from "path";
 import { DiagnosticMessage } from "assemblyscript/cli/asc";
-import { getLineColumnFromIndex } from "./line-column";
-import { Location } from "./location";
+import { getLineColumnFromIndex, LineColumn } from "./line-column";
 import { CompilerHost } from "./compiler-host";
 
+interface Location {
+  start?: LineColumn;
+  end?: LineColumn;
+}
+
 interface ArtificialModule {
   identifier(): string;
   readableIdentifier(): string;

src/index.ts

@@ -7,7 +7,7 @@ import { Schema } from "schema-utils/declarations/validate";
 import { createCompilerHost } from "./compiler-host";
 import { mapAscOptionsToArgs } from "./options";
 import { AssemblyScriptError } from "./error";
-import schema from "./options.json";
+import schema from "./schema.json";
 import { addErrorToModule, addWarningToModule } from "./webpack";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/line-column.ts

@@ -1,5 +1,7 @@
 interface LineColumn {
+  // 1-based line
   line: number;
+  // 1-based column
   column: number;
 }
 
@@ -12,8 +14,8 @@ function getLineColumnFromIndex(
   }
 
   let line = 1;
-  let prevLineIndex = 0;
-  let nextLineIndex = source.indexOf("\n", prevLineIndex);
+  let prevLineIndex = -1;
+  let nextLineIndex = source.indexOf("\n");
 
   while (nextLineIndex !== -1 && index > nextLineIndex) {
     prevLineIndex = nextLineIndex;

src/location.ts

@@ -8,7 +8,10 @@ function mapAscOptionsToArgs(options: Options): string[] {
     const value = options[key];
 
     if (typeof value === "boolean") {
-      args.push("--" + key);
+      if (value) {
+        // add flag only if value is true
+        args.push("--" + key);
+      }
     } else if (typeof value === "string" || typeof value === "number") {
       args.push("--" + key, String(value));
     } else if (Array.isArray(value)) {

src/options.ts

@@ -243,4 +243,56 @@ describe("as-loader", () => {
       }
     );
   });
+
+  describe("options", () => {
+    it("passes options to assemblyscript compiler", async () => {
+      await sandbox.load(path.resolve(__dirname, "fixtures/main"));
+      await sandbox.install("yarn", { webpack: WEBPACK_5 });
+
+      await sandbox.patch(
+        "webpack.config.js",
+        '          name: "[name].wasm",',
+        [
+          '          name: "[name].wasm",',
+          "          optimizeLevel: 2,",
+          "          shrinkLevel: 1,",
+          "          coverage: true,",
+          "          noAssert: true,",
+          '          runtime: "stub",',
+          "          debug: true,",
+          '          trapMode: "allow",',
+          "          noValidate: true,",
+          "          importMemory: false,",
+          "          noExportMemory: true,",
+          "          initialMemory: 1000,",
+          "          maximumMemory: 2000,",
+          "          sharedMemory: true,",
+          "          importTable: false,",
+          "          exportTable: false,",
+          "          explicitStart: false,",
+          '          enable: ["simd", "threads"],',
+          '          disable: ["mutable-globals"],',
+          "          lowMemoryLimit: false,",
+          "          memoryBase: 1024,",
+          "          tableBase: 0,",
+        ].join("\n")
+      );
+
+      const results = await sandbox.exec("yarn webpack");
+      expect(results).toContain("simple.wasm");
+      expect(results).toContain("simple.wasm.map");
+      expect(results).toContain("main.js");
+
+      const simpleWasmInstance = await instantiate<
+        typeof import("./fixtures/main/src/assembly/correct/simple")
+      >(await sandbox.read("dist/simple.wasm"));
+
+      expect(simpleWasmInstance.exports.run()).toEqual(15);
+
+      const simpleWasmMap = await sandbox.read("dist/simple.wasm.map", "utf8");
+      expect(Object.keys(JSON.parse(simpleWasmMap))).toEqual(
+        expect.arrayContaining(["version", "sources", "names", "mappings"])
+      );
+    });
+  });
 });

src/options.json src/schema.json

@@ -0,0 +1,34 @@
+import { getLineColumnFromIndex } from "../../src/line-column";
+
+const AS_SOURCE = [
+  "export function add(a: i32, b: i32): i32 {",
+  "  return a + b;",
+  "}",
+  "",
+].join("\n");
+
+describe("line-column", () => {
+  it.each([
+    [0, AS_SOURCE, 1, 1],
+    [10, AS_SOURCE, 1, 11],
+    [42, AS_SOURCE, 1, 43],
+    [43, AS_SOURCE, 2, 1],
+    [45, AS_SOURCE, 2, 3],
+    [58, AS_SOURCE, 2, 16],
+    [59, AS_SOURCE, 3, 1],
+    [60, AS_SOURCE, 3, 2],
+  ])(
+    "get line and column for index %p in %p",
+    (index, source, line, column) => {
+      expect(getLineColumnFromIndex(source, index)).toEqual({ line, column });
+    }
+  );
+
+  it.each([
+    [-1, AS_SOURCE],
+    [10000, AS_SOURCE],
+    [NaN, AS_SOURCE],
+  ])("returns undefined for invalid index %p in %p", (index, source) => {
+    expect(getLineColumnFromIndex(source, index)).toBeUndefined();
+  });
+});

test/e2e/main.spec.ts

@@ -0,0 +1,32 @@
+import { mapAscOptionsToArgs } from "../../src/options";
+
+describe("options", () => {
+  it.each([
+    [{}, []],
+    [{ optimizeLevel: 3 }, ["--optimizeLevel", "3"]],
+    [{ coverage: true }, ["--coverage"]],
+    [{ coverage: false }, []],
+    [{ runtime: "half" }, ["--runtime", "half"]],
+    [{ enable: ["bulk-memory", "simd"] }, ["--enable", "bulk-memory,simd"]],
+    [
+      {
+        optimizeLevel: 2,
+        shrinkLevel: 1,
+        noValidate: true,
+        sharedMemory: false,
+        disable: ["mutable-globals"],
+      },
+      [
+        "--optimizeLevel",
+        "2",
+        "--shrinkLevel",
+        "1",
+        "--noValidate",
+        "--disable",
+        "mutable-globals",
+      ],
+    ],
+  ])("maps options %p to args %p", (options, args) => {
+    expect(mapAscOptionsToArgs(options)).toEqual(args);
+  });
+});