feat: upgrade dependencies (assemblyscript, loader, as-bind) (#24)

BREAKING CHANGE: require Node >= 14 (because of as-bind update)

Author: piotr-oles

.eslintrc.js

@@ -32,6 +32,7 @@ module.exports = {
       files: ["test/e2e/fixtures/**/*.ts"],
       rules: {
         "node/no-missing-import": "off",
+        "node/no-extraneous-import": "off"
       },
     },
   ],

.github/workflows/main.yml

@@ -45,7 +45,7 @@ jobs:
     needs: build
     strategy:
       matrix:
-        node: [12, 14]
+        node: [14, 16]
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
     - uses: actions/checkout@v1
@@ -100,7 +100,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 14
 
       - name: Get yarn cache
         id: yarn-cache

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn build
+yarn lint
+yarn test unit

README.md

@@ -181,12 +181,6 @@ export interface BoundWasmModuleInstance<TModule, TImports> {
   importObject: TImports;
   module: WebAssembly.Module;
   instance: WebAssembly.Instance;
-  enableExportFunctionTypeCaching(): void;
-  disableExportFunctionTypeCaching(): void;
-  enableExportFunctionUnsafeReturnValue(): void;
-  disableExportFunctionUnsafeReturnValue(): void;
-  enableImportFunctionTypeCaching(): void;
-  disableImportFunctionTypeCaching(): void;
 }
 
 export interface JsModuleInstance<TModule> {
@@ -205,8 +199,6 @@ export function instantiate<TModule, TImports>(
   fallback: boolean = false,
   supports?: () => boolean
 ): Promise<BoundModuleInstance<TModule, TImports>>
-
-export const RETURN_TYPES: AsBindReturnTypes;
 ```
 
 <details>
@@ -220,14 +212,12 @@ export function sayHello(firstName: string, lastName: string): string {
 
 // ./src/sayHello.ts
 import * as sayHelloModule from "./assembly/sayHello";
-import { instantiate, RETURN_TYPES } from "as-loader/runtime/bind";
+import { instantiate } from "as-loader/runtime/bind";
 
 export async function loadModule(): Promise<typeof sayHelloModule> {
-  const { exports } = await instantiate(sayHelloModule, fetch);
-  const { sayHello } = exports;
-  sayHello.returnType = RETURN_TYPES.STRING;
+  const module = await instantiate(sayHelloModule, fetch);
 
-  return { sayHello };
+  return { sayHello: module.exports.sayHello };
 }
 ```
 

package.json

@@ -17,41 +17,43 @@
     "build": "tsc",
     "lint": "eslint src test",
     "test": "jest",
-    "release": "auto shipit"
+    "release": "auto shipit",
+    "prepare": "husky install"
   },
   "files": [
     "loader/*",
     "runtime/*"
   ],
   "peerDependencies": {
-    "assemblyscript": "~0.18.0",
+    "assemblyscript": "^0.19.0",
     "webpack": "^4.0.0 || ^5.0.0"
   },
   "dependencies": {
-    "@assemblyscript/loader": "~0.18.0",
-    "as-bind": "^0.6.0",
+    "@assemblyscript/loader": "^0.19.0",
+    "as-bind": "^0.8.0",
     "loader-utils": "^2.0.0",
-    "schema-utils": "^3.0.0"
+    "schema-utils": "^3.1.1"
   },
   "devDependencies": {
-    "@types/loader-utils": "^2.0.1",
-    "@types/webpack": "^4.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.15.1",
-    "@typescript-eslint/parser": "^4.15.1",
-    "assemblyscript": "^0.18.0",
-    "auto": "^10.16.5",
-    "eslint": "^7.20.0",
-    "eslint-config-prettier": "^8.0.0",
+    "@types/jest": "^26.0.24",
+    "@types/loader-utils": "^2.0.3",
+    "@types/webpack": "^5.28.0",
+    "@typescript-eslint/eslint-plugin": "^4.29.0",
+    "@typescript-eslint/parser": "^4.29.0",
+    "assemblyscript": "^0.19.0",
+    "auto": "^10.30.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "husky": "^4.0.0",
-    "jest": "^26.6.3",
+    "eslint-plugin-prettier": "^3.4.0",
+    "husky": "^7.0.0",
+    "jest": "^27.0.6",
     "karton": "^0.4.1",
-    "lint-staged": "^10.5.4",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.1",
-    "typescript": "^4.1.5",
-    "webpack": "^4.0.0"
+    "lint-staged": "^11.1.2",
+    "prettier": "^2.3.2",
+    "ts-jest": "^27.0.4",
+    "typescript": "^4.3.5",
+    "webpack": "^5.0.0"
   },
   "auto": {
     "plugins": [
@@ -62,11 +64,6 @@
       "noChangelog": true
     }
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && yarn build"
-    }
-  },
   "lint-staged": {
     "*.ts": "eslint --fix"
   },
@@ -75,6 +72,6 @@
     "testEnvironment": "node"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   }
 }

src/loader/compiler-host.ts

@@ -1,7 +1,17 @@
 import path from "path";
 import asc, { DiagnosticMessage, APIOptions } from "assemblyscript/cli/asc";
 
-type CompilerHost = Required<APIOptions> & {
+type CompilerHost = Required<
+  Pick<
+    APIOptions,
+    | "stdout"
+    | "stderr"
+    | "readFile"
+    | "writeFile"
+    | "listFiles"
+    | "reportDiagnostic"
+  >
+> & {
   getDiagnostics(): DiagnosticMessage[];
 };
 

src/loader/index.ts

@@ -68,6 +68,7 @@ function loader(this: any, buffer: Buffer) {
   if (bind && name.endsWith(".wasm")) {
     // overwrite options for bind
     ascOptions.exportRuntime = true;
+    ascOptions.transform = "as-bind";
   }
 
   if (name.endsWith(".js")) {
@@ -109,10 +110,6 @@ function loader(this: any, buffer: Buffer) {
     outFileName,
     ...mapAscOptionsToArgs(ascOptions),
   ];
-  if (bind && name.endsWith(".wasm")) {
-    // add required by as-bind file to compilation
-    args.unshift(require.resolve("as-bind/lib/assembly/as-bind.ts"));
-  }
 
   asc.ready
     .then(() => {

src/runtime/bind.ts

@@ -1,13 +1,12 @@
 import type { Imports } from "@assemblyscript/loader";
-import { AsBind } from "as-bind";
+import * as AsBind from "as-bind";
 import type {
   BoundWasmModuleInstance,
   JsModuleInstance,
   BoundModuleInstance,
   AsLoaderModule,
 } from "./types";
 import { context } from "./context";
-import { AsBindReturnTypes } from "./types/ref-types";
 import "./types/std";
 
 async function instantiate<
@@ -46,6 +45,8 @@ async function instantiate<
     // WebAssembly is supported
     return {
       type: "wasm-bound",
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore - invalid as-bind typings
       ...(await AsBind.instantiate(load(moduleURL as string), imports)),
     };
   } else if (fallback && moduleURL.fallback) {
@@ -60,11 +61,8 @@ async function instantiate<
   );
 }
 
-const RETURN_TYPES: AsBindReturnTypes = AsBind.RETURN_TYPES;
-
 export {
   instantiate,
-  RETURN_TYPES,
   Imports,
   BoundWasmModuleInstance,
   JsModuleInstance,

src/runtime/types/bound.ts

@@ -6,7 +6,6 @@ import type {
   PointerCastFunction,
   PointerCast,
 } from "./pointer";
-import { AsBindReturnTypes, RefType } from "./ref-types";
 
 export type BoundNonPointerTypes =
   | NonPointerTypes
@@ -30,17 +29,9 @@ export type BoundNonPointerTypes =
   | BigInt64Array
   | BigUint64Array;
 
-export type BoundFunction<T extends (...args: any) => any> = T extends (
-  ...args: any
-) => infer R
-  ? PointerCastFunction<T, BoundNonPointerTypes> & {
-      shouldCacheTypes?: boolean;
-      returnType?: R extends NonPointerTypes
-        ? AsBindReturnTypes["NUMBER"]
-        : RefType<R>;
-      unsafeReturnValue?: boolean;
-    }
-  : never;
+export type BoundFunction<T extends (...args: any) => any> =
+  PointerCastFunction<T, BoundNonPointerTypes>;
+
 export type BoundExports<T extends Record<any, any>> = T extends Record<
   string | symbol | number,
   any

src/runtime/types/index.ts

@@ -19,12 +19,6 @@ export interface BoundWasmModuleInstance<TModule, TImports> {
   importObject: TImports;
   module: WebAssembly.Module;
   instance: WebAssembly.Instance;
-  enableExportFunctionTypeCaching(): void;
-  disableExportFunctionTypeCaching(): void;
-  enableExportFunctionUnsafeReturnValue(): void;
-  disableExportFunctionUnsafeReturnValue(): void;
-  enableImportFunctionTypeCaching(): void;
-  disableImportFunctionTypeCaching(): void;
 }
 export interface JsModuleInstance<TModule> {
   type: "js";

src/runtime/types/ref-types.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 // Types
 declare type bool = boolean;
 declare type i8 = number;

src/runtime/types/std.ts

@@ -10,8 +10,7 @@
     "dist/*"
   ],
   "dependencies": {
-    "assemblyscript": "0.18.11",
-    "@assemblyscript/loader": "0.18.11",
+    "assemblyscript": "0.19.10",
     "ts-loader": "8.0.17",
     "typescript": "4.2.2",
     "webpack": "4.46.0",

test/e2e/fixtures/main/package.json

@@ -1,5 +1,5 @@
 import * as fs from 'fs';
-import { instantiate, RETURN_TYPES } from "as-loader/runtime/bind";
+import { instantiate } from "as-loader/runtime/bind";
 
 import * as assembly from "./assembly/correct/bind";
 
@@ -10,7 +10,6 @@ async function loadAndRun() {
   );
 
   const { hello } = module.exports;
-  hello.returnType = RETURN_TYPES.STRING;
 
   console.log(hello('world'));
 }