Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

fix(memory): 保持伙伴记忆独立于全局开关和清空 (#4566)

Chris Zhangeff1f9063320
diff --git a/packages/lizi-mcps/src/__tests__/botMemoryChain.test.ts b/packages/lizi-mcps/src/__tests__/botMemoryChain.test.ts
index 7636ee5ae1..92dbd0154c 100644
--- a/packages/lizi-mcps/src/__tests__/botMemoryChain.test.ts
+++ b/packages/lizi-mcps/src/__tests__/botMemoryChain.test.ts
@@ -38,11 +38,13 @@ import {
buildBotMemoryScopeKey,
buildMemoryScopeKey,
memoryScopeDirName,
+ parseBotMemoryScopeKey,
type Logger,
type MemoryRecord,
} from '@cindy/maker-core';
import { createCindyMemoryMcpServer } from '../cindy_memoryMcpServer.js';
+import { createLiziMcpProviders } from '../providers.js';
import type { LiziMcpSessionContext } from '../types.js';
const noopLogger: Logger = {
@@ -73,13 +75,20 @@ let databases: DatabaseCtor.Database[];
let ownerAvailable = true;
let memoryEnabled = true;
-function createManager(): MakerMemoryManager {
+function createManager(independentBots = false): MakerMemoryManager {
return new MakerMemoryManager({
basePath: root,
resolveBasePath: () => (ownerAvailable ? root : null),
ownerScopeKey: () => (ownerAvailable ? 'local:owner-a:1' : 'local:none:1'),
reloadEnabled: () => memoryEnabled,
initialEnabled: memoryEnabled,
+ ...(independentBots ? {
+ isIndependentScope: (scopeKey: string) => parseBotMemoryScopeKey(scopeKey) !== null,
+ resolveStorageDir: (scopeKey: string) => {
+ const botId = parseBotMemoryScopeKey(scopeKey);
+ return botId ? path.join(root, 'bots', botId, 'memories') : null;
+ },
+ } : {}),
sqliteFactory: (filePath) => {
const database = new DatabaseCtor(filePath);
databases.push(database);
@@ -110,18 +119,38 @@ afterEach(async () => {
* 会话」。ctx 形状与修复后的三个 harness 注入一致:workingDir 仍是项目目录,
* memoryScopeKey 才是伙伴记忆的定位键。
*/
-async function connectBotSession(ctx: Partial<LiziMcpSessionContext> & { agentKind: LiziMcpSessionContext['agentKind'] }) {
+async function connectBotSession(
+ ctx: Partial<LiziMcpSessionContext> & { agentKind: LiziMcpSessionContext['agentKind'] },
+ throughProvider = false,
+) {
const sessionContext: LiziMcpSessionContext = {
workingDir: PROJECT_DIR,
vendorOptions: {},
...ctx,
} as LiziMcpSessionContext;
- const server = createCindyMemoryMcpServer({
+ const deps = {
getManager: () => manager,
workdir: sessionContext.workingDir,
getSessionContext: () => sessionContext,
logger: noopLogger,
- });
+ };
+ let server: ReturnType<typeof createCindyMemoryMcpServer>;
+ if (throughProvider) {
+ const provider = createLiziMcpProviders({ memory: deps })
+ .find((item) => item.name === 'cindy_memory')!;
+ expect(provider.isEnabled?.(sessionContext)).toBe(true);
+ expect(provider.isEnabled?.({ ...sessionContext, memoryScopeKey: undefined })).toBe(false);
+ // Claude binds a concrete Session at registration; shared Codex/Pi
+ // bridges start without one and resolve it at tool-call time.
+ const registrationContext: LiziMcpSessionContext = ctx.agentKind === 'claude-code'
+ ? sessionContext
+ : { agentKind: ctx.agentKind, workingDir: '', getSessionContext: () => sessionContext };
+ expect(provider.isEnabled?.(registrationContext)).toBe(true);
+ const config = provider.toClaudeSdkConfig(registrationContext) as { instance: typeof server };
+ server = config.instance;
+ } else {
+ server = createCindyMemoryMcpServer(deps);
+ }
const [clientTx, serverTx] = InMemoryTransport.createLinkedPair();
const client = new Client({ name: 'bot-memory-chain', version: '0.0.0' });
await Promise.all([server.connect(serverTx), client.connect(clientTx)]);
@@ -182,6 +211,43 @@ function partition(records: readonly MemoryRecord[]): {
}
describe('Cindy Bot 记忆全链(形成 → 存 → 取 → 用 → 删)', () => {
+ it.each(['claude-code', 'codex', 'pi'] as const)('keeps %s Bot registration and MCP reads/writes available with global memory off', async (agentKind) => {
+ manager.dispose();
+ memoryEnabled = false;
+ manager = createManager(true);
+ const botScope = buildBotMemoryScopeKey(BOT_ID);
+ const bot = await connectBotSession({ agentKind, memoryScopeKey: botScope }, true);
+ const project = await connectBotSession({ agentKind: 'codex' });
+ const record = {
+ type: 'user', name: 'independent', title: 'Independent',
+ description: 'Bot-owned preference', body: 'Keep answers concise.',
+ };
+ try {
+ expect(await modelWritesMemory(bot.client, record)).toMatchObject({ ok: true });
+ const read = await bot.client.callTool({
+ name: 'call_tool',
+ arguments: { name: 'memory_read', args: { filename: 'user_independent.md' } },
+ });
+ expect(parseEnvelope(read)).toMatchObject({ ok: true, data: { body: record.body } });
+ expect(await readMemoryIndex(botScope)).toContain('user_independent.md');
+ expect(existsSync(path.join(root, 'bots', BOT_ID, 'memories', 'user_independent.md'))).toBe(true);
+ expect(await modelWritesMemory(project.client, record)).toMatchObject({
+ ok: false, code: 'MAKER_MEMORY_NOT_READY',
+ });
+ expect(existsSync(path.join(root, 'maker-memory'))).toBe(false);
+
+ // Independent from the global toggle does not mean independent from
+ // the account boundary: the same bound Bot must still fail closed.
+ ownerAvailable = false;
+ expect(await modelWritesMemory(bot.client, { ...record, name: 'signed-out' })).toMatchObject({
+ ok: false, code: 'MAKER_MEMORY_NOT_READY',
+ });
+ } finally {
+ await bot.cleanup();
+ await project.cleanup();
+ }
+ });
+
it('形成/存:模型的一次 memory_write 落进伙伴自己的记忆空间,不进项目记忆', async () => {
const session = await connectBotSession({
agentKind: 'claude-code',
diff --git a/packages/lizi-mcps/src/memory/_shared.ts b/packages/lizi-mcps/src/memory/_shared.ts
index 73c18e4ce5..062190ff19 100644
--- a/packages/lizi-mcps/src/memory/_shared.ts
+++ b/packages/lizi-mcps/src/memory/_shared.ts
@@ -51,7 +51,10 @@ export async function withStore(
let scopeAtEntry: string | null = null;
try {
manager = deps.getManager();
- if (!manager.isEnabled()) {
+ const ctx = deps.getSessionContext?.();
+ // Bot scope comes from the host-bound session, never tool arguments. Use
+ // the manager's independent-scope policy, just like its getStore path.
+ if (!manager.isEnabled(ctx?.memoryScopeKey)) {
return buildJsonResult(
{ ok: false, code: 'MAKER_MEMORY_NOT_READY', message: 'maker memory disabled (mode != "maker")' },
true,
@@ -61,7 +64,6 @@ export async function withStore(
// 守卫之外被调用方 await — 在拿 store 前捕获 scope, fn 完成后复核, 期间
// 登出/切账号则操作结果不可信, fail-closed。
scopeAtEntry = manager.currentOwnerScopeKey?.() ?? null;
- const ctx = deps.getSessionContext?.();
const workdir = ctx?.workingDir ?? deps.workdir;
// SSH remote 会话 (ctx 带 remoteHostId) 的 workdir 是远端路径 — 经 scope
// key 定位, 与 agent 启动注入 (claude-code/codex index.ts) 同一键规则;
diff --git a/packages/maker-core/src/memory/manager.scope.test.ts b/packages/maker-core/src/memory/manager.scope.test.ts
index 2cfd56e627..7114f4f8f0 100644
--- a/packages/maker-core/src/memory/manager.scope.test.ts
+++ b/packages/maker-core/src/memory/manager.scope.test.ts
@@ -66,6 +66,108 @@ function trackingSqlite() {
}
describe('MakerMemoryManager · owner scope guard (#2341)', () => {
+ it.each(['resetAll', 'resetDigests'] as const)(
+ '%s preserves unopened legacy Bot memory until lazy Home migration',
+ async (resetMethod) => {
+ const botScope = buildBotMemoryScopeKey('bot-not-opened');
+ // A normal project's sanitized path matches the legacy Bot name shape.
+ const projectScope = path.join(path.sep, 'bot', 'proj', '0123456789abcdef');
+ const deps = {
+ basePath: rootA,
+ resolveBasePath: () => rootA,
+ ownerScopeKey: () => 'cloud:abc:1',
+ sqliteFactory: trackingSqlite().factory,
+ agents: {},
+ logger: noopLogger,
+ initialEnabled: true,
+ };
+ const legacyManager = new MakerMemoryManager(deps);
+ try {
+ for (const scope of [botScope, projectScope]) {
+ await legacyManager.write(scope, {
+ type: 'user', name: 'keep', title: 'Preference',
+ description: 'Durable preference', body: 'Keep this preference.',
+ });
+ await legacyManager.write(scope, {
+ type: 'digest', name: 'summary', title: 'Summary',
+ description: 'Compaction summary', body: 'Keep this Bot summary.',
+ });
+ }
+ } finally {
+ legacyManager.dispose();
+ }
+ const legacyDir = path.join(rootA, 'maker-memory', memoryScopeDirName(botScope));
+ const homeMemory = path.join(rootA, 'bots', 'bot-not-opened', 'memories');
+ const manager = new MakerMemoryManager({
+ ...deps,
+ isIndependentScope: (scope) => scope === botScope,
+ resolveStorageDir: (scope) => scope === botScope ? homeMemory : null,
+ });
+ try {
+ expect(existsSync(homeMemory)).toBe(false);
+ expect(await manager[resetMethod]()).toEqual({ removedCount: 1 });
+ expect(existsSync(path.join(legacyDir, 'user_keep.md'))).toBe(true);
+ expect(existsSync(path.join(legacyDir, 'digest_summary.md'))).toBe(true);
+ const projectDir = path.join(rootA, 'maker-memory', memoryScopeDirName(projectScope));
+ expect(existsSync(path.join(projectDir, 'digest_summary.md'))).toBe(false);
+ expect(existsSync(path.join(projectDir, 'user_keep.md'))).toBe(resetMethod === 'resetDigests');
+
+ const migrated = await manager.getStore(botScope);
+ expect((await migrated.list()).map((record) => record.filename)).toEqual([
+ 'digest_summary.md', 'user_keep.md',
+ ]);
+ expect((await migrated.read('user_keep.md')).body.trim()).toBe('Keep this preference.');
+ expect(await migrated.getIndex()).toContain('user_keep.md');
+ expect(existsSync(path.join(homeMemory, 'user_keep.md'))).toBe(true);
+ } finally {
+ manager.dispose();
+ }
+ },
+ );
+
+ it.each(['resetAll', 'resetDigests'] as const)(
+ '%s refuses ambiguous directory ownership without reporting a successful clear',
+ async (resetMethod) => {
+ const scope = path.join(path.sep, 'bot-project-0123456789abcdef');
+ const deps = {
+ basePath: rootA, sqliteFactory: trackingSqlite().factory,
+ ownerScopeKey: () => 'cloud:abc:1',
+ agents: {}, logger: noopLogger, initialEnabled: true,
+ };
+ const writer = new MakerMemoryManager(deps);
+ try {
+ await writer.write(scope, {
+ type: 'digest', name: 'summary', title: 'Summary',
+ description: 'Project summary', body: 'Project data.',
+ });
+ } finally {
+ writer.dispose();
+ }
+ const dir = path.join(rootA, 'maker-memory', memoryScopeDirName(scope));
+ const metaPath = path.join(dir, 'meta.json');
+ const originalMeta = await readFile(metaPath, 'utf8');
+ const manager = new MakerMemoryManager(deps);
+ try {
+ // Reuse the directory under test: an extra project could be removed
+ // before or after the ambiguous entry depending on filesystem order.
+ const previouslyOpen = resetMethod === 'resetAll' ? await manager.getStore(scope) : null;
+ for (const metadata of [null, '{broken', JSON.stringify({ absPath: buildBotMemoryScopeKey('wrong-bot') })]) {
+ if (metadata === null) await rm(metaPath);
+ else await writeFile(metaPath, metadata, 'utf8');
+ await expect(manager[resetMethod]()).rejects.toThrow(/cannot determine memory scope/);
+ expect(existsSync(path.join(dir, 'digest_summary.md'))).toBe(true);
+ if (previouslyOpen) await expect(previouslyOpen.list()).rejects.toThrow(/memory was reset/);
+ }
+ // Recovering authoritative metadata restores the normal clear path.
+ await writeFile(metaPath, originalMeta, 'utf8');
+ expect(await manager[resetMethod]()).toEqual({ removedCount: 1 });
+ expect(existsSync(path.join(dir, 'digest_summary.md'))).toBe(false);
+ } finally {
+ manager.dispose();
+ }
+ },
+ );
+
it('keeps an independent Bot store available in Bot Home and copies legacy data', async () => {
const botScope = buildBotMemoryScopeKey('bot-a');
const legacyManager = new MakerMemoryManager({
diff --git a/packages/maker-core/src/memory/manager.ts b/packages/maker-core/src/memory/manager.ts
index 6a23b9ddea..1b324abc25 100644
--- a/packages/maker-core/src/memory/manager.ts
+++ b/packages/maker-core/src/memory/manager.ts
@@ -27,6 +27,7 @@ import * as fsSync from 'node:fs';
import type Database from 'better-sqlite3';
import { MakerMemoryStore, memoryScopeDirName, parseFilename } from './store.js';
+import { parseBotMemoryScopeKey } from './storage.js';
import {
MemoryError,
type MemoryConfig,
@@ -127,6 +128,26 @@ interface PooledEntry {
const MEMORY_SUBDIR = 'maker-memory';
const FTS_DB_FILENAME = 'fts.db';
const STORAGE_MIGRATION_RECEIPT = '.cindy-memory-migration-v1.json';
+// This shape is only a candidate: sanitized project paths can match it too.
+const LEGACY_BOT_MEMORY_DIR = /^bot-.{0,24}-[a-f0-9]{16}$/;
+
+async function isLegacyBotMemoryDir(dir: string): Promise<boolean> {
+ const name = path.basename(dir);
+ if (!LEGACY_BOT_MEMORY_DIR.test(name)) return false;
+ try {
+ const meta: unknown = JSON.parse(await fsSync.promises.readFile(path.join(dir, 'meta.json'), 'utf8'));
+ const scope = meta && typeof meta === 'object' && 'absPath' in meta ? meta.absPath : undefined;
+ // Validate both identity and its mapping to this directory. A matching
+ // project scope must be cleared even if its directory looks like a Bot's.
+ if (typeof scope === 'string' && scope && memoryScopeDirName(scope) === name) {
+ return parseBotMemoryScopeKey(scope) !== null;
+ }
+ } catch {
+ // Missing/damaged metadata cannot prove either ownership. Preserve the
+ // ambiguous data, but never report a successful global clear.
+ }
+ throw new MemoryError('not-ready', `cannot determine memory scope for ${name}; reset incomplete, data preserved`);
+}
function copyLegacyMemoryShardsSync(sourceDir: string, targetDir: string): void {
fsSync.mkdirSync(targetDir, { recursive: true });
@@ -384,14 +405,15 @@ export class MakerMemoryManager {
};
}
- isEnabled(): boolean {
+ /** No scope queries the global switch; host-owned independent scopes opt out. */
+ isEnabled(scopeKey?: string): boolean {
// 读取前同步 scope (review #2388 Codex 11th P1): rebindEnabled 只在
// ensureOwnerScope/syncOwnerScope 里跑, 先读 isEnabled() 的路径 (withStore
// 短路、session/remote option backfills) 会停留在旧 owner 的 flag —
// owner A false→B true 时不得继续短路, B false→A true 时不得漏暴露。
// 纯查询语义, 不抛 (owner 缺失由 getStore fail-closed)。
this.syncOwnerScope();
- return this.enabled;
+ return this.enabled || (scopeKey !== undefined && this.deps.isIndependentScope?.(scopeKey) === true);
}
/**
@@ -748,6 +770,9 @@ export class MakerMemoryManager {
} catch {
continue;
}
+ const botOwned = await isLegacyBotMemoryDir(dir);
+ this.assertScopeUnchanged(scopeAtEntry);
+ if (botOwned) continue;
for (const filename of filenames) {
if (parseFilename(filename)?.type !== 'digest') continue;
try {
@@ -806,7 +831,6 @@ export class MakerMemoryManager {
// 先复核 scope (review #2388 Greptile 23rd P1): readdir await 期间边界
// 可能发生 — 不得把跨边界的 reset 误判为成功。
this.assertScopeUnchanged(scopeAtEntry);
- this.poolGeneration += 1;
return { removedCount: 0 };
}
for (const entry of entries) {
@@ -814,7 +838,9 @@ export class MakerMemoryManager {
try {
const stat = await fs.stat(dir);
if (!stat.isDirectory()) continue;
+ const botOwned = await isLegacyBotMemoryDir(dir);
this.assertScopeUnchanged(scopeAtEntry);
+ if (botOwned) continue;
await fs.rm(dir, { recursive: true, force: true });
total += 1;
} catch (e) {
@@ -837,11 +863,11 @@ export class MakerMemoryManager {
'owner scope changed during resetAll; result is partial and must not be trusted',
);
}
- // 池世代兜底失效 (review #2388 Greptile 13th/16th): 即使有漏网旧条目,
- // getStore 命中旧世代也会 close + 重建, 不残留指向已删目录的条目。
- this.poolGeneration += 1;
return { removedCount: total };
} finally {
+ // closeResettableStores invalidates its handles even if ambiguous
+ // ownership aborts the reset. Retained callers must reopen their store.
+ this.poolGeneration += 1;
this.resetInFlight -= 1;
}
}