@woosh/meep-engine 3.46.0 → 3.49.0

package/src/engine/network/transport/ReliableCommandPipeline.js

@@ -1,335 +0,0 @@
-import { assert } from "../../../core/assert.js";
-import { BinaryBuffer } from "../../../core/binary/BinaryBuffer.js";
-import Signal from "../../../core/events/signal/Signal.js";
-import { MalformedPacketError } from "../core/MalformedPacketError.js";
-import { MAX_CHANNEL_PAYLOAD_BYTES } from "./fragments/packet_size.js";
-
-/**
- * Largest reliable-command payload that fits in a single channel packet.
- *
- * A command's wire form is `uint8 packet_type + uintVar logical_seq + payload`.
- * The pipeline sends it through {@link Channel#send} directly — it does NOT
- * fragment — so the whole thing must fit one channel packet
- * ({@link MAX_CHANNEL_PAYLOAD_BYTES}). We reserve 11 bytes for the framing:
- * 1 packet-type byte + up to 10 bytes of `uintVar` for `logical_seq` (its
- * worst case; `logical_seq` grows over the session, so we budget the maximum
- * rather than the current value). Sending a larger payload on a UDP-style
- * transport would emit an over-MTU datagram that the network silently drops;
- * we reject it loudly instead.
- *
- * @type {number}
- */
-export const MAX_RELIABLE_COMMAND_PAYLOAD_BYTES = MAX_CHANNEL_PAYLOAD_BYTES - 11;
-
-/**
- * Reliable, at-least-once delivery layer over a {@link Channel}.
- *
- * Used for messages that must arrive: chat, lobby/room state changes,
- * level transitions, kick / disconnect notifications. Distinct from the
- * action-stream traffic the rest of the netcode uses, which is UDP-style
- * best-effort with per-frame back-fill compensating for losses.
- *
- * Wire layout (after the {@link Channel}'s 8-byte header and the
- * `packet_type` byte that {@link NetworkPeer}'s dispatcher consumes):
- *
- *   uintVar logical_seq    sender-assigned, monotonically increasing
- *   bytes   command_payload
- *
- * Reliability mechanism: each outgoing command goes out as one
- * Channel.send call. The returned channel-level seq is tracked in
- * `__unacked`. When the Channel later fires:
- *   - `onPacketAcked(seq)`: drop the entry — the command was delivered
- *     (the receiver de-duplicated by logical_seq, so a "duplicate" from
- *     a previous retransmit is harmless).
- *   - `onPacketLost(seq)`: the Channel's 33-packet ack window aged out
- *     this seq without seeing it acked. Re-send the same logical
- *     command on a fresh channel seq.
- *
- * Receiver side: a sliding-window de-dupe of recent `logical_seq` values.
- * Anything seen within the last `max_received_history` is silently
- * dropped; first-time arrivals fire `onCommand` with the payload bytes.
- *
- * Ordering: NOT guaranteed. Commands may arrive in any order. If you
- * need in-order delivery (level transitions before subsequent chat),
- * key payloads with a counter and reorder in the application handler.
- *
- * Lifecycle constraints:
- *   - `max_unacked` caps outstanding commands. Send throws when full
- *     (signals real backpressure — receiver gone or path is broken).
- *   - `max_received_history` caps the de-dupe set. A retransmit older
- *     than this window will be re-delivered as a duplicate to the
- *     application; not a problem in practice because the sender's
- *     `max_unacked` keeps the inflight set bounded too.
- *
- * Caveats:
- *   - Loss detection relies on the Channel's seq window, which advances
- *     when subsequent packets are sent. Under sustained no-traffic
- *     conditions a single lost reliable command may stay unacked
- *     indefinitely — by convention the action-stream's per-tick traffic
- *     keeps the window moving even when the application is otherwise
- *     idle. Real production code may want a timer-based retransmit
- *     fallback layered on top of this.
- *
- * @author Alex Goldring
- * @copyright Company Named Limited (c) 2026
- */
-export class ReliableCommandPipeline {
-    /**
-     * Monotonic counter for outgoing logical seqs. Receiver dedups on
-     * this value; sender retransmits use the SAME logical_seq with a
-     * new channel_seq.
-     * @type {number}
-     * @private
-     */
-    #next_send_seq = 0;
-    #unacked;
-    #received_seqs;
-    /**
-     * FIFO order of received logical_seqs, for pruning when
-     * `__received_seqs` exceeds `max_received_history`.
-     * @type {number[]}
-     * @private
-     */
-    #received_order = [];
-    #send_scratch;
-    #bound_acked;
-    #bound_lost;
-
-    /**
-     * @param {{
-     *   channel: import("./Channel.js").Channel,
-     *   packet_type: number,
-     *   max_unacked?: number,
-     *   max_received_history?: number,
-     *   max_retries?: number,
-     * }} options
-     */
-    constructor({
-        channel,
-        packet_type,
-        max_unacked = 64,
-        max_received_history = 64,
-        max_retries = 16,
-    }) {
-        assert.ok(channel && typeof channel.send === 'function', 'channel must be a Channel');
-        assert.isNonNegativeInteger(packet_type, 'packet_type');
-        assert.ok(packet_type <= 0xFF, 'packet_type must fit in a uint8');
-        assert.isPositiveInteger(max_unacked, 'max_unacked');
-        assert.isPositiveInteger(max_received_history, 'max_received_history');
-        assert.isPositiveInteger(max_retries, 'max_retries');
-
-        /** @type {import("./Channel.js").Channel} */
-        this.channel = channel;
-        /** @type {number} @readonly */
-        this.packet_type = packet_type;
-        /** @type {number} @readonly */
-        this.max_unacked = max_unacked;
-        /** @type {number} @readonly */
-        this.max_received_history = max_received_history;
-        /**
-         * Maximum retransmissions per logical command before it is dropped
-         * and {@link onCommandAbandoned} fires. Bounded so a permanently-
-         * black-holed peer can't pin retransmit traffic on the channel
-         * forever. The default (16) tolerates roughly half a second of
-         * sustained loss at typical channel cadences before giving up.
-         * @type {number} @readonly
-         */
-        this.max_retries = max_retries;
-
-        /**
-         * Outstanding commands keyed by their CURRENT channel_seq. On
-         * retransmit, the entry is moved to the new channel_seq.
-         * `retries` counts how many times this logical command has been
-         * resent; the entry is dropped when it exceeds `max_retries`.
-         * @type {Map<number, {logical_seq: number, payload: Uint8Array, retries: number}>}
-         * @private
-         */
-        this.#unacked = new Map();
-
-        /**
-         * Logical seqs received recently. Sliding window for dedup.
-         * @type {Set<number>}
-         * @private
-         */
-        this.#received_seqs = new Set();
-
-        /**
-         * Scratch buffer for assembling outgoing packets.
-         * @type {BinaryBuffer}
-         * @private
-         */
-        this.#send_scratch = new BinaryBuffer();
-        this.#send_scratch.setCapacity(1024);
-
-        /**
-         * Fired when a brand-new logical command arrives (not a duplicate).
-         * Args: `(buf, payload_offset, payload_length)`. The buffer is
-         * shared scratch; consumers must copy bytes if they need them to
-         * outlive the handler.
-         * @type {Signal}
-         */
-        this.onCommand = new Signal();
-
-        /**
-         * Fired when a sent command has been retransmitted `max_retries`
-         * times without an ack and is being given up on. Args:
-         * `(logical_seq)`. Subscribers typically surface this as a "command
-         * failed to deliver" event to the application, or treat it as a
-         * hard signal to tear down the session.
-         * @type {Signal}
-         */
-        this.onCommandAbandoned = new Signal();
-
-        // Channel reliability notifications.
-        this.#bound_acked = (seq) => this.#on_packet_acked(seq);
-        this.#bound_lost = (seq) => this.#on_packet_lost(seq);
-        channel.onPacketAcked.add(this.#bound_acked);
-        channel.onPacketLost.add(this.#bound_lost);
-    }
-
-    /**
-     * Send a logical command. Returns the assigned `logical_seq` (useful
-     * for application-level diagnostics; the receiver dedups internally
-     * regardless).
-     *
-     * @param {Uint8Array} payload
-     * @param {number} length
-     * @returns {number}
-     */
-    send(payload, length) {
-        assert.isNonNegativeInteger(length, 'length');
-        if (length > MAX_RELIABLE_COMMAND_PAYLOAD_BYTES) {
-            // The pipeline does not fragment; an over-MTU command would be sent
-            // as one oversized datagram that UDP-style transports silently drop.
-            // Fail loudly so the caller chunks at the application layer (or uses
-            // a stream transport) rather than losing the message on the wire.
-            throw new Error(
-                `ReliableCommandPipeline.send: payload of ${length} bytes exceeds the ` +
-                `${MAX_RELIABLE_COMMAND_PAYLOAD_BYTES}-byte single-packet limit; this layer does not ` +
-                `fragment — chunk the message at the application layer or send it over a stream transport`
-            );
-        }
-        if (this.#unacked.size >= this.max_unacked) {
-            throw new Error(
-                `ReliableCommandPipeline.send: ${this.#unacked.size} commands unacked ` +
-                `(max ${this.max_unacked}); receiver likely disconnected or path saturated`
-            );
-        }
-        const logical_seq = this.#next_send_seq;
-        this.#next_send_seq++;
-
-        // Defensive copy: the caller's buffer may be reused after this call.
-        const payload_copy = new Uint8Array(length);
-        payload_copy.set(payload.subarray(0, length));
-
-        const channel_seq = this.#transmit(logical_seq, payload_copy);
-        this.#unacked.set(channel_seq, { logical_seq, payload: payload_copy, retries: 0 });
-        return logical_seq;
-    }
-
-    /**
-     * Called by the orchestrator (typically {@link NetworkPeer}'s
-     * dispatcher) when a packet of this pipeline's type arrives. `buf`
-     * is positioned just past the packet-type byte.
-     *
-     * @param {BinaryBuffer} buf
-     * @param {number} total_length    full transport-level payload length,
-     *                                  including the consumed packet-type byte
-     */
-    handle_inbound(buf, total_length) {
-        // Bounds-checked before the read, like every other parse path in the dispatcher.
-        //
-        // `#recv_buffer` is a reused scratch: `writeBytes(bytes, 0, length)` overwrites only the
-        // first `length` bytes, so everything past them is the previous, longer packet's content.
-        // A truncated RELIABLE_COMMAND - just the type byte, from a peer or a truncating middlebox
-        // - let `readUintVar` walk into those leftovers and produce a bogus `logical_seq`, which
-        // was then recorded in the received set, so a genuine later command carrying that seq was
-        // silently dropped as a duplicate.
-        if (buf.position >= total_length) {
-            throw new MalformedPacketError(`ReliableCommandPipeline: RELIABLE_COMMAND truncated before its sequence number`);
-        }
-
-        const logical_seq = buf.readUintVar();
-
-        // ...and after it: `readUintVar` may have consumed bytes past the packet even when one was
-        // available to start with. Subtracting gave a negative payload length and an offset into an
-        // unrelated packet's bytes, handed straight to the application.
-        if (buf.position > total_length) {
-            throw new MalformedPacketError(`ReliableCommandPipeline: RELIABLE_COMMAND sequence number runs past the packet`);
-        }
-
-        if (this.#received_seqs.has(logical_seq)) {
-            // Duplicate from a retransmit; ignore.
-            return;
-        }
-        this.#received_seqs.add(logical_seq);
-        this.#received_order.push(logical_seq);
-        // Prune. Oldest-first.
-        while (this.#received_order.length > this.max_received_history) {
-            const oldest = this.#received_order.shift();
-            this.#received_seqs.delete(oldest);
-        }
-
-        const payload_offset = buf.position;
-        const payload_length = total_length - payload_offset;
-        this.onCommand.send3(buf, payload_offset, payload_length);
-    }
-
-    /**
-     * Number of commands sent that haven't yet been acked. Useful for
-     * backpressure / progress UI.
-     * @returns {number}
-     */
-    unacked_count() {
-        return this.#unacked.size;
-    }
-
-    /**
-     * Drop subscriptions and clear state. Required before discarding a
-     * pipeline whose channel will outlive it.
-     */
-    dispose() {
-        this.channel.onPacketAcked.remove(this.#bound_acked);
-        this.channel.onPacketLost.remove(this.#bound_lost);
-        this.#unacked.clear();
-        this.#received_seqs.clear();
-        this.#received_order.length = 0;
-    }
-
-    /** @private */
-    #transmit(logical_seq, payload) {
-        const buf = this.#send_scratch;
-        // Worst-case capacity: type byte + 10 bytes for varint + payload.
-        const needed = 1 + 10 + payload.length;
-        if (buf.raw_bytes.length < needed) buf.setCapacity(needed);
-        buf.position = 0;
-        buf.writeUint8(this.packet_type);
-        buf.writeUintVar(logical_seq);
-        buf.writeBytes(payload, 0, payload.length);
-        return this.channel.send(buf.raw_bytes, buf.position);
-    }
-
-    /** @private */
-    #on_packet_acked(channel_seq) {
-        this.#unacked.delete(channel_seq);
-    }
-
-    /** @private */
-    #on_packet_lost(channel_seq) {
-        const entry = this.#unacked.get(channel_seq);
-        if (entry === undefined) return;
-        this.#unacked.delete(channel_seq);
-
-        if (entry.retries >= this.max_retries) {
-            // Permanently black-holed peer or fundamentally broken path —
-            // surface the failure to the application and stop retrying.
-            this.onCommandAbandoned.send1(entry.logical_seq);
-            return;
-        }
-
-        // Retransmit on a fresh channel_seq. Same logical_seq, same payload.
-        entry.retries++;
-        const new_channel_seq = this.#transmit(entry.logical_seq, entry.payload);
-        this.#unacked.set(new_channel_seq, entry);
-    }
-}

package/src/engine/network/transport/fragments/FragmentAssembler.d.ts

@@ -1,105 +0,0 @@
-/**
- * Per-peer reassembly buffer for fragmented packets.
- *
- * When a sender's logical payload exceeds the MTU it gets split into
- * multiple {@link NetworkPacketType.FRAGMENT} packets, each carrying a
- * `(message_id, chunk_index, total_chunks, chunk_bytes)` tuple. The
- * receiver feeds those tuples to {@link receive}; once all chunks for a
- * `message_id` have arrived, `receive` returns the reassembled bytes
- * for the upper layer to dispatch.
- *
- * Loss recovery via NACK: a partially-received message that doesn't
- * complete within `nack_initial_delay_ms` triggers a NACK back to the
- * sender listing the missing chunk indices. NACK rounds repeat at
- * `nack_resend_interval_ms` up to `nack_max_rounds`; after that the
- * receiver gives up on the message and the sender's retention ages
- * out independently. Wire the per-tick driver via {@link service}.
- *
- * Loss-of-last-resort model: if even the NACK retries fail (link is
- * dead, sender retention was evicted, etc.) the message never
- * completes and FIFO-evicts when the pending cap is hit. Upper layers
- * are still expected to tolerate occasional missing messages — NACK
- * recovers most loss, not all.
- *
- * @author Alex Goldring
- * @copyright Company Named Limited (c) 2026
- */
-export class FragmentAssembler {
-    /**
-     * @param {{
-     *   max_pending_messages?: number,
-     *   max_message_size?: number,
-     *   nack_initial_delay_ms?: number,
-     *   nack_resend_interval_ms?: number,
-     *   nack_max_rounds?: number,
-     * }} [options]
-     *   `max_pending_messages` caps the number of in-flight reassembly
-     *   slots; when full, the oldest pending message is evicted to make
-     *   room. `max_message_size` rejects reassembled messages larger than
-     *   this many bytes (defensive against a malicious peer or a wedged
-     *   sender). The `nack_*` knobs control the retransmit-request timer
-     *   driven by {@link service}.
-     */
-    constructor({ max_pending_messages, max_message_size, nack_initial_delay_ms, nack_resend_interval_ms, nack_max_rounds, }?: {
-        max_pending_messages?: number;
-        max_message_size?: number;
-        nack_initial_delay_ms?: number;
-        nack_resend_interval_ms?: number;
-        nack_max_rounds?: number;
-    });
-    /** @type {number} @readonly */
-    readonly max_pending_messages: number;
-    /** @type {number} @readonly */
-    readonly max_message_size: number;
-    /** @type {number} @readonly */
-    readonly nack_initial_delay_ms: number;
-    /** @type {number} @readonly */
-    readonly nack_resend_interval_ms: number;
-    /** @type {number} @readonly */
-    readonly nack_max_rounds: number;
-    /**
-     * Process an incoming fragment. Returns the reassembled bytes when
-     * the message is complete, or null otherwise.
-     *
-     * @param {number} message_id     sender-assigned message id
-     * @param {number} chunk_index    0-based
-     * @param {number} total_chunks   expected number of chunks (>= 1)
-     * @param {Uint8Array} chunk_bytes  source byte array
-     * @param {number} chunk_offset   start offset within `chunk_bytes`
-     * @param {number} chunk_length   number of bytes from `chunk_offset` to consume
-     * @returns {Uint8Array|null}
-     */
-    receive(message_id: number, chunk_index: number, total_chunks: number, chunk_bytes: Uint8Array, chunk_offset: number, chunk_length: number): Uint8Array | null;
-    /**
-     * Per-tick maintenance: drive NACK emission for pending messages
-     * whose initial delay has elapsed and whose resend interval has
-     * lapsed, and drop messages whose NACK budget is exhausted.
-     *
-     * On the first service tick that observes a pending entry, its
-     * arrival is timestamped (so the initial delay is measured from
-     * `now_ms` of that tick rather than from the actual wall-clock
-     * arrival of the first chunk — at typical tick rates the difference
-     * is one tick, negligible vs. the 100 ms initial delay).
-     *
-     * `on_nack` is invoked once per eligible message with
-     * `(message_id, indices, count)`: the missing chunks in index order, but
-     * never more of them than the message has delivered. The `indices` argument is a
-     * reused internal Uint8Array; only `indices[0..count)` is valid
-     * and only for the duration of the call.
-     *
-     * @param {number} now_ms
-     * @param {function(number, Uint8Array, number): void} on_nack
-     */
-    service(now_ms: number, on_nack: (arg0: number, arg1: Uint8Array, arg2: number) => void): void;
-    /**
-     * Number of in-flight reassembly slots currently held.
-     * @returns {number}
-     */
-    pending_count(): number;
-    /**
-     * Drop all in-flight reassembly state. Useful on peer disconnect.
-     */
-    clear(): void;
-    #private;
-}
-//# sourceMappingURL=FragmentAssembler.d.ts.map

package/src/engine/network/transport/fragments/FragmentAssembler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FragmentAssembler.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/network/transport/fragments/FragmentAssembler.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH;IAmCI;;;;;;;;;;;;;;OAcG;IACH,2HAdW;QACV,oBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,gBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,qBAAyB,CAAC,EAAE,MAAM,CAAC;QACnC,uBAA2B,CAAC,EAAE,MAAM,CAAC;QACrC,eAAmB,CAAC,EAAE,MAAM,CAAC;KAC1B,EAwDH;IAnCG,+BAA+B;IAC/B,+BADW,MAAM,CAC+B;IAChD,+BAA+B;IAC/B,2BADW,MAAM,CACuB;IACxC,+BAA+B;IAC/B,gCADW,MAAM,CACiC;IAClD,+BAA+B;IAC/B,kCADW,MAAM,CACqC;IACtD,+BAA+B;IAC/B,0BADW,MAAM,CACqB;IA4B1C;;;;;;;;;;;OAWG;IACH,oBARW,MAAM,eACN,MAAM,gBACN,MAAM,eACN,UAAU,gBACV,MAAM,gBACN,MAAM,GACJ,UAAU,GAAC,IAAI,CAuF3B;IA0BD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAHW,MAAM,kBACG,MAAM,QAAE,UAAU,QAAE,MAAM,KAAG,IAAI,QA+CpD;IAED;;;OAGG;IACH,iBAFa,MAAM,CAIlB;IAED;;OAEG;IACH,cAMC;;CAQJ"}