mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 16:08:56 +00:00
fix(cli): say when the Docker image build times out instead of blaming Docker (#5394)
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { describeDockerBuildFailure } from "./dockerBuildFailure.js";
|
||||
|
||||
function spawnError(message: string, code: string): Error {
|
||||
return Object.assign(new Error(message), { code });
|
||||
}
|
||||
|
||||
describe("describeDockerBuildFailure", () => {
|
||||
it("says the build timed out and that a rerun continues from the cached layers", () => {
|
||||
const error = new Error("Failed to build Docker image: spawnSync docker ETIMEDOUT", {
|
||||
cause: spawnError("spawnSync docker ETIMEDOUT", "ETIMEDOUT"),
|
||||
});
|
||||
const failure = describeDockerBuildFailure(error);
|
||||
expect(failure.title).toBe("Docker image build timed out");
|
||||
expect(failure.message).toContain("longer than 10 minutes");
|
||||
expect(failure.hint).toContain("Run the same command again");
|
||||
expect(failure.hint).not.toContain("docker info");
|
||||
});
|
||||
|
||||
it("keeps pointing at the Docker install when the binary is missing", () => {
|
||||
const error = new Error("Failed to build Docker image: spawnSync docker ENOENT", {
|
||||
cause: spawnError("spawnSync docker ENOENT", "ENOENT"),
|
||||
});
|
||||
expect(describeDockerBuildFailure(error)).toEqual({
|
||||
title: "Docker not available",
|
||||
message: "Failed to build Docker image: spawnSync docker ENOENT",
|
||||
hint: "Install Docker: https://docs.docker.com/get-docker/",
|
||||
});
|
||||
});
|
||||
|
||||
it("keeps the docker info hint for any other build failure", () => {
|
||||
const error = new Error("Failed to build Docker image: Command failed: docker build", {
|
||||
cause: spawnError("Command failed: docker build", "1"),
|
||||
});
|
||||
expect(describeDockerBuildFailure(error)).toEqual({
|
||||
title: "Docker image build failed",
|
||||
message: "Failed to build Docker image: Command failed: docker build",
|
||||
hint: "Check Docker is running: docker info",
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,36 @@
|
||||
import { normalizeErrorMessage } from "./errorMessage.js";
|
||||
|
||||
export const DOCKER_BUILD_TIMEOUT_MINUTES = 10;
|
||||
|
||||
interface DockerBuildFailure {
|
||||
title: string;
|
||||
message: string;
|
||||
hint: string;
|
||||
}
|
||||
|
||||
function isSpawnTimeout(error: unknown): boolean {
|
||||
return error instanceof Error && "code" in error && error.code === "ETIMEDOUT";
|
||||
}
|
||||
|
||||
export function describeDockerBuildFailure(error: unknown): DockerBuildFailure {
|
||||
if (error instanceof Error && isSpawnTimeout(error.cause)) {
|
||||
return {
|
||||
title: "Docker image build timed out",
|
||||
message: `Building the render image took longer than ${DOCKER_BUILD_TIMEOUT_MINUTES} minutes, so it was stopped.`,
|
||||
hint: "Run the same command again. Docker keeps the layers it already built, so the build picks up where it stopped.",
|
||||
};
|
||||
}
|
||||
const message = normalizeErrorMessage(error);
|
||||
if (/connect|not found|ENOENT/i.test(message)) {
|
||||
return {
|
||||
title: "Docker not available",
|
||||
message,
|
||||
hint: "Install Docker: https://docs.docker.com/get-docker/",
|
||||
};
|
||||
}
|
||||
return {
|
||||
title: "Docker image build failed",
|
||||
message,
|
||||
hint: "Check Docker is running: docker info",
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user