-
Notifications
You must be signed in to change notification settings - Fork 362
Expand file tree
/
Copy pathindex.ts
More file actions
862 lines (785 loc) · 35 KB
/
index.ts
File metadata and controls
862 lines (785 loc) · 35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
/**
* memory-tdai v3: Four-layer memory system plugin for OpenClaw.
*
* Provides:
* - L0: Automatic conversation recording (local JSONL)
* - L1: Structured memory extraction (LLM + dedup)
* - L2: Scene block management (LLM scene extraction)
* - L3: Persona generation (LLM persona synthesis)
*
* All processing is local, zero external API dependencies.
*
* v3.1: Refactored to use TdaiCore + OpenClawHostAdapter.
* index.ts is now a thin shell that:
* - Registers tools and hooks with OpenClaw
* - Translates OpenClaw events into TdaiCore calls
* - Manages prompt caching and metric reporting
*
* Core memory logic lives in src/core/tdai-core.ts (host-neutral).
*/
import path from "node:path";
import { createRequire } from "node:module";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core";
import { parseConfig } from "./src/config.js";
import type { MemoryTdaiConfig } from "./src/config.js";
import { registerOffload } from "./src/offload/index.js";
import {
setPreferredEmbeddedAgentRuntime,
prewarmEmbeddedAgent,
} from "./src/utils/clean-context-runner.js";
import { SessionFilter } from "./src/utils/session-filter.js";
import { LocalMemoryCleaner } from "./src/utils/memory-cleaner.js";
import { registerMemoryTdaiCli } from "./src/cli/index.js";
import { initDataDirectories, resetStores } from "./src/utils/pipeline-factory.js";
import { getOrCreateInstanceId, initReporter, report, resetReporter } from "./src/core/report/reporter.js";
import { ensureL2L3Local } from "./src/core/profile/profile-sync.js";
// Core abstractions (host-neutral)
import { OpenClawHostAdapter } from "./src/adapters/openclaw/host-adapter.js";
import { TdaiCore } from "./src/core/tdai-core.js";
import {
ensurePluginHookPolicy,
decideHookPolicy,
} from "./src/utils/ensure-hook-policy.js";
import { resolveOpenClawStateDir } from "./src/utils/openclaw-state-dir.js";
const TAG = "[memory-tdai]";
/**
* Epoch ms when the plugin was registered (cold-start timestamp).
* Used as a fallback cursor in performAutoCapture when no checkpoint
* exists yet — prevents the first agent_end from dumping the entire
* session history into L0.
*/
let pluginStartTimestamp = 0;
/**
* Cache original user prompts and message counts across hooks.
* - text: clean user prompt before prependContext injection
* - ts: cache creation time (for TTL sweep)
* - messageCount: session message count at before_prompt_build time,
* used as fallback slice offset if timestamp cursor is unreliable
*/
const pendingOriginalPrompts = new Map<string, { text: string; ts: number; messageCount: number }>();
const PROMPT_CACHE_TTL_MS = 10 * 60 * 1000; // 10 minutes
const PROMPT_CACHE_MAX_SIZE = 10_000; // Hard limit to prevent unbounded growth in high-concurrency scenarios
/**
* Cache recall results (L1 memories + L3 Persona) from before_prompt_build
* for retrieval at agent_end, enabling the agent_turn metric event.
*
* Keyed by sessionKey — same correlation pattern as pendingOriginalPrompts.
*/
const pendingRecallCache = new Map<string, {
l1Memories: Array<{ content: string; score: number; type: string }>;
l3Persona: string | null;
strategy: string;
durationMs: number;
ts: number;
}>();
/**
* Cache recall completion timestamps per session.
* Used in agent_end to estimate LLM reasoning time:
* llmEstimatedMs ≈ agent_end_start - recall_end_ts
* Entries are cleaned up in agent_end after use; stale entries swept alongside prompt cache.
*/
const pendingRecallEndTimestamps = new Map<string, number>();
// 进程级单例,避免同一进程重复启动清理器导致并发清理竞态
let sharedMemoryCleaner: LocalMemoryCleaner | undefined;
/**
* Sweep both pendingOriginalPrompts and pendingRecallCache for stale entries.
* Unified from the original sweepStalePromptCache() to cover both Maps
* with identical TTL + hard-cap logic.
*/
function sweepStaleCaches(): void {
const now = Date.now();
// Clean pendingOriginalPrompts
for (const [key, entry] of pendingOriginalPrompts) {
if (now - entry.ts > PROMPT_CACHE_TTL_MS) {
pendingOriginalPrompts.delete(key);
pendingRecallEndTimestamps.delete(key);
}
}
// Clean pendingRecallCache
for (const [key, entry] of pendingRecallCache) {
if (now - entry.ts > PROMPT_CACHE_TTL_MS) {
pendingRecallCache.delete(key);
}
}
// Hard limit: evict oldest entries if either Map exceeds cap
if (pendingOriginalPrompts.size > PROMPT_CACHE_MAX_SIZE) {
const entries = [...pendingOriginalPrompts.entries()].sort((a, b) => a[1].ts - b[1].ts);
const toEvict = entries.slice(0, entries.length - PROMPT_CACHE_MAX_SIZE);
for (const [key] of toEvict) {
pendingOriginalPrompts.delete(key);
pendingRecallEndTimestamps.delete(key);
}
}
if (pendingRecallCache.size > PROMPT_CACHE_MAX_SIZE) {
const entries = [...pendingRecallCache.entries()].sort((a, b) => a[1].ts - b[1].ts);
const toEvict = entries.slice(0, entries.length - PROMPT_CACHE_MAX_SIZE);
for (const [key] of toEvict) {
pendingRecallCache.delete(key);
}
}
}
export default function register(api: OpenClawPluginApi) {
// ─── CLI metadata mode: register CLI commands only, skip all runtime init ───
// In this mode, runtime is `{} as PluginRuntime` (empty object).
// OpenClaw calls this to discover CLI subcommands without starting the full plugin.
if (api.registrationMode === "cli-metadata") {
api.registerCli(
({ program, config, logger: cliLogger }) => {
const memoryTdai = program
.command("memory-tdai")
.description("memory-tdai plugin commands (seed, query, stats)");
registerMemoryTdaiCli(memoryTdai, {
config,
pluginConfig: api.pluginConfig,
stateDir: resolveOpenClawStateDir((api.runtime as any)?.state),
logger: cliLogger,
});
},
{ commands: ["memory-tdai"] },
);
return;
}
// ─── Full / discovery mode: complete runtime initialization ───
pluginStartTimestamp = Date.now();
setPreferredEmbeddedAgentRuntime(api.runtime.agent);
// Reset reporter singleton so config changes take effect on hot-reload.
resetReporter();
const _require = createRequire(import.meta.url);
const pluginVersion = (() => { try { return (_require("./package.json") as { version?: string }).version ?? "unknown"; } catch { return "unknown"; } })();
api.logger.debug?.(
`${TAG} Registering plugin ... ` +
`startTimestamp=${pluginStartTimestamp} (${new Date(pluginStartTimestamp).toISOString()})`,
);
let cfg: MemoryTdaiConfig;
try {
// OpenClaw calls register() N times (plugin scan → gateway start →
// per-channel bootstrap → config reload). Each call receives the full
// pluginConfig from openclaw.json, so we parse it directly every time.
const rawPluginConfig = api.pluginConfig as Record<string, unknown> | undefined;
const rawKeys = rawPluginConfig ? Object.keys(rawPluginConfig) : [];
api.logger.debug?.(
`${TAG} pluginConfig received (${rawKeys.length} keys)`,
);
cfg = parseConfig(rawPluginConfig);
api.logger.debug?.(
`${TAG} Config parsed: ` +
`capture=${cfg.capture.enabled}, ` +
`recall=${cfg.recall.enabled}(maxResults=${cfg.recall.maxResults}), ` +
`extraction=${cfg.extraction.enabled}(dedup=${cfg.extraction.enableDedup}, maxMem=${cfg.extraction.maxMemoriesPerSession}), ` +
`pipeline=(everyN=${cfg.pipeline.everyNConversations}, warmup=${cfg.pipeline.enableWarmup}, l1Idle=${cfg.pipeline.l1IdleTimeoutSeconds}s, l2DelayAfterL1=${cfg.pipeline.l2DelayAfterL1Seconds}s, l2Min=${cfg.pipeline.l2MinIntervalSeconds}s, l2Max=${cfg.pipeline.l2MaxIntervalSeconds}s, activeWindow=${cfg.pipeline.sessionActiveWindowHours}h), ` +
`persona(triggerEvery=${cfg.persona.triggerEveryN}, backupCount=${cfg.persona.backupCount}, sceneBackupCount=${cfg.persona.sceneBackupCount}), ` +
`memoryCleanup(enabled=${cfg.memoryCleanup.enabled}, retentionDays=${cfg.memoryCleanup.retentionDays ?? "(disabled)"}, cleanTime=${cfg.memoryCleanup.cleanTime}), ` +
`offload(enabled=${cfg.offload.enabled}, backendUrl=${cfg.offload.backendUrl ?? "(none)"}, mildRatio=${cfg.offload.mildOffloadRatio}, aggressiveRatio=${cfg.offload.aggressiveCompressRatio}, retentionDays=${cfg.offload.offloadRetentionDays})`,
);
} catch (err) {
api.logger.error(`${TAG} Config parsing failed: ${err instanceof Error ? err.message : String(err)}`);
throw err;
}
// ============================
// Hook policy auto-patch (v2026.4.24+ compat)
// ============================
// `allowConversationAccess` hook policy was introduced in v2026.4.23;
// the zod schema fix landed in v2026.4.24. Older hosts don't understand
// the field and don't need it patched in.
//
// Note: `api.runtime.version` is only exposed on v2026.4.15+. On older
// hosts it is `undefined`; we MUST treat that as "does not need the
// patch" (old hosts have no gate), otherwise we would silently mutate
// the user's openclaw.json on every gateway start.
{
// Gate: only apply the auto-patch when host version >= 2026.4.24.
// decideHookPolicy() parses the leading x.y.z prefix numerically
// (ignoring `-beta.N`, `-N`, etc.) and returns apply=false for any
// version we cannot parse — which is the safe default on old hosts
// that don't expose `api.runtime.version`. See ensure-hook-policy.ts
// for the full policy + co-located unit tests.
const rawVersion = (api.runtime as any)?.version;
const decision = decideHookPolicy(rawVersion);
const parsedStr = decision.parsedXYZ ? decision.parsedXYZ.join(".") : "<unparsable>";
const minStr = decision.minXYZ.join(".");
if (!decision.apply) {
api.logger.debug?.(
`${TAG} Hook policy auto-patch skipped: ` +
`original=${JSON.stringify(rawVersion)}, parsed=${parsedStr}, min=${minStr}`,
);
} else {
api.logger.debug?.(
`${TAG} Hook policy auto-patch applying: ` +
`original=${JSON.stringify(rawVersion)}, parsed=${parsedStr} >= min=${minStr}`,
);
try {
ensurePluginHookPolicy({
rootConfig: api.config,
runtimeConfig: api.runtime?.config,
logger: api.logger,
});
} catch (err) {
api.logger.warn(`${TAG} Hook policy check failed (non-fatal): ${err instanceof Error ? err.message : String(err)}`);
}
}
}
// If remote embedding config is incomplete, log a prominent error so the user knows
if (cfg.embedding.configError) {
api.logger.error(`${TAG} [EMBEDDING CONFIG ERROR] ${cfg.embedding.configError}`);
}
// Resolve plugin data directory via runtime API (avoid importing internal paths directly)
const openclawStateDir = resolveOpenClawStateDir((api.runtime as any)?.state);
const pluginDataDir = path.join(openclawStateDir, "memory-tdai");
initDataDirectories(pluginDataDir);
api.logger.debug?.(`${TAG} Data dir: ${pluginDataDir} (all subdirectories initialized)`);
// ============================
// Create OpenClawHostAdapter + TdaiCore
// ============================
const hostAdapter = new OpenClawHostAdapter({
api,
pluginDataDir,
openclawConfig: api.config,
});
const sessionFilter = new SessionFilter(cfg.capture.excludeAgents);
if (cfg.capture.excludeAgents.length > 0) {
api.logger.debug?.(`${TAG} Agent exclude patterns: ${cfg.capture.excludeAgents.join(", ")}`);
}
const core = new TdaiCore({
hostAdapter,
config: cfg,
sessionFilter,
});
// Initialize TdaiCore (async — store init, pipeline wiring)
const coreReady = core.initialize().then(() => {
// Keep cleaner's SQLite handle updated after store init
memoryCleaner?.setVectorStore(core.getVectorStore());
// Pull L2/L3 profiles if remote store supports it
const vs = core.getVectorStore();
if (vs?.pullProfiles) {
ensureL2L3Local(pluginDataDir, vs, api.logger).catch((err) => {
api.logger.warn(`${TAG} Startup L2/L3 pull failed (non-fatal): ${err instanceof Error ? err.message : String(err)}`);
});
}
}).catch((err) => {
api.logger.error(`${TAG} Core init failed: ${err instanceof Error ? err.message : String(err)}`);
});
// Kick off instanceId resolution immediately after data dir is ready.
let instanceId: string | undefined;
getOrCreateInstanceId(pluginDataDir).then((id) => {
instanceId = id;
core.setInstanceId(id);
initReporter({ enabled: cfg.report.enabled, type: cfg.report.type, logger: api.logger, instanceId: id, pluginVersion });
}).catch((err) => {
api.logger.warn(`${TAG} Failed to initialize instanceId for metrics: ${err instanceof Error ? err.message : String(err)}`);
});
// Daily local JSONL cleaner (L0/L1), enabled only when retentionDays is configured.
let memoryCleaner: LocalMemoryCleaner | undefined;
if (cfg.memoryCleanup.enabled && cfg.memoryCleanup.retentionDays != null) {
if (!sharedMemoryCleaner) {
sharedMemoryCleaner = new LocalMemoryCleaner({
baseDir: pluginDataDir,
retentionDays: cfg.memoryCleanup.retentionDays,
cleanTime: cfg.memoryCleanup.cleanTime,
logger: api.logger,
});
sharedMemoryCleaner.start();
api.logger.debug?.(`${TAG} Memory cleaner started (singleton)`);
} else {
api.logger.debug?.(`${TAG} Memory cleaner already started in this process, reusing existing instance`);
}
memoryCleaner = sharedMemoryCleaner;
} else {
api.logger.debug?.(`${TAG} Memory cleaner disabled (retentionDays not configured)`);
}
const resolveSessionKey = (sessionKey?: string): string | undefined => {
if (sessionKey) return sessionKey;
api.logger.warn(`${TAG} sessionKey is empty, skipping capture/recall to avoid unstable fallback key`);
return undefined;
};
/**
* Whether embedding warmup has been triggered.
* Deferred until first real conversation to avoid model downloads during CLI commands.
*/
let embeddingWarmupTriggered = false;
const ensureEmbeddingWarmup = (): void => {
const svc = core.getEmbeddingService();
if (!svc) return;
if (!embeddingWarmupTriggered) {
embeddingWarmupTriggered = true;
api.logger.debug?.(`${TAG} Triggering lazy embedding warmup on first conversation`);
svc.startWarmup();
return;
}
if (!svc.isReady()) {
api.logger.debug?.(`${TAG} Embedding not ready, re-triggering warmup (retry)`);
svc.startWarmup();
}
};
// ============================
// Tool registration — delegate to TdaiCore
// ============================
// tdai_memory_search — Agent-callable L1 memory search tool
// TODO: implement hard per-turn call limit via before_tool_call hook + execute early-return (方案 D)
if (cfg.recall.enabled || cfg.capture.enabled) {
api.registerTool(
{
name: "tdai_memory_search",
label: "Memory Search",
description:
"Search through the user's long-term memories. Use this when you need to recall specific information about the user's preferences, past events, instructions, or context from previous conversations. Returns relevant memory records ranked by relevance. " +
"Limit: tdai_memory_search and tdai_conversation_search share a combined limit of 3 calls per turn. Stop searching after 3 total attempts.",
parameters: {
type: "object",
properties: {
query: {
type: "string",
description: "Search query describing what you want to recall about the user",
},
limit: {
type: "number",
description: "Maximum number of results to return (default: 5, max: 20)",
},
type: {
type: "string",
enum: ["persona", "episodic", "instruction"],
description: "Optional filter by memory type: persona (identity/preferences), episodic (events/activities), instruction (user rules/commands)",
},
scene: {
type: "string",
description: "Optional filter by scene name",
},
},
required: ["query"],
},
async execute(_toolCallId: string, params: Record<string, unknown>) {
const startMs = Date.now();
const query = String(params.query ?? "");
const limit = Math.min(Math.max(Number(params.limit) || 5, 1), 20);
const typeFilter = typeof params.type === "string" ? params.type : undefined;
const sceneFilter = typeof params.scene === "string" ? params.scene : undefined;
api.logger.debug?.(
`${TAG} [tool] tdai_memory_search called: ` +
`query="${query.length > 80 ? query.slice(0, 80) + "…" : query}", ` +
`limit=${limit}, type=${typeFilter ?? "(all)"}, scene=${sceneFilter ?? "(all)"}`,
);
try {
const result = await core.searchMemories({ query, limit, type: typeFilter, scene: sceneFilter });
const elapsedMs = Date.now() - startMs;
api.logger.debug?.(
`${TAG} [tool] tdai_memory_search completed (${elapsedMs}ms): ` +
`total=${result.total}, strategy=${result.strategy}, ` +
`responseLength=${result.text.length} chars`,
);
report("tool_call", {
tool: "tdai_memory_search",
query, limit, typeFilter, sceneFilter,
resultCount: result.total,
strategy: result.strategy,
durationMs: elapsedMs,
success: true,
});
return {
content: [{ type: "text" as const, text: result.text }],
details: { count: result.total, strategy: result.strategy },
};
} catch (err) {
const elapsedMs = Date.now() - startMs;
const errMsg = err instanceof Error ? err.message : String(err);
api.logger.error(`${TAG} [tool] tdai_memory_search failed (${elapsedMs}ms): ${errMsg}`);
report("tool_call", {
tool: "tdai_memory_search",
query, limit, typeFilter, sceneFilter,
durationMs: elapsedMs,
success: false,
error: errMsg,
});
return {
content: [{ type: "text" as const, text: `Memory search failed: ${errMsg}` }],
details: { error: errMsg },
};
}
},
},
{ name: "tdai_memory_search" },
);
// tdai_conversation_search — Agent-callable L0 conversation search tool
// TODO: implement hard per-turn call limit via before_tool_call hook + execute early-return (方案 D)
api.registerTool(
{
name: "tdai_conversation_search",
label: "Conversation Search",
description:
"Search through past conversation history (raw dialogue records). " +
"Use this when tdai_memory_search (structured memories) doesn't have the information you need, " +
"or when you want to find specific past conversations, dialogue context, or exact words " +
"the user said before. Returns relevant individual messages ranked by relevance. " +
"Limit: tdai_memory_search and tdai_conversation_search share a combined limit of 3 calls per turn. Stop searching after 3 total attempts.",
parameters: {
type: "object",
properties: {
query: {
type: "string",
description: "Search query describing what conversation content you want to find",
},
limit: {
type: "number",
description: "Maximum number of messages to return (default: 5, max: 20)",
},
session_key: {
type: "string",
description: "Optional: filter results to a specific session",
},
},
required: ["query"],
},
async execute(_toolCallId: string, params: Record<string, unknown>) {
const startMs = Date.now();
const query = String(params.query ?? "");
const limit = Math.min(Math.max(Number(params.limit) || 5, 1), 20);
const sessionKeyFilter = typeof params.session_key === "string" ? params.session_key : undefined;
api.logger.debug?.(
`${TAG} [tool] tdai_conversation_search called: ` +
`query="${query.length > 80 ? query.slice(0, 80) + "…" : query}", ` +
`limit=${limit}, session_key=${sessionKeyFilter ?? "(all)"}`,
);
try {
const result = await core.searchConversations({ query, limit, sessionKey: sessionKeyFilter });
const elapsedMs = Date.now() - startMs;
api.logger.debug?.(
`${TAG} [tool] tdai_conversation_search completed (${elapsedMs}ms): ` +
`total=${result.total}, responseLength=${result.text.length} chars`,
);
report("tool_call", {
tool: "tdai_conversation_search",
query, limit, sessionKeyFilter,
resultCount: result.total,
durationMs: elapsedMs,
success: true,
});
return {
content: [{ type: "text" as const, text: result.text }],
details: { count: result.total },
};
} catch (err) {
const elapsedMs = Date.now() - startMs;
const errMsg = err instanceof Error ? err.message : String(err);
api.logger.error(`${TAG} [tool] tdai_conversation_search failed (${elapsedMs}ms): ${errMsg}`);
report("tool_call", {
tool: "tdai_conversation_search",
query, limit, sessionKeyFilter,
durationMs: elapsedMs,
success: false,
error: errMsg,
});
return {
content: [{ type: "text" as const, text: `Conversation search failed: ${errMsg}` }],
details: { error: errMsg },
};
}
},
},
{ name: "tdai_conversation_search" },
);
} else {
api.logger.debug?.(`${TAG} Memory tools (tdai_memory_search, tdai_conversation_search) not registered — memory features disabled`);
}
// ============================
// Lifecycle hooks — delegate to TdaiCore
// ============================
// Before prompt build: auto-recall relevant memories
if (cfg.recall.enabled) {
api.logger.debug?.(`${TAG} Registering before_prompt_build hook (auto-recall)`);
api.on("before_prompt_build", async (event, ctx) => {
const startMs = Date.now();
api.logger.debug?.(`${TAG} [before_prompt_build] Hook triggered`);
const sessionKey = ctx.sessionKey;
if (sessionFilter.shouldSkipCtx(ctx)) {
api.logger.debug?.(`${TAG} [before_prompt_build] Skipping filtered session`);
return;
}
ensureEmbeddingWarmup();
// Cache original user prompt for agent_end
const rawPrompt = event.prompt;
const messages = Array.isArray(event.messages) ? event.messages : undefined;
if (sessionKey && rawPrompt) {
const messageCount = messages?.length ?? 0;
pendingOriginalPrompts.set(sessionKey, { text: rawPrompt, ts: Date.now(), messageCount });
api.logger.debug?.(`${TAG} [before_prompt_build] Cached original prompt (${rawPrompt.length} chars, msgCount=${messageCount})`);
}
sweepStaleCaches();
const userText = rawPrompt;
api.logger.debug?.(`${TAG} [before_prompt_build] userText length: ${userText?.length}`);
if (!userText) {
api.logger.debug?.(`${TAG} [before_prompt_build] No user text found, skipping recall`);
return;
}
const resolvedSessionKey = resolveSessionKey(sessionKey);
if (!resolvedSessionKey) {
return;
}
try {
await coreReady;
const recallStartMs = Date.now();
const result = await core.handleBeforeRecall(userText, resolvedSessionKey);
const elapsedMs = Date.now() - startMs;
const recallDurationMs = Date.now() - recallStartMs;
// Cache recall results for agent_turn metric (retrieved at agent_end)
if (sessionKey && result) {
pendingRecallCache.set(sessionKey, {
l1Memories: result.recalledL1Memories ?? [],
l3Persona: result.recalledL3Persona ?? null,
strategy: result.recallStrategy ?? "unknown",
durationMs: recallDurationMs,
ts: Date.now(),
});
}
// Record recall completion timestamp for LLM timing estimation in agent_end
if (resolvedSessionKey) {
pendingRecallEndTimestamps.set(resolvedSessionKey, Date.now());
}
if (result?.appendSystemContext || result?.prependContext) {
const appendLen = result.appendSystemContext?.length ?? 0;
const prependLen = result.prependContext?.length ?? 0;
api.logger.info(
`${TAG} [before_prompt_build] Recall complete (${elapsedMs}ms), ` +
`appendSystemContext=${appendLen} chars, prependContext=${prependLen} chars`,
);
} else {
api.logger.info(`${TAG} [before_prompt_build] Recall complete (${elapsedMs}ms), no context to inject`);
}
return result;
} catch (err) {
const elapsedMs = Date.now() - startMs;
api.logger.error(`${TAG} [before_prompt_build] Auto-recall failed after ${elapsedMs}ms: ${err instanceof Error ? err.stack ?? err.message : String(err)}`);
if (instanceId) {
report("error_degradation", {
module: "auto-recall",
action: "performAutoRecall",
errorType: "exception",
errorMessage: err instanceof Error ? err.message : String(err),
degradedTo: "no_recall",
impact: "non-blocking",
});
}
}
});
}
// Strip <relevant-memories> from user messages before they are persisted to
// the session JSONL. The current-turn LLM already saw the full prompt
// (effectivePrompt lives in memory), but we don't want recall artifacts
// polluting the historical transcript for future replays.
api.logger.debug?.(`${TAG} Registering before_message_write hook (strip <relevant-memories>)`);
api.on("before_message_write", (event) => {
const msg = event.message as { role?: string; content?: unknown };
const contentType = typeof msg.content === "string" ? "string" : Array.isArray(msg.content) ? "parts" : typeof msg.content;
api.logger.debug?.(`${TAG} [before_message_write] role=${msg.role}, contentType=${contentType}`);
if (msg.role !== "user") return;
// UserMessage.content: string | (TextContent | ImageContent)[]
const STRIP_RE = /<relevant-memories>[\s\S]*?<\/relevant-memories>\s*/g;
if (typeof msg.content === "string") {
if (!msg.content.includes("<relevant-memories>")) return;
const cleaned = msg.content.replace(STRIP_RE, "").trim();
if (cleaned === msg.content) return;
api.logger.debug?.(`${TAG} [before_message_write] Stripped: ${msg.content.length} → ${cleaned.length} chars`);
return { message: { ...event.message, content: cleaned } as typeof event.message };
}
if (Array.isArray(msg.content)) {
let totalStripped = 0;
const cleanedParts = (msg.content as Array<Record<string, unknown>>).map((part) => {
if (part.type !== "text" || typeof part.text !== "string") return part;
if (!(part.text as string).includes("<relevant-memories>")) return part;
const cleaned = (part.text as string).replace(STRIP_RE, "").trim();
totalStripped += (part.text as string).length - cleaned.length;
return { ...part, text: cleaned };
});
if (totalStripped === 0) return;
api.logger.debug?.(`${TAG} [before_message_write] Stripped from parts: removed ${totalStripped} chars`);
return { message: { ...event.message, content: cleanedParts } as unknown as typeof event.message };
}
});
// After agent end: auto-capture + L0 record + L1/L2/L3 schedule
if (cfg.capture.enabled) {
api.logger.debug?.(`${TAG} Registering agent_end hook (auto-capture)`);
api.on("agent_end", async (event, ctx) => {
const startMs = Date.now();
api.logger.debug?.(`${TAG} [agent_end] Hook triggered`);
const e = event as Record<string, unknown>;
if (!e.success) {
api.logger.info(`${TAG} [agent_end] Agent did not succeed, skipping capture`);
return;
}
const sessionKey = ctx.sessionKey;
const sessionId = ctx.sessionId;
if (sessionFilter.shouldSkipCtx(ctx)) {
api.logger.debug?.(`${TAG} [agent_end] Skipping filtered session`);
return;
}
const messages = (e.messages as unknown[]) ?? [];
const resolvedSessionKey = resolveSessionKey(sessionKey);
if (!resolvedSessionKey) {
return;
}
// Estimate LLM reasoning time: recallEnd → agentEnd start
const recallEndTs = pendingRecallEndTimestamps.get(resolvedSessionKey);
if (recallEndTs) {
const llmEstimatedMs = startMs - recallEndTs;
api.logger.info(
`${TAG} ⏱ Turn timing: recallEnd→agentEnd=${llmEstimatedMs}ms ` +
`(≈ LLM reasoning + prompt build + tool calls)`,
);
pendingRecallEndTimestamps.delete(resolvedSessionKey);
}
// Retrieve cached original prompt
const cachedPrompt = sessionKey ? pendingOriginalPrompts.get(sessionKey) : undefined;
const originalUserText = cachedPrompt?.text;
try {
await coreReady;
// Pre-warm the embedded agent on first conversation
if (!core.isSchedulerStarted()) {
prewarmEmbeddedAgent(api.logger, api.runtime.agent);
}
const captureResult = await core.handleTurnCommitted({
userText: originalUserText ?? "",
assistantText: "",
messages,
sessionKey: resolvedSessionKey,
sessionId: sessionId || undefined,
startedAt: pluginStartTimestamp,
originalUserMessageCount: cachedPrompt?.messageCount,
});
const captureMs = Date.now() - startMs;
api.logger.info(
`${TAG} [agent_end] Auto-capture complete (${captureMs}ms), ` +
`l0Recorded=${captureResult.l0RecordedCount}, ` +
`schedulerNotified=${captureResult.schedulerNotified}`,
);
// ── agent_turn metric ──
const cachedRecall = sessionKey ? pendingRecallCache.get(sessionKey) : undefined;
if (sessionKey) pendingRecallCache.delete(sessionKey);
if (instanceId) {
report("agent_turn", {
sessionKey: resolvedSessionKey,
userPrompt: originalUserText ?? null,
recalledL1Memories: cachedRecall?.l1Memories ?? [],
recalledL1Count: cachedRecall?.l1Memories?.length ?? 0,
recalledL3Persona: cachedRecall?.l3Persona ?? null,
recallStrategy: cachedRecall?.strategy ?? null,
recallDurationMs: cachedRecall?.durationMs ?? 0,
l0CapturedMessages: captureResult.filteredMessages.map((m) => ({
role: m.role,
content: m.content,
ts: m.timestamp,
})),
l0CapturedCount: captureResult.l0RecordedCount,
l0VectorsWritten: captureResult.l0VectorsWritten,
captureDurationMs: captureMs,
totalDurationMs: Date.now() - startMs,
});
}
} catch (err) {
const elapsedMs = Date.now() - startMs;
api.logger.error(`${TAG} [agent_end] Auto-capture failed after ${elapsedMs}ms: ${err instanceof Error ? err.stack ?? err.message : String(err)}`);
if (instanceId) {
report("error_degradation", {
module: "auto-capture",
action: "performAutoCapture",
errorType: "exception",
errorMessage: err instanceof Error ? err.message : String(err),
degradedTo: "no_capture",
impact: "non-blocking",
});
}
}
});
// gateway_stop: ordered shutdown via TdaiCore.destroy()
api.on("gateway_stop", async () => {
const GATEWAY_STOP_TIMEOUT_MS = 3_000;
const hookStartMs = Date.now();
await coreReady.catch(() => {});
const doCleanup = async (): Promise<void> => {
// 1. Stop memory cleaner first
if (memoryCleaner) {
try {
memoryCleaner.destroy();
if (sharedMemoryCleaner === memoryCleaner) {
sharedMemoryCleaner = undefined;
}
} catch (error) {
api.logger.error(`${TAG} [gateway_stop] memoryCleaner error: ${error instanceof Error ? error.message : String(error)}`);
}
}
// 2. Destroy TdaiCore (scheduler flush + VectorStore close + EmbeddingService close)
await core.destroy();
};
// Race cleanup against a hard timeout
let timeoutId: ReturnType<typeof setTimeout> | undefined;
try {
await Promise.race([
doCleanup(),
new Promise<never>((_, reject) => {
timeoutId = setTimeout(
() => reject(new Error("timeout")),
GATEWAY_STOP_TIMEOUT_MS,
);
}),
]);
} catch (err) {
api.logger.warn(
`${TAG} [gateway_stop] Aborted (${Date.now() - hookStartMs}ms): ${err instanceof Error ? err.message : String(err)}. ` +
`Pending work will recover on next startup.`,
);
} finally {
if (timeoutId !== undefined) clearTimeout(timeoutId);
}
resetStores();
api.logger.info(`${TAG} [gateway_stop] Cleanup finished, all resources released (${Date.now() - hookStartMs}ms)`);
});
} else {
api.logger.debug?.(`${TAG} Auto-capture disabled`);
}
// memoryCleaner gateway_stop for capture-enabled-but-extraction-disabled case
if (memoryCleaner && !cfg.extraction.enabled) {
api.on("gateway_stop", async () => {
const startMs = Date.now();
try {
memoryCleaner?.destroy();
if (sharedMemoryCleaner === memoryCleaner) {
sharedMemoryCleaner = undefined;
}
api.logger.info(`${TAG} [gateway_stop] Memory cleaner destroyed (${Date.now() - startMs}ms)`);
} catch (error) {
api.logger.error(`${TAG} [gateway_stop] Error during memory cleaner destruction (${Date.now() - startMs}ms): ${error instanceof Error ? error.message : String(error)}`);
}
});
}
// ============================
// Context Offload (conditional)
// ============================
if (cfg.offload.enabled) {
api.logger.debug?.(`${TAG} Offload enabled, registering offload module...`);
try {
registerOffload(api, cfg.offload);
api.logger.debug?.(`${TAG} Offload module registered successfully`);
} catch (err) {
api.logger.error(`${TAG} Offload module registration failed: ${err instanceof Error ? err.message : String(err)}`);
}
} else {
api.logger.debug?.(`${TAG} Offload disabled (offload.enabled=false)`);
}
// ============================
// CLI registration
// ============================
api.registerCli(
({ program, config, logger: cliLogger }) => {
const memoryTdai = program
.command("memory-tdai")
.description("memory-tdai plugin commands (seed, query, stats)");
registerMemoryTdaiCli(memoryTdai, {
config,
pluginConfig: api.pluginConfig,
stateDir: openclawStateDir,
logger: cliLogger,
});
},
{ commands: ["memory-tdai"] },
);
api.logger.debug?.(
`${TAG} Plugin registration complete (v3.1 — TdaiCore). ` +
`startTimestamp=${pluginStartTimestamp} (${new Date(pluginStartTimestamp).toISOString()})`,
);
}