@dudousxd/nestjs-durable 0.46.3 → 0.47.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { WorkflowCtx, SearchAttributes, WorkflowClass, StepError, WorkflowRef, SingletonConfig, ConcurrencyConfig, SearchAttributesSchema, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, DurableTopology, RunDetail, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, GroupHealth, RunWaiting, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
+import { WorkflowCtx, SearchAttributes, WorkflowClass, StepError, WorkflowRef, SingletonConfig, ConcurrencyConfig, SearchAttributesSchema, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, DurableTopology, RunDetailOptions, RunDetail, FanPageQuery, FanPage, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, GroupHealth, RunWaiting, EngineEvent, RunRequest, RunReply, StepInvocation, WorkflowRun, TenantEvent } from '@dudousxd/nestjs-durable-core';
 export { AttributeFilter, DynamicWorkflowCtx, EngineEvent, InferSearchAttributes, RunDetail, RunGateway, RunListItem, RunQuery, RunStatus, RunWaiting, SearchAttributes, SearchAttributesSchema, StepCheckpoint, StepEvent, StepLogger, WorkflowCtx, WorkflowEngine, WorkflowHandler, WorkflowRun, readSearchAttributes } from '@dudousxd/nestjs-durable-core';
 import { z } from 'zod';
 import { ConcurrencyOption, StartRunDeps, RunRedisWorkerOptions, RunningWorker, DurableWorkerRuntime } from '@dudousxd/durable-worker';
@@ -500,6 +500,37 @@ interface DurableModuleOptions {
      * Ignored when `remoteRedispatchMs` is unset. Operator only.
      */
     remoteRedispatchMax?: number;
+    /**
+     * Fallback wake-up (ms) for a run suspended on an event (child, signal, `waitForEvent`, remote
+     * result) whose wake-up was lost: the reconcile pass re-drives it after this window, an idempotent
+     * replay that re-suspends a still-pending wait. Defaults to 300000 (5min); `0` disables it.
+     * See `WorkflowEngineDeps.reconcileMs`. Operator only.
+     */
+    reconcileMs?: number;
+    /**
+     * The most due timers one timer-poll pass loads and drives, most overdue first, so a wave of
+     * thousands of due runs is worked through in batches. Defaults to 500; a non-finite or sub-1 value
+     * falls back to the default. See `WorkflowEngineDeps.timerBatchSize`. Operator only.
+     */
+    timerBatchSize?: number;
+    /**
+     * Retention (ms) for a buffered event that no `waitForEvent` ever claims; the reconcile pass prunes
+     * rows past `publishedAt + eventBufferTtlMs`. Omit (or `0`) to keep them until consumed, the
+     * default. See `WorkflowEngineDeps.eventBufferTtlMs`. Operator only.
+     */
+    eventBufferTtlMs?: number;
+    /**
+     * How long (ms) a run parked `blocked` (no capable, protocol-compatible live worker) waits before
+     * the blocked-recovery poll re-checks the fleet. Defaults to 5000. See
+     * `WorkflowEngineDeps.blockedPollMs`. Operator only.
+     */
+    blockedPollMs?: number;
+    /**
+     * Persist a `running` checkpoint when a local step's body begins, so an in-flight step survives a
+     * dashboard reload. Defaults to `true`; set `false` on hot paths with many short local steps to
+     * halve their checkpoint writes. See `WorkflowEngineDeps.trackStepStart`. Operator only.
+     */
+    trackStepStart?: boolean;
     /**
      * The **default** workflow to route dead-lettered runs to, for workflows that don't declare their
      * own. When a run is moved to `dead` (exceeded `maxRecoveryAttempts`), the started handler gets a
@@ -945,7 +976,8 @@ declare class ProxyRunGateway implements RunGateway {
     private handleReply;
     private request;
     topology(): DurableTopology;
-    getRunDetail(runId: string): Promise<RunDetail | null>;
+    getRunDetail(runId: string, options?: RunDetailOptions): Promise<RunDetail | null>;
+    getFanMembers(runId: string, group: string, query: FanPageQuery): Promise<FanPage | null>;
     /** The control plane's `StoreRunGateway` resolves each run's `waiting` descriptor; the reply carries
      *  it through as plain JSON, so a tenant's list rows name the wait too. */
     listRuns(query: RunQuery): Promise<RunListItem[]>;
@@ -1045,7 +1077,9 @@ declare class StoreRunGateway implements RunGateway {
     private readonly engine;
     constructor(store: StateStore, engine: WorkflowEngine);
     topology(): DurableTopology;
-    getRunDetail(runId: string): Promise<RunDetail | null>;
+    getRunDetail(runId: string, options?: RunDetailOptions): Promise<RunDetail | null>;
+    getRun(runId: string): Promise<WorkflowRun | null>;
+    getFanMembers(runId: string, group: string, query: FanPageQuery): Promise<FanPage | null>;
     listRuns(query: RunQuery): Promise<RunListItem[]>;
     /**
      * The `(status, origin)` counts behind a console's chips, straight off the store's aggregate. The

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { WorkflowCtx, SearchAttributes, WorkflowClass, StepError, WorkflowRef, SingletonConfig, ConcurrencyConfig, SearchAttributesSchema, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, DurableTopology, RunDetail, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, GroupHealth, RunWaiting, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
+import { WorkflowCtx, SearchAttributes, WorkflowClass, StepError, WorkflowRef, SingletonConfig, ConcurrencyConfig, SearchAttributesSchema, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, DurableTopology, RunDetailOptions, RunDetail, FanPageQuery, FanPage, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, GroupHealth, RunWaiting, EngineEvent, RunRequest, RunReply, StepInvocation, WorkflowRun, TenantEvent } from '@dudousxd/nestjs-durable-core';
 export { AttributeFilter, DynamicWorkflowCtx, EngineEvent, InferSearchAttributes, RunDetail, RunGateway, RunListItem, RunQuery, RunStatus, RunWaiting, SearchAttributes, SearchAttributesSchema, StepCheckpoint, StepEvent, StepLogger, WorkflowCtx, WorkflowEngine, WorkflowHandler, WorkflowRun, readSearchAttributes } from '@dudousxd/nestjs-durable-core';
 import { z } from 'zod';
 import { ConcurrencyOption, StartRunDeps, RunRedisWorkerOptions, RunningWorker, DurableWorkerRuntime } from '@dudousxd/durable-worker';
@@ -500,6 +500,37 @@ interface DurableModuleOptions {
      * Ignored when `remoteRedispatchMs` is unset. Operator only.
      */
     remoteRedispatchMax?: number;
+    /**
+     * Fallback wake-up (ms) for a run suspended on an event (child, signal, `waitForEvent`, remote
+     * result) whose wake-up was lost: the reconcile pass re-drives it after this window, an idempotent
+     * replay that re-suspends a still-pending wait. Defaults to 300000 (5min); `0` disables it.
+     * See `WorkflowEngineDeps.reconcileMs`. Operator only.
+     */
+    reconcileMs?: number;
+    /**
+     * The most due timers one timer-poll pass loads and drives, most overdue first, so a wave of
+     * thousands of due runs is worked through in batches. Defaults to 500; a non-finite or sub-1 value
+     * falls back to the default. See `WorkflowEngineDeps.timerBatchSize`. Operator only.
+     */
+    timerBatchSize?: number;
+    /**
+     * Retention (ms) for a buffered event that no `waitForEvent` ever claims; the reconcile pass prunes
+     * rows past `publishedAt + eventBufferTtlMs`. Omit (or `0`) to keep them until consumed, the
+     * default. See `WorkflowEngineDeps.eventBufferTtlMs`. Operator only.
+     */
+    eventBufferTtlMs?: number;
+    /**
+     * How long (ms) a run parked `blocked` (no capable, protocol-compatible live worker) waits before
+     * the blocked-recovery poll re-checks the fleet. Defaults to 5000. See
+     * `WorkflowEngineDeps.blockedPollMs`. Operator only.
+     */
+    blockedPollMs?: number;
+    /**
+     * Persist a `running` checkpoint when a local step's body begins, so an in-flight step survives a
+     * dashboard reload. Defaults to `true`; set `false` on hot paths with many short local steps to
+     * halve their checkpoint writes. See `WorkflowEngineDeps.trackStepStart`. Operator only.
+     */
+    trackStepStart?: boolean;
     /**
      * The **default** workflow to route dead-lettered runs to, for workflows that don't declare their
      * own. When a run is moved to `dead` (exceeded `maxRecoveryAttempts`), the started handler gets a
@@ -945,7 +976,8 @@ declare class ProxyRunGateway implements RunGateway {
     private handleReply;
     private request;
     topology(): DurableTopology;
-    getRunDetail(runId: string): Promise<RunDetail | null>;
+    getRunDetail(runId: string, options?: RunDetailOptions): Promise<RunDetail | null>;
+    getFanMembers(runId: string, group: string, query: FanPageQuery): Promise<FanPage | null>;
     /** The control plane's `StoreRunGateway` resolves each run's `waiting` descriptor; the reply carries
      *  it through as plain JSON, so a tenant's list rows name the wait too. */
     listRuns(query: RunQuery): Promise<RunListItem[]>;
@@ -1045,7 +1077,9 @@ declare class StoreRunGateway implements RunGateway {
     private readonly engine;
     constructor(store: StateStore, engine: WorkflowEngine);
     topology(): DurableTopology;
-    getRunDetail(runId: string): Promise<RunDetail | null>;
+    getRunDetail(runId: string, options?: RunDetailOptions): Promise<RunDetail | null>;
+    getRun(runId: string): Promise<WorkflowRun | null>;
+    getFanMembers(runId: string, group: string, query: FanPageQuery): Promise<FanPage | null>;
     listRuns(query: RunQuery): Promise<RunListItem[]>;
     /**
      * The `(status, origin)` counts behind a console's chips, straight off the store's aggregate. The

package/dist/index.js

@@ -1072,10 +1072,19 @@ var ProxyRunGateway = class {
       tenant: this.tenant
     };
   }
-  getRunDetail(runId) {
+  getRunDetail(runId, options) {
     return this.request({
       kind: "getRunDetail",
-      runId
+      runId,
+      options
+    });
+  }
+  getFanMembers(runId, group, query) {
+    return this.request({
+      kind: "getFanMembers",
+      runId,
+      group,
+      query
     });
   }
   /** The control plane's `StoreRunGateway` resolves each run's `waiting` descriptor; the reply carries
@@ -1437,8 +1446,8 @@ var RunRequestResponder = class {
     if (body.kind === "waitingFor") {
       const all = await this.gateway.waitingFor(body.runIds);
       const owned = await Promise.all(Object.entries(all).map(async ([runId, waiting]) => {
-        const runDetail = await this.gateway.getRunDetail(runId);
-        return runDetail && runDetail.run.namespace === msg.tenant ? [
+        const owner = this.gateway.getRun ? await this.gateway.getRun(runId) : (await this.gateway.getRunDetail(runId))?.run;
+        return owner && owner.namespace === msg.tenant ? [
           runId,
           waiting
         ] : void 0;
@@ -1455,8 +1464,9 @@ var RunRequestResponder = class {
         }
       };
     }
-    const detail = await this.gateway.getRunDetail(body.runId);
-    if (detail && detail.run.namespace !== msg.tenant) {
+    const detail = body.kind === "getRunDetail" || !this.gateway.getRun ? await this.gateway.getRunDetail(body.runId, body.kind === "getRunDetail" ? body.options : void 0) : void 0;
+    const run = detail !== void 0 ? detail?.run ?? null : await this.gateway.getRun?.(body.runId);
+    if (run && run.namespace !== msg.tenant) {
       return {
         requestId: msg.requestId,
         result: {
@@ -1477,6 +1487,16 @@ var RunRequestResponder = class {
         }
       };
     }
+    if (body.kind === "getFanMembers") {
+      const data = run ? await this.gateway.getFanMembers?.(body.runId, body.group, body.query) ?? null : null;
+      return {
+        requestId: msg.requestId,
+        result: {
+          ok: true,
+          data
+        }
+      };
+    }
     try {
       const data = await this.callVerb(body);
       return {
@@ -1515,7 +1535,7 @@ var RunRequestResponder = class {
 };
 
 // src/store-run-gateway.ts
-import { STATE_STORE_CANONICAL as STATE_STORE_CANONICAL2, WorkflowEngine as WorkflowEngine2, indexWaitersByRun, listSignalWaitersOfRuns, mergeRunFacetRows, resolveRunWaiting } from "@dudousxd/nestjs-durable-core";
+import { STATE_STORE_CANONICAL as STATE_STORE_CANONICAL2, SUMMARY_CHILD_LIMIT, WorkflowEngine as WorkflowEngine2, childIdsOf, indexWaitersByRun, listSignalWaitersOfRuns, mergeRunFacetRows, pageFan, resolveRunWaiting, summarizeTimeline } from "@dudousxd/nestjs-durable-core";
 import { Inject as Inject5, Injectable as Injectable8 } from "@nestjs/common";
 function _ts_decorate8(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
@@ -1558,19 +1578,39 @@ var StoreRunGateway = class {
       role: "control-plane"
     };
   }
-  async getRunDetail(runId) {
+  async getRunDetail(runId, options) {
     const run = await this.store.getRun(runId);
     if (!run) return null;
-    const [timeline, children] = await Promise.all([
-      this.store.listCheckpoints(runId),
-      this.engine.getRunChildren(runId)
-    ]);
+    const over = options?.summarizeFansOver;
+    if (over === void 0) {
+      const [timeline2, children] = await Promise.all([
+        this.store.listCheckpoints(runId),
+        this.engine.getRunChildren(runId)
+      ]);
+      return {
+        run,
+        timeline: timeline2,
+        children
+      };
+    }
+    const full = await this.store.listCheckpoints(runId);
+    const { timeline, fans } = summarizeTimeline(full, over);
+    const ids = childIdsOf(full);
     return {
       run,
       timeline,
-      children
+      children: ids.slice(0, SUMMARY_CHILD_LIMIT),
+      fans,
+      childCount: ids.length
     };
   }
+  getRun(runId) {
+    return this.store.getRun(runId);
+  }
+  async getFanMembers(runId, group, query) {
+    if (!await this.store.getRun(runId)) return null;
+    return pageFan(await this.store.listCheckpoints(runId), group, query);
+  }
   async listRuns(query) {
     const runs = await this.store.listRuns(query);
     const waiterByRun = indexWaitersByRun(await listSignalWaitersOfRuns(this.store, runs.filter((run) => run.status === "suspended").map((run) => run.id)));
@@ -2505,6 +2545,11 @@ var DurableModule = class _DurableModule {
               remoteAdvanceSilenceMs: options.remoteAdvanceSilenceMs,
               remoteRedispatchMs: options.remoteRedispatchMs,
               remoteRedispatchMax: options.remoteRedispatchMax,
+              reconcileMs: options.reconcileMs,
+              timerBatchSize: options.timerBatchSize,
+              eventBufferTtlMs: options.eventBufferTtlMs,
+              blockedPollMs: options.blockedPollMs,
+              trackStepStart: options.trackStepStart,
               instanceId: options.instanceId,
               namespace: options.namespace,
               webhookUrl: options.webhookUrl,