@bytecodealliance/preview2-shim 0.14.1 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytecodealliance/preview2-shim",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "WASI Preview2 shim for JS environments",
   "author": "Guy Bedford, Eduardo Rodrigues<16357187+eduardomourar@users.noreply.github.com>",
   "type": "module",
@@ -18,7 +18,7 @@
     }
   },
   "scripts": {
-    "test": "mocha -u tdd test/test.js --timeout 10000"
+    "test": "node --expose-gc ../../node_modules/mocha/bin/mocha.js -u tdd test/test.js --timeout 30000"
   },
   "files": [
     "types",

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

@@ -37,7 +37,14 @@ export namespace WasiHttpTypes {
    * syntactically invalid, or if a header was forbidden.
    */
   /**
-   * Get all of the values corresponding to a key.
+   * 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.
+   */
+  /**
+   * Returns `true` when the key is present in this `fields`. If the key is
+   * syntactically invalid, `false` is returned.
    */
   /**
    * Set all of the values for a key. Clears any existing values for that
@@ -255,10 +262,14 @@ export namespace WasiHttpTypes {
    * The outer `option` represents future readiness. Users can wait on this
    * `option` to become `some` using the `subscribe` method.
    * 
-   * The `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 or not
-   * trailers were present in the body.
+   * The outer `result` is used to retrieve the trailers or error at most
+   * once. It will be success on the first call in which the outer option
+   * is `some`, and error on subsequent calls.
+   * 
+   * 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
+   * or not trailers were present in the body.
    * 
    * When some `trailers` are returned by this method, the `trailers`
    * resource is immutable, and a child. Use of the `set`, `append`, or
@@ -349,7 +360,7 @@ import type { InputStream } from '../interfaces/wasi-io-streams.js';
 export { InputStream };
 import type { OutputStream } from '../interfaces/wasi-io-streams.js';
 export { OutputStream };
-import type { IoError } from '../interfaces/wasi-io-error.js';
+import type { Error as IoError } from '../interfaces/wasi-io-error.js';
 export { IoError };
 import type { Pollable } from '../interfaces/wasi-io-poll.js';
 export { Pollable };
@@ -618,15 +629,16 @@ export type Trailers = Fields;
 export type StatusCode = number;
 export type Result<T, E> = { tag: 'ok', val: T } | { tag: 'err', val: E };
 
-export class FutureIncomingResponse {
-  subscribe(): Pollable;
-  get(): Result<Result<IncomingResponse, ErrorCode>, void> | undefined;
+export class OutgoingBody {
+  write(): OutputStream;
+  static finish(this_: OutgoingBody, trailers: Trailers | undefined): void;
 }
 
 export class Fields {
   constructor()
   static fromList(entries: [FieldKey, FieldValue][]): Fields;
   get(name: FieldKey): FieldValue[];
+  has(name: FieldKey): boolean;
   set(name: FieldKey, value: FieldValue[]): void;
   delete(name: FieldKey): void;
   append(name: FieldKey, value: FieldValue): void;
@@ -634,33 +646,18 @@ export class Fields {
   clone(): Fields;
 }
 
-export class FutureTrailers {
+export class FutureIncomingResponse {
   subscribe(): Pollable;
-  get(): Result<Trailers | undefined, ErrorCode> | undefined;
+  get(): Result<Result<IncomingResponse, ErrorCode>, void> | undefined;
 }
 
-export class OutgoingRequest {
-  constructor(headers: Headers)
-  body(): OutgoingBody;
+export class IncomingRequest {
   method(): Method;
-  setMethod(method: Method): void;
   pathWithQuery(): string | undefined;
-  setPathWithQuery(pathWithQuery: string | undefined): void;
   scheme(): Scheme | undefined;
-  setScheme(scheme: Scheme | undefined): void;
   authority(): string | undefined;
-  setAuthority(authority: string | undefined): void;
   headers(): Headers;
-}
-
-export class RequestOptions {
-  constructor()
-  connectTimeoutMs(): Duration | undefined;
-  setConnectTimeoutMs(ms: Duration | undefined): void;
-  firstByteTimeoutMs(): Duration | undefined;
-  setFirstByteTimeoutMs(ms: Duration | undefined): void;
-  betweenBytesTimeoutMs(): Duration | undefined;
-  setBetweenBytesTimeoutMs(ms: Duration | undefined): void;
+  consume(): IncomingBody;
 }
 
 export class IncomingBody {
@@ -668,15 +665,13 @@ export class IncomingBody {
   static finish(this_: IncomingBody): FutureTrailers;
 }
 
-export class ResponseOutparam {
-  static set(param: ResponseOutparam, response: Result<OutgoingResponse, ErrorCode>): void;
+export class FutureTrailers {
+  subscribe(): Pollable;
+  get(): Result<Result<Trailers | undefined, ErrorCode>, void> | undefined;
 }
 
-export class IncomingRequest {
-  method(): Method;
-  pathWithQuery(): string | undefined;
-  scheme(): Scheme | undefined;
-  authority(): string | undefined;
+export class IncomingResponse {
+  status(): StatusCode;
   headers(): Headers;
   consume(): IncomingBody;
 }
@@ -689,13 +684,30 @@ export class OutgoingResponse {
   body(): OutgoingBody;
 }
 
-export class IncomingResponse {
-  status(): StatusCode;
+export class OutgoingRequest {
+  constructor(headers: Headers)
+  body(): OutgoingBody;
+  method(): Method;
+  setMethod(method: Method): void;
+  pathWithQuery(): string | undefined;
+  setPathWithQuery(pathWithQuery: string | undefined): void;
+  scheme(): Scheme | undefined;
+  setScheme(scheme: Scheme | undefined): void;
+  authority(): string | undefined;
+  setAuthority(authority: string | undefined): void;
   headers(): Headers;
-  consume(): IncomingBody;
 }
 
-export class OutgoingBody {
-  write(): OutputStream;
-  static finish(this_: OutgoingBody, trailers: Trailers | undefined): void;
+export class RequestOptions {
+  constructor()
+  connectTimeout(): Duration | undefined;
+  setConnectTimeout(duration: Duration | undefined): void;
+  firstByteTimeout(): Duration | undefined;
+  setFirstByteTimeout(duration: Duration | undefined): void;
+  betweenBytesTimeout(): Duration | undefined;
+  setBetweenBytesTimeout(duration: Duration | undefined): void;
+}
+
+export class ResponseOutparam {
+  static set(param: ResponseOutparam, response: Result<OutgoingResponse, ErrorCode>): void;
 }

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

@@ -24,6 +24,11 @@ export namespace WasiSocketsTcp {
    * - `not-in-progress`:           A `bind` operation is not in progress.
    * - `would-block`:               Can't finish the operation, it is still in progress. (EWOULDBLOCK, EAGAIN)
    * 
+   * # Implementors note
+   * When binding to a non-zero port, this bind operation shouldn't be affected by the TIME_WAIT
+   * state of a recently closed socket on the same local address (i.e. the SO_REUSEADDR socket
+   * option should be set implicitly on platforms that require it).
+   * 
    * # References
    * - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>
    * - <https://man7.org/linux/man-pages/man2/bind.2.html>

package/lib/common/assert.js

@@ -1,7 +0,0 @@
-export function assert(condition, tag, _val) {
-  if (condition) {
-    // TODO: throw meaningful errors
-    // NOTE: wasmtime conformance tests are expecting a string here (a tag)
-    throw tag;
-  }
-}

package/lib/nodejs/sockets/socket-common.js

@@ -1,116 +0,0 @@
-export function cappedUint32(value) {
-  // Note: cap the value to the highest possible BigInt value that can be represented as a
-  // unsigned 32-bit integer.
-  const width = 32n;
-  return BigInt.asUintN(Number(width), value);
-}
-
-export function noop() {}
-
-function tupleToIPv6(arr) {
-  if (arr.length !== 8) {
-    return null;
-  }
-  return arr.map((segment) => segment.toString(16)).join(":");
-}
-
-function tupleToIpv4(arr) {
-  if (arr.length !== 4) {
-    return null;
-  }
-  return arr.map((segment) => segment.toString(10)).join(".");
-}
-
-// TODO: write a better (faste?) parser for ipv6
-function ipv6ToTuple(ipv6) {
-  if (ipv6 === "::1") {
-    return [0, 0, 0, 0, 0, 0, 0, 1];
-  } else if (ipv6 === "::") {
-    return [0, 0, 0, 0, 0, 0, 0, 0];
-  } else if (ipv6.includes("::")) {
-    const [head, tail] = ipv6.split("::");
-    const headSegments = head.split(":").map((segment) => parseInt(segment, 16));
-    const tailSegments = tail.split(":").map((segment) => parseInt(segment, 16));
-    const missingSegments = 8 - headSegments.length - tailSegments.length;
-    const middleSegments = Array(missingSegments).fill(0);
-    return headSegments.concat(middleSegments).concat(tailSegments);
-  }
-  return ipv6.split(":").map((segment) => parseInt(segment, 16));
-}
-
-function ipv4ToTuple(ipv4) {
-  return ipv4.split(".").map((segment) => parseInt(segment, 10));
-}
-
-export function serializeIpAddress(addr = undefined, includePort = false) {
-  if (addr === undefined) {
-    return undefined;
-  }
-
-  const family = addr.tag;
-
-  let { address } = addr.val;
-  if (family.toLocaleLowerCase() === "ipv4") {
-    address = tupleToIpv4(address);
-  } else if (family.toLocaleLowerCase() === "ipv6") {
-    address = tupleToIPv6(address);
-  }
-
-  if (includePort) {
-    address = `${address}:${addr.val.port}`;
-  }
-
-  return address;
-}
-
-export function deserializeIpAddress(addr, family) {
-  let address = [];
-  if (family.toLocaleLowerCase() === "ipv4") {
-    address = ipv4ToTuple(addr);
-  } else if (family.toLocaleLowerCase() === "ipv6") {
-    address = ipv6ToTuple(addr);
-  }
-  return address;
-}
-
-export function findUnsuedLocalAddress(family) {
-  let address = [127, 0, 0, 1];
-  if (family.toLocaleLowerCase() === "ipv6") {
-    address = [0, 0, 0, 0, 0, 0, 0, 1];
-  }
-  return {
-    tag: family,
-    val: {
-      address,
-      port: 0,
-    },
-  };
-}
-
-export function isUnicastIpAddress(ipSocketAddress) {
-  return !isMulticastIpAddress(ipSocketAddress) && !isBroadcastIpAddress(ipSocketAddress);
-}
-
-export function isMulticastIpAddress(ipSocketAddress) {
-  // ipv6: [0xff00, 0, 0, 0, 0, 0, 0, 0]
-  // ipv4: [224, 0, 0, 0]
-  return ipSocketAddress.val.address[0] === 224 || ipSocketAddress.val.address[0] === 0xff00;
-}
-
-export function isBroadcastIpAddress(ipSocketAddress) {
-  // ipv4: [255, 255, 255, 255]
-  return (
-    ipSocketAddress.val.address[0] === 0xff && // 255
-    ipSocketAddress.val.address[1] === 0xff && // 255
-    ipSocketAddress.val.address[2] === 0xff && // 255
-    ipSocketAddress.val.address[3] === 0xff // 255
-  );
-}
-
-export function isIPv4MappedAddress(ipSocketAddress) {
-  // ipv6: [0, 0, 0, 0, 0, 0xffff, 0, 0]
-  if (ipSocketAddress.val.address.length !== 8) {
-    return false;
-  }
-  return ipSocketAddress.val.address[5] === 0xffff;
-}

package/lib/nodejs/sockets/socketopts-bindings.js

@@ -1,94 +0,0 @@
-import { platform } from "node:os";
-import { _errnoException } from "node:util";
-import { types, refType } from "ref-napi";
-import { Library, errno as _errno } from "ffi-napi";
-
-const tryGetUV = (() => {
-  let UV = null;
-  return () => {
-    if (UV === null) {
-      try {
-        UV = typeof process.binding === "function" ? process.binding("uv") : undefined;
-      } catch (ex) {
-        // Continue regardless
-      }
-    }
-    return UV;
-  };
-})();
-
-const uvErrName = (errno) => {
-  const UV = tryGetUV();
-  return UV && UV.errname ? UV.errname(errno) : "UNKNOWN";
-};
-
-const errnoException = (errno, syscall, original) => {
-  if (_errnoException) {
-    return _errnoException(-errno, syscall, original);
-  }
-
-  const errname = uvErrName(-errno),
-    message = original ? `${syscall} ${errname} (${errno}) ${original}` : `${syscall} ${errname} (${errno})`;
-
-  const e = new Error(message);
-  e.code = errname;
-  e.errno = errname;
-  e.syscall = syscall;
-  return e;
-};
-
-const createFFI = () => {
-  const cInt = types.int;
-  const cVoid = types.void;
-
-  return Library(null, {
-    //name       ret    1     2     3     4                   5
-    setsockopt: [cInt, [cInt, cInt, cInt, refType(cVoid), cInt]],
-    getsockopt: [cInt, [cInt, cInt, cInt, refType(cVoid), refType(cInt)]],
-  });
-};
-
-const ffi = (() => {
-  let instance;
-  return () => {
-    if (!instance) {
-      instance = createFFI();
-    }
-    return instance;
-  };
-})();
-
-const _setsockopt = (fd, level, name, value, valueLength) => {
-  if (fd == null) {
-    return false;
-  }
-
-  const err = ffi().setsockopt(fd, level, name, value, valueLength);
-
-  if (err !== 0) {
-    const errno = _errno();
-    throw errnoException(errno, "setsockopt");
-  }
-
-  return true;
-};
-
-const _getsockopt = (fd, level, name, value, valueLength) => {
-  if (fd == null) {
-    return false;
-  }
-
-  const err = ffi().getsockopt(fd, level, name, value, valueLength);
-
-  if (err !== 0) {
-    const errno = _errno();
-    throw errnoException(errno, "getsockopt");
-  }
-  return true;
-};
-
-const noop = () => false;
-const isWin32 = platform() === "win32";
-
-export const setsockopt = isWin32 ? noop : _setsockopt;
-export const getsockopt = isWin32 ? noop : _getsockopt;