diff --git a/server/src/__tests__/git-workspace-restoration-diagnostic.test.ts b/server/src/__tests__/git-workspace-restoration-diagnostic.test.ts index bc92845cc87..95bef204240 100644 --- a/server/src/__tests__/git-workspace-restoration-diagnostic.test.ts +++ b/server/src/__tests__/git-workspace-restoration-diagnostic.test.ts @@ -1,5 +1,12 @@ import { describe, expect, it } from "vitest"; -import { classifyWorkspaceRestorationError, GitCacheRestorationFailure } from "../services/git-workspace-restoration.js"; +import type { heartbeatRuns } from "@paperclipai/db"; +import { + classifyWorkspaceRestorationError, + GIT_CACHE_RESTORATION_FAILED_CODE, + GitCacheRestorationFailure, +} from "../services/git-workspace-restoration.js"; +import { collectRunFailureDiagnostics } from "../services/run-failure-diagnostics.js"; +import { failureCauseFromError } from "../services/heartbeat/run-failure-cause.js"; import { workspaceReopenDiagnostic } from "../services/execution-workspaces.js"; import { GitConnectionFailureError } from "../services/git-connection-failure.js"; @@ -56,4 +63,20 @@ describe("workspace restoration diagnostic", () => { expect(classifyWorkspaceRestorationError(gitError("", { code: "ERR_CHILD_PROCESS_STDIO_MAXBUFFER", killed: true }))).toBe("git_command"); expect(classifyWorkspaceRestorationError(Object.assign(new Error("unknown"), { code: "EUNRECOGNIZED" }))).toBe("unknown"); }); + + it("gives every restoration failure a stable code that run diagnostics and failure causes record", () => { + const run = { id: "run-restore", companyId: "company-restore", errorCode: "setup_failed", resultJson: null } as typeof heartbeatRuns.$inferSelect; + for (const failure of [ + new GitCacheRestorationFailure(), + new GitCacheRestorationFailure({ step: "saved_commit", kind: "commit_unavailable" }), + ]) { + expect(failure.code).toBe(GIT_CACHE_RESTORATION_FAILED_CODE); + expect(failureCauseFromError(failure)).toBe(GIT_CACHE_RESTORATION_FAILED_CODE); + expect(failureCauseFromError(new Error("Workspace reopen failed", { cause: failure }))).toBe(GIT_CACHE_RESTORATION_FAILED_CODE); + const exceptions = collectRunFailureDiagnostics(run, { error: failure, phase: "setup" }).exceptions; + expect(exceptions.at(-1)?.code).toBe(GIT_CACHE_RESTORATION_FAILED_CODE); + expect(classifyWorkspaceRestorationError(failure)).toBe(failure.kind ?? "verification"); + expect(failure.message).toBe("The saved workspace commit could not be restored. Check repository access and retry."); + } + }); }); diff --git a/server/src/services/git-workspace-restoration.ts b/server/src/services/git-workspace-restoration.ts index 2039039f03d..464d531577f 100644 --- a/server/src/services/git-workspace-restoration.ts +++ b/server/src/services/git-workspace-restoration.ts @@ -91,7 +91,10 @@ export type GitCacheRestorationStep = "recipe" | "trash_recovery" | "source_chec export type WorkspaceRestorationFailureKind = "remote_unavailable" | "auth_rejected" | "commit_unavailable" | "timeout" | "verification" | "filesystem" | "git_command" | "unknown"; +export const GIT_CACHE_RESTORATION_FAILED_CODE = "git_cache_restoration_failed"; + export class GitCacheRestorationFailure extends Error { + readonly code = GIT_CACHE_RESTORATION_FAILED_CODE; readonly step: GitCacheRestorationStep | null; readonly kind: WorkspaceRestorationFailureKind | null; constructor(diagnostic: { step: GitCacheRestorationStep; kind: WorkspaceRestorationFailureKind } | null = null) {