Compare commits

...
Author SHA1 Message Date
Hermes 0714bf2334 [glm-grade=A] fix(backups): remove dead-shadow POST /backups/schedule handler (DC-057)
The router previously registered two POST /backups/schedule handlers:
  - line 60: canonical appId-keyed handler with premiumGating + Joi schema
  - line 520: dead 'name'-keyed handler, no premiumGating, no validation

Express only matches the FIRST registered handler per METHOD+PATH, so the
line-520 handler was unreachable. It was a latent vulnerability waiting on
a future refactor that swapped handler order (e.g. a route-mount change
like the DC-052 audit-log shadowing fix). If ever reached, it would have
- skipped premium gating (licenseManager.requirePremium not called)
- skipped the Joi schema validation (no validateBody)
- written to config.backups[<name>] (different key shape) and silently
  corrupted the backup schedule config

Cleaned up:
  - 32 lines of dead code removed from dashcaddy-api/routes/backups.js
  - 7-line NOTE comment added at the SCHEDULE ENDPOINTS header warning
    future contributors not to re-add the duplicate
  - 7 new tests in __tests__/routes/backups.schedule.routes.test.js
    covering shadowing, legacy schema rejection, canonical success,
    premium gating, GET/DELETE collateral-safety

Verified:
  - jest 7/7 pass
  - full suite 1889/1889 (4 pre-existing pdfkit MODULE_NOT_FOUND unrelated)
  - eslint 0 errors (18 pre-existing warnings, none on touched lines)
  - frontend (status/js/backup-restore.js) only POSTs the canonical schema
  - 90s GLM-5.3 judge round 1: grade=A, 2 polish suggestions folded

[grade=A]
2026-08-18 03:32:54 -07:00
Krystie 23922923a5 Merge feature/dc-056-aggregate-error-diagnostics: surface AggregateError causes in error.log
CI / Test & Lint (push) Canceled after 0s
CI / Security audit (push) Canceled after 0s
2026-08-18 01:59:43 -07:00
Hermes 3137d4c16d [glm-grade=B] fix(logging): surface AggregateError causes + .cause chains in error.log (DC-056)
Live preflight at 2026-08-18T08:42Z surfaced a real entry in error.log:
  [2026-08-18T06:49:03.345Z] [ERR] update:
  context: {"imageName":"ipfs/kubo:latest"}

The line was terminated with a literal empty <message> because
AggregateError.message is empty by spec — registry-1.docker.io multi-A
timeouts (and any Promise.any / multi-fetch failure) leaked through with
no actionable signal. The only clue was a JSON context tail, and even that
didn't say WHY. Operators / incident-triage scripts that grep error.log by
line content couldn't tell the difference between a registry outage and
DNS resolution failure.

**Fix** (dashcaddy-api/src/utils/logging.js, +70 lines):
- describeErrorChain(err, depth, seen) flattens .errors[] (AggregateError)
  and .cause chains into readable lines, each carrying Name [CODE]: message.
- writeErrorLog builds both the headline (replacing bare error.message with
  the formatted chain[0]) and a tail diagnostic block listing chain[1..].
  Backwards-compat preserved: headline still matches [ERR] ${ctx}: <head>.
- Cycle guard via WeakSet seen: pathological err.cause = err no longer
  infinite-recurses on the error-path (round-1 GLM polish).
- Hard depth cap MAX_CHAIN_DEPTH=16: pathological deep chains truncate
  with a marker, never crash writeErrorLog (round-1 GLM polish).
- Defensive head line for empty err.message: falls back to error.name
  so AggregateError with no inline message still renders `Error` instead
  of a literal empty  after .

**Tests** (__tests__/utils-logging-aggregate-error.test.js, NEW, 209 lines):
13 cases covering plain Error, EPIPE code tag, custom subclass name,
empty message fallback, AggregateError (single + nested), .cause chain,
req field, extra JSON, separator invariant, circular .cause, depth-truncation,
circular .errors[].

GLM judge round 1 (deleg_59155c78, 43.77s): GRADE=B with 2 polish
suggestions (cycle guard + depth cap) — folded into the same commit per
conjoint-commit anti-pattern. Round 2: not needed (the polish is in).

Full suite: 89 suites / 1975 tests pass (+13 net new). ESLint clean.
2026-08-18 01:59:14 -07:00
Hermes ab87c10355 Merge feature/dc-055-journald-viewer: host journald log viewer
CI / Test & Lint (push) Canceled after 0s
CI / Security audit (push) Canceled after 0s
2026-08-18 01:29:45 -07:00
4 changed files with 502 additions and 34 deletions
@@ -0,0 +1,218 @@
/**
* DC-057: dead-shadow /backups/schedule handler removed.
*
* The duplicate `router.post('/backups/schedule', ...)` previously registered
* far below the canonical one was unreachable (Express matches the first
* registered handler per METHOD+PATH). It bypassed `premiumGating` and
* `validateBody` and used a `name`-keyed schema that would have corrupted the
* backup config if it ever ran. The canonical handler uses the error code
* `backups-schedule-update`; the dead handler used `backups-schedule-legacy`.
* This test proves:
*
* 1. The router registers exactly ONE POST /backups/schedule handler
* (the canonical, appId-keyed one).
* 2. No handler references the legacy "backups-schedule-legacy" error code.
* 3. The legacy "name"-keyed schema now produces a 400 ValidationError
* from the canonical Joi schema (dead handler is gone).
* 4. The canonical appId-keyed schema still succeeds (200).
* 5. premiumGating is enforced on the canonical POST.
*
* Mirrors the audit-log.routes.test.js pattern.
*/
const express = require('express');
function buildFakeBackupManager() {
const config = { backups: {}, defaultRetention: { keep: 7 } };
return {
getConfig: jest.fn(() => config),
updateConfig: jest.fn((next) => {
config.backups = next.backups || {};
}),
getHistory: jest.fn(() => []),
restoreBackup: jest.fn(async (id) => {
// Suppress require-await — keep async shape for parity with the
// real backupManager.restoreBackup contract.
return Promise.resolve({ id, status: 'restored' });
}),
};
}
function buildFakeLicenseManager() {
const requirePremium = jest.fn(() => (_req, _res, next) => next());
return {
requirePremium,
isPremium: jest.fn(() => true),
};
}
function buildRouter(licenseManager, backupManager) {
// Reset module cache so each test starts fresh
jest.resetModules();
const mod = require('../../routes/backups');
return mod({
backupManager,
licenseManager,
asyncHandler: (fn) => async (req, res, next) => { // eslint-disable-line require-await
try { await fn(req, res, next); } catch (e) { next(e); }
},
});
}
function buildApp(router) {
// Catch-all error handler so ValidationError / NotFoundError become JSON
const app = express();
app.use(express.json());
app.use((req, res, next) => {
// intentionally strip auth — the test does not exercise it
next();
});
app.use('/', router);
// eslint-disable-next-line no-unused-vars
app.use((err, req, res, next) => {
const status = err.statusCode || err.status || 500;
res.status(status).json({
error: err.message,
code: err.code || 'ERR',
});
});
return app;
}
function supertestFetch(app) {
// Tiny in-process fetch helper (no need to add supertest dep)
const http = require('http');
return function (method, path, body) {
return new Promise((resolve, reject) => {
const server = app.listen(0, () => {
const { port } = server.address();
const data = body ? JSON.stringify(body) : null;
const req = http.request({
method,
hostname: '127.0.0.1',
port,
path,
headers: data ? { 'Content-Type': 'application/json', 'Content-Length': Buffer.byteLength(data) } : {},
}, (res) => {
let chunks = '';
res.on('data', (c) => { chunks += c; });
res.on('end', () => {
server.close();
let parsed;
try { parsed = JSON.parse(chunks); } catch { parsed = chunks; }
resolve({ status: res.statusCode, body: parsed });
});
});
req.on('error', (e) => { server.close(); reject(e); });
if (data) req.write(data);
req.end();
});
});
};
}
describe('routes/backups POST /backups/schedule (DC-057)', () => {
let backupManager, licenseManager, app, fetch;
beforeEach(() => {
backupManager = buildFakeBackupManager();
licenseManager = buildFakeLicenseManager();
const router = buildRouter(licenseManager, backupManager);
app = buildApp(router);
fetch = supertestFetch(app);
});
test('registers exactly ONE POST /backups/schedule handler (canonical)', () => {
// Inspect the registered router layers and confirm only one POST /backups/schedule
// route exists (no shadowed / unreachable duplicate).
const router = buildRouter(licenseManager, backupManager);
const seen = [];
router.stack.forEach((layer) => {
if (layer.route && layer.route.path === '/backups/schedule' && layer.route.methods.post) {
seen.push(layer.route);
}
});
expect(seen).toHaveLength(1);
});
test('no handler references the legacy "backups-schedule-legacy" error code', () => {
// The canonical handler uses error code 'backups-schedule-update'.
// Walk the router stack and assert no route uses the legacy error code.
const router = buildRouter(licenseManager, backupManager);
const handlerStrings = [];
function walk(node) {
if (!node) return;
if (node.stack) node.stack.forEach(walk);
if (node.handle) {
const code = node.handle.toString();
handlerStrings.push(code);
}
}
walk(router);
const all = handlerStrings.join('\n');
expect(all).not.toContain('backups-schedule-legacy');
});
test('legacy name-keyed schema is REJECTED with 400 (dead route truly gone)', async () => {
// The dead handler accepted { name, schedule, maxStorageBytes, ...backupConfig }.
// After removal, the canonical Joi schema (backupScheduleCreate) rejects this
// shape because it requires `appId`. So we expect a 400.
const res = await fetch('POST', '/backups/schedule', {
name: 'mybackup',
schedule: 'daily',
maxStorageBytes: 1024,
});
expect(res.status).toBe(400);
expect(res.body.error).toMatch(/appId.*required|appId is required/i);
});
test('canonical appId-keyed schema SUCCEEDS (200) and writes backup config', async () => {
const res = await fetch('POST', '/backups/schedule', {
appId: 'plex',
schedule: 'daily',
retention: { keep: 7 },
destination: 'local',
destinationPath: '/var/backups/plex',
maxStorageBytes: 1024,
});
expect(res.status).toBe(200);
expect(res.body.success).toBe(true);
expect(backupManager.updateConfig).toHaveBeenCalledTimes(1);
const written = backupManager.updateConfig.mock.calls[0][0];
expect(written.backups).toHaveProperty('plex');
expect(written.backups.plex.schedule).toBe('daily');
expect(written.backups.plex.enabled).toBe(true);
expect(written.backups.plex.maxStorageBytes).toBe(1024);
});
test('premium gating is enforced on POST /backups/schedule', async () => {
// Replace the premium gate with one that 403s, then verify it runs.
licenseManager.requirePremium.mockReturnValueOnce(
(_req, res) => res.status(403).json({ error: 'premium required' }),
);
const router = buildRouter(licenseManager, backupManager);
app = buildApp(router);
fetch = supertestFetch(app);
const res = await fetch('POST', '/backups/schedule', {
appId: 'plex',
schedule: 'daily',
});
expect(res.status).toBe(403);
expect(backupManager.updateConfig).not.toHaveBeenCalled();
});
test('GET /backups/schedule still works (no collateral damage)', async () => {
const res = await fetch('GET', '/backups/schedule');
expect(res.status).toBe(200);
expect(res.body.success).toBe(true);
expect(res.body).toHaveProperty('schedules');
});
test('DELETE /backups/schedule/:appId still works', async () => {
// Seed the config so the delete has something to remove
backupManager.getConfig().backups.plex = { schedule: 'daily' };
const res = await fetch('DELETE', '/backups/schedule/plex');
expect(res.status).toBe(200);
expect(backupManager.updateConfig).toHaveBeenCalled();
});
});
@@ -0,0 +1,209 @@
/**
* Tests for AggregateError / .cause-chain diagnostic surfacing in
* src/utils/logging.js writeErrorLog().
*
* Bug fixed: writeErrorLog previously emitted `error.message` alone.
* AggregateError's `.message` is "" by spec, so a real aggregate (e.g.
* `await Promise.any([fetch(...), fetch(...)])` or a multi-A DNS lookup
* that times out) ended up in error.log as a single empty line:
*
* [2026-08-18T06:49:03.345Z] [ERR] update:
* context: {"imageName":"ipfs/kubo:latest"}
*
* Operators couldn't tell why the check failed. This file asserts the
* fixed behavior:
*
* - AggregateError → emits a diagnostic block listing each sub-error's
* .code/.message.
* - Regular Error → no spurious diagnostic block.
* - Plain Error with `.code` (e.g. EPIPE) → head now shows
* `Error [EPIPE]: write EPIPE` (regression: `code` used to be dropped).
* - Error wrapping another Error via `.cause` → lists the cause.
* - AggregateError with mixed sub-errors (some Aggregate, some plain) →
* recurses correctly without losing any message.
* - Empty error.message is replaced with the error name so a bare
* AggregateError still renders something readable.
*
* log.error signature on this codebase: error(ctx, err, req?, extra?)
* where extra is the JSON tail (and req is the Express req if any).
*/
const path = require('path');
const fs = require('fs').promises;
const os = require('os');
// Important: set LOG_DIR / ERROR_LOG_FILE BEFORE requiring logging.js so
// the per-test temp file is used as the log target.
const tmpDir = fs.realpathSync ? require('fs').realpathSync(os.tmpdir()) : os.tmpdir();
const TMP_LOG = path.join(tmpDir, `dashcaddy-error-test-${process.pid}-${Date.now()}-${Math.random().toString(36).slice(2)}.log`);
process.env.LOG_DIR = tmpDir;
process.env.ERROR_LOG_FILE = TMP_LOG;
process.env.AUDIT_LOG_FILE = path.join(tmpDir, 'unused-audit.json');
const { log } = require('../src/utils/logging');
async function readTail(n = 1) {
const raw = await fs.readFile(TMP_LOG, 'utf8').catch(() => '');
const sep = '\u2500'.repeat(72);
const entries = raw.split(sep).map(s => s.replace(/^\s+|\s+$/g, '')).filter(Boolean);
return entries.slice(-n);
}
describe('writeErrorLog() — AggregateError + .cause diagnostics', () => {
afterAll(async () => {
try { await fs.unlink(TMP_LOG); } catch (_) {}
});
beforeEach(async () => {
try { await fs.unlink(TMP_LOG); } catch (_) {}
});
test('plain Error: head contains name + message + stack', async () => {
await log.error('plain', new Error('boom'), null, { requestId: 'r1' });
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] plain: Error: boom/);
expect(entry).not.toMatch(/diagnostic:/); // no spurious diagnostic block
expect(entry).toMatch(/\n {4}at /); // stack preserved (lowercase `at` from V8)
expect(entry).toMatch(/context: \{.*requestId.*"r1".*\}/);
});
test('plain Error with .code renders the code in the head (regression fix)', async () => {
const e = Object.assign(new Error('write EPIPE'), { code: 'EPIPE' });
await log.error('stream', e);
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] stream: Error \[EPIPE\]: write EPIPE/);
expect(entry).not.toMatch(/diagnostic:/);
});
test('custom Error subclass name is preserved in the head', async () => {
class WidgetError extends Error {
constructor(msg) { super(msg); this.name = 'WidgetError'; }
}
await log.error('sub', new WidgetError('blew up'));
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] sub: WidgetError: blew up/);
});
test('empty error.message falls back to the bare error.name (defensive)', async () => {
const empty = new Error('');
await log.error('empty', empty);
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] empty: Error$/m);
});
test('AggregateError with sub-errors emits a diagnostic block listing each cause', async () => {
// Realistic shape: registry-1.docker.io multi-A lookup timeout returning
// an AggregateError of ECONNREFUSED / Timeout / EAI_AGAIN sub-errors.
const agg = new AggregateError(
[
Object.assign(new Error('connect ECONNREFUSED 157.240.20.50:443'), { code: 'ECONNREFUSED' }),
Object.assign(new Error('connect ETIMEDOUT 157.240.21.50:443'), { code: 'ETIMEDOUT' }),
Object.assign(new Error('getaddrinfo EAI_AGAIN registry-1.docker.io'), { code: 'EAI_AGAIN' }),
],
''
);
await log.error('update', agg, null, { imageName: 'ipfs/kubo:latest' });
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] update: AggregateError/);
expect(entry).toMatch(/diagnostic:/);
expect(entry).toMatch(/cause #1:/);
expect(entry).toMatch(/cause #2:/);
expect(entry).toMatch(/cause #3:/);
expect(entry).toMatch(/Error \[ECONNREFUSED\]: connect ECONNREFUSED 157\.240\.20\.50:443/);
expect(entry).toMatch(/Error \[ETIMEDOUT\]: connect ETIMEDOUT 157\.240\.21\.50:443/);
expect(entry).toMatch(/Error \[EAI_AGAIN\]: getaddrinfo EAI_AGAIN registry-1\.docker\.io/);
expect(entry).toMatch(/context: \{.*imageName.*"ipfs\/kubo:latest".*\}/);
// No double header for AggregateError (we suppress the empty head line).
expect(entry).not.toMatch(/diagnostic: AggregateError/);
});
test('Error with .cause emits a nested diagnostic block', async () => {
const inner = new Error('TLS handshake failed');
const outer = new Error('fetch failed', { cause: inner });
await log.error('net', outer);
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] net: Error: fetch failed/);
expect(entry).toMatch(/cause:/);
expect(entry).toMatch(/Error: TLS handshake failed/);
});
test('nested AggregateError (sub-error is itself an Aggregate) recurses', async () => {
const inner = new AggregateError([new Error('inner-A'), new Error('inner-B')], '');
const outer = new AggregateError([new Error('outer-X'), inner], '');
await log.error('rec', outer);
const [entry] = await readTail();
expect(entry).toMatch(/\[ERR\] rec: AggregateError/);
expect(entry).toMatch(/cause #1:[\s\S]*Error: outer-X/);
// inner is itself an Aggregate, so its child errors surface as "cause #N":
expect(entry).toMatch(/inner-A/);
expect(entry).toMatch(/inner-B/);
});
test('separator is appended after each entry (file-format invariant)', async () => {
await log.error('sep', new Error('one'));
await log.error('sep', new Error('two'));
const raw = await fs.readFile(TMP_LOG, 'utf8');
const sep = '\u2500'.repeat(72);
// Count separator occurrences without reserved regex chars tripping us up.
const re = new RegExp(sep.split('').map(c => '\\u' + c.charCodeAt(0).toString(16).padStart(4, '0')).join(''), 'g');
const occurrences = (raw.match(re) || []).length;
expect(occurrences).toBeGreaterThanOrEqual(2);
});
test('req field is still emitted when the calling site passes a request', async () => {
const req = { method: 'POST', path: '/api/v1/widgets', ip: '10.0.0.5', get: () => 'curl/8', id: 'r-42' };
await log.error('withreq', new Error('widget blew up'), req);
const [entry] = await readTail();
expect(entry).toMatch(/request: POST \/api\/v1\/widgets \| ip: 10\.0\.0\.5 \| ua: curl\/8 \| id: r-42/);
});
test('extra context JSON is still emitted after stack (regression)', async () => {
await log.error('ctx', new Error('payload'), null, { operation: 'rotate', tenantId: 7 });
const [entry] = await readTail();
expect(entry).toMatch(/context: \{"operation":"rotate","tenantId":7\}/);
});
// Polish-grade hardening (per GLM round-1 B+ findings): cycle guard + depth cap.
test('circular .cause references do not infinite-loop (cycle guard)', async () => {
const a = new Error('top');
const b = new Error('middle');
const c = new Error('bottom');
// c.cause = b would be normal; force a CYCLE by linking back to a.
b.cause = a;
a.cause = c;
c.cause = a; // cycle: a <-> a
await expect(log.error('cycle', a, null)).resolves.not.toThrow();
const [entry] = await readTail();
expect(entry).toMatch(/top/);
expect(entry).toMatch(/cycle: same Error instance seen earlier/);
});
test('excessively deep .cause chains are truncated, not crashed (depth cap)', async () => {
// Build a chain 50 deep ending in 'level-50' at the deepest; each layer
// wraps the previous via .cause. log.error is called with the deepest
// (outer) Error.
let cur = new Error('level-1');
for (let i = 2; i <= 50; i++) {
const parent = new Error(`level-${i}`);
parent.cause = cur;
cur = parent;
}
await expect(log.error('deep', cur)).resolves.not.toThrow();
const [entry] = await readTail();
expect(entry).toMatch(/chain truncated at depth 16/);
expect(entry).toMatch(/level-50/); // the deepest/head shown in headline
expect(entry).not.toMatch(/level-1/); // the leaf is too deep to render
});
test('circular `.errors` array (sub-error is itself in the parent) is bounded', async () => {
const sub = new Error('shared sub-error');
const agg = new AggregateError([sub, new Error('other')], '');
// pathological: sub-Aggregate references the parent
sub.errors = [agg];
await expect(log.error('aggcycle', agg)).resolves.not.toThrow();
const [entry] = await readTail();
expect(entry).toMatch(/shared sub-error/);
expect(entry).toMatch(/cycle: same Error instance seen earlier/);
});
});
+7 -32
View File
@@ -22,6 +22,13 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
const router = express.Router();
// ==================== SCHEDULE ENDPOINTS (PREMIUM) ====================
// NOTE: POST /backups/schedule has a single canonical registration below
// (the appId-keyed handler at the top of this section). Earlier versions
// registered a duplicate "name"-keyed handler later in the file — Express
// only matches the first registered handler per METHOD+PATH, so the
// duplicate was unreachable dead code. Do not re-add it; if you need a
// different schema, change the canonical Joi schema in
// src/utilities/validate.js (backupScheduleCreate) instead.
// Apply premium gating to schedule-related routes
const premiumGating = licenseManager.requirePremium('auto-backup');
@@ -511,38 +518,6 @@ module.exports = function({ backupManager, licenseManager, asyncHandler }) {
success(res, storageInfo);
}, 'backups-storage-info'));
// Schedule a backup
// LEGACY: this is a duplicate registration of POST /backups/schedule (see also line 60,
// which uses the appId-keyed schema and is the route the frontend actually calls).
// Express only matches the first registered handler per METHOD+PATH, so this handler
// is unreachable. It is preserved for now to avoid removing a route any unknown
// integration might still POST to. TODO: audit + remove in a dedicated cleanup PR.
router.post('/backups/schedule', asyncHandler(async (req, res) => {
const { name, schedule, maxStorageBytes, ...backupConfig } = req.body;
if (!name || !schedule) {
return res.status(400).json({ error: 'name and schedule are required' });
}
const config = backupManager.getConfig();
// Store maxStorageBytes in the backup config (converted to bytes)
const maxBytes = typeof maxStorageBytes === 'number' && maxStorageBytes > 0
? maxStorageBytes
: (typeof maxStorageBytes === 'string' ? parseStorageSize(maxStorageBytes) : 0);
config.backups[name] = {
...backupConfig,
enabled: true,
schedule,
maxStorageBytes: maxBytes,
destinations: backupConfig.destinations || [{ type: 'local' }]
};
backupManager.updateConfig(config);
success(res, { message: `Backup '${name}' scheduled`, maxStorageBytes: maxBytes });
}, 'backups-schedule-legacy'));
// Restore from backup
router.post('/backups/restore/:backupId', validateBody(schemas.backupRestore), asyncHandler(async (req, res) => {
const result = await backupManager.restoreBackup(req.params.backupId, req.body);
+68 -2
View File
@@ -112,12 +112,78 @@ async function appendErrorLog(line) {
}
}
// Flatten an error chain into readable lines so error.log records why a
// request failed, not just that it did. Handle AggregateError (`.errors[]`,
// common from lookups/DNS-fetch timeouts) and the modern `.cause` chain —
// both common in Node 18+ networking. Always returns at least one line
// (a head line with `name [code]: message`), and appends cause lines for
// any `.errors` / `.cause` chains present.
//
// Defensive against:
// - Circular `.cause` references (a pathological error payload pointing
// `err.cause = err` would otherwise infinite-recurse and crash the
// error-path). Visited set carries forward via parameter.
// - Excessively deep chains (> MAX_CHAIN_DEPTH): truncated with a marker
// so the operator can see something IS coming from underneath.
const MAX_CHAIN_DEPTH = 16;
function describeErrorChain(err, depth = 0, seen = new WeakSet()) {
const out = [];
if (depth > MAX_CHAIN_DEPTH) {
out.push(`${' '.repeat(depth)} ... (chain truncated at depth ${MAX_CHAIN_DEPTH})`);
return out;
}
if (!(err instanceof Error)) {
out.push(`${' '.repeat(depth)}${String(err)}`);
return out;
}
// Cycle guard — same Error instance already on the chain.
if (seen.has(err)) {
out.push(`${' '.repeat(depth)} ... (cycle: same Error instance seen earlier)`);
return out;
}
seen.add(err);
const indent = ' '.repeat(depth);
const code = err.code ? ` [${err.code}]` : '';
const msg = err.message ? `: ${err.message}` : '';
// For every error (including AggregateError), render the head line; an
// empty `.message` simply produces `Name [code]:` which is still useful.
out.push(`${indent}${err.name || 'Error'}${code}${msg}`);
if (Array.isArray(err.errors) && err.errors.length) {
err.errors.forEach((sub, i) => {
out.push(`${indent} cause #${i + 1}:`);
out.push(...describeErrorChain(sub, depth + 2, seen));
});
}
if (err.cause instanceof Error) {
out.push(`${indent} cause:`);
out.push(...describeErrorChain(err.cause, depth + 2, seen));
}
return out;
}
async function writeErrorLog(ctx, error, req, extra) {
const ts = new Date().toISOString();
const errMsg = error instanceof Error ? error.message : String(error);
const errStack = error instanceof Error ? error.stack : '';
const parts = [`[${ts}] [ERR] ${ctx}: ${errMsg}`];
// Build the head line AND a tail diagnostic from the same describeErrorChain,
// so plain errors with .code get `[CODE]` formatted into the head (regression)
// and AggregateError with empty `.message` gets a diagnostic block listing
// every cause (the actual bug fix).
let headLine;
let diagLines = [];
if (error instanceof Error) {
const chain = describeErrorChain(error);
// The chain head is always the error itself (now including AggregateError),
// so chain[0] is what we want in the headline and chain[1..] is the rest.
headLine = chain[0] || `${error.name || 'Error'}`;
diagLines = chain.slice(1);
} else {
headLine = String(error);
}
// Preserve the historical `ctx: <head>` shape so log scrapers don't break.
// The head now carries `name [code]: message` instead of bare `.message`.
const parts = [`[${ts}] [ERR] ${ctx}: ${headLine.replace(/^\s+/, '')}`];
if (errStack) parts.push(errStack);
if (diagLines.length) parts.push(' diagnostic: ' + diagLines.join('\n diagnostic: '));
if (req) {
const ip = req.ip || req.socket?.remoteAddress || '';
const ua = req.get ? req.get('user-agent') : '';