@wpelevator/tug 0.2.1 → 0.4.0

package/dist/reconciler.js

@@ -0,0 +1,362 @@
+// The agent's container reconciler. Every service is one Docker container labelled with the hash of
+// its resolved definition (`tug.config-hash`); a container whose hash no longer matches is replaced.
+// `recreate` (the default) stops the old container and starts the new one. `rolling` starts the new
+// container beside the old one on a free host port, health-checks it, lets the ingress switch, and
+// removes the old one after a drain delay. State of rolling services lives in
+// `<project dir>/rollout.json` so an agent restart resumes mid-rollout.
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { isRolling } from "./compose.js";
+import { LABEL_HASH, LABEL_PROJECT, LABEL_SERVICE, startOrder, withHostPort, } from "./container-spec.js";
+import { isNotFound } from "./docker-api.js";
+import { ensureDir, errMessage, now, parseDuration } from "./util.js";
+export const DEFAULT_DRAIN = '30s';
+export const DEFAULT_PORT_RANGE = '20000-20999';
+export function parsePortRange(value) {
+    const m = (value || DEFAULT_PORT_RANGE).trim().match(/^(\d+)-(\d+)$/);
+    const lo = Number(m?.[1]);
+    const hi = Number(m?.[2]);
+    if (!m || lo < 1024 || hi > 65535 || lo > hi)
+        throw new Error(`invalid rollout port range ${JSON.stringify(value)} (expected LOW-HIGH within 1024-65535, e.g. ${DEFAULT_PORT_RANGE})`);
+    return [lo, hi];
+}
+// ---- Containers --------------------------------------------------------------------------------
+const containerNameOf = (c) => (c.Names?.[0] || c.Id).replace(/^\//, '');
+/** Containers of a project (or one service of it), running or not. */
+export async function projectContainers(docker, project, service) {
+    return docker.listContainers({
+        label: [`${LABEL_PROJECT}=${project}`, ...(service ? [`${LABEL_SERVICE}=${service}`] : [])],
+    });
+}
+async function removeContainers(docker, containers) {
+    for (const c of containers) {
+        if (c.State === 'running')
+            await docker.stopContainer(c.Id).catch(() => { });
+        await docker.removeContainer(c.Id);
+    }
+}
+async function removeByName(docker, name) {
+    await docker.stopContainer(name).catch(() => { });
+    await docker.removeContainer(name);
+}
+/** Creates the project network and its volumes; volumes are never removed by reconciliation. */
+export async function ensureProjectResources(docker, project, plan) {
+    if (!(await docker.inspectNetwork(plan.network)))
+        await docker.createNetwork(plan.network, { [LABEL_PROJECT]: project });
+    for (const volume of plan.volumes) {
+        if (await docker.inspectVolume(volume.name))
+            continue;
+        if (volume.external)
+            throw new Error(`external volume ${volume.name} does not exist on this node`);
+        await docker.createVolume(volume.name, {
+            driver: volume.driver,
+            opts: volume.opts,
+            labels: volume.labels,
+        });
+    }
+}
+/** Makes sure a service's container exists for `spec`, running, replacing any container with another hash. */
+export async function ensureContainer(docker, spec, existing) {
+    const match = existing.find((c) => c.Labels?.[LABEL_HASH] === spec.hash);
+    await removeContainers(docker, existing.filter((c) => c !== match));
+    if (match) {
+        if (match.State !== 'running')
+            await docker.startContainer(match.Id);
+        return match.Id;
+    }
+    const id = await docker.createContainer(spec.name, spec.body);
+    await docker.startContainer(id);
+    return id;
+}
+/** Removes containers of services that are not placed here any more (never volumes). */
+export async function sweepOrphans(docker, project, keep) {
+    const stray = (await projectContainers(docker, project)).filter((c) => !keep.has(c.Labels?.[LABEL_SERVICE] ?? ''));
+    await removeContainers(docker, stray);
+}
+const stateFile = (dir) => path.join(dir, 'rollout.json');
+export async function loadRolloutState(dir) {
+    try {
+        const parsed = JSON.parse(await fs.readFile(stateFile(dir), 'utf8'));
+        for (const s of Object.values(parsed.services))
+            s.draining ||= [];
+        return parsed;
+    }
+    catch {
+        return { services: {} };
+    }
+}
+async function saveRolloutState(dir, state) {
+    const tmp = `${stateFile(dir)}.tmp`;
+    await fs.writeFile(tmp, JSON.stringify(state, null, 2), { mode: 0o600 });
+    await fs.rename(tmp, stateFile(dir));
+}
+/** Host ports already published by containers on this node. */
+async function publishedHostPorts(docker) {
+    return new Set((await docker.listContainers({}, false)).flatMap((c) => (c.Ports || []).flatMap((p) => (p.PublicPort ? [p.PublicPort] : []))));
+}
+async function allocatePort(docker, range, known, exclude) {
+    const [lo, hi] = parsePortRange(range);
+    const busy = await publishedHostPorts(docker);
+    for (const port of [...known, ...exclude])
+        busy.add(port);
+    // Start after the newest port in use so a just-released port is not reused straight away.
+    const last = Math.max(lo - 1, ...known.filter((p) => p >= lo && p <= hi));
+    const size = hi - lo + 1;
+    for (let i = 0; i < size; i++) {
+        const port = lo + ((last + 1 - lo + i) % size);
+        if (!busy.has(port))
+            return port;
+    }
+    throw new Error(`no free host port left in the rollout range ${lo}-${hi} (TUG_ROLLOUT_PORTS)`);
+}
+const PORT_CONFLICT = /port is already allocated|address already in use|bind for .* failed/i;
+function knownPorts(rollout) {
+    return [rollout.active, rollout.candidate]
+        .filter((r) => Boolean(r))
+        .map((r) => r.port);
+}
+/** Waits for the dependencies a service started with `service_healthy` on. */
+async function waitForDependencies(docker, spec, containers, deps) {
+    for (const [dep, condition] of Object.entries(spec.dependsOn)) {
+        const id = containers.get(dep);
+        if (condition === 'service_healthy' && id)
+            await deps.waitForHealth(id, dep, true);
+    }
+}
+/**
+ * Recreate-strategy services: pull, then create/start each in dependency order. `onStarting` and
+ * `onHealth` let the agent report per-service state; a failure throws with the service named in
+ * `failing`.
+ */
+export async function reconcileRecreate(docker, input, report) {
+    const { plan, deps, services, desired } = input;
+    const only = Object.fromEntries(services.map((s) => [s, plan.specs[s]]));
+    for (const service of services)
+        await report.pulling(service);
+    for (const service of services) {
+        if (desired.services[service].artifact)
+            await deps.ensureArtifact(service);
+        else if (input.pull || !(await docker.inspectImage(plan.specs[service].body.Image)))
+            await deps.pullImage(service);
+    }
+    const ids = new Map();
+    const order = startOrder(Object.fromEntries(Object.entries(only).map(([name, spec]) => [
+        name,
+        {
+            ...spec,
+            dependsOn: Object.fromEntries(Object.entries(spec.dependsOn).filter(([d]) => d in only)),
+        },
+    ])));
+    for (const service of order) {
+        const spec = plan.specs[service];
+        await report.starting(service);
+        report.failing(service);
+        await waitForDependencies(docker, spec, ids, deps);
+        ids.set(service, await ensureContainer(docker, spec, await projectContainers(docker, desired.project, service)));
+        report.failing(undefined);
+    }
+    for (const service of order) {
+        await report.checking(service);
+        report.failing(service);
+        await deps.waitForHealth(ids.get(service), service);
+        report.failing(undefined);
+        await report.serving(service);
+    }
+}
+function servingState(rev, extra = {}) {
+    return {
+        rolloutState: 'serving',
+        image: rev.image,
+        healthyAt: now(),
+        port: rev.port,
+        rolloutRevision: rev.hash,
+        ...extra,
+    };
+}
+export const isRollingService = (desired, service) => isRolling(desired.compose.services[service]);
+/** The host port a container publishes for the container port `target`. */
+function publishedOf(c, target) {
+    const ports = (c.Ports || []).filter((p) => p.PublicPort);
+    return (ports.find((p) => p.PrivatePort === target) ?? ports[0])?.PublicPort;
+}
+export async function reconcileRolling(docker, input) {
+    const { desired, dir, services, plan, deps } = input;
+    const project = desired.project;
+    const state = await loadRolloutState(dir);
+    const result = { serviceStates: {}, errors: {} };
+    await ensureDir(dir);
+    // Drained revisions go first so their host ports are free for this rollout.
+    await retireRevisions(docker, dir, state, new Set(services), deps);
+    for (const service of services) {
+        const rollout = (state.services[service] ||= { draining: [] });
+        const spec = plan.specs[service];
+        const ext = desired.compose.services[service];
+        const ingressPort = ext['x-tug'].ingress.port;
+        const drainMs = parseDuration(ext['x-tug']?.rollout?.drain ?? DEFAULT_DRAIN, 30000);
+        const image = desired.services[service].image;
+        // Adopt a container that predates the rollout state (a service that used to be recreated, or a lost state file).
+        const present = await projectContainers(docker, project, service);
+        if (!rollout.active) {
+            const adopt = present.find((c) => c.State === 'running');
+            const port = adopt && publishedOf(adopt, ingressPort);
+            if (adopt && port)
+                rollout.active = {
+                    hash: adopt.Labels?.[LABEL_HASH] ?? 'unknown',
+                    container: containerNameOf(adopt),
+                    port,
+                    image,
+                };
+        }
+        if (rollout.candidate && rollout.candidate.hash !== spec.hash) {
+            await removeByName(docker, rollout.candidate.container).catch(() => { });
+            delete rollout.candidate;
+        }
+        if (rollout.active && rollout.active.hash === spec.hash) {
+            // Steady state: make sure the revision is still up and healthy; nothing restarts when it is.
+            const active = { ...rollout.active, image };
+            try {
+                const running = present.find((c) => containerNameOf(c) === active.container);
+                if (!running)
+                    await docker.startContainer(await docker.createContainer(active.container, withHostPort(spec.body, active.port)));
+                else if (running.State !== 'running')
+                    await docker.startContainer(running.Id);
+                await deps.waitForHealth(active.container, service);
+                delete rollout.failed;
+                result.serviceStates[service] = servingState(active);
+            }
+            catch (e) {
+                result.errors[service] = errMessage(e);
+                result.serviceStates[service] = {
+                    rolloutState: 'health_checking',
+                    image,
+                    rolloutRevision: spec.hash,
+                };
+            }
+            continue;
+        }
+        const key = `${desired.revision || desired.version}:${spec.hash}`;
+        const reject = (error) => {
+            result.errors[service] = error;
+            result.serviceStates[service] = rollout.active
+                ? servingState(rollout.active, { rolloutError: error })
+                : { rolloutState: 'health_checking', image, rolloutRevision: spec.hash };
+        };
+        if (rollout.failed?.key === key) {
+            reject(rollout.failed.error);
+            continue;
+        }
+        try {
+            const candidate = rollout.candidate ?? {
+                hash: spec.hash,
+                container: spec.name,
+                port: await allocatePort(docker, input.rolloutPorts, knownPorts(rollout), new Set()),
+                image,
+            };
+            rollout.candidate = candidate;
+            await saveRolloutState(dir, state);
+            await deps.emit(service, 'pulling');
+            if (desired.services[service].artifact)
+                await deps.ensureArtifact(service);
+            else
+                await deps.pullImage(service);
+            const exclude = new Set();
+            for (let attempt = 0;; attempt++) {
+                await deps.emit(service, 'starting', `starting new revision on host port ${candidate.port}`);
+                try {
+                    await removeByName(docker, candidate.container);
+                    const id = await docker.createContainer(candidate.container, withHostPort(spec.body, candidate.port));
+                    await docker.startContainer(id);
+                    break;
+                }
+                catch (e) {
+                    if (attempt >= 4 || !PORT_CONFLICT.test(errMessage(e)))
+                        throw e;
+                    exclude.add(candidate.port);
+                    candidate.port = await allocatePort(docker, input.rolloutPorts, knownPorts(rollout), exclude);
+                    await saveRolloutState(dir, state);
+                }
+            }
+            await deps.emit(service, 'health_checking');
+            await deps.waitForHealth(candidate.container, service);
+            // Takeover: the next status report carries the new port and control re-renders the ingress.
+            if (rollout.active)
+                rollout.draining.push({
+                    service,
+                    container: rollout.active.container,
+                    drainUntil: Date.now() + drainMs,
+                });
+            rollout.active = { ...candidate };
+            delete rollout.candidate;
+            delete rollout.failed;
+            await saveRolloutState(dir, state);
+            result.serviceStates[service] = servingState(rollout.active);
+            await deps.emit(service, 'serving', `new revision serving on host port ${rollout.active.port}`);
+        }
+        catch (e) {
+            const error = errMessage(e);
+            if (rollout.candidate)
+                await removeByName(docker, rollout.candidate.container).catch(() => { });
+            delete rollout.candidate;
+            rollout.failed = { key, error };
+            await saveRolloutState(dir, state);
+            reject(error);
+            await deps.emit(service, 'rollout_failed', `new revision rejected, previous revision keeps serving: ${error}`);
+        }
+    }
+    // Containers of a rolling service that are no revision of it (a failed adoption, a lost state file).
+    for (const service of services) {
+        const rollout = state.services[service];
+        const known = new Set([
+            rollout?.active?.container,
+            rollout?.candidate?.container,
+            ...(rollout?.draining || []).map((d) => d.container),
+        ].filter(Boolean));
+        const stray = (await projectContainers(docker, project, service)).filter((c) => !known.has(containerNameOf(c)));
+        await removeContainers(docker, stray).catch(() => { });
+    }
+    await saveRolloutState(dir, state);
+    return result;
+}
+/** Removes drained revisions, and revisions of services that are no longer rolling on this node. */
+async function retireRevisions(docker, dir, state, rolling, deps) {
+    for (const [service, rollout] of Object.entries(state.services)) {
+        if (!rolling.has(service)) {
+            // No longer rolling here: the recreate path (or the orphan sweep) removes the containers.
+            delete state.services[service];
+            continue;
+        }
+        const keep = [];
+        for (const old of rollout.draining) {
+            if (old.drainUntil > Date.now()) {
+                keep.push(old);
+                continue;
+            }
+            try {
+                await removeByName(docker, old.container);
+                await deps?.emit(service, 'drained', `previous revision ${old.container} removed after drain`);
+            }
+            catch (e) {
+                if (!isNotFound(e))
+                    keep.push(old);
+            }
+        }
+        rollout.draining = keep;
+        if (!rollout.active && !rollout.candidate && !rollout.draining.length && !rollout.failed)
+            delete state.services[service];
+    }
+}
+/** Drops rolling state of a project that has no rolling service on this node any more. */
+export async function clearRolloutState(dir) {
+    await fs.rm(stateFile(dir), { force: true });
+}
+/** Reported states for rolling services whose current revision is still serving, used when another part of the reconcile failed. */
+export async function activeRollingStates(dir, services) {
+    const state = await loadRolloutState(dir);
+    const out = {};
+    for (const service of services) {
+        const active = state.services[service]?.active;
+        if (active)
+            out[service] = servingState(active);
+    }
+    return out;
+}

package/dist/runners.d.ts

@@ -1,11 +1,6 @@
 import type { RunResult } from './build.ts';
-export type DockerRunner = (args: string[], opts?: {
-    cwd?: string;
-}) => Promise<RunResult>;
 export type HttpClient = typeof fetch;
-/** Default runner: `docker <args>` via the shared `run()` helper. */
-export declare function createDockerRunner(): DockerRunner;
-/** Runs a host binary (`wg`, `ip`); rejects on a non-zero exit like the docker runner. */
+/** Runs a host binary (`wg`, `ip`); rejects on a non-zero exit. */
 export type HostRunner = (cmd: string, args: string[], opts?: {
     cwd?: string;
 }) => Promise<RunResult>;

package/dist/runners.js

@@ -1,10 +1,6 @@
 // Injectable seams for the agent's side effects so rollout/health/secret logic can be unit-tested
-// without a real Docker daemon or control plane.
+// without a real Docker daemon or control plane. Docker itself is the `DockerApi` in `docker-api.ts`.
 import { run } from "./build.js";
-/** Default runner: `docker <args>` via the shared `run()` helper. */
-export function createDockerRunner() {
-    return (args, opts) => run('docker', args, opts);
-}
 export function createHostRunner() {
     return (cmd, args, opts) => run(cmd, args, opts);
 }

package/dist/secrets.js

@@ -10,7 +10,9 @@ export async function loadOrCreateMasterKey(file) {
     await fs.writeFile(file, key, { mode: 0o600 });
     return key;
 }
-function keyBytes(key) { return crypto.createHash('sha256').update(key).digest(); }
+function keyBytes(key) {
+    return crypto.createHash('sha256').update(key).digest();
+}
 export function encrypt(value, masterKey) {
     const iv = crypto.randomBytes(12);
     const cipher = crypto.createCipheriv('aes-256-gcm', keyBytes(masterKey), iv);

package/dist/templates/control-compose.yml

@@ -7,6 +7,7 @@ services:
       PORT: 8080
       TUG_DATA_DIR: /data
       TUG_OPERATOR_TOKEN: {{OPERATOR_TOKEN}}
+      TUG_MESH: {{MESH}}
       TUG_REGISTRY: {{REGISTRY_HOST}}
       TUG_REGISTRY_AUTH_PATH: {{REGISTRY_AUTH_PATH}}
       TUG_REGISTRY_CONTAINER: {{REGISTRY_CONTAINER}}

package/dist/templates/install-docker.sh

@@ -1,6 +1,9 @@
 set -eu
-if docker version >/dev/null 2>&1 && docker compose version >/dev/null 2>&1; then
-  echo 'Docker Engine and Compose are already available.' >&2
+# Nodes need only the Docker Engine. The control host also runs its own install with Docker Compose,
+# which the caller asks for with TUG_INSTALL_COMPOSE=1.
+want_compose="${TUG_INSTALL_COMPOSE:-0}"
+if docker version >/dev/null 2>&1 && { [ "$want_compose" != 1 ] || docker compose version >/dev/null 2>&1; }; then
+  echo 'Docker Engine is already available.' >&2
   exit 0
 fi
 os_release="${TUG_OS_RELEASE:-/etc/os-release}"
@@ -61,9 +64,10 @@ Signed-By: /etc/apt/keyrings/docker.asc
 REPO
   apt-get update >&2
   if [ "$engine_present" = true ]; then
-    apt-get install -y --no-upgrade --no-remove docker-compose-plugin >&2
+    [ "$want_compose" != 1 ] || apt-get install -y --no-upgrade --no-remove docker-compose-plugin >&2
   else
-    apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin >&2
+    apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin >&2
+    [ "$want_compose" != 1 ] || apt-get install -y docker-compose-plugin >&2
   fi
 else
   if [ "$engine_present" = false ]; then
@@ -75,11 +79,12 @@ else
   command -v curl >/dev/null 2>&1 || dnf install -y curl >&2
   curl -fsSL "https://download.docker.com/linux/$repo_os/docker-ce.repo" -o /etc/yum.repos.d/docker-ce.repo
   if [ "$engine_present" = true ]; then
-    dnf install -y docker-compose-plugin >&2
+    [ "$want_compose" != 1 ] || dnf install -y docker-compose-plugin >&2
   else
-    dnf install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin >&2
+    dnf install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin >&2
+    [ "$want_compose" != 1 ] || dnf install -y docker-compose-plugin >&2
   fi
 fi
 [ "$engine_present" = true ] || systemctl enable --now docker >&2
 docker version >/dev/null
-docker compose version >/dev/null
+[ "$want_compose" != 1 ] || docker compose version >/dev/null

package/dist/tokens.d.ts

@@ -2,7 +2,7 @@ import type { Request, RequestHandler } from 'express';
 import type { Db } from './db.ts';
 /** Roles are cumulative: `deploy` includes `read`, and `admin` includes both. */
 export declare const ROLES: readonly ["read", "deploy", "admin"];
-export type Role = typeof ROLES[number];
+export type Role = (typeof ROLES)[number];
 export type RouteRole = Role | 'public';
 /** Name recorded in the audit trail for the root operator token. */
 export declare const OPERATOR_ACTOR = "operator";

package/dist/tokens.js

@@ -17,6 +17,7 @@ const LAST_USED_INTERVAL_MS = 60_000;
  * credential check (the registry hook) and are not behind the token guard. docs/access-control.md mirrors this table.
  */
 export const ROUTE_ROLES = {
+    'GET /api/v1/live': 'deploy',
     'GET /api/v1/status': 'read',
     'GET /api/v1/events': 'read',
     'GET /api/v1/projects/:project': 'read',
@@ -27,6 +28,7 @@ export const ROUTE_ROLES = {
     'POST /api/v1/deployments': 'deploy',
     'POST /api/v1/deployments/:id/cancel': 'deploy',
     'POST /api/v1/rollback': 'deploy',
+    'POST /api/v1/scale': 'deploy',
     'POST /api/v1/restart': 'deploy',
     'POST /api/v1/logs': 'deploy',
     'GET /api/v1/commands/:id': 'deploy',
@@ -40,6 +42,7 @@ export const ROUTE_ROLES = {
     'POST /api/v1/nodes/:name/revoke-registry-token': 'admin',
     'POST /api/v1/nodes/:name/rotate-wg-key': 'admin',
     'POST /api/v1/nodes/:name/ingress': 'admin',
+    'DELETE /api/v1/nodes/:name': 'admin',
     'POST /api/v1/control/backups/run': 'admin',
     'POST /api/v1/control/restore': 'admin',
     'GET /api/v1/diagnostics': 'admin',
@@ -47,7 +50,7 @@ export const ROUTE_ROLES = {
     'POST /api/v1/tokens': 'admin',
     'GET /api/v1/tokens': 'admin',
     'DELETE /api/v1/tokens/:name': 'admin',
-    'POST /api/v1/registry/auth': 'public'
+    'POST /api/v1/registry/auth': 'public',
 };
 const statusError = (status, message) => Object.assign(new Error(message), { status });
 export const isRole = (value) => typeof value === 'string' && ROLES.includes(value);
@@ -64,7 +67,10 @@ export function parseTokenRequest(body) {
         throw statusError(400, `role must be one of ${ROLES.join(', ')}`);
     let scope = null;
     if (projects !== undefined && projects !== null) {
-        if (!Array.isArray(projects) || !projects.length || projects.length > 100 || projects.some(p => typeof p !== 'string' || !PROJECT_NAME_PATTERN.test(p)))
+        if (!Array.isArray(projects) ||
+            !projects.length ||
+            projects.length > 100 ||
+            projects.some((p) => typeof p !== 'string' || !PROJECT_NAME_PATTERN.test(p)))
             throw statusError(400, 'projects must be a nonempty list of valid project names, or omitted for all projects');
         if (role === 'admin')
             throw statusError(400, 'admin tokens manage the whole control plane and cannot be limited to projects');
@@ -72,13 +78,25 @@ export function parseTokenRequest(body) {
     }
     let expiresAt = null;
     if (expiresInSeconds !== undefined && expiresInSeconds !== null) {
-        if (typeof expiresInSeconds !== 'number' || !Number.isSafeInteger(expiresInSeconds) || expiresInSeconds < 1 || expiresInSeconds > 10 * 365 * 86400)
+        if (typeof expiresInSeconds !== 'number' ||
+            !Number.isSafeInteger(expiresInSeconds) ||
+            expiresInSeconds < 1 ||
+            expiresInSeconds > 10 * 365 * 86400)
             throw statusError(400, 'expiresInSeconds must be a positive integer of at most ten years');
         expiresAt = new Date(Date.now() + expiresInSeconds * 1000).toISOString();
     }
     return { name, role, projects: scope, expiresAt };
 }
-const info = (row) => ({ name: row.name, role: row.role, projects: row.projects_json ? JSON.parse(row.projects_json) : null, createdAt: row.created_at, createdBy: row.created_by, lastUsedAt: row.last_used_at, expiresAt: row.expires_at, revokedAt: row.revoked_at });
+const info = (row) => ({
+    name: row.name,
+    role: row.role,
+    projects: row.projects_json ? JSON.parse(row.projects_json) : null,
+    createdAt: row.created_at,
+    createdBy: row.created_by,
+    lastUsedAt: row.last_used_at,
+    expiresAt: row.expires_at,
+    revokedAt: row.revoked_at,
+});
 /** Creates a token. The plaintext is returned once; only its hash is stored. */
 export async function createToken(db, request, createdBy) {
     const value = token(TOKEN_PREFIX);
@@ -90,7 +108,10 @@ export async function createToken(db, request, createdBy) {
             throw statusError(409, `token name ${request.name} is already used (revoked tokens keep their names for the audit trail)`);
         throw e;
     }
-    return { ...info((await db.get('SELECT * FROM api_tokens WHERE name=?', request.name))), token: value };
+    return {
+        ...info((await db.get('SELECT * FROM api_tokens WHERE name=?', request.name))),
+        token: value,
+    };
 }
 export async function listTokens(db) {
     return (await db.all('SELECT * FROM api_tokens ORDER BY created_at, name')).map(info);
@@ -117,10 +138,14 @@ export async function authenticate(db, raw) {
     // Best effort and throttled: a slow or failing bookkeeping write must never fail or delay the request.
     if (!row.last_used_at || Date.parse(row.last_used_at) < Date.now() - LAST_USED_INTERVAL_MS)
         void db.run('UPDATE api_tokens SET last_used_at=? WHERE id=?', now(), row.id).catch(() => { });
-    return { name: row.name, role: row.role, projects: row.projects_json ? JSON.parse(row.projects_json) : null };
+    return {
+        name: row.name,
+        role: row.role,
+        projects: row.projects_json ? JSON.parse(row.projects_json) : null,
+    };
 }
-export const bodyProject = req => String(req.body?.project || 'site');
-export const queryProject = req => String(req.query.project || 'site');
+export const bodyProject = (req) => String(req.body?.project || 'site');
+export const queryProject = (req) => String(req.query.project || 'site');
 const FORBIDDEN_PROJECT = 'forbidden: this token may not access that project';
 /** Throws 403 unless the actor may act on `project`. Used where the project is only known after the body is parsed. */
 export function assertProject(actor, project) {
@@ -146,7 +171,8 @@ export function createGuard(db) {
                     res.status(403).json({ error: 'forbidden: this action requires the admin role' });
                     return;
                 }
-                if (actor.projects && (project === undefined || project === null || !actor.projects.includes(project))) {
+                if (actor.projects &&
+                    (project === undefined || project === null || !actor.projects.includes(project))) {
                     res.status(403).json({ error: FORBIDDEN_PROJECT });
                     return;
                 }

package/dist/util.d.ts

@@ -13,3 +13,10 @@ export declare const errMessage: (e: unknown) => string;
 /** Parses `500ms` / `2s` / `1m` or a millisecond number; `fallback` when it does not parse. */
 export declare function parseDuration(value: string | number, fallback?: number): number;
 export declare const isDuration: (value: unknown) => boolean;
+/**
+ * True for an IP address that is routable on the internet: anything outside loopback, private
+ * (RFC 1918, IPv6 ULA), link-local, CGNAT (`100.64.0.0/10`) and the unspecified address. The
+ * unspecified addresses `0.0.0.0` and `::` count as public, since listening there means every
+ * interface. Hostnames and other non-IP strings return false.
+ */
+export declare function isPublicAddress(address: string): boolean;