xonecas.io
70160
Ce

cel-tui / files

cel-tui / packages / components / src / ticker.test.ts

3.6 KB
1import { afterEach, describe, expect, jest, test } from "bun:test";
2import { createTicker } from "./ticker.js";
3
4describe("createTicker", () => {
5  afterEach(() => {
6    jest.useRealTimers();
7  });
8
9  test("does nothing until explicitly started", () => {
10    jest.useFakeTimers();
11    jest.setSystemTime(new Date(0));
12    const ticks: number[] = [];
13    let renders = 0;
14    const ticker = createTicker({
15      maxFps: 20,
16      onTick: ({ frame }) => ticks.push(frame),
17      requestRender: () => renders++,
18    });
19
20    jest.advanceTimersByTime(1_000);
21
22    expect(ticks).toEqual([]);
23    expect(renders).toBe(0);
24    expect(ticker.running).toBe(false);
25    ticker.dispose();
26  });
27
28  test("never schedules faster than maxFps and batches one render per tick", () => {
29    jest.useFakeTimers();
30    jest.setSystemTime(new Date(0));
31    const ticks: Array<{ frame: number; deltaMs: number; elapsedMs: number }> =
32      [];
33    let renders = 0;
34    const ticker = createTicker({
35      maxFps: 20,
36      onTick: (tick) => ticks.push(tick),
37      requestRender: () => renders++,
38    });
39
40    ticker.start();
41    jest.advanceTimersByTime(49);
42    expect(ticks).toEqual([]);
43
44    jest.advanceTimersByTime(1);
45    expect(ticks).toEqual([{ frame: 1, deltaMs: 50, elapsedMs: 50 }]);
46    expect(renders).toBe(1);
47
48    jest.advanceTimersByTime(200);
49    expect(ticks).toHaveLength(5);
50    expect(renders).toBe(5);
51    ticker.dispose();
52  });
53
54  test("start is idempotent and stop cancels pending work", () => {
55    jest.useFakeTimers();
56    jest.setSystemTime(new Date(0));
57    let ticks = 0;
58    const ticker = createTicker({
59      maxFps: 10,
60      onTick: () => ticks++,
61      requestRender: () => {},
62    });
63
64    ticker.start();
65    ticker.start();
66    expect(jest.getTimerCount()).toBe(1);
67
68    jest.advanceTimersByTime(100);
69    expect(ticks).toBe(1);
70    ticker.stop();
71    expect(ticker.running).toBe(false);
72    expect(jest.getTimerCount()).toBe(0);
73
74    jest.advanceTimersByTime(1_000);
75    expect(ticks).toBe(1);
76    ticker.dispose();
77  });
78
79  test("a callback can stop the ticker without leaving another timer", () => {
80    jest.useFakeTimers();
81    jest.setSystemTime(new Date(0));
82    let ticks = 0;
83    const ticker = createTicker({
84      maxFps: 30,
85      onTick: () => {
86        ticks++;
87        ticker.stop();
88      },
89      requestRender: () => {},
90    });
91
92    ticker.start();
93    jest.advanceTimersByTime(1_000);
94
95    expect(ticks).toBe(1);
96    expect(ticker.running).toBe(false);
97    expect(jest.getTimerCount()).toBe(0);
98    ticker.dispose();
99  });
100
101  test("dispose is idempotent and rejects later restarts", () => {
102    jest.useFakeTimers();
103    const ticker = createTicker({ maxFps: 12 });
104    ticker.start();
105
106    ticker.dispose();
107    ticker.dispose();
108
109    expect(ticker.disposed).toBe(true);
110    expect(ticker.running).toBe(false);
111    expect(jest.getTimerCount()).toBe(0);
112    expect(() => ticker.start()).toThrow("disposed");
113  });
114
115  test("stops cleanly when a callback throws", () => {
116    jest.useFakeTimers();
117    jest.setSystemTime(new Date(0));
118    const ticker = createTicker({
119      maxFps: 10,
120      onTick: () => {
121        throw new Error("tick failed");
122      },
123      requestRender: () => {},
124    });
125    ticker.start();
126
127    expect(() => jest.advanceTimersByTime(100)).toThrow("tick failed");
128    expect(ticker.running).toBe(false);
129    expect(jest.getTimerCount()).toBe(0);
130    ticker.dispose();
131  });
132
133  test("validates the rate eagerly", () => {
134    for (const maxFps of [0, -1, Number.NaN, Number.POSITIVE_INFINITY]) {
135      expect(() => createTicker({ maxFps })).toThrow("maxFps");
136    }
137  });
138});