@dbos-inc/dbos-sdk 5.4.11-preview → 5.5.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.
Files changed (64) hide show
  1. package/dist/schemas/system_db_schema.d.ts +7 -0
  2. package/dist/schemas/system_db_schema.d.ts.map +1 -1
  3. package/dist/schemas/system_db_schema.js.map +1 -1
  4. package/dist/src/client.d.ts +26 -2
  5. package/dist/src/client.d.ts.map +1 -1
  6. package/dist/src/client.js +65 -1
  7. package/dist/src/client.js.map +1 -1
  8. package/dist/src/config.d.ts.map +1 -1
  9. package/dist/src/config.js +3 -0
  10. package/dist/src/config.js.map +1 -1
  11. package/dist/src/dbos-executor.d.ts +26 -1
  12. package/dist/src/dbos-executor.d.ts.map +1 -1
  13. package/dist/src/dbos-executor.js +50 -7
  14. package/dist/src/dbos-executor.js.map +1 -1
  15. package/dist/src/dbos.d.ts +74 -5
  16. package/dist/src/dbos.d.ts.map +1 -1
  17. package/dist/src/dbos.js +139 -22
  18. package/dist/src/dbos.js.map +1 -1
  19. package/dist/src/debugpoint.d.ts +1 -0
  20. package/dist/src/debugpoint.d.ts.map +1 -1
  21. package/dist/src/debugpoint.js +4 -2
  22. package/dist/src/debugpoint.js.map +1 -1
  23. package/dist/src/enterprise.d.ts +56 -1
  24. package/dist/src/enterprise.d.ts.map +1 -1
  25. package/dist/src/enterprise.js +26 -4
  26. package/dist/src/enterprise.js.map +1 -1
  27. package/dist/src/error.d.ts +42 -0
  28. package/dist/src/error.d.ts.map +1 -1
  29. package/dist/src/error.js +85 -1
  30. package/dist/src/error.js.map +1 -1
  31. package/dist/src/external_storage.d.ts +27 -0
  32. package/dist/src/external_storage.d.ts.map +1 -0
  33. package/dist/src/external_storage.js +28 -0
  34. package/dist/src/external_storage.js.map +1 -0
  35. package/dist/src/index.d.ts +4 -3
  36. package/dist/src/index.d.ts.map +1 -1
  37. package/dist/src/index.js +2 -1
  38. package/dist/src/index.js.map +1 -1
  39. package/dist/src/scheduler/scheduler.d.ts +78 -3
  40. package/dist/src/scheduler/scheduler.d.ts.map +1 -1
  41. package/dist/src/scheduler/scheduler.js +414 -173
  42. package/dist/src/scheduler/scheduler.js.map +1 -1
  43. package/dist/src/sysdb_migrations/internal/migrations.js +82 -0
  44. package/dist/src/sysdb_migrations/internal/migrations.js.map +1 -1
  45. package/dist/src/system_database.d.ts +51 -10
  46. package/dist/src/system_database.d.ts.map +1 -1
  47. package/dist/src/system_database.js +418 -207
  48. package/dist/src/system_database.js.map +1 -1
  49. package/dist/src/utils.d.ts +2 -0
  50. package/dist/src/utils.d.ts.map +1 -1
  51. package/dist/src/utils.js +9 -1
  52. package/dist/src/utils.js.map +1 -1
  53. package/dist/src/wfqueue.js +1 -1
  54. package/dist/src/wfqueue.js.map +1 -1
  55. package/dist/src/workflow.d.ts +3 -1
  56. package/dist/src/workflow.d.ts.map +1 -1
  57. package/dist/src/workflow.js +16 -3
  58. package/dist/src/workflow.js.map +1 -1
  59. package/dist/src/workflow_management.d.ts +16 -4
  60. package/dist/src/workflow_management.d.ts.map +1 -1
  61. package/dist/src/workflow_management.js +74 -32
  62. package/dist/src/workflow_management.js.map +1 -1
  63. package/dist/tsconfig.tsbuildinfo +1 -1
  64. package/package.json +2 -2
@@ -1,6 +1,7 @@
1
1
  import { type SystemDatabase, WorkflowScheduleInternal } from '../system_database';
2
2
  import { DBOSSerializer } from '../serialization';
3
- import { DBOSLifecycleCallback } from '../decorators';
3
+ import { TimeMatcher } from './crontab';
4
+ import type { GlobalLogger } from '../telemetry/logs';
4
5
  export type ScheduledWorkflowFn = (scheduledDate: Date, context: any) => Promise<void>;
5
6
  export interface ScheduleOptions {
6
7
  automaticBackfill?: boolean;
@@ -26,14 +27,88 @@ export interface WorkflowSchedule {
26
27
  export declare function toWorkflowSchedule(internal: WorkflowScheduleInternal, serializer: DBOSSerializer): Promise<WorkflowSchedule>;
27
28
  export declare function createScheduleId(): string;
28
29
  export declare function scheduleSignature(sched: WorkflowScheduleInternal): string;
29
- export declare class DynamicSchedulerLoop implements DBOSLifecycleCallback {
30
+ export declare const schedulerConfig: {
31
+ /** Most scheduled runs enqueued in one transaction. */
32
+ fireBatchSize: number;
33
+ /** How long a standby keeps a tick no poll has shown fired, or three polling intervals if longer. */
34
+ bufferMinMs: number;
35
+ /** How far back a starting scheduler arms each schedule, so a tick missed while its leader died still fires. */
36
+ startupLookbackMs: number;
37
+ /** How often a scheduler that isn't firing checks whether it has taken over. */
38
+ standbyCheckMs: number;
39
+ };
40
+ /** What a schedule's runs are enqueued with. */
41
+ export interface ScheduleDefinition {
42
+ scheduleName: string;
43
+ workflowName: string;
44
+ workflowClassName: string;
45
+ context: unknown;
46
+ queueName?: string;
47
+ applicationName?: string;
48
+ shardKey?: string;
49
+ }
50
+ export declare function scheduleDefinition(sched: WorkflowScheduleInternal, serializer: DBOSSerializer): Promise<ScheduleDefinition>;
51
+ /** An active schedule in the scheduler and its next tick. */
52
+ export declare class ScheduleEntry {
53
+ readonly definition: ScheduleDefinition;
54
+ readonly matcher: TimeMatcher;
55
+ readonly scheduleId: string;
56
+ readonly signature: string;
57
+ nextTime: number;
58
+ private constructor();
59
+ /** Arm `sched` at its first tick after `after`, by default now. Throws if it can't run. */
60
+ static create(sched: WorkflowScheduleInternal, matcher: TimeMatcher, serializer: DBOSSerializer, after?: number): Promise<ScheduleEntry>;
61
+ advance(): void;
62
+ advancePast(lastFired: number): void;
63
+ }
64
+ /** A min-heap of entries by next tick, ties in push order. */
65
+ declare class TickHeap {
66
+ #private;
67
+ get size(): number;
68
+ /** The earliest tick, or Infinity if empty. */
69
+ peek(): number;
70
+ push(entry: ScheduleEntry): void;
71
+ pop(): ScheduleEntry;
72
+ }
73
+ /** Fires every active schedule from one loop, enqueueing each tick's runs in batches. */
74
+ export declare class Scheduler {
75
+ #private;
76
+ readonly systemDatabase: SystemDatabase;
77
+ readonly serializer: DBOSSerializer;
78
+ readonly logger: GlobalLogger;
79
+ readonly entries: Map<string, ScheduleEntry>;
80
+ heap: TickHeap;
81
+ constructor(systemDatabase: SystemDatabase, serializer: DBOSSerializer, logger: GlobalLogger);
82
+ /** Sync the armed schedules with the database, then rebuild the heap from them. */
83
+ poll(): Promise<void>;
84
+ /** Milliseconds until the earliest tick is `lag` milliseconds old, Infinity if none. */
85
+ msUntilDue(lag?: number): number;
86
+ /** Fire every due tick, batch by batch, until `signal` aborts. */
87
+ fireDue(signal: AbortSignal): Promise<void>;
88
+ /** Pass over ticks older than `before` without firing them. */
89
+ skipDue(before: number): void;
90
+ }
91
+ /** Poll schedules until aborted, firing only while `leading()`; a standby keeps each tick until a poll shows it fired, so a taker fires all it missed. */
92
+ export declare function schedulerLoop(signal: AbortSignal, scheduler: Scheduler, pollingIntervalMs: number, leading: () => boolean): Promise<void>;
93
+ /** Runs the scheduler loop from `initialize` until `destroy`, firing while `leading()`. */
94
+ export declare class DynamicSchedulerLoop {
30
95
  #private;
31
- constructor(pollingIntervalMs?: number);
96
+ readonly systemDatabase: SystemDatabase;
97
+ readonly serializer: DBOSSerializer;
98
+ readonly logger: GlobalLogger;
99
+ readonly leading: () => boolean;
100
+ constructor(systemDatabase: SystemDatabase, serializer: DBOSSerializer, logger: GlobalLogger, pollingIntervalMs: number | undefined, leading: () => boolean);
101
+ /** Start the loop; a no-op while it runs. */
32
102
  initialize(): Promise<void>;
103
+ /** Stop the loop and wait for it to end; a no-op if it isn't running. */
33
104
  destroy(): Promise<void>;
34
105
  }
106
+ /** Enqueue these scheduled runs in one batch, skipping existing ones. Returns their workflow IDs. */
107
+ export declare function enqueueTicks(systemDatabase: SystemDatabase, serializer: DBOSSerializer, ticks: [ScheduleDefinition, number][], stampLastFired: boolean): Promise<string[]>;
35
108
  export declare function triggerSchedule(systemDatabase: SystemDatabase, serializer: DBOSSerializer, name: string): Promise<string>;
109
+ /** Enqueue every scheduled execution between `start` and `end`. Returns their workflow IDs. */
36
110
  export declare function backfillSchedule(systemDatabase: SystemDatabase, serializer: DBOSSerializer, name: string, start: Date, end: Date): Promise<string[]>;
37
111
  /** The shard key a schedule's workflows run under. */
38
112
  export declare function scheduleShardKey(systemDatabase: SystemDatabase, name: string): Promise<string | undefined>;
113
+ export {};
39
114
  //# sourceMappingURL=scheduler.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../../src/scheduler/scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,wBAAwB,EAA+B,MAAM,oBAAoB,CAAC;AAChH,OAAO,EAAE,cAAc,EAAiB,MAAM,kBAAkB,CAAC;AAGjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAWtD,MAAM,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvF,MAAM,WAAW,eAAe;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,wBAAwB,EAClC,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAkB3B;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CAEzC;AASD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,wBAAwB,GAAG,MAAM,CAUzE;AAUD,qBAAa,oBAAqB,YAAW,qBAAqB;;gBAMpD,iBAAiB,CAAC,EAAE,MAAM;IAKhC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CA6M/B;AA4CD,wBAAsB,eAAe,CACnC,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAsB,gBAAgB,CACpC,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,IAAI,EACX,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,MAAM,EAAE,CAAC,CA6BnB;AAED,sDAAsD;AACtD,wBAAsB,gBAAgB,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAEhH"}
1
+ {"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../../src/scheduler/scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,wBAAwB,EAA+B,MAAM,oBAAoB,CAAC;AAChH,OAAO,EAAE,cAAc,EAAiB,MAAM,kBAAkB,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOtD,MAAM,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvF,MAAM,WAAW,eAAe;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,wBAAwB,EAClC,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAkB3B;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CAEzC;AAGD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,wBAAwB,GAAG,MAAM,CAUzE;AAED,eAAO,MAAM,eAAe;IAC1B,uDAAuD;;IAEvD,qGAAqG;;IAErG,gHAAgH;;IAEhH,gFAAgF;;CAEjF,CAAC;AAUF,gDAAgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,wBAAwB,EAC/B,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAU7B;AAYD,6DAA6D;AAC7D,qBAAa,aAAa;IAQtB,QAAQ,CAAC,UAAU,EAAE,kBAAkB;IACvC,QAAQ,CAAC,OAAO,EAAE,WAAW;IAR/B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO;IAWP,2FAA2F;WAC9E,MAAM,CACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,cAAc,EAC1B,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,aAAa,CAAC;IAKzB,OAAO,IAAI,IAAI;IAIf,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;CAKrC;AAED,8DAA8D;AAC9D,cAAM,QAAQ;;IAIZ,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,+CAA+C;IAC/C,IAAI,IAAI,MAAM;IAId,IAAI,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAYhC,GAAG,IAAI,aAAa;CA0BrB;AAED,yFAAyF;AACzF,qBAAa,SAAS;;IASlB,QAAQ,CAAC,cAAc,EAAE,cAAc;IACvC,QAAQ,CAAC,UAAU,EAAE,cAAc;IACnC,QAAQ,CAAC,MAAM,EAAE,YAAY;IAT/B,QAAQ,CAAC,OAAO,6BAAoC;IAEpD,IAAI,WAAkB;gBAKX,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,YAAY;IAG/B,mFAAmF;IAC7E,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA0F3B,wFAAwF;IACxF,UAAU,CAAC,GAAG,GAAE,MAAU,GAAG,MAAM;IAInC,kEAAkE;IAC5D,OAAO,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD,+DAA+D;IAC/D,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAqD9B;AAcD,0JAA0J;AAC1J,wBAAsB,aAAa,CACjC,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,MAAM,OAAO,GACrB,OAAO,CAAC,IAAI,CAAC,CAoCf;AAED,2FAA2F;AAC3F,qBAAa,oBAAoB;;IAM7B,QAAQ,CAAC,cAAc,EAAE,cAAc;IACvC,QAAQ,CAAC,UAAU,EAAE,cAAc;IACnC,QAAQ,CAAC,MAAM,EAAE,YAAY;IAE7B,QAAQ,CAAC,OAAO,EAAE,MAAM,OAAO;gBAJtB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,YAAY,EAC7B,iBAAiB,EAAE,MAAM,GAAG,SAAS,EAC5B,OAAO,EAAE,MAAM,OAAO;IAKjC,6CAA6C;IACvC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAYjC,yEAAyE;IACnE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAW/B;AA4CD,qGAAqG;AACrG,wBAAsB,YAAY,CAChC,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,CAAC,kBAAkB,EAAE,MAAM,CAAC,EAAE,EACrC,cAAc,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBnB;AAED,wBAAsB,eAAe,CACnC,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAejB;AAED,+FAA+F;AAC/F,wBAAsB,gBAAgB,CACpC,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,cAAc,EAC1B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,IAAI,EACX,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,MAAM,EAAE,CAAC,CAmBnB;AAED,sDAAsD;AACtD,wBAAsB,gBAAgB,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAEhH"}