openworkflow 0.4.0 → 0.5.0

package/dist/backend-postgres/postgres.js

@@ -0,0 +1,234 @@
+import postgres from "postgres";
+export const DEFAULT_POSTGRES_URL = "postgresql://postgres:postgres@localhost:5432/postgres";
+// The default schema to use for OpenWorkflow data. This type is more for
+// documentation than for practical use. The only time we allow schema
+// customization is during testing, specifically for testing migrations.
+// Everywhere else uses the "openworkflow" schema directly for prepared
+// statements.
+export const DEFAULT_SCHEMA = "openworkflow";
+/**
+ * newPostgres creates a new Postgres client.
+ * @param url - Database connection URL
+ * @param options - Postgres client options
+ * @returns A Postgres client
+ */
+export function newPostgres(url, options) {
+    return postgres(url, { ...options, transform: postgres.toCamel });
+}
+/**
+ * newPostgresMaxOne creates a new Postgres client with a maximum pool size of
+ * one, which is useful for migrations.
+ * @param url - Database connection URL
+ * @param options - Postgres client options
+ * @returns A Postgres client
+ */
+export function newPostgresMaxOne(url, options) {
+    return newPostgres(url, { ...options, max: 1 });
+}
+/**
+ * migrations returns the list of migration SQL statements.
+ * @param schema - Schema name
+ * @returns Migration SQL statements
+ */
+export function migrations(schema) {
+    return [
+        // 0 - init
+        `BEGIN;
+
+    CREATE SCHEMA IF NOT EXISTS ${schema};
+
+    CREATE TABLE IF NOT EXISTS "${schema}"."openworkflow_migrations" (
+      "version" BIGINT NOT NULL PRIMARY KEY
+    );
+
+    INSERT INTO "${schema}"."openworkflow_migrations" ("version")
+    VALUES (0)
+    ON CONFLICT DO NOTHING;
+
+    COMMIT;`,
+        // 1 - add workflow_runs and step_attempts tables
+        `BEGIN;
+
+    CREATE TABLE IF NOT EXISTS "${schema}"."workflow_runs" (
+      "namespace_id" TEXT NOT NULL,
+      "id" TEXT NOT NULL,
+      --
+      "workflow_name" TEXT NOT NULL,
+      "version" TEXT,
+      "status" TEXT NOT NULL,
+      "idempotency_key" TEXT,
+      "config" JSONB NOT NULL,
+      "context" JSONB,
+      "input" JSONB,
+      "output" JSONB,
+      "error" JSONB,
+      "attempts" INTEGER NOT NULL,
+      "parent_step_attempt_namespace_id" TEXT,
+      "parent_step_attempt_id" TEXT,
+      "worker_id" TEXT,
+      "available_at" TIMESTAMPTZ,
+      "deadline_at" TIMESTAMPTZ,
+      "started_at" TIMESTAMPTZ,
+      "finished_at" TIMESTAMPTZ,
+      "created_at" TIMESTAMPTZ NOT NULL,
+      "updated_at" TIMESTAMPTZ NOT NULL,
+      PRIMARY KEY ("namespace_id", "id")
+    );
+
+    CREATE TABLE IF NOT EXISTS "${schema}"."step_attempts" (
+      "namespace_id" TEXT NOT NULL,
+      "id" TEXT NOT NULL,
+      --
+      "workflow_run_id" TEXT NOT NULL,
+      "step_name" TEXT NOT NULL,
+      "kind" TEXT NOT NULL,
+      "status" TEXT NOT NULL,
+      "config" JSONB NOT NULL,
+      "context" JSONB,
+      "output" JSONB,
+      "error" JSONB,
+      "child_workflow_run_namespace_id" TEXT,
+      "child_workflow_run_id" TEXT,
+      "started_at" TIMESTAMPTZ,
+      "finished_at" TIMESTAMPTZ,
+      "created_at" TIMESTAMPTZ NOT NULL,
+      "updated_at" TIMESTAMPTZ NOT NULL,
+      PRIMARY KEY ("namespace_id", "id")
+    );
+
+    INSERT INTO "${schema}"."openworkflow_migrations" ("version")
+    VALUES (1)
+    ON CONFLICT DO NOTHING;
+    
+    COMMIT;`,
+        // 2 - foreign keys
+        `BEGIN;
+
+    ALTER TABLE "${schema}"."step_attempts"
+    ADD CONSTRAINT "step_attempts_workflow_run_fk"
+    FOREIGN KEY ("namespace_id", "workflow_run_id")
+    REFERENCES "${schema}"."workflow_runs" ("namespace_id", "id")
+    ON DELETE CASCADE
+    NOT VALID;
+
+    ALTER TABLE "${schema}"."workflow_runs"
+    ADD CONSTRAINT "workflow_runs_parent_step_attempt_fk"
+    FOREIGN KEY ("parent_step_attempt_namespace_id", "parent_step_attempt_id")
+    REFERENCES "${schema}"."step_attempts" ("namespace_id", "id")
+    ON DELETE SET NULL
+    NOT VALID;
+
+    ALTER TABLE "${schema}"."step_attempts"
+    ADD CONSTRAINT "step_attempts_child_workflow_run_fk"
+    FOREIGN KEY ("child_workflow_run_namespace_id", "child_workflow_run_id")
+    REFERENCES "${schema}"."workflow_runs" ("namespace_id", "id")
+    ON DELETE SET NULL
+    NOT VALID;
+
+    INSERT INTO "${schema}"."openworkflow_migrations" ("version")
+    VALUES (2)
+    ON CONFLICT DO NOTHING;
+
+    COMMIT;`,
+        // 3 - validate foreign keys
+        `BEGIN;
+
+    ALTER TABLE "${schema}"."step_attempts"
+    VALIDATE CONSTRAINT "step_attempts_workflow_run_fk";
+    
+    ALTER TABLE "${schema}"."workflow_runs" VALIDATE CONSTRAINT
+    "workflow_runs_parent_step_attempt_fk";
+
+    ALTER TABLE "${schema}"."step_attempts"
+    VALIDATE CONSTRAINT "step_attempts_child_workflow_run_fk";
+
+    INSERT INTO "${schema}"."openworkflow_migrations" ("version")
+    VALUES (3)
+    ON CONFLICT DO NOTHING;
+
+    COMMIT;`,
+        // 4 - indexes
+        `BEGIN;
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_status_available_at_created_at_idx"
+    ON "${schema}"."workflow_runs" ("namespace_id", "status", "available_at", "created_at");
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_workflow_name_idempotency_key_created_at_idx"
+    ON "${schema}"."workflow_runs" ("namespace_id", "workflow_name", "idempotency_key", "created_at");
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_parent_step_idx"
+    ON "${schema}"."workflow_runs" ("parent_step_attempt_namespace_id", "parent_step_attempt_id")
+    WHERE parent_step_attempt_namespace_id IS NOT NULL AND parent_step_attempt_id IS NOT NULL;
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_created_at_desc_idx"
+    ON "${schema}"."workflow_runs" ("namespace_id", "created_at" DESC);
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_status_created_at_desc_idx"
+    ON "${schema}"."workflow_runs" ("namespace_id", "status", "created_at" DESC);
+
+    CREATE INDEX IF NOT EXISTS "workflow_runs_workflow_name_status_created_at_desc_idx"
+    ON "${schema}"."workflow_runs" ("namespace_id", "workflow_name", "status", "created_at" DESC);
+
+    CREATE INDEX IF NOT EXISTS "step_attempts_workflow_run_created_at_idx"
+    ON "${schema}"."step_attempts" ("namespace_id", "workflow_run_id", "created_at");
+
+    CREATE INDEX IF NOT EXISTS "step_attempts_workflow_run_step_name_created_at_idx"
+    ON "${schema}"."step_attempts" ("namespace_id", "workflow_run_id", "step_name", "created_at");
+
+    CREATE INDEX IF NOT EXISTS "step_attempts_child_workflow_run_idx"
+    ON "${schema}"."step_attempts" ("child_workflow_run_namespace_id", "child_workflow_run_id")
+    WHERE child_workflow_run_namespace_id IS NOT NULL AND child_workflow_run_id IS NOT NULL;
+
+    INSERT INTO "${schema}"."openworkflow_migrations"("version")
+    VALUES (4)
+    ON CONFLICT DO NOTHING;
+
+    COMMIT;`,
+    ];
+}
+/**
+ * migrate applies pending migrations to the database. Does nothing if the
+ * database is already up to date.
+ * @param pg - Postgres client
+ * @param schema - Schema name
+ * @returns Promise resolved when migrations complete
+ */
+export async function migrate(pg, schema) {
+    const currentMigrationVersion = await getCurrentMigrationVersion(pg, schema);
+    for (const [i, migrationSql] of migrations(schema).entries()) {
+        if (i <= currentMigrationVersion)
+            continue; // already applied
+        await pg.unsafe(migrationSql);
+    }
+}
+/**
+ * dropSchema drops the specified schema from the database.
+ * @param pg - Postgres client
+ * @param schema - Schema name
+ * @returns Promise resolved when the schema is dropped
+ */
+export async function dropSchema(pg, schema) {
+    await pg.unsafe(`DROP SCHEMA IF EXISTS ${schema} CASCADE;`);
+}
+/**
+ * getCurrentVersion returns the current migration version of the database.
+ * @param pg - Postgres client
+ * @param schema - Schema name
+ * @returns Current migration version
+ */
+async function getCurrentMigrationVersion(pg, schema) {
+    // check if migrations table exists
+    const existsRes = await pg.unsafe(`
+    SELECT EXISTS (
+      SELECT 1
+      FROM information_schema.tables
+      WHERE table_schema = '${schema}'
+      AND table_name = 'openworkflow_migrations'
+    )`);
+    if (!existsRes[0]?.exists)
+        return -1;
+    // get current version
+    const currentVersionRes = await pg.unsafe(`SELECT MAX("version") AS "version" FROM "${schema}"."openworkflow_migrations";`);
+    return currentVersionRes[0]?.version ?? -1;
+}
+//# sourceMappingURL=postgres.js.map

package/dist/backend-postgres/postgres.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres.js","sourceRoot":"","sources":["../../src/backend-postgres/postgres.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,MAAM,CAAC,MAAM,oBAAoB,GAC/B,wDAAwD,CAAC;AAE3D,yEAAyE;AACzE,sEAAsE;AACtE,wEAAwE;AACxE,uEAAuE;AACvE,cAAc;AACd,MAAM,CAAC,MAAM,cAAc,GAAG,cAAc,CAAC;AAK7C;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,OAAyB;IAChE,OAAO,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,OAAyB;IACtE,OAAO,WAAW,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,OAAO;QACL,WAAW;QACX;;kCAE8B,MAAM;;kCAEN,MAAM;;;;mBAIrB,MAAM;;;;YAIb;QAER,iDAAiD;QACjD;;kCAE8B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;kCA0BN,MAAM;;;;;;;;;;;;;;;;;;;;;mBAqBrB,MAAM;;;;YAIb;QAER,mBAAmB;QACnB;;mBAEe,MAAM;;;kBAGP,MAAM;;;;mBAIL,MAAM;;;kBAGP,MAAM;;;;mBAIL,MAAM;;;kBAGP,MAAM;;;;mBAIL,MAAM;;;;YAIb;QAER,4BAA4B;QAC5B;;mBAEe,MAAM;;;mBAGN,MAAM;;;mBAGN,MAAM;;;mBAGN,MAAM;;;;YAIb;QAER,cAAc;QACd;;;UAGM,MAAM;;;UAGN,MAAM;;;UAGN,MAAM;;;;UAIN,MAAM;;;UAGN,MAAM;;;UAGN,MAAM;;;UAGN,MAAM;;;UAGN,MAAM;;;UAGN,MAAM;;;mBAGG,MAAM;;;;YAIb;KACT,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,EAAY,EAAE,MAAc;IACxD,MAAM,uBAAuB,GAAG,MAAM,0BAA0B,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAE7E,KAAK,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7D,IAAI,CAAC,IAAI,uBAAuB;YAAE,SAAS,CAAC,kBAAkB;QAE9D,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,EAAY,EAAE,MAAc;IAC3D,MAAM,EAAE,CAAC,MAAM,CAAC,yBAAyB,MAAM,WAAW,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,0BAA0B,CACvC,EAAY,EACZ,MAAc;IAEd,mCAAmC;IACnC,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,MAAM,CAAwB;;;;8BAI7B,MAAM;;MAE9B,CAAC,CAAC;IACN,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM;QAAE,OAAO,CAAC,CAAC,CAAC;IAErC,sBAAsB;IACtB,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,MAAM,CACvC,4CAA4C,MAAM,8BAA8B,CACjF,CAAC;IACF,OAAO,iBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC"}

package/dist/backend-sqlite/index.d.ts

@@ -0,0 +1,42 @@
+import type { Backend, CancelWorkflowRunParams, ClaimWorkflowRunParams, CompleteStepAttemptParams, CompleteWorkflowRunParams, CreateStepAttemptParams, CreateWorkflowRunParams, ExtendWorkflowRunLeaseParams, FailStepAttemptParams, FailWorkflowRunParams, GetStepAttemptParams, GetWorkflowRunParams, ListStepAttemptsParams, ListWorkflowRunsParams, PaginatedResponse, SleepWorkflowRunParams } from "../backend.js";
+import type { StepAttempt } from "../core/step.js";
+import type { WorkflowRun } from "../core/workflow.js";
+interface BackendSqliteOptions {
+    namespaceId?: string;
+    runMigrations?: boolean;
+}
+/**
+ * Manages a connection to a SQLite database for workflow operations.
+ */
+export declare class BackendSqlite implements Backend {
+    private db;
+    private namespaceId;
+    private constructor();
+    /**
+     * Create and initialize a new BackendSqlite instance. This will
+     * automatically run migrations on startup unless `runMigrations` is set to
+     * false.
+     * @param path - Database path
+     * @param options - Backend options
+     * @returns A connected backend instance
+     */
+    static connect(path: string, options?: BackendSqliteOptions): BackendSqlite;
+    stop(): Promise<void>;
+    createWorkflowRun(params: CreateWorkflowRunParams): Promise<WorkflowRun>;
+    getWorkflowRun(params: GetWorkflowRunParams): Promise<WorkflowRun | null>;
+    claimWorkflowRun(params: ClaimWorkflowRunParams): Promise<WorkflowRun | null>;
+    extendWorkflowRunLease(params: ExtendWorkflowRunLeaseParams): Promise<WorkflowRun>;
+    sleepWorkflowRun(params: SleepWorkflowRunParams): Promise<WorkflowRun>;
+    completeWorkflowRun(params: CompleteWorkflowRunParams): Promise<WorkflowRun>;
+    failWorkflowRun(params: FailWorkflowRunParams): Promise<WorkflowRun>;
+    cancelWorkflowRun(params: CancelWorkflowRunParams): Promise<WorkflowRun>;
+    listWorkflowRuns(params: ListWorkflowRunsParams): Promise<PaginatedResponse<WorkflowRun>>;
+    listStepAttempts(params: ListStepAttemptsParams): Promise<PaginatedResponse<StepAttempt>>;
+    private processPaginationResults;
+    createStepAttempt(params: CreateStepAttemptParams): Promise<StepAttempt>;
+    getStepAttempt(params: GetStepAttemptParams): Promise<StepAttempt | null>;
+    completeStepAttempt(params: CompleteStepAttemptParams): Promise<StepAttempt>;
+    failStepAttempt(params: FailStepAttemptParams): Promise<StepAttempt>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/backend-sqlite/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/backend-sqlite/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,OAAO,EACP,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,uBAAuB,EACvB,4BAA4B,EAC5B,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAgBvD,UAAU,oBAAoB;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC3C,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO;IAKP;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,aAAa;IAiBrE,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAgDvB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAenE,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IA0FxB,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,WAAW,CAAC;IAmCjB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAoCtE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IAyCjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;IA+DpE,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAuDvB,gBAAgB,CACd,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAgE1C,gBAAgB,CACd,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAmE1C,OAAO,CAAC,wBAAwB;IAyC1B,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAwCvB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAenE,mBAAmB,CACvB,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,WAAW,CAAC;IA0DjB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;CAyD3E"}