feat(api): error + validate + pagination plumbing
Add lib/api/{errors,validate,pagination,index}.js: typed ApiError
subclasses, errorMiddleware, zod-backed validate(), parsePagination
with caps, and a mountApi() that owns /api routing + 404 + error tail.
server.js delegates /api to mountApi and drops the inline /api/spaces
smoke (returns in Task 2).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
48
lib/api/errors.js
Normal file
48
lib/api/errors.js
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
import { log } from '../log.js';
|
||||||
|
|
||||||
|
export class ApiError extends Error {
|
||||||
|
constructor(code, message, status, details) {
|
||||||
|
super(message);
|
||||||
|
this.code = code;
|
||||||
|
this.status = status;
|
||||||
|
this.details = details;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class NotFoundError extends ApiError {
|
||||||
|
constructor(message = 'not found', details) {
|
||||||
|
super('not_found', message, 404, details);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ValidationError extends ApiError {
|
||||||
|
constructor(message = 'validation failed', details) {
|
||||||
|
super('validation_failed', message, 400, details);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ConflictError extends ApiError {
|
||||||
|
constructor(message = 'conflict', details) {
|
||||||
|
super('conflict', message, 409, details);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ForbiddenError extends ApiError {
|
||||||
|
constructor(message = 'forbidden', details) {
|
||||||
|
super('forbidden', message, 403, details);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function asyncWrap(fn) {
|
||||||
|
return (req, res, next) => Promise.resolve(fn(req, res, next)).catch(next);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function errorMiddleware(err, _req, res, _next) {
|
||||||
|
if (err instanceof ApiError) {
|
||||||
|
const body = { error: { code: err.code, message: err.message } };
|
||||||
|
if (err.details !== undefined) body.error.details = err.details;
|
||||||
|
return res.status(err.status).json(body);
|
||||||
|
}
|
||||||
|
log.error({ err }, 'unhandled');
|
||||||
|
res.status(500).json({ error: { code: 'internal', message: err.message } });
|
||||||
|
}
|
||||||
16
lib/api/index.js
Normal file
16
lib/api/index.js
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { Router } from 'express';
|
||||||
|
import { ownerOnly } from '../auth/owner.js';
|
||||||
|
import { errorMiddleware, NotFoundError } from './errors.js';
|
||||||
|
|
||||||
|
export function mountApi(app) {
|
||||||
|
const api = Router();
|
||||||
|
api.use(ownerOnly);
|
||||||
|
|
||||||
|
// route modules registered here as Plan 2 progresses
|
||||||
|
|
||||||
|
api.use((_req, _res, next) => next(new NotFoundError('route not found')));
|
||||||
|
|
||||||
|
api.use(errorMiddleware);
|
||||||
|
app.use('/api', api);
|
||||||
|
return api;
|
||||||
|
}
|
||||||
14
lib/api/pagination.js
Normal file
14
lib/api/pagination.js
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { ValidationError } from './errors.js';
|
||||||
|
|
||||||
|
export function parsePagination(req, { defaultLimit = 50, max = 200 } = {}) {
|
||||||
|
const q = req.query || {};
|
||||||
|
const limit = q.limit === undefined ? defaultLimit : Number(q.limit);
|
||||||
|
const offset = q.offset === undefined ? 0 : Number(q.offset);
|
||||||
|
if (!Number.isFinite(limit) || limit < 1 || limit > max) {
|
||||||
|
throw new ValidationError(`limit must be 1..${max}`, { limit: q.limit });
|
||||||
|
}
|
||||||
|
if (!Number.isFinite(offset) || offset < 0) {
|
||||||
|
throw new ValidationError('offset must be >= 0', { offset: q.offset });
|
||||||
|
}
|
||||||
|
return { limit, offset };
|
||||||
|
}
|
||||||
15
lib/api/validate.js
Normal file
15
lib/api/validate.js
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { ValidationError } from './errors.js';
|
||||||
|
|
||||||
|
export function validate({ body, params, query } = {}) {
|
||||||
|
return (req, _res, next) => {
|
||||||
|
try {
|
||||||
|
if (body) req.body = body.parse(req.body);
|
||||||
|
if (params) req.params = params.parse(req.params);
|
||||||
|
if (query) req.validatedQuery = query.parse(req.query);
|
||||||
|
next();
|
||||||
|
} catch (e) {
|
||||||
|
if (e?.issues) return next(new ValidationError('validation failed', e.issues));
|
||||||
|
next(e);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,9 +1,8 @@
|
|||||||
import 'dotenv/config';
|
import 'dotenv/config';
|
||||||
import express from 'express';
|
import express from 'express';
|
||||||
import { pool } from './lib/db/pool.js';
|
import { pool } from './lib/db/pool.js';
|
||||||
import { ownerOnly } from './lib/auth/owner.js';
|
|
||||||
import { log } from './lib/log.js';
|
import { log } from './lib/log.js';
|
||||||
import * as spaces from './lib/db/repos/spaces.js';
|
import { mountApi } from './lib/api/index.js';
|
||||||
|
|
||||||
const VERSION = '2.0.0-alpha.1';
|
const VERSION = '2.0.0-alpha.1';
|
||||||
|
|
||||||
@@ -22,11 +21,7 @@ export function createApp() {
|
|||||||
res.json({ ok: true, db_ok, version: VERSION });
|
res.json({ ok: true, db_ok, version: VERSION });
|
||||||
});
|
});
|
||||||
|
|
||||||
app.use('/api', ownerOnly);
|
mountApi(app);
|
||||||
|
|
||||||
app.get('/api/spaces', async (_req, res) => {
|
|
||||||
res.json(await spaces.list());
|
|
||||||
});
|
|
||||||
|
|
||||||
app.use((_req, res) => res.status(404).json({ error: { code: 'not_found' } }));
|
app.use((_req, res) => res.status(404).json({ error: { code: 'not_found' } }));
|
||||||
|
|
||||||
|
|||||||
64
tests/api/errors.test.js
Normal file
64
tests/api/errors.test.js
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import express from 'express';
|
||||||
|
import request from 'supertest';
|
||||||
|
import {
|
||||||
|
errorMiddleware,
|
||||||
|
NotFoundError, ValidationError, ConflictError, ForbiddenError,
|
||||||
|
asyncWrap, ApiError
|
||||||
|
} from '../../lib/api/errors.js';
|
||||||
|
|
||||||
|
function buildApp(handler) {
|
||||||
|
const app = express();
|
||||||
|
app.use(express.json());
|
||||||
|
app.get('/test', asyncWrap(handler));
|
||||||
|
app.use(errorMiddleware);
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('api/errors', () => {
|
||||||
|
it('NotFoundError → 404 with code "not_found"', async () => {
|
||||||
|
const res = await request(buildApp(() => { throw new NotFoundError('missing'); }))
|
||||||
|
.get('/test');
|
||||||
|
expect(res.status).toBe(404);
|
||||||
|
expect(res.body).toEqual({ error: { code: 'not_found', message: 'missing' } });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ValidationError → 400 with details', async () => {
|
||||||
|
const res = await request(buildApp(() => { throw new ValidationError('bad', [{ path: 'name' }]); }))
|
||||||
|
.get('/test');
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(res.body.error.code).toBe('validation_failed');
|
||||||
|
expect(res.body.error.details).toEqual([{ path: 'name' }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ConflictError → 409', async () => {
|
||||||
|
const res = await request(buildApp(() => { throw new ConflictError(); })).get('/test');
|
||||||
|
expect(res.status).toBe(409);
|
||||||
|
expect(res.body.error.code).toBe('conflict');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ForbiddenError → 403', async () => {
|
||||||
|
const res = await request(buildApp(() => { throw new ForbiddenError(); })).get('/test');
|
||||||
|
expect(res.status).toBe(403);
|
||||||
|
expect(res.body.error.code).toBe('forbidden');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('unknown error → 500 with generic shape', async () => {
|
||||||
|
const res = await request(buildApp(() => { throw new Error('boom'); })).get('/test');
|
||||||
|
expect(res.status).toBe(500);
|
||||||
|
expect(res.body.error.code).toBe('internal');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('asyncWrap forwards rejected promises', async () => {
|
||||||
|
const res = await request(buildApp(async () => { throw new NotFoundError(); }))
|
||||||
|
.get('/test');
|
||||||
|
expect(res.status).toBe(404);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ApiError exposes code, status, and details', () => {
|
||||||
|
const e = new ApiError('x', 'y', 418, { a: 1 });
|
||||||
|
expect(e.code).toBe('x');
|
||||||
|
expect(e.status).toBe(418);
|
||||||
|
expect(e.details).toEqual({ a: 1 });
|
||||||
|
});
|
||||||
|
});
|
||||||
14
tests/api/helpers.js
Normal file
14
tests/api/helpers.js
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { createApp } from '../../server.js';
|
||||||
|
import { resetDb } from '../helpers/db.js';
|
||||||
|
import { migrateUp } from '../../lib/db/migrate.js';
|
||||||
|
|
||||||
|
const OWNER_TOKEN = 'test-token';
|
||||||
|
|
||||||
|
export async function setup() {
|
||||||
|
await resetDb();
|
||||||
|
await migrateUp();
|
||||||
|
process.env.OWNER_TOKEN = OWNER_TOKEN;
|
||||||
|
const app = createApp();
|
||||||
|
const ownerHeaders = { Authorization: `Bearer ${OWNER_TOKEN}` };
|
||||||
|
return { app, ownerHeaders, OWNER_TOKEN };
|
||||||
|
}
|
||||||
75
tests/api/validate.test.js
Normal file
75
tests/api/validate.test.js
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import express from 'express';
|
||||||
|
import request from 'supertest';
|
||||||
|
import { z } from 'zod';
|
||||||
|
import { validate } from '../../lib/api/validate.js';
|
||||||
|
import { errorMiddleware } from '../../lib/api/errors.js';
|
||||||
|
import { parsePagination } from '../../lib/api/pagination.js';
|
||||||
|
|
||||||
|
function buildApp() {
|
||||||
|
const app = express();
|
||||||
|
app.use(express.json());
|
||||||
|
|
||||||
|
app.post('/body',
|
||||||
|
validate({ body: z.object({ name: z.string().min(1) }) }),
|
||||||
|
(req, res) => res.json(req.body)
|
||||||
|
);
|
||||||
|
|
||||||
|
app.get('/params/:id',
|
||||||
|
validate({ params: z.object({ id: z.string().uuid() }) }),
|
||||||
|
(req, res) => res.json(req.params)
|
||||||
|
);
|
||||||
|
|
||||||
|
app.get('/page', (req, res) => {
|
||||||
|
try {
|
||||||
|
const p = parsePagination(req);
|
||||||
|
res.json(p);
|
||||||
|
} catch (e) { errorMiddleware(e, req, res, () => {}); }
|
||||||
|
});
|
||||||
|
|
||||||
|
app.use(errorMiddleware);
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('api/validate', () => {
|
||||||
|
it('body schema parses and replaces req.body', async () => {
|
||||||
|
const res = await request(buildApp()).post('/body').send({ name: 'home' });
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(res.body).toEqual({ name: 'home' });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('body schema failure → 400 with zod issues in details', async () => {
|
||||||
|
const res = await request(buildApp()).post('/body').send({ name: '' });
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
expect(res.body.error.code).toBe('validation_failed');
|
||||||
|
expect(Array.isArray(res.body.error.details)).toBe(true);
|
||||||
|
expect(res.body.error.details.length).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('params schema failure → 400', async () => {
|
||||||
|
const res = await request(buildApp()).get('/params/not-a-uuid');
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('api/pagination', () => {
|
||||||
|
it('defaults to limit=50 offset=0', async () => {
|
||||||
|
const res = await request(buildApp()).get('/page');
|
||||||
|
expect(res.body).toEqual({ limit: 50, offset: 0 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('honors ?limit&offset', async () => {
|
||||||
|
const res = await request(buildApp()).get('/page?limit=10&offset=5');
|
||||||
|
expect(res.body).toEqual({ limit: 10, offset: 5 });
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects negative offset', async () => {
|
||||||
|
const res = await request(buildApp()).get('/page?offset=-1');
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects limit above max', async () => {
|
||||||
|
const res = await request(buildApp()).get('/page?limit=999');
|
||||||
|
expect(res.status).toBe(400);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -25,16 +25,14 @@ describe('server', () => {
|
|||||||
expect(res.status).toBe(401);
|
expect(res.status).toBe(401);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('GET /api/spaces with token returns 200 and empty array', async () => {
|
it('unknown /api route returns 404 with structured error', async () => {
|
||||||
const res = await request(app)
|
const res = await request(app).get('/api/nope').set('Authorization', 'Bearer test-token');
|
||||||
.get('/api/spaces')
|
expect(res.status).toBe(404);
|
||||||
.set('Authorization', 'Bearer test-token');
|
expect(res.body).toEqual({ error: { code: 'not_found', message: 'route not found' } });
|
||||||
expect(res.status).toBe(200);
|
|
||||||
expect(res.body).toEqual([]);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('unknown route returns 404', async () => {
|
it('unknown non-api route returns 404', async () => {
|
||||||
const res = await request(app).get('/api/nope').set('Authorization', 'Bearer test-token');
|
const res = await request(app).get('/missing');
|
||||||
expect(res.status).toBe(404);
|
expect(res.status).toBe(404);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user