Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

Show Docker list errors and ignore stale loads

Juan Denisdb5f4df74ac9
diff --git a/.github/workflows/frontend-ci.yml b/.github/workflows/frontend-ci.yml
index 6d6444a8..f035bea7 100644
--- a/.github/workflows/frontend-ci.yml
+++ b/.github/workflows/frontend-ci.yml
@@ -74,6 +74,9 @@ jobs:
- name: Terminal log viewer browser regressions
working-directory: frontend
run: npm run test:terminal-logs
+ - name: Docker tabs browser regressions
+ working-directory: frontend
+ run: npm run test:docker-tabs
- name: Upload Settings screenshots
if: always()
uses: actions/upload-artifact@v4
diff --git a/backend/app/services/docker_service.py b/backend/app/services/docker_service.py
index 196aab98..a8de8ac2 100644
--- a/backend/app/services/docker_service.py
+++ b/backend/app/services/docker_service.py
@@ -7,6 +7,7 @@ import shlex
import yaml
from datetime import datetime
+from app.exceptions import DependencyUnavailableError
from app.utils.system import run_checked
logger = logging.getLogger(__name__)
@@ -152,38 +153,45 @@ class DockerService:
@staticmethod
def list_containers(all_containers=True):
- """List Docker containers."""
- try:
- args = ['ps', '--format', '{{json .}}']
- if all_containers:
- args.insert(1, '-a')
+ """List Docker containers.
- result = DockerService.run(args, timeout=None)
- if not result['success']:
- return []
+ Raises DependencyUnavailableError when docker does not answer: an
+ empty list would tell the UI "no containers" on a box running many.
+ """
+ args = ['ps', '--format', '{{json .}}']
+ if all_containers:
+ args.insert(1, '-a')
- containers = []
- for line in result['output'].strip().split('\n'):
- if line:
- container = json.loads(line)
- name = container.get('Names')
- containers.append({
- 'id': container.get('ID'),
- 'name': name,
- 'image': container.get('Image'),
- 'status': container.get('Status'),
- 'state': container.get('State'),
- 'ports': container.get('Ports'),
- 'created': container.get('CreatedAt'),
- 'size': container.get('Size'),
- # Flag ServerKit's own containers so the UI can hide
- # lifecycle controls; the API rejects them regardless.
- 'protected': DockerService.is_protected_name(name),
- })
- return containers
- except Exception as e:
- logger.error(f"Failed to list containers: {e}")
- return []
+ result = DockerService.run(args, timeout=None)
+ if not result['success']:
+ raise DependencyUnavailableError(
+ 'Docker is not reachable: '
+ + (result.get('stderr') or result.get('error') or 'docker ps failed'))
+
+ containers = []
+ for line in result['output'].strip().split('\n'):
+ if not line:
+ continue
+ try:
+ container = json.loads(line)
+ except ValueError:
+ logger.warning('Unparseable docker ps line: %r', line)
+ continue
+ name = container.get('Names')
+ containers.append({
+ 'id': container.get('ID'),
+ 'name': name,
+ 'image': container.get('Image'),
+ 'status': container.get('Status'),
+ 'state': container.get('State'),
+ 'ports': container.get('Ports'),
+ 'created': container.get('CreatedAt'),
+ 'size': container.get('Size'),
+ # Flag ServerKit's own containers so the UI can hide
+ # lifecycle controls; the API rejects them regardless.
+ 'protected': DockerService.is_protected_name(name),
+ })
+ return containers
# One `docker ps` row, tab-delimited. Tabs are used instead of
# `--format '{{json .}}'` because the JSON form flattens every label into a
diff --git a/backend/app/services/remote_docker_service.py b/backend/app/services/remote_docker_service.py
index baa2ed8b..afb68c56 100644
--- a/backend/app/services/remote_docker_service.py
+++ b/backend/app/services/remote_docker_service.py
@@ -42,7 +42,7 @@ class RemoteDockerService:
# Use local Docker
from app.services.docker_service import DockerService
try:
- containers = DockerService.list_containers(all=all)
+ containers = DockerService.list_containers(all_containers=all)
return {'success': True, 'data': containers}
except Exception as e:
return {'success': False, 'error': str(e)}
diff --git a/backend/tests/test_docker_list_unreachable.py b/backend/tests/test_docker_list_unreachable.py
new file mode 100644
index 00000000..3c4c1983
--- /dev/null
+++ b/backend/tests/test_docker_list_unreachable.py
@@ -0,0 +1,40 @@
+"""Docker being down is an error, not an empty host.
+
+list_containers returned [] when `docker ps` failed, so the Containers
+page said "no containers" on a box running dozens. The local branch of
+RemoteDockerService also passed `all=` to a function whose parameter is
+`all_containers`, so it always failed with a TypeError.
+"""
+import pytest
+
+from app.exceptions import DependencyUnavailableError
+from app.services.docker_service import DockerService
+from app.services.remote_docker_service import RemoteDockerService
+from factories import headers_for, make_user
+
+PS_ROW = ('{"ID": "abc", "Names": "web", "Image": "nginx", "Status": "Up", '
+ '"State": "running", "Ports": "", "CreatedAt": "now", "Size": "0B"}')
+
+
+def test_daemon_down_raises_instead_of_listing_nothing(fake_subprocess):
+ fake_subprocess.script(['docker', 'ps'], returncode=1,
+ stderr='Cannot connect to the Docker daemon')
+ with pytest.raises(DependencyUnavailableError, match='Cannot connect'):
+ DockerService.list_containers()
+
+
+def test_containers_route_answers_503_when_docker_is_down(app, client, fake_subprocess):
+ from app import db
+ headers = headers_for(make_user(db, 'dk_admin', 'admin'))
+ fake_subprocess.script(['docker', 'ps'], returncode=1,
+ stderr='Cannot connect to the Docker daemon')
+ resp = client.get('/api/v1/docker/containers', headers=headers)
+ assert resp.status_code == 503
+ assert 'Docker is not reachable' in resp.get_json()['error']
+
+
+def test_local_remote_docker_listing_works(fake_subprocess):
+ fake_subprocess.script(['docker', 'ps'], stdout=PS_ROW)
+ result = RemoteDockerService.list_containers('local', all=True)
+ assert result['success'], result
+ assert [c['name'] for c in result['data']] == ['web']
diff --git a/frontend/package.json b/frontend/package.json
index c584231a..8ea8b7cc 100644
--- a/frontend/package.json
+++ b/frontend/package.json
@@ -18,6 +18,7 @@
"test:backups": "node scripts/backups-browser.mjs",
"test:sanitize-svg": "node scripts/sanitize-svg-browser.mjs",
"test:terminal-logs": "node scripts/terminal-logs-browser.mjs",
+ "test:docker-tabs": "node scripts/docker-tabs-browser.mjs",
"lint:settings-index": "node scripts/check-settings-index.mjs",
"lint:fonts": "node scripts/check-font-integrity.mjs",
"lint:status": "node scripts/check-status-one-door.mjs",
diff --git a/frontend/scripts/docker-tabs-browser.mjs b/frontend/scripts/docker-tabs-browser.mjs
new file mode 100644
index 00000000..73b92f12
--- /dev/null
+++ b/frontend/scripts/docker-tabs-browser.mjs
@@ -0,0 +1,99 @@
+import assert from 'node:assert/strict';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createServer } from 'vite';
+import react from '@vitejs/plugin-react';
+import { chromium } from 'playwright';
+
+// The real Containers and Images tabs. Switching servers while the old
+// server's list was still loading let that late answer overwrite the new
+// server's list, and a failed load left the previous list (or "No
+// containers") on screen instead of an error. Only HTTP is stubbed.
+const root = fileURLToPath(new URL('../', import.meta.url));
+const fixture = `
+import React,{useState} from 'react';
+import {createRoot} from 'react-dom/client';
+import {MemoryRouter} from 'react-router-dom';
+import {ServerContext} from '/src/components/docker/dockerHelpers.js';
+import ContainersTab from '/src/components/docker/ContainersTab.jsx';
+import ImagesTab from '/src/components/docker/ImagesTab.jsx';
+window.pending=[];
+const hold=(server,kind)=>new Promise((resolve,reject)=>window.pending.push({server,kind,resolve,reject}));
+window.release=(server,kind,ok=true)=>{const i=window.pending.findIndex(p=>p.server===server&&p.kind===kind);const p=window.pending.splice(i,1)[0];
+ const row=kind==='containers'?{data:[{id:server+'-c',name:server+'-web',image:'nginx',status:'Up',state:'running'}]}:{data:[{id:server+'-i',repository:server+'-repo',tag:'latest',size:'1MB'}]};
+ ok?p.resolve({success:true,...row}):p.reject(new Error('Docker is not reachable: daemon down'));};
+window.testApi={
+ getRemoteContainers:(server)=>hold(server,'containers'),
+ getRemoteImages:(server)=>hold(server,'images'),
+ getRemoteContainerStats:()=>Promise.resolve({}),
+ getContainersStats:()=>Promise.resolve({}),
+};
+function App(){const [server,setServer]=useState('alpha');window.setServer=setServer;const tab=new URLSearchParams(location.search).get('tab');
+ return <ServerContext.Provider value={{serverId:server,serverName:server,isRemote:true}}>{tab==='images'?<ImagesTab/>:<ContainersTab/>}</ServerContext.Provider>}
+createRoot(document.getElementById('root')).render(<MemoryRouter><App/></MemoryRouter>);
+`;
+const server = await createServer({
+ root, configFile: false, logLevel: 'error', resolve: { alias: { '@': path.join(root, 'src') } },
+ cacheDir: path.join(root, 'node_modules/.vite-docker-tabs-regression'),
+ optimizeDeps: { entries: [] }, server: { host: '127.0.0.1', port: 0 },
+ plugins: [{
+ name: 'docker-tabs-fixtures', enforce: 'pre',
+ resolveId(id) {
+ if (id === 'react-i18next') return '\0test-i18n';
+ if (id.endsWith('/docker-fixture.jsx')) return path.join(root, 'docker-fixture.jsx');
+ },
+ load(id) {
+ const normalized = id.replaceAll('\\', '/');
+ if (id === '\0test-i18n') return `const t=(key,f)=>typeof f==='string'?f:(f&&(f.defaultValue_other||f.defaultValue))||key;export const useTranslation=()=>({t,i18n:{language:'en'}});export const Trans=({children})=>children;export const initReactI18next={type:'3rdParty',init(){}};`;
+ if (normalized.endsWith('/src/contexts/useAuth.js')) return `import {createContext} from 'react';export const AuthContext=createContext(null);const auth={user:{id:1,role:'admin'},isAdmin:true,isAuthenticated:true,hasPermission:()=>true};export const useAuth=()=>auth;`;
+ if (normalized.endsWith('/src/contexts/useWorkspace.js')) return `const ws={activeWorkspaceId:null,workspaces:[],setActiveWorkspace(){}};export const useWorkspace=()=>ws;`;
+ if (normalized.endsWith('/src/contexts/useToast.js')) return `const toast={error(){},success(){},info(){},warning(){}};export const useToast=()=>toast;`;
+ if (normalized.endsWith('/src/services/api.js') || normalized.endsWith('/src/services/api/index.js')) return `export default new Proxy({}, {get:(_,key)=>(...args)=>(window.testApi[key]?window.testApi[key](...args):Promise.resolve({}))});`;
+ if (normalized.endsWith('/docker-fixture.jsx')) return fixture;
+ },
+ configureServer(vite) {
+ vite.middlewares.use('/docker-check', async (_req, res) => {
+ res.setHeader('Content-Type', 'text/html');
+ res.end(await vite.transformIndexHtml('/docker-check', '<div id="root"></div><script type="module" src="/docker-fixture.jsx"></script>'));
+ });
+ },
+ }, react()],
+});
+const executablePath = [process.env.CHROME_PATH, chromium.executablePath(), 'C:/Program Files/Google/Chrome/Application/chrome.exe', 'C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe'].find(candidate => candidate && existsSync(candidate));
+const waitPending = (page, srv, kind) => page.waitForFunction(([s, k]) => (window.pending || []).some(p => p.server === s && p.kind === k), [srv, kind]);
+let browser;
+try {
+ await server.listen();
+ browser = await chromium.launch({ ...(executablePath ? { executablePath } : {}), headless: true });
+ const page = await browser.newPage();
+ const errors = [];
+ page.on('pageerror', error => errors.push(error.message));
+ const base = `http://127.0.0.1:${server.httpServer.address().port}/docker-check`;
+
+ for (const [tab, kind, label] of [['containers', 'containers', 'web'], ['images', 'images', 'repo']]) {
+ await page.goto(`${base}?tab=${tab}`);
+ await waitPending(page, 'alpha', kind);
+ await page.evaluate(() => window.setServer('beta'));
+ await waitPending(page, 'beta', kind);
+ await page.evaluate(k => window.release('beta', k), kind);
+ await page.getByText(`beta-${label}`).first().waitFor();
+ await page.evaluate(k => window.release('alpha', k), kind); // the late answer
+ await page.waitForTimeout(300);
+ assert.equal(await page.getByText(`alpha-${label}`).count(), 0, `${tab}: old server's late answer replaced the list`);
+ assert.equal(await page.getByText(`beta-${label}`).count() > 0, true);
+ console.log(`PASS ${tab}: a late answer from the previous server is ignored`);
+
+ await page.evaluate(() => window.setServer('gamma'));
+ await waitPending(page, 'gamma', kind);
+ await page.evaluate(k => window.release('gamma', k, false), kind);
+ await page.getByText('Docker is not reachable', { exact: false }).first().waitFor();
+ assert.equal(await page.getByText(`beta-${label}`).count(), 0, `${tab}: previous list still shown after a failed load`);
+ assert.equal(await page.getByText(/^No (containers|images)$/).count(), 0, `${tab}: failure rendered as an empty host`);
+ console.log(`PASS ${tab}: a failed load shows the error, not an empty or stale list`);
+ }
+ assert.deepEqual(errors, []);
+} finally {
+ await browser?.close();
+ await server.close();
+}
diff --git a/frontend/src/components/docker/ContainersTab.jsx b/frontend/src/components/docker/ContainersTab.jsx
index 123d9e68..44ba0b97 100644
--- a/frontend/src/components/docker/ContainersTab.jsx
+++ b/frontend/src/components/docker/ContainersTab.jsx
@@ -6,6 +6,7 @@ import { useConfirm } from '../../hooks/useConfirm';
import LogToolbar from '../log-viewer/LogToolbar';
import LogContent from '../log-viewer/LogContent';
import EmptyState from '../EmptyState';
+import { ErrorState } from '../ErrorState';
import Modal from '@/components/Modal';
import { Drawer, DataTable, DataTableFooter, Pill, SearchField } from '@/components/ds';
import {
@@ -224,6 +225,10 @@ const ContainersTab = ({ onStatsChange }) => {
// Not persisted on its own: a grouping worth keeping is a saved view.
const [groupBy, setGroupBy] = useState(null);
const statsRequestSeq = useRef(0);
+ // Switching servers fires a new load while the old one may still be in
+ // flight; only the newest may write, or the old server's list wins.
+ const loadSeq = useRef(0);
+ const [loadError, setLoadError] = useState(null);
useEffect(() => {
loadContainers();
@@ -304,7 +309,9 @@ const ContainersTab = ({ onStatsChange }) => {
);
async function loadContainers() {
+ const seq = ++loadSeq.current;
setLoading(true);
+ setLoadError(null);
try {
let data;
if (isRemote) {
@@ -313,6 +320,7 @@ const ContainersTab = ({ onStatsChange }) => {
} else {
data = await api.getContainers(showAll);
}
+ if (seq !== loadSeq.current) return;
const containerList = data.containers || [];
const requestSeq = ++statsRequestSeq.current;
setContainers(containerList);
@@ -324,7 +332,13 @@ const ContainersTab = ({ onStatsChange }) => {
setLoading(false);
refreshContainerStats(containerList, requestSeq);
} catch (err) {
- console.error('Failed to load containers:', err);
+ if (seq !== loadSeq.current) return;
+ // An empty list here would read as "No containers" on a host
+ // running many; say that the list could not be read instead.
+ setContainers([]);
+ setContainerStats({});
+ setSelectedContainer(null);
+ setLoadError(err);
setLoading(false);
}
}
@@ -818,7 +832,12 @@ const ContainersTab = ({ onStatsChange }) => {
{/* Only the SEARCH can empty the pane outright. A column rule that
matches nothing keeps the table mounted — the header menu that
undoes it lives in the header. */}
- {filteredContainers.length === 0 ? (
+ {loadError ? (
+ <ErrorState
+ error={loadError}
+ onRetry={loadContainers}
+ />
+ ) : filteredContainers.length === 0 ? (
<EmptyState
icon={Box}
title={containers.length === 0 ? t('app.containersTab.noContainers', 'No containers') : t('app.containersTab.noMatchingContainers', 'No matching containers')}
diff --git a/frontend/src/components/docker/ImagesTab.jsx b/frontend/src/components/docker/ImagesTab.jsx
index adaed9dd..6662d455 100644
--- a/frontend/src/components/docker/ImagesTab.jsx
+++ b/frontend/src/components/docker/ImagesTab.jsx
@@ -1,8 +1,9 @@
-import { useState, useEffect, useMemo, useCallback } from 'react';
+import { useState, useEffect, useMemo, useCallback, useRef } from 'react';
import api from '../../services/api';
import { useToast } from '../../contexts/useToast.js';
import { useConfirm } from '../../hooks/useConfirm';
import EmptyState from '../EmptyState';
+import { ErrorState } from '../ErrorState';
import Modal from '@/components/Modal';
import { DataTable, DataTableFooter, SearchField } from '@/components/ds';
import {
@@ -175,13 +176,18 @@ const ImagesTab = ({ onStatsChange }) => {
storageKey: 'serverkit-table-docker-images-cols',
});
const [groupBy, setGroupBy] = useState(null);
+ // Only the newest load may write: see ContainersTab.
+ const loadSeq = useRef(0);
+ const [loadError, setLoadError] = useState(null);
useEffect(() => {
loadImages();
}, [serverId]); // eslint-disable-line react-hooks/exhaustive-deps
async function loadImages() {
+ const seq = ++loadSeq.current;
setLoading(true);
+ setLoadError(null);
try {
let data;
if (isRemote) {
@@ -190,10 +196,13 @@ const ImagesTab = ({ onStatsChange }) => {
} else {
data = await api.getImages();
}
+ if (seq !== loadSeq.current) return;
setImages(data.images || []);
+ setLoading(false);
} catch (err) {
- console.error('Failed to load images:', err);
- } finally {
+ if (seq !== loadSeq.current) return;
+ setImages([]);
+ setLoadError(err);
setLoading(false);
}
}
@@ -389,7 +398,12 @@ const ImagesTab = ({ onStatsChange }) => {
{/* Only the SEARCH can empty the pane outright. A column rule that
matches nothing keeps the table mounted — the header menu that
undoes it lives in the header. */}
- {filteredImages.length === 0 ? (
+ {loadError ? (
+ <ErrorState
+ error={loadError}
+ onRetry={loadImages}
+ />
+ ) : filteredImages.length === 0 ? (
<EmptyState
icon={Layers}
title={images.length === 0 ? t('app.imagesTab.noImages', 'No images') : t('app.imagesTab.noMatchingImages', 'No matching images')}