mirror of
https://github.com/yusufipk/OpenFrame.git
synced 2026-09-11 17:46:06 +00:00
test: add unit, API, component and end-to-end test suites
The repo had no automated tests. Every change was verified by hand. Adds four layers, 2023 tests in total, runnable with one command: - 1191 unit tests over the pure logic in lib/, including the full computeProjectAccess permission matrix and the billing gate - 167 component and hook tests in jsdom, covering the hooks that hold real logic rather than presentational wrappers - 647 API integration tests against a real Postgres, with only auth() mocked, including a data-driven sweep asserting that none of the 60 route modules answers 2xx to an unauthenticated caller - 18 Playwright specs driving a real browser against a real build Infrastructure: vitest.config.ts with three projects, a disposable Postgres and MinIO in docker-compose.test.yml, factories and helpers under tests/, scripts/test.sh as the single entry point, a pre-push hook running bun run verify, and CI split into check, test and e2e jobs. The test database is built with prisma db push plus a replay of the hand-written SQL, because prisma migrate deploy cannot build this schema from empty: the migration history has no captured baseline. This mirrors what scripts/docker-db-bootstrap.ts already does in production, and tests/setup/db-global.ts carries a drift guard so a new migration fails the run until someone reviews it. Production code is unchanged apart from one pure-function extraction out of use-video-player.ts, which was too large to test in jsdom. Several tests pin behaviour that looks wrong, each marked KNOWN BUG in place. TESTING.md section 12 records where the plan turned out to be wrong, and AGENTS.md now states which layer a change needs a test in.
This commit is contained in:
yusufipk
@@ -0,0 +1,194 @@
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import { renderHook, waitFor } from '@testing-library/react';
|
||||
import { useVersionDurationSync } from '@/components/video-page/hooks/use-version-duration-sync';
|
||||
import type { VideoData } from '@/components/video-page/types';
|
||||
|
||||
type Params = Parameters<typeof useVersionDurationSync>[0];
|
||||
|
||||
function makeVideo(versionDuration: number | null): VideoData {
|
||||
return {
|
||||
id: 'vid1',
|
||||
title: 'Cut 3',
|
||||
description: null,
|
||||
projectId: 'proj1',
|
||||
project: { name: 'Ad campaign', ownerId: 'user1' },
|
||||
isAuthenticated: true,
|
||||
currentUserId: 'user1',
|
||||
currentUserName: 'Ada',
|
||||
versions: [
|
||||
{
|
||||
id: 'ver1',
|
||||
versionNumber: 1,
|
||||
versionLabel: null,
|
||||
providerId: 'bunny',
|
||||
videoId: 'vid1',
|
||||
originalUrl: 'https://cdn.example.com/a.mp4',
|
||||
title: null,
|
||||
thumbnailUrl: null,
|
||||
duration: versionDuration,
|
||||
isActive: true,
|
||||
_count: { comments: 0 },
|
||||
comments: [],
|
||||
},
|
||||
{
|
||||
id: 'ver2',
|
||||
versionNumber: 2,
|
||||
versionLabel: null,
|
||||
providerId: 'bunny',
|
||||
videoId: 'vid1',
|
||||
originalUrl: 'https://cdn.example.com/b.mp4',
|
||||
title: null,
|
||||
thumbnailUrl: null,
|
||||
duration: 999,
|
||||
isActive: false,
|
||||
_count: { comments: 0 },
|
||||
comments: [],
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
function baseParams(overrides: Partial<Params> = {}): Params {
|
||||
return {
|
||||
videoDuration: 42.4,
|
||||
activeVersionDuration: null,
|
||||
activeVersionId: 'ver1',
|
||||
propProjectId: 'proj1',
|
||||
videoId: 'vid1',
|
||||
setVideo: vi.fn(),
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
/** Mirrors what React's useState does with a functional updater. */
|
||||
function makeStore(initial: VideoData | null) {
|
||||
const store: { current: VideoData | null } = { current: initial };
|
||||
const setVideo = vi.fn((updater: unknown) => {
|
||||
store.current =
|
||||
typeof updater === 'function'
|
||||
? (updater as (prev: VideoData | null) => VideoData | null)(store.current)
|
||||
: (updater as VideoData | null);
|
||||
});
|
||||
return { store, setVideo: setVideo as unknown as Params['setVideo'], spy: setVideo };
|
||||
}
|
||||
|
||||
let fetchMock: ReturnType<typeof vi.fn>;
|
||||
|
||||
beforeEach(() => {
|
||||
fetchMock = vi.fn().mockResolvedValue({ ok: true });
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllGlobals();
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('useVersionDurationSync', () => {
|
||||
it('PATCHes the measured duration, rounded, to the active version', async () => {
|
||||
renderHook(() => useVersionDurationSync(baseParams({ videoDuration: 42.4 })));
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(1));
|
||||
const [url, init] = fetchMock.mock.calls[0];
|
||||
expect(url).toBe('/api/projects/proj1/videos/vid1/versions/ver1');
|
||||
expect(init.method).toBe('PATCH');
|
||||
expect(JSON.parse(init.body as string)).toEqual({ duration: 42 });
|
||||
});
|
||||
|
||||
it('rounds to the nearest second rather than truncating', async () => {
|
||||
renderHook(() => useVersionDurationSync(baseParams({ videoDuration: 42.6 })));
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(1));
|
||||
expect(JSON.parse(fetchMock.mock.calls[0][1].body as string)).toEqual({ duration: 43 });
|
||||
});
|
||||
|
||||
it('writes the rounded duration onto the active version only', async () => {
|
||||
const { store, setVideo, spy } = makeStore(makeVideo(null));
|
||||
|
||||
renderHook(() => useVersionDurationSync(baseParams({ videoDuration: 42.4, setVideo })));
|
||||
|
||||
await waitFor(() => expect(spy).toHaveBeenCalledTimes(1));
|
||||
expect(store.current?.versions[0].duration).toBe(42);
|
||||
expect(store.current?.versions[1].duration).toBe(999);
|
||||
});
|
||||
|
||||
it('leaves state null when the video has not loaded yet', async () => {
|
||||
const { store, setVideo, spy } = makeStore(null);
|
||||
|
||||
renderHook(() => useVersionDurationSync(baseParams({ setVideo })));
|
||||
|
||||
await waitFor(() => expect(spy).toHaveBeenCalledTimes(1));
|
||||
expect(store.current).toBeNull();
|
||||
});
|
||||
|
||||
it('does nothing until a duration has been measured', () => {
|
||||
const setVideo = vi.fn();
|
||||
renderHook(() => useVersionDurationSync(baseParams({ videoDuration: 0, setVideo })));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
expect(setVideo).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does nothing without an active version', () => {
|
||||
const setVideo = vi.fn();
|
||||
renderHook(() => useVersionDurationSync(baseParams({ activeVersionId: null, setVideo })));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
expect(setVideo).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does nothing on a share page, where there is no project id', () => {
|
||||
const setVideo = vi.fn();
|
||||
renderHook(() => useVersionDurationSync(baseParams({ propProjectId: undefined, setVideo })));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
expect(setVideo).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('skips the write when the version already has a stored duration', () => {
|
||||
const setVideo = vi.fn();
|
||||
renderHook(() => useVersionDurationSync(baseParams({ activeVersionDuration: 41, setVideo })));
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
expect(setVideo).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('treats a stored duration of 0 as missing and backfills it', async () => {
|
||||
renderHook(() => useVersionDurationSync(baseParams({ activeVersionDuration: 0 })));
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(1));
|
||||
});
|
||||
|
||||
it('still updates local state when the PATCH fails', async () => {
|
||||
fetchMock.mockRejectedValue(new Error('offline'));
|
||||
const { store, setVideo, spy } = makeStore(makeVideo(null));
|
||||
|
||||
renderHook(() => useVersionDurationSync(baseParams({ setVideo })));
|
||||
|
||||
await waitFor(() => expect(spy).toHaveBeenCalledTimes(1));
|
||||
expect(store.current?.versions[0].duration).toBe(42);
|
||||
});
|
||||
|
||||
it('writes once per measurement, not on every re-render', async () => {
|
||||
const params = baseParams();
|
||||
const { rerender } = renderHook(() => useVersionDurationSync(params));
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(1));
|
||||
rerender();
|
||||
rerender();
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('writes again when the active version changes', async () => {
|
||||
const setVideo = vi.fn();
|
||||
const { rerender } = renderHook((props: Params) => useVersionDurationSync(props), {
|
||||
initialProps: baseParams({ setVideo }),
|
||||
});
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(1));
|
||||
rerender(baseParams({ activeVersionId: 'ver2', setVideo }));
|
||||
|
||||
await waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(2));
|
||||
expect(fetchMock.mock.calls[1][0]).toBe('/api/projects/proj1/videos/vid1/versions/ver2');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user