@ninhache/probe 0.10.0 → 0.11.0

package/README.md

@@ -121,7 +121,7 @@ of macOS.
 | `e`             | Edit the selected service                      |
 | `d`             | Remove the selected service, after a question  |
 | `:`             | Find a command by what it does; `Enter` runs   |
-| `o`             | Options: interval and timeout                  |
+| `o`             | Options: interval, timeout and notifications   |
 | `?`             | Every key; `?` or `Esc` closes                 |
 | `q`             | Quit                                           |
 
@@ -143,11 +143,15 @@ is replaced by `(hidden)`. None of it is written anywhere, and `probe check --js
 The panels save what you change in `.probe/local.yml`, for your machine only:
 
 ```yaml
-dashboard: { interval: 5, timeout: 3 }
+dashboard: { interval: 5, timeout: 3, notify: true }
 services:
   db: { skip: true }
 ```
 
+With `notify` on, a desktop notification says when a service goes down or comes back: one per round of checks
+that saw a change, none when the dashboard starts. It names the services and nothing else, and needs
+`notify-send` on Linux (`osascript`, already there, on macOS); without it the dashboard says so once and goes on.
+
 A skipped service is left out of `probe check`, `probe wait` and the dashboard, and shown as `skipped`. Name it
 (`probe check db`) and it is checked anyway.
 

package/dist/{chunk-VSQVZK7F.js → chunk-VHDD7JN7.js}

@@ -36,6 +36,7 @@ var EXIT_ERROR = 2;
 var DETECT_PORTS = [3e3, 3001, 4200, 4321, 5173, 8e3, 8080];
 var DETECT_PORTS_ENV = "PROBE_DETECT_PORTS";
 var DETECT_TIMEOUT_MS = 300;
+var NOTIFY_WAIT_MS = 5e3;
 
 // src/errors.ts
 var ProbeError = class extends Error {
@@ -524,6 +525,7 @@ export {
   DETECT_PORTS,
   DETECT_PORTS_ENV,
   DETECT_TIMEOUT_MS,
+  NOTIFY_WAIT_MS,
   CURRENT_SCHEMA_VERSION,
   SERVICE_NAME_PATTERN,
   serviceSchemaV1,

package/dist/cli.js

@@ -50,7 +50,7 @@ import {
   serviceSchemaV1,
   stripStyles,
   targetUrl
-} from "./chunk-VSQVZK7F.js";
+} from "./chunk-VHDD7JN7.js";
 import "./chunk-M3ASEG5F.js";
 
 // src/cli.ts
@@ -624,7 +624,7 @@ async function writeLock(paths, lock) {
 }
 
 // src/version.ts
-var CLI_VERSION = true ? "0.10.0" : "0.0.0-dev";
+var CLI_VERSION = true ? "0.11.0" : "0.0.0-dev";
 
 // src/makefile/generator.ts
 import { createHash } from "crypto";
@@ -885,6 +885,7 @@ import { dirname as dirname2, join as join5 } from "path";
 import { isMap as isMap2, isScalar as isScalar2, parseDocument as parseDocument2 } from "yaml";
 var SECTION = "dashboard";
 var KEYS = ["interval", "timeout"];
+var NOTIFY = "notify";
 var SERVICES = "services";
 var SKIP = "skip";
 function isDelay(value) {
@@ -907,18 +908,21 @@ async function readDashboardPreferences(paths) {
     const value = doc.getIn([SECTION, key]);
     if (isDelay(value)) preferences[key] = value;
   }
+  if (doc.getIn([SECTION, NOTIFY]) === true) preferences.notify = true;
   return preferences;
 }
 function initialDashboardSettings(askedIntervalMs, saved) {
   return {
     intervalMs: askedIntervalMs ?? (saved.interval ?? DASHBOARD_INTERVAL_SECONDS) * 1e3,
-    timeoutMs: (saved.timeout ?? DEFAULT_TIMEOUT_SECONDS) * 1e3
+    timeoutMs: (saved.timeout ?? DEFAULT_TIMEOUT_SECONDS) * 1e3,
+    ...saved.notify ? { notify: true } : {}
   };
 }
 function changedPreferences(previous, next) {
   const changed = {};
   if (next.intervalMs !== previous.intervalMs) changed.interval = next.intervalMs / 1e3;
   if (next.timeoutMs !== previous.timeoutMs) changed.timeout = next.timeoutMs / 1e3;
+  if (Boolean(next.notify) !== Boolean(previous.notify)) changed.notify = Boolean(next.notify);
   return changed;
 }
 async function editLocal(paths, edit) {
@@ -951,6 +955,11 @@ function writeDashboardPreferences(paths, preferences) {
     for (const key of KEYS) {
       if (preferences[key] !== void 0) doc.setIn([SECTION, key], preferences[key]);
     }
+    if (preferences.notify) doc.setIn([SECTION, NOTIFY], true);
+    else if (preferences.notify === false && isMap2(section)) {
+      section.delete(NOTIFY);
+      if (section.items.length === 0) doc.delete(SECTION);
+    }
     return true;
   });
 }
@@ -1796,7 +1805,7 @@ async function openedDashboard(rawArgs) {
     if (!asked) return false;
     throw new ProbeError("USAGE", "No services yet. Add one: probe add api -p 3000");
   }
-  const { openDashboard } = await import("./open-W2TWG636.js");
+  const { openDashboard } = await import("./open-QWB24XAM.js");
   let settings = initialDashboardSettings(askedMs, await readDashboardPreferences(paths));
   const saves = createSaveQueue();
   const local = `${PROBE_DIR}/${LOCAL_FILE}`;

package/dist/{open-W2TWG636.js → open-QWB24XAM.js}

@@ -4,6 +4,7 @@ import {
   DASHBOARD_HISTORY_LENGTH,
   DASHBOARD_INTERVAL_CHOICES_SECONDS,
   DASHBOARD_TIMEOUT_CHOICES_SECONDS,
+  NOTIFY_WAIT_MS,
   createColors,
   curlCommand,
   expectProblem,
@@ -18,7 +19,7 @@ import {
   runChecks,
   targetUrl,
   truncate
-} from "./chunk-VSQVZK7F.js";
+} from "./chunk-VHDD7JN7.js";
 import {
   __commonJS,
   __export,
@@ -20279,12 +20280,50 @@ async function copyText(text, platform2 = process.platform, env3 = process.env,
   return false;
 }
 
+// src/notify.ts
+import { spawn as nodeSpawn2 } from "child_process";
+function notifierName(platform2) {
+  return platform2 === "darwin" ? "osascript" : "notify-send";
+}
+function notifierCommand(platform2, title, text) {
+  if (platform2 !== "darwin") return ["notify-send", "--app-name=probe", "--", title, text];
+  return [
+    "osascript",
+    "-e",
+    "on run argv",
+    "-e",
+    "display notification (item 2 of argv) with title (item 1 of argv)",
+    "-e",
+    "end run",
+    title,
+    text
+  ];
+}
+function sendNotification(title, text, platform2 = process.platform, spawn = nodeSpawn2) {
+  const [command = "", ...args] = notifierCommand(platform2, title, text);
+  return new Promise((resolve) => {
+    const child = spawn(command, args, { stdio: "ignore" });
+    const late = setTimeout(() => {
+      child.kill();
+      resolve(false);
+    }, NOTIFY_WAIT_MS);
+    const settle = (shown) => {
+      clearTimeout(late);
+      resolve(shown);
+    };
+    child.once("error", () => settle(false));
+    child.once("exit", (code) => settle(code === 0));
+  });
+}
+
 // src/dashboard/actions.ts
+var NOTIFICATION_TITLE = "probe";
 var system = () => ({
   platform: process.platform,
   env: process.env,
   openUrl,
-  copyText
+  copyText,
+  notify: sendNotification
 });
 function serviceActions(config, deps = system()) {
   const service = (name) => config().services[name];
@@ -20306,6 +20345,10 @@ ${url}`;
       const tools = clipboardTools(deps.platform, deps.env).map(([tool]) => tool);
       return `No ${tools.join(" or ")} to copy with. The command:
 ${command}`;
+    },
+    async onNotify(message) {
+      if (await deps.notify(NOTIFICATION_TITLE, message)) return void 0;
+      return `${notifierName(deps.platform)} could not show a desktop notification`;
     }
   };
 }
@@ -20313,6 +20356,24 @@ ${command}`;
 // src/dashboard/Dashboard.tsx
 var import_react36 = __toESM(require_react(), 1);
 
+// src/dashboard/changes.ts
+function stateChanges(known, results) {
+  const checked = results.filter(({ skipped }) => !skipped);
+  return {
+    known: new Map(checked.map(({ name, ok }) => [name, ok])),
+    changes: checked.filter(({ name, ok }) => known.has(name) && known.get(name) !== ok).map(({ name, ok }) => ({ name, up: ok }))
+  };
+}
+function changeMessage(changes) {
+  const [only] = changes;
+  if (only && changes.length === 1) return `${only.name} is ${only.up ? "back up" : "down"}`;
+  const names = (up) => changes.filter((change) => change.up === up).map(({ name }) => name).join(", ");
+  return [
+    ...names(false) ? [`down: ${names(false)}`] : [],
+    ...names(true) ? [`back up: ${names(true)}`] : []
+  ].join("; ");
+}
+
 // src/dashboard/detail.ts
 var BLOCKS = "\u2581\u2582\u2583\u2584\u2585\u2586\u2587\u2588";
 var HEADER_LINES = 6;
@@ -20665,6 +20726,7 @@ function stepChoice(choices, current, direction) {
 // src/dashboard/Dashboard.tsx
 var import_jsx_runtime = __toESM(require_jsx_runtime(), 1);
 var SERVICE_ROWS = ["Skip", "Timeout"];
+var NOTIFY_ROW = SETTING_ROWS.length;
 var TIMEOUT_ROW = SERVICE_ROWS.indexOf("Timeout");
 var NO_TIMEOUTS = {};
 var MARKER_WIDTH = 2;
@@ -20691,6 +20753,7 @@ function Dashboard({
   onTimeoutChange,
   onOpen,
   onCopy,
+  onNotify,
   serviceFields,
   onServiceWrite
 }) {
@@ -20717,6 +20780,20 @@ function Dashboard({
     void saved?.then(setUnsaved);
   };
   const { intervalMs, timeoutMs } = settings;
+  const known = (0, import_react36.useRef)(/* @__PURE__ */ new Map());
+  const notifying = (0, import_react36.useRef)(false);
+  notifying.current = settings.notify === true;
+  const warned = (0, import_react36.useRef)(false);
+  const tell = (next) => {
+    const { known: now, changes } = stateChanges(known.current, next);
+    known.current = now;
+    if (!notifying.current || changes.length === 0) return;
+    void onNotify?.(changeMessage(changes)).then((warning) => {
+      if (warning === void 0 || warned.current) return;
+      warned.current = true;
+      setNotice(warning);
+    });
+  };
   (0, import_react36.useEffect)(() => {
     const controller = new AbortController();
     const { signal } = controller;
@@ -20725,6 +20802,7 @@ function Dashboard({
         const next = await check2(signal, timeoutMs, skipped, timeouts);
         if (signal.aborted) return;
         setLatest(next);
+        tell(next);
         setHistory((before) => recordLatencies(before, next));
         await new Promise((resolve) => {
           const timer = setTimeout(resolve, intervalMs);
@@ -20793,10 +20871,9 @@ ${outcome.warning}` : done);
   };
   const change = (rowIndex, direction) => {
     const row = SETTING_ROWS[rowIndex];
-    if (!row) return;
-    const value = stepChoice(row.choicesMs, settings[row.key], direction);
-    if (value === settings[row.key]) return;
-    const next = { ...settings, [row.key]: value };
+    if (!row && rowIndex !== NOTIFY_ROW) return;
+    const next = row ? { ...settings, [row.key]: stepChoice(row.choicesMs, settings[row.key], direction) } : { ...settings, notify: !settings.notify };
+    if (row && next[row.key] === settings[row.key]) return;
     setSettings(next);
     track(onSettingsChange?.(next));
   };
@@ -20890,7 +20967,7 @@ ${outcome.warning}` : done);
     } else if (key === "escape" || (panel.kind === "options" ? input === "o" : enter))
       setPanel(null);
     else if (up2 || down) {
-      const lastRow = (panel.kind === "options" ? SETTING_ROWS : SERVICE_ROWS).length - 1;
+      const lastRow = panel.kind === "options" ? NOTIFY_ROW : SERVICE_ROWS.length - 1;
       setPanel({ ...panel, row: Math.max(0, Math.min(lastRow, panel.row + (down ? 1 : -1))) });
     } else if (left || right) {
       if (panel.kind === "options") change(panel.row, right ? 1 : -1);
@@ -20981,7 +21058,10 @@ ${outcome.warning}` : done);
     room: (windowRows || DEFAULT_ROWS) - taken - (unsaved === void 0 ? 0 : 1)
   }) : [];
   const toned = ({ text, tone }) => tone === "good" ? colors.green(text) : tone === "bad" ? colors.red(text) : tone === "dim" ? colors.dim(text) : text;
-  const panelRows = panel?.kind === "options" ? SETTING_ROWS.map((row) => [row.label, seconds(settings[row.key])]) : panel ? [
+  const panelRows = panel?.kind === "options" ? [
+    ...SETTING_ROWS.map((row) => [row.label, seconds(settings[row.key])]),
+    ["Notify", settings.notify ? "on" : "off"]
+  ] : panel ? [
     ["Skip", skipped.has(panel.name) ? "yes" : "no"],
     [
       "Timeout",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninhache/probe",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Health checks for your local dev services, from the CLI or a generated Makefile",
   "license": "MIT",
   "author": "Ninhache",