fix: address release v2 reviews

This commit is contained in:
ajnart committed 2026-08-14 02:18:46 +02:00
1 parent 4905ea6738
commit 32732680e5
55 files changed
+925 -294

No files matched your search

+65 -33
View File
@@ -41,7 +41,7 @@ const withDockerTimeoutAsync = async <T>(
}
};
const isDemoMode = ["1", "yes", "t", "true"].includes((process.env.DEMO_MODE ?? "").toLowerCase());
const isDemoMode = () => ["1", "yes", "t", "true"].includes((process.env.DEMO_MODE ?? "").toLowerCase());
const port = (privatePort: number, publicPort: number, type: string): Port => ({
IP: "0.0.0.0",
@@ -197,7 +197,7 @@ const mockContainers: {
export const dockerContainersRequestHandler = createWidgetRequestHandler({
async requestAsync() {
if (isDemoMode) {
if (isDemoMode()) {
return {
containers: mockContainers.map((container) => ({
...container,
@@ -228,7 +228,10 @@ const extractImage = (container: ContainerInfo) => extractContainerImageName(con
export const hasDockerEndpointCapability = (
endpointId: string,
capability: "inventory" | "logs" | "lifecycle" | "remove",
) => DockerSingleton.hasCapability(endpointId, capability);
) =>
isDemoMode()
? endpointId === "demo" && capability === "inventory"
: DockerSingleton.hasCapability(endpointId, capability);
export const findDockerContainerAsync = async (
{ endpointId, id }: DockerContainerTarget,
@@ -302,6 +305,7 @@ export const streamContainerLogsAsync = async (
export async function getContainersWithStatsAsync(timeoutMs = dockerWidgetEndpointTimeoutMs) {
const dockerInstances = DockerSingleton.getInstances();
const initializationFailures = DockerSingleton.getInitializationFailures();
const results = await Promise.allSettled(
dockerInstances.map(async ({ instance, host, endpointId, endpointName }) => {
const instanceContainers = await withDockerTimeoutAsync(
@@ -315,20 +319,32 @@ export async function getContainersWithStatsAsync(timeoutMs = dockerWidgetEndpoi
}),
);
const endpoints = results.map((result, index) => {
const dockerInstance = dockerInstances.at(index);
if (!dockerInstance) throw new Error("Docker endpoint result did not match a configured endpoint");
return {
id: dockerInstance.endpointId,
name: dockerInstance.endpointName,
status: result.status === "fulfilled" ? "available" : "unavailable",
kind: dockerInstance.descriptor.kind,
transport: dockerInstance.descriptor.transport.type,
capabilities: dockerInstance.descriptor.capabilities,
source: dockerInstance.descriptor.source,
scope: dockerInstance.descriptor.scope,
} satisfies DockerEndpointStatus;
});
const endpoints = [
...results.map((result, index) => {
const dockerInstance = dockerInstances.at(index);
if (!dockerInstance) throw new Error("Docker endpoint result did not match a configured endpoint");
return {
id: dockerInstance.endpointId,
name: dockerInstance.endpointName,
status: result.status === "fulfilled" ? ("available" as const) : ("unavailable" as const),
kind: dockerInstance.descriptor.kind,
transport: dockerInstance.descriptor.transport.type,
capabilities: dockerInstance.descriptor.capabilities,
source: dockerInstance.descriptor.source,
scope: dockerInstance.descriptor.scope,
} satisfies DockerEndpointStatus;
}),
...initializationFailures.map(({ descriptor }) => ({
id: descriptor.id,
name: descriptor.name,
status: "unavailable" as const,
kind: descriptor.kind,
transport: descriptor.transport.type,
capabilities: descriptor.capabilities,
source: descriptor.source,
scope: descriptor.scope,
})),
] satisfies DockerEndpointStatus[];
const containers = results.flatMap((result, index) => {
if (result.status === "fulfilled") return result.value;
@@ -354,24 +370,35 @@ export async function getContainersWithStatsAsync(timeoutMs = dockerWidgetEndpoi
})
: [];
const degradedEndpointIds = new Set<string>();
const containerStatsPromises = containers.map(async (container) => {
const instance = DockerSingleton.findInstance(container.endpointId)?.instance;
if (!instance) return null;
const stats = await withDockerTimeoutAsync(
async (signal) => {
const options = { stream: false as const, "one-shot": true, abortSignal: signal };
return await instance.getContainer(container.Id).stats(options);
},
`Timed out reading Docker container stats for ${container.Id}`,
timeoutMs,
).catch(
() =>
({
cpu_stats: { online_cpus: 0, cpu_usage: { total_usage: 0 }, system_cpu_usage: 0 },
memory_stats: { usage: 0 },
}) as ContainerStats,
);
let stats: ContainerStats;
try {
stats = await withDockerTimeoutAsync(
async (signal) => {
const options = { stream: false as const, "one-shot": true, abortSignal: signal };
return await instance.getContainer(container.Id).stats(options);
},
`Timed out reading Docker container stats for ${container.Id}`,
timeoutMs,
);
} catch (error) {
degradedEndpointIds.add(container.endpointId);
logger.warn(
new ErrorWithMetadata(
"Failed to read Docker container stats",
{ endpointId: container.endpointId, containerId: container.Id, host: container.instance },
{ cause: error },
),
);
stats = {
cpu_stats: { online_cpus: 0, cpu_usage: { total_usage: 0 }, system_cpu_usage: 0 },
memory_stats: { usage: 0 },
} as ContainerStats;
}
const cpuUsage = calculateCpuUsage(stats);
const memoryUsage = calculateMemoryUsage(stats);
@@ -392,9 +419,14 @@ export async function getContainersWithStatsAsync(timeoutMs = dockerWidgetEndpoi
};
});
const resolvedContainers = (await Promise.all(containerStatsPromises)).filter((container) => container !== null);
return {
containers: (await Promise.all(containerStatsPromises)).filter((container) => container !== null),
endpoints,
containers: resolvedContainers,
endpoints: endpoints.map((endpoint) =>
endpoint.status === "available" && degradedEndpointIds.has(endpoint.id)
? { ...endpoint, status: "degraded" as const }
: endpoint,
),
};
}
@@ -4,7 +4,12 @@ import { describe, expect, test, vi } from "vitest";
import { createDb } from "@homarr/db/test";
import { DockerSingleton } from "@homarr/docker";
import { calculateCpuUsage, calculateMemoryUsage, getContainersWithStatsAsync } from "../docker";
import {
calculateCpuUsage,
calculateMemoryUsage,
getContainersWithStatsAsync,
hasDockerEndpointCapability,
} from "../docker";
vi.mock("@homarr/db", async (importActual) => {
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
@@ -144,7 +149,7 @@ describe("getContainersWithStatsAsync", () => {
}
});
test("returns a container with zeroed stats when its stats request times out", async () => {
test("marks an endpoint degraded and returns zeroed stats when its stats request times out", async () => {
vi.useFakeTimers();
try {
const dockerInstance = createDockerInstance("healthy", async () => [
@@ -173,11 +178,50 @@ describe("getContainersWithStatsAsync", () => {
expect(observedSignal?.aborted).toBe(true);
expect(result.containers).toEqual([expect.objectContaining({ id: "container-1", cpuUsage: 0, memoryUsage: 0 })]);
expect(result.endpoints).toEqual([expect.objectContaining({ id: "healthy", status: "degraded" })]);
} finally {
vi.useRealTimers();
vi.restoreAllMocks();
}
});
test("includes endpoints that failed during TLS initialization", async () => {
vi.spyOn(DockerSingleton, "getInstances").mockReturnValue([]);
vi.spyOn(DockerSingleton, "getInitializationFailures").mockReturnValue([
{
host: "broken.example:2376",
descriptor: {
id: "broken-tls",
name: "Broken TLS",
kind: "docker",
transport: { type: "tls", host: "broken.example", port: 2376, caPath: "/missing/ca.pem" },
capabilities: ["inventory"],
scope: "admin",
source: "environment",
},
},
]);
const result = await getContainersWithStatsAsync(50);
expect(result.endpoints).toEqual([
expect.objectContaining({ id: "broken-tls", status: "unavailable", transport: "tls" }),
]);
vi.restoreAllMocks();
});
});
test("demo capabilities match the advertised inventory-only endpoint", () => {
const previousDemoMode = process.env.DEMO_MODE;
process.env.DEMO_MODE = "true";
try {
expect(hasDockerEndpointCapability("demo", "inventory")).toBe(true);
expect(hasDockerEndpointCapability("demo", "logs")).toBe(false);
expect(hasDockerEndpointCapability("other", "inventory")).toBe(false);
} finally {
if (previousDemoMode === undefined) delete process.env.DEMO_MODE;
else process.env.DEMO_MODE = previousDemoMode;
}
});
const createDockerInstance = (endpointId: string, listContainers: () => Promise<unknown[]>) => ({