@cogitator-ai/channels 0.15.12 → 0.17.0

package/dist/gateway.d.ts

@@ -23,6 +23,12 @@ export interface GatewayFullConfig extends GatewayConfig {
      * the prompt cache they open with
      */
     brief?: (msg: ChannelMessage) => string | undefined;
+    /**
+     * How long {@link Gateway.stop} waits for the queued messages and the runs in progress to be
+     * answered, in milliseconds (default 30000). What is still running then is aborted, and what
+     * is still waiting is dropped.
+     */
+    drainTimeout?: number;
 }
 export interface GatewaySessionInfo {
     threadId: string;
@@ -33,6 +39,8 @@ export interface GatewaySessionInfo {
     lastActiveAt: number;
     active: boolean;
 }
+/** Threads kept in the gateway's own bookkeeping (stats, sessions, envelope times) */
+export declare const MAX_TRACKED_THREADS = 10000;
 export declare class Gateway {
     private readonly config;
     private readonly channels;
@@ -44,6 +52,8 @@ export declare class Gateway {
     private readonly hooks;
     private readonly approvalWords;
     private readonly pausedThreads;
+    /** The stop of every run in progress */
+    private readonly runs;
     /** The stop of each run, by the signal the run was given */
     private readonly stops;
     /** The stop of each run streaming into a draft with a stop button, by channel, chat and draft */
@@ -53,16 +63,57 @@ export declare class Gateway {
     private readonly lastMessageTime;
     private readonly threads;
     private readonly inFlight;
+    /** Messages taken and not answered yet, for {@link idle} */
+    private readonly pending;
+    /** The stop in progress, which a second {@link stop} call returns */
+    private stopping;
+    /** Calls of `channel.redeliver` in progress */
+    private readonly redeliveries;
+    /**
+     * Messages taken from a channel that can redeliver them, by the promise of their answer, until
+     * it settles. Those still here once `stop()` gave up on the runs are handed back.
+     */
+    private readonly unanswered;
+    /**
+     * Messages whose answer is going out or went out, by `answerKey`, so a run aborted after its
+     * first message was sent (or while it is being sent) is not redelivered
+     */
+    private readonly answeredKeys;
+    /** The last pending write of each user's session, so writes to one session never interleave */
+    private readonly sessionWrites;
     private running;
     private startedAt;
     private messageCount;
     private messageCountDay;
     constructor(config: GatewayFullConfig);
     start(): Promise<void>;
+    /**
+     * Stops the gateway. Channels have already confirmed the messages they handed over, so it
+     * first lets them be answered: messages held by `debounce` are flushed, and it waits up to
+     * `drainTimeout` for the queues and the runs in progress. Then it aborts the runs still going,
+     * drops the messages still waiting, waits for the aborted runs to settle (up to `drainTimeout`
+     * again) and stops the channels. Messages that come in meanwhile are refused (see
+     * {@link injectMessage}). A second call while it stops returns the same promise.
+     */
     stop(): Promise<void>;
+    private drainAndStop;
     get stats(): GatewayStats;
     getSessions(): GatewaySessionInfo[];
+    /**
+     * Feeds a message to the gateway as if a channel had received it (the scheduler sends its
+     * tasks this way). It resolves once the message is answered, or once it is buffered when
+     * `debounce` is on. It rejects when the message was not answered: its run failed (also
+     * reported to `onError`), it was aborted or dropped by {@link stop}, or it came in while the
+     * gateway was stopping.
+     */
     injectMessage(msg: ChannelMessage): Promise<void>;
+    /**
+     * Resolves once every message the gateway has taken is answered: those waiting in their
+     * thread's queue and the runs in progress, including messages that come in while it waits.
+     * Messages held by `debounce` count from the moment they are flushed. {@link stop} waits
+     * for it, up to `drainTimeout`.
+     */
+    idle(): Promise<void>;
     /**
      * Summarize older messages of a conversation thread, keeping `keepRecent` messages intact.
      * Runs regardless of the configured thresholds.
@@ -77,7 +128,8 @@ export declare class Gateway {
     compactAll(): Promise<string>;
     /**
      * The threads {@link compactAll} goes through: those served since the gateway started, and the
-     * default thread of each stored session when threads are not keyed by `session.threadKey`
+     * threads of each stored session when they are keyed by the default key (the conversations kept
+     * in the session's metadata, or the chat it was created in) or by `legacyThreadKey`
      */
     private knownThreads;
     /**
@@ -98,10 +150,38 @@ export declare class Gateway {
      * decision, or go away when the request was dropped.
      */
     private closePrompts;
+    /**
+     * A message from a channel, a button or {@link injectMessage}. With a queue, a channel's message
+     * is only queued, so the channel goes on to its next update while the thread waits its turn.
+     * `untilAnswered` waits for the answer. A message of `channel` the gateway does not answer
+     * because it stops (refused while stopping, or dropped by `stop()`) goes back through
+     * `channel.redeliver`.
+     */
     private handleIncoming;
+    /** Hands a message back to its channel, reporting a failure to `onError`. */
+    private redeliver;
+    /**
+     * Watches the answer of messages taken from `channel`: when the gateway stops before answering
+     * them they go back through `channel.redeliver`, and so do those whose run is still going when
+     * `stop()` gives up on it. A message whose answer went out is never handed back.
+     */
+    private watchUnanswered;
+    /** Puts a message through the queue of its thread, resolving once it is done with */
     private dispatch;
+    /** Resolves `true` once the message is handled, `false` when it failed or was dropped */
+    private route;
+    /**
+     * A scheduled message names only its chat, so with the default thread key it gets the topic or
+     * conversation of the user's most recent conversation in that chat, kept in their session: the
+     * task is then answered in the thread and topic it was set up in.
+     */
+    private locateScheduled;
     private rollMessageCounter;
     private runMiddleware;
+    /**
+     * Handles one message, `false` when its run failed or was aborted. A message for a channel
+     * the gateway does not run counts as handled: it never can be.
+     */
     private processMessage;
     private processWithChannel;
     private handleAccepted;
@@ -128,6 +208,16 @@ export declare class Gateway {
      */
     private streamRun;
     private getThreadId;
+    /**
+     * Keeps the message's conversation in the user's session, so its thread is known after a
+     * restart. A failure is reported to `onError` and does not keep the message from its answer.
+     */
+    private rememberConversation;
+    /**
+     * Runs `write` after every earlier write to the same session has finished, so a read, change
+     * and write of its metadata never loses another one's change.
+     */
+    private writeSession;
     private resolveAgent;
     private createMiddlewareContext;
     /**

package/dist/gateway.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gateway.d.ts","sourceRoot":"","sources":["../src/gateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EAIZ,cAAc,EAMd,YAAY,EASb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAM3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAe9D,OAAO,KAAK,EAIV,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,GAAG,SAAS,CAAC;CACrD;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB;AAgFD,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmC;IACjE,4DAA4D;IAC5D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA+C;IACrE,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsC;IACtE,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsE;IAC9F,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,eAAe,CAAsB;gBAEjC,MAAM,EAAE,iBAAiB;IAkC/B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAetB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAW3B,IAAI,KAAK,IAAI,YAAY,CASxB;IAED,WAAW,IAAI,kBAAkB,EAAE;IAM7B,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;OAGG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAYrE;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IA2BnC;;;OAGG;YACW,YAAY;IAe1B;;;OAGG;YACW,eAAe;YAMf,OAAO;IAqBrB;;;;OAIG;YACW,YAAY;YAmBZ,oBAAoB;IA8ClC;;;OAGG;YACW,YAAY;YAyBZ,cAAc;YAQd,QAAQ;IAQtB,OAAO,CAAC,kBAAkB;YAQZ,aAAa;YAab,cAAc;YAuBd,kBAAkB;YAkBlB,cAAc;IAgF5B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;YAUX,UAAU;YA+BV,eAAe;YAgDf,cAAc;YAgBd,gBAAgB;YA4ChB,OAAO;YAeP,YAAY;IA6B1B,OAAO,CAAC,eAAe;YAuBT,WAAW;YAsBX,SAAS;YA0BT,SAAS;YA+BT,YAAY;IAuC1B;;;OAGG;YACW,SAAS;IA6EvB,OAAO,CAAC,WAAW;YAOL,YAAY;IAQ1B,OAAO,CAAC,uBAAuB;IAmB/B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAqB1B"}
+{"version":3,"file":"gateway.d.ts","sourceRoot":"","sources":["../src/gateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EAIZ,cAAc,EAMd,YAAY,EAUb,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAM3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAuB9D,OAAO,KAAK,EAIV,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,GAAG,SAAS,CAAC;IACpD;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB;AAiED,sFAAsF;AACtF,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAqD1C,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA+B;IAC9D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmC;IACjE,wCAAwC;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA8B;IACnD,4DAA4D;IAC5D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA+C;IACrE,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsC;IACtE,iGAAiG;IACjG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsE;IAC9F,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA6B;IACtD,4DAA4D;IAC5D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IACvD,qEAAqE;IACrE,OAAO,CAAC,QAAQ,CAA8B;IAC9C,+CAA+C;IAC/C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IACzD;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAGvB;IACJ;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,+FAA+F;IAC/F,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoC;IAClE,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,eAAe,CAAsB;gBAEjC,MAAM,EAAE,iBAAiB;IAwC/B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAe5B;;;;;;;OAOG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAWP,YAAY;IA2B1B,IAAI,KAAK,IAAI,YAAY,CASxB;IAED,WAAW,IAAI,kBAAkB,EAAE;IAMnC;;;;;;OAMG;IACG,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3B;;;OAGG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IAYrE;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IA2BnC;;;;OAIG;YACW,YAAY;IA+B1B;;;OAGG;YACW,eAAe;YAMf,OAAO;IAqBrB;;;;OAIG;YACW,YAAY;YAmBZ,oBAAoB;IA+ClC;;;OAGG;YACW,YAAY;IAyB1B;;;;;;OAMG;YACW,cAAc;IA4B5B,6EAA6E;IAC7E,OAAO,CAAC,SAAS;IASjB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAgBvB,qFAAqF;IACrF,OAAO,CAAC,QAAQ;IAUhB,yFAAyF;YAC3E,KAAK;IAMnB;;;;OAIG;YACW,eAAe;IA+B7B,OAAO,CAAC,kBAAkB;YAQZ,aAAa;IAa3B;;;OAGG;YACW,cAAc;YA6Bd,kBAAkB;YAkBlB,cAAc;IAsF5B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;YAUX,UAAU;YA+BV,eAAe;YAgDf,cAAc;YAgBd,gBAAgB;YA4ChB,OAAO;YAeP,YAAY;IA6B1B,OAAO,CAAC,eAAe;YAyBT,WAAW;YA8BX,SAAS;YA0BT,SAAS;YA+BT,YAAY;IAuC1B;;;OAGG;YACW,SAAS;IA+EvB,OAAO,CAAC,WAAW;IAOnB;;;OAGG;YACW,oBAAoB;IAgBlC;;;OAGG;YACW,YAAY;YAYZ,YAAY;IAQ1B,OAAO,CAAC,uBAAuB;IAmB/B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAqB1B"}