@andrian.yablonskyy/thub-coordinator 1.0.28 → 1.0.30

package/views/mixins/client-config.pug

@@ -0,0 +1,205 @@
+//- A Client's capabilities — the hw or sw section of its config — edited on
+//- the resource card's Config tab (README §10). public/js/client-config.js
+//- turns the form into JSON on Save; the Client applies it on its next
+//- heartbeat, then restarts once idle. Starts from what was last saved, else
+//- what the Client reported at registration.
+
+//- One device row: "Device" is a udev index (1-8) or a /dev path; fields the
+//- form doesn't show (vendorId/productId/subsystem) ride along in data-extra.
+mixin deviceRow(kind, d)
+  - const known = ['index', 'path', 'serial', 'baudRate', 'devpath']
+  - const extra = Object.fromEntries(Object.entries(d || {}).filter(([k]) => !known.includes(k)))
+  tr(data-row=kind data-extra=JSON.stringify(extra))
+    td: input.form-control.form-control-sm.font-monospace(data-f="device" value=d ? (d.path || d.index || '') : '' placeholder="1 or /dev/…" required)
+    if kind === 'stlinks'
+      td: input.form-control.form-control-sm.font-monospace(data-f="serial" value=d && d.serial || '' placeholder="(from udev)")
+    if kind === 'uarts'
+      td: input.form-control.form-control-sm(data-f="baudRate" type="number" min="50" value=d && d.baudRate || '' placeholder="115200")
+    td: input.form-control.form-control-sm.font-monospace(data-f="devpath" value=d && d.devpath || '' placeholder="3.3.4.1")
+    td.text-end
+      button.btn.btn-sm.btn-outline-secondary(type="button" data-remove-row aria-label="Remove row")
+        i.bi.bi-x-lg
+
+mixin relayRow(rl)
+  tr(data-row="relays")
+    td: input.form-control.form-control-sm(data-f="channel" type="number" min="0" max="7" value=rl ? rl.channel : '' required)
+    td: input.form-control.form-control-sm(data-f="baseUrl" type="url" value=rl && rl.baseUrl || '' placeholder="http://localhost:3000")
+    td.text-end
+      button.btn.btn-sm.btn-outline-secondary(type="button" data-remove-row aria-label="Remove row")
+        i.bi.bi-x-lg
+
+mixin deviceTable(kind, title, rows, columns)
+  .d-flex.justify-content-between.align-items-center.mb-1
+    strong.small= title
+    button.btn.btn-sm.btn-outline-primary(type="button" data-add-row=kind)
+      i.bi.bi-plus-lg.me-1
+      | Add
+  table.table.table-sm.align-middle.mb-0(data-table=kind)
+    thead
+      tr
+        each c in columns
+          th.small.text-body-secondary.fw-normal= c
+        th
+    tbody
+      each d in rows
+        if kind === 'relays'
+          +relayRow(d)
+        else
+          +deviceRow(kind, d)
+  template(data-template=kind)
+    if kind === 'relays'
+      +relayRow(null)
+    else
+      +deviceRow(kind, null)
+
+//- The ⚠ shown on a config (sub-)tab while its data differs from what was
+//- loaded — public/js/client-config.js toggles it.
+mixin dirtyIcon()
+  i.bi.bi-exclamation-triangle-fill.text-warning.ms-1.d-none(
+    data-dirty-icon
+    role="img"
+    aria-label="changed, not saved"
+    title="Changed — not saved yet"
+  )
+
+mixin configTab(p, key, label)
+  li.nav-item(role="presentation")
+    button.nav-link(
+      id=`${p}-${key}-tab`
+      type="button"
+      role="tab"
+      data-bs-toggle="tab"
+      data-bs-target=`#${p}-${key}`
+      aria-controls=`${p}-${key}`
+      aria-selected="false"
+      data-config-tab=key
+    )
+      = label
+      +dirtyIcon()
+
+mixin configPane(p, key)
+  .tab-pane.fade(id=`${p}-${key}` role="tabpanel" aria-labelledby=`${p}-${key}-tab` tabindex="0" data-config-pane=key)
+    block
+
+mixin saveCapabilities(canEdit)
+  if canEdit
+    .d-flex.justify-content-end.mt-3
+      button.btn.btn-sm.btn-primary(type="submit") Save capabilities
+
+//- Where the saved capabilities stand, at the top of each capability tab.
+mixin capabilitiesStatus(r)
+  - const pending = r.config_desired && r.config_applied_revision < r.config_revision
+  if pending || (r.config_revision && !r.config_error) || r.config_error
+    .d-flex.justify-content-end.gap-1.mb-2
+      if pending
+        span.badge.text-bg-warning(
+          data-bs-toggle="tooltip"
+          data-bs-title=`Capabilities revision ${r.config_revision} is saved; the Client applies it on its next heartbeat, then restarts once idle`
+        ) not applied yet
+      else if r.config_revision && !r.config_error
+        span.badge.text-bg-success(data-bs-toggle="tooltip" data-bs-title=`The Client runs capabilities revision ${r.config_applied_revision}`) applied
+      if r.config_error
+        span.badge.text-bg-danger(data-bs-toggle="tooltip" data-bs-title=r.config_error) refused by the Client
+
+//- The Client's config, as tabs of the resource card next to Details:
+//- HW — ST-Link, UART, DUT USB, Power (relays + power control); SW —
+//- Emulator; both — Reboot (the schedule, its own Save). The capability tabs
+//- share one form and one "Save capabilities"; a tab with unsaved changes
+//- shows ⚠ (public/js/client-config.js).
+mixin configTabItems(r)
+  - const p = `cfg-${r.id}`
+  - const tabs = r.type === 'hw' ? [['stlinks', 'ST-Link'], ['uarts', 'UART'], ['usbs', 'DUT USB'], ['power', 'Power']] : [['emulator', 'Emulator']]
+  each t in tabs
+    +configTab(p, t[0], t[1])
+  +configTab(p, 'reboot', 'Reboot')
+
+mixin configPanes(r, returnTo)
+  - const p = `cfg-${r.id}`
+  - const current = r.config_desired || r.client_config
+  - const canEdit = user.role === 'admin'
+  if !current
+    each t in (r.type === 'hw' ? [['stlinks', 'ST-Link'], ['uarts', 'UART'], ['usbs', 'DUT USB'], ['power', 'Power']] : [['emulator', 'Emulator']])
+      +configPane(p, t[0])
+        p.small.text-body-secondary.mb-0 This Client is too old to report its config — update it to edit its capabilities here.
+  else
+    form(
+      method="post"
+      action=`/resources/${r.id}/config`
+      data-client-config=r.type
+      data-confirm=`Apply these capabilities to ${r.name}? The Client writes them to its config file on its next heartbeat and restarts once it has no job running.`
+      data-confirm-title="Save Client capabilities?"
+      data-confirm-ok="Save"
+      data-confirm-tone="primary"
+    )
+      input(type="hidden" name="returnTo" value=returnTo)
+      input(type="hidden" name="config")
+      fieldset(disabled=!canEdit)
+        if r.type === 'sw'
+          +configPane(p, 'emulator')
+            +capabilitiesStatus(r)
+            .row.g-2
+              .col-sm-6
+                label.form-label.small.mb-0 Image
+                input.form-control.form-control-sm.font-monospace(data-f="image" value=current.image || '' placeholder="dut-emulator:2026.08")
+              .col-sm-6
+                label.form-label.small.mb-0 Registry
+                input.form-control.form-control-sm.font-monospace(data-f="registry" value=current.registry || '' placeholder="registry.lab:5000")
+              .col-sm-3
+                label.form-label.small.mb-0 CPUs
+                input.form-control.form-control-sm(data-f="cpus" type="number" step="0.1" min="0.1" value=current.cpus != null ? current.cpus : '' placeholder="2")
+              .col-sm-3
+                label.form-label.small.mb-0 Memory
+                input.form-control.form-control-sm(data-f="memory" value=current.memory || '' placeholder="2g")
+              .col-sm-6
+                label.form-label.small.mb-0 Container command
+                input.form-control.form-control-sm.font-monospace(
+                  data-f="cmd"
+                  value=(current.cmd || []).join(' ')
+                  placeholder="--firmware /downloads/app.bin"
+                  title="For the image above (not a job's own); space-separated"
+                )
+              .col-12.d-flex.gap-4.mt-2
+                .form-check
+                  input.form-check-input(type="checkbox" data-f="allowDockerHub" id=`cc-${r.id}-hub` checked=current.allowDockerHub === true)
+                  label.form-check-label.small(for=`cc-${r.id}-hub`) Pull from Docker Hub
+                .form-check
+                  input.form-check-input(type="checkbox" data-f="allowJobImages" id=`cc-${r.id}-jobimg` checked=current.allowJobImages === true)
+                  label.form-check-label.small(for=`cc-${r.id}-jobimg`) Run jobs' own images (--docker-image)
+            +saveCapabilities(canEdit)
+        else
+          - const power = current.power || {}
+          +configPane(p, 'stlinks')
+            +capabilitiesStatus(r)
+            +deviceTable('stlinks', 'ST-Link probes', current.stlinks || [], ['Device', 'Serial', 'udev devpath'])
+            .form-text Device: a udev index 1–8 (→ /dev/thub/dut&lt;N&gt;-stlink) or a /dev path. The serial is looked up from the udev symlink when empty.
+            +saveCapabilities(canEdit)
+          +configPane(p, 'uarts')
+            +capabilitiesStatus(r)
+            +deviceTable('uarts', 'UARTs', current.uarts || [], ['Device', 'Baud rate', 'udev devpath'])
+            .form-text Device: a udev index 1–8 (→ /dev/thub/dut&lt;N&gt;-uart) or a /dev path. Baud rate: 115200 when empty.
+            +saveCapabilities(canEdit)
+          +configPane(p, 'usbs')
+            +capabilitiesStatus(r)
+            +deviceTable('usbs', 'DUT USB devices', current.usbs || [], ['Device', 'udev devpath'])
+            .form-text Device: a udev index 1–8 (→ /dev/thub/dut&lt;N&gt;-usb) or a /dev path. udev devpath: the USB port it's plugged into.
+            +saveCapabilities(canEdit)
+          +configPane(p, 'power')
+            +capabilitiesStatus(r)
+            +deviceTable('relays', 'Relay channels', current.relays || [], ['Channel (0-7)', 'Board URL'])
+            strong.small.d-block.mt-3.mb-1 Power control
+            .row.g-2(data-power)
+              .col-sm-3
+                select.form-select.form-select-sm(data-f="method" aria-label="Power method")
+                  option(value="" selected=!power.method) none
+                  option(value="uhubctl" selected=power.method === 'uhubctl') uhubctl
+                  option(value="relay" selected=power.method === 'relay') relay
+              .col-sm-3
+                input.form-control.form-control-sm(data-f="hub" value=power.hub || '' placeholder="hub (uhubctl)")
+              .col-sm-2
+                input.form-control.form-control-sm(data-f="port" type="number" min="1" value=power.port != null ? power.port : '' placeholder="port")
+              .col-sm-4
+                input.form-control.form-control-sm(data-f="baseUrl" type="url" value=power.baseUrl || '' placeholder="relay URL")
+            +saveCapabilities(canEdit)
+  +configPane(p, 'reboot')
+    dl.row.mb-0
+      +rebootScheduleRow(r, returnTo)

package/views/mixins/resource.pug

@@ -1,3 +1,5 @@
+include client-config
+
 //- Resource actions and the resource info card (modal), shared by the
 //- Overview and Resources pages. `returnTo` is the page the action forms
 //- redirect back to.
@@ -307,9 +309,11 @@ mixin resourceCard(r, groupsById, returnTo)
         .modal-header
           h5.modal-title(id=`resource-card-${r.id}-title`)= r.name
           button.btn-close(type="button" data-bs-dismiss="modal" aria-label="Close")
-        .modal-body.pt-2
-          //- Details: what the Client is and reports. Config: settings sent
-          //- to it (today the scheduled reboot); read-only for viewers.
+        //- data-config-root: where public/js/client-config.js tracks unsaved
+        //- changes (⚠ on the config tabs).
+        .modal-body.pt-2(data-config-root)
+          //- Details: what the Client is and reports. Then its config tabs
+          //- (client-config.pug; read-only for viewers), then its USB devices.
           ul.nav.nav-tabs.mb-3(role="tablist")
             li.nav-item(role="presentation")
               button.nav-link.active(
@@ -321,27 +325,68 @@ mixin resourceCard(r, groupsById, returnTo)
                 aria-controls=`rc-${r.id}-details`
                 aria-selected="true"
               ) Details
+            +configTabItems(r)
             li.nav-item(role="presentation")
               button.nav-link(
-                id=`rc-${r.id}-config-tab`
+                id=`rc-${r.id}-usb-tab`
                 type="button"
                 role="tab"
                 data-bs-toggle="tab"
-                data-bs-target=`#rc-${r.id}-config`
-                aria-controls=`rc-${r.id}-config`
+                data-bs-target=`#rc-${r.id}-usb`
+                aria-controls=`rc-${r.id}-usb`
                 aria-selected="false"
-              ) Config
+              ) 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")
               +resourceDetails(r, groupsById, returnTo, local, external)
-            .tab-pane.fade(id=`rc-${r.id}-config` role="tabpanel" aria-labelledby=`rc-${r.id}-config-tab` tabindex="0")
-              dl.row.mb-0
-                +rebootScheduleRow(r, returnTo)
-        if user.role === 'admin'
-          .modal-footer
-            +rebootButton(r, returnTo)
+            +configPanes(r, returnTo)
+            .tab-pane.fade(id=`rc-${r.id}-usb` role="tabpanel" aria-labelledby=`rc-${r.id}-usb-tab` tabindex="0")
+              +usbScanPane(r)
+
+//- "Connected USB devices" (resource card tab): the Client's `lsusb`, run
+//- only on Refresh (admins; public/js/usb-scan.js fetches and fills it in).
+mixin usbScanPane(r)
+  - const offline = r.status === 'OUT_OF_SERVICE' || !r.last_heartbeat_at
+  - const scan = r.usb_scan
+  //- Import to config (public/js/usb-import.js): HW Clients that report
+  //- their config only; enabled once there's a scan to import from.
+  - const importWhy = r.type !== 'hw' ? 'Only HW Clients have USB device lists to import into' : !(r.config_desired || r.client_config) ? 'This Client is too old to report its config — update it first' : null
+  div(data-usb-scan=`/resources/${r.id}/usb-scan` data-pending=r.usb_scan_request_id ? '1' : null data-requested-at=r.usb_scan_requested_at)
+    .d-flex.align-items-center.gap-2.mb-2
+      if user.role === 'admin'
+        if offline
+          span.d-inline-block(tabindex="0" data-bs-toggle="tooltip" data-bs-title="Offline — a Client can only be scanned while it's connected")
+            button.btn.btn-sm.btn-outline-primary(type="button" disabled style="pointer-events: none;")
+              i.bi.bi-arrow-clockwise.me-1
+              | Refresh
+        else
+          button.btn.btn-sm.btn-outline-primary(type="button" data-usb-refresh)
+            i.bi.bi-arrow-clockwise.me-1
+            | Refresh
+        if importWhy
+          span.d-inline-block(tabindex="0" data-bs-toggle="tooltip" data-bs-title=importWhy)
+            button.btn.btn-sm.btn-outline-secondary(type="button" disabled style="pointer-events: none;")
+              i.bi.bi-box-arrow-in-down.me-1
+              | Import to config
+        else
+          button.btn.btn-sm.btn-outline-secondary(
+            type="button"
+            data-usb-import
+            disabled=!(scan && scan.output)
+            title="Fill the ST-Link, UART and DUT USB tabs from this scan, for you to review and save"
+          )
+            i.bi.bi-box-arrow-in-down.me-1
+            | Import to config
+      span.small.text-body-secondary(data-usb-status)
+        if scan
+          = `lsusb -tvv at ${fmtDate(scan.at)}`
+        else
+          | Not scanned yet#{user.role === 'admin' ? ' — press Refresh to run lsusb -tvv on the Client' : ''}.
+    .alert.alert-danger.py-2.small(data-usb-error class=scan && scan.error ? null : 'd-none')= scan && scan.error || ''
+    pre.bg-body-tertiary.p-2.rounded.small.mb-0(data-usb-output style="max-height: 360px; overflow: auto;" class=scan && scan.output ? null : 'd-none')= scan && scan.output || ''
 
-//- Reboot the Client's host now (card footer): confirmed first — naming the
+//- Reboot the Client's host now (card's Actions row, icon only): confirmed first — naming the
 //- job that gets canceled, if one is running — then sent with the Client's
 //- next heartbeat. Disabled while it's offline or has no reboot helper.
 mixin rebootButton(r, returnTo)
@@ -349,12 +394,11 @@ mixin rebootButton(r, returnTo)
   - const unsupported = r.capabilities && r.capabilities.rebootSupported === false
   - const why = offline ? 'Offline — a Client can only be rebooted while connected' : unsupported ? "This host has no reboot helper — reinstall the Client as root" : null
   if why
-    span.d-inline-block(tabindex="0" data-bs-toggle="tooltip" data-bs-title=why)
-      button.btn.btn-outline-danger(type="button" disabled style="pointer-events: none;")
-        i.bi.bi-bootstrap-reboot.me-1
-        | Reboot
+    span.d-inline-block.ms-1(tabindex="0" data-bs-toggle="tooltip" data-bs-title=`Reboot unavailable: ${why}`)
+      button.btn.btn-sm.btn-outline-danger(type="button" disabled style="pointer-events: none;" aria-label="Reboot")
+        i.bi.bi-power
   else
-    form(
+    form.d-inline.ms-1(
       method="post"
       action=`/resources/${r.id}/reboot`
       data-confirm=r.activeJob
@@ -365,15 +409,48 @@ mixin rebootButton(r, returnTo)
       data-confirm-dismiss="Don't reboot"
     )
       input(type="hidden" name="returnTo" value=returnTo)
-      button.btn.btn-outline-danger(type="submit")
-        i.bi.bi-bootstrap-reboot.me-1
-        | Reboot
+      button.btn.btn-sm.btn-outline-danger(
+        type="submit"
+        aria-label=`Reboot ${r.name}'s host`
+        data-bs-toggle="tooltip"
+        data-bs-title=r.activeJob ? `Reboot the host (cancels running job ${r.activeJob.id})` : 'Reboot the host'
+      )
+        i.bi.bi-power
 
 //- The resource card's Details tab.
 mixin resourceDetails(r, groupsById, returnTo, local, external)
   dl.row.mb-0
     dt.col-sm-4 Name
-    dd.col-sm-8= r.name
+    dd.col-sm-8
+      span= r.name
+      if r.name_override && r.reported_name
+        span.text-body-secondary.small.ms-2(
+          data-bs-toggle="tooltip"
+          data-bs-title="Renamed on the dashboard; this is the name the Client itself reports"
+        )= `(Client: ${r.reported_name})`
+      if user.role === 'admin'
+        button.btn.btn-sm.btn-link.p-0.ms-2.align-baseline(
+          type="button"
+          data-bs-toggle="collapse"
+          data-bs-target=`#rename-${r.id}`
+          aria-expanded="false"
+          aria-controls=`rename-${r.id}`
+          aria-label=`Rename ${r.name}`
+        )
+          i.bi.bi-pencil(data-bs-toggle="tooltip" data-bs-title="Rename")
+        .collapse(id=`rename-${r.id}`)
+          form.d-flex.gap-1.mt-1(method="post" action=`/resources/${r.id}/rename`)
+            input(type="hidden" name="returnTo" value=returnTo)
+            input.form-control.form-control-sm(
+              name="name"
+              value=r.name
+              maxlength="64"
+              pattern="[A-Za-z0-9._@+\-]*"
+              placeholder=r.reported_name || ''
+              aria-label=`New name for ${r.name}`
+            )
+            button.btn.btn-sm.btn-primary(type="submit") Rename
+          .form-text Kept across the Client's restarts. Empty = back to the Client's own name#{r.reported_name ? ` (${r.reported_name})` : ''}.
     dt.col-sm-4 Type
     dd.col-sm-8.text-uppercase= r.type
     dt.col-sm-4 Status
@@ -422,3 +499,4 @@ mixin resourceDetails(r, groupsById, returnTo, local, external)
       dt.col-sm-4 Actions
       dd.col-sm-8.mb-0
         +resourceActions(r, returnTo)
+        +rebootButton(r, returnTo)

package/views/resources/list.pug

@@ -60,3 +60,7 @@ block content
 block scripts
   script(src="/js/resource-card.js")
   script(src="/js/remove-resource.js")
+  script(src="/js/client-config.js")
+  script(src="/js/usb-scan.js")
+  script(src="/js/usb-parse.js")
+  script(src="/js/usb-import.js")