@dudousxd/nestjs-durable-store-drizzle 0.25.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
2
2
  import { PgDatabase } from 'drizzle-orm/pg-core';
3
- import { StateStore, WorkflowRun, RunStatus, RetentionPolicy, StepCheckpoint, StepSettlement, StoreTransaction, OwnedLeaseReclaim, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, CheckpointStat, CheckpointQuery, SignalWaiter, ChildWait, BufferedSignalRow } from '@dudousxd/nestjs-durable-core';
3
+ import { StateStore, WorkflowRun, RunStatus, RetentionPolicy, StepCheckpoint, StepSettlement, StepResultSettlement, StoreTransaction, OwnedLeaseReclaim, RunQuery, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, ScheduleRecord, ScheduleQuery, CheckpointStat, CheckpointQuery, SignalWaiter, ChildWait, BufferedSignalRow } from '@dudousxd/nestjs-durable-core';
4
4
  import { SQL } from 'drizzle-orm';
5
5
 
6
6
  /**
@@ -57,6 +57,16 @@ declare function drizzlePgSchemaRepairWarning(repairs: readonly string[]): strin
57
57
  */
58
58
  declare function ensureDrizzlePgDurableSchema(db: PgDatabase<any, any, any>, options?: EnsureDrizzlePgDurableSchemaOptions): Promise<void>;
59
59
 
60
+ interface PgHotPathOptions {
61
+ /**
62
+ * Send the hot statements as NAMED prepared statements (parsed once per connection). Saves
63
+ * Postgres a parse per statement, which halves its CPU per workflow. Needs a direct connection or
64
+ * a pooler that supports protocol-level prepared statements (PgBouncer in transaction mode before
65
+ * 1.21 does not): pass `false` there. Default on.
66
+ */
67
+ preparedStatements?: boolean | undefined;
68
+ }
69
+
60
70
  /**
61
71
  * Any drizzle Postgres database — `drizzle-orm/node-postgres`, `drizzle-orm/postgres-js`,
62
72
  * `drizzle-orm/pglite`, Neon, … — built with or without a relational schema. The store only uses the
@@ -79,6 +89,13 @@ interface DrizzlePgStateStoreOptions {
79
89
  * satisfies it.
80
90
  */
81
91
  schemaLogger?: DurableSchemaLogger | undefined;
92
+ /**
93
+ * On node-postgres, send the statements every workflow turn and step result run as NAMED prepared
94
+ * statements, parsed once per connection (see `PgHotPathOptions`). Needs a direct connection or
95
+ * a pooler with protocol-level prepared statements; pass `false` behind PgBouncer in transaction
96
+ * mode before 1.21. Default on.
97
+ */
98
+ preparedStatements?: PgHotPathOptions['preparedStatements'];
82
99
  }
83
100
  /**
84
101
  * Drizzle `StateStore` for **PostgreSQL**. Pass any drizzle Postgres db (see {@link DrizzlePgDatabase});
@@ -99,7 +116,18 @@ declare class DrizzlePgStateStore implements StateStore {
99
116
  private readonly db;
100
117
  private readonly options;
101
118
  private readonly scopeNamespace;
119
+ /** Constant-SQL path for the per-step statements, on node-postgres (see `hot-path.ts`). */
120
+ private readonly hot;
121
+ /** The run read-scope predicate as SQL text from `$2` on, and its values (hot path). */
122
+ private readonly hotScope;
123
+ /** Hot-path UPDATE texts by patch shape. */
124
+ private readonly hotUpdates;
102
125
  constructor(db: DrizzlePgDatabase, options?: DrizzlePgStateStoreOptions);
126
+ /**
127
+ * A hot-path `UPDATE` of the runs table setting `row`'s columns on run `$n`, optionally only while
128
+ * its status is one of `expected` (then `RETURNING "id"`). Text cached per shape.
129
+ */
130
+ private hotRunUpdate;
103
131
  /** A store confined to `scope.namespace`, sharing this store's db (no new connection). Used by the
104
132
  * NestJS module's `scopeReads`; `{ namespace: undefined }` is the unscoped operator view. */
105
133
  withScope(scope: {
@@ -127,6 +155,11 @@ declare class DrizzlePgStateStore implements StateStore {
127
155
  saveCheckpointIfPending(checkpoint: StepCheckpoint): Promise<boolean>;
128
156
  saveCheckpointsIfPending(checkpoints: StepCheckpoint[]): Promise<boolean[]>;
129
157
  settleCheckpointsIfPending(settlements: StepSettlement[]): Promise<boolean[]>;
158
+ settleResultsIfPending(results: StepResultSettlement[]): Promise<(StepCheckpoint | null)[]>;
159
+ insertCheckpointIfAbsent(checkpoint: StepCheckpoint): Promise<boolean>;
160
+ tryLockRunAndGet(runId: string, owner: string, leaseUntilMs: number, nowMs: number): Promise<WorkflowRun | null>;
161
+ /** Run `work` on the db as is when it is one statement (atomic by itself), else in a transaction. */
162
+ private inTransactionIf;
130
163
  transaction<T>(work: (tx: StoreTransaction) => Promise<T>): Promise<T>;
131
164
  /** Crash recovery. Namespace-scoped: a worker re-drives only its own tenant's runs. */
132
165
  listIncompleteRuns(namespace?: string): Promise<WorkflowRun[]>;
@@ -134,6 +167,7 @@ declare class DrizzlePgStateStore implements StateStore {
134
167
  /** FIFO pick-up, served by `durable_workflow_runs_namespace_status_idx`. The engine then leases
135
168
  * each run with {@link tryLockRun}; the listing itself takes no locks (it runs outside a tx). */
136
169
  listPendingRuns(limit: number, namespace?: string): Promise<WorkflowRun[]>;
170
+ claimPendingRuns(limit: number, owner: string, leaseUntilMs: number, nowMs: number, namespace?: string): Promise<WorkflowRun[]>;
137
171
  listDueTimers(nowMs: number, namespace?: string, limit?: number): Promise<WorkflowRun[]>;
138
172
  tryLockRun(runId: string, owner: string, leaseUntilMs: number, nowMs: number): Promise<boolean>;
139
173
  releaseRunLock(runId: string, owner?: string): Promise<void>;
@@ -182,6 +216,13 @@ declare class DrizzlePgStateStore implements StateStore {
182
216
  takeBufferedSignal(token: string): Promise<{
183
217
  payload: unknown;
184
218
  } | null>;
219
+ takeOldestBufferedSignal(tokens: string[]): Promise<{
220
+ token: string;
221
+ payload: unknown;
222
+ } | null>;
223
+ claimSignalId(token: string, id: string, expiresAt: number, nowMs: number): Promise<boolean>;
224
+ releaseSignalId(token: string, id: string): Promise<void>;
225
+ deleteExpiredSignalIds(nowMs: number, limit: number): Promise<number>;
185
226
  listBufferedSignals(tokenPrefix: string, afterId: string | undefined, limit: number): Promise<BufferedSignalRow[]>;
186
227
  deleteBufferedSignals(ids: string[]): Promise<void>;
187
228
  bufferEvent(input: {
@@ -531,6 +572,40 @@ declare const durableWorkflowRuns: drizzle_orm_pg_core.PgTableWithColumns<{
531
572
  identity: undefined;
532
573
  generated: undefined;
533
574
  }, {}, {}>;
575
+ tenantId: drizzle_orm_pg_core.PgColumn<{
576
+ name: "tenant_id";
577
+ tableName: "durable_workflow_runs";
578
+ dataType: "string";
579
+ columnType: "PgText";
580
+ data: string;
581
+ driverParam: string;
582
+ notNull: false;
583
+ hasDefault: false;
584
+ isPrimaryKey: false;
585
+ isAutoincrement: false;
586
+ hasRuntimeDefault: false;
587
+ enumValues: [string, ...string[]];
588
+ baseColumn: never;
589
+ identity: undefined;
590
+ generated: undefined;
591
+ }, {}, {}>;
592
+ tenantKind: drizzle_orm_pg_core.PgColumn<{
593
+ name: "tenant_kind";
594
+ tableName: "durable_workflow_runs";
595
+ dataType: "string";
596
+ columnType: "PgText";
597
+ data: string;
598
+ driverParam: string;
599
+ notNull: false;
600
+ hasDefault: false;
601
+ isPrimaryKey: false;
602
+ isAutoincrement: false;
603
+ hasRuntimeDefault: false;
604
+ enumValues: [string, ...string[]];
605
+ baseColumn: never;
606
+ identity: undefined;
607
+ generated: undefined;
608
+ }, {}, {}>;
534
609
  createdAt: drizzle_orm_pg_core.PgColumn<{
535
610
  name: string;
536
611
  tableName: "durable_workflow_runs";
@@ -1147,6 +1222,64 @@ declare const durableBufferedEvents: drizzle_orm_pg_core.PgTableWithColumns<{
1147
1222
  };
1148
1223
  dialect: "pg";
1149
1224
  }>;
1225
+ declare const durableSignalIds: drizzle_orm_pg_core.PgTableWithColumns<{
1226
+ name: "durable_signal_ids";
1227
+ schema: undefined;
1228
+ columns: {
1229
+ token: drizzle_orm_pg_core.PgColumn<{
1230
+ name: "token";
1231
+ tableName: "durable_signal_ids";
1232
+ dataType: "string";
1233
+ columnType: "PgText";
1234
+ data: string;
1235
+ driverParam: string;
1236
+ notNull: true;
1237
+ hasDefault: false;
1238
+ isPrimaryKey: false;
1239
+ isAutoincrement: false;
1240
+ hasRuntimeDefault: false;
1241
+ enumValues: [string, ...string[]];
1242
+ baseColumn: never;
1243
+ identity: undefined;
1244
+ generated: undefined;
1245
+ }, {}, {}>;
1246
+ signalId: drizzle_orm_pg_core.PgColumn<{
1247
+ name: "signal_id";
1248
+ tableName: "durable_signal_ids";
1249
+ dataType: "string";
1250
+ columnType: "PgText";
1251
+ data: string;
1252
+ driverParam: string;
1253
+ notNull: true;
1254
+ hasDefault: false;
1255
+ isPrimaryKey: false;
1256
+ isAutoincrement: false;
1257
+ hasRuntimeDefault: false;
1258
+ enumValues: [string, ...string[]];
1259
+ baseColumn: never;
1260
+ identity: undefined;
1261
+ generated: undefined;
1262
+ }, {}, {}>;
1263
+ expiresAt: drizzle_orm_pg_core.PgColumn<{
1264
+ name: string;
1265
+ tableName: "durable_signal_ids";
1266
+ dataType: "date";
1267
+ columnType: "PgTimestamp";
1268
+ data: Date;
1269
+ driverParam: string;
1270
+ notNull: true;
1271
+ hasDefault: false;
1272
+ isPrimaryKey: false;
1273
+ isAutoincrement: false;
1274
+ hasRuntimeDefault: false;
1275
+ enumValues: undefined;
1276
+ baseColumn: never;
1277
+ identity: undefined;
1278
+ generated: undefined;
1279
+ }, {}, {}>;
1280
+ };
1281
+ dialect: "pg";
1282
+ }>;
1150
1283
  declare const durableSchedules: drizzle_orm_pg_core.PgTableWithColumns<{
1151
1284
  name: "durable_schedules";
1152
1285
  schema: undefined;
@@ -1293,6 +1426,40 @@ declare const durableSchedules: drizzle_orm_pg_core.PgTableWithColumns<{
1293
1426
  }, {}, {
1294
1427
  $type: Record<string, unknown>;
1295
1428
  }>;
1429
+ tenantId: drizzle_orm_pg_core.PgColumn<{
1430
+ name: "tenant_id";
1431
+ tableName: "durable_schedules";
1432
+ dataType: "string";
1433
+ columnType: "PgText";
1434
+ data: string;
1435
+ driverParam: string;
1436
+ notNull: false;
1437
+ hasDefault: false;
1438
+ isPrimaryKey: false;
1439
+ isAutoincrement: false;
1440
+ hasRuntimeDefault: false;
1441
+ enumValues: [string, ...string[]];
1442
+ baseColumn: never;
1443
+ identity: undefined;
1444
+ generated: undefined;
1445
+ }, {}, {}>;
1446
+ tenantKind: drizzle_orm_pg_core.PgColumn<{
1447
+ name: "tenant_kind";
1448
+ tableName: "durable_schedules";
1449
+ dataType: "string";
1450
+ columnType: "PgText";
1451
+ data: string;
1452
+ driverParam: string;
1453
+ notNull: false;
1454
+ hasDefault: false;
1455
+ isPrimaryKey: false;
1456
+ isAutoincrement: false;
1457
+ hasRuntimeDefault: false;
1458
+ enumValues: [string, ...string[]];
1459
+ baseColumn: never;
1460
+ identity: undefined;
1461
+ generated: undefined;
1462
+ }, {}, {}>;
1296
1463
  createdAt: drizzle_orm_pg_core.PgColumn<{
1297
1464
  name: string;
1298
1465
  tableName: "durable_schedules";
@@ -1633,6 +1800,40 @@ declare const durablePgSchema: {
1633
1800
  identity: undefined;
1634
1801
  generated: undefined;
1635
1802
  }, {}, {}>;
1803
+ tenantId: drizzle_orm_pg_core.PgColumn<{
1804
+ name: "tenant_id";
1805
+ tableName: "durable_workflow_runs";
1806
+ dataType: "string";
1807
+ columnType: "PgText";
1808
+ data: string;
1809
+ driverParam: string;
1810
+ notNull: false;
1811
+ hasDefault: false;
1812
+ isPrimaryKey: false;
1813
+ isAutoincrement: false;
1814
+ hasRuntimeDefault: false;
1815
+ enumValues: [string, ...string[]];
1816
+ baseColumn: never;
1817
+ identity: undefined;
1818
+ generated: undefined;
1819
+ }, {}, {}>;
1820
+ tenantKind: drizzle_orm_pg_core.PgColumn<{
1821
+ name: "tenant_kind";
1822
+ tableName: "durable_workflow_runs";
1823
+ dataType: "string";
1824
+ columnType: "PgText";
1825
+ data: string;
1826
+ driverParam: string;
1827
+ notNull: false;
1828
+ hasDefault: false;
1829
+ isPrimaryKey: false;
1830
+ isAutoincrement: false;
1831
+ hasRuntimeDefault: false;
1832
+ enumValues: [string, ...string[]];
1833
+ baseColumn: never;
1834
+ identity: undefined;
1835
+ generated: undefined;
1836
+ }, {}, {}>;
1636
1837
  createdAt: drizzle_orm_pg_core.PgColumn<{
1637
1838
  name: string;
1638
1839
  tableName: "durable_workflow_runs";
@@ -2249,6 +2450,64 @@ declare const durablePgSchema: {
2249
2450
  };
2250
2451
  dialect: "pg";
2251
2452
  }>;
2453
+ durableSignalIds: drizzle_orm_pg_core.PgTableWithColumns<{
2454
+ name: "durable_signal_ids";
2455
+ schema: undefined;
2456
+ columns: {
2457
+ token: drizzle_orm_pg_core.PgColumn<{
2458
+ name: "token";
2459
+ tableName: "durable_signal_ids";
2460
+ dataType: "string";
2461
+ columnType: "PgText";
2462
+ data: string;
2463
+ driverParam: string;
2464
+ notNull: true;
2465
+ hasDefault: false;
2466
+ isPrimaryKey: false;
2467
+ isAutoincrement: false;
2468
+ hasRuntimeDefault: false;
2469
+ enumValues: [string, ...string[]];
2470
+ baseColumn: never;
2471
+ identity: undefined;
2472
+ generated: undefined;
2473
+ }, {}, {}>;
2474
+ signalId: drizzle_orm_pg_core.PgColumn<{
2475
+ name: "signal_id";
2476
+ tableName: "durable_signal_ids";
2477
+ dataType: "string";
2478
+ columnType: "PgText";
2479
+ data: string;
2480
+ driverParam: string;
2481
+ notNull: true;
2482
+ hasDefault: false;
2483
+ isPrimaryKey: false;
2484
+ isAutoincrement: false;
2485
+ hasRuntimeDefault: false;
2486
+ enumValues: [string, ...string[]];
2487
+ baseColumn: never;
2488
+ identity: undefined;
2489
+ generated: undefined;
2490
+ }, {}, {}>;
2491
+ expiresAt: drizzle_orm_pg_core.PgColumn<{
2492
+ name: string;
2493
+ tableName: "durable_signal_ids";
2494
+ dataType: "date";
2495
+ columnType: "PgTimestamp";
2496
+ data: Date;
2497
+ driverParam: string;
2498
+ notNull: true;
2499
+ hasDefault: false;
2500
+ isPrimaryKey: false;
2501
+ isAutoincrement: false;
2502
+ hasRuntimeDefault: false;
2503
+ enumValues: undefined;
2504
+ baseColumn: never;
2505
+ identity: undefined;
2506
+ generated: undefined;
2507
+ }, {}, {}>;
2508
+ };
2509
+ dialect: "pg";
2510
+ }>;
2252
2511
  durableSchedules: drizzle_orm_pg_core.PgTableWithColumns<{
2253
2512
  name: "durable_schedules";
2254
2513
  schema: undefined;
@@ -2395,6 +2654,40 @@ declare const durablePgSchema: {
2395
2654
  }, {}, {
2396
2655
  $type: Record<string, unknown>;
2397
2656
  }>;
2657
+ tenantId: drizzle_orm_pg_core.PgColumn<{
2658
+ name: "tenant_id";
2659
+ tableName: "durable_schedules";
2660
+ dataType: "string";
2661
+ columnType: "PgText";
2662
+ data: string;
2663
+ driverParam: string;
2664
+ notNull: false;
2665
+ hasDefault: false;
2666
+ isPrimaryKey: false;
2667
+ isAutoincrement: false;
2668
+ hasRuntimeDefault: false;
2669
+ enumValues: [string, ...string[]];
2670
+ baseColumn: never;
2671
+ identity: undefined;
2672
+ generated: undefined;
2673
+ }, {}, {}>;
2674
+ tenantKind: drizzle_orm_pg_core.PgColumn<{
2675
+ name: "tenant_kind";
2676
+ tableName: "durable_schedules";
2677
+ dataType: "string";
2678
+ columnType: "PgText";
2679
+ data: string;
2680
+ driverParam: string;
2681
+ notNull: false;
2682
+ hasDefault: false;
2683
+ isPrimaryKey: false;
2684
+ isAutoincrement: false;
2685
+ hasRuntimeDefault: false;
2686
+ enumValues: [string, ...string[]];
2687
+ baseColumn: never;
2688
+ identity: undefined;
2689
+ generated: undefined;
2690
+ }, {}, {}>;
2398
2691
  createdAt: drizzle_orm_pg_core.PgColumn<{
2399
2692
  name: string;
2400
2693
  tableName: "durable_schedules";
@@ -2440,4 +2733,4 @@ declare const durablePgSchema: {
2440
2733
  */
2441
2734
  declare function durablePgManagedTables(): string[];
2442
2735
 
2443
- export { DEFAULT_NAMESPACE, DURABLE_PG_DDL, type DrizzlePgDatabase, type DrizzlePgSqlExecutor, DrizzlePgStateStore, type DrizzlePgStateStoreOptions, type DurableSchemaLogger, type EnsureDrizzlePgDurableSchemaOptions, drizzlePgExecutor, drizzlePgSchemaRepairWarning, durableBufferedEvents, durableBufferedSignals, durablePgManagedTables, durablePgSchema, durableRunAttributes, durableSchedules, durableSignalWaiters, durableStepCheckpoints, durableWorkflowRuns, ensureDrizzlePgDurableSchema, rowsOf, toDrizzleSql };
2736
+ export { DEFAULT_NAMESPACE, DURABLE_PG_DDL, type DrizzlePgDatabase, type DrizzlePgSqlExecutor, DrizzlePgStateStore, type DrizzlePgStateStoreOptions, type DurableSchemaLogger, type EnsureDrizzlePgDurableSchemaOptions, drizzlePgExecutor, drizzlePgSchemaRepairWarning, durableBufferedEvents, durableBufferedSignals, durablePgManagedTables, durablePgSchema, durableRunAttributes, durableSchedules, durableSignalIds, durableSignalWaiters, durableStepCheckpoints, durableWorkflowRuns, ensureDrizzlePgDurableSchema, rowsOf, toDrizzleSql };