@dudousxd/nestjs-durable-store-mikro-orm 0.29.0 → 0.31.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _mikro_orm_core from '@mikro-orm/core';
 import { EntityRepository, EntityRepositoryType, EntitySchema, MikroORM } from '@mikro-orm/core';
-import { StepKind, RunStatus, StateStore, WorkflowRun, RetentionPolicy, StepCheckpoint, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, SignalWaiter, ChildWait } from '@dudousxd/nestjs-durable-core';
+import { StepKind, RunStatus, StateStore, WorkflowRun, RetentionPolicy, StepCheckpoint, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, CheckpointStat, CheckpointQuery, SignalWaiter, ChildWait } from '@dudousxd/nestjs-durable-core';
 
 /**
  * Custom repositories for the durable entities, so a host app can `@InjectRepository`/inject a
@@ -188,6 +188,7 @@ declare class MikroOrmStateStore implements StateStore {
     tryAdmitSingleton(runId: string, tag: string, workflow: string, limit: number, retryWakeAt?: number): Promise<boolean>;
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, inputPatch: Partial<WorkflowRun>): Promise<void>;
+    updateRunIf(runId: string, expectedStatuses: RunStatus[], inputPatch: Partial<WorkflowRun>): Promise<boolean>;
     /** Rewrite a run's normalized attribute rows: delete the old set, insert the current one. Mirrors
      *  the in-memory store's reindex so the side-table always reflects the run's live searchAttributes. */
     private reindexAttributes;
@@ -198,11 +199,13 @@ declare class MikroOrmStateStore implements StateStore {
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     saveCheckpointIfPending(checkpoint: StepCheckpoint): Promise<boolean>;
+    saveCheckpointsIfPending(checkpoints: StepCheckpoint[]): Promise<boolean[]>;
     transaction<T>(work: (tx: {
         raw: unknown;
         saveCheckpoint: (cp: StepCheckpoint) => Promise<void>;
     }) => Promise<T>): Promise<T>;
     listIncompleteRuns(namespace?: string): Promise<WorkflowRun[]>;
+    listOrphanedRuns(nowMs: number, limit: number, namespace?: string): Promise<WorkflowRun[]>;
     listPendingRuns(limit: number, namespace?: string): Promise<WorkflowRun[]>;
     listDueTimers(nowMs: number, namespace?: string, limit?: number): Promise<WorkflowRun[]>;
     tryLockRun(runId: string, owner: string, leaseUntilMs: number, nowMs: number): Promise<boolean>;
@@ -290,6 +293,19 @@ declare class MikroOrmStateStore implements StateStore {
     getLatestCheckpointByName(runId: string, name: string): Promise<StepCheckpoint | undefined>;
     countCheckpoints(runId: string, fromSeq: number, toSeq: number, statuses: StepCheckpoint['status'][]): Promise<number>;
     listCheckpointsByNamePrefix(runId: string, prefixes: string[]): Promise<StepCheckpoint[]>;
+    /** One `GROUP BY parallel_group, status, <name kind>` over the run's checkpoints — the buckets a
+     *  run detail summarizes a fan from, without loading its rows. The name-kind `CASE` is the SQL of
+     *  `checkpointNameKind`, and `min(coalesce(enqueued_at, started_at))` reads `enqueuedAt` the way
+     *  {@link listCheckpoints} does. Raw SQL on metadata-resolved names, so a custom column naming
+     *  strategy is honoured. */
+    checkpointStats(runId: string, opts?: {
+        group?: string | undefined;
+    }): Promise<CheckpointStat[]>;
+    /** The run's checkpoints matching `query`, in `seq` order and paged in the database — a fan's
+     *  failures or one page of its members without the rest of the run. An excluded group keeps the
+     *  ungrouped rows (`parallel_group is null or not in (...)`); an empty `statuses`/`namePrefixes`
+     *  matches nothing, so it returns before querying. */
+    queryCheckpoints(runId: string, query: CheckpointQuery): Promise<StepCheckpoint[]>;
     putSignalWaiter(waiter: SignalWaiter): Promise<void>;
     takeSignalWaiter(token: string): Promise<SignalWaiter | null>;
     listSignalWaiters(prefix: string): Promise<SignalWaiter[]>;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _mikro_orm_core from '@mikro-orm/core';
 import { EntityRepository, EntityRepositoryType, EntitySchema, MikroORM } from '@mikro-orm/core';
-import { StepKind, RunStatus, StateStore, WorkflowRun, RetentionPolicy, StepCheckpoint, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, SignalWaiter, ChildWait } from '@dudousxd/nestjs-durable-core';
+import { StepKind, RunStatus, StateStore, WorkflowRun, RetentionPolicy, StepCheckpoint, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, CheckpointStat, CheckpointQuery, SignalWaiter, ChildWait } from '@dudousxd/nestjs-durable-core';
 
 /**
  * Custom repositories for the durable entities, so a host app can `@InjectRepository`/inject a
@@ -188,6 +188,7 @@ declare class MikroOrmStateStore implements StateStore {
     tryAdmitSingleton(runId: string, tag: string, workflow: string, limit: number, retryWakeAt?: number): Promise<boolean>;
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, inputPatch: Partial<WorkflowRun>): Promise<void>;
+    updateRunIf(runId: string, expectedStatuses: RunStatus[], inputPatch: Partial<WorkflowRun>): Promise<boolean>;
     /** Rewrite a run's normalized attribute rows: delete the old set, insert the current one. Mirrors
      *  the in-memory store's reindex so the side-table always reflects the run's live searchAttributes. */
     private reindexAttributes;
@@ -198,11 +199,13 @@ declare class MikroOrmStateStore implements StateStore {
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     saveCheckpointIfPending(checkpoint: StepCheckpoint): Promise<boolean>;
+    saveCheckpointsIfPending(checkpoints: StepCheckpoint[]): Promise<boolean[]>;
     transaction<T>(work: (tx: {
         raw: unknown;
         saveCheckpoint: (cp: StepCheckpoint) => Promise<void>;
     }) => Promise<T>): Promise<T>;
     listIncompleteRuns(namespace?: string): Promise<WorkflowRun[]>;
+    listOrphanedRuns(nowMs: number, limit: number, namespace?: string): Promise<WorkflowRun[]>;
     listPendingRuns(limit: number, namespace?: string): Promise<WorkflowRun[]>;
     listDueTimers(nowMs: number, namespace?: string, limit?: number): Promise<WorkflowRun[]>;
     tryLockRun(runId: string, owner: string, leaseUntilMs: number, nowMs: number): Promise<boolean>;
@@ -290,6 +293,19 @@ declare class MikroOrmStateStore implements StateStore {
     getLatestCheckpointByName(runId: string, name: string): Promise<StepCheckpoint | undefined>;
     countCheckpoints(runId: string, fromSeq: number, toSeq: number, statuses: StepCheckpoint['status'][]): Promise<number>;
     listCheckpointsByNamePrefix(runId: string, prefixes: string[]): Promise<StepCheckpoint[]>;
+    /** One `GROUP BY parallel_group, status, <name kind>` over the run's checkpoints — the buckets a
+     *  run detail summarizes a fan from, without loading its rows. The name-kind `CASE` is the SQL of
+     *  `checkpointNameKind`, and `min(coalesce(enqueued_at, started_at))` reads `enqueuedAt` the way
+     *  {@link listCheckpoints} does. Raw SQL on metadata-resolved names, so a custom column naming
+     *  strategy is honoured. */
+    checkpointStats(runId: string, opts?: {
+        group?: string | undefined;
+    }): Promise<CheckpointStat[]>;
+    /** The run's checkpoints matching `query`, in `seq` order and paged in the database — a fan's
+     *  failures or one page of its members without the rest of the run. An excluded group keeps the
+     *  ungrouped rows (`parallel_group is null or not in (...)`); an empty `statuses`/`namePrefixes`
+     *  matches nothing, so it returns before querying. */
+    queryCheckpoints(runId: string, query: CheckpointQuery): Promise<StepCheckpoint[]>;
     putSignalWaiter(waiter: SignalWaiter): Promise<void>;
     takeSignalWaiter(token: string): Promise<SignalWaiter | null>;
     listSignalWaiters(prefix: string): Promise<SignalWaiter[]>;

package/dist/index.js

@@ -337,6 +337,19 @@ function durableEntities(options = {}) {
     class: StepCheckpointEntity,
     tableName: "durable_step_checkpoints",
     repository: /* @__PURE__ */ __name(() => StepCheckpointRepository, "repository"),
+    // `(runId, parallelGroup, seq)` serves the run detail's per-group reads — `checkpointStats` with a
+    // group and `queryCheckpoints` paging one fan in `seq` order — without scanning the whole run.
+    // Mirrors the Prisma adapter's index of the same name.
+    indexes: [
+      {
+        name: "durable_step_checkpoints_group_idx",
+        properties: [
+          "runId",
+          "parallelGroup",
+          "seq"
+        ]
+      }
+    ],
     properties: {
       runId: {
         type: "string",
@@ -956,6 +969,30 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
     await em.flush();
     if ("searchAttributes" in patch) await this.reindexAttributes(runId, patch.searchAttributes);
   }
+  async updateRunIf(runId, expectedStatuses, inputPatch) {
+    if (expectedStatuses.length === 0) return false;
+    const patch = inputPatch.status && TERMINAL_RUN_STATUSES.includes(inputPatch.status) ? await clearTerminalSingletonAdmission(runId, inputPatch, (id) => this.withScope({}).getRun(id)) : inputPatch;
+    const data = runUpdateData(patch);
+    const em = this.fork();
+    let applied;
+    if (Object.keys(data).length) {
+      applied = await em.nativeUpdate(WorkflowRunEntity, {
+        id: runId,
+        status: {
+          $in: expectedStatuses
+        }
+      }, data) > 0;
+    } else {
+      applied = await em.count(WorkflowRunEntity, {
+        id: runId,
+        status: {
+          $in: expectedStatuses
+        }
+      }) > 0;
+    }
+    if (applied && "searchAttributes" in patch) await this.reindexAttributes(runId, patch.searchAttributes);
+    return applied;
+  }
   /** Rewrite a run's normalized attribute rows: delete the old set, insert the current one. Mirrors
   *  the in-memory store's reindex so the side-table always reflects the run's live searchAttributes. */
   async reindexAttributes(runId, attributes, forked) {
@@ -1078,6 +1115,25 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
     });
     return affected > 0;
   }
+  async saveCheckpointsIfPending(checkpoints) {
+    if (checkpoints.length === 0) return [];
+    return this.fork().transactional(async (em) => {
+      const wrote = [];
+      for (const checkpoint of checkpoints) {
+        const { runId: _runId, seq: _seq, ...data } = toCheckpointEntity(checkpoint);
+        const affected = await em.nativeUpdate(StepCheckpointEntity, {
+          runId: checkpoint.runId,
+          seq: checkpoint.seq,
+          status: "pending"
+        }, {
+          ...data,
+          wakeAt: checkpoint.wakeAt != null ? new Date(checkpoint.wakeAt) : null
+        });
+        wrote.push(affected > 0);
+      }
+      return wrote;
+    });
+  }
   async transaction(work) {
     return this.fork().transactional(async (em) => work({
       raw: em,
@@ -1101,6 +1157,37 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
     });
     return rows.map(fromRunEntity);
   }
+  async listOrphanedRuns(nowMs, limit, namespace) {
+    if (limit <= 0) return [];
+    const em = this.fork();
+    const rows = await em.find(WorkflowRunEntity, {
+      status: {
+        $in: [
+          "running",
+          "cancelling"
+        ]
+      },
+      $or: [
+        {
+          lockedUntil: null
+        },
+        {
+          lockedUntil: {
+            $lte: new Date(nowMs)
+          }
+        }
+      ],
+      ...namespace !== void 0 ? {
+        namespace
+      } : {}
+    }, {
+      orderBy: {
+        createdAt: "ASC"
+      },
+      limit
+    });
+    return rows.map(fromRunEntity);
+  }
   async listPendingRuns(limit, namespace) {
     const em = this.fork();
     const rows = await em.find(WorkflowRunEntity, {
@@ -1598,6 +1685,103 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
         seq: "asc"
       }
     });
+    return rows.filter((r) => prefixes.some((p) => r.name.startsWith(p))).map(fromCheckpointEntity);
+  }
+  /** One `GROUP BY parallel_group, status, <name kind>` over the run's checkpoints — the buckets a
+  *  run detail summarizes a fan from, without loading its rows. The name-kind `CASE` is the SQL of
+  *  `checkpointNameKind`, and `min(coalesce(enqueued_at, started_at))` reads `enqueuedAt` the way
+  *  {@link listCheckpoints} does. Raw SQL on metadata-resolved names, so a custom column naming
+  *  strategy is honoured. */
+  async checkpointStats(runId, opts) {
+    const em = this.fork();
+    const quote = this.idQuote(em);
+    const meta = em.getMetadata().get(StepCheckpointEntity);
+    const c = /* @__PURE__ */ __name((prop) => quote(meta.properties[prop]?.fieldNames?.[0] ?? prop), "c");
+    const nameKind = `case when ${c("name")} like 'signal:child:%' then 'child' when ${c("name")} like 'fan:%' then 'folded' when ${c("name")} like 'spawn:%' then 'spawn' else 'step' end`;
+    const params = [
+      runId
+    ];
+    let where = `${c("runId")} = ?`;
+    if (opts?.group !== void 0) {
+      where += ` and ${c("parallelGroup")} = ?`;
+      params.push(opts.group);
+    }
+    const sql = `select ${c("parallelGroup")} as ${quote("grp")}, ${c("status")} as ${quote("status")}, ${nameKind} as ${quote("name_kind")}, count(*) as ${quote("n")}, min(${c("seq")}) as ${quote("min_seq")}, max(${c("seq")}) as ${quote("max_seq")}, min(${c("name")}) as ${quote("min_name")}, max(${c("name")}) as ${quote("max_name")}, min(coalesce(${c("enqueuedAt")}, ${c("startedAt")})) as ${quote("min_enqueued_at")}, min(${c("startedAt")}) as ${quote("min_started_at")}, max(${c("startedAt")}) as ${quote("max_started_at")}, max(${c("finishedAt")}) as ${quote("max_finished_at")}, sum(${c("attempts")}) as ${quote("sum_attempts")} from ${quote(meta.tableName)} where ${where} group by ${c("parallelGroup")}, ${c("status")}, ${nameKind}`;
+    const rows = await em.getConnection().execute(sql, params);
+    const date = aggregateDateReader(em);
+    return rows.map((row) => ({
+      group: row.grp ?? null,
+      status: row.status,
+      nameKind: row.name_kind,
+      count: Number(row.n),
+      minSeq: Number(row.min_seq),
+      maxSeq: Number(row.max_seq),
+      minName: String(row.min_name),
+      maxName: String(row.max_name),
+      minEnqueuedAt: date(row.min_enqueued_at),
+      minStartedAt: date(row.min_started_at),
+      maxStartedAt: date(row.max_started_at),
+      maxFinishedAt: date(row.max_finished_at),
+      sumAttempts: Number(row.sum_attempts)
+    }));
+  }
+  /** The run's checkpoints matching `query`, in `seq` order and paged in the database — a fan's
+  *  failures or one page of its members without the rest of the run. An excluded group keeps the
+  *  ungrouped rows (`parallel_group is null or not in (...)`); an empty `statuses`/`namePrefixes`
+  *  matches nothing, so it returns before querying. */
+  async queryCheckpoints(runId, query) {
+    if (query.statuses?.length === 0 || query.namePrefixes?.length === 0) return [];
+    const and = [
+      {
+        runId
+      }
+    ];
+    if (query.group !== void 0) and.push({
+      parallelGroup: query.group
+    });
+    if (query.excludeGroups?.length) {
+      and.push({
+        $or: [
+          {
+            parallelGroup: null
+          },
+          {
+            parallelGroup: {
+              $nin: query.excludeGroups
+            }
+          }
+        ]
+      });
+    }
+    if (query.statuses) and.push({
+      status: {
+        $in: query.statuses
+      }
+    });
+    if (query.namePrefixes) {
+      and.push({
+        $or: query.namePrefixes.map((p) => ({
+          name: {
+            $like: `${p}%`
+          }
+        }))
+      });
+    }
+    const rows = await this.fork().find(StepCheckpointEntity, {
+      $and: and
+    }, {
+      orderBy: {
+        seq: "asc"
+      },
+      // An offset alone is not valid SQL on SQLite/MySQL, so an unbounded page gets a limit no
+      // run reaches.
+      ...query.limit !== void 0 || query.offset ? {
+        limit: query.limit ?? Number.MAX_SAFE_INTEGER
+      } : {},
+      ...query.offset ? {
+        offset: query.offset
+      } : {}
+    });
     return rows.map(fromCheckpointEntity);
   }
   async putSignalWaiter(waiter) {
@@ -1632,7 +1816,7 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
         $like: `${prefix}%`
       }
     });
-    return rows.map((e) => ({
+    return rows.filter((e) => e.token.startsWith(prefix)).map((e) => ({
       token: e.token,
       runId: e.runId,
       seq: e.seq,
@@ -1765,6 +1949,29 @@ var MikroOrmStateStore = class _MikroOrmStateStore {
     return affected > 0;
   }
 };
+function runUpdateData(patch) {
+  const data = {};
+  if ("workflow" in patch) data.workflow = patch.workflow;
+  if ("workflowVersion" in patch) data.workflowVersion = patch.workflowVersion;
+  if ("status" in patch) data.status = patch.status;
+  if ("input" in patch) data.input = patch.input ?? null;
+  if ("output" in patch) data.output = patch.output ?? null;
+  if ("error" in patch) data.error = patch.error ?? null;
+  if ("wakeAt" in patch) data.wakeAt = patch.wakeAt == null ? null : new Date(patch.wakeAt);
+  if ("lockedBy" in patch) data.lockedBy = patch.lockedBy ?? null;
+  if ("lockedUntil" in patch) data.lockedUntil = patch.lockedUntil == null ? null : new Date(patch.lockedUntil);
+  if ("awaitingDecisionTaskId" in patch) data.awaitingDecisionTaskId = patch.awaitingDecisionTaskId ?? null;
+  if ("recoveryAttempts" in patch) data.recoveryAttempts = patch.recoveryAttempts ?? null;
+  if ("tags" in patch) data.tags = patch.tags ?? null;
+  if ("searchAttributes" in patch) data.searchAttributes = patch.searchAttributes ?? null;
+  if ("priority" in patch) data.priority = patch.priority ?? null;
+  if ("namespace" in patch) data.namespace = patch.namespace ?? "default";
+  if ("origin" in patch) data.origin = patch.origin ?? null;
+  if (patch.createdAt != null) data.createdAt = patch.createdAt;
+  if (patch.updatedAt != null) data.updatedAt = patch.updatedAt;
+  return data;
+}
+__name(runUpdateData, "runUpdateData");
 function toRunEntity(run) {
   const e = new WorkflowRunEntity();
   e.id = run.id;
@@ -1814,6 +2021,21 @@ function fromRunEntity(e) {
   };
 }
 __name(fromRunEntity, "fromRunEntity");
+function aggregateDateReader(em) {
+  const platform = em.getPlatform();
+  const tz = platform.getTimezone();
+  return (value) => {
+    if (value instanceof Date) return value;
+    if (typeof value === "bigint") return platform.parseDate(Number(value));
+    if (typeof value === "number" || !tz || tz === "local") {
+      return platform.parseDate(value);
+    }
+    const text = String(value);
+    const zoned = text.includes("+") || text.lastIndexOf("-") > 10 || text.endsWith("Z");
+    return platform.parseDate(zoned ? text : `${text}${tz}`);
+  };
+}
+__name(aggregateDateReader, "aggregateDateReader");
 function toCheckpointEntity(cp) {
   const e = new StepCheckpointEntity();
   e.runId = cp.runId;