/**
* Tests for the Layout component.
*/
import { describe, it, expect, beforeEach } from 'vitest';
import { waitFor } from '@testing-library/react';
import { render } from '../utils';
import { Layout } from '../../components/Layout';
import { http, HttpResponse } from 'msw';
import { server } from '../mocks/server';
describe('Layout', () => {
beforeEach(() => {
server.use(
http.get('/api/v1/printers/', () => {
return HttpResponse.json([
{ id: 1, name: 'X1 Carbon', model: 'X1C', enabled: true },
]);
}),
http.get('/api/v1/printers/:id/status', () => {
return HttpResponse.json({
connected: true,
state: 'IDLE',
});
}),
http.get('/api/v1/version', () => {
return HttpResponse.json({ version: '0.1.6', build: 'test' });
}),
http.get('/api/v1/settings/', () => {
return HttpResponse.json({
check_updates: false,
check_printer_firmware: false,
auto_archive: true,
});
}),
http.get('/api/v1/external-links/', () => {
return HttpResponse.json([]);
}),
http.get('/api/v1/smart-plugs/', () => {
return HttpResponse.json([]);
}),
http.get('/api/v1/support/debug-logging', () => {
return HttpResponse.json({ enabled: false });
}),
http.get('/api/v1/queue/', () => {
return HttpResponse.json([]);
}),
http.get('/api/v1/pending-uploads/count', () => {
return HttpResponse.json({ count: 0 });
}),
http.get('/api/v1/updates/check', () => {
return HttpResponse.json({ update_available: false });
}),
http.get('/api/v1/auth/status', () => {
return HttpResponse.json({ auth_enabled: false, requires_setup: false });
}),
http.get('/api/v1/printers/developer-mode-warnings', () => {
return HttpResponse.json([]);
})
);
});
describe('rendering', () => {
it('renders the sidebar', async () => {
render();
// Layout renders as a flex container with sidebar
await waitFor(() => {
const sidebar = document.querySelector('aside');
expect(sidebar).toBeInTheDocument();
});
});
it('renders navigation links', async () => {
render();
await waitFor(() => {
// Navigation links should be present
const links = document.querySelectorAll('a');
expect(links.length).toBeGreaterThan(0);
});
});
});
describe('navigation', () => {
it('has navigation items', async () => {
render();
await waitFor(() => {
// Should have multiple navigation links
const navLinks = document.querySelectorAll('a[href]');
expect(navLinks.length).toBeGreaterThan(0);
});
});
it('includes settings link', async () => {
render();
await waitFor(() => {
// Settings link should exist (route /settings)
const settingsLink = document.querySelector('a[href="/settings"]');
expect(settingsLink).toBeInTheDocument();
});
});
});
describe('version display', () => {
it('shows version info', async () => {
render();
await waitFor(() => {
// Version info is displayed in sidebar
expect(document.body).toBeInTheDocument();
});
});
});
describe('theme toggle', () => {
it('has theme toggle button', async () => {
render();
await waitFor(() => {
// Theme toggle should be present
const buttons = document.querySelectorAll('button');
expect(buttons.length).toBeGreaterThan(0);
});
});
it('cycles through dark → light → system → dark', async () => {
localStorage.setItem('theme-mode', 'dark');
render();
await waitFor(() => {
// In dark mode, title should say "Switch to light mode"
const btn = document.querySelector('button[title="Switch to light mode"]');
expect(btn).toBeInTheDocument();
});
// Click to go from dark → light
const lightBtn = document.querySelector('button[title="Switch to light mode"]')!;
lightBtn.click();
await waitFor(() => {
// In light mode, title should say "Switch to system mode"
const btn = document.querySelector('button[title="Switch to system mode"]');
expect(btn).toBeInTheDocument();
});
// Click to go from light → system
const systemBtn = document.querySelector('button[title="Switch to system mode"]')!;
systemBtn.click();
await waitFor(() => {
// In system mode, title should say "Switch to dark mode"
const btn = document.querySelector('button[title="Switch to dark mode"]');
expect(btn).toBeInTheDocument();
});
// Click to go from system → dark
const darkBtn = document.querySelector('button[title="Switch to dark mode"]')!;
darkBtn.click();
await waitFor(() => {
// Back to dark mode
const btn = document.querySelector('button[title="Switch to light mode"]');
expect(btn).toBeInTheDocument();
});
});
});
describe('plate detection alert modal', () => {
it('shows modal when plate-not-empty event is dispatched', async () => {
render();
// Dispatch the plate-not-empty event
window.dispatchEvent(
new CustomEvent('plate-not-empty', {
detail: {
printer_id: 1,
printer_name: 'Test Printer',
message: 'Objects detected on build plate',
},
})
);
await waitFor(() => {
// Modal should appear with "Print Paused!" text
expect(document.body.textContent).toContain('Print Paused!');
expect(document.body.textContent).toContain('Test Printer');
});
});
it('closes modal when I Understand button is clicked', async () => {
render();
// Dispatch the plate-not-empty event
window.dispatchEvent(
new CustomEvent('plate-not-empty', {
detail: {
printer_id: 1,
printer_name: 'Test Printer',
message: 'Objects detected on build plate',
},
})
);
await waitFor(() => {
expect(document.body.textContent).toContain('Print Paused!');
});
// Click the "I Understand" button
const button = document.querySelector('button');
if (button && button.textContent?.includes('I Understand')) {
button.click();
}
// Find and click the "I Understand" button by searching all buttons
const buttons = document.querySelectorAll('button');
buttons.forEach((btn) => {
if (btn.textContent?.includes('I Understand')) {
btn.click();
}
});
await waitFor(() => {
// Modal should be closed
expect(document.body.textContent).not.toContain('Print Paused!');
});
});
});
describe('developer mode warning banner', () => {
it('shows warning banner when printers lack developer mode', async () => {
server.use(
http.get('/api/v1/printers/developer-mode-warnings', () => {
return HttpResponse.json([
{ printer_id: 1, name: 'X1 Carbon' },
]);
})
);
render();
await waitFor(() => {
expect(document.body.textContent).toContain('Developer LAN mode is not enabled on');
expect(document.body.textContent).toContain('X1 Carbon');
});
});
it('shows multiple printer names in warning banner', async () => {
server.use(
http.get('/api/v1/printers/developer-mode-warnings', () => {
return HttpResponse.json([
{ printer_id: 1, name: 'X1 Carbon' },
{ printer_id: 2, name: 'P1S' },
]);
})
);
render();
await waitFor(() => {
expect(document.body.textContent).toContain('X1 Carbon');
expect(document.body.textContent).toContain('P1S');
});
});
it('hides warning banner when no printers lack developer mode', async () => {
// Default handler returns empty array
render();
await waitFor(() => {
const sidebar = document.querySelector('aside');
expect(sidebar).toBeInTheDocument();
});
// Banner should not be present
expect(document.body.textContent).not.toContain('Developer LAN mode is not enabled on');
});
it('shows how to enable link in warning banner', async () => {
server.use(
http.get('/api/v1/printers/developer-mode-warnings', () => {
return HttpResponse.json([
{ printer_id: 1, name: 'X1 Carbon' },
]);
})
);
render();
await waitFor(() => {
expect(document.body.textContent).toContain('How to enable');
const link = document.querySelector('a[href*="enable-developer-mode"]');
expect(link).toBeInTheDocument();
});
});
});
describe('update banner suppression for HA addon', () => {
// HA Supervisor surfaces its own update notification natively in the HA
// UI, so the in-app banner would be duplicate noise that links to a page
// that just says "update via HA". Suppress it for HA addon deployments.
it('hides the update-available banner when running as an HA addon', async () => {
server.use(
http.get('/api/v1/updates/check', () => {
return HttpResponse.json({
update_available: true,
current_version: '0.2.4',
latest_version: '0.2.5',
is_docker: true,
is_ha_addon: true,
update_method: 'ha_addon',
});
}),
);
render();
await waitFor(() => {
const sidebar = document.querySelector('aside');
expect(sidebar).toBeInTheDocument();
});
expect(document.body.textContent).not.toContain('Update available');
});
it('still shows the update-available banner for plain Docker deployments', async () => {
server.use(
http.get('/api/v1/updates/check', () => {
return HttpResponse.json({
update_available: true,
current_version: '0.2.4',
latest_version: '0.2.5',
is_docker: true,
is_ha_addon: false,
update_method: 'docker',
});
}),
);
render();
await waitFor(() => {
expect(document.body.textContent).toContain('0.2.5');
});
});
});
describe('MakerWorld sidebar permission gate (#1175)', () => {
// The MakerWorld sidebar entry was visible to every authenticated user
// regardless of group permissions because Layout's `navPermissions` map
// had no entry for `makerworld`. Backend routes already gated on
// `makerworld:view`, so users without the permission saw the entry,
// clicked, and got 403'd by every API call inside the page. The fix
// adds `makerworld: 'makerworld:view'` to the map so the entry is
// hidden when the permission is absent — same shape as every other
// sidebar entry.
const enableAuthWithUser = (permissions: string[]) => {
server.use(
http.get('/api/v1/auth/status', () =>
HttpResponse.json({ auth_enabled: true, requires_setup: false }),
),
http.get('/api/v1/auth/me', () =>
HttpResponse.json({
id: 1,
username: 'tester',
role: 'user',
is_active: true,
is_admin: false,
groups: [{ id: 2, name: 'Standard Users' }],
permissions,
created_at: '2026-01-01T00:00:00Z',
}),
),
);
// AuthProvider needs a token in localStorage to fetch /auth/me; the
// value isn't validated by the mocked server.
window.localStorage.setItem('auth_token', 'test-token');
};
const findMakerWorldNavLink = () => {
// Sidebar nav links use react-router's `to` prop, which renders as a
// plain ``. Match on the href so the test isn't
// coupled to whatever locale string is rendered.
return document.querySelector('aside a[href="/makerworld"]');
};
it('hides the MakerWorld nav entry when the user lacks makerworld:view', async () => {
// Standard user without the MakerWorld permission. Every other
// permission they hold (library:read, etc.) is irrelevant here — the
// gate is per-entry and the MakerWorld entry must not render.
enableAuthWithUser(['library:read', 'archives:read', 'queue:read']);
render();
await waitFor(() => {
// Wait for the auth resolution + sidebar render. Some other nav
// entry (Files / Archives) confirms the sidebar finished mounting.
const sidebar = document.querySelector('aside');
expect(sidebar).toBeInTheDocument();
expect(sidebar?.querySelector('a[href="/files"]')).toBeInTheDocument();
});
expect(findMakerWorldNavLink()).toBeNull();
});
it('shows the MakerWorld nav entry when the user has makerworld:view', async () => {
enableAuthWithUser([
'library:read',
'archives:read',
'queue:read',
'makerworld:view',
]);
render();
await waitFor(() => {
expect(findMakerWorldNavLink()).toBeInTheDocument();
});
});
});
});