@cedarjs/jobs 8.0.0-canary.3421 → 8.0.0-canary.3423

package/dist/adapters/BaseAdapter/BaseAdapter.d.ts

@@ -7,6 +7,38 @@ export interface SchedulePayload {
     runAt: Date;
     queue: string;
     priority: number;
+    /**
+     * The job's unique key, if it was scheduled with one. Only passed to
+     * adapters that set `supportsUniqueKeys`. While a job with this key is
+     * still queued, the adapter must not add another one (see
+     * `ScheduleJobOptions['key']`)
+     */
+    key?: string | undefined;
+}
+/** A recurring schedule declared in code, as passed to `syncSchedules()` */
+export interface ScheduleDefinition extends SchedulePayload {
+    cron: string;
+    /**
+     * The schedule's identity: `SCHEDULE_KEY_PREFIX`, the job's name and the
+     * schedule's own key, like `cedar:schedule:ReportJob:nightly`
+     */
+    key: string;
+}
+export interface SyncSchedulesOptions {
+    /** Every schedule declared in the app's code */
+    schedules: ScheduleDefinition[];
+    /**
+     * Every schedule key starts with this prefix. Stored schedules with this
+     * prefix that are not in `schedules` must be removed
+     */
+    keyPrefix: string;
+}
+/** The keys of the schedules `syncSchedules()` touched, by what it did */
+export interface SyncSchedulesResult {
+    created: string[];
+    updated: string[];
+    removed: string[];
+    unchanged: string[];
 }
 export interface FindArgs {
     processName: string;
@@ -108,6 +140,12 @@ export interface ListedJob {
 export declare abstract class BaseAdapter<TOptions extends BaseAdapterOptions = BaseAdapterOptions, TScheduleReturn = unknown> {
     options: TOptions;
     logger: NonNullable<TOptions['logger']>;
+    /**
+     * Whether `schedule()` honors `payload.key` (see `SchedulePayload['key']`).
+     * Scheduling a job with a `key` through an adapter that doesn't throws a
+     * `UniqueKeysNotSupportedError`, so a key is never silently ignored
+     */
+    readonly supportsUniqueKeys: boolean;
     constructor(options: TOptions);
     abstract schedule(payload: SchedulePayload): TScheduleReturn;
     /**
@@ -151,6 +189,22 @@ export declare abstract class BaseAdapter<TOptions extends BaseAdapterOptions =
      * cancellation and `later.cancel()` will throw a `CancelNotImplementedError`
      */
     cancel?(options: CancelOptions): boolean | Promise<boolean>;
+    /**
+     * Makes the stored recurring schedules match `options.schedules`, the ones
+     * declared in code. Called by every job worker when it starts, so several
+     * calls can run at the same time and must not create duplicates:
+     * - a declared schedule without a stored job is created, with its `runAt`
+     *   at the next match of its `cron`
+     * - a stored schedule whose job name, path, args, queue, priority or cron
+     *   differ from the declaration is updated
+     * - a stored schedule (key starting with `options.keyPrefix`) that is not
+     *   declared any more is removed
+     *
+     * This method is optional: declaring `schedules` on a job with an adapter
+     * that doesn't implement it makes the workers throw a
+     * `SchedulesNotSupportedError` when they start
+     */
+    syncSchedules?(options: SyncSchedulesOptions): SyncSchedulesResult | Promise<SyncSchedulesResult>;
     /**
      * Pause a job, so that no worker picks it up until it's resumed. A run in
      * progress finishes, and a recurring job's next run stays paused: `success()`

package/dist/adapters/BaseAdapter/BaseAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/BaseAdapter/BaseAdapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAG3E,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,KAAK,EAAE,IAAI,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC5D,GAAG,EAAE,IAAI,CAAA;IACT;;;;OAIG;IACH,KAAK,EAAE,IAAI,GAAG,SAAS,CAAA;IACvB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,YAAY,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC1D,GAAG,EAAE,IAAI,CAAA;IACT,KAAK,EAAE,IAAI,CAAA;IACX,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC5D,GAAG,EAAE,IAAI,CAAA;IACT,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,aAAa,EAAE,OAAO,CAAA;IACtB,8BAA8B;IAC9B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,SAAS,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,sEAAsE;AACtE,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,8DAA8D;IAC9D,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,uDAAuD;IACvD,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,8BAAsB,WAAW,CAC/B,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,eAAe,GAAG,OAAO;IAEzB,OAAO,EAAE,QAAQ,CAAA;IACjB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAE3B,OAAO,EAAE,QAAQ;IAY7B,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,eAAe;IAE5D;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAEzE;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,KAAK,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtC;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE3D;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAEjE;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CACpE"}
+{"version":3,"file":"BaseAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/BaseAdapter/BaseAdapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAG3E,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,KAAK,EAAE,IAAI,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB;AAED,4EAA4E;AAC5E,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,SAAS,EAAE,kBAAkB,EAAE,CAAA;IAC/B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,0EAA0E;AAC1E,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC5D,GAAG,EAAE,IAAI,CAAA;IACT;;;;OAIG;IACH,KAAK,EAAE,IAAI,GAAG,SAAS,CAAA;IACvB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,YAAY,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC1D,GAAG,EAAE,IAAI,CAAA;IACT,KAAK,EAAE,IAAI,CAAA;IACX,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,OAAO,GAAG,OAAO;IAC5D,GAAG,EAAE,IAAI,CAAA;IACT,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,aAAa,EAAE,OAAO,CAAA;IACtB,8BAA8B;IAC9B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,SAAS,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,sEAAsE;AACtE,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,8DAA8D;IAC9D,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,uDAAuD;IACvD,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,8BAAsB,WAAW,CAC/B,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,eAAe,GAAG,OAAO;IAEzB,OAAO,EAAE,QAAQ,CAAA;IACjB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEvC;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAQ;gBAEhC,OAAO,EAAE,QAAQ;IAY7B,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,eAAe;IAE5D;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAEzE;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,KAAK,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtC;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE3D;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,CACZ,OAAO,EAAE,oBAAoB,GAC5B,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAEjE;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CACpE"}

package/dist/adapters/BaseAdapter/BaseAdapter.js

@@ -2,6 +2,12 @@ import { DEFAULT_LOGGER } from "../../consts.js";
 class BaseAdapter {
   options;
   logger;
+  /**
+   * Whether `schedule()` honors `payload.key` (see `SchedulePayload['key']`).
+   * Scheduling a job with a `key` through an adapter that doesn't throws a
+   * `UniqueKeysNotSupportedError`, so a key is never silently ignored
+   */
+  supportsUniqueKeys = false;
   constructor(options) {
     this.options = options;
     this.logger = options?.logger ?? DEFAULT_LOGGER;

package/dist/adapters/PrismaAdapter/PrismaAdapter.d.ts

@@ -1,5 +1,5 @@
 import type { BaseJob } from '../../types.js';
-import type { BaseAdapterOptions, ListedJob, ListJobsOptions, PauseOptions, PauseResult, ResumeOptions, ResumeResult, SchedulePayload, FindArgs, SuccessOptions, ErrorOptions, FailureOptions, CancelOptions } from '../BaseAdapter/BaseAdapter.js';
+import type { BaseAdapterOptions, ListedJob, ListJobsOptions, PauseOptions, PauseResult, ResumeOptions, ResumeResult, SchedulePayload, SyncSchedulesOptions, SyncSchedulesResult, FindArgs, SuccessOptions, ErrorOptions, FailureOptions, CancelOptions } from '../BaseAdapter/BaseAdapter.js';
 import { BaseAdapter } from '../BaseAdapter/BaseAdapter.js';
 export interface PrismaJob extends BaseJob {
     id: number;
@@ -22,6 +22,20 @@ export interface PrismaJob extends BaseJob {
     pausedAt?: Date | null;
     createdAt: Date;
     updatedAt: Date;
+    /**
+     * The job's unique key. Only queued jobs and active recurring jobs hold
+     * their key, it's null once a worker has picked up a non-recurring job.
+     * Undefined when the model has no `key` column
+     */
+    key?: string | null;
+}
+/** What `schedule()` returns: the stored job */
+export interface ScheduledPrismaJob extends PrismaJob {
+    /**
+     * `true` when the job was scheduled with a `key` and a job with that key
+     * was already queued. No new job was added, and this is the queued job
+     */
+    alreadyQueued: boolean;
 }
 interface PrismaAdapterDelegate {
     findFirst(args: Record<string, unknown>): Promise<any>;
@@ -32,7 +46,7 @@ interface PrismaAdapterDelegate {
     update(args: Record<string, unknown>): Promise<unknown>;
     create(args: Record<string, unknown>): Promise<unknown>;
     deleteMany(args?: Record<string, unknown>): Promise<unknown>;
-    /** Every Prisma delegate has it. Only `list()` uses it */
+    /** Every Prisma delegate has it. Only `syncSchedules()` and `list()` use it */
     findMany?(args: Record<string, unknown>): Promise<any[]>;
 }
 interface DelegateLike {
@@ -96,8 +110,9 @@ export interface PrismaAdapterOptions<TDb extends object = object> extends BaseA
  * }
  * ```
  */
-export declare class PrismaAdapter<TDb extends object = object> extends BaseAdapter<PrismaAdapterOptions<TDb>, Promise<PrismaJob>> {
+export declare class PrismaAdapter<TDb extends object = object> extends BaseAdapter<PrismaAdapterOptions<TDb>, Promise<ScheduledPrismaJob>> {
     #private;
+    readonly supportsUniqueKeys = true;
     db: TDb;
     model: DelegateKey<TDb> | string;
     accessor: PrismaAdapterDelegate;
@@ -113,7 +128,24 @@ export declare class PrismaAdapter<TDb extends object = object> extends BaseAdap
     success({ job, runAt, deleteJob }: SuccessOptions<PrismaJob>): Promise<void>;
     error({ job, runAt, error }: ErrorOptions<PrismaJob>): Promise<void>;
     failure({ job, deleteJob, error }: FailureOptions<PrismaJob>): Promise<void>;
-    schedule({ name, path, args, runAt, cron, queue, priority, }: SchedulePayload): Promise<PrismaJob>;
+    /**
+     * Schedules a job by creating a new record in the background job table.
+     * Returns the created job so that callers get access to its `id` (to cancel
+     * it later, poll its status, etc.)
+     *
+     * With a `key`, the `key` column's unique constraint makes sure only one
+     * queued job holds the key, also when several processes schedule at once.
+     * If the insert hits the constraint, the job that holds the key is
+     * returned with `alreadyQueued: true` instead
+     */
+    schedule({ name, path, args, runAt, cron, queue, priority, key, }: SchedulePayload): Promise<ScheduledPrismaJob>;
+    /**
+     * Makes the stored declared schedules match `schedules`. Each schedule is
+     * one row, identified by its unique `key`, so concurrent syncs can't create
+     * duplicates: an insert that hits the unique constraint compares against
+     * (and if needed updates) the row the other sync created instead
+     */
+    syncSchedules({ schedules, keyPrefix, }: SyncSchedulesOptions): Promise<SyncSchedulesResult>;
     /**
      * Cancels a job by marking it as permanently failed so no worker will pick
      * it up (or retry it, if it's currently being worked on).

package/dist/adapters/PrismaAdapter/PrismaAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrismaAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/PrismaAdapter/PrismaAdapter.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EACV,kBAAkB,EAClB,SAAS,EACT,eAAe,EACf,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,aAAa,EACd,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAI3D,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,4DAA4D;IAC5D,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAC/B,0DAA0D;IAC1D,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,UAAU,qBAAqB;IAC7B,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACtD,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACrE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5D,0DAA0D;IAC1D,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;CACzD;AAID,UAAU,YAAY;IACpB,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACpC;AAED,KAAK,WAAW,CAAC,GAAG,SAAS,MAAM,IAAI,OAAO,CAC5C;KACG,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,KAAK;CAC5D,CAAC,MAAM,GAAG,CAAC,EACZ,MAAM,CACP,CAAA;AAwDD,MAAM,WAAW,oBAAoB,CACnC,GAAG,SAAS,MAAM,GAAG,MAAM,CAC3B,SAAQ,kBAAkB;IAC1B;;;;;;;;;OASG;IAIH,EAAE,EAAE,GAAG,CAAA;IAEP;;;;;;;;;;OAUG;IAGH,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;CAClC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,WAAW,CACzE,oBAAoB,CAAC,GAAG,CAAC,EACzB,OAAO,CAAC,SAAS,CAAC,CACnB;;IACC,EAAE,EAAE,GAAG,CAAA;IACP,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;IAChC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAA;gBASJ,OAAO,EAAE,oBAAoB,CAAC,GAAG,CAAC;IAqB9C;;;;;OAKG;IACY,IAAI,CAAC,EAClB,WAAW,EACX,UAAU,EACV,MAAM,GACP,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAqJ7B,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,SAAS,CAAC;IAyB5D,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,YAAY,CAAC,SAAS,CAAC;IAmBpD,OAAO,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,cAAc,CAAC,SAAS,CAAC;IAyB5D,QAAQ,CAAC,EACtB,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,KAAK,EACL,QAAQ,GACT,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC;IAkBvC;;;;;;;;OAQG;IACY,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa;IAqB9C;;;;OAIG;IACY,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAiCnE;;;;;;;;;OASG;IACY,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAqEtE;;;OAGG;IACY,IAAI,CAAC,EAClB,KAAK,EACL,MAAM,EACN,MAAM,GACP,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAyC1B,KAAK;CAGrB"}
+{"version":3,"file":"PrismaAdapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/PrismaAdapter/PrismaAdapter.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EACV,kBAAkB,EAClB,SAAS,EACT,eAAe,EACf,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,EACZ,eAAe,EAEf,oBAAoB,EACpB,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,aAAa,EACd,MAAM,+BAA+B,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAQ3D,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,4DAA4D;IAC5D,KAAK,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAC/B,0DAA0D;IAC1D,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,IAAI,CAAA;IACf;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAA;CACvB;AAUD,UAAU,qBAAqB;IAC7B,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACtD,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACrE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACvD,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5D,+EAA+E;IAC/E,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;CACzD;AAID,UAAU,YAAY;IACpB,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACnC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC/B,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;CACpC;AAED,KAAK,WAAW,CAAC,GAAG,SAAS,MAAM,IAAI,OAAO,CAC5C;KACG,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,KAAK;CAC5D,CAAC,MAAM,GAAG,CAAC,EACZ,MAAM,CACP,CAAA;AA6FD,MAAM,WAAW,oBAAoB,CACnC,GAAG,SAAS,MAAM,GAAG,MAAM,CAC3B,SAAQ,kBAAkB;IAC1B;;;;;;;;;OASG;IAIH,EAAE,EAAE,GAAG,CAAA;IAEP;;;;;;;;;;OAUG;IAGH,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;CAClC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,aAAa,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,WAAW,CACzE,oBAAoB,CAAC,GAAG,CAAC,EACzB,OAAO,CAAC,kBAAkB,CAAC,CAC5B;;IACC,SAAkB,kBAAkB,QAAO;IAE3C,EAAE,EAAE,GAAG,CAAA;IACP,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;IAChC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAA;gBASJ,OAAO,EAAE,oBAAoB,CAAC,GAAG,CAAC;IAqB9C;;;;;OAKG;IACY,IAAI,CAAC,EAClB,WAAW,EACX,UAAU,EACV,MAAM,GACP,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IA8J7B,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,cAAc,CAAC,SAAS,CAAC;IAyB5D,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,YAAY,CAAC,SAAS,CAAC;IAmBpD,OAAO,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,cAAc,CAAC,SAAS,CAAC;IA8B3E;;;;;;;;;OASG;IACY,QAAQ,CAAC,EACtB,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,GAAG,GACJ,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA6DhD;;;;;OAKG;IACY,aAAa,CAAC,EAC3B,SAAS,EACT,SAAS,GACV,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqItD;;;;;;;;OAQG;IACY,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa;IA8B9C;;;;OAIG;IACY,KAAK,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAiCnE;;;;;;;;;OASG;IACY,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAqEtE;;;OAGG;IACY,IAAI,CAAC,EAClB,KAAK,EACL,MAAM,EACN,MAAM,GACP,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAyC1B,KAAK;CAGrB"}

package/dist/adapters/PrismaAdapter/PrismaAdapter.js

@@ -4,10 +4,19 @@ import {
   DEFAULT_MODEL_NAME,
   MAX_RUNTIME_GRACE_PERIOD
 } from "../../consts.js";
-import { JobIdNotFoundError, JobNotActiveError } from "../../errors.js";
+import {
+  CedarJSJobsError,
+  JobIdNotFoundError,
+  JobNotActiveError
+} from "../../errors.js";
 import { nextCronRunAt } from "../../util.js";
 import { BaseAdapter } from "../BaseAdapter/BaseAdapter.js";
-import { ModelNameError, PausedAtColumnMissingError } from "./errors.js";
+import {
+  KeyColumnMissingError,
+  ModelNameError,
+  PausedAtColumnMissingError
+} from "./errors.js";
+const MAX_KEY_RETRIES = 5;
 function isPrismaAdapterDelegate(value) {
   const candidate = value;
   return candidate !== null && typeof candidate === "object" && typeof candidate.findFirst === "function" && typeof candidate.updateMany === "function" && typeof candidate.delete === "function" && typeof candidate.update === "function" && typeof candidate.create === "function" && typeof candidate.deleteMany === "function";
@@ -29,10 +38,24 @@ function getActiveProvider(db) {
   }
   return provider;
 }
+function isUniqueViolation(e) {
+  return typeof e === "object" && e !== null && "code" in e && e.code === "P2002";
+}
+function isMissingKeyColumn(e) {
+  return e instanceof Error && e.name === "PrismaClientValidationError" && /Unknown (argument|field) `key`/.test(e.message);
+}
+function releaseKey(job) {
+  return job.key != null ? { key: null } : {};
+}
+function rowToJob(row) {
+  const { name, path, args } = JSON.parse(row.handler);
+  return { ...row, name, path, args };
+}
 function isMissingPausedAtColumn(e) {
   return e instanceof Error && e.name === "PrismaClientValidationError" && /Unknown (argument|field) `pausedAt`/.test(e.message);
 }
 class PrismaAdapter extends BaseAdapter {
+  supportsUniqueKeys = true;
   db;
   model;
   accessor;
@@ -93,7 +116,6 @@ class PrismaAdapter extends BaseAdapter {
       ...queues.length > 1 || queues[0] !== "*" ? [{ queue: { in: queues } }] : []
     ];
     const findCandidate = (withPausedAt) => this.accessor.findFirst({
-      select: { id: true, attempts: true },
       where: { AND: conditions(withPausedAt) },
       orderBy: [{ priority: "asc" }, { runAt: "asc" }],
       take: 1
@@ -122,13 +144,15 @@ class PrismaAdapter extends BaseAdapter {
         data: {
           lockedAt: /* @__PURE__ */ new Date(),
           lockedBy: processName,
-          attempts: job.attempts + 1
+          attempts: job.attempts + 1,
+          ...job.cron ? {} : releaseKey(job)
         }
       });
       if (count) {
         const data = await this.accessor.findFirst({ where: { id: job.id } });
-        const { name, path, args } = JSON.parse(data.handler);
-        return { ...data, name, path, args };
+        if (data) {
+          return rowToJob(data);
+        }
       }
     }
     return void 0;
@@ -216,7 +240,8 @@ ${error.stack}`,
     } else {
       const data = {
         failedAt: /* @__PURE__ */ new Date(),
-        runAt: null
+        runAt: null,
+        ...releaseKey(job)
       };
       if (error) {
         data.lastError = `${error.message}
@@ -229,9 +254,16 @@ ${error.stack}`;
       });
     }
   }
-  // Schedules a job by creating a new record in the background job table.
-  // Returns the created job so that callers get access to its `id` (to cancel
-  // it later, poll its status, etc.)
+  /**
+   * Schedules a job by creating a new record in the background job table.
+   * Returns the created job so that callers get access to its `id` (to cancel
+   * it later, poll its status, etc.)
+   *
+   * With a `key`, the `key` column's unique constraint makes sure only one
+   * queued job holds the key, also when several processes schedule at once.
+   * If the insert hits the constraint, the job that holds the key is
+   * returned with `alreadyQueued: true` instead
+   */
   async schedule({
     name,
     path,
@@ -239,19 +271,151 @@ ${error.stack}`;
     runAt,
     cron,
     queue,
-    priority
+    priority,
+    key
   }) {
-    const data = await this.accessor.create({
-      data: {
-        handler: JSON.stringify({ name, path, args }),
-        runAt,
-        cron,
-        queue,
-        priority
+    const job = { name, path, args };
+    const data = {
+      handler: JSON.stringify(job),
+      runAt,
+      cron,
+      queue,
+      priority,
+      ...key !== void 0 ? { key } : {}
+    };
+    if (key === void 0) {
+      return { ...await this.#create(data, job), alreadyQueued: false };
+    }
+    for (let attempt = 0; attempt <= MAX_KEY_RETRIES; attempt++) {
+      try {
+        return { ...await this.#create(data, job), alreadyQueued: false };
+      } catch (e) {
+        if (!isUniqueViolation(e)) {
+          throw e;
+        }
       }
-    });
-    const row = data;
-    return { ...row, name, path, args };
+      const queued = await this.accessor.findFirst({ where: { key } });
+      if (queued) {
+        return { ...rowToJob(queued), alreadyQueued: true };
+      }
+    }
+    throw new CedarJSJobsError(
+      `Could not schedule ${name} with the key \`${key}\`: the key was taken and released again ${MAX_KEY_RETRIES + 1} times in a row`
+    );
+  }
+  async #create(data, job) {
+    let row;
+    try {
+      row = await this.accessor.create({ data });
+    } catch (e) {
+      if (isMissingKeyColumn(e)) {
+        throw new KeyColumnMissingError(String(this.model));
+      }
+      throw e;
+    }
+    return { ...row, ...job };
+  }
+  /**
+   * Makes the stored declared schedules match `schedules`. Each schedule is
+   * one row, identified by its unique `key`, so concurrent syncs can't create
+   * duplicates: an insert that hits the unique constraint compares against
+   * (and if needed updates) the row the other sync created instead
+   */
+  async syncSchedules({
+    schedules,
+    keyPrefix
+  }) {
+    const result = {
+      created: [],
+      updated: [],
+      removed: [],
+      unchanged: []
+    };
+    if (!this.accessor.findMany) {
+      throw new ModelNameError(String(this.model));
+    }
+    let stored;
+    try {
+      stored = await this.accessor.findMany({
+        where: { key: { startsWith: keyPrefix } }
+      });
+    } catch (e) {
+      if (!isMissingKeyColumn(e)) {
+        throw e;
+      }
+      if (schedules.length === 0) {
+        return result;
+      }
+      throw new KeyColumnMissingError(String(this.model));
+    }
+    const storedByKey = new Map(stored.map((row) => [row.key, row]));
+    for (const schedule of schedules) {
+      const outcome = await this.#syncSchedule(
+        schedule,
+        storedByKey.get(schedule.key)
+      );
+      result[outcome].push(schedule.key);
+    }
+    const declared = new Set(schedules.map((schedule) => schedule.key));
+    const undeclared = stored.map((row) => row.key).filter((key) => !!key && !declared.has(key));
+    if (undeclared.length > 0) {
+      await this.accessor.deleteMany({ where: { key: { in: undeclared } } });
+      result.removed.push(...undeclared);
+    }
+    return result;
+  }
+  async #syncSchedule(schedule, stored) {
+    const { name, path, args, cron, runAt, queue, priority, key } = schedule;
+    const handler = JSON.stringify({ name, path, args });
+    let row = stored;
+    for (let attempt = 0; attempt <= MAX_KEY_RETRIES; attempt++) {
+      if (!row) {
+        try {
+          await this.accessor.create({
+            data: { handler, runAt, cron, queue, priority, key }
+          });
+          return "created";
+        } catch (e) {
+          if (!isUniqueViolation(e)) {
+            throw e;
+          }
+        }
+        row = await this.accessor.findFirst({ where: { key } });
+        if (!row) {
+          continue;
+        }
+      }
+      const changes = {};
+      if (row.handler !== handler) {
+        changes.handler = handler;
+      }
+      if (row.queue !== queue) {
+        changes.queue = queue;
+      }
+      if (row.priority !== priority) {
+        changes.priority = priority;
+      }
+      if (row.cron !== cron) {
+        changes.cron = cron;
+        if (!row.lockedAt) {
+          changes.runAt = runAt;
+        }
+      }
+      if (Object.keys(changes).length === 0) {
+        return "unchanged";
+      }
+      const { count } = await this.accessor.updateMany({
+        where: { id: row.id },
+        data: changes
+      });
+      if (count > 0) {
+        return "updated";
+      }
+      row = void 0;
+    }
+    throw new CedarJSJobsError(
+      `Could not sync the schedule \`${key}\`: it was created and removed again ${MAX_KEY_RETRIES + 1} times in a row`
+    );
   }
   /**
    * Cancels a job by marking it as permanently failed so no worker will pick
@@ -264,12 +428,16 @@ ${error.stack}`;
    */
   async cancel({ jobId }) {
     this.logger.debug(`[CedarJS Jobs] Cancelling job ${jobId}`);
+    const job = await this.accessor.findFirst({
+      where: { id: jobId }
+    });
     const { count } = await this.accessor.updateMany({
       where: { id: jobId, failedAt: null, runAt: { not: null } },
       data: {
         failedAt: /* @__PURE__ */ new Date(),
         lastError: "Job cancelled by user",
-        runAt: null
+        runAt: null,
+        ...releaseKey(job ?? {})
       }
     });
     return count > 0;

package/dist/adapters/PrismaAdapter/errors.d.ts

@@ -5,6 +5,13 @@ import { CedarJSJobsError } from '../../errors.js';
 export declare class ModelNameError extends CedarJSJobsError {
     constructor(name: string);
 }
+/**
+ * Thrown when a job is scheduled with a unique `key`, or jobs declare
+ * `schedules`, but the jobs model has no `key` column to store the key in
+ */
+export declare class KeyColumnMissingError extends CedarJSJobsError {
+    constructor(model: string);
+}
 /**
  * Thrown when a job is paused or resumed, but the jobs model has no
  * `pausedAt` column to store the pause in

package/dist/adapters/PrismaAdapter/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/adapters/PrismaAdapter/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAElD;;GAEG;AACH,qBAAa,cAAe,SAAQ,gBAAgB;gBACtC,IAAI,EAAE,MAAM;CAGzB;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;gBAClD,KAAK,EAAE,MAAM;CAO1B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/adapters/PrismaAdapter/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAElD;;GAEG;AACH,qBAAa,cAAe,SAAQ,gBAAgB;gBACtC,IAAI,EAAE,MAAM;CAGzB;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,gBAAgB;gBAC7C,KAAK,EAAE,MAAM;CAQ1B;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;gBAClD,KAAK,EAAE,MAAM;CAO1B"}

package/dist/adapters/PrismaAdapter/errors.js

@@ -4,6 +4,13 @@ class ModelNameError extends CedarJSJobsError {
     super(`Model \`${name}\` not found in PrismaClient`);
   }
 }
+class KeyColumnMissingError extends CedarJSJobsError {
+  constructor(model) {
+    super(
+      `The \`${model}\` model has no \`key\` column, which unique job keys and declared schedules need. Add \`key String? @unique\` to the model in your Prisma schema and create a migration with \`yarn cedar prisma migrate dev\``
+    );
+  }
+}
 class PausedAtColumnMissingError extends CedarJSJobsError {
   constructor(model) {
     super(
@@ -12,6 +19,7 @@ class PausedAtColumnMissingError extends CedarJSJobsError {
   }
 }
 export {
+  KeyColumnMissingError,
   ModelNameError,
   PausedAtColumnMissingError
 };

package/dist/bins/cedar-jobs-worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cedar-jobs-worker.d.ts","sourceRoot":"","sources":["../../src/bins/cedar-jobs-worker.ts"],"names":[],"mappings":";AAWA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAwC/C,eAAO,MAAM,WAAW,GAAI,iBAGzB;IACD,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B,WAEA,CAAA;AA0BD,eAAO,MAAM,SAAS,GAAU,gCAK7B;IACD,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;CACjB,oBAqBA,CAAA"}
+{"version":3,"file":"cedar-jobs-worker.d.ts","sourceRoot":"","sources":["../../src/bins/cedar-jobs-worker.ts"],"names":[],"mappings":";AAWA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAwC/C,eAAO,MAAM,WAAW,GAAI,iBAGzB;IACD,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B,WAEA,CAAA;AA0BD,eAAO,MAAM,SAAS,GAAU,gCAK7B;IACD,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;CACjB,oBA+BA,CAAA"}

package/dist/bins/cedar-jobs-worker.js

@@ -65,6 +65,9 @@ const getWorker = async ({
   if (!workerConfig) {
     throw new WorkerConfigIndexNotFoundError(index);
   }
+  if (!clear && !workoff) {
+    await manager.syncSchedules();
+  }
   return manager.createWorker({
     index,
     clear,

package/dist/consts.d.ts

@@ -30,6 +30,15 @@ export declare const DEFAULT_PRIORITY = 50;
 export declare const DEFAULT_WAIT = 0;
 export declare const DEFAULT_WAIT_UNTIL: null;
 export declare const PROCESS_TITLE_PREFIX = "cedar-jobs-worker";
+/** Job keys starting with this are reserved for keys Cedar creates itself */
+export declare const RESERVED_KEY_PREFIX = "cedar:";
+/**
+ * Keys of stored declared schedules start with this, followed by the job's
+ * name and the schedule's own key: `cedar:schedule:ReportJob:nightly`
+ */
+export declare const SCHEDULE_KEY_PREFIX = "cedar:schedule:";
+/** The key of a job's schedule when the job has one and it has no `key` */
+export declare const DEFAULT_SCHEDULE_KEY = "default";
 export declare const DEFAULT_MODEL_NAME = "BackgroundJob";
 /**
  * The name of the exported variable from the jobs config file that contains

package/dist/consts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oBAAoB,KAAK,CAAA;AACtC,yBAAyB;AACzB,eAAO,MAAM,mBAAmB,QAAS,CAAA;AACzC;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAA;AAC1C,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,IAAI,CAAA;AACpC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAA0B,CAAA;AAErD,eAAO,MAAM,8BAA8B,OAAO,CAAA;AAClD,eAAO,MAAM,0BAA0B,QAAQ,CAAA;AAC/C,eAAO,MAAM,cAAc,SAAU,CAAA;AACrC,eAAO,MAAM,aAAa,YAAY,CAAA;AACtC,eAAO,MAAM,kBAAkB,MAAM,CAAA;AACrC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAClC,eAAO,MAAM,YAAY,IAAI,CAAA;AAC7B,eAAO,MAAM,kBAAkB,MAAO,CAAA;AACtC,eAAO,MAAM,oBAAoB,sBAAsB,CAAA;AAEvD,eAAO,MAAM,kBAAkB,kBAAkB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,YAAY,CAAA;AAC7C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAW,CAAA"}
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oBAAoB,KAAK,CAAA;AACtC,yBAAyB;AACzB,eAAO,MAAM,mBAAmB,QAAS,CAAA;AACzC;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAA;AAC1C,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,IAAI,CAAA;AACpC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAA0B,CAAA;AAErD,eAAO,MAAM,8BAA8B,OAAO,CAAA;AAClD,eAAO,MAAM,0BAA0B,QAAQ,CAAA;AAC/C,eAAO,MAAM,cAAc,SAAU,CAAA;AACrC,eAAO,MAAM,aAAa,YAAY,CAAA;AACtC,eAAO,MAAM,kBAAkB,MAAM,CAAA;AACrC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAClC,eAAO,MAAM,YAAY,IAAI,CAAA;AAC7B,eAAO,MAAM,kBAAkB,MAAO,CAAA;AACtC,eAAO,MAAM,oBAAoB,sBAAsB,CAAA;AACvD,6EAA6E;AAC7E,eAAO,MAAM,mBAAmB,WAAW,CAAA;AAC3C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,oBAAoC,CAAA;AACpE,2EAA2E;AAC3E,eAAO,MAAM,oBAAoB,YAAY,CAAA;AAE7C,eAAO,MAAM,kBAAkB,kBAAkB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,YAAY,CAAA;AAC7C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAW,CAAA"}

package/dist/consts.js

@@ -13,6 +13,9 @@ const DEFAULT_PRIORITY = 50;
 const DEFAULT_WAIT = 0;
 const DEFAULT_WAIT_UNTIL = null;
 const PROCESS_TITLE_PREFIX = "cedar-jobs-worker";
+const RESERVED_KEY_PREFIX = "cedar:";
+const SCHEDULE_KEY_PREFIX = `${RESERVED_KEY_PREFIX}schedule:`;
+const DEFAULT_SCHEDULE_KEY = "default";
 const DEFAULT_MODEL_NAME = "BackgroundJob";
 const DEFAULT_ADAPTER_NAME = "adapter";
 const DEFAULT_LOGGER_NAME = "logger";
@@ -27,11 +30,14 @@ export {
   DEFAULT_MODEL_NAME,
   DEFAULT_PRIORITY,
   DEFAULT_QUEUE,
+  DEFAULT_SCHEDULE_KEY,
   DEFAULT_SLEEP_DELAY,
   DEFAULT_WAIT,
   DEFAULT_WAIT_UNTIL,
   DEFAULT_WORK_QUEUE,
   MAX_BACKOFF_MS,
   MAX_RUNTIME_GRACE_PERIOD,
-  PROCESS_TITLE_PREFIX
+  PROCESS_TITLE_PREFIX,
+  RESERVED_KEY_PREFIX,
+  SCHEDULE_KEY_PREFIX
 };

package/dist/core/Executor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Executor.d.ts","sourceRoot":"","sources":["../../src/core/Executor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAezE,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAKvD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,iDAAiD;IACjD,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,QAAQ;;;;;;CAMpB,CAAA;AAED,qBAAa,QAAQ;;IACnB,OAAO,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAA;IAClC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,EAAE,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC9C,GAAG,EAAE,OAAO,CAAA;IACZ,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAA;IACxD,UAAU,EAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAA;IACtD,gBAAgB,EAAE,WAAW,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAA;IAClE,oBAAoB,EAAE,WAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,CAAA;gBAE9D,OAAO,EAAE,eAAe;IAsBpC,IAAI,aAAa,WAEhB;IAED;;;;;;;OAOG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAgKjC;;;;OAIG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM;CAGrC"}
+{"version":3,"file":"Executor.d.ts","sourceRoot":"","sources":["../../src/core/Executor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAgBzE,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAKvD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,WAAW,CAAA;IACpB,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,iDAAiD;IACjD,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,QAAQ;;;;;;CAMpB,CAAA;AAED,qBAAa,QAAQ;;IACnB,OAAO,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAA;IAClC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,EAAE,WAAW,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC9C,GAAG,EAAE,OAAO,CAAA;IACZ,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAA;IACxD,UAAU,EAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAA;IACtD,gBAAgB,EAAE,WAAW,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAA;IAClE,oBAAoB,EAAE,WAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,CAAC,CAAA;gBAE9D,OAAO,EAAE,eAAe;IAsBpC,IAAI,aAAa,WAEhB;IAED;;;;;;;OAOG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAuKjC;;;;OAIG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM;CAGrC"}

package/dist/core/Executor.js

@@ -5,7 +5,8 @@ import {
   DEFAULT_DELETE_FAILED_JOBS,
   DEFAULT_DELETE_SUCCESSFUL_JOBS,
   DEFAULT_LOGGER,
-  MAX_BACKOFF_MS
+  MAX_BACKOFF_MS,
+  SCHEDULE_KEY_PREFIX
 } from "../consts.js";
 import {
   AdapterRequiredError,
@@ -134,12 +135,18 @@ class Executor {
    * called only after `failure()` has recorded that (a throwing `failure()`
    * is logged by `#adapterWrite()` instead). A permanently failed recurring
    * (cron) job is not rescheduled, so its schedule stops until the job is
-   * scheduled again. That is logged at error level, together with how to
-   * restart the schedule
+   * scheduled again (a declared schedule: until the workers restart and sync
+   * it). That is logged at error level, together with how to restart the
+   * schedule
    */
   #logPermanentFailure(reason) {
     const message = `[CedarJS Jobs] Failed job ${this.jobIdentifier}: ${reason}`;
-    if (this.job.cron) {
+    if (this.job.cron && this.job.key?.startsWith(SCHEDULE_KEY_PREFIX)) {
+      this.logger.error(
+        this.job,
+        `${message}. Its declared schedule (cron: '${this.job.cron}') has stopped until the job workers restart, which recreates it`
+      );
+    } else if (this.job.cron) {
       this.logger.error(
         this.job,
         `${message}. Its recurring schedule (cron: '${this.job.cron}') has stopped and the job will not run again. To restart it, schedule the job again with \`later(job, args, { cron: '${this.job.cron}' })\``