@bytecodealliance/preview2-shim 0.0.12 → 0.0.14

package/lib/http/wasi-http.js

@@ -1,18 +1,19 @@
 // Based on:
-// https://github.com/bytecodealliance/wasmtime/blob/76eb40e0756d90cc9c16b26a8d8b1e0ebf75f44d/crates/wasi-http/src/http_impl.rs
+// https://github.com/bytecodealliance/wasmtime/blob/8efcb9851602287fd07a1a1e91501f51f2653d7e/crates/wasi-http/
 
 /**
- * @typedef {import("../../types/imports/types").Fields} Fields
- * @typedef {import("../../types/imports/types").FutureIncomingResponse} FutureIncomingResponse
- * @typedef {import("../../types/imports/types").Headers} Headers
- * @typedef {import("../../types/imports/types").IncomingResponse} IncomingResponse
- * @typedef {import("../../types/imports/types").IncomingStream} IncomingStream
- * @typedef {import("../../types/imports/types").Method} Method
- * @typedef {import("../../types/imports/types").OutgoingRequest} OutgoingRequest
- * @typedef {import("../../types/imports/types").RequestOptions} RequestOptions
- * @typedef {import("../../types/imports/types").Result} Result
- * @typedef {import("../../types/imports/types").Scheme} Scheme
- * @typedef {import("../../types/imports/types").StatusCode} StatusCode
+ * @typedef {import("../../types/imports/wasi-http-types").Fields} Fields
+ * @typedef {import("../../types/imports/wasi-http-types").FutureIncomingResponse} FutureIncomingResponse
+ * @typedef {import("../../types/imports/wasi-http-types").Headers} Headers
+ * @typedef {import("../../types/imports/wasi-http-types").IncomingResponse} IncomingResponse
+ * @typedef {import("../../types/imports/wasi-http-types").IncomingStream} IncomingStream
+ * @typedef {import("../../types/imports/wasi-http-types").Method} Method
+ * @typedef {import("../../types/imports/wasi-http-types").OutgoingRequest} OutgoingRequest
+ * @typedef {import("../../types/imports/wasi-http-types").RequestOptions} RequestOptions
+ * @typedef {import("../../types/imports/wasi-http-types").Result} Result
+ * @typedef {import("../../types/imports/wasi-http-types").Scheme} Scheme
+ * @typedef {import("../../types/imports/wasi-http-types").StatusCode} StatusCode
+ * @typedef {import("../../types/imports/wasi-io-streams").StreamStatus} StreamStatus
 */
 
 import * as io from '@bytecodealliance/preview2-shim/io';
@@ -48,12 +49,14 @@ export class WasiHttp {
 
     const scheme = request.scheme.tag === "HTTP" ? "http://" : "https://";
 
-    const url = scheme + request.authority + request.path + request.query;
+    const url = scheme + request.authority + request.pathWithQuery;
     const headers = {
       "host": request.authority,
     };
-    for (const [key, value] of request.headers.entries()) {
-      headers[key] = Array.isArray(value) ? value.join(",") : value;
+    if (request.headers && request.headers.size > 0) {
+      for (const [key, value] of request.headers.entries()) {
+        headers[key] = Array.isArray(value) ? value.join(",") : value;
+      }
     }
     const body =  this.streams.get(request.body);
 
@@ -66,8 +69,10 @@ export class WasiHttp {
     });
 
     response.status = res.status;
-    for (const [key, value] of res.headers) {
-      response.responseHeaders.set(key, [value]);
+    if (res.headers && res.headers.size > 0) {
+      for (const [key, value] of res.headers) {
+        response.responseHeaders.set(key, [value]);
+      }
     }
     const buf = res.body;
     response.body = this.streamIdBase;
@@ -82,25 +87,29 @@ export class WasiHttp {
     return futureId;
   }
 
+  read = (stream, len) => {
+    return this.blockingRead(stream, len);
+  }
+
   /**
    * @param {InputStream} stream 
    * @param {bigint} len 
-   * @returns {[Uint8Array | ArrayBuffer, boolean]}
+   * @returns {[Uint8Array | ArrayBuffer, StreamStatus]}
    */
-  read = (stream, len) => {
+  blockingRead = (stream, len) => {
     if (stream < 3) {
-      return io.read(stream);
+      return io.streams.blockingRead(stream);
     }
     const s = this.streams.get(stream);
     if (!s) throw Error(`stream not found: ${stream}`);
     const position = Number(len);
     if (position === 0) {
-      return [new Uint8Array(), s.byteLength > 0];
+      return [new Uint8Array(), s.byteLength > 0 ? 'open' : 'ended'];
     } else if (s.byteLength > position) {
       this.streams.set(stream, s.slice(position, s.byteLength));
-      return [s.slice(0, position), false];
+      return [s.slice(0, position), 'open'];
     } else {
-      return [s.slice(0, position), true];
+      return [s.slice(0, position), 'ended'];
     }
   }
 
@@ -108,8 +117,9 @@ export class WasiHttp {
    * @param {InputStream} stream 
    * @returns {Pollable}
    */
-  subscribeToInputStream = (_stream) => {
-    throw Error("unimplemented: subscribeToInputStream");
+  subscribeToInputStream = (stream) => {
+    // TODO: not implemented yet
+    console.log(`[streams] Subscribe to input stream ${stream}`);
   }
 
   /**
@@ -121,25 +131,30 @@ export class WasiHttp {
     s.set([]);
   }
 
+  write = (stream, buf) => {
+    return this.blockingWrite(stream, buf);
+  }
+
   /**
    * @param {OutputStream} stream 
    * @param {Uint8Array} buf 
-   * @returns {bigint}
+   * @returns {[bigint, StreamStatus]}
    */
-  write = (stream, buf) => {
+  blockingWrite = (stream, buf) => {
     if (stream < 3) {
-      return io.write(stream, buf);
+      return io.streams.blockingWrite(stream, buf);
     }
     this.streams.set(stream, buf);
-    return BigInt(buf.byteLength);
+    return [BigInt(buf.byteLength), 'ended'];
   }
 
   /**
    * @param {OutputStream} stream 
    * @returns {Pollable}
    */
-  subscribeToOutputStream = (_stream) => {
-    throw Error("unimplemented: subscribeToOutputStream");
+  subscribeToOutputStream = (stream) => {
+    // TODO: not implemented yet
+    console.log(`[streams] Subscribe to output stream ${stream}`);
   }
 
   /**
@@ -189,20 +204,18 @@ export class WasiHttp {
 
   /**
    * @param {Method} method
-   * @param {string} path
-   * @param {string} query
+   * @param {string | null} pathWithQuery
    * @param {Scheme | null} scheme
-   * @param {string} authority
+   * @param {string | null} authority
    * @param {Headers} headers
    * @returns {number}
    */
-  newOutgoingRequest = (method, path, query, scheme, authority, headers) => {
+  newOutgoingRequest = (method, pathWithQuery, scheme, authority, headers) => {
     const id = this.requestIdBase;
     this.requestIdBase += 1;
 
     const req = new ActiveRequest(id);
-    req.path = path;
-    req.query = query;
+    req.pathWithQuery = pathWithQuery;
     req.authority = authority;
     req.method = method;
     req.headers = this.fields.get(headers);
@@ -301,9 +314,8 @@ class ActiveRequest {
   activeRequest = false;
   /** @type {Method} */ method = { tag: 'get' };
   /** @type {Scheme | null} */ scheme = { tag: 'HTTP' };
-  path = "";
-  query = "";
-  authority = "";
+  pathWithQuery = null;
+  authority = null;
   /** @type {Map<string,string[]>} */ headers = new Map();
   body = 3;
 

package/lib/nodejs/cli.js

@@ -0,0 +1,75 @@
+let _env, _args = [], _cwd = null;
+export function _setEnv (envObj) {
+  _env = Object.entries(envObj);
+}
+
+export function _setArgs (args) {
+  _args = args;
+}
+
+export function _setCwd (cwd) {
+  _cwd = cwd;
+}
+
+export const environment = {
+  getEnvironment () {
+    if (!_env) _setEnv(process.env);
+    return _env;
+  },
+  getArguments () {
+    return _args;
+  },
+  initialCwd () {
+    return _cwd;
+  }
+};
+
+export const exit = {
+  exit (status) {
+    process.exit(status.tag === 'err' ? 1 : 0);
+  }
+};
+
+export const stdin = {
+  getStdin () {
+    return 0;
+  }
+};
+
+export const stdout = {
+  getStdout () {
+    return 1;
+  }
+};
+
+export const stderr = {
+  getStderr () {
+    return 2;
+  }
+};
+
+export const terminalInput = {
+  dropTerminalInput () {}
+};
+
+export const terminalOutput = {
+  dropTerminalOutput () {}
+};
+
+export const terminalStderr = {
+  getTerminalStderr () {
+    return 0;
+  }
+};
+
+export const terminalStdin = {
+  getTerminalStdin () {
+    return 1;
+  }
+};
+
+export const terminalStdout = {
+  getTerminalStdout () {
+    return 2;
+  }
+};

package/lib/nodejs/filesystem.js

@@ -1,7 +1,70 @@
 import { openSync, constants, statSync, lstatSync, fstatSync, closeSync, readdirSync } from 'node:fs';
-import { _descriptors, _addOpenedDescriptor, _removeOpenedDescriptor, _getDescriptorType, _setSubdescriptorType, _setDescriptorType, _getFullPath } from './cli-base.js';
 import { _createFsStream, _dropFsStream, _getFsStreamContext } from './io.js';
 
+// default is full permissions
+let preopenCnt = 4;
+export let _descriptors = {
+  3: { type: 'directory', path: '/', parent: null, subpathTypes: {} }
+};
+let directories = [[3, '/']];
+
+export function _setPreopens (preopens) {
+  _descriptors = {};
+  directories = [,,];
+  for (const [virtualPath, path] of Object.entries(preopens)) {
+    _descriptors[preopenCnt] = { type: 'directory', path, parent: null, subpathTypes: {} };
+    directories.push([preopenCnt++, virtualPath]);
+  }
+}
+
+export function _getFullPath (fd) {
+  let path = '';
+  while (fd) {
+    path = _descriptors[fd].path + path;
+    fd = _descriptors[fd].parent;
+  }
+  return path;
+}
+
+export function _getDescriptorType (fd) {
+  return _descriptors[fd].type;
+}
+
+export function _setDescriptorType (fd, type) {
+  _descriptors[fd].type = type;
+}
+
+export function _setSubdescriptorType (fd, path, type) {
+  while (_descriptors[fd].parent) {
+    path = _descriptors[fd].path + path;
+    fd = _descriptors[fd].parent;
+  }
+  _descriptors[fd].subpathTypes[path] = type;
+}
+
+export function _addOpenedDescriptor (fd, path, parentFd) {
+  if (fd < preopenCnt || _descriptors[fd])
+    throw 'bad-descriptor';
+  let type = null;
+  for (const [_path, _type] of Object.entries(_descriptors[parentFd].subpathTypes)) {
+    if (_path === path)
+      type = _type;
+  }
+  _descriptors[fd] = { path, type, parent: parentFd, subpathTypes: {} };
+}
+
+export function _removeOpenedDescriptor (fd) {
+  if (fd < preopenCnt)
+    throw 'eperm';
+  delete _descriptors[fd];
+}
+
+export const preopens = {
+  getDirectories () {
+    return directories;
+  }
+}
+
 const nsMagnitude = 1_000_000_000_000n;
 function nsToDateTime (ns) {
   const seconds = ns / nsMagnitude;
@@ -71,7 +134,7 @@ function _lookupType (obj) {
   return 'unknown';
 }
 
-export const filesystem = {
+export const types = {
   readViaStream(fd, offset) {
     if (Number(offset) !== 0)
       throw new Error('Read streams with non-zero offset not currently supported');
@@ -102,7 +165,7 @@ export const filesystem = {
   getType(fd) {
     let type = _getDescriptorType(fd);
     if (type === null) {
-      filesystem.stat(fd);
+      types.stat(fd);
       type = _getDescriptorType(fd);
     }
     return type;
@@ -307,5 +370,32 @@ export const filesystem = {
 
   dropDirectoryEntryStream(stream) {
     _dropFsStream(stream);
+  },
+
+  metadataHash(fd) {
+    let stats;
+    try {
+      stats = fstatSync(fd, { bigint: true });
+    }
+    catch (e) {
+      _convertFsError(e);
+    }
+    const type = _lookupType(stats);
+    _setDescriptorType(fd, type);
+    return { upper: BigInt(stats.size), lower: stats.mtimeNs };
+  },
+
+  metadataHashAt(fd, { symlinkFollow }, path) {
+    const fullPath = _descriptors[fd].path + path;
+    let stats;
+    try {
+      stats = (symlinkFollow ? statSync : lstatSync)(fullPath, { bigint: true });
+    }
+    catch (e) {
+      _convertFsError(e);
+    }
+    const type = _lookupType(stats);
+    _setSubdescriptorType(fd, path, type);
+    return { upper: BigInt(stats.size), lower: stats.mtimeNs };
   }
 };

package/lib/nodejs/http.js

@@ -15,7 +15,7 @@ export function send(req) {
       body: response.body ? Buffer.from(response.body, "base64") : undefined,
     };
   }
-  throw new UnexpectedError(response);
+  throw new UnexpectedError(response.message);
 }
 
 export const incomingHandler = {
@@ -70,11 +70,8 @@ export const types = {
   incomingRequestMethod(_req) {
     console.log("[types] Incoming request method");
   },
-  incomingRequestPath(_req) {
-    console.log("[types] Incoming request path");
-  },
-  incomingRequestQuery(_req) {
-    console.log("[types] Incoming request query");
+  incomingRequestPathWithQuery(_req) {
+    console.log("[types] Incoming request path with query");
   },
   incomingRequestScheme(_req) {
     console.log("[types] Incoming request scheme");
@@ -88,7 +85,7 @@ export const types = {
   incomingRequestConsume(_req) {
     console.log("[types] Incoming request consume");
   },
-  newOutgoingRequest(_method, _path, _query, _scheme, _authority, _headers) {
+  newOutgoingRequest(_method, _pathWithQuery, _scheme, _authority, _headers) {
     console.log("[types] New outgoing request");
   },
   outgoingRequestWrite(_req) {

package/lib/nodejs/index.js

@@ -6,7 +6,7 @@ import * as logging from "./logging.js";
 import * as poll from "./poll.js";
 import * as random from "./random.js";
 import * as sockets from "./sockets.js";
-import * as cliBase from "./cli-base.js";
+import * as cli from "./cli.js";
 
 export const importObject = {
   clocks,
@@ -17,7 +17,7 @@ export const importObject = {
   poll,
   random,
   sockets,
-  cliBase,
+  cli,
 };
 
 export { WasiHttp } from "../http/wasi-http.js";

package/lib/nodejs/logging.js

@@ -1,8 +1,8 @@
-const levels = ["trace", "debug", "info", "warn", "error"];
+const levels = ["trace", "debug", "info", "warn", "error", "critical"];
 
 let logLevel = levels.indexOf("warn");
 
-export const handler = {
+export const logging = {
   log(level, context, msg) {
     if (logLevel > levels.indexOf(level)) return;
     process.stdout.write(`${level}: (${context}) ${msg}\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytecodealliance/preview2-shim",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "WASI Preview2 shim for JS environments",
   "author": "Guy Bedford, Eduardo Rodrigues<16357187+eduardomourar@users.noreply.github.com>",
   "type": "module",

package/types/{imports/environment.d.ts → exports/wasi-cli-environment.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsEnvironment {
+export namespace WasiCliEnvironment {
   /**
    * Get the POSIX-style environment variables.
    * 
@@ -14,4 +14,9 @@ export namespace ImportsEnvironment {
    * Get the POSIX-style arguments to the program.
    */
   export function getArguments(): string[];
+  /**
+   * Return a path that programs should use as their initial current working
+   * directory, interpreting `.` as shorthand for this.
+   */
+  export function initialCwd(): string | null;
 }

package/types/{imports/exit.d.ts → exports/wasi-cli-exit.d.ts}

@@ -1,6 +1,6 @@
-export namespace ImportsExit {
+export namespace WasiCliExit {
   /**
-   * Exit the curerent instance and any linked instances.
+   * Exit the current instance and any linked instances.
    */
   export function exit(status: Result<void, void>): void;
 }

package/types/exports/wasi-cli-run.d.ts

@@ -0,0 +1,6 @@
+export namespace WasiCliRun {
+  /**
+   * Run the program.
+   */
+  export function run(): void;
+}

package/types/exports/wasi-cli-stderr.d.ts

@@ -0,0 +1,5 @@
+export namespace WasiCliStderr {
+  export function getStderr(): OutputStream;
+}
+import type { OutputStream } from '../exports/wasi-io-streams';
+export { OutputStream };

package/types/exports/wasi-cli-stdin.d.ts

@@ -0,0 +1,5 @@
+export namespace WasiCliStdin {
+  export function getStdin(): InputStream;
+}
+import type { InputStream } from '../exports/wasi-io-streams';
+export { InputStream };

package/types/exports/wasi-cli-stdout.d.ts

@@ -0,0 +1,5 @@
+export namespace WasiCliStdout {
+  export function getStdout(): OutputStream;
+}
+import type { OutputStream } from '../exports/wasi-io-streams';
+export { OutputStream };

package/types/exports/wasi-cli-terminal-input.d.ts

@@ -0,0 +1,13 @@
+export namespace WasiCliTerminalInput {
+  /**
+   * Dispose of the specified terminal-input after which it may no longer
+   * be used.
+   */
+  export function dropTerminalInput(this_: TerminalInput): void;
+}
+/**
+ * The input side of a terminal.
+ * 
+ * This [represents a resource](https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources).
+ */
+export type TerminalInput = number;

package/types/exports/wasi-cli-terminal-output.d.ts

@@ -0,0 +1,13 @@
+export namespace WasiCliTerminalOutput {
+  /**
+   * Dispose of the specified terminal-output, after which it may no longer
+   * be used.
+   */
+  export function dropTerminalOutput(this_: TerminalOutput): void;
+}
+/**
+ * The output side of a terminal.
+ * 
+ * This [represents a resource](https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources).
+ */
+export type TerminalOutput = number;

package/types/exports/wasi-cli-terminal-stderr.d.ts

@@ -0,0 +1,9 @@
+export namespace WasiCliTerminalStderr {
+  /**
+   * If stderr is connected to a terminal, return a `terminal-output` handle
+   * allowing further interaction with it.
+   */
+  export function getTerminalStderr(): TerminalOutput | null;
+}
+import type { TerminalOutput } from '../exports/wasi-cli-terminal-output';
+export { TerminalOutput };

package/types/exports/wasi-cli-terminal-stdin.d.ts

@@ -0,0 +1,9 @@
+export namespace WasiCliTerminalStdin {
+  /**
+   * If stdin is connected to a terminal, return a `terminal-input` handle
+   * allowing further interaction with it.
+   */
+  export function getTerminalStdin(): TerminalInput | null;
+}
+import type { TerminalInput } from '../exports/wasi-cli-terminal-input';
+export { TerminalInput };

package/types/exports/wasi-cli-terminal-stdout.d.ts

@@ -0,0 +1,9 @@
+export namespace WasiCliTerminalStdout {
+  /**
+   * If stdout is connected to a terminal, return a `terminal-output` handle
+   * allowing further interaction with it.
+   */
+  export function getTerminalStdout(): TerminalOutput | null;
+}
+import type { TerminalOutput } from '../exports/wasi-cli-terminal-output';
+export { TerminalOutput };

package/types/{imports/monotonic-clock.d.ts → exports/wasi-clocks-monotonic-clock.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsMonotonicClock {
+export namespace WasiClocksMonotonicClock {
   /**
    * Read the current value of the clock.
    * 
@@ -16,7 +16,7 @@ export namespace ImportsMonotonicClock {
    */
   export function subscribe(when: Instant, absolute: boolean): Pollable;
 }
-import type { Pollable } from '../imports/poll';
+import type { Pollable } from '../exports/wasi-poll-poll';
 export { Pollable };
 /**
  * A timestamp in nanoseconds.

package/types/{imports/timezone.d.ts → exports/wasi-clocks-timezone.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsTimezone {
+export namespace WasiClocksTimezone {
   /**
    * Return information needed to display the given `datetime`. This includes
    * the UTC offset, the time zone name, and a flag indicating whether
@@ -8,19 +8,29 @@ export namespace ImportsTimezone {
    * `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
    * saving time.
    */
-  export function display(this: Timezone, when: Datetime): TimezoneDisplay;
+  export function display(this_: Timezone, when: Datetime): TimezoneDisplay;
   /**
    * The same as `display`, but only return the UTC offset.
    */
-  export function utcOffset(this: Timezone, when: Datetime): number;
+  export function utcOffset(this_: Timezone, when: Datetime): number;
   /**
    * Dispose of the specified input-stream, after which it may no longer
    * be used.
    */
-  export function dropTimezone(this: Timezone): void;
+  export function dropTimezone(this_: Timezone): void;
 }
-import type { Datetime } from '../imports/wall-clock';
+import type { Datetime } from '../exports/wasi-clocks-wall-clock';
 export { Datetime };
+/**
+ * A timezone.
+ * 
+ * In timezones that recognize daylight saving time, also known as daylight
+ * time and summer time, the information returned from the functions varies
+ * over time to reflect these adjustments.
+ * 
+ * This [represents a resource](https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources).
+ */
+export type Timezone = number;
 /**
  * Information useful for displaying the timezone of a specific `datetime`.
  * 
@@ -59,13 +69,3 @@ export interface TimezoneDisplay {
    */
   inDaylightSavingTime: boolean,
 }
-/**
- * A timezone.
- * 
- * In timezones that recognize daylight saving time, also known as daylight
- * time and summer time, the information returned from the functions varies
- * over time to reflect these adjustments.
- * 
- * This [represents a resource](https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources).
- */
-export type Timezone = number;

package/types/{imports/wall-clock.d.ts → exports/wasi-clocks-wall-clock.d.ts}

@@ -1,4 +1,4 @@
-export namespace ImportsWallClock {
+export namespace WasiClocksWallClock {
   /**
    * Read the current value of the clock.
    * 

package/types/exports/wasi-filesystem-preopens.d.ts

@@ -0,0 +1,8 @@
+export namespace WasiFilesystemPreopens {
+  /**
+   * Return the set of preopened directories, and their path.
+   */
+  export function getDirectories(): [Descriptor, string][];
+}
+import type { Descriptor } from '../exports/wasi-filesystem-types';
+export { Descriptor };