@shivaedev/admin 0.1.5 → 0.2.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 +31 -0
- package/dist/jobs/page.d.ts +223 -0
- package/dist/jobs/page.d.ts.map +1 -0
- package/dist/jobs/page.js +39 -0
- package/dist/jobs/page.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 +6 -0
- package/dist/server/jobsHandlers.d.ts.map +1 -0
- package/dist/server/jobsHandlers.js +60 -0
- package/dist/server/jobsHandlers.js.map +1 -0
- package/package.json +5 -3
- package/src/jobs/page.ts +39 -0
- package/src/jobs/schemas.ts +78 -0
- package/src/page.ts +8 -1
- package/src/server/jobsHandlers.ts +76 -0
package/README.md
CHANGED
|
@@ -60,3 +60,34 @@ const handlers = registration.handlers.pipe(
|
|
|
60
60
|
Pass `registration.group` and `handlers` to the existing application's RPC host on `/rpc`, merging them with its other groups and Layers as needed. The Platform host supplies generated change handlers; registration requires the page's application handlers. Handler Layer errors and service requirements remain inferred. Missing or extra page ids fail at registration; TypeScript also checks each Layer provides the handlers for its page.
|
|
61
61
|
|
|
62
62
|
Page declarations and the registry are browser-safe. Server registration lives under `/server`; views belong in the application. This package ships no UI components and adds no transport. The package's stories prove role enforcement through native in-process RPC, with an already resolved session as a precondition.
|
|
63
|
+
|
|
64
|
+
## Built-in Jobs page
|
|
65
|
+
|
|
66
|
+
Share each queue's name and payload Schema with the browser declaration. The page exposes only the queues passed to `jobsPage`; a queue registered with the jobs runtime is not automatically available to operators.
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
import { Schema } from "effect";
|
|
70
|
+
import { jobsPage } from "@shivaedev/admin/jobs/page.ts";
|
|
71
|
+
import { adminRegistry } from "@shivaedev/admin/registry.ts";
|
|
72
|
+
|
|
73
|
+
const MailPayload = Schema.Struct({ id: Schema.NumberFromString });
|
|
74
|
+
const JobsPage = jobsPage({ name: "mail", schema: MailPayload });
|
|
75
|
+
const Admin = adminRegistry(JobsPage);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Register its handlers with the application's existing `makePgBoss` service:
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
import { jobsHandlers } from "@shivaedev/admin/server/jobsHandlers.ts";
|
|
82
|
+
import { registerAdmin } from "@shivaedev/admin/server/registerAdmin.ts";
|
|
83
|
+
|
|
84
|
+
const registration = registerAdmin(Admin, {
|
|
85
|
+
jobs: jobsHandlers(JobsPage, JobsService),
|
|
86
|
+
});
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The queries are `admin.jobs.health`, `admin.jobs.counts`, `admin.jobs.failed`, `admin.jobs.deadLettered` and `admin.jobs.job`. Counts take `{ queue }`; listings take `{ queue, limit, cursor? }` and return `{ jobs, next }`, where `next` is an `Option<string>`. Job lookup takes `{ queue, id }` and returns `Option<Job>`. Each job carries its queue, decoded payload, state, attempt and retry counts, output and timestamps. Dead-letter listings also carry `sourceId` and `sourceOutput`. Timestamps use UTC `DateTime` values; the RPC encodes timestamps as strings and Options as nullable values. The queue's original codec encodes and decodes its payload across RPC, preserving its service requirements.
|
|
90
|
+
|
|
91
|
+
Health filters the runtime's monitor snapshot to the page's queues and recomputes totals from those queues. It has the same refresh timing as effect-pg-boss health. Unregistered names, including dead-letter queue names passed directly, fail with `JobsQueueUnregistered`. Stored payload decoding failures become `JobsPayloadInvalid`; jobs operation failures become `JobsUnavailable`, carrying the operation name. These declared failures do not expose the original database error.
|
|
92
|
+
|
|
93
|
+
The page declares no commands. Handler registration performs no jobs read, and a failed jobs request leaves other pages available. PostgreSQL stories exercise these queries through serialized `/rpc` requests, including pagination, transformed payloads, missing jobs, queue restrictions and role enforcement. The application supplies the Jobs view and mounts the registration on its existing RPC host.
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
import { type JobsQueue } from "./schemas.ts";
|
|
3
|
+
export declare function jobsPage<const TQueues extends readonly JobsQueue[]>(...queues: TQueues): import("#page.ts").AdminPage & {
|
|
4
|
+
readonly id: "jobs";
|
|
5
|
+
readonly contract: import("@shivaedev/effect-contract/contract.ts").Contract<"admin.jobs", readonly [NoInfer<import("@shivaedev/effect-contract/operation.ts").Query<"health", Schema.Void, Schema.Struct<{
|
|
6
|
+
readonly activeTotal: Schema.Number;
|
|
7
|
+
readonly deadLetteredTotal: Schema.Number;
|
|
8
|
+
readonly failedTotal: Schema.Number;
|
|
9
|
+
readonly jobs: Schema.$Array<Schema.Struct<{
|
|
10
|
+
readonly activeCount: Schema.Number;
|
|
11
|
+
readonly deadLetteredCount: Schema.Number;
|
|
12
|
+
readonly failedCount: Schema.Number;
|
|
13
|
+
readonly name: Schema.String;
|
|
14
|
+
readonly queuedCount: Schema.Number;
|
|
15
|
+
readonly readyCount: Schema.Number;
|
|
16
|
+
}>>;
|
|
17
|
+
readonly queuedTotal: Schema.Number;
|
|
18
|
+
readonly readyTotal: Schema.Number;
|
|
19
|
+
}>, {
|
|
20
|
+
JobsPayloadInvalid: typeof import("./schemas.ts").JobsPayloadInvalid;
|
|
21
|
+
JobsQueueUnregistered: typeof import("./schemas.ts").JobsQueueUnregistered;
|
|
22
|
+
JobsUnavailable: typeof import("./schemas.ts").JobsUnavailable;
|
|
23
|
+
}>>, NoInfer<import("@shivaedev/effect-contract/operation.ts").Query<"counts", Schema.Struct<{
|
|
24
|
+
queue: Schema.String;
|
|
25
|
+
}>, Schema.Struct<{
|
|
26
|
+
readonly activeCount: Schema.Number;
|
|
27
|
+
readonly failedCount: Schema.Number;
|
|
28
|
+
readonly queuedCount: Schema.Number;
|
|
29
|
+
readonly totalCount: Schema.Number;
|
|
30
|
+
}>, {
|
|
31
|
+
JobsPayloadInvalid: typeof import("./schemas.ts").JobsPayloadInvalid;
|
|
32
|
+
JobsQueueUnregistered: typeof import("./schemas.ts").JobsQueueUnregistered;
|
|
33
|
+
JobsUnavailable: typeof import("./schemas.ts").JobsUnavailable;
|
|
34
|
+
}>>, NoInfer<import("@shivaedev/effect-contract/operation.ts").Query<"failed", Schema.Struct<{
|
|
35
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
36
|
+
limit: Schema.Number;
|
|
37
|
+
queue: Schema.String;
|
|
38
|
+
}>, Schema.Struct<{
|
|
39
|
+
readonly jobs: Schema.$Array<Schema.Union<Schema.Struct<{
|
|
40
|
+
readonly attempt: Schema.Number;
|
|
41
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
42
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
43
|
+
readonly id: Schema.String;
|
|
44
|
+
readonly output: Schema.Unknown;
|
|
45
|
+
readonly retryCount: Schema.Number;
|
|
46
|
+
readonly retryLimit: Schema.Number;
|
|
47
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
48
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
49
|
+
readonly data: TQueues[number]["schema"];
|
|
50
|
+
readonly queue: Schema.Literal<string>;
|
|
51
|
+
}>[]>>;
|
|
52
|
+
readonly next: Schema.OptionFromNullOr<Schema.String>;
|
|
53
|
+
}>, {
|
|
54
|
+
JobsPayloadInvalid: typeof import("./schemas.ts").JobsPayloadInvalid;
|
|
55
|
+
JobsQueueUnregistered: typeof import("./schemas.ts").JobsQueueUnregistered;
|
|
56
|
+
JobsUnavailable: typeof import("./schemas.ts").JobsUnavailable;
|
|
57
|
+
}>>, NoInfer<import("@shivaedev/effect-contract/operation.ts").Query<"deadLettered", Schema.Struct<{
|
|
58
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
59
|
+
limit: Schema.Number;
|
|
60
|
+
queue: Schema.String;
|
|
61
|
+
}>, Schema.Struct<{
|
|
62
|
+
readonly jobs: Schema.$Array<Schema.Union<Schema.Struct<{
|
|
63
|
+
readonly attempt: Schema.Number;
|
|
64
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
65
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
66
|
+
readonly id: Schema.String;
|
|
67
|
+
readonly output: Schema.Unknown;
|
|
68
|
+
readonly retryCount: Schema.Number;
|
|
69
|
+
readonly retryLimit: Schema.Number;
|
|
70
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
71
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
72
|
+
readonly data: TQueues[number]["schema"];
|
|
73
|
+
readonly queue: Schema.Literal<string>;
|
|
74
|
+
readonly sourceId: Schema.OptionFromNullOr<Schema.String>;
|
|
75
|
+
readonly sourceOutput: Schema.Unknown;
|
|
76
|
+
}>[]>>;
|
|
77
|
+
readonly next: Schema.OptionFromNullOr<Schema.String>;
|
|
78
|
+
}>, {
|
|
79
|
+
JobsPayloadInvalid: typeof import("./schemas.ts").JobsPayloadInvalid;
|
|
80
|
+
JobsQueueUnregistered: typeof import("./schemas.ts").JobsQueueUnregistered;
|
|
81
|
+
JobsUnavailable: typeof import("./schemas.ts").JobsUnavailable;
|
|
82
|
+
}>>, NoInfer<import("@shivaedev/effect-contract/operation.ts").Query<"job", Schema.Struct<{
|
|
83
|
+
id: Schema.String;
|
|
84
|
+
queue: Schema.String;
|
|
85
|
+
}>, Schema.OptionFromNullOr<Schema.Union<Schema.Struct<{
|
|
86
|
+
readonly attempt: Schema.Number;
|
|
87
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
88
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
89
|
+
readonly id: Schema.String;
|
|
90
|
+
readonly output: Schema.Unknown;
|
|
91
|
+
readonly retryCount: Schema.Number;
|
|
92
|
+
readonly retryLimit: Schema.Number;
|
|
93
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
94
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
95
|
+
readonly data: TQueues[number]["schema"];
|
|
96
|
+
readonly queue: Schema.Literal<string>;
|
|
97
|
+
}>[]>>, {
|
|
98
|
+
JobsPayloadInvalid: typeof import("./schemas.ts").JobsPayloadInvalid;
|
|
99
|
+
JobsQueueUnregistered: typeof import("./schemas.ts").JobsQueueUnregistered;
|
|
100
|
+
JobsUnavailable: typeof import("./schemas.ts").JobsUnavailable;
|
|
101
|
+
}>>], readonly [], import("effect/rpc/Rpc").Rpc<"admin.jobs.job", Schema.Struct<{
|
|
102
|
+
id: Schema.String;
|
|
103
|
+
queue: Schema.String;
|
|
104
|
+
}>, Schema.OptionFromNullOr<Schema.Union<Schema.Struct<{
|
|
105
|
+
readonly attempt: Schema.Number;
|
|
106
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
107
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
108
|
+
readonly id: Schema.String;
|
|
109
|
+
readonly output: Schema.Unknown;
|
|
110
|
+
readonly retryCount: Schema.Number;
|
|
111
|
+
readonly retryLimit: Schema.Number;
|
|
112
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
113
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
114
|
+
readonly data: TQueues[number]["schema"];
|
|
115
|
+
readonly queue: Schema.Literal<string>;
|
|
116
|
+
}>[]>>, Schema.Union<readonly (typeof import("./schemas.ts").JobsUnavailable | typeof import("./schemas.ts").JobsPayloadInvalid | typeof import("./schemas.ts").JobsQueueUnregistered)[]>, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never> | import("effect/rpc/Rpc").Rpc<"admin.jobs.$changes", Schema.Struct<{
|
|
117
|
+
queries: Schema.$Array<Schema.Union<readonly (Schema.Struct<{
|
|
118
|
+
query: Schema.Literal<"counts">;
|
|
119
|
+
payload: Schema.Struct<{
|
|
120
|
+
queue: Schema.String;
|
|
121
|
+
}>;
|
|
122
|
+
}> | Schema.Struct<{
|
|
123
|
+
query: Schema.Literal<"deadLettered">;
|
|
124
|
+
payload: Schema.Struct<{
|
|
125
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
126
|
+
limit: Schema.Number;
|
|
127
|
+
queue: Schema.String;
|
|
128
|
+
}>;
|
|
129
|
+
}> | Schema.Struct<{
|
|
130
|
+
query: Schema.Literal<"failed">;
|
|
131
|
+
payload: Schema.Struct<{
|
|
132
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
133
|
+
limit: Schema.Number;
|
|
134
|
+
queue: Schema.String;
|
|
135
|
+
}>;
|
|
136
|
+
}> | Schema.Struct<{
|
|
137
|
+
query: Schema.Literal<"health">;
|
|
138
|
+
payload: Schema.Void;
|
|
139
|
+
}> | Schema.Struct<{
|
|
140
|
+
query: Schema.Literal<"job">;
|
|
141
|
+
payload: Schema.Struct<{
|
|
142
|
+
id: Schema.String;
|
|
143
|
+
queue: Schema.String;
|
|
144
|
+
}>;
|
|
145
|
+
}>)[]>>;
|
|
146
|
+
}>, import("effect/rpc/RpcSchema").Stream<Schema.Union<readonly [Schema.Struct<{
|
|
147
|
+
readonly _tag: Schema.Literal<"Changed">;
|
|
148
|
+
readonly keys: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
|
|
149
|
+
readonly _tag: Schema.Literal<"List">;
|
|
150
|
+
readonly collection: Schema.String;
|
|
151
|
+
}>, Schema.Struct<{
|
|
152
|
+
readonly _tag: Schema.Literal<"Item">;
|
|
153
|
+
readonly collection: Schema.String;
|
|
154
|
+
readonly id: Schema.Union<readonly [Schema.String, Schema.Number]>;
|
|
155
|
+
}>]>>;
|
|
156
|
+
}>, Schema.Struct<{
|
|
157
|
+
readonly _tag: Schema.Literal<"Resync">;
|
|
158
|
+
}>]>, Schema.Never>, Schema.Never, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never> | import("effect/rpc/Rpc").Rpc<"admin.jobs.counts", Schema.Struct<{
|
|
159
|
+
queue: Schema.String;
|
|
160
|
+
}>, Schema.Struct<{
|
|
161
|
+
readonly activeCount: Schema.Number;
|
|
162
|
+
readonly failedCount: Schema.Number;
|
|
163
|
+
readonly queuedCount: Schema.Number;
|
|
164
|
+
readonly totalCount: Schema.Number;
|
|
165
|
+
}>, Schema.Union<readonly (typeof import("./schemas.ts").JobsUnavailable | typeof import("./schemas.ts").JobsPayloadInvalid | typeof import("./schemas.ts").JobsQueueUnregistered)[]>, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never> | import("effect/rpc/Rpc").Rpc<"admin.jobs.health", Schema.Void, Schema.Struct<{
|
|
166
|
+
readonly activeTotal: Schema.Number;
|
|
167
|
+
readonly deadLetteredTotal: Schema.Number;
|
|
168
|
+
readonly failedTotal: Schema.Number;
|
|
169
|
+
readonly jobs: Schema.$Array<Schema.Struct<{
|
|
170
|
+
readonly activeCount: Schema.Number;
|
|
171
|
+
readonly deadLetteredCount: Schema.Number;
|
|
172
|
+
readonly failedCount: Schema.Number;
|
|
173
|
+
readonly name: Schema.String;
|
|
174
|
+
readonly queuedCount: Schema.Number;
|
|
175
|
+
readonly readyCount: Schema.Number;
|
|
176
|
+
}>>;
|
|
177
|
+
readonly queuedTotal: Schema.Number;
|
|
178
|
+
readonly readyTotal: Schema.Number;
|
|
179
|
+
}>, Schema.Union<readonly (typeof import("./schemas.ts").JobsUnavailable | typeof import("./schemas.ts").JobsPayloadInvalid | typeof import("./schemas.ts").JobsQueueUnregistered)[]>, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never> | import("effect/rpc/Rpc").Rpc<"admin.jobs.failed", Schema.Struct<{
|
|
180
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
181
|
+
limit: Schema.Number;
|
|
182
|
+
queue: Schema.String;
|
|
183
|
+
}>, Schema.Struct<{
|
|
184
|
+
readonly jobs: Schema.$Array<Schema.Union<Schema.Struct<{
|
|
185
|
+
readonly attempt: Schema.Number;
|
|
186
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
187
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
188
|
+
readonly id: Schema.String;
|
|
189
|
+
readonly output: Schema.Unknown;
|
|
190
|
+
readonly retryCount: Schema.Number;
|
|
191
|
+
readonly retryLimit: Schema.Number;
|
|
192
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
193
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
194
|
+
readonly data: TQueues[number]["schema"];
|
|
195
|
+
readonly queue: Schema.Literal<string>;
|
|
196
|
+
}>[]>>;
|
|
197
|
+
readonly next: Schema.OptionFromNullOr<Schema.String>;
|
|
198
|
+
}>, Schema.Union<readonly (typeof import("./schemas.ts").JobsUnavailable | typeof import("./schemas.ts").JobsPayloadInvalid | typeof import("./schemas.ts").JobsQueueUnregistered)[]>, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never> | import("effect/rpc/Rpc").Rpc<"admin.jobs.deadLettered", Schema.Struct<{
|
|
199
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
200
|
+
limit: Schema.Number;
|
|
201
|
+
queue: Schema.String;
|
|
202
|
+
}>, Schema.Struct<{
|
|
203
|
+
readonly jobs: Schema.$Array<Schema.Union<Schema.Struct<{
|
|
204
|
+
readonly attempt: Schema.Number;
|
|
205
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
206
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
207
|
+
readonly id: Schema.String;
|
|
208
|
+
readonly output: Schema.Unknown;
|
|
209
|
+
readonly retryCount: Schema.Number;
|
|
210
|
+
readonly retryLimit: Schema.Number;
|
|
211
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
212
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
213
|
+
readonly data: TQueues[number]["schema"];
|
|
214
|
+
readonly queue: Schema.Literal<string>;
|
|
215
|
+
readonly sourceId: Schema.OptionFromNullOr<Schema.String>;
|
|
216
|
+
readonly sourceOutput: Schema.Unknown;
|
|
217
|
+
}>[]>>;
|
|
218
|
+
readonly next: Schema.OptionFromNullOr<Schema.String>;
|
|
219
|
+
}>, Schema.Union<readonly (typeof import("./schemas.ts").JobsUnavailable | typeof import("./schemas.ts").JobsPayloadInvalid | typeof import("./schemas.ts").JobsQueueUnregistered)[]>, typeof import("@shivaedev/platform/rpc/middleware.ts").AuthenticatedAdmin, never>, readonly [], undefined>;
|
|
220
|
+
} & {
|
|
221
|
+
queues: TQueues;
|
|
222
|
+
};
|
|
223
|
+
//# sourceMappingURL=page.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../src/jobs/page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhC,OAAO,EAAgD,KAAK,SAAS,EAA+C,MAAM,cAAc,CAAC;AAEzI,wBAAgB,QAAQ,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,SAAS,EAAE,EAAE,GAAG,MAAM,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCtF"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
import { contract } from "@shivaedev/effect-contract/contract.ts";
|
|
3
|
+
import { query } from "@shivaedev/effect-contract/operation.ts";
|
|
4
|
+
import { adminPage } from "#page.ts";
|
|
5
|
+
import { deadLetteredSchema, JobsFailures, JobsHealth, jobPage, jobSchema, PageFields, QueueCounts } from "./schemas.js";
|
|
6
|
+
export function jobsPage(...queues) {
|
|
7
|
+
const Job = Schema.Union(queues.map((queue) => jobSchema(queue)));
|
|
8
|
+
const DeadLettered = Schema.Union(queues.map((queue) => deadLetteredSchema(queue)));
|
|
9
|
+
const page = adminPage({
|
|
10
|
+
contract: contract("admin.jobs", {
|
|
11
|
+
queries: [
|
|
12
|
+
query("health", { reads: () => [], rejections: JobsFailures, success: JobsHealth }),
|
|
13
|
+
query("counts", { payload: { queue: Schema.String }, reads: () => [], rejections: JobsFailures, success: QueueCounts }),
|
|
14
|
+
query("failed", {
|
|
15
|
+
payload: { ...PageFields, queue: Schema.String },
|
|
16
|
+
reads: () => [],
|
|
17
|
+
rejections: JobsFailures,
|
|
18
|
+
success: jobPage(Job),
|
|
19
|
+
}),
|
|
20
|
+
query("deadLettered", {
|
|
21
|
+
payload: { ...PageFields, queue: Schema.String },
|
|
22
|
+
reads: () => [],
|
|
23
|
+
rejections: JobsFailures,
|
|
24
|
+
success: jobPage(DeadLettered),
|
|
25
|
+
}),
|
|
26
|
+
query("job", {
|
|
27
|
+
payload: { id: Schema.String, queue: Schema.String },
|
|
28
|
+
reads: () => [],
|
|
29
|
+
rejections: JobsFailures,
|
|
30
|
+
success: Schema.OptionFromNullOr(Job),
|
|
31
|
+
}),
|
|
32
|
+
],
|
|
33
|
+
}),
|
|
34
|
+
id: "jobs",
|
|
35
|
+
route: { path: "/admin/jobs", title: "Jobs" },
|
|
36
|
+
});
|
|
37
|
+
return Object.assign(page, { queues });
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=page.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page.js","sourceRoot":"","sources":["../../src/jobs/page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,yCAAyC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,UAAU,EAAkB,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEzI,MAAM,UAAU,QAAQ,CAA6C,GAAG,MAAe;IACtF,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAsB,EAAE,EAAE,CAAC,SAAS,CAA4B,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9G,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAsB,EAAE,EAAE,CAAC,kBAAkB,CAA4B,KAAK,CAAC,CAAC,CAAC,CAAC;IAChI,MAAM,IAAI,GAAG,SAAS,CAAC;QACtB,QAAQ,EAAE,QAAQ,CAAC,YAAY,EAAE;YAChC,OAAO,EAAE;gBACR,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;gBACnF,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;gBACvH,KAAK,CAAC,QAAQ,EAAE;oBACf,OAAO,EAAE,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;oBAChD,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE;oBACf,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC;iBACrB,CAAC;gBACF,KAAK,CAAC,cAAc,EAAE;oBACrB,OAAO,EAAE,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;oBAChD,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE;oBACf,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC;iBAC9B,CAAC;gBACF,KAAK,CAAC,KAAK,EAAE;oBACZ,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;oBACpD,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE;oBACf,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC;iBACrC,CAAC;aACF;SACD,CAAC;QACF,EAAE,EAAE,MAAM;QACV,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE;KAC7C,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AACxC,CAAC"}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
export interface JobsQueue {
|
|
3
|
+
readonly name: string;
|
|
4
|
+
readonly schema: Schema.Top & {
|
|
5
|
+
readonly Type: object;
|
|
6
|
+
readonly Encoded: object;
|
|
7
|
+
};
|
|
8
|
+
}
|
|
9
|
+
declare const JobsUnavailable_base: Schema.Class<JobsUnavailable, Schema.TaggedStruct<"JobsUnavailable", {
|
|
10
|
+
readonly operation: Schema.String;
|
|
11
|
+
}>, import("effect/Cause").YieldableError>;
|
|
12
|
+
export declare class JobsUnavailable extends JobsUnavailable_base {
|
|
13
|
+
}
|
|
14
|
+
declare const JobsPayloadInvalid_base: Schema.Class<JobsPayloadInvalid, Schema.TaggedStruct<"JobsPayloadInvalid", {
|
|
15
|
+
readonly queue: Schema.String;
|
|
16
|
+
}>, import("effect/Cause").YieldableError>;
|
|
17
|
+
export declare class JobsPayloadInvalid extends JobsPayloadInvalid_base {
|
|
18
|
+
}
|
|
19
|
+
declare const JobsQueueUnregistered_base: Schema.Class<JobsQueueUnregistered, Schema.TaggedStruct<"JobsQueueUnregistered", {
|
|
20
|
+
readonly queue: Schema.String;
|
|
21
|
+
}>, import("effect/Cause").YieldableError>;
|
|
22
|
+
export declare class JobsQueueUnregistered extends JobsQueueUnregistered_base {
|
|
23
|
+
}
|
|
24
|
+
export declare const JobsFailures: {
|
|
25
|
+
JobsPayloadInvalid: typeof JobsPayloadInvalid;
|
|
26
|
+
JobsQueueUnregistered: typeof JobsQueueUnregistered;
|
|
27
|
+
JobsUnavailable: typeof JobsUnavailable;
|
|
28
|
+
};
|
|
29
|
+
export declare const QueueCounts: Schema.Struct<{
|
|
30
|
+
readonly activeCount: Schema.Number;
|
|
31
|
+
readonly failedCount: Schema.Number;
|
|
32
|
+
readonly queuedCount: Schema.Number;
|
|
33
|
+
readonly totalCount: Schema.Number;
|
|
34
|
+
}>;
|
|
35
|
+
export declare const QueueHealth: Schema.Struct<{
|
|
36
|
+
readonly activeCount: Schema.Number;
|
|
37
|
+
readonly deadLetteredCount: Schema.Number;
|
|
38
|
+
readonly failedCount: Schema.Number;
|
|
39
|
+
readonly name: Schema.String;
|
|
40
|
+
readonly queuedCount: Schema.Number;
|
|
41
|
+
readonly readyCount: Schema.Number;
|
|
42
|
+
}>;
|
|
43
|
+
export declare const JobsHealth: Schema.Struct<{
|
|
44
|
+
readonly activeTotal: Schema.Number;
|
|
45
|
+
readonly deadLetteredTotal: Schema.Number;
|
|
46
|
+
readonly failedTotal: Schema.Number;
|
|
47
|
+
readonly jobs: Schema.$Array<Schema.Struct<{
|
|
48
|
+
readonly activeCount: Schema.Number;
|
|
49
|
+
readonly deadLetteredCount: Schema.Number;
|
|
50
|
+
readonly failedCount: Schema.Number;
|
|
51
|
+
readonly name: Schema.String;
|
|
52
|
+
readonly queuedCount: Schema.Number;
|
|
53
|
+
readonly readyCount: Schema.Number;
|
|
54
|
+
}>>;
|
|
55
|
+
readonly queuedTotal: Schema.Number;
|
|
56
|
+
readonly readyTotal: Schema.Number;
|
|
57
|
+
}>;
|
|
58
|
+
export declare const JobFields: {
|
|
59
|
+
attempt: Schema.Number;
|
|
60
|
+
completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
61
|
+
createdOn: Schema.DateTimeUtcFromString;
|
|
62
|
+
id: Schema.String;
|
|
63
|
+
output: Schema.Unknown;
|
|
64
|
+
retryCount: Schema.Number;
|
|
65
|
+
retryLimit: Schema.Number;
|
|
66
|
+
startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
67
|
+
state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
68
|
+
};
|
|
69
|
+
export declare const PageFields: {
|
|
70
|
+
cursor: Schema.optionalKey<Schema.String>;
|
|
71
|
+
limit: Schema.Number;
|
|
72
|
+
};
|
|
73
|
+
export declare function jobSchema<TPayload extends JobsQueue["schema"]>(queue: {
|
|
74
|
+
readonly name: string;
|
|
75
|
+
readonly schema: TPayload;
|
|
76
|
+
}): Schema.Struct<{
|
|
77
|
+
readonly attempt: Schema.Number;
|
|
78
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
79
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
80
|
+
readonly id: Schema.String;
|
|
81
|
+
readonly output: Schema.Unknown;
|
|
82
|
+
readonly retryCount: Schema.Number;
|
|
83
|
+
readonly retryLimit: Schema.Number;
|
|
84
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
85
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
86
|
+
readonly data: TPayload;
|
|
87
|
+
readonly queue: Schema.Literal<string>;
|
|
88
|
+
}>;
|
|
89
|
+
export declare function deadLetteredSchema<TPayload extends JobsQueue["schema"]>(queue: {
|
|
90
|
+
readonly name: string;
|
|
91
|
+
readonly schema: TPayload;
|
|
92
|
+
}): Schema.Struct<{
|
|
93
|
+
readonly attempt: Schema.Number;
|
|
94
|
+
readonly completedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
95
|
+
readonly createdOn: Schema.DateTimeUtcFromString;
|
|
96
|
+
readonly id: Schema.String;
|
|
97
|
+
readonly output: Schema.Unknown;
|
|
98
|
+
readonly retryCount: Schema.Number;
|
|
99
|
+
readonly retryLimit: Schema.Number;
|
|
100
|
+
readonly startedOn: Schema.OptionFromNullOr<Schema.DateTimeUtcFromString>;
|
|
101
|
+
readonly state: Schema.Literals<readonly ["created", "retry", "active", "completed", "cancelled", "failed"]>;
|
|
102
|
+
readonly data: TPayload;
|
|
103
|
+
readonly queue: Schema.Literal<string>;
|
|
104
|
+
readonly sourceId: Schema.OptionFromNullOr<Schema.String>;
|
|
105
|
+
readonly sourceOutput: Schema.Unknown;
|
|
106
|
+
}>;
|
|
107
|
+
export declare function jobPage<TJob extends Schema.Top>(job: TJob): Schema.Struct<{
|
|
108
|
+
readonly jobs: Schema.$Array<TJob>;
|
|
109
|
+
readonly next: Schema.OptionFromNullOr<Schema.String>;
|
|
110
|
+
}>;
|
|
111
|
+
export {};
|
|
112
|
+
//# sourceMappingURL=schemas.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/jobs/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAClF;;;;AAED,qBAAa,eAAgB,SAAQ,oBAEnC;CAAG;;;;AAEL,qBAAa,kBAAmB,SAAQ,uBAEtC;CAAG;;;;AAEL,qBAAa,qBAAsB,SAAQ,0BAEzC;CAAG;AAEL,eAAO,MAAM,YAAY;;;;CAAiE,CAAC;AAE3F,eAAO,MAAM,WAAW;;;;;EAKtB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;EAOtB,CAAC;AAEH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;EAOrB,CAAC;AAEH,eAAO,MAAM,SAAS;IACrB,OAAO;IACP,WAAW;IACX,SAAS;IACT,EAAE;IACF,MAAM;IACN,UAAU;IACV,UAAU;IACV,SAAS;IACT,KAAK;CACL,CAAC;AAEF,eAAO,MAAM,UAAU;IAAK,MAAM;IAAqC,KAAK;CAAiB,CAAC;AAE9F,wBAAgB,SAAS,CAAC,QAAQ,SAAS,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;CAAE;;;;;;;;;;;;GAE1H;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,SAAS,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;CAAE;;;;;;;;;;;;;;GASnI;AAED,wBAAgB,OAAO,CAAC,IAAI,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI;;;GAEzD"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
export class JobsUnavailable extends Schema.TaggedError()("JobsUnavailable", {
|
|
3
|
+
operation: Schema.String,
|
|
4
|
+
}) {
|
|
5
|
+
}
|
|
6
|
+
export class JobsPayloadInvalid extends Schema.TaggedError()("JobsPayloadInvalid", {
|
|
7
|
+
queue: Schema.String,
|
|
8
|
+
}) {
|
|
9
|
+
}
|
|
10
|
+
export class JobsQueueUnregistered extends Schema.TaggedError()("JobsQueueUnregistered", {
|
|
11
|
+
queue: Schema.String,
|
|
12
|
+
}) {
|
|
13
|
+
}
|
|
14
|
+
export const JobsFailures = { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable };
|
|
15
|
+
export const QueueCounts = Schema.Struct({
|
|
16
|
+
activeCount: Schema.Number,
|
|
17
|
+
failedCount: Schema.Number,
|
|
18
|
+
queuedCount: Schema.Number,
|
|
19
|
+
totalCount: Schema.Number,
|
|
20
|
+
});
|
|
21
|
+
export const QueueHealth = Schema.Struct({
|
|
22
|
+
activeCount: Schema.Number,
|
|
23
|
+
deadLetteredCount: Schema.Number,
|
|
24
|
+
failedCount: Schema.Number,
|
|
25
|
+
name: Schema.String,
|
|
26
|
+
queuedCount: Schema.Number,
|
|
27
|
+
readyCount: Schema.Number,
|
|
28
|
+
});
|
|
29
|
+
export const JobsHealth = Schema.Struct({
|
|
30
|
+
activeTotal: Schema.Number,
|
|
31
|
+
deadLetteredTotal: Schema.Number,
|
|
32
|
+
failedTotal: Schema.Number,
|
|
33
|
+
jobs: Schema.Array(QueueHealth),
|
|
34
|
+
queuedTotal: Schema.Number,
|
|
35
|
+
readyTotal: Schema.Number,
|
|
36
|
+
});
|
|
37
|
+
export const JobFields = {
|
|
38
|
+
attempt: Schema.Number,
|
|
39
|
+
completedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
|
|
40
|
+
createdOn: Schema.DateTimeUtcFromString,
|
|
41
|
+
id: Schema.String,
|
|
42
|
+
output: Schema.Unknown,
|
|
43
|
+
retryCount: Schema.Number,
|
|
44
|
+
retryLimit: Schema.Number,
|
|
45
|
+
startedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
|
|
46
|
+
state: Schema.Literals(["created", "retry", "active", "completed", "cancelled", "failed"]),
|
|
47
|
+
};
|
|
48
|
+
export const PageFields = { cursor: Schema.optionalKey(Schema.String), limit: Schema.Number };
|
|
49
|
+
export function jobSchema(queue) {
|
|
50
|
+
return Schema.Struct({ ...JobFields, data: queue.schema, queue: Schema.Literal(queue.name) });
|
|
51
|
+
}
|
|
52
|
+
export function deadLetteredSchema(queue) {
|
|
53
|
+
const name = `${queue.name}-dlq`;
|
|
54
|
+
return Schema.Struct({
|
|
55
|
+
...JobFields,
|
|
56
|
+
data: queue.schema,
|
|
57
|
+
queue: Schema.Literal(name),
|
|
58
|
+
sourceId: Schema.OptionFromNullOr(Schema.String),
|
|
59
|
+
sourceOutput: Schema.Unknown,
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
export function jobPage(job) {
|
|
63
|
+
return Schema.Struct({ jobs: Schema.Array(job), next: Schema.OptionFromNullOr(Schema.String) });
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=schemas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/jobs/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAOhC,MAAM,OAAO,eAAgB,SAAQ,MAAM,CAAC,WAAW,EAAmB,CAAC,iBAAiB,EAAE;IAC7F,SAAS,EAAE,MAAM,CAAC,MAAM;CACxB,CAAC;CAAG;AAEL,MAAM,OAAO,kBAAmB,SAAQ,MAAM,CAAC,WAAW,EAAsB,CAAC,oBAAoB,EAAE;IACtG,KAAK,EAAE,MAAM,CAAC,MAAM;CACpB,CAAC;CAAG;AAEL,MAAM,OAAO,qBAAsB,SAAQ,MAAM,CAAC,WAAW,EAAyB,CAAC,uBAAuB,EAAE;IAC/G,KAAK,EAAE,MAAM,CAAC,MAAM;CACpB,CAAC;CAAG;AAEL,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,eAAe,EAAE,CAAC;AAE3F,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,UAAU,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,iBAAiB,EAAE,MAAM,CAAC,MAAM;IAChC,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,UAAU,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,iBAAiB,EAAE,MAAM,CAAC,MAAM;IAChC,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC,MAAM;IAC1B,UAAU,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAClE,SAAS,EAAE,MAAM,CAAC,qBAAqB;IACvC,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,MAAM,EAAE,MAAM,CAAC,OAAO;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM;IACzB,SAAS,EAAE,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAChE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC1F,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;AAE9F,MAAM,UAAU,SAAS,CAAuC,KAA2D;IAC1H,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC/F,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAuC,KAA2D;IACnI,MAAM,IAAI,GAAW,GAAG,KAAK,CAAC,IAAI,MAAM,CAAC;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC;QACpB,GAAG,SAAS;QACZ,IAAI,EAAE,KAAK,CAAC,MAAM;QAClB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC;QAChD,YAAY,EAAE,MAAM,CAAC,OAAO;KAC5B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CAA0B,GAAS;IACzD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACjG,CAAC"}
|
package/dist/page.d.ts
CHANGED
|
@@ -20,11 +20,9 @@ export declare function adminPage<const TId extends string, const TName extends
|
|
|
20
20
|
readonly id: TId;
|
|
21
21
|
readonly route: AdminRoute;
|
|
22
22
|
readonly contract: Contract<TName, TQueries, TCommands, TRpcs, TStreams>;
|
|
23
|
-
}): {
|
|
24
|
-
id: TId;
|
|
25
|
-
|
|
26
|
-
[AdminPageTypeId]: true;
|
|
27
|
-
contract: Contract<TName, TQueries, TCommands, Rpc.AddMiddleware<TRpcs, typeof AuthenticatedAdmin>, TStreams, undefined>;
|
|
23
|
+
}): AdminPage & {
|
|
24
|
+
readonly id: TId;
|
|
25
|
+
readonly contract: Contract<TName, TQueries, TCommands, Rpc.AddMiddleware<TRpcs, typeof AuthenticatedAdmin>, TStreams>;
|
|
28
26
|
};
|
|
29
27
|
export {};
|
|
30
28
|
//# sourceMappingURL=page.d.ts.map
|
package/dist/page.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../src/page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACrG,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAE3E,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED,QAAA,MAAM,eAAe,eAAsC,CAAC;AAE5D,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,GAAG;QACjC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC;QACnC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;KAChD,CAAC;IACF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC;CACjC;AAED,wBAAgB,SAAS,CACxB,KAAK,CAAC,GAAG,SAAS,MAAM,EACxB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,EAC5C,KAAK,CAAC,SAAS,SAAS,SAAS,YAAY,EAAE,EAC/C,KAAK,SAAS,GAAG,CAAC,GAAG,EACrB,KAAK,CAAC,QAAQ,SAAS,SAAS,WAAW,EAAE,EAC5C,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../src/page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACrG,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAE3E,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED,QAAA,MAAM,eAAe,eAAsC,CAAC;AAE5D,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,GAAG;QACjC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC;QACnC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;KAChD,CAAC;IACF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC;CACjC;AAED,wBAAgB,SAAS,CACxB,KAAK,CAAC,GAAG,SAAS,MAAM,EACxB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,EAC5C,KAAK,CAAC,SAAS,SAAS,SAAS,YAAY,EAAE,EAC/C,KAAK,SAAS,GAAG,CAAC,GAAG,EACrB,KAAK,CAAC,QAAQ,SAAS,SAAS,WAAW,EAAE,EAC5C,IAAI,EAAE;IACP,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC;IACjB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;CACzE,GAAG,SAAS,GAAG;IACf,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC;IACjB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,kBAAkB,CAAC,EAAE,QAAQ,CAAC,CAAC;CACvH,CAEA"}
|
package/dist/page.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"page.js","sourceRoot":"","sources":["../src/page.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAO3E,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;AAY5D,MAAM,UAAU,SAAS,CAOvB,
|
|
1
|
+
{"version":3,"file":"page.js","sourceRoot":"","sources":["../src/page.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAO3E,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;AAY5D,MAAM,UAAU,SAAS,CAOvB,IAID;IAIA,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,eAAe,CAAC,EAAE,IAAa,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;AAC9G,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { type Context } from "effect";
|
|
2
|
+
import type { PgBossService } from "@shivaedev/effect-pg-boss/server/service.ts";
|
|
3
|
+
import type { jobsPage } from "#jobs/page.ts";
|
|
4
|
+
import { type JobsQueue } from "#jobs/schemas.ts";
|
|
5
|
+
export declare function jobsHandlers<const TQueues extends readonly JobsQueue[], TService>(page: ReturnType<typeof jobsPage<TQueues>>, service: Context.Service<TService, PgBossService>): import("effect/Layer").Layer<import("effect/rpc/Rpc").Handler<"admin.jobs.counts"> | import("effect/rpc/Rpc").Handler<"admin.jobs.deadLettered"> | import("effect/rpc/Rpc").Handler<"admin.jobs.failed"> | import("effect/rpc/Rpc").Handler<"admin.jobs.health"> | import("effect/rpc/Rpc").Handler<"admin.jobs.job">, never, Exclude<Exclude<TService, import("@shivaedev/platform/rpc/identity.ts").Identity | import("@shivaedev/platform/rpc/identity.ts").SessionUser>, import("effect/Scope").Scope> | Exclude<Exclude<TService, import("@shivaedev/platform/rpc/identity.ts").Identity | import("@shivaedev/platform/rpc/identity.ts").SessionUser>, import("effect/Scope").Scope> | Exclude<Exclude<TQueues[number]["schema"]["DecodingServices"], import("@shivaedev/platform/rpc/identity.ts").Identity | import("@shivaedev/platform/rpc/identity.ts").SessionUser>, import("effect/Scope").Scope>>;
|
|
6
|
+
//# sourceMappingURL=jobsHandlers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobsHandlers.d.ts","sourceRoot":"","sources":["../../src/server/jobsHandlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAA4B,MAAM,QAAQ,CAAC;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAsB,KAAK,SAAS,EAA0C,MAAM,kBAAkB,CAAC;AAU9G,wBAAgB,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,SAAS,SAAS,EAAE,EAAE,QAAQ,EAChF,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,EAC1C,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,k3BA2DjD"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { DateTime, Effect, Option } from "effect";
|
|
2
|
+
import { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable } from "#jobs/schemas.ts";
|
|
3
|
+
function failures(effect) {
|
|
4
|
+
return effect.pipe(Effect.mapError((error) => error._tag === "PgBossPayloadError" ? new JobsPayloadInvalid({ queue: error.queue }) : new JobsUnavailable({ operation: error.operation })));
|
|
5
|
+
}
|
|
6
|
+
export function jobsHandlers(page, service) {
|
|
7
|
+
function registered(name) {
|
|
8
|
+
const queues = page.queues;
|
|
9
|
+
const queue = queues.find((candidate) => candidate.name === name);
|
|
10
|
+
return queue === undefined ? Effect.fail(new JobsQueueUnregistered({ queue: name })) : Effect.succeed(queue);
|
|
11
|
+
}
|
|
12
|
+
return page.contract.application.toLayer({
|
|
13
|
+
"admin.jobs.counts": ({ queue }) => Effect.gen(function* () {
|
|
14
|
+
const definition = yield* registered(queue);
|
|
15
|
+
const jobs = yield* service;
|
|
16
|
+
return yield* failures(jobs.counts(definition));
|
|
17
|
+
}),
|
|
18
|
+
"admin.jobs.deadLettered": ({ queue, ...options }) => Effect.gen(function* () {
|
|
19
|
+
const definition = yield* registered(queue);
|
|
20
|
+
const jobs = yield* service;
|
|
21
|
+
return yield* failures(jobs.deadLetteredJobs(definition, options));
|
|
22
|
+
}),
|
|
23
|
+
"admin.jobs.failed": ({ queue, ...options }) => Effect.gen(function* () {
|
|
24
|
+
const definition = yield* registered(queue);
|
|
25
|
+
const jobs = yield* service;
|
|
26
|
+
return yield* failures(jobs.failedJobs(definition, options));
|
|
27
|
+
}),
|
|
28
|
+
"admin.jobs.health": () => Effect.gen(function* () {
|
|
29
|
+
const jobs = yield* service;
|
|
30
|
+
const health = yield* failures(jobs.health);
|
|
31
|
+
const visible = health.jobs.filter((queue) => page.queues.some((candidate) => candidate.name === queue.name));
|
|
32
|
+
return {
|
|
33
|
+
activeTotal: visible.reduce((sum, queue) => sum + queue.activeCount, 0),
|
|
34
|
+
deadLetteredTotal: visible.reduce((sum, queue) => sum + queue.deadLetteredCount, 0),
|
|
35
|
+
failedTotal: visible.reduce((sum, queue) => sum + queue.failedCount, 0),
|
|
36
|
+
jobs: visible,
|
|
37
|
+
queuedTotal: visible.reduce((sum, queue) => sum + queue.queuedCount, 0),
|
|
38
|
+
readyTotal: visible.reduce((sum, queue) => sum + queue.readyCount, 0),
|
|
39
|
+
};
|
|
40
|
+
}),
|
|
41
|
+
"admin.jobs.job": ({ id, queue }) => Effect.gen(function* () {
|
|
42
|
+
const definition = yield* registered(queue);
|
|
43
|
+
const jobs = yield* service;
|
|
44
|
+
return Option.map(yield* failures(jobs.getJob(definition, id)), (job) => ({
|
|
45
|
+
attempt: job.startedOn === null ? 0 : job.retryCount + 1,
|
|
46
|
+
completedOn: Option.map(Option.fromNullishOr(job.completedOn), DateTime.makeUnsafe),
|
|
47
|
+
createdOn: DateTime.makeUnsafe(job.createdOn),
|
|
48
|
+
data: job.data,
|
|
49
|
+
id: job.id,
|
|
50
|
+
output: job.output,
|
|
51
|
+
queue: job.name,
|
|
52
|
+
retryCount: job.retryCount,
|
|
53
|
+
retryLimit: job.retryLimit,
|
|
54
|
+
startedOn: Option.map(Option.fromNullishOr(job.startedOn), DateTime.makeUnsafe),
|
|
55
|
+
state: job.state,
|
|
56
|
+
}));
|
|
57
|
+
}),
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=jobsHandlers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobsHandlers.js","sourceRoot":"","sources":["../../src/server/jobsHandlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhE,OAAO,EAAE,kBAAkB,EAAkB,qBAAqB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE9G,SAAS,QAAQ,CAAO,MAA6D;IACpF,OAAO,MAAM,CAAC,IAAI,CACjB,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACzB,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAC1I,CACD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAC3B,IAA0C,EAC1C,OAAiD;IAEjD,SAAS,UAAU,CAAC,IAAY;QAC/B,MAAM,MAAM,GAA+B,IAAI,CAAC,MAAM,CAAC;QACvD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAClE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,qBAAqB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9G,CAAC;IACD,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC;QACxC,mBAAmB,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAClC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC;YAC5B,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC;QACH,yBAAyB,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CACpD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC;YAC5B,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAoC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QACvG,CAAC,CAAC;QACH,mBAAmB,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAC9C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC;YAC5B,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAoC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;QACH,mBAAmB,EAAE,GAAG,EAAE,CACzB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9G,OAAO;gBACN,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;gBACvE,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnF,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;gBACvE,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;gBACvE,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;aACrE,CAAC;QACH,CAAC,CAAC;QACH,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CACnC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC;YAC5B,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAoC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC5G,OAAO,EAAE,GAAG,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC;gBACxD,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC;gBACnF,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC;gBAC7C,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,KAAK,EAAE,GAAG,CAAC,IAAI;gBACf,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC;gBAC/E,KAAK,EAAE,GAAG,CAAC,KAAK;aAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;KACH,CAAC,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/admin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Explicit admin page contracts and a protected native Effect RPC registry",
|
|
5
5
|
"homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/admin#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -40,10 +40,12 @@
|
|
|
40
40
|
],
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@shivaedev/effect-contract": "0.15.0",
|
|
43
|
-
"@shivaedev/
|
|
43
|
+
"@shivaedev/effect-pg-boss": "0.19.0",
|
|
44
|
+
"@shivaedev/platform": "0.32.0"
|
|
44
45
|
},
|
|
45
46
|
"devDependencies": {
|
|
46
|
-
"@shivaedev/
|
|
47
|
+
"@shivaedev/effect-test-sql": "0.9.3",
|
|
48
|
+
"@shivaedev/quality": "0.40.0",
|
|
47
49
|
"@shivaedev/test-story": "0.20.0",
|
|
48
50
|
"@types/node": "24.19.2",
|
|
49
51
|
"effect": "4.0.5",
|
package/src/jobs/page.ts
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
import { contract } from "@shivaedev/effect-contract/contract.ts";
|
|
3
|
+
import { query } from "@shivaedev/effect-contract/operation.ts";
|
|
4
|
+
import { adminPage } from "#page.ts";
|
|
5
|
+
import { deadLetteredSchema, JobsFailures, JobsHealth, type JobsQueue, jobPage, jobSchema, PageFields, QueueCounts } from "./schemas.ts";
|
|
6
|
+
|
|
7
|
+
export function jobsPage<const TQueues extends readonly JobsQueue[]>(...queues: TQueues) {
|
|
8
|
+
const Job = Schema.Union(queues.map((queue: TQueues[number]) => jobSchema<TQueues[number]["schema"]>(queue)));
|
|
9
|
+
const DeadLettered = Schema.Union(queues.map((queue: TQueues[number]) => deadLetteredSchema<TQueues[number]["schema"]>(queue)));
|
|
10
|
+
const page = adminPage({
|
|
11
|
+
contract: contract("admin.jobs", {
|
|
12
|
+
queries: [
|
|
13
|
+
query("health", { reads: () => [], rejections: JobsFailures, success: JobsHealth }),
|
|
14
|
+
query("counts", { payload: { queue: Schema.String }, reads: () => [], rejections: JobsFailures, success: QueueCounts }),
|
|
15
|
+
query("failed", {
|
|
16
|
+
payload: { ...PageFields, queue: Schema.String },
|
|
17
|
+
reads: () => [],
|
|
18
|
+
rejections: JobsFailures,
|
|
19
|
+
success: jobPage(Job),
|
|
20
|
+
}),
|
|
21
|
+
query("deadLettered", {
|
|
22
|
+
payload: { ...PageFields, queue: Schema.String },
|
|
23
|
+
reads: () => [],
|
|
24
|
+
rejections: JobsFailures,
|
|
25
|
+
success: jobPage(DeadLettered),
|
|
26
|
+
}),
|
|
27
|
+
query("job", {
|
|
28
|
+
payload: { id: Schema.String, queue: Schema.String },
|
|
29
|
+
reads: () => [],
|
|
30
|
+
rejections: JobsFailures,
|
|
31
|
+
success: Schema.OptionFromNullOr(Job),
|
|
32
|
+
}),
|
|
33
|
+
],
|
|
34
|
+
}),
|
|
35
|
+
id: "jobs",
|
|
36
|
+
route: { path: "/admin/jobs", title: "Jobs" },
|
|
37
|
+
});
|
|
38
|
+
return Object.assign(page, { queues });
|
|
39
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
|
|
3
|
+
export interface JobsQueue {
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly schema: Schema.Top & { readonly Type: object; readonly Encoded: object };
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
export class JobsUnavailable extends Schema.TaggedError<JobsUnavailable>()("JobsUnavailable", {
|
|
9
|
+
operation: Schema.String,
|
|
10
|
+
}) {}
|
|
11
|
+
|
|
12
|
+
export class JobsPayloadInvalid extends Schema.TaggedError<JobsPayloadInvalid>()("JobsPayloadInvalid", {
|
|
13
|
+
queue: Schema.String,
|
|
14
|
+
}) {}
|
|
15
|
+
|
|
16
|
+
export class JobsQueueUnregistered extends Schema.TaggedError<JobsQueueUnregistered>()("JobsQueueUnregistered", {
|
|
17
|
+
queue: Schema.String,
|
|
18
|
+
}) {}
|
|
19
|
+
|
|
20
|
+
export const JobsFailures = { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable };
|
|
21
|
+
|
|
22
|
+
export const QueueCounts = Schema.Struct({
|
|
23
|
+
activeCount: Schema.Number,
|
|
24
|
+
failedCount: Schema.Number,
|
|
25
|
+
queuedCount: Schema.Number,
|
|
26
|
+
totalCount: Schema.Number,
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
export const QueueHealth = Schema.Struct({
|
|
30
|
+
activeCount: Schema.Number,
|
|
31
|
+
deadLetteredCount: Schema.Number,
|
|
32
|
+
failedCount: Schema.Number,
|
|
33
|
+
name: Schema.String,
|
|
34
|
+
queuedCount: Schema.Number,
|
|
35
|
+
readyCount: Schema.Number,
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
export const JobsHealth = Schema.Struct({
|
|
39
|
+
activeTotal: Schema.Number,
|
|
40
|
+
deadLetteredTotal: Schema.Number,
|
|
41
|
+
failedTotal: Schema.Number,
|
|
42
|
+
jobs: Schema.Array(QueueHealth),
|
|
43
|
+
queuedTotal: Schema.Number,
|
|
44
|
+
readyTotal: Schema.Number,
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
export const JobFields = {
|
|
48
|
+
attempt: Schema.Number,
|
|
49
|
+
completedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
|
|
50
|
+
createdOn: Schema.DateTimeUtcFromString,
|
|
51
|
+
id: Schema.String,
|
|
52
|
+
output: Schema.Unknown,
|
|
53
|
+
retryCount: Schema.Number,
|
|
54
|
+
retryLimit: Schema.Number,
|
|
55
|
+
startedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
|
|
56
|
+
state: Schema.Literals(["created", "retry", "active", "completed", "cancelled", "failed"]),
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
export const PageFields = { cursor: Schema.optionalKey(Schema.String), limit: Schema.Number };
|
|
60
|
+
|
|
61
|
+
export function jobSchema<TPayload extends JobsQueue["schema"]>(queue: { readonly name: string; readonly schema: TPayload }) {
|
|
62
|
+
return Schema.Struct({ ...JobFields, data: queue.schema, queue: Schema.Literal(queue.name) });
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function deadLetteredSchema<TPayload extends JobsQueue["schema"]>(queue: { readonly name: string; readonly schema: TPayload }) {
|
|
66
|
+
const name: string = `${queue.name}-dlq`;
|
|
67
|
+
return Schema.Struct({
|
|
68
|
+
...JobFields,
|
|
69
|
+
data: queue.schema,
|
|
70
|
+
queue: Schema.Literal(name),
|
|
71
|
+
sourceId: Schema.OptionFromNullOr(Schema.String),
|
|
72
|
+
sourceOutput: Schema.Unknown,
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function jobPage<TJob extends Schema.Top>(job: TJob) {
|
|
77
|
+
return Schema.Struct({ jobs: Schema.Array(job), next: Schema.OptionFromNullOr(Schema.String) });
|
|
78
|
+
}
|
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,76 @@
|
|
|
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
|
+
function failures<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 jobsHandlers<const TQueues extends readonly JobsQueue[], TService>(
|
|
16
|
+
page: ReturnType<typeof jobsPage<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 page.contract.application.toLayer({
|
|
25
|
+
"admin.jobs.counts": ({ queue }) =>
|
|
26
|
+
Effect.gen(function* () {
|
|
27
|
+
const definition = yield* registered(queue);
|
|
28
|
+
const jobs = yield* service;
|
|
29
|
+
return yield* failures(jobs.counts(definition));
|
|
30
|
+
}),
|
|
31
|
+
"admin.jobs.deadLettered": ({ queue, ...options }) =>
|
|
32
|
+
Effect.gen(function* () {
|
|
33
|
+
const definition = yield* registered(queue);
|
|
34
|
+
const jobs = yield* service;
|
|
35
|
+
return yield* failures(jobs.deadLetteredJobs<string, TQueues[number]["schema"]>(definition, options));
|
|
36
|
+
}),
|
|
37
|
+
"admin.jobs.failed": ({ queue, ...options }) =>
|
|
38
|
+
Effect.gen(function* () {
|
|
39
|
+
const definition = yield* registered(queue);
|
|
40
|
+
const jobs = yield* service;
|
|
41
|
+
return yield* failures(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* failures(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 }) =>
|
|
58
|
+
Effect.gen(function* () {
|
|
59
|
+
const definition = yield* registered(queue);
|
|
60
|
+
const jobs = yield* service;
|
|
61
|
+
return Option.map(yield* failures(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
|
+
}
|