Skip to content

test(rest): type the unchecked route.handler call sites in rest.test.ts, and measure what the response literals actually are #15582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-litant merged 2 commits into from
Sep 5, 2026
+40 −33
Merged

test(rest): type the unchecked route.handler call sites in rest.test.ts, and measure what the response literals actually are #15582

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d6b55c
test(rest): type the seven unchecked route.handler call sites in rest…
claude Sep 4, 2026
c4bde18
Merge remote-tracking branch 'origin/main' into claude/issue-14356-un…
claude Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 40 additions & 33 deletions packages/rest/src/rest.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1876,8 +1876,8 @@ describe('createRestApiPlugin', () => {
// ---------------------------------------------------------------------------

describe('PUT /meta/:type/:name handler — header → request plumbing (PR-10d.4)', () => {
function getPutRoute(rest: any, path: string) {
return rest.getRoutes().find((r: any) => r.method === 'PUT' && r.path === path);
function getPutRoute(rest: RestServer, path: string) {
return rest.getRoutes().find((r) => r.method === 'PUT' && r.path === path);
}

it('forwards If-Match header as parentVersion to protocol.saveMetaItem', async () => {
Expand All @@ -1892,14 +1892,14 @@ describe('PUT /meta/:type/:name handler — header → request plumbing (PR-10d.
const route = getPutRoute(rest, '/api/v1/meta/:type/:name');
expect(route).toBeDefined();

const req = {
const req = httpRequestForRoute(route!, {
params: { type: 'view', name: 'cases' },
headers: { 'if-match': 'sha256:abc', 'x-actor': 'user_42' },
body: { name: 'cases', type: 'grid', label: 'X', columns: ['id'] },
};
const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
});
const res = httpResponseTestDouble();

await route.handler(req, res);
await route!.handler(req, res);

// [#7941] `actor` is the authenticated identity, NOT the `x-actor` header
// this request also sends. The header is retained in the fixture on
Expand Down Expand Up @@ -1927,13 +1927,13 @@ describe('PUT /meta/:type/:name handler — header → request plumbing (PR-10d.
rest.registerRoutes();
const route = getPutRoute(rest, '/api/v1/meta/:type/:name');

await route.handler(
{
await route!.handler(
httpRequestForRoute(route!, {
params: { type: 'view', name: 'cases' },
headers: { 'If-Match': '"sha256:xyz"' },
body: {},
},
{ json: vi.fn(), status: vi.fn().mockReturnThis() },
}),
httpResponseTestDouble(),
);

expect(protocol.saveMetaItem).toHaveBeenCalledWith(
Expand All @@ -1951,13 +1951,13 @@ describe('PUT /meta/:type/:name handler — header → request plumbing (PR-10d.
rest.registerRoutes();
const route = getPutRoute(rest, '/api/v1/meta/:type/:name');

await route.handler(
{
await route!.handler(
httpRequestForRoute(route!, {
params: { type: 'view', name: 'cases' },
headers: {},
body: {},
},
{ json: vi.fn(), status: vi.fn().mockReturnThis() },
}),
httpResponseTestDouble(),
);

const arg = (protocol.saveMetaItem as any).mock.calls[0][0];
Expand Down Expand Up @@ -1985,9 +1985,13 @@ describe('PUT /meta/:type/:name handler — header → request plumbing (PR-10d.
rest.registerRoutes();
const route = getPutRoute(rest, '/api/v1/meta/:type/:name');

const res = { json: vi.fn(), status: vi.fn().mockReturnThis() };
await route.handler(
{ params: { type: 'view', name: 'cases' }, headers: { 'if-match': 'sha256:stale' }, body: {} },
const res = httpResponseTestDouble();
await route!.handler(
httpRequestForRoute(route!, {
params: { type: 'view', name: 'cases' },
headers: { 'if-match': 'sha256:stale' },
body: {},
}),
res,
);
expect(res.status).toHaveBeenCalledWith(409);
Expand Down Expand Up @@ -3891,15 +3895,15 @@ describe('filterAppForUser — ADR-0057 D10 requiresService gate', () => {
{ id: 'nav_organizations', type: 'object', requiresService: 'org-scoping' },
] },
});
const rest: any = new RestServer(createMockServer() as any, protocol, ANON_API as any);
rest.resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
rest.serviceExistsProvider = (n: string) => n !== 'org-scoping';
const rest = new RestServer(createMockServer() as any, protocol, ANON_API as any);
(rest as any).resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
(rest as any).serviceExistsProvider = (n: string) => n !== 'org-scoping';
rest.registerRoutes();
const route = rest.getRoutes().find(
(r: any) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
(r) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), header: vi.fn(), send: vi.fn() };
await route.handler({ params: { type: 'app', name: 'setup' }, query: {}, headers: {} }, res);
await route!.handler(httpRequestForRoute(route!, { params: { type: 'app', name: 'setup' } }), res);

const body = res.json.mock.calls.at(-1)![0];
expect(body).toMatchObject({ type: 'app', name: 'setup', lock: 'none' });
Expand Down Expand Up @@ -3955,7 +3959,7 @@ describe('filterDashboardForUser — ADR-0057 D10 widget requiresService gate',
protocol.getMetaItem = vi.fn().mockResolvedValue({
type: 'dashboard', name: 'system_overview', item: dash(),
});
const rest: any = new RestServer(
const rest = new RestServer(
createMockServer() as any,
protocol,
// [#5881] `enableCache: false` is no longer what makes this reachable —
Expand All @@ -3966,14 +3970,17 @@ describe('filterDashboardForUser — ADR-0057 D10 widget requiresService gate',
// green proof the gate worked at all while the default path skipped it.
{ api: { requireAuth: false }, metadata: { enableCache: false } } as any,
);
rest.resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
rest.serviceExistsProvider = (n: string) => n !== 'org-scoping';
(rest as any).resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
(rest as any).serviceExistsProvider = (n: string) => n !== 'org-scoping';
rest.registerRoutes();
const route = rest.getRoutes().find(
(r: any) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
(r) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), header: vi.fn(), send: vi.fn() };
await route.handler({ params: { type: 'dashboard', name: 'system_overview' }, query: {}, headers: {} }, res);
await route!.handler(
httpRequestForRoute(route!, { params: { type: 'dashboard', name: 'system_overview' } }),
res,
);

const body = res.json.mock.calls.at(-1)![0];
expect(body).toMatchObject({ type: 'dashboard', name: 'system_overview' });
Expand Down Expand Up @@ -4030,18 +4037,18 @@ describe('filterDashboardForUser — ADR-0057 D10 widget requiresService gate',
};
/** Default config — no `metadata` block at all, so `enableCache` is its default. */
const defaultServer = (protocol: any) => {
const rest: any = new RestServer(createMockServer() as any, protocol, ANON_API as any);
rest.resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
rest.serviceExistsProvider = (n: string) => n !== 'org-scoping';
const rest = new RestServer(createMockServer() as any, protocol, ANON_API as any);
(rest as any).resolveExecCtx = async () => ({ userId: 'u1', systemPermissions: [] });
(rest as any).serviceExistsProvider = (n: string) => n !== 'org-scoping';
rest.registerRoutes();
return rest;
};
const readMeta = async (rest: any, type: string, name: string) => {
const readMeta = async (rest: RestServer, type: string, name: string) => {
const route = rest.getRoutes().find(
(r: any) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
(r) => r.method === 'GET' && r.path === '/api/v1/meta/:type/:name',
);
const res = { json: vi.fn(), status: vi.fn().mockReturnThis(), header: vi.fn(), send: vi.fn() };
await route.handler({ params: { type, name }, query: {}, headers: {} }, res);
await route!.handler(httpRequestForRoute(route!, { params: { type, name } }), res);
return res;
};

Expand Down
Loading