@napi-rs/cli 3.0.0-alpha.10 → 3.0.0-alpha.100

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

@@ -0,0 +1,216 @@
+export const createWasiBrowserBinding = (
+  wasiFilename: string,
+  initialMemory = 4000,
+  maximumMemory = 65536,
+  fs = false,
+  asyncInit = false,
+  buffer = false,
+) => {
+  const fsImport = fs ? `import { memfs } from '@napi-rs/wasm-runtime/fs'` : ''
+  const bufferImport = buffer
+    ? fs
+      ? ``
+      : `import { Buffer } from 'buffer'`
+    : ''
+  const wasiCreation = fs
+    ? `
+export const { fs: __fs, vol: __volume } = memfs()
+
+const __wasi = new __WASI({
+  version: 'preview1',
+  fs: __fs,
+  preopens: {
+    '/': '/',
+  },
+})`
+    : `
+const __wasi = new __WASI({
+  version: 'preview1',
+})`
+
+  const workerFsHandler = fs
+    ? `    worker.addEventListener('message', __wasmCreateOnMessageForFsProxy(__fs))\n`
+    : ''
+
+  const emnapiInjectBuffer = buffer
+    ? '__emnapiContext.feature.Buffer = Buffer'
+    : ''
+  const emnapiInstantiateImport = asyncInit
+    ? `instantiateNapiModule as __emnapiInstantiateNapiModule`
+    : `instantiateNapiModuleSync as __emnapiInstantiateNapiModuleSync`
+  const emnapiInstantiateCall = asyncInit
+    ? `await __emnapiInstantiateNapiModule`
+    : `__emnapiInstantiateNapiModuleSync`
+
+  return `import {
+  createOnMessage as __wasmCreateOnMessageForFsProxy,
+  getDefaultContext as __emnapiGetDefaultContext,
+  ${emnapiInstantiateImport},
+  WASI as __WASI,
+} from '@napi-rs/wasm-runtime'
+${fsImport}
+${bufferImport}
+${wasiCreation}
+
+const __wasmUrl = new URL('./${wasiFilename}.wasm', import.meta.url).href
+const __emnapiContext = __emnapiGetDefaultContext()
+${emnapiInjectBuffer}
+
+const __sharedMemory = new WebAssembly.Memory({
+  initial: ${initialMemory},
+  maximum: ${maximumMemory},
+  shared: true,
+})
+
+const __wasmFile = await fetch(__wasmUrl).then((res) => res.arrayBuffer())
+
+const {
+  instance: __napiInstance,
+  module: __wasiModule,
+  napiModule: __napiModule,
+} = ${emnapiInstantiateCall}(__wasmFile, {
+  context: __emnapiContext,
+  asyncWorkPoolSize: 4,
+  wasi: __wasi,
+  onCreateWorker() {
+    const worker = new Worker(new URL('./wasi-worker-browser.mjs', import.meta.url), {
+      type: 'module',
+    })
+${workerFsHandler}
+    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]()
+      }
+    }
+  },
+})
+`
+}
+
+export const createWasiBinding = (
+  wasmFileName: string,
+  packageName: string,
+  initialMemory = 4000,
+  maximumMemory = 65536,
+) => `/* 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 {
+  createOnMessage: __wasmCreateOnMessageForFsProxy,
+  getDefaultContext: __emnapiGetDefaultContext,
+  instantiateNapiModuleSync: __emnapiInstantiateNapiModuleSync,
+} = require('@napi-rs/wasm-runtime')
+
+const __rootDir = __nodePath.parse(process.cwd()).root
+
+const __wasi = new __nodeWASI({
+  version: 'preview1',
+  env: process.env,
+  preopens: {
+    [__rootDir]: __rootDir,
+  }
+})
+
+const __emnapiContext = __emnapiGetDefaultContext()
+
+const __sharedMemory = new WebAssembly.Memory({
+  initial: ${initialMemory},
+  maximum: ${maximumMemory},
+  shared: true,
+})
+
+let __wasmFilePath = __nodePath.join(__dirname, '${wasmFileName}.wasm')
+const __wasmDebugFilePath = __nodePath.join(__dirname, '${wasmFileName}.debug.wasm')
+
+if (__nodeFs.existsSync(__wasmDebugFilePath)) {
+  __wasmFilePath = __wasmDebugFilePath
+} else 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
+    }
+  })(),
+  reuseWorker: true,
+  wasi: __wasi,
+  onCreateWorker() {
+    const worker = new Worker(__nodePath.join(__dirname, 'wasi-worker.mjs'), {
+      env: process.env,
+    })
+    worker.onmessage = ({ data }) => {
+      __wasmCreateOnMessageForFsProxy(__nodeFs)(data)
+    }
+
+    // The main thread of Node.js waits for all the active handles before exiting.
+    // But Rust threads are never waited without \`thread::join\`.
+    // So here we hack the code of Node.js to prevent the workers from being referenced (active).
+    // According to https://github.com/nodejs/node/blob/19e0d472728c79d418b74bddff588bea70a403d0/lib/internal/worker.js#L415,
+    // a worker is consist of two handles: kPublicPort and kHandle.
+    {
+      const kPublicPort = Object.getOwnPropertySymbols(worker).find(s =>
+        s.toString().includes("kPublicPort")
+      );
+      if (kPublicPort) {
+        worker[kPublicPort].ref = () => {};
+      }
+
+      const kHandle = Object.getOwnPropertySymbols(worker).find(s =>
+        s.toString().includes("kHandle")
+      );
+      if (kHandle) {
+        worker[kHandle].ref = () => {};
+      }
+
+      worker.unref();
+    }
+    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]()
+      }
+    }
+  },
+})
+`

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

@@ -0,0 +1,122 @@
+export const WASI_WORKER_TEMPLATE = `import fs from "node:fs";
+import { createRequire } from "node:module";
+import { parse } from "node:path";
+import { WASI } from "node:wasi";
+import { parentPort, Worker } from "node:worker_threads";
+
+const require = createRequire(import.meta.url);
+
+const { instantiateNapiModuleSync, MessageHandler, getDefaultContext } = require("@napi-rs/wasm-runtime");
+
+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 emnapiContext = getDefaultContext();
+
+const __rootDir = parse(process.cwd()).root;
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    const wasi = new WASI({
+      version: 'preview1',
+      env: process.env,
+      preopens: {
+        [__rootDir]: __rootDir,
+      },
+    });
+
+    return instantiateNapiModuleSync(wasmModule, {
+      childThread: true,
+      wasi,
+      context: emnapiContext,
+      overwriteImports(importObject) {
+        importObject.env = {
+          ...importObject.env,
+          ...importObject.napi,
+          ...importObject.emnapi,
+          memory: wasmMemory
+        };
+      },
+    });
+  },
+});
+
+globalThis.onmessage = function (e) {
+  handler.handle(e);
+};
+`
+
+export const createWasiBrowserWorkerBinding = (fs: boolean) => {
+  const fsImport = fs
+    ? `import { instantiateNapiModuleSync, MessageHandler, WASI, createFsProxy } from '@napi-rs/wasm-runtime'
+import { memfsExported as __memfsExported } from '@napi-rs/wasm-runtime/fs'
+
+const fs = createFsProxy(__memfsExported)`
+    : `import { instantiateNapiModuleSync, MessageHandler, WASI } from '@napi-rs/wasm-runtime'`
+  const wasiCreation = fs
+    ? `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)
+      },
+    })`
+    : `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 `${fsImport}
+
+const handler = new MessageHandler({
+  onLoad({ wasmModule, wasmMemory }) {
+    ${wasiCreation}
+    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/api/universalize.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
-import { join, resolve } from 'path'
+import { spawnSync } from 'node:child_process'
+import { join, resolve } from 'node:path'
 
 import {
   applyDefaultUniversalizeOptions,
@@ -27,7 +27,10 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
 
   const packageJsonPath = join(options.cwd, options.packageJsonPath)
 
-  const config = await readNapiConfig(packageJsonPath)
+  const config = await readNapiConfig(
+    packageJsonPath,
+    options.configPath ? resolve(options.cwd, options.configPath) : undefined,
+  )
 
   const target = config.targets.find(
     (t) => t.platform === process.platform && t.arch === 'universal',
@@ -39,8 +42,12 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
     )
   }
 
-  const srcFiles = UniArchsByPlatform[process.platform]?.map(
-    (arch) => `${config.binaryName}.${process.platform}-${arch}.node`,
+  const srcFiles = UniArchsByPlatform[process.platform]?.map((arch) =>
+    resolve(
+      options.cwd,
+      options.outputDir,
+      `${config.binaryName}.${process.platform}-${arch}.node`,
+    ),
   )
 
   if (!srcFiles || !universalizers[process.platform]) {
@@ -52,9 +59,7 @@ export async function universalizeBinaries(userOptions: UniversalizeOptions) {
   debug(`Looking up source binaries to combine: `)
   debug('  %O', srcFiles)
 
-  const srcFileLookup = await Promise.all(
-    srcFiles.map((f) => fileExists(resolve(options.cwd, options.outputDir, f))),
-  )
+  const srcFileLookup = await Promise.all(srcFiles.map((f) => fileExists(f)))
 
   const notFoundFiles = srcFiles.filter((_, i) => !srcFileLookup[i])
 

package/src/api/version.ts

@@ -1,4 +1,4 @@
-import { join, resolve } from 'path'
+import { join, resolve } from 'node:path'
 
 import { applyDefaultVersionOptions, VersionOptions } from '../def/version.js'
 import {
@@ -13,7 +13,10 @@ export async function version(userOptions: VersionOptions) {
   const options = applyDefaultVersionOptions(userOptions)
   const packageJsonPath = resolve(options.cwd, options.packageJsonPath)
 
-  const config = await readNapiConfig(packageJsonPath)
+  const config = await readNapiConfig(
+    packageJsonPath,
+    options.configPath ? resolve(options.cwd, options.configPath) : undefined,
+  )
 
   for (const target of config.targets) {
     const pkgDir = resolve(options.cwd, options.npmDir, target.platformArchABI)

package/src/commands/artifacts.ts

@@ -8,9 +8,9 @@ export class ArtifactsCommand extends BaseArtifactsCommand {
     description: 'Copy artifacts from Github Actions into specified dir',
     examples: [
       [
-        '$0 artifacts --dir . --dist ./npm',
+        '$0 artifacts --output-dir ./artifacts --dist ./npm',
         `Copy [binaryName].[platform].node under current dir(.) into packages under npm dir.
-e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.node`,
+e.g: index.linux-x64-gnu.node --> ./npm/linux-x64-gnu/index.linux-x64-gnu.node`,
       ],
     ],
   })

package/src/commands/build.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { Option } from 'clipanion'
 

package/src/commands/new.ts

@@ -1,7 +1,7 @@
-import path from 'path'
+import path from 'node:path'
 
+import { input, select, checkbox, confirm } from '@inquirer/prompts'
 import { Option } from 'clipanion'
-import inquirer from 'inquirer'
 
 import { newProject } from '../api/new.js'
 import { BaseNewCommand } from '../def/new.js'
@@ -16,7 +16,7 @@ import { napiEngineRequirement } from '../utils/version.js'
 const debug = debugFactory('new')
 
 export class NewCommand extends BaseNewCommand {
-  interactive = Option.Boolean('--interactive,-i', false, {
+  interactive = Option.Boolean('--interactive,-i', true, {
     description:
       'Ask project basic information interactively without just using the default.',
   })
@@ -37,9 +37,13 @@ export class NewCommand extends BaseNewCommand {
     const cmdOptions = super.getOptions()
 
     if (this.interactive) {
+      const targetPath: string = cmdOptions.path
+        ? cmdOptions.path
+        : await inquirerProjectPath()
+      cmdOptions.path = targetPath
       return {
         ...cmdOptions,
-        name: await this.fetchName(path.parse(cmdOptions.path).base),
+        name: await this.fetchName(path.parse(targetPath).base),
         minNodeApiVersion: await this.fetchNapiVersion(),
         targets: await this.fetchTargets(),
         license: await this.fetchLicense(),
@@ -54,43 +58,31 @@ export class NewCommand extends BaseNewCommand {
   private async fetchName(defaultName: string): Promise<string> {
     return (
       this.$$name ??
-      (await inquirer
-        .prompt({
-          type: 'input',
-          name: 'name',
-          message: 'Package name (the name field in your package.json file)',
-          default: defaultName,
-        })
-        .then(({ name }) => name))
+      input({
+        message: 'Package name (the name field in your package.json file)',
+        default: defaultName,
+      })
     )
   }
 
   private async fetchLicense(): Promise<string> {
-    return inquirer
-      .prompt({
-        type: 'input',
-        name: 'license',
-        message: 'License for open-sourced project',
-        default: this.license,
-      })
-      .then(({ license }) => license)
+    return input({
+      message: 'License for open-sourced project',
+      default: this.license,
+    })
   }
 
   private async fetchNapiVersion(): Promise<number> {
-    return inquirer
-      .prompt({
-        type: 'list',
-        name: 'minNodeApiVersion',
-        message: 'Minimum node-api version (with node version requirement)',
-        loop: false,
-        choices: new Array(8).fill(0).map((_, i) => ({
-          name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
-          value: i + 1,
-        })),
-        // choice index
-        default: this.minNodeApiVersion - 1,
-      })
-      .then(({ minNodeApiVersion }) => minNodeApiVersion)
+    return select({
+      message: 'Minimum node-api version (with node version requirement)',
+      loop: false,
+      choices: Array.from({ length: 8 }, (_, i) => ({
+        name: `napi${i + 1} (${napiEngineRequirement(i + 1)})`,
+        value: i + 1,
+      })),
+      // choice index
+      default: this.minNodeApiVersion - 1,
+    })
   }
 
   private async fetchTargets(): Promise<TargetTriple[]> {
@@ -98,22 +90,22 @@ export class NewCommand extends BaseNewCommand {
       return AVAILABLE_TARGETS.concat()
     }
 
-    const { targets } = await inquirer.prompt({
-      name: 'targets',
-      type: 'checkbox',
+    const targets = await checkbox({
       loop: false,
       message: 'Choose target(s) your crate will be compiled to',
-      default: this.enableDefaultTargets ? DEFAULT_TARGETS : [],
-      choices: AVAILABLE_TARGETS,
+      choices: AVAILABLE_TARGETS.map((target) => ({
+        name: target,
+        value: target,
+        // @ts-expect-error
+        checked: DEFAULT_TARGETS.includes(target),
+      })),
     })
 
     return targets
   }
 
   private async fetchTypeDef(): Promise<boolean> {
-    const { enableTypeDef } = await inquirer.prompt({
-      name: 'enableTypeDef',
-      type: 'confirm',
+    const enableTypeDef = await confirm({
       message: 'Enable type definition auto-generation',
       default: this.enableTypeDef,
     })
@@ -122,9 +114,7 @@ export class NewCommand extends BaseNewCommand {
   }
 
   private async fetchGithubActions(): Promise<boolean> {
-    const { enableGithubActions } = await inquirer.prompt({
-      name: 'enableGithubActions',
-      type: 'confirm',
+    const enableGithubActions = await confirm({
       message: 'Enable Github Actions CI',
       default: this.enableGithubActions,
     })
@@ -132,3 +122,14 @@ export class NewCommand extends BaseNewCommand {
     return enableGithubActions
   }
 }
+
+async function inquirerProjectPath(): Promise<string> {
+  return input({
+    message: 'Target path to create the project, relative to cwd.',
+  }).then((path) => {
+    if (!path) {
+      return inquirerProjectPath()
+    }
+    return path
+  })
+}

package/src/def/artifacts.ts

@@ -15,11 +15,15 @@ export abstract class BaseArtifactsCommand extends Command {
       'The working directory of where napi command will be executed in, all other paths options are relative to this path',
   })
 
+  configPath?: string = Option.String('--config-path,-c', {
+    description: 'Path to `napi` config json file',
+  })
+
   packageJsonPath = Option.String('--package-json-path', 'package.json', {
     description: 'Path to `package.json`',
   })
 
-  outputDir = Option.String('--output-dir,-o', './', {
+  outputDir = Option.String('--output-dir,-o,-d', './artifacts', {
     description:
       'Path to the folder where all built `.node` files put, same as `--output-dir` of build command',
   })
@@ -28,12 +32,19 @@ export abstract class BaseArtifactsCommand extends Command {
     description: 'Path to the folder where the npm packages put',
   })
 
+  buildOutputDir?: string = Option.String('--build-output-dir', {
+    description:
+      'Path to the build output dir, only needed when targets contains `wasm32-wasi-*`',
+  })
+
   getOptions() {
     return {
       cwd: this.cwd,
+      configPath: this.configPath,
       packageJsonPath: this.packageJsonPath,
       outputDir: this.outputDir,
       npmDir: this.npmDir,
+      buildOutputDir: this.buildOutputDir,
     }
   }
 }
@@ -48,6 +59,10 @@ export interface ArtifactsOptions {
    * @default process.cwd()
    */
   cwd?: string
+  /**
+   * Path to `napi` config json file
+   */
+  configPath?: string
   /**
    * Path to `package.json`
    *
@@ -57,7 +72,7 @@ export interface ArtifactsOptions {
   /**
    * Path to the folder where all built `.node` files put, same as `--output-dir` of build command
    *
-   * @default './'
+   * @default './artifacts'
    */
   outputDir?: string
   /**
@@ -66,13 +81,17 @@ export interface ArtifactsOptions {
    * @default 'npm'
    */
   npmDir?: string
+  /**
+   * Path to the build output dir, only needed when targets contains `wasm32-wasi-*`
+   */
+  buildOutputDir?: string
 }
 
 export function applyDefaultArtifactsOptions(options: ArtifactsOptions) {
   return {
     cwd: process.cwd(),
     packageJsonPath: 'package.json',
-    outputDir: './',
+    outputDir: './artifacts',
     npmDir: 'npm',
     ...options,
   }