tiennm99/ccs
1
0
Fork 0
mirror of https://github.com/tiennm99/ccs.git synced 2026-09-08 22:19:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(config-facade): clarify cache coherence contract

Browse Source 
Document that uncached reads (loadOrCreateUnifiedConfig)
bypass the cache and callers should use
invalidateConfigCache() if they mix uncached reads
with cached writes outside the facade. Resolves
remaining PR-Agent concern from #1150 comment.
This commit is contained in:
Tam Nhu Tran
2026-04-30 15:44:34 -04:00
parent 6d266fc7e8
commit 2290a1dc5a
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/config/config-loader-facade.ts
+8 -4
View File
@@ -5,10 +5,14 @@
* Re-exports read-only functions from unified-config-loader and config-manager, * Re-exports read-only functions from unified-config-loader and config-manager,
* and provides cache-coherent write wrappers that keep the memoization cache in sync. * and provides cache-coherent write wrappers that keep the memoization cache in sync.
* *
* IMPORTANT: Raw write functions (saveUnifiedConfig, mutateUnifiedConfig, * IMPORTANT:
* updateUnifiedConfig) are NOT re-exported here. Use the cache-coherent * - Raw write functions (saveUnifiedConfig, mutateUnifiedConfig,
* wrappers (saveConfig, mutateConfig, updateConfig) instead. If you need * updateUnifiedConfig) are NOT re-exported here. Use the cache-coherent
* the raw functions, import directly from './unified-config-loader'. * wrappers (saveConfig, mutateConfig, updateConfig) instead.
* - `loadOrCreateUnifiedConfig` and `loadUnifiedConfig` are re-exported as
* uncached reads. If you need cached reads, use `getCachedConfig()`.
* If you use an uncached read followed by a write outside this facade,
* call `invalidateConfigCache()` to keep the cache coherent.
* *
* Usage: * Usage:
* import { getCachedConfig, saveConfig, mutateConfig } from '../config/config-loader-facade'; * import { getCachedConfig, saveConfig, mutateConfig } from '../config/config-loader-facade';