Add browser tests

.github/workflows/ci.yml

@@ -31,6 +31,25 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
+      - name: Set up browser tests
+        working-directory: tests-browser
+        run: pnpm install && pnpm exec playwright install chromium firefox
+
+      - name: Install webkit browser on macos
+        working-directory: tests-browser
+        if: matrix.os == 'macos-latest'
+        run: pnpm exec playwright install
+
+      - name: Run browser tests (chromium, firefox)
+        run: |
+          pnpm test:browser
+          pnpm test:browser -- --browser=firefox
+
+      - name: Run browser tests (webkit)
+        if: matrix.os == 'macos-latest'
+        run: |
+          pnpm test:browser -- --browser=webkit
+
   check-runtimes:
     runs-on: ubuntu-latest
     steps:
@@ -50,8 +69,8 @@ jobs:
         with:
           deno-version: v2.x
 
-      - run: pnpm install && pnpm build
-      - run: cd example && pnpm install
-      - run: bun run example/main.js
-      - run: deno run --allow-read example/main.js
-      - run: node example/main.js
+      - run: pnpm install && pnpm build && cd example && pnpm install
+
+      - name: check main.js
+        run: |
+          ./scripts/check-runtime.sh example/main.js

.gitignore

@@ -2,9 +2,12 @@ node_modules/
 coverage/
 dist/
 
+.DS_Store
+
 # example
 example/bun.lockb
 example/deno.lock
 example/pnpm-lock.yaml
 
-.DS_Store
+# browser tests
+tests-browser/pnpm-lock.yaml

package.json

@@ -49,13 +49,14 @@
   },
   "scripts": {
     "build": "npx tsc",
-    "test": "vitest"
+    "test": "vitest",
+    "test:browser": "cd tests-browser && pnpm test"
   },
   "peerDependencies": {
     "@noble/ciphers": "^1.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.8.6",
     "@vitest/coverage-v8": "^2.1.4",
     "typescript": "^5.6.3",
     "vitest": "^2.1.4"

scripts/check-runtime.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+bun run $1
+deno run --allow-read $1
+node $1

tests-browser/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "tests-browser",
+  "description": "Test browser compatibility",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@ecies/ciphers": "file:.."
+  },
+  "devDependencies": {
+    "@vitest/browser": "^2.1.4",
+    "playwright": "^1.48.2",
+    "vitest": "^2.1.4"
+  },
+  "packageManager": "pnpm@9.12.3+sha512.cce0f9de9c5a7c95bef944169cc5dfe8741abfb145078c0d508b868056848a87c81e626246cb60967cbd7fd29a6c062ef73ff840d96b3c86c40ac92cf4a813ee"
+}

tests-browser/random.test.ts

@@ -0,0 +1,39 @@
+import { aes256cbc, aes256gcm } from "@ecies/ciphers/aes";
+import { xchacha20 } from "@ecies/ciphers/chacha";
+import { randomBytes } from "@noble/ciphers/webcrypto";
+
+import { describe, expect, it } from "vitest";
+
+const TEXT = "hello browser🌍!";
+const encoder = new TextEncoder();
+const data = encoder.encode(TEXT);
+
+describe("test random", () => {
+  function checkCipher(
+    callback: typeof aes256gcm | typeof aes256cbc | typeof xchacha20,
+    key: Uint8Array,
+    nonce: Uint8Array,
+    aad?: Uint8Array
+  ) {
+    const cipher = callback(key, nonce, aad);
+    expect(cipher.decrypt(cipher.encrypt(data))).toStrictEqual(data);
+  }
+
+  it("tests aes gcm", () => {
+    checkCipher(aes256gcm, randomBytes(32), randomBytes(16), randomBytes(8));
+    checkCipher(aes256gcm, randomBytes(32), randomBytes(12), randomBytes(8));
+  });
+
+  it("tests aes cbc", () => {
+    const key = randomBytes();
+    const nonce = randomBytes(16);
+    checkCipher(aes256cbc, key, nonce);
+  });
+
+  it("tests xchacha20", () => {
+    const key = randomBytes();
+    const nonce = randomBytes(24);
+    const aad = randomBytes(8);
+    checkCipher(xchacha20, key, nonce, aad);
+  });
+});

vitest.config.ts → tests-browser/vitest.config.mts

@@ -2,10 +2,11 @@ import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
-    coverage: {
-      include: ["src/**"],
+    browser: {
       enabled: true,
-      provider: "v8",
+      name: "chromium",
+      provider: "playwright",
+      providerOptions: {},
     },
   },
 });

vitest.config.mts

@@ -0,0 +1,12 @@
+import { configDefaults, defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    exclude: [...configDefaults.exclude, "tests-browser/**"],
+    coverage: {
+      include: ["src/**"],
+      enabled: true,
+      provider: "v8",
+    },
+  },
+});