feat(documents): paginated register with honest total + Documents page (Phase 2, WS-D)
listDocuments now returns { documents, total, page, pageSize } (default 50,
cap 200, newest first) with the client name joined server-side — no N+1.
GET /documents passes page/pageSize through; type/status/clientId filters
compose against the same WHERE for both count and page (rule 8: no silent
caps). clientLedger walks the paginated repo in 200-row batches so the
ledger still surfaces every document. New /documents screen: type chips,
status filter, mono doc numbers, amount column, pager honouring the server
total; rows open /documents/:id. Nav entry under WORK (exact-match so New
Document keeps its own highlight).
Note: the GET /documents route hunk itself landed via 8861b46, swept into
a concurrent commit from the same working tree; this commit carries the
repo/ledger/web halves and the tests.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
feat/client-detail-redesign
Thomas Joise
5 days ago
parent
8861b46afd
commit
584fb291f8
@ -0,0 +1,151 @@
|
||||
// apps/hq/test/documents-page.test.ts — Phase 2 (go-live cluster WS-D):
|
||||
// listDocuments pagination with an honest total (rule 8) + GET /documents pass-through.
|
||||
import express from 'express'
|
||||
import { describe, it, expect, afterAll } from 'vitest'
|
||||
import { openDb } from '../src/db'
|
||||
import { seedIfEmpty } from '../src/seed'
|
||||
import { createStaff } from '../src/auth'
|
||||
import { createClient } from '../src/repos-clients'
|
||||
import { createModule, setPrice } from '../src/repos-modules'
|
||||
import { createDraft, issueDocument, listDocuments, markStatus } from '../src/repos-documents'
|
||||
import { clientLedger } from '../src/repos-payments'
|
||||
import { apiRouter } from '../src/api'
|
||||
|
||||
const KEY = '11'.repeat(32)
|
||||
const fakePdf = async () => Buffer.from('%PDF-fake')
|
||||
|
||||
function world() {
|
||||
const db = openDb(':memory:'); seedIfEmpty(db)
|
||||
const m = createModule(db, 'u1', { code: 'CORE', name: 'Core Banking' })
|
||||
setPrice(db, 'u1', { moduleId: m.id, kind: 'yearly', pricePaise: 9_000_00, effectiveFrom: '2026-01-01' })
|
||||
const mkClient = (name: string) => createClient(db, 'u1', { name, stateCode: '32' })
|
||||
const mkDraft = (clientId: string, docType: 'QUOTATION' | 'PROFORMA' | 'INVOICE' = 'QUOTATION') =>
|
||||
createDraft(db, 'u1', { docType, clientId, lines: [{ moduleId: m.id, qty: 1, kind: 'yearly' }] })
|
||||
return { db, m, mkClient, mkDraft }
|
||||
}
|
||||
|
||||
describe('listDocuments — pagination (rule 8)', () => {
|
||||
it('returns { documents, total, page, pageSize } with defaults page=1 pageSize=50, newest first', () => {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
const c = mkClient('Acme Bank')
|
||||
const ids: string[] = []
|
||||
for (let i = 0; i < 55; i++) ids.push(mkDraft(c.id).id)
|
||||
const p1 = listDocuments(db)
|
||||
expect(p1.total).toBe(55)
|
||||
expect(p1.page).toBe(1)
|
||||
expect(p1.pageSize).toBe(50)
|
||||
expect(p1.documents).toHaveLength(50)
|
||||
// newest first — the last-created draft leads the list
|
||||
expect(p1.documents[0]!.id).toBe(ids[54])
|
||||
const p2 = listDocuments(db, { page: 2 })
|
||||
expect(p2.total).toBe(55) // total is stable across pages
|
||||
expect(p2.documents).toHaveLength(5)
|
||||
// no overlap between pages
|
||||
const seen = new Set(p1.documents.map((d) => d.id))
|
||||
expect(p2.documents.some((d) => seen.has(d.id))).toBe(false)
|
||||
})
|
||||
|
||||
it('joins the client name onto every row (no N+1 for the list view)', () => {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
const a = mkClient('Acme Bank'); const b = mkClient('Beta Coop')
|
||||
mkDraft(a.id); mkDraft(b.id)
|
||||
const page = listDocuments(db)
|
||||
const names = new Map(page.documents.map((d) => [d.clientId, d.clientName]))
|
||||
expect(names.get(a.id)).toBe('Acme Bank')
|
||||
expect(names.get(b.id)).toBe('Beta Coop')
|
||||
})
|
||||
|
||||
it('type/status/clientId filters compose, with an honest filtered total', () => {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
const a = mkClient('Acme Bank'); const b = mkClient('Beta Coop')
|
||||
mkDraft(a.id, 'QUOTATION')
|
||||
const invA = mkDraft(a.id, 'INVOICE')
|
||||
issueDocument(db, 'u1', invA.id)
|
||||
markStatus(db, 'u1', invA.id, 'sent')
|
||||
mkDraft(b.id, 'INVOICE') // stays draft
|
||||
const filtered = listDocuments(db, { type: 'INVOICE', clientId: a.id, status: 'sent', pageSize: 1 })
|
||||
expect(filtered.total).toBe(1)
|
||||
expect(filtered.documents.map((d) => d.id)).toEqual([invA.id])
|
||||
const draftInvoices = listDocuments(db, { type: 'INVOICE', status: 'draft' })
|
||||
expect(draftInvoices.total).toBe(1)
|
||||
expect(draftInvoices.documents[0]!.clientId).toBe(b.id)
|
||||
})
|
||||
|
||||
it('clamps pageSize to 200 and floors page/pageSize at 1', () => {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
const c = mkClient('Acme Bank')
|
||||
for (let i = 0; i < 3; i++) mkDraft(c.id)
|
||||
expect(listDocuments(db, { pageSize: 9999 }).pageSize).toBe(200)
|
||||
expect(listDocuments(db, { pageSize: 0 }).pageSize).toBe(1)
|
||||
expect(listDocuments(db, { page: 0 }).page).toBe(1)
|
||||
})
|
||||
|
||||
it('clientLedger still surfaces EVERY document — the page cap never truncates the ledger', () => {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
const c = mkClient('Acme Bank')
|
||||
for (let i = 0; i < 55; i++) mkDraft(c.id)
|
||||
const ledger = clientLedger(db, c.id)
|
||||
expect(ledger.documents).toHaveLength(55)
|
||||
})
|
||||
})
|
||||
|
||||
// ---------- GET /documents pass-through ----------
|
||||
|
||||
function appWith() {
|
||||
const { db, mkClient, mkDraft } = world()
|
||||
createStaff(db, { email: 'staff@test.in', displayName: 'Staff', role: 'staff', password: 'staff-password' })
|
||||
const app = express(); app.use(express.json()); app.locals['db'] = db
|
||||
const nullFetch = (async () => new Response('{}', { status: 500 })) as typeof fetch
|
||||
app.use('/api', apiRouter(db, { f: nullFetch, clientId: 'cid', clientSecret: 'sec', keyHex: KEY }, fakePdf))
|
||||
const server = app.listen(0)
|
||||
const baseUrl = `http://localhost:${(server.address() as { port: number }).port}/api`
|
||||
return { db, server, baseUrl, mkClient, mkDraft }
|
||||
}
|
||||
|
||||
async function login(baseUrl: string) {
|
||||
return (await (await fetch(`${baseUrl}/auth/login`, {
|
||||
method: 'POST', headers: { 'content-type': 'application/json' },
|
||||
body: JSON.stringify({ email: 'staff@test.in', password: 'staff-password' }),
|
||||
})).json() as { token: string }).token
|
||||
}
|
||||
|
||||
interface ListJson {
|
||||
ok: boolean; total: number; page: number; pageSize: number
|
||||
documents: { id: string; docType: string; clientName: string }[]
|
||||
}
|
||||
|
||||
describe('GET /documents — paginated route', () => {
|
||||
const servers: { close: () => void }[] = []
|
||||
afterAll(() => { for (const s of servers) s.close() })
|
||||
|
||||
it('passes page/pageSize through and reports the honest total + clientName rows', async () => {
|
||||
const ctx = appWith(); servers.push(ctx.server)
|
||||
const c = ctx.mkClient('Acme Bank')
|
||||
for (let i = 0; i < 5; i++) ctx.mkDraft(c.id)
|
||||
const token = await login(ctx.baseUrl)
|
||||
const res = await fetch(`${ctx.baseUrl}/documents?page=2&pageSize=2`, {
|
||||
headers: { authorization: `Bearer ${token}` },
|
||||
})
|
||||
expect(res.status).toBe(200)
|
||||
const json = await res.json() as ListJson
|
||||
expect(json).toMatchObject({ ok: true, total: 5, page: 2, pageSize: 2 })
|
||||
expect(json.documents).toHaveLength(2)
|
||||
expect(json.documents[0]!.clientName).toBe('Acme Bank')
|
||||
})
|
||||
|
||||
it('composes type + status filters with pagination', async () => {
|
||||
const ctx = appWith(); servers.push(ctx.server)
|
||||
const c = ctx.mkClient('Acme Bank')
|
||||
ctx.mkDraft(c.id, 'QUOTATION')
|
||||
ctx.mkDraft(c.id, 'INVOICE')
|
||||
ctx.mkDraft(c.id, 'INVOICE')
|
||||
const token = await login(ctx.baseUrl)
|
||||
const res = await fetch(`${ctx.baseUrl}/documents?type=INVOICE&status=draft&page=1&pageSize=1`, {
|
||||
headers: { authorization: `Bearer ${token}` },
|
||||
})
|
||||
const json = await res.json() as ListJson
|
||||
expect(json.total).toBe(2) // both draft invoices counted, one on the page
|
||||
expect(json.documents).toHaveLength(1)
|
||||
expect(json.documents[0]!.docType).toBe('INVOICE')
|
||||
})
|
||||
})
|
||||
Loading…
Reference in New Issue