@gjsify/worker_threads 0.4.0 → 0.4.3

package/src/index.ts

@@ -1,148 +0,0 @@
-// Reference: Node.js lib/worker_threads.js
-// Reimplemented for GJS — MessageChannel/BroadcastChannel are pure JS,
-// Worker uses Gio.Subprocess (subprocess-based workers)
-
-export { MessagePort } from './message-port.ts';
-export { Worker } from './worker.ts';
-export type { WorkerOptions } from './worker.ts';
-
-import { MessagePort } from './message-port.ts';
-import { Worker } from './worker.ts';
-
-// When running inside a Worker subprocess, the bootstrap script sets
-// globalThis.__gjsify_worker_context before importing the user's code.
-const _ctx = (globalThis as Record<string, unknown>).__gjsify_worker_context as
-  { isMainThread: boolean; parentPort: unknown; workerData: unknown; threadId: number } | undefined;
-
-export const isMainThread: boolean = !_ctx;
-export const parentPort: MessagePort | null = (_ctx?.parentPort as MessagePort) ?? null;
-export const workerData: unknown = _ctx?.workerData ?? null;
-export const threadId: number = _ctx?.threadId ?? 0;
-export const resourceLimits: Record<string, unknown> = {};
-export const SHARE_ENV: unique symbol = Symbol('worker_threads.SHARE_ENV');
-
-export class MessageChannel {
-  readonly port1: MessagePort;
-  readonly port2: MessagePort;
-
-  constructor() {
-    this.port1 = new MessagePort();
-    this.port2 = new MessagePort();
-    this.port1._otherPort = this.port2;
-    this.port2._otherPort = this.port1;
-  }
-}
-
-const _broadcastRegistry = new Map<string, Set<BroadcastChannel>>();
-
-export class BroadcastChannel {
-  readonly name: string;
-  private _closed = false;
-  onmessage: ((event: { data: unknown }) => void) | null = null;
-  onmessageerror: ((event: { data: unknown }) => void) | null = null;
-
-  constructor(name: string) {
-    this.name = String(name);
-    if (!_broadcastRegistry.has(this.name)) {
-      _broadcastRegistry.set(this.name, new Set());
-    }
-    _broadcastRegistry.get(this.name)!.add(this);
-  }
-
-  postMessage(message: unknown): void {
-    if (this._closed) {
-      throw new Error('BroadcastChannel is closed');
-    }
-
-    const channels = _broadcastRegistry.get(this.name);
-    if (!channels) return;
-
-    for (const channel of channels) {
-      if (channel !== this && !channel._closed) {
-        // Clone per receiver per W3C spec — each recipient gets an independent copy
-        const cloned = structuredClone(message);
-        Promise.resolve().then(() => {
-          if (!channel._closed && channel.onmessage) {
-            channel.onmessage({ data: cloned });
-          }
-        });
-      }
-    }
-  }
-
-  close(): void {
-    if (this._closed) return;
-    this._closed = true;
-    const channels = _broadcastRegistry.get(this.name);
-    if (channels) {
-      channels.delete(this);
-      if (channels.size === 0) {
-        _broadcastRegistry.delete(this.name);
-      }
-    }
-    this.onmessage = null;
-    this.onmessageerror = null;
-  }
-
-  addEventListener(type: string, listener: ((event: unknown) => void) | null): void {
-    if (type === 'message') {
-      this.onmessage = listener as ((event: { data: unknown }) => void) | null;
-    } else if (type === 'messageerror') {
-      this.onmessageerror = listener as ((event: { data: unknown }) => void) | null;
-    }
-  }
-
-  removeEventListener(type: string, _listener: ((event: unknown) => void) | null): void {
-    if (type === 'message') this.onmessage = null;
-    else if (type === 'messageerror') this.onmessageerror = null;
-  }
-
-  dispatchEvent(_event: Event): boolean {
-    return true;
-  }
-}
-
-const _environmentData = new Map<string, unknown>();
-
-export function setEnvironmentData(key: string, value: unknown): void {
-  if (value === undefined) {
-    _environmentData.delete(key);
-  } else {
-    _environmentData.set(key, value);
-  }
-}
-
-export function getEnvironmentData(key: string): unknown {
-  return _environmentData.get(key);
-}
-
-export function receiveMessageOnPort(port: MessagePort): { message: unknown } | undefined {
-  if (!port._hasQueuedMessages) return undefined;
-  return { message: port._dequeueMessage() };
-}
-
-// No-ops in GJS — all messages are cloned, not transferred
-export function markAsUntransferable(_object: unknown): void {}
-export function markAsUncloneable(_object: unknown): void {}
-export function moveMessagePortToContext(port: MessagePort, _context: unknown): MessagePort {
-  return port;
-}
-
-export default {
-  isMainThread,
-  parentPort,
-  workerData,
-  threadId,
-  resourceLimits,
-  SHARE_ENV,
-  Worker,
-  MessageChannel,
-  MessagePort,
-  BroadcastChannel,
-  setEnvironmentData,
-  getEnvironmentData,
-  receiveMessageOnPort,
-  markAsUntransferable,
-  markAsUncloneable,
-  moveMessagePortToContext,
-};

package/src/message-port.ts

@@ -1,365 +0,0 @@
-// Reference: Node.js lib/internal/worker/io.js
-// Reference: HTML Living Standard §9.4.4 message ports + transferable objects
-// Reference: refs/node-test/parallel/test-worker-message-port-transfer*.js
-// Reimplemented for GJS using EventEmitter
-//
-// Transferable support:
-// - ArrayBuffer transfer uses the structured-clone layer's transfer hook
-//   (SM140 ArrayBuffer.prototype.transfer() — zero-copy, sender detaches).
-// - MessagePort transfer is handled at this layer: a MessagePort listed in
-//   transferList is detached from its current channel (close locally) and
-//   re-attached on the receiver side. Wire format: a placeholder
-//   `{ __gjsifyTransferredPort: true, queue: [...], hasOtherEnd: bool }`
-//   is substituted into the cloned message tree, then materialised back into
-//   a MessagePort on the receiver. Because the underlying linked-port pair
-//   is in-process JS (no IPC), we move the surviving end of the channel
-//   directly — there is no separate serialization step.
-//
-// Cross-process MessagePort transfer (i.e. via Worker subprocess IPC) is not
-// supported — see STATUS.md "Open TODOs".
-
-import { EventEmitter } from 'node:events';
-
-/**
- * Internal placeholder used while serializing a transferred MessagePort.
- * Replaced with a fresh local MessagePort by `_finalizeTransfer` after
- * structuredClone returns.
- */
-interface TransferredPortPlaceholder {
-  readonly __gjsifyTransferredPort: true;
-  /** Index into the materialisation array — unique per transfer. */
-  readonly index: number;
-}
-
-function isTransferredPortPlaceholder(value: unknown): value is TransferredPortPlaceholder {
-  return (
-    typeof value === 'object'
-    && value !== null
-    && (value as { __gjsifyTransferredPort?: unknown }).__gjsifyTransferredPort === true
-  );
-}
-
-export class MessagePort extends EventEmitter {
-  private _started = false;
-  private _closed = false;
-  private _detached = false;
-  private _messageQueue: unknown[] = [];
-  /** @internal Linked port for in-process communication */
-  _otherPort: MessagePort | null = null;
-  /** @internal Maps addEventListener listeners to their internal wrappers */
-  private _aeWrappers: Map<((event: unknown) => void), ((data: unknown) => void)> = new Map();
-
-  start(): void {
-    if (this._started || this._closed) return;
-    this._started = true;
-    this._drainQueue();
-  }
-
-  close(): void {
-    if (this._closed) return;
-    this._closed = true;
-    const other = this._otherPort;
-    this._otherPort = null;
-    if (other) other._otherPort = null;
-    this.emit('close');
-    this.removeAllListeners();
-  }
-
-  postMessage(value: unknown, transferList?: unknown[]): void {
-    if (this._closed) return;
-    const target = this._otherPort;
-    if (!target) return;
-
-    // --- Transfer-list pre-flight ---
-    // Validate transferable entries up front. Per HTML spec, validation must
-    // happen before any side effects (no partial transfer on error).
-    const arrayBufferTransfers: ArrayBuffer[] = [];
-    const portTransfers: MessagePort[] = [];
-
-    if (transferList && transferList.length > 0) {
-      const seenInList = new Set<unknown>();
-      for (const item of transferList) {
-        if (seenInList.has(item)) {
-          throw createDataCloneError('Transfer list contains duplicate entries');
-        }
-        seenInList.add(item);
-
-        if (item instanceof MessagePort) {
-          if (item === this) {
-            throw createDataCloneError('Cannot transfer source port');
-          }
-          if (item._closed || item._detached) {
-            throw createDataCloneError('MessagePort in transfer list is already detached');
-          }
-          portTransfers.push(item);
-          continue;
-        }
-
-        // ArrayBuffer
-        const tag = Object.prototype.toString.call(item).slice(8, -1);
-        if (tag === 'ArrayBuffer') {
-          const buf = item as ArrayBuffer & { detached?: boolean };
-          if (buf.detached === true) {
-            throw createDataCloneError('ArrayBuffer in transfer list is detached');
-          }
-          arrayBufferTransfers.push(buf);
-          continue;
-        }
-
-        // SharedArrayBuffer must NOT appear in transfer list — it shares.
-        if (tag === 'SharedArrayBuffer') {
-          throw createDataCloneError('SharedArrayBuffer cannot appear in transfer list (it is shared, not transferred)');
-        }
-
-        throw createDataCloneError(`Value at index ${transferList.indexOf(item)} of transfer list is not transferable`);
-      }
-    }
-
-    // --- Substitute MessagePort placeholders before clone ---
-    // The structured-clone layer doesn't know about MessagePort; we walk the
-    // value tree and replace each transferred port instance with a placeholder
-    // (so the cloned tree reuses the same placeholder objects), then swap the
-    // placeholders back to fresh local MessagePorts on the receiver side.
-    const portMaterialisationOrder = portTransfers.slice();
-    let substituted: unknown = value;
-    if (portTransfers.length > 0) {
-      substituted = substitutePortsWithPlaceholders(value, portTransfers);
-    }
-
-    // --- Clone (with ArrayBuffer transfer) ---
-    let cloned: unknown;
-    try {
-      cloned = structuredClone(substituted, {
-        transfer: arrayBufferTransfers.length > 0 ? arrayBufferTransfers : undefined,
-      });
-    } catch (err) {
-      this.emit('messageerror', err instanceof Error ? err : new Error('Could not clone message'));
-      return;
-    }
-
-    // --- Materialise transferred MessagePorts on the receiver ---
-    // For each transferred port: detach the source MessagePort locally, then
-    // create a new MessagePort on the receiver side that takes over the
-    // surviving end of the channel.
-    let receiverMessage = cloned;
-    if (portMaterialisationOrder.length > 0) {
-      const newPorts = portMaterialisationOrder.map((sourcePort) => {
-        // The source port is being moved. Steal its channel partner.
-        const partner = sourcePort._otherPort;
-        const queued = sourcePort._messageQueue.slice();
-        sourcePort._messageQueue.length = 0;
-        sourcePort._otherPort = null;
-        sourcePort._detached = true;
-        // Mark closed locally — the original port is no longer usable.
-        sourcePort._closed = true;
-
-        const newPort = new MessagePort();
-        newPort._otherPort = partner;
-        if (partner) partner._otherPort = newPort;
-        // Carry over any pending messages that the sourcePort had not drained yet.
-        for (const msg of queued) newPort._messageQueue.push(msg);
-        return newPort;
-      });
-      receiverMessage = replacePlaceholdersWithPorts(cloned, newPorts);
-    }
-
-    target._receiveMessage(receiverMessage);
-  }
-
-  ref(): this { return this; }
-  unref(): this { return this; }
-
-  _receiveMessage(message: unknown): void {
-    if (this._closed) return;
-    if (!this._started) {
-      this._messageQueue.push(message);
-      return;
-    }
-    this._dispatchMessage(message);
-  }
-
-  get _hasQueuedMessages(): boolean {
-    return this._messageQueue.length > 0;
-  }
-
-  _dequeueMessage(): unknown | undefined {
-    return this._messageQueue.shift();
-  }
-
-  /** @internal Has this port been transferred elsewhere? */
-  get _wasTransferred(): boolean {
-    return this._detached;
-  }
-
-  private _drainQueue(): void {
-    while (this._messageQueue.length > 0) {
-      this._dispatchMessage(this._messageQueue.shift());
-    }
-  }
-
-  private _dispatchMessage(message: unknown): void {
-    Promise.resolve().then(() => {
-      if (!this._closed) {
-        this.emit('message', message);
-      }
-    });
-  }
-
-  /**
-   * Web-compatible addEventListener. Wraps message data in a MessageEvent-like
-   * object `{ data, type }` before calling the listener.
-   * Requires explicit `port.start()` call (unlike `on('message')` which auto-starts).
-   */
-  addEventListener(type: string, listener: ((event: unknown) => void) | null): void {
-    if (!listener) return;
-    if (type === 'message') {
-      const wrapper = (data: unknown) => {
-        listener({ data, type: 'message' });
-      };
-      this._aeWrappers.set(listener, wrapper);
-      super.on('message', wrapper);
-    } else {
-      super.on(type, listener);
-    }
-  }
-
-  removeEventListener(type: string, listener: ((event: unknown) => void) | null): void {
-    if (!listener) return;
-    if (type === 'message') {
-      const wrapper = this._aeWrappers.get(listener);
-      if (wrapper) {
-        super.off('message', wrapper);
-        this._aeWrappers.delete(listener);
-      }
-    } else {
-      super.off(type, listener);
-    }
-  }
-
-  on(event: string | symbol, listener: (...args: unknown[]) => void): this {
-    super.on(event, listener);
-    if (event === 'message' && !this._started) {
-      this.start();
-    }
-    return this;
-  }
-
-  addListener(event: string | symbol, listener: (...args: unknown[]) => void): this {
-    return this.on(event, listener);
-  }
-
-  once(event: string | symbol, listener: (...args: unknown[]) => void): this {
-    super.once(event, listener);
-    if (event === 'message' && !this._started) {
-      this.start();
-    }
-    return this;
-  }
-}
-
-// --- Helpers ---
-
-function createDataCloneError(message: string): Error {
-  const DOMExceptionCtor = (globalThis as Record<string, unknown>).DOMException as
-    (new (message: string, name: string) => Error) | undefined;
-  if (typeof DOMExceptionCtor === 'function') {
-    const err = new DOMExceptionCtor(message, 'DataCloneError');
-    // Ensure the `code` property matches Node/W3C (25 = DATA_CLONE_ERR).
-    if ((err as { code?: number }).code === undefined) {
-      try {
-        Object.defineProperty(err, 'code', { value: 25, configurable: true });
-      } catch { /* ignore */ }
-    }
-    return err;
-  }
-  const err = new Error(message);
-  err.name = 'DataCloneError';
-  (err as { code?: number }).code = 25;
-  return err;
-}
-
-/**
- * Walk `value`, replacing any MessagePort listed in `ports` with a
- * placeholder. Returns the new tree (copy-on-substitute). Mutates nothing in
- * the input.
- *
- * Handles plain objects and arrays. Other tagged types (Map, Set, …) are
- * passed through unchanged — the structured clone step that follows will
- * handle them, and ports inside Maps/Sets are uncommon enough in practice
- * that we don't expand the walk for them. (Node accepts the same constraint.)
- */
-function substitutePortsWithPlaceholders(value: unknown, ports: MessagePort[]): unknown {
-  const portToIndex = new Map<MessagePort, number>();
-  for (let i = 0; i < ports.length; i++) portToIndex.set(ports[i]!, i);
-
-  function walk(v: unknown, seen: Map<object, unknown>): unknown {
-    if (v === null || typeof v !== 'object') return v;
-
-    // MessagePort substitution
-    if (v instanceof MessagePort) {
-      const idx = portToIndex.get(v);
-      if (idx === undefined) return v; // not transferred
-      const placeholder: TransferredPortPlaceholder = { __gjsifyTransferredPort: true, index: idx };
-      return placeholder;
-    }
-
-    if (seen.has(v)) return seen.get(v);
-
-    if (Array.isArray(v)) {
-      const out: unknown[] = [];
-      seen.set(v, out);
-      for (let i = 0; i < v.length; i++) {
-        if (i in v) out[i] = walk(v[i], seen);
-      }
-      return out;
-    }
-
-    const tag = Object.prototype.toString.call(v).slice(8, -1);
-    if (tag === 'Object') {
-      const out: Record<string, unknown> = {};
-      seen.set(v, out);
-      for (const k of Object.keys(v as Record<string, unknown>)) {
-        out[k] = walk((v as Record<string, unknown>)[k], seen);
-      }
-      return out;
-    }
-
-    // Other tagged types: leave intact for structuredClone to handle.
-    return v;
-  }
-
-  return walk(value, new Map());
-}
-
-/**
- * Walk `value` post-clone and replace each placeholder with the corresponding
- * receiver-side MessagePort.
- */
-function replacePlaceholdersWithPorts(value: unknown, newPorts: MessagePort[]): unknown {
-  function walk(v: unknown, seen: Map<object, unknown>): unknown {
-    if (v === null || typeof v !== 'object') return v;
-    if (isTransferredPortPlaceholder(v)) {
-      return newPorts[v.index];
-    }
-    if (seen.has(v)) return seen.get(v);
-
-    if (Array.isArray(v)) {
-      seen.set(v, v);
-      for (let i = 0; i < v.length; i++) {
-        if (i in v) v[i] = walk(v[i], seen);
-      }
-      return v;
-    }
-
-    const tag = Object.prototype.toString.call(v).slice(8, -1);
-    if (tag === 'Object') {
-      seen.set(v, v);
-      for (const k of Object.keys(v as Record<string, unknown>)) {
-        (v as Record<string, unknown>)[k] = walk((v as Record<string, unknown>)[k], seen);
-      }
-      return v;
-    }
-    return v;
-  }
-  return walk(value, new Map());
-}

package/src/test.mts

@@ -1,8 +0,0 @@
-import '@gjsify/node-globals/register/process';
-import '@gjsify/node-globals/register/buffer';
-import '@gjsify/node-globals/register/timers';
-import '@gjsify/node-globals/register/url';
-import '@gjsify/node-globals/register/structured-clone';
-import { run } from '@gjsify/unit';
-import testSuite from './index.spec.js';
-run({ testSuite });