@andrian.yablonskyy/thub-coordinator 1.1.16 → 1.1.17

package/README.md

@@ -172,7 +172,7 @@ The Coordinator's own version (`ver. X.Y.Z`) is shown under the TestHub logo, to
 **Versions and self-update.** The Coordinator checks the npm registry for the latest Coordinator, Agent and Client every `updates.checkIntervalMin` (default 15 minutes, `0` disables; the older `checkIntervalHours` is ignored; `updates.registry` for a private mirror) and immediately with the navbar's **check for updates** button (admins; also on the Agents and Resources pages), which reports in a toast whether the Coordinator is current and which connected resources can update their Client. A newer Coordinator shows as an **Update app to X.Y.Z** button in the navbar for admins (a badge under the logo for viewers); Agents and Resources show each one's version with an **update available** or pending **→ vX.Y.Z** badge. Admins request self-updates per agent/resource (**Update**, which becomes **Cancel update**) or with **Update all agents** / **Update all clients**, always to the latest version:
 - Clients get a `self-update` command on their next heartbeat and install it through their root `thub-client-update` helper, once none of the host's instances is busy.
 - Agents install it at the start of their next run (`GET /api/v1/agents/me/update`), then re-run the command on the new version.
-- The Coordinator itself, only when started with `--self-update` (off by default; under systemd add it to the unit's `ExecStart`, a re-install keeps it): the **Update app** button writes `<dataDir>/update-request.json`; the root `thub-coordinator-update.path` unit (installed by `sudo npm i -g`) runs `npm i -g` for it, and the postinstall restarts the service (the dashboard and API are briefly down). Logs: `journalctl -u thub-coordinator-update`. Without that unit, use `thub-admin self-update` on the host.
+- The Coordinator itself, only when started with `--self-update` (a systemd install has it; elsewhere, e.g. in a container, it's off and the dashboard shows nothing about Coordinator updates): the **Update app** button writes `<dataDir>/update-request.json`; the root `thub-coordinator-update.path` unit (installed by `sudo npm i -g`) runs `npm i -g` for it, and the postinstall restarts the service (the dashboard and API are briefly down). Logs: `journalctl -u thub-coordinator-update`. Without that unit, use `thub-admin self-update` on the host.
 
 A request is cleared when the Agent/Client reports the new version.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andrian.yablonskyy/thub-coordinator",
-  "version": "1.1.16",
+  "version": "1.1.17",
   "description": "TestHub Coordinator — job queue, resource registry, scheduler, heartbeat monitor, log/artifact store and web dashboard",
   "main": "src/server.js",
   "engines": {

package/scripts/install-systemd-unit.js

@@ -34,23 +34,15 @@ const fs = require('node:fs'),
 // The checked-in unit only has placeholders — fill in the target user and
 // wherever *this* install's node and server.js actually are, so it works
 // regardless of npm prefix or an nvm-managed Node.
-// `--self-update` (README §10.2) is off by default; once added to the
-// installed unit's ExecStart, a re-install keeps it there.
-function selfUpdateFlag(existingUnit = UNIT_DEST){
-  try {
-    return /^ExecStart=.*\s--self-update(\s|$)/m.test(fs.readFileSync(existingUnit, 'utf8')) ? ' --self-update' : '';
-  }
-  catch {
-    return '';
-  }
-}
-
 function renderUnit(user, paths){
   return fs.readFileSync(UNIT_SRC, 'utf8')
     .replace(/^User=.*$/m, `User=${user.name}`)
     .replace(/^Group=.*$/m, `Group=${user.gid}`)
     .replace(/^Environment=THUB_COORDINATOR_CONFIG=.*$/m, `Environment=THUB_COORDINATOR_CONFIG=${paths.configPath}`)
-    .replace(/^ExecStart=.*$/m, `ExecStart=${process.execPath} ${SERVER_PATH}${selfUpdateFlag()}`)
+    // --self-update: the dashboard's "Update app" (README §10.2), through the
+    // root thub-coordinator-update units installed below — on for a systemd
+    // install. To turn it off, override ExecStart in a drop-in.
+    .replace(/^ExecStart=.*$/m, `ExecStart=${process.execPath} ${SERVER_PATH} --self-update`)
     .replace(/^ReadWritePaths=.*$/m, `ReadWritePaths=${[paths.dataDir, paths.dbDir].filter(Boolean).join(' ')}`);
 }
 

package/src/web/routes.js

@@ -807,9 +807,13 @@ function createWebRouter({ services, config }){
       return { type: 'danger', text: `Update check failed — the npm registry couldn't be reached (${s.error}). Nothing was checked.` };
     }
 
-    parts.push(s.coordinatorUpdate
-      ? `Coordinator v${s.coordinatorVersion} → v${s.coordinatorUpdate} available.`
-      : `Coordinator is up to date (v${s.coordinatorVersion}).`);
+    // The Coordinator's own version only when it can update itself
+    // (--self-update); Agents and Clients are always reported.
+    if (s.selfUpdate){
+      parts.push(s.coordinatorUpdate
+        ? `Coordinator v${s.coordinatorVersion} → v${s.coordinatorUpdate} available.`
+        : `Coordinator is up to date (v${s.coordinatorVersion}).`);
+    }
 
     const connected = services.registry.list().filter((r) => r.status !== RESOURCE_STATES.OUT_OF_SERVICE && r.last_heartbeat_at),
       outdated = connected.filter((r) => r.client_version && isNewer(s.latest.client, r.client_version)),
@@ -834,7 +838,7 @@ function createWebRouter({ services, config }){
     if (s.error){
       parts.push(`Some checks failed: ${s.error}`);
     }
-    const behind = s.coordinatorUpdate || outdated.length || unknown.length;
+    const behind = (s.selfUpdate && s.coordinatorUpdate) || outdated.length || unknown.length;
     return { type: behind || s.error ? 'warning' : 'success', text: parts.join('\n') };
   }));
 

package/systemd/thub-coordinator.service

@@ -3,8 +3,10 @@ Description=TestHub Coordinator
 After=network-online.target
 Wants=network-online.target
 
-# Add --self-update to ExecStart to let admins update the Coordinator from
-# the dashboard ("Update app", README §10.2); a re-install keeps it.
+# --self-update lets admins update the Coordinator from the dashboard
+# ("Update app", README §10.2) through thub-coordinator-update.path. To turn
+# it off: sudo systemctl edit thub-coordinator, then [Service], ExecStart=
+# (empty) and ExecStart=<the same line without --self-update>.
 # User, Group, THUB_COORDINATOR_CONFIG, ReadWritePaths and ExecStart are
 # rewritten by scripts/install-systemd-unit.js at install time to the user
 # who ran `sudo npm i -g` and this install's real node/server.js paths.
@@ -13,7 +15,7 @@ Type=simple
 User=thub
 Group=thub
 Environment=THUB_COORDINATOR_CONFIG=/var/lib/thub/.config/thub/coordinator.json
-ExecStart=/usr/bin/node /usr/lib/node_modules/@andrian.yablonskyy/thub-coordinator/src/server.js
+ExecStart=/usr/bin/node /usr/lib/node_modules/@andrian.yablonskyy/thub-coordinator/src/server.js --self-update
 Restart=always
 RestartSec=2
 NoNewPrivileges=yes

package/test/updates.test.js

@@ -105,9 +105,11 @@ test('on startup, a finished update\'s status is cleared; a failure is kept for
   assert.equal(fs.existsSync(statusFile), true);
 });
 
-test('self-update is off unless the Coordinator was started with --self-update: no request, no button', async (t) => {
+test('without --self-update: no request, no Coordinator check or button; Agents and Clients keep theirs', async (t) => {
   const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'thub-updates-')),
-    updates = createUpdatesService({ config: { dataDir, updates: {} }, pathUnit: path.join(dataDir, 'fake.path'), fetchLatest: async () => '99.0.0' });
+    updates = createUpdatesService({
+      config: { dataDir, updates: {} }, pathUnit: path.join(dataDir, 'fake.path'), fetchLatest: async () => '99.0.0'
+    });
   fs.writeFileSync(path.join(dataDir, 'fake.path'), '');
   await updates.checkNow();
   assert.equal(updates.status().selfUpdate, false);
@@ -123,7 +125,9 @@ test('self-update is off unless the Coordinator was started with --self-update:
   for (const selfUpdate of [false, true]){
     const config = { ...loadConfig(file), selfUpdate },
       services = buildServices(config);
-    services.updates.checkNow = async () => {};
+    services.updates.checkNow = async () => ({
+      fetched: ['coordinator', 'client'], latest: { client: '9.9.9' }, coordinatorVersion: '1.0.0', coordinatorUpdate: '99.0.0', selfUpdate
+    });
     Object.assign(services.updates, { status: () => ({ latest: {}, coordinatorVersion: '1.0.0', coordinatorUpdate: '99.0.0', selfUpdate }) });
     services.adminUsers.create({ username: `root${selfUpdate}`, email: `r${selfUpdate}@example.com`, role: 'admin', password: 'pw' }, { by: 't' });
     const server = createApp(config, services).listen(0, '127.0.0.1');
@@ -137,7 +141,19 @@ test('self-update is off unless the Coordinator was started with --self-update:
         method: 'POST', body: new URLSearchParams({ username: `root${selfUpdate}`, password: 'pw' }), redirect: 'manual'
       })).headers.get('set-cookie').split(';')[0],
       html = await (await fetch(`${base}/runners`, { headers: { cookie } })).text();
+    // The Coordinator's own: Update app and the navbar's check — only with --self-update.
     assert.equal(/action="\/updates\/coordinator"/.test(html), selfUpdate, `Update app button with selfUpdate=${selfUpdate}`);
-    assert.match(html, /v99\.0\.0 available|Update app to 99\.0\.0/);
+    assert.equal(/action="\/updates\/check" data-submit-busy/.test(html), selfUpdate, `navbar update check with selfUpdate=${selfUpdate}`);
+    assert.equal(/99\.0\.0/.test(html.slice(0, html.indexOf('<main'))), selfUpdate); // nothing about a new Coordinator in the navbar
+    // Clients' (and Agents') check and update-all: always.
+    assert.match(html, /<form class="d-inline" method="post" action="\/updates\/check">/);
+    assert.match(html, /action="\/runners\/update-all"/);
+    // "Check for updates" (Runners page): Clients always, the Coordinator only with --self-update.
+    const check = await fetch(`${base}/updates/check`, {
+        method: 'POST', headers: { cookie }, body: new URLSearchParams({ returnTo: '/runners' }), redirect: 'manual'
+      }),
+      toast = await (await fetch(`${base}${check.headers.get('location')}`, { headers: { cookie } })).text();
+    assert.match(toast, /No connected runners|connected runner/);
+    assert.equal(/Coordinator v1\.0\.0 → v99\.0\.0 available/.test(toast), selfUpdate);
   }
 });

package/views/help/_coordinator.pug

@@ -13,7 +13,7 @@
     #[code ~/.config/thub/coordinator.json] (with a random #[code sessionSecret]) and
     #[code ~/var/lib/thub] (database, avatars). It installs, enables and starts
     #[code thub-coordinator.service], plus the root helper behind the navbar's #[strong Update app] button
-    (off unless the Coordinator runs with #[code --self-update]; see Updates below).
+    (the unit starts the Coordinator with #[code --self-update]; see Updates below).
     The unit uses #[code ProtectSystem=strict] with #[code PrivateTmp=yes], so the data directory and a
     private #[code /tmp] (SQLite's temp files) are the only places the service can write.
 
@@ -176,11 +176,10 @@
   h3.h6 Updates
   p.small.mb-0.
     The Coordinator checks npm for new Coordinator, Agent and Client versions. Admins update Agents and Clients
-    from the #[a(href="/admin/agents") Agents] and #[a(href="/runners") Runners] pages; Clients install an update
-    only between jobs. Updating the #[strong Coordinator] from the dashboard (#[strong Update app] in the navbar)
-    is #[strong off by default]: start it with #[code --self-update] to turn it on. Under systemd:
-    #[code sudo sed -i 's|server.js$|server.js --self-update|' /etc/systemd/system/thub-coordinator.service],
-    then #[code sudo systemctl daemon-reload && sudo systemctl restart thub-coordinator] (a re-install keeps it).
-    Without it, a #[strong vX.Y.Z available] badge shows; update by hand — #[code thub-admin self-update],
-    #[code sudo npm i -g …], or a new container image. Manual alternatives for the others:
-    #[code thub self-update] and #[code thub-client self-update].
+    from the #[a(href="/admin/agents") CI tokens] and #[a(href="/runners") Runners] pages (always there); Clients install
+    an update only between jobs. The #[strong Coordinator]'s own update (the navbar's check for updates and
+    #[strong Update app]) is there only when it runs with #[code --self-update]. A systemd install has it on
+    (#[code sudo npm i -g] writes it into the unit); to turn it off, override #[code ExecStart] in a drop-in
+    (#[code sudo systemctl edit thub-coordinator]). Started any other way, e.g. in a container, it's off and the dashboard
+    shows nothing about Coordinator updates: update it by hand (#[code thub-admin self-update], #[code sudo npm i -g …])
+    or with a new image. Manual alternatives for the others: #[code thub self-update] and #[code thub-client self-update].

package/views/help/_kubernetes.pug

@@ -2,8 +2,8 @@
   p.
     The Coordinator runs as one container: the published package in a Node.js image, its SQLite database on a
     persistent volume, TLS at the ingress. Clients and Agents connect from outside at #[code publicUrl].
-    Self-update stays off: the image starts the Coordinator without #[code --self-update], and you update it by
-    deploying a new image tag.
+    Self-update stays off: the image starts the Coordinator without #[code --self-update], so the dashboard shows
+    nothing about Coordinator updates; you update it by deploying a new image tag.
 
   h3.h6 1. Build the image
   +code('Dockerfile').
@@ -160,7 +160,7 @@
   h3.h6 Things to know
   ul.small
     li #[strong One replica.] One SQLite file and an in-process scheduler: no scale-out, no HPA. #[code Recreate] means a few seconds of downtime per upgrade; Clients and Agents reconnect by themselves.
-    li #[strong Updating:] deploy a new image tag. Migrations run on the new pod's first start. #[strong Update app] stays off (no #[code --self-update]); admins see a #[strong vX.Y.Z available] badge. Agents and Clients still update from the dashboard.
+    li #[strong Updating:] deploy a new image tag. Migrations run on the new pod's first start. No #[code --self-update], so no Coordinator update check or #[strong Update app] on the dashboard. Agents and Clients still update from it.
     li #[strong Storage:] block storage (ReadWriteOnce), not NFS. A separate database volume: mount it and set #[code THUB_DB_PATH].
     li #[strong /tmp] is an #[code emptyDir]: SQLite needs a writable temp directory and the root filesystem is read-only.
     li #[strong Backups:] #[code kubectl -n thub exec deploy/thub-coordinator -- node -e "new (require('/app/node_modules/better-sqlite3'))('/var/lib/thub/thub.db').backup('/var/lib/thub/backup.db')"], then #[code kubectl cp].

package/views/layout.pug

@@ -29,12 +29,13 @@ html(lang="en" data-bs-theme=(user && user.theme) || "auto")
             data-bs-title=`Coordinator v${coordinatorVersion} · thub-common v${commonVersion} (validates job specs)`
           )
             | ver. #{coordinatorVersion}
-            //- Without --self-update (or for non-admins): just the notice.
-            if user && updates.coordinatorUpdate && !(can.admin && updates.selfUpdate)
+            //- With --self-update, for those who can't update it themselves.
+            //- Without it, nothing about Coordinator updates is shown.
+            if user && updates.selfUpdate && updates.coordinatorUpdate && !can.admin
               span.badge.text-bg-warning.ms-1(
                 data-bs-toggle="tooltip"
                 data-bs-placement="bottom"
-                data-bs-title=updates.selfUpdate ? 'An admin can update the Coordinator from the navbar' : 'Update the Coordinator by hand (thub-admin self-update, npm i -g, or a new container image); self-update from the dashboard is off'
+                data-bs-title="An admin can update the Coordinator from the navbar"
               )= `v${updates.coordinatorUpdate} available`
         button.navbar-toggler(type="button" data-bs-toggle="collapse" data-bs-target="#nav")
           span.navbar-toggler-icon
@@ -80,7 +81,9 @@ html(lang="en" data-bs-theme=(user && user.theme) || "auto")
                 )
                   i.bi.bi-question-circle.me-1
                   | Help
-            if user && can.operate
+            //- The Coordinator's own update check: only with --self-update.
+            //- (Agents and Clients are checked from their own pages, always.)
+            if user && can.operate && updates.selfUpdate
               li.nav-item.d-flex.align-items-center.me-2
                 form(method="post" action="/updates/check" data-submit-busy)
                   input(type="hidden" name="returnTo" value=currentPath)