fix: use STATE_DIR instead of hardcoded ~/.openclaw for identity and canvas (#4824)
* fix: use STATE_DIR instead of hardcoded ~/.openclaw for identity and canvas device-identity.ts and canvas-host/server.ts used hardcoded path.join(os.homedir(), '.openclaw', ...) ignoring OPENCLAW_STATE_DIR env var and the resolveStateDir() logic from config/paths.ts. This caused ~/.openclaw/identity and ~/.openclaw/canvas directories to be created even when state dir was overridden or resided elsewhere. * fix: format and remove duplicate imports * fix: scope state-dir patch + add regression tests (#4824) (thanks @kossoy) * fix: align state-dir fallbacks in hooks and agent paths (#4824) (thanks @kossoy) --------- Co-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
This commit is contained in:
@@ -15,6 +15,7 @@ Docs: https://docs.openclaw.ai
|
|||||||
- Memory: set Voyage embeddings `input_type` for improved retrieval. (#10818) Thanks @mcinteerj.
|
- Memory: set Voyage embeddings `input_type` for improved retrieval. (#10818) Thanks @mcinteerj.
|
||||||
- Memory/QMD: run boot refresh in background by default, add configurable QMD maintenance timeouts, and retry QMD after fallback failures. (#9690, #9705)
|
- Memory/QMD: run boot refresh in background by default, add configurable QMD maintenance timeouts, and retry QMD after fallback failures. (#9690, #9705)
|
||||||
- Media understanding: recognize `.caf` audio attachments for transcription. (#10982) Thanks @succ985.
|
- Media understanding: recognize `.caf` audio attachments for transcription. (#10982) Thanks @succ985.
|
||||||
|
- State dir: honor `OPENCLAW_STATE_DIR` for default device identity and canvas storage paths. (#4824) Thanks @kossoy.
|
||||||
- Tests: harden flaky hotspots by removing timer sleeps, consolidating onboarding provider-auth coverage, and improving memory test realism. (#11598) Thanks @gumadeiras.
|
- Tests: harden flaky hotspots by removing timer sleeps, consolidating onboarding provider-auth coverage, and improving memory test realism. (#11598) Thanks @gumadeiras.
|
||||||
|
|
||||||
## 2026.2.6
|
## 2026.2.6
|
||||||
|
|||||||
@@ -178,7 +178,8 @@ export function resolveAgentWorkspaceDir(cfg: OpenClawConfig, agentId: string) {
|
|||||||
}
|
}
|
||||||
return DEFAULT_AGENT_WORKSPACE_DIR;
|
return DEFAULT_AGENT_WORKSPACE_DIR;
|
||||||
}
|
}
|
||||||
return path.join(os.homedir(), ".openclaw", `workspace-${id}`);
|
const stateDir = resolveStateDir(process.env, os.homedir);
|
||||||
|
return path.join(stateDir, `workspace-${id}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function resolveAgentDir(cfg: OpenClawConfig, agentId: string) {
|
export function resolveAgentDir(cfg: OpenClawConfig, agentId: string) {
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
import os from "node:os";
|
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { CHANNEL_IDS } from "../../channels/registry.js";
|
import { CHANNEL_IDS } from "../../channels/registry.js";
|
||||||
import { STATE_DIR } from "../../config/config.js";
|
import { STATE_DIR } from "../../config/config.js";
|
||||||
|
|
||||||
export const DEFAULT_SANDBOX_WORKSPACE_ROOT = path.join(os.homedir(), ".openclaw", "sandboxes");
|
export const DEFAULT_SANDBOX_WORKSPACE_ROOT = path.join(STATE_DIR, "sandboxes");
|
||||||
|
|
||||||
export const DEFAULT_SANDBOX_IMAGE = "openclaw-sandbox:bookworm-slim";
|
export const DEFAULT_SANDBOX_IMAGE = "openclaw-sandbox:bookworm-slim";
|
||||||
export const DEFAULT_SANDBOX_CONTAINER_PREFIX = "openclaw-sbx-";
|
export const DEFAULT_SANDBOX_CONTAINER_PREFIX = "openclaw-sbx-";
|
||||||
@@ -47,7 +46,6 @@ export const DEFAULT_SANDBOX_BROWSER_AUTOSTART_TIMEOUT_MS = 12_000;
|
|||||||
|
|
||||||
export const SANDBOX_AGENT_WORKSPACE_MOUNT = "/agent";
|
export const SANDBOX_AGENT_WORKSPACE_MOUNT = "/agent";
|
||||||
|
|
||||||
const resolvedSandboxStateDir = STATE_DIR ?? path.join(os.homedir(), ".openclaw");
|
export const SANDBOX_STATE_DIR = path.join(STATE_DIR, "sandbox");
|
||||||
export const SANDBOX_STATE_DIR = path.join(resolvedSandboxStateDir, "sandbox");
|
|
||||||
export const SANDBOX_REGISTRY_PATH = path.join(SANDBOX_STATE_DIR, "containers.json");
|
export const SANDBOX_REGISTRY_PATH = path.join(SANDBOX_STATE_DIR, "containers.json");
|
||||||
export const SANDBOX_BROWSER_REGISTRY_PATH = path.join(SANDBOX_STATE_DIR, "browsers.json");
|
export const SANDBOX_BROWSER_REGISTRY_PATH = path.join(SANDBOX_STATE_DIR, "browsers.json");
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import os from "node:os";
|
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import type { OpenClawConfig } from "../config/config.js";
|
import type { OpenClawConfig } from "../config/config.js";
|
||||||
|
import { resolveStateDir } from "../config/paths.js";
|
||||||
import { resolveRunWorkspaceDir } from "./workspace-run.js";
|
import { resolveRunWorkspaceDir } from "./workspace-run.js";
|
||||||
import { DEFAULT_AGENT_WORKSPACE_DIR } from "./workspace.js";
|
import { DEFAULT_AGENT_WORKSPACE_DIR } from "./workspace.js";
|
||||||
|
|
||||||
@@ -93,7 +93,9 @@ describe("resolveRunWorkspaceDir", () => {
|
|||||||
|
|
||||||
expect(result.agentId).toBe("research");
|
expect(result.agentId).toBe("research");
|
||||||
expect(result.agentIdSource).toBe("explicit");
|
expect(result.agentIdSource).toBe("explicit");
|
||||||
expect(result.workspaceDir).toBe(path.resolve(os.homedir(), ".openclaw", "workspace-research"));
|
expect(result.workspaceDir).toBe(
|
||||||
|
path.resolve(resolveStateDir(process.env), "workspace-research"),
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("throws for malformed agent session keys even when config has a default agent", () => {
|
it("throws for malformed agent session keys even when config has a default agent", () => {
|
||||||
|
|||||||
48
src/canvas-host/server.state-dir.test.ts
Normal file
48
src/canvas-host/server.state-dir.test.ts
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
import fs from "node:fs/promises";
|
||||||
|
import os from "node:os";
|
||||||
|
import path from "node:path";
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||||
|
import { defaultRuntime } from "../runtime.js";
|
||||||
|
import {
|
||||||
|
restoreStateDirEnv,
|
||||||
|
setStateDirEnv,
|
||||||
|
snapshotStateDirEnv,
|
||||||
|
} from "../test-helpers/state-dir-env.js";
|
||||||
|
|
||||||
|
describe("canvas host state dir defaults", () => {
|
||||||
|
let envSnapshot: ReturnType<typeof snapshotStateDirEnv>;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
envSnapshot = snapshotStateDirEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
vi.resetModules();
|
||||||
|
restoreStateDirEnv(envSnapshot);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("uses OPENCLAW_STATE_DIR for the default canvas root", async () => {
|
||||||
|
const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-canvas-state-"));
|
||||||
|
const stateDir = path.join(tempRoot, "state");
|
||||||
|
setStateDirEnv(stateDir);
|
||||||
|
vi.resetModules();
|
||||||
|
|
||||||
|
const { createCanvasHostHandler } = await import("./server.js");
|
||||||
|
const handler = await createCanvasHostHandler({
|
||||||
|
runtime: defaultRuntime,
|
||||||
|
allowInTests: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
const expectedRoot = await fs.realpath(path.join(stateDir, "canvas"));
|
||||||
|
const actualRoot = await fs.realpath(handler.rootDir);
|
||||||
|
expect(actualRoot).toBe(expectedRoot);
|
||||||
|
const indexPath = path.join(expectedRoot, "index.html");
|
||||||
|
const indexContents = await fs.readFile(indexPath, "utf8");
|
||||||
|
expect(indexContents).toContain("OpenClaw Canvas");
|
||||||
|
} finally {
|
||||||
|
await handler.close();
|
||||||
|
await fs.rm(tempRoot, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -4,10 +4,10 @@ import chokidar from "chokidar";
|
|||||||
import * as fsSync from "node:fs";
|
import * as fsSync from "node:fs";
|
||||||
import fs from "node:fs/promises";
|
import fs from "node:fs/promises";
|
||||||
import http, { type IncomingMessage, type Server, type ServerResponse } from "node:http";
|
import http, { type IncomingMessage, type Server, type ServerResponse } from "node:http";
|
||||||
import os from "node:os";
|
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { type WebSocket, WebSocketServer } from "ws";
|
import { type WebSocket, WebSocketServer } from "ws";
|
||||||
import type { RuntimeEnv } from "../runtime.js";
|
import type { RuntimeEnv } from "../runtime.js";
|
||||||
|
import { STATE_DIR } from "../config/paths.js";
|
||||||
import { isTruthyEnvValue } from "../infra/env.js";
|
import { isTruthyEnvValue } from "../infra/env.js";
|
||||||
import { SafeOpenError, openFileWithinRoot } from "../infra/fs-safe.js";
|
import { SafeOpenError, openFileWithinRoot } from "../infra/fs-safe.js";
|
||||||
import { detectMime } from "../media/mime.js";
|
import { detectMime } from "../media/mime.js";
|
||||||
@@ -235,7 +235,7 @@ async function prepareCanvasRoot(rootDir: string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function resolveDefaultCanvasRoot(): string {
|
function resolveDefaultCanvasRoot(): string {
|
||||||
const candidates = [path.join(os.homedir(), ".openclaw", "canvas")];
|
const candidates = [path.join(STATE_DIR, "canvas")];
|
||||||
const existing = candidates.find((dir) => {
|
const existing = candidates.find((dir) => {
|
||||||
try {
|
try {
|
||||||
return fsSync.statSync(dir).isDirectory();
|
return fsSync.statSync(dir).isDirectory();
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ import {
|
|||||||
resolveUpdateAvailability,
|
resolveUpdateAvailability,
|
||||||
} from "../commands/status.update.js";
|
} from "../commands/status.update.js";
|
||||||
import { readConfigFileSnapshot, writeConfigFile } from "../config/config.js";
|
import { readConfigFileSnapshot, writeConfigFile } from "../config/config.js";
|
||||||
|
import { resolveStateDir } from "../config/paths.js";
|
||||||
import { resolveOpenClawPackageRoot } from "../infra/openclaw-root.js";
|
import { resolveOpenClawPackageRoot } from "../infra/openclaw-root.js";
|
||||||
import { trimLogTail } from "../infra/restart-sentinel.js";
|
import { trimLogTail } from "../infra/restart-sentinel.js";
|
||||||
import { parseSemver } from "../infra/runtime-guard.js";
|
import { parseSemver } from "../infra/runtime-guard.js";
|
||||||
@@ -126,7 +127,6 @@ const DEFAULT_PACKAGE_NAME = "openclaw";
|
|||||||
const CORE_PACKAGE_NAMES = new Set([DEFAULT_PACKAGE_NAME]);
|
const CORE_PACKAGE_NAMES = new Set([DEFAULT_PACKAGE_NAME]);
|
||||||
const CLI_NAME = resolveCliName();
|
const CLI_NAME = resolveCliName();
|
||||||
const OPENCLAW_REPO_URL = "https://github.com/openclaw/openclaw.git";
|
const OPENCLAW_REPO_URL = "https://github.com/openclaw/openclaw.git";
|
||||||
const DEFAULT_GIT_DIR = path.join(os.homedir(), ".openclaw");
|
|
||||||
|
|
||||||
function normalizeTag(value?: string | null): string | null {
|
function normalizeTag(value?: string | null): string | null {
|
||||||
if (!value) {
|
if (!value) {
|
||||||
@@ -313,7 +313,7 @@ function resolveGitInstallDir(): string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function resolveDefaultGitDir(): string {
|
function resolveDefaultGitDir(): string {
|
||||||
return DEFAULT_GIT_DIR;
|
return resolveStateDir(process.env, os.homedir);
|
||||||
}
|
}
|
||||||
|
|
||||||
function resolveNodeRunner(): string {
|
function resolveNodeRunner(): string {
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import os from "node:os";
|
|||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { describe, expect, it } from "vitest";
|
import { describe, expect, it } from "vitest";
|
||||||
import type { OpenClawConfig } from "../config/config.js";
|
import type { OpenClawConfig } from "../config/config.js";
|
||||||
|
import { resolveStateDir } from "../config/paths.js";
|
||||||
import {
|
import {
|
||||||
applyAgentBindings,
|
applyAgentBindings,
|
||||||
applyAgentConfig,
|
applyAgentConfig,
|
||||||
@@ -43,7 +44,9 @@ describe("agents helpers", () => {
|
|||||||
const work = summaries.find((summary) => summary.id === "work");
|
const work = summaries.find((summary) => summary.id === "work");
|
||||||
|
|
||||||
expect(main).toBeTruthy();
|
expect(main).toBeTruthy();
|
||||||
expect(main?.workspace).toBe(path.join(os.homedir(), ".openclaw", "workspace-main"));
|
expect(main?.workspace).toBe(
|
||||||
|
path.join(resolveStateDir(process.env, os.homedir), "workspace-main"),
|
||||||
|
);
|
||||||
expect(main?.bindings).toBe(1);
|
expect(main?.bindings).toBe(1);
|
||||||
expect(main?.model).toBe("anthropic/claude");
|
expect(main?.model).toBe("anthropic/claude");
|
||||||
expect(main?.agentDir.endsWith(path.join("agents", "main", "agent"))).toBe(true);
|
expect(main?.agentDir.endsWith(path.join("agents", "main", "agent"))).toBe(true);
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ import fs from "node:fs/promises";
|
|||||||
import os from "node:os";
|
import os from "node:os";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import type { HookHandler } from "../../hooks.js";
|
import type { HookHandler } from "../../hooks.js";
|
||||||
|
import { resolveStateDir } from "../../../config/paths.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Log all command events to a file
|
* Log all command events to a file
|
||||||
@@ -39,7 +40,7 @@ const logCommand: HookHandler = async (event) => {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
// Create log directory
|
// Create log directory
|
||||||
const stateDir = process.env.OPENCLAW_STATE_DIR?.trim() || path.join(os.homedir(), ".openclaw");
|
const stateDir = resolveStateDir(process.env, os.homedir);
|
||||||
const logDir = path.join(stateDir, "logs");
|
const logDir = path.join(stateDir, "logs");
|
||||||
await fs.mkdir(logDir, { recursive: true });
|
await fs.mkdir(logDir, { recursive: true });
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import path from "node:path";
|
|||||||
import type { OpenClawConfig } from "../../../config/config.js";
|
import type { OpenClawConfig } from "../../../config/config.js";
|
||||||
import type { HookHandler } from "../../hooks.js";
|
import type { HookHandler } from "../../hooks.js";
|
||||||
import { resolveAgentWorkspaceDir } from "../../../agents/agent-scope.js";
|
import { resolveAgentWorkspaceDir } from "../../../agents/agent-scope.js";
|
||||||
|
import { resolveStateDir } from "../../../config/paths.js";
|
||||||
import { createSubsystemLogger } from "../../../logging/subsystem.js";
|
import { createSubsystemLogger } from "../../../logging/subsystem.js";
|
||||||
import { resolveAgentIdFromSessionKey } from "../../../routing/session-key.js";
|
import { resolveAgentIdFromSessionKey } from "../../../routing/session-key.js";
|
||||||
import { resolveHookConfig } from "../../config.js";
|
import { resolveHookConfig } from "../../config.js";
|
||||||
@@ -79,7 +80,7 @@ const saveSessionToMemory: HookHandler = async (event) => {
|
|||||||
const agentId = resolveAgentIdFromSessionKey(event.sessionKey);
|
const agentId = resolveAgentIdFromSessionKey(event.sessionKey);
|
||||||
const workspaceDir = cfg
|
const workspaceDir = cfg
|
||||||
? resolveAgentWorkspaceDir(cfg, agentId)
|
? resolveAgentWorkspaceDir(cfg, agentId)
|
||||||
: path.join(os.homedir(), ".openclaw", "workspace");
|
: path.join(resolveStateDir(process.env, os.homedir), "workspace");
|
||||||
const memoryDir = path.join(workspaceDir, "memory");
|
const memoryDir = path.join(workspaceDir, "memory");
|
||||||
await fs.mkdir(memoryDir, { recursive: true });
|
await fs.mkdir(memoryDir, { recursive: true });
|
||||||
|
|
||||||
|
|||||||
40
src/infra/device-identity.state-dir.test.ts
Normal file
40
src/infra/device-identity.state-dir.test.ts
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import fs from "node:fs/promises";
|
||||||
|
import os from "node:os";
|
||||||
|
import path from "node:path";
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||||
|
import {
|
||||||
|
restoreStateDirEnv,
|
||||||
|
setStateDirEnv,
|
||||||
|
snapshotStateDirEnv,
|
||||||
|
} from "../test-helpers/state-dir-env.js";
|
||||||
|
|
||||||
|
describe("device identity state dir defaults", () => {
|
||||||
|
let envSnapshot: ReturnType<typeof snapshotStateDirEnv>;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
envSnapshot = snapshotStateDirEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
vi.resetModules();
|
||||||
|
restoreStateDirEnv(envSnapshot);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("writes the default identity file under OPENCLAW_STATE_DIR", async () => {
|
||||||
|
const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-identity-state-"));
|
||||||
|
const stateDir = path.join(tempRoot, "state");
|
||||||
|
setStateDirEnv(stateDir);
|
||||||
|
vi.resetModules();
|
||||||
|
|
||||||
|
const { loadOrCreateDeviceIdentity } = await import("./device-identity.js");
|
||||||
|
const identity = loadOrCreateDeviceIdentity();
|
||||||
|
|
||||||
|
try {
|
||||||
|
const identityPath = path.join(stateDir, "identity", "device.json");
|
||||||
|
const raw = JSON.parse(await fs.readFile(identityPath, "utf8")) as { deviceId?: string };
|
||||||
|
expect(raw.deviceId).toBe(identity.deviceId);
|
||||||
|
} finally {
|
||||||
|
await fs.rm(tempRoot, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import crypto from "node:crypto";
|
import crypto from "node:crypto";
|
||||||
import fs from "node:fs";
|
import fs from "node:fs";
|
||||||
import os from "node:os";
|
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
|
import { STATE_DIR } from "../config/paths.js";
|
||||||
|
|
||||||
export type DeviceIdentity = {
|
export type DeviceIdentity = {
|
||||||
deviceId: string;
|
deviceId: string;
|
||||||
@@ -17,7 +17,7 @@ type StoredIdentity = {
|
|||||||
createdAtMs: number;
|
createdAtMs: number;
|
||||||
};
|
};
|
||||||
|
|
||||||
const DEFAULT_DIR = path.join(os.homedir(), ".openclaw", "identity");
|
const DEFAULT_DIR = path.join(STATE_DIR, "identity");
|
||||||
const DEFAULT_FILE = path.join(DEFAULT_DIR, "device.json");
|
const DEFAULT_FILE = path.join(DEFAULT_DIR, "device.json");
|
||||||
|
|
||||||
function ensureDir(filePath: string) {
|
function ensureDir(filePath: string) {
|
||||||
|
|||||||
29
src/test-helpers/state-dir-env.ts
Normal file
29
src/test-helpers/state-dir-env.ts
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
type StateDirEnvSnapshot = {
|
||||||
|
openclawStateDir: string | undefined;
|
||||||
|
clawdbotStateDir: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
export function snapshotStateDirEnv(): StateDirEnvSnapshot {
|
||||||
|
return {
|
||||||
|
openclawStateDir: process.env.OPENCLAW_STATE_DIR,
|
||||||
|
clawdbotStateDir: process.env.CLAWDBOT_STATE_DIR,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function restoreStateDirEnv(snapshot: StateDirEnvSnapshot): void {
|
||||||
|
if (snapshot.openclawStateDir === undefined) {
|
||||||
|
delete process.env.OPENCLAW_STATE_DIR;
|
||||||
|
} else {
|
||||||
|
process.env.OPENCLAW_STATE_DIR = snapshot.openclawStateDir;
|
||||||
|
}
|
||||||
|
if (snapshot.clawdbotStateDir === undefined) {
|
||||||
|
delete process.env.CLAWDBOT_STATE_DIR;
|
||||||
|
} else {
|
||||||
|
process.env.CLAWDBOT_STATE_DIR = snapshot.clawdbotStateDir;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function setStateDirEnv(stateDir: string): void {
|
||||||
|
process.env.OPENCLAW_STATE_DIR = stateDir;
|
||||||
|
delete process.env.CLAWDBOT_STATE_DIR;
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user