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

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,32 +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 npm 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
@@ -242,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'
@@ -277,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'
@@ -312,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'
@@ -349,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
@@ -371,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
@@ -390,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
@@ -413,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
@@ -421,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
@@ -435,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
@@ -456,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
@@ -478,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
@@ -523,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'
@@ -548,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)

package/src/api/templates/js-binding.ts

@@ -16,18 +16,52 @@ let nativeBinding = null
 let localFileExisted = false
 let loadError = null
 
-function isMusl() {
-  // For Node 10
-  if (!process.report || typeof process.report.getReport !== 'function') {
-    try {
-      const lddPath = require('child_process').execSync('which ldd').toString().trim()
-      return readFileSync(lddPath, 'utf8').includes('musl')
-    } catch (e) {
+const isMusl = () => {
+  let musl = false
+  if (process.platform === 'linux') {
+    musl = isMuslFromFilesystem()
+    if (musl === null) {
+      musl = isMuslFromReport()
+    }
+    if (musl === null) {
+      musl = isMuslFromChildProcess()
+    }
+  }
+  return musl
+}
+
+const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
+
+const isMuslFromFilesystem = () => {
+  try {
+    return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
+  } catch {
+    return null
+  }
+}
+
+const isMuslFromReport = () => {
+  const report = typeof process.report.getReport === 'function' ? process.report.getReport() : null
+  if (!report) {
+    return null
+  }
+  if (report.header && report.header.glibcVersionRuntime) {
+    return false
+  }
+  if (Array.isArray(report.sharedObjects)) {
+    if (report.sharedObjects.some(isFileMusl)) {
       return true
     }
-  } else {
-    const { glibcVersionRuntime } = process.report.getReport().header
-    return !glibcVersionRuntime
+  }
+  return false
+}
+
+const isMuslFromChildProcess = () => {
+  try {
+    return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
+  } catch (e) {
+    // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
+    return false
   }
 }
 
@@ -256,7 +290,7 @@ if (!nativeBinding) {
 }
 
 ${idents
-  .map((ident) => `module.exports.${ident} = binding.${ident}`)
+  .map((ident) => `module.exports.${ident} = nativeBinding.${ident}`)
   .join('\n')}
 `
 }

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

@@ -0,0 +1,52 @@
+export const WASI_WORKER_TEMPLATE = `import fs from "node:fs";
+import { createRequire } from "node:module";
+import { parentPort, Worker } from "node:worker_threads";
+
+import { instantiateNapiModuleSync, MessageHandler } from "@emnapi/core";
+import { WASI } from "@tybys/wasm-util";
+
+const require = createRequire(import.meta.url);
+
+if (parentPort) {
+  parentPort.on("message", (data) => {
+    globalThis.onmessage({ data });
+  });
+}
+
+Object.assign(globalThis, {
+  self: globalThis,
+  require,
+  Worker,
+  importScripts: function (f) {
+    ;(0, eval)(fs.readFileSync(f, "utf8") + "//# sourceURL=" + f);
+  },
+  postMessage: function (msg) {
+    if (parentPort) {
+      parentPort.postMessage(msg);
+    }
+  },
+});
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({ fs });
+
+    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);
+};
+`

package/src/utils/target.ts

@@ -1,5 +1,7 @@
 import { execSync } from 'child_process'
 
+export type Platform = NodeJS.Platform | 'wasm' | 'wasi'
+
 export const AVAILABLE_TARGETS = [
   'aarch64-apple-darwin',
   'aarch64-linux-android',
@@ -63,24 +65,22 @@ export const NodeArchToCpu: Record<string, string> = {
   riscv64: 'riscv64gc',
 }
 
-const SysToNodePlatform: Record<string, NodeJS.Platform> = {
+const SysToNodePlatform: Record<string, Platform> = {
   linux: 'linux',
   freebsd: 'freebsd',
   darwin: 'darwin',
   windows: 'win32',
 }
 
-export const UniArchsByPlatform: Partial<
-  Record<NodeJS.Platform, NodeJSArch[]>
-> = {
+export const UniArchsByPlatform: Partial<Record<Platform, NodeJSArch[]>> = {
   darwin: ['x64', 'arm64'],
 }
 
 export interface Target {
   triple: string
   platformArchABI: string
-  platform: NodeJS.Platform
-  arch: NodeJSArch
+  platform: Platform
+  arch: NodeJSArch | 'wasm32'
   abi: string | null
 }
 
@@ -95,6 +95,15 @@ export interface Target {
  *   - `abi` = The ABI, for example `gnu`, `android`, `eabi`, etc.
  */
 export function parseTriple(rawTriple: string): Target {
+  if (rawTriple === 'wasm32-wasi-preview1-threads') {
+    return {
+      triple: rawTriple,
+      platformArchABI: rawTriple,
+      platform: 'wasi',
+      arch: 'wasm32',
+      abi: 'wasi',
+    }
+  }
   const triple = rawTriple.endsWith('eabi')
     ? `${rawTriple.slice(0, -4)}-eabi`
     : rawTriple
@@ -114,7 +123,7 @@ export function parseTriple(rawTriple: string): Target {
     ;[cpu, , sys, abi = null] = triples
   }
 
-  const platform = SysToNodePlatform[sys] ?? (sys as NodeJS.Platform)
+  const platform = SysToNodePlatform[sys] ?? (sys as Platform)
   const arch = CpuToNodeArch[cpu] ?? (cpu as NodeJSArch)
   return {
     triple: rawTriple,