openworkflow 0.5.0 → 0.6.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.
- package/README.md +40 -347
- package/dist/{testing → backend-test}/backend.testsuite.d.ts +1 -1
- package/dist/backend-test/backend.testsuite.d.ts.map +1 -0
- package/dist/{testing → backend-test}/backend.testsuite.js +8 -9
- package/dist/backend-test/index.d.ts +2 -0
- package/dist/backend-test/index.d.ts.map +1 -0
- package/dist/{testing → backend-test}/index.js +0 -1
- package/dist/backend.js +0 -1
- package/dist/backend.testsuite.d.ts +20 -0
- package/dist/backend.testsuite.d.ts.map +1 -0
- package/dist/backend.testsuite.js +1090 -0
- package/dist/bin/openworkflow.js +0 -1
- package/dist/chaos.test.d.ts +2 -0
- package/dist/chaos.test.d.ts.map +1 -0
- package/dist/chaos.test.js +88 -0
- package/dist/client.js +0 -1
- package/dist/client.test.d.ts +2 -0
- package/dist/client.test.d.ts.map +1 -0
- package/dist/client.test.js +311 -0
- package/dist/core/duration.js +0 -1
- package/dist/core/duration.test.d.ts +2 -0
- package/dist/core/duration.test.d.ts.map +1 -0
- package/dist/core/duration.test.js +263 -0
- package/dist/core/error.js +0 -1
- package/dist/core/error.test.d.ts +2 -0
- package/dist/core/error.test.d.ts.map +1 -0
- package/dist/core/error.test.js +60 -0
- package/dist/core/json.js +0 -1
- package/dist/core/result.js +0 -1
- package/dist/core/result.test.d.ts +2 -0
- package/dist/core/result.test.d.ts.map +1 -0
- package/dist/core/result.test.js +11 -0
- package/dist/core/retry.js +0 -1
- package/dist/core/schema.js +0 -1
- package/dist/core/step.js +0 -1
- package/dist/core/step.test.d.ts +2 -0
- package/dist/core/step.test.d.ts.map +1 -0
- package/dist/core/step.test.js +266 -0
- package/dist/core/workflow.js +0 -1
- package/dist/core/workflow.test.d.ts +2 -0
- package/dist/core/workflow.test.d.ts.map +1 -0
- package/dist/core/workflow.test.js +113 -0
- package/dist/driver.d.ts +116 -0
- package/dist/driver.d.ts.map +1 -0
- package/dist/driver.js +1 -0
- package/dist/execution.js +0 -1
- package/dist/execution.test.d.ts +2 -0
- package/dist/execution.test.d.ts.map +1 -0
- package/dist/execution.test.js +381 -0
- package/dist/factory.d.ts +74 -0
- package/dist/factory.d.ts.map +1 -0
- package/dist/factory.js +72 -0
- package/dist/index.js +0 -1
- package/dist/internal.d.ts +4 -5
- package/dist/internal.d.ts.map +1 -1
- package/dist/internal.js +1 -4
- package/dist/{backend-sqlite/index.d.ts → node-sqlite/backend.d.ts} +14 -4
- package/dist/node-sqlite/backend.d.ts.map +1 -0
- package/dist/{backend-sqlite/index.js → node-sqlite/backend.js} +23 -5
- package/dist/node-sqlite/index.d.ts +11 -0
- package/dist/node-sqlite/index.d.ts.map +1 -0
- package/dist/node-sqlite/index.js +7 -0
- package/dist/{backend-sqlite → node-sqlite}/sqlite.d.ts +2 -3
- package/dist/node-sqlite/sqlite.d.ts.map +1 -0
- package/dist/{backend-sqlite → node-sqlite}/sqlite.js +0 -1
- package/dist/{pg → postgres}/backend.d.ts +3 -1
- package/dist/postgres/backend.d.ts.map +1 -0
- package/dist/{pg → postgres}/backend.js +5 -5
- package/dist/postgres/backend.test.d.ts +2 -0
- package/dist/postgres/backend.test.d.ts.map +1 -0
- package/dist/postgres/backend.test.js +19 -0
- package/dist/postgres/driver.d.ts +81 -0
- package/dist/postgres/driver.d.ts.map +1 -0
- package/dist/postgres/driver.js +63 -0
- package/dist/postgres/index.d.ts +11 -0
- package/dist/postgres/index.d.ts.map +1 -0
- package/dist/postgres/index.js +7 -0
- package/dist/postgres/internal.d.ts +2 -0
- package/dist/postgres/internal.d.ts.map +1 -0
- package/dist/postgres/internal.js +1 -0
- package/dist/postgres/postgres.d.ts.map +1 -0
- package/dist/{backend-postgres → postgres}/postgres.js +0 -1
- package/dist/postgres/postgres.test.d.ts +2 -0
- package/dist/postgres/postgres.test.d.ts.map +1 -0
- package/dist/postgres/postgres.test.js +45 -0
- package/dist/postgres/scripts/db-migrate.d.ts.map +1 -0
- package/dist/{pg → postgres}/scripts/db-migrate.js +0 -1
- package/dist/postgres/scripts/db-reset.d.ts.map +1 -0
- package/dist/{pg → postgres}/scripts/db-reset.js +0 -1
- package/dist/{pg → postgres}/scripts/squawk.d.ts.map +1 -1
- package/dist/{pg → postgres}/scripts/squawk.js +0 -1
- package/dist/postgres/vitest.global-setup.d.ts.map +1 -0
- package/dist/{pg → postgres}/vitest.global-setup.js +0 -1
- package/dist/postgres.d.ts +2 -0
- package/dist/postgres.d.ts.map +1 -0
- package/dist/postgres.js +1 -0
- package/dist/registry.js +0 -1
- package/dist/registry.test.d.ts +2 -0
- package/dist/registry.test.d.ts.map +1 -0
- package/dist/registry.test.js +109 -0
- package/dist/sqlite/backend.d.ts +3 -1
- package/dist/sqlite/backend.d.ts.map +1 -1
- package/dist/sqlite/backend.js +5 -5
- package/dist/sqlite/backend.test.d.ts +2 -0
- package/dist/sqlite/backend.test.d.ts.map +1 -0
- package/dist/sqlite/backend.test.js +50 -0
- package/dist/sqlite/driver.d.ts +79 -0
- package/dist/sqlite/driver.d.ts.map +1 -0
- package/dist/sqlite/driver.js +62 -0
- package/dist/sqlite/index.d.ts +12 -2
- package/dist/sqlite/index.d.ts.map +1 -1
- package/dist/sqlite/index.js +11 -3
- package/dist/sqlite/internal.d.ts +2 -0
- package/dist/sqlite/internal.d.ts.map +1 -0
- package/dist/sqlite/internal.js +1 -0
- package/dist/sqlite/sqlite.js +0 -1
- package/dist/sqlite/sqlite.test.d.ts +2 -0
- package/dist/sqlite/sqlite.test.d.ts.map +1 -0
- package/dist/sqlite/sqlite.test.js +171 -0
- package/dist/sqlite.d.ts +2 -0
- package/dist/sqlite.d.ts.map +1 -0
- package/dist/sqlite.js +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/worker.js +0 -1
- package/dist/worker.test.d.ts +2 -0
- package/dist/worker.test.d.ts.map +1 -0
- package/dist/worker.test.js +900 -0
- package/dist/workflow.js +0 -1
- package/dist/workflow.test.d.ts +2 -0
- package/dist/workflow.test.d.ts.map +1 -0
- package/dist/workflow.test.js +84 -0
- package/package.json +19 -5
- package/dist/backend-postgres/index.d.ts +0 -44
- package/dist/backend-postgres/index.d.ts.map +0 -1
- package/dist/backend-postgres/index.js +0 -535
- package/dist/backend-postgres/index.js.map +0 -1
- package/dist/backend-postgres/postgres.d.ts.map +0 -1
- package/dist/backend-postgres/postgres.js.map +0 -1
- package/dist/backend-sqlite/index.d.ts.map +0 -1
- package/dist/backend-sqlite/index.js.map +0 -1
- package/dist/backend-sqlite/sqlite.d.ts.map +0 -1
- package/dist/backend-sqlite/sqlite.js.map +0 -1
- package/dist/backend.js.map +0 -1
- package/dist/bin/openworkflow.js.map +0 -1
- package/dist/client.js.map +0 -1
- package/dist/config.d.ts +0 -34
- package/dist/config.d.ts.map +0 -1
- package/dist/config.js +0 -49
- package/dist/config.js.map +0 -1
- package/dist/core/duration.js.map +0 -1
- package/dist/core/error.js.map +0 -1
- package/dist/core/json.js.map +0 -1
- package/dist/core/result.js.map +0 -1
- package/dist/core/retry.js.map +0 -1
- package/dist/core/schema.js.map +0 -1
- package/dist/core/step.js.map +0 -1
- package/dist/core/workflow.js.map +0 -1
- package/dist/execution.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/internal.js.map +0 -1
- package/dist/pg/backend.d.ts.map +0 -1
- package/dist/pg/backend.js.map +0 -1
- package/dist/pg/index.d.ts +0 -3
- package/dist/pg/index.d.ts.map +0 -1
- package/dist/pg/index.js +0 -3
- package/dist/pg/index.js.map +0 -1
- package/dist/pg/postgres.d.ts +0 -42
- package/dist/pg/postgres.d.ts.map +0 -1
- package/dist/pg/postgres.js +0 -234
- package/dist/pg/postgres.js.map +0 -1
- package/dist/pg/scripts/db-migrate.d.ts.map +0 -1
- package/dist/pg/scripts/db-migrate.js.map +0 -1
- package/dist/pg/scripts/db-reset.d.ts.map +0 -1
- package/dist/pg/scripts/db-reset.js.map +0 -1
- package/dist/pg/scripts/squawk.js.map +0 -1
- package/dist/pg/vitest.global-setup.d.ts.map +0 -1
- package/dist/pg/vitest.global-setup.js.map +0 -1
- package/dist/registry.js.map +0 -1
- package/dist/sqlite/backend.js.map +0 -1
- package/dist/sqlite/index.js.map +0 -1
- package/dist/sqlite/sqlite.js.map +0 -1
- package/dist/testing/backend.testsuite.d.ts.map +0 -1
- package/dist/testing/backend.testsuite.js.map +0 -1
- package/dist/testing/index.d.ts +0 -2
- package/dist/testing/index.d.ts.map +0 -1
- package/dist/testing/index.js.map +0 -1
- package/dist/worker.js.map +0 -1
- package/dist/workflow.js.map +0 -1
- /package/dist/{backend-postgres → postgres}/postgres.d.ts +0 -0
- /package/dist/{pg → postgres}/scripts/db-migrate.d.ts +0 -0
- /package/dist/{pg → postgres}/scripts/db-reset.d.ts +0 -0
- /package/dist/{pg → postgres}/scripts/squawk.d.ts +0 -0
- /package/dist/{pg → postgres}/vitest.global-setup.d.ts +0 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { DEFAULT_POSTGRES_URL, DEFAULT_SCHEMA, newPostgresMaxOne, migrations, migrate, dropSchema, } from "./postgres.js";
|
|
2
|
+
import { afterAll, beforeAll, describe, expect, test } from "vitest";
|
|
3
|
+
describe("postgres", () => {
|
|
4
|
+
let pg;
|
|
5
|
+
beforeAll(() => {
|
|
6
|
+
// maxOne since we use SQL-based transactions instead of the postgres
|
|
7
|
+
// driver's built-in transactions
|
|
8
|
+
pg = newPostgresMaxOne(DEFAULT_POSTGRES_URL);
|
|
9
|
+
});
|
|
10
|
+
afterAll(async () => {
|
|
11
|
+
await pg.end();
|
|
12
|
+
});
|
|
13
|
+
describe("migrations()", () => {
|
|
14
|
+
test("returns migrations in 'openworkflow' schema when no schema is specified", () => {
|
|
15
|
+
const migs = migrations(DEFAULT_SCHEMA);
|
|
16
|
+
for (const mig of migs) {
|
|
17
|
+
expect(mig).toContain(`"openworkflow"`);
|
|
18
|
+
}
|
|
19
|
+
});
|
|
20
|
+
test("returns migration in the specified schema when one is specified", () => {
|
|
21
|
+
const schema = "test_custom_schema";
|
|
22
|
+
const migs = migrations(schema);
|
|
23
|
+
for (const mig of migs) {
|
|
24
|
+
expect(mig).toContain(`"${schema}"`);
|
|
25
|
+
expect(mig).not.toContain(`"openworkflow"`);
|
|
26
|
+
}
|
|
27
|
+
});
|
|
28
|
+
});
|
|
29
|
+
describe("migrate()", () => {
|
|
30
|
+
test("runs database migrations idempotently", async () => {
|
|
31
|
+
const schema = "test_migrate_idempotent";
|
|
32
|
+
await dropSchema(pg, schema);
|
|
33
|
+
await migrate(pg, schema);
|
|
34
|
+
await migrate(pg, schema);
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
describe("dropSchema()", () => {
|
|
38
|
+
test("drops the schema idempotently", async () => {
|
|
39
|
+
const testSchema = "test_drop_schema_idempotent";
|
|
40
|
+
await migrate(pg, testSchema);
|
|
41
|
+
await dropSchema(pg, testSchema);
|
|
42
|
+
await dropSchema(pg, testSchema);
|
|
43
|
+
});
|
|
44
|
+
});
|
|
45
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"db-migrate.d.ts","sourceRoot":"","sources":["../../../postgres/scripts/db-migrate.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"db-reset.d.ts","sourceRoot":"","sources":["../../../postgres/scripts/db-reset.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"squawk.d.ts","sourceRoot":"","sources":["../../../
|
|
1
|
+
{"version":3,"file":"squawk.d.ts","sourceRoot":"","sources":["../../../postgres/scripts/squawk.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vitest.global-setup.d.ts","sourceRoot":"","sources":["../../postgres/vitest.global-setup.ts"],"names":[],"mappings":"AAOA,kEAAkE;AAClE,wBAAsB,KAAK,kBAI1B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"postgres.d.ts","sourceRoot":"","sources":["../postgres.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}
|
package/dist/postgres.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { BackendPostgres } from "./postgres/backend.js";
|
package/dist/registry.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.test.d.ts","sourceRoot":"","sources":["../registry.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { WorkflowRegistry } from "./registry.js";
|
|
2
|
+
import { defineWorkflow } from "./workflow.js";
|
|
3
|
+
import { describe, expect, test } from "vitest";
|
|
4
|
+
describe("WorkflowRegistry", () => {
|
|
5
|
+
describe("register", () => {
|
|
6
|
+
test("registers a workflow without version", () => {
|
|
7
|
+
const registry = new WorkflowRegistry();
|
|
8
|
+
const workflow = createMockWorkflow("my-workflow");
|
|
9
|
+
registry.register(workflow);
|
|
10
|
+
expect(registry.get("my-workflow", null)).toBe(workflow);
|
|
11
|
+
});
|
|
12
|
+
test("registers a workflow with version", () => {
|
|
13
|
+
const registry = new WorkflowRegistry();
|
|
14
|
+
const workflow = createMockWorkflow("my-workflow", "v1");
|
|
15
|
+
registry.register(workflow);
|
|
16
|
+
expect(registry.get("my-workflow", "v1")).toBe(workflow);
|
|
17
|
+
});
|
|
18
|
+
test("registers multiple versions of the same workflow", () => {
|
|
19
|
+
const registry = new WorkflowRegistry();
|
|
20
|
+
const v1 = createMockWorkflow("my-workflow", "v1");
|
|
21
|
+
const v2 = createMockWorkflow("my-workflow", "v2");
|
|
22
|
+
registry.register(v1);
|
|
23
|
+
registry.register(v2);
|
|
24
|
+
expect(registry.get("my-workflow", "v1")).toBe(v1);
|
|
25
|
+
expect(registry.get("my-workflow", "v2")).toBe(v2);
|
|
26
|
+
});
|
|
27
|
+
test("registers different workflows with same version", () => {
|
|
28
|
+
const registry = new WorkflowRegistry();
|
|
29
|
+
const workflow1 = createMockWorkflow("workflow-a", "v1");
|
|
30
|
+
const workflow2 = createMockWorkflow("workflow-b", "v1");
|
|
31
|
+
registry.register(workflow1);
|
|
32
|
+
registry.register(workflow2);
|
|
33
|
+
expect(registry.get("workflow-a", "v1")).toBe(workflow1);
|
|
34
|
+
expect(registry.get("workflow-b", "v1")).toBe(workflow2);
|
|
35
|
+
});
|
|
36
|
+
test("throws when registering duplicate unversioned workflow", () => {
|
|
37
|
+
const registry = new WorkflowRegistry();
|
|
38
|
+
registry.register(createMockWorkflow("my-workflow"));
|
|
39
|
+
expect(() => {
|
|
40
|
+
registry.register(createMockWorkflow("my-workflow"));
|
|
41
|
+
}).toThrow('Workflow "my-workflow" is already registered');
|
|
42
|
+
});
|
|
43
|
+
test("throws when registering duplicate versioned workflow", () => {
|
|
44
|
+
const registry = new WorkflowRegistry();
|
|
45
|
+
registry.register(createMockWorkflow("my-workflow", "v1"));
|
|
46
|
+
expect(() => {
|
|
47
|
+
registry.register(createMockWorkflow("my-workflow", "v1"));
|
|
48
|
+
}).toThrow('Workflow "my-workflow" (version: v1) is already registered');
|
|
49
|
+
});
|
|
50
|
+
test("allows same name with different versions", () => {
|
|
51
|
+
const registry = new WorkflowRegistry();
|
|
52
|
+
const versioned = createMockWorkflow("my-workflow", "v1");
|
|
53
|
+
const unversioned = createMockWorkflow("my-workflow");
|
|
54
|
+
registry.register(versioned);
|
|
55
|
+
registry.register(unversioned);
|
|
56
|
+
expect(registry.get("my-workflow", "v1")).toBe(versioned);
|
|
57
|
+
expect(registry.get("my-workflow", null)).toBe(unversioned);
|
|
58
|
+
});
|
|
59
|
+
});
|
|
60
|
+
describe("get", () => {
|
|
61
|
+
test("returns undefined for non-existent workflow", () => {
|
|
62
|
+
const registry = new WorkflowRegistry();
|
|
63
|
+
expect(registry.get("non-existent", null)).toBeUndefined();
|
|
64
|
+
});
|
|
65
|
+
test("returns undefined for wrong version", () => {
|
|
66
|
+
const registry = new WorkflowRegistry();
|
|
67
|
+
registry.register(createMockWorkflow("my-workflow", "v1"));
|
|
68
|
+
expect(registry.get("my-workflow", "v2")).toBeUndefined();
|
|
69
|
+
expect(registry.get("my-workflow", null)).toBeUndefined();
|
|
70
|
+
});
|
|
71
|
+
test("returns undefined for versioned lookup on unversioned workflow", () => {
|
|
72
|
+
const registry = new WorkflowRegistry();
|
|
73
|
+
registry.register(createMockWorkflow("my-workflow"));
|
|
74
|
+
expect(registry.get("my-workflow", "v1")).toBeUndefined();
|
|
75
|
+
});
|
|
76
|
+
test("returns the registered workflow", () => {
|
|
77
|
+
const registry = new WorkflowRegistry();
|
|
78
|
+
const workflow = createMockWorkflow("my-workflow");
|
|
79
|
+
registry.register(workflow);
|
|
80
|
+
expect(registry.get("my-workflow", null)).toBe(workflow);
|
|
81
|
+
});
|
|
82
|
+
});
|
|
83
|
+
describe("getAll", () => {
|
|
84
|
+
test("returns all registered workflows", () => {
|
|
85
|
+
const registry = new WorkflowRegistry();
|
|
86
|
+
const a = createMockWorkflow("workflow-a");
|
|
87
|
+
const b = createMockWorkflow("workflow-b", "v1");
|
|
88
|
+
const c = createMockWorkflow("workflow-a", "v2");
|
|
89
|
+
registry.register(a);
|
|
90
|
+
registry.register(b);
|
|
91
|
+
registry.register(c);
|
|
92
|
+
const all = registry.getAll();
|
|
93
|
+
expect(all).toHaveLength(3);
|
|
94
|
+
expect(all).toEqual(expect.arrayContaining([a, b, c]));
|
|
95
|
+
});
|
|
96
|
+
test("returns empty array when none registered", () => {
|
|
97
|
+
const registry = new WorkflowRegistry();
|
|
98
|
+
expect(registry.getAll()).toEqual([]);
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
function createMockWorkflow(name, version) {
|
|
103
|
+
return defineWorkflow({
|
|
104
|
+
name,
|
|
105
|
+
...(version && { version }),
|
|
106
|
+
}, async () => {
|
|
107
|
+
// no-op
|
|
108
|
+
});
|
|
109
|
+
}
|
package/dist/sqlite/backend.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import { Backend, CancelWorkflowRunParams, ClaimWorkflowRunParams, CreateStepAttemptParams, CreateWorkflowRunParams, GetStepAttemptParams, GetWorkflowRunParams, ExtendWorkflowRunLeaseParams, ListStepAttemptsParams, ListWorkflowRunsParams, PaginatedResponse, FailStepAttemptParams, CompleteStepAttemptParams, FailWorkflowRunParams, CompleteWorkflowRunParams, SleepWorkflowRunParams
|
|
1
|
+
import { Backend, CancelWorkflowRunParams, ClaimWorkflowRunParams, CreateStepAttemptParams, CreateWorkflowRunParams, GetStepAttemptParams, GetWorkflowRunParams, ExtendWorkflowRunLeaseParams, ListStepAttemptsParams, ListWorkflowRunsParams, PaginatedResponse, FailStepAttemptParams, CompleteStepAttemptParams, FailWorkflowRunParams, CompleteWorkflowRunParams, SleepWorkflowRunParams } from "../backend.js";
|
|
2
|
+
import { StepAttempt } from "../core/step.js";
|
|
3
|
+
import { WorkflowRun } from "../core/workflow.js";
|
|
2
4
|
interface BackendSqliteOptions {
|
|
3
5
|
namespaceId?: string;
|
|
4
6
|
runMigrations?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../sqlite/backend.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../../sqlite/backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,OAAO,EACP,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACrB,yBAAyB,EACzB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAgBlD,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"}
|
package/dist/sqlite/backend.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { DEFAULT_NAMESPACE_ID, } from "../backend.js";
|
|
2
|
+
import { DEFAULT_RETRY_POLICY } from "../core/retry.js";
|
|
1
3
|
import { newDatabase, migrate, generateUUID, now, addMilliseconds, toJSON, fromJSON, toISO, fromISO, } from "./sqlite.js";
|
|
2
|
-
import { DEFAULT_NAMESPACE_ID, DEFAULT_RETRY_POLICY, } from "openworkflow/internal";
|
|
3
4
|
const DEFAULT_PAGINATION_PAGE_SIZE = 100;
|
|
4
5
|
/**
|
|
5
6
|
* Manages a connection to a SQLite database for workflow operations.
|
|
@@ -309,12 +310,12 @@ export class BackendSqlite {
|
|
|
309
310
|
cursor = decodeCursor(before);
|
|
310
311
|
}
|
|
311
312
|
const order = before
|
|
312
|
-
? `ORDER BY "created_at"
|
|
313
|
-
: `ORDER BY "created_at"
|
|
313
|
+
? `ORDER BY "created_at" ASC, "id" ASC`
|
|
314
|
+
: `ORDER BY "created_at" DESC, "id" DESC`;
|
|
314
315
|
let query;
|
|
315
316
|
let queryParams;
|
|
316
317
|
if (cursor) {
|
|
317
|
-
const op = after ? "
|
|
318
|
+
const op = after ? "<" : ">";
|
|
318
319
|
query = `
|
|
319
320
|
SELECT *
|
|
320
321
|
FROM "workflow_runs"
|
|
@@ -651,4 +652,3 @@ function decodeCursor(cursor) {
|
|
|
651
652
|
id: parsed.id,
|
|
652
653
|
};
|
|
653
654
|
}
|
|
654
|
-
//# sourceMappingURL=backend.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"backend.test.d.ts","sourceRoot":"","sources":["../../sqlite/backend.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { testBackend } from "../internal.js";
|
|
2
|
+
import { BackendSqlite } from "./backend.js";
|
|
3
|
+
import assert from "node:assert";
|
|
4
|
+
import { randomUUID } from "node:crypto";
|
|
5
|
+
import { unlinkSync, existsSync } from "node:fs";
|
|
6
|
+
import { tmpdir } from "node:os";
|
|
7
|
+
import path from "node:path";
|
|
8
|
+
import { test, describe, afterAll } from "vitest";
|
|
9
|
+
test("it is a test file (workaround for sonarjs/no-empty-test-file linter)", () => {
|
|
10
|
+
assert.ok(true);
|
|
11
|
+
});
|
|
12
|
+
describe("BackendSqlite (in-memory)", () => {
|
|
13
|
+
testBackend({
|
|
14
|
+
setup: () => {
|
|
15
|
+
return Promise.resolve(BackendSqlite.connect(":memory:", {
|
|
16
|
+
namespaceId: randomUUID(),
|
|
17
|
+
}));
|
|
18
|
+
},
|
|
19
|
+
teardown: async (backend) => {
|
|
20
|
+
await backend.stop();
|
|
21
|
+
},
|
|
22
|
+
});
|
|
23
|
+
});
|
|
24
|
+
describe("BackendSqlite (file-based)", () => {
|
|
25
|
+
const testDbPath = path.join(tmpdir(), `openworkflow-test-${randomUUID()}.db`);
|
|
26
|
+
afterAll(() => {
|
|
27
|
+
const walPath = `${testDbPath}-wal`;
|
|
28
|
+
const shmPath = `${testDbPath}-shm`;
|
|
29
|
+
// clean up the test database, WAL, and SHM files if they exist
|
|
30
|
+
if (existsSync(testDbPath)) {
|
|
31
|
+
unlinkSync(testDbPath);
|
|
32
|
+
}
|
|
33
|
+
if (existsSync(walPath)) {
|
|
34
|
+
unlinkSync(walPath);
|
|
35
|
+
}
|
|
36
|
+
if (existsSync(shmPath)) {
|
|
37
|
+
unlinkSync(shmPath);
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
testBackend({
|
|
41
|
+
setup: () => {
|
|
42
|
+
return Promise.resolve(BackendSqlite.connect(testDbPath, {
|
|
43
|
+
namespaceId: randomUUID(),
|
|
44
|
+
}));
|
|
45
|
+
},
|
|
46
|
+
teardown: async (backend) => {
|
|
47
|
+
await backend.stop();
|
|
48
|
+
},
|
|
49
|
+
});
|
|
50
|
+
});
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SQLite driver for OpenWorkflow using the Drizzle-style API.
|
|
3
|
+
*
|
|
4
|
+
* This module provides a `sqlite()` function that creates a driver
|
|
5
|
+
* for connecting to SQLite databases.
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* import { openworkflow } from 'openworkflow';
|
|
9
|
+
* import { sqlite } from 'openworkflow/sqlite';
|
|
10
|
+
*
|
|
11
|
+
* // In-memory database (great for testing)
|
|
12
|
+
* const ow = await openworkflow(sqlite(':memory:'));
|
|
13
|
+
*
|
|
14
|
+
* // File-based database
|
|
15
|
+
* const ow = await openworkflow(sqlite('./data/workflow.db'));
|
|
16
|
+
*
|
|
17
|
+
* // With configuration options
|
|
18
|
+
* const ow = await openworkflow(sqlite({
|
|
19
|
+
* path: './data/workflow.db',
|
|
20
|
+
* namespace: 'my-app',
|
|
21
|
+
* runMigrations: true,
|
|
22
|
+
* }));
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
import type { Backend, Driver, DriverConfig } from "openworkflow/internal";
|
|
26
|
+
/**
|
|
27
|
+
* SQLite-specific driver configuration.
|
|
28
|
+
*/
|
|
29
|
+
export interface SqliteDriverConfig extends DriverConfig {
|
|
30
|
+
/**
|
|
31
|
+
* Path to the SQLite database file.
|
|
32
|
+
* Use ':memory:' for an in-memory database.
|
|
33
|
+
*/
|
|
34
|
+
path?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Existing SQLite database instance.
|
|
37
|
+
* If provided, the driver will use this database instead of creating a new one.
|
|
38
|
+
*/
|
|
39
|
+
database?: SqliteDatabase;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Interface for SQLite database instance.
|
|
43
|
+
* This matches the node:sqlite DatabaseSync interface.
|
|
44
|
+
*/
|
|
45
|
+
export interface SqliteDatabase {
|
|
46
|
+
close(): void;
|
|
47
|
+
exec(sql: string): void;
|
|
48
|
+
prepare(sql: string): any;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* SQLite driver instance.
|
|
52
|
+
*/
|
|
53
|
+
export interface SqliteDriver extends Driver {
|
|
54
|
+
readonly dialect: "sqlite";
|
|
55
|
+
readonly $client: SqliteDatabase | undefined;
|
|
56
|
+
createBackend(): Backend;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Creates a SQLite driver for OpenWorkflow.
|
|
60
|
+
*
|
|
61
|
+
* This function follows the Drizzle ORM pattern and supports multiple
|
|
62
|
+
* calling conventions:
|
|
63
|
+
* @param config - Database path or configuration object
|
|
64
|
+
* @returns A SqliteDriver instance
|
|
65
|
+
* @example
|
|
66
|
+
* ```ts
|
|
67
|
+
* // With database path
|
|
68
|
+
* sqlite('./data/workflow.db')
|
|
69
|
+
* sqlite(':memory:')
|
|
70
|
+
*
|
|
71
|
+
* // With config object
|
|
72
|
+
* sqlite({
|
|
73
|
+
* path: './data/workflow.db',
|
|
74
|
+
* namespace: 'my-app',
|
|
75
|
+
* })
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
export declare function sqlite(config: string | SqliteDriverConfig): SqliteDriver;
|
|
79
|
+
//# sourceMappingURL=driver.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../sqlite/driver.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,CAAC;IAC7C,aAAa,IAAI,OAAO,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,GAAG,YAAY,CAqExE"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Creates a SQLite driver for OpenWorkflow.
|
|
3
|
+
*
|
|
4
|
+
* This function follows the Drizzle ORM pattern and supports multiple
|
|
5
|
+
* calling conventions:
|
|
6
|
+
* @param config - Database path or configuration object
|
|
7
|
+
* @returns A SqliteDriver instance
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* // With database path
|
|
11
|
+
* sqlite('./data/workflow.db')
|
|
12
|
+
* sqlite(':memory:')
|
|
13
|
+
*
|
|
14
|
+
* // With config object
|
|
15
|
+
* sqlite({
|
|
16
|
+
* path: './data/workflow.db',
|
|
17
|
+
* namespace: 'my-app',
|
|
18
|
+
* })
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
export function sqlite(config) {
|
|
22
|
+
// Normalize config
|
|
23
|
+
const normalizedConfig = typeof config === "string" ? { path: config } : config;
|
|
24
|
+
// Store the database reference (will be set on createBackend)
|
|
25
|
+
let databaseRef = normalizedConfig.database;
|
|
26
|
+
return {
|
|
27
|
+
dialect: "sqlite",
|
|
28
|
+
get $client() {
|
|
29
|
+
return databaseRef;
|
|
30
|
+
},
|
|
31
|
+
createBackend() {
|
|
32
|
+
// Dynamically import BackendSqlite to avoid requiring the sqlite
|
|
33
|
+
// package as a direct dependency of the openworkflow package
|
|
34
|
+
// Note: We use require here because sqlite is synchronous
|
|
35
|
+
// Determine the database path
|
|
36
|
+
const databasePath = normalizedConfig.path;
|
|
37
|
+
if (!databasePath && !normalizedConfig.database) {
|
|
38
|
+
throw new Error("SQLite driver requires either a database path or an existing database. " +
|
|
39
|
+
"Provide `path` or `database` in the config.");
|
|
40
|
+
}
|
|
41
|
+
// If we have an existing database, we need to handle it differently
|
|
42
|
+
if (!databasePath) {
|
|
43
|
+
throw new Error("Using an existing SQLite database is not yet supported. " +
|
|
44
|
+
"Please provide a database path via the `path` option.");
|
|
45
|
+
}
|
|
46
|
+
// Import and create the backend synchronously
|
|
47
|
+
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
48
|
+
const { BackendSqlite } = require("@openworkflow/backend-sqlite");
|
|
49
|
+
const options = {
|
|
50
|
+
runMigrations: normalizedConfig.runMigrations ?? true,
|
|
51
|
+
};
|
|
52
|
+
if (normalizedConfig.namespace) {
|
|
53
|
+
options.namespaceId = normalizedConfig.namespace;
|
|
54
|
+
}
|
|
55
|
+
const backend = BackendSqlite.connect(databasePath, options);
|
|
56
|
+
// Store database reference for $client getter
|
|
57
|
+
// Note: BackendSqlite doesn't expose the database, so this remains undefined
|
|
58
|
+
databaseRef = undefined;
|
|
59
|
+
return backend;
|
|
60
|
+
},
|
|
61
|
+
};
|
|
62
|
+
}
|
package/dist/sqlite/index.d.ts
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
/**
|
|
2
|
+
* SQLite driver for OpenWorkflow.
|
|
3
|
+
* @example
|
|
4
|
+
* ```ts
|
|
5
|
+
* import { openworkflow } from 'openworkflow';
|
|
6
|
+
* import { sqlite } from 'openworkflow/sqlite';
|
|
7
|
+
*
|
|
8
|
+
* const ow = await openworkflow(sqlite(':memory:'));
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
export { sqlite } from "./driver.js";
|
|
12
|
+
export type { SqliteDriver, SqliteDriverConfig, SqliteDatabase, } from "./driver.js";
|
|
3
13
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../sqlite/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../sqlite/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EACV,YAAY,EACZ,kBAAkB,EAClB,cAAc,GACf,MAAM,aAAa,CAAC"}
|
package/dist/sqlite/index.js
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
/**
|
|
2
|
+
* SQLite driver for OpenWorkflow.
|
|
3
|
+
* @example
|
|
4
|
+
* ```ts
|
|
5
|
+
* import { openworkflow } from 'openworkflow';
|
|
6
|
+
* import { sqlite } from 'openworkflow/sqlite';
|
|
7
|
+
*
|
|
8
|
+
* const ow = await openworkflow(sqlite(':memory:'));
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
export { sqlite } from "./driver.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../sqlite/internal.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./sqlite.js";
|
package/dist/sqlite/sqlite.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sqlite.test.d.ts","sourceRoot":"","sources":["../../sqlite/sqlite.test.ts"],"names":[],"mappings":""}
|