@andrian.yablonskyy/thub-coordinator 1.0.37 → 1.0.39

package/views/help/index.pug

@@ -0,0 +1,67 @@
+extends ../layout
+include _mixins
+
+block content
+  -
+    const toc = [
+      { id: 'overview', label: 'Product overview' },
+      { id: 'use-cases', label: 'Use cases' },
+      { id: 'quick-start', label: 'Quick start' },
+      { id: 'coordinator', label: 'Coordinator setup' },
+      { id: 'agent-setup', label: 'Agent setup' },
+      { id: 'client-setup', label: 'Client setup' },
+      { id: 'client-machines', label: 'Client machines (HW / SW)' },
+      { id: 'docker', label: 'Docker registry' },
+      { id: 'git', label: 'Git repositories' },
+      { id: 'agent-cli', label: 'Agent CLI reference' },
+      { id: 'env', label: 'Environment variables' },
+      { id: 'ci', label: 'CI/CD (GitHub Actions)' },
+      { id: 'troubleshooting', label: 'Troubleshooting' }
+    ]
+
+  .row.g-4
+    .col-lg-3.d-none.d-lg-block
+      .thub-help-toc.sticky-top
+        input.form-control.form-control-sm.mb-3#help-filter(
+          type="search"
+          placeholder="Filter help…"
+          aria-label="Filter help sections"
+        )
+        nav.nav.nav-pills.flex-column#help-toc
+          each item in toc
+            a.nav-link.py-1(href=`#${item.id}` data-help-toc=item.id)= item.label
+        p.small.text-body-secondary.mt-3.mb-0
+          | Coordinator v#{coordinatorVersion} · examples use
+          br
+          code.small= coordinatorUrl
+
+    .col-lg-9
+      .d-flex.flex-wrap.align-items-center.justify-content-between.gap-2.mb-3
+        h1.h3.mb-0 TestHub help
+        //- Small screens have no sidebar: jump menu + filter instead.
+        .d-lg-none.d-flex.gap-2.w-100
+          select.form-select.form-select-sm#help-jump(aria-label="Jump to section")
+            each item in toc
+              option(value=item.id)= item.label
+          input.form-control.form-control-sm#help-filter-sm(type="search" placeholder="Filter…" aria-label="Filter help sections")
+      p.lead.
+        Everything needed to run TestHub: what it is, how to install and configure the
+        Coordinator, Agent and Client, how to prepare lab machines, and how jobs use Docker,
+        git and environment variables.
+      p.text-body-secondary.small#help-no-match(hidden) No section matches the filter.
+
+      include _overview
+      include _quick-start
+      include _coordinator
+      include _agent-setup
+      include _client-setup
+      include _client-machines
+      include _docker
+      include _git
+      include _agent-cli
+      include _env
+      include _ci
+      include _troubleshooting
+
+block scripts
+  script(src="/js/help.js")

package/views/index.pug

@@ -6,7 +6,8 @@ include mixins/updates
 block content
   h1.h4.mb-2 Overview
 
-  .row.g-3.mb-4
+  //- data-live: swapped in place when it changes (public/js/live.js).
+  .row.g-3.mb-4(data-live="overview-stats")
     .col-md-4
       .card
         .card-body
@@ -23,7 +24,7 @@ block content
           h6.card-subtitle.mb-2.text-body-secondary Resources online
           p.display-6= `${onlineCount} / ${resources.length}`
 
-  .row.g-3
+  .row.g-3(data-live="overview-cards")
     each r in resources
       .col-sm-6.col-md-4.col-lg-3
         .card.h-100(role="button" tabindex="0" data-resource-card=`resource-card-${r.id}` class=`border-${{IDLE:'success',BUSY:'primary',OUT_OF_SERVICE:'danger',MAINTENANCE:'secondary',REGISTERED:'secondary'}[r.status] || 'secondary'}`)

package/views/jobs/list.pug

@@ -11,7 +11,9 @@ block content
         button.btn.btn-sm.btn-outline-warning(type="button" data-bs-toggle="modal" data-bs-target="#reset-queue-modal") Reset queue
         button.btn.btn-sm.btn-outline-danger.ms-1(type="button" data-bs-toggle="modal" data-bs-target="#clean-history-modal") Clean up database
 
-  form.row.g-2.mb-3(method="get")
+  form.row.g-2.mb-3(method="get" role="search")
+    .col-12.col-md-5.col-lg-4
+      +searchBox(filters.q, 'Search jobs: id, user, resource, command, repo…', list.urlFor({ q: '' }))
     .col-auto
       select.form-select.form-select-sm(name="state" onchange="this.form.submit()")
         option(value="") any state
@@ -25,7 +27,8 @@ block content
     .col-auto.ms-auto
       +pageSizePicker(list)
 
-  +listToolbar(list, 'jobs')
+  div(data-live="list-toolbar")
+    +listToolbar(list, 'jobs')
 
   table.table.table-hover.align-middle
     thead
@@ -39,7 +42,7 @@ block content
         +sortHeader(list, 'duration', 'Duration', 'desc')
         if canManage
           th
-    tbody
+    tbody(data-live="rows")
       each j in jobs
         tr
           td: a(href=`/jobs/${j.id}`)= j.id
@@ -84,7 +87,7 @@ block content
           |
           code CANCELED
           | .
-        p.small.text-body-secondary.mb-0 Finished jobs, logs and artifacts are not touched.
+        p.small.text-body-secondary.mb-0 Finished jobs and their logs are not touched.
       else
         p.mb-0 There are no active jobs — nothing to cancel.
 
@@ -129,7 +132,7 @@ block content
             onclick="document.getElementById('cleanup-before').value = this.dataset.value"
           )= preset.label
       p
-        | Deletes finished jobs that ended before then, with their logs and artifacts (files too), and the resource, agent and group history logged before then — then compacts the database file.
+        | Deletes finished jobs that ended before then, with their logs, and the resource, agent and group history logged before then — then compacts the database file.
         |
         strong This cannot be undone.
         |  Active jobs are never touched.

package/views/jobs/show.pug

@@ -49,15 +49,5 @@ block content
       dt.col-sm-2 Message
       dd.col-sm-10= job.message
 
-  h2.h6.mt-4#artifacts Artifacts
-  if artifacts.length
-    ul.list-group
-      each a in artifacts
-        li.list-group-item.d-flex.justify-content-between
-          span= a.name
-          a(href=a.url) download
-  else
-    p.text-body-secondary No artifacts yet.
-
   h2.h6.mt-4 Log
   +logViewer(job.id, jobActive)

package/views/layout.pug

@@ -7,7 +7,9 @@ html(lang="en" data-bs-theme=(user && user.theme) || "auto")
     link(rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css")
     link(rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css")
     link(rel="stylesheet" href="/css/thub.css")
-  body
+  //- liveTopics (routes.js): the page updates itself when these change
+  //- (public/js/live.js, services/live.js).
+  body(data-live-topics=user && liveTopics ? liveTopics : false)
     nav.navbar.navbar-expand-lg.bg-body-tertiary.border-bottom
       .container-fluid
         a.navbar-brand.d-flex.flex-column.lh-1.py-1(href="/")
@@ -42,6 +44,24 @@ html(lang="en" data-bs-theme=(user && user.theme) || "auto")
                 li.nav-item
                   a.nav-link(href="/admin/agents" class=active === 'agents' ? 'active' : '') Agents
           ul.navbar-nav
+            if user && liveTopics
+              //- Live-update status, driven by public/js/live.js.
+              li.nav-item.d-flex.align-items-center.me-3
+                span#thub-live.thub-live.small.text-body-secondary(data-state="connecting" title="Connecting to live updates…" role="status")
+                  span.thub-live-dot(aria-hidden="true")
+                  span.thub-live-label Live
+            if user
+              li.nav-item.d-flex.align-items-center.me-2
+                a.nav-link.d-flex.align-items-center(
+                  href="/help"
+                  class=active === 'help' ? 'active' : ''
+                  aria-current=active === 'help' ? 'page' : false
+                  data-bs-toggle="tooltip"
+                  data-bs-placement="bottom"
+                  data-bs-title="Product guide, setup and CLI reference"
+                )
+                  i.bi.bi-question-circle.me-1
+                  | Help
             if user && user.role === 'admin'
               li.nav-item.d-flex.align-items-center.me-2
                 form(method="post" action="/updates/check" onsubmit="this.querySelector('button').disabled = true; this.querySelector('i').className = 'spinner-border spinner-border-sm';")
@@ -171,6 +191,9 @@ html(lang="en" data-bs-theme=(user && user.theme) || "auto")
     script(src="/js/toasts.js")
     script(src="/js/copy-to-clipboard.js")
     script(src="/js/confirm.js")
+    script(src="/js/list-search.js")
+    if user && liveTopics
+      script(src="/js/live.js")
     if user && user.role === 'admin' && updates.coordinatorPending
       script(src="/js/update-watch.js")
     block scripts

package/views/mixins/list-controls.pug

@@ -16,6 +16,38 @@ mixin pageSizePicker(list)
       each s in list.pageSizes
         option(value=list.urlFor({ size: s }) selected=list.prefs.size === s)= s === 'all' ? 'All' : s
 
+//- Search box (?q=) for a list page: every word must match (routes.js,
+//- services/search.js). Goes inside a GET form — the Jobs filter form, or
+//- +searchForm on its own. `/` focuses it, Esc clears (public/js/list-search.js).
+mixin searchBox(q, placeholder, clearUrl)
+  .input-group.input-group-sm.thub-search
+    span.input-group-text
+      i.bi.bi-search
+    input.form-control(
+      type="search"
+      name="q"
+      value=q
+      placeholder=placeholder
+      aria-label=placeholder
+      maxlength="200"
+      autocomplete="off"
+      data-list-search
+      data-bs-toggle="tooltip"
+      data-bs-title="Press Enter to search · / to focus · Esc to clear"
+    )
+    if q
+      a.btn.btn-outline-secondary(href=clearUrl aria-label="Clear search" data-list-search-clear)
+        i.bi.bi-x-lg
+
+mixin searchForm(q, placeholder, clearUrl)
+  form.m-0(method="get" role="search")
+    +searchBox(q, placeholder, clearUrl)
+
+//- "matching “foo”" after a list's count, when a search is active.
+mixin searchNote(q)
+  if q
+    |  matching “#{q}”
+
 //- Shown above the table: "Showing 26–50 of 312 jobs" and the page links.
 mixin listToolbar(list, noun)
   - const p = list.pagination
@@ -25,6 +57,10 @@ mixin listToolbar(list, noun)
         | Showing #{p.from}–#{p.to} of #{p.total} #{noun}
       else
         | No #{noun}
+      +searchNote(list.q)
+      if list.q
+        |  · 
+        a(href=list.urlFor({ q: '' })) show all
     if p.pages > 1
       +pager(list)
 

package/views/mixins/log-viewer.pug

@@ -1,12 +1,48 @@
 mixin logViewer(jobId, jobActive)
-  .mb-2
-    select#stream-filter.form-select.form-select-sm.w-auto.d-inline-block
+  //- Stream filter + search (public/js/log-viewer.js): matches are
+  //- highlighted; Enter / Shift+Enter or the arrows step through them.
+  //- The log loads from its end; earlier lines load as you scroll up.
+  .d-flex.flex-wrap.align-items-center.gap-2.mb-2
+    select#stream-filter.form-select.form-select-sm.w-auto(aria-label="Log stream")
       option(value="") all streams
       option(value="uart") uart
       option(value="runner") runner
       option(value="flash") flash
       option(value="emulator") emulator
-  pre#log-viewer.bg-body-tertiary.p-3.rounded(
+    .input-group.input-group-sm.thub-search(role="search")
+      span.input-group-text
+        i.bi.bi-search
+      input#log-search.form-control(
+        type="search"
+        placeholder="Search log…"
+        aria-label="Search log"
+        autocomplete="off"
+        maxlength="200"
+        data-bs-toggle="tooltip"
+        data-bs-title="Enter: next match · Shift+Enter: previous · Esc: clear"
+      )
+      span#log-search-count.input-group-text.small(aria-live="polite" hidden)
+      button#log-search-prev.btn.btn-outline-secondary(type="button" aria-label="Previous match" disabled)
+        i.bi.bi-chevron-up
+      button#log-search-next.btn.btn-outline-secondary(type="button" aria-label="Next match" disabled)
+        i.bi.bi-chevron-down
+    .form-check.form-check-inline.small.mb-0
+      input#log-search-only.form-check-input(type="checkbox")
+      label.form-check-label(for="log-search-only") Display only matching lines
+    a.btn.btn-sm.btn-outline-secondary.ms-auto(
+      href=`/jobs/${jobId}/log.txt`
+      target="_blank"
+      rel="noopener"
+      data-bs-toggle="tooltip"
+      data-bs-title="Open the full log as plain text in a new tab"
+    )
+      i.bi.bi-file-earmark-text.me-1
+      | Raw
+  //- "Showing the last 1,000 of 5,321 lines · Load all" (log-viewer.js).
+  .d-flex.flex-wrap.align-items-center.gap-2.small.text-body-secondary.mb-1(aria-live="polite")
+    span#log-info Loading log…
+    button#log-load-all.btn.btn-link.btn-sm.p-0.align-baseline(type="button" hidden) Load all
+  pre#log-viewer.bg-body-tertiary.p-3.rounded.position-relative(
     style="height: 420px; overflow-y: auto;"
     data-job-id=jobId
     data-job-active=jobActive ? 'true' : 'false'

package/views/mixins/resource.pug

@@ -322,7 +322,7 @@ mixin resourceCard(r, groupsById, returnTo)
               ) Connected USB devices
             
           .tab-content
-            .tab-pane.fade.show.active(id=`rc-${r.id}-details` role="tabpanel" aria-labelledby=`rc-${r.id}-details-tab` tabindex="0")
+            .tab-pane.fade.show.active(id=`rc-${r.id}-details` role="tabpanel" aria-labelledby=`rc-${r.id}-details-tab` tabindex="0" data-live=`rc-details-${r.id}`)
               +resourceDetails(r, groupsById, returnTo, local, external)
             +configPanes(r, returnTo)
             .tab-pane.fade(id=`rc-${r.id}-usb` role="tabpanel" aria-labelledby=`rc-${r.id}-usb-tab` tabindex="0")

package/views/resources/list.pug

@@ -6,15 +6,18 @@ include ../mixins/list-controls
 
 block content
   h1.h4.mb-3 Resources
-  p.text-body-secondary.small.
+  .d-flex.flex-wrap.align-items-center.gap-2.mb-3
+    +updatesToolbar('client', 'clients', '/resources')
+  p.text-body-secondary.small: i.
     Resources register themselves — start a Client with the shared join key and it appears here. Click a resource for its details, including IP addresses.
 
   .d-flex.flex-wrap.align-items-center.gap-2.mb-3
-    +updatesToolbar('client', 'clients', '/resources')
+    +searchForm(list.q, 'Search resources: name, label, group, status, IP…', list.urlFor({ q: '' }))
     .ms-auto
       +pageSizePicker(list)
 
-  +listToolbar(list, 'resources')
+  div(data-live="list-toolbar")
+    +listToolbar(list, 'resources')
 
   table.table.table-hover.align-middle
     thead
@@ -29,7 +32,7 @@ block content
         +sortHeader(list, 'heartbeat', 'Last heartbeat', 'desc')
         if user.role === 'admin'
           th Actions
-    tbody
+    tbody(data-live="rows")
       each r in resources
         tr(role="button" tabindex="0" data-resource-card=`resource-card-${r.id}`)
           td= r.name

package/src/services/artifacts.js

@@ -1,149 +0,0 @@
-/**
- * @file        packages/coordinator/src/services/artifacts.js
- * @description Job artifact storage: saves uploaded files and generates download links
- *
- * @author      Andrian Yablonskyy
- * @copyright   Copyright (c) 2026 Andrian Yablonskyy. All rights reserved.
- *
- * This file is part of TestHub and is proprietary and confidential.
- * Unauthorized copying, modification, distribution, or use of this file,
- * via any medium, is strictly prohibited without prior written permission
- * from AdSystem.PRO.
- */
-
-'use strict';
-
-const fs = require('node:fs'),
-  path = require('node:path'),
-  crypto = require('node:crypto');
-
-// §3.1 / §12: stores uploaded result files under artifacts/<jobId>/ and
-// generates HMAC-signed, time-limited download links (no server-side
-// session needed for the Agent/CI to fetch them).
-function createArtifactsService(db, { config }){
-  const secret = config.sessionSecret;
-
-  function jobDir(jobId){
-    const dir = path.join(config.artifactsDir, jobId);
-    fs.mkdirSync(dir, { recursive: true });
-    return dir;
-  }
-
-  function sha256File(filePath){
-    const hash = crypto.createHash('sha256');
-    hash.update(fs.readFileSync(filePath));
-    return hash.digest('hex');
-  }
-
-  // `files` are multer file objects already written to a temp path.
-  function storeUploaded(jobId, files){
-    const dir = jobDir(jobId),
-      stored = [];
-    for (const file of files){
-      const dest = path.join(dir, path.basename(file.originalname));
-      fs.renameSync(file.path, dest);
-      const sha256 = sha256File(dest),
-        size = fs.statSync(dest).size,
-        info = db
-          .prepare(
-            `INSERT INTO artifacts (job_id, name, path, size, sha256, content_type, created_at)
-           VALUES (?, ?, ?, ?, ?, ?, ?)`
-          )
-          .run(jobId, file.originalname, dest, size, sha256, file.mimetype, new Date().toISOString());
-      stored.push(get(info.lastInsertRowid));
-    }
-    return stored;
-  }
-
-  function storeGenerated(jobId, name, buffer, contentType){
-    const dir = jobDir(jobId),
-      dest = path.join(dir, name);
-    fs.writeFileSync(dest, buffer);
-    const info = db
-      .prepare(
-        `INSERT INTO artifacts (job_id, name, path, size, sha256, content_type, created_at)
-         VALUES (?, ?, ?, ?, ?, ?, ?)`
-      )
-      .run(jobId, name, dest, buffer.length, sha256File(dest), contentType, new Date().toISOString());
-    return get(info.lastInsertRowid);
-  }
-
-  function get(id){
-    return db.prepare('SELECT * FROM artifacts WHERE id = ?').get(id);
-  }
-
-  function listForJob(jobId){
-    return db.prepare('SELECT * FROM artifacts WHERE job_id = ? ORDER BY id ASC').all(jobId);
-  }
-
-  function sign(artifactId, ttlHours = config.artifacts.linkTtlHours){
-    const expiresAt = Date.now() + ttlHours * 3600 * 1000,
-      payload = `${artifactId}.${expiresAt}`,
-      mac = crypto.createHmac('sha256', secret).update(payload).digest('base64url');
-    return `${payload}.${mac}`;
-  }
-
-  function verify(token){
-    const [artifactId, expiresAt, mac] = String(token).split('.');
-    if (!artifactId || !expiresAt || !mac){
-      throw invalidLink();
-    }
-    const payload = `${artifactId}.${expiresAt}`,
-      expectedMac = crypto.createHmac('sha256', secret).update(payload).digest('base64url');
-    if (!crypto.timingSafeEqual(Buffer.from(mac), Buffer.from(expectedMac))){
-      throw invalidLink();
-    }
-    if (Date.now() > Number(expiresAt)){
-      throw invalidLink('Link expired');
-    }
-    const artifact = get(Number(artifactId));
-    if (!artifact){
-      throw invalidLink();
-    }
-    return artifact;
-  }
-
-  function invalidLink(message = 'Invalid or expired link'){
-    return Object.assign(new Error(message), { status: 403 });
-  }
-
-  function signedUrl(artifact){
-    return `${config.publicUrl}/artifacts/download/${sign(artifact.id)}`;
-  }
-
-  // Removes a job's artifact files from disk (not the DB rows — the
-  // caller, jobs.js's cleanHistory, deletes those as part of the same
-  // transaction that also deletes the job itself).
-  function deleteJobArtifacts(jobId){
-    fs.rmSync(path.join(config.artifactsDir, jobId), { recursive: true, force: true });
-  }
-
-  function purgeOlderThan(days){
-    const cutoff = new Date(Date.now() - days * 86400 * 1000).toISOString(),
-      stale = db
-        .prepare(
-          `SELECT a.* FROM artifacts a JOIN jobs j ON j.id = a.job_id
-         WHERE j.finished_at IS NOT NULL AND j.finished_at <= ?`
-        )
-        .all(cutoff);
-    for (const artifact of stale){
-      fs.rmSync(artifact.path, { force: true });
-      db.prepare('DELETE FROM artifacts WHERE id = ?').run(artifact.id);
-    }
-  }
-
-  return {
-    storeUploaded,
-    storeGenerated,
-    get,
-    listForJob,
-    sign,
-    verify,
-    signedUrl,
-    purgeOlderThan,
-    deleteJobArtifacts,
-    jobDir
-  };
-}
-
-module.exports = { createArtifactsService };