dsh-notify-say 0.4.34 → 0.4.35

package/lib/client.js

@@ -127,6 +127,15 @@ window.__ModuleLoader__.load({
         body: JSON.stringify({ key: key }),
       }).then(function (r) { return r ? r.json() : null }).catch(function () { return null })
     }
+    // 导出诊断（v0.4.35）：宿主读日志 → 脱敏 → 写文件，返回路径。
+    // 用 POST：它会写文件，GET 可被任意网页用 <img> 触发。
+    function exportDiagnostics() {
+      return fetch(apiUrl('diagnostics'), {
+        method: 'POST', cache: 'no-store', credentials: 'same-origin',
+        headers: { 'content-type': 'application/json' },
+        body: '{}',
+      }).then(function (r) { return r ? r.json() : null }).catch(function () { return null })
+    }
 
     function openSession(ctx, sessionId) {
       try {
@@ -514,6 +523,22 @@ window.__ModuleLoader__.load({
           if (ok) loadPacks()
         })
       }
+      // 导出诊断：成功后把路径显示出来（用户要能直接找到文件）。
+      function doExportDiagnostics() {
+        set(function (p) {
+          return { loaded: p.loaded, values: p.values, advOpen: p.advOpen, packs: p.packs, busy: true, msg: '正在导出诊断…', err: '' }
+        })
+        exportDiagnostics().then(function (r) {
+          var ok = r && r.ok
+          set(function (p) {
+            return {
+              loaded: p.loaded, values: p.values, advOpen: p.advOpen, packs: p.packs, busy: false,
+              msg: ok ? ("已导出：" + r.path + "（" + r.lines + " 行）") : "",
+              err: ok ? "" : ("导出失败：" + ((r && (r.error || r.reason)) || "未知原因")),
+            }
+          })
+        })
+      }
 
       var v = s.values || {}
       var rows = []
@@ -1446,6 +1471,23 @@ window.__ModuleLoader__.load({
             ? '⚠️ debug 档会把台词和通知正文写进日志。日志在 %TEMP%\\dsh-notify-say\\notify.log，'
               + '提 Issue 前请先切回「只记元数据」或自行删改。'
             : '日志只记事件类型、音源、成败与数量，不含台词正文。排查问题时可切到 debug。'))
+
+        // ── 导出诊断（v0.4.35）───────────────────────────────────────────
+        //
+        // 用户提 Issue 时最需要的东西：一份**已脱敏**的日志。
+        // 让他自己去 %TEMP% 找、手动删用户名，多数人不会做。
+        rows.push(h('div', { key: 'dg-row', style: S.row },
+          h('span', { style: S.label }, '诊断'),
+          h('button', {
+            type: 'button',
+            disabled: s.busy,
+            style: S.btn,
+            onClick: function () { doExportDiagnostics() },
+          }, '导出诊断文件'),
+        ))
+        rows.push(h('div', { key: 'dg-hint', style: S.subHint },
+          '导出到日志同目录（%TEMP%\\dsh-notify-say\\）。会自动把用户名替换为 <user>、'
+            + '绝对路径替换为 <path>，但**仍请自己再看一遍**再上传。'))
       }
 
       if (s.msg) rows.push(h('div', { key: 'msg', style: S.ok }, s.msg))

package/lib/diagnostics.js

@@ -0,0 +1,143 @@
+/**
+ * 诊断导出（v0.4.35）。
+ *
+ * ## 为什么要单独一个出口
+ *
+ * `log-privacy.js` 里的 `sanitizeDiagnostics()` 早就写好了，但**没有调用方** ——
+ * 等于脱敏能力存在却用不上。用户提 Issue 时还是得自己去 `%TEMP%` 找日志、
+ * 手动删用户名，多数人不会做。
+ *
+ * 所以这里把它接成一个真正的功能：读日志 → 脱敏 → 写一份可直接上传的文件。
+ *
+ * ## 为什么写到同一目录而不是让浏览器下载
+ *
+ * 渲染进程（设置卡片）跑在沙箱里，没有 `fs`，也没有可用的保存对话框 API。
+ * 宿主侧写文件 + 返回路径让用户自己去打开，是唯一可靠的做法。
+ *
+ * ## 输出位置
+ *
+ * ```
+ * %TEMP%\dsh-notify-say\diagnostics-<时间戳>.txt
+ * ```
+ *
+ * 与日志同目录 —— 用户已经知道去哪儿找日志，就一定能找到它。
+ *
+ * ## ⚠️ 脱敏不是万能的
+ *
+ * 只处理：用户名、绝对路径、长 token。
+ * **不处理**：用户自己写在台词里的项目名、人名（那些看起来就是普通文本）。
+ *
+ * 所以导出文件的头部明确写「仍请自行检查一遍」。
+ * 默认档日志本来就不含台词，这条主要是给开了 debug 的用户兜底。
+ */
+
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, statSync, unlinkSync } from 'node:fs';
+import { join } from 'node:path';
+
+import { sanitizeDiagnostics, diagnosticsHeader, normalizeLevel } from './log-privacy.js';
+
+/** 导出的诊断文件保留几份（太多了目录会乱）。 */
+const KEEP_MAX = 5;
+
+/**
+ * 日志目录。
+ *
+ * @returns {string}
+ */
+export function logDirPath() {
+  const tmp = process.env.TEMP || process.env.TMP || '';
+  return tmp ? join(tmp, 'dsh-notify-say') : '';
+}
+
+/**
+ * 读日志正文（含轮转出来的 .1）。
+ *
+ * 为什么要带 .1：用户遇到问题时日志可能刚轮转过，
+ * 上一份里才有事发时的记录。
+ *
+ * @returns {{ ok: boolean, text?: string, error?: string }}
+ */
+export function readLogText() {
+  const dir = logDirPath();
+  if (!dir) return { ok: false, error: 'no-temp-dir' };
+
+  const main = join(dir, 'notify.log');
+  const rotated = join(dir, 'notify.log.1');
+
+  const parts = [];
+  try {
+    // 轮转的先读（它更旧）
+    if (existsSync(rotated)) {
+      parts.push('--- notify.log.1（较早，已轮转）---');
+      parts.push(readFileSync(rotated, 'utf8'));
+    }
+    if (existsSync(main)) {
+      parts.push('--- notify.log（当前）---');
+      parts.push(readFileSync(main, 'utf8'));
+    }
+  } catch (e) {
+    return { ok: false, error: `read: ${(e && e.message) || e}` };
+  }
+
+  if (parts.length === 0) return { ok: false, error: 'no-log-file' };
+  return { ok: true, text: parts.join('\n') };
+}
+
+/** 清理旧的诊断文件，只留最近 KEEP_MAX 份。 */
+function pruneOldDiagnostics(dir) {
+  try {
+    const files = readdirSync(dir)
+      .filter((f) => /^diagnostics-.*\.txt$/.test(f))
+      .map((f) => ({ f, t: statSync(join(dir, f)).mtimeMs }))
+      .sort((a, b) => b.t - a.t);
+    for (const { f } of files.slice(KEEP_MAX)) {
+      try { unlinkSync(join(dir, f)); } catch { /* ignore */ }
+    }
+  } catch { /* 清理失败不影响导出 */ }
+}
+
+/** 时间戳里去掉 Windows 文件名不允许的字符。 */
+function stamp() {
+  return new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
+}
+
+/**
+ * 导出一份可直接上传的诊断文件。
+ *
+ * @param {object} info 环境信息（version / nodeVersion / platform / logLevel）
+ * @returns {{ ok: boolean, path?: string, bytes?: number, lines?: number, error?: string }}
+ */
+export function exportDiagnostics(info) {
+  const dir = logDirPath();
+  if (!dir) return { ok: false, error: 'no-temp-dir' };
+
+  const read = readLogText();
+  if (!read.ok) return { ok: false, error: read.error };
+
+  const header = diagnosticsHeader({
+    version: info && info.version,
+    nodeVersion: process.version,
+    platform: process.platform,
+    logLevel: normalizeLevel(info && info.logLevel),
+    now: new Date().toISOString(),
+  });
+
+  // ⚠️ 先脱敏再拼头部：头部本身不含用户内容，但保持"整个文件都过了一遍脱敏"的习惯。
+  const body = sanitizeDiagnostics(read.text);
+  const content = header + body;
+
+  try {
+    mkdirSync(dir, { recursive: true });
+    pruneOldDiagnostics(dir);
+    const out = join(dir, `diagnostics-${stamp()}.txt`);
+    writeFileSync(out, content, 'utf8');
+    return {
+      ok: true,
+      path: out,
+      bytes: Buffer.byteLength(content, 'utf8'),
+      lines: content.split('\n').length,
+    };
+  } catch (e) {
+    return { ok: false, error: `write: ${(e && e.message) || e}` };
+  }
+}

package/lib/index.js

@@ -99,10 +99,21 @@ import { checkLocalOrigin, throttle } from './http-guard.js';
 import { poolSummary } from './voice-pack-store.js';
 import { createVoicePackRoute } from './voice-pack-route.js';
 import { isDebug, redactText } from './log-privacy.js';
+import { exportDiagnostics } from './diagnostics.js';
 import { selfReload, watchPackage, computeFingerprint } from './dev-reload.js';
 import { pickTtsText, sanitizeTtsText, MAX_TEXT_LEN } from './tts-lines.js';
 
 const PLUGIN_ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
+
+// 插件版本（诊断导出用）。读 package.json，失败就返回 unknown ——
+// 这只是个信息字段，不值得为它抛异常。
+const PLUGIN_VERSION = (() => {
+  try {
+    return JSON.parse(readFileSync(join(PLUGIN_ROOT, 'package.json'), 'utf8')).version || 'unknown';
+  } catch {
+    return 'unknown';
+  }
+})();
 const SCRIPT_PATH = join(PLUGIN_ROOT, 'dsh-notify.ps1');
 
 /**
@@ -1532,7 +1543,38 @@ function hasVoiceLine(psKind) {
                 //   ② 事件进来了但 notify() 坏了
                 // 有了这个端点就能二分：/selftest 能弹窗出声 → notify 好、问题在事件；
                 // 否则 → notify 链路坏了。
-                // 语音包管理（异步：会下载与写盘）
+                // ── 诊断导出（v0.4.35）────────────────────────────────────
+        //
+        // 读日志 → 脱敏（用户名/路径/长 token）→ 写到日志同目录，
+        // 返回路径给界面显示。
+        //
+        // 为什么必须 POST：它会**写文件**。用 GET 的话，
+        // 任意网页放个 <img src=".../diagnostics"> 就能让本机反复生成文件。
+        if (head === 'diagnostics') {
+          if (String((req && req.method) || 'GET').toUpperCase() !== 'POST') {
+            try {
+              res.writeHead(405, { 'content-type': 'application/json; charset=utf-8', allow: 'POST' });
+              res.end(JSON.stringify({ ok: false, reason: 'method-not-allowed' }));
+            } catch { /* 响应已发出 */ }
+            return;
+          }
+          try {
+            const r = exportDiagnostics({
+              version: PLUGIN_VERSION,
+              logLevel: (cfg && cfg.logLevel) || 'info',
+            });
+            res.writeHead(r.ok ? 200 : 500, { 'content-type': 'application/json; charset=utf-8', 'cache-control': 'no-store' });
+            res.end(JSON.stringify(r));
+          } catch (e) {
+            try {
+              res.writeHead(500, { 'content-type': 'application/json; charset=utf-8' });
+              res.end(JSON.stringify({ ok: false, error: String((e && e.message) || e) }));
+            } catch { /* 响应已发出 */ }
+          }
+          return;
+        }
+
+        // 语音包管理（异步：会下载与写盘）
         if (head === 'voicepacks') {
           Promise.resolve(voicePackRoute.handle(req, res, head, pathname))
             .catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name":  "dsh-notify-say",
-    "version":  "0.4.34",
+    "version":  "0.4.35",
     "description":  "Desktop notifications for DSH Desktop that actually speak: Windows TTS out of the box (zero download), VOICEVOX voice packs optional, a selectable system-sound fallback, and an idle gate that waits for running subagents before saying the turn is done. Includes a settings-page GUI (sound source, per-event overrides, jump-back-to-session, cooldowns) and a self hot-reload for development.",
     "license":  "MIT",
     "type":  "module",

package/test/diagnostics.test.mjs

@@ -0,0 +1,178 @@
+/**
+ * 诊断导出测试（v0.4.35）。
+ *
+ * ## 为什么必须测这个
+ *
+ * 这是**唯一一个"把本机数据写到文件"且用户会主动外发**的功能。
+ * 一旦脱敏失效，用户会以为安全、然后把它传到公开 Issue 里。
+ *
+ * 所以重点不是"能不能导出"，而是：
+ *   · 导出的文件里有没有残留用户名 / 路径 / token
+ *   · 路由是不是 POST（GET 可被任意网页用 <img> 触发，反复生成文件）
+ *   · 头部是否明确提醒"仍需自己检查"
+ */
+import { test } from 'node:test';
+import assert from 'node:assert/strict';
+import { existsSync, readFileSync, readdirSync, rmSync, writeFileSync, mkdirSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join, resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { exportDiagnostics, readLogText, logDirPath } from '../lib/diagnostics.js';
+
+const ROOT = resolve(dirname(fileURLToPath(import.meta.url)), '..');
+const INDEX = readFileSync(join(ROOT, 'lib', 'index.js'), 'utf8');
+const CLIENT = readFileSync(join(ROOT, 'lib', 'client.js'), 'utf8');
+
+/** 在隔离的临时目录里跑（改 TEMP 环境变量）。 */
+async function withTemp(fn) {
+  const old = process.env.TEMP;
+  const oldTmp = process.env.TMP;
+  const dir = join(tmpdir(), `diag-${Math.random().toString(36).slice(2, 10)}`);
+  mkdirSync(dir, { recursive: true });
+  process.env.TEMP = dir;
+  process.env.TMP = dir;
+  try {
+    return await fn(dir);
+  } finally {
+    if (old === undefined) delete process.env.TEMP; else process.env.TEMP = old;
+    if (oldTmp === undefined) delete process.env.TMP; else process.env.TMP = oldTmp;
+    try { rmSync(dir, { recursive: true, force: true }); } catch { /* ignore */ }
+  }
+}
+
+/** 造一份假日志（含敏感内容）。 */
+function seedLog(dir, text) {
+  const logDir = join(dir, 'dsh-notify-say');
+  mkdirSync(logDir, { recursive: true });
+  writeFileSync(join(logDir, 'notify.log'), text, 'utf8');
+  return logDir;
+}
+
+// ── G1: 没有日志时给出明确原因（不崩）──────────────────────────────────
+test('G1: 没有日志文件时返回 no-log-file', async () => {
+  await withTemp(async () => {
+    const r = exportDiagnostics({ version: '0.4.35', logLevel: 'info' });
+    assert.equal(r.ok, false);
+    assert.equal(r.error, 'no-log-file');
+  });
+});
+
+// ── G2: 正常导出（文件真的写出来了）────────────────────────────────────
+test('G2: 有日志时导出成功，文件存在且非空', async () => {
+  await withTemp(async (dir) => {
+    seedLog(dir, '2026-10-18 12:00:00 [plan] kind=done source=bundled\n');
+    const r = exportDiagnostics({ version: '0.4.35', logLevel: 'info' });
+    assert.equal(r.ok, true, `应成功，实际 ${r.error}`);
+    assert.ok(existsSync(r.path), '导出文件应存在');
+    assert.ok(r.bytes > 100, '文件不应是空的');
+  });
+});
+
+// ── G3: 脱敏真的生效（核心）────────────────────────────────────────────
+test('G3: 导出文件里没有用户名、绝对路径、长 token', async () => {
+  await withTemp(async (dir) => {
+    seedLog(dir, [
+      'log=C:\\Users\\alice\\AppData\\Local\\dsh-notify-say\\notify.log',
+      'src=E:\\secret-project\\lib\\index.js',
+      'token=abcdefghijklmnopqrstuvwxyz0123456789ABCDEF',
+      'normal [plan] kind=done',
+    ].join('\n'));
+
+    const r = exportDiagnostics({ version: '0.4.35', logLevel: 'info' });
+    assert.equal(r.ok, true);
+
+    const text = readFileSync(r.path, 'utf8');
+    assert.doesNotMatch(text, /alice/, '用户名必须被替换');
+    assert.doesNotMatch(text, /secret-project/, '绝对路径必须被替换');
+    assert.doesNotMatch(text, /abcdefghijklmnopqrstuvwxyz/, '长 token 必须被替换');
+    // 但正常内容要保留（诊断价值）
+    assert.match(text, /\[plan\] kind=done/, '非敏感内容应保留');
+  });
+});
+
+// ── G4: 头部必须声明已脱敏 + 提醒自查 ───────────────────────────────────
+test('G4: 导出文件头部声明脱敏范围并提醒自查', async () => {
+  await withTemp(async (dir) => {
+    seedLog(dir, 'x\n');
+    const r = exportDiagnostics({ version: '0.4.35', logLevel: 'debug' });
+    const text = readFileSync(r.path, 'utf8');
+
+    assert.match(text, /已自动脱敏/, '必须声明脱敏');
+    assert.match(text, /仍请自行检查/, '必须提醒用户自己再看（脱敏不是万能的）');
+    assert.match(text, /logLevel: debug/, '应记录导出时的日志级别（debug 说明可能含内容）');
+    assert.match(text, /pluginVersion: 0\.4\.35/);
+  });
+});
+
+// ── G5: 轮转的旧日志也要带上 ───────────────────────────────────────────
+test('G5: 有 notify.log.1 时一并导出（事发记录可能在那里）', async () => {
+  await withTemp(async (dir) => {
+    const logDir = seedLog(dir, 'current line\n');
+    writeFileSync(join(logDir, 'notify.log.1'), 'older line from rotation\n', 'utf8');
+
+    const r = exportDiagnostics({ version: '0.4.35', logLevel: 'info' });
+    const text = readFileSync(r.path, 'utf8');
+    assert.match(text, /older line from rotation/, '轮转的旧日志必须带上');
+    assert.match(text, /current line/, '当前日志也要有');
+  });
+});
+
+// ── G6: 保留策略 —— 不留无限多的导出文件 ───────────────────────────────
+test('G6: 多次导出只保留最近几份', async () => {
+  await withTemp(async (dir) => {
+    seedLog(dir, 'x\n');
+    for (let i = 0; i < 8; i++) {
+      const r = exportDiagnostics({ version: '0.4.35', logLevel: 'info' });
+      assert.equal(r.ok, true);
+      // 文件名按秒级时间戳，同秒会覆盖 —— 稍等一下保证 mtime 不同
+      await new Promise((res) => setTimeout(res, 15));
+    }
+    const files = readdirSync(join(dir, 'dsh-notify-say')).filter((f) => /^diagnostics-/.test(f));
+    assert.ok(files.length <= 5, `最多保留 5 份，实际 ${files.length}`);
+  });
+});
+
+// ── G7: readLogText 对不存在目录返回结构化错误 ─────────────────────────
+test('G7: readLogText 在无日志时返回结构化错误', async () => {
+  await withTemp(async () => {
+    const r = readLogText();
+    assert.equal(r.ok, false);
+    assert.ok(r.error, '应给出原因');
+  });
+});
+
+// ── G8: 路由必须是 POST（GET 可被网页触发）──────────────────────────────
+test('G8: /diagnostics 路由只接受 POST', () => {
+  const at = INDEX.indexOf("head === 'diagnostics'");
+  assert.ok(at > 0, '应有 diagnostics 路由');
+  const seg = INDEX.slice(at, at + 600);
+  assert.match(seg, /!== 'POST'/, '必须显式拒绝非 POST');
+  assert.match(seg, /405/, '非 POST 应回 405');
+  assert.match(seg, /allow: 'POST'/, '应告知正确方法');
+});
+
+// ── G9: 路由把版本与级别传进去 ─────────────────────────────────────────
+test('G9: 导出时带上插件版本与当前日志级别', () => {
+  const at = INDEX.indexOf('exportDiagnostics({');
+  assert.ok(at > 0);
+  const seg = INDEX.slice(at, at + 300);
+  assert.match(seg, /version: PLUGIN_VERSION/, '应传版本');
+  assert.match(seg, /logLevel:/, '应传日志级别（debug 导出要标明可能含内容）');
+});
+
+// ── G10: 前端有按钮且用 POST ───────────────────────────────────────────
+test('G10: 设置页有导出按钮，请求用 POST', () => {
+  assert.match(CLIENT, /导出诊断文件/, '应有按钮文案');
+  const at = CLIENT.indexOf("apiUrl('diagnostics')");
+  assert.ok(at > 0, '应调用 diagnostics 路由');
+  const seg = CLIENT.slice(at, at + 300);
+  assert.match(seg, /method: 'POST'/, '前端必须用 POST（后端会拒 GET）');
+});
+
+// ── G11: 按钮提示里说明脱敏范围与自查 ──────────────────────────────────
+test('G11: UI 提示说明会自动脱敏但需自查', () => {
+  assert.match(CLIENT, /<user>/, '应说明用户名会被替换');
+  assert.match(CLIENT, /<path>/, '应说明路径会被替换');
+  assert.match(CLIENT, /仍请自己再看一遍/, '必须提醒自查 —— 脱敏不覆盖用户自己写的内容');
+});