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

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

@@ -2,6 +2,7 @@ import { load, dump } from 'js-yaml'
 
 import {
   NodeArchToCpu,
+  type SupportedPackageManager,
   UniArchsByPlatform,
   parseTriple,
 } from '../../utils/index.js'
@@ -15,11 +16,12 @@ const TEST_LINUX_X64_MUSL = 'test-linux-x64-musl-binding'
 const TEST_LINUX_AARCH64_GNU = 'test-linux-aarch64-gnu-binding'
 const TEST_LINUX_AARCH64_MUSL = 'test-linux-aarch64-musl-binding'
 const TEST_LINUX_ARM_GNUEABIHF = 'test-linux-arm-gnueabihf-binding'
+const TEST_WASI = 'test-wasi-nodejs'
 const UNIVERSAL_MACOS = 'universal-macOS'
 
 export const createGithubActionsCIYml = (
-  binaryName: string,
   targets: string[],
+  packageManager: SupportedPackageManager,
 ) => {
   const allTargets = new Set(
     targets.flatMap((t) => {
@@ -34,7 +36,7 @@ export const createGithubActionsCIYml = (
     }),
   )
 
-  const fullTemplate = load(YAML()) as any
+  const fullTemplate = load(YAML(packageManager)) as any
 
   const requiredSteps = []
   const enableWindowsX86 = allTargets.has('x86_64-pc-windows-msvc')
@@ -46,6 +48,7 @@ export const createGithubActionsCIYml = (
   const enableLinuxArm7 = allTargets.has('armv7-unknown-linux-gnueabihf')
   const enableFreeBSD = allTargets.has('x86_64-unknown-freebsd')
   const enableMacOSUni = allTargets.has('universal-apple-darwin')
+  const enableWasi = allTargets.has('wasm32-wasi-preview1-threads')
   fullTemplate.jobs.build.strategy.matrix.settings =
     fullTemplate.jobs.build.strategy.matrix.settings.filter(
       ({ target }: { target: string }) => allTargets.has(target),
@@ -63,10 +66,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)
@@ -108,6 +117,12 @@ export const createGithubActionsCIYml = (
     requiredSteps.push(UNIVERSAL_MACOS)
   }
 
+  if (!enableWasi) {
+    delete fullTemplate.jobs[TEST_WASI]
+  } else {
+    requiredSteps.push(TEST_WASI)
+  }
+
   fullTemplate.jobs.publish.needs = requiredSteps
 
   return dump(fullTemplate, {

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

@@ -1,8 +1,10 @@
-export function createJsBinding(localName: string, pkgName: string): string {
+export function createCjsBinding(
+  localName: string,
+  pkgName: string,
+  idents: string[],
+): string {
   return `// prettier-ignore
-/* tslint:disable */
 /* eslint-disable */
-
 /* auto-generated by NAPI-RS */
 
 const { existsSync, readFileSync } = require('fs')
@@ -14,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
   }
 }
 
@@ -57,7 +93,7 @@ switch (platform) {
         }
         break
       default:
-        throw new Error(\`Unsupported architecture on Android \${arch}\`)
+        loadError = new Error(\`Unsupported architecture on Android \${arch}\`)
     }
     break
   case 'win32':
@@ -105,7 +141,7 @@ switch (platform) {
         }
         break
       default:
-        throw new Error(\`Unsupported architecture on Windows: \${arch}\`)
+        loadError = new Error(\`Unsupported architecture on Windows: \${arch}\`)
     }
     break
   case 'darwin':
@@ -146,22 +182,37 @@ switch (platform) {
         }
         break
       default:
-        throw new Error(\`Unsupported architecture on macOS: \${arch}\`)
+        loadError = new Error(\`Unsupported architecture on macOS: \${arch}\`)
     }
     break
   case 'freebsd':
-    if (arch !== 'x64') {
-      throw new Error(\`Unsupported architecture on FreeBSD: \${arch}\`)
-    }
-    localFileExisted = existsSync(join(__dirname, '${localName}.freebsd-x64.node'))
-    try {
-      if (localFileExisted) {
-        nativeBinding = require('./${localName}.freebsd-x64.node')
-      } else {
-        nativeBinding = require('${pkgName}-freebsd-x64')
-      }
-    } catch (e) {
-      loadError = e
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, '${localName}.freebsd-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.freebsd-x64.node')
+          } else {
+            nativeBinding = require('${pkgName}-freebsd-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, '${localName}.freebsd-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.freebsd-arm64.node')
+          } else {
+            nativeBinding = require('${pkgName}-freebsd-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        loadError = new Error(\`Unsupported architecture on FreeBSD: \${arch}\`)
     }
     break
   case 'linux':
@@ -238,12 +289,74 @@ switch (platform) {
           loadError = e
         }
         break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, '${localName}.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./${localName}.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('${pkgName}-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, '${localName}.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./${localName}.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('${pkgName}-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
       default:
-        throw new Error(\`Unsupported architecture on Linux: \${arch}\`)
+        loadError = new Error(\`Unsupported architecture on Linux: \${arch}\`)
     }
     break
   default:
-    throw new Error(\`Unsupported OS: \${platform}, architecture: \${arch}\`)
+    loadError = new Error(\`Unsupported OS: \${platform}, architecture: \${arch}\`)
+}
+
+if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  try {
+    nativeBinding = require('./${localName}.wasi.cjs')
+  } catch (err) {
+    if (process.env.NAPI_RS_FORCE_WASI) {
+      console.error(err)
+    }
+  }
+  if (!nativeBinding) {
+    try {
+      nativeBinding = require('${pkgName}-wasm32-wasi')
+    } catch (err) {
+      if (process.env.NAPI_RS_FORCE_WASI) {
+        console.error(err)
+      }
+    }
+  }
 }
 
 if (!nativeBinding) {
@@ -253,5 +366,8 @@ if (!nativeBinding) {
   throw new Error(\`Failed to load native binding\`)
 }
 
+${idents
+  .map((ident) => `module.exports.${ident} = nativeBinding.${ident}`)
+  .join('\n')}
 `
 }

package/src/api/templates/lib.rs.ts

@@ -1,7 +1,4 @@
-export const createLibRs = () => `#![deny(clippy::all)]
-
-#[macro_use]
-extern crate napi_derive;
+export const createLibRs = () => `use napi_derive::napi;
 
 #[napi]
 pub fn sum(a: i32, b: i32) -> i32 {

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

@@ -0,0 +1,150 @@
+export const createWasiBrowserBinding = (
+  wasiFilename: string,
+  wasiRegisterFunctions: string[],
+) => `import {
+  instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync,
+  getDefaultContext as __emnapiGetDefaultContext,
+  WASI as __WASI,
+} from '@napi-rs/wasm-runtime'
+import { Volume as __Volume, createFsFromVolume as __createFsFromVolume } from '@napi-rs/wasm-runtime/fs'
+
+import __wasmUrl from './${wasiFilename}.wasm?url'
+
+const __fs = __createFsFromVolume(
+  __Volume.fromJSON({
+    '/': null,
+  }),
+)
+
+const __wasi = new __WASI({
+  version: 'preview1',
+  fs: __fs,
+})
+
+const __emnapiContext = __emnapiGetDefaultContext()
+
+const __sharedMemory = new WebAssembly.Memory({
+  initial: 1024,
+  maximum: 10240,
+  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() {
+    return new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {
+      type: 'module',
+    })
+  },
+  overwriteImports(importObject) {
+    importObject.env = {
+      ...importObject.env,
+      ...importObject.napi,
+      ...importObject.emnapi,
+      memory: __sharedMemory,
+    }
+    return importObject
+  },
+  beforeInit({ instance }) {
+    __napi_rs_initialize_modules(instance)
+  },
+})
+
+function __napi_rs_initialize_modules(__napiInstance) {
+${wasiRegisterFunctions
+  .map((name) => `  __napiInstance.exports['${name}']?.()`)
+  .join('\n')}
+}
+`
+
+export const createWasiBinding = (
+  wasmFileName: string,
+  packageName: string,
+  wasiRegisterFunctions: string[],
+) => `/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const __nodeFs= require('node:fs')
+const __nodePath = require('node:path')
+const { WASI: __nodeWASI } = require('node:wasi')
+const { Worker } = require('node:worker_threads')
+
+const {
+  instantiateNapiModuleSync: __emnapiInstantiateNapiModuleSync,
+  getDefaultContext: __emnapiGetDefaultContext,
+} = require('@napi-rs/wasm-runtime')
+
+const __wasi = new __nodeWASI({
+  version: 'preview1',
+  env: process.env,
+  preopens: {
+    '/': '/'
+  }
+})
+
+const __emnapiContext = __emnapiGetDefaultContext()
+
+const __sharedMemory = new WebAssembly.Memory({
+  initial: 1024,
+  maximum: 10240,
+  shared: true,
+})
+
+let __wasmFilePath = __nodePath.join(__dirname, '${wasmFileName}.wasm')
+
+if (!__nodeFs.existsSync(__wasmFilePath)) {
+  try {
+    __wasmFilePath = __nodePath.resolve('${packageName}-wasm32-wasi')
+  } catch {
+    throw new Error('Cannot find ${wasmFileName}.wasm file, and ${packageName}-wasm32-wasi package is not installed.')
+  }
+}
+
+const { instance: __napiInstance, module: __wasiModule, napiModule: __napiModule } = __emnapiInstantiateNapiModuleSync(__nodeFs.readFileSync(__wasmFilePath), {
+  context: __emnapiContext,
+  asyncWorkPoolSize: (function() {
+    const threadsSizeFromEnv = Number(process.env.NAPI_RS_ASYNC_WORK_POOL_SIZE ?? process.env.UV_THREADPOOL_SIZE)
+    // NaN > 0 is false
+    if (threadsSizeFromEnv > 0) {
+      return threadsSizeFromEnv
+    } else {
+      return 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,
+    }
+    return importObject
+  },
+  beforeInit({ instance }) {
+    __napi_rs_initialize_modules(instance)
+  }
+})
+
+function __napi_rs_initialize_modules(__napiInstance) {
+${wasiRegisterFunctions
+  .map((name) => `  __napiInstance.exports['${name}']?.()`)
+  .join('\n')}
+}
+`

package/src/api/templates/package.json.ts

@@ -1,10 +1,21 @@
-export const createPackageJson = ({
+import type {
+  CommonPackageJsonFields,
+  SupportedTestFramework,
+} from '../../utils/config.js'
+import { UNIVERSAL_TARGETS } from '../../utils/target.js'
+
+export interface PackageMeta {
+  'dist-tags': { [index: string]: string }
+}
+
+export const createPackageJson = async ({
   name,
   binaryName,
   targets,
   license,
   engineRequirement,
   cliVersion,
+  testFramework,
 }: {
   name: string
   binaryName: string
@@ -12,32 +23,68 @@ export const createPackageJson = ({
   license: string
   engineRequirement: string
   cliVersion: string
+  testFramework: SupportedTestFramework
 }) => {
-  return `{
-  "name": "${name}",
-  "version": "1.0.0",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "license": "${license}",
-  "engines": {
-    "node": "${engineRequirement}"
-  },
-  "napi": {
-    "binaryName": "${binaryName}",
-    "targets": [
-      ${targets.map((t) => `"${t}"`).join(',\n      ')}
-    ]
-  },
-  "scripts": {
-    "test": "node -e \\"assert(require('.').sum(1, 2) === 3)\\"",
-    "build": "napi build --release --platform --strip",
-    "build:debug": "napi build",
-    "prepublishOnly": "napi prepublish -t npm",
-    "artifacts": "napi artifacts",
-    "version": "napi version"
-  },
-  "devDependencies": {
-    "@napi-rs/cli": "^${cliVersion}"
+  const hasWasmTarget = targets.some((t) => t.includes('wasm'))
+  const universalTargets = targets.filter(
+    (t) => t in UNIVERSAL_TARGETS,
+  ) as (keyof typeof UNIVERSAL_TARGETS)[]
+  const unifiedtargets = universalTargets.length
+    ? targets.filter(
+        (target) =>
+          !universalTargets.some((t) => {
+            // @ts-expect-error
+            return UNIVERSAL_TARGETS[t].includes(target)
+          }),
+      )
+    : targets
+  const content: CommonPackageJsonFields = {
+    name,
+    version: '0.0.0',
+    license,
+    engines: {
+      node: engineRequirement,
+    },
+    type: 'commonjs',
+    main: 'index.js',
+    types: 'index.d.ts',
+    browser: 'browser.js',
+    module: undefined,
+    exports: undefined,
+    napi: {
+      binaryName,
+      targets: unifiedtargets,
+    },
+    scripts: {
+      test: testFramework,
+      build: 'napi build --release --platform --strip',
+      'build:debug': 'napi build',
+      prepublishOnly: 'napi prepublish -t npm',
+      artifacts: 'napi artifacts',
+      version: 'napi version',
+    },
+    devDependencies: {
+      '@napi-rs/cli': `^${cliVersion}`,
+    },
+  }
+
+  if (testFramework === 'ava') {
+    const avaMeta = await fetch(`https://registry.npmjs.org/ava`).then(
+      (res) => res.json() as Promise<PackageMeta>,
+    )
+    content.devDependencies!['ava'] = `^${avaMeta['dist-tags'].latest}`
+    content.ava = {
+      timeout: '1m',
+    }
+  }
+
+  if (hasWasmTarget) {
+    const wasmRuntime = await fetch(
+      `https://registry.npmjs.org/@napi-rs/wasm-runtime`,
+    ).then((res) => res.json() as Promise<PackageMeta>)
+    const latest = wasmRuntime['dist-tags'].latest
+    content.devDependencies!['@napi-rs/wasm-runtime'] = `^${latest}`
   }
-}`
+
+  return JSON.stringify(content, null, 2)
 }

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

@@ -0,0 +1,93 @@
+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, WASI } from "@napi-rs/wasm-runtime";
+
+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);
+};
+`
+
+export const WASI_WORKER_BROWSER_TEMPLATE = `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'
+import { Volume, createFsFromVolume } from '@napi-rs/wasm-runtime/fs'
+
+const fs = createFsFromVolume(
+  Volume.fromJSON({
+    '/': null,
+  }),
+)
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({
+      fs,
+      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)
+}
+`