Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
feat: allow viewing retained logs for stopped projects (#4097)
Kyle Mendellb350d394cd19
diff --git a/frontend/src/lib/utils/api.ts b/frontend/src/lib/utils/api.tsindex 915801bee..8cf95c14e 100644--- a/frontend/src/lib/utils/api.ts+++ b/frontend/src/lib/utils/api.ts@@ -101,6 +101,12 @@ function extractApiErrorStatus(err: unknown, fallbackStatus = 500): number {return fallbackStatus;}+/** True when the server explicitly rejected the caller's credentials (401/403). */+export function isAuthRejectionError(err: unknown): boolean {+ const status = extractApiErrorStatus(err, 0);+ return status === 401 || status === 403;+}+export function throwPageLoadError(err: unknown, fallbackMessage: string): never {const status = extractApiErrorStatus(err);const message = extractApiErrorMessage(err) || fallbackMessage;diff --git a/frontend/src/routes/(app)/projects/[projectId]/+page.svelte b/frontend/src/routes/(app)/projects/[projectId]/+page.svelteindex ac496a619..88b41d49e 100644--- a/frontend/src/routes/(app)/projects/[projectId]/+page.svelte+++ b/frontend/src/routes/(app)/projects/[projectId]/+page.svelte@@ -1777,11 +1777,7 @@{#snippet second()}<div class="flex h-full min-h-0 flex-col overflow-hidden">{#key project.id}- <ProjectsLogsPanel- projectId={project.id}- bind:autoScroll={autoScrollStackLogs}- isRunning={project.status?.toLowerCase().includes('running')}- />+ <ProjectsLogsPanel projectId={project.id} bind:autoScroll={autoScrollStackLogs} />{/key}</div>{/snippet}diff --git a/frontend/src/routes/(app)/projects/components/ProjectLogsPanel.svelte b/frontend/src/routes/(app)/projects/components/ProjectLogsPanel.svelteindex a7b66cfdf..572d46e9a 100644--- a/frontend/src/routes/(app)/projects/components/ProjectLogsPanel.svelte+++ b/frontend/src/routes/(app)/projects/components/ProjectLogsPanel.svelte@@ -9,22 +9,20 @@let {projectId,- autoScroll = $bindable(),- isRunning = true+ autoScroll = $bindable()}: {projectId: string;autoScroll: boolean;- isRunning?: boolean;} = $props();let isStreaming = $state(false);let viewer = $state<ReturnType<typeof LogViewer>>();const preferences = new UseLogPreferences();let logSearchTerm = $state('');- let hasAutoStarted = $state(false);+ // Plain guard, not $state: it is only written from the auto-start effect and never rendered.+ let hasAutoStarted = false;function handleStart() {- if (!isRunning) return;viewer?.startLogStream();}@@ -33,20 +31,11 @@}async function handleRefresh() {- await viewer?.clearLogs({ hard: true, restart: isRunning });+ await viewer?.clearLogs({ hard: true, restart: true });}- // The panel stays visible while the project is stopped; the stream pauses and- // picks back up (via auto-start) once the project is running again.$effect(() => {- if (!isRunning) {- hasAutoStarted = false;- if (isStreaming) handleStop();- }- });-- $effect(() => {- if (preferences.autoStartLogs && !hasAutoStarted && !isStreaming && projectId && isRunning && viewer) {+ if (preferences.autoStartLogs && !hasAutoStarted && !isStreaming && projectId && viewer) {hasAutoStarted = true;handleStart();}@@ -66,7 +55,7 @@mobileLayout="full"showDesktop={false}{isStreaming}- disabled={!projectId || !isRunning}+ disabled={!projectId}onStart={handleStart}onStop={handleStop}onRefresh={handleRefresh}@@ -80,7 +69,7 @@{preferences}mobileLayout="none"{isStreaming}- disabled={!projectId || !isRunning}+ disabled={!projectId}onStart={handleStart}onStop={handleStop}onRefresh={handleRefresh}diff --git a/frontend/src/routes/+layout.ts b/frontend/src/routes/+layout.tsindex 65572a67d..21c42483e 100644--- a/frontend/src/routes/+layout.ts+++ b/frontend/src/routes/+layout.ts@@ -11,13 +11,14 @@ import { environmentStore } from '#lib/stores/environment.store.svelte.js';import userStore from '#lib/stores/user-store.svelte.js';import { versionStore } from '#lib/stores/version.store.svelte.js';import type { SearchPaginationSortRequest } from '#lib/types/shared.js';-import type { PermissionsManifest } from '#lib/types/auth.js';+import type { PermissionsManifest, User } from '#lib/types/auth.js';import { authService } from '#lib/services/auth-service.js';import { tryCatch } from '#lib/utils/try-catch.js';import { QueryClient } from '@tanstack/svelte-query';import { queryKeys } from '#lib/query/query-keys.js';import { redirect } from '@sveltejs/kit';import { getAuthRedirectPath, userHasPermission } from '#lib/utils/auth.js';+import { isAuthRejectionError } from '#lib/utils/api.js';import { getEffectiveLandingPage } from '#lib/utils/navigation.js';import type { LayoutLoad } from './$types';@@ -38,6 +39,16 @@ const queryClient = new QueryClient({let authenticatedUserId: string | null | undefined;+// The layout load re-runs on every navigation and re-checks the session. A+// transient failure of that check (network blip, 5xx, 429) must not sign the+// user out of the SPA: that clears every cache, bounces through /login and+// lands on the landing page. Only an explicit rejection means the session is+// gone; anything else keeps the user we already know about.+function resolveUserAfterLoadFailureInternal(error: unknown): User | null {+ if (isAuthRejectionError(error)) return null;+ return userStore.current;+}+export const load: LayoutLoad = async ({ url }) => {const versionInformationRequest = versionService.getVersionInformation();const autoLoginConfigRequest = browser@@ -47,7 +58,9 @@ export const load: LayoutLoad = async ({ url }) => {}): Promise.resolve(null);let [user, autoLoginConfig] = await Promise.all([- tryCatch(userService.getCurrentUser()).then((result) => (result.error ? null : result.data)),+ tryCatch(userService.getCurrentUser()).then((result) =>+ result.error ? resolveUserAfterLoadFailureInternal(result.error) : result.data+ ),autoLoginConfigRequest]);@@ -98,7 +111,9 @@ export const load: LayoutLoad = async ({ url }) => {const environments = await environmentsRequest;if (!environments.error) {await environmentStore.initialize(environments.data.data);- } else {+ } else if (!environmentStore.isInitialized()) {+ // A failed refetch on an already-initialised store keeps the current+ // selection; re-initialising with [] would drop it to "No Environment".await environmentStore.initialize([]);}diff --git a/tests/spec/project.spec.ts b/tests/spec/project.spec.tsindex 4b3cbf37a..4a729ecca 100644--- a/tests/spec/project.spec.ts+++ b/tests/spec/project.spec.ts@@ -277,6 +277,54 @@ async function destroyProjectByIdViaAPI(page: Page, projectId: string) {.catch(() => undefined);}+async function expectProjectStopped(page: Page, projectId: string) {+ await expect+ .poll(+ async () => {+ const detail = await fetchProjectDetail(page, projectId);+ return detail?.status ?? 'missing';+ },+ {+ message: 'Expected project to be stopped',+ timeout: 60000+ }+ )+ .toBe('stopped');+}++function buildExitServiceCompose(marker: string) {+ return [+ 'services:',+ ' exiter:',+ ' image: public.ecr.aws/docker/library/alpine:3.20',+ ' restart: "no"',+ ` command: sh -c "echo ${marker}; exit 0"`,+ ''+ ].join('\n');+}++async function createExitedMarkerProject(page: Page, projectName: string) {+ const marker = `ARCANE_LOGS_MARKER_${Date.now()}`;+ const projectId = await createProjectViaUI(page, projectName, buildExitServiceCompose(marker));++ const deployResponsePromise = page.waitForResponse(+ (response) =>+ response.request().method() === 'POST' &&+ /\/api\/environments\/[^/]+\/projects\/[^/]+\/up$/.test(getPathname(response.url()))+ );+ await page+ .getByRole('button', { name: 'Up', exact: true })+ .filter({ visible: true })+ .first()+ .click();+ const deployResponse = await deployResponsePromise;+ expect(deployResponse.ok()).toBe(true);++ await expectProjectStopped(page, projectId);++ return { projectId, marker };+}+let realProjects: Project[] = [];let projectCounts: ProjectStatusCounts = {runningProjects: 0,@@ -1619,65 +1667,125 @@ test.describe('Project Detail Page', () => {}});- test('should show the logs pane alongside services for running projects', async ({ page }) => {- test.skip(!realProjects.length, 'No projects available for logs test');+ test('should show retained logs for a stopped project and reload them on refresh', async ({+ page+ }) => {+ test.slow();- const runningProject = realProjects.find((p) => p.status === 'running');- test.skip(!runningProject, 'No running projects found for logs test');- const targetProject = runningProject!;+ const projectName = `test-logs-stopped-${Date.now()}`;+ const logViewer = page.getByRole('log');+ let projectId = '';+ let marker = '';- await page.goto(`/projects/${targetProject.id || targetProject.name}?tab=services`);- await page.waitForLoadState('load');+ try {+ const created = await createExitedMarkerProject(page, projectName);+ projectId = created.projectId;+ marker = created.marker;++ let logSocketCount = 0;+ page.on('websocket', (ws) => {+ if (/ws\/projects\/.+\/logs/.test(ws.url())) {+ logSocketCount += 1;+ }+ });- await expect(page.getByText('Real-time project logs', { exact: true })).toBeVisible();- await expect(- page- .getByRole('button', { name: 'Start', exact: true })- .or(page.getByRole('button', { name: 'Stop', exact: true }))- .first()- ).toBeVisible();- await expect(page.getByTitle('Refresh')).toBeVisible();+ await page.goto(`/projects/${projectId}?tab=services`);+ await page.waitForLoadState('load');+ await expect(page.getByText('Real-time project logs', { exact: true })).toBeVisible();+ await expect(logViewer).toHaveAttribute('data-is-streaming', 'false');- const logViewer = page.getByRole('log');- const startButton = page- .getByRole('button', { name: 'Start', exact: true })- .filter({ visible: true })- .first();- const stopButton = page- .getByRole('button', { name: 'Stop', exact: true })- .filter({ visible: true })- .first();+ const startButton = page+ .getByRole('button', { name: 'Start', exact: true })+ .filter({ visible: true })+ .first();+ const stopButton = page+ .getByRole('button', { name: 'Stop', exact: true })+ .filter({ visible: true })+ .first();- if ((await startButton.count()) > 0) {await startButton.click();+ await expect(logViewer).toHaveAttribute('data-is-streaming', 'true');+ await expect(logViewer).toContainText(marker, { timeout: 20000 });+ await expect(logViewer.getByText(marker).filter({ visible: true })).toHaveCount(1);++ await page.getByTitle('Refresh').click();+ await expect(logViewer).toContainText(marker, { timeout: 20000 });+ await expect(logViewer.getByText(marker).filter({ visible: true })).toHaveCount(1);++ await stopButton.click();+ await expect(logViewer).toHaveAttribute('data-is-streaming', 'false');+ await expect(logViewer).toContainText(marker);++ const socketsAfterStop = logSocketCount;+ await page.waitForTimeout(2000);+ expect(logSocketCount, 'Manual stop must not resubscribe to the log stream').toBe(+ socketsAfterStop+ );+ } finally {+ await destroyProjectByIdViaAPI(page, projectId || getProjectIdFromPageUrl(page.url()));}- await expect(logViewer).toHaveAttribute('data-is-streaming', 'true');- await expect(stopButton).toBeVisible();+ });++ test('should apply the auto-start preference to stopped projects', async ({ page }) => {+ test.slow();- await stopButton.click();- await expect(logViewer).toHaveAttribute('data-is-streaming', 'false');- await expect(startButton).toBeEnabled();+ const projectName = `test-log-autostart-${Date.now()}`;+ let projectId = '';- await startButton.click();- await expect(logViewer).toHaveAttribute('data-is-streaming', 'true');+ try {+ const created = await createExitedMarkerProject(page, projectName);+ projectId = created.projectId;- await page.getByTitle('Refresh').click();- await expect(logViewer).toHaveAttribute('data-is-streaming', 'true');- await expect(stopButton).toBeVisible();+ await page.goto(`/projects/${projectId}?tab=services`);+ await page.waitForLoadState('load');- await expect(- page.getByText('No project selected. Please select a project to view logs.', { exact: true })- ).not.toBeVisible();+ const logViewer = page.getByRole('log');+ await page.waitForTimeout(2000);+ await expect(+ logViewer,+ 'With auto-start disabled the viewer must wait for Start'+ ).toHaveAttribute('data-is-streaming', 'false');- const stoppedProject = realProjects.find((p) => p.status === 'stopped');- expect(stoppedProject, 'GitOps setup must provide a stopped project').toBeDefined();+ // PersistedState JSON-serializes values, so the stored form is the quoted string "true".+ await page.evaluate(() =>+ localStorage.setItem('arcane_log_auto_start', JSON.stringify('true'))+ );+ await page.reload();+ await page.waitForLoadState('load');- await page.goto(`/projects/${stoppedProject!.id || stoppedProject!.name}?tab=services`);+ const reloadedViewer = page.getByRole('log');+ await expect(reloadedViewer).toHaveAttribute('data-is-streaming', 'true', {+ timeout: 15000+ });+ await expect(reloadedViewer).toContainText(created.marker, { timeout: 20000 });+ } finally {+ await destroyProjectByIdViaAPI(page, projectId);+ }+ });++ test('should surface a project log stream connection failure inline', async ({ page }) => {+ test.skip(!realProjects.length, 'No projects available for log stream failure test');++ const targetProject = realProjects[0];+ await page.routeWebSocket('**/api/environments/*/ws/projects/*/logs**', (ws) => {+ ws.close({ code: 1013, reason: 'forced failure' });+ });++ await page.goto(`/projects/${targetProject.id || targetProject.name}?tab=services`);await page.waitForLoadState('load');- await expect(page.getByText('Real-time project logs', { exact: true })).toBeVisible();- await expect(startButton).toBeDisabled();- await page.getByTitle('Refresh').click();- await expect(logViewer).toHaveAttribute('data-is-streaming', 'false');+ await page+ .getByRole('button', { name: 'Start', exact: true })+ .filter({ visible: true })+ .first()+ .click();++ await expect(+ page+ .getByText('Failed to connect to Project log stream')+ .or(page.getByText('Connection to Project log stream lost'))+ .or(page.getByText('Project log stream was closed by server'))+ .first()+ ).toBeVisible({ timeout: 20000 });});});