Changeset 7a235bc in Klonkt

Timestamp:

06/25/2026 05:56:08 PM (3 months ago)

Author:

Robin Genis <roboburr@…>

Branches:

main

Children:

f0c3f83

Parents:

6a51968

Message:

feat(updates): make the in-app updater GitHub/upstream-aware for self-hosters

The Updates page checked a hardcoded bare repo (KLONKT_GIT_DIR) that only exists on
Robin's VPS fleet, so a GitHub-clone install logged 'fatal: not a git repository' and
couldn't show its version. Now it auto-detects topology: a git CHECKOUT (app dir has
.git, origin=GitHub) checks origin/<branch> (fetched on view); the BARE-repo fleet is
unchanged. git stderr is ignored so a foreign/missing repo never spams the console.
External installs can't self-update in-app (klonkt-update needs root for systemd), so
the page shows the 'sudo klonkt-update' command instead of a button. Fleet keeps the
detached-script button.

Co-Authored-By: Claude <noreply@…>

Location:

src

Files:

• routes/admin-updates.js (modified) (5 diffs)
• services/i18n.js (modified) (3 diffs)
• views/pages/admin-updates.ejs (modified) (3 diffs)

src/routes/admin-updates.js

@@ -1 +1 @@
 /**
  * Admin: Updates (god-only).
- * Git-based v1 for instances running from a bare repo.
  *   GET  /admin/updates      -> current vs. latest version + status
- *   POST /admin/updates/run  -> fetch latest main + restart (detached script)
+ *   POST /admin/updates/run  -> fetch latest + restart (fleet only; see below)
  *
- * The instance knows its "current" commit from .klonkt-version (written by the
- * script) and the "latest" from the bare repo (KLONKT_GIT_DIR). For external
- * self-hosters a SIGNED release feed will follow later (see monetization plan);
- * this v1 is intentionally simple and only for Robin's own VPS instances.
+ * Two topologies are supported, detected automatically:
+ *   - CHECKOUT (external self-hoster): the app dir is itself a git clone with
+ *     origin = GitHub. "Latest" = origin/<branch> (fetched on view). Updating is
+ *     done out-of-band by `klonkt-update` (needs root for systemd), so the page
+ *     shows that command instead of an in-app button.
+ *   - BARE (Robin's own VPS fleet): a bare repo at KLONKT_GIT_DIR; the app dir is
+ *     a `checkout -f` work-tree (no .git). "Latest" = <branch>. The detached
+ *     self-update script runs in-app (no root needed) → the button works.
+ * git stderr is ignored so a foreign/missing repo never spams "fatal: ...".
  */
 
@@ -21 +25 @@
 
 const HOME = process.env.HOME || '';
+const APP_DIR = process.cwd();
+const BRANCH = process.env.KLONKT_BRANCH || 'main';
 const GIT_DIR = process.env.KLONKT_GIT_DIR || path.join(HOME, 'git-repos/prutfolio.git');
 const UPDATE_SCRIPT = process.env.KLONKT_UPDATE_SCRIPT || path.join(HOME, 'bin/klonkt-self-update.sh');
 
-function versionFile() { return path.join(process.cwd(), '.klonkt-version'); }
+// The app dir is a git CHECKOUT (GitHub install) when it has a .git; otherwise we
+// fall back to the BARE repo (fleet). This split keeps the version check pointed at
+// a repo that actually exists, so it never logs "fatal: not a git repository".
+const IS_CHECKOUT = (() => { try { return fs.existsSync(path.join(APP_DIR, '.git')); } catch { return false; } })();
+const REMOTE_REF = IS_CHECKOUT ? `origin/${BRANCH}` : BRANCH; // what "latest" resolves to
+
 function appVersion() {
-  try { return JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8')).version || null; }
+  try { return JSON.parse(fs.readFileSync(path.join(APP_DIR, 'package.json'), 'utf8')).version || null; }
   catch { return null; }
 }
+// stderr is ignored on purpose → a missing/foreign repo fails silently (returns null).
 function git(args) {
-  try { return execFileSync('git', ['--git-dir', GIT_DIR, ...args], { encoding: 'utf8', timeout: 5000 }).trim(); }
-  catch { return null; }
+  try {
+    const base = IS_CHECKOUT ? ['-C', APP_DIR] : ['--git-dir', GIT_DIR];
+    return execFileSync('git', [...base, ...args], { encoding: 'utf8', timeout: 8000, stdio: ['ignore', 'pipe', 'ignore'] }).trim();
+  } catch { return null; }
 }
 function currentSha() {
-  try { return fs.readFileSync(versionFile(), 'utf8').trim() || null; } catch { return null; }
+  if (IS_CHECKOUT) return git(['rev-parse', 'HEAD']);
+  try { return fs.readFileSync(path.join(APP_DIR, '.klonkt-version'), 'utf8').trim() || null; } catch { return null; }
 }
 
-// Last 5 commits on main = the "recent changes" you'll get when updating.
+// Last 5 commits = the "recent changes" you'll get when updating.
 function recentChanges() {
-  const out = git(['log', '-5', '--format=%s%x1f%cd', '--date=short', 'main']);
+  const out = git(['log', '-5', '--format=%s%x1f%cd', '--date=short', REMOTE_REF]);
   if (!out) return [];
   return out.split('\n').map((l) => {
@@ -48 +63 @@
 
 router.get('/', requireGod, (req, res) => {
+  // For a GitHub checkout, refresh the remote ref so "latest" is current. Quiet +
+  // shallow; offline just leaves the last-known ref. stderr ignored (no log noise).
+  if (IS_CHECKOUT) {
+    try { execFileSync('git', ['-C', APP_DIR, 'fetch', '--quiet', '--depth', '1', 'origin', BRANCH], { timeout: 20000, stdio: 'ignore' }); } catch { /* offline / no remote */ }
+  }
   const cur = currentSha();
-  const latest = git(['rev-parse', 'main']);
+  const latest = git(['rev-parse', REMOTE_REF]);
+  // The in-app "Update now" button only works with the detached self-update script
+  // (the fleet). A systemd install updates via `klonkt-update` (root) → show that.
+  const canSelfUpdate = (() => { try { return fs.existsSync(UPDATE_SCRIPT); } catch { return false; } })();
   renderPage(req, res, 'pages/admin-updates', {
     pageTitle: 'Updates',
@@ -57 +80 @@
     currentDesc: cur ? git(['log', '-1', '--format=%s · %cd', '--date=short', cur]) : null,
     latestSha: latest ? latest.slice(0, 8) : null,
-    latestDesc: latest ? git(['log', '-1', '--format=%s · %cd', '--date=short', 'main']) : null,
+    latestDesc: latest ? git(['log', '-1', '--format=%s · %cd', '--date=short', REMOTE_REF]) : null,
     upToDate: !!(cur && latest && cur === latest),
     canCheck: !!latest,
-    behind: (cur && latest && cur !== latest) ? git(['rev-list', '--count', cur + '..main']) : null,
+    canSelfUpdate,
+    manualCommand: (!canSelfUpdate && IS_CHECKOUT) ? 'sudo klonkt-update' : null,
+    behind: (cur && latest && cur !== latest) ? git(['rev-list', '--count', cur + '..' + REMOTE_REF]) : null,
     changes: recentChanges(),
     success: req.query.success || null,
@@ -69 +94 @@
 router.post('/run', requireGod, (req, res) => {
   if (!fs.existsSync(UPDATE_SCRIPT)) {
-    return res.redirect('/admin/updates?error=' + encodeURIComponent('Update-script ontbreekt op de server.'));
+    return res.redirect('/admin/updates?error=' + encodeURIComponent('In-app updaten is hier niet beschikbaar — werk bij met `klonkt-update` op de server.'));
   }
   try {
-    // Detached + unlinked: survives the pm2-reload that restarts this app.
-    const child = spawn('bash', [UPDATE_SCRIPT, process.cwd()], { detached: true, stdio: 'ignore' });
+    // Detached + unlinked: survives the reload that restarts this app.
+    const child = spawn('bash', [UPDATE_SCRIPT, APP_DIR], { detached: true, stdio: 'ignore' });
     child.unref();
   } catch (e) {

src/services/i18n.js

@@ -628 +628 @@
     'aupd.update_now': 'Nu bijwerken',
     'aupd.help': 'Bijwerken haalt de nieuwste code op en herstart deze site kort (~10s). Doe dit rustig — er gaat niets verloren (je posts, instellingen en cirkel blijven staan).',
+    'aupd.manual_hint': 'Werk bij vanaf GitHub door dit op je server uit te voeren:',
     'aepk.title': 'Perskit bewerken',
     'aepk.back_admin': 'Beheer',
@@ -1625 +1626 @@
     'aupd.update_now': 'Update now',
     'aupd.help': 'Updating fetches the latest code and restarts this site briefly (~10s). Take your time — nothing is lost (your posts, settings and circle stay intact).',
+    'aupd.manual_hint': 'Update from GitHub by running this on your server:',
     'aepk.title': 'Edit press kit',
     'aepk.back_admin': 'Admin',
@@ -2621 +2623 @@
     'aupd.update_now': 'Jetzt aktualisieren',
     'aupd.help': 'Das Aktualisieren holt den neuesten Code und startet diese Seite kurz neu (~10s). Lass dir Zeit — es geht nichts verloren (deine Beiträge, Einstellungen und dein Zirkel bleiben erhalten).',
+    'aupd.manual_hint': 'Aktualisiere von GitHub, indem du dies auf deinem Server ausführst:',
     'aepk.title': 'Pressekit bearbeiten',
     'aepk.back_admin': 'Verwaltung',

src/views/pages/admin-updates.ejs

@@ -38 +38 @@
     </div>
 
-    <% if (canCheck) { %>
+    <% if (canCheck && canSelfUpdate) { %>
     <form method="post" action="/admin/updates/run" class="set-form"
           onsubmit="return confirm('<%= t('aupd.run_confirm') %>');">
@@ -45 +45 @@
       </button>
     </form>
+    <% } else if (typeof manualCommand !== 'undefined' && manualCommand && !upToDate) { %>
+    <p class="set-help" style="margin:.2rem 0 .45rem"><%= t('aupd.manual_hint') %></p>
+    <pre class="upd-cmd"><code><%= manualCommand %></code></pre>
     <% } %>
 
@@ -76 +79 @@
 .upd-desc { color: var(--ink-muted); }
 .upd-status { margin: 1.1rem 0; }
+.upd-cmd { background: var(--paper); border: 1px solid var(--rule); border-radius: 6px; padding: .6rem .8rem; margin: 0; overflow-x: auto; }
+.upd-cmd code { font-size: .9em; }
 .upd-badge { font-size: .8rem; font-weight: 700; padding: .25rem .7rem; border-radius: 20px; }
 .upd-badge.ok { background: #d1fae5; color: #065f46; }