@replit/river 0.208.4 → 0.209.0

package/dist/transport-CxjUaGhi.d.cts

@@ -0,0 +1,577 @@
+import { TSchema, Static } from '@sinclair/typebox';
+import { f as TelemetryInfo, c as TransportClientId, P as ProtocolVersion, b as OpaqueTransportMessage, e as PartialTransportMessage, a as TransportMessage, g as HandshakeErrorCustomHandlerFatalResponseCodes, H as HandshakeErrorResponseCodes } from './message-Dlsh5WDF.cjs';
+import { M as MessageMetadata, L as Logger, T as Tags, a as LogFn, b as LoggingLevel } from './index-D9R6UTMl.cjs';
+import { C as Codec, a as CodecMessageAdapter, S as SendResult, b as SendBufferResult } from './adapter-DjiEwOYi.cjs';
+import { Tracer } from '@opentelemetry/api';
+
+/**
+ * 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();
+    get loggingMetadata(): MessageMetadata;
+    dataListener?: (msg: Uint8Array) => void;
+    closeListener?: () => void;
+    errorListener?: (err: Error) => void;
+    onData(msg: Uint8Array): void;
+    onError(err: Error): void;
+    onClose(): void;
+    /**
+     * Set the callback for when a message is received.
+     * @param cb The message handler callback.
+     */
+    setDataListener(cb: (msg: Uint8Array) => void): void;
+    removeDataListener(): void;
+    /**
+     * Set the callback for when the connection is closed.
+     * This should also be called if an error happens and after notifying the error listener.
+     * @param cb The callback to call when the connection is closed.
+     */
+    setCloseListener(cb: () => void): void;
+    removeCloseListener(): void;
+    /**
+     * Set the callback for when an error is received.
+     * This should only be used for logging errors, all cleanup
+     * should be delegated to setCloseListener.
+     *
+     * 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.
+     */
+    setErrorListener(cb: (err: Error) => void): void;
+    removeErrorListener(): 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;
+}
+
+declare const enum SessionState {
+    NoConnection = "NoConnection",
+    BackingOff = "BackingOff",
+    Connecting = "Connecting",
+    Handshaking = "Handshaking",
+    Connected = "Connected",
+    WaitingForHandshake = "WaitingForHandshake"
+}
+declare abstract class StateMachineState {
+    abstract readonly state: SessionState;
+    _isConsumed: boolean;
+    abstract _handleStateExit(): void;
+    abstract _handleClose(): void;
+    /**
+     * Cleanup this state machine state and mark it as consumed.
+     * After calling close, it is an error to access any properties on the state.
+     * You should never need to call this as a consumer.
+     *
+     * If you're looking to close the session from the client,
+     * use `.hardDisconnect` on the client transport.
+     */
+    close(): void;
+    constructor();
+}
+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;
+    /**
+     * Max duration that a session can be without a connection before we consider
+     * it dead. This deadline is carried between states and is used to determine
+     * when to consider the session a lost cause and delete it entirely.
+     * Generally, this should be strictly greater than the sum of
+     * {@link connectionTimeoutMs} and {@link handshakeTimeoutMs}.
+     */
+    sessionDisconnectGraceMs: number;
+    /**
+     * Connection timeout in milliseconds
+     */
+    connectionTimeoutMs: number;
+    /**
+     * Handshake timeout in milliseconds
+     */
+    handshakeTimeoutMs: number;
+    /**
+     * Whether to enable transparent session reconnects
+     */
+    enableTransparentSessionReconnects: boolean;
+    /**
+     * The codec to use for encoding/decoding messages over the wire
+     */
+    codec: Codec;
+}
+interface CommonSessionProps {
+    from: TransportClientId;
+    options: SessionOptions;
+    codec: CodecMessageAdapter;
+    tracer: Tracer;
+    log: Logger | undefined;
+}
+declare abstract class CommonSession extends StateMachineState {
+    readonly from: TransportClientId;
+    readonly options: SessionOptions;
+    readonly codec: CodecMessageAdapter;
+    tracer: Tracer;
+    log?: Logger;
+    abstract get loggingMetadata(): MessageMetadata;
+    constructor({ from, options, log, tracer, codec }: CommonSessionProps);
+}
+type SessionId = string;
+interface IdentifiedSessionProps extends CommonSessionProps {
+    id: SessionId;
+    to: TransportClientId;
+    seq: number;
+    ack: number;
+    seqSent: number;
+    sendBuffer: Array<OpaqueTransportMessage>;
+    telemetry: TelemetryInfo;
+    protocolVersion: ProtocolVersion;
+}
+declare abstract class IdentifiedSession extends CommonSession {
+    readonly id: SessionId;
+    readonly telemetry: TelemetryInfo;
+    readonly to: TransportClientId;
+    readonly protocolVersion: ProtocolVersion;
+    /**
+     * Index of the message we will send next (excluding handshake)
+     */
+    seq: number;
+    /**
+     * Last seq we sent over the wire this session (excluding handshake) and retransmissions
+     */
+    seqSent: number;
+    /**
+     * Number of unique messages we've received this session (excluding handshake)
+     */
+    ack: number;
+    sendBuffer: Array<OpaqueTransportMessage>;
+    constructor(props: IdentifiedSessionProps);
+    get loggingMetadata(): MessageMetadata;
+    constructMsg<Payload>(partialMsg: PartialTransportMessage<Payload>): TransportMessage<Payload>;
+    nextSeq(): number;
+    send(msg: PartialTransportMessage): SendResult;
+    _handleStateExit(): void;
+    _handleClose(): void;
+}
+interface IdentifiedSessionWithGracePeriodListeners {
+    onSessionGracePeriodElapsed: () => void;
+}
+interface IdentifiedSessionWithGracePeriodProps extends IdentifiedSessionProps {
+    graceExpiryTime: number;
+    listeners: IdentifiedSessionWithGracePeriodListeners;
+}
+declare abstract class IdentifiedSessionWithGracePeriod extends IdentifiedSession {
+    graceExpiryTime: number;
+    protected gracePeriodTimeout?: ReturnType<typeof setTimeout>;
+    listeners: IdentifiedSessionWithGracePeriodListeners;
+    constructor(props: IdentifiedSessionWithGracePeriodProps);
+    _handleStateExit(): void;
+    _handleClose(): void;
+}
+
+type ConstructHandshake<T extends TSchema> = () => Static<T> | Promise<Static<T>>;
+type ValidateHandshake<T extends TSchema, ParsedMetadata> = (metadata: Static<T>, previousParsedMetadata?: ParsedMetadata) => Static<typeof HandshakeErrorCustomHandlerFatalResponseCodes> | ParsedMetadata | Promise<Static<typeof HandshakeErrorCustomHandlerFatalResponseCodes> | 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, ParsedMetadata extends object = object> {
+    /**
+     * 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, ParsedMetadata>;
+}
+declare function createClientHandshakeOptions<MetadataSchema extends TSchema = TSchema>(schema: MetadataSchema, construct: ConstructHandshake<MetadataSchema>): ClientHandshakeOptions;
+declare function createServerHandshakeOptions<MetadataSchema extends TSchema = TSchema, ParsedMetadata extends object = object>(schema: MetadataSchema, validate: ValidateHandshake<MetadataSchema, ParsedMetadata>): ServerHandshakeOptions<MetadataSchema, ParsedMetadata>;
+
+/**
+ * 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 intervalHandle?;
+    private readonly options;
+    constructor(options: ConnectionRetryOptions);
+    getBackoffMs(): number;
+    get totalBudgetRestoreTime(): number;
+    consumeBudget(): void;
+    getBudgetConsumed(): number;
+    hasBudget(): boolean;
+    startRestoringBudget(): void;
+    private stopLeak;
+    close(): void;
+}
+
+type TransportOptions = SessionOptions;
+type ProvidedTransportOptions = Partial<TransportOptions>;
+type ClientTransportOptions = TransportOptions & ConnectionRetryOptions;
+type ProvidedClientTransportOptions = Partial<ClientTransportOptions>;
+type ServerTransportOptions = TransportOptions;
+type ProvidedServerTransportOptions = Partial<ServerTransportOptions>;
+
+interface SessionConnectingListeners extends IdentifiedSessionWithGracePeriodListeners {
+    onConnectionEstablished: (conn: Connection) => void;
+    onConnectionFailed: (err: unknown) => void;
+    onConnectionTimeout: () => void;
+}
+interface SessionConnectingProps<ConnType extends Connection> extends IdentifiedSessionWithGracePeriodProps {
+    connPromise: Promise<ConnType>;
+    listeners: SessionConnectingListeners;
+}
+declare class SessionConnecting<ConnType extends Connection> extends IdentifiedSessionWithGracePeriod {
+    readonly state: SessionState.Connecting;
+    connPromise: Promise<ConnType>;
+    listeners: SessionConnectingListeners;
+    connectionTimeout?: ReturnType<typeof setTimeout>;
+    constructor(props: SessionConnectingProps<ConnType>);
+    bestEffortClose(): void;
+    _handleStateExit(): void;
+    _handleClose(): void;
+}
+
+interface SessionHandshakingListeners extends IdentifiedSessionWithGracePeriodListeners {
+    onConnectionErrored: (err: unknown) => void;
+    onConnectionClosed: () => void;
+    onHandshake: (msg: OpaqueTransportMessage) => void;
+    onInvalidHandshake: (reason: string, code: Static<typeof HandshakeErrorResponseCodes>) => void;
+    onHandshakeTimeout: () => void;
+}
+interface SessionHandshakingProps<ConnType extends Connection> extends IdentifiedSessionWithGracePeriodProps {
+    conn: ConnType;
+    listeners: SessionHandshakingListeners;
+}
+declare class SessionHandshaking<ConnType extends Connection> extends IdentifiedSessionWithGracePeriod {
+    readonly state: SessionState.Handshaking;
+    conn: ConnType;
+    listeners: SessionHandshakingListeners;
+    handshakeTimeout?: ReturnType<typeof setTimeout>;
+    constructor(props: SessionHandshakingProps<ConnType>);
+    get loggingMetadata(): {
+        protocolVersion?: ProtocolVersion | undefined;
+        clientId?: string | undefined;
+        connectedTo?: string | undefined;
+        sessionId?: string | undefined;
+        connId?: string | undefined;
+        transportMessage?: Partial<OpaqueTransportMessage> | undefined;
+        validationErrors?: {
+            path: string;
+            message: string;
+        }[] | undefined;
+        tags?: Tags[] | undefined;
+        telemetry?: {
+            traceId: string;
+            spanId: string;
+        } | undefined;
+        extras?: Record<string, unknown> | undefined;
+    };
+    onHandshakeData: (msg: Uint8Array) => void;
+    sendHandshake(msg: TransportMessage): SendResult;
+    _handleStateExit(): void;
+    _handleClose(): void;
+}
+
+interface SessionConnectedListeners {
+    onConnectionErrored: (err: unknown) => void;
+    onConnectionClosed: () => void;
+    onMessage: (msg: OpaqueTransportMessage) => void;
+    onMessageSendFailure: (msg: PartialTransportMessage, reason: string) => void;
+    onInvalidMessage: (reason: string) => void;
+}
+interface SessionConnectedProps<ConnType extends Connection> extends IdentifiedSessionProps {
+    conn: ConnType;
+    listeners: SessionConnectedListeners;
+}
+declare class SessionConnected<ConnType extends Connection> extends IdentifiedSession {
+    readonly state: SessionState.Connected;
+    conn: ConnType;
+    listeners: SessionConnectedListeners;
+    private heartbeatHandle?;
+    private heartbeatMissTimeout?;
+    private isActivelyHeartbeating;
+    updateBookkeeping(ack: number, seq: number): void;
+    private assertSendOrdering;
+    send(msg: PartialTransportMessage): SendResult;
+    constructor(props: SessionConnectedProps<ConnType>);
+    sendBufferedMessages(): SendBufferResult;
+    get loggingMetadata(): {
+        protocolVersion?: ProtocolVersion | undefined;
+        clientId?: string | undefined;
+        connectedTo?: string | undefined;
+        sessionId?: string | undefined;
+        connId?: string | undefined;
+        transportMessage?: Partial<OpaqueTransportMessage> | undefined;
+        validationErrors?: {
+            path: string;
+            message: string;
+        }[] | undefined;
+        tags?: Tags[] | undefined;
+        telemetry?: {
+            traceId: string;
+            spanId: string;
+        } | undefined;
+        extras?: Record<string, unknown> | undefined;
+    };
+    startMissingHeartbeatTimeout(): void;
+    startActiveHeartbeat(): void;
+    private sendHeartbeat;
+    onMessageData: (msg: Uint8Array) => void;
+    _handleStateExit(): void;
+    _handleClose(): void;
+}
+
+declare class SessionNoConnection extends IdentifiedSessionWithGracePeriod {
+    readonly state: SessionState.NoConnection;
+    _handleClose(): void;
+    _handleStateExit(): void;
+}
+
+interface SessionBackingOffListeners extends IdentifiedSessionWithGracePeriodListeners {
+    onBackoffFinished: () => void;
+}
+interface SessionBackingOffProps extends IdentifiedSessionWithGracePeriodProps {
+    backoffMs: number;
+    listeners: SessionBackingOffListeners;
+}
+declare class SessionBackingOff extends IdentifiedSessionWithGracePeriod {
+    readonly state: SessionState.BackingOff;
+    listeners: SessionBackingOffListeners;
+    backoffTimeout?: ReturnType<typeof setTimeout>;
+    constructor(props: SessionBackingOffProps);
+    _handleClose(): void;
+    _handleStateExit(): void;
+}
+
+type ClientSession<ConnType extends Connection> = SessionNoConnection | SessionBackingOff | SessionConnecting<ConnType> | SessionHandshaking<ConnType> | SessionConnected<ConnType>;
+type ServerSession<ConnType extends Connection> = SessionConnected<ConnType> | SessionNoConnection;
+type Session<ConnType extends Connection> = ClientSession<ConnType> | ServerSession<ConnType>;
+
+declare const ProtocolError: {
+    readonly RetriesExceeded: "conn_retry_exceeded";
+    readonly HandshakeFailed: "handshake_failed";
+    readonly MessageOrderingViolated: "message_ordering_violated";
+    readonly InvalidMessage: "invalid_message";
+    readonly MessageSendFailure: "message_send_failure";
+};
+type ProtocolErrorType = (typeof ProtocolError)[keyof typeof ProtocolError];
+interface EventMap {
+    message: OpaqueTransportMessage;
+    sessionStatus: {
+        status: 'created' | 'closing';
+        session: Session<Connection>;
+    } | {
+        status: 'closed';
+        session: Pick<Session<Connection>, 'id' | 'to'>;
+    };
+    sessionTransition: {
+        state: SessionState.Connected;
+        id: SessionId;
+    } | {
+        state: SessionState.Handshaking;
+        id: SessionId;
+    } | {
+        state: SessionState.Connecting;
+        id: SessionId;
+    } | {
+        state: SessionState.BackingOff;
+        id: SessionId;
+    } | {
+        state: SessionState.NoConnection;
+        id: SessionId;
+    };
+    protocolError: {
+        type: (typeof ProtocolError)['HandshakeFailed'];
+        code: Static<typeof HandshakeErrorResponseCodes>;
+        message: string;
+    } | {
+        type: Omit<ProtocolErrorType, (typeof ProtocolError)['HandshakeFailed']>;
+        message: string;
+    };
+    transportStatus: {
+        status: TransportStatus;
+    };
+}
+type EventTypes = keyof EventMap;
+type EventHandler<K extends EventTypes> = (event: EventMap[K]) => unknown;
+declare class EventDispatcher<T extends EventTypes> {
+    private eventListeners;
+    removeAllListeners(): void;
+    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;
+}
+
+/**
+ * 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 permanently closed and cannot be reopened.
+ */
+type TransportStatus = 'open' | 'closed';
+interface DeleteSessionOptions {
+    unhealthy: boolean;
+}
+type SessionBoundSendFn = (msg: PartialTransportMessage) => string;
+/**
+ * Transports manage the lifecycle (creation/deletion) of sessions
+ *
+ * ```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> {
+    /**
+     * The status of the transport.
+     */
+    private status;
+    /**
+     * The client ID of this transport.
+     */
+    clientId: TransportClientId;
+    /**
+     * The event dispatcher for handling events of type EventTypes.
+     */
+    eventDispatcher: EventDispatcher<EventTypes>;
+    /**
+     * The options for this transport.
+     */
+    protected options: TransportOptions;
+    log?: Logger;
+    tracer: Tracer;
+    sessions: Map<TransportClientId, Session<ConnType>>;
+    /**
+     * Creates a new Transport instance.
+     * @param codec The codec used to encode and decode messages.
+     * @param clientId The client ID of this transport.
+     */
+    constructor(clientId: TransportClientId, providedOptions?: ProvidedTransportOptions);
+    bindLogger(fn: LogFn | Logger, level?: LoggingLevel): void;
+    /**
+     * Called when a message is received by this transport.
+     * You generally shouldn't need to override this in downstream transport implementations.
+     * @param message The received message.
+     */
+    protected handleMsg(message: 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;
+    protected protocolError(message: EventMap['protocolError']): 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;
+    getStatus(): TransportStatus;
+    protected createSession<S extends Session<ConnType>>(session: S): void;
+    protected updateSession<S extends Session<ConnType>>(session: S): void;
+    protected deleteSession(session: Session<ConnType>, options?: DeleteSessionOptions): void;
+    protected onSessionGracePeriodElapsed(session: Session<ConnType>): void;
+    protected onConnectingFailed(session: SessionConnecting<ConnType>): SessionNoConnection;
+    protected onConnClosed(session: SessionHandshaking<ConnType> | SessionConnected<ConnType>): SessionNoConnection;
+    /**
+     * Gets a send closure scoped to a specific session. Sending using the returned
+     * closure after the session has transitioned to a different state will be a noop.
+     *
+     * Session objects themselves can become stale as they transition between
+     * states. As stale sessions cannot be used again (and will throw), holding
+     * onto a session object is not recommended.
+     */
+    getSessionBoundSendFn(to: TransportClientId, sessionId: SessionId): SessionBoundSendFn;
+}
+
+export { Connection as C, type DeleteSessionOptions as D, type EventMap as E, LeakyBucketRateLimit as L, type ProvidedTransportOptions as P, type Session as S, Transport as T, type TransportStatus as a, type ProvidedClientTransportOptions as b, type ProvidedServerTransportOptions as c, SessionState as d, SessionNoConnection as e, SessionConnecting as f, SessionHandshaking as g, SessionConnected as h, type EventTypes as i, type EventHandler as j, ProtocolError as k, type ProtocolErrorType as l, type ClientTransportOptions as m, type ClientHandshakeOptions as n, type ClientSession as o, SessionBackingOff as p, type ServerHandshakeOptions as q, createClientHandshakeOptions as r, createServerHandshakeOptions as s, CommonSession as t, type CommonSessionProps as u, type ServerTransportOptions as v, type ServerSession as w, type SessionOptions as x, type SessionBoundSendFn as y, type SessionId as z };