@spzhongwin/skill-logger-plugin 1.0.11 → 1.0.13

package/src/paths.test.ts

@@ -1,57 +1,57 @@
-import { describe, it, beforeEach, afterEach } from "node:test";
-import assert from "node:assert/strict";
-import fs from "node:fs/promises";
-import path from "node:path";
-import os from "node:os";
-import { resolveAgentSkillDirs } from "./paths.ts";
-
-let home: string;
-
-beforeEach(async () => {
-  home = path.join(os.tmpdir(), `slp-paths-${Date.now()}-${Math.random().toString(36).slice(2)}`);
-  await fs.mkdir(home, { recursive: true });
-});
-
-afterEach(async () => {
-  await fs.rm(home, { recursive: true, force: true });
-});
-
-describe("resolveAgentSkillDirs", () => {
-  it("从 openclaw.json 收集各 agent workspace 的 skills 目录（含默认与顶层）", async () => {
-    const cfg = {
-      agents: {
-        defaults: { workspace: path.join(home, "workspace") },
-        list: [
-          { id: "main" }, // 无 workspace → 落到默认
-          { id: "coder", workspace: path.join(home, "workspace-coder") },
-          { id: "proj", workspace: path.join(home, "agency-agents", "proj") },
-        ],
-      },
-    };
-    const configPath = path.join(home, "openclaw.json");
-    await fs.writeFile(configPath, JSON.stringify(cfg));
-
-    const dirs = resolveAgentSkillDirs(home, configPath);
-
-    assert.ok(dirs.includes(path.join(home, "skills")), "应含顶层全局 skills");
-    assert.ok(dirs.includes(path.join(home, "workspace", "skills")), "应含默认 workspace skills");
-    assert.ok(dirs.includes(path.join(home, "workspace-coder", "skills")), "应含 coder workspace skills");
-    assert.ok(dirs.includes(path.join(home, "agency-agents", "proj", "skills")), "应含 proj workspace skills");
-    // 去重：main 落到默认 workspace，不应产生重复项
-    assert.equal(new Set(dirs).size, dirs.length);
-  });
-
-  it("openclaw.json 缺失时回退到顶层 skills + 默认 workspace skills，且不抛", async () => {
-    const dirs = resolveAgentSkillDirs(home, path.join(home, "does-not-exist.json"));
-    assert.ok(dirs.includes(path.join(home, "skills")));
-    assert.ok(dirs.includes(path.join(home, "workspace", "skills")));
-  });
-
-  it("非法 JSON 不抛，回退到默认目录", async () => {
-    const configPath = path.join(home, "openclaw.json");
-    await fs.writeFile(configPath, "{ not valid json ");
-    const dirs = resolveAgentSkillDirs(home, configPath);
-    assert.ok(dirs.includes(path.join(home, "skills")));
-    assert.ok(dirs.includes(path.join(home, "workspace", "skills")));
-  });
-});
+import { describe, it, beforeEach, afterEach } from "node:test";
+import assert from "node:assert/strict";
+import fs from "node:fs/promises";
+import path from "node:path";
+import os from "node:os";
+import { resolveAgentSkillDirs } from "./paths.ts";
+
+let home: string;
+
+beforeEach(async () => {
+  home = path.join(os.tmpdir(), `slp-paths-${Date.now()}-${Math.random().toString(36).slice(2)}`);
+  await fs.mkdir(home, { recursive: true });
+});
+
+afterEach(async () => {
+  await fs.rm(home, { recursive: true, force: true });
+});
+
+describe("resolveAgentSkillDirs", () => {
+  it("从 openclaw.json 收集各 agent workspace 的 skills 目录（含默认与顶层）", async () => {
+    const cfg = {
+      agents: {
+        defaults: { workspace: path.join(home, "workspace") },
+        list: [
+          { id: "main" }, // 无 workspace → 落到默认
+          { id: "coder", workspace: path.join(home, "workspace-coder") },
+          { id: "proj", workspace: path.join(home, "agency-agents", "proj") },
+        ],
+      },
+    };
+    const configPath = path.join(home, "openclaw.json");
+    await fs.writeFile(configPath, JSON.stringify(cfg));
+
+    const dirs = resolveAgentSkillDirs(home, configPath);
+
+    assert.ok(dirs.includes(path.join(home, "skills")), "应含顶层全局 skills");
+    assert.ok(dirs.includes(path.join(home, "workspace", "skills")), "应含默认 workspace skills");
+    assert.ok(dirs.includes(path.join(home, "workspace-coder", "skills")), "应含 coder workspace skills");
+    assert.ok(dirs.includes(path.join(home, "agency-agents", "proj", "skills")), "应含 proj workspace skills");
+    // 去重：main 落到默认 workspace，不应产生重复项
+    assert.equal(new Set(dirs).size, dirs.length);
+  });
+
+  it("openclaw.json 缺失时回退到顶层 skills + 默认 workspace skills，且不抛", async () => {
+    const dirs = resolveAgentSkillDirs(home, path.join(home, "does-not-exist.json"));
+    assert.ok(dirs.includes(path.join(home, "skills")));
+    assert.ok(dirs.includes(path.join(home, "workspace", "skills")));
+  });
+
+  it("非法 JSON 不抛，回退到默认目录", async () => {
+    const configPath = path.join(home, "openclaw.json");
+    await fs.writeFile(configPath, "{ not valid json ");
+    const dirs = resolveAgentSkillDirs(home, configPath);
+    assert.ok(dirs.includes(path.join(home, "skills")));
+    assert.ok(dirs.includes(path.join(home, "workspace", "skills")));
+  });
+});

package/src/paths.ts

@@ -1,84 +1,84 @@
-/**
- * 集中管理插件用到的所有文件系统路径。
- *
- * 为什么集中：① 单测可注入临时目录；② openclaw 安全策略下插件不读环境变量，
- * 路径在此固定，运行时不依赖外部配置。
- */
-import fs from "node:fs";
-import path from "node:path";
-import os from "node:os";
-
-/** 所有可注入路径的集合；不传时回落到 `~/.openclaw` 下的默认位置。 */
-export type PluginPaths = {
-  /** 事件日志队列：待上报事件追加写入；成功上报后清理已确认行。 */
-  eventsLogPath: string;
-  /** 配置同步状态：已装 skill 签名 + 缓存的标准配置。 */
-  syncStatePath: string;
-  /** 更新冷却期状态：skill@version → 上次尝试时间戳。 */
-  cooldownStatePath: string;
-  /** openclaw 扩展安装目录，用于扫描已装 skill。 */
-  extensionsDir: string;
-  /** openclaw 主配置文件路径（含 agents 列表），用于动态解析各 agent workspace 的 skills 目录。 */
-  openclawConfigPath: string;
-};
-
-/** 默认根目录 `~/.openclaw`。 */
-export function openclawHome(): string {
-  return path.join(os.homedir(), ".openclaw");
-}
-
-/**
- * 解析所有 agent workspace 下的 skill 扫描目录。
- *
- * 来源：
- *  - 顶层全局 skills：`<home>/skills`
- *  - 默认 workspace：`<agents.defaults.workspace>/skills`（缺省为 `<home>/workspace`）
- *  - 各 agent：`<agents.list[].workspace>/skills`（未显式配置 workspace 的 agent 落到默认）
- *
- * openclaw.json 不存在 / 解析失败 / 字段缺失时，回退到「顶层 skills + 默认 workspace skills」，
- * 至少不弱于历史行为，且整段被 try/catch 包裹，绝不抛。
- */
-export function resolveAgentSkillDirs(home: string, configPath: string): string[] {
-  const dirs = new Set<string>();
-  // 永远纳入的兜底目录（即便 openclaw.json 缺失也能工作）。
-  dirs.add(path.join(home, "skills"));
-  const defaultWorkspaceFallback = path.join(home, "workspace");
-  dirs.add(path.join(defaultWorkspaceFallback, "skills"));
-
-  try {
-    const raw = fs.readFileSync(configPath, "utf-8");
-    const cfg = JSON.parse(raw) as {
-      agents?: { defaults?: { workspace?: unknown }; list?: Array<{ workspace?: unknown }> };
-    };
-    const agents = cfg?.agents;
-    const defaultWs =
-      typeof agents?.defaults?.workspace === "string" ? agents.defaults.workspace : defaultWorkspaceFallback;
-    dirs.add(path.join(defaultWs, "skills"));
-
-    const list = Array.isArray(agents?.list) ? agents!.list! : [];
-    for (const a of list) {
-      const ws = typeof a?.workspace === "string" ? a.workspace : defaultWs;
-      dirs.add(path.join(ws, "skills"));
-    }
-  } catch {
-    // openclaw.json 不存在 / 非法 JSON / 权限不足 → 用上面的兜底目录，绝不影响插件启动。
-  }
-
-  return [...dirs];
-}
-
-/**
- * 生成一组路径。`overrides` 仅供测试注入（如指向临时目录）。
- */
-export function resolvePaths(overrides?: Partial<PluginPaths>): PluginPaths {
-  const home = openclawHome();
-  const logsDir = path.join(home, "logs");
-  return {
-    eventsLogPath: path.join(logsDir, "skill-logger-plugin.jsonl"),
-    syncStatePath: path.join(logsDir, "skill-logger-plugin.sync.json"),
-    cooldownStatePath: path.join(logsDir, "skill-logger-plugin.cooldown.json"),
-    extensionsDir: path.join(home, "extensions"),
-    openclawConfigPath: path.join(home, "openclaw.json"),
-    ...overrides,
-  };
-}
+/**
+ * 集中管理插件用到的所有文件系统路径。
+ *
+ * 为什么集中：① 单测可注入临时目录；② openclaw 安全策略下插件不读环境变量，
+ * 路径在此固定，运行时不依赖外部配置。
+ */
+import fs from "node:fs";
+import path from "node:path";
+import os from "node:os";
+
+/** 所有可注入路径的集合；不传时回落到 `~/.openclaw` 下的默认位置。 */
+export type PluginPaths = {
+  /** 事件日志队列：待上报事件追加写入；成功上报后清理已确认行。 */
+  eventsLogPath: string;
+  /** 配置同步状态：已装 skill 签名 + 缓存的标准配置。 */
+  syncStatePath: string;
+  /** 更新冷却期状态：skill@version → 上次尝试时间戳。 */
+  cooldownStatePath: string;
+  /** openclaw 扩展安装目录，用于扫描已装 skill。 */
+  extensionsDir: string;
+  /** openclaw 主配置文件路径（含 agents 列表），用于动态解析各 agent workspace 的 skills 目录。 */
+  openclawConfigPath: string;
+};
+
+/** 默认根目录 `~/.openclaw`。 */
+export function openclawHome(): string {
+  return path.join(os.homedir(), ".openclaw");
+}
+
+/**
+ * 解析所有 agent workspace 下的 skill 扫描目录。
+ *
+ * 来源：
+ *  - 顶层全局 skills：`<home>/skills`
+ *  - 默认 workspace：`<agents.defaults.workspace>/skills`（缺省为 `<home>/workspace`）
+ *  - 各 agent：`<agents.list[].workspace>/skills`（未显式配置 workspace 的 agent 落到默认）
+ *
+ * openclaw.json 不存在 / 解析失败 / 字段缺失时，回退到「顶层 skills + 默认 workspace skills」，
+ * 至少不弱于历史行为，且整段被 try/catch 包裹，绝不抛。
+ */
+export function resolveAgentSkillDirs(home: string, configPath: string): string[] {
+  const dirs = new Set<string>();
+  // 永远纳入的兜底目录（即便 openclaw.json 缺失也能工作）。
+  dirs.add(path.join(home, "skills"));
+  const defaultWorkspaceFallback = path.join(home, "workspace");
+  dirs.add(path.join(defaultWorkspaceFallback, "skills"));
+
+  try {
+    const raw = fs.readFileSync(configPath, "utf-8");
+    const cfg = JSON.parse(raw) as {
+      agents?: { defaults?: { workspace?: unknown }; list?: Array<{ workspace?: unknown }> };
+    };
+    const agents = cfg?.agents;
+    const defaultWs =
+      typeof agents?.defaults?.workspace === "string" ? agents.defaults.workspace : defaultWorkspaceFallback;
+    dirs.add(path.join(defaultWs, "skills"));
+
+    const list = Array.isArray(agents?.list) ? agents!.list! : [];
+    for (const a of list) {
+      const ws = typeof a?.workspace === "string" ? a.workspace : defaultWs;
+      dirs.add(path.join(ws, "skills"));
+    }
+  } catch {
+    // openclaw.json 不存在 / 非法 JSON / 权限不足 → 用上面的兜底目录，绝不影响插件启动。
+  }
+
+  return [...dirs];
+}
+
+/**
+ * 生成一组路径。`overrides` 仅供测试注入（如指向临时目录）。
+ */
+export function resolvePaths(overrides?: Partial<PluginPaths>): PluginPaths {
+  const home = openclawHome();
+  const logsDir = path.join(home, "logs");
+  return {
+    eventsLogPath: path.join(logsDir, "skill-logger-plugin.jsonl"),
+    syncStatePath: path.join(logsDir, "skill-logger-plugin.sync.json"),
+    cooldownStatePath: path.join(logsDir, "skill-logger-plugin.cooldown.json"),
+    extensionsDir: path.join(home, "extensions"),
+    openclawConfigPath: path.join(home, "openclaw.json"),
+    ...overrides,
+  };
+}

package/src/reporter.test.ts

@@ -1,139 +1,139 @@
-import { describe, it, beforeEach, afterEach } from "node:test";
-import assert from "node:assert/strict";
-import fs from "node:fs/promises";
-import path from "node:path";
-import os from "node:os";
-import { Reporter } from "./reporter.ts";
-import type { PluginConfig, SkillEvent } from "./types.ts";
-
-const identityProvider = {
-  getIdentity: async () => ({ user_id: "", git_name: "n", git_email: "e", machine_id: "m" }),
-};
-
-function makeEvent(i: number): SkillEvent {
-  return { event_id: `id${i}`, event_type: "function_call", skill_name: "s", called_at: new Date().toISOString() };
-}
-
-let dir: string;
-let paths: { eventsLogPath: string };
-
-beforeEach(async () => {
-  dir = path.join(os.tmpdir(), `slp-reporter-${Date.now()}-${Math.random().toString(36).slice(2)}`);
-  await fs.mkdir(dir, { recursive: true });
-  paths = {
-    eventsLogPath: path.join(dir, "events.jsonl"),
-  };
-});
-
-afterEach(async () => {
-  await fs.rm(dir, { recursive: true, force: true });
-});
-
-/** 缺文件视为空，匹配轮转模型下「上报成功即删除」的形态。 */
-async function readEventsOrEmpty(p: string): Promise<string> {
-  try {
-    return await fs.readFile(p, "utf-8");
-  } catch {
-    return "";
-  }
-}
-
-/** 列出已轮转、待上报的日志文件（排除活跃的 events.jsonl）。 */
-async function listRotated(d: string): Promise<string[]> {
-  try {
-    const entries = await fs.readdir(d);
-    return entries.filter((f) => f.startsWith("events.") && f.endsWith(".jsonl") && f !== "events.jsonl");
-  } catch {
-    return [];
-  }
-}
-
-describe("Reporter.appendEvent", () => {
-  it("目录自动创建并追加写", async () => {
-    const r = new Reporter({ paths, getConfig: () => ({}), identityProvider });
-    await r.appendEvent(makeEvent(1));
-    await r.appendEvent(makeEvent(2));
-    const lines = (await fs.readFile(paths.eventsLogPath, "utf-8")).trim().split("\n");
-    assert.equal(lines.length, 2);
-    assert.equal(JSON.parse(lines[1]).event_id, "id2");
-  });
-});
-
-describe("Reporter.flush", () => {
-  it("未配置 reportBaseUrl 时不上报", async () => {
-    let called = 0;
-    const r = new Reporter({
-      paths,
-      getConfig: () => ({}),
-      identityProvider,
-      fetchImpl: async () => {
-        called++;
-        return { ok: true, status: 200 };
-      },
-    });
-    await r.appendEvent(makeEvent(1));
-    await r.flush();
-    assert.equal(called, 0);
-  });
-
-  it("成功上报后清理本地日志，再次 flush 不重复发", async () => {
-    const sent: number[] = [];
-    const config: PluginConfig = { reportBaseUrl: "https://x" };
-    const r = new Reporter({
-      paths,
-      getConfig: () => config,
-      identityProvider,
-      fetchImpl: async (_url, init) => {
-        const body = JSON.parse(String(init.body));
-        sent.push(body.events.length);
-        return { ok: true, status: 200 };
-      },
-    });
-    await r.appendEvent(makeEvent(1));
-    await r.appendEvent(makeEvent(2));
-    await r.flush();
-    await r.flush(); // 无新事件
-    assert.deepEqual(sent, [2]);
-    // 轮转文件已全部上报并删除，活跃日志清空
-    assert.equal(await readEventsOrEmpty(paths.eventsLogPath), "");
-    assert.equal((await listRotated(dir)).length, 0);
-  });
-
-  it("保留 flush 期间新追加的事件（轮转隔离读写）", async () => {
-    let appendedDuringFlush = false;
-    const r = new Reporter({
-      paths,
-      getConfig: () => ({ reportBaseUrl: "https://x" }),
-      identityProvider,
-      fetchImpl: async () => {
-        if (!appendedDuringFlush) {
-          appendedDuringFlush = true;
-          await fs.appendFile(paths.eventsLogPath, JSON.stringify(makeEvent(2)) + "\n");
-        }
-        return { ok: true, status: 200 };
-      },
-    });
-    await r.appendEvent(makeEvent(1));
-    await r.flush();
-    const lines = (await readEventsOrEmpty(paths.eventsLogPath)).trim().split("\n").filter(Boolean);
-    assert.equal(lines.length, 1);
-    assert.equal(JSON.parse(lines[0]).event_id, "id2");
-  });
-
-  it("上报失败保留轮转文件，下轮重试成功后清空", async () => {
-    let ok = false;
-    const r = new Reporter({
-      paths,
-      getConfig: () => ({ reportBaseUrl: "https://x" }),
-      identityProvider,
-      fetchImpl: async () => ({ ok, status: ok ? 200 : 500 }),
-    });
-    await r.appendEvent(makeEvent(1));
-    await r.flush(); // 失败：轮转文件保留待重试
-    assert.equal((await listRotated(dir)).length, 1);
-    ok = true;
-    await r.flush(); // 成功：清空
-    assert.equal((await listRotated(dir)).length, 0);
-    assert.equal(await readEventsOrEmpty(paths.eventsLogPath), "");
-  });
-});
+import { describe, it, beforeEach, afterEach } from "node:test";
+import assert from "node:assert/strict";
+import fs from "node:fs/promises";
+import path from "node:path";
+import os from "node:os";
+import { Reporter } from "./reporter.ts";
+import type { PluginConfig, SkillEvent } from "./types.ts";
+
+const identityProvider = {
+  getIdentity: async () => ({ user_id: "", git_name: "n", git_email: "e", machine_id: "m" }),
+};
+
+function makeEvent(i: number): SkillEvent {
+  return { event_id: `id${i}`, event_type: "function_call", skill_name: "s", called_at: new Date().toISOString() };
+}
+
+let dir: string;
+let paths: { eventsLogPath: string };
+
+beforeEach(async () => {
+  dir = path.join(os.tmpdir(), `slp-reporter-${Date.now()}-${Math.random().toString(36).slice(2)}`);
+  await fs.mkdir(dir, { recursive: true });
+  paths = {
+    eventsLogPath: path.join(dir, "events.jsonl"),
+  };
+});
+
+afterEach(async () => {
+  await fs.rm(dir, { recursive: true, force: true });
+});
+
+/** 缺文件视为空，匹配轮转模型下「上报成功即删除」的形态。 */
+async function readEventsOrEmpty(p: string): Promise<string> {
+  try {
+    return await fs.readFile(p, "utf-8");
+  } catch {
+    return "";
+  }
+}
+
+/** 列出已轮转、待上报的日志文件（排除活跃的 events.jsonl）。 */
+async function listRotated(d: string): Promise<string[]> {
+  try {
+    const entries = await fs.readdir(d);
+    return entries.filter((f) => f.startsWith("events.") && f.endsWith(".jsonl") && f !== "events.jsonl");
+  } catch {
+    return [];
+  }
+}
+
+describe("Reporter.appendEvent", () => {
+  it("目录自动创建并追加写", async () => {
+    const r = new Reporter({ paths, getConfig: () => ({}), identityProvider });
+    await r.appendEvent(makeEvent(1));
+    await r.appendEvent(makeEvent(2));
+    const lines = (await fs.readFile(paths.eventsLogPath, "utf-8")).trim().split("\n");
+    assert.equal(lines.length, 2);
+    assert.equal(JSON.parse(lines[1]).event_id, "id2");
+  });
+});
+
+describe("Reporter.flush", () => {
+  it("未配置 reportBaseUrl 时不上报", async () => {
+    let called = 0;
+    const r = new Reporter({
+      paths,
+      getConfig: () => ({}),
+      identityProvider,
+      fetchImpl: async () => {
+        called++;
+        return { ok: true, status: 200 };
+      },
+    });
+    await r.appendEvent(makeEvent(1));
+    await r.flush();
+    assert.equal(called, 0);
+  });
+
+  it("成功上报后清理本地日志，再次 flush 不重复发", async () => {
+    const sent: number[] = [];
+    const config: PluginConfig = { reportBaseUrl: "https://x" };
+    const r = new Reporter({
+      paths,
+      getConfig: () => config,
+      identityProvider,
+      fetchImpl: async (_url, init) => {
+        const body = JSON.parse(String(init.body));
+        sent.push(body.events.length);
+        return { ok: true, status: 200 };
+      },
+    });
+    await r.appendEvent(makeEvent(1));
+    await r.appendEvent(makeEvent(2));
+    await r.flush();
+    await r.flush(); // 无新事件
+    assert.deepEqual(sent, [2]);
+    // 轮转文件已全部上报并删除，活跃日志清空
+    assert.equal(await readEventsOrEmpty(paths.eventsLogPath), "");
+    assert.equal((await listRotated(dir)).length, 0);
+  });
+
+  it("保留 flush 期间新追加的事件（轮转隔离读写）", async () => {
+    let appendedDuringFlush = false;
+    const r = new Reporter({
+      paths,
+      getConfig: () => ({ reportBaseUrl: "https://x" }),
+      identityProvider,
+      fetchImpl: async () => {
+        if (!appendedDuringFlush) {
+          appendedDuringFlush = true;
+          await fs.appendFile(paths.eventsLogPath, JSON.stringify(makeEvent(2)) + "\n");
+        }
+        return { ok: true, status: 200 };
+      },
+    });
+    await r.appendEvent(makeEvent(1));
+    await r.flush();
+    const lines = (await readEventsOrEmpty(paths.eventsLogPath)).trim().split("\n").filter(Boolean);
+    assert.equal(lines.length, 1);
+    assert.equal(JSON.parse(lines[0]).event_id, "id2");
+  });
+
+  it("上报失败保留轮转文件，下轮重试成功后清空", async () => {
+    let ok = false;
+    const r = new Reporter({
+      paths,
+      getConfig: () => ({ reportBaseUrl: "https://x" }),
+      identityProvider,
+      fetchImpl: async () => ({ ok, status: ok ? 200 : 500 }),
+    });
+    await r.appendEvent(makeEvent(1));
+    await r.flush(); // 失败：轮转文件保留待重试
+    assert.equal((await listRotated(dir)).length, 1);
+    ok = true;
+    await r.flush(); // 成功：清空
+    assert.equal((await listRotated(dir)).length, 0);
+    assert.equal(await readEventsOrEmpty(paths.eventsLogPath), "");
+  });
+});