@spinajs/queue-stomp-transport 2.0.481 → 2.0.482

package/lib/mjs/connection.d.ts

@@ -1,15 +1,114 @@
 import { IQueueMessage, IQueueConnectionOptions, QueueClient, QueueMessage } from '@spinajs/queue';
 import Stomp from '@stomp/stompjs';
 import { Constructor } from '@spinajs/di';
+import { ResiliencePipeline } from '@spinajs/util';
+/**
+ * Describes a subscription we want to keep alive across reconnects.
+ *
+ * stompjs does NOT replay subscriptions after a socket drop, so we track the
+ * intent ( channel + callback + options ) and re-create the live subscription
+ * inside `onConnect` on every ( re )connect.
+ */
+interface ISubscriptionDescriptor {
+    channel: string;
+    callback: (e: IQueueMessage) => Promise<void>;
+    subscriptionId?: string;
+    durable?: boolean;
+    active?: Stomp.StompSubscription;
+}
+/**
+ * A message emitted while the client was disconnected. It is buffered and
+ * flushed once the connection is ( re )established.
+ */
+interface IPendingEmit {
+    message: IQueueMessage;
+    resolve: () => void;
+    reject: (err: unknown) => void;
+}
 export declare class StompQueueClient extends QueueClient {
     protected Client: Stomp.Client;
-    protected Subscriptions: Map<string, Stomp.StompSubscription>;
+    protected Subscriptions: Map<string, ISubscriptionDescriptor>;
+    protected PendingEmits: IPendingEmit[];
+    protected ReadyWaiters: Array<() => void>;
+    protected Disposing: boolean;
+    /** Publisher-side resilience: retry each receipt-confirmed publish with backoff so a transient
+     * broker hiccup / receipt timeout doesn't fail the emit. Duplicates are handled by consumer dedup. */
+    protected EmitPipeline: ResiliencePipeline<void>;
     get ClientId(): string;
+    /**
+     * `true` when there is an active connection with the broker.
+     */
+    get Connected(): boolean;
+    protected get ReceiptTimeout(): number;
+    /**
+     * Resolves once the client is connected. If already connected resolves immediately,
+     * otherwise waits for the next ( re )connect, optionally bounded by `timeoutMs`.
+     */
+    whenReady(timeoutMs?: number): Promise<void>;
     constructor(options: IQueueConnectionOptions);
+    /**
+     * Creates the underlying stompjs client. Extracted so it can be overridden
+     * ( e.g. with a fake ) in unit tests without a live broker.
+     */
+    protected createClient(config: Stomp.StompConfig): Stomp.Client;
     resolve(): Promise<void>;
     dispose(): Promise<void>;
     emit(message: IQueueMessage): Promise<void>;
-    unsubscribe(channelOrMessage: string | Constructor<QueueMessage>): void;
+    unsubscribe(channelOrMessage: string | Constructor<QueueMessage>, removeDurable?: boolean): void;
     subscribe(channelOrMessage: string | Constructor<QueueMessage>, callback: (e: IQueueMessage) => Promise<void>, subscriptionId?: string, durable?: boolean): Promise<void>;
+    /**
+     * Creates the live broker subscription for a tracked descriptor.
+     * Called on initial subscribe and replayed for every descriptor on reconnect.
+     */
+    protected applySubscription(desc: ISubscriptionDescriptor): void;
+    /**
+     * Handles a message whose consumer callback rejected.
+     *
+     * Events ( fire-and-forget ) are logged and acked ( dropped ) - the queue model
+     * does not retry them. Jobs are retried up to their RetryCount by re-publishing
+     * to the same channel with an incremented retry header ( and optional backoff ),
+     * then dead-lettered once retries are exhausted.
+     */
+    protected handleFailedMessage(message: Stomp.IMessage, qMessage: IQueueMessage, desc: ISubscriptionDescriptor, err: unknown): void;
+    /**
+     * Handles a message whose body could not be parsed as JSON. It cannot be retried
+     * ( we don't know its type ), so it is dead-lettered or nacked.
+     */
+    protected handleUnparseableMessage(message: Stomp.IMessage, channel: string, err: unknown): void;
+    /**
+     * Publishes a failed message to the given dead-letter channel and acks the original
+     * to unblock the source queue. When no dead-letter channel is configured the message is
+     * dropped ( acked ) with a warning - we never nack-loop a poison message forever.
+     */
+    protected deadLetter(message: Stomp.IMessage, dlq: string | undefined, channel: string, reason: string, attempt?: number): void;
+    /**
+     * Exponential backoff ( ms ) for the given retry attempt, based on `Options.retryDelay`.
+     * Returns 0 ( immediate redelivery ) when no base delay is configured.
+     */
+    protected retryBackoff(attempt: number): number;
+    /**
+     * Publisher-side resilience pipeline used by emit(). Retries a failed / timed-out receipt
+     * publish with exponential backoff ( the per-attempt timeout lives in publishWithReceipt ).
+     */
+    protected buildEmitPipeline(): ResiliencePipeline<void>;
+    /**
+     * Publishes a message to all of its routed channels and resolves only once the
+     * broker has acknowledged each publish with a RECEIPT frame.
+     */
+    protected publishMessage(message: IQueueMessage): Promise<void>;
+    /**
+     * Publishes to a single channel and waits for the broker RECEIPT frame so the
+     * caller gets real delivery confirmation ( bounded by `ReceiptTimeout` ).
+     */
+    protected publishWithReceipt(channel: string, body: string, headers: Stomp.StompHeaders, message: IQueueMessage): Promise<void>;
+    /**
+     * Flushes messages buffered while disconnected. Called from `onConnect`.
+     */
+    protected flushPendingEmits(): void;
+    /**
+     * Resolves everyone waiting on {@link whenReady}. Called from `onConnect`.
+     */
+    protected flushReadyWaiters(): void;
 }
+export {};
 //# sourceMappingURL=connection.d.ts.map

package/lib/mjs/connection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/connection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnG,OAAO,KAAK,MAAM,gBAAgB,CAAC;AAEnC,OAAO,EAAE,WAAW,EAAgC,MAAM,aAAa,CAAC;AAOxE,qBAEa,gBAAiB,SAAQ,WAAW;IAC/C,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IAE/B,SAAS,CAAC,aAAa,uCAA8C;IAErE,IAAW,QAAQ,WAElB;gBAEW,OAAO,EAAE,uBAAuB;IAI/B,OAAO;IAmEP,OAAO;IAsBP,IAAI,CAAC,OAAO,EAAE,aAAa;IAuCjC,WAAW,CAAC,gBAAgB,EAAE,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC;IAa1D,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA4CvL"}
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/connection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAa,uBAAuB,EAA6B,WAAW,EAAE,YAAY,EAAoB,MAAM,gBAAgB,CAAC;AAC3J,OAAO,KAAK,MAAM,gBAAgB,CAAC;AAEnC,OAAO,EAAE,WAAW,EAAoC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAe,kBAAkB,EAA6B,MAAM,eAAe,CAAC;AAqC3F;;;;;;GAMG;AACH,UAAU,uBAAuB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,CAAC,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAGlB,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;CAClC;AAED;;;GAGG;AACH,UAAU,YAAY;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;CAChC;AAED,qBAEa,gBAAiB,SAAQ,WAAW;IAC/C,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;IAE/B,SAAS,CAAC,aAAa,uCAA8C;IAErE,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,CAAM;IAG5C,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,CAAM;IAE/C,SAAS,CAAC,SAAS,UAAS;IAE5B;0GACsG;IACtG,SAAS,CAAC,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAA4B;IAE5E,IAAW,QAAQ,WAElB;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,SAAS,KAAK,cAAc,IAAI,MAAM,CAErC;IAED;;;OAGG;IACI,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;gBA0BvC,OAAO,EAAE,uBAAuB;IAI5C;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,MAAM;IAIlD,OAAO;IAsGP,OAAO;IAsBP,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBjD,WAAW,CAAC,gBAAgB,EAAE,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,EAAE,aAAa,UAAQ;IAuBjF,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBtL;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,uBAAuB;IA6CzD;;;;;;;OAOG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,uBAAuB,EAAE,GAAG,EAAE,OAAO;IAuD3H;;;OAGG;IACH,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO;IAKzF;;;;OAIG;IACH,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IA+BxH;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAK/C;;;OAGG;IACH,SAAS,CAAC,iBAAiB,IAAI,kBAAkB,CAAC,IAAI,CAAC;IASvD;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC/D;;;OAGG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB/H;;OAEG;IACH,SAAS,CAAC,iBAAiB;IAe3B;;OAEG;IACH,SAAS,CAAC,iBAAiB;CAY5B"}