Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
678a0160c4 | ||
|
|
30d5fdbb2c | ||
|
|
71d20ceef3 | ||
|
|
87f76aef66 |
@@ -336,32 +336,77 @@ describe('AutoRestartManager', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe('_resolveContainerId', () => {
|
describe('_resolveContainerId', () => {
|
||||||
test('returns containerId from status.details when present', () => {
|
test('returns containerId from status.details when present', async () => {
|
||||||
const { manager } = makeManager();
|
const { manager } = makeManager();
|
||||||
const cid = manager._resolveContainerId('svc-1', { details: { containerId: 'cid-details' } });
|
const cid = await manager._resolveContainerId('svc-1', { details: { containerId: 'cid-details' } });
|
||||||
expect(cid).toBe('cid-details');
|
expect(cid).toBe('cid-details');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('falls back to healthChecker.config.services[serviceId].containerId', () => {
|
test('falls back to healthChecker.config.services[serviceId].containerId', async () => {
|
||||||
const { manager, healthChecker } = makeManager();
|
const { manager, healthChecker } = makeManager();
|
||||||
healthChecker.config = { services: { 'svc-1': { containerId: 'cid-hc' } } };
|
healthChecker.config = { services: { 'svc-1': { containerId: 'cid-hc' } } };
|
||||||
const cid = manager._resolveContainerId('svc-1', { details: {} });
|
const cid = await manager._resolveContainerId('svc-1', { details: {} });
|
||||||
expect(cid).toBe('cid-hc');
|
expect(cid).toBe('cid-hc');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('falls back to servicesStateManager.read when sync list is returned', () => {
|
test('DC-060: awaits async servicesStateManager.read() and resolves containerId', async () => {
|
||||||
|
// Regression test for the auto-restart silently no-op bug:
|
||||||
|
// _resolveContainerId used to fire servicesStateManager.read() via
|
||||||
|
// .then(...) and discard the result. Callers gated on the return
|
||||||
|
// value, so a healthy→unhealthy transition whose only containerId
|
||||||
|
// source was the async state manager never triggered handleContainerDown.
|
||||||
const { manager, servicesStateManager } = makeManager();
|
const { manager, servicesStateManager } = makeManager();
|
||||||
servicesStateManager.read.mockReturnValue([
|
servicesStateManager.read.mockResolvedValue([
|
||||||
{ id: 'svc-1', containerId: 'cid-state' },
|
{ id: 'svc-1', containerId: 'cid-state' },
|
||||||
]);
|
]);
|
||||||
const cid = manager._resolveContainerId('svc-1', { details: {} });
|
const cid = await manager._resolveContainerId('svc-1', { details: {} });
|
||||||
expect(cid).toBe('cid-state');
|
expect(cid).toBe('cid-state');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('returns null when no source has a containerId', () => {
|
test('returns null when no source has a containerId', async () => {
|
||||||
const { manager } = makeManager();
|
const { manager } = makeManager();
|
||||||
const cid = manager._resolveContainerId('svc-unknown', { details: {} });
|
const cid = await manager._resolveContainerId('svc-unknown', { details: {} });
|
||||||
|
expect(cid).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('swallows servicesStateManager.read() rejection', async () => {
|
||||||
|
const { manager, servicesStateManager } = makeManager();
|
||||||
|
servicesStateManager.read.mockRejectedValue(new Error('disk gone'));
|
||||||
|
const cid = await manager._resolveContainerId('svc-1', { details: {} });
|
||||||
expect(cid).toBeNull();
|
expect(cid).toBeNull();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('DC-060: healthy→unhealthy transitions trigger restart via async lookup', () => {
|
||||||
|
test('handleContainerDown is invoked with containerId from async state-manager lookup', async () => {
|
||||||
|
// End-to-end: containerId comes ONLY from servicesStateManager.read()
|
||||||
|
// (the production path for services.json-backed deployments).
|
||||||
|
const { manager, docker, servicesStateManager } = makeManager();
|
||||||
|
docker.client.getContainer.mockReturnValue({
|
||||||
|
start: jest.fn().mockResolvedValue(undefined),
|
||||||
|
});
|
||||||
|
await manager.setPolicy('svc-1', { maxRetries: 3, retryIntervalMs: 0 });
|
||||||
|
manager._previousHealth.set('svc-1', 'up');
|
||||||
|
servicesStateManager.read.mockResolvedValue([
|
||||||
|
{ id: 'svc-1', containerId: 'cid-from-state' },
|
||||||
|
]);
|
||||||
|
|
||||||
|
const handleDownSpy = jest.spyOn(manager, 'handleContainerDown');
|
||||||
|
await manager._handleStatusCheck({ serviceId: 'svc-1', status: 'down' });
|
||||||
|
expect(handleDownSpy).toHaveBeenCalledWith('svc-1', 'cid-from-state');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('handleContainerDown is NOT invoked when async lookup returns no containerId', async () => {
|
||||||
|
const { manager, servicesStateManager } = makeManager();
|
||||||
|
await manager.setPolicy('svc-1', { maxRetries: 3, retryIntervalMs: 0 });
|
||||||
|
manager._previousHealth.set('svc-1', 'up');
|
||||||
|
servicesStateManager.read.mockResolvedValue([
|
||||||
|
{ id: 'svc-1' /* no containerId */ },
|
||||||
|
]);
|
||||||
|
|
||||||
|
const handleDownSpy = jest.spyOn(manager, 'handleContainerDown');
|
||||||
|
await manager._handleStatusCheck({ serviceId: 'svc-1', status: 'down' });
|
||||||
|
expect(handleDownSpy).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,277 @@
|
|||||||
|
/**
|
||||||
|
* DC-059: disk-space POST /config threshold-ordering invariant.
|
||||||
|
*
|
||||||
|
* DiskSpaceMonitor._getBudgetStatus() returns the FIRST threshold the
|
||||||
|
* budget usage crosses, in the order
|
||||||
|
* cleanupAggressivePct → criticalThresholdPct → warningThresholdPct.
|
||||||
|
* If a caller writes the three thresholds out of order
|
||||||
|
* (e.g. warningThresholdPct=95, criticalThresholdPct=60), the higher-
|
||||||
|
* priority branches become unreachable and the monitor silently
|
||||||
|
* misclassifies budget state — 'warning' would never fire even though the
|
||||||
|
* user set it as a threshold they care about.
|
||||||
|
*
|
||||||
|
* The fix lives in `routes/disk-space.js`: a `mergeAndCheckOrdering()`
|
||||||
|
* helper validates the *effective* (merged with live baseline) config
|
||||||
|
* against the invariant `warningThresholdPct < criticalThresholdPct <
|
||||||
|
* cleanupAggressivePct` BEFORE the route mutates diskSpaceMonitor.diskConfig.
|
||||||
|
*
|
||||||
|
* Tests cover:
|
||||||
|
* 1. Monotonic ascending order is accepted (happy path).
|
||||||
|
* 2. warningThresholdPct >= criticalThresholdPct is rejected with 400.
|
||||||
|
* 3. criticalThresholdPct >= cleanupAggressivePct is rejected with 400.
|
||||||
|
* 4. Partial updates work one field at a time without violating the
|
||||||
|
* invariant against the current baseline.
|
||||||
|
* 5. Out-of-bounds numeric values are clamped to the same bounds the
|
||||||
|
* original inline Math.min/Math.max chains enforced (50/60/70 → 99).
|
||||||
|
* 6. DiskSpaceMonitor.configure is NEVER called when the request is
|
||||||
|
* rejected (no partial mutation).
|
||||||
|
* 7. The merged config returned to the client is the post-clamp value,
|
||||||
|
* not the raw request body.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const express = require('express');
|
||||||
|
const http = require('http');
|
||||||
|
|
||||||
|
const DEFAULT_CONFIG = {
|
||||||
|
enabled: true,
|
||||||
|
diskBudgetGB: 10,
|
||||||
|
warningThresholdPct: 80,
|
||||||
|
criticalThresholdPct: 90,
|
||||||
|
autoCleanup: true,
|
||||||
|
cleanupAggressivePct: 95,
|
||||||
|
};
|
||||||
|
|
||||||
|
function buildFakeDiskSpaceMonitor(initial = { ...DEFAULT_CONFIG }) {
|
||||||
|
const state = { ...initial };
|
||||||
|
return {
|
||||||
|
configure: jest.fn((updates) => {
|
||||||
|
Object.assign(state, updates);
|
||||||
|
return { ...state };
|
||||||
|
}),
|
||||||
|
getConfig: jest.fn(() => ({ ...state })),
|
||||||
|
getSnapshot: jest.fn(async () => ({})),
|
||||||
|
getDetailedBreakdown: jest.fn(async () => ({})),
|
||||||
|
performCleanup: jest.fn(async () => ({})),
|
||||||
|
// Test-only: peek at the internal state to confirm no mutation on rejection
|
||||||
|
_state: state,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildRouter(monitor) {
|
||||||
|
// Reset module cache so each test starts fresh
|
||||||
|
jest.resetModules();
|
||||||
|
const mod = require('../../routes/disk-space');
|
||||||
|
return mod({
|
||||||
|
diskSpaceMonitor: monitor,
|
||||||
|
asyncHandler: (fn) => async (req, res, next) => { // eslint-disable-line require-await
|
||||||
|
try { await fn(req, res, next); } catch (e) { next(e); }
|
||||||
|
},
|
||||||
|
log: { info: jest.fn(), warn: jest.fn(), error: jest.fn() },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildApp(router) {
|
||||||
|
const app = express();
|
||||||
|
app.use(express.json());
|
||||||
|
app.use((req, _res, next) => { next(); }); // strip auth
|
||||||
|
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',
|
||||||
|
field: err.field || null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
function supertestFetch(app) {
|
||||||
|
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/disk-space POST /config (DC-059 threshold ordering)', () => {
|
||||||
|
let monitor, app, fetch;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
monitor = buildFakeDiskSpaceMonitor();
|
||||||
|
const router = buildRouter(monitor);
|
||||||
|
app = buildApp(router);
|
||||||
|
fetch = supertestFetch(app);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('happy path — strict monotonic ascending order is accepted', async () => {
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 75,
|
||||||
|
criticalThresholdPct: 88,
|
||||||
|
cleanupAggressivePct: 95,
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config).toEqual(expect.objectContaining({
|
||||||
|
warningThresholdPct: 75,
|
||||||
|
criticalThresholdPct: 88,
|
||||||
|
cleanupAggressivePct: 95,
|
||||||
|
}));
|
||||||
|
expect(monitor.configure).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('warningThresholdPct >= criticalThresholdPct is rejected with 400', async () => {
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 95,
|
||||||
|
criticalThresholdPct: 80,
|
||||||
|
cleanupAggressivePct: 99,
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(res.body.error).toMatch(/warningThresholdPct.*strictly less than.*criticalThresholdPct/);
|
||||||
|
expect(res.body.field).toBe('warningThresholdPct');
|
||||||
|
// Critical invariant: monitor.configure was NEVER called.
|
||||||
|
expect(monitor.configure).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('criticalThresholdPct >= cleanupAggressivePct is rejected with 400', async () => {
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 60,
|
||||||
|
criticalThresholdPct: 95,
|
||||||
|
cleanupAggressivePct: 80,
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(res.body.error).toMatch(/criticalThresholdPct.*strictly less than.*cleanupAggressivePct/);
|
||||||
|
expect(res.body.field).toBe('criticalThresholdPct');
|
||||||
|
expect(monitor.configure).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('equal thresholds are rejected (strict <, not <=)', async () => {
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 80,
|
||||||
|
criticalThresholdPct: 80,
|
||||||
|
cleanupAggressivePct: 90,
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(monitor.configure).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('partial update — single field accepted against existing baseline', async () => {
|
||||||
|
// Defaults: warning=80, critical=90, aggressive=95. Raise warning to 85.
|
||||||
|
const res = await fetch('POST', '/config', { warningThresholdPct: 85 });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config.warningThresholdPct).toBe(85);
|
||||||
|
expect(res.body.config.criticalThresholdPct).toBe(90);
|
||||||
|
expect(res.body.config.cleanupAggressivePct).toBe(95);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('partial update — would violate invariant against baseline, rejected', async () => {
|
||||||
|
// Defaults: warning=80, critical=90, aggressive=95. Setting warning=95
|
||||||
|
// would collide with the existing critical=90 (warning >= critical).
|
||||||
|
const res = await fetch('POST', '/config', { warningThresholdPct: 95 });
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(res.body.error).toMatch(/warningThresholdPct.*strictly less than.*criticalThresholdPct/);
|
||||||
|
expect(monitor.configure).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
test('partial update — succeeds after baseline was updated in a prior request', async () => {
|
||||||
|
// First request: bump warning from 80 → 85 (within current critical=90).
|
||||||
|
let res = await fetch('POST', '/config', { warningThresholdPct: 85 });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
// Second request: now bump warning from 85 → 89. Still under critical=90.
|
||||||
|
res = await fetch('POST', '/config', { warningThresholdPct: 89 });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(monitor.configure).toHaveBeenCalledTimes(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('partial update — would violate against the NEW baseline, rejected', async () => {
|
||||||
|
// Step 1: raise warning to 85.
|
||||||
|
let res = await fetch('POST', '/config', { warningThresholdPct: 85 });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
// Step 2: try to raise warning to 95 — would collide with critical=90.
|
||||||
|
res = await fetch('POST', '/config', { warningThresholdPct: 95 });
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
// monitor.configure should have run exactly once (the accepted request).
|
||||||
|
expect(monitor.configure).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('out-of-bounds values are clamped to documented ranges', async () => {
|
||||||
|
// Note: the three values must produce a valid monotonic ordering AFTER
|
||||||
|
// clamping. Setting warning=20 (→ 50), critical=200 (→ 99), aggressive=70
|
||||||
|
// would produce critical=99 > aggressive=70 which is rejected by the
|
||||||
|
// ordering check. Use values that clamp into a valid range.
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 20, // below warning min 50 → clamped to 50
|
||||||
|
criticalThresholdPct: 85, // valid
|
||||||
|
cleanupAggressivePct: 200, // above aggressive max 99 → clamped to 99
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config).toEqual(expect.objectContaining({
|
||||||
|
warningThresholdPct: 50,
|
||||||
|
criticalThresholdPct: 85,
|
||||||
|
cleanupAggressivePct: 99,
|
||||||
|
}));
|
||||||
|
});
|
||||||
|
|
||||||
|
test('non-numeric threshold values are silently dropped (legacy behaviour preserved)', async () => {
|
||||||
|
// Strings are not numbers → unchanged from baseline. Confirms the
|
||||||
|
// ordering check doesn\'t reject legitimate "I didn\'t change this" requests.
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: '80',
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config.warningThresholdPct).toBe(80); // baseline unchanged
|
||||||
|
expect(monitor.configure).toHaveBeenCalledWith({}); // empty updates
|
||||||
|
});
|
||||||
|
|
||||||
|
test('diskBudgetGB and autoCleanup updates still work alongside threshold validation', async () => {
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
diskBudgetGB: 50,
|
||||||
|
autoCleanup: false,
|
||||||
|
warningThresholdPct: 81,
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config.diskBudgetGB).toBe(50);
|
||||||
|
expect(res.body.config.autoCleanup).toBe(false);
|
||||||
|
expect(res.body.config.warningThresholdPct).toBe(81);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('rejected request does NOT mutate the live diskConfig', async () => {
|
||||||
|
const before = { ...monitor._state };
|
||||||
|
const res = await fetch('POST', '/config', {
|
||||||
|
warningThresholdPct: 95, // collides with critical=90
|
||||||
|
});
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(monitor._state).toEqual(before);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('POST /config with no thresholds in body is a no-op against baseline', async () => {
|
||||||
|
const res = await fetch('POST', '/config', { diskBudgetGB: 25 });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body.config.diskBudgetGB).toBe(25);
|
||||||
|
expect(res.body.config.warningThresholdPct).toBe(80); // unchanged
|
||||||
|
expect(res.body.config.criticalThresholdPct).toBe(90); // unchanged
|
||||||
|
expect(res.body.config.cleanupAggressivePct).toBe(95); // unchanged
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,10 +1,17 @@
|
|||||||
/**
|
/**
|
||||||
* DC-076: Tests for the dashboard WebSocket server
|
* DC-076 / DC-061: Tests for the dashboard WebSocket server
|
||||||
|
*
|
||||||
|
* DC-061 added:
|
||||||
|
* - Real authVerifier injection (no string-presence-only check)
|
||||||
|
* - Rejection of bare cookies / token query params
|
||||||
|
* - close() detaches only OUR listeners (not shared SSE listeners)
|
||||||
|
* - Message size cap (16 KB)
|
||||||
|
* - parseCookieHeader unit coverage
|
||||||
*/
|
*/
|
||||||
const http = require('http');
|
const http = require('http');
|
||||||
const WebSocket = require('ws');
|
const WebSocket = require('ws');
|
||||||
const EventEmitter = require('events');
|
const EventEmitter = require('events');
|
||||||
const createDashboardWS = require('../../src/websocket/dashboard-ws');
|
const { createDashboardWS, parseCookieHeader } = require('../../src/websocket/dashboard-ws');
|
||||||
|
|
||||||
function createMockServer() {
|
function createMockServer() {
|
||||||
return http.createServer((req, res) => {
|
return http.createServer((req, res) => {
|
||||||
@@ -13,23 +20,38 @@ function createMockServer() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build a stub verifier that mimics the production `session.isValid`
|
||||||
|
* shape: takes an IncomingMessage-ish request, returns true iff the
|
||||||
|
* session cookie value is a non-empty string.
|
||||||
|
*/
|
||||||
|
function cookieValueVerifier() {
|
||||||
|
return (req) => {
|
||||||
|
const parsed = parseCookieHeader(req && req.headers && req.headers.cookie);
|
||||||
|
const raw = parsed.dashcaddy_session;
|
||||||
|
return typeof raw === 'string' && raw.length > 0;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
describe('DC-076: Dashboard WebSocket', () => {
|
describe('DC-076: Dashboard WebSocket', () => {
|
||||||
let server, wsServer, port;
|
let server, wsServer, port;
|
||||||
|
let resourceMonitor, healthChecker, updateManager;
|
||||||
|
|
||||||
beforeEach((done) => {
|
beforeEach((done) => {
|
||||||
server = createMockServer();
|
server = createMockServer();
|
||||||
server.listen(0, () => {
|
server.listen(0, () => {
|
||||||
port = server.address().port;
|
port = server.address().port;
|
||||||
|
|
||||||
const resourceMonitor = new EventEmitter();
|
resourceMonitor = new EventEmitter();
|
||||||
const healthChecker = new EventEmitter();
|
healthChecker = new EventEmitter();
|
||||||
const updateManager = new EventEmitter();
|
updateManager = new EventEmitter();
|
||||||
|
|
||||||
wsServer = createDashboardWS(server, {
|
wsServer = createDashboardWS(server, {
|
||||||
resourceMonitor,
|
resourceMonitor,
|
||||||
healthChecker,
|
healthChecker,
|
||||||
updateManager,
|
updateManager,
|
||||||
log: { info: jest.fn(), error: jest.fn() },
|
authVerifier: cookieValueVerifier(),
|
||||||
|
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
|
||||||
});
|
});
|
||||||
done();
|
done();
|
||||||
});
|
});
|
||||||
@@ -40,19 +62,19 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
server.close(done);
|
server.close(done);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('accepts connections at the upgrade path', (done) => {
|
it('accepts connections at the upgrade path with a session cookie', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
ws.on('open', () => {
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
ws.close();
|
|
||||||
});
|
|
||||||
ws.on('close', () => {
|
|
||||||
done();
|
|
||||||
});
|
});
|
||||||
|
ws.on('open', () => ws.close());
|
||||||
|
ws.on('close', () => done());
|
||||||
ws.on('error', done);
|
ws.on('error', done);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('sends a connected event on join', (done) => {
|
it('sends a connected event on join', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
|
});
|
||||||
ws.on('message', (raw) => {
|
ws.on('message', (raw) => {
|
||||||
const msg = JSON.parse(raw.toString());
|
const msg = JSON.parse(raw.toString());
|
||||||
if (msg.type === 'connected') {
|
if (msg.type === 'connected') {
|
||||||
@@ -65,7 +87,9 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('responds to ping with pong', (done) => {
|
it('responds to ping with pong', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
|
});
|
||||||
ws.on('open', () => {
|
ws.on('open', () => {
|
||||||
ws.send(JSON.stringify({ type: 'ping' }));
|
ws.send(JSON.stringify({ type: 'ping' }));
|
||||||
});
|
});
|
||||||
@@ -80,7 +104,9 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('responds to subscribe with subscribed confirmation', (done) => {
|
it('responds to subscribe with subscribed confirmation', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
|
});
|
||||||
ws.on('open', () => {
|
ws.on('open', () => {
|
||||||
ws.send(JSON.stringify({ type: 'subscribe', events: ['resource-alert', 'incident'] }));
|
ws.send(JSON.stringify({ type: 'subscribe', events: ['resource-alert', 'incident'] }));
|
||||||
});
|
});
|
||||||
@@ -96,7 +122,9 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('responds to client-count request', (done) => {
|
it('responds to client-count request', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
|
});
|
||||||
ws.on('open', () => {
|
ws.on('open', () => {
|
||||||
ws.send(JSON.stringify({ type: 'client-count' }));
|
ws.send(JSON.stringify({ type: 'client-count' }));
|
||||||
});
|
});
|
||||||
@@ -112,7 +140,9 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('returns error for invalid JSON', (done) => {
|
it('returns error for invalid JSON', (done) => {
|
||||||
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`);
|
const ws = new WebSocket(`ws://localhost:${port}/api/v1/ws`, {
|
||||||
|
headers: { Cookie: 'dashcaddy_session=valid-session-id' },
|
||||||
|
});
|
||||||
ws.on('open', () => {
|
ws.on('open', () => {
|
||||||
ws.send('not json');
|
ws.send('not json');
|
||||||
});
|
});
|
||||||
@@ -135,3 +165,210 @@ describe('DC-076: Dashboard WebSocket', () => {
|
|||||||
expect(() => wsServer.broadcast('test', { foo: 'bar' })).not.toThrow();
|
expect(() => wsServer.broadcast('test', { foo: 'bar' })).not.toThrow();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
// DC-061 auth gate tests
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('DC-061: WS upgrade auth gate', () => {
|
||||||
|
let server, wsServer, port;
|
||||||
|
|
||||||
|
beforeEach((done) => {
|
||||||
|
server = createMockServer();
|
||||||
|
server.listen(0, () => {
|
||||||
|
port = server.address().port;
|
||||||
|
wsServer = createDashboardWS(server, {
|
||||||
|
resourceMonitor: new EventEmitter(),
|
||||||
|
healthChecker: new EventEmitter(),
|
||||||
|
updateManager: new EventEmitter(),
|
||||||
|
authVerifier: cookieValueVerifier(),
|
||||||
|
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
|
||||||
|
});
|
||||||
|
done();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach((done) => {
|
||||||
|
wsServer.close();
|
||||||
|
server.close(done);
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open a raw socket, send a hand-crafted WS upgrade request, and read
|
||||||
|
* the server's HTTP status line. Avoids the ws library's auto-retry
|
||||||
|
* behaviour so we get a deterministic single response.
|
||||||
|
*/
|
||||||
|
function probeUpgrade({ path, cookie, token } = {}) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const net = require('net');
|
||||||
|
const sock = net.createConnection(port, '127.0.0.1');
|
||||||
|
let buf = '';
|
||||||
|
const headers = [
|
||||||
|
`GET ${path || '/api/v1/ws'} HTTP/1.1`,
|
||||||
|
'Host: 127.0.0.1',
|
||||||
|
'Upgrade: websocket',
|
||||||
|
'Connection: Upgrade',
|
||||||
|
'Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==',
|
||||||
|
'Sec-WebSocket-Version: 13',
|
||||||
|
];
|
||||||
|
if (cookie) headers.push(`Cookie: ${cookie}`);
|
||||||
|
if (token) {
|
||||||
|
const sep = path && path.includes('?') ? '&' : '?';
|
||||||
|
headers[0] = headers[0].replace(path, `${path || '/api/v1/ws'}${sep}token=${token}`);
|
||||||
|
}
|
||||||
|
sock.on('connect', () => {
|
||||||
|
sock.write(headers.join('\r\n') + '\r\n\r\n');
|
||||||
|
});
|
||||||
|
sock.on('data', (chunk) => {
|
||||||
|
buf += chunk.toString('utf8');
|
||||||
|
if (buf.includes('\r\n\r\n')) {
|
||||||
|
sock.destroy();
|
||||||
|
const statusLine = buf.split('\r\n')[0];
|
||||||
|
const status = parseInt((statusLine.match(/HTTP\/1\.1 (\d+)/) || [])[1], 10);
|
||||||
|
resolve({ status, raw: buf });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
sock.on('error', (err) => {
|
||||||
|
// Connection reset is fine — server destroys socket after 401.
|
||||||
|
if (buf) resolve({ status: -1, raw: buf });
|
||||||
|
else reject(err);
|
||||||
|
});
|
||||||
|
setTimeout(() => {
|
||||||
|
if (!buf) {
|
||||||
|
sock.destroy();
|
||||||
|
reject(new Error('No response within 1s'));
|
||||||
|
}
|
||||||
|
}, 1000);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
it('rejects WS upgrade with NO cookie', async () => {
|
||||||
|
const res = await probeUpgrade({});
|
||||||
|
expect(res.status).toBe(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects WS upgrade with empty session cookie value', async () => {
|
||||||
|
const res = await probeUpgrade({ cookie: 'dashcaddy_session=' });
|
||||||
|
expect(res.status).toBe(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects WS upgrade with unrelated cookie (no session cookie)', async () => {
|
||||||
|
const res = await probeUpgrade({ cookie: 'foo=bar; baz=qux' });
|
||||||
|
expect(res.status).toBe(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('NO LONGER accepts `?token=` query param bypass (DC-061 fix)', async () => {
|
||||||
|
// Pre-DC-061: any 11+ char token in ?token=... granted WS access in
|
||||||
|
// production. Post-fix: token query param is ignored entirely; only a
|
||||||
|
// valid session cookie grants access.
|
||||||
|
const res = await probeUpgrade({ token: 'thisstringisdefinitelylongenough' });
|
||||||
|
expect(res.status).toBe(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects WS upgrade with token= AND empty cookie (no bypass combo)', async () => {
|
||||||
|
const res = await probeUpgrade({ cookie: 'dashcaddy_session=', token: 'abcdefghijklmnop' });
|
||||||
|
expect(res.status).toBe(401);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('accepts upgrade when verifier returns true', async () => {
|
||||||
|
const res = await probeUpgrade({ cookie: 'dashcaddy_session=valid-session-id' });
|
||||||
|
// 101 Switching Protocols for successful WS handshake
|
||||||
|
expect(res.status).toBe(101);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
// DC-061 close() listener detach test (the SSE-poisoning regression)
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('DC-061: close() detaches only OUR listeners', () => {
|
||||||
|
it('does NOT remove listeners attached by SSE route to shared emitters', () => {
|
||||||
|
// Set up two "subscribers" on the same EventEmitter, simulating the
|
||||||
|
// real-world shape: SSE route subscribes via `.on('alert', sseHandler)`
|
||||||
|
// and dashboard-ws subscribes via `.on('alert', wsHandler)` to the
|
||||||
|
// SAME resourceMonitor. Calling dashboard-ws.close() must remove
|
||||||
|
// ONLY wsHandler — sseHandler must remain.
|
||||||
|
const server = createMockServer();
|
||||||
|
const resourceMonitor = new EventEmitter();
|
||||||
|
|
||||||
|
// Pre-existing "SSE" listener (registered before dashboard-ws boots)
|
||||||
|
const sseHandler = jest.fn();
|
||||||
|
resourceMonitor.on('alert', sseHandler);
|
||||||
|
|
||||||
|
const wsServer = createDashboardWS(server, {
|
||||||
|
resourceMonitor,
|
||||||
|
healthChecker: new EventEmitter(),
|
||||||
|
updateManager: new EventEmitter(),
|
||||||
|
authVerifier: () => true,
|
||||||
|
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
|
||||||
|
});
|
||||||
|
|
||||||
|
// dashboard-ws added its own listener — verify it's there
|
||||||
|
const wsHandlerCallsBefore = resourceMonitor.listenerCount('alert');
|
||||||
|
expect(wsHandlerCallsBefore).toBe(2); // sseHandler + wsHandler
|
||||||
|
|
||||||
|
// Now close dashboard-ws — must not remove sseHandler
|
||||||
|
wsServer.close();
|
||||||
|
|
||||||
|
const wsHandlerCallsAfter = resourceMonitor.listenerCount('alert');
|
||||||
|
expect(wsHandlerCallsAfter).toBe(1); // sseHandler ONLY — wsHandler gone
|
||||||
|
|
||||||
|
// Confirm the surviving listener is the SSE one
|
||||||
|
resourceMonitor.emit('alert', { test: true });
|
||||||
|
expect(sseHandler).toHaveBeenCalledWith({ test: true });
|
||||||
|
|
||||||
|
server.close();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('is safe to call close() multiple times', () => {
|
||||||
|
const server = createMockServer();
|
||||||
|
const wsServer = createDashboardWS(server, {
|
||||||
|
resourceMonitor: new EventEmitter(),
|
||||||
|
healthChecker: new EventEmitter(),
|
||||||
|
updateManager: new EventEmitter(),
|
||||||
|
authVerifier: () => true,
|
||||||
|
log: { info: jest.fn(), error: jest.fn(), warn: jest.fn() },
|
||||||
|
});
|
||||||
|
expect(() => {
|
||||||
|
wsServer.close();
|
||||||
|
wsServer.close();
|
||||||
|
wsServer.close();
|
||||||
|
}).not.toThrow();
|
||||||
|
server.close();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
// DC-061 parseCookieHeader unit tests
|
||||||
|
// ─────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
describe('parseCookieHeader', () => {
|
||||||
|
it('returns empty object for undefined', () => {
|
||||||
|
expect(parseCookieHeader(undefined)).toEqual({});
|
||||||
|
});
|
||||||
|
it('returns empty object for empty string', () => {
|
||||||
|
expect(parseCookieHeader('')).toEqual({});
|
||||||
|
});
|
||||||
|
it('parses a single cookie pair', () => {
|
||||||
|
expect(parseCookieHeader('foo=bar')).toEqual({ foo: 'bar' });
|
||||||
|
});
|
||||||
|
it('parses multiple cookie pairs', () => {
|
||||||
|
expect(parseCookieHeader('a=1; b=2; c=3')).toEqual({ a: '1', b: '2', c: '3' });
|
||||||
|
});
|
||||||
|
it('trims whitespace around names and values', () => {
|
||||||
|
expect(parseCookieHeader(' foo = bar ; baz=qux')).toEqual({ foo: 'bar', baz: 'qux' });
|
||||||
|
});
|
||||||
|
it('preserves dots/dashes in HMAC-shaped session cookie values', () => {
|
||||||
|
// dashcaddy_session cookies are `<b64>.<sig>` — parseCookieHeader
|
||||||
|
// must NOT url-decode (the HMAC verifier reads the raw value).
|
||||||
|
expect(parseCookieHeader('dashcaddy_session=abc.def_123-XYZ')).toEqual({
|
||||||
|
dashcaddy_session: 'abc.def_123-XYZ',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
it('skips malformed pairs without `=`', () => {
|
||||||
|
expect(parseCookieHeader('foo; bar=baz')).toEqual({ bar: 'baz' });
|
||||||
|
});
|
||||||
|
it('skips empty name parts', () => {
|
||||||
|
expect(parseCookieHeader('=value; foo=bar')).toEqual({ foo: 'bar' });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const { success, error: errorResponse } = require('../src/utils/responses');
|
const { success, error: errorResponse } = require('../src/utils/responses');
|
||||||
|
const { ValidationError } = require('../src/utilities/errors');
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Disk space management routes
|
* Disk space management routes
|
||||||
@@ -10,6 +11,76 @@ const { success, error: errorResponse } = require('../src/utils/responses');
|
|||||||
* POST /disk/config — update disk budget settings
|
* POST /disk/config — update disk budget settings
|
||||||
* POST /disk/cleanup — trigger manual cleanup (standard|aggressive|logs-only)
|
* POST /disk/cleanup — trigger manual cleanup (standard|aggressive|logs-only)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
// DC-059: monotonic-ordering invariant for the three threshold percentages.
|
||||||
|
// DiskSpaceMonitor._getBudgetStatus() walks them in order
|
||||||
|
// (cleanupAggressivePct → criticalThresholdPct → warningThresholdPct) and
|
||||||
|
// returns at the FIRST threshold the usage crosses. If a caller writes
|
||||||
|
// them out of order (e.g. warningThresholdPct=95, criticalThresholdPct=60),
|
||||||
|
// the higher-priority branches become unreachable and the monitor silently
|
||||||
|
// misclassifies budget state. Validate against the *effective* config
|
||||||
|
// (current value + incoming update for each field) so partial updates can
|
||||||
|
// be applied one field at a time without violating the invariant.
|
||||||
|
//
|
||||||
|
// Clamp values to the same ranges the previous inline Math.min/Math.max
|
||||||
|
// chains enforced (warning 50..99, critical 60..99, aggressive 70..99)
|
||||||
|
// so we don't loosen the original bounds while adding the new check.
|
||||||
|
const THRESHOLD_BOUNDS = Object.freeze({
|
||||||
|
warning: { min: 50, max: 99 },
|
||||||
|
critical: { min: 60, max: 99 },
|
||||||
|
aggressive: { min: 70, max: 99 },
|
||||||
|
});
|
||||||
|
|
||||||
|
function clampThreshold(name, value) {
|
||||||
|
const { min, max } = THRESHOLD_BOUNDS[name];
|
||||||
|
return Math.min(Math.max(value, min), max);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply a candidate update to a baseline config, then verify the three
|
||||||
|
* threshold percentages still satisfy
|
||||||
|
* warningThresholdPct < criticalThresholdPct < cleanupAggressivePct.
|
||||||
|
* The POST /config endpoint accepts partial updates (single field at a
|
||||||
|
* time), so we merge into the live diskSpaceMonitor config first, then test
|
||||||
|
* the merged value. Returns the merged candidate on success; throws
|
||||||
|
* ValidationError if the ordering invariant would be violated.
|
||||||
|
*
|
||||||
|
* @param {Object} baseline - current effective config from diskSpaceMonitor
|
||||||
|
* @param {Object} candidate - the partial update being applied this request
|
||||||
|
* @returns {Object} merged candidate with thresholds clamped to bounds
|
||||||
|
*/
|
||||||
|
function mergeAndCheckOrdering(baseline, candidate) {
|
||||||
|
const next = { ...baseline };
|
||||||
|
if (typeof candidate.warningThresholdPct === 'number') {
|
||||||
|
next.warningThresholdPct = clampThreshold('warning', candidate.warningThresholdPct);
|
||||||
|
}
|
||||||
|
if (typeof candidate.criticalThresholdPct === 'number') {
|
||||||
|
next.criticalThresholdPct = clampThreshold('critical', candidate.criticalThresholdPct);
|
||||||
|
}
|
||||||
|
if (typeof candidate.cleanupAggressivePct === 'number') {
|
||||||
|
next.cleanupAggressivePct = clampThreshold('aggressive', candidate.cleanupAggressivePct);
|
||||||
|
}
|
||||||
|
if (!(next.warningThresholdPct < next.criticalThresholdPct)) {
|
||||||
|
throw new ValidationError(
|
||||||
|
`warningThresholdPct (${next.warningThresholdPct}) must be strictly less than criticalThresholdPct (${next.criticalThresholdPct})`,
|
||||||
|
'warningThresholdPct'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (!(next.criticalThresholdPct < next.cleanupAggressivePct)) {
|
||||||
|
throw new ValidationError(
|
||||||
|
`criticalThresholdPct (${next.criticalThresholdPct}) must be strictly less than cleanupAggressivePct (${next.cleanupAggressivePct})`,
|
||||||
|
'criticalThresholdPct'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// Return only the fields the caller asked to change (preserves partial-
|
||||||
|
// update semantics; diskSpaceMonitor.configure does its own merge).
|
||||||
|
const out = {};
|
||||||
|
if (typeof candidate.warningThresholdPct === 'number') out.warningThresholdPct = next.warningThresholdPct;
|
||||||
|
if (typeof candidate.criticalThresholdPct === 'number') out.criticalThresholdPct = next.criticalThresholdPct;
|
||||||
|
if (typeof candidate.cleanupAggressivePct === 'number') out.cleanupAggressivePct = next.cleanupAggressivePct;
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = function({ diskSpaceMonitor, asyncHandler, log }) {
|
module.exports = function({ diskSpaceMonitor, asyncHandler, log }) {
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
|
|
||||||
@@ -36,9 +107,16 @@ module.exports = function({ diskSpaceMonitor, asyncHandler, log }) {
|
|||||||
|
|
||||||
const updates = {};
|
const updates = {};
|
||||||
if (typeof diskBudgetGB === 'number' && diskBudgetGB > 0) updates.diskBudgetGB = Math.min(diskBudgetGB, 1000);
|
if (typeof diskBudgetGB === 'number' && diskBudgetGB > 0) updates.diskBudgetGB = Math.min(diskBudgetGB, 1000);
|
||||||
if (typeof warningThresholdPct === 'number') updates.warningThresholdPct = Math.min(Math.max(warningThresholdPct, 50), 99);
|
// DC-059: threshold percentages must satisfy a strict monotonic order
|
||||||
if (typeof criticalThresholdPct === 'number') updates.criticalThresholdPct = Math.min(Math.max(criticalThresholdPct, 60), 99);
|
// (warning < critical < aggressive) so _getBudgetStatus() reaches the
|
||||||
if (typeof cleanupAggressivePct === 'number') updates.cleanupAggressivePct = Math.min(Math.max(cleanupAggressivePct, 70), 99);
|
// correct branch. mergeAndCheckOrdering() validates against the live
|
||||||
|
// baseline, so partial updates that violate the invariant are rejected
|
||||||
|
// BEFORE we mutate diskSpaceMonitor.diskConfig.
|
||||||
|
const thresholdUpdates = mergeAndCheckOrdering(
|
||||||
|
diskSpaceMonitor.getConfig(),
|
||||||
|
{ warningThresholdPct, criticalThresholdPct, cleanupAggressivePct }
|
||||||
|
);
|
||||||
|
Object.assign(updates, thresholdUpdates);
|
||||||
if (typeof autoCleanup === 'boolean') updates.autoCleanup = autoCleanup;
|
if (typeof autoCleanup === 'boolean') updates.autoCleanup = autoCleanup;
|
||||||
if (typeof enabled === 'boolean') updates.enabled = enabled;
|
if (typeof enabled === 'boolean') updates.enabled = enabled;
|
||||||
|
|
||||||
|
|||||||
+11
-1
@@ -75,7 +75,16 @@ process.on('uncaughtException', (error) => {
|
|||||||
// .on() on a class threw on every boot and silently killed the WS).
|
// .on() on a class threw on every boot and silently killed the WS).
|
||||||
try {
|
try {
|
||||||
const { ctx } = app.locals;
|
const { ctx } = app.locals;
|
||||||
const createDashboardWS = require('./src/websocket/dashboard-ws');
|
const createDashboardWS = require('./src/websocket/dashboard-ws').createDashboardWS;
|
||||||
|
|
||||||
|
// DC-061: WS upgrade bypasses Express middleware, so inject the
|
||||||
|
// real session verifier from the shared context. Without this
|
||||||
|
// the WS would fall back to a presence-only cookie check that
|
||||||
|
// any attacker can satisfy by setting a cookie named
|
||||||
|
// `dashcaddy_session` (verified HMAC required, not just name).
|
||||||
|
const authVerifier = (ctx.session && typeof ctx.session.isValid === 'function')
|
||||||
|
? ctx.session.isValid
|
||||||
|
: null;
|
||||||
|
|
||||||
createDashboardWS(server, {
|
createDashboardWS(server, {
|
||||||
resourceMonitor: ctx.resourceMonitor,
|
resourceMonitor: ctx.resourceMonitor,
|
||||||
@@ -86,6 +95,7 @@ process.on('uncaughtException', (error) => {
|
|||||||
driftDetector: ctx.driftDetector,
|
driftDetector: ctx.driftDetector,
|
||||||
sslMonitor: ctx.sslMonitor,
|
sslMonitor: ctx.sslMonitor,
|
||||||
dnsPropagationChecker: ctx.dnsPropagationChecker,
|
dnsPropagationChecker: ctx.dnsPropagationChecker,
|
||||||
|
authVerifier,
|
||||||
log,
|
log,
|
||||||
});
|
});
|
||||||
log.info('server', 'Dashboard WebSocket attached at /api/v1/ws');
|
log.info('server', 'Dashboard WebSocket attached at /api/v1/ws');
|
||||||
|
|||||||
@@ -406,7 +406,7 @@ class AutoRestartManager extends EventEmitter {
|
|||||||
// Transition: healthy → unhealthy
|
// Transition: healthy → unhealthy
|
||||||
if (previousStatus === 'up' && currentStatus === 'down') {
|
if (previousStatus === 'up' && currentStatus === 'down') {
|
||||||
// Find the containerId from the health checker config or status details
|
// Find the containerId from the health checker config or status details
|
||||||
const containerId = this._resolveContainerId(serviceId, status);
|
const containerId = await this._resolveContainerId(serviceId, status);
|
||||||
if (containerId) {
|
if (containerId) {
|
||||||
try {
|
try {
|
||||||
await this.handleContainerDown(serviceId, containerId);
|
await this.handleContainerDown(serviceId, containerId);
|
||||||
@@ -429,12 +429,19 @@ class AutoRestartManager extends EventEmitter {
|
|||||||
/**
|
/**
|
||||||
* Attempt to find the containerId for a service from various sources.
|
* Attempt to find the containerId for a service from various sources.
|
||||||
*
|
*
|
||||||
|
* DC-060: the previous implementation fired the async lookup via `.then(...)`
|
||||||
|
* but discarded the returned containerId, returning `undefined` from the
|
||||||
|
* function. Callers (`_handleStatusCheck`) gate on the return value, so
|
||||||
|
* every auto-restart whose containerId came from servicesStateManager
|
||||||
|
* silently no-op'd. Now awaits the read() promise so the containerId
|
||||||
|
* actually propagates.
|
||||||
|
*
|
||||||
* @param {string} serviceId
|
* @param {string} serviceId
|
||||||
* @param {Object} status - The status-check event data
|
* @param {Object} status - The status-check event data
|
||||||
* @returns {string|null}
|
* @returns {Promise<string|null>}
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
_resolveContainerId(serviceId, status) {
|
async _resolveContainerId(serviceId, status) {
|
||||||
// Check if it's in the status details (some health checks embed it)
|
// Check if it's in the status details (some health checks embed it)
|
||||||
if (status.details?.containerId) return status.details.containerId;
|
if (status.details?.containerId) return status.details.containerId;
|
||||||
|
|
||||||
@@ -442,23 +449,20 @@ class AutoRestartManager extends EventEmitter {
|
|||||||
const hcService = this.healthChecker?.config?.services?.[serviceId];
|
const hcService = this.healthChecker?.config?.services?.[serviceId];
|
||||||
if (hcService?.containerId) return hcService.containerId;
|
if (hcService?.containerId) return hcService.containerId;
|
||||||
|
|
||||||
// Try to look it up from the services state manager
|
// Try to look it up from the services state manager. StateManager.read()
|
||||||
|
// is async (returns a Promise) — must await, not fire-and-forget.
|
||||||
try {
|
try {
|
||||||
const servicesStateManager = this.ctx.servicesStateManager;
|
const servicesStateManager = this.ctx.servicesStateManager;
|
||||||
if (servicesStateManager) {
|
if (!servicesStateManager) return null;
|
||||||
const readResult = servicesStateManager.read();
|
const list = await servicesStateManager.read();
|
||||||
if (readResult && typeof readResult.then === 'function') {
|
|
||||||
// It returns a promise — fire-and-forget lookup
|
|
||||||
readResult.then(list => {
|
|
||||||
const found = (list || []).find(s => s.id === serviceId);
|
const found = (list || []).find(s => s.id === serviceId);
|
||||||
return found?.containerId || null;
|
|
||||||
}).catch(() => null);
|
|
||||||
} else {
|
|
||||||
const found = (readResult || []).find(s => s.id === serviceId);
|
|
||||||
if (found?.containerId) return found.containerId;
|
if (found?.containerId) return found.containerId;
|
||||||
|
} catch (err) {
|
||||||
|
// Best-effort: a state-manager read failure must not break the bridge.
|
||||||
|
// Surface at debug level so an operator hunting "why didn't auto-restart
|
||||||
|
// fire?" can find it without polluting the info-level event stream.
|
||||||
|
this.log?.debug?.('auto-restart', 'containerId resolve failed', { serviceId, error: err?.message });
|
||||||
}
|
}
|
||||||
}
|
|
||||||
} catch (_) { /* best effort */ }
|
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,31 @@
|
|||||||
*/
|
*/
|
||||||
const { WebSocketServer } = require('ws');
|
const { WebSocketServer } = require('ws');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse the `Cookie` header into a plain `{name: value}` map.
|
||||||
|
* WS upgrade requests don't go through Express's cookie-parser, so we
|
||||||
|
* do it by hand here. We deliberately do NOT decode the values — the
|
||||||
|
* session-cookie HMAC verifier reads the raw cookie string verbatim
|
||||||
|
* (`payloadB64.sig` shape), so any decoding (e.g. url-decode) would
|
||||||
|
* corrupt the signature. Single cookie-pair per call, no nesting.
|
||||||
|
*
|
||||||
|
* @param {string|undefined} header - Raw Cookie header value
|
||||||
|
* @returns {Object<string, string>} name → value map (empty string for blanks)
|
||||||
|
*/
|
||||||
|
function parseCookieHeader(header) {
|
||||||
|
const out = {};
|
||||||
|
if (!header) return out;
|
||||||
|
for (const part of header.split(';')) {
|
||||||
|
const idx = part.indexOf('=');
|
||||||
|
if (idx === -1) continue;
|
||||||
|
const name = part.slice(0, idx).trim();
|
||||||
|
if (!name) continue;
|
||||||
|
const value = part.slice(idx + 1).trim();
|
||||||
|
out[name] = value;
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
function createDashboardWS(server, deps = {}) {
|
function createDashboardWS(server, deps = {}) {
|
||||||
const wss = new WebSocketServer({ noServer: true });
|
const wss = new WebSocketServer({ noServer: true });
|
||||||
|
|
||||||
@@ -30,9 +55,52 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
log,
|
log,
|
||||||
} = deps;
|
} = deps;
|
||||||
|
|
||||||
|
// ── Auth verifier (injected by server.js from app.locals.ctx.session) ──
|
||||||
|
// The WS upgrade path bypasses Express middleware, so the global
|
||||||
|
// `totpAuthMiddleware` (which calls `isSessionValid(req)`) never runs.
|
||||||
|
// We accept the SAME verifier here so a valid browser session cookie
|
||||||
|
// grants access and nothing else does.
|
||||||
|
//
|
||||||
|
// The injected verifier receives the raw HTTP upgrade request (an
|
||||||
|
// IncomingMessage with `.headers.cookie`). Production wires
|
||||||
|
// `app.locals.ctx.session.isValid` directly — it accepts the same
|
||||||
|
// shape, parses the Cookie header internally, and runs the HMAC
|
||||||
|
// check. Tests inject a stub.
|
||||||
|
//
|
||||||
|
// DC-061 hardening: prior code only checked that the `dashcaddy_session`
|
||||||
|
// SUBSTRING appeared in the Cookie header. That let an attacker set any
|
||||||
|
// cookie named `dashcaddy_session=garbage` (or include the literal text
|
||||||
|
// in another cookie's value) and bypass auth. The injected verifier
|
||||||
|
// runs HMAC validation, so a present-but-invalid cookie now 401s.
|
||||||
|
const authVerifier = typeof deps.authVerifier === 'function'
|
||||||
|
? deps.authVerifier
|
||||||
|
: (req) => {
|
||||||
|
// Last-resort fallback: presence-only check on a non-empty
|
||||||
|
// session-cookie value. Used only when the caller didn't inject
|
||||||
|
// a real verifier (e.g. tests, unusual boot paths). Production
|
||||||
|
// wires the real one from app.locals.ctx.session.isValid.
|
||||||
|
const parsed = parseCookieHeader(req && req.headers && req.headers.cookie);
|
||||||
|
const raw = parsed.dashcaddy_session || parsed.sid;
|
||||||
|
return typeof raw === 'string' && raw.length > 0;
|
||||||
|
};
|
||||||
|
|
||||||
// Track connected clients and their subscriptions
|
// Track connected clients and their subscriptions
|
||||||
const wsClients = new Set();
|
const wsClients = new Set();
|
||||||
|
|
||||||
|
// Track the listener functions we attach to shared EventEmitters so we
|
||||||
|
// can detach exactly OUR listeners on close() — without disturbing the
|
||||||
|
// SSE route's listeners on the same emitters. DC-061 critical fix:
|
||||||
|
// the previous code called `resourceMonitor.removeAllListeners()` which
|
||||||
|
// silently killed the SSE route's `alert`/`status-check`/etc subscribers
|
||||||
|
// whenever close() ran (hot reload, graceful restart).
|
||||||
|
const emitterListeners = [];
|
||||||
|
|
||||||
|
function attachListener(emitter, event, handler) {
|
||||||
|
if (!emitter || typeof emitter.on !== 'function') return;
|
||||||
|
emitter.on(event, handler);
|
||||||
|
emitterListeners.push({ emitter, event, handler });
|
||||||
|
}
|
||||||
|
|
||||||
function broadcast(event, data) {
|
function broadcast(event, data) {
|
||||||
const msg = JSON.stringify({ type: 'event', event, data });
|
const msg = JSON.stringify({ type: 'event', event, data });
|
||||||
for (const client of wsClients) {
|
for (const client of wsClients) {
|
||||||
@@ -49,13 +117,10 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
|
|
||||||
// ── Wire up EventEmitter listeners (same events as SSE) ──
|
// ── Wire up EventEmitter listeners (same events as SSE) ──
|
||||||
|
|
||||||
if (resourceMonitor) {
|
attachListener(resourceMonitor, 'alert', (data) => broadcast('resource-alert', data));
|
||||||
resourceMonitor.on('alert', (data) => broadcast('resource-alert', data));
|
attachListener(resourceMonitor, 'auto-restart', (data) => broadcast('auto-restart', data));
|
||||||
resourceMonitor.on('auto-restart', (data) => broadcast('auto-restart', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (healthChecker) {
|
attachListener(healthChecker, 'status-check', (data) => {
|
||||||
healthChecker.on('status-check', (data) => {
|
|
||||||
broadcast('status-change', {
|
broadcast('status-change', {
|
||||||
serviceId: data.serviceId,
|
serviceId: data.serviceId,
|
||||||
name: data.name,
|
name: data.name,
|
||||||
@@ -64,47 +129,34 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
timestamp: data.timestamp,
|
timestamp: data.timestamp,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
healthChecker.on('incident-created', (data) => broadcast('incident', { type: 'created', ...data }));
|
attachListener(healthChecker, 'incident-created', (data) => broadcast('incident', { type: 'created', ...data }));
|
||||||
healthChecker.on('incident-resolved', (data) => broadcast('incident', { type: 'resolved', ...data }));
|
attachListener(healthChecker, 'incident-resolved', (data) => broadcast('incident', { type: 'resolved', ...data }));
|
||||||
}
|
|
||||||
|
|
||||||
if (updateManager) {
|
attachListener(updateManager, 'update-available', (data) => broadcast('update-available', data));
|
||||||
updateManager.on('update-available', (data) => broadcast('update-available', data));
|
attachListener(updateManager, 'update-start', (data) => broadcast('update-start', data));
|
||||||
updateManager.on('update-start', (data) => broadcast('update-start', data));
|
attachListener(updateManager, 'update-complete', (data) => broadcast('update-complete', data));
|
||||||
updateManager.on('update-complete', (data) => broadcast('update-complete', data));
|
attachListener(updateManager, 'update-failed', (data) => broadcast('update-failed', data));
|
||||||
updateManager.on('update-failed', (data) => broadcast('update-failed', data));
|
attachListener(updateManager, 'auto-update-start', (data) => broadcast('auto-update-start', data));
|
||||||
updateManager.on('auto-update-start', (data) => broadcast('auto-update-start', data));
|
attachListener(updateManager, 'auto-update-complete', (data) => broadcast('auto-update-complete', data));
|
||||||
updateManager.on('auto-update-complete', (data) => broadcast('auto-update-complete', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (dependencyManager) {
|
attachListener(dependencyManager, 'dependency-restart-start', (data) => broadcast('dependency-restart-start', data));
|
||||||
dependencyManager.on('dependency-restart-start', (data) => broadcast('dependency-restart-start', data));
|
attachListener(dependencyManager, 'dependency-restart-progress', (data) => broadcast('dependency-restart-progress', data));
|
||||||
dependencyManager.on('dependency-restart-progress', (data) => broadcast('dependency-restart-progress', data));
|
attachListener(dependencyManager, 'dependency-restart-complete', (data) => broadcast('dependency-restart-complete', data));
|
||||||
dependencyManager.on('dependency-restart-complete', (data) => broadcast('dependency-restart-complete', data));
|
attachListener(dependencyManager, 'dependency-restart-failed', (data) => broadcast('dependency-restart-failed', data));
|
||||||
dependencyManager.on('dependency-restart-failed', (data) => broadcast('dependency-restart-failed', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (autoRestartManager) {
|
attachListener(autoRestartManager, 'auto-restart-attempt', (data) => broadcast('auto-restart-attempt', data));
|
||||||
autoRestartManager.on('auto-restart-attempt', (data) => broadcast('auto-restart-attempt', data));
|
attachListener(autoRestartManager, 'auto-restart-success', (data) => broadcast('auto-restart-success', data));
|
||||||
autoRestartManager.on('auto-restart-success', (data) => broadcast('auto-restart-success', data));
|
attachListener(autoRestartManager, 'auto-restart-failed', (data) => broadcast('auto-restart-failed', data));
|
||||||
autoRestartManager.on('auto-restart-failed', (data) => broadcast('auto-restart-failed', data));
|
attachListener(autoRestartManager, 'auto-restart-max-reached', (data) => broadcast('auto-restart-max-reached', data));
|
||||||
autoRestartManager.on('auto-restart-max-reached', (data) => broadcast('auto-restart-max-reached', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (driftDetector) {
|
attachListener(driftDetector, 'drift-detected', (data) => broadcast('drift-detected', data));
|
||||||
driftDetector.on('drift-detected', (data) => broadcast('drift-detected', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (sslMonitor) {
|
attachListener(sslMonitor, 'cert-expiring', (data) => broadcast('cert-expiring', data));
|
||||||
sslMonitor.on('cert-expiring', (data) => broadcast('cert-expiring', data));
|
attachListener(sslMonitor, 'cert-critical', (data) => broadcast('cert-critical', data));
|
||||||
sslMonitor.on('cert-critical', (data) => broadcast('cert-critical', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (dnsPropagationChecker) {
|
attachListener(dnsPropagationChecker, 'propagation-check', (data) => broadcast('dns-propagation-check', data));
|
||||||
dnsPropagationChecker.on('propagation-check', (data) => broadcast('dns-propagation-check', data));
|
attachListener(dnsPropagationChecker, 'propagation-complete', (data) => broadcast('dns-propagation-complete', data));
|
||||||
dnsPropagationChecker.on('propagation-complete', (data) => broadcast('dns-propagation-complete', data));
|
attachListener(dnsPropagationChecker, 'propagation-timeout', (data) => broadcast('dns-propagation-timeout', data));
|
||||||
dnsPropagationChecker.on('propagation-timeout', (data) => broadcast('dns-propagation-timeout', data));
|
|
||||||
}
|
|
||||||
|
|
||||||
// ── Handle upgrade requests at /api/v1/ws ──
|
// ── Handle upgrade requests at /api/v1/ws ──
|
||||||
|
|
||||||
@@ -116,16 +168,21 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
return; // Let other upgrade handlers deal with it
|
return; // Let other upgrade handlers deal with it
|
||||||
}
|
}
|
||||||
|
|
||||||
// DC-076: Auth check — extract session/token from query params or cookies
|
// DC-061 auth gate: WS upgrade bypasses Express middleware, so we
|
||||||
// The SSE endpoint is behind auth middleware; WS needs the same gate.
|
// must validate the session here. We accept ONLY a valid signed
|
||||||
// We validate the session cookie or API token before accepting the upgrade.
|
// session cookie (no `token` query-param bypass — that was the
|
||||||
const cookies = (request.headers.cookie || '');
|
// previous footgun, which granted access to any random 11+ char
|
||||||
const hasSession = cookies.includes('dashcaddy_session') || cookies.includes('sid');
|
// string in production). The verifier is injected from
|
||||||
const token = url.searchParams.get('token');
|
// app.locals.ctx.session.isValid in production.
|
||||||
const hasToken = token && token.length > 10;
|
const ok = authVerifier(request);
|
||||||
|
|
||||||
if (!hasSession && !hasToken && process.env.NODE_ENV === 'production') {
|
if (!ok) {
|
||||||
socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n');
|
const ip = (request.socket && request.socket.remoteAddress) || 'unknown';
|
||||||
|
if (log && log.warn) {
|
||||||
|
log.warn('websocket', 'WS upgrade rejected — no valid session', { ip, path: url.pathname });
|
||||||
|
}
|
||||||
|
// 401 + Connection: close so the client doesn't retry.
|
||||||
|
socket.write('HTTP/1.1 401 Unauthorized\r\nConnection: close\r\n\r\n');
|
||||||
socket.destroy();
|
socket.destroy();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -170,6 +227,17 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
ws.on('pong', () => { ws.isAlive = true; });
|
ws.on('pong', () => { ws.isAlive = true; });
|
||||||
|
|
||||||
ws.on('message', (raw) => {
|
ws.on('message', (raw) => {
|
||||||
|
// Cap message size at 16 KB — defense-in-depth against a malicious
|
||||||
|
// peer that exploits ws's message framing to flood our parser.
|
||||||
|
// The `ws` library already enforces this via its constructor option,
|
||||||
|
// but a second guard at the handler level catches any future
|
||||||
|
// regressions (e.g. someone passing `maxPayload` differently).
|
||||||
|
if (raw.length > 16 * 1024) {
|
||||||
|
ws.send(JSON.stringify({ type: 'error', error: 'Message too large' }));
|
||||||
|
try { ws.close(1009, 'Message too large'); } catch { /* already closed */ }
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let msg;
|
let msg;
|
||||||
try {
|
try {
|
||||||
msg = JSON.parse(raw.toString());
|
msg = JSON.parse(raw.toString());
|
||||||
@@ -248,12 +316,21 @@ function createDashboardWS(server, deps = {}) {
|
|||||||
}
|
}
|
||||||
wsClients.clear();
|
wsClients.clear();
|
||||||
wss.close();
|
wss.close();
|
||||||
// Remove all listeners from the event emitters to prevent leaks on restart
|
// DC-061: detach ONLY the listeners we attached. Previously the
|
||||||
if (resourceMonitor) resourceMonitor.removeAllListeners();
|
// module called `resourceMonitor.removeAllListeners()` (and same
|
||||||
if (healthChecker) healthChecker.removeAllListeners();
|
// for healthChecker / updateManager), which silently wiped the
|
||||||
if (updateManager) updateManager.removeAllListeners();
|
// SSE route's listeners on the same shared emitters — the SSE
|
||||||
|
// stream went dead the moment close() ran (hot reload, restart).
|
||||||
|
for (const { emitter, event, handler } of emitterListeners) {
|
||||||
|
if (emitter && typeof emitter.removeListener === 'function') {
|
||||||
|
emitter.removeListener(event, handler);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
emitterListeners.length = 0;
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = createDashboardWS;
|
module.exports = createDashboardWS;
|
||||||
|
module.exports.createDashboardWS = createDashboardWS;
|
||||||
|
module.exports.parseCookieHeader = parseCookieHeader;
|
||||||
|
|||||||
Reference in New Issue
Block a user