Build ErsatzTV Image / decisions.md append-only (pull_request) Successful in 10s
Build ErsatzTV Image / Docs update reminder (pull_request) Successful in 10s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m12s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 3m4s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m17s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 10m36s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
Version every /api route to /api/v1 (251 controller routes + ~24 Location
headers + the scanner callback URL + the Startup request-log literal),
uniform across the machine API, auth, scanner and scripted-build surfaces.
Add ApiVersionRewriteMiddleware: a legacy unversioned /api/* request is
rewritten (NOT redirected) to /api/v1/* in-pipeline — method, body, auth
headers and query survive — carrying RFC 8594 Deprecation/Sunset headers,
so curl / the future MCP server / bookmarks keep working. An already-
versioned path passes through; a future /api/v2 is never forced to v1.
Standardize the route convention (leading-slash absolute route per method,
no class-[Route] — except the two Scanner/Scripted controllers whose ~all
actions share a parametrized {id} prefix), enforced by ApiRouteVersioningTests
(^/api/v\d+/ over the whole Controllers.Api surface; browser-nav
/auth/oidc/login is out of scope).
Regenerate v1.json (160 paths, all /api/v1)/endpoint-index/v1.d.ts; sweep 945
SPA request literals + the test mocks (regex + positional URL parsers). /api/v1
is additive-only after freeze; the legacy-rewrite shim sunsets in ~2 releases
(owner decision) with removal tracked as a Phase-3 follow-up.
Docs: decisions.md 2026-07-13, api-conventions §1/§9, rest-api/spa-conventions/
blazor-route-parity/e2e-local/domain-model.
fixes #286
refs #197
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
101 lines
4.0 KiB
TypeScript
101 lines
4.0 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import {
|
|
createMultiCollection,
|
|
deleteMultiCollection,
|
|
getMultiCollection,
|
|
getMultiCollections,
|
|
messageFromMultiCollectionError,
|
|
updateMultiCollection
|
|
} from './multiCollections';
|
|
import { ApiError } from './client';
|
|
|
|
function jsonResponse(body: unknown, status = 200): Response {
|
|
return new Response(JSON.stringify(body), {
|
|
headers: { 'Content-Type': 'application/json' },
|
|
status
|
|
});
|
|
}
|
|
|
|
function noContent(): Response {
|
|
return new Response(null, { status: 204 });
|
|
}
|
|
|
|
describe('multiCollections api client', () => {
|
|
beforeEach(() => {
|
|
window.localStorage.clear();
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it('getMultiCollections maps paging params into the query string', async () => {
|
|
const fetchMock = vi.spyOn(window, 'fetch').mockResolvedValue(jsonResponse({ page: [], totalCount: 0 }));
|
|
|
|
await getMultiCollections({ pageNum: 2, pageSize: 25, query: 'kids' });
|
|
|
|
const url = new URL(String(fetchMock.mock.calls[0][0]), 'http://localhost');
|
|
expect(url.pathname).toBe('/api/v1/multi-collections');
|
|
expect(url.searchParams.get('pageNum')).toBe('2');
|
|
expect(url.searchParams.get('pageSize')).toBe('25');
|
|
expect(url.searchParams.get('query')).toBe('kids');
|
|
});
|
|
|
|
it('getMultiCollections with no params hits the bare endpoint', async () => {
|
|
const fetchMock = vi.spyOn(window, 'fetch').mockResolvedValue(jsonResponse({ page: [], totalCount: 0 }));
|
|
|
|
await getMultiCollections();
|
|
|
|
expect(fetchMock).toHaveBeenCalledWith('/api/v1/multi-collections', expect.objectContaining({ method: 'GET' }));
|
|
});
|
|
|
|
it('getMultiCollection fetches a single multi-collection by id', async () => {
|
|
const fetchMock = vi
|
|
.spyOn(window, 'fetch')
|
|
.mockResolvedValue(jsonResponse({ id: 4, items: [], name: 'Bundle' }));
|
|
|
|
await expect(getMultiCollection(4)).resolves.toMatchObject({ id: 4 });
|
|
expect(fetchMock).toHaveBeenCalledWith('/api/v1/multi-collections/4', expect.objectContaining({ method: 'GET' }));
|
|
});
|
|
|
|
it('createMultiCollection POSTs the name and items', async () => {
|
|
const fetchMock = vi.spyOn(window, 'fetch').mockResolvedValue(jsonResponse({ id: 9, items: [], name: 'New' }, 201));
|
|
|
|
const body = {
|
|
items: [{ collectionId: 3, playbackOrder: 'Chronological' as const, scheduleAsGroup: true, smartCollectionId: null }],
|
|
name: 'New'
|
|
};
|
|
await expect(createMultiCollection(body)).resolves.toMatchObject({ id: 9 });
|
|
|
|
const [url, init] = fetchMock.mock.calls[0];
|
|
expect(url).toBe('/api/v1/multi-collections');
|
|
expect(init).toMatchObject({ method: 'POST' });
|
|
expect(JSON.parse(String(init?.body))).toEqual(body);
|
|
});
|
|
|
|
it('updateMultiCollection PUTs to the id route', async () => {
|
|
const fetchMock = vi.spyOn(window, 'fetch').mockResolvedValue(jsonResponse({ id: 5, items: [], name: 'Renamed' }));
|
|
|
|
const body = {
|
|
items: [{ collectionId: null, playbackOrder: 'Chronological' as const, scheduleAsGroup: false, smartCollectionId: 7 }],
|
|
name: 'Renamed'
|
|
};
|
|
await updateMultiCollection(5, body);
|
|
|
|
const [url, init] = fetchMock.mock.calls[0];
|
|
expect(url).toBe('/api/v1/multi-collections/5');
|
|
expect(init).toMatchObject({ method: 'PUT' });
|
|
expect(JSON.parse(String(init?.body))).toEqual(body);
|
|
});
|
|
|
|
it('deleteMultiCollection issues a DELETE and resolves on 204', async () => {
|
|
const fetchMock = vi.spyOn(window, 'fetch').mockResolvedValue(noContent());
|
|
|
|
await expect(deleteMultiCollection(6)).resolves.toBeUndefined();
|
|
expect(fetchMock).toHaveBeenCalledWith('/api/v1/multi-collections/6', expect.objectContaining({ method: 'DELETE' }));
|
|
});
|
|
|
|
it('messageFromMultiCollectionError narrows ApiError, Error, and unknown', () => {
|
|
expect(messageFromMultiCollectionError(new ApiError(422, { detail: 'In use', title: 'Unprocessable' }))).toBe('In use');
|
|
expect(messageFromMultiCollectionError(new Error('boom'))).toBe('boom');
|
|
expect(messageFromMultiCollectionError('nope', 'fallback')).toBe('fallback');
|
|
});
|
|
});
|