File size: 9,232 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | import { normalizeCronJobCreate, normalizeCronJobPatch } from "../../cron/normalize.js";
import {
readCronRunLogEntriesPage,
readCronRunLogEntriesPageAll,
resolveCronRunLogPath,
} from "../../cron/run-log.js";
import type { CronJobCreate, CronJobPatch } from "../../cron/types.js";
import { validateScheduleTimestamp } from "../../cron/validate-timestamp.js";
import {
ErrorCodes,
errorShape,
formatValidationErrors,
validateCronAddParams,
validateCronListParams,
validateCronRemoveParams,
validateCronRunParams,
validateCronRunsParams,
validateCronStatusParams,
validateCronUpdateParams,
validateWakeParams,
} from "../protocol/index.js";
import type { GatewayRequestHandlers } from "./types.js";
export const cronHandlers: GatewayRequestHandlers = {
wake: ({ params, respond, context }) => {
if (!validateWakeParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid wake params: ${formatValidationErrors(validateWakeParams.errors)}`,
),
);
return;
}
const p = params as {
mode: "now" | "next-heartbeat";
text: string;
};
const result = context.cron.wake({ mode: p.mode, text: p.text });
respond(true, result, undefined);
},
"cron.list": async ({ params, respond, context }) => {
if (!validateCronListParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.list params: ${formatValidationErrors(validateCronListParams.errors)}`,
),
);
return;
}
const p = params as {
includeDisabled?: boolean;
limit?: number;
offset?: number;
query?: string;
enabled?: "all" | "enabled" | "disabled";
sortBy?: "nextRunAtMs" | "updatedAtMs" | "name";
sortDir?: "asc" | "desc";
};
const page = await context.cron.listPage({
includeDisabled: p.includeDisabled,
limit: p.limit,
offset: p.offset,
query: p.query,
enabled: p.enabled,
sortBy: p.sortBy,
sortDir: p.sortDir,
});
respond(true, page, undefined);
},
"cron.status": async ({ params, respond, context }) => {
if (!validateCronStatusParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.status params: ${formatValidationErrors(validateCronStatusParams.errors)}`,
),
);
return;
}
const status = await context.cron.status();
respond(true, status, undefined);
},
"cron.add": async ({ params, respond, context }) => {
const normalized = normalizeCronJobCreate(params) ?? params;
if (!validateCronAddParams(normalized)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.add params: ${formatValidationErrors(validateCronAddParams.errors)}`,
),
);
return;
}
const jobCreate = normalized as unknown as CronJobCreate;
const timestampValidation = validateScheduleTimestamp(jobCreate.schedule);
if (!timestampValidation.ok) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, timestampValidation.message),
);
return;
}
const job = await context.cron.add(jobCreate);
context.logGateway.info("cron: job created", { jobId: job.id, schedule: jobCreate.schedule });
respond(true, job, undefined);
},
"cron.update": async ({ params, respond, context }) => {
const normalizedPatch = normalizeCronJobPatch((params as { patch?: unknown } | null)?.patch);
const candidate =
normalizedPatch && typeof params === "object" && params !== null
? { ...params, patch: normalizedPatch }
: params;
if (!validateCronUpdateParams(candidate)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.update params: ${formatValidationErrors(validateCronUpdateParams.errors)}`,
),
);
return;
}
const p = candidate as {
id?: string;
jobId?: string;
patch: Record<string, unknown>;
};
const jobId = p.id ?? p.jobId;
if (!jobId) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid cron.update params: missing id"),
);
return;
}
const patch = p.patch as unknown as CronJobPatch;
if (patch.schedule) {
const timestampValidation = validateScheduleTimestamp(patch.schedule);
if (!timestampValidation.ok) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, timestampValidation.message),
);
return;
}
}
const job = await context.cron.update(jobId, patch);
context.logGateway.info("cron: job updated", { jobId });
respond(true, job, undefined);
},
"cron.remove": async ({ params, respond, context }) => {
if (!validateCronRemoveParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.remove params: ${formatValidationErrors(validateCronRemoveParams.errors)}`,
),
);
return;
}
const p = params as { id?: string; jobId?: string };
const jobId = p.id ?? p.jobId;
if (!jobId) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid cron.remove params: missing id"),
);
return;
}
const result = await context.cron.remove(jobId);
if (result.removed) {
context.logGateway.info("cron: job removed", { jobId });
}
respond(true, result, undefined);
},
"cron.run": async ({ params, respond, context }) => {
if (!validateCronRunParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.run params: ${formatValidationErrors(validateCronRunParams.errors)}`,
),
);
return;
}
const p = params as { id?: string; jobId?: string; mode?: "due" | "force" };
const jobId = p.id ?? p.jobId;
if (!jobId) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid cron.run params: missing id"),
);
return;
}
const result = await context.cron.enqueueRun(jobId, p.mode ?? "force");
respond(true, result, undefined);
},
"cron.runs": async ({ params, respond, context }) => {
if (!validateCronRunsParams(params)) {
respond(
false,
undefined,
errorShape(
ErrorCodes.INVALID_REQUEST,
`invalid cron.runs params: ${formatValidationErrors(validateCronRunsParams.errors)}`,
),
);
return;
}
const p = params as {
scope?: "job" | "all";
id?: string;
jobId?: string;
limit?: number;
offset?: number;
statuses?: Array<"ok" | "error" | "skipped">;
status?: "all" | "ok" | "error" | "skipped";
deliveryStatuses?: Array<"delivered" | "not-delivered" | "unknown" | "not-requested">;
deliveryStatus?: "delivered" | "not-delivered" | "unknown" | "not-requested";
query?: string;
sortDir?: "asc" | "desc";
};
const explicitScope = p.scope;
const jobId = p.id ?? p.jobId;
const scope: "job" | "all" = explicitScope ?? (jobId ? "job" : "all");
if (scope === "job" && !jobId) {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid cron.runs params: missing id"),
);
return;
}
if (scope === "all") {
const jobs = await context.cron.list({ includeDisabled: true });
const jobNameById = Object.fromEntries(
jobs
.filter((job) => typeof job.id === "string" && typeof job.name === "string")
.map((job) => [job.id, job.name]),
);
const page = await readCronRunLogEntriesPageAll({
storePath: context.cronStorePath,
limit: p.limit,
offset: p.offset,
statuses: p.statuses,
status: p.status,
deliveryStatuses: p.deliveryStatuses,
deliveryStatus: p.deliveryStatus,
query: p.query,
sortDir: p.sortDir,
jobNameById,
});
respond(true, page, undefined);
return;
}
let logPath: string;
try {
logPath = resolveCronRunLogPath({
storePath: context.cronStorePath,
jobId: jobId as string,
});
} catch {
respond(
false,
undefined,
errorShape(ErrorCodes.INVALID_REQUEST, "invalid cron.runs params: invalid id"),
);
return;
}
const page = await readCronRunLogEntriesPage(logPath, {
limit: p.limit,
offset: p.offset,
jobId: jobId as string,
statuses: p.statuses,
status: p.status,
deliveryStatuses: p.deliveryStatuses,
deliveryStatus: p.deliveryStatus,
query: p.query,
sortDir: p.sortDir,
});
respond(true, page, undefined);
},
};
|