@bytecodealliance/preview2-shim 0.16.7 → 0.17.1

package/lib/browser/cli.js

@@ -4,7 +4,7 @@ const { InputStream, OutputStream } = streams;
 
 const symbolDispose = Symbol.dispose ?? Symbol.for('dispose');
 
-let _env = [], _args = [], _cwd = null;
+let _env = [], _args = [], _cwd = "/";
 export function _setEnv (envObj) {
   _env = Object.entries(envObj);
 }
@@ -29,16 +29,19 @@ export const environment = {
 };
 
 class ComponentExit extends Error {
-  constructor(ok) {
-    super(`Component exited ${ok ? 'successfully' : 'with error'}`);
+  constructor(code) {
+    super(`Component exited ${code === 0 ? 'successfully' : 'with error'}`);
     this.exitError = true;
-    this.ok = ok;
+    this.code = code;
   }
 }
 
 export const exit = {
   exit (status) {
-    throw new ComponentExit(status.tag === 'err' ? true : false);
+    throw new ComponentExit(status.tag === 'err' ? 1 : 0);
+  },
+  exitWithCode (code) {
+    throw new ComponentExit(code);
   }
 };
 
@@ -75,6 +78,10 @@ const stdinStream = new InputStream({
 let textDecoder = new TextDecoder();
 const stdoutStream = new OutputStream({
   write (contents) {
+    if (contents[contents.length - 1] == 10) {
+      // console.log already appends a new line
+      contents = contents.subarray(0, contents.length - 1);
+    }
     console.log(textDecoder.decode(contents));
   },
   blockingFlush () {
@@ -84,10 +91,13 @@ const stdoutStream = new OutputStream({
 });
 const stderrStream = new OutputStream({
   write (contents) {
+    if (contents[contents.length - 1] == 10) {
+      // console.error already appends a new line
+      contents = contents.subarray(0, contents.length - 1);
+    }
     console.error(textDecoder.decode(contents));
   },
   blockingFlush () {
-
   },
   [symbolDispose] () {
 

package/lib/browser/filesystem.js

@@ -3,7 +3,7 @@ import { environment } from './cli.js';
 
 const { InputStream, OutputStream } = streams;
 
-let _cwd = null;
+let _cwd = "/";
 
 export function _setCwd (cwd) {
   _cwd = cwd;

package/lib/io/worker-socket-tcp.js

@@ -31,7 +31,7 @@ import {
 } from "./worker-sockets.js";
 import { Socket, Server } from "node:net";
 
-const winOrMac = process.platform === 'win32' || process.platform === 'darwin';
+const win = process.platform === 'win32';
 
 /**
  * @typedef {import("../../types/interfaces/wasi-sockets-network.js").IpSocketAddress} IpSocketAddress
@@ -265,16 +265,13 @@ export function socketTcpGetRemoteAddress(id) {
   return ipSocketAddress(out.family.toLowerCase(), out.address, out.port);
 }
 
-export function socketTcpShutdown(id, shutdownType) {
+export function socketTcpShutdown(id, _shutdownType) {
   const socket = tcpSockets.get(id);
   if (socket.state !== SOCKET_STATE_CONNECTION) throw "invalid-state";
-  // Node.js only supports a write shutdown, which is triggered on end
-  if (shutdownType === "send" || shutdownType === "both") {
-    if (winOrMac && socket.tcpSocket.destroySoon)
-      socket.tcpSocket.destroySoon();
-    else
-      socket.tcpSocket.destroy();
-  }
+  if (win && socket.tcpSocket.destroySoon)
+    socket.tcpSocket.destroySoon();
+  else
+    socket.tcpSocket.destroy();
 }
 
 export function socketTcpSetKeepAlive(id, { keepAlive, keepAliveIdleTime }) {

package/lib/io/worker-thread.js

@@ -393,8 +393,9 @@ function handle(call, id, payload) {
       return;
     }
     case HTTP_OUTGOING_BODY_DISPOSE:
-      if (!streams.delete(id))
-        throw new Error("wasi-io trap: stream not found to dispose");
+      if (debug && !streams.has(id))
+        console.warn(`wasi-io: stream ${id} not found to dispose`);
+      streams.delete(id);  
       return;
     case HTTP_SERVER_START:
       return startHttpServer(id, payload);

package/lib/nodejs/cli.js

@@ -47,6 +47,9 @@ export const exit = {
   exit(status) {
     process.exit(status.tag === "err" ? 1 : 0);
   },
+  exitWithCode(code) {
+    process.exit(code);
+  }
 };
 
 // Stdin is created as a FILE descriptor

package/lib/nodejs/filesystem.js

@@ -368,19 +368,16 @@ class Descriptor {
       }
     }
     try {
-      const fd = openSync(fullPath, fsOpenFlags);
+      const fd = openSync(fullPath.endsWith('/') ? fullPath.slice(0, -1) : fullPath, fsOpenFlags);
       const descriptor = descriptorCreate(
         fd,
         descriptorFlags,
         fullPath,
         preopenEntries
       );
-      if (fullPath.endsWith("/") && isWindows) {
-        // check if its a directory
-        if (descriptor.getType() !== "directory") {
-          descriptor[symbolDispose]();
-          throw "not-directory";
-        }
+      if (fullPath.endsWith('/') && descriptor.getType() !== 'directory') {
+        descriptor[symbolDispose]();
+        throw "not-directory";
       }
       return descriptor;
     } catch (e) {
@@ -671,6 +668,7 @@ function convertFsError(e) {
     case "ENOSPC":
       return "insufficient-space";
     case "ENOTDIR":
+    case 'ERR_FS_EISDIR':
       return "not-directory";
     case "ENOTEMPTY":
       return "not-empty";

package/package.json

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

package/types/interfaces/wasi-clocks-monotonic-clock.d.ts

@@ -13,13 +13,12 @@ export namespace WasiClocksMonotonicClock {
   export function resolution(): Duration;
   /**
    * Create a `pollable` which will resolve once the specified instant
-   * occured.
+   * has occurred.
    */
   export function subscribeInstant(when: Instant): Pollable;
   /**
-   * Create a `pollable` which will resolve once the given duration has
-   * elapsed, starting at the time at which this function was called.
-   * occured.
+   * Create a `pollable` that will resolve after the specified duration has
+   * elapsed from the time this function is invoked.
    */
   export function subscribeDuration(when: Duration): Pollable;
 }

package/types/interfaces/wasi-filesystem-types.d.ts

@@ -95,7 +95,7 @@ export interface DescriptorFlags {
    */
   dataIntegritySync?: boolean,
   /**
-   * Requests that reads be performed at the same level of integrety
+   * Requests that reads be performed at the same level of integrity
    * requested for writes. This is similar to `O_RSYNC` in POSIX.
    * 
    * The precise semantics of this operation have not yet been defined for
@@ -569,12 +569,6 @@ export class Descriptor {
   /**
   * Open a file or directory.
   * 
-  * The returned descriptor is not guaranteed to be the lowest-numbered
-  * descriptor not currently open/ it is randomized to prevent applications
-  * from depending on making assumptions about indexes, since this is
-  * error-prone in multi-threaded contexts. The returned descriptor is
-  * guaranteed to be less than 2**31.
-  * 
   * If `flags` contains `descriptor-flags::mutate-directory`, and the base
   * descriptor doesn't have `descriptor-flags::mutate-directory` set,
   * `open-at` fails with `error-code::read-only`.

package/types/interfaces/wasi-http-types.d.ts

@@ -255,7 +255,7 @@ export interface ErrorCodeInternalError {
  */
 export type HeaderError = HeaderErrorInvalidSyntax | HeaderErrorForbidden | HeaderErrorImmutable;
 /**
- * This error indicates that a `field-key` or `field-value` was
+ * This error indicates that a `field-name` or `field-value` was
  * syntactically invalid when used with an operation that sets headers in a
  * `fields`.
  */
@@ -263,7 +263,7 @@ export interface HeaderErrorInvalidSyntax {
   tag: 'invalid-syntax',
 }
 /**
- * This error indicates that a forbidden `field-key` was used when trying
+ * This error indicates that a forbidden `field-name` was used when trying
  * to set a header in a `fields`.
  */
 export interface HeaderErrorForbidden {
@@ -278,8 +278,22 @@ export interface HeaderErrorImmutable {
 }
 /**
  * Field keys are always strings.
+ * 
+ * Field keys should always be treated as case insensitive by the `fields`
+ * resource for the purposes of equality checking.
+ * 
+ * # Deprecation
+ * 
+ * This type has been deprecated in favor of the `field-name` type.
  */
 export type FieldKey = string;
+/**
+ * Field names are always strings.
+ * 
+ * Field names should always be treated as case insensitive by the `fields`
+ * resource for the purposes of equality checking.
+ */
+export type FieldName = FieldKey;
 /**
  * Field values should always be ASCII strings. However, in
  * reality, HTTP implementations often have to interpret malformed values,
@@ -312,63 +326,73 @@ export class Fields {
   * 
   * The resulting `fields` is mutable.
   * 
-  * The list represents each key-value pair in the Fields. Keys
+  * The list represents each name-value pair in the Fields. Names
   * which have multiple values are represented by multiple entries in this
-  * list with the same key.
+  * list with the same name.
   * 
-  * The tuple is a pair of the field key, represented as a string, and
-  * Value, represented as a list of bytes. In a valid Fields, all keys
-  * and values are valid UTF-8 strings. However, values are not always
-  * well-formed, so they are represented as a raw list of bytes.
+  * The tuple is a pair of the field name, represented as a string, and
+  * Value, represented as a list of bytes.
   * 
-  * An error result will be returned if any header or value was
-  * syntactically invalid, or if a header was forbidden.
+  * An error result will be returned if any `field-name` or `field-value` is
+  * syntactically invalid, or if a field is forbidden.
   */
-  static fromList(entries: Array<[FieldKey, FieldValue]>): Fields;
+  static fromList(entries: Array<[FieldName, FieldValue]>): Fields;
   /**
-  * Get all of the values corresponding to a key. If the key is not present
-  * in this `fields`, an empty list is returned. However, if the key is
-  * present but empty, this is represented by a list with one or more
-  * empty field-values present.
+  * Get all of the values corresponding to a name. If the name is not present
+  * in this `fields` or is syntactically invalid, an empty list is returned.
+  * However, if the name is present but empty, this is represented by a list
+  * with one or more empty field-values present.
   */
-  get(name: FieldKey): Array<FieldValue>;
+  get(name: FieldName): Array<FieldValue>;
   /**
-  * Returns `true` when the key is present in this `fields`. If the key is
+  * Returns `true` when the name is present in this `fields`. If the name is
   * syntactically invalid, `false` is returned.
   */
-  has(name: FieldKey): boolean;
+  has(name: FieldName): boolean;
   /**
-  * Set all of the values for a key. Clears any existing values for that
-  * key, if they have been set.
+  * Set all of the values for a name. Clears any existing values for that
+  * name, if they have been set.
   * 
   * Fails with `header-error.immutable` if the `fields` are immutable.
+  * 
+  * Fails with `header-error.invalid-syntax` if the `field-name` or any of
+  * the `field-value`s are syntactically invalid.
   */
-  set(name: FieldKey, value: Array<FieldValue>): void;
+  set(name: FieldName, value: Array<FieldValue>): void;
   /**
-  * Delete all values for a key. Does nothing if no values for the key
+  * Delete all values for a name. Does nothing if no values for the name
   * exist.
   * 
   * Fails with `header-error.immutable` if the `fields` are immutable.
+  * 
+  * Fails with `header-error.invalid-syntax` if the `field-name` is
+  * syntactically invalid.
   */
-  'delete'(name: FieldKey): void;
+  'delete'(name: FieldName): void;
   /**
-  * Append a value for a key. Does not change or delete any existing
-  * values for that key.
+  * Append a value for a name. Does not change or delete any existing
+  * values for that name.
   * 
   * Fails with `header-error.immutable` if the `fields` are immutable.
+  * 
+  * Fails with `header-error.invalid-syntax` if the `field-name` or
+  * `field-value` are syntactically invalid.
   */
-  append(name: FieldKey, value: FieldValue): void;
+  append(name: FieldName, value: FieldValue): void;
   /**
-  * Retrieve the full set of keys and values in the Fields. Like the
-  * constructor, the list represents each key-value pair.
+  * Retrieve the full set of names and values in the Fields. Like the
+  * constructor, the list represents each name-value pair.
   * 
-  * The outer list represents each key-value pair in the Fields. Keys
+  * The outer list represents each name-value pair in the Fields. Names
   * which have multiple values are represented by multiple entries in this
-  * list with the same key.
+  * list with the same name.
+  * 
+  * The names and values are always returned in the original casing and in
+  * the order in which they will be serialized for transport.
   */
-  entries(): Array<[FieldKey, FieldValue]>;
+  entries(): Array<[FieldName, FieldValue]>;
   /**
-  * Make a deep copy of the Fields. Equivelant in behavior to calling the
+  * Make a deep copy of the Fields. Equivalent in behavior to calling the
   * `fields` constructor on the return value of `entries`. The resulting
   * `fields` is mutable.
   */
@@ -378,7 +402,7 @@ export class Fields {
 export class FutureIncomingResponse {
   /**
   * Returns a pollable which becomes ready when either the Response has
-  * been received, or an error has occured. When this pollable is ready,
+  * been received, or an error has occurred. When this pollable is ready,
   * the `get` method will return `some`.
   */
   subscribe(): Pollable;
@@ -393,8 +417,8 @@ export class FutureIncomingResponse {
   * is `some`, and error on subsequent calls.
   * 
   * The inner `result` represents that either the incoming HTTP Response
-  * status and headers have recieved successfully, or that an error
-  * occured. Errors may also occur while consuming the response body,
+  * status and headers have received successfully, or that an error
+  * occurred. Errors may also occur while consuming the response body,
   * but those will be reported by the `incoming-body` and its
   * `output-stream` child.
   */
@@ -404,12 +428,12 @@ export class FutureIncomingResponse {
 export class FutureTrailers {
   /**
   * Returns a pollable which becomes ready when either the trailers have
-  * been received, or an error has occured. When this pollable is ready,
+  * been received, or an error has occurred. When this pollable is ready,
   * the `get` method will return `some`.
   */
   subscribe(): Pollable;
   /**
-  * Returns the contents of the trailers, or an error which occured,
+  * Returns the contents of the trailers, or an error which occurred,
   * once the future is ready.
   * 
   * The outer `option` represents future readiness. Users can wait on this
@@ -421,7 +445,7 @@ export class FutureTrailers {
   * 
   * The inner `result` represents that either the HTTP Request or Response
   * body, as well as any trailers, were received successfully, or that an
-  * error occured receiving them. The optional `trailers` indicates whether
+  * error occurred receiving them. The optional `trailers` indicates whether
   * or not trailers were present in the body.
   * 
   * When some `trailers` are returned by this method, the `trailers`
@@ -472,7 +496,7 @@ export class IncomingRequest {
   */
   scheme(): Scheme | undefined;
   /**
-  * Returns the authority from the request, if it was present.
+  * Returns the authority of the Request's target URI, if present.
   */
   authority(): string | undefined;
   /**
@@ -597,16 +621,16 @@ export class OutgoingRequest {
   */
   setScheme(scheme: Scheme | undefined): void;
   /**
-  * Get the HTTP Authority for the Request. A value of `none` may be used
-  * with Related Schemes which do not require an Authority. The HTTP and
+  * Get the authority of the Request's target URI. A value of `none` may be used
+  * with Related Schemes which do not require an authority. The HTTP and
   * HTTPS schemes always require an authority.
   */
   authority(): string | undefined;
   /**
-  * Set the HTTP Authority for the Request. A value of `none` may be used
-  * with Related Schemes which do not require an Authority. The HTTP and
+  * Set the authority of the Request's target URI. A value of `none` may be used
+  * with Related Schemes which do not require an authority. The HTTP and
   * HTTPS schemes always require an authority. Fails if the string given is
-  * not a syntactically valid uri authority.
+  * not a syntactically valid URI authority.
   */
   setAuthority(authority: string | undefined): void;
   /**
@@ -616,7 +640,7 @@ export class OutgoingRequest {
   * `delete` operations will fail with `header-error.immutable`.
   * 
   * This headers resource is a child: it must be dropped before the parent
-  * `outgoing-request` is dropped, or its ownership is transfered to
+  * `outgoing-request` is dropped, or its ownership is transferred to
   * another component by e.g. `outgoing-handler.handle`.
   */
   headers(): Headers;
@@ -647,7 +671,7 @@ export class OutgoingResponse {
   * `delete` operations will fail with `header-error.immutable`.
   * 
   * This headers resource is a child: it must be dropped before the parent
-  * `outgoing-request` is dropped, or its ownership is transfered to
+  * `outgoing-request` is dropped, or its ownership is transferred to
   * another component by e.g. `outgoing-handler.handle`.
   */
   headers(): Headers;

package/types/interfaces/wasi-io-poll.d.ts

@@ -9,8 +9,9 @@ export namespace WasiIoPoll {
    * The result `list<u32>` contains one or more indices of handles in the
    * argument list that is ready for I/O.
    * 
-   * If the list contains more elements than can be indexed with a `u32`
-   * value, this function traps.
+   * This function traps if either:
+   * - the list is empty, or:
+   * - the list contains more elements than can be indexed with a `u32` value.
    * 
    * A timeout can be implemented by adding a pollable from the
    * wasi-clocks API to the list.
@@ -18,7 +19,7 @@ export namespace WasiIoPoll {
    * This function does not return a `result`; polling in itself does not
    * do any I/O so it doesn't fail. If any of the I/O sources identified by
    * the pollables has an error, it is indicated by marking the source as
-   * being reaedy for I/O.
+   * being ready for I/O.
    */
   export function poll(in_: Array<Pollable>): Uint32Array;
 }

package/types/interfaces/wasi-io-streams.d.ts

@@ -14,6 +14,9 @@ export type StreamError = StreamErrorLastOperationFailed | StreamErrorClosed;
  * The last operation (a write or flush) failed before completion.
  * 
  * More information is available in the `error` payload.
+ * 
+ * After this, the stream will be closed. All future operations return
+ * `stream-error::closed`.
  */
 export interface StreamErrorLastOperationFailed {
   tag: 'last-operation-failed',
@@ -162,7 +165,7 @@ export class OutputStream {
     blockingFlush(): void;
     /**
     * Create a `pollable` which will resolve once the output-stream
-    * is ready for more writing, or an error has occured. When this
+    * is ready for more writing, or an error has occurred. When this
     * pollable is ready, `check-write` will return `ok(n)` with n>0, or an
     * error.
     * 
@@ -212,7 +215,7 @@ export class OutputStream {
       /**
       * Read from one stream and write to another.
       * 
-      * The behavior of splice is equivelant to:
+      * The behavior of splice is equivalent to:
       * 1. calling `check-write` on the `output-stream`
       * 2. calling `read` on the `input-stream` with the smaller of the
       * `check-write` permitted length and the `len` provided to `splice`

package/types/interfaces/wasi-sockets-ip-name-lookup.d.ts

@@ -53,7 +53,7 @@ export class ResolveAddressStream {
   /**
   * Create a `pollable` which will resolve once the stream is ready for I/O.
   * 
-  * Note: this function is here for WASI Preview2 only.
+  * Note: this function is here for WASI 0.2 only.
   * It's planned to be removed when `future` is natively supported in Preview3.
   */
   subscribe(): Pollable;

package/types/interfaces/wasi-sockets-tcp.d.ts

@@ -79,7 +79,7 @@ export class TcpSocket {
   * Connect to a remote endpoint.
   * 
   * On success:
-  * - the socket is transitioned into the `connection` state.
+  * - the socket is transitioned into the `connected` state.
   * - a pair of streams is returned that can be used to read & write to the connection
   * 
   * After a failed connection attempt, the socket will be in the `closed`
@@ -329,10 +329,10 @@ export class TcpSocket {
   * `subscribe` only has to be called once per socket and can then be
   * (re)used for the remainder of the socket's lifetime.
   * 
-  * See <https://github.com/WebAssembly/wasi-sockets/TcpSocketOperationalSemantics.md#Pollable-readiness>
-  * for a more information.
+  * See <https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md#pollable-readiness>
+  * for more information.
   * 
-  * Note: this function is here for WASI Preview2 only.
+  * Note: this function is here for WASI 0.2 only.
   * It's planned to be removed when `future` is natively supported in Preview3.
   */
   subscribe(): Pollable;
@@ -347,7 +347,7 @@ export class TcpSocket {
   * associated with this socket will be closed and a FIN packet will be sent.
   * - `both`: Same effect as `receive` & `send` combined.
   * 
-  * This function is idempotent. Shutting a down a direction more than once
+  * This function is idempotent; shutting down a direction more than once
   * has no effect and returns `ok`.
   * 
   * The shutdown function does not close (drop) the socket.

package/types/interfaces/wasi-sockets-udp.d.ts

@@ -82,7 +82,7 @@ export class IncomingDatagramStream {
   /**
   * Create a `pollable` which will resolve once the stream is ready to receive again.
   * 
-  * Note: this function is here for WASI Preview2 only.
+  * Note: this function is here for WASI 0.2 only.
   * It's planned to be removed when `future` is natively supported in Preview3.
   */
   subscribe(): Pollable;
@@ -143,7 +143,7 @@ export class OutgoingDatagramStream {
   /**
   * Create a `pollable` which will resolve once the stream is ready to send again.
   * 
-  * Note: this function is here for WASI Preview2 only.
+  * Note: this function is here for WASI 0.2 only.
   * It's planned to be removed when `future` is natively supported in Preview3.
   */
   subscribe(): Pollable;
@@ -290,7 +290,7 @@ export class UdpSocket {
       /**
       * Create a `pollable` which will resolve once the socket is ready for I/O.
       * 
-      * Note: this function is here for WASI Preview2 only.
+      * Note: this function is here for WASI 0.2 only.
       * It's planned to be removed when `future` is natively supported in Preview3.
       */
       subscribe(): Pollable;