feat(api): establish stable HTTP contract — uniform {success,data} envelope, status codes, /api/v1

Point 1 of the v1.0 lock-in: commit to a stable HTTP API (the cleanest, fullest form).

Core (centralized):
- Every JSON /api response now uses ONE envelope via a Fastify preSerialization hook (src/web/server.ts): success -> { success:true, data:<payload> }; error -> { success:false, error, errorCode } with a conventional HTTP status. Non-JSON routes (file-raw, tail-file SSE, download, screenshots, /q redirect, WS) are skipped.
- Error-code -> HTTP status is a single source of truth (httpStatusForErrorCode in src/types/api.ts): 400/401/404/409/422/429/500. Expanded ApiErrorCode (added UNAUTHORIZED, CONFLICT, RATE_LIMITED). Errors are no longer HTTP 200.
- Versioned alias: /api/v1/* rewrites to /api/* (rewriteApiV1Url), so external clients pin to a stable surface while the bundled UI keeps using /api/*.
- Handlers stripped of manual 'success:true' (50 across 14 route files) so they return bare payloads the hook wraps uniformly; fixed the mux DELETE {success:<bool>} envelope collision (-> {killed}).

Frontend (48 call sites across 10 files):
- _apiJson() auto-unwraps { success:true, data } -> data (null on error), so most bare-shape readers are transparent. Raw-fetch sites relocate payload reads under .data; success/res.ok/error checks unchanged.

Docs: new docs/api-reference.md (envelope, status table, error codes, /api/v1, SSE); versioning-policy.md flipped — the HTTP/SSE API is now part of the stable, SemVer-covered surface.

Verification: full unit/route suite green (2680 passed) incl. ~166 updated assertions across 24 test files; typecheck/lint/format/frontend-syntax clean; a headless-chromium smoke loaded the migrated UI and drove the panels with 0 console/page errors; /api/status and /api/v1/status confirmed returning the uniform envelope live.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
arkon
2026-06-10 01:30:43 +02:00
co-authored by Claude Opus 4.8
parent 5b3024b327
commit 458fb81cbe
49 changed files with 929 additions and 554 deletions
+11 -19
View File
@@ -140,7 +140,6 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'GET', url: '/api/config' });
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.config).toBeDefined();
});
});
@@ -156,7 +155,7 @@ describe('system-routes', () => {
});
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.config).toBeDefined();
expect(harness.ctx.store.setConfig).toHaveBeenCalled();
});
@@ -179,7 +178,6 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'GET', url: '/api/stats' });
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.stats).toBeDefined();
});
});
@@ -191,7 +189,6 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'GET', url: '/api/token-stats' });
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.daily).toBeDefined();
expect(body.totals).toBeDefined();
});
@@ -230,7 +227,6 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'POST', url: '/api/cleanup-state' });
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.cleanedSessions).toBe(0);
expect(harness.ctx.store.cleanupStaleSessions).toHaveBeenCalled();
});
@@ -266,7 +262,7 @@ describe('system-routes', () => {
});
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body).toEqual({});
});
it('revokes a specific session token', async () => {
@@ -280,7 +276,6 @@ describe('system-routes', () => {
payload: { sessionToken: 'tok-123' },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(authSessions.has('tok-123')).toBe(false);
});
@@ -333,8 +328,6 @@ describe('system-routes', () => {
payload: { showSystemStats: true, subagentTrackingEnabled: false },
});
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(mockedWriteFile).toHaveBeenCalled();
});
@@ -347,7 +340,7 @@ describe('system-routes', () => {
payload: { showTokenCount: false },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
// Verify writeFile was called with merged content
const writtenContent = JSON.parse(mockedWriteFile.mock.calls[0][1] as string);
@@ -377,7 +370,7 @@ describe('system-routes', () => {
payload: { lastUsedCase: 'my-test-case' },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
const writtenContent = JSON.parse(mockedWriteFile.mock.calls[0][1] as string);
expect(writtenContent.lastUsedCase).toBe('my-test-case');
@@ -439,7 +432,7 @@ describe('system-routes', () => {
payload: { minimized: { 'agent-1': true }, open: ['agent-2'] },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
expect(mockedWriteFile).toHaveBeenCalled();
});
@@ -450,7 +443,7 @@ describe('system-routes', () => {
payload: { minimized: {}, open: [] },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
});
it('rejects invalid minimized values', async () => {
@@ -496,7 +489,7 @@ describe('system-routes', () => {
payload: { 'agent-1': 'session-abc' },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
expect(mockedWriteFile).toHaveBeenCalled();
});
@@ -507,7 +500,7 @@ describe('system-routes', () => {
payload: {},
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
});
it('rejects non-string values in parent map', async () => {
@@ -629,7 +622,6 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'GET', url: '/api/session-lifecycle' });
expect(res.statusCode).toBe(200);
const body = JSON.parse(res.body);
expect(body.success).toBe(true);
expect(body.entries).toEqual(mockEntries);
});
@@ -754,7 +746,7 @@ describe('system-routes', () => {
payload: { model: 'claude-3', temperature: 0.5 },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
expect(mockedWriteFile).toHaveBeenCalled();
// Verify the written content contains modelConfig
@@ -771,7 +763,7 @@ describe('system-routes', () => {
payload: { model: 'new-model' },
});
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
const writtenContent = JSON.parse(mockedWriteFile.mock.calls[0][1] as string);
expect(writtenContent.showCost).toBe(true);
@@ -972,7 +964,7 @@ describe('system-routes', () => {
const res = await harness.app.inject({ method: 'POST', url: '/api/tunnel/qr/regenerate' });
expect(res.statusCode).toBe(200);
expect(JSON.parse(res.body).success).toBe(true);
expect(JSON.parse(res.body)).toEqual({});
});
});
});