@shivaedev/effect-pg-boss 0.8.1 → 0.10.0

package/dist/server/internal/testingReadout.d.ts

@@ -0,0 +1,44 @@
+import { Effect } from "effect";
+import type { FindJobsOptions, PgBoss } from "pg-boss";
+import type { JobPayloadSchema, QueueDefinition } from "#definition.ts";
+import { PgBossPayloadError, PgBossTestingError } from "#error.ts";
+export declare function testingOperation<A>(operation: string, run: () => Promise<A>, queue?: string): Effect.Effect<A, PgBossTestingError, never>;
+export declare function testingReadout(client: () => PgBoss): <TName extends string, TPayload extends JobPayloadSchema>(queue: QueueDefinition<TName, TPayload>, options?: FindJobsOptions) => Effect.Effect<{
+    id: string;
+    name: string;
+    retryCount: number;
+    signal: AbortSignal;
+    groupId?: string | null;
+    groupTier?: string | null;
+    priority: number;
+    state: 'created' | 'retry' | 'active' | 'completed' | 'cancelled' | 'failed';
+    retryLimit: number;
+    retryDelay: number;
+    retryBackoff: boolean;
+    retryDelayMax?: number;
+    startAfter: Date;
+    startedOn: Date;
+    singletonKey: string | null;
+    singletonOn: Date | null;
+    expireInSeconds: number;
+    deleteAfterSeconds: number;
+    createdOn: Date;
+    completedOn: Date | null;
+    keepUntil: Date;
+    policy: import("pg-boss").QueuePolicy;
+    heartbeatOn: Date | null;
+    heartbeatSeconds: number | null;
+    blocked: boolean;
+    blocking: boolean;
+    pendingDependencies: number;
+    deadLetter: string;
+    output: object;
+    sourceName: string | null;
+    sourceId: string | null;
+    sourceCreatedOn: Date | null;
+    sourceRetryCount: number | null;
+    sourceOutput: object | null;
+    sourceRootId: string | null;
+    data: TPayload["Type"];
+}[], PgBossPayloadError | PgBossTestingError, TPayload["DecodingServices"]>;
+//# sourceMappingURL=testingReadout.d.ts.map

package/dist/server/internal/testingReadout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingReadout.d.ts","sourceRoot":"","sources":["../../../src/server/internal/testingReadout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAoB,MAAM,QAAQ,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAGnE,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,+CAK3F;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,MAAM,IAC1C,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,gBAAgB,SAAS,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4EAWnI"}

package/dist/server/internal/testingReadout.js

@@ -0,0 +1,13 @@
+import { Effect, Redacted, Schema } from "effect";
+import { PgBossPayloadError, PgBossTestingError } from "#error.ts";
+import { payloadOf } from "#internal/tracing.ts";
+export function testingOperation(operation, run, queue) {
+    return Effect.tryPromise({
+        catch: (original) => new PgBossTestingError({ operation, original: Redacted.make(original), queue }),
+        try: run,
+    });
+}
+export function testingReadout(client) {
+    return (queue, options) => testingOperation("jobs", () => client().findJobs(queue.name, options), queue.name).pipe(Effect.flatMap((jobs) => Effect.forEach(jobs, (job) => Schema.decodeUnknownEffect(queue.schema)(payloadOf(job.data)).pipe(Effect.mapError((original) => new PgBossPayloadError({ direction: "decode", original: Redacted.make(original), queue: queue.name })), Effect.map((data) => ({ ...job, data }))))));
+}
+//# sourceMappingURL=testingReadout.js.map

package/dist/server/internal/testingReadout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingReadout.js","sourceRoot":"","sources":["../../../src/server/internal/testingReadout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGlD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,UAAU,gBAAgB,CAAI,SAAiB,EAAE,GAAqB,EAAE,KAAc;IAC3F,OAAO,MAAM,CAAC,UAAU,CAAC;QACxB,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;QACpG,GAAG,EAAE,GAAG;KACR,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAoB;IAClD,OAAO,CAA0D,KAAuC,EAAE,OAAyB,EAAE,EAAE,CACtI,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAU,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAC/F,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAC5B,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CACjE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,EACpI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CACxC,CACD,CACD,CACD,CAAC;AACJ,CAAC"}

package/dist/server/internal/testingSignal.d.ts

@@ -0,0 +1,7 @@
+import { Effect } from "effect";
+export declare function testingSignal(): {
+    changed(): void;
+    revision: Effect.Effect<number, never, never>;
+    waitForChange: (after: number) => Effect.Effect<number>;
+};
+//# sourceMappingURL=testingSignal.d.ts.map

package/dist/server/internal/testingSignal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingSignal.d.ts","sourceRoot":"","sources":["../../../src/server/internal/testingSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,wBAAgB,aAAa;IAI3B,OAAO;IAOP,QAAQ;IACR,aAAa,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;EAatD"}

package/dist/server/internal/testingSignal.js

@@ -0,0 +1,27 @@
+import { Effect } from "effect";
+export function testingSignal() {
+    let revision = 0;
+    const listeners = new Set();
+    return {
+        changed() {
+            revision += 1;
+            for (const listener of listeners) {
+                listener(revision);
+            }
+            listeners.clear();
+        },
+        revision: Effect.sync(() => revision),
+        waitForChange: (after) => Effect.callback((resume) => {
+            if (revision !== after) {
+                resume(Effect.succeed(revision));
+                return;
+            }
+            function listener(current) {
+                resume(Effect.succeed(current));
+            }
+            listeners.add(listener);
+            return Effect.sync(() => listeners.delete(listener));
+        }),
+    };
+}
+//# sourceMappingURL=testingSignal.js.map

package/dist/server/internal/testingSignal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingSignal.js","sourceRoot":"","sources":["../../../src/server/internal/testingSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,UAAU,aAAa;IAC5B,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,MAAM,SAAS,GAAG,IAAI,GAAG,EAA8B,CAAC;IACxD,OAAO;QACN,OAAO;YACN,QAAQ,IAAI,CAAC,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAClC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACpB,CAAC;YACD,SAAS,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC;QACD,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;QACrC,aAAa,EAAE,CAAC,KAAa,EAAyB,EAAE,CACvD,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;gBACxB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACjC,OAAO;YACR,CAAC;YACD,SAAS,QAAQ,CAAC,OAAe;gBAChC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YACjC,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;KACH,CAAC;AACH,CAAC"}

package/dist/server/schema.d.ts

@@ -0,0 +1,8 @@
+import { Effect } from "effect";
+import { SqlClient } from "effect/sql";
+import { type PgBossError } from "#error.ts";
+export interface PgBossSchemaOptions {
+    readonly schema?: string;
+}
+export declare function installPgBossSchema(options?: PgBossSchemaOptions): Effect.Effect<void, PgBossError, SqlClient.SqlClient>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/server/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/server/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIvC,OAAO,EAAE,KAAK,WAAW,EAAiB,MAAM,WAAW,CAAC;AAI5D,MAAM,WAAW,mBAAmB;IACnC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CACzB;AAoCD,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,mBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,SAAS,CAAC,CAS5H"}

package/dist/server/schema.js

@@ -0,0 +1,43 @@
+import { Effect } from "effect";
+import { SqlClient } from "effect/sql";
+import { getConstructionPlans, getMigrationPlans, PgBoss } from "pg-boss";
+import pgBossPackage from "pg-boss/package.json" with { type: "json" };
+import { toPgBossError } from "#error.ts";
+import { runSchemaPlan } from "#internal/runSchemaPlan.ts";
+import { resumeSchemaIndexes } from "#internal/schemaIndexBuilds.ts";
+async function installSchema(connection, options, run) {
+    const schema = options.schema ?? "pgboss";
+    const construction = getConstructionPlans(schema);
+    const client = new PgBoss({
+        db: { executeSql: async (text, values = []) => ({ rows: Array.from(await run(connection.executeUnprepared(text, values, undefined))) }) },
+        schema,
+    });
+    if (!(await client.isInstalled())) {
+        await runSchemaPlan(connection, construction, run);
+        return;
+    }
+    const version = await client.schemaVersion();
+    if (version === null) {
+        throw new Error("The pg-boss version table is empty");
+    }
+    if (version > pgBossPackage.pgboss.schema) {
+        return;
+    }
+    if (version >= 27) {
+        await resumeSchemaIndexes(client, schema);
+    }
+    if (version < pgBossPackage.pgboss.schema) {
+        const partitionTables = Array.from(await run(connection.executeUnprepared(`SELECT table_name AS "tableName", policy FROM ${schema}.queue WHERE partition = true`, [], undefined)));
+        await runSchemaPlan(connection, getMigrationPlans(schema, version, { partitionTables }), run, { schema, version: pgBossPackage.pgboss.schema });
+        await resumeSchemaIndexes(client, schema);
+    }
+}
+export function installPgBossSchema(options = {}) {
+    return Effect.scoped(Effect.gen(function* () {
+        const sql = yield* SqlClient.SqlClient;
+        const connection = yield* sql.reserve;
+        const run = Effect.runPromiseWith(yield* Effect.context());
+        yield* Effect.tryPromise({ catch: (error) => error, try: () => installSchema(connection, options, run) });
+    }).pipe(Effect.mapError((error) => toPgBossError("install", error)))).pipe(Effect.uninterruptible);
+}
+//# sourceMappingURL=schema.js.map

package/dist/server/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/server/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAA2B,MAAM,EAAE,MAAM,SAAS,CAAC;AACnG,OAAO,aAAa,MAAM,sBAAsB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACvE,OAAO,EAAoB,aAAa,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAMrE,KAAK,UAAU,aAAa,CAC3B,UAAsB,EACtB,OAA4B,EAC5B,GAAsD;IAEtD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC;IAC1C,MAAM,YAAY,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACzB,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;QACzI,MAAM;KACN,CAAC,CAAC;IACH,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QACnC,MAAM,aAAa,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;QACnD,OAAO;IACR,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IAC7C,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3C,OAAO;IACR,CAAC;IACD,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;QACnB,MAAM,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAyB,KAAK,CAAC,IAAI,CACvD,MAAM,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,iDAAiD,MAAM,+BAA+B,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAC9I,CAAC;QACF,MAAM,aAAa,CAAC,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,eAAe,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAChJ,MAAM,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;AACF,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAO,GAAwB,EAAE;IACpE,OAAO,MAAM,CAAC,MAAM,CACnB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACnB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QACtC,MAAM,GAAG,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,EAAS,CAAC,CAAC;QAClE,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CACpE,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;AAChC,CAAC"}

package/dist/server/testing.d.ts

@@ -0,0 +1,61 @@
+import { Effect } from "effect";
+import type { PgBossClientFactory } from "#client.ts";
+import type { QueueDefinition } from "#definition.ts";
+import { PgBossTestingError } from "#error.ts";
+export declare const testRetryPolicy: Readonly<{
+    retryBackoff: false;
+    retryDelay: 0;
+}>;
+export interface PgBossTestingOptions {
+    readonly retryPolicy?: typeof testRetryPolicy;
+}
+export declare function makePgBossTesting(options?: PgBossTestingOptions): {
+    checkBatchWindow: (queue: QueueDefinition, millisecondsPerJob: number) => Effect.Effect<void, PgBossTestingError, never>;
+    checkSchemaVersion: (expected: number) => Effect.Effect<void, PgBossTestingError, never>;
+    clientFactory: PgBossClientFactory;
+    expireAfter: (queue: QueueDefinition, attempts: number) => Effect.Effect<void, PgBossTestingError, never>;
+    failNextSend: (queue: QueueDefinition) => Effect.Effect<void, never, never>;
+    jobs: <TName extends string, TPayload extends import("#definition.ts").JobPayloadSchema>(queue: QueueDefinition<TName, TPayload>, options?: import("pg-boss").FindJobsOptions) => Effect.Effect<{
+        id: string;
+        name: string;
+        retryCount: number;
+        signal: AbortSignal;
+        groupId?: string | null;
+        groupTier?: string | null;
+        priority: number;
+        state: 'created' | 'retry' | 'active' | 'completed' | 'cancelled' | 'failed';
+        retryLimit: number;
+        retryDelay: number;
+        retryBackoff: boolean;
+        retryDelayMax?: number;
+        startAfter: Date;
+        startedOn: Date;
+        singletonKey: string | null;
+        singletonOn: Date | null;
+        expireInSeconds: number;
+        deleteAfterSeconds: number;
+        createdOn: Date;
+        completedOn: Date | null;
+        keepUntil: Date;
+        policy: import("pg-boss").QueuePolicy;
+        heartbeatOn: Date | null;
+        heartbeatSeconds: number | null;
+        blocked: boolean;
+        blocking: boolean;
+        pendingDependencies: number;
+        deadLetter: string;
+        output: object;
+        sourceName: string | null;
+        sourceId: string | null;
+        sourceCreatedOn: Date | null;
+        sourceRetryCount: number | null;
+        sourceOutput: object | null;
+        sourceRootId: string | null;
+        data: TPayload["Type"];
+    }[], import("#error.ts").PgBossPayloadError | PgBossTestingError, TPayload["DecodingServices"]>;
+    revision: Effect.Effect<number, never, never>;
+    schemaVersion: Effect.Effect<number | null, PgBossTestingError, never>;
+    waitForChange: (after: number) => Effect.Effect<number>;
+};
+export type PgBossTesting = ReturnType<typeof makePgBossTesting>;
+//# sourceMappingURL=testing.d.ts.map

package/dist/server/testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../../src/server/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAY,MAAM,QAAQ,CAAC;AAE1C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAK/C,eAAO,MAAM,eAAe;;;EAAwD,CAAC;AAErF,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,eAAe,CAAC;CAC9C;AAED,wBAAgB,iBAAiB,CAAC,OAAO,GAAE,oBAAyB;8BAuBxC,eAAe,sBAAsB,MAAM;mCAqBtC,MAAM;;yBAOhB,eAAe,YAAY,MAAM;0BAUhC,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtC;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/server/testing.js

@@ -0,0 +1,69 @@
+import { Effect, Redacted } from "effect";
+import { PgBoss } from "pg-boss";
+import { PgBossTestingError } from "#error.ts";
+import { testingClient } from "#internal/testingClient.ts";
+import { testingOperation, testingReadout } from "#internal/testingReadout.ts";
+import { testingSignal } from "#internal/testingSignal.ts";
+export const testRetryPolicy = Object.freeze({ retryBackoff: false, retryDelay: 0 });
+export function makePgBossTesting(options = {}) {
+    let current;
+    const signal = testingSignal();
+    const controls = {
+        changed: signal.changed,
+        expirations: new Map(),
+        failures: new Set(),
+        retryPolicy: options.retryPolicy ?? {},
+    };
+    function client() {
+        if (current === undefined) {
+            throw new Error("Provide the testing clientFactory to a jobs Layer first");
+        }
+        return current;
+    }
+    const clientFactory = (clientOptions) => {
+        if (current !== undefined) {
+            throw new Error("A testing controller owns one jobs client; create a controller per runtime");
+        }
+        current = new PgBoss({ ...clientOptions, "__test__enableSpies": true });
+        return testingClient(current, clientOptions.schema ?? "pgboss", controls);
+    };
+    return {
+        checkBatchWindow: (queue, millisecondsPerJob) => testingOperation("checkBatchWindow", async () => {
+            const stored = await client().getQueue(queue.name);
+            if (stored === null) {
+                throw new Error("Queue is not registered");
+            }
+            if (stored.expireInSeconds === undefined) {
+                throw new Error("Queue has no expiry window");
+            }
+            if (!Number.isFinite(millisecondsPerJob) || millisecondsPerJob < 0) {
+                throw new RangeError("Job duration must be nonnegative and finite");
+            }
+            const required = (queue.workerOptions.batchSize ?? 10) * millisecondsPerJob;
+            if (required >= stored.expireInSeconds * 1000) {
+                throw new Error("Sequential batch work must fit within the queue expiry window");
+            }
+        }, queue.name),
+        checkSchemaVersion: (expected) => testingOperation("checkSchemaVersion", async () => {
+            if ((await client().schemaVersion()) !== expected) {
+                throw new Error(`Expected pg-boss schema version ${expected}`);
+            }
+        }),
+        clientFactory,
+        expireAfter: (queue, attempts) => Effect.try({
+            catch: (original) => new PgBossTestingError({ operation: "expireAfter", original: Redacted.make(original), queue: queue.name }),
+            try: () => {
+                if (!Number.isSafeInteger(attempts) || attempts < 1) {
+                    throw new RangeError("Attempts must be a positive integer");
+                }
+                controls.expirations.set(queue.name, attempts);
+            },
+        }),
+        failNextSend: (queue) => Effect.sync(() => controls.failures.add(queue.name)).pipe(Effect.asVoid),
+        jobs: testingReadout(client),
+        revision: signal.revision,
+        schemaVersion: testingOperation("schemaVersion", () => client().schemaVersion()),
+        waitForChange: signal.waitForChange,
+    };
+}
+//# sourceMappingURL=testing.js.map

package/dist/server/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../../src/server/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;AAMrF,MAAM,UAAU,iBAAiB,CAAC,OAAO,GAAyB,EAAE;IACnE,IAAI,OAA2B,CAAC;IAChC,MAAM,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG;QAChB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,WAAW,EAAE,IAAI,GAAG,EAAkB;QACtC,QAAQ,EAAE,IAAI,GAAG,EAAU;QAC3B,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;KACtC,CAAC;IACF,SAAS,MAAM;QACd,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,MAAM,aAAa,GAAwB,CAAC,aAAa,EAAE,EAAE;QAC5D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,GAAG,IAAI,MAAM,CAAC,EAAE,GAAG,aAAa,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,OAAO,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,IAAI,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC3E,CAAC,CAAC;IACF,OAAO;QACN,gBAAgB,EAAE,CAAC,KAAsB,EAAE,kBAA0B,EAAE,EAAE,CACxE,gBAAgB,CACf,kBAAkB,EAClB,KAAK,IAAI,EAAE;YACV,MAAM,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAC/C,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,kBAAkB,GAAG,CAAC,EAAE,CAAC;gBACpE,MAAM,IAAI,UAAU,CAAC,6CAA6C,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,IAAI,EAAE,CAAC,GAAG,kBAAkB,CAAC;YAC5E,IAAI,QAAQ,IAAI,MAAM,CAAC,eAAe,GAAG,IAAI,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;YAClF,CAAC;QACF,CAAC,EACD,KAAK,CAAC,IAAI,CACV;QACF,kBAAkB,EAAE,CAAC,QAAgB,EAAE,EAAE,CACxC,gBAAgB,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;YACjD,IAAI,CAAC,MAAM,MAAM,EAAE,CAAC,aAAa,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;YAChE,CAAC;QACF,CAAC,CAAC;QACH,aAAa;QACb,WAAW,EAAE,CAAC,KAAsB,EAAE,QAAgB,EAAE,EAAE,CACzD,MAAM,CAAC,GAAG,CAAC;YACV,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAC/H,GAAG,EAAE,GAAG,EAAE;gBACT,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;oBACrD,MAAM,IAAI,UAAU,CAAC,qCAAqC,CAAC,CAAC;gBAC7D,CAAC;gBACD,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAChD,CAAC;SACD,CAAC;QACH,YAAY,EAAE,CAAC,KAAsB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAClH,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC;QAC5B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,gBAAgB,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,aAAa,EAAE,CAAC;QAChF,aAAa,EAAE,MAAM,CAAC,aAAa;KACnC,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shivaedev/effect-pg-boss",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "description": "Effect-native jobs and lifecycle management for pg-boss",
   "homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/effect-pg-boss#readme",
   "bugs": {
@@ -24,9 +24,8 @@
   },
   "exports": {
     "./*.ts": {
-      "types": "./dist/server/*.d.ts",
       "source": "./src/server/*.ts",
-      "import": "./dist/server/*.js",
+      "types": "./dist/server/*.d.ts",
       "default": "./dist/server/*.js"
     },
     "./internal/*": null,
@@ -38,18 +37,18 @@
     "!src/**/*.test.ts",
     "!src/**/*.spec.ts",
     "!src/**/test-support",
-    "docs",
     "CHANGELOG.md",
     "README.md"
   ],
   "devDependencies": {
-    "@shivaedev/effect-test-sql": "0.5.3",
-    "@shivaedev/quality": "0.23.0",
+    "@shivaedev/effect-test": "0.6.0",
+    "@shivaedev/effect-test-sql": "0.5.5",
+    "@shivaedev/quality": "0.27.0",
+    "@shivaedev/test-story": "0.9.0",
     "@types/node": "24.19.2",
-    "@typescript/native": "npm:typescript@7.0.2",
     "effect": "4.0.4",
     "pg-boss": "12.37.1",
-    "typescript": "npm:@typescript/typescript6@6.0.2",
+    "typescript": "7.0.2",
     "vitest": "5.0.3"
   },
   "peerDependencies": {

package/src/server/error.ts

@@ -1,6 +1,6 @@
 import { Data, Redacted } from "effect";
 
-export type PgBossOperation = "counts" | "enqueue" | "getJob" | "health" | "register" | "retry" | "start" | "stop";
+export type PgBossOperation = "counts" | "enqueue" | "getJob" | "health" | "install" | "register" | "retry" | "start" | "stop";
 
 export class PgBossError extends Data.TaggedError("PgBossError")<{
 	readonly operation: PgBossOperation;
@@ -37,6 +37,12 @@ export class PgBossPayloadError extends Data.TaggedError("PgBossPayloadError")<{
 	readonly original: Redacted.Redacted<unknown>;
 }> {}
 
+export class PgBossTestingError extends Data.TaggedError("PgBossTestingError")<{
+	readonly operation: string;
+	readonly original: Redacted.Redacted<unknown>;
+	readonly queue?: string | undefined;
+}> {}
+
 export const toPgBossError = (operation: PgBossOperation, error: unknown, queue?: string): PgBossError =>
 	new PgBossError({
 		operation,

package/src/server/internal/expireAttempt.ts

@@ -0,0 +1,18 @@
+import type { Job, PgBoss } from "pg-boss";
+
+export async function expireAttempt(client: PgBoss, schema: string, job: Job<unknown>): Promise<void> {
+	if ((await client.schemaVersion()) !== 45) {
+		throw new Error("Testing expiry requires pg-boss schema version 45");
+	}
+	const quoted = `"${schema.replaceAll('"', '""')}"`;
+	await client.getDb().executeSql(
+		`UPDATE ${quoted}.job SET started_on = ${quoted}.job_now() - (expire_seconds + 1) * interval '1 second'
+		WHERE name = $1 AND id = $2 AND retry_count = $3 AND state = 'active'`,
+		[job.name, job.id, job.retryCount],
+	);
+	// Supervision owns expiry and dead lettering; make its claim due with the job's deadline.
+	await client
+		.getDb()
+		.executeSql(`UPDATE ${quoted}.queue SET monitor_claim_on = ${quoted}.job_now() - interval '1 week' WHERE name = $1`, [job.name]);
+	await client.supervise(job.name);
+}

package/src/server/internal/observeTestingSettlements.ts

@@ -0,0 +1,36 @@
+import type { PgBoss } from "pg-boss";
+
+export function observeTestingSettlements(client: PgBoss, changed: () => void) {
+	const observers = new Map<string, () => void>();
+	return {
+		close() {
+			for (const close of observers.values()) {
+				close();
+			}
+			observers.clear();
+		},
+		watch(name: string) {
+			if (observers.has(name)) {
+				return;
+			}
+			const spy = client.getSpy(name);
+			let open = true;
+			async function observe() {
+				while (true) {
+					await Promise.race([spy.waitForJob(() => true, "completed"), spy.waitForJob(() => true, "failed")]);
+					if (!open) {
+						return;
+					}
+					// This controller owns the spy; clear history and the losing wait before rearming both outcomes.
+					spy.clear();
+					changed();
+				}
+			}
+			observers.set(name, () => {
+				open = false;
+				spy.clear();
+			});
+			void observe().catch((error: unknown) => client.emit("error", error instanceof Error ? error : new Error(String(error))));
+		},
+	};
+}

package/src/server/internal/runSchemaPlan.ts

@@ -0,0 +1,32 @@
+import type { Effect } from "effect";
+import type { Connection } from "effect/sql/SqlConnection";
+import { pendingIndexInserts } from "./schemaIndexBuilds.ts";
+
+export async function runSchemaPlan(
+	connection: Connection,
+	plan: string,
+	run: <A, E>(effect: Effect.Effect<A, E>) => Promise<A>,
+	upgrade?: { readonly schema: string; readonly version: number },
+): Promise<void> {
+	// Native exported plans append concurrent index DDL after the migration transaction.
+	const parts = /^\s*BEGIN;(?<body>[\s\S]*)\n {4}COMMIT;(?<concurrent>[\s\S]*)$/u.exec(plan);
+	if (parts?.groups === undefined) {
+		throw new Error("Unrecognized pg-boss schema plan transaction");
+	}
+	const { body = "", concurrent = "" } = parts.groups;
+	function quote(text: string) {
+		return `'${text.replaceAll("'", "''")}'`;
+	}
+	const commands = concurrent
+		.trim()
+		.split(/;\s*(?:\n|$)/u)
+		.filter((statement) => statement.trim() !== "");
+	const pending = upgrade === undefined ? "" : pendingIndexInserts(upgrade.schema, upgrade.version, commands, quote);
+	// Effect SQL uses the extended protocol, which accepts one statement per command.
+	await run(connection.executeRaw(`DO ${quote(`BEGIN EXECUTE ${quote(`${body}\n${pending}`)}; END`)}`, []));
+	if (upgrade === undefined) {
+		for (const statement of commands) {
+			await run(connection.executeRaw(statement, []));
+		}
+	}
+}

package/src/server/internal/schemaIndexBuilds.ts

@@ -0,0 +1,44 @@
+import type { PgBoss } from "pg-boss";
+
+const BUILD_PREFIX = "effect-pg-boss-schema:";
+
+function indexName(command: string): string {
+	const match =
+		/^\s*(?:CREATE (?:UNIQUE )?INDEX CONCURRENTLY IF NOT EXISTS |DROP INDEX CONCURRENTLY IF EXISTS (?:(?:"[^"]+"|\w+)\.))(?<name>\w+)/mu.exec(
+			command,
+		);
+	const name = match?.groups?.name;
+	if (name === undefined) {
+		throw new Error("Unrecognized pg-boss concurrent index command");
+	}
+	return name;
+}
+
+export function pendingIndexInserts(schema: string, version: number, commands: readonly string[], quote: (text: string) => string): string {
+	return commands
+		.map((command, position) => {
+			const table = indexName(command).replace(/_i\d+$/u, "");
+			const name = `${BUILD_PREFIX}${String(position).padStart(6, "0")}`;
+			return `INSERT INTO ${schema}.bam (name, version, table_name, command) VALUES (${quote(name)}, ${version}, ${quote(table)}, ${quote(command)});`;
+		})
+		.join("\n");
+}
+
+export async function resumeSchemaIndexes(client: PgBoss, schema: string): Promise<void> {
+	const db = client.getDb();
+	const { rows } = await db.executeSql(
+		`SELECT id, command FROM ${schema}.bam WHERE starts_with(name, $1) AND status <> 'completed' ORDER BY created_on, name`,
+		[BUILD_PREFIX],
+	);
+	for (const row of rows) {
+		const name = indexName(row.command);
+		if (/^\s*CREATE /mu.test(row.command)) {
+			const probe = await db.executeSql("SELECT NOT indisvalid AS invalid FROM pg_index WHERE indexrelid = to_regclass($1)", [`${schema}.${name}`]);
+			if (probe.rows[0]?.invalid === true) {
+				await db.executeSql(`DROP INDEX CONCURRENTLY IF EXISTS ${schema}."${name}"`);
+			}
+		}
+		await db.executeSql(row.command);
+		await db.executeSql(`UPDATE ${schema}.bam SET status = 'completed', completed_on = clock_timestamp() WHERE id = $1`, [row.id]);
+	}
+}

package/src/server/internal/testingClient.ts

@@ -0,0 +1,115 @@
+import type { Job, PgBoss, SendOptions, UpdateOptions, UpdateRequest, UpdateResponse } from "pg-boss";
+import type { PgBossClient } from "#client.ts";
+import { expireAttempt } from "#internal/expireAttempt.ts";
+import { observeTestingSettlements } from "#internal/observeTestingSettlements.ts";
+import { testingExpirations } from "#internal/testingExpirations.ts";
+
+export interface TestingControls {
+	readonly changed: () => void;
+	readonly expirations: Map<string, number>;
+	readonly failures: Set<string>;
+	readonly retryPolicy: Pick<SendOptions, "retryBackoff" | "retryDelay">;
+}
+
+export function testingClient(client: PgBoss, schema: string, controls: TestingControls): PgBossClient {
+	const settlements = observeTestingSettlements(client, controls.changed);
+	const expirations = testingExpirations(client);
+	function update(request: UpdateRequest): Promise<UpdateResponse>;
+	function update(name: string, data: object | null | undefined, options?: UpdateOptions): Promise<UpdateResponse>;
+	async function update(request: string | UpdateRequest, data?: object | null, options?: UpdateOptions): Promise<UpdateResponse> {
+		const result = typeof request === "string" ? await client.update(request, data, options) : await client.update(request);
+		controls.changed();
+		return result;
+	}
+	const overrides: Partial<PgBossClient> = {
+		complete: async (...args) => {
+			const result = await client.complete(...args);
+			controls.changed();
+			return result;
+		},
+		createQueue: (name, options) => {
+			const { retryDelayMax, ...rest } = options ?? {};
+			return client.createQueue(name, {
+				...rest,
+				...(controls.retryPolicy.retryBackoff === false || retryDelayMax === undefined ? {} : { retryDelayMax }),
+				...controls.retryPolicy,
+			});
+		},
+		fail: async (...args) => {
+			const result = await client.fail(...args);
+			controls.changed();
+			return result;
+		},
+		retry: async (...args) => {
+			const result = await client.retry(...args);
+			controls.changed();
+			return result;
+		},
+		send: async (name, data, options) => {
+			if (controls.failures.delete(name)) {
+				throw new Error("Injected pg-boss send failure");
+			}
+			const attempts = controls.expirations.get(name);
+			const { retryDelayMax, ...rest } = options ?? {};
+			const id = await expirations.send(
+				name,
+				data,
+				{
+					...rest,
+					...(controls.retryPolicy.retryBackoff === false || retryDelayMax === undefined ? {} : { retryDelayMax }),
+					...controls.retryPolicy,
+					...(attempts === undefined ? {} : { retryLimit: attempts - 1 }),
+				},
+				attempts,
+			);
+			controls.changed();
+			return id;
+		},
+		stop: async (options) => {
+			try {
+				await client.stop(options);
+			} finally {
+				settlements.close();
+			}
+		},
+		update,
+		updateQueue: (name, options) =>
+			client.updateQueue(name, {
+				...options,
+				...controls.retryPolicy,
+				...(controls.retryPolicy.retryBackoff === false ? { retryDelayMax: null } : {}),
+			}),
+		work: (name, options, handler) => {
+			settlements.watch(name);
+			return client.work(name, options, async (jobs: Job<unknown>[]) => {
+				controls.changed();
+				try {
+					const ready: Job<unknown>[] = [];
+					for (const job of jobs) {
+						const attempts = await expirations.attemptsFor(job);
+						if (attempts !== undefined && job.retryCount + 1 >= attempts) {
+							await expireAttempt(client, schema, job);
+						} else {
+							ready.push(job);
+						}
+					}
+					if (ready.length > 0) {
+						await handler(ready);
+					}
+				} finally {
+					controls.changed();
+				}
+			});
+		},
+	};
+	return new Proxy(client, {
+		get(target, property) {
+			if (Object.hasOwn(overrides, property)) {
+				const override: unknown = Reflect.get(overrides, property);
+				return override;
+			}
+			const value: unknown = Reflect.get(target, property);
+			return typeof value === "function" ? value.bind(target) : value;
+		},
+	});
+}