pg-workflows 0.7.0 → 0.8.0

package/dist/index.js

@@ -1,50 +1,23 @@
-// src/definition.ts
-function createWorkflowFactory(plugins = []) {
-  const factory = (id, handler, { inputSchema, timeout, retries } = {}) => ({
-    id,
-    handler,
-    inputSchema,
-    timeout,
-    retries,
-    plugins: plugins.length > 0 ? plugins : undefined
-  });
-  factory.use = (plugin) => createWorkflowFactory([
-    ...plugins,
-    plugin
-  ]);
-  return factory;
-}
-var workflow = createWorkflowFactory();
+import {
+  DEFAULT_PGBOSS_SCHEMA,
+  PAUSE_EVENT_NAME,
+  StepType,
+  WORKFLOW_RUN_QUEUE_NAME,
+  WorkflowClient,
+  WorkflowEngineError,
+  WorkflowRunNotFoundError,
+  WorkflowStatus,
+  createWorkflowRef,
+  getWorkflowRun,
+  getWorkflowRuns,
+  insertWorkflowRun,
+  runMigrations,
+  updateWorkflowRun,
+  withPostgresTransaction,
+  workflow
+} from "./shared/chunk-8n9chg7z.js";
 // src/duration.ts
 import parse from "parse-duration";
-
-// src/error.ts
-class WorkflowEngineError extends Error {
-  workflowId;
-  runId;
-  cause;
-  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);
-    }
-  }
-}
-
-class WorkflowRunNotFoundError extends WorkflowEngineError {
-  constructor(runId, workflowId) {
-    super("Workflow run not found", workflowId, runId);
-    this.name = "WorkflowRunNotFoundError";
-  }
-}
-
-// src/duration.ts
 var MS_PER_SECOND = 1000;
 var MS_PER_MINUTE = 60 * MS_PER_SECOND;
 var MS_PER_HOUR = 60 * MS_PER_MINUTE;
@@ -75,28 +48,6 @@ import { PgBoss } from "pg-boss";
 
 // src/ast-parser.ts
 import * as ts from "typescript";
-
-// src/types.ts
-var WorkflowStatus;
-((WorkflowStatus2) => {
-  WorkflowStatus2["PENDING"] = "pending";
-  WorkflowStatus2["RUNNING"] = "running";
-  WorkflowStatus2["PAUSED"] = "paused";
-  WorkflowStatus2["COMPLETED"] = "completed";
-  WorkflowStatus2["FAILED"] = "failed";
-  WorkflowStatus2["CANCELLED"] = "cancelled";
-})(WorkflowStatus ||= {});
-var StepType;
-((StepType2) => {
-  StepType2["PAUSE"] = "pause";
-  StepType2["RUN"] = "run";
-  StepType2["WAIT_FOR"] = "waitFor";
-  StepType2["WAIT_UNTIL"] = "waitUntil";
-  StepType2["DELAY"] = "delay";
-  StepType2["POLL"] = "poll";
-})(StepType ||= {});
-
-// src/ast-parser.ts
 function parseWorkflowHandler(handler) {
   const handlerSource = handler.toString();
   const sourceFile = ts.createSourceFile("handler.ts", handlerSource, ts.ScriptTarget.Latest, true);
@@ -165,353 +116,8 @@ function parseWorkflowHandler(handler) {
   return { steps: Array.from(steps.values()) };
 }
 
-// src/db/migration.ts
-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 (
-        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,
-        resource_id varchar(32),
-        workflow_id varchar(32) NOT NULL,
-        status text DEFAULT 'pending' NOT NULL,
-        input jsonb NOT NULL,
-        output jsonb,
-        error text,
-        current_step_id varchar(256) NOT NULL,
-        timeline jsonb DEFAULT '{}'::jsonb NOT NULL,
-        paused_at timestamp with time zone,
-        resumed_at timestamp with time zone,
-        completed_at timestamp with time zone,
-        timeout_at timestamp with time zone,
-        retry_count integer DEFAULT 0 NOT NULL,
-        max_retries integer DEFAULT 0 NOT NULL,
-        job_id varchar(256),
-        idempotency_key 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);
-      CREATE UNIQUE INDEX workflow_runs_idempotency_key_idx ON workflow_runs (idempotency_key) WHERE idempotency_key IS NOT NULL;
-    `, []);
-  } 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);
-      ALTER TABLE workflow_runs ADD COLUMN IF NOT EXISTS idempotency_key varchar(256);
-      CREATE UNIQUE INDEX IF NOT EXISTS workflow_runs_idempotency_key_idx ON workflow_runs (idempotency_key) WHERE idempotency_key IS NOT NULL;
-      `, []);
-  }
-}
-
-// src/db/queries.ts
-import ksuid from "ksuid";
-function generateKSUID(prefix) {
-  return `${prefix ? `${prefix}_` : ""}${ksuid.randomSync().string}`;
-}
-function mapRowToWorkflowRun(row) {
-  return {
-    id: row.id,
-    createdAt: new Date(row.created_at),
-    updatedAt: new Date(row.updated_at),
-    resourceId: row.resource_id,
-    workflowId: row.workflow_id,
-    status: row.status,
-    input: typeof row.input === "string" ? JSON.parse(row.input) : row.input,
-    output: typeof row.output === "string" ? row.output.trim().startsWith("{") || row.output.trim().startsWith("[") ? JSON.parse(row.output) : row.output : row.output ?? null,
-    error: row.error,
-    currentStepId: row.current_step_id,
-    timeline: typeof row.timeline === "string" ? JSON.parse(row.timeline) : row.timeline,
-    pausedAt: row.paused_at ? new Date(row.paused_at) : null,
-    resumedAt: row.resumed_at ? new Date(row.resumed_at) : null,
-    completedAt: row.completed_at ? new Date(row.completed_at) : null,
-    timeoutAt: row.timeout_at ? new Date(row.timeout_at) : null,
-    retryCount: row.retry_count,
-    maxRetries: row.max_retries,
-    jobId: row.job_id,
-    idempotencyKey: row.idempotency_key
-  };
-}
-async function insertWorkflowRun({
-  resourceId,
-  workflowId,
-  currentStepId,
-  status,
-  input,
-  maxRetries,
-  timeoutAt,
-  idempotencyKey
-}, db) {
-  const runId = generateKSUID("run");
-  const now = new Date;
-  const result = await db.executeSql(`INSERT INTO workflow_runs (
-      id,
-      resource_id,
-      workflow_id,
-      current_step_id,
-      status,
-      input,
-      max_retries,
-      timeout_at,
-      created_at,
-      updated_at,
-      timeline,
-      retry_count,
-      idempotency_key
-    )
-    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,
-    workflowId,
-    currentStepId,
-    status,
-    JSON.stringify(input),
-    maxRetries,
-    timeoutAt,
-    now,
-    now,
-    "{}",
-    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
-  ]);
-  if (!existing.rows[0]) {
-    throw new Error(`Idempotency conflict: existing run not found for key "${idempotencyKey}"`);
-  }
-  return { run: mapRowToWorkflowRun(existing.rows[0]), created: false };
-}
-async function getWorkflowRun({
-  runId,
-  resourceId
-}, { exclusiveLock = false, db }) {
-  const lockSuffix = exclusiveLock ? "FOR UPDATE" : "";
-  const result = resourceId ? await db.executeSql(`SELECT * FROM workflow_runs 
-        WHERE id = $1 AND resource_id = $2
-        ${lockSuffix}`, [runId, resourceId]) : await db.executeSql(`SELECT * FROM workflow_runs 
-        WHERE id = $1
-        ${lockSuffix}`, [runId]);
-  const run = result.rows[0];
-  if (!run) {
-    return null;
-  }
-  return mapRowToWorkflowRun(run);
-}
-async function updateWorkflowRun({
-  runId,
-  resourceId,
-  data,
-  expectedStatuses
-}, db) {
-  const now = new Date;
-  const updates = ["updated_at = $1"];
-  const values = [now];
-  let paramIndex = 2;
-  if (data.status !== undefined) {
-    updates.push(`status = $${paramIndex}`);
-    values.push(data.status);
-    paramIndex++;
-  }
-  if (data.currentStepId !== undefined) {
-    updates.push(`current_step_id = $${paramIndex}`);
-    values.push(data.currentStepId);
-    paramIndex++;
-  }
-  if (data.timeline !== undefined) {
-    updates.push(`timeline = $${paramIndex}`);
-    values.push(JSON.stringify(data.timeline));
-    paramIndex++;
-  }
-  if (data.pausedAt !== undefined) {
-    updates.push(`paused_at = $${paramIndex}`);
-    values.push(data.pausedAt);
-    paramIndex++;
-  }
-  if (data.resumedAt !== undefined) {
-    updates.push(`resumed_at = $${paramIndex}`);
-    values.push(data.resumedAt);
-    paramIndex++;
-  }
-  if (data.completedAt !== undefined) {
-    updates.push(`completed_at = $${paramIndex}`);
-    values.push(data.completedAt);
-    paramIndex++;
-  }
-  if (data.output !== undefined) {
-    updates.push(`output = $${paramIndex}`);
-    values.push(JSON.stringify(data.output));
-    paramIndex++;
-  }
-  if (data.error !== undefined) {
-    updates.push(`error = $${paramIndex}`);
-    values.push(data.error);
-    paramIndex++;
-  }
-  if (data.retryCount !== undefined) {
-    updates.push(`retry_count = $${paramIndex}`);
-    values.push(data.retryCount);
-    paramIndex++;
-  }
-  if (data.jobId !== undefined) {
-    updates.push(`job_id = $${paramIndex}`);
-    values.push(data.jobId);
-    paramIndex++;
-  }
-  values.push(runId);
-  const idParam = paramIndex;
-  paramIndex++;
-  if (resourceId) {
-    values.push(resourceId);
-    paramIndex++;
-  }
-  if (expectedStatuses && expectedStatuses.length > 0) {
-    values.push(expectedStatuses);
-    paramIndex++;
-  }
-  let whereClause = resourceId ? `WHERE id = $${idParam} AND resource_id = $${idParam + 1}` : `WHERE id = $${idParam}`;
-  if (expectedStatuses && expectedStatuses.length > 0) {
-    whereClause += ` AND status = ANY($${paramIndex - 1})`;
-  }
-  const query = `
-    UPDATE workflow_runs 
-    SET ${updates.join(", ")}
-    ${whereClause}
-    RETURNING *
-  `;
-  const result = await db.executeSql(query, values);
-  const run = result.rows[0];
-  if (!run) {
-    return null;
-  }
-  return mapRowToWorkflowRun(run);
-}
-async function getWorkflowRuns({
-  resourceId,
-  startingAfter,
-  endingBefore,
-  limit = 20,
-  statuses,
-  workflowId
-}, db) {
-  const conditions = [];
-  const values = [];
-  let paramIndex = 1;
-  if (resourceId) {
-    conditions.push(`resource_id = $${paramIndex}`);
-    values.push(resourceId);
-    paramIndex++;
-  }
-  if (statuses && statuses.length > 0) {
-    conditions.push(`status = ANY($${paramIndex})`);
-    values.push(statuses);
-    paramIndex++;
-  }
-  if (workflowId) {
-    conditions.push(`workflow_id = $${paramIndex}`);
-    values.push(workflowId);
-    paramIndex++;
-  }
-  const cursorIds = [startingAfter, endingBefore].filter(Boolean);
-  if (cursorIds.length > 0) {
-    const cursorResult = await db.executeSql("SELECT id, created_at FROM workflow_runs WHERE id = ANY($1)", [cursorIds]);
-    const cursorMap = new Map;
-    for (const row of cursorResult.rows) {
-      cursorMap.set(row.id, typeof row.created_at === "string" ? new Date(row.created_at) : row.created_at);
-    }
-    if (startingAfter) {
-      const cursor = cursorMap.get(startingAfter);
-      if (cursor) {
-        conditions.push(`created_at < $${paramIndex}`);
-        values.push(cursor);
-        paramIndex++;
-      }
-    }
-    if (endingBefore) {
-      const cursor = cursorMap.get(endingBefore);
-      if (cursor) {
-        conditions.push(`created_at > $${paramIndex}`);
-        values.push(cursor);
-        paramIndex++;
-      }
-    }
-  }
-  const whereClause = conditions.length > 0 ? `WHERE ${conditions.join(" AND ")}` : "";
-  const actualLimit = Math.min(Math.max(limit, 1), 100) + 1;
-  const isBackward = !!endingBefore && !startingAfter;
-  const query = `
-    SELECT * FROM workflow_runs
-    ${whereClause}
-    ORDER BY created_at ${isBackward ? "ASC" : "DESC"}
-    LIMIT $${paramIndex}
-  `;
-  values.push(actualLimit);
-  const result = await db.executeSql(query, values);
-  const rows = result.rows;
-  const hasExtraRow = rows.length > (limit ?? 20);
-  const rawItems = hasExtraRow ? rows.slice(0, limit) : rows;
-  if (isBackward) {
-    rawItems.reverse();
-  }
-  const items = rawItems.map((row) => mapRowToWorkflowRun(row));
-  const hasMore = isBackward ? items.length > 0 : hasExtraRow;
-  const hasPrev = isBackward ? hasExtraRow : !!startingAfter && items.length > 0;
-  const nextCursor = hasMore && items.length > 0 ? items[items.length - 1]?.id ?? null : null;
-  const prevCursor = hasPrev && items.length > 0 ? items[0]?.id ?? null : null;
-  return { items, nextCursor, prevCursor, hasMore, hasPrev };
-}
-async function withPostgresTransaction(db, callback, pool) {
-  let txDb;
-  let release;
-  if (pool) {
-    const client = await pool.connect();
-    txDb = {
-      executeSql: (text, values) => client.query(text, values)
-    };
-    release = () => client.release();
-  } else {
-    txDb = db;
-  }
-  try {
-    await txDb.executeSql("BEGIN", []);
-    const result = await callback(txDb);
-    await txDb.executeSql("COMMIT", []);
-    return result;
-  } catch (error) {
-    await txDb.executeSql("ROLLBACK", []);
-    throw error;
-  } finally {
-    release?.();
-  }
-}
-
 // src/engine.ts
-var PAUSE_EVENT_NAME = "__internal_pause";
-var WORKFLOW_RUN_QUEUE_NAME = "workflow-run";
 var LOG_PREFIX = "[WorkflowEngine]";
-var DEFAULT_PGBOSS_SCHEMA = "pgboss_v12_pgworkflow";
 var StepTypeToIcon = {
   ["run" /* RUN */]: "λ",
   ["waitFor" /* WAIT_FOR */]: "○",
@@ -618,13 +224,26 @@ class WorkflowEngine {
     this.workflows.clear();
     return this;
   }
-  async startWorkflow({
-    resourceId,
-    workflowId,
-    input,
-    idempotencyKey,
-    options
-  }) {
+  async startWorkflow(refOrParams, inputArg, optionsArg) {
+    let workflowId;
+    let input;
+    let resourceId;
+    let idempotencyKey;
+    let options;
+    if (typeof refOrParams === "function" && "id" in refOrParams) {
+      workflowId = refOrParams.id;
+      input = inputArg;
+      options = optionsArg;
+      resourceId = optionsArg?.resourceId;
+      idempotencyKey = optionsArg?.idempotencyKey;
+    } else {
+      const params = refOrParams;
+      workflowId = params.workflowId;
+      input = params.input;
+      resourceId = params.resourceId;
+      idempotencyKey = params.idempotencyKey;
+      options = params.options;
+    }
     if (!this._started) {
       await this.start(false, { batchSize: options?.batchSize ?? 1 });
     }
@@ -875,27 +494,29 @@ class WorkflowEngine {
     return run.resourceId ?? undefined;
   }
   async handleWorkflowRun([job]) {
-    const { runId, resourceId, workflowId, input, event } = job?.data ?? {};
-    if (!runId) {
-      throw new WorkflowEngineError("Invalid workflow run job, missing runId", workflowId);
-    }
-    if (!workflowId) {
-      throw new WorkflowEngineError("Invalid workflow run job, missing workflowId", undefined, runId);
-    }
-    const workflow2 = this.workflows.get(workflowId);
-    if (!workflow2) {
-      throw new WorkflowEngineError(`Workflow ${workflowId} not found`, workflowId, runId);
-    }
-    this.logger.log("Processing workflow run...", {
-      runId,
-      workflowId
-    });
-    let run = await this.getRun({ runId });
-    if (run.workflowId !== workflowId) {
-      throw new WorkflowEngineError(`Workflow run ${runId} does not match job workflowId ${workflowId}`, workflowId, runId);
-    }
-    const scopedResourceId = this.resolveScopedResourceId(resourceId, run);
+    const { runId = "", resourceId, workflowId = "", input, event } = job?.data ?? {};
+    let run;
+    let scopedResourceId;
     try {
+      if (!runId) {
+        throw new WorkflowEngineError("Invalid workflow run job, missing runId", workflowId);
+      }
+      if (!workflowId) {
+        throw new WorkflowEngineError("Invalid workflow run job, missing workflowId", undefined, runId);
+      }
+      const workflow2 = this.workflows.get(workflowId);
+      if (!workflow2) {
+        throw new WorkflowEngineError(`Workflow ${workflowId} not found`, workflowId, runId);
+      }
+      this.logger.log("Processing workflow run...", {
+        runId,
+        workflowId
+      });
+      run = await this.getRun({ runId });
+      if (run.workflowId !== workflowId) {
+        throw new WorkflowEngineError(`Workflow run ${runId} does not match job workflowId ${workflowId}`, workflowId, runId);
+      }
+      scopedResourceId = this.resolveScopedResourceId(resourceId, run);
       if (run.status === "cancelled" /* CANCELLED */) {
         this.logger.log(`Workflow run ${runId} is cancelled, skipping`);
         return;
@@ -1039,7 +660,7 @@ class WorkflowEngine {
         });
       }
     } catch (error) {
-      if (run.retryCount < run.maxRetries) {
+      if (run && run.retryCount < run.maxRetries) {
         await this.updateRun({
           runId,
           resourceId: scopedResourceId,
@@ -1061,15 +682,17 @@ class WorkflowEngine {
         });
         return;
       }
-      await this.updateRun({
-        runId,
-        resourceId: scopedResourceId,
-        data: {
-          status: "failed" /* FAILED */,
-          error: error instanceof Error ? error.message : String(error),
-          jobId: job?.id
-        }
-      });
+      if (runId) {
+        await this.updateRun({
+          runId,
+          resourceId: scopedResourceId,
+          data: {
+            status: "failed" /* FAILED */,
+            error: error instanceof Error ? error.message : String(error),
+            jobId: job?.id
+          }
+        });
+      }
       throw error;
     }
   }
@@ -1369,12 +992,14 @@ ${error.stack}` : String(error)
 export {
   workflow,
   parseDuration,
+  createWorkflowRef,
   WorkflowStatus,
   WorkflowRunNotFoundError,
   WorkflowEngineError,
   WorkflowEngine,
+  WorkflowClient,
   StepType
 };
 
-//# debugId=89B8D55BEBA1FA4564756E2164756E21
+//# debugId=9A3E4733F40A491264756E2164756E21
 //# sourceMappingURL=index.js.map