File size: 2,778 Bytes
7d285f5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | import Docker from "dockerode";
const DEFAULT_DOCKER_PROBE_TIMEOUT_MS = 4000;
const WINDOWS_DOCKER_SOCKET_CANDIDATES = [
"//./pipe/docker_engine",
"//./pipe/dockerDesktopLinuxEngine",
] as const;
const POSIX_DOCKER_SOCKET_CANDIDATES = [
"/var/run/docker.sock",
] as const;
export interface DockerClientResolution {
docker: Docker;
socketPath: string;
}
export interface DockerAvailabilityResult {
available: boolean;
docker?: Docker;
socketPath?: string;
reason?: string;
}
function getConfiguredSocketPath(): string | null {
const configuredSocketPath = process.env.DOCKER_SOCKET_PATH?.trim();
return configuredSocketPath ? configuredSocketPath : null;
}
export function getDockerSocketCandidates(): string[] {
const configuredSocketPath = getConfiguredSocketPath();
const platformCandidates = process.platform === "win32"
? [...WINDOWS_DOCKER_SOCKET_CANDIDATES]
: [...POSIX_DOCKER_SOCKET_CANDIDATES];
return configuredSocketPath
? [configuredSocketPath, ...platformCandidates.filter((candidate) => candidate !== configuredSocketPath)]
: platformCandidates;
}
export function createDockerClient(socketPath?: string): Docker {
const resolvedSocketPath = socketPath ?? getDockerSocketCandidates()[0];
return new Docker({ socketPath: resolvedSocketPath });
}
async function pingDockerClient(docker: Docker, timeoutMs: number): Promise<void> {
let timeoutId: NodeJS.Timeout | null = null;
try {
await Promise.race([
docker.ping().then(() => undefined),
new Promise<never>((_, reject) => {
timeoutId = setTimeout(() => reject(new Error(`Docker ping timed out after ${timeoutMs}ms`)), timeoutMs);
}),
]);
} finally {
if (timeoutId) {
clearTimeout(timeoutId);
}
}
}
export async function resolveDockerClient(timeoutMs: number = DEFAULT_DOCKER_PROBE_TIMEOUT_MS): Promise<DockerClientResolution | null> {
for (const socketPath of getDockerSocketCandidates()) {
const docker = createDockerClient(socketPath);
try {
await pingDockerClient(docker, timeoutMs);
return { docker, socketPath };
} catch {
continue;
}
}
return null;
}
export async function probeDockerAvailability(timeoutMs: number = DEFAULT_DOCKER_PROBE_TIMEOUT_MS): Promise<DockerAvailabilityResult> {
const resolution = await resolveDockerClient(timeoutMs);
if (!resolution) {
return {
available: false,
reason: "Docker daemon unreachable",
};
}
return {
available: true,
docker: resolution.docker,
socketPath: resolution.socketPath,
};
}
|