BitSquare/Codeman
2
0
Fork 0
mirror of https://github.com/Ark0N/Codeman.git synced 2026-10-07 07:59:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
test/session-cleanup.test.ts
+22 -22
View File
@@ -60,14 +60,14 @@ describe('Session Cleanup', () => {
expect(quickStartData.success).toBe(true);
// Delete the session
const deleteRes = await fetch(`${baseUrl}/api/sessions/${quickStartData.sessionId}`, {
const deleteRes = await fetch(`${baseUrl}/api/sessions/${quickStartData.data.sessionId}`, {
method: 'DELETE',
});
const deleteData = await deleteRes.json();
expect(deleteData.success).toBe(true);
// Verify session is gone
const getRes = await fetch(`${baseUrl}/api/sessions/${quickStartData.sessionId}`);
const getRes = await fetch(`${baseUrl}/api/sessions/${quickStartData.data.sessionId}`);
const getData = await getRes.json();
expect(getData.error).toContain('not found');
});
@@ -87,7 +87,7 @@ describe('Session Cleanup', () => {
});
const data = await res.json();
expect(data.success).toBe(true);
sessionIds.push(data.sessionId);
sessionIds.push(data.data.sessionId);
}
// Delete all sessions
@@ -103,7 +103,7 @@ describe('Session Cleanup', () => {
const listRes = await fetch(`${baseUrl}/api/sessions`);
const sessions = await listRes.json();
for (const id of sessionIds) {
expect(sessions.find((s: any) => s.id === id)).toBeUndefined();
expect(sessions.data.find((s: any) => s.id === id)).toBeUndefined();
}
}, 60000); // Extended timeout for multi-session test
});
@@ -129,19 +129,19 @@ describe('Session Cleanup', () => {
expect(sessionData.success).toBe(true);
// Start interactive with respawn
const interactiveRes = await fetch(`${baseUrl}/api/sessions/${sessionData.session.id}/interactive-respawn`, {
const interactiveRes = await fetch(`${baseUrl}/api/sessions/${sessionData.data.session.id}/interactive-respawn`, {
method: 'POST',
});
const interactiveData = await interactiveRes.json();
expect(interactiveData.success).toBe(true);
// Verify respawn is running
const respawnRes = await fetch(`${baseUrl}/api/sessions/${sessionData.session.id}/respawn`);
const respawnRes = await fetch(`${baseUrl}/api/sessions/${sessionData.data.session.id}/respawn`);
const respawnData = await respawnRes.json();
expect(respawnData.enabled).toBe(true);
expect(respawnData.data.enabled).toBe(true);
// Delete session
await fetch(`${baseUrl}/api/sessions/${sessionData.session.id}`, {
await fetch(`${baseUrl}/api/sessions/${sessionData.data.session.id}`, {
method: 'DELETE',
});
@@ -149,10 +149,10 @@ describe('Session Cleanup', () => {
await new Promise((resolve) => setTimeout(resolve, 500));
// Verify respawn controller is cleaned up (enabled: false when controller doesn't exist)
const respawnAfterRes = await fetch(`${baseUrl}/api/sessions/${sessionData.session.id}/respawn`);
const respawnAfterRes = await fetch(`${baseUrl}/api/sessions/${sessionData.data.session.id}/respawn`);
const respawnAfterData = await respawnAfterRes.json();
// The respawn endpoint returns enabled: false when there's no controller
expect(respawnAfterData.enabled).toBe(false);
expect(respawnAfterData.data.enabled).toBe(false);
});
});
@@ -172,16 +172,16 @@ describe('Session Cleanup', () => {
expect(createData.success).toBe(true);
// Stop the scheduled run
const stopRes = await fetch(`${baseUrl}/api/scheduled/${createData.run.id}`, {
const stopRes = await fetch(`${baseUrl}/api/scheduled/${createData.data.run.id}`, {
method: 'DELETE',
});
const stopData = await stopRes.json();
expect(stopData.success).toBe(true);
// Verify status is stopped
const getRes = await fetch(`${baseUrl}/api/scheduled/${createData.run.id}`);
const getRes = await fetch(`${baseUrl}/api/scheduled/${createData.data.run.id}`);
const getData = await getRes.json();
expect(getData.status).toBe('stopped');
expect(getData.data.status).toBe('stopped');
});
});
});
@@ -211,7 +211,7 @@ describe('Resource Management', () => {
// Get initial session count (may have restored sessions from other tests)
const initialRes = await fetch(`${baseUrl}/api/sessions`);
const initialSessions = await initialRes.json();
const initialCount = initialSessions.length;
const initialCount = initialSessions.data.length;
const iterations = 5;
const createdSessionIds: string[] = [];
@@ -228,10 +228,10 @@ describe('Resource Management', () => {
});
const createData = await createRes.json();
expect(createData.success).toBe(true);
createdSessionIds.push(createData.sessionId);
createdSessionIds.push(createData.data.sessionId);
// Delete immediately
const deleteRes = await fetch(`${baseUrl}/api/sessions/${createData.sessionId}`, {
const deleteRes = await fetch(`${baseUrl}/api/sessions/${createData.data.sessionId}`, {
method: 'DELETE',
});
const deleteData = await deleteRes.json();
@@ -250,11 +250,11 @@ describe('Resource Management', () => {
// None of the sessions we created should still exist
for (const sessionId of createdSessionIds) {
expect(sessions.find((s: { id: string }) => s.id === sessionId)).toBeUndefined();
expect(sessions.data.find((s: { id: string }) => s.id === sessionId)).toBeUndefined();
}
// Session count should be back to initial (or less if some restored sessions were cleaned up)
expect(sessions.length).toBeLessThanOrEqual(initialCount);
expect(sessions.data.length).toBeLessThanOrEqual(initialCount);
});
it('should clear terminal buffer after session stop', async () => {
@@ -274,18 +274,18 @@ describe('Resource Management', () => {
await new Promise((resolve) => setTimeout(resolve, 2000));
// Get terminal buffer before stop - may or may not have content depending on timing
const terminalRes = await fetch(`${baseUrl}/api/sessions/${createData.sessionId}/terminal`);
const terminalRes = await fetch(`${baseUrl}/api/sessions/${createData.data.sessionId}/terminal`);
const terminalData = await terminalRes.json();
// Just verify the property exists
expect(terminalData.terminalBuffer).toBeDefined();
expect(terminalData.data.terminalBuffer).toBeDefined();
// Delete session
await fetch(`${baseUrl}/api/sessions/${createData.sessionId}`, {
await fetch(`${baseUrl}/api/sessions/${createData.data.sessionId}`, {
method: 'DELETE',
});
// Session should be gone
const afterRes = await fetch(`${baseUrl}/api/sessions/${createData.sessionId}/terminal`);
const afterRes = await fetch(`${baseUrl}/api/sessions/${createData.data.sessionId}/terminal`);
const afterData = await afterRes.json();
expect(afterData.error).toContain('not found');
});