mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-09-30 12:39:42 +02:00
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>
205 lines
6.9 KiB
TypeScript
205 lines
6.9 KiB
TypeScript
/**
|
|
* @fileoverview Tests for push-routes route handlers.
|
|
*
|
|
* Uses app.inject() — no real HTTP ports needed.
|
|
* Port: N/A (app.inject doesn't open ports)
|
|
*/
|
|
|
|
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
|
|
import { createRouteTestHarness, type RouteTestHarness } from './_route-test-utils.js';
|
|
import { registerPushRoutes } from '../../src/web/routes/push-routes.js';
|
|
|
|
describe('push-routes', () => {
|
|
let harness: RouteTestHarness;
|
|
|
|
beforeEach(async () => {
|
|
harness = await createRouteTestHarness(registerPushRoutes);
|
|
// Push routes expect ctx.pushStore to be a real object (not null)
|
|
harness.ctx.pushStore = {
|
|
getPublicKey: vi.fn(() => 'test-vapid-public-key-base64'),
|
|
addSubscription: vi.fn((record: Record<string, unknown>) => record),
|
|
updatePreferences: vi.fn(() => true),
|
|
removeSubscription: vi.fn(() => true),
|
|
} as never;
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await harness.app.close();
|
|
});
|
|
|
|
// ========== GET /api/push/vapid-key ==========
|
|
|
|
describe('GET /api/push/vapid-key', () => {
|
|
it('returns the VAPID public key', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'GET',
|
|
url: '/api/push/vapid-key',
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(true);
|
|
expect(body.data.publicKey).toBe('test-vapid-public-key-base64');
|
|
});
|
|
});
|
|
|
|
// ========== POST /api/push/subscribe ==========
|
|
|
|
describe('POST /api/push/subscribe', () => {
|
|
it('creates a push subscription', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'POST',
|
|
url: '/api/push/subscribe',
|
|
payload: {
|
|
endpoint: 'https://push.example.com/send/abc123',
|
|
keys: {
|
|
p256dh: 'test-p256dh-key',
|
|
auth: 'test-auth-key',
|
|
},
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(true);
|
|
expect(body.data.id).toBeDefined();
|
|
expect(harness.ctx.pushStore.addSubscription).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
endpoint: 'https://push.example.com/send/abc123',
|
|
keys: { p256dh: 'test-p256dh-key', auth: 'test-auth-key' },
|
|
})
|
|
);
|
|
});
|
|
|
|
it('accepts optional userAgent and pushPreferences', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'POST',
|
|
url: '/api/push/subscribe',
|
|
payload: {
|
|
endpoint: 'https://push.example.com/send/abc123',
|
|
keys: { p256dh: 'test-p256dh', auth: 'test-auth' },
|
|
userAgent: 'TestBrowser/1.0',
|
|
pushPreferences: { 'session:idle': true, 'session:error': false },
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(true);
|
|
expect(harness.ctx.pushStore.addSubscription).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
userAgent: 'TestBrowser/1.0',
|
|
pushPreferences: { 'session:idle': true, 'session:error': false },
|
|
})
|
|
);
|
|
});
|
|
|
|
it('rejects invalid subscription (missing endpoint)', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'POST',
|
|
url: '/api/push/subscribe',
|
|
payload: {
|
|
keys: { p256dh: 'test-p256dh', auth: 'test-auth' },
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(400);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(false);
|
|
});
|
|
|
|
it('rejects invalid subscription (missing keys)', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'POST',
|
|
url: '/api/push/subscribe',
|
|
payload: {
|
|
endpoint: 'https://push.example.com/send/abc123',
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(400);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(false);
|
|
});
|
|
});
|
|
|
|
// ========== PUT /api/push/subscribe/:id ==========
|
|
|
|
describe('PUT /api/push/subscribe/:id', () => {
|
|
it('updates push preferences for a subscription', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'PUT',
|
|
url: '/api/push/subscribe/sub-123',
|
|
payload: {
|
|
pushPreferences: { 'session:idle': true, 'session:error': true },
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
// Handler returns a bare {} on success; the uniform envelope wraps it to
|
|
// { success:true, data:{} } in production. At the route-handler layer the
|
|
// harness sees the bare return, so the meaningful check is the empty body
|
|
// plus the pushStore call below.
|
|
expect(body).toEqual({});
|
|
expect(harness.ctx.pushStore.updatePreferences).toHaveBeenCalledWith('sub-123', {
|
|
'session:idle': true,
|
|
'session:error': true,
|
|
});
|
|
});
|
|
|
|
it('returns 404 for unknown subscription', async () => {
|
|
(harness.ctx.pushStore.updatePreferences as ReturnType<typeof vi.fn>).mockReturnValue(false);
|
|
|
|
const res = await harness.app.inject({
|
|
method: 'PUT',
|
|
url: '/api/push/subscribe/nonexistent',
|
|
payload: {
|
|
pushPreferences: { 'session:idle': true },
|
|
},
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(false);
|
|
expect(body.error).toContain('not found');
|
|
});
|
|
|
|
it('rejects invalid body (missing pushPreferences)', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'PUT',
|
|
url: '/api/push/subscribe/sub-123',
|
|
payload: {},
|
|
});
|
|
expect(res.statusCode).toBe(400);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(false);
|
|
});
|
|
});
|
|
|
|
// ========== DELETE /api/push/subscribe/:id ==========
|
|
|
|
describe('DELETE /api/push/subscribe/:id', () => {
|
|
it('removes a push subscription', async () => {
|
|
const res = await harness.app.inject({
|
|
method: 'DELETE',
|
|
url: '/api/push/subscribe/sub-123',
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
// Handler returns a bare {} on success; the uniform envelope wraps it to
|
|
// { success:true, data:{} } in production. At the route-handler layer the
|
|
// harness sees the bare return, so the meaningful check is the empty body
|
|
// plus the pushStore call below.
|
|
expect(body).toEqual({});
|
|
expect(harness.ctx.pushStore.removeSubscription).toHaveBeenCalledWith('sub-123');
|
|
});
|
|
|
|
it('returns 404 for unknown subscription', async () => {
|
|
(harness.ctx.pushStore.removeSubscription as ReturnType<typeof vi.fn>).mockReturnValue(false);
|
|
|
|
const res = await harness.app.inject({
|
|
method: 'DELETE',
|
|
url: '/api/push/subscribe/nonexistent',
|
|
});
|
|
expect(res.statusCode).toBe(200);
|
|
const body = JSON.parse(res.body);
|
|
expect(body.success).toBe(false);
|
|
expect(body.error).toContain('not found');
|
|
});
|
|
});
|
|
});
|