@dizzlkheinz/ynab-mcpb 0.18.4 → 0.19.0

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 (343) hide show
  1. package/CLAUDE.md +87 -8
  2. package/bin/ynab-mcp-server.cjs +2 -2
  3. package/bin/ynab-mcp-server.js +3 -3
  4. package/biome.json +39 -0
  5. package/dist/bundle/index.cjs +67 -67
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.js +27 -27
  8. package/dist/server/YNABMCPServer.d.ts +3 -4
  9. package/dist/server/YNABMCPServer.js +111 -116
  10. package/dist/server/budgetResolver.d.ts +6 -5
  11. package/dist/server/budgetResolver.js +46 -36
  12. package/dist/server/cacheKeys.js +6 -6
  13. package/dist/server/cacheManager.js +14 -11
  14. package/dist/server/completions.d.ts +2 -2
  15. package/dist/server/completions.js +20 -15
  16. package/dist/server/config.d.ts +10 -5
  17. package/dist/server/config.js +24 -7
  18. package/dist/server/deltaCache.d.ts +2 -2
  19. package/dist/server/deltaCache.js +22 -16
  20. package/dist/server/deltaCache.merge.d.ts +2 -2
  21. package/dist/server/diagnostics.d.ts +4 -4
  22. package/dist/server/diagnostics.js +38 -32
  23. package/dist/server/errorHandler.d.ts +5 -12
  24. package/dist/server/errorHandler.js +219 -217
  25. package/dist/server/prompts.d.ts +2 -2
  26. package/dist/server/prompts.js +45 -45
  27. package/dist/server/rateLimiter.js +4 -4
  28. package/dist/server/requestLogger.d.ts +1 -1
  29. package/dist/server/requestLogger.js +40 -35
  30. package/dist/server/resources.d.ts +3 -3
  31. package/dist/server/resources.js +55 -52
  32. package/dist/server/responseFormatter.js +6 -6
  33. package/dist/server/securityMiddleware.d.ts +2 -2
  34. package/dist/server/securityMiddleware.js +22 -20
  35. package/dist/server/serverKnowledgeStore.js +1 -1
  36. package/dist/server/toolRegistry.d.ts +3 -3
  37. package/dist/server/toolRegistry.js +47 -40
  38. package/dist/tools/__tests__/deltaTestUtils.d.ts +3 -3
  39. package/dist/tools/__tests__/deltaTestUtils.js +2 -2
  40. package/dist/tools/accountTools.d.ts +9 -8
  41. package/dist/tools/accountTools.js +47 -47
  42. package/dist/tools/adapters.d.ts +13 -8
  43. package/dist/tools/adapters.js +21 -11
  44. package/dist/tools/budgetTools.d.ts +8 -7
  45. package/dist/tools/budgetTools.js +22 -22
  46. package/dist/tools/categoryTools.d.ts +9 -8
  47. package/dist/tools/categoryTools.js +68 -59
  48. package/dist/tools/compareTransactions/formatter.d.ts +3 -3
  49. package/dist/tools/compareTransactions/formatter.js +9 -9
  50. package/dist/tools/compareTransactions/index.d.ts +6 -6
  51. package/dist/tools/compareTransactions/index.js +58 -43
  52. package/dist/tools/compareTransactions/matcher.d.ts +1 -1
  53. package/dist/tools/compareTransactions/matcher.js +28 -15
  54. package/dist/tools/compareTransactions/parser.d.ts +2 -2
  55. package/dist/tools/compareTransactions/parser.js +144 -138
  56. package/dist/tools/compareTransactions/types.d.ts +4 -4
  57. package/dist/tools/compareTransactions.d.ts +1 -1
  58. package/dist/tools/compareTransactions.js +1 -1
  59. package/dist/tools/deltaFetcher.d.ts +2 -2
  60. package/dist/tools/deltaFetcher.js +16 -15
  61. package/dist/tools/deltaSupport.d.ts +4 -4
  62. package/dist/tools/deltaSupport.js +35 -41
  63. package/dist/tools/exportTransactions.d.ts +5 -4
  64. package/dist/tools/exportTransactions.js +61 -59
  65. package/dist/tools/monthTools.d.ts +7 -6
  66. package/dist/tools/monthTools.js +31 -29
  67. package/dist/tools/payeeTools.d.ts +7 -6
  68. package/dist/tools/payeeTools.js +28 -28
  69. package/dist/tools/reconcileAdapter.d.ts +2 -2
  70. package/dist/tools/reconcileAdapter.js +19 -12
  71. package/dist/tools/reconciliation/analyzer.d.ts +4 -4
  72. package/dist/tools/reconciliation/analyzer.js +73 -59
  73. package/dist/tools/reconciliation/csvParser.d.ts +3 -3
  74. package/dist/tools/reconciliation/csvParser.js +128 -104
  75. package/dist/tools/reconciliation/executor.d.ts +4 -4
  76. package/dist/tools/reconciliation/executor.js +148 -109
  77. package/dist/tools/reconciliation/index.d.ts +10 -10
  78. package/dist/tools/reconciliation/index.js +96 -83
  79. package/dist/tools/reconciliation/matcher.d.ts +3 -3
  80. package/dist/tools/reconciliation/matcher.js +17 -16
  81. package/dist/tools/reconciliation/payeeNormalizer.js +19 -8
  82. package/dist/tools/reconciliation/recommendationEngine.d.ts +1 -1
  83. package/dist/tools/reconciliation/recommendationEngine.js +40 -40
  84. package/dist/tools/reconciliation/reportFormatter.d.ts +2 -2
  85. package/dist/tools/reconciliation/reportFormatter.js +59 -58
  86. package/dist/tools/reconciliation/signDetector.d.ts +1 -1
  87. package/dist/tools/reconciliation/types.d.ts +16 -16
  88. package/dist/tools/reconciliation/ynabAdapter.d.ts +2 -2
  89. package/dist/tools/schemas/common.d.ts +1 -1
  90. package/dist/tools/schemas/common.js +1 -1
  91. package/dist/tools/schemas/outputs/accountOutputs.d.ts +1 -1
  92. package/dist/tools/schemas/outputs/accountOutputs.js +24 -18
  93. package/dist/tools/schemas/outputs/budgetOutputs.d.ts +1 -1
  94. package/dist/tools/schemas/outputs/budgetOutputs.js +14 -11
  95. package/dist/tools/schemas/outputs/categoryOutputs.d.ts +1 -1
  96. package/dist/tools/schemas/outputs/categoryOutputs.js +49 -29
  97. package/dist/tools/schemas/outputs/comparisonOutputs.d.ts +1 -1
  98. package/dist/tools/schemas/outputs/comparisonOutputs.js +12 -12
  99. package/dist/tools/schemas/outputs/index.d.ts +14 -14
  100. package/dist/tools/schemas/outputs/index.js +14 -14
  101. package/dist/tools/schemas/outputs/monthOutputs.d.ts +1 -1
  102. package/dist/tools/schemas/outputs/monthOutputs.js +56 -41
  103. package/dist/tools/schemas/outputs/payeeOutputs.d.ts +1 -1
  104. package/dist/tools/schemas/outputs/payeeOutputs.js +10 -10
  105. package/dist/tools/schemas/outputs/reconciliationOutputs.d.ts +2 -2
  106. package/dist/tools/schemas/outputs/reconciliationOutputs.js +45 -45
  107. package/dist/tools/schemas/outputs/transactionMutationOutputs.d.ts +1 -1
  108. package/dist/tools/schemas/outputs/transactionMutationOutputs.js +28 -22
  109. package/dist/tools/schemas/outputs/transactionOutputs.d.ts +1 -1
  110. package/dist/tools/schemas/outputs/transactionOutputs.js +43 -35
  111. package/dist/tools/schemas/outputs/utilityOutputs.d.ts +1 -1
  112. package/dist/tools/schemas/outputs/utilityOutputs.js +5 -3
  113. package/dist/tools/schemas/shared/commonOutputs.d.ts +1 -1
  114. package/dist/tools/schemas/shared/commonOutputs.js +15 -9
  115. package/dist/tools/transactionReadTools.d.ts +11 -0
  116. package/dist/tools/transactionReadTools.js +202 -0
  117. package/dist/tools/transactionSchemas.d.ts +7 -7
  118. package/dist/tools/transactionSchemas.js +77 -57
  119. package/dist/tools/transactionTools.d.ts +6 -24
  120. package/dist/tools/transactionTools.js +7 -1499
  121. package/dist/tools/transactionUtils.d.ts +6 -6
  122. package/dist/tools/transactionUtils.js +78 -63
  123. package/dist/tools/transactionWriteTools.d.ts +20 -0
  124. package/dist/tools/transactionWriteTools.js +1342 -0
  125. package/dist/tools/utilityTools.d.ts +5 -4
  126. package/dist/tools/utilityTools.js +11 -11
  127. package/dist/types/index.d.ts +7 -7
  128. package/dist/types/index.js +6 -6
  129. package/dist/types/reconciliation.d.ts +1 -1
  130. package/dist/types/toolRegistration.d.ts +14 -12
  131. package/dist/utils/amountUtils.js +1 -1
  132. package/dist/utils/dateUtils.js +4 -4
  133. package/dist/utils/errors.d.ts +3 -3
  134. package/dist/utils/errors.js +4 -4
  135. package/dist/utils/money.d.ts +2 -2
  136. package/dist/utils/money.js +8 -8
  137. package/dist/utils/validationError.d.ts +1 -1
  138. package/dist/utils/validationError.js +1 -1
  139. package/docs/assets/examples/reconciliation-with-recommendations.json +66 -66
  140. package/docs/assets/schemas/reconciliation-v2.json +360 -336
  141. package/esbuild.config.mjs +53 -50
  142. package/meta.json +12548 -12548
  143. package/package.json +98 -111
  144. package/scripts/analyze-bundle.mjs +33 -30
  145. package/scripts/create-pr-description.js +169 -120
  146. package/scripts/run-all-tests.js +178 -169
  147. package/scripts/run-domain-integration-tests.js +28 -18
  148. package/scripts/run-generate-mcpb.js +19 -17
  149. package/scripts/run-throttled-integration-tests.js +92 -83
  150. package/scripts/test-delta-params.mjs +149 -120
  151. package/scripts/test-recommendations.ts +36 -32
  152. package/scripts/tmpTransaction.ts +80 -43
  153. package/scripts/validate-env.js +98 -91
  154. package/scripts/verify-build.js +78 -76
  155. package/src/__tests__/comprehensive.integration.test.ts +1281 -1154
  156. package/src/__tests__/performance.test.ts +723 -671
  157. package/src/__tests__/setup.ts +442 -395
  158. package/src/__tests__/smoke.e2e.test.ts +41 -39
  159. package/src/__tests__/testRunner.ts +314 -295
  160. package/src/__tests__/testUtils.ts +456 -364
  161. package/src/__tests__/tools/reconciliation/csvParser.integration.test.ts +109 -107
  162. package/src/__tests__/tools/reconciliation/real-world.integration.test.ts +41 -41
  163. package/src/index.ts +68 -59
  164. package/src/server/CLAUDE.md +480 -0
  165. package/src/server/YNABMCPServer.ts +821 -794
  166. package/src/server/__tests__/YNABMCPServer.integration.test.ts +929 -893
  167. package/src/server/__tests__/YNABMCPServer.test.ts +903 -899
  168. package/src/server/__tests__/budgetResolver.test.ts +466 -423
  169. package/src/server/__tests__/cacheManager.test.ts +891 -874
  170. package/src/server/__tests__/completions.integration.test.ts +115 -106
  171. package/src/server/__tests__/completions.test.ts +334 -313
  172. package/src/server/__tests__/config.test.ts +98 -86
  173. package/src/server/__tests__/deltaCache.merge.test.ts +774 -703
  174. package/src/server/__tests__/deltaCache.swr.test.ts +198 -153
  175. package/src/server/__tests__/deltaCache.test.ts +946 -759
  176. package/src/server/__tests__/diagnostics.test.ts +825 -792
  177. package/src/server/__tests__/errorHandler.integration.test.ts +512 -462
  178. package/src/server/__tests__/errorHandler.test.ts +402 -397
  179. package/src/server/__tests__/prompts.test.ts +424 -347
  180. package/src/server/__tests__/rateLimiter.test.ts +313 -309
  181. package/src/server/__tests__/requestLogger.test.ts +443 -403
  182. package/src/server/__tests__/resources.template.test.ts +196 -185
  183. package/src/server/__tests__/resources.test.ts +294 -288
  184. package/src/server/__tests__/security.integration.test.ts +487 -421
  185. package/src/server/__tests__/securityMiddleware.test.ts +519 -444
  186. package/src/server/__tests__/server-startup.integration.test.ts +509 -490
  187. package/src/server/__tests__/serverKnowledgeStore.test.ts +174 -173
  188. package/src/server/__tests__/toolRegistration.test.ts +239 -210
  189. package/src/server/__tests__/toolRegistry.test.ts +907 -845
  190. package/src/server/budgetResolver.ts +221 -181
  191. package/src/server/cacheKeys.ts +6 -6
  192. package/src/server/cacheManager.ts +498 -484
  193. package/src/server/completions.ts +267 -243
  194. package/src/server/config.ts +35 -14
  195. package/src/server/deltaCache.merge.ts +146 -128
  196. package/src/server/deltaCache.ts +352 -309
  197. package/src/server/diagnostics.ts +257 -242
  198. package/src/server/errorHandler.ts +747 -744
  199. package/src/server/prompts.ts +181 -176
  200. package/src/server/rateLimiter.ts +131 -129
  201. package/src/server/requestLogger.ts +350 -322
  202. package/src/server/resources.ts +442 -374
  203. package/src/server/responseFormatter.ts +41 -37
  204. package/src/server/securityMiddleware.ts +223 -205
  205. package/src/server/serverKnowledgeStore.ts +67 -67
  206. package/src/server/toolRegistry.ts +508 -474
  207. package/src/tools/CLAUDE.md +604 -0
  208. package/src/tools/__tests__/accountTools.delta.integration.test.ts +128 -111
  209. package/src/tools/__tests__/accountTools.integration.test.ts +129 -111
  210. package/src/tools/__tests__/accountTools.test.ts +685 -638
  211. package/src/tools/__tests__/adapters.test.ts +142 -108
  212. package/src/tools/__tests__/budgetTools.delta.integration.test.ts +73 -73
  213. package/src/tools/__tests__/budgetTools.integration.test.ts +132 -124
  214. package/src/tools/__tests__/budgetTools.test.ts +442 -413
  215. package/src/tools/__tests__/categoryTools.delta.integration.test.ts +76 -68
  216. package/src/tools/__tests__/categoryTools.integration.test.ts +314 -288
  217. package/src/tools/__tests__/categoryTools.test.ts +656 -625
  218. package/src/tools/__tests__/compareTransactions/formatter.test.ts +535 -462
  219. package/src/tools/__tests__/compareTransactions/index.test.ts +378 -358
  220. package/src/tools/__tests__/compareTransactions/matcher.test.ts +497 -398
  221. package/src/tools/__tests__/compareTransactions/parser.test.ts +765 -747
  222. package/src/tools/__tests__/compareTransactions.test.ts +352 -332
  223. package/src/tools/__tests__/compareTransactions.window.test.ts +150 -146
  224. package/src/tools/__tests__/deltaFetcher.scheduled.integration.test.ts +69 -65
  225. package/src/tools/__tests__/deltaFetcher.test.ts +325 -265
  226. package/src/tools/__tests__/deltaSupport.test.ts +211 -184
  227. package/src/tools/__tests__/deltaTestUtils.ts +37 -33
  228. package/src/tools/__tests__/exportTransactions.test.ts +205 -200
  229. package/src/tools/__tests__/monthTools.delta.integration.test.ts +68 -68
  230. package/src/tools/__tests__/monthTools.integration.test.ts +178 -166
  231. package/src/tools/__tests__/monthTools.test.ts +561 -512
  232. package/src/tools/__tests__/payeeTools.delta.integration.test.ts +68 -68
  233. package/src/tools/__tests__/payeeTools.integration.test.ts +158 -142
  234. package/src/tools/__tests__/payeeTools.test.ts +486 -434
  235. package/src/tools/__tests__/transactionSchemas.test.ts +1202 -1186
  236. package/src/tools/__tests__/transactionTools.integration.test.ts +875 -825
  237. package/src/tools/__tests__/transactionTools.test.ts +4923 -4366
  238. package/src/tools/__tests__/transactionUtils.test.ts +1004 -977
  239. package/src/tools/__tests__/utilityTools.integration.test.ts +32 -32
  240. package/src/tools/__tests__/utilityTools.test.ts +68 -58
  241. package/src/tools/accountTools.ts +293 -271
  242. package/src/tools/adapters.ts +120 -63
  243. package/src/tools/budgetTools.ts +121 -116
  244. package/src/tools/categoryTools.ts +379 -339
  245. package/src/tools/compareTransactions/formatter.ts +131 -119
  246. package/src/tools/compareTransactions/index.ts +249 -214
  247. package/src/tools/compareTransactions/matcher.ts +259 -209
  248. package/src/tools/compareTransactions/parser.ts +517 -487
  249. package/src/tools/compareTransactions/types.ts +38 -38
  250. package/src/tools/compareTransactions.ts +1 -1
  251. package/src/tools/deltaFetcher.ts +281 -260
  252. package/src/tools/deltaSupport.ts +264 -259
  253. package/src/tools/exportTransactions.ts +230 -218
  254. package/src/tools/monthTools.ts +180 -165
  255. package/src/tools/payeeTools.ts +152 -140
  256. package/src/tools/reconcileAdapter.ts +297 -252
  257. package/src/tools/reconciliation/CLAUDE.md +506 -0
  258. package/src/tools/reconciliation/__tests__/adapter.causes.test.ts +133 -124
  259. package/src/tools/reconciliation/__tests__/adapter.test.ts +249 -230
  260. package/src/tools/reconciliation/__tests__/analyzer.test.ts +408 -400
  261. package/src/tools/reconciliation/__tests__/csvParser.test.ts +71 -69
  262. package/src/tools/reconciliation/__tests__/executor.integration.test.ts +348 -323
  263. package/src/tools/reconciliation/__tests__/executor.progress.test.ts +503 -457
  264. package/src/tools/reconciliation/__tests__/executor.test.ts +898 -831
  265. package/src/tools/reconciliation/__tests__/matcher.test.ts +667 -663
  266. package/src/tools/reconciliation/__tests__/payeeNormalizer.test.ts +296 -276
  267. package/src/tools/reconciliation/__tests__/recommendationEngine.integration.test.ts +692 -624
  268. package/src/tools/reconciliation/__tests__/recommendationEngine.test.ts +1008 -989
  269. package/src/tools/reconciliation/__tests__/reconciliation.delta.integration.test.ts +187 -146
  270. package/src/tools/reconciliation/__tests__/reportFormatter.test.ts +583 -533
  271. package/src/tools/reconciliation/__tests__/scenarios/adapterCurrency.scenario.test.ts +75 -74
  272. package/src/tools/reconciliation/__tests__/scenarios/extremes.scenario.test.ts +70 -62
  273. package/src/tools/reconciliation/__tests__/scenarios/repeatAmount.scenario.test.ts +102 -88
  274. package/src/tools/reconciliation/__tests__/schemaUrl.test.ts +56 -55
  275. package/src/tools/reconciliation/__tests__/signDetector.test.ts +209 -206
  276. package/src/tools/reconciliation/__tests__/ynabAdapter.test.ts +66 -60
  277. package/src/tools/reconciliation/analyzer.ts +564 -504
  278. package/src/tools/reconciliation/csvParser.ts +656 -609
  279. package/src/tools/reconciliation/executor.ts +1290 -1128
  280. package/src/tools/reconciliation/index.ts +580 -528
  281. package/src/tools/reconciliation/matcher.ts +256 -240
  282. package/src/tools/reconciliation/payeeNormalizer.ts +92 -78
  283. package/src/tools/reconciliation/recommendationEngine.ts +357 -345
  284. package/src/tools/reconciliation/reportFormatter.ts +343 -307
  285. package/src/tools/reconciliation/signDetector.ts +89 -83
  286. package/src/tools/reconciliation/types.ts +164 -159
  287. package/src/tools/reconciliation/ynabAdapter.ts +17 -15
  288. package/src/tools/schemas/CLAUDE.md +546 -0
  289. package/src/tools/schemas/common.ts +1 -1
  290. package/src/tools/schemas/outputs/__tests__/accountOutputs.test.ts +410 -409
  291. package/src/tools/schemas/outputs/__tests__/budgetOutputs.test.ts +305 -299
  292. package/src/tools/schemas/outputs/__tests__/categoryOutputs.test.ts +431 -430
  293. package/src/tools/schemas/outputs/__tests__/comparisonOutputs.test.ts +510 -495
  294. package/src/tools/schemas/outputs/__tests__/dateValidation.test.ts +179 -153
  295. package/src/tools/schemas/outputs/__tests__/discrepancyDirection.test.ts +293 -254
  296. package/src/tools/schemas/outputs/__tests__/monthOutputs.test.ts +457 -457
  297. package/src/tools/schemas/outputs/__tests__/payeeOutputs.test.ts +362 -356
  298. package/src/tools/schemas/outputs/__tests__/reconciliationOutputs.test.ts +402 -399
  299. package/src/tools/schemas/outputs/__tests__/transactionMutationSchemas.test.ts +225 -211
  300. package/src/tools/schemas/outputs/__tests__/transactionOutputs.test.ts +457 -454
  301. package/src/tools/schemas/outputs/__tests__/utilityOutputs.test.ts +316 -315
  302. package/src/tools/schemas/outputs/accountOutputs.ts +40 -34
  303. package/src/tools/schemas/outputs/budgetOutputs.ts +24 -19
  304. package/src/tools/schemas/outputs/categoryOutputs.ts +76 -56
  305. package/src/tools/schemas/outputs/comparisonOutputs.ts +192 -169
  306. package/src/tools/schemas/outputs/index.ts +163 -163
  307. package/src/tools/schemas/outputs/monthOutputs.ts +95 -80
  308. package/src/tools/schemas/outputs/payeeOutputs.ts +18 -18
  309. package/src/tools/schemas/outputs/reconciliationOutputs.ts +386 -373
  310. package/src/tools/schemas/outputs/transactionMutationOutputs.ts +259 -231
  311. package/src/tools/schemas/outputs/transactionOutputs.ts +81 -71
  312. package/src/tools/schemas/outputs/utilityOutputs.ts +90 -84
  313. package/src/tools/schemas/shared/commonOutputs.ts +27 -19
  314. package/src/tools/toolCategories.ts +114 -114
  315. package/src/tools/transactionReadTools.ts +327 -0
  316. package/src/tools/transactionSchemas.ts +322 -291
  317. package/src/tools/transactionTools.ts +84 -2246
  318. package/src/tools/transactionUtils.ts +507 -422
  319. package/src/tools/transactionWriteTools.ts +2110 -0
  320. package/src/tools/utilityTools.ts +46 -41
  321. package/src/types/CLAUDE.md +477 -0
  322. package/src/types/__tests__/index.test.ts +51 -51
  323. package/src/types/index.ts +43 -39
  324. package/src/types/integration-tests.d.ts +26 -26
  325. package/src/types/reconciliation.ts +29 -29
  326. package/src/types/toolAnnotations.ts +30 -30
  327. package/src/types/toolRegistration.ts +43 -32
  328. package/src/utils/CLAUDE.md +508 -0
  329. package/src/utils/__tests__/dateUtils.test.ts +174 -168
  330. package/src/utils/__tests__/money.test.ts +193 -187
  331. package/src/utils/amountUtils.ts +5 -5
  332. package/src/utils/baseError.ts +5 -5
  333. package/src/utils/dateUtils.ts +29 -26
  334. package/src/utils/errors.ts +14 -14
  335. package/src/utils/money.ts +66 -52
  336. package/src/utils/validationError.ts +1 -1
  337. package/tsconfig.json +29 -29
  338. package/tsconfig.prod.json +16 -16
  339. package/vitest-reporters/split-json-reporter.ts +247 -204
  340. package/vitest.config.ts +99 -95
  341. package/.prettierignore +0 -10
  342. package/.prettierrc.json +0 -10
  343. package/eslint.config.js +0 -49
@@ -1,774 +1,961 @@
1
- import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
2
- import { DeltaCache, type DeltaCacheEntry, type Logger } from '../deltaCache.js';
3
- import type { CacheManager } from '../cacheManager.js';
4
- import type { ServerKnowledgeStore } from '../serverKnowledgeStore.js';
1
+ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2
+ import type { CacheManager } from "../cacheManager.js";
3
+ import {
4
+ DeltaCache,
5
+ type DeltaCacheEntry,
6
+ type Logger,
7
+ } from "../deltaCache.js";
8
+ import type { ServerKnowledgeStore } from "../serverKnowledgeStore.js";
5
9
 
6
10
  interface TestEntity {
7
- id: string;
8
- name?: string;
9
- deleted?: boolean;
10
- subtransactions?: TestEntity[];
11
+ id: string;
12
+ name?: string;
13
+ deleted?: boolean;
14
+ subtransactions?: TestEntity[];
11
15
  }
12
16
 
13
17
  interface CacheManagerSpies {
14
- get: ReturnType<typeof vi.fn>;
15
- set: ReturnType<typeof vi.fn>;
16
- deleteByPrefix: ReturnType<typeof vi.fn>;
17
- deleteByBudgetId: ReturnType<typeof vi.fn>;
18
- clear: ReturnType<typeof vi.fn>;
18
+ get: ReturnType<typeof vi.fn>;
19
+ set: ReturnType<typeof vi.fn>;
20
+ deleteByPrefix: ReturnType<typeof vi.fn>;
21
+ deleteByBudgetId: ReturnType<typeof vi.fn>;
22
+ clear: ReturnType<typeof vi.fn>;
19
23
  }
20
24
 
21
25
  interface KnowledgeStoreSpies {
22
- get: ReturnType<typeof vi.fn>;
23
- update: ReturnType<typeof vi.fn>;
24
- reset: ReturnType<typeof vi.fn>;
25
- resetByBudgetId: ReturnType<typeof vi.fn>;
26
+ get: ReturnType<typeof vi.fn>;
27
+ update: ReturnType<typeof vi.fn>;
28
+ reset: ReturnType<typeof vi.fn>;
29
+ resetByBudgetId: ReturnType<typeof vi.fn>;
26
30
  }
27
31
 
28
32
  const createCacheEntry = (
29
- snapshot: TestEntity[] = [{ id: 'snap-1' }],
30
- serverKnowledge = 1000,
31
- ttl = 5000,
33
+ snapshot: TestEntity[] = [{ id: "snap-1" }],
34
+ serverKnowledge = 1000,
35
+ ttl = 5000,
32
36
  ): DeltaCacheEntry<TestEntity> => ({
33
- snapshot,
34
- serverKnowledge,
35
- timestamp: Date.now(),
36
- ttl,
37
+ snapshot,
38
+ serverKnowledge,
39
+ timestamp: Date.now(),
40
+ ttl,
37
41
  });
38
42
 
39
- describe('DeltaCache', () => {
40
- let cacheManagerSpies: CacheManagerSpies;
41
- let knowledgeStoreSpies: KnowledgeStoreSpies;
42
- let loggerSpies: Logger;
43
- let cacheManagerMock: CacheManager;
44
- let knowledgeStoreMock: ServerKnowledgeStore;
45
- let deltaCache: DeltaCache;
46
-
47
- beforeEach(() => {
48
- vi.useFakeTimers({ now: 0 });
49
- cacheManagerSpies = {
50
- get: vi.fn(),
51
- set: vi.fn(),
52
- deleteByPrefix: vi.fn(),
53
- deleteByBudgetId: vi.fn(),
54
- clear: vi.fn(),
55
- };
56
- knowledgeStoreSpies = {
57
- get: vi.fn(),
58
- update: vi.fn(),
59
- reset: vi.fn(),
60
- resetByBudgetId: vi.fn(),
61
- };
62
- loggerSpies = {
63
- info: vi.fn(),
64
- warn: vi.fn(),
65
- error: vi.fn(),
66
- };
67
- cacheManagerMock = cacheManagerSpies as unknown as CacheManager;
68
- knowledgeStoreMock = knowledgeStoreSpies as unknown as ServerKnowledgeStore;
69
- process.env.YNAB_MCP_ENABLE_DELTA = 'true';
70
- deltaCache = new DeltaCache(cacheManagerMock, knowledgeStoreMock, loggerSpies);
71
- });
72
-
73
- afterEach(() => {
74
- vi.useRealTimers();
75
- delete process.env.YNAB_MCP_ENABLE_DELTA;
76
- });
77
-
78
- const createFetcher = (response: { data: TestEntity[]; serverKnowledge: number }) =>
79
- vi.fn().mockResolvedValue(response);
80
-
81
- const createMerger = () =>
82
- vi
83
- .fn<[TestEntity[], TestEntity[], unknown?], TestEntity[]>()
84
- .mockImplementation((snapshot: TestEntity[], delta: TestEntity[]) => [...snapshot, ...delta]);
85
-
86
- describe('Feature Flag', () => {
87
- it('should use delta path when the feature flag is enabled', async () => {
88
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap-1' }], 1000));
89
- knowledgeStoreSpies.get.mockReturnValue(1000);
90
- const fetcher = createFetcher({ data: [{ id: 'delta-1' }], serverKnowledge: 1010 });
91
- const merger = createMerger();
92
-
93
- const result = await deltaCache.fetchWithDelta(
94
- 'transactions:list:budget-1',
95
- 'budget-1',
96
- fetcher,
97
- merger,
98
- { ttl: 5000 },
99
- );
100
-
101
- expect(fetcher).toHaveBeenCalledWith(1000);
102
- expect(merger).toHaveBeenCalledTimes(1);
103
- expect(result.usedDelta).toBe(true);
104
- });
105
-
106
- it('should bypass delta logic when flag is disabled', async () => {
107
- process.env.YNAB_MCP_ENABLE_DELTA = 'false';
108
- cacheManagerSpies.get.mockReturnValue(null); // No cache - force fetch
109
- knowledgeStoreSpies.get.mockReturnValue(1000);
110
- const fetcher = createFetcher({ data: [{ id: 'full' }], serverKnowledge: 1100 });
111
- const merger = createMerger();
112
-
113
- const result = await deltaCache.fetchWithDelta(
114
- 'transactions:list:budget-1',
115
- 'budget-1',
116
- fetcher,
117
- merger,
118
- { ttl: 5000 },
119
- );
120
-
121
- expect(fetcher).toHaveBeenCalledWith(undefined);
122
- expect(merger).not.toHaveBeenCalled();
123
- expect(result.usedDelta).toBe(false);
124
- });
125
-
126
- it('should still cache results when delta is disabled', async () => {
127
- process.env.YNAB_MCP_ENABLE_DELTA = 'false';
128
- const fetcher = createFetcher({ data: [{ id: 'full' }], serverKnowledge: 1100 });
129
- cacheManagerSpies.get.mockReturnValue(null);
130
-
131
- await deltaCache.fetchWithDelta(
132
- 'transactions:list:budget-1',
133
- 'budget-1',
134
- fetcher,
135
- createMerger(),
136
- { ttl: 5000 },
137
- );
138
-
139
- expect(cacheManagerSpies.set).toHaveBeenCalledTimes(1);
140
- const [key, entry] = cacheManagerSpies.set.mock.calls[0];
141
- expect(key).toBe('transactions:list:budget-1');
142
- expect(entry.snapshot).toEqual([{ id: 'full' }]);
143
- });
144
- });
145
-
146
- describe('Delta Detection', () => {
147
- it('should detect delta when server knowledge increases', async () => {
148
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
149
- knowledgeStoreSpies.get.mockReturnValue(1000);
150
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1010 });
151
- const merger = createMerger();
152
-
153
- const result = await deltaCache.fetchWithDelta(
154
- 'transactions:list:budget-1',
155
- 'budget-1',
156
- fetcher,
157
- merger,
158
- { ttl: 5000 },
159
- );
160
-
161
- expect(result.usedDelta).toBe(true);
162
- expect(merger).toHaveBeenCalledWith([{ id: 'snap' }], [{ id: 'delta' }], undefined);
163
- });
164
-
165
- it('should treat response as unchanged when knowledge stays equal', async () => {
166
- const cachedEntry = createCacheEntry([{ id: 'snap' }], 1000);
167
- cacheManagerSpies.get.mockReturnValue(cachedEntry);
168
- knowledgeStoreSpies.get.mockReturnValue(1000);
169
- const fetcher = createFetcher({ data: [], serverKnowledge: 1000 });
170
-
171
- const result = await deltaCache.fetchWithDelta(
172
- 'transactions:list:budget-1',
173
- 'budget-1',
174
- fetcher,
175
- createMerger(),
176
- { ttl: 5000 },
177
- );
178
-
179
- expect(result.data).toEqual([{ id: 'snap' }]);
180
- expect(result.usedDelta).toBe(false);
181
- });
182
-
183
- it('should treat cache miss as full refresh', async () => {
184
- cacheManagerSpies.get.mockReturnValue(null);
185
- knowledgeStoreSpies.get.mockReturnValue(undefined);
186
- const fetcher = createFetcher({
187
- data: [{ id: 'kept' }, { id: 'deleted', deleted: true }],
188
- serverKnowledge: 1050,
189
- });
190
-
191
- const result = await deltaCache.fetchWithDelta(
192
- 'transactions:list:budget-1',
193
- 'budget-1',
194
- fetcher,
195
- createMerger(),
196
- { ttl: 5000 },
197
- );
198
-
199
- expect(result.usedDelta).toBe(false);
200
- expect(result.data).toEqual([{ id: 'kept' }]);
201
- });
202
-
203
- it('should use merger when delta detected and cache exists', async () => {
204
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'a' }], 1000));
205
- knowledgeStoreSpies.get.mockReturnValue(1000);
206
- const fetcher = createFetcher({ data: [{ id: 'b' }], serverKnowledge: 1010 });
207
- const merger = createMerger();
208
- merger.mockReturnValue([{ id: 'a' }, { id: 'b' }]);
209
-
210
- const result = await deltaCache.fetchWithDelta(
211
- 'categories:list:budget-1',
212
- 'budget-1',
213
- fetcher,
214
- merger,
215
- { ttl: 5000 },
216
- );
217
-
218
- expect(merger).toHaveBeenCalledTimes(1);
219
- expect(result.data).toEqual([{ id: 'a' }, { id: 'b' }]);
220
- });
221
-
222
- it('should filter deleted entities on full refresh', async () => {
223
- cacheManagerSpies.get.mockReturnValue(null);
224
- const fetcher = createFetcher({
225
- data: [{ id: '1' }, { id: '2', deleted: true }],
226
- serverKnowledge: 2000,
227
- });
228
-
229
- const result = await deltaCache.fetchWithDelta(
230
- 'payees:list:budget-1',
231
- 'budget-1',
232
- fetcher,
233
- createMerger(),
234
- { ttl: 5000 },
235
- );
236
-
237
- expect(result.data).toEqual([{ id: '1' }]);
238
- expect(result.usedDelta).toBe(false);
239
- });
240
-
241
- it('should handle initial fetch with no cache or knowledge', async () => {
242
- cacheManagerSpies.get.mockReturnValue(null);
243
- knowledgeStoreSpies.get.mockReturnValue(undefined);
244
- const fetcher = createFetcher({ data: [{ id: 'a' }], serverKnowledge: 5 });
245
-
246
- const result = await deltaCache.fetchWithDelta(
247
- 'accounts:list:budget-1',
248
- 'budget-1',
249
- fetcher,
250
- createMerger(),
251
- { ttl: 5000 },
252
- );
253
-
254
- expect(result.wasCached).toBe(false);
255
- expect(result.usedDelta).toBe(false);
256
- expect(result.serverKnowledge).toBe(5);
257
- });
258
- });
259
-
260
- describe('Knowledge Gap Warnings', () => {
261
- it('should log warning when knowledge gap exceeds threshold', async () => {
262
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
263
- knowledgeStoreSpies.get.mockReturnValue(1000);
264
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1205 });
265
-
266
- await deltaCache.fetchWithDelta(
267
- 'transactions:list:budget-1',
268
- 'budget-1',
269
- fetcher,
270
- createMerger(),
271
- { ttl: 5000 },
272
- );
273
-
274
- expect(loggerSpies.warn).toHaveBeenCalledWith(
275
- 'delta-cache.knowledge-gap',
276
- expect.objectContaining({
277
- budgetId: 'budget-1',
278
- lastKnowledge: 1000,
279
- serverKnowledge: 1205,
280
- gap: 205,
281
- }),
282
- );
283
- });
284
-
285
- it('should not log warning when gap is within tolerance', async () => {
286
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
287
- knowledgeStoreSpies.get.mockReturnValue(1000);
288
- const fetcher = createFetcher({ data: [], serverKnowledge: 1050 });
289
-
290
- await deltaCache.fetchWithDelta(
291
- 'transactions:list:budget-1',
292
- 'budget-1',
293
- fetcher,
294
- createMerger(),
295
- { ttl: 5000 },
296
- );
297
-
298
- expect(loggerSpies.warn).not.toHaveBeenCalled();
299
- });
300
-
301
- it('should include cacheKey in warning metadata', async () => {
302
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
303
- knowledgeStoreSpies.get.mockReturnValue(1000);
304
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1155 });
305
-
306
- await deltaCache.fetchWithDelta(
307
- 'payees:list:budget-xyz',
308
- 'budget-xyz',
309
- fetcher,
310
- createMerger(),
311
- {
312
- ttl: 5000,
313
- },
314
- );
315
-
316
- expect(loggerSpies.warn).toHaveBeenCalledWith(
317
- 'delta-cache.knowledge-gap',
318
- expect.objectContaining({
319
- cacheKey: 'payees:list:budget-xyz',
320
- budgetId: 'budget-xyz',
321
- }),
322
- );
323
- });
324
-
325
- it('should continue processing even after warning', async () => {
326
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
327
- knowledgeStoreSpies.get.mockReturnValue(1000);
328
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1300 });
329
-
330
- const result = await deltaCache.fetchWithDelta(
331
- 'transactions:list:budget-1',
332
- 'budget-1',
333
- fetcher,
334
- createMerger(),
335
- { ttl: 5000 },
336
- );
337
-
338
- // When knowledge gap > 100, a full refresh is triggered, so cached snapshot is discarded
339
- expect(result.data).toEqual([{ id: 'delta' }]);
340
- expect(loggerSpies.warn).toHaveBeenCalledWith(
341
- 'delta-cache.knowledge-gap',
342
- expect.objectContaining({
343
- gap: 300,
344
- action: 'full-refresh',
345
- }),
346
- );
347
- });
348
- });
349
-
350
- describe('Cache Operations', () => {
351
- it('should store entries in cache manager format', async () => {
352
- cacheManagerSpies.get.mockReturnValue(null);
353
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 101 });
354
-
355
- await deltaCache.fetchWithDelta(
356
- 'accounts:list:budget-1',
357
- 'budget-1',
358
- fetcher,
359
- createMerger(),
360
- {
361
- ttl: 1234,
362
- },
363
- );
364
-
365
- expect(cacheManagerSpies.set).toHaveBeenCalledWith(
366
- 'accounts:list:budget-1',
367
- expect.objectContaining({
368
- snapshot: [{ id: 'fresh' }],
369
- serverKnowledge: 101,
370
- ttl: 1234,
371
- }),
372
- { ttl: 1234 },
373
- );
374
- });
375
-
376
- it('should update knowledge store after fetch', async () => {
377
- cacheManagerSpies.get.mockReturnValue(null);
378
- const fetcher = createFetcher({ data: [{ id: 'item' }], serverKnowledge: 222 });
379
-
380
- await deltaCache.fetchWithDelta(
381
- 'accounts:list:budget-1',
382
- 'budget-1',
383
- fetcher,
384
- createMerger(),
385
- {
386
- ttl: 5000,
387
- },
388
- );
389
-
390
- expect(knowledgeStoreSpies.update).toHaveBeenCalledWith('accounts:list:budget-1', 222);
391
- });
392
-
393
- it('should return cached data on cache hit', async () => {
394
- const entry = createCacheEntry([{ id: 'cached' }], 333);
395
- cacheManagerSpies.get.mockReturnValue(entry);
396
- knowledgeStoreSpies.get.mockReturnValue(333);
397
- const fetcher = createFetcher({ data: [], serverKnowledge: 333 });
398
-
399
- const result = await deltaCache.fetchWithDelta(
400
- 'accounts:list:budget-1',
401
- 'budget-1',
402
- fetcher,
403
- createMerger(),
404
- { ttl: 5000 },
405
- );
406
-
407
- expect(result.wasCached).toBe(true);
408
- expect(result.data).toEqual([{ id: 'cached' }]);
409
- });
410
-
411
- it('should respect custom TTL overrides', async () => {
412
- cacheManagerSpies.get.mockReturnValue(null);
413
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 400 });
414
-
415
- await deltaCache.fetchWithDelta(
416
- 'accounts:list:budget-1',
417
- 'budget-1',
418
- fetcher,
419
- createMerger(),
420
- {
421
- ttl: 9999,
422
- },
423
- );
424
-
425
- expect(cacheManagerSpies.set).toHaveBeenCalledWith(
426
- 'accounts:list:budget-1',
427
- expect.objectContaining({ ttl: 9999 }),
428
- { ttl: 9999 },
429
- );
430
- });
431
-
432
- it('should use fresh cache but disable delta when forceFullRefresh is true', async () => {
433
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'cached' }], 500));
434
- knowledgeStoreSpies.get.mockReturnValue(500);
435
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 600 });
436
-
437
- const result = await deltaCache.fetchWithDelta(
438
- 'transactions:list:budget-1',
439
- 'budget-1',
440
- fetcher,
441
- createMerger(),
442
- {
443
- ttl: 5000,
444
- forceFullRefresh: true,
445
- },
446
- );
447
-
448
- // forceFullRefresh disables delta merging but still uses fresh cache
449
- expect(result.wasCached).toBe(true);
450
- expect(result.usedDelta).toBe(false);
451
- expect(result.data).toEqual([{ id: 'cached' }]);
452
- expect(fetcher).not.toHaveBeenCalled();
453
- });
454
- });
455
-
456
- describe('Merge Options', () => {
457
- it('should pass merge options to merger', async () => {
458
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'cached' }], 100));
459
- knowledgeStoreSpies.get.mockReturnValue(100);
460
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 200 });
461
- const merger = createMerger();
462
- const mergeOptions = { preserveDeleted: true, equalityFn: vi.fn() };
463
-
464
- await deltaCache.fetchWithDelta('transactions:list:budget-1', 'budget-1', fetcher, merger, {
465
- ttl: 5000,
466
- mergeOptions,
467
- });
468
-
469
- expect(merger).toHaveBeenCalledWith([{ id: 'cached' }], [{ id: 'delta' }], mergeOptions);
470
- });
471
-
472
- it('should allow preserveDeleted to keep deleted entities after merge', async () => {
473
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'cached' }], 100));
474
- knowledgeStoreSpies.get.mockReturnValue(100);
475
- const fetcher = createFetcher({
476
- data: [{ id: 'delta', deleted: true }],
477
- serverKnowledge: 200,
478
- });
479
- const merger = vi.fn().mockReturnValue([{ id: 'cached' }, { id: 'delta', deleted: true }]);
480
-
481
- const result = await deltaCache.fetchWithDelta(
482
- 'transactions:list:budget-1',
483
- 'budget-1',
484
- fetcher,
485
- merger,
486
- {
487
- ttl: 5000,
488
- mergeOptions: { preserveDeleted: true },
489
- },
490
- );
491
-
492
- expect(result.data).toEqual([{ id: 'cached' }, { id: 'delta', deleted: true }]);
493
- });
494
-
495
- it('should support custom equality functions via merge options', async () => {
496
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'cached' }], 100));
497
- knowledgeStoreSpies.get.mockReturnValue(100);
498
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 200 });
499
- const equalityFn = vi.fn();
500
- const merger = createMerger();
501
-
502
- await deltaCache.fetchWithDelta('transactions:list:budget-1', 'budget-1', fetcher, merger, {
503
- ttl: 5000,
504
- mergeOptions: { equalityFn },
505
- });
506
-
507
- expect(merger).toHaveBeenCalledWith(
508
- [{ id: 'cached' }],
509
- [{ id: 'delta' }],
510
- expect.objectContaining({ equalityFn }),
511
- );
512
- });
513
- });
514
-
515
- describe('Invalidation', () => {
516
- it('should delete by prefix when resource type provided', () => {
517
- deltaCache.invalidate('budget-123', 'transactions');
518
- expect(cacheManagerSpies.deleteByPrefix).toHaveBeenCalledWith('transactions:list:budget-123');
519
- });
520
-
521
- it('should delete by budget when resource type omitted', () => {
522
- deltaCache.invalidate('budget-123');
523
- expect(cacheManagerSpies.deleteByBudgetId).toHaveBeenCalledWith('budget-123');
524
- });
525
-
526
- it('should not reset knowledge on invalidate', () => {
527
- deltaCache.invalidate('budget-123');
528
- expect(knowledgeStoreSpies.reset).not.toHaveBeenCalled();
529
- expect(knowledgeStoreSpies.resetByBudgetId).not.toHaveBeenCalled();
530
- });
531
-
532
- it('should reset targeted knowledge during forceFullRefresh', () => {
533
- deltaCache.forceFullRefresh('budget-123', 'transactions');
534
- expect(cacheManagerSpies.deleteByPrefix).toHaveBeenCalledWith('transactions:list:budget-123');
535
- expect(knowledgeStoreSpies.reset).toHaveBeenCalledWith('transactions:list:budget-123');
536
- });
537
-
538
- it('should reset entire budget knowledge on forceFullRefresh without resource type', () => {
539
- deltaCache.forceFullRefresh('budget-123');
540
- expect(knowledgeStoreSpies.resetByBudgetId).toHaveBeenCalledWith('budget-123');
541
- });
542
-
543
- it('should support global forceFullRefresh without budgetId', () => {
544
- deltaCache.forceFullRefresh();
545
- expect(cacheManagerSpies.clear).toHaveBeenCalledTimes(1);
546
- expect(knowledgeStoreSpies.reset).toHaveBeenCalledTimes(1);
547
- });
548
- });
549
-
550
- describe('Error Handling', () => {
551
- it('should propagate fetcher errors without caching', async () => {
552
- cacheManagerSpies.get.mockReturnValue(null);
553
- const fetcher = vi.fn().mockRejectedValue(new Error('API down'));
554
-
555
- await expect(
556
- deltaCache.fetchWithDelta(
557
- 'transactions:list:budget-1',
558
- 'budget-1',
559
- fetcher,
560
- createMerger(),
561
- {
562
- ttl: 5000,
563
- },
564
- ),
565
- ).rejects.toThrow('API down');
566
-
567
- expect(cacheManagerSpies.set).not.toHaveBeenCalled();
568
- expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
569
- });
570
-
571
- it('should propagate merger errors', async () => {
572
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
573
- knowledgeStoreSpies.get.mockReturnValue(1000);
574
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1010 });
575
- const merger = vi.fn().mockImplementation(() => {
576
- throw new Error('merge failed');
577
- });
578
-
579
- await expect(
580
- deltaCache.fetchWithDelta('transactions:list:budget-1', 'budget-1', fetcher, merger, {
581
- ttl: 5000,
582
- }),
583
- ).rejects.toThrow('merge failed');
584
-
585
- expect(cacheManagerSpies.set).not.toHaveBeenCalled();
586
- expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
587
- });
588
-
589
- it('should not cache when fetch fails before delta detection', async () => {
590
- cacheManagerSpies.get.mockReturnValue(null);
591
- const fetcher = vi.fn().mockRejectedValue(new Error('boom'));
592
-
593
- await expect(
594
- deltaCache.fetchWithDelta('accounts:list:budget-1', 'budget-1', fetcher, createMerger(), {
595
- ttl: 5000,
596
- }),
597
- ).rejects.toThrow('boom');
598
-
599
- expect(cacheManagerSpies.set).not.toHaveBeenCalled();
600
- });
601
-
602
- it('should not update knowledge when fetch fails', async () => {
603
- cacheManagerSpies.get.mockReturnValue(null);
604
- const fetcher = vi.fn().mockRejectedValue(new Error('boom'));
605
-
606
- await expect(
607
- deltaCache.fetchWithDelta('accounts:list:budget-1', 'budget-1', fetcher, createMerger(), {
608
- ttl: 5000,
609
- }),
610
- ).rejects.toThrow();
611
-
612
- expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
613
- });
614
- });
615
-
616
- describe('Result Metadata', () => {
617
- it('should mark wasCached true on cache hits', async () => {
618
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
619
- knowledgeStoreSpies.get.mockReturnValue(1000);
620
- const fetcher = createFetcher({ data: [], serverKnowledge: 1000 });
621
-
622
- const result = await deltaCache.fetchWithDelta(
623
- 'accounts:list:budget-1',
624
- 'budget-1',
625
- fetcher,
626
- createMerger(),
627
- { ttl: 5000 },
628
- );
629
-
630
- expect(result.wasCached).toBe(true);
631
- expect(result.usedDelta).toBe(false);
632
- });
633
-
634
- it('should mark wasCached false when cache misses', async () => {
635
- cacheManagerSpies.get.mockReturnValue(null);
636
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 50 });
637
-
638
- const result = await deltaCache.fetchWithDelta(
639
- 'accounts:list:budget-1',
640
- 'budget-1',
641
- fetcher,
642
- createMerger(),
643
- { ttl: 5000 },
644
- );
645
-
646
- expect(result.wasCached).toBe(false);
647
- });
648
-
649
- it('should mark usedDelta true when merge applied', async () => {
650
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
651
- knowledgeStoreSpies.get.mockReturnValue(1000);
652
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1005 });
653
-
654
- const result = await deltaCache.fetchWithDelta(
655
- 'transactions:list:budget-1',
656
- 'budget-1',
657
- fetcher,
658
- createMerger(),
659
- { ttl: 5000 },
660
- );
661
-
662
- expect(result.usedDelta).toBe(true);
663
- });
664
-
665
- it('should mark usedDelta false when no merge happens', async () => {
666
- cacheManagerSpies.get.mockReturnValue(null);
667
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 100 });
668
-
669
- const result = await deltaCache.fetchWithDelta(
670
- 'transactions:list:budget-1',
671
- 'budget-1',
672
- fetcher,
673
- createMerger(),
674
- { ttl: 5000 },
675
- );
676
-
677
- expect(result.usedDelta).toBe(false);
678
- });
679
- });
680
-
681
- describe('Stats tracking', () => {
682
- it('increments deltaHits and mergeOperations when delta merge occurs', async () => {
683
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
684
- knowledgeStoreSpies.get.mockReturnValue(1000);
685
- const fetcher = createFetcher({ data: [{ id: 'delta' }], serverKnowledge: 1005 });
686
- const merger = createMerger();
687
-
688
- await deltaCache.fetchWithDelta('accounts:list:budget-1', 'budget-1', fetcher, merger, {
689
- ttl: 5000,
690
- });
691
-
692
- expect(deltaCache.getStats()).toEqual({
693
- deltaHits: 1,
694
- deltaMisses: 0,
695
- mergeOperations: 1,
696
- knowledgeGapEvents: 0,
697
- });
698
- });
699
-
700
- it('increments deltaMisses when full refresh is required', async () => {
701
- cacheManagerSpies.get.mockReturnValue(null);
702
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 50 });
703
-
704
- await deltaCache.fetchWithDelta(
705
- 'accounts:list:budget-1',
706
- 'budget-1',
707
- fetcher,
708
- createMerger(),
709
- {
710
- ttl: 5000,
711
- },
712
- );
713
-
714
- expect(deltaCache.getStats()).toEqual({
715
- deltaHits: 0,
716
- deltaMisses: 1,
717
- mergeOperations: 0,
718
- knowledgeGapEvents: 0,
719
- });
720
- });
721
-
722
- it('tracks knowledge gap events and treats them as hits', async () => {
723
- cacheManagerSpies.get.mockReturnValue(createCacheEntry([{ id: 'snap' }], 1000));
724
- knowledgeStoreSpies.get.mockReturnValue(1000);
725
- // Two responses required: first triggers gap detection (205 > threshold),
726
- // second is the full refresh that follows gap detection
727
- const fetcher = vi
728
- .fn()
729
- .mockResolvedValueOnce({ data: [{ id: 'delta' }], serverKnowledge: 1205 })
730
- .mockResolvedValueOnce({ data: [{ id: 'full' }], serverKnowledge: 1205 });
731
-
732
- await deltaCache.fetchWithDelta(
733
- 'accounts:list:budget-1',
734
- 'budget-1',
735
- fetcher,
736
- createMerger(),
737
- { ttl: 5000 },
738
- );
739
-
740
- expect(deltaCache.getStats()).toEqual({
741
- deltaHits: 1,
742
- deltaMisses: 0,
743
- mergeOperations: 0,
744
- knowledgeGapEvents: 1,
745
- });
746
- });
747
- });
748
-
749
- describe('TTL Validation', () => {
750
- it('should throw when ttl is missing for fetchWithDelta', async () => {
751
- cacheManagerSpies.get.mockReturnValue(null);
752
- const fetcher = createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 1 });
753
-
754
- await expect(
755
- deltaCache.fetchWithDelta('accounts:list:budget-1', 'budget-1', fetcher, createMerger(), {
756
- ttl: undefined as unknown as number,
757
- }),
758
- ).rejects.toThrow(/finite ttl/i);
759
- });
760
-
761
- it('should throw when ttl is not finite for fetchWithoutDelta', async () => {
762
- const fetchWithoutDelta = (deltaCache as any).fetchWithoutDelta.bind(deltaCache);
763
-
764
- await expect(
765
- fetchWithoutDelta(
766
- 'accounts:list:budget-1',
767
- 'budget-1',
768
- createFetcher({ data: [{ id: 'fresh' }], serverKnowledge: 1 }),
769
- { ttl: Number.POSITIVE_INFINITY },
770
- ),
771
- ).rejects.toThrow(/finite ttl/i);
772
- });
773
- });
43
+ describe("DeltaCache", () => {
44
+ let cacheManagerSpies: CacheManagerSpies;
45
+ let knowledgeStoreSpies: KnowledgeStoreSpies;
46
+ let loggerSpies: Logger;
47
+ let cacheManagerMock: CacheManager;
48
+ let knowledgeStoreMock: ServerKnowledgeStore;
49
+ let deltaCache: DeltaCache;
50
+
51
+ beforeEach(() => {
52
+ vi.useFakeTimers({ now: 0 });
53
+ cacheManagerSpies = {
54
+ get: vi.fn(),
55
+ set: vi.fn(),
56
+ deleteByPrefix: vi.fn(),
57
+ deleteByBudgetId: vi.fn(),
58
+ clear: vi.fn(),
59
+ };
60
+ knowledgeStoreSpies = {
61
+ get: vi.fn(),
62
+ update: vi.fn(),
63
+ reset: vi.fn(),
64
+ resetByBudgetId: vi.fn(),
65
+ };
66
+ loggerSpies = {
67
+ info: vi.fn(),
68
+ warn: vi.fn(),
69
+ error: vi.fn(),
70
+ };
71
+ cacheManagerMock = cacheManagerSpies as unknown as CacheManager;
72
+ knowledgeStoreMock = knowledgeStoreSpies as unknown as ServerKnowledgeStore;
73
+ process.env.YNAB_MCP_ENABLE_DELTA = "true";
74
+ deltaCache = new DeltaCache(
75
+ cacheManagerMock,
76
+ knowledgeStoreMock,
77
+ loggerSpies,
78
+ );
79
+ });
80
+
81
+ afterEach(() => {
82
+ vi.useRealTimers();
83
+ process.env.YNAB_MCP_ENABLE_DELTA = undefined;
84
+ });
85
+
86
+ const createFetcher = (response: {
87
+ data: TestEntity[];
88
+ serverKnowledge: number;
89
+ }) => vi.fn().mockResolvedValue(response);
90
+
91
+ const createMerger = () =>
92
+ vi
93
+ .fn<[TestEntity[], TestEntity[], unknown?], TestEntity[]>()
94
+ .mockImplementation((snapshot: TestEntity[], delta: TestEntity[]) => [
95
+ ...snapshot,
96
+ ...delta,
97
+ ]);
98
+
99
+ describe("Feature Flag", () => {
100
+ it("should use delta path when the feature flag is enabled", async () => {
101
+ cacheManagerSpies.get.mockReturnValue(
102
+ createCacheEntry([{ id: "snap-1" }], 1000),
103
+ );
104
+ knowledgeStoreSpies.get.mockReturnValue(1000);
105
+ const fetcher = createFetcher({
106
+ data: [{ id: "delta-1" }],
107
+ serverKnowledge: 1010,
108
+ });
109
+ const merger = createMerger();
110
+
111
+ const result = await deltaCache.fetchWithDelta(
112
+ "transactions:list:budget-1",
113
+ "budget-1",
114
+ fetcher,
115
+ merger,
116
+ { ttl: 5000 },
117
+ );
118
+
119
+ expect(fetcher).toHaveBeenCalledWith(1000);
120
+ expect(merger).toHaveBeenCalledTimes(1);
121
+ expect(result.usedDelta).toBe(true);
122
+ });
123
+
124
+ it("should bypass delta logic when flag is disabled", async () => {
125
+ process.env.YNAB_MCP_ENABLE_DELTA = "false";
126
+ cacheManagerSpies.get.mockReturnValue(null); // No cache - force fetch
127
+ knowledgeStoreSpies.get.mockReturnValue(1000);
128
+ const fetcher = createFetcher({
129
+ data: [{ id: "full" }],
130
+ serverKnowledge: 1100,
131
+ });
132
+ const merger = createMerger();
133
+
134
+ const result = await deltaCache.fetchWithDelta(
135
+ "transactions:list:budget-1",
136
+ "budget-1",
137
+ fetcher,
138
+ merger,
139
+ { ttl: 5000 },
140
+ );
141
+
142
+ expect(fetcher).toHaveBeenCalledWith(undefined);
143
+ expect(merger).not.toHaveBeenCalled();
144
+ expect(result.usedDelta).toBe(false);
145
+ });
146
+
147
+ it("should still cache results when delta is disabled", async () => {
148
+ process.env.YNAB_MCP_ENABLE_DELTA = "false";
149
+ const fetcher = createFetcher({
150
+ data: [{ id: "full" }],
151
+ serverKnowledge: 1100,
152
+ });
153
+ cacheManagerSpies.get.mockReturnValue(null);
154
+
155
+ await deltaCache.fetchWithDelta(
156
+ "transactions:list:budget-1",
157
+ "budget-1",
158
+ fetcher,
159
+ createMerger(),
160
+ { ttl: 5000 },
161
+ );
162
+
163
+ expect(cacheManagerSpies.set).toHaveBeenCalledTimes(1);
164
+ const [key, entry] = cacheManagerSpies.set.mock.calls[0];
165
+ expect(key).toBe("transactions:list:budget-1");
166
+ expect(entry.snapshot).toEqual([{ id: "full" }]);
167
+ });
168
+ });
169
+
170
+ describe("Delta Detection", () => {
171
+ it("should detect delta when server knowledge increases", async () => {
172
+ cacheManagerSpies.get.mockReturnValue(
173
+ createCacheEntry([{ id: "snap" }], 1000),
174
+ );
175
+ knowledgeStoreSpies.get.mockReturnValue(1000);
176
+ const fetcher = createFetcher({
177
+ data: [{ id: "delta" }],
178
+ serverKnowledge: 1010,
179
+ });
180
+ const merger = createMerger();
181
+
182
+ const result = await deltaCache.fetchWithDelta(
183
+ "transactions:list:budget-1",
184
+ "budget-1",
185
+ fetcher,
186
+ merger,
187
+ { ttl: 5000 },
188
+ );
189
+
190
+ expect(result.usedDelta).toBe(true);
191
+ expect(merger).toHaveBeenCalledWith(
192
+ [{ id: "snap" }],
193
+ [{ id: "delta" }],
194
+ undefined,
195
+ );
196
+ });
197
+
198
+ it("should treat response as unchanged when knowledge stays equal", async () => {
199
+ const cachedEntry = createCacheEntry([{ id: "snap" }], 1000);
200
+ cacheManagerSpies.get.mockReturnValue(cachedEntry);
201
+ knowledgeStoreSpies.get.mockReturnValue(1000);
202
+ const fetcher = createFetcher({ data: [], serverKnowledge: 1000 });
203
+
204
+ const result = await deltaCache.fetchWithDelta(
205
+ "transactions:list:budget-1",
206
+ "budget-1",
207
+ fetcher,
208
+ createMerger(),
209
+ { ttl: 5000 },
210
+ );
211
+
212
+ expect(result.data).toEqual([{ id: "snap" }]);
213
+ expect(result.usedDelta).toBe(false);
214
+ });
215
+
216
+ it("should treat cache miss as full refresh", async () => {
217
+ cacheManagerSpies.get.mockReturnValue(null);
218
+ knowledgeStoreSpies.get.mockReturnValue(undefined);
219
+ const fetcher = createFetcher({
220
+ data: [{ id: "kept" }, { id: "deleted", deleted: true }],
221
+ serverKnowledge: 1050,
222
+ });
223
+
224
+ const result = await deltaCache.fetchWithDelta(
225
+ "transactions:list:budget-1",
226
+ "budget-1",
227
+ fetcher,
228
+ createMerger(),
229
+ { ttl: 5000 },
230
+ );
231
+
232
+ expect(result.usedDelta).toBe(false);
233
+ expect(result.data).toEqual([{ id: "kept" }]);
234
+ });
235
+
236
+ it("should use merger when delta detected and cache exists", async () => {
237
+ cacheManagerSpies.get.mockReturnValue(
238
+ createCacheEntry([{ id: "a" }], 1000),
239
+ );
240
+ knowledgeStoreSpies.get.mockReturnValue(1000);
241
+ const fetcher = createFetcher({
242
+ data: [{ id: "b" }],
243
+ serverKnowledge: 1010,
244
+ });
245
+ const merger = createMerger();
246
+ merger.mockReturnValue([{ id: "a" }, { id: "b" }]);
247
+
248
+ const result = await deltaCache.fetchWithDelta(
249
+ "categories:list:budget-1",
250
+ "budget-1",
251
+ fetcher,
252
+ merger,
253
+ { ttl: 5000 },
254
+ );
255
+
256
+ expect(merger).toHaveBeenCalledTimes(1);
257
+ expect(result.data).toEqual([{ id: "a" }, { id: "b" }]);
258
+ });
259
+
260
+ it("should filter deleted entities on full refresh", async () => {
261
+ cacheManagerSpies.get.mockReturnValue(null);
262
+ const fetcher = createFetcher({
263
+ data: [{ id: "1" }, { id: "2", deleted: true }],
264
+ serverKnowledge: 2000,
265
+ });
266
+
267
+ const result = await deltaCache.fetchWithDelta(
268
+ "payees:list:budget-1",
269
+ "budget-1",
270
+ fetcher,
271
+ createMerger(),
272
+ { ttl: 5000 },
273
+ );
274
+
275
+ expect(result.data).toEqual([{ id: "1" }]);
276
+ expect(result.usedDelta).toBe(false);
277
+ });
278
+
279
+ it("should handle initial fetch with no cache or knowledge", async () => {
280
+ cacheManagerSpies.get.mockReturnValue(null);
281
+ knowledgeStoreSpies.get.mockReturnValue(undefined);
282
+ const fetcher = createFetcher({
283
+ data: [{ id: "a" }],
284
+ serverKnowledge: 5,
285
+ });
286
+
287
+ const result = await deltaCache.fetchWithDelta(
288
+ "accounts:list:budget-1",
289
+ "budget-1",
290
+ fetcher,
291
+ createMerger(),
292
+ { ttl: 5000 },
293
+ );
294
+
295
+ expect(result.wasCached).toBe(false);
296
+ expect(result.usedDelta).toBe(false);
297
+ expect(result.serverKnowledge).toBe(5);
298
+ });
299
+ });
300
+
301
+ describe("Knowledge Gap Warnings", () => {
302
+ it("should log warning when knowledge gap exceeds threshold", async () => {
303
+ cacheManagerSpies.get.mockReturnValue(
304
+ createCacheEntry([{ id: "snap" }], 1000),
305
+ );
306
+ knowledgeStoreSpies.get.mockReturnValue(1000);
307
+ const fetcher = createFetcher({
308
+ data: [{ id: "delta" }],
309
+ serverKnowledge: 1205,
310
+ });
311
+
312
+ await deltaCache.fetchWithDelta(
313
+ "transactions:list:budget-1",
314
+ "budget-1",
315
+ fetcher,
316
+ createMerger(),
317
+ { ttl: 5000 },
318
+ );
319
+
320
+ expect(loggerSpies.warn).toHaveBeenCalledWith(
321
+ "delta-cache.knowledge-gap",
322
+ expect.objectContaining({
323
+ budgetId: "budget-1",
324
+ lastKnowledge: 1000,
325
+ serverKnowledge: 1205,
326
+ gap: 205,
327
+ }),
328
+ );
329
+ });
330
+
331
+ it("should not log warning when gap is within tolerance", async () => {
332
+ cacheManagerSpies.get.mockReturnValue(
333
+ createCacheEntry([{ id: "snap" }], 1000),
334
+ );
335
+ knowledgeStoreSpies.get.mockReturnValue(1000);
336
+ const fetcher = createFetcher({ data: [], serverKnowledge: 1050 });
337
+
338
+ await deltaCache.fetchWithDelta(
339
+ "transactions:list:budget-1",
340
+ "budget-1",
341
+ fetcher,
342
+ createMerger(),
343
+ { ttl: 5000 },
344
+ );
345
+
346
+ expect(loggerSpies.warn).not.toHaveBeenCalled();
347
+ });
348
+
349
+ it("should include cacheKey in warning metadata", async () => {
350
+ cacheManagerSpies.get.mockReturnValue(
351
+ createCacheEntry([{ id: "snap" }], 1000),
352
+ );
353
+ knowledgeStoreSpies.get.mockReturnValue(1000);
354
+ const fetcher = createFetcher({
355
+ data: [{ id: "delta" }],
356
+ serverKnowledge: 1155,
357
+ });
358
+
359
+ await deltaCache.fetchWithDelta(
360
+ "payees:list:budget-xyz",
361
+ "budget-xyz",
362
+ fetcher,
363
+ createMerger(),
364
+ {
365
+ ttl: 5000,
366
+ },
367
+ );
368
+
369
+ expect(loggerSpies.warn).toHaveBeenCalledWith(
370
+ "delta-cache.knowledge-gap",
371
+ expect.objectContaining({
372
+ cacheKey: "payees:list:budget-xyz",
373
+ budgetId: "budget-xyz",
374
+ }),
375
+ );
376
+ });
377
+
378
+ it("should continue processing even after warning", async () => {
379
+ cacheManagerSpies.get.mockReturnValue(
380
+ createCacheEntry([{ id: "snap" }], 1000),
381
+ );
382
+ knowledgeStoreSpies.get.mockReturnValue(1000);
383
+ const fetcher = createFetcher({
384
+ data: [{ id: "delta" }],
385
+ serverKnowledge: 1300,
386
+ });
387
+
388
+ const result = await deltaCache.fetchWithDelta(
389
+ "transactions:list:budget-1",
390
+ "budget-1",
391
+ fetcher,
392
+ createMerger(),
393
+ { ttl: 5000 },
394
+ );
395
+
396
+ // When knowledge gap > 100, a full refresh is triggered, so cached snapshot is discarded
397
+ expect(result.data).toEqual([{ id: "delta" }]);
398
+ expect(loggerSpies.warn).toHaveBeenCalledWith(
399
+ "delta-cache.knowledge-gap",
400
+ expect.objectContaining({
401
+ gap: 300,
402
+ action: "full-refresh",
403
+ }),
404
+ );
405
+ });
406
+ });
407
+
408
+ describe("Cache Operations", () => {
409
+ it("should store entries in cache manager format", async () => {
410
+ cacheManagerSpies.get.mockReturnValue(null);
411
+ const fetcher = createFetcher({
412
+ data: [{ id: "fresh" }],
413
+ serverKnowledge: 101,
414
+ });
415
+
416
+ await deltaCache.fetchWithDelta(
417
+ "accounts:list:budget-1",
418
+ "budget-1",
419
+ fetcher,
420
+ createMerger(),
421
+ {
422
+ ttl: 1234,
423
+ },
424
+ );
425
+
426
+ expect(cacheManagerSpies.set).toHaveBeenCalledWith(
427
+ "accounts:list:budget-1",
428
+ expect.objectContaining({
429
+ snapshot: [{ id: "fresh" }],
430
+ serverKnowledge: 101,
431
+ ttl: 1234,
432
+ }),
433
+ { ttl: 1234 },
434
+ );
435
+ });
436
+
437
+ it("should update knowledge store after fetch", async () => {
438
+ cacheManagerSpies.get.mockReturnValue(null);
439
+ const fetcher = createFetcher({
440
+ data: [{ id: "item" }],
441
+ serverKnowledge: 222,
442
+ });
443
+
444
+ await deltaCache.fetchWithDelta(
445
+ "accounts:list:budget-1",
446
+ "budget-1",
447
+ fetcher,
448
+ createMerger(),
449
+ {
450
+ ttl: 5000,
451
+ },
452
+ );
453
+
454
+ expect(knowledgeStoreSpies.update).toHaveBeenCalledWith(
455
+ "accounts:list:budget-1",
456
+ 222,
457
+ );
458
+ });
459
+
460
+ it("should return cached data on cache hit", async () => {
461
+ const entry = createCacheEntry([{ id: "cached" }], 333);
462
+ cacheManagerSpies.get.mockReturnValue(entry);
463
+ knowledgeStoreSpies.get.mockReturnValue(333);
464
+ const fetcher = createFetcher({ data: [], serverKnowledge: 333 });
465
+
466
+ const result = await deltaCache.fetchWithDelta(
467
+ "accounts:list:budget-1",
468
+ "budget-1",
469
+ fetcher,
470
+ createMerger(),
471
+ { ttl: 5000 },
472
+ );
473
+
474
+ expect(result.wasCached).toBe(true);
475
+ expect(result.data).toEqual([{ id: "cached" }]);
476
+ });
477
+
478
+ it("should respect custom TTL overrides", async () => {
479
+ cacheManagerSpies.get.mockReturnValue(null);
480
+ const fetcher = createFetcher({
481
+ data: [{ id: "fresh" }],
482
+ serverKnowledge: 400,
483
+ });
484
+
485
+ await deltaCache.fetchWithDelta(
486
+ "accounts:list:budget-1",
487
+ "budget-1",
488
+ fetcher,
489
+ createMerger(),
490
+ {
491
+ ttl: 9999,
492
+ },
493
+ );
494
+
495
+ expect(cacheManagerSpies.set).toHaveBeenCalledWith(
496
+ "accounts:list:budget-1",
497
+ expect.objectContaining({ ttl: 9999 }),
498
+ { ttl: 9999 },
499
+ );
500
+ });
501
+
502
+ it("should use fresh cache but disable delta when forceFullRefresh is true", async () => {
503
+ cacheManagerSpies.get.mockReturnValue(
504
+ createCacheEntry([{ id: "cached" }], 500),
505
+ );
506
+ knowledgeStoreSpies.get.mockReturnValue(500);
507
+ const fetcher = createFetcher({
508
+ data: [{ id: "fresh" }],
509
+ serverKnowledge: 600,
510
+ });
511
+
512
+ const result = await deltaCache.fetchWithDelta(
513
+ "transactions:list:budget-1",
514
+ "budget-1",
515
+ fetcher,
516
+ createMerger(),
517
+ {
518
+ ttl: 5000,
519
+ forceFullRefresh: true,
520
+ },
521
+ );
522
+
523
+ // forceFullRefresh disables delta merging but still uses fresh cache
524
+ expect(result.wasCached).toBe(true);
525
+ expect(result.usedDelta).toBe(false);
526
+ expect(result.data).toEqual([{ id: "cached" }]);
527
+ expect(fetcher).not.toHaveBeenCalled();
528
+ });
529
+ });
530
+
531
+ describe("Merge Options", () => {
532
+ it("should pass merge options to merger", async () => {
533
+ cacheManagerSpies.get.mockReturnValue(
534
+ createCacheEntry([{ id: "cached" }], 100),
535
+ );
536
+ knowledgeStoreSpies.get.mockReturnValue(100);
537
+ const fetcher = createFetcher({
538
+ data: [{ id: "delta" }],
539
+ serverKnowledge: 200,
540
+ });
541
+ const merger = createMerger();
542
+ const mergeOptions = { preserveDeleted: true, equalityFn: vi.fn() };
543
+
544
+ await deltaCache.fetchWithDelta(
545
+ "transactions:list:budget-1",
546
+ "budget-1",
547
+ fetcher,
548
+ merger,
549
+ {
550
+ ttl: 5000,
551
+ mergeOptions,
552
+ },
553
+ );
554
+
555
+ expect(merger).toHaveBeenCalledWith(
556
+ [{ id: "cached" }],
557
+ [{ id: "delta" }],
558
+ mergeOptions,
559
+ );
560
+ });
561
+
562
+ it("should allow preserveDeleted to keep deleted entities after merge", async () => {
563
+ cacheManagerSpies.get.mockReturnValue(
564
+ createCacheEntry([{ id: "cached" }], 100),
565
+ );
566
+ knowledgeStoreSpies.get.mockReturnValue(100);
567
+ const fetcher = createFetcher({
568
+ data: [{ id: "delta", deleted: true }],
569
+ serverKnowledge: 200,
570
+ });
571
+ const merger = vi
572
+ .fn()
573
+ .mockReturnValue([{ id: "cached" }, { id: "delta", deleted: true }]);
574
+
575
+ const result = await deltaCache.fetchWithDelta(
576
+ "transactions:list:budget-1",
577
+ "budget-1",
578
+ fetcher,
579
+ merger,
580
+ {
581
+ ttl: 5000,
582
+ mergeOptions: { preserveDeleted: true },
583
+ },
584
+ );
585
+
586
+ expect(result.data).toEqual([
587
+ { id: "cached" },
588
+ { id: "delta", deleted: true },
589
+ ]);
590
+ });
591
+
592
+ it("should support custom equality functions via merge options", async () => {
593
+ cacheManagerSpies.get.mockReturnValue(
594
+ createCacheEntry([{ id: "cached" }], 100),
595
+ );
596
+ knowledgeStoreSpies.get.mockReturnValue(100);
597
+ const fetcher = createFetcher({
598
+ data: [{ id: "delta" }],
599
+ serverKnowledge: 200,
600
+ });
601
+ const equalityFn = vi.fn();
602
+ const merger = createMerger();
603
+
604
+ await deltaCache.fetchWithDelta(
605
+ "transactions:list:budget-1",
606
+ "budget-1",
607
+ fetcher,
608
+ merger,
609
+ {
610
+ ttl: 5000,
611
+ mergeOptions: { equalityFn },
612
+ },
613
+ );
614
+
615
+ expect(merger).toHaveBeenCalledWith(
616
+ [{ id: "cached" }],
617
+ [{ id: "delta" }],
618
+ expect.objectContaining({ equalityFn }),
619
+ );
620
+ });
621
+ });
622
+
623
+ describe("Invalidation", () => {
624
+ it("should delete by prefix when resource type provided", () => {
625
+ deltaCache.invalidate("budget-123", "transactions");
626
+ expect(cacheManagerSpies.deleteByPrefix).toHaveBeenCalledWith(
627
+ "transactions:list:budget-123",
628
+ );
629
+ });
630
+
631
+ it("should delete by budget when resource type omitted", () => {
632
+ deltaCache.invalidate("budget-123");
633
+ expect(cacheManagerSpies.deleteByBudgetId).toHaveBeenCalledWith(
634
+ "budget-123",
635
+ );
636
+ });
637
+
638
+ it("should not reset knowledge on invalidate", () => {
639
+ deltaCache.invalidate("budget-123");
640
+ expect(knowledgeStoreSpies.reset).not.toHaveBeenCalled();
641
+ expect(knowledgeStoreSpies.resetByBudgetId).not.toHaveBeenCalled();
642
+ });
643
+
644
+ it("should reset targeted knowledge during forceFullRefresh", () => {
645
+ deltaCache.forceFullRefresh("budget-123", "transactions");
646
+ expect(cacheManagerSpies.deleteByPrefix).toHaveBeenCalledWith(
647
+ "transactions:list:budget-123",
648
+ );
649
+ expect(knowledgeStoreSpies.reset).toHaveBeenCalledWith(
650
+ "transactions:list:budget-123",
651
+ );
652
+ });
653
+
654
+ it("should reset entire budget knowledge on forceFullRefresh without resource type", () => {
655
+ deltaCache.forceFullRefresh("budget-123");
656
+ expect(knowledgeStoreSpies.resetByBudgetId).toHaveBeenCalledWith(
657
+ "budget-123",
658
+ );
659
+ });
660
+
661
+ it("should support global forceFullRefresh without budgetId", () => {
662
+ deltaCache.forceFullRefresh();
663
+ expect(cacheManagerSpies.clear).toHaveBeenCalledTimes(1);
664
+ expect(knowledgeStoreSpies.reset).toHaveBeenCalledTimes(1);
665
+ });
666
+ });
667
+
668
+ describe("Error Handling", () => {
669
+ it("should propagate fetcher errors without caching", async () => {
670
+ cacheManagerSpies.get.mockReturnValue(null);
671
+ const fetcher = vi.fn().mockRejectedValue(new Error("API down"));
672
+
673
+ await expect(
674
+ deltaCache.fetchWithDelta(
675
+ "transactions:list:budget-1",
676
+ "budget-1",
677
+ fetcher,
678
+ createMerger(),
679
+ {
680
+ ttl: 5000,
681
+ },
682
+ ),
683
+ ).rejects.toThrow("API down");
684
+
685
+ expect(cacheManagerSpies.set).not.toHaveBeenCalled();
686
+ expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
687
+ });
688
+
689
+ it("should propagate merger errors", async () => {
690
+ cacheManagerSpies.get.mockReturnValue(
691
+ createCacheEntry([{ id: "snap" }], 1000),
692
+ );
693
+ knowledgeStoreSpies.get.mockReturnValue(1000);
694
+ const fetcher = createFetcher({
695
+ data: [{ id: "delta" }],
696
+ serverKnowledge: 1010,
697
+ });
698
+ const merger = vi.fn().mockImplementation(() => {
699
+ throw new Error("merge failed");
700
+ });
701
+
702
+ await expect(
703
+ deltaCache.fetchWithDelta(
704
+ "transactions:list:budget-1",
705
+ "budget-1",
706
+ fetcher,
707
+ merger,
708
+ {
709
+ ttl: 5000,
710
+ },
711
+ ),
712
+ ).rejects.toThrow("merge failed");
713
+
714
+ expect(cacheManagerSpies.set).not.toHaveBeenCalled();
715
+ expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
716
+ });
717
+
718
+ it("should not cache when fetch fails before delta detection", async () => {
719
+ cacheManagerSpies.get.mockReturnValue(null);
720
+ const fetcher = vi.fn().mockRejectedValue(new Error("boom"));
721
+
722
+ await expect(
723
+ deltaCache.fetchWithDelta(
724
+ "accounts:list:budget-1",
725
+ "budget-1",
726
+ fetcher,
727
+ createMerger(),
728
+ {
729
+ ttl: 5000,
730
+ },
731
+ ),
732
+ ).rejects.toThrow("boom");
733
+
734
+ expect(cacheManagerSpies.set).not.toHaveBeenCalled();
735
+ });
736
+
737
+ it("should not update knowledge when fetch fails", async () => {
738
+ cacheManagerSpies.get.mockReturnValue(null);
739
+ const fetcher = vi.fn().mockRejectedValue(new Error("boom"));
740
+
741
+ await expect(
742
+ deltaCache.fetchWithDelta(
743
+ "accounts:list:budget-1",
744
+ "budget-1",
745
+ fetcher,
746
+ createMerger(),
747
+ {
748
+ ttl: 5000,
749
+ },
750
+ ),
751
+ ).rejects.toThrow();
752
+
753
+ expect(knowledgeStoreSpies.update).not.toHaveBeenCalled();
754
+ });
755
+ });
756
+
757
+ describe("Result Metadata", () => {
758
+ it("should mark wasCached true on cache hits", async () => {
759
+ cacheManagerSpies.get.mockReturnValue(
760
+ createCacheEntry([{ id: "snap" }], 1000),
761
+ );
762
+ knowledgeStoreSpies.get.mockReturnValue(1000);
763
+ const fetcher = createFetcher({ data: [], serverKnowledge: 1000 });
764
+
765
+ const result = await deltaCache.fetchWithDelta(
766
+ "accounts:list:budget-1",
767
+ "budget-1",
768
+ fetcher,
769
+ createMerger(),
770
+ { ttl: 5000 },
771
+ );
772
+
773
+ expect(result.wasCached).toBe(true);
774
+ expect(result.usedDelta).toBe(false);
775
+ });
776
+
777
+ it("should mark wasCached false when cache misses", async () => {
778
+ cacheManagerSpies.get.mockReturnValue(null);
779
+ const fetcher = createFetcher({
780
+ data: [{ id: "fresh" }],
781
+ serverKnowledge: 50,
782
+ });
783
+
784
+ const result = await deltaCache.fetchWithDelta(
785
+ "accounts:list:budget-1",
786
+ "budget-1",
787
+ fetcher,
788
+ createMerger(),
789
+ { ttl: 5000 },
790
+ );
791
+
792
+ expect(result.wasCached).toBe(false);
793
+ });
794
+
795
+ it("should mark usedDelta true when merge applied", async () => {
796
+ cacheManagerSpies.get.mockReturnValue(
797
+ createCacheEntry([{ id: "snap" }], 1000),
798
+ );
799
+ knowledgeStoreSpies.get.mockReturnValue(1000);
800
+ const fetcher = createFetcher({
801
+ data: [{ id: "delta" }],
802
+ serverKnowledge: 1005,
803
+ });
804
+
805
+ const result = await deltaCache.fetchWithDelta(
806
+ "transactions:list:budget-1",
807
+ "budget-1",
808
+ fetcher,
809
+ createMerger(),
810
+ { ttl: 5000 },
811
+ );
812
+
813
+ expect(result.usedDelta).toBe(true);
814
+ });
815
+
816
+ it("should mark usedDelta false when no merge happens", async () => {
817
+ cacheManagerSpies.get.mockReturnValue(null);
818
+ const fetcher = createFetcher({
819
+ data: [{ id: "fresh" }],
820
+ serverKnowledge: 100,
821
+ });
822
+
823
+ const result = await deltaCache.fetchWithDelta(
824
+ "transactions:list:budget-1",
825
+ "budget-1",
826
+ fetcher,
827
+ createMerger(),
828
+ { ttl: 5000 },
829
+ );
830
+
831
+ expect(result.usedDelta).toBe(false);
832
+ });
833
+ });
834
+
835
+ describe("Stats tracking", () => {
836
+ it("increments deltaHits and mergeOperations when delta merge occurs", async () => {
837
+ cacheManagerSpies.get.mockReturnValue(
838
+ createCacheEntry([{ id: "snap" }], 1000),
839
+ );
840
+ knowledgeStoreSpies.get.mockReturnValue(1000);
841
+ const fetcher = createFetcher({
842
+ data: [{ id: "delta" }],
843
+ serverKnowledge: 1005,
844
+ });
845
+ const merger = createMerger();
846
+
847
+ await deltaCache.fetchWithDelta(
848
+ "accounts:list:budget-1",
849
+ "budget-1",
850
+ fetcher,
851
+ merger,
852
+ {
853
+ ttl: 5000,
854
+ },
855
+ );
856
+
857
+ expect(deltaCache.getStats()).toEqual({
858
+ deltaHits: 1,
859
+ deltaMisses: 0,
860
+ mergeOperations: 1,
861
+ knowledgeGapEvents: 0,
862
+ });
863
+ });
864
+
865
+ it("increments deltaMisses when full refresh is required", async () => {
866
+ cacheManagerSpies.get.mockReturnValue(null);
867
+ const fetcher = createFetcher({
868
+ data: [{ id: "fresh" }],
869
+ serverKnowledge: 50,
870
+ });
871
+
872
+ await deltaCache.fetchWithDelta(
873
+ "accounts:list:budget-1",
874
+ "budget-1",
875
+ fetcher,
876
+ createMerger(),
877
+ {
878
+ ttl: 5000,
879
+ },
880
+ );
881
+
882
+ expect(deltaCache.getStats()).toEqual({
883
+ deltaHits: 0,
884
+ deltaMisses: 1,
885
+ mergeOperations: 0,
886
+ knowledgeGapEvents: 0,
887
+ });
888
+ });
889
+
890
+ it("tracks knowledge gap events and treats them as hits", async () => {
891
+ cacheManagerSpies.get.mockReturnValue(
892
+ createCacheEntry([{ id: "snap" }], 1000),
893
+ );
894
+ knowledgeStoreSpies.get.mockReturnValue(1000);
895
+ // Two responses required: first triggers gap detection (205 > threshold),
896
+ // second is the full refresh that follows gap detection
897
+ const fetcher = vi
898
+ .fn()
899
+ .mockResolvedValueOnce({
900
+ data: [{ id: "delta" }],
901
+ serverKnowledge: 1205,
902
+ })
903
+ .mockResolvedValueOnce({
904
+ data: [{ id: "full" }],
905
+ serverKnowledge: 1205,
906
+ });
907
+
908
+ await deltaCache.fetchWithDelta(
909
+ "accounts:list:budget-1",
910
+ "budget-1",
911
+ fetcher,
912
+ createMerger(),
913
+ { ttl: 5000 },
914
+ );
915
+
916
+ expect(deltaCache.getStats()).toEqual({
917
+ deltaHits: 1,
918
+ deltaMisses: 0,
919
+ mergeOperations: 0,
920
+ knowledgeGapEvents: 1,
921
+ });
922
+ });
923
+ });
924
+
925
+ describe("TTL Validation", () => {
926
+ it("should throw when ttl is missing for fetchWithDelta", async () => {
927
+ cacheManagerSpies.get.mockReturnValue(null);
928
+ const fetcher = createFetcher({
929
+ data: [{ id: "fresh" }],
930
+ serverKnowledge: 1,
931
+ });
932
+
933
+ await expect(
934
+ deltaCache.fetchWithDelta(
935
+ "accounts:list:budget-1",
936
+ "budget-1",
937
+ fetcher,
938
+ createMerger(),
939
+ {
940
+ ttl: undefined as unknown as number,
941
+ },
942
+ ),
943
+ ).rejects.toThrow(/finite ttl/i);
944
+ });
945
+
946
+ it("should throw when ttl is not finite for fetchWithoutDelta", async () => {
947
+ const fetchWithoutDelta = (deltaCache as any).fetchWithoutDelta.bind(
948
+ deltaCache,
949
+ );
950
+
951
+ await expect(
952
+ fetchWithoutDelta(
953
+ "accounts:list:budget-1",
954
+ "budget-1",
955
+ createFetcher({ data: [{ id: "fresh" }], serverKnowledge: 1 }),
956
+ { ttl: Number.POSITIVE_INFINITY },
957
+ ),
958
+ ).rejects.toThrow(/finite ttl/i);
959
+ });
960
+ });
774
961
  });