@modusensus/dsh-mneme 0.2.4 → 0.2.6

package/test/service-search.test.js

@@ -0,0 +1,169 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { createStore } from "../src/store.js";
+import { createService } from "../src/service.js";
+import { createVectorIndex } from "../src/vector-index.js";
+
+// Mock embedder from the pipeline spec: every query maps to the fixed vector
+// [1,0,0], so vector recall surfaces any row embedded at [1,0,0] (cosine 1)
+// and ignores rows embedded elsewhere (cosine 0).
+const embedder = {
+  embedSingle: async () => [1, 0, 0],
+  embed: async () => [1, 0, 0],
+  modelHash: "mock#1",
+  dimension: 3
+};
+
+// Mock reranker: scores candidates by their merge order (0,1,2,...) then sorts
+// descending — i.e. it reverses the incoming order. Deterministic, so tests can
+// assert the on/off difference precisely.
+const reranker = {
+  rerank: async (q, cands) =>
+    cands.map((c, i) => ({ id: c.id, score: i })).sort((a, b) => b.score - a.score)
+};
+
+// Real store + service, wired with the mock embedder and a vector index over
+// the same store (the service's vector path prefers vectorIndex when set).
+function setup({ withEmbedder = true } = {}) {
+  const store = createStore(":memory:");
+  const service = createService({ store, mirror: null, config: {} });
+  const vectorIndex = createVectorIndex({ store });
+  if (withEmbedder) {
+    service.setEmbedder(embedder);
+    service.setVectorIndex(vectorIndex);
+  }
+  return { store, service, vectorIndex };
+}
+
+test("hybrid merges vector + keyword recalls and dedups shared memories", async () => {
+  const { service, vectorIndex } = setup();
+  // keyword-only hit: literal query in the title, embedding far from [1,0,0].
+  const kw = service.saveWithDedupe({ type: "preference", title: "量子计算", content: "量子计算入门", importance: 5 });
+  vectorIndex.saveEmbedding(kw.memory.id, [0, 1, 0]);
+  // vector-only hit: no literal match, but embedded exactly at the query vector.
+  const vec = service.saveWithDedupe({ type: "project", title: "猫", content: "喜欢猫" });
+  vectorIndex.saveEmbedding(vec.memory.id, [1, 0, 0]);
+  // both: literal match AND embedded at [1,0,0] -> must appear exactly once.
+  const both = service.saveWithDedupe({ type: "decision", title: "量子计算笔记", content: "量子计算实践" });
+  vectorIndex.saveEmbedding(both.memory.id, [1, 0, 0]);
+
+  const rows = await service.searchMemories("量子计算", { mode: "hybrid", topK: 10 });
+  const ids = rows.map((r) => r.id);
+  assert.ok(ids.includes(vec.memory.id), "vector recall surfaces the semantic-only hit");
+  assert.ok(ids.includes(kw.memory.id), "keyword recall surfaces the literal hit");
+  assert.equal(ids.filter((id) => id === both.memory.id).length, 1, "overlap row is deduped to a single entry");
+  assert.ok(rows.some((m) => m.id === both.memory.id && m.vector), "shared row is flagged as a vector hit");
+  assert.equal(ids[0], vec.memory.id, "vector leads the hybrid blend");
+});
+
+test("hybrid blend honors configured vector/keyword weights", async () => {
+  const { service, vectorIndex } = setup();
+  const both = service.saveWithDedupe({ type: "preference", title: "量子计算", content: "量子计算入门" });
+  vectorIndex.saveEmbedding(both.memory.id, [1, 0, 0]);
+
+  // Title hit scores 1 * (0.5 + 3/10) = 0.8; vector cosine = 1.0.
+  // Default weights (0.6/0.4) -> 0.6 + 0.32 = 0.92.
+  const defaults = await service.searchMemories("量子计算", { mode: "hybrid", topK: 10 });
+  const d = defaults.find((m) => m.id === both.memory.id);
+  assert.ok(Math.abs(d.score - 0.92) < 1e-9, `default blend ${d.score}`);
+
+  // Even 0.5/0.5 -> 0.5 + 0.4 = 0.9.
+  const store = createStore(":memory:");
+  const tuned = createService({ store, mirror: null, config: { hybridSearchVectorWeight: 0.5, hybridSearchKeywordWeight: 0.5 } });
+  const vi = createVectorIndex({ store });
+  tuned.setEmbedder(embedder);
+  tuned.setVectorIndex(vi);
+  const m = tuned.saveWithDedupe({ type: "preference", title: "量子计算", content: "量子计算入门" });
+  vi.saveEmbedding(m.memory.id, [1, 0, 0]);
+  const rows = await tuned.searchMemories("量子计算", { mode: "hybrid", topK: 10 });
+  const t = rows.find((r) => r.id === m.memory.id);
+  assert.ok(Math.abs(t.score - 0.9) < 1e-9, `tuned blend ${t.score}`);
+});
+
+test("auto = keyword leads, vector fills the remaining slots", async () => {
+  const { service, vectorIndex } = setup();
+  const kw = service.saveWithDedupe({ type: "preference", title: "量子计算", content: "量子计算入门" });
+  vectorIndex.saveEmbedding(kw.memory.id, [0, 1, 0]);
+  const vec = service.saveWithDedupe({ type: "preference", title: "猫", content: "喜欢猫" });
+  vectorIndex.saveEmbedding(vec.memory.id, [1, 0, 0]);
+
+  const rows = await service.searchMemories("量子计算", { mode: "auto", topK: 10 });
+  const ids = rows.map((r) => r.id);
+  assert.ok(ids.includes(kw.memory.id), "keyword hit present");
+  assert.ok(ids.includes(vec.memory.id), "vector fills a free slot");
+  assert.equal(ids[0], kw.memory.id, "keyword stays first in auto mode");
+});
+
+test("reranker on/off: rerank reorders by score, off keeps merge order", async () => {
+  const { service, vectorIndex } = setup();
+  const a = service.saveWithDedupe({ type: "preference", title: "猫", content: "喜欢猫", importance: 5 });
+  vectorIndex.saveEmbedding(a.memory.id, [0, 1, 0]);
+  const b = service.saveWithDedupe({ type: "preference", title: "猫猫", content: "猫粮", importance: 3 });
+  vectorIndex.saveEmbedding(b.memory.id, [0, 1, 0]);
+
+  // No reranker: keyword order (importance desc) is preserved.
+  const off = await service.searchMemories("猫", { mode: "keyword", topK: 10 });
+  assert.equal(off[0].id, a.memory.id, "without a reranker merge order is kept");
+
+  // Mock reranker installed: it reverses the merge order by score.
+  service.setReranker(reranker);
+  const on = await service.searchMemories("猫", { mode: "keyword", topK: 10 });
+  assert.equal(on[0].id, b.memory.id, "rerank reorders to the highest score first");
+  assert.equal(typeof on[0].score, "number", "reranked rows carry a score");
+
+  // Clearing the reranker restores merge order.
+  service.setReranker(null);
+  const after = await service.searchMemories("猫", { mode: "keyword", topK: 10 });
+  assert.equal(after[0].id, a.memory.id, "clearing the reranker restores original order");
+});
+
+test("keyword mode never calls the embedder", async () => {
+  let calls = 0;
+  const counting = { ...embedder, embedSingle: async () => { calls++; return [1, 0, 0]; } };
+  const { service, vectorIndex } = setup();
+  service.setEmbedder(counting);
+  service.setVectorIndex(vectorIndex);
+  service.saveWithDedupe({ type: "preference", title: "语言", content: "中文交流" });
+
+  const rows = await service.searchMemories("中文", { mode: "keyword", topK: 10 });
+  assert.equal(rows.length, 1);
+  assert.equal(rows[0].title, "语言");
+  assert.equal(calls, 0, "keyword mode must never embed the query");
+});
+
+test("embedder failure degrades to keyword results", async () => {
+  const broken = { ...embedder, embedSingle: async () => { throw new Error("model unavailable"); } };
+  const { service, vectorIndex } = setup();
+  service.setEmbedder(broken);
+  service.setVectorIndex(vectorIndex);
+  service.saveWithDedupe({ type: "preference", title: "语言", content: "中文交流" });
+
+  const rows = await service.searchMemories("中文", { mode: "auto", topK: 10 });
+  assert.equal(rows.length, 1, "keyword fallback still returns matches");
+  assert.equal(rows[0].title, "语言");
+  assert.ok(!rows.some((m) => m.vector), "no rows claim the vector path after a failure");
+});
+
+test("vector mode returns semantic hits, and falls back to keyword without an embedder", async () => {
+  const { service, vectorIndex } = setup();
+  const hit = service.saveWithDedupe({ type: "preference", title: "猫", content: "喜欢猫" });
+  vectorIndex.saveEmbedding(hit.memory.id, [1, 0, 0]);
+  const rows = await service.searchMemories("猫", { mode: "vector", topK: 10 });
+  assert.ok(rows.some((m) => m.id === hit.memory.id && m.vector), "vector-only recall surfaces the embedded hit");
+
+  // No embedder/vector index: vector mode falls back to literal keyword.
+  const bare = setup({ withEmbedder: false });
+  const m = bare.service.saveWithDedupe({ type: "preference", title: "语言", content: "中文交流" });
+  const fallback = await bare.service.searchMemories("中文", { mode: "vector", topK: 10 });
+  assert.ok(fallback.some((x) => x.id === m.memory.id), "keyword fallback when vector is unavailable");
+});
+
+test("topK caps the merged result set", async () => {
+  const { service, vectorIndex } = setup();
+  for (let i = 0; i < 5; i++) {
+    const m = service.saveWithDedupe({ type: "preference", title: `猫${i}`, content: "猫" });
+    vectorIndex.saveEmbedding(m.memory.id, [1, 0, 0]);
+  }
+  const rows = await service.searchMemories("猫", { mode: "auto", topK: 3 });
+  assert.equal(rows.length, 3, "merged list is trimmed to topK");
+});

package/test/service.test.js

@@ -0,0 +1,198 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { mkdtempSync, readFileSync, rmSync, existsSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { createStore } from "../src/store.js";
+import { createService } from "../src/service.js";
+import { createMirror } from "../src/mirror.js";
+
+function setup() {
+  const store = createStore(":memory:");
+  const service = createService({ store, mirror: null, config: {} });
+  return { store, service };
+}
+
+test("saveWithDedupe adds new memory when no similar exists", () => {
+  const { store, service } = setup();
+  const result = service.saveWithDedupe({
+    type: "project",
+    title: "记忆插件",
+    content: "正在开发 dsh-mneme，SQLite+Markdown",
+    importance: 4
+  });
+  assert.equal(result.action, "created");
+  assert.equal(store.count(), 1);
+});
+
+test("saveWithDedupe merges into existing on exact title match", () => {
+  const { store, service } = setup();
+  service.saveWithDedupe({ type: "project", title: "记忆插件", content: "旧内容", importance: 3 });
+  const result = service.saveWithDedupe({ type: "project", title: "记忆插件", content: "新内容", importance: 5 });
+  assert.equal(result.action, "merged");
+  assert.equal(store.count(), 1);
+  const all = store.all();
+  assert.equal(all[0].content, "新内容");
+  assert.equal(all[0].importance, 5);
+});
+
+test("injectCandidates returns preferences + high-importance items within limit", () => {
+  const { service } = setup();
+  for (let i = 0; i < 3; i++) service.saveWithDedupe({ type: "preference", title: `p${i}`, content: "偏好" });
+  service.saveWithDedupe({ type: "project", title: "low", content: "低", importance: 2 });
+  service.saveWithDedupe({ type: "project", title: "high", content: "高", importance: 5 });
+  service.saveWithDedupe({ type: "history", title: "h", content: "历史", importance: 5 });
+  const candidates = service.injectCandidates({ maxItems: 5, threshold: 4 });
+  const types = candidates.map((c) => c.type);
+  assert.ok(types.includes("preference"), "preferences included");
+  assert.ok(types.includes("project"), "high-importance project included");
+  assert.ok(!types.includes("history"), "history excluded by default");
+  assert.ok(candidates.length <= 5, "respects maxItems");
+});
+
+test("mergeHumanEdits applies human content over machine", () => {
+  const { store, service } = setup();
+  const saved = service.saveWithDedupe({ type: "preference", title: "语言", content: "机器内容" });
+  const edits = [{ id: saved.memory.id, title: "语言", content: "人类编辑内容" }];
+  service.mergeHumanEdits("preference", edits);
+  const got = store.getById(saved.memory.id);
+  assert.equal(got.content, "人类编辑内容");
+});
+
+test("toApiList maps store rows to wire DTOs", () => {
+  const { service } = setup();
+  const saved = service.saveWithDedupe({ type: "decision", title: "选型", content: "node:sqlite", importance: 3 });
+  const dto = service.toApiList([saved.memory]);
+  assert.deepEqual(Object.keys(dto[0]).sort(), ["id", "type", "title", "content", "tags", "importance", "source", "created_at", "updated_at"].sort());
+  assert.equal(dto[0].id, saved.memory.id);
+  assert.equal(dto[0].type, "decision");
+  assert.equal(dto[0].title, "选型");
+  assert.equal(dto[0].content, "node:sqlite");
+  assert.equal(dto[0].importance, 3);
+});
+
+test("mergeHumanEdits skips edits without id and keeps applying the rest", () => {
+  const { store, service } = setup();
+  const first = service.saveWithDedupe({ type: "preference", title: "语言", content: "机器内容" });
+  const second = service.saveWithDedupe({ type: "preference", title: "主题", content: "机器内容" });
+  const edits = [
+    { content: "缺少 id 的损坏条目" },
+    { id: first.memory.id, title: "语言", content: "人类编辑内容" },
+    { id: second.memory.id, title: "主题", content: "第二个人类编辑" }
+  ];
+  const applied = service.mergeHumanEdits("preference", edits);
+  assert.equal(applied, 2, "returns count of applied edits, not input length");
+  assert.equal(store.getById(first.memory.id).content, "人类编辑内容");
+  assert.equal(store.getById(second.memory.id).content, "第二个人类编辑");
+});
+
+test("mutations through passthroughs sync mirror; forgotten entries stay out of it", () => {
+  const store = createStore(":memory:");
+  const dir = mkdtempSync(join(tmpdir(), "dsh-mneme-service-"));
+  const mirror = createMirror(dir);
+  const service = createService({ store, mirror, config: {} });
+  try {
+    const saved = service.saveWithDedupe({ type: "project", title: "A", content: "a", importance: 4 });
+    assert.ok(existsSync(join(dir, "projects.md")), "mirror written on save");
+
+    service.update(saved.memory.id, { content: "a2" });
+    assert.match(readFileSync(join(dir, "projects.md"), "utf8"), /a2/, "update re-syncs mirror");
+
+    service.setForget(saved.memory.id, true);
+    assert.ok(!existsSync(join(dir, "projects.md")), "forgotten entry removed from mirror");
+
+    const second = service.saveWithDedupe({ type: "project", title: "B", content: "b", importance: 2 });
+    assert.ok(existsSync(join(dir, "projects.md")), "mirror rewritten after re-save");
+    service.remove(second.memory.id);
+    assert.ok(!existsSync(join(dir, "projects.md")), "remove re-syncs mirror");
+  } finally {
+    rmSync(dir, { recursive: true, force: true });
+  }
+});
+
+test("saveWithDedupe created branch keeps forgotten entries out of mirror", () => {
+  const store = createStore(":memory:");
+  const dir = mkdtempSync(join(tmpdir(), "dsh-mneme-service-"));
+  const mirror = createMirror(dir);
+  const service = createService({ store, mirror, config: {} });
+  try {
+    const a = service.saveWithDedupe({ type: "project", title: "A", content: "a", importance: 4 });
+    service.setForget(a.memory.id, true);
+    service.saveWithDedupe({ type: "project", title: "B", content: "b", importance: 2 });
+    const text = readFileSync(join(dir, "projects.md"), "utf8");
+    assert.ok(!text.includes(a.memory.id), "forgotten A must not reappear in mirror");
+    assert.ok(!text.includes("## A"), "forgotten A entry absent from mirror");
+    assert.match(text, /## B/, "non-forgotten B present in mirror");
+  } finally {
+    rmSync(dir, { recursive: true, force: true });
+  }
+});
+
+test("injectCandidates excludes archived entries", () => {
+  const { store, service } = setup();
+  const saved = service.saveWithDedupe({ type: "preference", title: "旧偏好", content: "old", importance: 5 });
+  store.setArchived(saved.memory.id, true);
+  const candidates = service.injectCandidates({ maxItems: 5, threshold: 3 });
+  assert.ok(!candidates.some((c) => c.id === saved.memory.id), "archived excluded");
+});
+
+test("summary memory is a candidate at top priority", () => {
+  const { service } = setup();
+  service.saveWithDedupe({ type: "preference", title: "语言", content: "中文", importance: 5 });
+  service.saveWithDedupe({ type: "summary", title: "记忆库总览", content: "总览内容", importance: 5 });
+  const candidates = service.injectCandidates({ maxItems: 5, threshold: 3 });
+  assert.equal(candidates[0]?.type, "summary", "summary first even with competing high-importance preference");
+});
+
+test("write methods invoke onWrite hook when provided", () => {
+  const { store } = setup();
+  let called = 0;
+  const svc = createService({ store, mirror: null, config: {}, onWrite: () => { called++; } });
+  svc.saveWithDedupe({ type: "project", title: "a", content: "x" });
+  assert.equal(called, 1, "saveWithDedupe hooks");
+  svc.update(svc.all()[0].id, { content: "y" });
+  assert.equal(called, 2, "update hooks");
+  svc.setArchived(svc.all()[0].id, true);
+  assert.equal(called, 2, "setArchived does not hook (not a content write)");
+});
+
+// --- transactions (item ②) + compare-and-set (item ①/③) --------------------
+
+test("service.transaction rolls back every step when the body throws", () => {
+  const { store, service } = setup();
+  let threw = false;
+  try {
+    service.transaction(() => {
+      service.saveWithDedupe({ type: "project", title: "原子A", content: "x" });
+      service.saveWithDedupe({ type: "project", title: "原子B", content: "y" });
+      throw new Error("boom");
+    });
+  } catch { threw = true; }
+  assert.equal(threw, true, "error propagates");
+  assert.equal(store.count(), 0, "no partial writes after rollback");
+  assert.ok(!store.all().some((m) => m.title === "原子A"), "step A rolled back");
+  assert.ok(!store.all().some((m) => m.title === "原子B"), "step B rolled back");
+  store.close();
+});
+
+test("service.transaction commits all steps atomically on success", () => {
+  const { store, service } = setup();
+  service.transaction(() => {
+    service.saveWithDedupe({ type: "project", title: "甲", content: "x" });
+    service.saveWithDedupe({ type: "project", title: "乙", content: "y" });
+  });
+  assert.equal(store.count(), 2, "both steps committed");
+  store.close();
+});
+
+test("service.compareAndUpdate rejects a stale version token (no lost update)", () => {
+  const { store, service } = setup();
+  const { memory: m } = service.saveWithDedupe({ type: "history", title: "计数器", content: "count=0" });
+  const baseline = service.getById(m.id);
+  const first = service.compareAndUpdate(m.id, baseline.updated_at, { content: "count=1" });
+  assert.ok(first, "current version CAS succeeds");
+  const stale = service.compareAndUpdate(m.id, baseline.updated_at, { content: "count=2" });
+  assert.equal(stale, undefined, "stale version CAS misses without writing");
+  assert.equal(service.getById(m.id).content, "count=1", "increment not lost");
+  store.close();
+});

package/test/settings.test.js

@@ -0,0 +1,101 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { createStore } from "../src/store.js";
+import { createSettings } from "../src/settings.js";
+
+function setup() {
+  const store = createStore(":memory:");
+  const settings = createSettings(store.db);
+  return { store, settings };
+}
+
+test("profile defaults to empty and round-trips", () => {
+  const { store, settings } = setup();
+  assert.equal(settings.getProfile(), "");
+  settings.setProfile("我是后端工程师，偏好简洁代码");
+  assert.equal(settings.getProfile(), "我是后端工程师，偏好简洁代码");
+  settings.setProfile("");
+  assert.equal(settings.getProfile(), "");
+  store.close();
+});
+
+test("rules default to empty list and round-trip", () => {
+  const { store, settings } = setup();
+  assert.deepEqual(settings.getRules(), []);
+  settings.setRules(["规则一", "规则二"]);
+  assert.deepEqual(settings.getRules(), ["规则一", "规则二"]);
+  settings.setRules([]);
+  assert.deepEqual(settings.getRules(), []);
+  store.close();
+});
+
+test("rules filters non-string entries", () => {
+  const { store, settings } = setup();
+  settings.setRules(["ok", 42, null, "also-ok"]);
+  assert.deepEqual(settings.getRules(), ["ok", "also-ok"]);
+  store.close();
+});
+
+test("addCommand stores and lists sorted by name", () => {
+  const { store, settings } = setup();
+  settings.addCommand({ name: "banner", description: "b", instruction: "打印横幅" });
+  settings.addCommand({ name: "agenda", instruction: "列出今日议程" });
+  const list = settings.listCommands();
+  assert.equal(list.length, 2);
+  assert.deepEqual(list.map((c) => c.name), ["agenda", "banner"]);
+  assert.ok(list[1].id, "has id");
+  store.close();
+});
+
+test("addCommand replaces existing name", () => {
+  const { store, settings } = setup();
+  settings.addCommand({ name: "fmt", instruction: "旧指令" });
+  const updated = settings.addCommand({ name: "fmt", instruction: "新指令" });
+  assert.equal(updated.instruction, "新指令");
+  assert.equal(settings.listCommands().length, 1);
+  store.close();
+});
+
+test("addCommand rejects invalid names and empty instructions", () => {
+  const { store, settings } = setup();
+  assert.throws(() => settings.addCommand({ name: "Bad Name", instruction: "x" }), /command name/);
+  assert.throws(() => settings.addCommand({ name: "123abc", instruction: "x" }), /command name/);
+  assert.throws(() => settings.addCommand({ name: "ok", instruction: "   " }), /instruction/);
+  assert.equal(settings.listCommands().length, 0);
+  store.close();
+});
+
+test("removeCommand removes by id and returns false for missing", () => {
+  const { store, settings } = setup();
+  const { id } = settings.addCommand({ name: "tmp", instruction: "x" });
+  assert.equal(settings.removeCommand(id), true);
+  assert.equal(settings.removeCommand(id), false);
+  assert.equal(settings.listCommands().length, 0);
+  store.close();
+});
+
+test("vector config defaults to undefined and round-trips", () => {
+  const { store, settings } = setup();
+  assert.equal(settings.getVectorConfig(), undefined);
+  const saved = settings.setVectorConfig({
+    enabled: true,
+    baseUrl: " https://api.openai.com/v1/ ",
+    apiKey: " sk-123 ",
+    model: "text-embedding-3-small"
+  });
+  assert.equal(saved.enabled, true);
+  assert.equal(saved.baseUrl, "https://api.openai.com/v1", "trims baseUrl");
+  assert.equal(saved.apiKey, "sk-123", "trims apiKey");
+  assert.equal(saved.model, "text-embedding-3-small");
+  const read = settings.getVectorConfig();
+  assert.equal(read.enabled, true);
+  assert.equal(read.model, "text-embedding-3-small");
+  store.close();
+});
+
+test("vector config disabled value is stored as false", () => {
+  const { store, settings } = setup();
+  settings.setVectorConfig({ enabled: false, baseUrl: "x", apiKey: "k", model: "m" });
+  assert.equal(settings.getVectorConfig().enabled, false);
+  store.close();
+});