@shivaedev/admin 0.23.7 → 0.24.1

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.
Files changed (38) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +9 -0
  3. package/dist/adapters/validateAdminRoutes.d.ts +2 -1
  4. package/dist/adapters/validateAdminRoutes.d.ts.map +1 -1
  5. package/dist/adapters/validateAdminRoutes.js +18 -18
  6. package/dist/adapters/validateAdminRoutes.js.map +1 -1
  7. package/dist/client/adapters/JobDetail.d.ts.map +1 -1
  8. package/dist/client/adapters/JobDetail.js +13 -3
  9. package/dist/client/adapters/JobDetail.js.map +1 -1
  10. package/dist/client/adapters/JobList.d.ts.map +1 -1
  11. package/dist/client/adapters/JobList.js +16 -2
  12. package/dist/client/adapters/JobList.js.map +1 -1
  13. package/dist/jobs/page.d.ts +57 -57
  14. package/dist/jobs/retryPage.d.ts +59 -59
  15. package/dist/registry.d.ts +2 -0
  16. package/dist/registry.d.ts.map +1 -1
  17. package/dist/registry.js +14 -11
  18. package/dist/registry.js.map +1 -1
  19. package/dist/server/jobsHandlers.d.ts +9 -9
  20. package/dist/server/jobsHandlers.d.ts.map +1 -1
  21. package/dist/server/jobsHandlers.js +9 -13
  22. package/dist/server/jobsHandlers.js.map +1 -1
  23. package/dist/server/jobsHandlersWithRetry.d.ts +2 -2
  24. package/dist/server/jobsHandlersWithRetry.d.ts.map +1 -1
  25. package/dist/server/jobsHandlersWithRetry.js +7 -4
  26. package/dist/server/jobsHandlersWithRetry.js.map +1 -1
  27. package/dist/server/registerAdmin.d.ts +1 -1
  28. package/dist/server/registerAdmin.d.ts.map +1 -1
  29. package/dist/server/registerAdmin.js +3 -2
  30. package/dist/server/registerAdmin.js.map +1 -1
  31. package/package.json +15 -15
  32. package/src/adapters/validateAdminRoutes.ts +18 -19
  33. package/src/client/adapters/JobDetail.tsx +23 -13
  34. package/src/client/adapters/JobList.tsx +28 -24
  35. package/src/registry.ts +15 -11
  36. package/src/server/jobsHandlers.ts +16 -16
  37. package/src/server/jobsHandlersWithRetry.ts +45 -35
  38. package/src/server/registerAdmin.ts +21 -15
@@ -1,6 +1,7 @@
1
- import { type Context, DateTime, Effect, Option, type Schema } from "effect";
1
+ import { type Context, DateTime, Effect, Layer, Option, type Schema } from "effect";
2
2
  import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
3
  import type { PgBossError, PgBossPayloadError } from "@shivaedev/jobs/server/error.ts";
4
+ import { PgBossInspection } from "@shivaedev/jobs/server/inspection.ts";
4
5
  import { readJobFailure } from "@shivaedev/jobs/server/readJobFailure.ts";
5
6
  import type { PgBossService } from "@shivaedev/jobs/server/service.ts";
6
7
  import { type JobsEntry, type JobsPayload, jobsQueue } from "#jobs/entry.ts";
@@ -22,10 +23,7 @@ export function jobsFailures<A, R>(effect: Effect.Effect<A, PgBossError | PgBoss
22
23
  );
23
24
  }
24
25
 
25
- export function jobsReadHandlers<const TQueues extends readonly JobsEntry[], TService>(
26
- page: { readonly queues: TQueues },
27
- service: Context.Service<TService, PgBossService>,
28
- ) {
26
+ export function jobsReadHandlers<const TQueues extends readonly JobsEntry[]>(page: { readonly queues: TQueues }) {
29
27
  function registered(name: string) {
30
28
  const queues: readonly TQueues[number][] = page.queues;
31
29
  const queue = queues.find((candidate) => candidate.name === name);
@@ -35,35 +33,30 @@ export function jobsReadHandlers<const TQueues extends readonly JobsEntry[], TSe
35
33
  "admin.jobs.counts": ({ queue }: { readonly queue: string }) =>
36
34
  Effect.gen(function* () {
37
35
  const definition = yield* registered(queue);
38
- const runtime = yield* service;
39
- const jobs = yield* runtime.inspection();
36
+ const jobs = yield* PgBossInspection;
40
37
  return yield* jobsFailures(jobs.counts(definition));
41
38
  }),
42
39
  "admin.jobs.deadLettered": ({ queue, ...options }: { readonly queue: string; readonly limit: number; readonly cursor?: string }) =>
43
40
  Effect.gen(function* () {
44
41
  const definition = yield* registered(queue);
45
- const runtime = yield* service;
46
- const jobs = yield* runtime.inspection();
42
+ const jobs = yield* PgBossInspection;
47
43
  return yield* jobsFailures(jobs.deadLetteredJobs<string, JobsPayload<TQueues[number]>>(definition, options));
48
44
  }),
49
45
  "admin.jobs.failed": ({ queue, ...options }: { readonly queue: string; readonly limit: number; readonly cursor?: string }) =>
50
46
  Effect.gen(function* () {
51
47
  const definition = yield* registered(queue);
52
- const runtime = yield* service;
53
- const jobs = yield* runtime.inspection();
48
+ const jobs = yield* PgBossInspection;
54
49
  return yield* jobsFailures(jobs.failedJobs<string, JobsPayload<TQueues[number]>>(definition, options));
55
50
  }),
56
51
  "admin.jobs.health": () =>
57
52
  Effect.gen(function* () {
58
- const runtime = yield* service;
59
- const jobs = yield* runtime.inspection();
53
+ const jobs = yield* PgBossInspection;
60
54
  return yield* jobsFailures(jobs.health(page.queues));
61
55
  }),
62
56
  "admin.jobs.job": ({ id, queue }: { readonly id: string; readonly queue: string }) =>
63
57
  Effect.gen(function* () {
64
58
  const definition = yield* registered(queue);
65
- const runtime = yield* service;
66
- const jobs = yield* runtime.inspection();
59
+ const jobs = yield* PgBossInspection;
67
60
  const result = yield* jobsFailures(jobs.getJob<string, JobsPayload<TQueues[number]>>(definition, id));
68
61
  if (Option.isNone(result)) {
69
62
  return Option.none();
@@ -91,5 +84,12 @@ export function jobsHandlers<const TQueues extends readonly JobsEntry[], TServic
91
84
  page: ReturnType<typeof jobsPage<TQueues>>,
92
85
  service: Context.Service<TService, PgBossService>,
93
86
  ) {
94
- return page.contract.application.toLayer(jobsReadHandlers(page, service));
87
+ return page.contract.application.toLayer(jobsReadHandlers(page)).pipe(
88
+ Layer.provide(
89
+ Layer.effect(
90
+ PgBossInspection,
91
+ Effect.flatMap(service, (jobs) => jobs.inspection()),
92
+ ),
93
+ ),
94
+ );
95
95
  }
@@ -1,6 +1,7 @@
1
- import { type Context, Effect, Option } from "effect";
1
+ import { type Context, Effect, Layer, Option } from "effect";
2
2
  import { requirePermission } from "@shivaedev/access/requirePermission.ts";
3
3
  import { SessionUser } from "@shivaedev/identity/identity.ts";
4
+ import { PgBossInspection } from "@shivaedev/jobs/server/inspection.ts";
4
5
  import type { PgBossService } from "@shivaedev/jobs/server/service.ts";
5
6
  import { type JobsEntry, type JobsPayload, jobsQueue } from "#jobs/entry.ts";
6
7
  import { JobsNotFailed, type jobsPageWithRetry } from "#jobs/retryPage.ts";
@@ -12,38 +13,47 @@ export function jobsHandlersWithRetry<const TQueues extends readonly JobsEntry[]
12
13
  page: ReturnType<typeof jobsPageWithRetry<TQueues>>,
13
14
  service: Context.Service<TService, PgBossService>,
14
15
  ) {
15
- return page.contract.application.toLayer({
16
- ...jobsReadHandlers(page, service),
17
- "admin.jobs.retry": ({ queue, id }) =>
18
- Effect.gen(function* () {
19
- yield* requirePermission(yield* SessionUser, RetryJobs);
20
- const entries: readonly TQueues[number][] = page.queues;
21
- const entry = entries.find((candidate) => candidate.name === queue);
22
- if (entry === undefined) {
23
- return yield* Effect.fail(new JobsQueueUnregistered({ queue }));
24
- }
25
- const definition = jobsQueue(entry);
26
- const runtime = yield* service;
27
- const jobs = yield* runtime.inspection();
28
- const job = yield* jobsFailures(jobs.getJob<string, JobsPayload<TQueues[number]>>(definition, id));
29
- if (Option.isNone(job) || job.value.state !== "failed") {
30
- return yield* Effect.fail(new JobsNotFailed({ id, queue }));
31
- }
32
- yield* jobsFailures(runtime.retry(definition, id));
33
- }),
34
- "admin.jobs.runScheduleNow": ({ queue }) =>
35
- Effect.gen(function* () {
36
- yield* requirePermission(yield* SessionUser, RetryJobs);
37
- const entries: readonly JobsEntry[] = page.queues;
38
- const entry = entries.find((candidate) => candidate.name === queue && !("schema" in candidate));
39
- if (entry === undefined || "schema" in entry) {
40
- return yield* Effect.fail(new JobsQueueUnregistered({ queue }));
41
- }
42
- const runtime = yield* service;
43
- return yield* runtime.runScheduleNow({ name: entry.name, scheduleOptions: entry.scheduleOptions ?? {} }).pipe(
44
- Effect.catchTag("PgBossNotFoundError", () => Effect.fail(new JobsQueueUnregistered({ queue }))),
45
- Effect.catchTag("PgBossError", (error) => jobsFailures(Effect.fail(error))),
46
- );
47
- }),
48
- });
16
+ return page.contract.application
17
+ .toLayer({
18
+ ...jobsReadHandlers(page),
19
+ "admin.jobs.retry": ({ queue, id }) =>
20
+ Effect.gen(function* () {
21
+ yield* requirePermission(yield* SessionUser, RetryJobs);
22
+ const entries: readonly TQueues[number][] = page.queues;
23
+ const entry = entries.find((candidate) => candidate.name === queue);
24
+ if (entry === undefined) {
25
+ return yield* Effect.fail(new JobsQueueUnregistered({ queue }));
26
+ }
27
+ const definition = jobsQueue(entry);
28
+ const runtime = yield* service;
29
+ const jobs = yield* runtime.inspection();
30
+ const job = yield* jobsFailures(jobs.getJob<string, JobsPayload<TQueues[number]>>(definition, id));
31
+ if (Option.isNone(job) || job.value.state !== "failed") {
32
+ return yield* Effect.fail(new JobsNotFailed({ id, queue }));
33
+ }
34
+ yield* jobsFailures(runtime.retry(definition, id));
35
+ }),
36
+ "admin.jobs.runScheduleNow": ({ queue }) =>
37
+ Effect.gen(function* () {
38
+ yield* requirePermission(yield* SessionUser, RetryJobs);
39
+ const entries: readonly JobsEntry[] = page.queues;
40
+ const entry = entries.find((candidate) => candidate.name === queue && !("schema" in candidate));
41
+ if (entry === undefined || "schema" in entry) {
42
+ return yield* Effect.fail(new JobsQueueUnregistered({ queue }));
43
+ }
44
+ const runtime = yield* service;
45
+ return yield* runtime.runScheduleNow({ name: entry.name, scheduleOptions: entry.scheduleOptions ?? {} }).pipe(
46
+ Effect.catchTag("PgBossNotFoundError", () => Effect.fail(new JobsQueueUnregistered({ queue }))),
47
+ Effect.catchTag("PgBossError", (error) => jobsFailures(Effect.fail(error))),
48
+ );
49
+ }),
50
+ })
51
+ .pipe(
52
+ Layer.provide(
53
+ Layer.effect(
54
+ PgBossInspection,
55
+ Effect.flatMap(service, (jobs) => jobs.inspection()),
56
+ ),
57
+ ),
58
+ );
49
59
  }
@@ -2,7 +2,7 @@ import { Effect, Layer } from "effect";
2
2
  import type { Rpc, RpcGroup } from "effect/rpc";
3
3
  import type { SessionPolicy } from "@shivaedev/identity/server/SessionPolicy.ts";
4
4
  import type { AdminPage } from "#page.ts";
5
- import type { AdminRegistry } from "#registry.ts";
5
+ import { type AdminRegistry, validateAdminRegistry } from "#registry.ts";
6
6
  import { pagePermissions } from "#server/pagePermissions.ts";
7
7
 
8
8
  type HandlerLayers<TPages extends readonly AdminPage[]> = {
@@ -28,19 +28,25 @@ export function registerAdmin(
28
28
  registry: AdminRegistry<readonly AdminPage[]>,
29
29
  handlers: Readonly<Record<string, Layer.Layer<never, unknown, unknown>>>,
30
30
  ): { readonly group: RpcGroup.Any; readonly handlers: Layer.Layer<never, unknown, unknown>; readonly pages: readonly AdminPage[] } {
31
- const registered = Layer.suspend(() => {
32
- const ids = new Set(registry.pages.map((page) => page.id));
33
- for (const id of ids) {
34
- if (!Object.hasOwn(handlers, id)) {
35
- return Layer.effectDiscard(Effect.die(new Error(`Missing admin handlers: ${id}`)));
36
- }
37
- }
38
- for (const id of Object.keys(handlers)) {
39
- if (!ids.has(id)) {
40
- return Layer.effectDiscard(Effect.die(new Error(`Unregistered admin handlers: ${id}`)));
41
- }
42
- }
43
- return Layer.mergeAll(Layer.empty, ...Object.values(handlers)).pipe(Layer.provideMerge(pagePermissions(registry)));
44
- });
31
+ const registered = Layer.unwrap(
32
+ validateAdminRegistry(registry.pages).pipe(
33
+ Effect.as(
34
+ Layer.suspend(() => {
35
+ const ids = new Set(registry.pages.map((page) => page.id));
36
+ for (const id of ids) {
37
+ if (!Object.hasOwn(handlers, id)) {
38
+ return Layer.effectDiscard(Effect.die(new Error(`Missing admin handlers: ${id}`)));
39
+ }
40
+ }
41
+ for (const id of Object.keys(handlers)) {
42
+ if (!ids.has(id)) {
43
+ return Layer.effectDiscard(Effect.die(new Error(`Unregistered admin handlers: ${id}`)));
44
+ }
45
+ }
46
+ return Layer.mergeAll(Layer.empty, ...Object.values(handlers)).pipe(Layer.provideMerge(pagePermissions(registry)));
47
+ }),
48
+ ),
49
+ ),
50
+ );
45
51
  return { group: registry.group, handlers: registered, pages: registry.pages };
46
52
  }