pg-workflows 0.6.1 → 0.7.1

package/dist/index.js

@@ -23,11 +23,13 @@ class WorkflowEngineError extends Error {
   workflowId;
   runId;
   cause;
-  constructor(message, workflowId, runId, cause = undefined) {
+  issues;
+  constructor(message, workflowId, runId, cause = undefined, issues) {
     super(message);
     this.workflowId = workflowId;
     this.runId = runId;
     this.cause = cause;
+    this.issues = issues;
     this.name = "WorkflowEngineError";
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, WorkflowEngineError);
@@ -164,17 +166,17 @@ function parseWorkflowHandler(handler) {
 }
 
 // src/db/migration.ts
+var MIGRATION_LOCK_ID = 738291645;
+var CURRENT_SCHEMA_VERSION = 2;
 async function runMigrations(db) {
-  const tableExistsResult = await db.executeSql(`
-    SELECT EXISTS (
-      SELECT FROM information_schema.tables 
-      WHERE table_schema = 'public' 
-      AND table_name = 'workflow_runs'
-    );
-  `, []);
-  if (!tableExistsResult.rows[0]?.exists) {
-    await db.executeSql(`
-      CREATE TABLE workflow_runs (
+  if (await isSchemaUpToDate(db)) {
+    return;
+  }
+  const currentVersion = await getCurrentVersion(db);
+  const commands = [];
+  if (currentVersion < 1) {
+    commands.push(`
+      CREATE TABLE IF NOT EXISTS workflow_runs (
         id varchar(32) PRIMARY KEY NOT NULL,
         created_at timestamp with time zone DEFAULT now() NOT NULL,
         updated_at timestamp with time zone DEFAULT now() NOT NULL,
@@ -193,25 +195,66 @@ async function runMigrations(db) {
         retry_count integer DEFAULT 0 NOT NULL,
         max_retries integer DEFAULT 0 NOT NULL,
         job_id varchar(256)
-      );
-    `, []);
-    await db.executeSql(`
-      CREATE INDEX workflow_runs_created_at_idx ON workflow_runs USING btree (created_at);
-      CREATE INDEX workflow_runs_resource_id_created_at_idx ON workflow_runs USING btree (resource_id, created_at DESC);
-      CREATE INDEX workflow_runs_status_created_at_idx ON workflow_runs USING btree (status, created_at DESC);
-      CREATE INDEX workflow_runs_workflow_id_created_at_idx ON workflow_runs USING btree (workflow_id, created_at DESC);
-      CREATE INDEX workflow_runs_resource_id_workflow_id_created_at_idx ON workflow_runs USING btree (resource_id, workflow_id, created_at DESC);
-    `, []);
+      )
+    `);
+    commands.push(`
+      CREATE INDEX IF NOT EXISTS workflow_runs_created_at_idx ON workflow_runs USING btree (created_at)
+    `);
+    commands.push(`
+      CREATE INDEX IF NOT EXISTS workflow_runs_resource_id_created_at_idx ON workflow_runs USING btree (resource_id, created_at DESC)
+    `);
+    commands.push(`
+      CREATE INDEX IF NOT EXISTS workflow_runs_status_created_at_idx ON workflow_runs USING btree (status, created_at DESC)
+    `);
+    commands.push(`
+      CREATE INDEX IF NOT EXISTS workflow_runs_workflow_id_created_at_idx ON workflow_runs USING btree (workflow_id, created_at DESC)
+    `);
+    commands.push(`
+      CREATE INDEX IF NOT EXISTS workflow_runs_resource_id_workflow_id_created_at_idx ON workflow_runs USING btree (resource_id, workflow_id, created_at DESC)
+    `);
+  }
+  if (currentVersion < 2) {
+    commands.push("DROP INDEX IF EXISTS workflow_runs_workflow_id_idx");
+    commands.push("DROP INDEX IF EXISTS workflow_runs_resource_id_idx");
+    commands.push("ALTER TABLE workflow_runs ADD COLUMN IF NOT EXISTS idempotency_key varchar(256)");
+    commands.push(`
+      CREATE UNIQUE INDEX IF NOT EXISTS workflow_runs_idempotency_key_idx ON workflow_runs (idempotency_key) WHERE idempotency_key IS NOT NULL
+    `);
+  }
+  if (currentVersion === 0) {
+    commands.push(`INSERT INTO workflow_schema_version (version) VALUES (${CURRENT_SCHEMA_VERSION})`);
   } else {
-    await db.executeSql(`
-      DROP INDEX IF EXISTS workflow_runs_workflow_id_idx;
-      DROP INDEX IF EXISTS workflow_runs_resource_id_idx;
-      CREATE INDEX IF NOT EXISTS workflow_runs_created_at_idx ON workflow_runs USING btree (created_at);
-      CREATE INDEX IF NOT EXISTS workflow_runs_resource_id_created_at_idx ON workflow_runs USING btree (resource_id, created_at DESC);
-      CREATE INDEX IF NOT EXISTS workflow_runs_status_created_at_idx ON workflow_runs USING btree (status, created_at DESC);
-      CREATE INDEX IF NOT EXISTS workflow_runs_workflow_id_created_at_idx ON workflow_runs USING btree (workflow_id, created_at DESC);
-      CREATE INDEX IF NOT EXISTS workflow_runs_resource_id_workflow_id_created_at_idx ON workflow_runs USING btree (resource_id, workflow_id, created_at DESC);
-      `, []);
+    commands.push(`UPDATE workflow_schema_version SET version = ${CURRENT_SCHEMA_VERSION}`);
+  }
+  if (commands.length === 0) {
+    return;
+  }
+  const sql = [
+    "BEGIN",
+    "SET LOCAL lock_timeout = '30s'",
+    "SET LOCAL idle_in_transaction_session_timeout = '30s'",
+    `SELECT pg_advisory_xact_lock(${MIGRATION_LOCK_ID})`,
+    "CREATE TABLE IF NOT EXISTS workflow_schema_version (version integer NOT NULL)",
+    ...commands,
+    "COMMIT"
+  ].join(`;
+`);
+  await db.executeSql(sql, []);
+}
+async function isSchemaUpToDate(db) {
+  try {
+    const result = await db.executeSql("SELECT version FROM workflow_schema_version LIMIT 1", []);
+    return (result.rows[0]?.version ?? 0) >= CURRENT_SCHEMA_VERSION;
+  } catch {
+    return false;
+  }
+}
+async function getCurrentVersion(db) {
+  try {
+    const result = await db.executeSql("SELECT version FROM workflow_schema_version LIMIT 1", []);
+    return result.rows[0]?.version ?? 0;
+  } catch {
+    return 0;
   }
 }
 
@@ -239,7 +282,8 @@ function mapRowToWorkflowRun(row) {
     timeoutAt: row.timeout_at ? new Date(row.timeout_at) : null,
     retryCount: row.retry_count,
     maxRetries: row.max_retries,
-    jobId: row.job_id
+    jobId: row.job_id,
+    idempotencyKey: row.idempotency_key
   };
 }
 async function insertWorkflowRun({
@@ -249,7 +293,8 @@ async function insertWorkflowRun({
   status,
   input,
   maxRetries,
-  timeoutAt
+  timeoutAt,
+  idempotencyKey
 }, db) {
   const runId = generateKSUID("run");
   const now = new Date;
@@ -265,9 +310,11 @@ async function insertWorkflowRun({
       created_at,
       updated_at,
       timeline,
-      retry_count
+      retry_count,
+      idempotency_key
     )
-    VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12)
+    VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
+    ON CONFLICT (idempotency_key) WHERE idempotency_key IS NOT NULL DO NOTHING
     RETURNING *`, [
     runId,
     resourceId ?? null,
@@ -280,13 +327,19 @@ async function insertWorkflowRun({
     now,
     now,
     "{}",
-    0
+    0,
+    idempotencyKey ?? null
+  ]);
+  if (result.rows[0]) {
+    return { run: mapRowToWorkflowRun(result.rows[0]), created: true };
+  }
+  const existing = await db.executeSql("SELECT * FROM workflow_runs WHERE idempotency_key = $1", [
+    idempotencyKey
   ]);
-  const insertedRun = result.rows[0];
-  if (!insertedRun) {
-    throw new Error("Failed to insert workflow run");
+  if (!existing.rows[0]) {
+    throw new Error(`Idempotency conflict: existing run not found for key "${idempotencyKey}"`);
   }
-  return mapRowToWorkflowRun(insertedRun);
+  return { run: mapRowToWorkflowRun(existing.rows[0]), created: false };
 }
 async function getWorkflowRun({
   runId,
@@ -606,6 +659,7 @@ class WorkflowEngine {
     resourceId,
     workflowId,
     input,
+    idempotencyKey,
     options
   }) {
     if (!this._started) {
@@ -621,33 +675,36 @@ class WorkflowEngine {
       throw new WorkflowEngineError(`Workflow ${workflowId} has no steps`, workflowId);
     }
     if (workflow2.inputSchema) {
-      const result = workflow2.inputSchema.safeParse(input);
-      if (!result.success) {
-        throw new WorkflowEngineError(result.error.message, workflowId);
+      const result = await workflow2.inputSchema["~standard"].validate(input);
+      if (result.issues) {
+        throw new WorkflowEngineError(JSON.stringify(result.issues), workflowId, undefined, undefined, result.issues);
       }
     }
     const initialStepId = workflow2.steps[0]?.id ?? "__start__";
     const run = await withPostgresTransaction(this.boss.getDb(), async (_db) => {
       const timeoutAt = options?.timeout ? new Date(Date.now() + options.timeout) : workflow2.timeout ? new Date(Date.now() + workflow2.timeout) : null;
-      const insertedRun = await insertWorkflowRun({
+      const { run: insertedRun, created } = await insertWorkflowRun({
         resourceId,
         workflowId,
         currentStepId: initialStepId,
         status: "running" /* RUNNING */,
         input,
         maxRetries: options?.retries ?? workflow2.retries ?? 0,
-        timeoutAt
+        timeoutAt,
+        idempotencyKey
       }, _db);
-      const job = {
-        runId: insertedRun.id,
-        resourceId,
-        workflowId,
-        input
-      };
-      await this.boss.send(WORKFLOW_RUN_QUEUE_NAME, job, {
-        startAfter: new Date,
-        expireInSeconds: options?.expireInSeconds ?? defaultExpireInSeconds
-      });
+      if (created) {
+        const job = {
+          runId: insertedRun.id,
+          resourceId,
+          workflowId,
+          input
+        };
+        await this.boss.send(WORKFLOW_RUN_QUEUE_NAME, job, {
+          startAfter: new Date,
+          expireInSeconds: options?.expireInSeconds ?? defaultExpireInSeconds
+        });
+      }
       return insertedRun;
     }, this.pool);
     this.logger.log("Started workflow run", {
@@ -1356,5 +1413,5 @@ export {
   StepType
 };
 
-//# debugId=0EF998205E7ED0B464756E2164756E21
+//# debugId=28A68A20D54F4D2C64756E2164756E21
 //# sourceMappingURL=index.js.map