@napi-rs/cli 3.0.0-alpha.4 → 3.0.0-alpha.6

package/src/api/build.ts

@@ -1,7 +1,8 @@
-import { spawn } from 'child_process'
-import { createHash } from 'crypto'
-import { tmpdir } from 'os'
-import { parse, join, resolve } from 'path'
+import { spawn } from 'node:child_process'
+import { createHash } from 'node:crypto'
+import { createRequire } from 'node:module'
+import { tmpdir } from 'node:os'
+import { parse, join, resolve } from 'node:path'
 
 import * as colors from 'colorette'
 
@@ -20,6 +21,7 @@ import {
   parseMetadata,
   parseTriple,
   processTypeDef,
+  readFileAsync,
   readNapiConfig,
   Target,
   targetToEnvVar,
@@ -28,11 +30,14 @@ import {
   writeFileAsync,
 } from '../utils/index.js'
 
-import { createJsBinding } from './templates/index.js'
+import { createWasiBinding } from './load-wasi-template.js'
+import { createCjsBinding } from './templates/index.js'
+import { WASI_WORKER_TEMPLATE } from './wasi-worker-template.js'
 
 const debug = debugFactory('build')
+const require = createRequire(import.meta.url)
 
-type OutputKind = 'js' | 'dts' | 'node' | 'exe'
+type OutputKind = 'js' | 'dts' | 'node' | 'exe' | 'wasm'
 type Output = {
   kind: OutputKind
   path: string
@@ -149,6 +154,7 @@ class Builder {
 
     const controller = new AbortController()
 
+    const watch = this.options.watch
     const buildTask = new Promise<void>((resolve, reject) => {
       const command =
         process.env.CARGO ?? (this.options.useCross ? 'cross' : 'cargo')
@@ -157,7 +163,7 @@ class Builder {
           ...process.env,
           ...this.envs,
         },
-        stdio: 'inherit',
+        stdio: watch ? ['inherit', 'inherit', 'pipe'] : 'inherit',
         cwd: this.cwd,
         signal: controller.signal,
       })
@@ -178,6 +184,15 @@ class Builder {
           }),
         )
       })
+
+      // watch mode only, they are piped through stderr
+      buildProcess.stderr?.on('data', (data) => {
+        const output = data.toString()
+        console.error(output)
+        if (/Finished\s(dev|release)/.test(output)) {
+          this.postBuild().catch(() => {})
+        }
+      })
     })
 
     return {
@@ -207,6 +222,7 @@ class Builder {
           this.crateDir,
           '--',
           'cargo',
+          'build',
         )
         set = true
       }
@@ -353,18 +369,35 @@ class Builder {
       const targetArch = this.target.arch === 'arm' ? 'armv7a' : 'aarch64'
       const targetPlatform =
         this.target.arch === 'arm' ? 'androideabi24' : 'android24'
+      const hostPlatform =
+        process.platform === 'darwin'
+          ? 'darwin'
+          : process.platform === 'win32'
+          ? 'windows'
+          : 'linux'
       Object.assign(this.envs, {
-        CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/${targetArch}-linux-android24-clang`,
-        CARGO_TARGET_ARMV7_LINUX_ANDROIDEABI_LINKER: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/${targetArch}-linux-androideabi24-clang`,
-        CC: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/${targetArch}-linux-${targetPlatform}-clang`,
-        CXX: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/${targetArch}-linux-${targetPlatform}-clang++`,
-        AR: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/llvm-ar`,
+        CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/${targetArch}-linux-android24-clang`,
+        CARGO_TARGET_ARMV7_LINUX_ANDROIDEABI_LINKER: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/${targetArch}-linux-androideabi24-clang`,
+        CC: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/${targetArch}-linux-${targetPlatform}-clang`,
+        CXX: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/${targetArch}-linux-${targetPlatform}-clang++`,
+        AR: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/llvm-ar`,
+        RANLIB: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin/llvm-ranlib`,
         ANDROID_NDK: ANDROID_NDK_LATEST_HOME,
-        PATH: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin:${process.env.PATH}`,
+        PATH: `${ANDROID_NDK_LATEST_HOME}/toolchains/llvm/prebuilt/${hostPlatform}-x86_64/bin:${process.env.PATH}`,
       })
     }
     // END LINKER
 
+    if (this.target.platform === 'wasi') {
+      const emnapi = join(
+        require.resolve('emnapi'),
+        '..',
+        'lib',
+        'wasm32-wasi-threads',
+      )
+      this.envs.EMNAPI_LINK_DIR = emnapi
+    }
+
     debug('Set envs: ')
     Object.entries(this.envs).forEach(([k, v]) => {
       debug('  %i', `${k}=${v}`)
@@ -452,8 +485,35 @@ class Builder {
 
     // only for cdylib
     if (this.cdyLibName) {
-      await this.generateTypeDef()
-      await this.writeJsBinding()
+      const idents = await this.generateTypeDef()
+      const intermediateWasiRegisterFile = this.envs.WASI_REGISTER_TMP_PATH
+      const wasiRegisterFunctions =
+        this.target.arch === 'wasm32'
+          ? JSON.parse(
+              await readFileAsync(intermediateWasiRegisterFile, 'utf8').catch(
+                (err) => {
+                  console.warn(
+                    `Read ${colors.yellowBright(
+                      intermediateWasiRegisterFile,
+                    )} failed, reason: ${err.message}`,
+                  )
+                  return `[]`
+                },
+              ),
+            )
+          : []
+      const jsOutput = await this.writeJsBinding(idents)
+      const wasmOutput = await this.writeWasiBinding(
+        wasiRegisterFunctions,
+        jsOutput?.path ?? 'index',
+        idents,
+      )
+      if (jsOutput) {
+        this.outputs.push(jsOutput)
+      }
+      if (wasmOutput) {
+        this.outputs.push(wasmOutput)
+      }
     }
 
     return this.outputs
@@ -499,6 +559,8 @@ class Builder {
           ? `lib${cdyLib}.dylib`
           : this.target.platform === 'win32'
           ? `${cdyLib}.dll`
+          : this.target.platform === 'wasi' || this.target.platform === 'wasm'
+          ? `${cdyLib}.wasm`
           : `lib${cdyLib}.so`
 
       let destName = this.config.binaryName
@@ -508,7 +570,11 @@ class Builder {
       if (this.options.platform) {
         destName += `.${this.target.platformArchABI}`
       }
-      destName += '.node'
+      if (srcName.endsWith('.wasm')) {
+        destName += '.wasi-wasm32.wasm'
+      } else {
+        destName += '.node'
+      }
 
       return [srcName, destName]
     } else if (this.binName) {
@@ -523,12 +589,12 @@ class Builder {
 
   private async generateTypeDef() {
     if (!(await fileExists(this.envs.TYPE_DEF_TMP_PATH))) {
-      return
+      return []
     }
 
     const dest = join(this.outputDir, this.options.dts ?? 'index.d.ts')
 
-    const dts = await processTypeDef(
+    const { dts, exports } = await processTypeDef(
       this.envs.TYPE_DEF_TMP_PATH,
       !this.options.noDtsHeader
         ? this.options.dtsHeader ?? DEFAULT_TYPE_DEF_HEADER
@@ -547,27 +613,69 @@ class Builder {
       debug.error('Failed to write type def file')
       debug.error(e as Error)
     }
+
+    return exports
   }
 
-  private async writeJsBinding() {
-    if (!this.options.platform || this.options.noJsBinding) {
+  private async writeJsBinding(idents: string[]) {
+    if (
+      !this.options.platform ||
+      // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+      this.options.noJsBinding ||
+      idents.length === 0
+    ) {
       return
     }
 
-    const dest = join(this.outputDir, this.options.jsBinding ?? 'index.js')
+    const name = parse(this.options.jsBinding ?? 'index.js').name
 
-    const js = createJsBinding(this.config.binaryName, this.config.packageName)
+    const cjs = createCjsBinding(
+      this.config.binaryName,
+      this.config.packageName,
+      idents,
+    )
 
     try {
+      const dest = join(this.outputDir, `${name}.js`)
       debug('Writing js binding to:')
       debug('  %i', dest)
-      await writeFileAsync(dest, js, 'utf-8')
-      this.outputs.push({
+      await writeFileAsync(dest, cjs, 'utf-8')
+      return {
         kind: 'js',
         path: dest,
-      })
+      } satisfies Output
     } catch (e) {
       throw new Error('Failed to write js binding file', { cause: e })
     }
   }
+
+  private async writeWasiBinding(
+    wasiRegisterFunctions: string[],
+    distFileName: string | undefined,
+    idents: string[],
+  ) {
+    if (distFileName && wasiRegisterFunctions.length) {
+      const { name, dir } = parse(distFileName)
+      const newPath = join(dir, `${name}.wasi.mjs`)
+      const workerPath = join(dir, 'wasi-worker.mjs')
+      const declareCodes = `const { ${idents.join(', ')} } = binding\n`
+      const exportsCode = `export {\n${idents
+        .map((ident) => `  ${ident}`)
+        .join(',\n')}\n}`
+      await writeFileAsync(
+        newPath,
+        createWasiBinding(this.config.binaryName, wasiRegisterFunctions) +
+          declareCodes +
+          exportsCode +
+          '\n',
+        'utf8',
+      )
+      await writeFileAsync(workerPath, WASI_WORKER_TEMPLATE, 'utf8')
+      return {
+        kind: 'wasm',
+        path: newPath,
+      } satisfies Output
+    }
+    return null
+  }
 }

package/src/api/load-wasi-template.ts

@@ -0,0 +1,65 @@
+export const createWasiBinding = (
+  localName: string,
+  wasiRegisterFunctions: string[],
+) => `/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+import * as __nodeFsPromises from 'node:fs/promises'
+import * as __nodePath from 'node:path'
+import { WASI as __nodeWASI } from 'node:wasi'
+import { Worker } from 'node:worker_threads'
+import * as __nodeURL from 'node:url'
+
+import { instantiateNapiModule as __emnapiInstantiateNapiModule } from '@emnapi/core'
+import { getDefaultContext as __emnapiGetDefaultContext } from '@emnapi/runtime'
+
+const __wasi = new __nodeWASI({
+  env: process.env,
+  preopens: {
+    '/': __nodePath.join(__nodeURL.fileURLToPath(import.meta.url), '..'),
+  }
+})
+
+const __dirname = __nodePath.join(__nodeURL.fileURLToPath(import.meta.url), '..')
+
+const __emnapiContext = __emnapiGetDefaultContext()
+
+const __sharedMemory = new WebAssembly.Memory({
+  initial: 1024,
+  maximum: 10240,
+  shared: true,
+})
+
+const { instance: __napiInstance, module: __wasiModule, napiModule: __napiModule } = await __emnapiInstantiateNapiModule(__nodeFsPromises.readFile(__nodePath.join(__dirname, '${localName}.wasi-wasm32.wasm')), {
+  context: __emnapiContext,
+  asyncWorkPoolSize: 4,
+  wasi: __wasi,
+  onCreateWorker() {
+    return new Worker(__nodePath.join(__dirname, 'wasi-worker.mjs'), {
+      env: process.env,
+      execArgv: ['--experimental-wasi-unstable-preview1'],
+    })
+  },
+  overwriteImports(importObject) {
+    importObject.env = {
+      ...importObject.env,
+      ...importObject.napi,
+      ...importObject.emnapi,
+      memory: __sharedMemory,
+    }
+  },
+  beforeInit({ instance }) {
+    __napi_rs_initialize_modules(instance)
+  }
+})
+
+function __napi_rs_initialize_modules(__napiInstance) {
+${wasiRegisterFunctions
+  .map((name) => `  __napiInstance.exports['${name}']()`)
+  .join('\n')}
+}
+
+const binding = __napiModule.exports
+`

package/src/api/new.ts

@@ -157,10 +157,7 @@ function generateGithubWorkflow(options: NewOptions): Output | null {
 
   return {
     target: './.github/workflows/ci.yml',
-    content: createGithubActionsCIYml(
-      getBinaryName(options.name),
-      options.targets,
-    ),
+    content: createGithubActionsCIYml(options.targets),
   }
 }
 

package/src/api/pre-publish.ts

@@ -129,11 +129,14 @@ export async function prePublish(userOptions: PrePublishOptions) {
   if (!options.dryRun) {
     await version(userOptions)
     await updatePackageJson(packageJsonPath, {
-      optionalDependencies: targets.reduce((deps, target) => {
-        deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
-
-        return deps
-      }, {} as Record<string, string>),
+      optionalDependencies: targets.reduce(
+        (deps, target) => {
+          deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
+
+          return deps
+        },
+        {} as Record<string, string>,
+      ),
     })
   }
 

package/src/api/templates/.gitignore.ts

@@ -195,4 +195,5 @@ Cargo.lock
 !.yarn/versions
 
 *.node
+*.wasm
 `

package/src/api/templates/ci-template.ts

@@ -5,6 +5,10 @@ env:
   DEBUG: 'napi:*'
   MACOSX_DEPLOYMENT_TARGET: '10.13'
 
+permissions:
+  contents: write
+  id-token: write
+
 on:
   push:
     branches:
@@ -107,10 +111,10 @@ jobs:
     runs-on: \${{ matrix.settings.host }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         if: \${{ !matrix.settings.docker }}
         with:
           node-version: 18
@@ -137,7 +141,7 @@ jobs:
       - uses: goto-bus-stop/setup-zig@v2
         if: \${{ matrix.settings.target == 'armv7-unknown-linux-gnueabihf' }}
         with:
-          version: 0.10.1
+          version: 0.11.0
 
       - name: Setup toolchain
         run: \${{ matrix.settings.setup }}
@@ -153,7 +157,7 @@ jobs:
         run: yarn install
 
       - name: Setup node x86
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         if: matrix.settings.target == 'i686-pc-windows-msvc'
         with:
           node-version: 18
@@ -184,34 +188,32 @@ jobs:
     runs-on: macos-12
     name: Build FreeBSD
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build
         id: build
-        uses: vmactions/freebsd-vm@v0
+        uses: cross-platform-actions/action@v0.21.0
         env:
           DEBUG: 'napi:*'
-          RUSTUP_HOME: /usr/local/rustup
-          CARGO_HOME: /usr/local/cargo
           RUSTUP_IO_THREADS: 1
         with:
-          envs: 'DEBUG RUSTUP_HOME CARGO_HOME RUSTUP_IO_THREADS'
-          usesh: true
-          mem: 3000
+          operating_system: freebsd
+          version: '13.2'
+          memory: 13G
+          cpu_count: 3
+          environment_variables: 'DEBUG RUSTUP_IO_THREADS'
+          shell: bash
           prepare: |
-            pkg install -y -f curl node libnghttp2
-            curl -qL https://www.npmjs.com/install.sh | sh
-            npm install --location=global --ignore-scripts yarn
+            sudo pkg install -y -f curl node libnghttp2 npm
+            sudo npm install -g yarn --ignore-scripts
             curl https://sh.rustup.rs -sSf --output rustup.sh
-            sh rustup.sh -y --profile minimal --default-toolchain beta
-            export PATH="/usr/local/cargo/bin:$PATH"
+            sh rustup.sh -y --profile minimal --default-toolchain stable
+            source "$HOME/.cargo/env"
             echo "~~~~ rustc --version ~~~~"
             rustc --version
             echo "~~~~ node -v ~~~~"
             node -v
             echo "~~~~ yarn --version ~~~~"
             yarn --version
-          run: |
-            export PATH="/usr/local/cargo/bin:$PATH"
             pwd
             ls -lah
             whoami
@@ -244,13 +246,14 @@ jobs:
           - host: windows-latest
             target: 'x86_64-pc-windows-msvc'
         node: ['16', '18']
+        node: ['18', '20']
     runs-on: \${{ matrix.settings.host }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: \${{ matrix.node }}
           cache: 'yarn'
@@ -279,13 +282,14 @@ jobs:
       fail-fast: false
       matrix:
         node: ['16', '18']
+        node: ['18', '20']
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: \${{ matrix.node }}
           cache: 'yarn'
@@ -314,13 +318,14 @@ jobs:
       fail-fast: false
       matrix:
         node: ['16', '18']
+        node: ['18', '20']
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: \${{ matrix.node }}
           cache: 'yarn'
@@ -351,10 +356,11 @@ jobs:
       fail-fast: false
       matrix:
         node: ['16', '18']
+        node: ['18', '20']
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download artifacts
         uses: actions/download-artifact@v3
@@ -373,7 +379,7 @@ jobs:
           yarn install
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         with:
           platforms: arm64
       - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
@@ -392,11 +398,15 @@ jobs:
     name: Test bindings on aarch64-unknown-linux-musl - node@\${{ matrix.node }}
     needs:
       - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ['16', '18']
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download artifacts
         uses: actions/download-artifact@v3
@@ -415,7 +425,7 @@ jobs:
           yarn install
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         with:
           platforms: arm64
       - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
@@ -423,7 +433,7 @@ jobs:
       - name: Setup and run tests
         uses: addnab/docker-run-action@v3
         with:
-          image: node:lts-alpine
+          image: node:\${{ matrix.node }}-alpine
           options: --platform linux/arm64 -v \${{ github.workspace }}:/build -w /build
           run: |
             set -e
@@ -437,10 +447,11 @@ jobs:
       fail-fast: false
       matrix:
         node: ['16', '18']
+        node: ['18', '20']
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download artifacts
         uses: actions/download-artifact@v3
@@ -458,7 +469,7 @@ jobs:
           yarn install
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         with:
           platforms: arm
       - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
@@ -480,10 +491,10 @@ jobs:
     runs-on: macos-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: yarn
@@ -525,10 +536,10 @@ jobs:
       - build-freebsd
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
           cache: 'yarn'
@@ -550,6 +561,7 @@ jobs:
 
       - name: Publish
         run: |
+          npm config set provenance true
           if git log -1 --pretty=%B | grep "^[0-9]\\+\\.[0-9]\\+\\.[0-9]\\+$";
           then
             echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc

package/src/api/templates/ci.yml.ts

@@ -17,10 +17,7 @@ const TEST_LINUX_AARCH64_MUSL = 'test-linux-aarch64-musl-binding'
 const TEST_LINUX_ARM_GNUEABIHF = 'test-linux-arm-gnueabihf-binding'
 const UNIVERSAL_MACOS = 'universal-macOS'
 
-export const createGithubActionsCIYml = (
-  binaryName: string,
-  targets: string[],
-) => {
+export const createGithubActionsCIYml = (targets: string[]) => {
   const allTargets = new Set(
     targets.flatMap((t) => {
       const platform = parseTriple(t)
@@ -63,10 +60,16 @@ export const createGithubActionsCIYml = (
   if (!enableWindowsX86 && !enableMacOSX86) {
     delete fullTemplate.jobs[TEST_MACOS_WINDOWS]
   } else {
-    const filterTarget = enableWindowsX86 ? 'macos-latest' : 'windows-latest'
+    const filterTargets = new Set<string>()
+    if (enableWindowsX86) {
+      filterTargets.add('windows-latest')
+    }
+    if (enableMacOSUni || enableMacOSX86) {
+      filterTargets.add('macos-latest')
+    }
     fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings =
       fullTemplate.jobs[TEST_MACOS_WINDOWS].strategy.matrix.settings.filter(
-        ({ host }: { host: string; target: string }) => host !== filterTarget,
+        ({ host }: { host: string; target: string }) => filterTargets.has(host),
       )
 
     requiredSteps.push(TEST_MACOS_WINDOWS)