@cronwatch/sdk 0.6.0 → 0.7.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-import { C as CronWatchOptions, a as CronWatch } from './client-B7bqnkI5.cjs';
-export { F as FetchHandler, H as HandlerFn, b as HandlerOptions, J as JobContext, c as JobFn, d as JobHandle, R as RecordRunOptions, e as Routes, f as RoutesOptions, g as RunHandle, h as RunOutcome, S as Source, i as SourceHost, j as StartOptions, k as consoleChannel, l as createRoutes, m as custom } from './client-B7bqnkI5.cjs';
-import { S as Store, D as Duration, b as AlertDraft, c as StoredJobDefinition, A as Alert } from './types-Ddq1MUPL.cjs';
-export { a as AlertChannel, d as AlertDetails, e as AlertType, B as BudgetBreach, C as ChannelContext, f as CheckResult, g as Condition, E as ExpectRule, J as JobDefinition, h as JobHealth, i as JobOptions, j as JobState, k as JobSummary, R as Run, l as RunStatus, m as StoredJob, T as TriageContext, n as TriageFn } from './types-Ddq1MUPL.cjs';
+import { C as CronWatchOptions, a as CronWatch } from './client-Di5HAWQz.cjs';
+export { F as FetchHandler, H as HandlerFn, b as HandlerOptions, J as JobContext, c as JobFn, d as JobHandle, R as RecordRunOptions, e as Routes, f as RoutesOptions, g as RunHandle, h as RunOutcome, S as Source, i as SourceHost, j as StartOptions, k as consoleChannel, l as createRoutes, m as custom } from './client-Di5HAWQz.cjs';
+import { S as Store, D as Duration, b as AlertDraft, c as StoredJobDefinition, A as Alert } from './types-BjBbCGeJ.cjs';
+export { a as AlertChannel, d as AlertDetails, e as AlertType, B as BudgetBreach, C as ChannelContext, f as CheckResult, g as Condition, E as ExpectRule, J as JobDefinition, h as JobHealth, i as JobOptions, j as JobState, k as JobSummary, R as Run, l as RunStatus, m as StoredJob, T as TriageContext, n as TriageFn } from './types-BjBbCGeJ.cjs';
 
 /**
  * Keeps everything in process memory. The default when no store is given,

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { C as CronWatchOptions, a as CronWatch } from './client-pmqH3apS.js';
-export { F as FetchHandler, H as HandlerFn, b as HandlerOptions, J as JobContext, c as JobFn, d as JobHandle, R as RecordRunOptions, e as Routes, f as RoutesOptions, g as RunHandle, h as RunOutcome, S as Source, i as SourceHost, j as StartOptions, k as consoleChannel, l as createRoutes, m as custom } from './client-pmqH3apS.js';
-import { S as Store, D as Duration, b as AlertDraft, c as StoredJobDefinition, A as Alert } from './types-Ddq1MUPL.js';
-export { a as AlertChannel, d as AlertDetails, e as AlertType, B as BudgetBreach, C as ChannelContext, f as CheckResult, g as Condition, E as ExpectRule, J as JobDefinition, h as JobHealth, i as JobOptions, j as JobState, k as JobSummary, R as Run, l as RunStatus, m as StoredJob, T as TriageContext, n as TriageFn } from './types-Ddq1MUPL.js';
+import { C as CronWatchOptions, a as CronWatch } from './client-B5hM4l-D.js';
+export { F as FetchHandler, H as HandlerFn, b as HandlerOptions, J as JobContext, c as JobFn, d as JobHandle, R as RecordRunOptions, e as Routes, f as RoutesOptions, g as RunHandle, h as RunOutcome, S as Source, i as SourceHost, j as StartOptions, k as consoleChannel, l as createRoutes, m as custom } from './client-B5hM4l-D.js';
+import { S as Store, D as Duration, b as AlertDraft, c as StoredJobDefinition, A as Alert } from './types-BjBbCGeJ.js';
+export { a as AlertChannel, d as AlertDetails, e as AlertType, B as BudgetBreach, C as ChannelContext, f as CheckResult, g as Condition, E as ExpectRule, J as JobDefinition, h as JobHealth, i as JobOptions, j as JobState, k as JobSummary, R as Run, l as RunStatus, m as StoredJob, T as TriageContext, n as TriageFn } from './types-BjBbCGeJ.js';
 
 /**
  * Keeps everything in process memory. The default when no store is given,

package/dist/index.js

@@ -9,11 +9,14 @@ var UNIT_MS = {
   d: 864e5,
   w: 6048e5
 };
+var MAX_LENGTH = 64;
+var QUOTED = 32;
 function parseDuration(value, label = "duration") {
   if (typeof value === "number") {
     if (!Number.isFinite(value) || value < 0) throw new Error(`${label} must be a non-negative number of milliseconds`);
     return value;
   }
+  if (value.length > MAX_LENGTH) tooLong(value, label);
   const text = value.trim().toLowerCase();
   if (text === "") throw new Error(`${label} is empty`);
   const re = /(\d+(?:\.\d+)?)\s*(ms|s|m|h|d|w)/g;
@@ -29,6 +32,16 @@ function parseDuration(value, label = "duration") {
   }
   return Math.round(total);
 }
+function tooLong(value, label) {
+  let count = 0;
+  let head = "";
+  for (const char of value) {
+    if (count < QUOTED) head += char;
+    if (++count > MAX_LENGTH) {
+      throw new Error(`${label} "${head}..." is too long for a duration (more than ${MAX_LENGTH} characters)`);
+    }
+  }
+}
 function formatDuration(ms) {
   if (!Number.isFinite(ms)) return "?";
   if (ms < 1e3) return `${Math.round(ms)}ms`;
@@ -155,15 +168,15 @@ function runCovers(startedAt, dueAt, followingAt = null) {
 }
 function inSpringForwardGap(parsed, startedAt, fireAt) {
   const LOOKBACK = 3 * 36e5;
-  const after = utcOffset(fireAt, parsed.timezone);
+  const after2 = utcOffset(fireAt, parsed.timezone);
   const before = utcOffset(fireAt - LOOKBACK, parsed.timezone);
-  const gap = after - before;
+  const gap = after2 - before;
   if (gap <= 0) return false;
   let lo = fireAt - LOOKBACK;
   let hi = fireAt;
   while (hi - lo > 6e4) {
     const mid = lo + Math.floor((hi - lo) / 2);
-    if (utcOffset(mid, parsed.timezone) === after) hi = mid;
+    if (utcOffset(mid, parsed.timezone) === after2) hi = mid;
     else lo = mid;
   }
   const jumpAt = Math.floor(hi / 6e4) * 6e4;
@@ -501,8 +514,8 @@ ${out}`);
         break;
       }
       title = `${name} recovered`;
-      const after = draft.details.after.map((c) => c.replace("_", " ")).join(", ");
-      lines.push(`A run ${run ? when(run.startedAt, now) : "just now"} succeeded${after ? ` after: ${after}` : ""}.`);
+      const after2 = draft.details.after.map((c) => c.replace("_", " ")).join(", ");
+      lines.push(`A run ${run ? when(run.startedAt, now) : "just now"} succeeded${after2 ? ` after: ${after2}` : ""}.`);
       if (run?.durationMs !== null && run?.durationMs !== void 0) lines.push(`Ran ${formatDuration(run.durationMs)}.`);
       break;
     }
@@ -689,6 +702,9 @@ function checkExpectation(expect, output) {
 function escapeHtml(value) {
   return String(value ?? "").replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
 }
+function escapeName(value) {
+  return escapeHtml(value).replace(/([_:./-]+)(?=[^_:./-])/g, "$1<wbr>");
+}
 
 // src/routes/icons.ts
 var ICON_SVG = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40"><rect width="40" height="40" rx="10" fill="#141417"/><rect x="0.5" y="0.5" width="39" height="39" rx="9.5" fill="none" stroke="#2a2a2f"/><circle cx="20" cy="20" r="10.5" fill="none" stroke="#f3f3f1" stroke-width="2"/><path d="M20 12.5V20h6" fill="none" stroke="#f3f3f1" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/></svg>';
@@ -1035,7 +1051,7 @@ function dayTimeline(lanes, span, base, total) {
     const { job } = input;
     const parts = lane(input, span, { nowInLane: false, label: job.name });
     return {
-      html: `<li class="lane"><div class="who"><i class="sq ${stateClass(job)}" aria-hidden="true"></i><a class="name" href="${escapeHtml(base)}/jobs/${encodeURIComponent(job.name)}">${escapeHtml(job.name)}</a><span class="sched">${escapeHtml(job.definition.schedule ?? "no schedule")}</span></div><div class="track">${parts.svg}${parts.note}</div></li>`,
+      html: `<li class="lane"><div class="who"><i class="sq ${stateClass(job)}" aria-hidden="true"></i><a class="name" href="${escapeHtml(base)}/jobs/${encodeURIComponent(job.name)}">${escapeName(job.name)}</a><span class="sched">${escapeHtml(job.definition.schedule ?? "no schedule")}</span></div><div class="track">${parts.svg}${parts.note}</div></li>`,
       words: `<li>${escapeHtml(`${job.name} (${job.definition.schedule ?? "no schedule"}): ${parts.words}.`)}</li>`
     };
   });
@@ -1275,7 +1291,7 @@ ${options.refresh ? `<meta http-equiv="refresh" content="${options.refresh}">` :
 }
 function brand(base, crumb) {
   const home = `<a href="${h(base)}/">${MARK}<span>CronWatch</span></a>`;
-  return crumb === void 0 ? `<p class="brand">${home}</p>` : `<p class="brand">${home}<span class="slash" aria-hidden="true">/</span><span class="crumb">${h(crumb)}</span></p>`;
+  return crumb === void 0 ? `<p class="brand">${home}</p>` : `<p class="brand">${home}<span class="slash" aria-hidden="true">/</span><span class="crumb">${escapeName(crumb)}</span></p>`;
 }
 var HEALTH = {
   failing: ["bad", "failing"],
@@ -1328,7 +1344,7 @@ function dashboardPage(jobs, runsByJob, now, base, checkedAt, lanes = jobs.slice
     const last = job.lastRun;
     const d = job.definition;
     return `<tr>
-<td class="job"><a class="name" href="${h(base)}/jobs/${encodeURIComponent(job.name)}">${h(job.name)}</a>${d.description ? `<span class="desc">${h(d.description)}</span>` : ""}</td>
+<td class="job"><a class="name" href="${h(base)}/jobs/${encodeURIComponent(job.name)}">${escapeName(job.name)}</a>${d.description ? `<span class="desc">${h(d.description)}</span>` : ""}</td>
 <td class="health">${healthState(job)}</td>
 <td class="nowrap hide-sm">${d.schedule ? `${h(d.schedule)}${d.timezone ? `<span class="tz">${h(d.timezone)}</span>` : ""}` : `<span class="muted">no schedule</span>`}</td>
 <td class="nowrap last">${last ? `${runState(last)} ${stamp(last.startedAt, now)}${last.durationMs !== null ? `<span class="sub">took ${h(formatDuration(last.durationMs))}</span>` : ""}` : `<span class="muted">never</span>`}</td>
@@ -1400,7 +1416,7 @@ function jobPage(job, runs, now, base, complete = true) {
 <section class="sec intro" aria-label="Job">
   <h2>Job</h2>
   <div>
-    <h1 class="jobname">${h(job.name)}</h1>
+    <h1 class="jobname">${escapeName(job.name)}</h1>
     ${d.description ? `<p class="desc">${h(d.description)}</p>` : ""}
     <p class="stateline">${healthState(job)}${why ? `<span class="why">${h(why)}</span>` : ""}</p>
     <div class="actions">
@@ -1477,7 +1493,20 @@ function developmentToken() {
   return btoa(String.fromCharCode(...bytes)).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
 }
 function developmentSignInLine(origin, base, token) {
-  return `[cronwatch] CRONWATCH_TOKEN is not set, so this development server made a token for the dashboard. Sign in: ${origin}${base}/?token=${token}`;
+  const intro = "[cronwatch] CRONWATCH_TOKEN is not set, so this development server made a token for the dashboard. Sign in: ";
+  return origin === null ? `${intro}${base}/?token=${token} on this server (the first request's host is not local, so the link leaves it out)` : `${intro}${origin}${base}/?token=${token}`;
+}
+function isLoopbackOrigin(origin) {
+  let host;
+  try {
+    host = new URL(origin).hostname.toLowerCase();
+  } catch {
+    return false;
+  }
+  if (host === "localhost" || host.endsWith(".localhost")) return true;
+  if (host === "[::1]") return true;
+  const octets = /^127\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/.exec(host);
+  return octets !== null && octets.slice(1).every((o) => Number(o) <= 255);
 }
 function safeDecode(value) {
   try {
@@ -1582,7 +1611,8 @@ function createRoutes(cw, options = {}) {
     const publicOrigin = originOf(request, url);
     if (generated && !announced) {
       announced = true;
-      console.info(developmentSignInLine(publicOrigin, base, token));
+      const shown = fixedOrigin ?? (isLoopbackOrigin(publicOrigin) ? publicOrigin : null);
+      console.info(developmentSignInLine(shown, base, token));
     }
     if (method === "GET" || method === "HEAD") {
       if (path === "/offline") {
@@ -2146,8 +2176,7 @@ var CronWatch = class {
     const started = recorded ? this.updateState(name, (before) => ({ state: onRunStart(before), result: void 0 })).then(() => {
     }, (e) => this.onError(e, `starting ${name}`)) : Promise.resolve();
     const recorder = createRecorder(run);
-    const timer = setTimeout(() => recorder.abort(), timeoutMs(definition));
-    if (typeof timer === "object" && "unref" in timer) timer.unref();
+    const clearTimer = after(timeoutMs(definition), () => recorder.abort());
     let result;
     let error;
     let threw = false;
@@ -2157,7 +2186,7 @@ var CronWatch = class {
       error = e;
       threw = true;
     } finally {
-      clearTimeout(timer);
+      clearTimer();
     }
     const finishedAt = this.now();
     run.finishedAt = finishedAt;
@@ -2712,7 +2741,7 @@ ${id}`;
    */
   start(every = "1m") {
     if (this.timer) return;
-    const ms = Math.max(5e3, parseDuration(every, "check interval"));
+    const ms = Math.min(TIMER_MAX_MS, Math.max(5e3, parseDuration(every, "check interval")));
     if (this.deferDelivery && !this.warnedDeferredStart) {
       this.warnedDeferredStart = true;
       console.warn('[cronwatch] start() was called with deliver: "check", so these checks send no alerts. Another process must run checks with deliver: "now" (the default) to send them.');
@@ -2851,20 +2880,30 @@ function checkRunId(job, id, method) {
     throw new Error(`job "${job}": ${method}() cannot take a run id starting with "${RESERVED_RUN_ID_PREFIX}", which the pg_cron source uses for its runs`);
   }
 }
-function joinLines(before, after) {
-  if (before === null || before === "") return after;
-  if (after === null) return before;
+function joinLines(before, after2) {
+  if (before === null || before === "") return after2;
+  if (after2 === null) return before;
   return `${before}
-${after}`;
+${after2}`;
 }
-function joinOutput(before, after) {
-  const joined = joinLines(before, after);
+function joinOutput(before, after2) {
+  const joined = joinLines(before, after2);
   return joined === null ? null : capOutput(joined);
 }
 function clampLimit(limit, fallback, min) {
   const n = typeof limit === "number" && Number.isFinite(limit) ? Math.trunc(limit) : fallback;
   return Math.min(500, Math.max(min, n));
 }
+var TIMER_MAX_MS = 2 ** 31 - 1;
+function after(ms, fn) {
+  let timer;
+  const arm = (left) => {
+    timer = left > TIMER_MAX_MS ? setTimeout(() => arm(left - TIMER_MAX_MS), TIMER_MAX_MS) : setTimeout(fn, left);
+    if (typeof timer === "object" && "unref" in timer) timer.unref();
+  };
+  arm(ms);
+  return () => clearTimeout(timer);
+}
 function withTimeout(promise, ms) {
   return new Promise((resolve, reject) => {
     const t = setTimeout(() => reject(new Error(`timed out after ${ms}ms`)), ms);