File size: 10,401 Bytes
f778c12 | 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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | // Daemon lifecycle config guard tests cover config checks before service lifecycle actions.
import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import { VERSION } from "../../version.js";
import {
lifecycleTestRuntime,
resetLifecycleRuntimeLogs,
resetLifecycleServiceMocks,
service,
stubEmptyGatewayEnv,
} from "./test-helpers/lifecycle-core-harness.js";
const readConfigFileSnapshotMock = vi.fn();
const loadConfig = vi.fn(() => ({}));
const newerConfigHints = [
"Run the newer openclaw binary on PATH, or reinstall the intended gateway service from the newer install.",
"Set OPENCLAW_ALLOW_OLDER_BINARY_DESTRUCTIVE_ACTIONS=1 only for an intentional downgrade or recovery action.",
];
const newerConfigHintItems = newerConfigHints.map((text) => ({ kind: "generic", text }));
const invalidConfigRecoveryHint = [
'Run "openclaw doctor --fix" to repair, then retry.',
"If startup is still blocked, inspect the adjacent .bak backup before restoring it manually.",
].join("\n");
const pluginPackagingRecoveryHints = [
"This is a plugin packaging issue, not a local config problem.",
"Update or reinstall the plugin after the publisher ships compiled JavaScript, or disable/uninstall the plugin until then.",
];
const pluginPackagingHintItems = pluginPackagingRecoveryHints.map((text) => ({
kind: "generic",
text,
}));
function expectLatestRuntimeJson(payload: unknown) {
const calls = lifecycleTestRuntime.writeJson.mock.calls;
expect(calls[calls.length - 1]?.[0]).toEqual(payload);
}
vi.mock("../../config/config.js", () => ({
getRuntimeConfig: () => loadConfig(),
loadConfig: () => loadConfig(),
readConfigFileSnapshot: () => readConfigFileSnapshotMock(),
}));
vi.mock("../../config/issue-format.js", () => ({
formatConfigIssueLines: (
issues: Array<{ path: string; message: string }>,
_prefix: string,
_opts?: unknown,
) => issues.map((i) => `${i.path}: ${i.message}`),
}));
vi.mock("../../runtime.js", () => ({
defaultRuntime: lifecycleTestRuntime,
}));
function setConfigSnapshot(params: {
exists: boolean;
valid: boolean;
issues?: Array<{ path: string; message: string }>;
warnings?: Array<{ path: string; message: string }>;
legacyIssues?: Array<{ path: string; message: string }>;
lastTouchedVersion?: string;
}) {
const config = params.lastTouchedVersion
? { meta: { lastTouchedVersion: params.lastTouchedVersion } }
: {};
readConfigFileSnapshotMock.mockResolvedValue({
exists: params.exists,
valid: params.valid,
config,
sourceConfig: config,
issues: params.issues ?? [],
warnings: params.warnings ?? [],
legacyIssues: params.legacyIssues ?? [],
});
}
function setPluginPackagingInvalidSnapshot() {
setConfigSnapshot({
exists: true,
valid: false,
issues: [
{
path: "plugins.slots.memory",
message: "plugin not found: source-only-pack",
},
],
warnings: [
{
path: "plugins",
message:
"plugin source-only-pack: installed plugin package requires compiled runtime output for TypeScript entry index.ts: expected ./dist/index.js. This is a plugin packaging issue, not a local config problem.",
},
],
});
}
function createServiceRunArgs() {
return {
serviceNoun: "Gateway",
service,
renderStartHints: () => [],
opts: { json: true },
};
}
describe("runServiceRestart config pre-flight (#35862)", () => {
let runServiceRestart: typeof import("./lifecycle-core.js").runServiceRestart;
beforeAll(async () => {
({ runServiceRestart } = await import("./lifecycle-core.js"));
});
beforeEach(() => {
resetLifecycleRuntimeLogs();
readConfigFileSnapshotMock.mockReset();
setConfigSnapshot({ exists: true, valid: true });
loadConfig.mockReset();
loadConfig.mockReturnValue({});
resetLifecycleServiceMocks();
stubEmptyGatewayEnv();
});
it("aborts restart when config is invalid", async () => {
setConfigSnapshot({
exists: true,
valid: false,
issues: [{ path: "agents.defaults.pdfModel", message: "Unrecognized key" }],
});
await expect(runServiceRestart(createServiceRunArgs())).rejects.toThrow("__exit__:1");
expect(service.restart).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "restart",
ok: false,
error: `Gateway aborted: config is invalid.\nagents.defaults.pdfModel: Unrecognized key\n${invalidConfigRecoveryHint}`,
hints: undefined,
hintItems: undefined,
warnings: undefined,
});
});
it("points restart at plugin packaging recovery for packaging-only invalid config", async () => {
setPluginPackagingInvalidSnapshot();
await expect(runServiceRestart(createServiceRunArgs())).rejects.toThrow("__exit__:1");
expect(service.restart).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "restart",
ok: false,
error: "Gateway restart blocked: plugins.slots.memory: plugin not found: source-only-pack",
hints: pluginPackagingRecoveryHints,
hintItems: pluginPackagingHintItems,
warnings: undefined,
});
});
it("blocks restart from an older binary when config was written by a newer one", async () => {
setConfigSnapshot({ exists: true, valid: true, lastTouchedVersion: "9999.1.1" });
await expect(runServiceRestart(createServiceRunArgs())).rejects.toThrow("__exit__:1");
expect(service.restart).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "restart",
ok: false,
error: `Gateway restart blocked: Refusing to restart the gateway service because this OpenClaw binary (${VERSION}) is older than the config last written by OpenClaw 9999.1.1.`,
hints: newerConfigHints,
hintItems: newerConfigHintItems,
warnings: undefined,
});
});
it("proceeds with restart when config is valid", async () => {
setConfigSnapshot({ exists: true, valid: true });
const result = await runServiceRestart(createServiceRunArgs());
expect(result).toBe(true);
expect(service.restart).toHaveBeenCalledTimes(1);
});
it("proceeds with restart when config file does not exist", async () => {
setConfigSnapshot({ exists: false, valid: true });
const result = await runServiceRestart(createServiceRunArgs());
expect(result).toBe(true);
expect(service.restart).toHaveBeenCalledTimes(1);
});
it("proceeds with restart when snapshot read throws", async () => {
readConfigFileSnapshotMock.mockRejectedValue(new Error("read failed"));
const result = await runServiceRestart(createServiceRunArgs());
expect(result).toBe(true);
expect(service.restart).toHaveBeenCalledTimes(1);
});
});
describe("runServiceStart config pre-flight (#35862)", () => {
let runServiceStart: typeof import("./lifecycle-core.js").runServiceStart;
beforeAll(async () => {
({ runServiceStart } = await import("./lifecycle-core.js"));
});
beforeEach(() => {
resetLifecycleRuntimeLogs();
readConfigFileSnapshotMock.mockReset();
setConfigSnapshot({ exists: true, valid: true });
resetLifecycleServiceMocks();
});
it("aborts start when config is invalid", async () => {
setConfigSnapshot({
exists: true,
valid: false,
issues: [{ path: "agents.defaults.pdfModel", message: "Unrecognized key" }],
});
await expect(runServiceStart(createServiceRunArgs())).rejects.toThrow("__exit__:1");
expect(service.start).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "start",
ok: false,
error: `Gateway aborted: config is invalid.\nagents.defaults.pdfModel: Unrecognized key\n${invalidConfigRecoveryHint}`,
hints: undefined,
hintItems: undefined,
warnings: undefined,
});
});
it("points start at plugin packaging recovery for packaging-only invalid config", async () => {
setPluginPackagingInvalidSnapshot();
await expect(runServiceStart(createServiceRunArgs())).rejects.toThrow("__exit__:1");
expect(service.start).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "start",
ok: false,
error: "Gateway start blocked: plugins.slots.memory: plugin not found: source-only-pack",
hints: pluginPackagingRecoveryHints,
hintItems: pluginPackagingHintItems,
warnings: undefined,
});
});
it("aborts before not-loaded start recovery when config is invalid", async () => {
const onNotLoaded = vi.fn(async () => ({
result: "started" as const,
loaded: true,
}));
setConfigSnapshot({
exists: true,
valid: false,
issues: [{ path: "agents.defaults.pdfModel", message: "Unrecognized key" }],
});
await expect(
runServiceStart({
...createServiceRunArgs(),
onNotLoaded,
}),
).rejects.toThrow("__exit__:1");
expect(onNotLoaded).not.toHaveBeenCalled();
expect(service.start).not.toHaveBeenCalled();
});
it("proceeds with start when config is valid", async () => {
setConfigSnapshot({ exists: true, valid: true });
await runServiceStart(createServiceRunArgs());
expect(service.start).toHaveBeenCalledTimes(1);
});
});
describe("runServiceStop future-config guard", () => {
let runServiceStop: typeof import("./lifecycle-core.js").runServiceStop;
beforeAll(async () => {
({ runServiceStop } = await import("./lifecycle-core.js"));
});
beforeEach(() => {
resetLifecycleRuntimeLogs();
readConfigFileSnapshotMock.mockReset();
setConfigSnapshot({ exists: true, valid: true });
resetLifecycleServiceMocks();
});
it("blocks stop from an older binary when config was written by a newer one", async () => {
setConfigSnapshot({ exists: true, valid: true, lastTouchedVersion: "9999.1.1" });
await expect(
runServiceStop({
serviceNoun: "Gateway",
service,
opts: { json: true },
}),
).rejects.toThrow("__exit__:1");
expect(service.stop).not.toHaveBeenCalled();
expectLatestRuntimeJson({
action: "stop",
ok: false,
error: `Gateway stop blocked: Refusing to stop the gateway service because this OpenClaw binary (${VERSION}) is older than the config last written by OpenClaw 9999.1.1.`,
hints: newerConfigHints,
hintItems: newerConfigHintItems,
warnings: undefined,
});
});
});
|