Merge pull request #45 from torch2424/entry-file-check

Added a check that the AssemblyScript Wasm Module was build with as-bind

Author: torch2424

lib/asbind-instance/asbind-instance.js

@@ -82,6 +82,16 @@ export default class AsbindInstance {
     // Set our unbound exports
     this.unboundExports = unboundExports;
 
+    // Ensure that the AS Wasm was built with the as-bind entryfile
+    if (
+      !this.unboundExports.__asbind_entryfile_flag ||
+      this.unboundExports.__asbind_entryfile_flag === 0
+    ) {
+      throw new Error(
+        "as-bind: The instantiated AssemblyScript wasm module was not built with the as-bind entryfile. Please see the as-bind documentation (Quick Start), and rebuild your AssemblyScript wasm module."
+      );
+    }
+
     // Wrap appropriate the appropriate export functions
     this.exports = {};
     Object.keys(this.unboundExports).forEach(unboundExportKey => {

lib/assembly/as-bind.ts

@@ -1,5 +1,8 @@
 // Neccessary bootstrapping for asbind
 
+// Flag for the entryfile check
+export const __asbind_entryfile_flag = 1;
+
 // Strings
 export const __asbind_String_ID = idof<String>();
 

package.json

@@ -13,14 +13,16 @@
     "lint": "prettier --write **/*.js **/*.ts **/*.json !build/**/* !dist/**/*",
     "lint:ci": "prettier --check **/*.js **/*.ts **/*.json !build/**/* !dist/**/*",
     "lib:watch": "chokidar --initial \"lib/**/*\" -c \"run-s lib:wasm:build lib:js:build:dev test\"",
-    "lib:test:watch": "chokidar \"test/**/*.js\" \"test/**/*.ts\" -c \"run-s lib:test:build test\"",
+    "lib:test:watch": "chokidar \"test/**/*.js\" \"test/**/*.ts\" -c \"run-s lib:test:build lib:test:build test\"",
     "lib:wasm:build": "run-s lib:wasm:build:debug lib:wasm:build:optimized lib:wasm:build:cp",
     "lib:wasm:build:debug": "asc lib/assembly/as-bind.ts -b dist/as-bind.debug.wasm -t dist/as-bind.debug.wat --sourceMap --debug --runtime full",
     "lib:wasm:build:optimized": "asc lib/assembly/as-bind.ts -b dist/as-bind.wasm --sourceMap dist/as-bind.wasm.map -t dist/as-bind.wat --runtime full -O3",
     "lib:wasm:build:cp": "cpy 'lib/assembly/**/*' dist",
     "lib:js:build": "rollup -c --environment LIB,PROD && cpy 'lib/as-bind.d.ts' dist",
     "lib:js:build:dev": "rollup -c --environment LIB,DEV",
-    "lib:test:build": "asc lib/assembly/as-bind.ts test/assembly/test.ts -b test/assembly/test.wasm --runtime full --debug",
+    "lib:test:build": "run-s lib:test:build:entry lib:test:build:no-entry",
+    "lib:test:build:entry": "asc lib/assembly/as-bind.ts test/assembly/test.ts -b test/assembly/test.wasm --runtime full --debug",
+    "lib:test:build:no-entry": "asc test/assembly/test.ts -b test/assembly/test-no-entry.wasm --runtime full --debug",
     "lib:deploy": "npm run build && np",
     "md:build": "run-s md:wasm:build md:ts:build md:js:build",
     "premd:dev": "npm run md:build",

test/assembly/test-no-entry.wasm

@@ -3,6 +3,9 @@ const assert = require("assert");
 const { AsBind } = require("../dist/as-bind.cjs");
 
 const wasmBytes = new Uint8Array(fs.readFileSync("./test/assembly/test.wasm"));
+const wasmBytesNoEntry = new Uint8Array(
+  fs.readFileSync("./test/assembly/test-no-entry.wasm")
+);
 
 describe("asbind", () => {
   const baseImportObject = {
@@ -36,6 +39,36 @@ describe("asbind", () => {
   });
 
   describe("instantiation", () => {
+    it("should error when instantiating a module that does not include the as-bind entryfile", async () => {
+      const wasmModule = await WebAssembly.compile(wasmBytesNoEntry);
+
+      let didInstantiate = false;
+      try {
+        await AsBind.instantiate(wasmModule, baseImportObject);
+        didInstantiate = true;
+      } catch (err) {
+        // Hooray! We caught the base instantiation
+        console.log("Expected Test Error: ", err.message);
+      }
+      if (didInstantiate) {
+        throw new Error("Was able to instantiate the incorrectly built test");
+      }
+
+      let didInstantiateSync = false;
+      try {
+        AsBind.instantiateSync(wasmModule, baseImportObject);
+        didInstantiateSync = true;
+      } catch (err) {
+        // Hooray! We caught the base instantiation
+        console.log("Expected Test Error: ", err.message);
+      }
+      if (didInstantiateSync) {
+        throw new Error(
+          "Was able to instantiateSync the incorrectly built test"
+        );
+      }
+    });
+
     it("should instantiate WebAssembly.Module", async () => {
       const wasmModule = await WebAssembly.compile(wasmBytes);
       asbindInstance = await AsBind.instantiate(wasmModule, baseImportObject);