File size: 18,825 Bytes
205131a | 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 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 | // SQLite CLI E2E tests cover startup and target ownership before offline maintenance.
import { spawnSync } from "node:child_process";
import fs from "node:fs";
import path from "node:path";
import { withTempHome } from "openclaw/plugin-sdk/test-env";
import { describe, expect, it } from "vitest";
import { requireGitCommand as requireGit } from "../src/infra/git-exec.js";
import {
closeOpenClawAgentDatabaseByPath,
openOpenClawAgentDatabase,
} from "../src/state/openclaw-agent-db.js";
import {
closeOpenClawStateDatabase,
openOpenClawStateDatabase,
} from "../src/state/openclaw-state-db.js";
function runDoctorCli(args: string[], env: NodeJS.ProcessEnv) {
return spawnSync(process.execPath, ["openclaw.mjs", "doctor", ...args], {
cwd: process.cwd(),
env,
encoding: "utf8",
timeout: 60_000,
});
}
describe("SQLite CLI maintenance ownership", () => {
it("compacts after full CLI startup without retaining a config-health database handle", async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
try {
const database = openOpenClawStateDatabase({ env });
database.db.exec(`
CREATE TABLE compact_cli_payload (
id INTEGER PRIMARY KEY,
payload TEXT NOT NULL
);
BEGIN IMMEDIATE;
`);
const insert = database.db.prepare(
"INSERT INTO compact_cli_payload (payload) VALUES (?)",
);
for (let index = 0; index < 256; index += 1) {
insert.run(`${index}:${"x".repeat(8_192)}`);
}
database.db.exec(`
COMMIT;
DELETE FROM compact_cli_payload;
PRAGMA wal_checkpoint(TRUNCATE);
`);
} finally {
closeOpenClawStateDatabase();
}
const result = runDoctorCli(["--state-sqlite", "compact", "--json"], env);
expect(result.status, result.stderr || result.stdout).toBe(0);
const report = JSON.parse(result.stdout.trim()) as {
after: { autoVacuum: number; freelistPages: number };
before: { freelistPages: number };
integrityCheck: string;
skipped: boolean;
};
expect(report).toMatchObject({
after: {
autoVacuum: 2,
freelistPages: 0,
},
integrityCheck: "ok",
skipped: false,
});
expect(report.before.freelistPages).toBeGreaterThan(0);
expect(fs.existsSync(path.join(stateDir, "state", "openclaw.sqlite"))).toBe(true);
},
{ prefix: "openclaw-state-sqlite-cli-" },
);
}, 90_000);
it.skipIf(process.platform === "win32")(
"rejects hard-linked shared-state SQLite sidecars before compaction",
async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
const database = openOpenClawStateDatabase({ env });
const walPath = `${database.path}-wal`;
const externalWalPath = path.join(tempHome, "external-state", "openclaw.sqlite-wal");
try {
database.db.exec(`
PRAGMA wal_autocheckpoint = 0;
CREATE TABLE compact_sidecar_payload (
id INTEGER PRIMARY KEY,
payload TEXT NOT NULL
);
PRAGMA wal_checkpoint(TRUNCATE);
INSERT INTO compact_sidecar_payload (payload) VALUES ('committed wal frame');
`);
fs.mkdirSync(path.dirname(externalWalPath), { recursive: true });
fs.linkSync(walPath, externalWalPath);
const externalWalBefore = fs.readFileSync(externalWalPath);
expect(externalWalBefore.byteLength).toBeGreaterThan(0);
const result = runDoctorCli(["--state-sqlite", "compact", "--json"], env);
expect(result.status).not.toBe(0);
expect(`${result.stderr}\n${result.stdout}`).toContain("hard-linked path");
expect(fs.readFileSync(externalWalPath)).toEqual(externalWalBefore);
} finally {
closeOpenClawStateDatabase();
}
},
{ prefix: "openclaw-state-sqlite-sidecar-cli-" },
);
},
90_000,
);
it("rejects destructive explicit session stores outside the active state owner", async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const externalStorePath = path.join(
tempHome,
"external-state",
"agents",
"main",
"sessions",
"sessions.json",
);
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
const result = runDoctorCli(
["--session-sqlite", "compact", "--session-sqlite-store", externalStorePath, "--json"],
env,
);
expect(result.status).not.toBe(0);
expect(`${result.stderr}\n${result.stdout}`).toContain(
"outside the active OpenClaw state directory",
);
expect(fs.existsSync(externalStorePath)).toBe(false);
},
{ prefix: "openclaw-session-sqlite-cli-" },
);
}, 90_000);
it("rejects hard-linked SQLite sidecars before destructive maintenance", async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const storePath = path.join(stateDir, "agents", "main", "sessions", "sessions.json");
const sqlitePath = path.join(stateDir, "agents", "main", "agent", "openclaw-agent.sqlite");
const externalWalPath = path.join(tempHome, "external-state", "openclaw-agent.sqlite-wal");
fs.mkdirSync(path.dirname(storePath), { recursive: true });
fs.mkdirSync(path.dirname(sqlitePath), { recursive: true });
fs.mkdirSync(path.dirname(externalWalPath), { recursive: true });
fs.writeFileSync(storePath, "{}\n", "utf8");
fs.writeFileSync(externalWalPath, "external wal\n", "utf8");
fs.linkSync(externalWalPath, `${sqlitePath}-wal`);
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
const result = runDoctorCli(
["--session-sqlite", "compact", "--session-sqlite-store", storePath, "--json"],
env,
);
expect(result.status).not.toBe(0);
expect(`${result.stderr}\n${result.stdout}`).toContain("hard-linked path");
expect(fs.readFileSync(externalWalPath, "utf8")).toBe("external wal\n");
},
{ prefix: "openclaw-session-sqlite-sidecar-cli-" },
);
}, 90_000);
it.skipIf(process.platform === "win32")(
"rejects symbolic-linked SQLite sidecars before destructive maintenance",
async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const storePath = path.join(stateDir, "agents", "main", "sessions", "sessions.json");
const sqlitePath = path.join(
stateDir,
"agents",
"main",
"agent",
"openclaw-agent.sqlite",
);
const targetPath = path.join(stateDir, "agents", "main", "agent", "sidecar-target");
fs.mkdirSync(path.dirname(storePath), { recursive: true });
fs.mkdirSync(path.dirname(sqlitePath), { recursive: true });
fs.writeFileSync(storePath, "{}\n", "utf8");
fs.writeFileSync(targetPath, "owned target\n", "utf8");
fs.symlinkSync(targetPath, `${sqlitePath}-wal`);
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
const result = runDoctorCli(
["--session-sqlite", "compact", "--session-sqlite-store", storePath, "--json"],
env,
);
expect(result.status).not.toBe(0);
expect(`${result.stderr}\n${result.stdout}`).toContain("symbolic-link path");
expect(fs.readFileSync(targetPath, "utf8")).toBe("owned target\n");
},
{ prefix: "openclaw-session-sqlite-symlink-sidecar-cli-" },
);
},
90_000,
);
it("rejects hard-linked SQLite sidecars discovered through configured session stores", async () => {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const storePath = path.join(tempHome, "external-sessions", "sessions.json");
const sqlitePath = path.join(path.dirname(storePath), "openclaw-agent.sqlite");
const externalWalPath = path.join(tempHome, "external-alias", "openclaw-agent.sqlite-wal");
const configPath = path.join(stateDir, "openclaw.json");
fs.mkdirSync(path.dirname(storePath), { recursive: true });
fs.mkdirSync(path.dirname(externalWalPath), { recursive: true });
fs.mkdirSync(stateDir, { recursive: true });
fs.writeFileSync(storePath, "{}\n", "utf8");
fs.writeFileSync(configPath, JSON.stringify({ session: { store: storePath } }), "utf8");
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_CONFIG_PATH: configPath,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
};
delete env.OPENCLAW_HOME;
delete env.VITEST;
const database = openOpenClawAgentDatabase({
agentId: "main",
env,
path: sqlitePath,
});
const walPath = `${sqlitePath}-wal`;
try {
database.db.exec(`
PRAGMA wal_autocheckpoint = 0;
CREATE TABLE compact_sidecar_payload (
id INTEGER PRIMARY KEY,
payload TEXT NOT NULL
);
PRAGMA wal_checkpoint(TRUNCATE);
INSERT INTO compact_sidecar_payload (payload) VALUES ('committed wal frame');
`);
fs.linkSync(walPath, externalWalPath);
const externalWalBefore = fs.readFileSync(externalWalPath);
expect(externalWalBefore.byteLength).toBeGreaterThan(0);
const result = runDoctorCli(["--session-sqlite", "compact", "--json"], env);
expect(result.status).not.toBe(0);
expect(`${result.stderr}\n${result.stdout}`).toContain("hard-linked path");
expect(fs.readFileSync(externalWalPath)).toEqual(externalWalBefore);
} finally {
closeOpenClawAgentDatabaseByPath(sqlitePath);
}
},
{ prefix: "openclaw-configured-session-sqlite-sidecar-cli-" },
);
}, 90_000);
it.skipIf(process.platform === "win32")(
"keeps Git backup failures useful through the shipped CLI",
async () => {
const repository = fs.mkdtempSync(
path.join(fs.realpathSync("/var/tmp"), "openclaw-backup-git-cli-"),
);
try {
await withTempHome(
async (tempHome) => {
const stateDir = path.join(tempHome, ".openclaw");
const remote = path.join(tempHome, "remote.git");
const unborn = path.join(tempHome, "unborn");
const hooks = path.join(tempHome, "hooks");
const env: NodeJS.ProcessEnv = {
...process.env,
HOME: tempHome,
USERPROFILE: tempHome,
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
OPENCLAW_STATE_DIR: stateDir,
OPENCLAW_TEST_FAST: "1",
GIT_CONFIG_GLOBAL: "/dev/null",
GIT_CONFIG_NOSYSTEM: "1",
GIT_TERMINAL_PROMPT: "0",
NO_COLOR: "1",
};
delete env.OPENCLAW_CONFIG_PATH;
delete env.OPENCLAW_HOME;
delete env.VITEST;
openOpenClawStateDatabase({ env });
closeOpenClawStateDatabase();
await requireGit(tempHome, ["init", "--bare", remote]);
const entry = path.resolve(process.cwd(), "openclaw.mjs");
const runCli = (args: string[], childEnv: NodeJS.ProcessEnv = env) =>
spawnSync(process.execPath, [entry, ...args], {
cwd: process.cwd(),
env: childEnv,
encoding: "utf8",
timeout: 60_000,
});
const expectExit = (result: ReturnType<typeof runCli>, code: number) => {
expect(result.status, `${result.stderr}\n${result.stdout}`).toBe(code);
};
expectExit(
runCli(["backup", "git", "init", "--repository", repository, "--remote", remote]),
0,
);
await requireGit(repository, ["config", "user.name", "OpenClaw Backup Test"]);
await requireGit(repository, ["config", "user.email", "backup@example.invalid"]);
fs.mkdirSync(hooks);
const username = ["synthetic", "cli", "user"].join("-");
const password = ["synthetic", "cli", "password"].join("-");
const querySecret = ["synthetic", "cli", "query"].join("-");
const credentialUrl = `https://${username}:${password}@example.invalid/backup.git?access_token=${querySecret}`;
fs.writeFileSync(
path.join(hooks, "pre-push"),
[
"#!/bin/sh",
...Array.from(
{ length: 20 },
(_, index) => `printf 'stderr-old-${index} ${credentialUrl}\\n' >&2`,
),
`printf 'stderr-tail-🦞 ${credentialUrl}\\n' >&2`,
...Array.from(
{ length: 20 },
(_, index) => `printf 'stdout-old-${index} ${credentialUrl}\\n'`,
),
`printf 'stdout-tail-🐚 ${credentialUrl}\\n'`,
"exit 1",
].join("\n"),
{ mode: 0o700 },
);
await requireGit(repository, ["config", "core.hooksPath", hooks]);
const failedPush = runCli([
"backup",
"git",
"create",
"--repository",
repository,
"--global",
"--push",
"--exclude-secrets",
]);
expectExit(failedPush, 0);
const pushOutput = `${failedPush.stdout}\n${failedPush.stderr}`;
expect(pushOutput).toContain("git push failed (code=1, termination=exit)");
expect(pushOutput).toContain("stderr-tail-🦞");
expect(pushOutput).toContain("stdout-tail-🐚");
expect(pushOutput).toContain(
"https://***:***@example.invalid/backup.git?access_token=***",
);
expect(pushOutput).not.toContain(username);
expect(pushOutput).not.toContain(password);
expect(pushOutput).not.toContain(querySecret);
await requireGit(tempHome, ["init", unborn]);
const emptyHistory = runCli(["backup", "git", "log", "--repository", unborn]);
expectExit(emptyHistory, 0);
expect(emptyHistory.stdout).toContain("No Git backup commits");
const blob = await requireGit(repository, ["hash-object", "-w", "--stdin"], {
input: "not a commit\n",
});
await requireGit(repository, ["update-ref", "refs/tags/broken", blob]);
const quarantine = path.join(repository, ".git", "quarantine");
fs.mkdirSync(quarantine);
fs.renameSync(
path.join(repository, ".git", "objects", blob.slice(0, 2), blob.slice(2)),
path.join(quarantine, blob),
);
await requireGit(repository, ["symbolic-ref", "HEAD", "refs/tags/broken"]);
const historyUsername = ["synthetic", "history", "user"].join("-");
const historyPassword = ["synthetic", "history", "password"].join("-");
const historyQuery = ["synthetic", "history", "query"].join("-");
const failedHistory = runCli(
["backup", "git", "log", "--repository", repository, "--json"],
{
...env,
GIT_ALTERNATE_OBJECT_DIRECTORIES: `"/tmp/https://${historyUsername}:${historyPassword}@example.invalid/objects?access_token=${historyQuery}"`,
},
);
expectExit(failedHistory, 1);
const historyOutput = `${failedHistory.stdout}\n${failedHistory.stderr}`;
expect(historyOutput).toContain(
"git show-ref HEAD failed (code=128, termination=exit)",
);
expect(historyOutput).toContain("stderr:");
expect(historyOutput).toContain(
"https://***:***@example.invalid/objects?access_token=***",
);
expect(historyOutput).not.toContain(historyUsername);
expect(historyOutput).not.toContain(historyPassword);
expect(historyOutput).not.toContain(historyQuery);
},
{ prefix: "openclaw-backup-git-cli-" },
);
} finally {
fs.rmSync(repository, { recursive: true, force: true });
}
},
120_000,
);
});
|