StreamOverlayBuilder.test.tsx 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  1. /**
  2. * Tests for the streaming-overlay URL builder (#1422).
  3. *
  4. * The builder's whole output is a URL, so that is what these assert: the field
  5. * order, what is omitted at its default, and that the preview does not open a
  6. * camera stream until it is asked to.
  7. */
  8. import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
  9. import { screen, waitFor, fireEvent, act, within } from '@testing-library/react';
  10. import userEvent from '@testing-library/user-event';
  11. import { http, HttpResponse } from 'msw';
  12. import { render } from '../utils';
  13. import { server } from '../mocks/server';
  14. import { setAuthToken } from '../../api/client';
  15. import { StreamOverlayBuilder } from '../../components/StreamOverlayBuilder';
  16. const printers = [
  17. { id: 1, name: 'X1 Carbon', ip_address: '192.168.1.100', serial_number: '00M09A350100001', model: 'X1C' },
  18. { id: 2, name: 'P1S', ip_address: '192.168.1.101', serial_number: '01P00A000000002', model: 'P1S' },
  19. ];
  20. const createdToken = {
  21. id: 42, user_id: 1, name: 'OBS', scope: 'overlay', lookup_prefix: '12345678',
  22. created_at: '2026-01-01T00:00:00Z', expires_at: '2099-01-01T00:00:00Z',
  23. last_used_at: null, token: null,
  24. };
  25. function setupSignedIn() {
  26. setAuthToken('test-login');
  27. server.use(http.get('*/api/v1/auth/status', () => HttpResponse.json({ auth_enabled: true, requires_setup: false })));
  28. }
  29. // The URL is rendered inside a <code>, so read it back the way a user would.
  30. function shownUrl(): string {
  31. const code = document.querySelector('code');
  32. return code?.textContent ?? '';
  33. }
  34. describe('StreamOverlayBuilder', () => {
  35. afterEach(() => { setAuthToken(null); vi.restoreAllMocks(); vi.unstubAllGlobals(); });
  36. beforeEach(() => {
  37. server.use(http.get('/api/v1/printers', () => HttpResponse.json(printers)), http.get('/api/v1/settings/overlay-logo', () => new HttpResponse(null, { status: 404 })));
  38. });
  39. it.each(['1', '2'])('provides independent orientation URLs and previews for artwork %s', async (artwork) => {
  40. const user = userEvent.setup();
  41. const copy = vi.spyOn(navigator.clipboard, 'writeText').mockResolvedValue();
  42. vi.stubGlobal('isSecureContext', true);
  43. const { unmount } = render(<StreamOverlayBuilder />);
  44. await screen.findByRole('option', { name: 'P1S' });
  45. await user.selectOptions(screen.getByLabelText('Artwork'), artwork);
  46. const layout = screen.getByLabelText('Layout');
  47. expect(layout).toHaveValue('landscape');
  48. await user.selectOptions(layout, 'both');
  49. fireEvent.change(screen.getByLabelText('From colour (hex)'), { target: { value: '#ff0000' } });
  50. fireEvent.change(screen.getByLabelText('To colour (hex)'), { target: { value: '#0000ff' } });
  51. if (artwork === '2') fireEvent.change(screen.getByRole('slider', { name: /Background transparency/ }), { target: { value: '65' } });
  52. expect(document.querySelectorAll('iframe')).toHaveLength(0);
  53. await user.selectOptions(screen.getByLabelText('Printer'), '2');
  54. await user.type(screen.getByLabelText(/token/i), 'bblt_example');
  55. await user.selectOptions(screen.getByLabelText('Text size'), 'large');
  56. await user.click(screen.getByLabelText('Nozzle'));
  57. await user.click(screen.getByLabelText('Camera feed'));
  58. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  59. for (const orientation of ['Landscape', 'Portrait']) {
  60. const group = within(screen.getByRole('group', { name: `${orientation} URL` }));
  61. const url = new URL(group.getByRole('link', { name: 'Open' }).getAttribute('href') ?? '');
  62. expect(url.pathname).toBe('/overlay/2');
  63. expect(url.searchParams.get('progressFrom')).toBe('#ff0000');
  64. expect(url.searchParams.get('progressTo')).toBe('#0000ff');
  65. expect(url.searchParams.get('backgroundTransparency')).toBe(artwork === '2' ? '65' : null);
  66. expect(url.searchParams.get('layout')).toBe(orientation === 'Portrait' ? 'portrait' : null);
  67. expect(url.searchParams.get('token')).toBe('bblt_example');
  68. expect(group.getByText(/token=\*\*\*\*/)).not.toHaveTextContent('bblt_example');
  69. expect(url.searchParams.get('size')).toBe('large');
  70. expect(url.searchParams.get('camera')).toBe('false');
  71. expect(url.searchParams.get('show')).toContain('nozzle');
  72. expect(url.searchParams.get('artwork')).toBe(artwork === '2' ? '2' : null);
  73. await waitFor(() => expect(screen.getByTitle(`${orientation} preview`)).toHaveAttribute('src', url.href));
  74. await user.click(group.getByRole('button', { name: 'Copy' }));
  75. expect(copy).toHaveBeenLastCalledWith(url.href);
  76. }
  77. await user.click(screen.getByLabelText('Camera feed'));
  78. await user.selectOptions(screen.getByLabelText('Text size'), 'small');
  79. const fps = screen.getByLabelText('Frame rate');
  80. await user.clear(fps);
  81. await user.type(fps, '5');
  82. await waitFor(() => {
  83. for (const iframe of document.querySelectorAll('iframe')) {
  84. const params = new URL(iframe.src).searchParams;
  85. expect(params.get('camera')).toBeNull();
  86. expect(params.get('size')).toBe('small');
  87. expect(params.get('fps')).toBe('5');
  88. }
  89. });
  90. await user.selectOptions(layout, 'portrait');
  91. expect(document.querySelectorAll('iframe')).toHaveLength(1);
  92. expect(screen.queryByTitle('Landscape preview')).not.toBeInTheDocument();
  93. await user.click(screen.getByRole('button', { name: 'Hide preview' }));
  94. expect(document.querySelectorAll('iframe')).toHaveLength(0);
  95. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  96. unmount();
  97. expect(document.querySelectorAll('iframe')).toHaveLength(0);
  98. copy.mockRestore();
  99. vi.unstubAllGlobals();
  100. });
  101. it('imports portrait sources and resets to landscape when layout is absent', async () => {
  102. const user = userEvent.setup();
  103. render(<StreamOverlayBuilder />);
  104. await screen.findByRole('option', { name: 'P1S' });
  105. const input = screen.getByLabelText('Existing overlay URL');
  106. await user.type(input, 'https://obs.local/overlay/2?layout=portrait&token=bblt_portrait');
  107. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  108. expect(screen.getByLabelText('Layout')).toHaveValue('portrait');
  109. expect(new URL(shownUrl()).searchParams.get('layout')).toBe('portrait');
  110. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  111. expect(new URL(screen.getByTitle('Portrait preview').getAttribute('src')!).searchParams.get('token')).toBe('bblt_portrait');
  112. await user.type(input, 'https://obs.local/overlay/1?token=bblt_landscape');
  113. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  114. expect(screen.getByLabelText('Layout')).toHaveValue('landscape');
  115. expect(new URL(shownUrl()).searchParams.has('layout')).toBe(false);
  116. expect(screen.queryByTitle('Portrait preview')).not.toBeInTheDocument();
  117. });
  118. it('accepts an existing raw token without requiring saved-token recovery', async () => {
  119. const user = userEvent.setup();
  120. const view = render(<StreamOverlayBuilder />);
  121. await screen.findByRole('option', { name: 'P1S' });
  122. const manual = screen.getByLabelText('Manual token');
  123. expect(manual).toHaveAttribute('type', 'password');
  124. await user.type(manual, 'bblt_existing');
  125. expect(shownUrl()).not.toContain('bblt_existing');
  126. expect(shownUrl()).toContain('token=****');
  127. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  128. expect(new URL(screen.getByTitle('Landscape preview').getAttribute('src')!).searchParams.get('token')).toBe('bblt_existing');
  129. await user.click(screen.getByRole('button', { name: 'Show token' }));
  130. expect(manual).toHaveAttribute('type', 'text');
  131. expect(shownUrl()).toContain('token=bblt_existing');
  132. view.unmount();
  133. render(<StreamOverlayBuilder />);
  134. expect(screen.getByLabelText('Manual token')).toHaveValue('');
  135. expect(shownUrl()).not.toContain('bblt_existing');
  136. });
  137. it('imports locally, masks credentials, restores settings and keeps the current origin', async () => {
  138. const user = userEvent.setup();
  139. const storageWrites = vi.spyOn(Storage.prototype, 'setItem');
  140. render(<StreamOverlayBuilder />);
  141. await screen.findByRole('option', { name: 'P1S' });
  142. const input = screen.getByLabelText('Existing overlay URL');
  143. expect(input).toHaveAttribute('type', 'password');
  144. // Chrome ignores autocomplete="off" on password fields and could fill the
  145. // login password in; new-password keeps both secret fields unfilled.
  146. expect(input).toHaveAttribute('autocomplete', 'new-password');
  147. expect(screen.getByLabelText('Manual token')).toHaveAttribute('autocomplete', 'new-password');
  148. await user.type(input, 'https://other.example/overlay/2?token=bblt_imported&show=nozzle,status&size=large&fps=5&artwork=2&camera=false');
  149. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  150. expect(input).toHaveValue('');
  151. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_imported');
  152. expect(shownUrl()).not.toContain('bblt_imported');
  153. expect(new URL(shownUrl()).origin).toBe(window.location.origin);
  154. expect(screen.getByLabelText('Printer')).toHaveValue('2');
  155. expect(screen.getByLabelText('Text size')).toHaveValue('large');
  156. expect(screen.getByLabelText('Artwork')).toHaveValue('2');
  157. expect(screen.getByLabelText('Camera feed')).not.toBeChecked();
  158. expect(new URL(shownUrl()).searchParams.get('show')).toBe('status,nozzle');
  159. expect(new URL(shownUrl()).searchParams.get('fps')).toBe('5');
  160. expect(document.querySelector('iframe')).toBeNull();
  161. expect(storageWrites).not.toHaveBeenCalledWith(expect.anything(), expect.stringContaining('bblt_imported'));
  162. await user.type(input, 'http://old.example/overlay/1');
  163. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  164. expect(screen.getByLabelText('Manual token')).toHaveValue('');
  165. expect(screen.getByLabelText('Text size')).toHaveValue('medium');
  166. expect(screen.getByLabelText('Artwork')).toHaveValue('1');
  167. expect(screen.getByLabelText('Camera feed')).toBeChecked();
  168. expect(new URL(shownUrl()).searchParams.has('fps')).toBe(false);
  169. });
  170. it.each([
  171. 'javascript:alert(1)', 'https://example.com/overlay/nope',
  172. 'https://example.com/overlay/0', 'https://example.com/overlay/9007199254740992',
  173. 'https://user:password@example.com/overlay/2',
  174. 'https://example.com/overlay/2?token=a&token=b',
  175. ])('rejects invalid or unsupported imports without changing settings: %s', async (value) => {
  176. const user = userEvent.setup();
  177. render(<StreamOverlayBuilder />);
  178. await screen.findByRole('option', { name: 'P1S' });
  179. await user.type(screen.getByLabelText('Manual token'), 'bblt_keep');
  180. const original = shownUrl();
  181. await user.type(screen.getByLabelText('Existing overlay URL'), value);
  182. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  183. expect(screen.getByRole('alert')).toBeInTheDocument();
  184. expect(shownUrl()).toBe(original);
  185. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_keep');
  186. });
  187. it.each([
  188. ['999', '30'], ['0', '1'], ['-5', '1'], ['5.9', '5'], ['20fps', '20'], ['bad', null], ['', null],
  189. ])('imports fps=%s with runtime clamping and ignores unknown configuration', async (fps, expected) => {
  190. const user = userEvent.setup();
  191. render(<StreamOverlayBuilder />);
  192. await screen.findByRole('option', { name: 'P1S' });
  193. fireEvent.change(screen.getByLabelText('Existing overlay URL'), { target: { value:
  194. `https://other.example/overlay/2?fps=${fps}&show=status,unknown&size=huge&unrelated=ignored` } });
  195. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  196. expect(screen.queryByRole('alert')).not.toBeInTheDocument();
  197. const url = new URL(shownUrl());
  198. expect(url.searchParams.get('fps')).toBe(expected);
  199. expect(url.searchParams.get('show')).toBe('status');
  200. expect(screen.getByLabelText('Text size')).toHaveValue('medium');
  201. expect(url.searchParams.has('unrelated')).toBe(false);
  202. });
  203. it('ignores a fragment, as the overlay page does', async () => {
  204. const user = userEvent.setup();
  205. render(<StreamOverlayBuilder />);
  206. await screen.findByRole('option', { name: 'P1S' });
  207. fireEvent.change(screen.getByLabelText('Existing overlay URL'), { target: { value:
  208. 'https://other.example/overlay/2?token=bblt_fragment&size=large#scene' } });
  209. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  210. expect(screen.queryByRole('alert')).not.toBeInTheDocument();
  211. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_fragment');
  212. expect(screen.getByLabelText('Text size')).toHaveValue('large');
  213. expect(new URL(shownUrl()).hash).toBe('');
  214. });
  215. it('imports branding and transparency and resets missing values on the next import', async () => {
  216. const user = userEvent.setup();
  217. render(<StreamOverlayBuilder />);
  218. await screen.findByRole('option', { name: 'P1S' });
  219. fireEvent.change(screen.getByLabelText('Existing overlay URL'), { target: { value:
  220. 'https://other.example/overlay/2?artwork=2&backgroundTransparency=150&logo=1&progressFrom=%23aabbcc&progressTo=%23112233' } });
  221. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  222. const params = new URL(shownUrl()).searchParams;
  223. expect(params.get('backgroundTransparency')).toBe('100');
  224. expect(params.get('logo')).toBe('1');
  225. expect(params.get('progressFrom')).toBe('#aabbcc');
  226. expect(params.get('progressTo')).toBe('#112233');
  227. expect(screen.getByLabelText('From colour (hex)')).toHaveValue('#aabbcc');
  228. expect(screen.getByLabelText('To colour (hex)')).toHaveValue('#112233');
  229. fireEvent.change(screen.getByLabelText('Existing overlay URL'), { target: { value:
  230. 'https://other.example/overlay/2?artwork=2&progressFrom=invalid&progressTo=%23112233' } });
  231. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  232. expect(shownUrl()).not.toMatch(/backgroundTransparency|logo=|progressFrom|progressTo/);
  233. expect(screen.getByLabelText('From colour (hex)')).toHaveValue('#00ae42');
  234. });
  235. it('locks import during a logo upload so its completion cannot overwrite imported branding', async () => {
  236. let finish = () => {};
  237. const gate = new Promise<void>((resolve) => { finish = resolve; });
  238. let started = false;
  239. server.use(http.post('/api/v1/settings/overlay-logo', async () => {
  240. started = true;
  241. await gate;
  242. return HttpResponse.json({ status: 'ok' });
  243. }));
  244. const user = userEvent.setup();
  245. render(<StreamOverlayBuilder />);
  246. fireEvent.change(screen.getByLabelText('Existing overlay URL'), { target: { value:
  247. 'https://other.example/overlay/2?progressFrom=%23aabbcc&progressTo=%23112233' } });
  248. expect(screen.getByRole('button', { name: 'Import URL' })).toBeEnabled();
  249. await user.upload(screen.getByLabelText('Upload logo'), new File(['png'], 'logo.png', { type: 'image/png' }));
  250. await waitFor(() => expect(started).toBe(true));
  251. expect(screen.getByLabelText('Existing overlay URL')).toBeDisabled();
  252. expect(screen.getByRole('button', { name: 'Import URL' })).toBeDisabled();
  253. await act(async () => { finish(); await gate; });
  254. await waitFor(() => expect(screen.getByRole('button', { name: 'Import URL' })).toBeEnabled());
  255. await user.click(screen.getByRole('button', { name: 'Import URL' }));
  256. expect(new URL(shownUrl()).searchParams.has('logo')).toBe(false);
  257. expect(new URL(shownUrl()).searchParams.get('progressFrom')).toBe('#aabbcc');
  258. expect(screen.getByLabelText('From colour (hex)')).toHaveValue('#aabbcc');
  259. });
  260. it('shows a server creation error, unlocks controls, and allows successful repeated creation', async () => {
  261. setupSignedIn();
  262. server.use(http.post('*/api/v1/auth/tokens', () => HttpResponse.json({ detail: 'Token limit reached' }, { status: 400 })));
  263. const user = userEvent.setup();
  264. render(<StreamOverlayBuilder />);
  265. await user.click(await screen.findByRole('button', { name: 'Create overlay token' }));
  266. await user.type(screen.getByLabelText('Token name'), 'OBS');
  267. await user.click(screen.getByRole('button', { name: 'Create', exact: true }));
  268. expect(await screen.findByText('Token limit reached')).toBeInTheDocument();
  269. expect(screen.getByRole('button', { name: 'Cancel' })).toBeEnabled();
  270. expect(screen.getByLabelText('Manual token')).toBeEnabled();
  271. expect(screen.getByLabelText('Existing overlay URL')).toBeEnabled();
  272. server.use(http.post('*/api/v1/auth/tokens', () => HttpResponse.json({ ...createdToken, token: 'bblt_retry' }, { status: 201 })));
  273. await user.click(screen.getByRole('button', { name: 'Create', exact: true }));
  274. await waitFor(() => expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_retry'));
  275. await user.click(screen.getByRole('button', { name: 'Create overlay token' }));
  276. await user.type(screen.getByLabelText('Token name'), 'OBS again');
  277. server.use(http.post('*/api/v1/auth/tokens', () => HttpResponse.json({ ...createdToken, token: 'bblt_second' }, { status: 201 })));
  278. await user.click(screen.getByRole('button', { name: 'Create', exact: true }));
  279. await waitFor(() => expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_second'));
  280. });
  281. it('starts on the first printer with the overlay defaults', async () => {
  282. render(<StreamOverlayBuilder />);
  283. await waitFor(() => {
  284. expect(shownUrl()).toContain('/overlay/1');
  285. });
  286. // The same set parseConfig() defaults to, so the builder's starting point
  287. // and a bare /overlay/1 render the same overlay. Emitted in the overlay's
  288. // own top-to-bottom field order rather than parseConfig's listing order —
  289. // ?show= is read with includes(), so order is free to be the stable one.
  290. expect(shownUrl()).toContain('show=filename%2Cstatus%2Cprogress%2Clayers%2Ceta');
  291. // Defaults are omitted rather than spelled out — a shorter URL to paste.
  292. expect(shownUrl()).not.toContain('layout=');
  293. expect(shownUrl()).not.toContain('size=');
  294. expect(shownUrl()).not.toContain('fps=');
  295. expect(shownUrl()).not.toContain('camera=');
  296. expect(shownUrl()).not.toContain('token=');
  297. });
  298. it('keeps the model opt-in and updates the URL and preview when toggled', async () => {
  299. const user = userEvent.setup();
  300. render(<StreamOverlayBuilder />);
  301. const model = await screen.findByLabelText('Printer model');
  302. expect(model).not.toBeChecked();
  303. const originalUrl = shownUrl();
  304. await user.click(model);
  305. expect(new URL(shownUrl()).searchParams.get('show')).toBe('model,filename,status,progress,layers,eta');
  306. await user.click(screen.getByLabelText('Printer name'));
  307. expect(new URL(shownUrl()).searchParams.get('show')).toBe('printer,model,filename,status,progress,layers,eta');
  308. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  309. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl()));
  310. await user.click(model);
  311. await user.click(screen.getByLabelText('Printer name'));
  312. expect(shownUrl()).toBe(originalUrl);
  313. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', originalUrl));
  314. });
  315. it('opts into artwork in the URL and preview and restores the original URL', async () => {
  316. const user = userEvent.setup();
  317. render(<StreamOverlayBuilder />);
  318. const artwork = await screen.findByLabelText('Artwork');
  319. expect(artwork).toHaveValue('1');
  320. const original = shownUrl();
  321. expect(new URL(original).searchParams.has('artwork')).toBe(false);
  322. await user.selectOptions(artwork, 'Version 2');
  323. expect(new URL(shownUrl()).searchParams.get('artwork')).toBe('2');
  324. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  325. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl()));
  326. await user.selectOptions(artwork, 'Classic');
  327. expect(shownUrl()).toBe(original);
  328. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', original));
  329. });
  330. it('only offers background transparency for Version 2 and preserves its selection', async () => {
  331. const user = userEvent.setup();
  332. render(<StreamOverlayBuilder />);
  333. const artwork = await screen.findByLabelText('Artwork');
  334. expect(screen.queryByRole('slider', { name: /Background transparency/ })).not.toBeInTheDocument();
  335. await user.selectOptions(artwork, 'Version 2');
  336. const slider = screen.getByRole('slider', { name: /Background transparency/ });
  337. expect(slider).toHaveValue('0');
  338. expect(shownUrl()).not.toContain('backgroundTransparency');
  339. fireEvent.change(slider, { target: { value: '65' } });
  340. expect(new URL(shownUrl()).searchParams.get('backgroundTransparency')).toBe('65');
  341. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  342. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl()));
  343. await user.selectOptions(artwork, 'Classic');
  344. expect(screen.queryByRole('slider', { name: /Background transparency/ })).not.toBeInTheDocument();
  345. expect(shownUrl()).not.toContain('backgroundTransparency');
  346. await user.selectOptions(artwork, 'Version 2');
  347. expect(screen.getByRole('slider', { name: /Background transparency/ })).toHaveValue('65');
  348. });
  349. it('switches printer', async () => {
  350. const user = userEvent.setup();
  351. render(<StreamOverlayBuilder />);
  352. await screen.findByRole('option', { name: 'P1S' });
  353. await user.selectOptions(screen.getByLabelText('Printer'), '2');
  354. await waitFor(() => expect(shownUrl()).toContain('/overlay/2'));
  355. });
  356. it('adds a temperature field the URL did not have', async () => {
  357. const user = userEvent.setup();
  358. render(<StreamOverlayBuilder />);
  359. await waitFor(() => expect(screen.getByLabelText('Nozzle')).toBeInTheDocument());
  360. await user.click(screen.getByLabelText('Nozzle'));
  361. await waitFor(() =>
  362. expect(shownUrl()).toContain('show=filename%2Cstatus%2Cprogress%2Clayers%2Ceta%2Cnozzle'),
  363. );
  364. });
  365. it('emits fields in the overlay order, not the order they were clicked', async () => {
  366. const user = userEvent.setup();
  367. render(<StreamOverlayBuilder />);
  368. // "Printer name" is first in the overlay's own top-to-bottom order, so
  369. // ticking it last must still put it at the front. Otherwise the same
  370. // selection would produce a different URL depending on click order, and a
  371. // scene file would stop being comparable to the one next to it.
  372. await waitFor(() => expect(screen.getByLabelText('Printer name')).toBeInTheDocument());
  373. await user.click(screen.getByLabelText('Printer name'));
  374. await waitFor(() => expect(shownUrl()).toContain('show=printer%2Cfilename'));
  375. });
  376. it('drops a field when its box is cleared', async () => {
  377. const user = userEvent.setup();
  378. render(<StreamOverlayBuilder />);
  379. await waitFor(() => expect(screen.getByLabelText('Layer count')).toBeInTheDocument());
  380. await user.click(screen.getByLabelText('Layer count'));
  381. await waitFor(() => expect(shownUrl()).not.toContain('layers'));
  382. expect(shownUrl()).toContain('progress');
  383. });
  384. it('emits camera=false when the camera feed is switched off', async () => {
  385. const user = userEvent.setup();
  386. render(<StreamOverlayBuilder />);
  387. await waitFor(() => expect(screen.getByLabelText('Camera feed')).toBeInTheDocument());
  388. await user.click(screen.getByLabelText('Camera feed'));
  389. await waitFor(() => expect(shownUrl()).toContain('camera=false'));
  390. });
  391. it('emits size and fps only when they differ from the defaults', async () => {
  392. const user = userEvent.setup();
  393. render(<StreamOverlayBuilder />);
  394. await waitFor(() => expect(screen.getByLabelText('Text size')).toBeInTheDocument());
  395. await user.selectOptions(screen.getByLabelText('Text size'), 'large');
  396. await waitFor(() => expect(shownUrl()).toContain('size=large'));
  397. await user.selectOptions(screen.getByLabelText('Text size'), 'medium');
  398. await waitFor(() => expect(shownUrl()).not.toContain('size='));
  399. });
  400. it('uses a newly created overlay token directly without retrieval', async () => {
  401. setupSignedIn();
  402. server.use(
  403. http.post('*/api/v1/auth/tokens', async ({ request }) => {
  404. expect(await request.json()).toEqual({ name: 'OBS', scope: 'overlay', expires_in_days: 90 });
  405. return HttpResponse.json({ ...createdToken, token: 'bblt_saved' }, { status: 201 });
  406. }),
  407. );
  408. const user = userEvent.setup();
  409. render(<StreamOverlayBuilder />);
  410. await user.click(await screen.findByRole('button', { name: 'Create overlay token' }));
  411. await user.selectOptions(screen.getByLabelText('Printer'), '2');
  412. await user.type(screen.getByLabelText('Token name'), 'OBS');
  413. expect(screen.getByLabelText('Scope')).toBeDisabled();
  414. await user.click(screen.getByRole('button', { name: 'Create', exact: true }));
  415. await screen.findByText(/This URL contains a token/);
  416. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_saved');
  417. await user.click(screen.getByRole('button', { name: 'Show token' }));
  418. expect(shownUrl()).toContain('/overlay/2?');
  419. expect(shownUrl()).toContain('token=bblt_saved');
  420. });
  421. it('locks conflicting controls until a delayed token is available', async () => {
  422. setupSignedIn();
  423. let finish = () => {};
  424. const gate = new Promise<void>((resolve) => { finish = resolve; });
  425. let started = false;
  426. server.use(http.post('*/api/v1/auth/tokens', async () => {
  427. started = true;
  428. await gate;
  429. return HttpResponse.json({ ...createdToken, token: 'bblt_late' }, { status: 201 });
  430. }));
  431. const user = userEvent.setup();
  432. render(<StreamOverlayBuilder />);
  433. await user.click(await screen.findByRole('button', { name: 'Create overlay token' }));
  434. await user.type(screen.getByLabelText('Existing overlay URL'), 'https://other.example/overlay/2?token=bblt_import');
  435. expect(screen.getByRole('button', { name: 'Import URL' })).toBeEnabled();
  436. await user.type(screen.getByLabelText('Token name'), 'OBS');
  437. await user.click(screen.getByRole('button', { name: 'Create', exact: true }));
  438. await waitFor(() => expect(started).toBe(true));
  439. expect(screen.getByRole('button', { name: 'Cancel' })).toBeDisabled();
  440. expect(screen.getByLabelText('Manual token')).toBeDisabled();
  441. expect(screen.getByLabelText('Existing overlay URL')).toBeDisabled();
  442. expect(screen.getByRole('button', { name: 'Import URL' })).toBeDisabled();
  443. await act(async () => { finish(); await gate; });
  444. await screen.findByText('Token created');
  445. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_late');
  446. expect(screen.getByLabelText('Manual token')).toBeEnabled();
  447. expect(screen.getByLabelText('Existing overlay URL')).toBeEnabled();
  448. await user.click(screen.getByRole('button', { name: 'Show token' }));
  449. expect(shownUrl()).toContain('token=bblt_late');
  450. await user.click(screen.getByRole('button', { name: 'Create overlay token' }));
  451. await user.click(screen.getByRole('button', { name: 'Cancel' }));
  452. expect(screen.getByLabelText('Manual token')).toHaveValue('bblt_late');
  453. });
  454. it('does not offer token creation without a signed-in user', async () => {
  455. render(<StreamOverlayBuilder />);
  456. await screen.findByRole('option', { name: 'P1S' });
  457. expect(screen.queryByRole('button', { name: 'Create overlay token' })).not.toBeInTheDocument();
  458. });
  459. it.each([true, false])('copies the full masked URL with secure context = %s', async (secure) => {
  460. setupSignedIn();
  461. const user = userEvent.setup();
  462. vi.stubGlobal('isSecureContext', secure);
  463. let copied = '';
  464. if (secure) {
  465. vi.spyOn(navigator.clipboard, 'writeText').mockImplementation(async (value) => { copied = value; });
  466. } else {
  467. Object.defineProperty(document, 'execCommand', { configurable: true, value: () => {
  468. copied = document.querySelector('textarea')?.value ?? '';
  469. return true;
  470. } });
  471. }
  472. render(<StreamOverlayBuilder />);
  473. await user.type(screen.getByLabelText('Manual token'), 'bblt_saved');
  474. await screen.findByText(/This URL contains a token/);
  475. await user.click(screen.getByRole('button', { name: 'Copy', exact: true }));
  476. expect(new URL(copied).searchParams.get('token')).toBe('bblt_saved');
  477. expect(shownUrl()).not.toContain('bblt_saved');
  478. });
  479. it('opens no camera stream until the preview is asked for', async () => {
  480. const user = userEvent.setup();
  481. render(<StreamOverlayBuilder />);
  482. await waitFor(() => expect(screen.getByText('Show preview')).toBeInTheDocument());
  483. // An always-on preview would hold a subscriber on the printer's single
  484. // camera connection for as long as the settings tab stays open.
  485. expect(document.querySelector('iframe')).toBeNull();
  486. await user.click(screen.getByText('Show preview'));
  487. await waitFor(() => expect(document.querySelector('iframe')).not.toBeNull());
  488. expect(document.querySelector('iframe')?.getAttribute('src')).toContain('/overlay/1');
  489. });
  490. it('still builds a URL when the printer list cannot be loaded', async () => {
  491. server.use(http.get('/api/v1/printers', () => HttpResponse.json({ detail: 'nope' }, { status: 500 })));
  492. render(<StreamOverlayBuilder />);
  493. // Falls back to printer 1 rather than rendering /overlay/null — the number
  494. // is the one thing the user can fix by hand in the URL.
  495. await waitFor(() => expect(shownUrl()).toContain('/overlay/1'));
  496. });
  497. });
  498. it('adds validated gradient colours to the URL and resets to the default', async () => {
  499. render(<StreamOverlayBuilder />);
  500. const from = await screen.findByLabelText('From colour (hex)');
  501. fireEvent.change(from, { target: { value: '#ff0000' } });
  502. fireEvent.change(screen.getByLabelText('To colour (hex)'), { target: { value: '#0000ff' } });
  503. expect(new URL(shownUrl()).searchParams.get('progressFrom')).toBe('#ff0000');
  504. expect(new URL(shownUrl()).searchParams.get('progressTo')).toBe('#0000ff');
  505. fireEvent.change(from, { target: { value: 'invalid' } });
  506. expect(new URL(shownUrl()).searchParams.get('progressFrom')).toBe('#ff0000');
  507. fireEvent.click(screen.getByRole('button', { name: 'Reset colours' }));
  508. expect(shownUrl()).not.toContain('progressFrom');
  509. expect(shownUrl()).not.toContain('progressTo');
  510. });
  511. it('uploads a logo, includes it in the URL, and removes it from the preview', async () => {
  512. const user = userEvent.setup();
  513. let saved = false;
  514. const create = vi.spyOn(URL, 'createObjectURL').mockReturnValue('blob:logo-preview');
  515. const revoke = vi.spyOn(URL, 'revokeObjectURL').mockImplementation(() => {});
  516. server.use(
  517. http.get('/api/v1/printers', () => HttpResponse.json(printers)),
  518. http.get('/api/v1/settings/overlay-logo', () => saved ? new HttpResponse(new Blob(['png'], { type: 'image/png' })) : new HttpResponse(null, { status: 404 })),
  519. http.post('/api/v1/settings/overlay-logo', () => { saved = true; return HttpResponse.json({ status: 'ok' }); }),
  520. http.delete('/api/v1/settings/overlay-logo', () => { saved = false; return HttpResponse.json({ status: 'ok' }); }),
  521. );
  522. try {
  523. render(<StreamOverlayBuilder />);
  524. await user.upload(await screen.findByLabelText('Upload logo'), new File(['png'], 'logo.png', { type: 'image/png' }));
  525. expect(await screen.findByRole('img', { name: 'Custom logo' })).toHaveAttribute('src', 'blob:logo-preview');
  526. expect(new URL(shownUrl()).searchParams.get('logo')).toBe('1');
  527. await user.click(screen.getByRole('button', { name: 'Show preview' }));
  528. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl()));
  529. const previousPreview = screen.getByTitle('Landscape preview');
  530. const previousUrl = shownUrl();
  531. await user.upload(screen.getByLabelText('Upload logo'), new File(['new png'], 'replacement.png', { type: 'image/png' }));
  532. await waitFor(() => expect(screen.getByTitle('Landscape preview')).not.toBe(previousPreview));
  533. expect(shownUrl()).toBe(previousUrl);
  534. expect(await screen.findByRole('img', { name: 'Custom logo' })).toBeInTheDocument();
  535. await user.click(screen.getByRole('button', { name: 'Remove' }));
  536. await waitFor(() => expect(screen.queryByRole('img', { name: 'Custom logo' })).not.toBeInTheDocument());
  537. expect(new URL(shownUrl()).searchParams.has('logo')).toBe(false);
  538. await waitFor(() => expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl()));
  539. } finally {
  540. create.mockRestore();
  541. revoke.mockRestore();
  542. }
  543. });
  544. it('debounces continuous preview changes and cancels a pending reload when hidden', async () => {
  545. server.use(
  546. http.get('/api/v1/printers', () => HttpResponse.json(printers)),
  547. http.get('/api/v1/settings/overlay-logo', () => new HttpResponse(null, { status: 404 })),
  548. );
  549. render(<StreamOverlayBuilder />);
  550. await screen.findByRole('option', { name: 'X1 Carbon' });
  551. fireEvent.change(screen.getByLabelText('Artwork'), { target: { value: '2' } });
  552. fireEvent.click(screen.getByRole('button', { name: 'Show preview' }));
  553. const original = screen.getByTitle('Landscape preview');
  554. vi.useFakeTimers();
  555. try {
  556. fireEvent.change(screen.getByLabelText('From colour'), { target: { value: '#ff0000' } });
  557. act(() => vi.advanceTimersByTime(200));
  558. fireEvent.change(screen.getByRole('slider', { name: /Background transparency/ }), { target: { value: '65' } });
  559. act(() => vi.advanceTimersByTime(299));
  560. expect(screen.getByTitle('Landscape preview')).toBe(original);
  561. expect(original).not.toHaveAttribute('src', shownUrl());
  562. act(() => vi.advanceTimersByTime(1));
  563. expect(screen.getByTitle('Landscape preview')).not.toBe(original);
  564. expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl());
  565. fireEvent.change(screen.getByLabelText('From colour'), { target: { value: '#0000ff' } });
  566. fireEvent.click(screen.getByRole('button', { name: 'Hide preview' }));
  567. act(() => vi.advanceTimersByTime(300));
  568. expect(screen.queryByTitle('Landscape preview')).not.toBeInTheDocument();
  569. fireEvent.click(screen.getByRole('button', { name: 'Show preview' }));
  570. expect(screen.getByTitle('Landscape preview')).toHaveAttribute('src', shownUrl());
  571. fireEvent.click(screen.getByRole('button', { name: 'Hide preview' }));
  572. } finally {
  573. vi.useRealTimers();
  574. }
  575. });
  576. it.each([
  577. [400, { detail: 'Logo must be a static PNG or WebP image' }, 'Logo must be a static PNG or WebP image'],
  578. [413, { detail: { message: 'Logo must be at most 2 MiB' } }, 'Logo must be at most 2 MiB'],
  579. [502, null, 'HTTP 502'],
  580. ])('shows the server upload error for status %s', async (status, body, message) => {
  581. server.use(
  582. http.get('/api/v1/printers', () => HttpResponse.json(printers)),
  583. http.get('/api/v1/settings/overlay-logo', () => new HttpResponse(null, { status: 404 })),
  584. http.post('/api/v1/settings/overlay-logo', () => body ? HttpResponse.json(body, { status }) : new HttpResponse('Bad gateway', { status })),
  585. );
  586. const user = userEvent.setup();
  587. render(<StreamOverlayBuilder />);
  588. await user.upload(screen.getByLabelText('Upload logo'), new File(['invalid'], 'logo.png', { type: 'image/png' }));
  589. expect(await screen.findByText(message)).toBeInTheDocument();
  590. expect(new URL(shownUrl()).searchParams.has('logo')).toBe(false);
  591. expect(screen.getByLabelText('Upload logo')).toBeEnabled();
  592. });
  593. describe('StreamOverlayBuilder remembers its choices in this browser', () => {
  594. const store = new Map<string, string>();
  595. const KEY = 'bambuddy.streamOverlayBuilder';
  596. beforeEach(() => {
  597. store.clear();
  598. vi.mocked(window.localStorage.getItem).mockImplementation((key: string) => store.get(key) ?? null);
  599. vi.mocked(window.localStorage.setItem).mockImplementation((key: string, value: string) => {
  600. store.set(key, value);
  601. });
  602. server.use(
  603. http.get('/api/v1/printers', () => HttpResponse.json(printers)),
  604. http.get('/api/v1/settings/overlay-logo', () => new HttpResponse(null, { status: 404 })),
  605. );
  606. });
  607. afterEach(() => {
  608. vi.mocked(window.localStorage.getItem).mockReset();
  609. vi.mocked(window.localStorage.setItem).mockReset();
  610. });
  611. it('reopens with the fields, printer and look that were picked, and never stores the token', async () => {
  612. const user = userEvent.setup();
  613. const first = render(<StreamOverlayBuilder />);
  614. await screen.findByRole('option', { name: 'P1S' });
  615. await user.click(screen.getByLabelText('Nozzle'));
  616. await user.click(screen.getByLabelText('Layer count'));
  617. await user.selectOptions(screen.getByLabelText('Printer'), '2');
  618. await user.selectOptions(screen.getByLabelText('Layout'), 'portrait');
  619. fireEvent.change(screen.getByLabelText('From colour (hex)'), { target: { value: '#ff0000' } });
  620. fireEvent.change(screen.getByLabelText('To colour (hex)'), { target: { value: '#0000ff' } });
  621. await user.type(screen.getByLabelText('Manual token'), 'bblt_secret');
  622. const withoutToken = (raw: string) => {
  623. const url = new URL(raw);
  624. url.searchParams.delete('token');
  625. return url.toString();
  626. };
  627. const before = withoutToken(shownUrl());
  628. first.unmount();
  629. expect(store.get(KEY)).not.toContain('bblt_secret');
  630. expect(store.get(KEY)).not.toContain('token');
  631. render(<StreamOverlayBuilder />);
  632. await screen.findByRole('option', { name: 'P1S' });
  633. expect(screen.getByLabelText('Nozzle')).toBeChecked();
  634. expect(screen.getByLabelText('Layer count')).not.toBeChecked();
  635. expect(screen.getByLabelText('Printer')).toHaveValue('2');
  636. expect(screen.getByLabelText('Layout')).toHaveValue('portrait');
  637. expect(screen.getByLabelText('Manual token')).toHaveValue('');
  638. // Same URL as before, minus the token that was not kept.
  639. expect(shownUrl()).toBe(before);
  640. });
  641. it('falls back to the defaults for anything stored that does not check out', async () => {
  642. store.set(KEY, JSON.stringify({
  643. printerId: 99, fields: ['nozzle', 'evil'], size: 'huge', fps: 500, artwork: '7',
  644. backgroundTransparency: -4, showCamera: 'no', layout: 'sideways', logo: 'yes', from: 'red', to: '#0000ff',
  645. }));
  646. render(<StreamOverlayBuilder />);
  647. await screen.findByRole('option', { name: 'P1S' });
  648. // Printer 99 no longer exists, so the first printer is used.
  649. await waitFor(() => expect(screen.getByLabelText('Printer')).toHaveValue('1'));
  650. const url = new URL(shownUrl());
  651. expect(url.pathname).toBe('/overlay/1');
  652. expect(url.searchParams.get('show')).toBe('nozzle');
  653. expect(url.searchParams.get('fps')).toBe('30');
  654. expect(url.searchParams.has('size')).toBe(false);
  655. expect(url.searchParams.has('artwork')).toBe(false);
  656. expect(url.searchParams.has('layout')).toBe(false);
  657. expect(url.searchParams.has('camera')).toBe(false);
  658. expect(url.searchParams.has('logo')).toBe(false);
  659. expect(url.searchParams.has('progressFrom')).toBe(false);
  660. });
  661. it('starts from the defaults when the stored value is not JSON', async () => {
  662. store.set(KEY, '{not json');
  663. render(<StreamOverlayBuilder />);
  664. await screen.findByRole('option', { name: 'P1S' });
  665. expect(new URL(shownUrl()).searchParams.get('show')).toBe('filename,status,progress,layers,eta');
  666. });
  667. it('keeps working when the browser refuses to store anything', async () => {
  668. vi.mocked(window.localStorage.setItem).mockImplementation((key: string) => {
  669. if (key === KEY) throw new Error('QuotaExceededError');
  670. });
  671. const user = userEvent.setup();
  672. render(<StreamOverlayBuilder />);
  673. await screen.findByRole('option', { name: 'P1S' });
  674. await user.click(screen.getByLabelText('Nozzle'));
  675. expect(new URL(shownUrl()).searchParams.get('show')).toContain('nozzle');
  676. });
  677. it('says when a change is saved, once per burst of edits', async () => {
  678. const user = userEvent.setup();
  679. render(<StreamOverlayBuilder />);
  680. await screen.findByRole('option', { name: 'P1S' });
  681. await user.click(screen.getByLabelText('Nozzle'));
  682. await user.click(screen.getByLabelText('Layer count'));
  683. await user.selectOptions(screen.getByLabelText('Layout'), 'portrait');
  684. await waitFor(() => expect(screen.getByText('Settings saved')).toBeInTheDocument());
  685. // Give any later toast of the same burst time to appear before counting.
  686. await new Promise((resolve) => setTimeout(resolve, 700));
  687. expect(screen.getAllByText('Settings saved')).toHaveLength(1);
  688. });
  689. it('does not claim a save when the page only opens, even when a deleted printer is replaced', async () => {
  690. store.set(KEY, JSON.stringify({ printerId: 99, fields: ['nozzle'] }));
  691. render(<StreamOverlayBuilder />);
  692. await screen.findByRole('option', { name: 'P1S' });
  693. await waitFor(() => expect(screen.getByLabelText('Printer')).toHaveValue('1'));
  694. expect(JSON.parse(store.get(KEY)!).printerId).toBe(1);
  695. await new Promise((resolve) => setTimeout(resolve, 900));
  696. expect(screen.queryByText('Settings saved')).toBeNull();
  697. });
  698. it('does not claim a save the browser refused', async () => {
  699. vi.mocked(window.localStorage.setItem).mockImplementation((key: string) => {
  700. if (key === KEY) throw new Error('QuotaExceededError');
  701. });
  702. const user = userEvent.setup();
  703. render(<StreamOverlayBuilder />);
  704. await screen.findByRole('option', { name: 'P1S' });
  705. await user.click(screen.getByLabelText('Nozzle'));
  706. await new Promise((resolve) => setTimeout(resolve, 900));
  707. expect(screen.queryByText('Settings saved')).toBeNull();
  708. });
  709. it('resets the choices to the defaults but keeps the token', async () => {
  710. const user = userEvent.setup();
  711. render(<StreamOverlayBuilder />);
  712. await screen.findByRole('option', { name: 'P1S' });
  713. const defaultUrl = shownUrl();
  714. await user.click(screen.getByLabelText('Nozzle'));
  715. await user.selectOptions(screen.getByLabelText('Printer'), '2');
  716. await user.type(screen.getByLabelText('Manual token'), 'bblt_keep');
  717. await user.click(screen.getByRole('button', { name: 'Reset choices' }));
  718. const url = new URL(shownUrl());
  719. expect(url.pathname).toBe('/overlay/1');
  720. expect(url.searchParams.get('show')).toBe(new URL(defaultUrl).searchParams.get('show'));
  721. expect(url.searchParams.get('token')).toBe('****');
  722. expect(JSON.parse(store.get(KEY)!).fields).toEqual(['progress', 'layers', 'eta', 'filename', 'status']);
  723. });
  724. });