File size: 6,280 Bytes
fc93158 | 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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | import { spinner } from "@clack/prompts";
import { formatDurationPrecise } from "../../infra/format-time/format-duration.ts";
import type {
UpdateRunResult,
UpdateStepInfo,
UpdateStepProgress,
} from "../../infra/update-runner.js";
import { defaultRuntime } from "../../runtime.js";
import { theme } from "../../terminal/theme.js";
import type { UpdateCommandOptions } from "./shared.js";
const STEP_LABELS: Record<string, string> = {
"clean check": "Working directory is clean",
"upstream check": "Upstream branch exists",
"git fetch": "Fetching latest changes",
"git rebase": "Rebasing onto target commit",
"git rev-parse @{upstream}": "Resolving upstream commit",
"git rev-list": "Enumerating candidate commits",
"git clone": "Cloning git checkout",
"preflight worktree": "Preparing preflight worktree",
"preflight cleanup": "Cleaning preflight worktree",
"deps install": "Installing dependencies",
build: "Building",
"ui:build": "Building UI assets",
"ui:build (post-doctor repair)": "Restoring missing UI assets",
"ui assets verify": "Validating UI assets",
"openclaw doctor entry": "Checking doctor entrypoint",
"openclaw doctor": "Running doctor checks",
"git rev-parse HEAD (after)": "Verifying update",
"global update": "Updating via package manager",
"global update (omit optional)": "Retrying update without optional deps",
"global install": "Installing global package",
};
function getStepLabel(step: UpdateStepInfo): string {
return STEP_LABELS[step.name] ?? step.name;
}
export function inferUpdateFailureHints(result: UpdateRunResult): string[] {
if (result.status !== "error" || result.mode !== "npm") {
return [];
}
const failedStep = [...result.steps].toReversed().find((step) => step.exitCode !== 0);
if (!failedStep) {
return [];
}
const stderr = (failedStep.stderrTail ?? "").toLowerCase();
const hints: string[] = [];
if (failedStep.name.startsWith("global update") && stderr.includes("eacces")) {
hints.push(
"Detected permission failure (EACCES). Re-run with a writable global prefix or sudo (for system-managed Node installs).",
);
hints.push("Example: npm config set prefix ~/.local && npm i -g openclaw@latest");
}
if (
failedStep.name.startsWith("global update") &&
(stderr.includes("node-gyp") || stderr.includes("prebuild"))
) {
hints.push(
"Detected native optional dependency build failure. The updater retries with --omit=optional automatically.",
);
hints.push("If it still fails: npm i -g openclaw@latest --omit=optional");
}
return hints;
}
export type ProgressController = {
progress: UpdateStepProgress;
stop: () => void;
};
export function createUpdateProgress(enabled: boolean): ProgressController {
if (!enabled) {
return {
progress: {},
stop: () => {},
};
}
let currentSpinner: ReturnType<typeof spinner> | null = null;
const progress: UpdateStepProgress = {
onStepStart: (step) => {
currentSpinner = spinner();
currentSpinner.start(theme.accent(getStepLabel(step)));
},
onStepComplete: (step) => {
if (!currentSpinner) {
return;
}
const label = getStepLabel(step);
const duration = theme.muted(`(${formatDurationPrecise(step.durationMs)})`);
const icon = step.exitCode === 0 ? theme.success("\u2713") : theme.error("\u2717");
currentSpinner.stop(`${icon} ${label} ${duration}`);
currentSpinner = null;
if (step.exitCode !== 0 && step.stderrTail) {
const lines = step.stderrTail.split("\n").slice(-10);
for (const line of lines) {
if (line.trim()) {
defaultRuntime.log(` ${theme.error(line)}`);
}
}
}
},
};
return {
progress,
stop: () => {
if (currentSpinner) {
currentSpinner.stop();
currentSpinner = null;
}
},
};
}
function formatStepStatus(exitCode: number | null): string {
if (exitCode === 0) {
return theme.success("\u2713");
}
if (exitCode === null) {
return theme.warn("?");
}
return theme.error("\u2717");
}
type PrintResultOptions = UpdateCommandOptions & {
hideSteps?: boolean;
};
export function printResult(result: UpdateRunResult, opts: PrintResultOptions): void {
if (opts.json) {
defaultRuntime.log(JSON.stringify(result, null, 2));
return;
}
const statusColor =
result.status === "ok" ? theme.success : result.status === "skipped" ? theme.warn : theme.error;
defaultRuntime.log("");
defaultRuntime.log(
`${theme.heading("Update Result:")} ${statusColor(result.status.toUpperCase())}`,
);
if (result.root) {
defaultRuntime.log(` Root: ${theme.muted(result.root)}`);
}
if (result.reason) {
defaultRuntime.log(` Reason: ${theme.muted(result.reason)}`);
}
if (result.before?.version || result.before?.sha) {
const before = result.before.version ?? result.before.sha?.slice(0, 8) ?? "";
defaultRuntime.log(` Before: ${theme.muted(before)}`);
}
if (result.after?.version || result.after?.sha) {
const after = result.after.version ?? result.after.sha?.slice(0, 8) ?? "";
defaultRuntime.log(` After: ${theme.muted(after)}`);
}
if (!opts.hideSteps && result.steps.length > 0) {
defaultRuntime.log("");
defaultRuntime.log(theme.heading("Steps:"));
for (const step of result.steps) {
const status = formatStepStatus(step.exitCode);
const duration = theme.muted(`(${formatDurationPrecise(step.durationMs)})`);
defaultRuntime.log(` ${status} ${step.name} ${duration}`);
if (step.exitCode !== 0 && step.stderrTail) {
const lines = step.stderrTail.split("\n").slice(0, 5);
for (const line of lines) {
if (line.trim()) {
defaultRuntime.log(` ${theme.error(line)}`);
}
}
}
}
}
const hints = inferUpdateFailureHints(result);
if (hints.length > 0) {
defaultRuntime.log("");
defaultRuntime.log(theme.heading("Recovery hints:"));
for (const hint of hints) {
defaultRuntime.log(` - ${theme.warn(hint)}`);
}
}
defaultRuntime.log("");
defaultRuntime.log(`Total time: ${theme.muted(formatDurationPrecise(result.durationMs))}`);
}
|