Merge pull request #29 from torch2424/fix-28

Implented a fix for #28, and did some type clarification

Author: torch2424

README.md

@@ -153,16 +153,18 @@ asyncTask();
 
 ## Supported Data Types
 
-**TL;DR:** Currently Numbers, Strings, and Typed Arrays are supported. Returning a high-level data type from an imported JavaScript function, and passing AssemblyScript Classes will be coming later.
+**TL;DR:** Currently Numbers, Strings, and Typed Arrays are supported. Returning a high-level data type from an imported JavaScript function, [BigInt](https://github.com/WebAssembly/JS-BigInt-integration), and passing AssemblyScript Classes will be coming later.
+
+**Note:** As discovered in #28, [`Array<NumberType>`](https://docs.assemblyscript.org/standard-library/array#api) is **NOT** the same as [`TypedArray`](https://docs.assemblyscript.org/standard-library/typedarray#api), and may not work for your use case. You want to use [`TypedArray`](https://docs.assemblyscript.org/standard-library/typedarray#api) where possible.
 
 <!-- Generated from: https://www.tablesgenerator.com/markdown_tables# -->
 
-| Function & Direction                        | Number (Integers and Floats) | Strings | Int8Array | Uint8Array | Int16Array | UInt16Array | Int32Array | Uint32Array | Float32Array | Float64Array | AssemblyScript Classes |
-| ------------------------------------------- | ---------------------------- | ------- | --------- | ---------- | ---------- | ----------- | ---------- | ----------- | ------------ | ------------ | ---------------------- |
-| Exported AssemblyScript Function Parameters | ✔️                           | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
-| Exported AssemblyScript Function Return     | ✔️                           | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
-| Imported JavaScript Function Paramters      | ✔️                           | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
-| Imported JavaScript Function Return         | ✔️                           | ❌      | ❌        | ❌         | ❌         | ❌          | ❌         | ❌          | ❌           | ❌           | ❌                     |
+| Function & Direction                        | Number (32-bit Integers and 32-bit / 64-bit Floats) | Strings | Int8Array | Uint8Array | Int16Array | UInt16Array | Int32Array | Uint32Array | Float32Array | Float64Array | AssemblyScript Classes |
+| ------------------------------------------- | --------------------------------------------------- | ------- | --------- | ---------- | ---------- | ----------- | ---------- | ----------- | ------------ | ------------ | ---------------------- |
+| Exported AssemblyScript Function Parameters | ✔️                                                  | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
+| Exported AssemblyScript Function Return     | ✔️                                                  | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
+| Imported JavaScript Function Paramters      | ✔️                                                  | ✔️      | ✔️        | ✔️         | ✔️         | ✔️          | ✔️         | ✔️          | ✔️           | ✔️           | ❌                     |
+| Imported JavaScript Function Return         | ✔️                                                  | ❌      | ❌        | ❌         | ❌         | ❌          | ❌         | ❌          | ❌           | ❌           | ❌                     |
 
 ## Supported AssemblyScript Runtime Variants
 

lib/asbind-instance/bind-function.js

@@ -176,7 +176,7 @@ export function bindExportFunction(asbindInstance, exportFunctionKey) {
     });
 
     // Call the Export
-    // NOTE: Super random, but we don't hav to worry about ref conflicts here.
+    // NOTE: Super random, but we don't have to worry about ref conflicts here.
     // Since we can only return a single value, there should be no matching reference
     // if the returned value is not a reference.
     const exportFunctionResponse = originalExport.apply(

test/assembly/test.ts

@@ -1,5 +1,18 @@
 // The entry file of your WebAssembly module.
 
+// User submitted issues
+
+// Learned from this, you must use a TypedArray, and not something like: Array<f64>
+export function issue28(arr: Float64Array): f64 {
+  let sum: f64 = 2.0;
+  for (let i = 0; i < 3; ++i) {
+    sum += arr[i];
+  }
+  return arr.length;
+}
+
+// Basic value Passing
+
 export function helloWorld(world: string): string {
   return "Hello " + world + "!";
 }
@@ -20,6 +33,18 @@ export function numberAndRefArgsReturnsNumber(num: i32, ref: string): i32 {
   return ref.length + num;
 }
 
+export function Int32Support(value: i32): i32 {
+  return value + 1;
+}
+
+export function Float32Support(value: f32): f32 {
+  return value + 1.0;
+}
+
+export function Float64Support(value: f64): f64 {
+  return value + 1.0;
+}
+
 export function mapInt8Array(array: Int8Array): Int8Array {
   return array.map((value: i8) => value * 2);
 }

test/assembly/test.wasm

@@ -24,6 +24,17 @@ describe("asbind", () => {
     }
   };
 
+  describe("Issues", () => {
+    it("#28", async () => {
+      const wasmModule = await WebAssembly.compile(wasmBytes);
+      asbindInstance = await AsBind.instantiate(wasmModule, baseImportObject);
+
+      const arr = Float64Array.from([1, 2, 3]);
+      const response = asbindInstance.exports.issue28(arr);
+      assert(response, 4);
+    });
+  });
+
   describe("instantiation", () => {
     it("should instantiate WebAssembly.Module", async () => {
       const wasmModule = await WebAssembly.compile(wasmBytes);
@@ -93,7 +104,7 @@ describe("asbind", () => {
   describe("exported functions", () => {
     let asbindInstance;
 
-    before(async () => {
+    beforeEach(async () => {
       asbindInstance = await AsBind.instantiate(wasmBytes, baseImportObject);
     });
 
@@ -125,18 +136,37 @@ describe("asbind", () => {
     });
 
     it("should allow passing in a number and a ref, and return a number", () => {
+      // TODO: The response here can be detected as a string?
+      // If the first param is 24, this will give an expected response of 30.
+      // In this case, the response is 30, but the original export returns 30?
       const response = asbindInstance.exports.numberAndRefArgsReturnsNumber(
-        24,
+        30,
         "asbind"
       );
-      assert.equal(response, 30);
+      assert.equal(response, 36);
     });
 
     it("should handle Strings", () => {
       const response = asbindInstance.exports.helloWorld("asbind");
       assert.equal(response, "Hello asbind!");
     });
 
+    // Number Types
+    [
+      "Int32",
+      // "Int64" - BigInt not supported in Wasm Currently: WebAssembly/JS-BigInt-integration
+      "Float32",
+      "Float64"
+    ].forEach(numberKey => {
+      it(`should support passing and returning ${numberKey}`, () => {
+        const randomValue = Math.floor(Math.random() * 10);
+        const response = asbindInstance.exports[numberKey + "Support"](
+          randomValue
+        );
+        assert.equal(response, randomValue + 1);
+      });
+    });
+
     // TypedArrays
     [
       "Int8Array",
@@ -150,7 +180,11 @@ describe("asbind", () => {
     ].forEach(typedArrayKey => {
       it(`should handle ${typedArrayKey}`, () => {
         const randomValue = Math.floor(Math.random() * 10);
-        const array = global[typedArrayKey].from([randomValue]);
+        const array = global[typedArrayKey].from([
+          randomValue,
+          randomValue,
+          randomValue
+        ]);
         const arrayMapResponse = asbindInstance.exports["map" + typedArrayKey](
           array
         );