@napi-rs/cli 3.7.2 → 3.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.7.2",
+  "version": "3.7.3",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://napi.rs/",
@@ -84,7 +84,7 @@
     "ava": "^8.0.1",
     "empathic": "^2.0.1",
     "env-paths": "^4.0.0",
-    "oxc-parser": "^0.135.0",
+    "oxc-parser": "^0.139.0",
     "prettier": "^3.8.3",
     "tsdown": "^0.22.2",
     "tslib": "^2.8.1",
@@ -111,7 +111,7 @@
     "extensions": [
       "ts"
     ],
-    "timeout": "2m",
+    "timeout": "5m",
     "workerThreads": false,
     "files": [
       "**/__tests__/**/*.spec.ts",

package/src/api/__tests__/__snapshots__/templates.spec.ts.md

@@ -0,0 +1,353 @@
+# Snapshot report for `src/api/__tests__/templates.spec.ts`
+
+The actual snapshot is saved in `templates.spec.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## createWasiBrowserBinding default
+
+> Snapshot 1
+
+    `import {␊
+      createOnMessage as __wasmCreateOnMessageForFsProxy,␊
+      getDefaultContext as __emnapiGetDefaultContext,␊
+      instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,␊
+      WASI as __WASI,␊
+    } from '@napi-rs/wasm-runtime'␊
+    ␊
+    ␊
+    ␊
+    const __wasi = new __WASI({␊
+      version: 'preview1',␊
+    })␊
+    ␊
+    const __wasmUrl = new URL('./test-wasi.wasm', import.meta.url).href␊
+    const __emnapiContext = __emnapiGetDefaultContext()␊
+    ␊
+    ␊
+    const __sharedMemory = new WebAssembly.Memory({␊
+      initial: 4000,␊
+      maximum: 65536,␊
+      shared: true,␊
+    })␊
+    ␊
+    const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())␊
+    ␊
+    const {␊
+      instance: __napiInstance,␊
+      module: __wasiModule,␊
+      napiModule: __napiModule,␊
+    } = __emnapiInstantiateNapiModuleSync(__wasmFile, {␊
+      context: __emnapiContext,␊
+      asyncWorkPoolSize: 4,␊
+      wasi: __wasi,␊
+      onCreateWorker() {␊
+        const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {␊
+          type: 'module',␊
+        })␊
+    ␊
+    ␊
+        return worker␊
+      },␊
+      overwriteImports(importObject) {␊
+        importObject.env = {␊
+          ...importObject.env,␊
+          ...importObject.napi,␊
+          ...importObject.emnapi,␊
+          memory: __sharedMemory,␊
+        }␊
+        return importObject␊
+      },␊
+      beforeInit({ instance }) {␊
+        for (const name of Object.keys(instance.exports)) {␊
+          if (name.startsWith('__napi_register__')) {␊
+            instance.exports[name]()␊
+          }␊
+        }␊
+      },␊
+    })␊
+    `
+
+## createWasiBrowserBinding with errorEvent
+
+> Snapshot 1
+
+    `import {␊
+      createOnMessage as __wasmCreateOnMessageForFsProxy,␊
+      getDefaultContext as __emnapiGetDefaultContext,␊
+      instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,␊
+      WASI as __WASI,␊
+    } from '@napi-rs/wasm-runtime'␊
+    ␊
+    ␊
+    ␊
+    const __wasi = new __WASI({␊
+      version: 'preview1',␊
+    })␊
+    ␊
+    const __wasmUrl = new URL('./test-wasi.wasm', import.meta.url).href␊
+    const __emnapiContext = __emnapiGetDefaultContext()␊
+    ␊
+    ␊
+    const __sharedMemory = new WebAssembly.Memory({␊
+      initial: 4000,␊
+      maximum: 65536,␊
+      shared: true,␊
+    })␊
+    ␊
+    const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())␊
+    ␊
+    const {␊
+      instance: __napiInstance,␊
+      module: __wasiModule,␊
+      napiModule: __napiModule,␊
+    } = __emnapiInstantiateNapiModuleSync(__wasmFile, {␊
+      context: __emnapiContext,␊
+      asyncWorkPoolSize: 4,␊
+      wasi: __wasi,␊
+      onCreateWorker() {␊
+        const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {␊
+          type: 'module',␊
+        })␊
+    ␊
+        worker.addEventListener('message', (event) => {␊
+          if (event.data && typeof event.data === 'object' && event.data.type === 'error') {␊
+            window.dispatchEvent(new CustomEvent('napi-rs-worker-error', { detail: event.data }))␊
+          }␊
+        })␊
+    ␊
+        return worker␊
+      },␊
+      overwriteImports(importObject) {␊
+        importObject.env = {␊
+          ...importObject.env,␊
+          ...importObject.napi,␊
+          ...importObject.emnapi,␊
+          memory: __sharedMemory,␊
+        }␊
+        return importObject␊
+      },␊
+      beforeInit({ instance }) {␊
+        for (const name of Object.keys(instance.exports)) {␊
+          if (name.startsWith('__napi_register__')) {␊
+            instance.exports[name]()␊
+          }␊
+        }␊
+      },␊
+    })␊
+    `
+
+## createWasiBrowserBinding with errorEvent and fs
+
+> Snapshot 1
+
+    `import {␊
+      createOnMessage as __wasmCreateOnMessageForFsProxy,␊
+      getDefaultContext as __emnapiGetDefaultContext,␊
+      instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,␊
+      WASI as __WASI,␊
+    } from '@napi-rs/wasm-runtime'␊
+    import { memfs } from '@napi-rs/wasm-runtime/fs'␊
+    ␊
+    ␊
+    export const { fs: __fs, vol: __volume } = memfs()␊
+    ␊
+    const __wasi = new __WASI({␊
+      version: 'preview1',␊
+      fs: __fs,␊
+      preopens: {␊
+        '/': '/',␊
+      },␊
+    })␊
+    ␊
+    const __wasmUrl = new URL('./test-wasi.wasm', import.meta.url).href␊
+    const __emnapiContext = __emnapiGetDefaultContext()␊
+    ␊
+    ␊
+    const __sharedMemory = new WebAssembly.Memory({␊
+      initial: 4000,␊
+      maximum: 65536,␊
+      shared: true,␊
+    })␊
+    ␊
+    const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())␊
+    ␊
+    const {␊
+      instance: __napiInstance,␊
+      module: __wasiModule,␊
+      napiModule: __napiModule,␊
+    } = __emnapiInstantiateNapiModuleSync(__wasmFile, {␊
+      context: __emnapiContext,␊
+      asyncWorkPoolSize: 4,␊
+      wasi: __wasi,␊
+      onCreateWorker() {␊
+        const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {␊
+          type: 'module',␊
+        })␊
+        worker.addEventListener('message', __wasmCreateOnMessageForFsProxy(__fs))␊
+    ␊
+        worker.addEventListener('message', (event) => {␊
+          if (event.data && typeof event.data === 'object' && event.data.type === 'error') {␊
+            window.dispatchEvent(new CustomEvent('napi-rs-worker-error', { detail: event.data }))␊
+          }␊
+        })␊
+    ␊
+        return worker␊
+      },␊
+      overwriteImports(importObject) {␊
+        importObject.env = {␊
+          ...importObject.env,␊
+          ...importObject.napi,␊
+          ...importObject.emnapi,␊
+          memory: __sharedMemory,␊
+        }␊
+        return importObject␊
+      },␊
+      beforeInit({ instance }) {␊
+        for (const name of Object.keys(instance.exports)) {␊
+          if (name.startsWith('__napi_register__')) {␊
+            instance.exports[name]()␊
+          }␊
+        }␊
+      },␊
+    })␊
+    `
+
+## createWasiBrowserWorkerBinding default
+
+> Snapshot 1
+
+    `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'␊
+    ␊
+    const handler = new MessageHandler({␊
+      onLoad({ wasmModule, wasmMemory }) {␊
+        const wasi = new WASI({␊
+          print: function () {␊
+            // eslint-disable-next-line no-console␊
+            console.log.apply(console, arguments)␊
+          },␊
+          printErr: function() {␊
+            // eslint-disable-next-line no-console␊
+            console.error.apply(console, arguments)␊
+            ␊
+          },␊
+        })␊
+        return instantiateNapiModuleSync(wasmModule, {␊
+          childThread: true,␊
+          wasi,␊
+          overwriteImports(importObject) {␊
+            importObject.env = {␊
+              ...importObject.env,␊
+              ...importObject.napi,␊
+              ...importObject.emnapi,␊
+              memory: wasmMemory,␊
+            }␊
+          },␊
+        })␊
+      },␊
+      ␊
+    })␊
+    ␊
+    globalThis.onmessage = function (e) {␊
+      handler.handle(e)␊
+    }␊
+    `
+
+## createWasiBrowserWorkerBinding with errorEvent
+
+> Snapshot 1
+
+    `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'␊
+    ␊
+    const errorOutputs = []␊
+    ␊
+    const handler = new MessageHandler({␊
+      onLoad({ wasmModule, wasmMemory }) {␊
+        const wasi = new WASI({␊
+          print: function () {␊
+            // eslint-disable-next-line no-console␊
+            console.log.apply(console, arguments)␊
+          },␊
+          printErr: function() {␊
+            // eslint-disable-next-line no-console␊
+            console.error.apply(console, arguments)␊
+            ␊
+            errorOutputs.push([...arguments])␊
+          },␊
+        })␊
+        return instantiateNapiModuleSync(wasmModule, {␊
+          childThread: true,␊
+          wasi,␊
+          overwriteImports(importObject) {␊
+            importObject.env = {␊
+              ...importObject.env,␊
+              ...importObject.napi,␊
+              ...importObject.emnapi,␊
+              memory: wasmMemory,␊
+            }␊
+          },␊
+        })␊
+      },␊
+      onError(error) {␊
+        postMessage({ type: 'error', error, errorOutputs })␊
+        errorOutputs.length = 0␊
+      }␊
+    })␊
+    ␊
+    globalThis.onmessage = function (e) {␊
+      handler.handle(e)␊
+    }␊
+    `
+
+## createWasiBrowserWorkerBinding with errorEvent and fs
+
+> Snapshot 1
+
+    `import { instantiateNapiModuleSync, MessageHandler, WASI, createFsProxy } from '@napi-rs/wasm-runtime'␊
+    import { memfsExported as __memfsExported } from '@napi-rs/wasm-runtime/fs'␊
+    ␊
+    const fs = createFsProxy(__memfsExported)␊
+    ␊
+    const errorOutputs = []␊
+    ␊
+    const handler = new MessageHandler({␊
+      onLoad({ wasmModule, wasmMemory }) {␊
+        const wasi = new WASI({␊
+          fs,␊
+          preopens: {␊
+            '/': '/',␊
+          },␊
+          print: function () {␊
+            // eslint-disable-next-line no-console␊
+            console.log.apply(console, arguments)␊
+          },␊
+          printErr: function() {␊
+            // eslint-disable-next-line no-console␊
+            console.error.apply(console, arguments)␊
+            ␊
+            errorOutputs.push([...arguments])␊
+          },␊
+        })␊
+        return instantiateNapiModuleSync(wasmModule, {␊
+          childThread: true,␊
+          wasi,␊
+          overwriteImports(importObject) {␊
+            importObject.env = {␊
+              ...importObject.env,␊
+              ...importObject.napi,␊
+              ...importObject.emnapi,␊
+              memory: wasmMemory,␊
+            }␊
+          },␊
+        })␊
+      },␊
+      onError(error) {␊
+        postMessage({ type: 'error', error, errorOutputs })␊
+        errorOutputs.length = 0␊
+      }␊
+    })␊
+    ␊
+    globalThis.onmessage = function (e) {␊
+      handler.handle(e)␊
+    }␊
+    `

package/src/api/__tests__/android-build.spec.ts

@@ -0,0 +1,113 @@
+import { existsSync } from 'node:fs'
+import { mkdir, rm, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import ava, { type TestFn } from 'ava'
+
+import { buildProject } from '../build.js'
+
+const test = ava as TestFn<{ tmpDir: string; projectDir: string }>
+
+test.beforeEach(async (t) => {
+  const tmpDir = join(
+    tmpdir(),
+    'napi-rs-test',
+    `android-build-${Date.now()}-${Math.random().toString(36).slice(2)}`,
+  )
+  const projectDir = join(tmpDir, 'project')
+
+  await mkdir(join(projectDir, 'src'), { recursive: true })
+  await writeFile(
+    join(projectDir, 'Cargo.toml'),
+    `[package]
+name = "android_build"
+version = "0.1.0"
+edition = "2021"
+
+[[bin]]
+name = "android-build"
+path = "src/main.rs"
+`,
+  )
+  await writeFile(join(projectDir, 'src', 'main.rs'), 'fn main() {}\n')
+  await writeFile(
+    join(projectDir, 'package.json'),
+    JSON.stringify({ name: 'android-build', version: '0.1.0' }),
+  )
+  t.context = { tmpDir, projectDir }
+})
+
+test.afterEach.always(async (t) => {
+  if (existsSync(t.context.tmpDir)) {
+    await rm(t.context.tmpDir, { recursive: true, force: true })
+  }
+})
+
+test.serial(
+  'requires ANDROID_NDK_LATEST_HOME before spawning an Android cross-build',
+  async (t) => {
+    const { projectDir } = t.context
+    const originalCargo = process.env.CARGO
+    const originalNdkHome = process.env.ANDROID_NDK_LATEST_HOME
+    process.env.CARGO = join(projectDir, 'cargo-must-not-run')
+    delete process.env.ANDROID_NDK_LATEST_HOME
+    try {
+      const error = await t.throwsAsync(() =>
+        buildProject({
+          cwd: projectDir,
+          target: 'aarch64-linux-android',
+          bin: 'android-build',
+        }),
+      )
+
+      t.regex(error!.message, /ANDROID_NDK_LATEST_HOME.+required/)
+    } finally {
+      if (originalCargo === undefined) {
+        delete process.env.CARGO
+      } else {
+        process.env.CARGO = originalCargo
+      }
+      if (originalNdkHome === undefined) {
+        delete process.env.ANDROID_NDK_LATEST_HOME
+      } else {
+        process.env.ANDROID_NDK_LATEST_HOME = originalNdkHome
+      }
+    }
+  },
+)
+
+test.serial(
+  'skips host Android NDK setup when building with cross',
+  async (t) => {
+    const { projectDir } = t.context
+    const originalCargo = process.env.CARGO
+    const originalNdkHome = process.env.ANDROID_NDK_LATEST_HOME
+    const cargoPath = join(projectDir, 'cross-must-be-spawned')
+    process.env.CARGO = cargoPath
+    delete process.env.ANDROID_NDK_LATEST_HOME
+    try {
+      const { task } = await buildProject({
+        cwd: projectDir,
+        target: 'aarch64-linux-android',
+        bin: 'android-build',
+        useCross: true,
+      })
+      const error = await t.throwsAsync(task)
+
+      t.is((error!.cause as NodeJS.ErrnoException).path, cargoPath)
+      t.notRegex(error!.message, /ANDROID_NDK_LATEST_HOME/)
+    } finally {
+      if (originalCargo === undefined) {
+        delete process.env.CARGO
+      } else {
+        process.env.CARGO = originalCargo
+      }
+      if (originalNdkHome === undefined) {
+        delete process.env.ANDROID_NDK_LATEST_HOME
+      } else {
+        process.env.ANDROID_NDK_LATEST_HOME = originalNdkHome
+      }
+    }
+  },
+)

package/src/api/__tests__/artifacts.spec.ts

@@ -0,0 +1,95 @@
+import { existsSync } from 'node:fs'
+import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import ava, { type TestFn } from 'ava'
+
+import { collectArtifacts } from '../artifacts.js'
+
+const test = ava as TestFn<{ tmpDir: string }>
+
+test.beforeEach(async (t) => {
+  const tmpDir = join(
+    tmpdir(),
+    'napi-rs-test',
+    `artifacts-spec-${Date.now()}-${Math.random().toString(36).slice(2)}`,
+  )
+
+  await mkdir(tmpDir, { recursive: true })
+  t.context = { tmpDir }
+})
+
+test.afterEach.always(async (t) => {
+  if (existsSync(t.context.tmpDir)) {
+    await rm(t.context.tmpDir, { recursive: true, force: true })
+  }
+})
+
+test('resolves a relative WASI build output directory from cwd', async (t) => {
+  const { tmpDir } = t.context
+  const binaryName = 'wasi-artifact'
+  const packageName = '@napi-rs/wasi-artifact'
+  const buildOutputDir = join(tmpDir, 'build-output')
+  const wasiPackageDir = join(tmpDir, 'npm', 'wasm32-wasi')
+
+  await Promise.all([
+    mkdir(join(tmpDir, 'artifacts'), { recursive: true }),
+    mkdir(buildOutputDir, { recursive: true }),
+    mkdir(wasiPackageDir, { recursive: true }),
+  ])
+  await writeFile(
+    join(tmpDir, 'package.json'),
+    JSON.stringify({
+      name: packageName,
+      version: '0.0.0',
+      napi: {
+        binaryName,
+        targets: ['wasm32-wasi-preview1-threads'],
+      },
+    }),
+  )
+
+  const browserEntry =
+    "const worker = new URL('./wasi-worker-browser.mjs', import.meta.url)\n"
+  await Promise.all([
+    writeFile(join(buildOutputDir, `${binaryName}.wasi.cjs`), 'node binding'),
+    writeFile(join(buildOutputDir, 'wasi-worker.mjs'), 'node worker'),
+    writeFile(
+      join(buildOutputDir, `${binaryName}.wasi-browser.js`),
+      browserEntry,
+    ),
+    writeFile(
+      join(buildOutputDir, 'wasi-worker-browser.mjs'),
+      'browser worker',
+    ),
+  ])
+
+  await collectArtifacts({
+    cwd: tmpDir,
+    buildOutputDir: 'build-output',
+  })
+
+  t.is(
+    await readFile(join(wasiPackageDir, `${binaryName}.wasi.cjs`), 'utf8'),
+    'node binding',
+  )
+  t.is(
+    await readFile(join(wasiPackageDir, 'wasi-worker.mjs'), 'utf8'),
+    'node worker',
+  )
+  t.is(
+    await readFile(join(wasiPackageDir, 'wasi-worker-browser.mjs'), 'utf8'),
+    'browser worker',
+  )
+  t.is(
+    await readFile(
+      join(wasiPackageDir, `${binaryName}.wasi-browser.js`),
+      'utf8',
+    ),
+    browserEntry.replace(
+      "new URL('./wasi-worker-browser.mjs', import.meta.url)",
+      `new URL('${packageName}-wasm32-wasi/wasi-worker-browser.mjs', import.meta.url)`,
+    ),
+  )
+})