@shgroup/dsh-serenity-hooks 1.77.1 → 1.78.0

package/lib/service-DDmHSglV.js

@@ -0,0 +1,282 @@
+import { s as loadSerenityConfig, t as DEFAULT_SERENITY_CONFIG_PATHS } from "./ccc-CyYJL4F2.js";
+import { join } from "node:path";
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+//#region src/tools/localstore/service.ts
+/**
+* tools/localstore/service.ts — localstore 纯逻辑层（零 DSH 依赖，可独立单测）
+*
+* S134 重设计（v1.16.7）：存储从 ~/.serenity/ 迁到 **CCC 根根目录 localstore.json**
+* （JSON 格式——方便 MSM 直接 read + JSON.parse 读取，零解析依赖）。
+*
+* git 提交策略（可靠机制 × 用户自由）：
+*   - 配置：.opencode/serenity.json `localstore.gitTrack`: "allow"（可提交）| "deny"（禁提交）
+*   - **缺省 deny（没配就是不提交）**；且 deny 的保证**不依赖 dsh 运行**——
+*     写入时自动确保 .gitignore 含 localstore.json（物理保证：即使 dsh 不在、
+*     用户手动 git commit 也不会误提交），container_git 检查为第二道防线（拒绝 + 提示）
+*   - allow：放行（文件可提交，用户自行管理 .gitignore）
+*
+* 存储结构（JSON 顶层分节）：
+*   { "credentials": { "HOME_GITLAB_TOKEN": "xxx" }, "<config节>": { "<key>": "v" } }
+*   credentials 为保留节（credential 命名空间，key 大写蛇形）；其余节归 config 命名空间
+*   （path = section.key，如 cheap-worker.models）。
+*/
+const LOCALSTORE_SCOPES = ["credential", "config"];
+/** 存储文件名（CCC 根根目录） */
+const LOCALSTORE_FILENAME = "localstore.json";
+/** 凭据保留节名（JSON 顶层） */
+const CREDENTIALS_SECTION = "credentials";
+/** 凭据 key 规范：大写蛇形，如 HOME_GITLAB_TOKEN */
+const CREDENTIAL_KEY_RE = /^[A-Z][A-Z0-9_]*$/;
+/** 配置节名规范：小写字母数字连字符 */
+const CONFIG_SECTION_RE = /^[a-z][a-z0-9-]*$/;
+/** 配置 key 规范（节内）：小驼峰，如 defaultModel */
+const CONFIG_KEY_RE = /^[a-z][a-zA-Z0-9_]*$/;
+/** 存储文件绝对路径（CCC 根根目录） */
+function localstorePath(root) {
+	return join(root, LOCALSTORE_FILENAME);
+}
+/** git 策略：serenity.json localstore.gitTrack，缺省 deny（不提交） */
+function readGitTrack(root, paths = DEFAULT_SERENITY_CONFIG_PATHS) {
+	return loadSerenityConfig(root, paths).localstore?.gitTrack === "allow" ? "allow" : "deny";
+}
+/** .gitignore 是否已覆盖 localstore 文件（非空非注释行含文件名即算） */
+function isLocalstoreGitignored(root) {
+	const gi = join(root, ".gitignore");
+	if (!existsSync(gi)) return false;
+	return readFileSync(gi, "utf-8").split("\n").some((l) => {
+		const t = l.trim();
+		return t !== "" && !t.startsWith("#") && t.includes("localstore.json");
+	});
+}
+/**
+* 确保 .gitignore 含 localstore 文件（deny 时的物理保证，不依赖 dsh 运行）：
+* 写入 localstore 时调用——deny（含缺省）且 .gitignore 未覆盖 → 自动追加一行。
+* allow → 不写入（放行，文件可提交）。
+*/
+function ensureLocalstoreGitignored(root) {
+	if (readGitTrack(root) === "allow") return { status: "allow" };
+	if (isLocalstoreGitignored(root)) return { status: "ignored" };
+	const gi = join(root, ".gitignore");
+	const existing = existsSync(gi) ? readFileSync(gi, "utf-8") : "";
+	const line = `${LOCALSTORE_FILENAME}  # ACC localstore (localstore.gitTrack defaults to deny — do not commit)`;
+	writeFileSync(gi, (existing.endsWith("\n") || existing === "" ? existing : existing + "\n") + line + "\n", "utf-8");
+	return { status: "appended" };
+}
+/**
+* container_git 联动检查（第二道防线）：文件存在 && deny && .gitignore 未覆盖 → 不通过。
+* 调用方（container_git commit）据此拒绝提交；status 可输出 warning。
+*/
+function checkLocalstoreGitCompliance(root) {
+	if (!existsSync(localstorePath(root))) return { ok: true };
+	if (readGitTrack(root) === "allow") return { ok: true };
+	if (isLocalstoreGitignored(root)) return { ok: true };
+	return {
+		ok: false,
+		reason: `localstore.json must not be committed (localstore.gitTrack=deny default) but .gitignore does not cover it — add ${LOCALSTORE_FILENAME} to .gitignore (or set localstore.gitTrack=allow to explicitly permit)`
+	};
+}
+/** 已告警的坏 localstore 路径（进程级去重；F-07：凭据文件损坏不得静默） */
+const warnedBrokenStores = /* @__PURE__ */ new Set();
+/** 读取全文件（顶层分节）；文件不存在 → 空；**坏 JSON → 空 + 响亮告警**（每路径一次） */
+function readAll(root) {
+	const p = localstorePath(root);
+	if (!existsSync(p)) return {};
+	try {
+		const v = JSON.parse(readFileSync(p, "utf-8").replace(/^\uFEFF/, ""));
+		if (v && typeof v === "object" && !Array.isArray(v)) return v;
+		return {};
+	} catch (err) {
+		if (!warnedBrokenStores.has(p)) {
+			warnedBrokenStores.add(p);
+			console.warn(`[serenity-hooks] ✗ localstore 解析失败，已按空存储继续（其中凭据/配置对工具表现为"未设置"，请修 JSON）: ${p} — ${String(err?.message ?? err)}`);
+		}
+		return {};
+	}
+}
+/** 写回全文件（2 空格缩进 + 尾换行，方便 MSM 直接读取） */
+function writeAll(root, data) {
+	writeFileSync(localstorePath(root), JSON.stringify(data, null, 2) + "\n", "utf-8");
+}
+/** 读取命名空间全部条目：credential → 扁平；config → 分节（剔除 credentials 保留节） */
+function readStore(root, scope) {
+	const all = readAll(root);
+	if (scope === "credential") return all[CREDENTIALS_SECTION] ?? {};
+	const { [CREDENTIALS_SECTION]: _cred, ...rest } = all;
+	return rest;
+}
+/** 校验凭据 key 合法（大写蛇形）；不合法抛错 */
+function assertCredentialKey(key) {
+	if (!CREDENTIAL_KEY_RE.test(key)) throw new Error(`credential key "${key}" must match UPPER_SNAKE ^[A-Z][A-Z0-9_]*$ (e.g. HOME_GITLAB_TOKEN)`);
+}
+/** 校验 config 路径（节.key）；不合法抛错 */
+function assertConfigPath(path) {
+	const idx = path.indexOf(".");
+	if (idx <= 0 || idx === path.length - 1) throw new Error(`config path "${path}" must be section.key (e.g. cheap-worker.models)`);
+	const section = path.slice(0, idx);
+	const key = path.slice(idx + 1);
+	if (!CONFIG_SECTION_RE.test(section)) throw new Error(`config section "${section}" must match ^[a-z][a-z0-9-]*$`);
+	if (!CONFIG_KEY_RE.test(key)) throw new Error(`config key "${key}" must match lowerCamel ^[a-z][a-zA-Z0-9_]*$ (e.g. defaultModel)`);
+	return {
+		section,
+		key
+	};
+}
+/** 写入单个条目（自动建文件；deny 默认时同步确保 .gitignore 物理保证） */
+function writeEntry(root, scope, name, value) {
+	const all = readAll(root);
+	if (scope === "credential") {
+		assertCredentialKey(name);
+		all[CREDENTIALS_SECTION] ??= {};
+		all[CREDENTIALS_SECTION][name] = value;
+	} else {
+		const { section, key } = assertConfigPath(name);
+		all[section] ??= {};
+		all[section][key] = value;
+	}
+	writeAll(root, all);
+	ensureLocalstoreGitignored(root);
+}
+/** 删除单个条目（不存在返回 false）；空节自动移除 */
+function unsetEntry(root, scope, name) {
+	const all = readAll(root);
+	if (scope === "credential") {
+		assertCredentialKey(name);
+		const sec = all[CREDENTIALS_SECTION];
+		if (!sec || !(name in sec)) return false;
+		delete sec[name];
+		if (Object.keys(sec).length === 0) delete all[CREDENTIALS_SECTION];
+	} else {
+		const { section, key } = assertConfigPath(name);
+		const sec = all[section];
+		if (!sec || !(key in sec)) return false;
+		delete sec[key];
+		if (Object.keys(sec).length === 0) delete all[section];
+	}
+	writeAll(root, all);
+	return true;
+}
+/** 读取单个条目值；不存在返回 null */
+function getEntry(root, scope, name) {
+	const all = readAll(root);
+	if (scope === "credential") {
+		assertCredentialKey(name);
+		return all[CREDENTIALS_SECTION]?.[name] ?? null;
+	}
+	const { section, key } = assertConfigPath(name);
+	return all[section]?.[key] ?? null;
+}
+/** 列出 key（凭据只返回 key 名，不返回值） */
+function listKeys(root, scope) {
+	const data = readStore(root, scope);
+	if (scope === "credential") return Object.keys(data);
+	return Object.entries(data).flatMap(([section, entries]) => Object.keys(entries).map((key) => `${section}.${key}`));
+}
+/**
+* doc 说明文本：输出存储位置/格式/key 规范/git 策略/读写方法。
+* agent 据此可直接用 fs 工具（read/write）自己读写凭据/配置。
+*/
+function docText(root) {
+	const path = localstorePath(root);
+	return [
+		"# localstore — ACC local credential/config storage (standard, S134 redesign)",
+		"",
+		"One tool manages two namespaces: credential (credentials) + config (preferences).",
+		`Stored at the CCC root in ${path} (JSON format; MSMs can read + JSON.parse directly).`,
+		"",
+		"## Git commit policy",
+		"- Config: .opencode/serenity.json `localstore.gitTrack`: `\"allow\"` (may commit) | `\"deny\"` (must not commit; .dsh fallback)",
+		"- **Default deny (unset = not committed)**; when deny, writes automatically ensure .gitignore contains localstore.json",
+		"  (physical guarantee, independent of dsh runtime); container_git commit checks and refuses",
+		"- To commit: set `\"localstore\": { \"gitTrack\": \"allow\" }` and remove localstore.json from .gitignore",
+		"",
+		"## Format (JSON top-level sections)",
+		"```json",
+		"{",
+		"  \"credentials\": {",
+		"    \"HOME_GITLAB_TOKEN\": \"xxx\"",
+		"  },",
+		"  \"cheap-worker\": {",
+		"    \"models\": [\"minimax-cn-coding-plan/MiniMax-M3\"]",
+		"  }",
+		"}",
+		"```",
+		"- credentials is a reserved section (credentials, UPPER_SNAKE keys); other sections = config (path = section.key)",
+		"",
+		"## Key conventions",
+		"- credential key: ^[A-Z][A-Z0-9_]*$ (e.g. HOME_GITLAB_TOKEN)",
+		"- config path: section.key (section ^[a-z][a-z0-9-]*$, key lowerCamel ^[a-z][a-zA-Z0-9_]*$, e.g. cheap-worker.models)",
+		"",
+		"## Reading (agents may use fs tools directly)",
+		`- Read ${path} with the read tool → JSON.parse`,
+		"- Or use localstore get <name> [--scope credential|config]",
+		"",
+		"## Writing",
+		"- Recommended: localstore set <name> <value> [--scope ...] (auto-creates file / preserves other entries / syncs .gitignore)",
+		"- Or modify the file directly with write/edit, keeping the JSON valid",
+		"",
+		"## Security boundary",
+		"- list/show return only key names for credentials, never values",
+		"- Credential values should be used internally by the agent; never write them into conversation or logs",
+		"- Default deny: the file is not committed to git (.gitignore physical guarantee + container_git check fallback)",
+		""
+	].join("\n");
+}
+/** 运行 localstore 操作（纯逻辑；返回 JSON 值供工具 render） */
+function runLocalStore(root, args) {
+	const scope = args.scope === "config" ? "config" : "credential";
+	switch (args.action) {
+		case "list": return {
+			scope,
+			keys: listKeys(root, scope)
+		};
+		case "get": {
+			if (!args.name) throw new Error("get requires name");
+			const value = getEntry(root, scope, args.name);
+			if (value === null) throw new Error(`not found: ${args.name} (scope=${scope})`);
+			return {
+				scope,
+				name: args.name,
+				value,
+				source: scope
+			};
+		}
+		case "set": {
+			if (!args.name) throw new Error("set requires name");
+			if (args.value === void 0) throw new Error("set requires value");
+			writeEntry(root, scope, args.name, args.value);
+			const git = checkLocalstoreGitCompliance(root);
+			return {
+				scope,
+				name: args.name,
+				set: true,
+				path: localstorePath(root),
+				gitTrack: readGitTrack(root),
+				gitOk: git.ok,
+				git: git.reason ? { warning: git.reason } : null
+			};
+		}
+		case "unset": {
+			if (!args.name) throw new Error("unset requires name");
+			const removed = unsetEntry(root, scope, args.name);
+			return {
+				scope,
+				name: args.name,
+				removed
+			};
+		}
+		case "show": {
+			if (!args.name) throw new Error("show requires name");
+			const exists = getEntry(root, scope, args.name) !== null;
+			return {
+				scope,
+				name: args.name,
+				exists,
+				path: localstorePath(root)
+			};
+		}
+		case "doc": return { doc: docText(root) };
+		default: throw new Error(`Unknown subcommand: ${args.action} (available: list/get/set/unset/show/doc)`);
+	}
+}
+//#endregion
+export { readGitTrack as a, unsetEntry as c, localstorePath as i, writeEntry as l, checkLocalstoreGitCompliance as n, readStore as o, getEntry as r, runLocalStore as s, LOCALSTORE_SCOPES as t };