test: Adding web client testing framework

.github/workflows/test.yml

@@ -29,6 +29,8 @@ jobs:
       - uses: actions/checkout@main
       - name: Install Rust
         run: rustup update --no-self-update
+      - name: Install Node.js
+        uses: actions/setup-node@v3
       - uses: taiki-e/install-action@nextest
       - run: make clean-node
       - run: make node

CHANGELOG.md

@@ -9,6 +9,7 @@
 * Added support for importing committed notes from older blocks than current (#472).
 * Added support for account export in the CLI (#479).
 * Added the Web Client Crate
+* Added testing suite for the Web Client Crate
 * [BREAKING] Refactored `TransactionRequest` to represent a generalized transaction (#438).
 
 ### Enhancements

Makefile

@@ -80,10 +80,15 @@ test-deps: ## Install dependencies for tests
 integration-test: ## Run integration tests
 	cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI) --no-default-features
 
+.PHONY: integration-test-web-client
+integration-test-web-client: ## Run integration tests for the web client
+	cd ./crates/web-client && npm run test:clean
+
 .PHONY: integration-test-full
 integration-test-full: ## Run the integration test binary with ignored tests included
 	cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI)
 	cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI) --run-ignored ignored-only -- test_import_genesis_accounts_can_be_used_for_transactions
+	$(MAKE) integration-test-web-client
 
 .PHONY: kill-node
 kill-node: ## Kill node process

crates/web-client/.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "require": ["ts-node/register", "esm"],
+  "extension": ["ts"],
+  "spec": "test/**/*.test.ts",
+  "timeout": 600000
+}

crates/web-client/js/types/index.d.ts

@@ -1,6 +1,6 @@
 export {
-    WebClient,
-    NewTransactionResult,
-    SerializedAccountStub,
-    NewSwapTransactionResult
+  WebClient,
+  NewTransactionResult,
+  SerializedAccountStub,
+  NewSwapTransactionResult,
 } from "./crates/miden_client";

crates/web-client/package.json

@@ -18,15 +18,27 @@
     "../LICENSE.md"
   ],
   "scripts": {
-    "build": "rimraf dist && rollup -c rollup.config.js && cpr js/types dist && rimraf dist/wasm*"
+    "build": "rimraf dist && rollup -c rollup.config.js && cpr js/types dist && rimraf dist/wasm*",
+    "test": "node --loader ts-node/esm --loader esm ./node_modules/mocha/bin/mocha --file ./test/mocha.global.setup.mjs",
+    "test:clean": "npm install && npm run build && node --loader ts-node/esm --loader esm ./node_modules/mocha/bin/mocha --file ./test/mocha.global.setup.mjs"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@wasm-tool/rollup-plugin-rust": "^2.4.5",
+    "@types/chai": "^4.3.17",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^22.4.1",
+    "chai": "^5.1.1",
     "cpr": "^3.0.1",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.27.2"
+    "esm": "^3.2.25",
+    "http-server": "^14.1.1",
+    "mocha": "^10.7.3",
+    "puppeteer": "^23.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^3.27.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4",
+    "@wasm-tool/rollup-plugin-rust": "wasm-tool/rollup-plugin-rust"
   },
   "dependencies": {
     "dexie": "^4.0.1"

crates/web-client/test/README.md

@@ -0,0 +1,75 @@
+# Testing
+
+The .wasm must be run within the context of a webpage. To this end, we've set up a Mocha
+test suite which hosts the .wasm on a local server and then executes WebClient commands
+within the context of the web page.
+
+## Running tests
+
+1. Install dependencies via `yarn`
+1. Ensure the .wasm is built by running `yarn build`
+1. In crates/web-client run `yarn test` to run all tests
+
+   - Can alternatively run `yarn test:clean` to run the .wasm build process prior to testing. We provide both paths as the build process can take some time.
+
+1. For running an individual test by name run `yarn test -g <test-name>`
+
+## Writing tests
+
+1. The test setup in `mocha.global.setup.mjs` should expose the `create_client` function which can be used inside tests.
+   - Any further setup of wasm code should be done in this file and similarly expose a function for testing here
+1. `webClientTestUtils.js` should contain all interfaces for interacting with the web client. If further methods need to be added, follow existing patterns which use the exposed `testingPage` and pass through any required arguments to the page execution. Example:
+
+```
+/**
+ *
+ * @param {string} arg1
+ * @param {boolean} arg2
+ *
+ * @returns {Promise<string>} The result
+ */
+export const webClientCall = async (arg1, arg2) => {
+  return await testingPage.evaluate(
+    async (_arg1, _arg2) => {
+      if (!window.client) {
+        await window.create_client();
+      }
+
+      /** @type {WebClient} */
+      const client = window.client;
+      const result = client.webClientCall(_arg1, _arg2);
+
+      return result;
+    },
+    arg1,
+    arg2
+  );
+};
+```
+
+- Add JSDocs to methods. This will allow typing in the `*.test.ts` files.
+- We add the `if (!window.client)` to avoid spinning up clients unnecessarily lengthening test time. This unfortunately cannot be pulled out to a helper method as the testingPage scope does not share the scope of the file.
+- Similarly, the boilerplate for passing args through as shown above is necessary due to scoping.
+
+## Debugging
+
+1. When inside of a `page.evaluate` , console logs are being sent to the servers console rather than your IDE's. You can uncomment the line as seen below in the `mocha.global.setup.mjs`:
+
+```
+    page.on("console", (msg) => console.log("PAGE LOG:", msg.text()));
+```
+
+This will forward logs from the server to your terminal logs
+
+## Troubleshooting
+
+1. When trying to run the tests, if you receieve the following error:
+
+```
+     Error: Could not find Chrome (ver. 128.0.6613.119). This can occur if either
+ 1. you did not perform an installation before running the script (e.g. `npx puppeteer browsers install ${browserType}`) or
+ 2. your cache path is incorrectly configured (which is: /Users/ignacioamigo/.cache/puppeteer).
+For (2), check out our guide on configuring puppeteer at https://pptr.dev/guides/configuration.
+```
+
+Try running: `npx puppeteer browsers install` and then run the tests again

crates/web-client/test/faucet.test.ts

@@ -0,0 +1,15 @@
+import { createNewFaucet, isValidAddress } from "./webClientTestUtils.js";
+
+describe("faucet tests", () => {
+  it("create a new faucet", async () => {
+    const result = await createNewFaucet(
+      "OffChain",
+      false,
+      "DMX",
+      "10",
+      "1000000"
+    );
+
+    isValidAddress(result);
+  });
+});

crates/web-client/test/global.test.d.ts

@@ -0,0 +1,5 @@
+import { Page } from "puppeteer";
+
+declare module "./mocha.global.setup.mjs" {
+  export const testingPage: Page;
+}

crates/web-client/test/mocha.global.setup.mjs

@@ -0,0 +1,61 @@
+import puppeteer from "puppeteer";
+import { exec } from "child_process";
+
+import { register } from "ts-node";
+
+register({
+  project: "./tsconfig.json",
+});
+
+let serverProcess;
+let browser;
+let testingPage;
+
+const TEST_SERVER_PORT = 8080;
+const TEST_SERVER = `http://localhost:${TEST_SERVER_PORT}`;
+
+// Should be in sync with the rpc port in tests/config/miden-node.toml
+const LOCAL_MIDEN_NODE_PORT = 57291;
+
+before(async () => {
+  console.log("Starting test server...");
+  serverProcess = exec(`http-server ./dist -p ${TEST_SERVER_PORT}`);
+  browser = await puppeteer.launch({ headless: true });
+  testingPage = await browser.newPage();
+  await testingPage.goto(TEST_SERVER);
+
+  // Uncomment below to enable console logging
+  // testingPage.on("console", (msg) => console.log("PAGE LOG:", msg.text()));
+
+  // Creates the client in the test context and attach to window object
+  await testingPage.exposeFunction("create_client", async () => {
+    await testingPage.evaluate(async (port) => {
+      const { WebClient } = await import("./index.js");
+      let rpc_url = `http://localhost:${port}`;
+      const client = new WebClient();
+      await client.create_client(rpc_url);
+
+      window.client = client;
+    }, LOCAL_MIDEN_NODE_PORT);
+  });
+});
+
+after(async () => {
+  console.log("Stopping test server...");
+  await browser.close();
+  serverProcess.kill("SIGTERM");
+
+  await new Promise((resolve, reject) => {
+    serverProcess.on("close", (code) => {
+      console.log(`Server process exited with code ${code}`);
+      resolve();
+    });
+
+    serverProcess.on("error", (error) => {
+      console.error("Error killing server process:", error);
+      reject(error);
+    });
+  });
+});
+
+export { testingPage };

crates/web-client/test/wallet.test.ts

@@ -0,0 +1,9 @@
+import { createNewWallet, isValidAddress } from "./webClientTestUtils.js";
+
+describe("wallet tests", () => {
+  it("create a new wallet", async () => {
+    const result = await createNewWallet("OffChain", false);
+
+    isValidAddress(result);
+  });
+});