diff --git a/apps/web/e2e/tests/platform/rest-posts.spec.ts b/apps/web/e2e/tests/platform/rest-posts.spec.ts index e253964ca6..80043483d6 100644 --- a/apps/web/e2e/tests/platform/rest-posts.spec.ts +++ b/apps/web/e2e/tests/platform/rest-posts.spec.ts @@ -107,18 +107,11 @@ test.describe('REST posts: list and read', () => { expect(page2.data.map((p: { id: string }) => p.id)).toEqual([first.id]) expect(page2.meta.pagination.hasMore).toBe(false) - // limit is clamped to at least 1; a non-numeric limit means 20. - const one = await expectJson( - await admin.api.get(`/api/v1/posts?boardId=${board.id}&limit=-5`), - 200 - ) - expect(one.data).toHaveLength(1) - expect(one.meta.pagination.hasMore).toBe(true) - const all = await expectJson( - await admin.api.get(`/api/v1/posts?boardId=${board.id}&limit=abc`), - 200 - ) - expect(all.data).toHaveLength(3) + // A limit below 1 or not a whole number is refused (400), not clamped. + for (const bad of ['-5', '0', 'abc']) { + const res = await admin.api.get(`/api/v1/posts?boardId=${board.id}&limit=${bad}`) + expect(res.status(), `limit=${bad}`).toBe(400) + } await admin.api.dispose() } ) diff --git a/apps/web/src/lib/server/domains/api/__tests__/request.test.ts b/apps/web/src/lib/server/domains/api/__tests__/request.test.ts new file mode 100644 index 0000000000..ce8cfcb6cd --- /dev/null +++ b/apps/web/src/lib/server/domains/api/__tests__/request.test.ts @@ -0,0 +1,75 @@ +import { describe, expect, it } from 'vitest' +import { ValidationError } from '@/lib/shared/errors' +import { generateId } from '@quackback/ids' +import { parseCursor, parseLimit, parseOffset, readJsonBody } from '../request' + +const post = (body: BodyInit | null) => new Request('http://t/', { method: 'POST', body }) + +describe('readJsonBody', () => { + it('parses a JSON body', async () => { + expect(await readJsonBody(post('{"a":1}'))).toEqual({ a: 1 }) + }) + + it('is undefined when there is no body', async () => { + expect(await readJsonBody(post(null))).toBeUndefined() + expect(await readJsonBody(post(' '))).toBeUndefined() + }) + + it('refuses a body that is not JSON as a ValidationError', async () => { + for (const body of ['{"a":', 'not json', new Uint8Array([0xff, 0xfe, 0x00])]) { + const attempt = readJsonBody(post(body)) + await expect(attempt).rejects.toBeInstanceOf(ValidationError) + await expect(attempt).rejects.toThrow('Request body must be valid JSON') + } + }) +}) + +describe('parseLimit', () => { + const url = (query: string) => new URL(`http://t/?${query}`) + + it('falls back when absent and caps at the max', () => { + expect(parseLimit(url(''))).toBe(20) + expect(parseLimit(url('limit='))).toBe(20) + expect(parseLimit(url(''), { fallback: 30 })).toBe(30) + expect(parseLimit(url('limit=7'))).toBe(7) + expect(parseLimit(url('limit=500'))).toBe(100) + expect(parseLimit(url('limit=50'), { max: 20 })).toBe(20) + }) + + it.each(['0', '-1', 'abc', '2.5', '1e2', ' 3'])('refuses limit=%s', (limit) => { + expect(() => parseLimit(url(`limit=${encodeURIComponent(limit)}`))).toThrow( + 'limit must be a whole number of 1 or more' + ) + }) +}) + +describe('parseOffset', () => { + const url = (query: string) => new URL(`http://t/?${query}`) + + it('is 0 when absent and takes any whole number', () => { + expect(parseOffset(url(''))).toBe(0) + expect(parseOffset(url('offset=0'))).toBe(0) + expect(parseOffset(url('offset=40'))).toBe(40) + }) + + it.each(['-1', 'abc', '1.5'])('refuses offset=%s', (offset) => { + expect(() => parseOffset(url(`offset=${offset}`))).toThrow(ValidationError) + }) +}) + +describe('parseCursor', () => { + const url = (query: string) => new URL(`http://t/?${query}`) + + it('is undefined when absent and takes any TypeID', () => { + expect(parseCursor(url(''))).toBeUndefined() + expect(parseCursor(url('cursor='))).toBeUndefined() + const id = generateId('changelog') + expect(parseCursor(url(`cursor=${id}`))).toBe(id) + const other = generateId('post') + expect(parseCursor(url(`cursor=${other}`))).toBe(other) + }) + + it.each(['garbage', 'not-an-id', 'post_123'])('refuses cursor=%s', (cursor) => { + expect(() => parseCursor(url(`cursor=${cursor}`))).toThrow('Invalid cursor format') + }) +}) diff --git a/apps/web/src/lib/server/domains/api/__tests__/responses.test.ts b/apps/web/src/lib/server/domains/api/__tests__/responses.test.ts index 486e695f7f..ed0383c07b 100644 --- a/apps/web/src/lib/server/domains/api/__tests__/responses.test.ts +++ b/apps/web/src/lib/server/domains/api/__tests__/responses.test.ts @@ -425,27 +425,9 @@ describe('API Responses', () => { expect(result.limit).toBe(100) }) - it('should use default for limit=0', () => { - // limit=0 is falsy, so it falls through to the default of 20 - const url = new URL('https://example.com/api?limit=0') - const result = parsePaginationParams(url) - - expect(result.limit).toBe(20) - }) - - it('should enforce minimum limit of 1', () => { - // Negative numbers are capped to 1 by Math.max - const url = new URL('https://example.com/api?limit=-5') - const result = parsePaginationParams(url) - - expect(result.limit).toBe(1) - }) - - it('should handle invalid limit gracefully', () => { - const url = new URL('https://example.com/api?limit=invalid') - const result = parsePaginationParams(url) - - expect(result.limit).toBe(20) + it.each(['0', '-5', 'invalid'])('refuses limit=%s as a ValidationError', (limit) => { + const url = new URL(`https://example.com/api?limit=${limit}`) + expect(() => parsePaginationParams(url)).toThrow('limit must be a whole number of 1 or more') }) }) diff --git a/apps/web/src/lib/server/domains/api/request.ts b/apps/web/src/lib/server/domains/api/request.ts new file mode 100644 index 0000000000..f10b3de12a --- /dev/null +++ b/apps/web/src/lib/server/domains/api/request.ts @@ -0,0 +1,55 @@ +/** + * Reading what a REST caller sent: the JSON body and the paging parameters. + * Input the caller got wrong throws a ValidationError, which every route's + * handleDomainError answers with a 400, never a 500. + */ +import { isValidTypeId } from '@quackback/ids' +import { ValidationError } from '@/lib/shared/errors' + +/** + * The request body parsed as JSON, or undefined when there is no body (the + * route's schema then says what was missing). + */ +export async function readJsonBody(request: Request): Promise { + const text = await request.text() + if (!text.trim()) return undefined + try { + return JSON.parse(text) + } catch { + throw new ValidationError('VALIDATION_ERROR', 'Request body must be valid JSON') + } +} + +/** + * `?cursor=`: the id of the last row on the previous page. Anything that is + * not a TypeID is a 400; a TypeID that names no row pages from the start. + */ +export function parseCursor(url: URL): string | undefined { + const cursor = url.searchParams.get('cursor') + if (!cursor) return undefined + if (!isValidTypeId(cursor)) throw new ValidationError('VALIDATION_ERROR', 'Invalid cursor format') + return cursor +} + +/** A query parameter that must be a whole number of at least `min`, or absent. */ +function wholeNumberParam(url: URL, name: string, min: number): number | undefined { + const raw = url.searchParams.get(name) + if (raw === null || raw === '') return undefined + if (!/^\d+$/.test(raw) || Number(raw) < min) { + throw new ValidationError( + 'VALIDATION_ERROR', + `${name} must be a whole number of ${min} or more` + ) + } + return Number(raw) +} + +/** `?limit=`: a whole number from 1, `fallback` when absent, capped at `max`. */ +export function parseLimit(url: URL, { fallback = 20, max = 100 } = {}): number { + return Math.min(wholeNumberParam(url, 'limit', 1) ?? fallback, max) +} + +/** `?offset=`: a whole number from 0, 0 when absent. */ +export function parseOffset(url: URL): number { + return wholeNumberParam(url, 'offset', 0) ?? 0 +} diff --git a/apps/web/src/lib/server/domains/api/responses.ts b/apps/web/src/lib/server/domains/api/responses.ts index 223c29d957..7da44cfb98 100644 --- a/apps/web/src/lib/server/domains/api/responses.ts +++ b/apps/web/src/lib/server/domains/api/responses.ts @@ -7,6 +7,7 @@ import { TierLimitError } from '@/lib/server/errors/tier-limit-error' import { logger } from '@/lib/server/logger' import { getLogContext } from '@/lib/server/log-context' +import { parseLimit } from './request' const log = logger.child({ component: 'api' }) @@ -291,11 +292,7 @@ export function parsePaginationParams(url: URL): { cursor?: string limit: number } { - const cursor = url.searchParams.get('cursor') ?? undefined - const limitParam = url.searchParams.get('limit') - const limit = Math.min(Math.max(parseInt(limitParam || '20', 10) || 20, 1), 100) - - return { cursor, limit } + return { cursor: url.searchParams.get('cursor') ?? undefined, limit: parseLimit(url) } } /** diff --git a/apps/web/src/lib/server/domains/help-center/__tests__/help-center-article-feedback.service.test.ts b/apps/web/src/lib/server/domains/help-center/__tests__/help-center-article-feedback.service.test.ts index fbe44da604..0d8f068644 100644 --- a/apps/web/src/lib/server/domains/help-center/__tests__/help-center-article-feedback.service.test.ts +++ b/apps/web/src/lib/server/domains/help-center/__tests__/help-center-article-feedback.service.test.ts @@ -30,6 +30,7 @@ function compiledWhere(callIndex: number): string { const mockFeedbackFindFirst = vi.fn() const mockFeedbackFindMany = vi.fn() +const mockArticleFindFirst = vi.fn() /** Rows the guarded reason UPDATE reports back; [] models "no row matched". */ let updateReturningRows: unknown[] = [] @@ -43,7 +44,10 @@ vi.mock('@/lib/server/db', async (importOriginal) => ({ findMany: (...args: unknown[]) => mockFeedbackFindMany(...args), }, helpCenterCategories: { findFirst: vi.fn() }, - helpCenterArticles: { findFirst: vi.fn(), findMany: vi.fn() }, + helpCenterArticles: { + findFirst: (...args: unknown[]) => mockArticleFindFirst(...args), + findMany: vi.fn(), + }, principal: { findFirst: vi.fn() }, }, insert: vi.fn(() => { @@ -94,6 +98,7 @@ beforeEach(async () => { updateReturningRows = [] mockFeedbackFindFirst.mockResolvedValue(null) mockFeedbackFindMany.mockResolvedValue([]) + mockArticleFindFirst.mockResolvedValue({ id: 'kb_article_1' }) const mod = await import('../help-center.article-feedback.service') recordArticleFeedback = mod.recordArticleFeedback diff --git a/apps/web/src/lib/server/domains/help-center/__tests__/help-center-unknown-references.db.test.ts b/apps/web/src/lib/server/domains/help-center/__tests__/help-center-unknown-references.db.test.ts new file mode 100644 index 0000000000..b5cc3ff038 --- /dev/null +++ b/apps/web/src/lib/server/domains/help-center/__tests__/help-center-unknown-references.db.test.ts @@ -0,0 +1,79 @@ +/** + * An article write that names a category or article that is not there is the + * caller's mistake: a typed error, never the foreign key violation (a 500) + * the insert would hit. + */ +import { afterAll, afterEach, beforeEach, expect, it, vi } from 'vitest' +import { + createId, + type KbArticleId, + type KbCategoryId, + type PrincipalId, + type UserId, +} from '@quackback/ids' +import { createDbTestFixture, testDb } from '@/lib/server/__tests__/db-test-fixture' +import { helpCenterCategories, principal, user } from '@/lib/server/db' +import { NotFoundError, ValidationError } from '@/lib/shared/errors' + +vi.mock('@/lib/server/db', async (original) => ({ + ...(await original()), + db: (await import('@/lib/server/__tests__/db-test-fixture')).testDb, +})) +vi.mock('../help-center-embedding.service', () => ({ + generateArticleEmbedding: async () => undefined, +})) + +import { createArticle, updateArticle } from '../help-center.article.service' +import { recordArticleFeedback } from '../help-center.article-feedback.service' + +const fixture = await createDbTestFixture({ + probe: async (db) => { + await db.select({ id: helpCenterCategories.id }).from(helpCenterCategories).limit(0) + }, +}) + +let author: PrincipalId +beforeEach(async () => { + expect(fixture.available).toBe(true) + await fixture.begin() + const userId = createId('user') as UserId + author = createId('principal') as PrincipalId + await testDb.insert(user).values({ id: userId, name: 'Ada', email: `${userId}@example.com` }) + await testDb + .insert(principal) + .values({ id: author, userId, role: 'admin', type: 'user', createdAt: new Date() }) +}) +afterEach(fixture.rollback) +afterAll(fixture.close) + +const category = async (values: { deletedAt?: Date } = {}) => { + const [row] = await testDb + .insert(helpCenterCategories) + .values({ name: 'Docs', slug: `docs-${createId('kb_category')}`, ...values }) + .returning() + return row!.id +} + +it('refuses to file an article in a category that does not exist or was deleted', async () => { + for (const categoryId of [createId('kb_category'), await category({ deletedAt: new Date() })]) { + const attempt = createArticle({ title: 'Setup', content: 'x', categoryId }, author) + await expect(attempt).rejects.toBeInstanceOf(ValidationError) + await expect(attempt).rejects.toThrow('Category not found') + } +}) + +it('refuses to move an article to a category that does not exist', async () => { + const article = await createArticle( + { title: 'Setup', content: 'x', categoryId: await category() }, + author + ) + const attempt = updateArticle(article.id, { categoryId: createId('kb_category') as KbCategoryId }) + await expect(attempt).rejects.toBeInstanceOf(ValidationError) + await expect(attempt).rejects.toThrow('Category not found') +}) + +it('feedback on an article that does not exist is not found', async () => { + const attempt = recordArticleFeedback(createId('kb_article') as KbArticleId, true, author) + await expect(attempt).rejects.toBeInstanceOf(NotFoundError) + await expect(attempt).rejects.toMatchObject({ code: 'ARTICLE_NOT_FOUND' }) +}) diff --git a/apps/web/src/lib/server/domains/help-center/help-center.article-feedback.service.ts b/apps/web/src/lib/server/domains/help-center/help-center.article-feedback.service.ts index b4e750f034..f482687de3 100644 --- a/apps/web/src/lib/server/domains/help-center/help-center.article-feedback.service.ts +++ b/apps/web/src/lib/server/domains/help-center/help-center.article-feedback.service.ts @@ -11,7 +11,7 @@ import { } from '@/lib/server/db' import { createId } from '@quackback/ids' import type { KbArticleFeedbackId, KbArticleId, PrincipalId } from '@quackback/ids' -import { ValidationError } from '@/lib/shared/errors' +import { NotFoundError, ValidationError } from '@/lib/shared/errors' import { ARTICLE_FEEDBACK_REASON_MAX_LENGTH } from '@/lib/shared/schemas/help-center' import { logger } from '@/lib/server/logger' @@ -30,6 +30,12 @@ export async function recordArticleFeedback( principalId?: PrincipalId | null ): Promise { return db.transaction(async (tx) => { + const article = await tx.query.helpCenterArticles.findFirst({ + where: eq(helpCenterArticles.id, articleId), + columns: { id: true }, + }) + if (!article) throw new NotFoundError('ARTICLE_NOT_FOUND', `Article ${articleId} not found`) + if (principalId) { const existing = await tx.query.helpCenterArticleFeedback.findFirst({ where: and( diff --git a/apps/web/src/lib/server/domains/help-center/help-center.article.service.ts b/apps/web/src/lib/server/domains/help-center/help-center.article.service.ts index 6a3294dffd..3dccb0efef 100644 --- a/apps/web/src/lib/server/domains/help-center/help-center.article.service.ts +++ b/apps/web/src/lib/server/domains/help-center/help-center.article.service.ts @@ -202,6 +202,15 @@ const findArticleSlugConflict = (slug: string) => columns: { id: true }, }) +/** An article can only be filed in a category that exists and is not deleted. */ +async function assertLiveCategory(categoryId: KbCategoryId): Promise { + const category = await db.query.helpCenterCategories.findFirst({ + where: and(eq(helpCenterCategories.id, categoryId), isNull(helpCenterCategories.deletedAt)), + columns: { id: true }, + }) + if (!category) throw new ValidationError('VALIDATION_ERROR', 'Category not found') +} + export async function createArticle( input: CreateArticleInput, principalId: PrincipalId, @@ -250,8 +259,9 @@ export async function createArticle( }) // No category picked (a first article in an empty help center): file it // under General rather than refusing the save. - const categoryId = - (input.categoryId?.trim() as KbCategoryId) || (await ensureDefaultHelpCategory()) + const chosen = input.categoryId?.trim() as KbCategoryId | undefined + if (chosen) await assertLiveCategory(chosen) + const categoryId = chosen || (await ensureDefaultHelpCategory()) const [article] = await db .insert(helpCenterArticles) @@ -295,7 +305,10 @@ export async function updateArticle( updateData.contentJson = contentJson updateData.content = projectContentJsonToMarkdown(contentJson, input.content?.trim() ?? '') } - if (input.categoryId !== undefined) updateData.categoryId = input.categoryId as KbCategoryId + if (input.categoryId !== undefined) { + await assertLiveCategory(input.categoryId as KbCategoryId) + updateData.categoryId = input.categoryId as KbCategoryId + } if (input.slug !== undefined) updateData.slug = await uniqueHelpCenterSlug( input.slug.trim(), diff --git a/apps/web/src/lib/server/domains/status/__tests__/status.lifecycle.db.test.ts b/apps/web/src/lib/server/domains/status/__tests__/status.lifecycle.db.test.ts index 13e47a0dfc..f497c8d44f 100644 --- a/apps/web/src/lib/server/domains/status/__tests__/status.lifecycle.db.test.ts +++ b/apps/web/src/lib/server/domains/status/__tests__/status.lifecycle.db.test.ts @@ -186,6 +186,21 @@ describe('status lifecycle (Postgres)', () => { ).rejects.toThrow('An affected service has been deleted. Choose the services again.') }) + it('tells an editor naming a service that never existed so, not that it was deleted', async () => { + const api = await service('API') + const incident = await openIncident([{ componentId: api, componentStatus: 'major_outage' }]) + + await expect( + updateIncident(incident.id, { + title: 'Elevated errors', + affectedComponents: [ + { componentId: api, componentStatus: 'major_outage' }, + { componentId: createId('status_component'), componentStatus: 'major_outage' }, + ], + }) + ).rejects.toThrow('An affected service does not exist.') + }) + it('maintenance auto-complete still completes the window and restores the rest', async () => { const db = await service('Database') const api = await service('API') @@ -254,6 +269,24 @@ describe('status lifecycle (Postgres)', () => { expect(await testDb.query.statusIncidents.findMany()).toEqual([]) }) + it('rejects a service that never existed as unknown, not deleted, and writes nothing', async () => { + const attempt = createIncident( + { + kind: 'incident', + title: 'Errors', + status: 'investigating', + body: 'Looking into it.', + affectedComponents: [ + { componentId: createId('status_component'), componentStatus: 'major_outage' }, + ], + }, + { principalId: author } + ) + await expect(attempt).rejects.toBeInstanceOf(ValidationError) + await expect(attempt).rejects.toThrow('An affected service does not exist.') + expect(await testDb.query.statusIncidents.findMany()).toEqual([]) + }) + it('created already resolved, it is stamped resolved and leaves its services alone', async () => { const api = await service('API') await setComponentStatus(api, 'degraded_performance', 'manual') diff --git a/apps/web/src/lib/server/domains/status/status.service.ts b/apps/web/src/lib/server/domains/status/status.service.ts index ffc24b0bd1..33bbe1b024 100644 --- a/apps/web/src/lib/server/domains/status/status.service.ts +++ b/apps/web/src/lib/server/domains/status/status.service.ts @@ -136,6 +136,20 @@ function assertWindowOrder(start: Date | null | undefined, end: Date | null | un * Worded for the dashboard and API callers alike. */ const DELETED_SERVICE_MESSAGE = 'An affected service has been deleted. Choose the services again.' +/** Refuses ids that never named a service: a caller's mistake, not a + * service deleted since the editor loaded. */ +async function assertKnownComponents(ids: StatusComponentId[], executor: Executor): Promise { + if (ids.length === 0) return + const rows = await executor + .select({ id: statusComponents.id }) + .from(statusComponents) + .where(inArray(statusComponents.id, ids)) + const known = new Set(rows.map((r) => r.id)) + if (ids.some((id) => !known.has(id))) { + throw new ValidationError('VALIDATION_ERROR', 'An affected service does not exist.') + } +} + /** The subset of `ids` that are live (not soft-deleted) services. */ async function liveComponentIds( ids: StatusComponentId[], @@ -248,7 +262,9 @@ export async function createIncident( const incident = await db.transaction(async (tx) => { const requested = input.affectedComponents.map((c) => c.componentId) const live = await liveComponentIds(requested, tx) - if (requested.some((id) => !live.has(id))) { + const notLive = requested.filter((id) => !live.has(id)) + if (notLive.length > 0) { + await assertKnownComponents(notLive, tx) throw new ValidationError('VALIDATION_ERROR', DELETED_SERVICE_MESSAGE) } @@ -434,6 +450,10 @@ export async function updateIncident( ], tx ) + await assertKnownComponents( + input.affectedComponents.map((c) => c.componentId).filter((id) => !live.has(id)), + tx + ) nextComponents = input.affectedComponents.filter((c) => live.has(c.componentId)) // Every service sent has been deleted since the editor loaded: say so, // rather than that none was chosen. diff --git a/apps/web/src/routes/api/v1/__tests__/bad-input.db.test.ts b/apps/web/src/routes/api/v1/__tests__/bad-input.db.test.ts new file mode 100644 index 0000000000..5d36606e2c --- /dev/null +++ b/apps/web/src/routes/api/v1/__tests__/bad-input.db.test.ts @@ -0,0 +1,275 @@ +/** + * Bad client input never answers 500. Each case runs the real route handler + * against real Postgres (only the API key check is stubbed), so a malformed id + * that reaches a typeid column, or a body that is not JSON, shows up here as + * the 500 a caller would get. + */ +import { afterAll, afterEach, beforeEach, describe, expect, it, vi } from 'vitest' +import { createId, generateId, type PrincipalId, type UserId } from '@quackback/ids' +import { createDbTestFixture, testDb } from '@/lib/server/__tests__/db-test-fixture' +import { changelogEntries, helpCenterCategories, principal, user } from '@/lib/server/db' +import { SYSTEM_ROLE_PERMISSIONS } from '@/lib/shared/permissions' +import type { ApiAuthContext } from '@/lib/server/domains/api/auth' +import type { ApiKeyId } from '@/lib/server/domains/api-keys' + +vi.mock('@/lib/server/db', async (original) => ({ + ...(await original()), + db: (await import('@/lib/server/__tests__/db-test-fixture')).testDb, +})) +vi.mock('@tanstack/react-router', () => ({ + createFileRoute: vi.fn(() => (opts: unknown) => ({ options: opts })), +})) +const auth = vi.hoisted(() => ({ context: null as unknown })) +vi.mock('@/lib/server/domains/api/auth', async (original) => ({ + ...(await original()), + withApiKeyAuth: async () => auth.context, +})) +vi.mock('@/lib/server/domains/settings/settings.service', async (original) => ({ + ...(await original()), + isFeatureEnabled: async () => true, +})) +vi.mock('@/lib/server/domains/help-center/help-center-embedding.service', () => ({ + generateArticleEmbedding: async () => undefined, + generateKbQueryEmbedding: async () => null, +})) + +import { Route as changelogList } from '../changelog/index' +import { Route as changelogEntry } from '../changelog/$entryId' +import { Route as postsList } from '../posts/index' +import { Route as incidentsList } from '../status/incidents/index' +import { Route as servicesList } from '../status/services/index' +import { Route as serviceOne } from '../status/services/$serviceId' +import { Route as categoriesList } from '../help-center/categories/index' +import { Route as categoryOne } from '../help-center/categories/$categoryId' +import { Route as articlesList } from '../help-center/articles/index' +import { Route as articleOne } from '../help-center/articles/$articleId' +import { Route as articleFeedback } from '../help-center/articles/$articleId.feedback' +import { Route as conversationsList } from '../conversations/index' +import { Route as conversationMessages } from '../conversations/$conversationId.messages' + +import { Route as ticketsList } from '../tickets/index' + +type Handler = (ctx: { request: Request; params: Record }) => Promise +const handlers = (route: unknown) => + (route as { options: { server: { handlers: Record } } }).options.server.handlers + +const fixture = await createDbTestFixture({ + probe: async (db) => { + await db.select({ id: helpCenterCategories.id }).from(helpCenterCategories).limit(0) + }, +}) + +let admin: PrincipalId + +beforeEach(async () => { + expect(fixture.available).toBe(true) + await fixture.begin() + const userId = createId('user') as UserId + admin = createId('principal') as PrincipalId + await testDb.insert(user).values({ id: userId, name: 'Ada', email: `${userId}@example.com` }) + await testDb + .insert(principal) + .values({ id: admin, userId, role: 'admin', type: 'user', createdAt: new Date() }) + auth.context = { + apiKey: { + id: 'api_key_test' as ApiKeyId, + name: 'test', + kind: 'workspace', + keyPrefix: 'qb_', + createdById: null, + principalId: admin, + lastUsedAt: null, + expiresAt: null, + createdAt: new Date(), + revokedAt: null, + scopes: null, + }, + principalId: admin, + role: 'admin', + permissions: new Set(SYSTEM_ROLE_PERMISSIONS.owner), + principal: null, + importMode: false, + } satisfies ApiAuthContext +}) +afterEach(fixture.rollback) +afterAll(fixture.close) + +/** Raw bytes, as a client that sends a broken body does. */ +const NOT_JSON = '{"title": "x",' + +async function call( + route: unknown, + method: string, + path: string, + opts: { params?: Record; body?: string } = {} +): Promise<{ status: number; body: { error?: { code: string; message: string } } }> { + const request = new Request(`http://t/api/v1/${path}`, { + method, + headers: { 'content-type': 'application/json' }, + ...(opts.body !== undefined ? { body: opts.body } : {}), + }) + const res = await handlers(route)[method]({ request, params: opts.params ?? {} }) + const text = await res.text() + return { status: res.status, body: text ? JSON.parse(text) : {} } +} + +describe('a body that is not JSON is a 400', () => { + it.each([ + ['POST changelog', changelogList, 'changelog', {}], + ['PATCH changelog entry', changelogEntry, 'changelog/x', { entryId: generateId('changelog') }], + ['POST status services', servicesList, 'status/services', {}], + ['POST status incidents', incidentsList, 'status/incidents', {}], + ['POST help center categories', categoriesList, 'help-center/categories', {}], + [ + 'PATCH help center category', + categoryOne, + 'help-center/categories/x', + { categoryId: generateId('kb_category') }, + ], + ['POST help center articles', articlesList, 'help-center/articles', {}], + ])('%s', async (_name, route, path, params) => { + const method = _name.split(' ')[0]! + const res = await call(route, method, path, { params, body: NOT_JSON }) + expect(res.status, JSON.stringify(res.body)).toBe(400) + expect(res.body.error?.message).toBe('Request body must be valid JSON') + }) +}) + +describe('a malformed cursor or id filter is a 400; a well-formed unknown one is not', () => { + it.each([ + ['changelog', changelogList, 'changelog', 'changelog'], + ['posts', postsList, 'posts', 'post'], + ['status incidents', incidentsList, 'status/incidents', 'status_incident'], + ['help center articles', articlesList, 'help-center/articles', 'article'], + ['help center article search', articlesList, 'help-center/articles?search=setup', 'article'], + ['conversations', conversationsList, 'conversations', 'conversation'], + ] as const)('%s cursor', async (_name, route, path, prefix) => { + const sep = path.includes('?') ? '&' : '?' + const bad = await call(route, 'GET', `${path}${sep}cursor=not-an-id&limit=2`) + expect(bad.status, JSON.stringify(bad.body)).toBe(400) + expect(bad.body.error?.message).toBe('Invalid cursor format') + // An unknown id, even one of another type, pages from the start. + for (const cursor of [generateId(prefix), generateId('board')]) { + const unknown = await call(route, 'GET', `${path}${sep}cursor=${cursor}`) + expect(unknown.status, JSON.stringify(unknown.body)).toBe(200) + } + }) + + it('messages cursor', async () => { + const res = await call(conversationMessages, 'GET', 'conversations/x/messages?cursor=garbage', { + params: { conversationId: generateId('conversation') }, + }) + expect(res.status, JSON.stringify(res.body)).toBe(400) + }) + + it('a cursor the list handed out reads the next page', async () => { + await testDb.insert(changelogEntries).values( + [1, 2, 3].map((n) => ({ + title: `Entry ${n}`, + content: 'x', + createdAt: new Date(Date.UTC(2026, 0, n)), + })) + ) + type Page = { data: { id: string }[]; meta: { pagination: { cursor: string } } } + const first = (await call(changelogList, 'GET', 'changelog?limit=2')).body as unknown as Page + const next = await call( + changelogList, + 'GET', + `changelog?limit=2&cursor=${first.meta.pagination.cursor}` + ) + expect(next.status, JSON.stringify(next.body)).toBe(200) + expect((next.body as unknown as Page).data).toHaveLength(1) + }) + + it.each([ + ['help center articles categoryId', articlesList, 'help-center/articles?categoryId=garbage'], + [ + 'conversations assignedAgentPrincipalId', + conversationsList, + 'conversations?assignedAgentPrincipalId=garbage', + ], + ['tickets requesterPrincipalId', ticketsList, 'tickets?requesterPrincipalId=garbage'], + ['tickets companyId', ticketsList, 'tickets?companyId=garbage'], + ])('%s', async (_name, route, path) => { + const res = await call(route, 'GET', path) + expect(res.status, JSON.stringify(res.body)).toBe(400) + }) +}) + +describe('limit is a whole number from 1; above the cap it is capped', () => { + it.each(['0', '-1', 'abc', '2.5'])('changelog ?limit=%s is a 400', async (limit) => { + const res = await call(changelogList, 'GET', `changelog?limit=${limit}`) + expect(res.status, JSON.stringify(res.body)).toBe(400) + expect(res.body.error?.message).toMatch(/limit/) + }) + + it.each([ + ['changelog', changelogList], + ['posts', postsList], + ['status/incidents', incidentsList], + ['help-center/articles', articlesList], + ['conversations', conversationsList], + ] as const)('%s refuses limit=0 and caps limit=500', async (path, route) => { + expect((await call(route, 'GET', `${path}?limit=0`)).status).toBe(400) + expect((await call(route, 'GET', `${path}?limit=500`)).status).toBe(200) + }) + + it('tickets refuses limit=0', async () => { + expect((await call(ticketsList, 'GET', 'tickets?limit=0')).status).toBe(400) + }) +}) + +describe('help center references', () => { + it.each(['garbage', generateId('kb_category')])( + 'an article in category %s is refused, not a server error', + async (categoryId) => { + const res = await call(articlesList, 'POST', 'help-center/articles', { + body: JSON.stringify({ categoryId, title: 'Orphan', content: 'x', authorId: admin }), + }) + expect(res.status, JSON.stringify(res.body)).toBe(400) + } + ) + + it('moving an article to an unknown category is refused', async () => { + const [cat] = await testDb + .insert(helpCenterCategories) + .values({ name: 'Docs', slug: 'docs' }) + .returning() + const created = await call(articlesList, 'POST', 'help-center/articles', { + body: JSON.stringify({ categoryId: cat!.id, title: 'Setup', content: 'x', authorId: admin }), + }) + expect(created.status).toBe(201) + const articleId = (created.body as unknown as { data: { id: string } }).data.id + for (const categoryId of ['garbage', generateId('kb_category')]) { + const res = await call(articleOne, 'PATCH', 'help-center/articles/x', { + params: { articleId }, + body: JSON.stringify({ categoryId }), + }) + expect(res.status, JSON.stringify(res.body)).toBe(400) + } + }) + + it('feedback for an unknown article is not found', async () => { + const res = await call(articleFeedback, 'POST', 'help-center/articles/x/feedback', { + params: { articleId: generateId('article') }, + body: JSON.stringify({ helpful: true }), + }) + expect(res.status, JSON.stringify(res.body)).toBe(404) + expect(res.body.error?.message).toBe('Help center article not found') + }) +}) + +describe('the services path names a service', () => { + it('in its malformed-id and not-found errors', async () => { + const bad = await call(serviceOne, 'GET', 'status/services/nope', { + params: { serviceId: 'nope' }, + }) + expect(bad.status).toBe(400) + expect(bad.body.error?.message).toMatch(/service/i) + const missing = await call(serviceOne, 'GET', 'status/services/x', { + params: { serviceId: generateId('status_component') }, + }) + expect(missing.status).toBe(404) + expect(missing.body.error?.message).toMatch(/service/i) + }) +}) diff --git a/apps/web/src/routes/api/v1/__tests__/json-body-guard.test.ts b/apps/web/src/routes/api/v1/__tests__/json-body-guard.test.ts new file mode 100644 index 0000000000..0692871e26 --- /dev/null +++ b/apps/web/src/routes/api/v1/__tests__/json-body-guard.test.ts @@ -0,0 +1,31 @@ +/** + * Every REST route reads its body with `readJsonBody`. + * + * A bare `request.json()` throws a SyntaxError on a body that is not JSON, + * which no route maps, so the caller gets a 500 for their own mistake. + * `readJsonBody` turns it into a 400. This guard fails on any bare call under + * `routes/api/v1`. + */ +import { describe, it, expect } from 'vitest' +import { readdirSync, readFileSync, statSync } from 'node:fs' +import { join, relative } from 'node:path' + +const ROOT = join(__dirname, '..') + +function sourceFiles(dir: string): string[] { + return readdirSync(dir).flatMap((name) => { + const path = join(dir, name) + if (statSync(path).isDirectory()) return name === '__tests__' ? [] : sourceFiles(path) + return /\.tsx?$/.test(name) ? [path] : [] + }) +} + +describe('REST request bodies', () => { + it('are read with readJsonBody, never a bare request.json()', () => { + const offenders = sourceFiles(ROOT) + .filter((file) => /\brequest\.json\(/.test(readFileSync(file, 'utf8'))) + .map((file) => relative(ROOT, file)) + + expect(offenders).toEqual([]) + }) +}) diff --git a/apps/web/src/routes/api/v1/apps/link.ts b/apps/web/src/routes/api/v1/apps/link.ts index 472c83c112..ce5561a010 100644 --- a/apps/web/src/routes/api/v1/apps/link.ts +++ b/apps/web/src/routes/api/v1/apps/link.ts @@ -6,6 +6,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PostId } from '@quackback/ids' import { appJsonResponse, preflightResponse, withCors } from '@/lib/server/integrations/apps/cors' +import { readJsonBody } from '@/lib/server/domains/api/request' const linkSchema = z.object({ postId: z.string().min(1), @@ -33,7 +34,7 @@ export const Route = createFileRoute('/api/v1/apps/link')({ permission: PERMISSIONS.POST_VOTE_ON_BEHALF, }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = linkSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/apps/posts.ts b/apps/web/src/routes/api/v1/apps/posts.ts index 3d5f69be18..4e58a91380 100644 --- a/apps/web/src/routes/api/v1/apps/posts.ts +++ b/apps/web/src/routes/api/v1/apps/posts.ts @@ -9,6 +9,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import type { BoardId, PostId } from '@quackback/ids' import { appJsonResponse, preflightResponse, withCors } from '@/lib/server/integrations/apps/cors' import { segmentIdsForPrincipal } from '@/lib/server/domains/segments/segment-membership.service' +import { readJsonBody } from '@/lib/server/domains/api/request' const createPostSchema = z.object({ boardId: z.string().min(1, 'Board ID is required'), @@ -41,7 +42,7 @@ export const Route = createFileRoute('/api/v1/apps/posts')({ const apiAuth = await withApiKeyAuth(request, { permission: PERMISSIONS.POST_CREATE }) const { principalId } = apiAuth - const body = await request.json() + const body = await readJsonBody(request) const parsed = createPostSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/apps/unlink.ts b/apps/web/src/routes/api/v1/apps/unlink.ts index c63eb9b550..509aa408a9 100644 --- a/apps/web/src/routes/api/v1/apps/unlink.ts +++ b/apps/web/src/routes/api/v1/apps/unlink.ts @@ -6,6 +6,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PostId } from '@quackback/ids' import { appJsonResponse, preflightResponse, withCors } from '@/lib/server/integrations/apps/cors' +import { readJsonBody } from '@/lib/server/domains/api/request' const unlinkSchema = z.object({ postId: z.string().min(1), @@ -22,7 +23,7 @@ export const Route = createFileRoute('/api/v1/apps/unlink')({ try { await withApiKeyAuth(request, { permission: PERMISSIONS.POST_VOTE_ON_BEHALF }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = unlinkSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/boards/$boardId.ts b/apps/web/src/routes/api/v1/boards/$boardId.ts index d59cc753a1..da1746d159 100644 --- a/apps/web/src/routes/api/v1/boards/$boardId.ts +++ b/apps/web/src/routes/api/v1/boards/$boardId.ts @@ -10,6 +10,7 @@ import { import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import type { BoardId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema — `audience` and `access` are intentionally // excluded. Visibility is a policy-level setting changed only via @@ -66,7 +67,7 @@ export const Route = createFileRoute('/api/v1/boards/$boardId')({ const boardId = parseTypeId(params.boardId, 'board', 'board ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateBoardSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/boards/index.ts b/apps/web/src/routes/api/v1/boards/index.ts index bb741850dc..9d03886eb3 100644 --- a/apps/web/src/routes/api/v1/boards/index.ts +++ b/apps/web/src/routes/api/v1/boards/index.ts @@ -8,6 +8,7 @@ import { handleDomainError, } from '@/lib/server/domains/api/responses' import { PERMISSIONS } from '@/lib/shared/permissions' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema — `audience` and `access` are intentionally // excluded, matching the strip on PATCH /api/v1/boards/:boardId. Visibility // is a policy-level setting changed only via updateBoardAccessFn (admin-only, @@ -70,7 +71,7 @@ export const Route = createFileRoute('/api/v1/boards/')({ await withApiKeyAuth(request, { permission: PERMISSIONS.BOARD_MANAGE }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = createBoardSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/changelog/$entryId.ts b/apps/web/src/routes/api/v1/changelog/$entryId.ts index fcccf0b252..9597020fce 100644 --- a/apps/web/src/routes/api/v1/changelog/$entryId.ts +++ b/apps/web/src/routes/api/v1/changelog/$entryId.ts @@ -17,6 +17,7 @@ import type { PublishState } from '@/lib/shared/schemas/changelog' import { PERMISSIONS } from '@/lib/shared/permissions' import type { ChangelogId, PostId } from '@quackback/ids' import { formatChangelogResponse } from './-serialize' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const updateChangelogSchema = z.object({ @@ -65,7 +66,7 @@ export const Route = createFileRoute('/api/v1/changelog/$entryId')({ 'changelog entry ID' ) - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateChangelogSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/changelog/index.ts b/apps/web/src/routes/api/v1/changelog/index.ts index 7b885756ef..8233ea5b39 100644 --- a/apps/web/src/routes/api/v1/changelog/index.ts +++ b/apps/web/src/routes/api/v1/changelog/index.ts @@ -15,6 +15,7 @@ import { db, principal, eq } from '@/lib/server/db' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PostId } from '@quackback/ids' import { formatChangelogResponse } from './-serialize' +import { parseCursor, parseLimit, readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const createChangelogSchema = z.object({ @@ -38,8 +39,8 @@ export const Route = createFileRoute('/api/v1/changelog/')({ // Parse query params const url = new URL(request.url) const published = url.searchParams.get('published') - const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min(parseInt(url.searchParams.get('limit') || '20', 10), 100) + const cursor = parseCursor(url) + const limit = parseLimit(url) // Map published filter to service status param let status: 'draft' | 'published' | 'all' = 'all' @@ -75,7 +76,7 @@ export const Route = createFileRoute('/api/v1/changelog/')({ permission: PERMISSIONS.CHANGELOG_MANAGE, }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = createChangelogSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/comments/$commentId.ts b/apps/web/src/routes/api/v1/comments/$commentId.ts index 4ecbd023a0..a8507ccd8b 100644 --- a/apps/web/src/routes/api/v1/comments/$commentId.ts +++ b/apps/web/src/routes/api/v1/comments/$commentId.ts @@ -11,6 +11,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PostCommentId } from '@quackback/ids' import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const updateCommentSchema = z.object({ @@ -74,7 +75,7 @@ export const Route = createFileRoute('/api/v1/comments/$commentId')({ 'comment ID' ) - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateCommentSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/companies/index.ts b/apps/web/src/routes/api/v1/companies/index.ts index ed3f76e343..9c3c57ce62 100644 --- a/apps/web/src/routes/api/v1/companies/index.ts +++ b/apps/web/src/routes/api/v1/companies/index.ts @@ -2,6 +2,7 @@ import { createFileRoute } from '@tanstack/react-router' import { withApiKeyAuth } from '@/lib/server/domains/api/auth' import { PERMISSIONS } from '@/lib/shared/permissions' import { successResponse, handleDomainError } from '@/lib/server/domains/api/responses' +import { parseLimit } from '@/lib/server/domains/api/request' import type { CompanyId } from '@quackback/ids' import { serializeCompany } from './-serialize' @@ -19,10 +20,7 @@ export const Route = createFileRoute('/api/v1/companies/')({ const url = new URL(request.url) const search = url.searchParams.get('search') ?? undefined const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '20', 10) || 20) - ) + const limit = parseLimit(url) // Integration lookup filters: company_id is an exact match on the // external reference; tag_id/segment_id restrict the list. diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.assign.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.assign.ts index b9301c0f87..17ce93a8a7 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.assign.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.assign.ts @@ -11,6 +11,7 @@ import { serviceActorFromApiAuth } from '@/lib/server/domains/api/service-actor' import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeConversation } from './-serialize' import type { ConversationId, PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // null or omitted = unassign; no 'me' sentinel for a service key (it has no // personal identity to resolve to). @@ -33,7 +34,7 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/assi 'conversation ID' ) - const parsed = assignSchema.safeParse(await request.json().catch(() => null)) + const parsed = assignSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.messages.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.messages.ts index 2dd64bf342..d900e388b7 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.messages.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.messages.ts @@ -2,6 +2,7 @@ import { createFileRoute } from '@tanstack/react-router' import { serviceActorFromApiAuth } from '@/lib/server/domains/api/service-actor' import { withApiKeyAuth } from '@/lib/server/domains/api/auth' import { successResponse, handleDomainError } from '@/lib/server/domains/api/responses' +import { parseCursor, parseLimit } from '@/lib/server/domains/api/request' import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeMessage } from './-serialize' @@ -21,11 +22,8 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/mess ) const url = new URL(request.url) - const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '30', 10) || 30) - ) + const cursor = parseCursor(url) + const limit = parseLimit(url, { fallback: 30 }) const includeInternal = url.searchParams.get('includeInternal') === 'true' const { assertConversationVisible } = diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.note.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.note.ts index cbe994f609..d4b4d1f874 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.note.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.note.ts @@ -17,6 +17,7 @@ import { markdownToSanitizedJson, } from './-validation' import type { ConversationId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const noteSchema = z.object({ content: messageContentSchema, @@ -36,7 +37,7 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/note 'conversation ID' ) - const parsed = noteSchema.safeParse(await request.json().catch(() => null)) + const parsed = noteSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.priority.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.priority.ts index 721b24fa81..fa90578e11 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.priority.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.priority.ts @@ -12,6 +12,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeConversation } from './-serialize' import { priorityEnum } from './-validation' import type { ConversationId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const prioritySchema = z.object({ priority: priorityEnum, @@ -32,7 +33,7 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/prio 'conversation ID' ) - const parsed = prioritySchema.safeParse(await request.json().catch(() => null)) + const parsed = prioritySchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.reply.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.reply.ts index 9e61ee8f48..7fc14c258c 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.reply.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.reply.ts @@ -17,6 +17,7 @@ import { markdownToSanitizedJson, } from './-validation' import type { ConversationId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const replySchema = z.object({ content: messageContentSchema, @@ -37,7 +38,7 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/repl 'conversation ID' ) - const parsed = replySchema.safeParse(await request.json().catch(() => null)) + const parsed = replySchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.status.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.status.ts index a1b9148ca4..dad95c0575 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.status.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.status.ts @@ -12,6 +12,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeConversation } from './-serialize' import { statusEnum } from './-validation' import type { ConversationId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const statusSchema = z.object({ status: statusEnum, @@ -34,7 +35,7 @@ export const Route = createFileRoute('/api/v1/conversations/$conversationId/stat 'conversation ID' ) - const parsed = statusSchema.safeParse(await request.json().catch(() => null)) + const parsed = statusSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/conversations/$conversationId.tags.ts b/apps/web/src/routes/api/v1/conversations/$conversationId.tags.ts index d29acb6642..2c401a16cc 100644 --- a/apps/web/src/routes/api/v1/conversations/$conversationId.tags.ts +++ b/apps/web/src/routes/api/v1/conversations/$conversationId.tags.ts @@ -11,6 +11,7 @@ import { serviceActorFromApiAuth } from '@/lib/server/domains/api/service-actor' import { PERMISSIONS } from '@/lib/shared/permissions' import type { z as zType } from 'zod' import type { ConversationId, ConversationTagId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const tagSchema = z.object({ tagId: z.string().min(1), @@ -26,7 +27,7 @@ async function parseTagRequest(request: Request, conversationIdRaw: string): Pro 'conversation', 'conversation ID' ) - const parsed = tagSchema.safeParse(await request.json().catch(() => null)) + const parsed = tagSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return { ok: false, error: parsed.error } } diff --git a/apps/web/src/routes/api/v1/conversations/index.ts b/apps/web/src/routes/api/v1/conversations/index.ts index c04e08227a..8ba3b2f076 100644 --- a/apps/web/src/routes/api/v1/conversations/index.ts +++ b/apps/web/src/routes/api/v1/conversations/index.ts @@ -2,6 +2,8 @@ import { createFileRoute } from '@tanstack/react-router' import { serviceActorFromApiAuth } from '@/lib/server/domains/api/service-actor' import { withApiKeyAuth } from '@/lib/server/domains/api/auth' import { successResponse, handleDomainError } from '@/lib/server/domains/api/responses' +import { parseCursor, parseLimit } from '@/lib/server/domains/api/request' +import { parseOptionalTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeConversation } from './-serialize' import type { ConversationStatus, ConversationPriority } from '@/lib/server/db' @@ -16,16 +18,16 @@ export const Route = createFileRoute('/api/v1/conversations/')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.CONVERSATION_VIEW }) const url = new URL(request.url) - const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '20', 10) || 20) - ) + const cursor = parseCursor(url) + const limit = parseLimit(url) const status = (url.searchParams.get('status') as ConversationStatus | null) ?? undefined const priority = (url.searchParams.get('priority') as ConversationPriority | null) ?? undefined - const assignedAgentPrincipalId = - (url.searchParams.get('assignedAgentPrincipalId') as PrincipalId | null) ?? undefined + const assignedAgentPrincipalId = parseOptionalTypeId( + url.searchParams.get('assignedAgentPrincipalId'), + 'principal', + 'assignedAgentPrincipalId' + ) // A personal key lists only what its creator can see // (conversationFilter follows the actor's scopePrincipalId). diff --git a/apps/web/src/routes/api/v1/help-center/__tests__/articles.test.ts b/apps/web/src/routes/api/v1/help-center/__tests__/articles.test.ts index 25951fe597..a43528fd43 100644 --- a/apps/web/src/routes/api/v1/help-center/__tests__/articles.test.ts +++ b/apps/web/src/routes/api/v1/help-center/__tests__/articles.test.ts @@ -165,6 +165,7 @@ describe('GET /api/v1/help-center/articles', () => { nextCursor: null, hasMore: false, }) + vi.mocked(parseOptionalTypeId).mockImplementation((value) => value ?? undefined) const request = createRequest( 'GET', @@ -386,7 +387,8 @@ describe('PATCH /api/v1/help-center/articles/:id', () => { author: { id: 'principal_2' as PrincipalId, name: 'Other', avatarUrl: null }, } vi.mocked(updateArticle).mockResolvedValue(updatedArticle) - vi.mocked(parseOptionalTypeId).mockReturnValue('principal_2' as PrincipalId) + // Echo each id back, so the absent categoryId stays absent. + vi.mocked(parseOptionalTypeId).mockImplementation((value) => value ?? undefined) const body = { authorId: 'principal_2' } const request = createRequest( diff --git a/apps/web/src/routes/api/v1/help-center/articles/$articleId.feedback.ts b/apps/web/src/routes/api/v1/help-center/articles/$articleId.feedback.ts index f1f93026a5..b7369fda54 100644 --- a/apps/web/src/routes/api/v1/help-center/articles/$articleId.feedback.ts +++ b/apps/web/src/routes/api/v1/help-center/articles/$articleId.feedback.ts @@ -11,6 +11,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { isFeatureEnabled } from '@/lib/server/domains/settings/settings.service' import { recordArticleFeedback } from '@/lib/server/domains/help-center/help-center.service' import type { KbArticleId, PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const feedbackBody = z.object({ helpful: z.boolean(), @@ -27,7 +28,7 @@ export const Route = createFileRoute('/api/v1/help-center/articles/$articleId/fe const articleId = parseTypeId(params.articleId, 'article', 'article ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = feedbackBody.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/help-center/articles/$articleId.ts b/apps/web/src/routes/api/v1/help-center/articles/$articleId.ts index 0bb3cc623a..02465ae8c1 100644 --- a/apps/web/src/routes/api/v1/help-center/articles/$articleId.ts +++ b/apps/web/src/routes/api/v1/help-center/articles/$articleId.ts @@ -20,7 +20,8 @@ import { } from '@/lib/server/domains/help-center/help-center.service' import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' import type { TiptapContent } from '@/lib/server/db' -import type { KbArticleId, PrincipalId } from '@quackback/ids' +import type { KbArticleId, KbCategoryId, PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const updateArticleBody = z.object({ categoryId: z.string().optional(), @@ -93,7 +94,7 @@ export const Route = createFileRoute('/api/v1/help-center/articles/$articleId')( const articleId = parseTypeId(params.articleId, 'article', 'article ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateArticleBody.safeParse(body) if (!parsed.success) { @@ -108,7 +109,15 @@ export const Route = createFileRoute('/api/v1/help-center/articles/$articleId')( 'author ID' ) - const { publishedAt: _, authorId: __, ...updateData } = parsed.data + const { publishedAt: _, authorId: __, ...fields } = parsed.data + const updateData = { + ...fields, + categoryId: parseOptionalTypeId( + fields.categoryId, + 'kb_category', + 'category ID' + ), + } // authorPrincipalId is included because reassigning the author requires // the same updateArticle call even when no other fields change. const hasUpdates = diff --git a/apps/web/src/routes/api/v1/help-center/articles/index.ts b/apps/web/src/routes/api/v1/help-center/articles/index.ts index 20ce44264a..1319da5bcb 100644 --- a/apps/web/src/routes/api/v1/help-center/articles/index.ts +++ b/apps/web/src/routes/api/v1/help-center/articles/index.ts @@ -10,12 +10,13 @@ import { handleDomainError, parsePaginationParams, } from '@/lib/server/domains/api/responses' -import { parseOptionalTypeId } from '@/lib/server/domains/api/validation' +import { parseOptionalTypeId, parseTypeId } from '@/lib/server/domains/api/validation' import { isFeatureEnabled } from '@/lib/server/domains/settings/settings.service' import { listArticles, createArticle } from '@/lib/server/domains/help-center/help-center.service' import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' import type { TiptapContent } from '@/lib/server/db' -import type { PrincipalId } from '@quackback/ids' +import type { KbCategoryId, PrincipalId } from '@quackback/ids' +import { parseCursor, readJsonBody } from '@/lib/server/domains/api/request' const createArticleBody = z.object({ categoryId: z.string().min(1, 'Category ID is required'), @@ -72,8 +73,13 @@ export const Route = createFileRoute('/api/v1/help-center/articles/')({ await withApiKeyAuth(request) const url = new URL(request.url) - const { cursor, limit } = parsePaginationParams(url) - const categoryId = url.searchParams.get('categoryId') ?? undefined + const { limit } = parsePaginationParams(url) + const cursor = parseCursor(url) + const categoryId = parseOptionalTypeId( + url.searchParams.get('categoryId'), + 'kb_category', + 'categoryId' + ) const status = (url.searchParams.get('status') as 'draft' | 'published' | 'all') ?? 'all' const search = url.searchParams.get('search') ?? undefined @@ -98,7 +104,7 @@ export const Route = createFileRoute('/api/v1/help-center/articles/')({ permission: PERMISSIONS.HELP_CENTER_MANAGE, }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createArticleBody.safeParse(body) if (!parsed.success) { @@ -108,6 +114,11 @@ export const Route = createFileRoute('/api/v1/help-center/articles/')({ } const { authorId, ...articleData } = parsed.data + const categoryId = parseTypeId( + articleData.categoryId, + 'kb_category', + 'category ID' + ) const authorPrincipalId = parseOptionalTypeId( authorId, @@ -116,7 +127,7 @@ export const Route = createFileRoute('/api/v1/help-center/articles/')({ ) const article = await createArticle( - articleData, + { ...articleData, categoryId }, principalId as PrincipalId, authorPrincipalId ) diff --git a/apps/web/src/routes/api/v1/help-center/categories/$categoryId.ts b/apps/web/src/routes/api/v1/help-center/categories/$categoryId.ts index 2496c72f7b..072a1e73f5 100644 --- a/apps/web/src/routes/api/v1/help-center/categories/$categoryId.ts +++ b/apps/web/src/routes/api/v1/help-center/categories/$categoryId.ts @@ -17,6 +17,7 @@ import { deleteCategory, } from '@/lib/server/domains/help-center/help-center.service' import type { KbCategoryId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const updateCategoryBody = z.object({ name: z.string().min(1).max(200).optional(), @@ -88,7 +89,7 @@ export const Route = createFileRoute('/api/v1/help-center/categories/$categoryId 'category ID' ) - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateCategoryBody.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/help-center/categories/index.ts b/apps/web/src/routes/api/v1/help-center/categories/index.ts index 2aa40313dd..5ad22f2904 100644 --- a/apps/web/src/routes/api/v1/help-center/categories/index.ts +++ b/apps/web/src/routes/api/v1/help-center/categories/index.ts @@ -14,6 +14,7 @@ import { listCategories, createCategory, } from '@/lib/server/domains/help-center/help-center.service' +import { readJsonBody } from '@/lib/server/domains/api/request' const createCategoryBody = z.object({ name: z.string().min(1, 'Name is required').max(200), @@ -78,7 +79,7 @@ export const Route = createFileRoute('/api/v1/help-center/categories/')({ try { await withApiKeyAuth(request, { permission: PERMISSIONS.HELP_CENTER_MANAGE }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createCategoryBody.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/moderation/comments.$commentId.reject.ts b/apps/web/src/routes/api/v1/moderation/comments.$commentId.reject.ts index 0916a42045..2edbf3693c 100644 --- a/apps/web/src/routes/api/v1/moderation/comments.$commentId.reject.ts +++ b/apps/web/src/routes/api/v1/moderation/comments.$commentId.reject.ts @@ -10,6 +10,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { moderationAuditFromApiAuth } from './-audit' import type { PostCommentId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const rejectSchema = z.object({ reason: z.string().max(500).optional(), @@ -28,7 +29,7 @@ export const Route = createFileRoute('/api/v1/moderation/comments/$commentId/rej 'comment ID' ) - const parsed = rejectSchema.safeParse(await request.json().catch(() => ({}))) + const parsed = rejectSchema.safeParse((await readJsonBody(request)) ?? {}) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/moderation/posts.$postId.reject.ts b/apps/web/src/routes/api/v1/moderation/posts.$postId.reject.ts index 976c76f5d0..8326ecdce2 100644 --- a/apps/web/src/routes/api/v1/moderation/posts.$postId.reject.ts +++ b/apps/web/src/routes/api/v1/moderation/posts.$postId.reject.ts @@ -10,6 +10,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { moderationAuditFromApiAuth } from './-audit' import type { PostId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const rejectSchema = z.object({ reason: z.string().max(500).optional(), @@ -24,7 +25,7 @@ export const Route = createFileRoute('/api/v1/moderation/posts/$postId/reject')( const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.POST_APPROVE }) const postId = parseTypeId(params.postId, 'post', 'post ID') - const parsed = rejectSchema.safeParse(await request.json().catch(() => ({}))) + const parsed = rejectSchema.safeParse((await readJsonBody(request)) ?? {}) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/posts/$postId.comments.ts b/apps/web/src/routes/api/v1/posts/$postId.comments.ts index a8b9e43395..48d19e7491 100644 --- a/apps/web/src/routes/api/v1/posts/$postId.comments.ts +++ b/apps/web/src/routes/api/v1/posts/$postId.comments.ts @@ -13,6 +13,7 @@ import { parseTypeId, parseOptionalTypeId } from '@/lib/server/domains/api/valid import type { Role } from '@/lib/shared/roles' import type { PostId, PostCommentId, PrincipalId } from '@quackback/ids' import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const createCommentSchema = z.object({ @@ -75,7 +76,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId/comments')({ const postId = parseTypeId(params.postId, 'post', 'post ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = createCommentSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/posts/$postId.merge.ts b/apps/web/src/routes/api/v1/posts/$postId.merge.ts index 16e77a9239..b61b2cecdf 100644 --- a/apps/web/src/routes/api/v1/posts/$postId.merge.ts +++ b/apps/web/src/routes/api/v1/posts/$postId.merge.ts @@ -9,6 +9,7 @@ import { } from '@/lib/server/domains/api/responses' import { parseTypeId } from '@/lib/server/domains/api/validation' import type { PostId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const mergeSchema = z.object({ canonicalPostId: z.string().min(1, 'Canonical post ID is required'), @@ -29,7 +30,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId/merge')({ const postId = parseTypeId(params.postId, 'post', 'post ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = mergeSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/posts/$postId.ts b/apps/web/src/routes/api/v1/posts/$postId.ts index 2da51f5f18..d8cbdb12e1 100644 --- a/apps/web/src/routes/api/v1/posts/$postId.ts +++ b/apps/web/src/routes/api/v1/posts/$postId.ts @@ -18,6 +18,7 @@ import { import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' import type { PostId, PostStatusId, PostTagId, PrincipalId } from '@quackback/ids' import type { MergedPostSummary } from '@/lib/server/domains/posts/post.types' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const updatePostSchema = z.object({ @@ -119,7 +120,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId')({ const postId = parseTypeId(params.postId, 'post', 'post ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updatePostSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/posts/$postId.vote.proxy.ts b/apps/web/src/routes/api/v1/posts/$postId.vote.proxy.ts index fc4da2aae4..43a7b29580 100644 --- a/apps/web/src/routes/api/v1/posts/$postId.vote.proxy.ts +++ b/apps/web/src/routes/api/v1/posts/$postId.vote.proxy.ts @@ -10,6 +10,7 @@ import { } from '@/lib/server/domains/api/responses' import { parseTypeId } from '@/lib/server/domains/api/validation' import type { PostId, PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const bodySchema = z.object({ voterPrincipalId: z.string().min(1, 'Voter principal ID is required'), @@ -32,7 +33,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId/vote/proxy')({ const postId = parseTypeId(params.postId, 'post', 'post ID') - const body = await request.json().catch(() => null) + const body = await readJsonBody(request) const parsed = bodySchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { @@ -92,7 +93,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId/vote/proxy')({ const postId = parseTypeId(params.postId, 'post', 'post ID') - const body = await request.json().catch(() => null) + const body = await readJsonBody(request) const parsed = bodySchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { diff --git a/apps/web/src/routes/api/v1/posts/$postId.voters.ts b/apps/web/src/routes/api/v1/posts/$postId.voters.ts index 68bbec362a..69cb9899de 100644 --- a/apps/web/src/routes/api/v1/posts/$postId.voters.ts +++ b/apps/web/src/routes/api/v1/posts/$postId.voters.ts @@ -2,6 +2,7 @@ import { createFileRoute } from '@tanstack/react-router' import { withApiKeyAuth } from '@/lib/server/domains/api/auth' import { PERMISSIONS } from '@/lib/shared/permissions' import { successResponse, handleDomainError } from '@/lib/server/domains/api/responses' +import { parseLimit } from '@/lib/server/domains/api/request' import { parseTypeId } from '@/lib/server/domains/api/validation' import type { PostId, PostVoteId } from '@quackback/ids' @@ -20,10 +21,7 @@ export const Route = createFileRoute('/api/v1/posts/$postId/voters')({ const url = new URL(request.url) const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '20', 10) || 20) - ) + const limit = parseLimit(url) const { isValidTypeId } = await import('@quackback/ids') const cursorVoteId = diff --git a/apps/web/src/routes/api/v1/posts/index.ts b/apps/web/src/routes/api/v1/posts/index.ts index c1272f3c1b..5762f5a54b 100644 --- a/apps/web/src/routes/api/v1/posts/index.ts +++ b/apps/web/src/routes/api/v1/posts/index.ts @@ -17,6 +17,7 @@ import { import { contentJsonToMarkdown } from '@/lib/server/markdown-tiptap' import type { BoardId, PrincipalId, PostStatusId, PostTagId } from '@quackback/ids' import { segmentIdsForPrincipal } from '@/lib/server/domains/segments/segment-membership.service' +import { parseCursor, parseLimit, readJsonBody } from '@/lib/server/domains/api/request' // Input validation schemas const createPostSchema = z.object({ @@ -42,11 +43,8 @@ export const Route = createFileRoute('/api/v1/posts/')({ const url = new URL(request.url) - const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '20', 10) || 20) - ) + const cursor = parseCursor(url) + const limit = parseLimit(url) const boardIdParam = url.searchParams.get('boardId') ?? undefined const statusSlug = url.searchParams.get('status') ?? undefined @@ -134,7 +132,7 @@ export const Route = createFileRoute('/api/v1/posts/')({ try { const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.POST_CREATE }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createPostSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/principals/$principalId.ts b/apps/web/src/routes/api/v1/principals/$principalId.ts index 6edd532236..f2e63a62ba 100644 --- a/apps/web/src/routes/api/v1/principals/$principalId.ts +++ b/apps/web/src/routes/api/v1/principals/$principalId.ts @@ -13,6 +13,7 @@ import { isValidTypeId } from '@quackback/ids' import type { PrincipalId, RoleId } from '@quackback/ids' import { isTeamMember } from '@/lib/shared/roles' import { PERMISSIONS } from '@/lib/shared/permissions' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema for updating member role const updateMemberSchema = z.object({ @@ -99,7 +100,7 @@ export const principalHandlers = { const principalId = parseTypeId(params.principalId, 'principal', 'principal ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateMemberSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.$columnId.ts b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.$columnId.ts index d4d37044c1..3a84e38291 100644 --- a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.$columnId.ts +++ b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.$columnId.ts @@ -10,6 +10,7 @@ import { } from '@/lib/server/domains/api/responses' import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' +import { readJsonBody } from '@/lib/server/domains/api/request' const updateColumnSchema = z.object({ name: z.string().min(1).max(100).optional(), @@ -30,7 +31,7 @@ export const Route = createFileRoute('/api/v1/roadmaps/$roadmapId/columns/$colum 'roadmap_col', 'roadmap column ID' ) - const parsed = updateColumnSchema.safeParse(await request.json()) + const parsed = updateColumnSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.ts b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.ts index 0ccdbed2fd..ee1b771041 100644 --- a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.ts +++ b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.columns.ts @@ -11,6 +11,7 @@ import { } from '@/lib/server/domains/api/responses' import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' +import { readJsonBody } from '@/lib/server/domains/api/request' const createColumnSchema = z.object({ statusId: postStatusIdSchema, @@ -37,7 +38,7 @@ export const Route = createFileRoute('/api/v1/roadmaps/$roadmapId/columns')({ try { await withApiKeyAuth(request, { permission: PERMISSIONS.ROADMAP_MANAGE }) const roadmapId = parseTypeId(params.roadmapId, 'roadmap', 'roadmap ID') - const parsed = createColumnSchema.safeParse(await request.json()) + const parsed = createColumnSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.ts b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.ts index 59345450dc..c71f362a76 100644 --- a/apps/web/src/routes/api/v1/roadmaps/$roadmapId.ts +++ b/apps/web/src/routes/api/v1/roadmaps/$roadmapId.ts @@ -20,6 +20,7 @@ import { segmentIdInputSchema, } from '@/lib/shared/roadmap-config' import { postStatusIdSchema, roadmapColumnIdSchema } from '@quackback/ids/zod' +import { readJsonBody } from '@/lib/server/domains/api/request' const roadmapColumnSchema = z.object({ id: roadmapColumnIdSchema.optional(), @@ -101,7 +102,7 @@ export const Route = createFileRoute('/api/v1/roadmaps/$roadmapId')({ const roadmapId = parseTypeId(params.roadmapId, 'roadmap', 'roadmap ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateRoadmapSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/roadmaps/index.ts b/apps/web/src/routes/api/v1/roadmaps/index.ts index 049fc430ea..f929493326 100644 --- a/apps/web/src/routes/api/v1/roadmaps/index.ts +++ b/apps/web/src/routes/api/v1/roadmaps/index.ts @@ -18,6 +18,7 @@ import { segmentIdInputSchema, } from '@/lib/shared/roadmap-config' import { postStatusIdSchema, roadmapColumnIdSchema } from '@quackback/ids/zod' +import { readJsonBody } from '@/lib/server/domains/api/request' const roadmapColumnSchema = z.object({ id: roadmapColumnIdSchema.optional(), @@ -102,7 +103,7 @@ export const Route = createFileRoute('/api/v1/roadmaps/')({ await withApiKeyAuth(request, { permission: PERMISSIONS.ROADMAP_MANAGE }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = createRoadmapSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/segments/$slug.members.ts b/apps/web/src/routes/api/v1/segments/$slug.members.ts index 7db20d7b9f..658784cb76 100644 --- a/apps/web/src/routes/api/v1/segments/$slug.members.ts +++ b/apps/web/src/routes/api/v1/segments/$slug.members.ts @@ -11,6 +11,7 @@ import { db, segments, principal, eq, and, isNull, inArray } from '@/lib/server/ import { PERMISSIONS } from '@/lib/shared/permissions' import { addMember, removeMember } from '@/lib/server/domains/segments/segment-membership.service' import { isValidTypeId, type PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const MutateBody = z.object({ principalIds: z.array(z.string()).min(1).max(1000), @@ -70,7 +71,7 @@ export const Route = createFileRoute('/api/v1/segments/$slug/members')({ POST: async ({ request, params }) => { try { const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.SEGMENT_MANAGE }) - const body = MutateBody.parse(await request.json()) + const body = MutateBody.parse(await readJsonBody(request)) const segment = await db.query.segments.findFirst({ where: and(eq(segments.slug, params.slug), isNull(segments.deletedAt)), @@ -123,7 +124,7 @@ export const Route = createFileRoute('/api/v1/segments/$slug/members')({ DELETE: async ({ request, params }) => { try { const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.SEGMENT_MANAGE }) - const body = MutateBody.parse(await request.json()) + const body = MutateBody.parse(await readJsonBody(request)) const segment = await db.query.segments.findFirst({ where: and(eq(segments.slug, params.slug), isNull(segments.deletedAt)), diff --git a/apps/web/src/routes/api/v1/settings/$area.ts b/apps/web/src/routes/api/v1/settings/$area.ts index ccfa1fbbef..ff411aa11e 100644 --- a/apps/web/src/routes/api/v1/settings/$area.ts +++ b/apps/web/src/routes/api/v1/settings/$area.ts @@ -12,6 +12,7 @@ import { settingsCallerFromApiAuth, withEtag, } from '@/lib/server/domains/settings-registry/http' +import { readJsonBody } from '@/lib/server/domains/api/request' export const Route = createFileRoute('/api/v1/settings/$area')({ server: { @@ -52,7 +53,7 @@ export const Route = createFileRoute('/api/v1/settings/$area')({ ) let patch: unknown try { - patch = await request.json() + patch = await readJsonBody(request) } catch { return badRequestResponse('Request body must be a JSON object') } diff --git a/apps/web/src/routes/api/v1/status/-service-handlers.ts b/apps/web/src/routes/api/v1/status/-service-handlers.ts index 9d7c60e842..7cde6bc043 100644 --- a/apps/web/src/routes/api/v1/status/-service-handlers.ts +++ b/apps/web/src/routes/api/v1/status/-service-handlers.ts @@ -21,11 +21,13 @@ import { handleDomainError, } from '@/lib/server/domains/api/responses' import { parseTypeId, parseTypeIdArray } from '@/lib/server/domains/api/validation' +import { NotFoundError } from '@/lib/shared/errors' import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeStatusComponent } from './-serialize' import { STATUS_COMPONENT_STATUSES, parseNullableTypeId } from './-validation' import type { StatusComponentId, StatusComponentGroupId, SegmentId } from '@quackback/ids' import type { StatusComponentRow } from '@/lib/server/domains/status' +import { readJsonBody } from '@/lib/server/domains/api/request' const createComponentSchema = z.object({ name: z.string().min(1, 'Name is required').max(200), @@ -101,7 +103,7 @@ export async function createStatusComponentHandler({ request }: { request: Reque try { await withApiKeyAuth(request, { permission: PERMISSIONS.STATUS_PAGE_MANAGE }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createComponentSchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { @@ -137,22 +139,48 @@ export async function createStatusComponentHandler({ request }: { request: Reque } } +/** What the caller's path calls the thing: the services path says "service", + * the legacy components path keeps "component". */ +export type ServiceNoun = 'service' | 'component' + +interface ServiceRequest { + request: Request + id: string + noun: ServiceNoun +} + +function parseServiceId(id: string, noun: ServiceNoun): StatusComponentId { + return parseTypeId(id, 'status_component', `${noun} ID`) +} + +function serviceNotFound(noun: ServiceNoun): Response { + return notFoundResponse(`Status ${noun}`) +} + +/** handleDomainError, with a missing service named the way the path names it. */ +function serviceError(error: unknown, noun: ServiceNoun): Response { + if (error instanceof NotFoundError && error.code === 'STATUS_COMPONENT_NOT_FOUND') { + return serviceNotFound(noun) + } + return handleDomainError(error) +} + /** * GET /api/v1/status/components/:componentId (aliased at * /api/v1/status/services/:serviceId) */ -export async function getStatusComponentHandler({ request, id }: { request: Request; id: string }) { +export async function getStatusComponentHandler({ request, id, noun }: ServiceRequest) { try { await withApiKeyAuth(request) - const componentId = parseTypeId(id, 'status_component', 'component ID') + const componentId = parseServiceId(id, noun) const row = await findComponentRow(componentId) - if (!row) return notFoundResponse('Status component') + if (!row) return serviceNotFound(noun) return successResponse(serializeStatusComponent(row)) } catch (error) { - return handleDomainError(error) + return serviceError(error, noun) } } @@ -163,19 +191,13 @@ export async function getStatusComponentHandler({ request, id }: { request: Requ * status in one call. A `{ status }`-only body is the primary * automation hook — see the schema comment above. */ -export async function patchStatusComponentHandler({ - request, - id, -}: { - request: Request - id: string -}) { +export async function patchStatusComponentHandler({ request, id, noun }: ServiceRequest) { try { await withApiKeyAuth(request, { permission: PERMISSIONS.STATUS_PAGE_MANAGE }) - const componentId = parseTypeId(id, 'status_component', 'component ID') + const componentId = parseServiceId(id, noun) - const body = await request.json() + const body = await readJsonBody(request) const parsed = patchComponentSchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { @@ -213,10 +235,10 @@ export async function patchStatusComponentHandler({ } const row = await findComponentRow(componentId) - if (!row) return notFoundResponse('Status component') + if (!row) return serviceNotFound(noun) return successResponse(serializeStatusComponent(row)) } catch (error) { - return handleDomainError(error) + return serviceError(error, noun) } } diff --git a/apps/web/src/routes/api/v1/status/components/$componentId.ts b/apps/web/src/routes/api/v1/status/components/$componentId.ts index 5677240499..22cd032ede 100644 --- a/apps/web/src/routes/api/v1/status/components/$componentId.ts +++ b/apps/web/src/routes/api/v1/status/components/$componentId.ts @@ -11,13 +11,13 @@ export const Route = createFileRoute('/api/v1/status/components/$componentId')({ * GET /api/v1/status/components/:componentId */ GET: async ({ request, params }) => - getStatusComponentHandler({ request, id: params.componentId }), + getStatusComponentHandler({ request, id: params.componentId, noun: 'component' }), /** * PATCH /api/v1/status/components/:componentId */ PATCH: async ({ request, params }) => - patchStatusComponentHandler({ request, id: params.componentId }), + patchStatusComponentHandler({ request, id: params.componentId, noun: 'component' }), }, }, }) diff --git a/apps/web/src/routes/api/v1/status/incidents/$incidentId.updates.ts b/apps/web/src/routes/api/v1/status/incidents/$incidentId.updates.ts index 3e17d6c6a5..b97d6e380d 100644 --- a/apps/web/src/routes/api/v1/status/incidents/$incidentId.updates.ts +++ b/apps/web/src/routes/api/v1/status/incidents/$incidentId.updates.ts @@ -11,6 +11,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeIncidentDetails } from '../-serialize' import { STATUS_INCIDENT_LIFECYCLE_STATUSES } from '../-validation' import type { StatusIncidentId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const postIncidentUpdateSchema = z.object({ status: z.enum(STATUS_INCIDENT_LIFECYCLE_STATUSES), @@ -40,7 +41,7 @@ export const Route = createFileRoute('/api/v1/status/incidents/$incidentId/updat 'incident ID' ) - const body = await request.json() + const body = await readJsonBody(request) const parsed = postIncidentUpdateSchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { diff --git a/apps/web/src/routes/api/v1/status/incidents/index.ts b/apps/web/src/routes/api/v1/status/incidents/index.ts index 0261fe0692..9a22bbe978 100644 --- a/apps/web/src/routes/api/v1/status/incidents/index.ts +++ b/apps/web/src/routes/api/v1/status/incidents/index.ts @@ -17,6 +17,7 @@ import { parseOptionalDate, } from '../-validation' import type { StatusComponentId } from '@quackback/ids' +import { parseCursor, parseLimit, readJsonBody } from '@/lib/server/domains/api/request' const affectedComponentSchema = z.object({ componentId: z.string(), @@ -60,8 +61,8 @@ export const Route = createFileRoute('/api/v1/status/incidents/')({ const url = new URL(request.url) const kindParam = url.searchParams.get('kind') const stateParam = url.searchParams.get('state') - const cursor = url.searchParams.get('cursor') ?? undefined - const limit = Math.min(parseInt(url.searchParams.get('limit') || '20', 10), 100) + const cursor = parseCursor(url) + const limit = parseLimit(url) const kind = kindParam === 'incident' || kindParam === 'maintenance' ? kindParam : undefined @@ -93,7 +94,7 @@ export const Route = createFileRoute('/api/v1/status/incidents/')({ permission: PERMISSIONS.STATUS_PAGE_PUBLISH, }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createIncidentSchema.safeParse(body) if (!parsed.success) { return badRequestResponse('Invalid request body', { diff --git a/apps/web/src/routes/api/v1/status/services/$serviceId.ts b/apps/web/src/routes/api/v1/status/services/$serviceId.ts index ea672fc4a3..92b8bff761 100644 --- a/apps/web/src/routes/api/v1/status/services/$serviceId.ts +++ b/apps/web/src/routes/api/v1/status/services/$serviceId.ts @@ -13,13 +13,13 @@ export const Route = createFileRoute('/api/v1/status/services/$serviceId')({ * GET /api/v1/status/services/:serviceId */ GET: async ({ request, params }) => - getStatusComponentHandler({ request, id: params.serviceId }), + getStatusComponentHandler({ request, id: params.serviceId, noun: 'service' }), /** * PATCH /api/v1/status/services/:serviceId */ PATCH: async ({ request, params }) => - patchStatusComponentHandler({ request, id: params.serviceId }), + patchStatusComponentHandler({ request, id: params.serviceId, noun: 'service' }), }, }, }) diff --git a/apps/web/src/routes/api/v1/statuses/$statusId.ts b/apps/web/src/routes/api/v1/statuses/$statusId.ts index 3b8ed3ca8f..b5bdd4490d 100644 --- a/apps/web/src/routes/api/v1/statuses/$statusId.ts +++ b/apps/web/src/routes/api/v1/statuses/$statusId.ts @@ -11,6 +11,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { HexColorSchema, TaxonomyNameSchema } from '@/lib/shared/schemas/taxonomy' import type { PostStatusId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema - matches UpdateStatusInput from service const updateStatusSchema = z.object({ @@ -63,7 +64,7 @@ export const Route = createFileRoute('/api/v1/statuses/$statusId')({ const statusId = parseTypeId(params.statusId, 'post_status', 'status ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateStatusSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/statuses/index.ts b/apps/web/src/routes/api/v1/statuses/index.ts index d04c90320e..6c998e916e 100644 --- a/apps/web/src/routes/api/v1/statuses/index.ts +++ b/apps/web/src/routes/api/v1/statuses/index.ts @@ -9,6 +9,7 @@ import { } from '@/lib/server/domains/api/responses' import { PERMISSIONS } from '@/lib/shared/permissions' import { HexColorSchema } from '@/lib/shared/schemas/taxonomy' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const createStatusSchema = z.object({ @@ -68,7 +69,7 @@ export const Route = createFileRoute('/api/v1/statuses/')({ await withApiKeyAuth(request, { permission: PERMISSIONS.STATUS_MANAGE }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = createStatusSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/suggestions/$suggestionId.accept.ts b/apps/web/src/routes/api/v1/suggestions/$suggestionId.accept.ts index 8edf8fe45c..00fbb8ac5d 100644 --- a/apps/web/src/routes/api/v1/suggestions/$suggestionId.accept.ts +++ b/apps/web/src/routes/api/v1/suggestions/$suggestionId.accept.ts @@ -1,4 +1,5 @@ import { createFileRoute } from '@tanstack/react-router' +import { z } from 'zod' import { withApiKeyAuth } from '@/lib/server/domains/api/auth' import { successResponse, @@ -8,6 +9,9 @@ import { import { isValidTypeId } from '@quackback/ids' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PostMergeSuggestionId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' + +const acceptSchema = z.object({ swapDirection: z.boolean().optional() }) export const Route = createFileRoute('/api/v1/suggestions/$suggestionId/accept')({ server: { @@ -27,18 +31,18 @@ export const Route = createFileRoute('/api/v1/suggestions/$suggestionId/accept') return badRequestResponse('Invalid suggestion ID format. Expected post_merge_sug_xxx') } - // Parse optional body - let body: { swapDirection?: boolean } = {} - try { - body = await request.json() - } catch { - // Empty body is ok + // The body is optional + const parsed = acceptSchema.safeParse((await readJsonBody(request)) ?? {}) + if (!parsed.success) { + return badRequestResponse('Invalid request body', { + errors: parsed.error.flatten().fieldErrors, + }) } const { acceptMergeSuggestion } = await import('@/lib/server/domains/merge-suggestions/merge-suggestion.service') await acceptMergeSuggestion(suggestionId as PostMergeSuggestionId, principalId, { - swapDirection: body.swapDirection, + swapDirection: parsed.data.swapDirection, }) return successResponse({ accepted: true, id: suggestionId }) } catch (error) { diff --git a/apps/web/src/routes/api/v1/tags/$tagId.ts b/apps/web/src/routes/api/v1/tags/$tagId.ts index 834eb7f0c0..3b2a1b7f85 100644 --- a/apps/web/src/routes/api/v1/tags/$tagId.ts +++ b/apps/web/src/routes/api/v1/tags/$tagId.ts @@ -11,6 +11,7 @@ import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import { HexColorSchema, TaxonomyNameSchema } from '@/lib/shared/schemas/taxonomy' import type { PostTagId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const updateTagSchema = z.object({ @@ -60,7 +61,7 @@ export const Route = createFileRoute('/api/v1/tags/$tagId')({ const tagId = parseTypeId(params.tagId, 'post_tag', 'tag ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateTagSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/tags/index.ts b/apps/web/src/routes/api/v1/tags/index.ts index f0eb7d0011..d9310e75dd 100644 --- a/apps/web/src/routes/api/v1/tags/index.ts +++ b/apps/web/src/routes/api/v1/tags/index.ts @@ -9,6 +9,7 @@ import { } from '@/lib/server/domains/api/responses' import { PERMISSIONS } from '@/lib/shared/permissions' import { HexColorSchema } from '@/lib/shared/schemas/taxonomy' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const createTagSchema = z.object({ @@ -58,7 +59,7 @@ export const Route = createFileRoute('/api/v1/tags/')({ await withApiKeyAuth(request, { permission: PERMISSIONS.TAG_MANAGE }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = createTagSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/tickets/$ticketId.assign.ts b/apps/web/src/routes/api/v1/tickets/$ticketId.assign.ts index 80ab08c767..d97e17cf13 100644 --- a/apps/web/src/routes/api/v1/tickets/$ticketId.assign.ts +++ b/apps/web/src/routes/api/v1/tickets/$ticketId.assign.ts @@ -12,6 +12,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeTicket } from './-serialize' import type { AssignTicketInput } from '@/lib/server/domains/tickets/ticket.types' import type { TicketId, PrincipalId, TeamId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Both keys are optional AND nullable: an absent key leaves that side untouched, // an explicit null clears it (mirrors `functions/tickets.ts`, minus the 'me' @@ -30,7 +31,7 @@ export const Route = createFileRoute('/api/v1/tickets/$ticketId/assign')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_ASSIGN }) const ticketId = parseTypeId(params.ticketId, 'ticket', 'ticket ID') - const parsed = assignSchema.safeParse(await request.json().catch(() => null)) + const parsed = assignSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/tickets/$ticketId.note.ts b/apps/web/src/routes/api/v1/tickets/$ticketId.note.ts index b00eacae97..22be2a9693 100644 --- a/apps/web/src/routes/api/v1/tickets/$ticketId.note.ts +++ b/apps/web/src/routes/api/v1/tickets/$ticketId.note.ts @@ -17,6 +17,7 @@ import { markdownToSanitizedJson, } from './-validation' import type { TicketId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const noteSchema = z.object({ content: messageContentSchema, @@ -35,7 +36,7 @@ export const Route = createFileRoute('/api/v1/tickets/$ticketId/note')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_NOTE }) const ticketId = parseTypeId(params.ticketId, 'ticket', 'ticket ID') - const parsed = noteSchema.safeParse(await request.json().catch(() => null)) + const parsed = noteSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/tickets/$ticketId.priority.ts b/apps/web/src/routes/api/v1/tickets/$ticketId.priority.ts index e70519d5b7..b859697890 100644 --- a/apps/web/src/routes/api/v1/tickets/$ticketId.priority.ts +++ b/apps/web/src/routes/api/v1/tickets/$ticketId.priority.ts @@ -12,6 +12,7 @@ import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeTicket } from './-serialize' import { priorityEnum } from './-validation' import type { TicketId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const prioritySchema = z.object({ priority: priorityEnum, @@ -26,7 +27,7 @@ export const Route = createFileRoute('/api/v1/tickets/$ticketId/priority')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_SET_STATUS }) const ticketId = parseTypeId(params.ticketId, 'ticket', 'ticket ID') - const parsed = prioritySchema.safeParse(await request.json().catch(() => null)) + const parsed = prioritySchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/tickets/$ticketId.reply.ts b/apps/web/src/routes/api/v1/tickets/$ticketId.reply.ts index b4110ba51b..95615bf807 100644 --- a/apps/web/src/routes/api/v1/tickets/$ticketId.reply.ts +++ b/apps/web/src/routes/api/v1/tickets/$ticketId.reply.ts @@ -17,6 +17,7 @@ import { markdownToSanitizedJson, } from './-validation' import type { TicketId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const replySchema = z.object({ content: messageContentSchema, @@ -37,7 +38,7 @@ export const Route = createFileRoute('/api/v1/tickets/$ticketId/reply')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_REPLY }) const ticketId = parseTypeId(params.ticketId, 'ticket', 'ticket ID') - const parsed = replySchema.safeParse(await request.json().catch(() => null)) + const parsed = replySchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/tickets/$ticketId.status.ts b/apps/web/src/routes/api/v1/tickets/$ticketId.status.ts index 1589dccf10..72b8cca465 100644 --- a/apps/web/src/routes/api/v1/tickets/$ticketId.status.ts +++ b/apps/web/src/routes/api/v1/tickets/$ticketId.status.ts @@ -11,6 +11,7 @@ import { serviceActorFromApiAuth } from '@/lib/server/domains/api/service-actor' import { PERMISSIONS } from '@/lib/shared/permissions' import { serializeTicket } from './-serialize' import type { TicketId, TicketStatusId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const statusSchema = z.object({ statusId: z.string().min(1), @@ -25,7 +26,7 @@ export const Route = createFileRoute('/api/v1/tickets/$ticketId/status')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_SET_STATUS }) const ticketId = parseTypeId(params.ticketId, 'ticket', 'ticket ID') - const parsed = statusSchema.safeParse(await request.json().catch(() => null)) + const parsed = statusSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/tickets/index.ts b/apps/web/src/routes/api/v1/tickets/index.ts index 01a38a54a7..b36d3319f9 100644 --- a/apps/web/src/routes/api/v1/tickets/index.ts +++ b/apps/web/src/routes/api/v1/tickets/index.ts @@ -22,6 +22,7 @@ import { import type { TicketType, TicketStatusCategory, TicketStage } from '@/lib/server/db' import type { TicketSort } from '@/lib/server/domains/tickets/ticket.types' import type { PrincipalId, CompanyId, TicketTypeId } from '@quackback/ids' +import { parseLimit, readJsonBody } from '@/lib/server/domains/api/request' const createTicketSchema = z.object({ // Optional since Phase 4: derivable from ticketTypeId (a mismatched explicit @@ -47,10 +48,7 @@ export const Route = createFileRoute('/api/v1/tickets/')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_VIEW }) const url = new URL(request.url) - const limit = Math.min( - 100, - Math.max(1, parseInt(url.searchParams.get('limit') ?? '20', 10) || 20) - ) + const limit = parseLimit(url) const type = (url.searchParams.get('type') as TicketType | null) ?? undefined // The Phase 4 registry-type filter — the TypeID check keeps a junk // value out of the uuid-backed query (mirrors listTicketsFn). @@ -58,9 +56,16 @@ export const Route = createFileRoute('/api/v1/tickets/')({ const statusCategory = (url.searchParams.get('statusCategory') as TicketStatusCategory | null) ?? undefined const stage = (url.searchParams.get('stage') as TicketStage | null) ?? undefined - const requesterPrincipalId = - (url.searchParams.get('requesterPrincipalId') as PrincipalId | null) ?? undefined - const companyId = (url.searchParams.get('companyId') as CompanyId | null) ?? undefined + const requesterPrincipalId = parseOptionalTypeId( + url.searchParams.get('requesterPrincipalId'), + 'principal', + 'requesterPrincipalId' + ) + const companyId = parseOptionalTypeId( + url.searchParams.get('companyId'), + 'company', + 'companyId' + ) const sort = (url.searchParams.get('sort') as TicketSort | null) ?? undefined const actor = serviceActorFromApiAuth(auth) @@ -93,7 +98,7 @@ export const Route = createFileRoute('/api/v1/tickets/')({ try { const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.TICKET_CREATE }) - const parsed = createTicketSchema.safeParse(await request.json().catch(() => null)) + const parsed = createTicketSchema.safeParse(await readJsonBody(request)) if (!parsed.success) { return badRequestResponse('Invalid request body', { errors: parsed.error.flatten().fieldErrors, diff --git a/apps/web/src/routes/api/v1/users/$principalId.ts b/apps/web/src/routes/api/v1/users/$principalId.ts index d13a056226..c65d51d05b 100644 --- a/apps/web/src/routes/api/v1/users/$principalId.ts +++ b/apps/web/src/routes/api/v1/users/$principalId.ts @@ -11,6 +11,7 @@ import { import { parseTypeId } from '@/lib/server/domains/api/validation' import { PERMISSIONS } from '@/lib/shared/permissions' import type { PrincipalId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' const updateUserSchema = z.object({ name: z.string().min(1).max(200).optional(), @@ -96,7 +97,7 @@ export const Route = createFileRoute('/api/v1/users/$principalId')({ 'principal ID' ) - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateUserSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/users/identify.ts b/apps/web/src/routes/api/v1/users/identify.ts index 2e3a37f05e..34d5f85b10 100644 --- a/apps/web/src/routes/api/v1/users/identify.ts +++ b/apps/web/src/routes/api/v1/users/identify.ts @@ -8,6 +8,7 @@ import { handleDomainError, } from '@/lib/server/domains/api/responses' import { PERMISSIONS } from '@/lib/shared/permissions' +import { readJsonBody } from '@/lib/server/domains/api/request' const identifyUserSchema = z.object({ email: z.string().email('Valid email is required'), @@ -31,7 +32,7 @@ export const Route = createFileRoute('/api/v1/users/identify')({ const auth = await withApiKeyAuth(request, { permission: PERMISSIONS.PEOPLE_MANAGE }) // Parse and validate body - const body = await request.json() + const body = await readJsonBody(request) const parsed = identifyUserSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/webhooks/$webhookId.ts b/apps/web/src/routes/api/v1/webhooks/$webhookId.ts index f900490f04..7d69044278 100644 --- a/apps/web/src/routes/api/v1/webhooks/$webhookId.ts +++ b/apps/web/src/routes/api/v1/webhooks/$webhookId.ts @@ -12,6 +12,7 @@ import { WEBHOOK_EVENTS } from '@/lib/server/events/integrations/webhook/constan import { toWebhookResponse } from '@/lib/server/domains/api/webhooks' import { PERMISSIONS } from '@/lib/shared/permissions' import type { BoardId, WebhookId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const updateWebhookSchema = z.object({ @@ -53,7 +54,7 @@ export const Route = createFileRoute('/api/v1/webhooks/$webhookId')({ const webhookId = parseTypeId(params.webhookId, 'webhook', 'webhook ID') - const body = await request.json() + const body = await readJsonBody(request) const parsed = updateWebhookSchema.safeParse(body) if (!parsed.success) { diff --git a/apps/web/src/routes/api/v1/webhooks/index.ts b/apps/web/src/routes/api/v1/webhooks/index.ts index b31e464835..0eac23dc02 100644 --- a/apps/web/src/routes/api/v1/webhooks/index.ts +++ b/apps/web/src/routes/api/v1/webhooks/index.ts @@ -12,6 +12,7 @@ import { parseTypeIdArray } from '@/lib/server/domains/api/validation' import { toWebhookListResponse } from '@/lib/server/domains/api/webhooks' import { PERMISSIONS } from '@/lib/shared/permissions' import type { BoardId } from '@quackback/ids' +import { readJsonBody } from '@/lib/server/domains/api/request' // Input validation schema const createWebhookSchema = z.object({ @@ -50,7 +51,7 @@ export const Route = createFileRoute('/api/v1/webhooks/')({ permission: PERMISSIONS.WEBHOOK_MANAGE, }) - const body = await request.json() + const body = await readJsonBody(request) const parsed = createWebhookSchema.safeParse(body) if (!parsed.success) {