Splict wasm tests into multiple functions and files; use strict mode; use knip

Author: ImplOfAnImpl

.dockerignore

@@ -45,8 +45,7 @@ test/config.ini
 
 # wasm
 wasm-wrappers/pkg/
-wasm-wrappers/js-bindings-test/test.js
-wasm-wrappers/js-bindings-test/test.js.map
+wasm-wrappers/js-bindings-test/dist/
 
 # 'mintlayer-data' will be mapped to home directories of docker containers, so everything
 # inside it will be generated by the containers.

.github/workflows/wasm.yml

@@ -35,8 +35,8 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install TypeScript
-        run: npm install typescript
+      - name: Install TypeScript & Knip
+        run: npm install typescript knip
       - name: Install wasm-pack
         run: cargo install wasm-pack
       - name: Build the wasm module
@@ -48,6 +48,9 @@ jobs:
       - name: Run the tests
         working-directory: ./wasm-wrappers
         run: node --enable-source-maps js-bindings-test/node-entry.js
+      - name: Run Knip
+        working-directory: ./wasm-wrappers/js-bindings-test
+        run: npx knip
 
   wasm_artifacts:
     runs-on: ubuntu-latest

.gitignore

@@ -43,8 +43,7 @@ test/config.ini
 
 # wasm
 wasm-wrappers/pkg/
-wasm-wrappers/js-bindings-test/test.js
-wasm-wrappers/js-bindings-test/test.js.map
+wasm-wrappers/js-bindings-test/dist/
 
 # 'mintlayer-data' will be mapped to home directories of docker containers, so everything
 # inside it will be generated by the containers.

build-tools/codecheck/codecheck.py

@@ -34,7 +34,8 @@
     '.git',
     'build-tools/docker/example-mainnet/mintlayer-data',
     'build-tools/docker/example-mainnet-dns-server/mintlayer-data',
-    'wasm-wrappers/pkg'
+    'wasm-wrappers/pkg',
+    'wasm-wrappers/js-bindings-test/dist',
 ]
 
 
@@ -325,7 +326,6 @@ def check_files_end_with_newline():
     # list of files exempted from checks
     exempted_files = [
         'wasm-wrappers/doc/*',
-        'wasm-wrappers/js-bindings-test/test.js',
     ]
 
     ok = True

wasm-wrappers/README.md

@@ -35,21 +35,21 @@ In the wasm Cargo.toml directory, run:
 tsc --project js-bindings-test/tsconfig.json
 ```
 
-### Running the tests in a web browser
+### Run the tests in a web browser
 
 To build the wasm package from the crate, run (in the wasm Cargo.toml directory):
 
 ```
 wasm-pack build --target web
 ```
 
-To test the wasm binary. First, install `http-server` web server (feel free to use any other web-server of your choosing):
+To test the wasm binary, first install `http-server` web server (feel free to use any other web-server of your choosing):
 
 ```
 cargo install http-server
 ```
 
-Then run the http server, and then choose the file `js-bindings-test/index.html`:
+Then run the http server:
 
 ```
 http-server --port 8080
@@ -61,22 +61,41 @@ If you're using a remote server, either tunnel to port 8080, or expose that port
 http-server --port 8080 --host 0.0.0.0
 ```
 
-The ported wasm functions are exported to the file `js-bindings-test/index.js` and used in the file `js-bindings-test/index.html` with a basic test/example in them using JavaScript. Use your browser's console to see the output.
+To run test tests, choose the file `js-bindings-test/index.html` in the browser. Use browser's console to see the output.
 
-### Running the tests in Node.js
+### Run the tests in Node.js
 
 To build the wasm package from the crate, run (in the wasm Cargo.toml directory):
 
 ```
 wasm-pack build --target nodejs
 ```
 
-Finally, to run the example, run:
+Finally, to run the tests, run:
 
 ```
 node --enable-source-maps  js-bindings-test/node-entry.js
 ```
 
+### Run `knip`
+
+We use `knip` to make sure that there are no unused exports in `js-bindings-test/tests` (which could
+mean that some of the tests are never run).
+
+**Note: unused local definitions are caught by the TypeScript compiler itself, via the `noUnusedLocals` setting.**
+
+To run `knip` locally, first install it:
+```
+npm install -g knip
+```
+
+And then run (in the wasm Cargo.toml directory):
+```
+(cd js-bindings-test && npx knip)
+```
+
+**Note: to explicitly exclude an export from `knip`'s report, annotate it with `/** @public */`.**
+
 ### Further documentation on wasm
 
 - https://developer.mozilla.org/en-US/docs/WebAssembly/Rust_to_wasm

wasm-wrappers/js-bindings-test/knip.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "entry": ["tests/main.ts"],
+  "project": ["tests/**/*.ts"],
+  "includeEntryExports": true,
+  "ignoreExportsUsedInFile": true
+}

wasm-wrappers/js-bindings-test/node-entry.js

@@ -1,7 +1,7 @@
-import { run_test } from "./test.js";
+import { run_all_tests } from "./dist/main.js";
 
 async function node_run() {
-  await run_test();
+  await run_all_tests();
 }
 
 node_run();

wasm-wrappers/js-bindings-test/package.json

@@ -1,7 +1,7 @@
 {
-    "name": "wasm-wrappers-example",
-    "version": "0.1.0",
-    "license": "MIT",
-    "main": "index.js",
-    "type": "module"
-  }
+  "name": "js-bindings-test",
+  "version": "0.1.0",
+  "license": "MIT",
+  "main": "index.js",
+  "type": "module"
+}