@replit/river 0.23.3 → 0.23.4

package/dist/transport-4a5e288a.d.ts

@@ -0,0 +1,535 @@
+import { C as Codec } from './types-3e5768ec.js';
+import { a as TelemetryInfo, T as TransportClientId, b as PropagationContext, M as MessageMetadata, P as PartialTransportMessage, c as TransportMessage, O as OpaqueTransportMessage } from './index-926aea33.js';
+import { TSchema, Static } from '@sinclair/typebox';
+
+/**
+ * A connection is the actual raw underlying transport connection.
+ * It’s responsible for dispatching to/from the actual connection itself
+ * This should be instantiated as soon as the client/server has a connection
+ * It’s tied to the lifecycle of the underlying transport connection (i.e. if the WS drops, this connection should be deleted)
+ */
+declare abstract class Connection {
+    id: string;
+    telemetry?: TelemetryInfo;
+    constructor();
+    /**
+     * Handle adding a callback for when a message is received.
+     * @param msg The message that was received.
+     */
+    abstract addDataListener(cb: (msg: Uint8Array) => void): void;
+    abstract removeDataListener(cb: (msg: Uint8Array) => void): void;
+    /**
+     * Handle adding a callback for when the connection is closed.
+     * This should also be called if an error happens.
+     * @param cb The callback to call when the connection is closed.
+     */
+    abstract addCloseListener(cb: () => void): void;
+    /**
+     * Handle adding a callback for when an error is received.
+     * This should only be used for logging errors, all cleanup
+     * should be delegated to addCloseListener.
+     *
+     * The implementer should take care such that the implemented
+     * connection will call both the close and error callbacks
+     * on an error.
+     *
+     * @param cb The callback to call when an error is received.
+     */
+    abstract addErrorListener(cb: (err: Error) => void): void;
+    /**
+     * Sends a message over the connection.
+     * @param msg The message to send.
+     * @returns true if the message was sent, false otherwise.
+     */
+    abstract send(msg: Uint8Array): boolean;
+    /**
+     * Closes the connection.
+     */
+    abstract close(): void;
+}
+interface SessionOptions {
+    /**
+     * Frequency at which to send heartbeat acknowledgements
+     */
+    heartbeatIntervalMs: number;
+    /**
+     * Number of elapsed heartbeats without a response message before we consider
+     * the connection dead.
+     */
+    heartbeatsUntilDead: number;
+    /**
+     * Duration to wait between connection disconnect and actual session disconnect
+     */
+    sessionDisconnectGraceMs: number;
+    /**
+     * The codec to use for encoding/decoding messages over the wire
+     */
+    codec: Codec;
+}
+/**
+ * A session is a higher-level abstraction that operates over the span of potentially multiple transport-level connections
+ * - It’s responsible for tracking any metadata for a particular client that might need to be persisted across connections (i.e. the sendBuffer, ack, seq)
+ * - This will only be considered disconnected if
+ *    - the server tells the client that we’ve reconnected but it doesn’t recognize us anymore (server definitely died) or
+ *    - we hit a grace period after a connection disconnect
+ */
+declare class Session<ConnType extends Connection> {
+    private codec;
+    private options;
+    telemetry: TelemetryInfo;
+    /**
+     * The buffer of messages that have been sent but not yet acknowledged.
+     */
+    private sendBuffer;
+    /**
+     * The active connection associated with this session
+     */
+    connection?: ConnType;
+    readonly from: TransportClientId;
+    readonly to: TransportClientId;
+    /**
+     * The unique ID of this session.
+     */
+    id: string;
+    /**
+     * What the other side advertised as their session ID
+     * for this session.
+     */
+    advertisedSessionId?: string;
+    /**
+     * Number of messages we've sent along this session (excluding handshake and acks)
+     */
+    private seq;
+    /**
+     * Number of unique messages we've received this session (excluding handshake and acks)
+     */
+    private ack;
+    /**
+     * The grace period between when the inner connection is disconnected
+     * and when we should consider the entire session disconnected.
+     */
+    private disconnectionGrace?;
+    /**
+     * Number of heartbeats we've sent without a response.
+     */
+    private heartbeatMisses;
+    /**
+     * The interval for sending heartbeats.
+     */
+    private heartbeat;
+    constructor(conn: ConnType | undefined, from: TransportClientId, to: TransportClientId, options: SessionOptions, propagationCtx?: PropagationContext);
+    get loggingMetadata(): Omit<MessageMetadata, 'parsedMsg'>;
+    /**
+     * Sends a message over the session's connection.
+     * If the connection is not ready or the message fails to send, the message can be buffered for retry unless skipped.
+     *
+     * @param msg The partial message to be sent, which will be constructed into a full message.
+     * @param addToSendBuff Whether to add the message to the send buffer for retry.
+     * @returns The full transport ID of the message that was attempted to be sent.
+     */
+    send(msg: PartialTransportMessage): string;
+    sendHeartbeat(): void;
+    resetBufferedMessages(): void;
+    sendBufferedMessages(conn: ConnType): void;
+    updateBookkeeping(ack: number, seq: number): void;
+    closeStaleConnection(conn?: ConnType): void;
+    replaceWithNewConnection(newConn: ConnType): void;
+    beginGrace(cb: () => void): void;
+    cancelGrace(): void;
+    close(): void;
+    get connected(): boolean;
+    get nextExpectedSeq(): number;
+    constructMsg<Payload>(partialMsg: PartialTransportMessage<Payload>): TransportMessage<Payload>;
+    inspectSendBuffer(): ReadonlyArray<OpaqueTransportMessage>;
+}
+
+type ConnectionStatus = 'connect' | 'disconnect';
+declare const ProtocolError: {
+    readonly RetriesExceeded: "conn_retry_exceeded";
+    readonly HandshakeFailed: "handshake_failed";
+    readonly UseAfterDestroy: "use_after_destroy";
+    readonly MessageOrderingViolated: "message_ordering_violated";
+};
+type ProtocolErrorType = (typeof ProtocolError)[keyof typeof ProtocolError];
+interface EventMap {
+    message: OpaqueTransportMessage;
+    connectionStatus: {
+        status: ConnectionStatus;
+        conn: Connection;
+    };
+    sessionStatus: {
+        status: ConnectionStatus;
+        session: Session<Connection>;
+    };
+    protocolError: {
+        type: ProtocolErrorType;
+        message: string;
+    };
+}
+type EventTypes = keyof EventMap;
+type EventHandler<K extends EventTypes> = (event: EventMap[K]) => unknown;
+declare class EventDispatcher<T extends EventTypes> {
+    private eventListeners;
+    numberOfListeners<K extends T>(eventType: K): number;
+    addEventListener<K extends T>(eventType: K, handler: EventHandler<K>): void;
+    removeEventListener<K extends T>(eventType: K, handler: EventHandler<K>): void;
+    dispatchEvent<K extends T>(eventType: K, event: EventMap[K]): void;
+}
+
+/**
+ * Options to control the backoff and retry behavior of the client transport's connection behaviour.
+ *
+ * River implements exponential backoff with jitter to prevent flooding the server
+ * when there's an issue with connection establishment.
+ *
+ * The backoff is calculated via the following:
+ *   backOff = min(jitter + {@link baseIntervalMs} * 2 ^ budget_consumed, {@link maxBackoffMs})
+ *
+ * We use a leaky bucket rate limit with a budget of {@link attemptBudgetCapacity} reconnection attempts.
+ * Budget only starts to restore after a successful handshake at a rate of one budget per {@link budgetRestoreIntervalMs}.
+ */
+interface ConnectionRetryOptions {
+    /**
+     * The base interval to wait before retrying a connection.
+     */
+    baseIntervalMs: number;
+    /**
+     * The maximum random jitter to add to the total backoff time.
+     */
+    maxJitterMs: number;
+    /**
+     * The maximum amount of time to wait before retrying a connection.
+     * This does not include the jitter.
+     */
+    maxBackoffMs: number;
+    /**
+     * The max number of times to attempt a connection before a successful handshake.
+     * This persists across connections but starts restoring budget after a successful handshake.
+     * The restoration interval depends on {@link budgetRestoreIntervalMs}
+     */
+    attemptBudgetCapacity: number;
+    /**
+     * After a successful connection attempt, how long to wait before we restore a single budget.
+     */
+    budgetRestoreIntervalMs: number;
+}
+declare class LeakyBucketRateLimit {
+    private budgetConsumed;
+    private intervalHandles;
+    private readonly options;
+    constructor(options: ConnectionRetryOptions);
+    getBackoffMs(user: TransportClientId): number;
+    get totalBudgetRestoreTime(): number;
+    consumeBudget(user: TransportClientId): void;
+    getBudgetConsumed(user: TransportClientId): number;
+    hasBudget(user: TransportClientId): boolean;
+    startRestoringBudget(user: TransportClientId): void;
+    private stopLeak;
+    close(): void;
+}
+
+/**
+ * The context for services/procedures. This is used only on
+ * the server.
+ *
+ * An important detail is that the state prop is always on
+ * this interface and it shouldn't be changed, removed, or
+ * extended. This prop is for the state of a service.
+ *
+ * You should use declaration merging to extend this interface
+ * with whatever you need. For example, if you need to access
+ * a database, you could do:
+ *
+ * ```ts
+ * declare module '@replit/river' {
+ *   interface ServiceContext {
+ *     db: Database;
+ *   }
+ * }
+ * ```
+ */
+interface ServiceContext {
+}
+/**
+ * The parsed metadata schema for a service. This is the
+ * return value of the {@link ServerHandshakeOptions.validate}
+ * if the handshake extension is used.
+
+ * You should use declaration merging to extend this interface
+ * with the sanitized metadata.
+ *
+ * ```ts
+ * declare module '@replit/river' {
+ *   interface ParsedMetadata {
+ *     userId: number;
+ *   }
+ * }
+ * ```
+ */
+interface ParsedMetadata {
+}
+/**
+ * The {@link ServiceContext} with state. This is what is passed to procedures.
+ */
+type ServiceContextWithState<State> = ServiceContext & {
+    state: State;
+};
+type ServiceContextWithTransportInfo<State> = ServiceContext & {
+    state: Omit<State, typeof Symbol.dispose>;
+    to: TransportClientId;
+    from: TransportClientId;
+    streamId: string;
+    session: Session<Connection>;
+    metadata: ParsedMetadata;
+};
+
+type ConstructHandshake<T extends TSchema> = () => Static<T> | Promise<Static<T>>;
+type ValidateHandshake<T extends TSchema> = (metadata: Static<T>, previousParsedMetadata?: ParsedMetadata) => false | ParsedMetadata | Promise<false | ParsedMetadata>;
+interface ClientHandshakeOptions<MetadataSchema extends TSchema = TSchema> {
+    /**
+     * Schema for the metadata that the client sends to the server
+     * during the handshake.
+     */
+    schema: MetadataSchema;
+    /**
+     * Gets the {@link HandshakeRequestMetadata} to send to the server.
+     */
+    construct: ConstructHandshake<MetadataSchema>;
+}
+interface ServerHandshakeOptions<MetadataSchema extends TSchema = TSchema> {
+    /**
+     * Schema for the metadata that the server receives from the client
+     * during the handshake.
+     */
+    schema: MetadataSchema;
+    /**
+     * Parses the {@link HandshakeRequestMetadata} sent by the client, transforming
+     * it into {@link ParsedHandshakeMetadata}.
+     *
+     * May return `false` if the client should be rejected.
+     *
+     * @param metadata - The metadata sent by the client.
+     * @param session - The session that the client would be associated with.
+     * @param isReconnect - Whether the client is reconnecting to the session,
+     *                      or if this is a new session.
+     */
+    validate: ValidateHandshake<MetadataSchema>;
+}
+
+/**
+ * Represents the possible states of a transport.
+ * @property {'open'} open - The transport is open and operational (note that this doesn't mean it is actively connected)
+ * @property {'closed'} closed - The transport is closed and not operational, but can be reopened.
+ * @property {'destroyed'} destroyed - The transport is permanently destroyed and cannot be reopened.
+ */
+type TransportStatus = 'open' | 'closed' | 'destroyed';
+type TransportOptions = SessionOptions;
+type ProvidedTransportOptions = Partial<TransportOptions>;
+type ClientTransportOptions = TransportOptions & ConnectionRetryOptions;
+type ProvidedClientTransportOptions = Partial<ClientTransportOptions>;
+type ServerTransportOptions = TransportOptions;
+type ProvidedServerTransportOptions = Partial<ServerTransportOptions>;
+/**
+ * Transports manage the lifecycle (creation/deletion) of sessions and connections. Its responsibilities include:
+ *
+ *  1) Constructing a new {@link Session} and {@link Connection} on {@link TransportMessage}s from new clients.
+ *     After constructing the {@link Connection}, {@link onConnect} is called which adds it to the connection map.
+ *  2) Delegating message listening of the connection to the newly created {@link Connection}.
+ *     From this point on, the {@link Connection} is responsible for *reading* and *writing*
+ *     messages from the connection.
+ *  3) When a connection is closed, the {@link Transport} calls {@link onDisconnect} which closes the
+ *     connection via {@link Connection.close} and removes it from the {@link connections} map.
+
+ *
+ * ```plaintext
+ *            ▲
+ *  incoming  │
+ *  messages  │
+ *            ▼
+ *      ┌─────────────┐   1:N   ┌───────────┐   1:1*  ┌────────────┐
+ *      │  Transport  │ ◄─────► │  Session  │ ◄─────► │ Connection │
+ *      └─────────────┘         └───────────┘         └────────────┘
+ *            ▲                               * (may or may not be initialized yet)
+ *            │
+ *            ▼
+ *      ┌───────────┐
+ *      │ Message   │
+ *      │ Listeners │
+ *      └───────────┘
+ * ```
+ * @abstract
+ */
+declare abstract class Transport<ConnType extends Connection> {
+    /**
+     * A flag indicating whether the transport has been destroyed.
+     * A destroyed transport will not attempt to reconnect and cannot be used again.
+     */
+    state: TransportStatus;
+    /**
+     * The {@link Codec} used to encode and decode messages.
+     */
+    codec: Codec;
+    /**
+     * The client ID of this transport.
+     */
+    clientId: TransportClientId;
+    /**
+     * The map of {@link Session}s managed by this transport.
+     */
+    sessions: Map<TransportClientId, Session<ConnType>>;
+    /**
+     * The map of {@link Connection}s managed by this transport.
+     */
+    get connections(): Map<string, ConnType>;
+    /**
+     * The event dispatcher for handling events of type EventTypes.
+     */
+    eventDispatcher: EventDispatcher<EventTypes>;
+    /**
+     * The options for this transport.
+     */
+    protected options: TransportOptions;
+    /**
+     * Creates a new Transport instance.
+     * This should also set up {@link onConnect}, and {@link onDisconnect} listeners.
+     * @param codec The codec used to encode and decode messages.
+     * @param clientId The client ID of this transport.
+     */
+    constructor(clientId: TransportClientId, providedOptions?: ProvidedTransportOptions);
+    /**
+     * This is called immediately after a new connection is established and we
+     * may or may not know the identity of the connected client.
+     * It should attach all the necessary listeners to the connection for lifecycle
+     * events (i.e. data, close, error)
+     *
+     * This method is implemented by {@link ClientTransport} and {@link ServerTransport}.
+     */
+    protected abstract handleConnection(conn: ConnType, to: TransportClientId): void;
+    /**
+     * Called when a new connection is established
+     * and we know the identity of the connected client.
+     * @param conn The connection object.
+     */
+    protected onConnect(conn: ConnType, connectedTo: TransportClientId, session: Session<ConnType>, isReconnect: boolean): void;
+    protected createSession(to: TransportClientId, conn?: ConnType, propagationCtx?: PropagationContext): Session<ConnType>;
+    protected getOrCreateSession(to: TransportClientId, conn?: ConnType, sessionId?: string, propagationCtx?: PropagationContext): {
+        session: Session<ConnType>;
+        isReconnect: boolean;
+    };
+    protected deleteSession(session: Session<ConnType>): void;
+    /**
+     * The downstream implementation needs to call this when a connection is closed.
+     * @param conn The connection object.
+     * @param connectedTo The peer we are connected to.
+     */
+    protected onDisconnect(conn: ConnType, session: Session<ConnType>): void;
+    /**
+     * Parses a message from a Uint8Array into a {@link OpaqueTransportMessage}.
+     * @param msg The message to parse.
+     * @returns The parsed message, or null if the message is malformed or invalid.
+     */
+    protected parseMsg(msg: Uint8Array): OpaqueTransportMessage | null;
+    /**
+     * Called when a message is received by this transport.
+     * You generally shouldn't need to override this in downstream transport implementations.
+     * @param msg The received message.
+     */
+    protected handleMsg(msg: OpaqueTransportMessage): void;
+    /**
+     * Adds a listener to this transport.
+     * @param the type of event to listen for
+     * @param handler The message handler to add.
+     */
+    addEventListener<K extends EventTypes, T extends EventHandler<K>>(type: K, handler: T): void;
+    /**
+     * Removes a listener from this transport.
+     * @param the type of event to un-listen on
+     * @param handler The message handler to remove.
+     */
+    removeEventListener<K extends EventTypes, T extends EventHandler<K>>(type: K, handler: T): void;
+    /**
+     * Sends a message over this transport, delegating to the appropriate connection to actually
+     * send the message.
+     * @param msg The message to send.
+     * @returns The ID of the sent message or undefined if it wasn't sent
+     */
+    send(to: TransportClientId, msg: PartialTransportMessage): string | undefined;
+    sendCloseStream(to: TransportClientId, streamId: string): string | undefined;
+    protected protocolError(type: ProtocolErrorType, message: string): void;
+    /**
+     * Default close implementation for transports. You should override this in the downstream
+     * implementation if you need to do any additional cleanup and call super.close() at the end.
+     * Closes the transport. Any messages sent while the transport is closed will be silently discarded.
+     */
+    close(): void;
+    /**
+     * Default destroy implementation for transports. You should override this in the downstream
+     * implementation if you need to do any additional cleanup and call super.destroy() at the end.
+     * Destroys the transport. Any messages sent while the transport is destroyed will throw an error.
+     */
+    destroy(): void;
+}
+declare abstract class ClientTransport<ConnType extends Connection> extends Transport<ConnType> {
+    /**
+     * The options for this transport.
+     */
+    protected options: ClientTransportOptions;
+    /**
+     * The map of reconnect promises for each client ID.
+     */
+    inflightConnectionPromises: Map<TransportClientId, Promise<ConnType>>;
+    retryBudget: LeakyBucketRateLimit;
+    /**
+     * A flag indicating whether the transport should automatically reconnect
+     * when a connection is dropped.
+     * Realistically, this should always be true for clients unless you are writing
+     * tests or a special case where you don't want to reconnect.
+     */
+    reconnectOnConnectionDrop: boolean;
+    /**
+     * Optional handshake options for this client.
+     */
+    handshakeExtensions?: ClientHandshakeOptions;
+    constructor(clientId: TransportClientId, providedOptions?: ProvidedClientTransportOptions);
+    extendHandshake(options: ClientHandshakeOptions): void;
+    protected handleConnection(conn: ConnType, to: TransportClientId): void;
+    receiveHandshakeResponseMessage(data: Uint8Array, conn: ConnType): Session<ConnType> | false;
+    /**
+     * Abstract method that creates a new {@link Connection} object.
+     * This should call {@link handleConnection} when the connection is created.
+     * The downstream client implementation needs to implement this.
+     *
+     * @param to The client ID of the node to connect to.
+     * @returns The new connection object.
+     */
+    protected abstract createNewOutgoingConnection(to: TransportClientId): Promise<ConnType>;
+    /**
+     * Manually attempts to connect to a client.
+     * @param to The client ID of the node to connect to.
+     */
+    connect(to: TransportClientId): Promise<void>;
+    protected deleteSession(session: Session<ConnType>): void;
+    protected sendHandshake(to: TransportClientId, conn: ConnType): Promise<boolean>;
+    close(): void;
+}
+declare abstract class ServerTransport<ConnType extends Connection> extends Transport<ConnType> {
+    /**
+     * The options for this transport.
+     */
+    protected options: ServerTransportOptions;
+    /**
+     * Optional handshake options for the server.
+     */
+    handshakeExtensions?: ServerHandshakeOptions;
+    /**
+     * A map of session handshake data for each session.
+     */
+    sessionHandshakeMetadata: WeakMap<Session<ConnType>, ParsedMetadata>;
+    constructor(clientId: TransportClientId, providedOptions?: ProvidedServerTransportOptions);
+    extendHandshake(options: ServerHandshakeOptions): void;
+    protected handleConnection(conn: ConnType): void;
+    private validateHandshakeMetadata;
+    receiveHandshakeRequestMessage(data: Uint8Array, conn: ConnType): Promise<Session<ConnType> | false>;
+}
+
+export { Connection as C, EventMap as E, ProvidedClientTransportOptions as P, SessionOptions as S, Transport as T, ServiceContext as a, Session as b, ClientTransport as c, ServerTransport as d, ProvidedServerTransportOptions as e, ServerHandshakeOptions as f, ParsedMetadata as g, ServiceContextWithState as h, ServiceContextWithTransportInfo as i, ClientHandshakeOptions as j, ProvidedTransportOptions as k, TransportStatus as l, EventTypes as m, EventHandler as n, ProtocolError as o, ProtocolErrorType as p };

package/dist/util/testHelpers.cjs

@@ -355,7 +355,7 @@ var log = void 0;
 var import_api = require("@opentelemetry/api");
 
 // package.json
-var version = "0.23.3";
+var version = "0.23.4";
 
 // tracing/index.ts
 function createSessionTelemetryInfo(session, propagationCtx) {