@rackbops/plugin-tracker 0.17.0 → 0.18.0

package/README.md

@@ -22,7 +22,9 @@ that reads a listing page you paste, or BoardGameGeek's marketplace once BGG app
 application, every few hours with no model, and DMs each new listing within your limits once, until
 you press Done, and, while the model runner is set up, has the model look at each new listing
 first -- is it the thing, and what does its page show about the seller -- before DMing it; for
-eBay it hands you an eBay search to save on eBay, and never reads eBay. The model runs never happen here: they go
+eBay it hands you an eBay search to save on eBay, and never reads eBay -- and the daily "today and
+overdue" digest (plan 5.5): one DM a day at each person's preferred hour listing their reminders
+and renewals due today or overdue. The model runs never happen here: they go
 through city-hall to Rackbops/docket-runner on roshne's own host (plan 5.12), and the whole execute
 lane stays off until the city-hall Executor is configured (Configuration below).
 
@@ -556,6 +558,7 @@ $ curl -s https://clerk.example.com/tracker/api/v1/tasks/t9 -H "Authorization: B
 | Page reads | `src/fetch.ts` | docket's `Fetch` port for `price`: http or https on the default port, no credentials, every resolved address public (no loopback, private, link-local, CGNAT, multicast or reserved range, IPv4 or IPv6), redirects followed by hand and re-checked (at most 5), 15 s including the name lookup, at most 3 MB kept. The body is then rebuilt in linear time (`src/page.ts`) to just what extraction reads -- JSON-LD, meta tags, and the page with every `<` blanked, so `near` still reads text, attributes and script data -- because docket's extraction patterns take quadratic time on a page of unclosed tags. A read the tick's abort cuts short requeues its run instead of counting a miss. A DNS answer that changes between the check and the read is not caught here. |
 | Renewals, prices | `src/tracked.ts`, `src/price.ts`, `src/series.ts`, `src/page.ts` | `/renewal`, `/price` and `/task decide`; the series lines of `/task history`. The series (docket's `series` table, schema 1) holds a renewal's paid amounts and a price's readings. |
 | Delivery | `src/notifier.ts`, `src/buttons.ts` | docket's `Notifier` over `host.dm`, with the buttons. docket claims each (run, person) in the store's `deliveries` before the DM and settles it after. The notifier maps the host's answers to docket's errors: cannot be messaged (50007) or an unknown user is `DeliveryFailedError(msg, true)` (failed for good; 50007 and 10013 count toward the pause); a message refused for its content is a plain `DeliveryFailedError` (retried); a paused person is `ExecutorUnavailableError` (deferred); anything else is rethrown, so docket settles it unconfirmed and never resends it. |
+| Daily digest | `src/digest.ts` | Plan 5.5's "today and overdue" DM, on the `notify` tick after the runs due now, no model. For each person whose preferred hour has come in their zone, the day is claimed first (docket's `claimNotice`, key `digest:<user>:<YYYY-MM-DD>`, research-triage's exactly-once pattern; forget-me erases it), then their own active reminders and renewals are read: overdue is the latest fired run before today with no done or decision from the owner, due today is a run not yet fired today or the latest fired run today still unanswered. A snoozed run, an older run behind a newer one, other types and received tasks are left out. Nothing listed, no DM; a paused person is passed by unclaimed; a failed send is not retried. |
 | Task lock | `src/locks.ts` | One task at a time: its runs, answers and edits never overlap (docket 0.4.0 asks the host to serialize per task). |
 | Pause | `src/delivery-health.ts` | The per-person failure count, the pause and the resume. |
 | People | `src/people.ts`, `src/admissions.ts` | Discord id, time zone, preferred hour, admin flag -- in the tracker's store, never usr; who admitted each person and when they registered. `TRACKER_ADMIN_DISCORD_IDS` only ever grants admin. |

package/dist/plugin.js

@@ -7918,6 +7918,122 @@ function healthResponse(health) {
   });
 }
 
+// plugins/tracker/src/digest.ts
+var DIGEST_TYPES = new Set(["reminder", "renewal"]);
+var ANSWERS = new Set(["done", "decision"]);
+var MAX_LINES = 10;
+function digestKey(userId, day) {
+  return `digest:${userId}:${day}`;
+}
+function localDay2(now, zone) {
+  const w = wallClock(now, zone);
+  const next = new Date(Date.UTC(w.year, w.month - 1, w.day + 1));
+  return {
+    day: `${w.year}-${String(w.month).padStart(2, "0")}-${String(w.day).padStart(2, "0")}`,
+    start: zonedInstant(w.year, w.month, w.day, 0, 0, zone),
+    end: zonedInstant(next.getUTCFullYear(), next.getUTCMonth() + 1, next.getUTCDate(), 0, 0, zone),
+    hour: w.hour
+  };
+}
+async function collectDigest(store, user, start, end) {
+  const from = start.toISOString();
+  const to = end.toISOString();
+  const overdue = [];
+  const today = [];
+  for (const task of await store.listTasks({ ownerId: user.id, status: "active" })) {
+    if (!DIGEST_TYPES.has(task.type))
+      continue;
+    const runs = await store.listOccurrences({ taskId: task.id });
+    const last = runs.filter(hasFired).at(-1);
+    if (last && last.status !== "snoozed" && !await answered(store, task, last)) {
+      (last.dueAt < from ? overdue : today).push({ task, run: last, waiting: true });
+    }
+    for (const run of runs) {
+      if (run.status === "queued" && !hasFired(run) && run.dueAt >= from && run.dueAt < to)
+        today.push({ task, run, waiting: false });
+    }
+  }
+  const byDue = (a, b) => a.run.dueAt < b.run.dueAt ? -1 : a.run.dueAt > b.run.dueAt ? 1 : 0;
+  return { overdue: overdue.sort(byDue), today: today.sort(byDue) };
+}
+async function answered(store, task, run) {
+  return (await store.listReplies(task.id)).some((r) => r.occurrenceId === run.id && r.userId === task.ownerId && ANSWERS.has(r.kind));
+}
+var WEEKDAYS3 = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
+var MONTHS = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
+function dateLabel(now, zone) {
+  const w = wallClock(now, zone);
+  return `${WEEKDAYS3[w.weekday]} ${MONTHS[w.month - 1]} ${w.day}`;
+}
+function clockTime2(instant, zone) {
+  const w = wallClock(new Date(instant), zone);
+  return `${w.hour}:${String(w.minute).padStart(2, "0")}`;
+}
+function waitingOn(task) {
+  return task.type === "renewal" ? "waiting on your keep, cancel or renewed" : "not marked done yet";
+}
+function section(title, items, line) {
+  if (items.length === 0)
+    return [];
+  const lines = [title, ...items.slice(0, MAX_LINES).map(line)];
+  if (items.length > MAX_LINES)
+    lines.push(`- and ${items.length - MAX_LINES} more`);
+  return lines;
+}
+function formatDigest(digest, user, now) {
+  if (digest.overdue.length === 0 && digest.today.length === 0)
+    return null;
+  const zone = user.timeZone;
+  const title = (t) => t.title.length > 80 ? `${t.title.slice(0, 77)}...` : t.title;
+  const lines = [
+    `Your day, ${dateLabel(now, zone)}:`,
+    ...section("**Overdue**", digest.overdue, (i) => `- \`${i.task.id}\` ${title(i.task)} -- ${i.task.type === "renewal" ? "asked" : "due"} ${formatInstant(i.run.dueAt, zone, now)}, ${waitingOn(i.task)}`),
+    ...section("**Due today**", digest.today, (i) => i.waiting ? `- \`${i.task.id}\` ${title(i.task)} -- ${clockTime2(i.run.dueAt, zone)}, ${waitingOn(i.task)}` : `- \`${i.task.id}\` ${title(i.task)} -- ${clockTime2(i.run.dueAt, zone)}`),
+    "`/task done` marks a reminder done, `/task decide` answers a renewal, `/task snooze` puts either off; `/tasks` lists everything."
+  ];
+  return lines.join(`
+`);
+}
+async function runDigests(d, now, signal) {
+  const result = { claimed: 0, sent: 0, failed: 0 };
+  for (const user of await d.store.listUsers()) {
+    if (signal?.aborted)
+      break;
+    let day;
+    try {
+      day = localDay2(now, user.timeZone);
+    } catch (err) {
+      d.log.warn(`digest: ${user.id} has a time zone the clock cannot read (${err instanceof Error ? err.message : String(err)})`);
+      continue;
+    }
+    if (day.hour < user.preferredHour)
+      continue;
+    if (d.health?.isPaused(user.id))
+      continue;
+    if (!await d.store.claimNotice(digestKey(user.id, day.day), now.toISOString()))
+      continue;
+    result.claimed++;
+    let text;
+    try {
+      text = formatDigest(await collectDigest(d.store, user, day.start, day.end), user, now);
+    } catch (err) {
+      d.log.error(`digest: could not read ${user.id}'s day; today's digest is skipped`, err);
+      result.failed++;
+      continue;
+    }
+    if (text === null)
+      continue;
+    try {
+      await d.notifier.sendDm(user.id, { text });
+      result.sent++;
+    } catch (err) {
+      d.log.warn(`digest: today's digest to ${user.id} did not go out (${err instanceof Error ? err.message : String(err)}); it is not resent`);
+      result.failed++;
+    }
+  }
+  return result;
+}
+
 // plugins/tracker/src/store.ts
 var DEFAULT_TIME_ZONE2 = "UTC";
 var DEFAULT_PREFERRED_HOUR2 = 9;
@@ -8624,6 +8740,7 @@ class Roster {
       del("web_login_tokens", "user_id = ?", userId);
       del("api_tokens", "user_id = ?", userId);
       del("notices", "key LIKE 'budget:person:' || ? || ':%'", userId);
+      del("notices", "key LIKE 'digest:' || ? || ':%'", userId);
       del("ceiling_changes", "user_id = ?", userId);
       this.db.query("UPDATE ceiling_changes SET set_by = ? WHERE set_by = ?").run(FORGOTTEN, userId);
       del("users", "seq = ?", Number(seq));
@@ -12272,6 +12389,11 @@ function createPlugin(host, options = {}) {
     const { ran, failed } = outcome.result;
     if (failed > 0)
       host.log.warn(`${kind === "poll" ? "poll" : "notify"} lane: ${ran} ran, ${failed} failed`);
+    if (kind === "notify" && options.digest !== false && deps && store) {
+      const r = await runDigests({ store, notifier: deps.notifier, log: host.log, ...delivery ? { health: delivery } : {} }, clock.now(), signal);
+      if (r.failed > 0)
+        host.log.warn(`digest: ${r.sent} sent, ${r.failed} failed`);
+    }
   }
   const running = new Set;
   const tracked = (p) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rackbops/plugin-tracker",
-  "version": "0.17.0",
-  "description": "The task tracker for Rackbops Clerk: reminders, renewals, price drops, one-off research and an interest scout (through city-hall, with their findings), a want-list watcher (listing pages you paste, BoardGameGeek once its token is set, and an eBay saved search; with the model checking each new listing and its seller first, through city-hall) by slash command, delivered by DM with buttons, on docket's SQLite store (/allow, /register, /remind, /renewal, /price, /research, /scout, /want, /tasks, /task, /settings, /web), with a web area for your tasks, history and settings, a web editor to make, change, pause and delete your own tasks (research requests too, made but not changed, and scouts, made and changed), an admin view (with the DMs that did not arrive, raising a person's daily model ceiling, and daily model usage per person), an operator switch that turns the daily budgets off for the alpha, forget-me, and a JSON task API with personal API tokens",
+  "version": "0.18.0",
+  "description": "The task tracker for Rackbops Clerk: reminders, renewals, price drops, one-off research and an interest scout (through city-hall, with their findings), a want-list watcher (listing pages you paste, BoardGameGeek once its token is set, and an eBay saved search; with the model checking each new listing and its seller first, through city-hall) by slash command, delivered by DM with buttons, and a daily DM at each person's hour of what is due today and overdue, on docket's SQLite store (/allow, /register, /remind, /renewal, /price, /research, /scout, /want, /tasks, /task, /settings, /web), with a web area for your tasks, history and settings, a web editor to make, change, pause and delete your own tasks (research requests too, made but not changed, and scouts, made and changed), an admin view (with the DMs that did not arrive, raising a person's daily model ceiling, and daily model usage per person), an operator switch that turns the daily budgets off for the alpha, forget-me, and a JSON task API with personal API tokens",
   "type": "module",
   "main": "dist/plugin.js",
   "files": ["dist"],