@shivaedev/admin 0.1.5 → 0.3.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 +50 -0
- package/dist/jobs/keys.d.ts +8 -0
- package/dist/jobs/keys.d.ts.map +1 -0
- package/dist/jobs/keys.js +10 -0
- package/dist/jobs/keys.js.map +1 -0
- package/dist/jobs/page.d.ts +223 -0
- package/dist/jobs/page.d.ts.map +1 -0
- package/dist/jobs/page.js +45 -0
- package/dist/jobs/page.js.map +1 -0
- package/dist/jobs/retryPage.d.ts +241 -0
- package/dist/jobs/retryPage.d.ts.map +1 -0
- package/dist/jobs/retryPage.js +36 -0
- package/dist/jobs/retryPage.js.map +1 -0
- package/dist/jobs/schemas.d.ts +112 -0
- package/dist/jobs/schemas.d.ts.map +1 -0
- package/dist/jobs/schemas.js +65 -0
- package/dist/jobs/schemas.js.map +1 -0
- package/dist/page.d.ts +3 -5
- package/dist/page.d.ts.map +1 -1
- package/dist/page.js.map +1 -1
- package/dist/server/jobsHandlers.d.ts +49 -0
- package/dist/server/jobsHandlers.d.ts.map +1 -0
- package/dist/server/jobsHandlers.js +63 -0
- package/dist/server/jobsHandlers.js.map +1 -0
- package/dist/server/jobsHandlersWithRetry.d.ts +6 -0
- package/dist/server/jobsHandlersWithRetry.d.ts.map +1 -0
- package/dist/server/jobsHandlersWithRetry.js +22 -0
- package/dist/server/jobsHandlersWithRetry.js.map +1 -0
- package/package.json +5 -3
- package/src/jobs/keys.ts +10 -0
- package/src/jobs/page.ts +45 -0
- package/src/jobs/retryPage.ts +39 -0
- package/src/jobs/schemas.ts +78 -0
- package/src/page.ts +8 -1
- package/src/server/jobsHandlers.ts +83 -0
- package/src/server/jobsHandlersWithRetry.ts +27 -0
package/src/page.ts
CHANGED
|
@@ -27,6 +27,13 @@ export function adminPage<
|
|
|
27
27
|
const TCommands extends readonly CommandShape[],
|
|
28
28
|
TRpcs extends Rpc.Any,
|
|
29
29
|
const TStreams extends readonly StreamShape[],
|
|
30
|
-
>(page: {
|
|
30
|
+
>(page: {
|
|
31
|
+
readonly id: TId;
|
|
32
|
+
readonly route: AdminRoute;
|
|
33
|
+
readonly contract: Contract<TName, TQueries, TCommands, TRpcs, TStreams>;
|
|
34
|
+
}): AdminPage & {
|
|
35
|
+
readonly id: TId;
|
|
36
|
+
readonly contract: Contract<TName, TQueries, TCommands, Rpc.AddMiddleware<TRpcs, typeof AuthenticatedAdmin>, TStreams>;
|
|
37
|
+
} {
|
|
31
38
|
return { ...page, [AdminPageTypeId]: true as const, contract: page.contract.middleware(AuthenticatedAdmin) };
|
|
32
39
|
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { type Context, DateTime, Effect, Option } from "effect";
|
|
2
|
+
import type { PgBossError, PgBossPayloadError } from "@shivaedev/effect-pg-boss/server/error.ts";
|
|
3
|
+
import type { PgBossService } from "@shivaedev/effect-pg-boss/server/service.ts";
|
|
4
|
+
import type { jobsPage } from "#jobs/page.ts";
|
|
5
|
+
import { JobsPayloadInvalid, type JobsQueue, JobsQueueUnregistered, JobsUnavailable } from "#jobs/schemas.ts";
|
|
6
|
+
|
|
7
|
+
export function jobsFailures<A, R>(effect: Effect.Effect<A, PgBossError | PgBossPayloadError, R>) {
|
|
8
|
+
return effect.pipe(
|
|
9
|
+
Effect.mapError((error) =>
|
|
10
|
+
error._tag === "PgBossPayloadError" ? new JobsPayloadInvalid({ queue: error.queue }) : new JobsUnavailable({ operation: error.operation }),
|
|
11
|
+
),
|
|
12
|
+
);
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export function jobsReadHandlers<const TQueues extends readonly JobsQueue[], TService>(
|
|
16
|
+
page: { readonly queues: TQueues },
|
|
17
|
+
service: Context.Service<TService, PgBossService>,
|
|
18
|
+
) {
|
|
19
|
+
function registered(name: string) {
|
|
20
|
+
const queues: readonly TQueues[number][] = page.queues;
|
|
21
|
+
const queue = queues.find((candidate) => candidate.name === name);
|
|
22
|
+
return queue === undefined ? Effect.fail(new JobsQueueUnregistered({ queue: name })) : Effect.succeed(queue);
|
|
23
|
+
}
|
|
24
|
+
return {
|
|
25
|
+
"admin.jobs.counts": ({ queue }: { readonly queue: string }) =>
|
|
26
|
+
Effect.gen(function* () {
|
|
27
|
+
const definition = yield* registered(queue);
|
|
28
|
+
const jobs = yield* service;
|
|
29
|
+
return yield* jobsFailures(jobs.counts(definition));
|
|
30
|
+
}),
|
|
31
|
+
"admin.jobs.deadLettered": ({ queue, ...options }: { readonly queue: string; readonly limit: number; readonly cursor?: string }) =>
|
|
32
|
+
Effect.gen(function* () {
|
|
33
|
+
const definition = yield* registered(queue);
|
|
34
|
+
const jobs = yield* service;
|
|
35
|
+
return yield* jobsFailures(jobs.deadLetteredJobs<string, TQueues[number]["schema"]>(definition, options));
|
|
36
|
+
}),
|
|
37
|
+
"admin.jobs.failed": ({ queue, ...options }: { readonly queue: string; readonly limit: number; readonly cursor?: string }) =>
|
|
38
|
+
Effect.gen(function* () {
|
|
39
|
+
const definition = yield* registered(queue);
|
|
40
|
+
const jobs = yield* service;
|
|
41
|
+
return yield* jobsFailures(jobs.failedJobs<string, TQueues[number]["schema"]>(definition, options));
|
|
42
|
+
}),
|
|
43
|
+
"admin.jobs.health": () =>
|
|
44
|
+
Effect.gen(function* () {
|
|
45
|
+
const jobs = yield* service;
|
|
46
|
+
const health = yield* jobsFailures(jobs.health);
|
|
47
|
+
const visible = health.jobs.filter((queue) => page.queues.some((candidate) => candidate.name === queue.name));
|
|
48
|
+
return {
|
|
49
|
+
activeTotal: visible.reduce((sum, queue) => sum + queue.activeCount, 0),
|
|
50
|
+
deadLetteredTotal: visible.reduce((sum, queue) => sum + queue.deadLetteredCount, 0),
|
|
51
|
+
failedTotal: visible.reduce((sum, queue) => sum + queue.failedCount, 0),
|
|
52
|
+
jobs: visible,
|
|
53
|
+
queuedTotal: visible.reduce((sum, queue) => sum + queue.queuedCount, 0),
|
|
54
|
+
readyTotal: visible.reduce((sum, queue) => sum + queue.readyCount, 0),
|
|
55
|
+
};
|
|
56
|
+
}),
|
|
57
|
+
"admin.jobs.job": ({ id, queue }: { readonly id: string; readonly queue: string }) =>
|
|
58
|
+
Effect.gen(function* () {
|
|
59
|
+
const definition = yield* registered(queue);
|
|
60
|
+
const jobs = yield* service;
|
|
61
|
+
return Option.map(yield* jobsFailures(jobs.getJob<string, TQueues[number]["schema"]>(definition, id)), (job) => ({
|
|
62
|
+
attempt: job.startedOn === null ? 0 : job.retryCount + 1,
|
|
63
|
+
completedOn: Option.map(Option.fromNullishOr(job.completedOn), DateTime.makeUnsafe),
|
|
64
|
+
createdOn: DateTime.makeUnsafe(job.createdOn),
|
|
65
|
+
data: job.data,
|
|
66
|
+
id: job.id,
|
|
67
|
+
output: job.output,
|
|
68
|
+
queue: job.name,
|
|
69
|
+
retryCount: job.retryCount,
|
|
70
|
+
retryLimit: job.retryLimit,
|
|
71
|
+
startedOn: Option.map(Option.fromNullishOr(job.startedOn), DateTime.makeUnsafe),
|
|
72
|
+
state: job.state,
|
|
73
|
+
}));
|
|
74
|
+
}),
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function jobsHandlers<const TQueues extends readonly JobsQueue[], TService>(
|
|
79
|
+
page: ReturnType<typeof jobsPage<TQueues>>,
|
|
80
|
+
service: Context.Service<TService, PgBossService>,
|
|
81
|
+
) {
|
|
82
|
+
return page.contract.application.toLayer(jobsReadHandlers(page, service));
|
|
83
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { type Context, Effect, Option } from "effect";
|
|
2
|
+
import type { PgBossService } from "@shivaedev/effect-pg-boss/server/service.ts";
|
|
3
|
+
import { JobsNotFailed, type jobsPageWithRetry } from "#jobs/retryPage.ts";
|
|
4
|
+
import { type JobsQueue, JobsQueueUnregistered } from "#jobs/schemas.ts";
|
|
5
|
+
import { jobsFailures, jobsReadHandlers } from "./jobsHandlers.ts";
|
|
6
|
+
|
|
7
|
+
export function jobsHandlersWithRetry<const TQueues extends readonly JobsQueue[], TService>(
|
|
8
|
+
page: ReturnType<typeof jobsPageWithRetry<TQueues>>,
|
|
9
|
+
service: Context.Service<TService, PgBossService>,
|
|
10
|
+
) {
|
|
11
|
+
return page.contract.application.toLayer({
|
|
12
|
+
...jobsReadHandlers(page, service),
|
|
13
|
+
"admin.jobs.retry": ({ queue, id }) =>
|
|
14
|
+
Effect.gen(function* () {
|
|
15
|
+
const definition = page.queues.find((candidate) => candidate.name === queue);
|
|
16
|
+
if (definition === undefined) {
|
|
17
|
+
return yield* Effect.fail(new JobsQueueUnregistered({ queue }));
|
|
18
|
+
}
|
|
19
|
+
const jobs = yield* service;
|
|
20
|
+
const job = yield* jobsFailures(jobs.getJob<string, TQueues[number]["schema"]>(definition, id));
|
|
21
|
+
if (Option.isNone(job) || job.value.state !== "failed") {
|
|
22
|
+
return yield* Effect.fail(new JobsNotFailed({ id, queue }));
|
|
23
|
+
}
|
|
24
|
+
yield* jobsFailures(jobs.retry(definition, id));
|
|
25
|
+
}),
|
|
26
|
+
});
|
|
27
|
+
}
|