Files
ersatztv/web/src/api/channels.test.ts
T
timothyandClaude Opus 4.8 ef2bd65c27
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
feat(api): #286 — mount the whole /api surface at /api/v1
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>
2026-07-13 00:30:20 +02:00

167 lines
4.9 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from 'vitest';
import {
createChannel,
getChannelById,
getChannelStreamSelectors,
getMusicVideoCreditsTemplates,
updateChannel,
type CreateChannelRequest,
type UpdateChannelRequest
} from './channels';
const sampleChannel = {
id: 5,
number: '5',
name: 'Cartoons',
group: 'ChicoryTV',
categories: '',
ffmpegProfileId: 1,
slugSeconds: null,
logo: { path: '', contentType: '' },
streamSelectorMode: 'Default',
streamSelector: null,
preferredAudioLanguageCode: null,
preferredAudioTitle: null,
playoutSource: 'Generated',
playoutMode: 'Continuous',
mirrorSourceChannelId: null,
playoutOffset: null,
streamingMode: 'TransportStreamHybrid',
watermarkId: null,
fallbackFillerId: null,
playoutCount: 0,
preferredSubtitleLanguageCode: null,
subtitleMode: 'None',
musicVideoCreditsMode: 'None',
musicVideoCreditsTemplate: null,
songVideoMode: 'Default',
transcodeMode: 'OnDemand',
idleBehavior: 'StopOnDisconnect',
isEnabled: true,
showInEpg: true
};
describe('getChannelById', () => {
beforeEach(() => {
window.localStorage.clear();
vi.restoreAllMocks();
});
it('GETs the channel by id and returns the view model', async () => {
const fetchSpy = vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify(sampleChannel), {
headers: { 'Content-Type': 'application/json' },
status: 200
})
);
await expect(getChannelById(5)).resolves.toMatchObject({ id: 5, name: 'Cartoons' });
const [url, init] = fetchSpy.mock.calls[0];
expect(url).toBe('/api/v1/channels/5');
expect((init?.method ?? 'GET').toUpperCase()).toBe('GET');
});
it('rejects with the ApiError status on 404', async () => {
vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify({ status: 404, title: 'Not Found' }), {
headers: { 'Content-Type': 'application/json' },
status: 404
})
);
await expect(getChannelById(999)).rejects.toMatchObject({ status: 404 });
});
});
describe('updateChannel', () => {
beforeEach(() => {
window.localStorage.clear();
vi.restoreAllMocks();
});
it('PUTs the request body to the channel id and returns the updated view model', async () => {
const fetchSpy = vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify({ ...sampleChannel, name: 'Renamed' }), {
headers: { 'Content-Type': 'application/json' },
status: 200
})
);
const body = { ...sampleChannel, name: 'Renamed' } as unknown as UpdateChannelRequest;
await expect(updateChannel(5, body)).resolves.toMatchObject({ name: 'Renamed' });
const [url, init] = fetchSpy.mock.calls[0];
expect(url).toBe('/api/v1/channels/5');
expect((init?.method ?? '').toUpperCase()).toBe('PUT');
expect(JSON.parse(init?.body as string)).toMatchObject({ name: 'Renamed', number: '5' });
});
});
describe('createChannel', () => {
beforeEach(() => {
window.localStorage.clear();
vi.restoreAllMocks();
});
it('POSTs the request body to /api/v1/channels and returns the created view model', async () => {
const fetchSpy = vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify(sampleChannel), {
headers: { 'Content-Type': 'application/json' },
status: 200
})
);
const body = { ...sampleChannel, id: undefined } as unknown as CreateChannelRequest;
await expect(createChannel(body)).resolves.toMatchObject({ id: 5 });
const [url, init] = fetchSpy.mock.calls[0];
expect(url).toBe('/api/v1/channels');
expect((init?.method ?? '').toUpperCase()).toBe('POST');
});
});
describe('getMusicVideoCreditsTemplates', () => {
beforeEach(() => {
window.localStorage.clear();
vi.restoreAllMocks();
});
it('GETs /api/v1/channels/music-video-credits-templates', async () => {
const fetchSpy = vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify(['default']), {
headers: { 'Content-Type': 'application/json' },
status: 200
})
);
await expect(getMusicVideoCreditsTemplates()).resolves.toEqual(['default']);
const [url] = fetchSpy.mock.calls[0];
expect(url).toBe('/api/v1/channels/music-video-credits-templates');
});
});
describe('getChannelStreamSelectors', () => {
beforeEach(() => {
window.localStorage.clear();
vi.restoreAllMocks();
});
it('GETs /api/v1/channels/stream-selectors', async () => {
const fetchSpy = vi.spyOn(window, 'fetch').mockResolvedValue(
new Response(JSON.stringify(['selector.py']), {
headers: { 'Content-Type': 'application/json' },
status: 200
})
);
await expect(getChannelStreamSelectors()).resolves.toEqual(['selector.py']);
const [url] = fetchSpy.mock.calls[0];
expect(url).toBe('/api/v1/channels/stream-selectors');
});
});