mirror of
https://github.com/affaan-m/ECC.git
synced 2026-09-29 21:15:16 +02:00
affaan-m
506f25fb54
Preserve the contributor security repair and current main. Apply the artifact sandbox to SVG document responses and report unavailable symlink checks separately from passing assertions. Source-PR: https://github.com/affaan-m/ECC/pull/3241 Source-Head:d237e1972fIntegration-Main:d3b8a3e908
711 lines
32 KiB
JavaScript
711 lines
32 KiB
JavaScript
/**
|
|
* Integration tests for the Plan Canvas server (scripts/lib/plan-canvas/).
|
|
*
|
|
* Spins up the real HTTP server in-process and drives it exactly like the
|
|
* browser chrome (fetch + SSE) and the agent CLI (long-poll) do.
|
|
*
|
|
* Run with: node tests/scripts/plan-canvas.test.js
|
|
* Offline artifact checks: add --artifact-security-only (no listener).
|
|
*/
|
|
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const http = require('http');
|
|
const os = require('os');
|
|
const path = require('path');
|
|
|
|
const { createSessionStore } = require('../../scripts/lib/plan-canvas/sessions');
|
|
const { createPlanCanvasServer } = require('../../scripts/lib/plan-canvas/server');
|
|
|
|
class SkippedTest extends Error {}
|
|
|
|
function createTestRunner(log = console.log) {
|
|
let results = { passed: 0, failed: 0, skipped: 0 };
|
|
return {
|
|
get results() { return results; },
|
|
async test(name, fn) {
|
|
try {
|
|
await fn();
|
|
results = { ...results, passed: results.passed + 1 };
|
|
log(` PASS ${name}`);
|
|
} catch (error) {
|
|
if (error instanceof SkippedTest) {
|
|
results = { ...results, skipped: results.skipped + 1 };
|
|
log(` SKIP ${name}: ${error.message}`);
|
|
} else {
|
|
results = { ...results, failed: results.failed + 1 };
|
|
log(` FAIL ${name}\n Error: ${error.stack || error.message}`);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
function createTestSymlink(target, link, type = 'file', { symlink = fs.symlinkSync, platform = process.platform } = {}) {
|
|
try {
|
|
symlink(target, link, type);
|
|
} catch (error) {
|
|
if (error.code === 'ENOSYS' || error.code === 'ENOTSUP'
|
|
|| (platform === 'win32' && error.code === 'EPERM')) {
|
|
throw new SkippedTest(`symlink creation unavailable (${platform}, ${error.code})`);
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
function printResults(results) {
|
|
console.log(`Passed: ${results.passed}`);
|
|
console.log(`Failed: ${results.failed}`);
|
|
console.log(`Skipped: ${results.skipped}`);
|
|
process.exitCode = results.failed > 0 ? 1 : 0;
|
|
}
|
|
|
|
// Capture the real dispatcher without binding a socket. Artifact bodies are
|
|
// only compared as inert response bytes, never executed in a browser.
|
|
async function withArtifactHandler(callback) {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'plan-canvas-artifact-'));
|
|
let canvas;
|
|
try {
|
|
const base = path.join(root, 'artifacts');
|
|
const outside = path.join(root, 'outside');
|
|
fs.mkdirSync(base);
|
|
fs.mkdirSync(outside);
|
|
const session = { key: '0123456789ab', file: path.join(base, 'main.md') };
|
|
fs.writeFileSync(session.file, '# Inert fixture\n');
|
|
fs.writeFileSync(path.join(outside, 'secret.txt'), 'private-fixture-secret');
|
|
let handler;
|
|
const originalCreateServer = http.createServer;
|
|
http.createServer = requestHandler => {
|
|
handler = requestHandler;
|
|
return {
|
|
listen() { throw new Error('Artifact tests must not open a listener'); },
|
|
close(done) { done(); }
|
|
};
|
|
};
|
|
try {
|
|
canvas = createPlanCanvasServer({ store: { get: key => key === session.key ? session : null }, idleTimeoutMs: 0 });
|
|
} finally {
|
|
http.createServer = originalCreateServer;
|
|
}
|
|
const get = asset => new Promise(resolve => {
|
|
const response = { headersSent: false };
|
|
response.writeHead = (statusCode, headers) => {
|
|
response.statusCode = statusCode;
|
|
response.headers = headers;
|
|
response.headersSent = true;
|
|
};
|
|
response.end = data => resolve({ statusCode: response.statusCode, headers: response.headers, body: String(data || '') });
|
|
handler({ method: 'GET', headers: { host: '127.0.0.1' }, url: `/artifact/${session.key}/${asset}` }, response);
|
|
});
|
|
await callback({ base, outside, session, get });
|
|
} finally {
|
|
if (canvas) await canvas.close();
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
async function artifactSecurityTests(test) {
|
|
const sandbox = 'sandbox allow-scripts allow-forms allow-popups';
|
|
const svg = '<svg xmlns="http://www.w3.org/2000/svg"><script>window.inertFixture = true;</script></svg>';
|
|
await test('SVG sibling documents keep their MIME and use the artifact sandbox', () => withArtifactHandler(async ({ base, get }) => {
|
|
fs.writeFileSync(path.join(base, 'shape.svg'), svg);
|
|
const response = await get('shape.svg');
|
|
assert.strictEqual(response.statusCode, 200);
|
|
assert.strictEqual(response.headers['content-type'], 'image/svg+xml');
|
|
assert.strictEqual(response.headers['content-security-policy'], sandbox);
|
|
assert.strictEqual(response.body, svg);
|
|
}));
|
|
await test('SVG symlink request and target MIME fallback both receive sandbox CSP', () => withArtifactHandler(async ({ base, get }) => {
|
|
fs.writeFileSync(path.join(base, 'extensionless'), svg);
|
|
fs.writeFileSync(path.join(base, 'shape.svg'), svg);
|
|
createTestSymlink(path.join(base, 'extensionless'), path.join(base, 'by-name.svg'));
|
|
createTestSymlink(path.join(base, 'shape.svg'), path.join(base, 'by-target'));
|
|
for (const alias of ['by-name.svg', 'by-target']) {
|
|
const response = await get(alias);
|
|
assert.strictEqual(response.statusCode, 200);
|
|
assert.strictEqual(response.headers['content-type'], 'image/svg+xml');
|
|
assert.strictEqual(response.headers['content-security-policy'], sandbox);
|
|
assert.strictEqual(response.body, svg);
|
|
}
|
|
}));
|
|
await test('HTML and Markdown artifact policies and ordinary CSS MIME are preserved', () => withArtifactHandler(async ({ base, session, get }) => {
|
|
fs.writeFileSync(path.join(base, 'note.html'), '<html><body>inert HTML</body></html>');
|
|
fs.writeFileSync(path.join(base, 'style.css'), 'body { color: red }');
|
|
for (const asset of ['', 'note.html']) {
|
|
const response = await get(asset);
|
|
assert.strictEqual(response.statusCode, 200);
|
|
assert.strictEqual(response.headers['content-type'], 'text/html; charset=utf-8');
|
|
assert.strictEqual(response.headers['content-security-policy'], sandbox);
|
|
}
|
|
session.file = path.join(base, 'note.html');
|
|
const html = await get('');
|
|
assert.strictEqual(html.headers['content-security-policy'], sandbox);
|
|
assert.ok(html.body.includes('<script src="/sdk.js"></script>'));
|
|
const css = await get('style.css');
|
|
assert.strictEqual(css.statusCode, 200);
|
|
assert.strictEqual(css.headers['content-type'], 'text/css; charset=utf-8');
|
|
assert.strictEqual(css.headers['content-security-policy'], undefined);
|
|
assert.strictEqual(css.body, 'body { color: red }');
|
|
}));
|
|
await test('outside file and directory symlinks are refused without exposing their bytes', () => withArtifactHandler(async ({ base, outside, get }) => {
|
|
createTestSymlink(path.join(outside, 'secret.txt'), path.join(base, 'outside.txt'));
|
|
createTestSymlink(outside, path.join(base, 'outside-dir'), 'dir');
|
|
for (const asset of ['outside.txt', 'outside-dir/secret.txt']) {
|
|
const response = await get(asset);
|
|
assert.strictEqual(response.statusCode, 403);
|
|
assert.ok(!response.body.includes('private-fixture-secret'));
|
|
}
|
|
}));
|
|
await test('internal CSS symlink MIME uses the requested extension', () => withArtifactHandler(async ({ base, get }) => {
|
|
fs.writeFileSync(path.join(base, 'raw-style'), 'body { color: blue }');
|
|
createTestSymlink(path.join(base, 'raw-style'), path.join(base, 'theme.css'));
|
|
const response = await get('theme.css');
|
|
assert.strictEqual(response.statusCode, 200);
|
|
assert.strictEqual(response.headers['content-type'], 'text/css; charset=utf-8');
|
|
assert.strictEqual(response.body, 'body { color: blue }');
|
|
}));
|
|
await test('broken sibling links return 404', () => withArtifactHandler(async ({ base, get }) => {
|
|
createTestSymlink(path.join(base, 'missing.txt'), path.join(base, 'broken.txt'));
|
|
assert.strictEqual((await get('broken.txt')).statusCode, 404);
|
|
}));
|
|
await test('encoded lexical traversal stays forbidden', () => withArtifactHandler(async ({ get }) => {
|
|
const response = await get('..%2Foutside%2Fsecret.txt');
|
|
assert.strictEqual(response.statusCode, 403);
|
|
assert.ok(!response.body.includes('private-fixture-secret'));
|
|
}));
|
|
await test('missing paths escape angle brackets and quotes under restrictive CSP', () => withArtifactHandler(async ({ base, session, get }) => {
|
|
// This is a missing-path string, not a platform-dependent filename.
|
|
session.file = path.join(base, '<svg "quoted" & \'single\'>.md');
|
|
const response = await get('');
|
|
assert.strictEqual(response.statusCode, 404);
|
|
assert.ok(response.body.includes('<svg "quoted" & 'single'>.md'));
|
|
assert.ok(!response.body.includes('<svg'));
|
|
assert.ok(response.headers['content-security-policy'].includes("default-src 'self'"));
|
|
}));
|
|
await test('known unavailable symlink capability is counted separately from passes', async () => {
|
|
const suite = createTestRunner(() => {});
|
|
await suite.test('synthetic Windows privilege boundary', () => createTestSymlink('target', 'link', 'file', {
|
|
platform: 'win32', symlink() { throw Object.assign(new Error('privilege unavailable'), { code: 'EPERM' }); }
|
|
}));
|
|
assert.deepStrictEqual(suite.results, { passed: 0, failed: 0, skipped: 1 });
|
|
});
|
|
await test('unexpected symlink and ordinary fixture errors count as failures', async () => {
|
|
const suite = createTestRunner(() => {});
|
|
await suite.test('unexpected existing link', () => createTestSymlink('target', 'link', 'file', {
|
|
platform: 'win32', symlink() { throw Object.assign(new Error('already exists'), { code: 'EEXIST' }); }
|
|
}));
|
|
await suite.test('ordinary write error', () => { throw Object.assign(new Error('fixture write failed'), { code: 'EIO' }); });
|
|
await suite.test('non-Windows permission error', () => createTestSymlink('target', 'link', 'file', {
|
|
platform: 'darwin', symlink() { throw Object.assign(new Error('permission denied'), { code: 'EPERM' }); }
|
|
}));
|
|
assert.deepStrictEqual(suite.results, { passed: 0, failed: 3, skipped: 0 });
|
|
});
|
|
}
|
|
|
|
function request(port, method, requestPath, { body = null, headers = {} } = {}) {
|
|
return new Promise((resolve, reject) => {
|
|
const payload = body === null ? null : JSON.stringify(body);
|
|
const req = http.request(
|
|
{
|
|
host: '127.0.0.1',
|
|
port,
|
|
method,
|
|
path: requestPath,
|
|
agent: false,
|
|
headers: payload
|
|
? { 'content-type': 'application/json', 'content-length': Buffer.byteLength(payload), ...headers }
|
|
: headers
|
|
},
|
|
res => {
|
|
let data = '';
|
|
res.on('data', chunk => {
|
|
data += chunk;
|
|
});
|
|
res.on('end', () => resolve({ statusCode: res.statusCode, headers: res.headers, body: data }));
|
|
}
|
|
);
|
|
req.on('error', reject);
|
|
if (payload) req.write(payload);
|
|
req.end();
|
|
});
|
|
}
|
|
|
|
function jsonBody(res) {
|
|
return JSON.parse(res.body.trim());
|
|
}
|
|
|
|
// Open an SSE stream and collect parsed events into `received`.
|
|
function openSse(port, key) {
|
|
const received = [];
|
|
let close = () => {};
|
|
const ready = new Promise((resolve, reject) => {
|
|
const req = http.get(
|
|
{ host: '127.0.0.1', port, path: `/events/${key}`, agent: false },
|
|
res => {
|
|
let buffer = '';
|
|
res.on('data', chunk => {
|
|
buffer += chunk;
|
|
let idx;
|
|
while ((idx = buffer.indexOf('\n\n')) >= 0) {
|
|
const frame = buffer.slice(0, idx);
|
|
buffer = buffer.slice(idx + 2);
|
|
const eventMatch = frame.match(/^event: (.+)$/m);
|
|
const dataMatch = frame.match(/^data: (.+)$/m);
|
|
if (eventMatch && dataMatch) {
|
|
received.push({ event: eventMatch[1], data: JSON.parse(dataMatch[1]) });
|
|
}
|
|
}
|
|
});
|
|
resolve();
|
|
}
|
|
);
|
|
req.on('error', reject);
|
|
close = () => req.destroy();
|
|
});
|
|
return { received, ready, close: () => close() };
|
|
}
|
|
|
|
function waitFor(predicate, { timeoutMs = 3000, intervalMs = 20 } = {}) {
|
|
return new Promise((resolve, reject) => {
|
|
const startedAt = Date.now();
|
|
const timer = setInterval(() => {
|
|
if (predicate()) {
|
|
clearInterval(timer);
|
|
resolve();
|
|
} else if (Date.now() - startedAt > timeoutMs) {
|
|
clearInterval(timer);
|
|
reject(new Error('waitFor timed out'));
|
|
}
|
|
}, intervalMs);
|
|
});
|
|
}
|
|
|
|
async function main() {
|
|
console.log('\n=== Testing plan-canvas server ===\n');
|
|
|
|
const suite = createTestRunner();
|
|
const { test } = suite;
|
|
await artifactSecurityTests(test);
|
|
if (process.argv.includes('--artifact-security-only')) {
|
|
printResults(suite.results);
|
|
return;
|
|
}
|
|
|
|
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'plan-canvas-server-'));
|
|
const artifact = path.join(tmp, 'demo.plan.md');
|
|
fs.writeFileSync(artifact, '# Plan: Demo\n\n## Files to Change\n\n| File | Action |\n|---|---|\n| `a.js` | UPDATE |\n');
|
|
const htmlArtifact = path.join(tmp, 'report.html');
|
|
fs.writeFileSync(htmlArtifact, '<!DOCTYPE html><html><body><h1>Report</h1></body></html>');
|
|
fs.writeFileSync(path.join(tmp, 'style.css'), 'body { color: red }');
|
|
const outsideDir = fs.mkdtempSync(path.join(os.tmpdir(), 'plan-canvas-outside-'));
|
|
fs.writeFileSync(path.join(outsideDir, 'secret.txt'), 'secret');
|
|
|
|
const store = createSessionStore({ stateDir: path.join(tmp, 'state') });
|
|
let idleFired = false;
|
|
const canvas = createPlanCanvasServer({
|
|
store,
|
|
version: '9.9.9-test',
|
|
heartbeatMs: 25,
|
|
idleTimeoutMs: 0,
|
|
onIdleShutdown: () => {
|
|
idleFired = true;
|
|
}
|
|
});
|
|
const { port } = await canvas.listen(0);
|
|
|
|
let key = null;
|
|
let htmlKey = null;
|
|
|
|
await test('GET /health identifies the app and version', async () => {
|
|
const res = await request(port, 'GET', '/health');
|
|
assert.deepStrictEqual(jsonBody(res), { ok: true, app: 'ecc-plan-canvas', version: '9.9.9-test' });
|
|
});
|
|
|
|
await test('requests with a non-loopback Host header are rejected', async () => {
|
|
const res = await request(port, 'GET', '/health', { headers: { host: 'evil.example.com' } });
|
|
assert.strictEqual(res.statusCode, 403);
|
|
});
|
|
|
|
await test('requests with a cross-site Origin are rejected', async () => {
|
|
const res = await request(port, 'POST', '/shutdown', { headers: { origin: 'https://evil.example.com' } });
|
|
assert.strictEqual(res.statusCode, 403);
|
|
});
|
|
|
|
await test('POST /api/sessions opens a session for an existing artifact', async () => {
|
|
const res = await request(port, 'POST', '/api/sessions', { body: { file: artifact } });
|
|
assert.strictEqual(res.statusCode, 200);
|
|
const body = jsonBody(res);
|
|
assert.strictEqual(body.status, 'open');
|
|
assert.match(body.key, /^[a-f0-9]{12}$/);
|
|
key = body.key;
|
|
});
|
|
|
|
await test('POST /api/sessions 404s for a missing artifact', async () => {
|
|
const res = await request(port, 'POST', '/api/sessions', { body: { file: path.join(tmp, 'nope.md') } });
|
|
assert.strictEqual(res.statusCode, 404);
|
|
});
|
|
|
|
await test('GET /canvas/:key serves the ECC chrome with CSP', async () => {
|
|
const res = await request(port, 'GET', `/canvas/${key}`);
|
|
assert.strictEqual(res.statusCode, 200);
|
|
assert.ok(res.headers['content-security-policy'].includes("default-src 'self'"));
|
|
assert.ok(res.body.includes('Plan Canvas'));
|
|
assert.ok(res.body.includes('pc-session'));
|
|
assert.ok(res.body.includes('Approve plan'));
|
|
assert.ok(res.body.includes('sandbox="allow-scripts allow-forms allow-popups"'));
|
|
});
|
|
|
|
await test('markdown artifacts render in the ECC plan template with the SDK', async () => {
|
|
const res = await request(port, 'GET', `/artifact/${key}/`);
|
|
assert.strictEqual(res.statusCode, 200);
|
|
assert.ok(res.body.includes('<h1 id="plan-demo">'));
|
|
assert.ok(res.body.includes('<table>'));
|
|
assert.ok(res.body.includes('<script src="/sdk.js">'));
|
|
assert.strictEqual(res.headers['content-security-policy'], 'sandbox allow-scripts allow-forms allow-popups');
|
|
// No diagram in this plan → no Mermaid loader shipped.
|
|
assert.ok(!res.body.includes('mermaid.run'));
|
|
});
|
|
|
|
await test('a plan containing ```mermaid serves the themed Mermaid loader', async () => {
|
|
const diagram = path.join(tmp, 'flow.plan.md');
|
|
fs.writeFileSync(diagram, '# Flow\n\n```mermaid\nflowchart LR\n A --> B\n```\n');
|
|
const opened = jsonBody(await request(port, 'POST', '/api/sessions', { body: { file: diagram } }));
|
|
const res = await request(port, 'GET', `/artifact/${opened.key}/`);
|
|
assert.ok(res.body.includes('<pre class="mermaid">'), 'diagram container present');
|
|
assert.ok(res.body.includes('mermaid.run'), 'loader injected');
|
|
assert.ok(res.body.includes("securityLevel: 'strict'"), 'sanitizing config present');
|
|
await request(port, 'POST', '/api/end', { body: { file: diagram } });
|
|
});
|
|
|
|
await test('HTML artifacts pass through with the SDK injected before </body>', async () => {
|
|
const open = await request(port, 'POST', '/api/sessions', { body: { file: htmlArtifact } });
|
|
htmlKey = jsonBody(open).key;
|
|
const res = await request(port, 'GET', `/artifact/${htmlKey}/`);
|
|
assert.ok(res.body.includes('<h1>Report</h1>'));
|
|
assert.ok(res.body.includes('<script src="/sdk.js"></script>\n</body>'));
|
|
});
|
|
|
|
await test('sibling assets are served, traversal is blocked', async () => {
|
|
const ok = await request(port, 'GET', `/artifact/${key}/style.css`);
|
|
assert.strictEqual(ok.statusCode, 200);
|
|
assert.ok(ok.body.includes('color: red'));
|
|
const escape = await request(port, 'GET', `/artifact/${key}/..%2F${path.basename(outsideDir)}%2Fsecret.txt`);
|
|
assert.strictEqual(escape.statusCode, 403);
|
|
});
|
|
|
|
await test('artifact responses carry a sandbox CSP (direct-navigation hardening)', async () => {
|
|
const md = await request(port, 'GET', `/artifact/${key}/`);
|
|
assert.strictEqual(md.statusCode, 200);
|
|
assert.strictEqual(md.headers['content-security-policy'], 'sandbox allow-scripts allow-forms allow-popups');
|
|
const html = await request(port, 'GET', `/artifact/${htmlKey}/`);
|
|
assert.strictEqual(html.statusCode, 200);
|
|
assert.strictEqual(html.headers['content-security-policy'], 'sandbox allow-scripts allow-forms allow-popups');
|
|
});
|
|
|
|
await test('missing-artifact 404 escapes the file path', async () => {
|
|
// Quotes and ampersands are escapable on every platform (Windows
|
|
// rejects < > in filenames, so angle brackets stay out of fixtures).
|
|
const evilFile = path.join(tmp, `evil'b&xss.plan.md`);
|
|
fs.writeFileSync(evilFile, '# Evil\n');
|
|
const opened = jsonBody(await request(port, 'POST', '/api/sessions', { body: { file: evilFile } }));
|
|
fs.rmSync(evilFile);
|
|
const res = await request(port, 'GET', `/artifact/${opened.key}/`);
|
|
assert.strictEqual(res.statusCode, 404);
|
|
assert.ok(!res.body.includes(`evil'b&xss`), 'raw filename must not appear in the 404 page');
|
|
assert.ok(res.body.includes('evil'b&xss'), 'filename must be HTML-escaped in the 404 page');
|
|
});
|
|
|
|
await test('symlinked sibling assets escaping the artifact dir are blocked', async () => {
|
|
createTestSymlink(path.join(outsideDir, 'secret.txt'), path.join(tmp, 'evil-link.txt'));
|
|
createTestSymlink(path.join(tmp, 'style.css'), path.join(tmp, 'ok-link.css'));
|
|
const blocked = await request(port, 'GET', `/artifact/${key}/evil-link.txt`);
|
|
assert.strictEqual(blocked.statusCode, 403);
|
|
const allowed = await request(port, 'GET', `/artifact/${key}/ok-link.css`);
|
|
assert.strictEqual(allowed.statusCode, 200);
|
|
assert.ok(allowed.body.includes('color: red'));
|
|
});
|
|
|
|
await test('served HTML siblings carry the sandbox CSP', async () => {
|
|
fs.writeFileSync(path.join(tmp, 'note.html'), '<!DOCTYPE html><html><body><p>hi</p></body></html>');
|
|
const res = await request(port, 'GET', `/artifact/${key}/note.html`);
|
|
assert.strictEqual(res.statusCode, 200);
|
|
assert.strictEqual(res.headers['content-security-policy'], 'sandbox allow-scripts allow-forms allow-popups');
|
|
});
|
|
|
|
await test('symlinked assets take their MIME from the link name', async () => {
|
|
fs.writeFileSync(path.join(tmp, 'realfile'), 'body { color: blue }');
|
|
createTestSymlink(path.join(tmp, 'realfile'), path.join(tmp, 'theme.css'));
|
|
const res = await request(port, 'GET', `/artifact/${key}/theme.css`);
|
|
assert.strictEqual(res.statusCode, 200);
|
|
assert.ok(String(res.headers['content-type']).startsWith('text/css'));
|
|
});
|
|
|
|
await test('static chrome assets are served', async () => {
|
|
for (const asset of ['/canvas.css', '/client.js', '/sdk.js']) {
|
|
const res = await request(port, 'GET', asset);
|
|
assert.strictEqual(res.statusCode, 200, `${asset} should be 200`);
|
|
}
|
|
});
|
|
|
|
await test('await with timeoutMs returns waiting when idle', async () => {
|
|
const res = await request(port, 'GET', `/api/await?file=${encodeURIComponent(artifact)}&timeoutMs=50`);
|
|
assert.strictEqual(jsonBody(res).status, 'waiting');
|
|
});
|
|
|
|
await test('await returns missing for files without a session', async () => {
|
|
const res = await request(port, 'GET', `/api/await?file=${encodeURIComponent(path.join(tmp, 'other.md'))}`);
|
|
assert.strictEqual(jsonBody(res).status, 'missing');
|
|
});
|
|
|
|
await test('browser feedback wakes a blocking await; presence transitions', async () => {
|
|
const sse = openSse(port, key);
|
|
await sse.ready;
|
|
const awaitPromise = request(port, 'GET', `/api/await?file=${encodeURIComponent(artifact)}`);
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'listening'));
|
|
|
|
const post = await request(port, 'POST', `/api/session/${key}/feedback`, {
|
|
body: {
|
|
items: [
|
|
{ kind: 'annotation', text: 'tighten this', anchor: { selector: 'h2:nth-of-type(1)', tag: 'h2', snippet: 'Files to Change' } },
|
|
{ kind: 'verdict', verdict: 'request-changes' }
|
|
]
|
|
}
|
|
});
|
|
assert.strictEqual(jsonBody(post).accepted, 2);
|
|
|
|
const result = jsonBody(await awaitPromise);
|
|
assert.strictEqual(result.status, 'feedback');
|
|
assert.strictEqual(result.items.length, 2);
|
|
assert.strictEqual(result.items[0].anchor.selector, 'h2:nth-of-type(1)');
|
|
assert.strictEqual(result.items[1].verdict, 'request-changes');
|
|
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'thinking'));
|
|
await waitFor(() => sse.received.some(e => e.event === 'chat-sync' && e.data.chat.length === 2));
|
|
sse.close();
|
|
});
|
|
|
|
// Regression: feedback sent with nobody parked on `await` used to leave the
|
|
// pill claiming "agent working" while the message sat undelivered forever.
|
|
await test('feedback with no listener reports queued, not working', async () => {
|
|
const queuedArtifact = path.join(tmp, 'queued.plan.md');
|
|
fs.writeFileSync(queuedArtifact, '# Plan: Queued\n');
|
|
const opened = jsonBody(await request(port, 'POST', '/api/sessions', { body: { file: queuedArtifact } }));
|
|
const sse = openSse(port, opened.key);
|
|
await sse.ready;
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'waiting'));
|
|
|
|
const post = await request(port, 'POST', `/api/session/${opened.key}/feedback`, {
|
|
body: { items: [{ kind: 'chat', text: 'anyone there?' }] }
|
|
});
|
|
assert.strictEqual(jsonBody(post).presence, 'queued');
|
|
assert.strictEqual(canvas.presenceFor(opened.key), 'queued');
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'queued'));
|
|
|
|
// Draining it hands the batch over and flips the indicator to thinking.
|
|
const drained = jsonBody(await request(port, 'GET', `/api/await?key=${opened.key}&timeoutMs=0`));
|
|
assert.strictEqual(drained.status, 'feedback');
|
|
assert.strictEqual(canvas.presenceFor(opened.key), 'thinking');
|
|
sse.close();
|
|
});
|
|
|
|
await test('typing endpoint drives the indicator and reply clears it', async () => {
|
|
const typingArtifact = path.join(tmp, 'typing.plan.md');
|
|
fs.writeFileSync(typingArtifact, '# Plan: Typing\n');
|
|
const opened = jsonBody(await request(port, 'POST', '/api/sessions', { body: { file: typingArtifact } }));
|
|
const sse = openSse(port, opened.key);
|
|
await sse.ready;
|
|
|
|
const typing = await request(port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'typing' } });
|
|
assert.strictEqual(jsonBody(typing).presence, 'typing');
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'typing'));
|
|
|
|
const thinking = await request(port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'thinking' } });
|
|
assert.strictEqual(jsonBody(thinking).presence, 'thinking');
|
|
|
|
const bad = await request(port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'dancing' } });
|
|
assert.strictEqual(bad.statusCode, 400);
|
|
|
|
// A landed reply must take the bubble down, not leave it spinning.
|
|
await request(port, 'POST', `/api/session/${opened.key}/reply`, { body: { text: 'done' } });
|
|
assert.strictEqual(canvas.presenceFor(opened.key), 'waiting');
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'waiting'));
|
|
sse.close();
|
|
});
|
|
|
|
await test('thinking and typing states expire instead of sticking', async () => {
|
|
const staleArtifact = path.join(tmp, 'stale.plan.md');
|
|
fs.writeFileSync(staleArtifact, '# Plan: Stale\n');
|
|
const staleStore = createSessionStore({ stateDir: path.join(tmp, 'stale-state') });
|
|
const staleCanvas = createPlanCanvasServer({
|
|
store: staleStore,
|
|
version: '9.9.9-test',
|
|
idleTimeoutMs: 0,
|
|
thinkingStaleMs: 40,
|
|
typingExpiryMs: 20,
|
|
presenceSweepMs: 0
|
|
});
|
|
const bound = await staleCanvas.listen(0);
|
|
const opened = jsonBody(await request(bound.port, 'POST', '/api/sessions', { body: { file: staleArtifact } }));
|
|
|
|
await request(bound.port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'typing' } });
|
|
assert.strictEqual(staleCanvas.presenceFor(opened.key), 'typing');
|
|
await new Promise(resolve => setTimeout(resolve, 60));
|
|
assert.strictEqual(staleCanvas.presenceFor(opened.key), 'waiting');
|
|
|
|
// An abandoned agent decays to queued so the human is never told a
|
|
// stalled session is still being worked on.
|
|
await request(bound.port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'thinking' } });
|
|
await request(bound.port, 'POST', `/api/session/${opened.key}/feedback`, {
|
|
body: { items: [{ kind: 'chat', text: 'still there?' }] }
|
|
});
|
|
assert.strictEqual(staleCanvas.presenceFor(opened.key), 'thinking');
|
|
await new Promise(resolve => setTimeout(resolve, 60));
|
|
assert.strictEqual(staleCanvas.presenceFor(opened.key), 'queued');
|
|
await staleCanvas.close();
|
|
});
|
|
|
|
// The stuck pill only self-heals if the decay is pushed to an idle browser
|
|
// that is not making any requests of its own.
|
|
await test('presence sweep pushes the decayed state to an idle browser', async () => {
|
|
const sweepArtifact = path.join(tmp, 'sweep.plan.md');
|
|
fs.writeFileSync(sweepArtifact, '# Plan: Sweep\n');
|
|
const sweepStore = createSessionStore({ stateDir: path.join(tmp, 'sweep-state') });
|
|
const sweepCanvas = createPlanCanvasServer({
|
|
store: sweepStore,
|
|
version: '9.9.9-test',
|
|
idleTimeoutMs: 0,
|
|
thinkingStaleMs: 50,
|
|
presenceSweepMs: 20
|
|
});
|
|
const bound = await sweepCanvas.listen(0);
|
|
const opened = jsonBody(await request(bound.port, 'POST', '/api/sessions', { body: { file: sweepArtifact } }));
|
|
const sse = openSse(bound.port, opened.key);
|
|
await sse.ready;
|
|
|
|
await request(bound.port, 'POST', `/api/session/${opened.key}/typing`, { body: { state: 'thinking' } });
|
|
await waitFor(() => sse.received.some(e => e.event === 'presence' && e.data.state === 'thinking'));
|
|
|
|
const before = sse.received.length;
|
|
await waitFor(() =>
|
|
sse.received.slice(before).some(e => e.event === 'presence' && e.data.state === 'waiting')
|
|
);
|
|
sse.close();
|
|
await sweepCanvas.close();
|
|
});
|
|
|
|
await test('long-poll heartbeat whitespace arrives before the payload', async () => {
|
|
const chunks = [];
|
|
const done = new Promise((resolve, reject) => {
|
|
const req = http.get(
|
|
{ host: '127.0.0.1', port, path: `/api/await?file=${encodeURIComponent(artifact)}`, agent: false },
|
|
res => {
|
|
res.on('data', chunk => chunks.push(chunk.toString()));
|
|
res.on('end', resolve);
|
|
}
|
|
);
|
|
req.on('error', reject);
|
|
});
|
|
// Heartbeats tick every 25ms in this test server; wait for a few first.
|
|
await waitFor(() => chunks.join('').length >= 3);
|
|
assert.ok(/^\s+$/.test(chunks.join('')), 'expected only whitespace before payload');
|
|
await request(port, 'POST', `/api/session/${key}/feedback`, { body: { items: [{ kind: 'chat', text: 'wake up' }] } });
|
|
await done;
|
|
const full = chunks.join('');
|
|
assert.strictEqual(JSON.parse(full.trim()).status, 'feedback');
|
|
});
|
|
|
|
await test('agent reply lands in the chat via SSE chat-sync', async () => {
|
|
const sse = openSse(port, key);
|
|
await sse.ready;
|
|
const res = await request(port, 'POST', `/api/session/${key}/reply`, { body: { text: 'reworked, please re-check' } });
|
|
assert.strictEqual(jsonBody(res).status, 'sent');
|
|
await waitFor(() =>
|
|
sse.received.some(
|
|
e => e.event === 'chat-sync' && e.data.chat.some(m => m.role === 'agent' && m.text.includes('reworked'))
|
|
)
|
|
);
|
|
sse.close();
|
|
});
|
|
|
|
await test('live reload: editing the artifact emits an SSE reload event', async () => {
|
|
const sse = openSse(port, key);
|
|
await sse.ready;
|
|
fs.appendFileSync(artifact, '\n## Addendum\n');
|
|
await waitFor(() => sse.received.some(e => e.event === 'reload'), { timeoutMs: 4000 });
|
|
sse.close();
|
|
});
|
|
|
|
await test('send-and-end delivers the final batch and ends the session', async () => {
|
|
const awaitPromise = request(port, 'GET', `/api/await?file=${encodeURIComponent(artifact)}`);
|
|
await waitFor(() => canvas.presenceFor(key) === 'listening');
|
|
await request(port, 'POST', `/api/session/${key}/feedback`, {
|
|
body: { items: [{ kind: 'chat', text: 'looks good, wrapping up' }], endSession: true }
|
|
});
|
|
const result = jsonBody(await awaitPromise);
|
|
assert.strictEqual(result.status, 'feedback');
|
|
assert.strictEqual(result.sessionEnded, true);
|
|
assert.strictEqual(result.endedBy, 'user');
|
|
const after = await request(port, 'GET', `/api/await?file=${encodeURIComponent(artifact)}&timeoutMs=0`);
|
|
assert.strictEqual(jsonBody(after).status, 'ended');
|
|
});
|
|
|
|
await test('user-ended sessions return 409 on plain reopen, open with reopen:true', async () => {
|
|
const refused = await request(port, 'POST', '/api/sessions', { body: { file: artifact } });
|
|
assert.strictEqual(refused.statusCode, 409);
|
|
assert.strictEqual(jsonBody(refused).status, 'user-ended');
|
|
const forced = await request(port, 'POST', '/api/sessions', { body: { file: artifact, reopen: true } });
|
|
assert.strictEqual(forced.statusCode, 200);
|
|
});
|
|
|
|
await test('agent end via POST /api/end allows plain reopen', async () => {
|
|
const res = await request(port, 'POST', '/api/end', { body: { file: artifact } });
|
|
assert.strictEqual(jsonBody(res).endedBy, 'agent');
|
|
const reopened = await request(port, 'POST', '/api/sessions', { body: { file: artifact } });
|
|
assert.strictEqual(reopened.statusCode, 200);
|
|
});
|
|
|
|
await test('feedback on an ended session is refused with 409', async () => {
|
|
await request(port, 'POST', `/api/end`, { body: { file: htmlArtifact } });
|
|
const res = await request(port, 'POST', `/api/session/${htmlKey}/feedback`, {
|
|
body: { items: [{ kind: 'chat', text: 'too late' }] }
|
|
});
|
|
assert.strictEqual(res.statusCode, 409);
|
|
});
|
|
|
|
await test('GET / lists sessions in the ECC shell', async () => {
|
|
const res = await request(port, 'GET', '/');
|
|
assert.ok(res.body.includes('Plan Canvas sessions'));
|
|
assert.ok(res.body.includes('demo.plan.md'));
|
|
});
|
|
|
|
await test('POST /shutdown triggers the shutdown callback', async () => {
|
|
const res = await request(port, 'POST', '/shutdown');
|
|
assert.strictEqual(jsonBody(res).status, 'stopping');
|
|
await waitFor(() => idleFired);
|
|
});
|
|
|
|
await test('close() settles a held long-poll instead of hanging', async () => {
|
|
await request(port, 'POST', '/api/sessions', { body: { file: artifact, reopen: true } });
|
|
const held = request(port, 'GET', `/api/await?file=${encodeURIComponent(artifact)}`);
|
|
await waitFor(() => canvas.presenceFor(store.findByFile(artifact).key) === 'listening');
|
|
await canvas.close();
|
|
const result = jsonBody(await held);
|
|
assert.strictEqual(result.status, 'waiting');
|
|
assert.ok(result.note.includes('shutting down'));
|
|
});
|
|
|
|
fs.rmSync(tmp, { recursive: true, force: true });
|
|
fs.rmSync(outsideDir, { recursive: true, force: true });
|
|
|
|
console.log('\n' + '='.repeat(40));
|
|
printResults(suite.results);
|
|
console.log('='.repeat(40));
|
|
}
|
|
|
|
main().catch(err => {
|
|
console.error(err);
|
|
console.log('Passed: 0');
|
|
console.log('Failed: 1');
|
|
process.exit(1);
|
|
});
|