@yaroslavhaidash/gitstats-cli 0.2.1 → 0.3.0

package/README.md

@@ -14,4 +14,4 @@ What leaves the machine, per repo: an HMAC-SHA256 of the normalised remote URL k
 
 You are trusting the operator: `npx github:…` runs the committed `dist/` from this repo. Read `src/cli.ts` (~400 lines) or watch the payload with a proxy.
 
-Commands: `sync` · `status` · `add <path>` · `roots add <dir>` · `emails add <email>` · `names on|off` · `unlink` (also revokes server-side). Config lives in `~/.gitstats/config.json` (mode 600).
+Commands: `sync` · `status` · `add <path>` · `roots add <dir>` · `emails add <email>` · `names on|off` · `update` · `unlink` (also revokes server-side). It keeps itself up to date: every sync checks npm at most once a day and installs a newer version before finishing, `sync --no-update` skips that. Config lives in `~/.gitstats/config.json` (mode 600).

package/dist/cli.js

@@ -5,20 +5,21 @@
  *
  *   npx @yaroslavhaidash/gitstats-cli@latest link
  *                             pair this computer, scan for repos, sync, install a daily sync
- *   gitstats sync             fetch each repo's default branch, recount the last year, upload (idempotent; --no-fetch to skip)
+ *   gitstats sync             fetch each repo's default branch, recount the last year, upload (idempotent;
+ *                             --no-fetch skips the fetch, --no-update skips the daily version check)
  *   gitstats status           show what is linked and when it last ran
  *   gitstats add <path>       track a repo outside the scanned folders
  *   gitstats roots add <dir>  scan another folder (e.g. one outside your home directory)
  *   gitstats emails add <e>   attribute commits made with another email to you
  *   gitstats names on|off     also send repo names (off by default; your own page then labels private repos by hash)
  *   gitstats pause | resume   stop / restart the background sync without unlinking
- *   gitstats update           fetch the latest published version and replace the installed copy
+ *   gitstats update           fetch the latest published version now (sync does this on its own, once a day)
  *   gitstats unlink           revoke this computer and remove the schedule and local config
  */
 import { spawnSync } from "node:child_process";
 import { createHmac } from "node:crypto";
 import { createInterface } from "node:readline/promises";
-import { existsSync, mkdirSync, mkdtempSync, readdirSync, readFileSync, statSync, writeFileSync, rmSync, cpSync } from "node:fs";
+import { appendFileSync, existsSync, mkdirSync, mkdtempSync, readdirSync, readFileSync, statSync, writeFileSync, rmSync, cpSync } from "node:fs";
 import { homedir, hostname, platform, tmpdir } from "node:os";
 import { basename, dirname, join, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
@@ -30,12 +31,26 @@ const CONFIG = join(DIR, "config.json");
 const SELF = join(DIR, "cli");
 const DAYS = 365;
 const PENDING_DAYS = 30;
+const SYNC_LOG = join(DIR, "sync.log");
+const UPDATE_EVERY_MS = 24 * 60 * 60 * 1000;
+const REGISTRY = `https://registry.npmjs.org/${PKG.replace("/", "%2F")}/latest`;
 const SKIP_DIRS = new Set(["node_modules", "Library", "Applications", ".Trash", "vendor", "target", "build", "dist", ".venv", "venv", "__pycache__", "Pods", "DerivedData", "go", ".cargo", ".rustup", ".npm", ".cache", ".local", "snap", "AppData"]);
 const args = process.argv.slice(2);
 const cmd = args[0] ?? "help";
 function log(msg) {
     console.log(msg);
 }
+/** Background runs already redirect their output here; a manual run appends directly so a failed
+ *  update check leaves the same trail either way. */
+function logFile(msg) {
+    try {
+        mkdirSync(DIR, { recursive: true });
+        appendFileSync(SYNC_LOG, `${new Date().toISOString()} ${msg}\n`);
+    }
+    catch {
+        /* the log is best effort; it must never break a sync */
+    }
+}
 function loadConfig() {
     if (!existsSync(CONFIG))
         return null;
@@ -294,7 +309,7 @@ function count(c, since) {
 }
 async function upload(c, reports) {
     const payload = reports.map(({ remoteHash, name, language, weeks, days, pending }) => ({ remoteHash, name, language, weeks, days, pending }));
-    const { status, body } = await post(c.server, "/api/ingest", { repos: payload }, c.token);
+    const { status, body } = await post(c.server, "/api/ingest", { cliVersion: runningVersion(), repos: payload }, c.token);
     if (status !== 200 || !body) {
         c.lastSync = { at: new Date().toISOString(), repos: 0, weeks: 0, error: `server answered ${status}` };
         saveConfig(c);
@@ -302,9 +317,14 @@ async function upload(c, reports) {
     }
     c.lastSync = { at: new Date().toISOString(), repos: body.repos, weeks: body.weeks };
     saveConfig(c);
+    if (body.outdated)
+        log(`this computer runs ${runningVersion()}; the board expects ${body.minVersion} or newer — run \`gitstats update\``);
     return body;
 }
 async function sync(c, quiet = false) {
+    const restarted = await selfUpdate(c);
+    if (restarted !== null)
+        process.exit(restarted);
     const since = new Date(Date.now() - DAYS * 86_400_000).toISOString().slice(0, 10);
     const { scanned, reports } = count(c, since);
     const body = await upload(c, reports);
@@ -336,9 +356,9 @@ function writeShim() {
     }
     return script;
 }
-function installedVersion() {
+function readVersion(pkgRoot) {
     try {
-        const pkg = JSON.parse(readFileSync(join(SELF, "package.json"), "utf8"));
+        const pkg = JSON.parse(readFileSync(join(pkgRoot, "package.json"), "utf8"));
         const v = typeof pkg === "object" && pkg !== null ? pkg.version : null;
         return typeof v === "string" ? v : "unknown";
     }
@@ -346,6 +366,24 @@ function installedVersion() {
         return "unknown";
     }
 }
+function installedVersion() {
+    return readVersion(SELF);
+}
+/** The copy that is executing right now — an npx run is not the installed one. */
+function runningVersion() {
+    return readVersion(resolve(dirname(fileURLToPath(import.meta.url)), ".."));
+}
+/** Numeric semver compare; a pre-release suffix is ignored, this package never ships one. */
+function isNewer(candidate, current) {
+    const parts = (v) => v.split(/[-+]/)[0].split(".").map((n) => Number.parseInt(n, 10) || 0);
+    const a = parts(candidate);
+    const b = parts(current);
+    for (let i = 0; i < 3; i++) {
+        if ((a[i] ?? 0) !== (b[i] ?? 0))
+            return (a[i] ?? 0) > (b[i] ?? 0);
+    }
+    return false;
+}
 /**
  * Replace ~/.gitstats/cli with the latest published package. The schedule points at an absolute
  * path inside it and the config lives beside it, so neither is touched.
@@ -388,6 +426,41 @@ function update() {
         rmSync(tmp, { recursive: true, force: true });
     }
 }
+/**
+ * Asks the registry for a newer version at most once a day, installs it and restarts the sync under
+ * it. Nothing here may fail a sync: offline, a registry error or a bad download is one log line and
+ * the current version carries on. `--no-update` skips the check entirely.
+ * Returns the exit code of the restarted sync, or null when this process should carry on itself.
+ */
+async function selfUpdate(c) {
+    if (args.includes("--no-update"))
+        return null;
+    const last = c.lastUpdateCheck ? Date.parse(c.lastUpdateCheck) : 0;
+    if (Number.isFinite(last) && Date.now() - last < UPDATE_EVERY_MS)
+        return null;
+    // Stamped before the fetch, so a registry that is down is retried tomorrow and not every sync.
+    c.lastUpdateCheck = new Date().toISOString();
+    saveConfig(c);
+    const current = runningVersion();
+    try {
+        const res = await fetch(REGISTRY, { signal: AbortSignal.timeout(5000) });
+        if (!res.ok)
+            throw new Error(`registry answered ${res.status}`);
+        const meta = await res.json();
+        const latest = typeof meta === "object" && meta !== null ? meta.version : null;
+        if (typeof latest !== "string")
+            throw new Error("registry sent no version");
+        if (!isNewer(latest, current))
+            return null;
+        update();
+        const fresh = spawnSync(process.execPath, [join(SELF, "dist", "cli.js"), "sync", "--quiet"], { stdio: "inherit" });
+        return fresh.status ?? 1;
+    }
+    catch (e) {
+        logFile(`update check failed (${e instanceof Error ? e.message : String(e)}); staying on ${current}`);
+        return null;
+    }
+}
 function installSchedule() {
     const script = installSelf();
     const node = process.execPath;
@@ -611,7 +684,7 @@ async function main() {
             return;
         }
         default:
-            log("usage: gitstats <link [--root <dir>]... [--yes] | sync | status | add <path> | roots add <dir> | emails add <email> | names on|off | pause | resume | update | unlink>");
+            log("usage: gitstats <link [--root <dir>]... [--yes] | sync [--no-fetch] [--no-update] | status | add <path> | roots add <dir> | emails add <email> | names on|off | pause | resume | update | unlink>");
     }
 }
 main().catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaroslavhaidash/gitstats-cli",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Counts your commits and lines locally and sends only the numbers to your gitstats board.",
   "license": "MIT",
   "type": "module",