dsh-decision-engine 0.5.1 → 0.5.2

package/README.md

@@ -66,6 +66,29 @@ cd ~/.dsh/profiles/desktop && pnpm install
   （笔记、备份）一概不碰。
 - **权限 600**：配置里可能有明文 key，迁移后仍保持只有你可读。
 
+### 数据目录解析规则（跨平台）
+
+数据目录是 **`$DSH_HOME/dsh-decision-engine/`**，`~/.dsh` 只是 `DSH_HOME`
+未设置时的默认值。解析顺序与宿主 `@deepseek-ai/dsh-home-paths` 完全一致：
+
+| 优先级 | 来源 |
+|---|---|
+| 1 | 显式配置的路径（本插件暂无此入口） |
+| 2 | 环境变量 `$DSH_HOME` |
+| 3 | 操作系统家目录下的 `~/.dsh` |
+
+细节（都由 `lib/home-paths.js` 统一处理）：
+
+- **空白值等于未设置**：`DSH_HOME=""` 或纯空白会回退 `~/.dsh`，绝不会把数据
+  目录解析到当前工作目录。
+- **支持波浪号**：`DSH_HOME=~/myhome` 会展开；`~\`（Windows 形式）同样支持。
+- **相对路径会被规范化成绝对路径**，否则落盘位置会随进程工作目录漂移。
+
+**Windows 说明**：`~/.dsh` 里的 `.dsh` 只是**目录名**，不是路径分隔符——
+Windows 允许点开头的目录。真正与平台相关的是分隔符与家目录位置，二者分别由
+`node:path` 与 `node:os` 处理，所以 Windows 上实际路径是
+`C:\Users\<你的用户名>\.dsh\dsh-decision-engine\config.yml`。
+
 ## 配置
 
 ### 插件配置页

package/lib/home-paths.js

@@ -0,0 +1,86 @@
+/**
+ * DSH 家目录解析 —— 与宿主 `@deepseek-ai/dsh-home-paths` 保持同一语义。
+ *
+ * 为什么自己实现而不直接依赖宿主那个包：
+ *
+ *   `@deepseek-ai/dsh-home-paths` 是宿主的 peer 依赖，装上它本插件就无法在
+ *   没有 DSH node_modules 的裸仓库里被加载——而本项目刻意保持零运行时依赖
+ *   （`lib/providers.js` 甚至能在裸 Node 下单测）。因此这里复刻它的**行为**，
+ *   而不是引入它的代码。
+ *
+ * 与宿主 `resolveDshHome()` 必须一致的三条规则：
+ *
+ *   1. **优先级**：显式配置 > `$DSH_HOME` > `~/.dsh`
+ *   2. **空白即未设置**：空串或纯空白的 `$DSH_HOME` 当作没有，
+ *      否则空值会把数据目录解析到当前工作目录（宿主的注释专门强调过这点）
+ *   3. **波浪号展开**：`~`、`~/`、`~\` 都按操作系统家目录展开。
+ *      其中 `~\` 是 Windows 形式，宿主为此专门加了这一条
+ *
+ * 另外补上宿主也做、而早期实现漏掉的一步：**规范化成绝对路径**
+ * （`path.resolve`）。相对路径（`DSH_HOME=./home`）若不规范化，实际落盘位置
+ * 会随进程工作目录漂移，表现为「同一个配置有时读得到有时读不到」。
+ *
+ * 跨平台说明：`~/.dsh` 里的 `.dsh` 只是**目录名**，不是路径分隔符，Windows
+ * 完全允许点开头的目录。真正与平台相关的是分隔符与家目录位置，这两件事都由
+ * `node:path` / `node:os` 处理，所以 Windows 上会得到
+ * `C:\Users\<name>\.dsh\...`。
+ *
+ * @module dsh-decision-engine/home-paths
+ */
+
+import { homedir } from "node:os";
+import { join, resolve } from "node:path";
+
+/** 默认的 Harness 家目录名（宿主同名常量）。 */
+export const DSH_HOME_DIR_NAME = ".dsh";
+
+/** 覆盖默认家目录的环境变量（宿主同名常量）。 */
+export const DSH_HOME_ENV = "DSH_HOME";
+
+/**
+ * 展开 `~`、`~/`、`~\` 前缀。
+ *
+ * 只处理「单独的家目录」与「当前用户」两种形式；`~alice/...` 这类命名用户
+ * 形式原样返回——与宿主 `expandHomePath` 的行为一致，避免自作聪明地改坏
+ * 用户写的路径。
+ *
+ * @param path - 可能带波浪号前缀的路径。
+ * @returns 展开后的路径；没有可识别前缀时原样返回。
+ */
+export function expandHomePath(path) {
+  const text = typeof path === "string" ? path : "";
+  if (text === "~") return homedir();
+  if (text.startsWith("~/") || text.startsWith("~\\")) return join(homedir(), text.slice(2));
+  return text;
+}
+
+/**
+ * 解析 DSH 家目录。
+ *
+ * @param options.configured - 显式配置的路径，优先级最高（当前插件没有此入口，
+ *   保留参数是为了与宿主签名一致，便于将来接入 profile 配置）。
+ * @param options.env - 环境变量表，默认 `process.env`；注入便于单测。
+ * @returns 规范化后的绝对路径。
+ */
+export function resolveDshHome(options = {}) {
+  const env = options.env ?? process.env;
+  const raw = env?.[DSH_HOME_ENV];
+  const fromEnv = typeof raw === "string" && raw.trim().length > 0 ? raw : undefined;
+  const configured = typeof options.configured === "string" && options.configured.trim().length > 0
+    ? options.configured
+    : undefined;
+  const chosen = configured ?? fromEnv ?? join(homedir(), DSH_HOME_DIR_NAME);
+  // resolve() 同时完成「展开相对路径」与「消除 . / .. 」，
+  // 保证不同工作目录下得到同一个绝对路径。
+  return resolve(expandHomePath(chosen));
+}
+
+/**
+ * 把若干路径段拼到解析出的家目录上。
+ *
+ * @param segments - 追加的路径段；为空时返回家目录本身。
+ * @returns 绝对路径。
+ */
+export function dshHomePath(...segments) {
+  return join(resolveDshHome(), ...segments);
+}

package/lib/index.js

@@ -5,7 +5,8 @@
  *
  * 1. **零可选 API 依赖**。不调用 `settings.installSection`（该 API 在 DSH 中不存在），
  *    不依赖 `@deepseek-ai/dsh-credentials`、`launchEnvironmentOf`、`dshHomePath`。
- *    密钥走 config → 环境变量两级，路径走 `os.homedir()`。宿主 API 缺失不会炸成静默失效。
+ *    密钥走 config → 环境变量两级，路径走 `home-paths.js`（与宿主同一套规则）。
+ *    宿主 API 缺失不会炸成静默失效。
  *
  * 2. **endpoint 每次请求重新解析**。`classify()` 现读 `cfg` 并重新解析 provider，
  *    改配置立刻对下一次决策生效，无需重启（旧插件在 apply 期把 endpoint 固化进
@@ -23,8 +24,7 @@
 
 import { appendFile, mkdir, readFile } from "node:fs/promises";
 import { chmodSync, copyFileSync, existsSync, mkdirSync, readFileSync, renameSync } from "node:fs";
-import { homedir } from "node:os";
-import { join } from "node:path";
+import { dirname, join } from "node:path";
 import z from "@deepseek-ai/schemastery";
 
 import { DecisionCache } from "./decision-cache.js";
@@ -37,6 +37,7 @@ import { mountRoutePoint } from "./adapters/route.js";
 import { mountAgentPoints } from "./adapters/agent.js";
 import { mountCotTranslatePoint } from "./adapters/translate.js";
 import { applyConfigUpdates, parseConfigText } from "./config-file.js";
+import { resolveDshHome } from "./home-paths.js";
 import { applyRefUpdates, listRefNames, pickRefValue } from "./credentials.js";
 import {
   DEFAULT_PROVIDER,
@@ -501,10 +502,9 @@ export function resolveKey(cfg, provider) {
 export function readCredentialFromDsh(ref) {
   const name = typeof ref === "string" ? ref.trim() : "";
   if (name.length === 0) return undefined;
-  const candidates = [join(homedir(), ".dsh", ".credentials.yaml")];
-  if (typeof process.env.DSH_HOME === "string" && process.env.DSH_HOME.length > 0) {
-    candidates.unshift(join(process.env.DSH_HOME, ".credentials.yaml"));
-  }
+  // 读侧与写侧必须用**同一套**规则，否则会出现"存了却读不回"。
+  // 两边都交给 resolveDshHome()，候选只剩一个路径。
+  const candidates = [join(resolveDshHome(), ".credentials.yaml")];
   for (const path of candidates) {
     let raw;
     try {
@@ -527,14 +527,11 @@ export function readCredentialFromDsh(ref) {
  * @returns 凭据文件绝对路径（不保证已存在）。
  */
 export function credentialFilePath() {
-  // DSH_HOME 覆盖优先，其次 ~/.dsh。
-  //
-  // 注意：读取侧（readCredentialFromDsh）与写入侧必须用**同一套**候选，
-  // 否则会出现"保存成功但读不回来"——写到了 A 文件、读的是 B 文件。
+  // 读取侧（readCredentialFromDsh）与写入侧必须用**同一套**规则，否则会
+  // 出现"保存成功但读不回来"——写到了 A 文件、读的是 B 文件。
   // 早先写入侧只认 ~/.dsh，就是在这一步把 key 写进真实家目录的。
-  const home = typeof process.env.DSH_HOME === "string" ? process.env.DSH_HOME.trim() : "";
-  if (home.length > 0) return join(home, ".credentials.yaml");
-  return join(homedir(), ".dsh", ".credentials.yaml");
+  // 现在两侧都从 resolveDshHome() 派生，规则只有一份。
+  return join(resolveDshHome(), ".credentials.yaml");
 }
 
 /**
@@ -617,11 +614,10 @@ const LEGACY_CONFIG_FILE_NAMES = ["startlux.yml"];
  * 与插件源码分离——源码可以 clone 到任意位置，运行期数据只在 DSH 家目录下。
  */
 function defaultTelemetryDir() {
-  // DSH_HOME 优先：它既是"DSH 家目录"的权威来源，也让测试能完全隔离，
-  // 不必碰用户真实数据（HOME 在某些运行环境里不生效）。
-  const home = typeof process.env.DSH_HOME === "string" ? process.env.DSH_HOME.trim() : "";
-  const base = home.length > 0 ? home : join(homedir(), ".dsh");
-  return join(base, DATA_DIR_NAME);
+  // 家目录解析统一走 home-paths.js：优先级、空白值处理、~ 展开与
+  // 绝对路径规范化都与宿主 @deepseek-ai/dsh-home-paths 一致。
+  // 早期各处手写一份 `DSH_HOME || ~/.dsh`，既重复又漏了规范化。
+  return join(resolveDshHome(), DATA_DIR_NAME);
 }
 
 /**
@@ -639,8 +635,7 @@ function defaultTelemetryDir() {
  * 找不到老配置。顺序即优先级：越新的旧位置越靠前。
  */
 function legacyConfigPaths() {
-  const home = typeof process.env.DSH_HOME === "string" ? process.env.DSH_HOME.trim() : "";
-  const base = home.length > 0 ? home : join(homedir(), ".dsh");
+  const base = resolveDshHome();
   return [
     // 上一代数据目录（本项目改名前的正式位置）
     join(base, "dsh-startlux-decision", "startlux.yml"),
@@ -1273,6 +1268,11 @@ export function apply(ctx, config) {
    */
   const persistConfig = async (updates) => {
     const { writeFile } = await import("node:fs/promises");
+    // 先建目录：全新安装时数据目录还不存在，直接 writeFile 会 ENOENT。
+    // 那会造成最糟的一种失败——凭据已经写进去了、配置却写不进去，
+    // 用户只看到一条报错，而 key 其实「存了一半」。
+    // 目录创建必须幂等（recursive），已有目录时是无操作。
+    await mkdir(dirname(ownConfigPath), { recursive: true });
     let lines = [];
     try {
       lines = (await readFile(ownConfigPath, "utf8")).split("\n");
@@ -1345,17 +1345,31 @@ export function apply(ctx, config) {
     const names = Object.keys(credentialWrites);
     if (names.length === 0) return { ok: true, patch: ymlPatch };
 
+    /** 已成功写入的项，带上写入前的值，供上层在后续步骤失败时回滚。 */
+    const applied = [];
     for (const name of names) {
+      // 先记下旧值：万一配置没写成功，要把凭据恢复原状，
+      // 否则会出现「凭据存了、配置没存」的半成功状态。
+      const previous = readCredentialFromDsh(name);
       const result = await writeCredentialToDsh(name, credentialWrites[name]);
       if (!result.ok) {
+        // 本次之前已经写成功的，一并回滚，避免留下半套改动。
+        for (const done of applied) {
+          try {
+            await writeCredentialToDsh(done.refName, done.previous ?? "");
+          } catch {
+            /* 回滚尽力而为，失败也不能再抛 */
+          }
+        }
         return {
           ok: false,
           patch: ymlPatch,
           error: `写入 ~/.dsh/.credentials.yaml 失败（${name}）：${result.error}`,
         };
       }
+      applied.push({ refName: name, previous });
     }
-    return { ok: true, patch: ymlPatch };
+    return { ok: true, patch: ymlPatch, applied };
   };
 
   /** 一次决策的完整记录，写入 telemetry.jsonl 便于事后核对。 */
@@ -1830,7 +1844,28 @@ export function apply(ctx, config) {
           // key 已被写进指定位置的，不能同时再写进 yml（会变成两处明文）。
           const ymlPatch = { ...keyResult.patch };
 
-          await persistConfig(ymlPatch);
+          try {
+            await persistConfig(ymlPatch);
+          } catch (error) {
+            // 配置没写成功，就把已落地的凭据恢复原状：宁可整体失败，
+            // 也不要留下「凭据存了、配置没存」的半套状态——那种状态在
+            // 界面上看起来是保存失败，实际 key 已经悄悄换了。
+            for (const done of keyResult.applied ?? []) {
+              try {
+                await writeCredentialToDsh(done.refName, done.previous ?? "");
+              } catch {
+                /* 回滚尽力而为 */
+              }
+            }
+            return json(
+              {
+                error:
+                  `写入配置文件失败：${error instanceof Error ? error.message : String(error)}` +
+                  (keyResult.applied?.length > 0 ? "（已回滚本次写入的凭据）" : ""),
+              },
+              500,
+            );
+          }
           return json({ ok: true, ...statusPayload() });
         } catch (error) {
           return json({ error: error instanceof Error ? error.message : String(error) }, 500);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-decision-engine",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "dsh-decision-engine: a cheap judgement layer for DeepSeek Harness — all nine decision points (tool authorization, model routing, delegation, compaction, turn continuation, retrieval, skill pick, session title, COT translation) are implemented and individually switchable, and it works against any system-one style API (system one, bamboonode, or a custom base URL).",
   "icon": "./icon.svg",
   "type": "module",