memorix 1.2.2 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +3 -3
  3. package/README.zh-CN.md +3 -3
  4. package/TEAM.md +86 -86
  5. package/dist/cli/index.js +5199 -4726
  6. package/dist/cli/index.js.map +1 -1
  7. package/dist/index.js +428 -49
  8. package/dist/index.js.map +1 -1
  9. package/dist/maintenance-runner.js +97 -18
  10. package/dist/maintenance-runner.js.map +1 -1
  11. package/dist/memcode-runtime/CHANGELOG.md +27 -0
  12. package/dist/sdk.js +428 -49
  13. package/dist/sdk.js.map +1 -1
  14. package/docs/1.2.4-PERSISTENT-MEMORY-DELIVERY.md +86 -0
  15. package/docs/AGENT_OPERATOR_PLAYBOOK.md +13 -1
  16. package/docs/API_REFERENCE.md +13 -3
  17. package/docs/DESIGN_DECISIONS.md +357 -357
  18. package/docs/dev-log/progress.txt +60 -9
  19. package/package.json +1 -1
  20. package/plugins/codex/memorix/.codex-plugin/plugin.json +1 -1
  21. package/src/audit/index.ts +156 -156
  22. package/src/cli/capability-map.ts +1 -1
  23. package/src/cli/command-guide.ts +4 -1
  24. package/src/cli/commands/agent-integrations.ts +5 -1
  25. package/src/cli/commands/audit-list.ts +89 -89
  26. package/src/cli/commands/background.ts +659 -659
  27. package/src/cli/commands/codegraph.ts +1 -1
  28. package/src/cli/commands/context.ts +9 -1
  29. package/src/cli/commands/formation.ts +48 -48
  30. package/src/cli/commands/git-hook-install.ts +111 -111
  31. package/src/cli/commands/handoff.ts +54 -54
  32. package/src/cli/commands/hooks-status.ts +63 -63
  33. package/src/cli/commands/ingest-commit.ts +153 -153
  34. package/src/cli/commands/ingest-image.ts +66 -66
  35. package/src/cli/commands/ingest-log.ts +180 -180
  36. package/src/cli/commands/ingest.ts +44 -44
  37. package/src/cli/commands/integrate-shared.ts +15 -15
  38. package/src/cli/commands/lock.ts +82 -82
  39. package/src/cli/commands/message.ts +104 -104
  40. package/src/cli/commands/poll.ts +58 -58
  41. package/src/cli/commands/purge-all-memory.ts +85 -85
  42. package/src/cli/commands/purge-project-memory.ts +83 -83
  43. package/src/cli/commands/reasoning.ts +118 -118
  44. package/src/cli/commands/resume.ts +31 -0
  45. package/src/cli/commands/serve-shared.ts +118 -118
  46. package/src/cli/commands/session.ts +15 -7
  47. package/src/cli/commands/skills.ts +114 -114
  48. package/src/cli/commands/task.ts +167 -167
  49. package/src/cli/commands/transfer.ts +47 -47
  50. package/src/cli/commands/uninstall-project-artifacts.ts +85 -85
  51. package/src/cli/index.ts +3 -1
  52. package/src/cli/tui/ChatView.tsx +234 -234
  53. package/src/cli/tui/CommandBar.tsx +312 -312
  54. package/src/cli/tui/ContextRail.tsx +118 -118
  55. package/src/cli/tui/HeaderBar.tsx +72 -72
  56. package/src/cli/tui/LogoBanner.tsx +51 -51
  57. package/src/cli/tui/Sidebar.tsx +179 -179
  58. package/src/cli/tui/index.ts +41 -41
  59. package/src/cli/tui/markdown-render.tsx +371 -371
  60. package/src/cli/tui/session-service.ts +3 -2
  61. package/src/cli/tui/use-mouse.ts +157 -157
  62. package/src/cli/tui/useNavigation.ts +56 -56
  63. package/src/cli/update-checker.ts +211 -211
  64. package/src/cli/version.ts +7 -7
  65. package/src/cli/workbench.ts +1 -1
  66. package/src/codegraph/auto-context.ts +54 -1
  67. package/src/codegraph/task-lens.ts +29 -0
  68. package/src/compact/token-budget.ts +89 -74
  69. package/src/config/toml-loader.ts +9 -5
  70. package/src/dashboard/project-classification.ts +64 -64
  71. package/src/embedding/fastembed-provider.ts +142 -142
  72. package/src/embedding/transformers-provider.ts +111 -111
  73. package/src/git/extractor.ts +209 -209
  74. package/src/git/hooks-path.ts +85 -85
  75. package/src/hooks/handler.ts +127 -66
  76. package/src/hooks/installers/index.ts +5 -4
  77. package/src/hooks/official-skills.ts +6 -4
  78. package/src/hooks/pattern-detector.ts +173 -173
  79. package/src/hooks/rules/memorix-agent-rules.md +9 -7
  80. package/src/hooks/significance-filter.ts +250 -250
  81. package/src/knowledge/context-assembly.ts +4 -1
  82. package/src/knowledge/workset.ts +89 -1
  83. package/src/llm/memory-manager.ts +328 -328
  84. package/src/llm/provider.ts +885 -885
  85. package/src/llm/quality.ts +248 -248
  86. package/src/memory/attribution-guard.ts +249 -249
  87. package/src/memory/disclosure-policy.ts +135 -135
  88. package/src/memory/entity-extractor.ts +197 -197
  89. package/src/memory/formation/evaluate.ts +217 -217
  90. package/src/memory/formation/extract.ts +361 -361
  91. package/src/memory/formation/index.ts +417 -417
  92. package/src/memory/formation/resolve.ts +344 -344
  93. package/src/memory/formation/types.ts +315 -315
  94. package/src/memory/freshness.ts +122 -122
  95. package/src/memory/graph.ts +197 -197
  96. package/src/memory/refs.ts +94 -94
  97. package/src/memory/secret-filter.ts +79 -79
  98. package/src/memory/session.ts +158 -9
  99. package/src/multimodal/image-loader.ts +143 -143
  100. package/src/orchestrate/adapters/claude-stream.ts +192 -192
  101. package/src/orchestrate/adapters/claude.ts +111 -111
  102. package/src/orchestrate/adapters/codex-stream.ts +134 -134
  103. package/src/orchestrate/adapters/codex.ts +41 -41
  104. package/src/orchestrate/adapters/gemini-stream.ts +166 -166
  105. package/src/orchestrate/adapters/gemini.ts +42 -42
  106. package/src/orchestrate/adapters/index.ts +73 -73
  107. package/src/orchestrate/adapters/opencode-stream.ts +143 -143
  108. package/src/orchestrate/adapters/opencode.ts +47 -47
  109. package/src/orchestrate/adapters/spawn-helper.ts +286 -286
  110. package/src/orchestrate/adapters/types.ts +77 -77
  111. package/src/orchestrate/capability-router.ts +284 -284
  112. package/src/orchestrate/context-compact.ts +188 -188
  113. package/src/orchestrate/cost-tracker.ts +219 -219
  114. package/src/orchestrate/error-recovery.ts +191 -191
  115. package/src/orchestrate/evidence.ts +140 -140
  116. package/src/orchestrate/ledger.ts +110 -110
  117. package/src/orchestrate/memorix-bridge.ts +343 -343
  118. package/src/orchestrate/output-budget.ts +80 -80
  119. package/src/orchestrate/permission.ts +152 -152
  120. package/src/orchestrate/pipeline-trace.ts +131 -131
  121. package/src/orchestrate/prompt-builder.ts +155 -155
  122. package/src/orchestrate/ring-buffer.ts +37 -37
  123. package/src/orchestrate/task-graph.ts +389 -389
  124. package/src/orchestrate/worktree.ts +232 -232
  125. package/src/project/aliases.ts +374 -374
  126. package/src/project/detector.ts +268 -268
  127. package/src/rules/adapters/claude-code.ts +99 -99
  128. package/src/rules/adapters/codex.ts +97 -97
  129. package/src/rules/adapters/copilot.ts +124 -124
  130. package/src/rules/adapters/cursor.ts +114 -114
  131. package/src/rules/adapters/kiro.ts +126 -126
  132. package/src/rules/adapters/trae.ts +56 -56
  133. package/src/rules/adapters/windsurf.ts +83 -83
  134. package/src/rules/syncer.ts +235 -235
  135. package/src/sdk.ts +299 -299
  136. package/src/search/intent-detector.ts +289 -289
  137. package/src/search/query-expansion.ts +52 -52
  138. package/src/server/formation-timeout.ts +27 -27
  139. package/src/server.ts +144 -10
  140. package/src/skills/mini-skills.ts +386 -386
  141. package/src/store/bun-sqlite-compat.ts +118 -15
  142. package/src/store/chat-store.ts +119 -119
  143. package/src/store/graph-store.ts +249 -249
  144. package/src/store/mini-skill-store.ts +349 -349
  145. package/src/store/persistence-json.ts +212 -212
  146. package/src/store/persistence.ts +291 -291
  147. package/src/store/project-affinity.ts +195 -195
  148. package/src/store/sqlite-db.ts +3 -3
  149. package/src/team/event-bus.ts +76 -76
  150. package/src/team/file-locks.ts +173 -173
  151. package/src/team/handoff.ts +161 -161
  152. package/src/team/messages.ts +203 -203
  153. package/src/team/poll.ts +132 -132
  154. package/src/team/tasks.ts +211 -211
  155. package/src/workspace/mcp-adapters/codex.ts +191 -191
  156. package/src/workspace/mcp-adapters/copilot.ts +105 -105
  157. package/src/workspace/mcp-adapters/cursor.ts +53 -53
  158. package/src/workspace/mcp-adapters/kiro.ts +64 -64
  159. package/src/workspace/mcp-adapters/opencode.ts +123 -123
  160. package/src/workspace/mcp-adapters/trae.ts +134 -134
  161. package/src/workspace/mcp-adapters/windsurf.ts +91 -91
  162. package/src/workspace/sanitizer.ts +60 -60
  163. package/src/workspace/workflow-sync.ts +131 -131
@@ -1,417 +1,417 @@
1
- /**
2
- * Memory Formation Pipeline — Orchestrator
3
- *
4
- * Runs the three-stage pipeline: Extract → Resolve → Evaluate.
5
- *
6
- * Supports two execution modes:
7
- * - **Active mode**: Pipeline output drives storage decisions (replaces compact-on-write)
8
- * - **Shadow mode**: Pipeline runs in parallel with existing compact-on-write,
9
- * producing metrics for comparison without affecting storage
10
- *
11
- * Design: Pipeline is a pure function with injected dependencies (search, getObservation).
12
- * It does not import server.ts or storeObservation directly.
13
- */
14
-
15
- import type {
16
- FormationInput,
17
- FormedMemory,
18
- FormationConfig,
19
- FormationMetrics,
20
- BeforeAfterMetrics,
21
- FormationStage,
22
- } from './types.js';
23
- import { runExtract } from './extract.js';
24
- import { runResolve } from './resolve.js';
25
- import { runEvaluate } from './evaluate.js';
26
-
27
- // ── Shadow Mode Metrics Collection ──────────────────────────────
28
-
29
- /** In-memory metrics buffer for shadow mode analysis */
30
- const metricsBuffer: FormationMetrics[] = [];
31
- const MAX_METRICS_BUFFER = 500;
32
-
33
- /** In-memory before/after comparison metrics buffer */
34
- const beforeAfterBuffer: Array<{
35
- formationAction: string;
36
- formationTargetId?: number;
37
- oldCompactAction: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE';
38
- oldCompactTargetId?: number;
39
- oldCompactReason?: string;
40
- formationValueScore: number;
41
- formationValueCategory: string;
42
- formationDurationMs: number;
43
- compactDurationMs?: number;
44
- }> = [];
45
- const MAX_BEFORE_AFTER_BUFFER = 500;
46
-
47
- /**
48
- * Get collected shadow mode metrics (for analysis/dashboard).
49
- */
50
- export function getFormationMetrics(): readonly FormationMetrics[] {
51
- return metricsBuffer;
52
- }
53
-
54
- /**
55
- * Clear metrics buffer.
56
- */
57
- export function clearFormationMetrics(): void {
58
- metricsBuffer.length = 0;
59
- }
60
-
61
- /**
62
- * Record before/after comparison metrics.
63
- */
64
- export function recordBeforeAfterMetrics(data: {
65
- formationAction: string;
66
- formationTargetId?: number;
67
- oldCompactAction: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE';
68
- oldCompactTargetId?: number;
69
- oldCompactReason?: string;
70
- formationValueScore: number;
71
- formationValueCategory: string;
72
- formationDurationMs: number;
73
- compactDurationMs?: number;
74
- }): void {
75
- if (beforeAfterBuffer.length >= MAX_BEFORE_AFTER_BUFFER) {
76
- beforeAfterBuffer.shift();
77
- }
78
- beforeAfterBuffer.push(data);
79
- }
80
-
81
- /**
82
- * Get before/after comparison metrics.
83
- */
84
- export function getBeforeAfterMetrics(): BeforeAfterMetrics {
85
- const totalProcessed = beforeAfterBuffer.length;
86
- if (totalProcessed === 0) {
87
- return {
88
- totalProcessed: 0,
89
- agreements: 0,
90
- disagreements: 0,
91
- disagreementBreakdown: {
92
- formationDiscardedCompactAdded: 0,
93
- formationMergedCompactAdded: 0,
94
- formationAddedCompactDiscarded: 0,
95
- formationAddedCompactMerged: 0,
96
- formationEvolvedCompactAdded: 0,
97
- other: 0,
98
- },
99
- quality: {
100
- formationDiscardedLowValue: 0,
101
- formationMergedDuplicates: 0,
102
- formationEvolvedOutdated: 0,
103
- compactMissedDuplicates: 0,
104
- compactKeptLowValue: 0,
105
- },
106
- duration: {
107
- formationAvgMs: 0,
108
- compactAvgMs: 0,
109
- diffMs: 0,
110
- },
111
- };
112
- }
113
-
114
- let agreements = 0;
115
- let disagreements = 0;
116
- const disagreementBreakdown = {
117
- formationDiscardedCompactAdded: 0,
118
- formationMergedCompactAdded: 0,
119
- formationAddedCompactDiscarded: 0,
120
- formationAddedCompactMerged: 0,
121
- formationEvolvedCompactAdded: 0,
122
- other: 0,
123
- };
124
- const quality = {
125
- formationDiscardedLowValue: 0,
126
- formationMergedDuplicates: 0,
127
- formationEvolvedOutdated: 0,
128
- compactMissedDuplicates: 0,
129
- compactKeptLowValue: 0,
130
- };
131
- let formationTotalDuration = 0;
132
- let compactTotalDuration = 0;
133
- let compactDurationCount = 0;
134
-
135
- for (const data of beforeAfterBuffer) {
136
- formationTotalDuration += data.formationDurationMs;
137
- if (data.compactDurationMs !== undefined) {
138
- compactTotalDuration += data.compactDurationMs;
139
- compactDurationCount++;
140
- }
141
-
142
- // Determine if decisions agree
143
- const formationAction = data.formationAction;
144
- const oldCompactAction = data.oldCompactAction;
145
-
146
- // Map Formation actions to old compact actions for comparison
147
- let formationMapped: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE' = 'ADD';
148
- if (formationAction === 'merge' || formationAction === 'evolve') {
149
- formationMapped = 'UPDATE';
150
- } else if (formationAction === 'discard') {
151
- formationMapped = 'NONE';
152
- }
153
-
154
- if (formationMapped === oldCompactAction) {
155
- agreements++;
156
- } else {
157
- disagreements++;
158
- // Track disagreement breakdown
159
- if (formationAction === 'discard' && oldCompactAction === 'ADD') {
160
- disagreementBreakdown.formationDiscardedCompactAdded++;
161
- if (data.formationValueCategory === 'ephemeral') {
162
- quality.formationDiscardedLowValue++;
163
- }
164
- } else if (formationAction === 'merge' && oldCompactAction === 'ADD') {
165
- disagreementBreakdown.formationMergedCompactAdded++;
166
- quality.formationMergedDuplicates++;
167
- } else if (formationAction === 'new' && oldCompactAction === 'NONE') {
168
- disagreementBreakdown.formationAddedCompactDiscarded++;
169
- quality.compactMissedDuplicates++;
170
- } else if (formationAction === 'new' && oldCompactAction === 'UPDATE') {
171
- disagreementBreakdown.formationAddedCompactMerged++;
172
- } else if (formationAction === 'evolve' && oldCompactAction === 'ADD') {
173
- disagreementBreakdown.formationEvolvedCompactAdded++;
174
- quality.formationEvolvedOutdated++;
175
- } else if (formationAction === 'new' && oldCompactAction === 'ADD') {
176
- // Formation decided to add, but compact also decided to add (should be rare)
177
- // This might indicate compact missed a duplicate or Formation was too conservative
178
- if (data.formationValueCategory === 'ephemeral') {
179
- quality.compactKeptLowValue++;
180
- }
181
- } else {
182
- disagreementBreakdown.other++;
183
- }
184
- }
185
- }
186
-
187
- const compactAvgMs = compactDurationCount > 0 ? compactTotalDuration / compactDurationCount : 0;
188
- const formationAvgMs = totalProcessed > 0 ? formationTotalDuration / totalProcessed : 0;
189
-
190
- return {
191
- totalProcessed,
192
- agreements,
193
- disagreements,
194
- disagreementBreakdown,
195
- quality,
196
- duration: {
197
- formationAvgMs,
198
- compactAvgMs,
199
- diffMs: compactAvgMs - formationAvgMs,
200
- },
201
- };
202
- }
203
-
204
- /**
205
- * Get aggregated metrics summary.
206
- */
207
- export function getMetricsSummary(): {
208
- total: number;
209
- avgValueScore: number;
210
- avgExtractedFacts: number;
211
- titleImprovedRate: number;
212
- entityResolvedRate: number;
213
- typeCorectedRate: number;
214
- resolutionBreakdown: Record<string, number>;
215
- categoryBreakdown: Record<string, number>;
216
- avgDurationMs: number;
217
- } {
218
- const total = metricsBuffer.length;
219
- if (total === 0) {
220
- return {
221
- total: 0,
222
- avgValueScore: 0,
223
- avgExtractedFacts: 0,
224
- titleImprovedRate: 0,
225
- entityResolvedRate: 0,
226
- typeCorectedRate: 0,
227
- resolutionBreakdown: {},
228
- categoryBreakdown: {},
229
- avgDurationMs: 0,
230
- };
231
- }
232
-
233
- const sum = (fn: (m: FormationMetrics) => number) =>
234
- metricsBuffer.reduce((s, m) => s + fn(m), 0);
235
-
236
- const resolutionBreakdown: Record<string, number> = {};
237
- const categoryBreakdown: Record<string, number> = {};
238
- for (const m of metricsBuffer) {
239
- resolutionBreakdown[m.resolutionAction] = (resolutionBreakdown[m.resolutionAction] ?? 0) + 1;
240
- categoryBreakdown[m.valueCategory] = (categoryBreakdown[m.valueCategory] ?? 0) + 1;
241
- }
242
-
243
- return {
244
- total,
245
- avgValueScore: sum(m => m.valueScore) / total,
246
- avgExtractedFacts: sum(m => m.systemExtractedFacts) / total,
247
- titleImprovedRate: sum(m => m.titleImproved ? 1 : 0) / total,
248
- entityResolvedRate: sum(m => m.entityResolved ? 1 : 0) / total,
249
- typeCorectedRate: sum(m => m.typeCorrected ? 1 : 0) / total,
250
- resolutionBreakdown,
251
- categoryBreakdown,
252
- avgDurationMs: sum(m => m.durationMs) / total,
253
- };
254
- }
255
-
256
- // ── Pipeline Orchestrator ────────────────────────────────────────
257
-
258
- /**
259
- * Run the Memory Formation Pipeline.
260
- *
261
- * Three stages:
262
- * 1. Extract: Enrich with system-extracted facts, normalize title/entity/type
263
- * 2. Resolve: Compare against existing memories, decide new/merge/evolve/discard
264
- * 3. Evaluate: Assess knowledge value (core/contextual/ephemeral)
265
- *
266
- * In shadow mode, metrics are collected but no storage decisions are enforced.
267
- */
268
- export async function runFormation(
269
- input: FormationInput,
270
- config: FormationConfig,
271
- ): Promise<FormedMemory> {
272
- const startTime = Date.now();
273
- let stagesCompleted = 0;
274
- const stageDurationsMs: Partial<Record<FormationStage, number>> = {};
275
- const emitStageEvent = (
276
- stage: FormationStage,
277
- status: 'start' | 'success' | 'skipped',
278
- stageDurationMs?: number,
279
- ): void => {
280
- try {
281
- config.onStageEvent?.({
282
- stage,
283
- status,
284
- stageDurationMs,
285
- totalElapsedMs: Date.now() - startTime,
286
- });
287
- } catch {
288
- // Diagnostics hooks must never break the formation pipeline.
289
- }
290
- };
291
-
292
- // ── Stage 1: Extract ──
293
- const existingEntities = config.getEntityNames();
294
- const extractStartTime = Date.now();
295
- emitStageEvent('extract', 'start');
296
- const extraction = await runExtract(input, existingEntities, config.useLLM);
297
- stageDurationsMs.extract = Date.now() - extractStartTime;
298
- emitStageEvent('extract', 'success', stageDurationsMs.extract);
299
- stagesCompleted = 1;
300
-
301
- // ── Stage 2: Resolve ──
302
- // Skip resolve for topicKey upserts (they have their own resolution via topicKey)
303
- let resolution;
304
- if (input.topicKey) {
305
- stageDurationsMs.resolve = 0;
306
- emitStageEvent('resolve', 'skipped', 0);
307
- resolution = {
308
- action: 'new' as const,
309
- reason: 'TopicKey upsert — bypasses resolve stage',
310
- };
311
- } else {
312
- const resolveStartTime = Date.now();
313
- emitStageEvent('resolve', 'start');
314
- resolution = await runResolve(
315
- extraction,
316
- input.projectId,
317
- config.searchMemories,
318
- config.getObservation,
319
- config.useLLM,
320
- );
321
- stageDurationsMs.resolve = Date.now() - resolveStartTime;
322
- emitStageEvent('resolve', 'success', stageDurationsMs.resolve);
323
- }
324
- stagesCompleted = 2;
325
-
326
- // ── Stage 3: Evaluate ──
327
- const evaluateStartTime = Date.now();
328
- emitStageEvent('evaluate', 'start');
329
- const evaluation = runEvaluate(extraction);
330
- stageDurationsMs.evaluate = Date.now() - evaluateStartTime;
331
- emitStageEvent('evaluate', 'success', stageDurationsMs.evaluate);
332
- stagesCompleted = 3;
333
-
334
- const durationMs = Date.now() - startTime;
335
-
336
- const formed: FormedMemory = {
337
- // Final enriched data
338
- entityName: extraction.entityName,
339
- type: extraction.type,
340
- title: extraction.title,
341
- narrative: resolution.mergedNarrative ?? extraction.narrative,
342
- facts: resolution.mergedFacts ?? extraction.facts,
343
-
344
- // Stage results
345
- extraction,
346
- resolution,
347
- evaluation,
348
-
349
- // Pipeline metadata
350
- pipeline: {
351
- mode: config.useLLM ? 'llm' : 'rules',
352
- durationMs,
353
- stagesCompleted,
354
- shadow: config.mode === 'shadow',
355
- stageDurationsMs,
356
- },
357
-
358
- // Governance fields
359
- governance: {
360
- provenance: {
361
- creator: input.source === 'explicit' ? 'user' : 'system',
362
- createdAt: new Date().toISOString(),
363
- source: input.source,
364
- },
365
- confidence: {
366
- score: evaluation.score,
367
- breakdown: {
368
- extractionConfidence: extraction.extractedFacts.length > 0 ? 0.8 : 0.5,
369
- resolutionConfidence: resolution.action === 'new' ? 0.7 : 0.9,
370
- evaluationConfidence: evaluation.score,
371
- },
372
- reason: `Value score ${evaluation.score.toFixed(2)} in ${evaluation.category} category`,
373
- },
374
- supersession: (resolution.action === 'merge' || resolution.action === 'evolve') && resolution.targetId ? {
375
- replacedIds: [resolution.targetId],
376
- reason: resolution.reason,
377
- replacementType: resolution.action === 'evolve' ? 'hard' : 'soft',
378
- } : undefined,
379
- },
380
- };
381
-
382
- // ── Collect metrics ──
383
- const metrics: FormationMetrics = {
384
- systemExtractedFacts: extraction.extractedFacts.length,
385
- titleImproved: extraction.titleImproved,
386
- entityResolved: extraction.entityResolved,
387
- typeCorrected: extraction.typeCorrected,
388
- resolutionAction: resolution.action,
389
- valueScore: evaluation.score,
390
- valueCategory: evaluation.category,
391
- durationMs,
392
- mode: 'rules',
393
- };
394
-
395
- if (metricsBuffer.length >= MAX_METRICS_BUFFER) {
396
- metricsBuffer.shift();
397
- }
398
- metricsBuffer.push(metrics);
399
-
400
- return formed;
401
- }
402
-
403
- // ── Re-exports for convenience ──────────────────────────────────
404
-
405
- export type {
406
- FormationInput,
407
- FormedMemory,
408
- FormationConfig,
409
- FormationMetrics,
410
- ExtractResult,
411
- ResolveResult,
412
- EvaluateResult,
413
- ValueCategory,
414
- ResolutionAction,
415
- SearchHit,
416
- ExistingMemoryRef,
417
- } from './types.js';
1
+ /**
2
+ * Memory Formation Pipeline — Orchestrator
3
+ *
4
+ * Runs the three-stage pipeline: Extract → Resolve → Evaluate.
5
+ *
6
+ * Supports two execution modes:
7
+ * - **Active mode**: Pipeline output drives storage decisions (replaces compact-on-write)
8
+ * - **Shadow mode**: Pipeline runs in parallel with existing compact-on-write,
9
+ * producing metrics for comparison without affecting storage
10
+ *
11
+ * Design: Pipeline is a pure function with injected dependencies (search, getObservation).
12
+ * It does not import server.ts or storeObservation directly.
13
+ */
14
+
15
+ import type {
16
+ FormationInput,
17
+ FormedMemory,
18
+ FormationConfig,
19
+ FormationMetrics,
20
+ BeforeAfterMetrics,
21
+ FormationStage,
22
+ } from './types.js';
23
+ import { runExtract } from './extract.js';
24
+ import { runResolve } from './resolve.js';
25
+ import { runEvaluate } from './evaluate.js';
26
+
27
+ // ── Shadow Mode Metrics Collection ──────────────────────────────
28
+
29
+ /** In-memory metrics buffer for shadow mode analysis */
30
+ const metricsBuffer: FormationMetrics[] = [];
31
+ const MAX_METRICS_BUFFER = 500;
32
+
33
+ /** In-memory before/after comparison metrics buffer */
34
+ const beforeAfterBuffer: Array<{
35
+ formationAction: string;
36
+ formationTargetId?: number;
37
+ oldCompactAction: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE';
38
+ oldCompactTargetId?: number;
39
+ oldCompactReason?: string;
40
+ formationValueScore: number;
41
+ formationValueCategory: string;
42
+ formationDurationMs: number;
43
+ compactDurationMs?: number;
44
+ }> = [];
45
+ const MAX_BEFORE_AFTER_BUFFER = 500;
46
+
47
+ /**
48
+ * Get collected shadow mode metrics (for analysis/dashboard).
49
+ */
50
+ export function getFormationMetrics(): readonly FormationMetrics[] {
51
+ return metricsBuffer;
52
+ }
53
+
54
+ /**
55
+ * Clear metrics buffer.
56
+ */
57
+ export function clearFormationMetrics(): void {
58
+ metricsBuffer.length = 0;
59
+ }
60
+
61
+ /**
62
+ * Record before/after comparison metrics.
63
+ */
64
+ export function recordBeforeAfterMetrics(data: {
65
+ formationAction: string;
66
+ formationTargetId?: number;
67
+ oldCompactAction: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE';
68
+ oldCompactTargetId?: number;
69
+ oldCompactReason?: string;
70
+ formationValueScore: number;
71
+ formationValueCategory: string;
72
+ formationDurationMs: number;
73
+ compactDurationMs?: number;
74
+ }): void {
75
+ if (beforeAfterBuffer.length >= MAX_BEFORE_AFTER_BUFFER) {
76
+ beforeAfterBuffer.shift();
77
+ }
78
+ beforeAfterBuffer.push(data);
79
+ }
80
+
81
+ /**
82
+ * Get before/after comparison metrics.
83
+ */
84
+ export function getBeforeAfterMetrics(): BeforeAfterMetrics {
85
+ const totalProcessed = beforeAfterBuffer.length;
86
+ if (totalProcessed === 0) {
87
+ return {
88
+ totalProcessed: 0,
89
+ agreements: 0,
90
+ disagreements: 0,
91
+ disagreementBreakdown: {
92
+ formationDiscardedCompactAdded: 0,
93
+ formationMergedCompactAdded: 0,
94
+ formationAddedCompactDiscarded: 0,
95
+ formationAddedCompactMerged: 0,
96
+ formationEvolvedCompactAdded: 0,
97
+ other: 0,
98
+ },
99
+ quality: {
100
+ formationDiscardedLowValue: 0,
101
+ formationMergedDuplicates: 0,
102
+ formationEvolvedOutdated: 0,
103
+ compactMissedDuplicates: 0,
104
+ compactKeptLowValue: 0,
105
+ },
106
+ duration: {
107
+ formationAvgMs: 0,
108
+ compactAvgMs: 0,
109
+ diffMs: 0,
110
+ },
111
+ };
112
+ }
113
+
114
+ let agreements = 0;
115
+ let disagreements = 0;
116
+ const disagreementBreakdown = {
117
+ formationDiscardedCompactAdded: 0,
118
+ formationMergedCompactAdded: 0,
119
+ formationAddedCompactDiscarded: 0,
120
+ formationAddedCompactMerged: 0,
121
+ formationEvolvedCompactAdded: 0,
122
+ other: 0,
123
+ };
124
+ const quality = {
125
+ formationDiscardedLowValue: 0,
126
+ formationMergedDuplicates: 0,
127
+ formationEvolvedOutdated: 0,
128
+ compactMissedDuplicates: 0,
129
+ compactKeptLowValue: 0,
130
+ };
131
+ let formationTotalDuration = 0;
132
+ let compactTotalDuration = 0;
133
+ let compactDurationCount = 0;
134
+
135
+ for (const data of beforeAfterBuffer) {
136
+ formationTotalDuration += data.formationDurationMs;
137
+ if (data.compactDurationMs !== undefined) {
138
+ compactTotalDuration += data.compactDurationMs;
139
+ compactDurationCount++;
140
+ }
141
+
142
+ // Determine if decisions agree
143
+ const formationAction = data.formationAction;
144
+ const oldCompactAction = data.oldCompactAction;
145
+
146
+ // Map Formation actions to old compact actions for comparison
147
+ let formationMapped: 'ADD' | 'UPDATE' | 'NONE' | 'DELETE' = 'ADD';
148
+ if (formationAction === 'merge' || formationAction === 'evolve') {
149
+ formationMapped = 'UPDATE';
150
+ } else if (formationAction === 'discard') {
151
+ formationMapped = 'NONE';
152
+ }
153
+
154
+ if (formationMapped === oldCompactAction) {
155
+ agreements++;
156
+ } else {
157
+ disagreements++;
158
+ // Track disagreement breakdown
159
+ if (formationAction === 'discard' && oldCompactAction === 'ADD') {
160
+ disagreementBreakdown.formationDiscardedCompactAdded++;
161
+ if (data.formationValueCategory === 'ephemeral') {
162
+ quality.formationDiscardedLowValue++;
163
+ }
164
+ } else if (formationAction === 'merge' && oldCompactAction === 'ADD') {
165
+ disagreementBreakdown.formationMergedCompactAdded++;
166
+ quality.formationMergedDuplicates++;
167
+ } else if (formationAction === 'new' && oldCompactAction === 'NONE') {
168
+ disagreementBreakdown.formationAddedCompactDiscarded++;
169
+ quality.compactMissedDuplicates++;
170
+ } else if (formationAction === 'new' && oldCompactAction === 'UPDATE') {
171
+ disagreementBreakdown.formationAddedCompactMerged++;
172
+ } else if (formationAction === 'evolve' && oldCompactAction === 'ADD') {
173
+ disagreementBreakdown.formationEvolvedCompactAdded++;
174
+ quality.formationEvolvedOutdated++;
175
+ } else if (formationAction === 'new' && oldCompactAction === 'ADD') {
176
+ // Formation decided to add, but compact also decided to add (should be rare)
177
+ // This might indicate compact missed a duplicate or Formation was too conservative
178
+ if (data.formationValueCategory === 'ephemeral') {
179
+ quality.compactKeptLowValue++;
180
+ }
181
+ } else {
182
+ disagreementBreakdown.other++;
183
+ }
184
+ }
185
+ }
186
+
187
+ const compactAvgMs = compactDurationCount > 0 ? compactTotalDuration / compactDurationCount : 0;
188
+ const formationAvgMs = totalProcessed > 0 ? formationTotalDuration / totalProcessed : 0;
189
+
190
+ return {
191
+ totalProcessed,
192
+ agreements,
193
+ disagreements,
194
+ disagreementBreakdown,
195
+ quality,
196
+ duration: {
197
+ formationAvgMs,
198
+ compactAvgMs,
199
+ diffMs: compactAvgMs - formationAvgMs,
200
+ },
201
+ };
202
+ }
203
+
204
+ /**
205
+ * Get aggregated metrics summary.
206
+ */
207
+ export function getMetricsSummary(): {
208
+ total: number;
209
+ avgValueScore: number;
210
+ avgExtractedFacts: number;
211
+ titleImprovedRate: number;
212
+ entityResolvedRate: number;
213
+ typeCorectedRate: number;
214
+ resolutionBreakdown: Record<string, number>;
215
+ categoryBreakdown: Record<string, number>;
216
+ avgDurationMs: number;
217
+ } {
218
+ const total = metricsBuffer.length;
219
+ if (total === 0) {
220
+ return {
221
+ total: 0,
222
+ avgValueScore: 0,
223
+ avgExtractedFacts: 0,
224
+ titleImprovedRate: 0,
225
+ entityResolvedRate: 0,
226
+ typeCorectedRate: 0,
227
+ resolutionBreakdown: {},
228
+ categoryBreakdown: {},
229
+ avgDurationMs: 0,
230
+ };
231
+ }
232
+
233
+ const sum = (fn: (m: FormationMetrics) => number) =>
234
+ metricsBuffer.reduce((s, m) => s + fn(m), 0);
235
+
236
+ const resolutionBreakdown: Record<string, number> = {};
237
+ const categoryBreakdown: Record<string, number> = {};
238
+ for (const m of metricsBuffer) {
239
+ resolutionBreakdown[m.resolutionAction] = (resolutionBreakdown[m.resolutionAction] ?? 0) + 1;
240
+ categoryBreakdown[m.valueCategory] = (categoryBreakdown[m.valueCategory] ?? 0) + 1;
241
+ }
242
+
243
+ return {
244
+ total,
245
+ avgValueScore: sum(m => m.valueScore) / total,
246
+ avgExtractedFacts: sum(m => m.systemExtractedFacts) / total,
247
+ titleImprovedRate: sum(m => m.titleImproved ? 1 : 0) / total,
248
+ entityResolvedRate: sum(m => m.entityResolved ? 1 : 0) / total,
249
+ typeCorectedRate: sum(m => m.typeCorrected ? 1 : 0) / total,
250
+ resolutionBreakdown,
251
+ categoryBreakdown,
252
+ avgDurationMs: sum(m => m.durationMs) / total,
253
+ };
254
+ }
255
+
256
+ // ── Pipeline Orchestrator ────────────────────────────────────────
257
+
258
+ /**
259
+ * Run the Memory Formation Pipeline.
260
+ *
261
+ * Three stages:
262
+ * 1. Extract: Enrich with system-extracted facts, normalize title/entity/type
263
+ * 2. Resolve: Compare against existing memories, decide new/merge/evolve/discard
264
+ * 3. Evaluate: Assess knowledge value (core/contextual/ephemeral)
265
+ *
266
+ * In shadow mode, metrics are collected but no storage decisions are enforced.
267
+ */
268
+ export async function runFormation(
269
+ input: FormationInput,
270
+ config: FormationConfig,
271
+ ): Promise<FormedMemory> {
272
+ const startTime = Date.now();
273
+ let stagesCompleted = 0;
274
+ const stageDurationsMs: Partial<Record<FormationStage, number>> = {};
275
+ const emitStageEvent = (
276
+ stage: FormationStage,
277
+ status: 'start' | 'success' | 'skipped',
278
+ stageDurationMs?: number,
279
+ ): void => {
280
+ try {
281
+ config.onStageEvent?.({
282
+ stage,
283
+ status,
284
+ stageDurationMs,
285
+ totalElapsedMs: Date.now() - startTime,
286
+ });
287
+ } catch {
288
+ // Diagnostics hooks must never break the formation pipeline.
289
+ }
290
+ };
291
+
292
+ // ── Stage 1: Extract ──
293
+ const existingEntities = config.getEntityNames();
294
+ const extractStartTime = Date.now();
295
+ emitStageEvent('extract', 'start');
296
+ const extraction = await runExtract(input, existingEntities, config.useLLM);
297
+ stageDurationsMs.extract = Date.now() - extractStartTime;
298
+ emitStageEvent('extract', 'success', stageDurationsMs.extract);
299
+ stagesCompleted = 1;
300
+
301
+ // ── Stage 2: Resolve ──
302
+ // Skip resolve for topicKey upserts (they have their own resolution via topicKey)
303
+ let resolution;
304
+ if (input.topicKey) {
305
+ stageDurationsMs.resolve = 0;
306
+ emitStageEvent('resolve', 'skipped', 0);
307
+ resolution = {
308
+ action: 'new' as const,
309
+ reason: 'TopicKey upsert — bypasses resolve stage',
310
+ };
311
+ } else {
312
+ const resolveStartTime = Date.now();
313
+ emitStageEvent('resolve', 'start');
314
+ resolution = await runResolve(
315
+ extraction,
316
+ input.projectId,
317
+ config.searchMemories,
318
+ config.getObservation,
319
+ config.useLLM,
320
+ );
321
+ stageDurationsMs.resolve = Date.now() - resolveStartTime;
322
+ emitStageEvent('resolve', 'success', stageDurationsMs.resolve);
323
+ }
324
+ stagesCompleted = 2;
325
+
326
+ // ── Stage 3: Evaluate ──
327
+ const evaluateStartTime = Date.now();
328
+ emitStageEvent('evaluate', 'start');
329
+ const evaluation = runEvaluate(extraction);
330
+ stageDurationsMs.evaluate = Date.now() - evaluateStartTime;
331
+ emitStageEvent('evaluate', 'success', stageDurationsMs.evaluate);
332
+ stagesCompleted = 3;
333
+
334
+ const durationMs = Date.now() - startTime;
335
+
336
+ const formed: FormedMemory = {
337
+ // Final enriched data
338
+ entityName: extraction.entityName,
339
+ type: extraction.type,
340
+ title: extraction.title,
341
+ narrative: resolution.mergedNarrative ?? extraction.narrative,
342
+ facts: resolution.mergedFacts ?? extraction.facts,
343
+
344
+ // Stage results
345
+ extraction,
346
+ resolution,
347
+ evaluation,
348
+
349
+ // Pipeline metadata
350
+ pipeline: {
351
+ mode: config.useLLM ? 'llm' : 'rules',
352
+ durationMs,
353
+ stagesCompleted,
354
+ shadow: config.mode === 'shadow',
355
+ stageDurationsMs,
356
+ },
357
+
358
+ // Governance fields
359
+ governance: {
360
+ provenance: {
361
+ creator: input.source === 'explicit' ? 'user' : 'system',
362
+ createdAt: new Date().toISOString(),
363
+ source: input.source,
364
+ },
365
+ confidence: {
366
+ score: evaluation.score,
367
+ breakdown: {
368
+ extractionConfidence: extraction.extractedFacts.length > 0 ? 0.8 : 0.5,
369
+ resolutionConfidence: resolution.action === 'new' ? 0.7 : 0.9,
370
+ evaluationConfidence: evaluation.score,
371
+ },
372
+ reason: `Value score ${evaluation.score.toFixed(2)} in ${evaluation.category} category`,
373
+ },
374
+ supersession: (resolution.action === 'merge' || resolution.action === 'evolve') && resolution.targetId ? {
375
+ replacedIds: [resolution.targetId],
376
+ reason: resolution.reason,
377
+ replacementType: resolution.action === 'evolve' ? 'hard' : 'soft',
378
+ } : undefined,
379
+ },
380
+ };
381
+
382
+ // ── Collect metrics ──
383
+ const metrics: FormationMetrics = {
384
+ systemExtractedFacts: extraction.extractedFacts.length,
385
+ titleImproved: extraction.titleImproved,
386
+ entityResolved: extraction.entityResolved,
387
+ typeCorrected: extraction.typeCorrected,
388
+ resolutionAction: resolution.action,
389
+ valueScore: evaluation.score,
390
+ valueCategory: evaluation.category,
391
+ durationMs,
392
+ mode: 'rules',
393
+ };
394
+
395
+ if (metricsBuffer.length >= MAX_METRICS_BUFFER) {
396
+ metricsBuffer.shift();
397
+ }
398
+ metricsBuffer.push(metrics);
399
+
400
+ return formed;
401
+ }
402
+
403
+ // ── Re-exports for convenience ──────────────────────────────────
404
+
405
+ export type {
406
+ FormationInput,
407
+ FormedMemory,
408
+ FormationConfig,
409
+ FormationMetrics,
410
+ ExtractResult,
411
+ ResolveResult,
412
+ EvaluateResult,
413
+ ValueCategory,
414
+ ResolutionAction,
415
+ SearchHit,
416
+ ExistingMemoryRef,
417
+ } from './types.js';