Files
reverse-engineering-anything/src/filesystem/cacheDirectory.ts
T
8d6552e928 feat(config): persist provider settings in a user config file (#3023)
* feat(config): persist provider settings in a user config file

Providers currently rediscover install paths from scratch in every
process, so a path set once (for example GHIDRA_INSTALL_DIR) silently
reverts on the next run. Introduce ~/.config/rea/rea.json as the
user-owned persistence layer and merge it into the environment
snapshot before configuration parsing, keeping env > config file >
auto-detect precedence on both the CLI and MCP entry points.

Add a rea config command (list/get/set/unset) as the write surface,
reporting the effective value and where it came from.

* fix(config): address review findings on persistence safety and CLI surface

- stage config writes beside the file and rename into place so an
  interrupted write cannot leave partial JSON (greptile #4, codex #11)
- convert unreadable config files into configuration errors on the CLI
  seam instead of escaping raw filesystem errors (greptile #5, codex #15)
- keep injected runtimes without a config root isolated from the host
  account's rea.json (codex #18)
- surface the config file error on stderr when doctor falls back to the
  raw environment (greptile #3, codex #16)
- route the config command through logCliCommand and return documents so
  --json stays parseable and failures exit non-zero (greptile #2,
  codex #10)
- reject empty --set values, unknown --set/--unset/--get names, and --get
  combined with mutations (greptile #1/#7, codex #9/#12/#13/#17)
- cover the new behavior in the boundary tests and stop leaking one
  temporary home per run (greptile #8)

* fix(config): validate and back up persisted provider settings

* fix(config): keep saved provider defaults out of client registrations

* fix(config): preserve provider discovery and budgets for saved settings

* fix(config): check only settings needed by the IDA deadline lookup

* fix(config): share effective provider settings and verify config file reads

* fix(doctor): share selected settings with Hopper and ILSpy probes

* fix(config): resolve the destination of first-time saves

* fix(doctor): preserve unresolved provider location inputs

* fix(doctor): honor inherited IDA deadline overrides

* fix(config): show empty environment overrides

* fix(setup): preserve client-selected saved configuration roots

---------

Co-authored-by: Jackzigen <zigenhan@gmail.com>
Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>
2026-11-21 22:02:35 +00:00

99 lines
3.4 KiB
TypeScript

import { isAbsolute, posix, win32 } from "node:path";
import {
homeDirectoryFromEnvironment,
selectedHomeDirectorySettings,
} from "../config/homeDirectory.js";
import { absoluteCallerPath, appendCallerPath } from "./callerPath.js";
const selectedXdgCacheRoot = (
environment: Readonly<NodeJS.ProcessEnv>,
platform: NodeJS.Platform,
): string | undefined => {
if (platform === "darwin") return undefined;
const xdg = environment.XDG_CACHE_HOME;
return xdg !== undefined && isAbsolute(xdg) ? xdg : undefined;
};
/** Settings consulted when selecting the default cache location. */
export const reaCacheLocationSettings = (
environment: Readonly<NodeJS.ProcessEnv>,
platform: NodeJS.Platform,
): readonly string[] => [
...(platform === "darwin" ? [] : ["XDG_CACHE_HOME"]),
...(selectedXdgCacheRoot(environment, platform) === undefined
? selectedHomeDirectorySettings(platform, environment)
: []),
];
/** Per-user cache directory that REA owns for Kuna on this host. */
export const defaultKunaCacheDirectory = (
environment: Readonly<NodeJS.ProcessEnv>,
platform: NodeJS.Platform,
home?: string,
): string => reaCacheDirectory(environment, platform, "kuna", home);
/** A per-user cache directory REA owns on this host: `rea/<name>` under the platform's cache root. */
export const reaCacheDirectory = (
environment: Readonly<NodeJS.ProcessEnv>,
platform: NodeJS.Platform,
name: string,
home?: string,
): string => {
const root =
selectedXdgCacheRoot(environment, platform) ??
appendCallerPath(
home ?? homeDirectoryFromEnvironment(environment, platform),
platform === "darwin" ? "Library/Caches" : ".cache",
platform,
);
return appendCallerPath(root, `rea/${name}`, platform);
};
/**
* Lexical directory identity. Keeps POSIX parent traversal distinct because
* collapsing it can change directory identity across symbolic links.
* On Darwin and Linux, `\` is a filename character, so only `/` is removed.
*/
export const sameLexicalDirectory = (
left: string,
right: string,
platform: NodeJS.Platform,
): boolean =>
lexicalDirectory(left, platform) === lexicalDirectory(right, platform);
/**
* True when `child` is `parent` or is spelled below it. Parent traversal is
* never collapsed, because after a symbolic link it leads somewhere else:
* callers resolve such spellings through the filesystem instead.
*/
export const withinLexicalDirectory = (
child: string,
parent: string,
platform: NodeJS.Platform,
): boolean => {
const base = lexicalDirectory(parent, platform);
const inner = lexicalDirectory(child, platform);
const separator = (platform === "win32" ? win32 : posix).sep;
return (
inner === base ||
inner.startsWith(base.endsWith(separator) ? base : base + separator)
);
};
/** True when a POSIX spelling contains a `..` segment, whose meaning only the filesystem knows. */
export const hasParentTraversal = (value: string): boolean =>
value.split("/").includes("..");
const lexicalDirectory = (value: string, platform: NodeJS.Platform): string => {
const pathApi = platform === "win32" ? win32 : posix;
const normalized = absoluteCallerPath(value, { platform });
const root = pathApi.parse(normalized).root;
let end = normalized.length;
while (
end > root.length &&
normalized.charCodeAt(end - 1) === pathApi.sep.charCodeAt(0)
)
end -= 1;
return normalized.slice(0, end);
};