@warlock.js/cache 4.15.0 → 4.16.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.
- package/CHANGELOG.md +15 -0
- package/cjs/index.cjs +117 -14
- package/cjs/index.cjs.map +1 -1
- package/esm/drivers/base-cache-driver.d.mts +5 -0
- package/esm/drivers/base-cache-driver.d.mts.map +1 -1
- package/esm/drivers/base-cache-driver.mjs +8 -4
- package/esm/drivers/base-cache-driver.mjs.map +1 -1
- package/esm/drivers/file-cache-driver.d.mts +38 -0
- package/esm/drivers/file-cache-driver.d.mts.map +1 -1
- package/esm/drivers/file-cache-driver.mjs +69 -7
- package/esm/drivers/file-cache-driver.mjs.map +1 -1
- package/esm/drivers/redis-cache-driver.d.mts.map +1 -1
- package/esm/drivers/redis-cache-driver.mjs +12 -6
- package/esm/drivers/redis-cache-driver.mjs.map +1 -1
- package/esm/index.d.mts +2 -2
- package/esm/index.mjs +2 -2
- package/esm/utils.d.mts +17 -1
- package/esm/utils.d.mts.map +1 -1
- package/esm/utils.mjs +31 -1
- package/esm/utils.mjs.map +1 -1
- package/llms-full.txt +10 -1
- package/package.json +4 -4
- package/skills/handle-cache-errors/SKILL.md +1 -0
- package/skills/pick-cache-driver/SKILL.md +8 -0
- package/skills/use-cache-namespace/SKILL.md +1 -1
|
@@ -234,6 +234,11 @@ declare abstract class BaseCacheDriver<ClientType, Options extends Record<string
|
|
|
234
234
|
protected log(operation: CacheOperationType, key?: string | any): Promise<import("@warlock.js/logger").Logger> | undefined;
|
|
235
235
|
/**
|
|
236
236
|
* Log error message
|
|
237
|
+
*
|
|
238
|
+
* Never logs the raw `error` object — driver connection errors (Redis,
|
|
239
|
+
* Postgres, ...) can carry the connection string, including the password,
|
|
240
|
+
* in the message/cause. Only a redacted `{ message, code }` shape is
|
|
241
|
+
* passed to the structured logger.
|
|
237
242
|
*/
|
|
238
243
|
protected logError(message: string, error?: any): void;
|
|
239
244
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/base-cache-driver.ts"],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"base-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/base-cache-driver.ts"],"mappings":";;;;;AAsCA;;;;KAAY,oBAAA;EAaV;;;;;;AAiBO;AAwBT;EA7CE,GAAA;EA6CmC;;;EAzCnC,IAAA;EAgDyB;;;EA5CzB,UAAA,EAAY,mBAAmB;EAuFD;;;;;EAjF9B,MAAA;EAsGiB;;;;;;EA/FjB,OAAA;AAAA;AAAA,uBAwBoB,eAAA,6BAEJ,MAAA,0BACL,WAAA,CAAY,UAAA,EAAY,OAAA;EAwGhC;;;EAAA,UApGO,YAAA,EAAe,UAAA;EA2IG;;;EAAA,UAtIlB,SAAA;EAmJP;;;EAAA,IA9IQ,MAAA,IAgBe,UAAA;EAmLD;;;EA5LlB,eAAA,CAAgB,SAAA;EAsME;;;EAAA,IA7Ld,MAAA,CAAO,MAAA,EAAQ,UAAA;EA2MT;;;EAAA,SApMD,IAAA;EA4ME;;;EAvMX,OAAA,EAAU,OAAA;EA+Od;;;EAAA,UA1OO,cAAA,EAAgB,GAAA,CAAI,cAAA,EAAgB,GAAA,CAAI,iBAAA;EAqQhC;;;EA/PX,QAAA,CAAS,GAAA,EAAK,QAAA;EAmT4B;;;EA5S1C,UAAA,CAAW,OAAA,EAAS,OAAA;EA0VpB;;;EAlVA,EAAA,CAAG,KAAA,EAAO,cAAA,EAAgB,OAAA,EAAS,iBAAA;EAuV/B;;;EA5UJ,GAAA,CAAI,KAAA,EAAO,cAAA,EAAgB,OAAA,EAAS,iBAAA;EAkWjB;;;EAvVnB,IAAA,CAAK,KAAA,EAAO,cAAA,EAAgB,OAAA,EAAS,iBAAA;EAqYlB;;;EAAA,UA1XV,IAAA,CACd,KAAA,EAAO,cAAA,EACP,IAAA,GAAM,OAAA,CAAQ,cAAA,IACb,OAAA;EAgZyB;;;EAAA,SAjXZ,eAAA,CAAgB,SAAA,WAAoB,OAAA;EAgY3C;;;EAAA,SA3XO,GAAA,CACd,GAAA,EAAK,QAAA,EACL,KAAA,OACA,YAAA,GAAe,QAAA,GAAW,eAAA,GACzB,OAAA;EAgdsE;;;;;;;;EAAA,UAtc/D,iBAAA,CACR,YAAA,GAAe,QAAA,GAAW,eAAA,GACzB,oBAAA;EAyhBqC;;;;;;EAAA,UAvgBxB,cAAA,CACd,IAAA,yBACC,OAAA,CAAQ,GAAA;EA+jBQ;;;;EAAA,UA1iBH,SAAA,CAAU,SAAA,UAAmB,IAAA,aAAiB,OAAA;EA+jBpC;;;EAAA,SAnjBV,GAAA,CAAI,GAAA,EAAK,QAAA,GAAW,OAAA;EAmkBpB;;;EAAA,SA9jBA,MAAA,CAAO,GAAA,EAAK,QAAA,GAAW,OAAA;EA+jB3B;;;EAAA,SA1jBI,KAAA,IAAS,OAAA;EAmmBb;;;EA9lBC,GAAA,CAAI,GAAA,EAAK,QAAA,GAAW,OAAA;EAymBjB;;;EAAA,UAhmBN,KAAA,EAAO,GAAA,SAAY,OAAA;EAzOlB;;;EA8OE,QAAA,CACX,GAAA,EAAK,QAAA,EACL,YAAA,EAAc,QAAA,GAAW,eAAA,EACzB,QAAA,QAAgB,OAAA,QACf,OAAA;EAnPH;;;;EAAA,UAwRU,wBAAA,CACR,YAAA,EAAc,QAAA,GAAW,eAAA,GACxB,eAAA;EArRO;;;;;;;;;;;;;EA6SG,GAAA,UACX,GAAA,EAAK,QAAA,EACL,OAAA,EAAS,eAAA,EACT,QAAA,QAAgB,OAAA,CAAQ,CAAA,IACvB,OAAA,CAAQ,CAAA;EAtQe;;;;;;;EAAA,UAyTV,QAAA,CAAS,GAAA,EAAK,QAAA,GAAW,OAAA,CAAQ,SAAA;EA5StB;;;;;;;;;;;;;;EAAA,UAoUX,eAAA,CAAgB,GAAA,EAAK,QAAA,GAAW,OAAA;EAtSJ;;;;;EAAA,UA2T5B,gBAAA,IACd,GAAA,EAAK,QAAA,EACL,OAAA,EAAS,eAAA,EACT,QAAA,QAAgB,OAAA,CAAQ,CAAA,GACxB,YAAA,UACA,YAAA,WACC,OAAA,CAAQ,CAAA;EApTK;;;;;;EAAA,UAsUN,kBAAA,IACR,SAAA,UACA,GAAA,EAAK,QAAA,EACL,OAAA,EAAS,eAAA,EACT,QAAA,QAAgB,OAAA,CAAQ,CAAA,GACxB,YAAA,UACA,YAAA;EAtSK;;;EAsUM,IAAA,CAAK,GAAA,EAAK,QAAA,GAAW,OAAA;EApUN;;;EAgVf,OAAA,CAAQ,GAAA,EAAK,QAAA,EAAU,KAAA,QAAa,OAAA;EApUhC;;;EA4UJ,SAAA,CAAU,GAAA,EAAK,QAAA,EAAU,KAAA,YAAoB,OAAA;EAzT1C;;;EA0UH,SAAA,CAAU,GAAA,EAAK,QAAA,EAAU,KAAA,YAAoB,OAAA;EAnT1C;;;EA0TH,IAAA,CAAK,IAAA,EAAM,QAAA,KAAa,OAAA;EA9SrB;;;EAqTH,OAAA,CACX,KAAA,EAAO,MAAA,eACP,GAAA,YACC,OAAA;EAnTa;;;EAAA,UA4TN,GAAA,CAAI,SAAA,EAAW,kBAAA,EAAoB,GAAA,kBAAkB,OAAA,8BAAA,MAAA;EAvT/C;;;;;;;;EAAA,UAmWN,QAAA,CAAS,OAAA,UAAiB,KAAA;EAhVvB;;;;EAAA,IA4VF,GAAA;EA1VT;;;EAqWK,YAAA,CAAa,GAAA;EA9TV;;;;;EAAA,UAyUA,qBAAA,CAAsB,IAAA,OAAW,GAAA,WAAc,OAAA,YAAgB,SAAA;EA/SxD;;;EAAA,UAmUD,eAAA,CAAgB,GAAA,UAAa,IAAA,EAAM,SAAA,GAAS,OAAA;EAjU1D;;;EAoWW,OAAA,IAAO,OAAA;EAlWjB;;;EA2WU,UAAA,IAAU,OAAA;EAxTE;;;EAgUlB,IAAA,CAAK,IAAA;EAxSyB;;;;;;;EAmTxB,MAAA,UACX,GAAA,EAAK,QAAA,EACL,EAAA,GAAK,OAAA,EAAS,CAAA,YAAa,CAAA,UAAW,OAAA,CAAQ,CAAA,UAC9C,OAAA;IAAW,GAAA,GAAM,QAAA;EAAA,IAChB,OAAA,CAAQ,CAAA;EA/Re;;;EAqVb,KAAA,WAAgB,MAAA,gBAAsB,MAAA,eACjD,GAAA,EAAK,QAAA,EACL,OAAA,EAAS,OAAA,CAAQ,CAAA,GACjB,OAAA;IAAW,GAAA,GAAM,QAAA;EAAA,IAChB,OAAA,CAAQ,CAAA;EApUD;;;;;;EAuVH,IAAA,UAAc,GAAA,EAAK,QAAA,GAAW,iBAAA,CAAkB,CAAA;EAnVrC;;;;;;;;;;EAiWL,IAAA,IACX,GAAA,EAAK,QAAA,EACL,YAAA,EAAc,QAAA,GAAW,IAAA,CAAK,WAAA,aAC9B,EAAA,QAAU,OAAA,CAAQ,CAAA,IACjB,OAAA,CAAQ,WAAA,CAAY,CAAA;EAvTF;;;;;;;EA6VR,OAAA,UACX,OAAA,YACA,QAAA,EAAU,mBAAA,GACT,OAAA,CAAQ,eAAA,CAAgB,CAAA;EAvUd;;;EAAA,UAgVH,oBAAA,CACR,YAAA,EAAc,QAAA,GAAW,IAAA,CAAK,WAAA;IAE9B,GAAA,EAAK,QAAA;IACL,KAAA;EAAA;AAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CacheUnsupportedError } from "../types.mjs";
|
|
2
|
-
import { normalizeToOptions, parseCacheKey, parseTtl, resolveTtl } from "../utils.mjs";
|
|
2
|
+
import { normalizeToOptions, parseCacheKey, parseTtl, resolveTtl, safeErrorInfo } from "../utils.mjs";
|
|
3
3
|
import { MemoryCacheList } from "../list/memory-cache-list.mjs";
|
|
4
4
|
import { TaggedCache } from "../tagged-cache.mjs";
|
|
5
5
|
import { log } from "@warlock.js/logger";
|
|
@@ -345,10 +345,15 @@ var BaseCacheDriver = class {
|
|
|
345
345
|
}
|
|
346
346
|
/**
|
|
347
347
|
* Log error message
|
|
348
|
+
*
|
|
349
|
+
* Never logs the raw `error` object — driver connection errors (Redis,
|
|
350
|
+
* Postgres, ...) can carry the connection string, including the password,
|
|
351
|
+
* in the message/cause. Only a redacted `{ message, code }` shape is
|
|
352
|
+
* passed to the structured logger.
|
|
348
353
|
*/
|
|
349
354
|
logError(message, error) {
|
|
350
|
-
log.error("cache." + this.name, "error", message);
|
|
351
|
-
|
|
355
|
+
if (error) log.error("cache." + this.name, "error", message, safeErrorInfo(error));
|
|
356
|
+
else log.error("cache." + this.name, "error", message);
|
|
352
357
|
}
|
|
353
358
|
/**
|
|
354
359
|
* Get the default TTL in seconds. Parses human-readable strings (`"1h"`, `"30m"`)
|
|
@@ -394,7 +399,6 @@ var BaseCacheDriver = class {
|
|
|
394
399
|
try {
|
|
395
400
|
return structuredClone(value);
|
|
396
401
|
} catch (error) {
|
|
397
|
-
console.log(value);
|
|
398
402
|
this.logError(`Failed to clone cached value for ${key}, typeof value: ${typeof value}`, error);
|
|
399
403
|
throw error;
|
|
400
404
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-cache-driver.mjs","names":[],"sources":["../../../../../../../cache/src/drivers/base-cache-driver.ts"],"sourcesContent":["import { log } from \"@warlock.js/logger\";\r\nimport { MemoryCacheList } from \"../list/memory-cache-list\";\r\nimport { TaggedCache } from \"../tagged-cache\";\r\nimport type {\r\n CacheConflictPolicy,\r\n CacheData,\r\n CacheDriver,\r\n CacheEventData,\r\n CacheEventHandler,\r\n CacheEventType,\r\n CacheKey,\r\n CacheListAccessor,\r\n CacheOperationType,\r\n CacheSetOptions,\r\n CacheSetResult,\r\n CacheSimilarHit,\r\n CacheSimilarOptions,\r\n CacheSwrOptions,\r\n CacheTtl,\r\n LockOptions,\r\n LockOutcome,\r\n RememberOptions,\r\n} from \"../types\";\r\nimport { CacheUnsupportedError } from \"../types\";\r\nimport {\r\n normalizeToOptions,\r\n parseCacheKey,\r\n parseTtl,\r\n resolveTtl,\r\n} from \"../utils\";\r\n\r\n/**\r\n * Normalized form of the 3rd `set` argument.\r\n *\r\n * All drivers operate on this shape internally regardless of whether the caller\r\n * passed a positional TTL, a duration string, or a rich options object.\r\n */\r\nexport type NormalizedSetOptions = {\r\n /**\r\n * Final TTL in seconds — already merged with the driver-level default\r\n * (`this.options.ttl`). `Infinity` means \"no expiration\".\r\n *\r\n * Always populated. Drivers do NOT need to fall back to `this.ttl`\r\n * themselves — `resolveSetOptions` does the merge centrally so that\r\n * every driver respects the configured default without ceremony.\r\n */\r\n ttl: number;\r\n /**\r\n * Inline tag list, or undefined when none were provided.\r\n */\r\n tags?: string[];\r\n /**\r\n * Conflict policy. Defaults to `\"upsert\"`.\r\n */\r\n onConflict: CacheConflictPolicy;\r\n /**\r\n * Optional embedding vector for similarity retrieval. Drivers that do not\r\n * support similarity must throw {@link CacheUnsupportedError} when this is\r\n * present (rather than silently dropping it).\r\n */\r\n vector?: number[];\r\n /**\r\n * Optional freshness deadline as a millisecond timestamp. Set by `swr()`\r\n * to mark when the entry stops being \"fresh\" and becomes\r\n * \"stale-but-revalidatable.\" Drivers route this through\r\n * `prepareDataForStorage` so it persists in the wrapper.\r\n */\r\n staleAt?: number;\r\n};\r\n\r\nconst messages = {\r\n clearing: \"Clearing namespace\",\r\n cleared: \"Namespace cleared\",\r\n fetching: \"Fetching key\",\r\n fetched: \"Key fetched\",\r\n caching: \"Caching key\",\r\n cached: \"Key cached\",\r\n flushing: \"Flushing cache\",\r\n flushed: \"Cache flushed\",\r\n removing: \"Removing key\",\r\n removed: \"Key removed\",\r\n expired: \"Key expired\",\r\n notFound: \"Key not found\",\r\n connecting: \"Connecting to the cache engine.\",\r\n connected: \"Connected to the cache engine.\",\r\n disconnecting: \"Disconnecting from the cache engine.\",\r\n disconnected: \"Disconnected from the cache engine.\",\r\n connectionFailed: \"Failed to connect to the cache engine.\",\r\n error: \"Error occurred\",\r\n};\r\n\r\nexport abstract class BaseCacheDriver<\r\n ClientType,\r\n Options extends Record<string, any>,\r\n> implements CacheDriver<ClientType, Options> {\r\n /**\r\n * CLient driver\r\n */\r\n protected clientDriver!: ClientType;\r\n\r\n /**\r\n * Determine whether to log or not\r\n */\r\n protected shouldLog: boolean = true;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public get client() {\r\n return (this.clientDriver || this) as unknown as ClientType;\r\n }\r\n\r\n /**\r\n * Set logging state\r\n */\r\n public setLoggingState(shouldLog: boolean) {\r\n this.shouldLog = shouldLog;\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * Set client driver\r\n */\r\n public set client(client: ClientType) {\r\n this.clientDriver = client;\r\n }\r\n\r\n /**\r\n * Get the cache driver name\r\n */\r\n public abstract name: string;\r\n\r\n /**\r\n * Options list\r\n */\r\n public options!: Options;\r\n\r\n /**\r\n * Event listeners storage\r\n */\r\n protected eventListeners: Map<CacheEventType, Set<CacheEventHandler>> =\r\n new Map();\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public parseKey(key: CacheKey) {\r\n return parseCacheKey(key, this.options);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public setOptions(options: Options) {\r\n this.options = options || {};\r\n return this;\r\n }\r\n\r\n /**\r\n * Register an event listener\r\n */\r\n public on(event: CacheEventType, handler: CacheEventHandler): this {\r\n if (!this.eventListeners.has(event)) {\r\n this.eventListeners.set(event, new Set());\r\n }\r\n this.eventListeners.get(event)!.add(handler);\r\n return this;\r\n }\r\n\r\n /**\r\n * Remove an event listener\r\n */\r\n public off(event: CacheEventType, handler: CacheEventHandler): this {\r\n const handlers = this.eventListeners.get(event);\r\n if (handlers) {\r\n handlers.delete(handler);\r\n }\r\n return this;\r\n }\r\n\r\n /**\r\n * Register a one-time event listener\r\n */\r\n public once(event: CacheEventType, handler: CacheEventHandler): this {\r\n const onceHandler: CacheEventHandler = async (data) => {\r\n await handler(data);\r\n this.off(event, onceHandler);\r\n };\r\n return this.on(event, onceHandler);\r\n }\r\n\r\n /**\r\n * Emit an event to all registered listeners\r\n */\r\n protected async emit(\r\n event: CacheEventType,\r\n data: Partial<CacheEventData> = {},\r\n ): Promise<void> {\r\n const handlers = this.eventListeners.get(event);\r\n if (!handlers || handlers.size === 0) return;\r\n\r\n const eventData: CacheEventData = {\r\n driver: this.name,\r\n ...data,\r\n };\r\n\r\n // Execute all handlers\r\n const promises: Promise<void>[] = [];\r\n for (const handler of handlers) {\r\n try {\r\n const result = handler(eventData);\r\n if (result instanceof Promise) {\r\n promises.push(result);\r\n }\r\n } catch (error) {\r\n this.logError(`Error in event handler for '${event}'`, error);\r\n }\r\n }\r\n\r\n // Wait for all async handlers\r\n if (promises.length > 0) {\r\n await Promise.allSettled(promises);\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract removeNamespace(namespace: string): Promise<any>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract set(\r\n key: CacheKey,\r\n value: any,\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): Promise<any>;\r\n\r\n /**\r\n * Normalize the 3rd argument of a `set` call into a single shape every driver\r\n * can act on. Handles TTL parsing (number | string | Infinity), `expiresAt` →\r\n * relative TTL conversion, and mutual-exclusion validation.\r\n *\r\n * @throws {CacheConfigurationError} when `ttl` and `expiresAt` are passed together\r\n * or an unparseable duration string is supplied.\r\n */\r\n protected resolveSetOptions(\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): NormalizedSetOptions {\r\n const options = normalizeToOptions(ttlOrOptions);\r\n\r\n return {\r\n ttl: resolveTtl(options.ttl, options.expiresAt, this.ttl),\r\n tags: options.tags,\r\n onConflict: options.onConflict ?? \"upsert\",\r\n vector: options.vector,\r\n staleAt: options.staleAt,\r\n };\r\n }\r\n\r\n /**\r\n * Resolve the union of cache keys associated with any of the given tags.\r\n * Used by `similar()` to narrow the candidate pool before similarity ranking.\r\n *\r\n * Returns `null` when no tags are passed (callers should treat that as \"no filter\").\r\n */\r\n protected async getKeysForTags(\r\n tags: string[] | undefined,\r\n ): Promise<Set<string> | null> {\r\n if (!tags || tags.length === 0) {\r\n return null;\r\n }\r\n\r\n const allKeys = new Set<string>();\r\n for (const tag of tags) {\r\n const tagKey = `cache:tags:${tag}`;\r\n const keys = ((await this.get(tagKey)) as string[] | null) || [];\r\n for (const k of keys) {\r\n allKeys.add(k);\r\n }\r\n }\r\n\r\n return allKeys;\r\n }\r\n\r\n /**\r\n * Apply tag relationships after a successful write. Called by drivers once\r\n * the value is in storage.\r\n */\r\n protected async applyTags(parsedKey: string, tags: string[]): Promise<void> {\r\n if (tags.length === 0) {\r\n return;\r\n }\r\n\r\n const tagged = this.tags(tags);\r\n await (tagged as TaggedCache).storeTagRelationship(parsedKey);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract get(key: CacheKey): Promise<any>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract remove(key: CacheKey): Promise<void>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract flush(): Promise<void>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async has(key: CacheKey): Promise<boolean> {\r\n const value = await this.get(key);\r\n // Event is emitted by get() method\r\n return value !== null;\r\n }\r\n\r\n /**\r\n * Lock storage for preventing cache stampede\r\n */\r\n protected locks: Map<string, Promise<any>> = new Map();\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async remember(\r\n key: CacheKey,\r\n ttlOrOptions: CacheTtl | RememberOptions,\r\n callback: () => Promise<any>,\r\n ): Promise<any> {\r\n const parsedKey = this.parseKey(key);\r\n\r\n // The options-form lets callers forward tags / driver-override through to\r\n // the cache-miss write. Normalize both shapes into a single CacheSetOptions\r\n // blob so there's one path from here on.\r\n const setOptions = this.normalizeRememberOptions(ttlOrOptions);\r\n\r\n const cachedValue = await this.get(key);\r\n if (cachedValue) {\r\n return cachedValue;\r\n }\r\n\r\n const existingLock = this.locks.get(parsedKey);\r\n if (existingLock) {\r\n return existingLock;\r\n }\r\n\r\n const promise = callback()\r\n .then(async (result) => {\r\n await this.set(key, result, setOptions);\r\n this.locks.delete(parsedKey);\r\n return result;\r\n })\r\n .catch((err) => {\r\n this.locks.delete(parsedKey);\r\n throw err;\r\n });\r\n\r\n this.locks.set(parsedKey, promise);\r\n return promise;\r\n }\r\n\r\n /**\r\n * Resolve the TTL-or-options arg of `remember` into a `CacheSetOptions` object\r\n * that can be passed straight to `set()`. Keeps the implementation unbranched.\r\n */\r\n protected normalizeRememberOptions(\r\n ttlOrOptions: CacheTtl | RememberOptions,\r\n ): CacheSetOptions {\r\n if (typeof ttlOrOptions === \"number\" || typeof ttlOrOptions === \"string\") {\r\n return { ttl: ttlOrOptions };\r\n }\r\n\r\n return {\r\n ttl: ttlOrOptions.ttl,\r\n tags: ttlOrOptions.tags,\r\n };\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read raw entry, branch on freshness/staleness,\r\n * trigger background refresh in the stale window, fall through to\r\n * `callback` on miss/expiry. Concurrent stale-window callers share a\r\n * single in-flight refresh via {@link locks}.\r\n *\r\n * Drivers without a real {@link getEntry} override degrade gracefully —\r\n * the synthetic entry has no `staleAt`, which the freshness check treats\r\n * as \"always fresh,\" so SWR behaves like a TTL-only cached read on those\r\n * drivers (no background refresh, but no double-fetch either).\r\n */\r\n public async swr<T = any>(\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n ): Promise<T> {\r\n const parsedKey = this.parseKey(key);\r\n const freshSeconds = parseTtl(options.freshTtl);\r\n const staleSeconds = parseTtl(options.staleTtl);\r\n\r\n if (staleSeconds <= freshSeconds) {\r\n throw new Error(\r\n `cache.swr: 'staleTtl' (${staleSeconds}s) must be greater than 'freshTtl' (${freshSeconds}s).`,\r\n );\r\n }\r\n\r\n const entry = await this.getEntry(key);\r\n const now = Date.now();\r\n\r\n const isExpired = entry?.expiresAt !== undefined && entry.expiresAt <= now;\r\n\r\n if (!entry || isExpired) {\r\n return this.swrFetchAndStore<T>(\r\n key,\r\n options,\r\n callback,\r\n freshSeconds,\r\n staleSeconds,\r\n );\r\n }\r\n\r\n const isFresh = entry.staleAt === undefined || entry.staleAt > now;\r\n\r\n if (isFresh) {\r\n return entry.data as T;\r\n }\r\n\r\n this.scheduleSwrRefresh<T>(\r\n parsedKey,\r\n key,\r\n options,\r\n callback,\r\n freshSeconds,\r\n staleSeconds,\r\n );\r\n\r\n return entry.data as T;\r\n }\r\n\r\n /**\r\n * Read the raw {@link CacheData} wrapper for a key, including any\r\n * `expiresAt` / `staleAt` metadata. Default implementation falls back to\r\n * `get()` and synthesizes a metadata-less wrapper — drivers that store\r\n * the wrapper directly (memory, lru, file, redis, pg, mock) override\r\n * this to return real metadata so SWR can branch on freshness.\r\n */\r\n protected async getEntry(key: CacheKey): Promise<CacheData | null> {\r\n const value = await this.get(key);\r\n\r\n if (value === null) {\r\n return null;\r\n }\r\n\r\n return { data: value };\r\n }\r\n\r\n /**\r\n * Remaining lifetime of an existing entry, in seconds — used by TTL-preserving\r\n * writes such as `update()` / `merge()` when the caller passes no explicit\r\n * `ttl`.\r\n *\r\n * - `Infinity` — the entry exists with no expiry (preserve \"never expires\").\r\n * - positive number — seconds left before the entry expires.\r\n * - `undefined` — the key is missing or already past its deadline; the caller\r\n * should fall back to the driver default TTL.\r\n *\r\n * Default reads `expiresAt` from {@link getEntry}, which the metadata-aware\r\n * drivers (memory, lru, mock, pg) populate. Drivers that track TTL natively\r\n * and don't carry `expiresAt` in their payload (Redis) override this.\r\n */\r\n protected async getRemainingTtl(key: CacheKey): Promise<number | undefined> {\r\n const entry = await this.getEntry(key);\r\n\r\n if (!entry) {\r\n return undefined;\r\n }\r\n\r\n if (!entry.expiresAt || entry.expiresAt === Infinity) {\r\n return Infinity;\r\n }\r\n\r\n const remainingSeconds = Math.ceil((entry.expiresAt - Date.now()) / 1000);\r\n\r\n return remainingSeconds > 0 ? remainingSeconds : undefined;\r\n }\r\n\r\n /**\r\n * Block-and-fetch path of `swr()`: invoked on miss or past-`staleTtl`\r\n * expiry. Writes through `set()` with the SWR options translated into\r\n * standard `CacheSetOptions` (ttl = staleTtl, staleAt = now + freshTtl).\r\n */\r\n protected async swrFetchAndStore<T>(\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n freshSeconds: number,\r\n staleSeconds: number,\r\n ): Promise<T> {\r\n const result = await callback();\r\n\r\n await this.set(key, result, {\r\n ttl: staleSeconds,\r\n staleAt: Date.now() + freshSeconds * 1000,\r\n tags: options.tags,\r\n });\r\n\r\n return result;\r\n }\r\n\r\n /**\r\n * Stale-window background refresh. Registers a single in-flight promise\r\n * per parsed key so concurrent SWR callers share one refresh. Failed\r\n * refreshes preserve the stale entry, log via `logError`, and emit on\r\n * `error` — the stale-returning caller never sees the failure.\r\n */\r\n protected scheduleSwrRefresh<T>(\r\n parsedKey: string,\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n freshSeconds: number,\r\n staleSeconds: number,\r\n ): void {\r\n if (this.locks.has(parsedKey)) {\r\n return;\r\n }\r\n\r\n let refresh!: Promise<void>;\r\n refresh = (async () => {\r\n try {\r\n const result = await callback();\r\n\r\n await this.set(key, result, {\r\n ttl: staleSeconds,\r\n staleAt: Date.now() + freshSeconds * 1000,\r\n tags: options.tags,\r\n });\r\n } catch (error) {\r\n this.logError(`SWR background refresh failed for ${parsedKey}`, error);\r\n await this.emit(\"error\", { key: parsedKey, error });\r\n } finally {\r\n if (this.locks.get(parsedKey) === refresh) {\r\n this.locks.delete(parsedKey);\r\n }\r\n }\r\n })();\r\n\r\n this.locks.set(parsedKey, refresh);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async pull(key: CacheKey): Promise<any | null> {\r\n const value = await this.get(key);\r\n if (value !== null) {\r\n await this.remove(key);\r\n }\r\n // Events are emitted by get() and remove() methods\r\n return value;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async forever(key: CacheKey, value: any): Promise<any> {\r\n // Event is emitted by set() method\r\n return this.set(key, value, Infinity);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async increment(key: CacheKey, value: number = 1): Promise<number> {\r\n const current = (await this.get(key)) || 0;\r\n\r\n if (typeof current !== \"number\") {\r\n throw new Error(\r\n `Cannot increment non-numeric value for key: ${this.parseKey(key)}`,\r\n );\r\n }\r\n\r\n const newValue = current + value;\r\n await this.set(key, newValue);\r\n return newValue;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async decrement(key: CacheKey, value: number = 1): Promise<number> {\r\n return this.increment(key, -value);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async many(keys: CacheKey[]): Promise<any[]> {\r\n return Promise.all(keys.map((key) => this.get(key)));\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async setMany(\r\n items: Record<string, any>,\r\n ttl?: number,\r\n ): Promise<void> {\r\n await Promise.all(\r\n Object.entries(items).map(([key, value]) => this.set(key, value, ttl)),\r\n );\r\n }\r\n\r\n /**\r\n * Log the operation\r\n */\r\n protected log(operation: CacheOperationType, key?: string | any) {\r\n if (!this.shouldLog) return;\r\n\r\n if (typeof key === \"string\") {\r\n // this will be likely used with file cache driver as it will convert the dot to slash\r\n // to make it consistent and not to confuse developers we will output the key by making sure it's a dot\r\n key = key.replace(/\\//g, \".\");\r\n }\r\n\r\n if (operation === \"connectionFailed\") {\r\n log.fatal(`cache.${this.name}`, operation, key);\r\n }\r\n\r\n if (operation == \"notFound\" || operation == \"expired\") {\r\n return log.warn(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n if (operation.endsWith(\"ed\")) {\r\n return log.success(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n log.info(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n /**\r\n * Log error message\r\n */\r\n protected logError(message: string, error?: any) {\r\n log.error(\"cache.\" + this.name, \"error\", message);\r\n if (error) {\r\n console.log(error);\r\n }\r\n }\r\n\r\n /**\r\n * Get the default TTL in seconds. Parses human-readable strings (`\"1h\"`, `\"30m\"`)\r\n * from driver options if present; falls back to `Infinity` when no default is set.\r\n */\r\n public get ttl() {\r\n if (this.options.ttl === undefined) {\r\n return Infinity;\r\n }\r\n\r\n return parseTtl(this.options.ttl);\r\n }\r\n\r\n /**\r\n * Get time to live value in milliseconds\r\n */\r\n public getExpiresAt(ttl: number = this.ttl) {\r\n if (ttl) {\r\n return new Date().getTime() + ttl * 1000;\r\n }\r\n }\r\n\r\n /**\r\n * Wrap a value with TTL and optional freshness metadata for backend\r\n * storage. `staleAt` persists alongside `expiresAt` when supplied — used\r\n * by the SWR flow to mark when the entry stops being fresh.\r\n */\r\n protected prepareDataForStorage(data: any, ttl?: number, staleAt?: number) {\r\n const preparedData: CacheData = {\r\n data,\r\n };\r\n\r\n if (ttl) {\r\n preparedData.ttl = ttl;\r\n preparedData.expiresAt = this.getExpiresAt(ttl);\r\n }\r\n\r\n if (staleAt !== undefined) {\r\n preparedData.staleAt = staleAt;\r\n }\r\n\r\n return preparedData;\r\n }\r\n\r\n /**\r\n * Parse fetched data from cache\r\n */\r\n protected async parseCachedData(key: string, data: CacheData) {\r\n this.log(\"fetched\", key);\r\n\r\n if (data.expiresAt && data.expiresAt < Date.now()) {\r\n this.remove(key);\r\n return null;\r\n }\r\n\r\n const value = data.data;\r\n\r\n // Skip cloning for primitives (immutable types)\r\n if (value === null || value === undefined) {\r\n return value;\r\n }\r\n\r\n const type = typeof value;\r\n if (type === \"string\" || type === \"number\" || type === \"boolean\") {\r\n return value;\r\n }\r\n\r\n // Deep clone objects/arrays to prevent cache mutation\r\n try {\r\n return structuredClone(value);\r\n } catch (error) {\r\n console.log(value);\r\n\r\n this.logError(\r\n `Failed to clone cached value for ${key}, typeof value: ${typeof value}`,\r\n error,\r\n );\r\n throw error;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async connect() {\r\n this.log(\"connecting\");\r\n this.log(\"connected\");\r\n await this.emit(\"connected\");\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async disconnect() {\r\n this.log(\"disconnected\");\r\n await this.emit(\"disconnected\");\r\n }\r\n\r\n /**\r\n * Create a tagged cache instance for the given tags\r\n */\r\n public tags(tags: string[]): any {\r\n return new TaggedCache(tags, this);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read → transform → write under a per-key in-process\r\n * lock. Drivers that can offer stronger semantics (Redis via `WATCH`/`MULTI`)\r\n * should override.\r\n */\r\n public async update<T = any>(\r\n key: CacheKey,\r\n fn: (current: T | null) => T | null | Promise<T | null>,\r\n options: { ttl?: CacheTtl } = {},\r\n ): Promise<T | null> {\r\n const parsedKey = this.parseKey(key);\r\n\r\n // Chain each update onto the previous one for the same key so concurrent\r\n // callers are serialized end-to-end, not merely awakened together when an\r\n // earlier lock resolves.\r\n const previous = this.locks.get(parsedKey) ?? Promise.resolve();\r\n\r\n const next = previous\r\n .catch(() => undefined)\r\n .then(async () => {\r\n const current = (await this.get(key)) as T | null;\r\n const result = await fn(current);\r\n\r\n if (result === null) {\r\n await this.remove(key);\r\n return null;\r\n }\r\n\r\n if (options.ttl !== undefined) {\r\n await this.set(key, result, { ttl: options.ttl });\r\n\r\n return result;\r\n }\r\n\r\n // No explicit TTL → preserve the existing entry's remaining lifetime\r\n // rather than resetting it to the driver default.\r\n const remainingTtl = await this.getRemainingTtl(key);\r\n\r\n if (remainingTtl !== undefined) {\r\n await this.set(key, result, { ttl: remainingTtl });\r\n } else {\r\n await this.set(key, result);\r\n }\r\n\r\n return result;\r\n });\r\n\r\n this.locks.set(parsedKey, next);\r\n\r\n // Clean up the slot once this link finishes — but only if nobody chained\r\n // a follow-up onto it in the meantime.\r\n next.finally(() => {\r\n if (this.locks.get(parsedKey) === next) {\r\n this.locks.delete(parsedKey);\r\n }\r\n });\r\n\r\n return next;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async merge<T extends Record<string, any> = Record<string, any>>(\r\n key: CacheKey,\r\n partial: Partial<T>,\r\n options: { ttl?: CacheTtl } = {},\r\n ): Promise<T> {\r\n const result = await this.update<T>(\r\n key,\r\n (current) => {\r\n const base = (current ?? {}) as T;\r\n return { ...base, ...partial } as T;\r\n },\r\n options,\r\n );\r\n\r\n return result as T;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read-mutate-write array backed by the underlying\r\n * cache entry. Concrete drivers (e.g. Redis) override with native commands.\r\n */\r\n public list<T = any>(key: CacheKey): CacheListAccessor<T> {\r\n return new MemoryCacheList<T>(this, key);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Built on top of `set({ onConflict: \"create\" })` — Redis-native `SET … NX EX`\r\n * under the hood on Redis, emulated via key-existence check on other drivers.\r\n * The lock value is the resolved `owner` (defaults to `pid.<process.pid>`).\r\n *\r\n * Always releases in `finally`, even if `fn` throws — the thrown error\r\n * propagates to the caller unchanged.\r\n */\r\n public async lock<T>(\r\n key: CacheKey,\r\n ttlOrOptions: CacheTtl | Omit<LockOptions, \"driver\">,\r\n fn: () => Promise<T>,\r\n ): Promise<LockOutcome<T>> {\r\n const { ttl, owner } = this.normalizeLockOptions(ttlOrOptions);\r\n const lockOwner = owner ?? `pid.${process.pid}`;\r\n\r\n const setResult = (await this.set(key, lockOwner, {\r\n onConflict: \"create\",\r\n ttl,\r\n })) as CacheSetResult | unknown;\r\n\r\n // `onConflict` drivers return CacheSetResult. Drivers that no-op on set\r\n // (e.g. the null driver) may return anything else — treat that as\r\n // \"acquired\" since there's nothing to collide with.\r\n const wasSet =\r\n typeof setResult === \"object\" &&\r\n setResult !== null &&\r\n \"wasSet\" in setResult\r\n ? (setResult as CacheSetResult).wasSet\r\n : true;\r\n\r\n if (!wasSet) {\r\n return { acquired: false };\r\n }\r\n\r\n try {\r\n const value = await fn();\r\n return { acquired: true, value };\r\n } finally {\r\n await this.remove(key);\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation throws {@link CacheUnsupportedError}. Drivers that\r\n * support similarity retrieval (memory family, `pg`, `redis` w/ RediSearch)\r\n * override this with a real impl.\r\n */\r\n public async similar<T = any>(\r\n _vector: number[],\r\n _options: CacheSimilarOptions,\r\n ): Promise<CacheSimilarHit<T>[]> {\r\n throw new CacheUnsupportedError(\r\n `'${this.name}' driver does not support similarity retrieval. Use a memory driver, 'pg' (with pgvector), or 'redis' (with RediSearch).`,\r\n );\r\n }\r\n\r\n /**\r\n * Resolve the TTL-or-options arg of `lock` into a uniform shape.\r\n */\r\n protected normalizeLockOptions(\r\n ttlOrOptions: CacheTtl | Omit<LockOptions, \"driver\">,\r\n ): {\r\n ttl: CacheTtl;\r\n owner?: string;\r\n } {\r\n if (typeof ttlOrOptions === \"number\" || typeof ttlOrOptions === \"string\") {\r\n return { ttl: ttlOrOptions };\r\n }\r\n\r\n return { ttl: ttlOrOptions.ttl, owner: ttlOrOptions.owner };\r\n }\r\n}\r\n"],"mappings":";;;;;;;AAsEA,MAAM,WAAW;CACf,UAAU;CACV,SAAS;CACT,UAAU;CACV,SAAS;CACT,SAAS;CACT,QAAQ;CACR,UAAU;CACV,SAAS;CACT,UAAU;CACV,SAAS;CACT,SAAS;CACT,UAAU;CACV,YAAY;CACZ,WAAW;CACX,eAAe;CACf,cAAc;CACd,kBAAkB;CAClB,OAAO;AACT;AAEA,IAAsB,kBAAtB,MAG8C;;mBASb;wCAuC7B,IAAI,IAAI;+BAyLmC,IAAI,IAAI;;;;;CA3NrD,IAAW,SAAS;EAClB,OAAQ,KAAK,gBAAgB;CAC/B;;;;CAKA,AAAO,gBAAgB,WAAoB;EACzC,KAAK,YAAY;EAEjB,OAAO;CACT;;;;CAKA,IAAW,OAAO,QAAoB;EACpC,KAAK,eAAe;CACtB;;;;CAqBA,AAAO,SAAS,KAAe;EAC7B,OAAO,cAAc,KAAK,KAAK,OAAO;CACxC;;;;CAKA,AAAO,WAAW,SAAkB;EAClC,KAAK,UAAU,WAAW,CAAC;EAC3B,OAAO;CACT;;;;CAKA,AAAO,GAAG,OAAuB,SAAkC;EACjE,IAAI,CAAC,KAAK,eAAe,IAAI,KAAK,GAChC,KAAK,eAAe,IAAI,uBAAO,IAAI,IAAI,CAAC;EAE1C,KAAK,eAAe,IAAI,KAAK,CAAC,CAAE,IAAI,OAAO;EAC3C,OAAO;CACT;;;;CAKA,AAAO,IAAI,OAAuB,SAAkC;EAClE,MAAM,WAAW,KAAK,eAAe,IAAI,KAAK;EAC9C,IAAI,UACF,SAAS,OAAO,OAAO;EAEzB,OAAO;CACT;;;;CAKA,AAAO,KAAK,OAAuB,SAAkC;EACnE,MAAM,cAAiC,OAAO,SAAS;GACrD,MAAM,QAAQ,IAAI;GAClB,KAAK,IAAI,OAAO,WAAW;EAC7B;EACA,OAAO,KAAK,GAAG,OAAO,WAAW;CACnC;;;;CAKA,MAAgB,KACd,OACA,OAAgC,CAAC,GAClB;EACf,MAAM,WAAW,KAAK,eAAe,IAAI,KAAK;EAC9C,IAAI,CAAC,YAAY,SAAS,SAAS,GAAG;EAEtC,MAAM,YAA4B;GAChC,QAAQ,KAAK;GACb,GAAG;EACL;EAGA,MAAM,WAA4B,CAAC;EACnC,KAAK,MAAM,WAAW,UACpB,IAAI;GACF,MAAM,SAAS,QAAQ,SAAS;GAChC,IAAI,kBAAkB,SACpB,SAAS,KAAK,MAAM;EAExB,SAAS,OAAO;GACd,KAAK,SAAS,+BAA+B,MAAM,IAAI,KAAK;EAC9D;EAIF,IAAI,SAAS,SAAS,GACpB,MAAM,QAAQ,WAAW,QAAQ;CAErC;;;;;;;;;CAwBA,AAAU,kBACR,cACsB;EACtB,MAAM,UAAU,mBAAmB,YAAY;EAE/C,OAAO;GACL,KAAK,WAAW,QAAQ,KAAK,QAAQ,WAAW,KAAK,GAAG;GACxD,MAAM,QAAQ;GACd,YAAY,QAAQ,cAAc;GAClC,QAAQ,QAAQ;GAChB,SAAS,QAAQ;EACnB;CACF;;;;;;;CAQA,MAAgB,eACd,MAC6B;EAC7B,IAAI,CAAC,QAAQ,KAAK,WAAW,GAC3B,OAAO;EAGT,MAAM,0BAAU,IAAI,IAAY;EAChC,KAAK,MAAM,OAAO,MAAM;GACtB,MAAM,SAAS,cAAc;GAC7B,MAAM,OAAS,MAAM,KAAK,IAAI,MAAM,KAA0B,CAAC;GAC/D,KAAK,MAAM,KAAK,MACd,QAAQ,IAAI,CAAC;EAEjB;EAEA,OAAO;CACT;;;;;CAMA,MAAgB,UAAU,WAAmB,MAA+B;EAC1E,IAAI,KAAK,WAAW,GAClB;EAIF,MADe,KAAK,KAAK,IACb,CAAC,CAAiB,qBAAqB,SAAS;CAC9D;;;;CAoBA,MAAa,IAAI,KAAiC;EAGhD,OAAO,MAFa,KAAK,IAAI,GAAG,MAEf;CACnB;;;;CAUA,MAAa,SACX,KACA,cACA,UACc;EACd,MAAM,YAAY,KAAK,SAAS,GAAG;EAKnC,MAAM,aAAa,KAAK,yBAAyB,YAAY;EAE7D,MAAM,cAAc,MAAM,KAAK,IAAI,GAAG;EACtC,IAAI,aACF,OAAO;EAGT,MAAM,eAAe,KAAK,MAAM,IAAI,SAAS;EAC7C,IAAI,cACF,OAAO;EAGT,MAAM,UAAU,SAAS,CAAC,CACvB,KAAK,OAAO,WAAW;GACtB,MAAM,KAAK,IAAI,KAAK,QAAQ,UAAU;GACtC,KAAK,MAAM,OAAO,SAAS;GAC3B,OAAO;EACT,CAAC,CAAC,CACD,OAAO,QAAQ;GACd,KAAK,MAAM,OAAO,SAAS;GAC3B,MAAM;EACR,CAAC;EAEH,KAAK,MAAM,IAAI,WAAW,OAAO;EACjC,OAAO;CACT;;;;;CAMA,AAAU,yBACR,cACiB;EACjB,IAAI,OAAO,iBAAiB,YAAY,OAAO,iBAAiB,UAC9D,OAAO,EAAE,KAAK,aAAa;EAG7B,OAAO;GACL,KAAK,aAAa;GAClB,MAAM,aAAa;EACrB;CACF;;;;;;;;;;;;;;CAeA,MAAa,IACX,KACA,SACA,UACY;EACZ,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,eAAe,SAAS,QAAQ,QAAQ;EAC9C,MAAM,eAAe,SAAS,QAAQ,QAAQ;EAE9C,IAAI,gBAAgB,cAClB,MAAM,IAAI,MACR,0BAA0B,aAAa,sCAAsC,aAAa,IAC5F;EAGF,MAAM,QAAQ,MAAM,KAAK,SAAS,GAAG;EACrC,MAAM,MAAM,KAAK,IAAI;EAErB,MAAM,YAAY,OAAO,cAAc,UAAa,MAAM,aAAa;EAEvE,IAAI,CAAC,SAAS,WACZ,OAAO,KAAK,iBACV,KACA,SACA,UACA,cACA,YACF;EAKF,IAFgB,MAAM,YAAY,UAAa,MAAM,UAAU,KAG7D,OAAO,MAAM;EAGf,KAAK,mBACH,WACA,KACA,SACA,UACA,cACA,YACF;EAEA,OAAO,MAAM;CACf;;;;;;;;CASA,MAAgB,SAAS,KAA0C;EACjE,MAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;EAEhC,IAAI,UAAU,MACZ,OAAO;EAGT,OAAO,EAAE,MAAM,MAAM;CACvB;;;;;;;;;;;;;;;CAgBA,MAAgB,gBAAgB,KAA4C;EAC1E,MAAM,QAAQ,MAAM,KAAK,SAAS,GAAG;EAErC,IAAI,CAAC,OACH;EAGF,IAAI,CAAC,MAAM,aAAa,MAAM,cAAc,UAC1C,OAAO;EAGT,MAAM,mBAAmB,KAAK,MAAM,MAAM,YAAY,KAAK,IAAI,KAAK,GAAI;EAExE,OAAO,mBAAmB,IAAI,mBAAmB;CACnD;;;;;;CAOA,MAAgB,iBACd,KACA,SACA,UACA,cACA,cACY;EACZ,MAAM,SAAS,MAAM,SAAS;EAE9B,MAAM,KAAK,IAAI,KAAK,QAAQ;GAC1B,KAAK;GACL,SAAS,KAAK,IAAI,IAAI,eAAe;GACrC,MAAM,QAAQ;EAChB,CAAC;EAED,OAAO;CACT;;;;;;;CAQA,AAAU,mBACR,WACA,KACA,SACA,UACA,cACA,cACM;EACN,IAAI,KAAK,MAAM,IAAI,SAAS,GAC1B;EAGF,IAAI;EACJ,WAAW,YAAY;GACrB,IAAI;IACF,MAAM,SAAS,MAAM,SAAS;IAE9B,MAAM,KAAK,IAAI,KAAK,QAAQ;KAC1B,KAAK;KACL,SAAS,KAAK,IAAI,IAAI,eAAe;KACrC,MAAM,QAAQ;IAChB,CAAC;GACH,SAAS,OAAO;IACd,KAAK,SAAS,qCAAqC,aAAa,KAAK;IACrE,MAAM,KAAK,KAAK,SAAS;KAAE,KAAK;KAAW;IAAM,CAAC;GACpD,UAAU;IACR,IAAI,KAAK,MAAM,IAAI,SAAS,MAAM,SAChC,KAAK,MAAM,OAAO,SAAS;GAE/B;EACF,EAAC,CAAE;EAEH,KAAK,MAAM,IAAI,WAAW,OAAO;CACnC;;;;CAKA,MAAa,KAAK,KAAoC;EACpD,MAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;EAChC,IAAI,UAAU,MACZ,MAAM,KAAK,OAAO,GAAG;EAGvB,OAAO;CACT;;;;CAKA,MAAa,QAAQ,KAAe,OAA0B;EAE5D,OAAO,KAAK,IAAI,KAAK,OAAO,QAAQ;CACtC;;;;CAKA,MAAa,UAAU,KAAe,QAAgB,GAAoB;EACxE,MAAM,UAAW,MAAM,KAAK,IAAI,GAAG,KAAM;EAEzC,IAAI,OAAO,YAAY,UACrB,MAAM,IAAI,MACR,+CAA+C,KAAK,SAAS,GAAG,GAClE;EAGF,MAAM,WAAW,UAAU;EAC3B,MAAM,KAAK,IAAI,KAAK,QAAQ;EAC5B,OAAO;CACT;;;;CAKA,MAAa,UAAU,KAAe,QAAgB,GAAoB;EACxE,OAAO,KAAK,UAAU,KAAK,CAAC,KAAK;CACnC;;;;CAKA,MAAa,KAAK,MAAkC;EAClD,OAAO,QAAQ,IAAI,KAAK,KAAK,QAAQ,KAAK,IAAI,GAAG,CAAC,CAAC;CACrD;;;;CAKA,MAAa,QACX,OACA,KACe;EACf,MAAM,QAAQ,IACZ,OAAO,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW,KAAK,IAAI,KAAK,OAAO,GAAG,CAAC,CACvE;CACF;;;;CAKA,AAAU,IAAI,WAA+B,KAAoB;EAC/D,IAAI,CAAC,KAAK,WAAW;EAErB,IAAI,OAAO,QAAQ,UAGjB,MAAM,IAAI,QAAQ,OAAO,GAAG;EAG9B,IAAI,cAAc,oBAChB,IAAI,MAAM,SAAS,KAAK,QAAQ,WAAW,GAAG;EAGhD,IAAI,aAAa,cAAc,aAAa,WAC1C,OAAO,IAAI,KACT,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;EAGF,IAAI,UAAU,SAAS,IAAI,GACzB,OAAO,IAAI,QACT,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;EAGF,IAAI,KACF,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;CACF;;;;CAKA,AAAU,SAAS,SAAiB,OAAa;EAC/C,IAAI,MAAM,WAAW,KAAK,MAAM,SAAS,OAAO;EAChD,IAAI,OACF,QAAQ,IAAI,KAAK;CAErB;;;;;CAMA,IAAW,MAAM;EACf,IAAI,KAAK,QAAQ,QAAQ,QACvB,OAAO;EAGT,OAAO,SAAS,KAAK,QAAQ,GAAG;CAClC;;;;CAKA,AAAO,aAAa,MAAc,KAAK,KAAK;EAC1C,IAAI,KACF,wBAAO,IAAI,KAAK,EAAC,CAAC,QAAQ,IAAI,MAAM;CAExC;;;;;;CAOA,AAAU,sBAAsB,MAAW,KAAc,SAAkB;EACzE,MAAM,eAA0B,EAC9B,KACF;EAEA,IAAI,KAAK;GACP,aAAa,MAAM;GACnB,aAAa,YAAY,KAAK,aAAa,GAAG;EAChD;EAEA,IAAI,YAAY,QACd,aAAa,UAAU;EAGzB,OAAO;CACT;;;;CAKA,MAAgB,gBAAgB,KAAa,MAAiB;EAC5D,KAAK,IAAI,WAAW,GAAG;EAEvB,IAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;GACjD,KAAK,OAAO,GAAG;GACf,OAAO;EACT;EAEA,MAAM,QAAQ,KAAK;EAGnB,IAAI,UAAU,QAAQ,UAAU,QAC9B,OAAO;EAGT,MAAM,OAAO,OAAO;EACpB,IAAI,SAAS,YAAY,SAAS,YAAY,SAAS,WACrD,OAAO;EAIT,IAAI;GACF,OAAO,gBAAgB,KAAK;EAC9B,SAAS,OAAO;GACd,QAAQ,IAAI,KAAK;GAEjB,KAAK,SACH,oCAAoC,IAAI,kBAAkB,OAAO,SACjE,KACF;GACA,MAAM;EACR;CACF;;;;CAKA,MAAa,UAAU;EACrB,KAAK,IAAI,YAAY;EACrB,KAAK,IAAI,WAAW;EACpB,MAAM,KAAK,KAAK,WAAW;CAC7B;;;;CAKA,MAAa,aAAa;EACxB,KAAK,IAAI,cAAc;EACvB,MAAM,KAAK,KAAK,cAAc;CAChC;;;;CAKA,AAAO,KAAK,MAAqB;EAC/B,OAAO,IAAI,YAAY,MAAM,IAAI;CACnC;;;;;;;;CASA,MAAa,OACX,KACA,IACA,UAA8B,CAAC,GACZ;EACnB,MAAM,YAAY,KAAK,SAAS,GAAG;EAOnC,MAAM,QAFW,KAAK,MAAM,IAAI,SAAS,KAAK,QAAQ,QAAQ,EAEzC,CAClB,YAAY,MAAS,CAAC,CACtB,KAAK,YAAY;GAEhB,MAAM,SAAS,MAAM,GAAG,MADD,KAAK,IAAI,GAAG,CACJ;GAE/B,IAAI,WAAW,MAAM;IACnB,MAAM,KAAK,OAAO,GAAG;IACrB,OAAO;GACT;GAEA,IAAI,QAAQ,QAAQ,QAAW;IAC7B,MAAM,KAAK,IAAI,KAAK,QAAQ,EAAE,KAAK,QAAQ,IAAI,CAAC;IAEhD,OAAO;GACT;GAIA,MAAM,eAAe,MAAM,KAAK,gBAAgB,GAAG;GAEnD,IAAI,iBAAiB,QACnB,MAAM,KAAK,IAAI,KAAK,QAAQ,EAAE,KAAK,aAAa,CAAC;QAEjD,MAAM,KAAK,IAAI,KAAK,MAAM;GAG5B,OAAO;EACT,CAAC;EAEH,KAAK,MAAM,IAAI,WAAW,IAAI;EAI9B,KAAK,cAAc;GACjB,IAAI,KAAK,MAAM,IAAI,SAAS,MAAM,MAChC,KAAK,MAAM,OAAO,SAAS;EAE/B,CAAC;EAED,OAAO;CACT;;;;CAKA,MAAa,MACX,KACA,SACA,UAA8B,CAAC,GACnB;EAUZ,OAAO,MATc,KAAK,OACxB,MACC,YAAY;GAEX,OAAO;IAAE,GADK,WAAW,CAAC;IACR,GAAG;GAAQ;EAC/B,GACA,OACF;CAGF;;;;;;;CAQA,AAAO,KAAc,KAAqC;EACxD,OAAO,IAAI,gBAAmB,MAAM,GAAG;CACzC;;;;;;;;;;;CAYA,MAAa,KACX,KACA,cACA,IACyB;EACzB,MAAM,EAAE,KAAK,UAAU,KAAK,qBAAqB,YAAY;EAC7D,MAAM,YAAY,SAAS,OAAO,QAAQ;EAE1C,MAAM,YAAa,MAAM,KAAK,IAAI,KAAK,WAAW;GAChD,YAAY;GACZ;EACF,CAAC;EAYD,IAAI,EANF,OAAO,cAAc,YACrB,cAAc,QACd,YAAY,YACP,UAA6B,SAC9B,OAGJ,OAAO,EAAE,UAAU,MAAM;EAG3B,IAAI;GAEF,OAAO;IAAE,UAAU;IAAM,aADL,GAAG;GACQ;EACjC,UAAU;GACR,MAAM,KAAK,OAAO,GAAG;EACvB;CACF;;;;;;;;CASA,MAAa,QACX,SACA,UAC+B;EAC/B,MAAM,IAAI,sBACR,IAAI,KAAK,KAAK,yHAChB;CACF;;;;CAKA,AAAU,qBACR,cAIA;EACA,IAAI,OAAO,iBAAiB,YAAY,OAAO,iBAAiB,UAC9D,OAAO,EAAE,KAAK,aAAa;EAG7B,OAAO;GAAE,KAAK,aAAa;GAAK,OAAO,aAAa;EAAM;CAC5D;AACF"}
|
|
1
|
+
{"version":3,"file":"base-cache-driver.mjs","names":[],"sources":["../../../../../../../cache/src/drivers/base-cache-driver.ts"],"sourcesContent":["import { log } from \"@warlock.js/logger\";\r\nimport { MemoryCacheList } from \"../list/memory-cache-list\";\r\nimport { TaggedCache } from \"../tagged-cache\";\r\nimport type {\r\n CacheConflictPolicy,\r\n CacheData,\r\n CacheDriver,\r\n CacheEventData,\r\n CacheEventHandler,\r\n CacheEventType,\r\n CacheKey,\r\n CacheListAccessor,\r\n CacheOperationType,\r\n CacheSetOptions,\r\n CacheSetResult,\r\n CacheSimilarHit,\r\n CacheSimilarOptions,\r\n CacheSwrOptions,\r\n CacheTtl,\r\n LockOptions,\r\n LockOutcome,\r\n RememberOptions,\r\n} from \"../types\";\r\nimport { CacheUnsupportedError } from \"../types\";\r\nimport {\r\n normalizeToOptions,\r\n parseCacheKey,\r\n parseTtl,\r\n resolveTtl,\r\n safeErrorInfo,\r\n} from \"../utils\";\r\n\r\n/**\r\n * Normalized form of the 3rd `set` argument.\r\n *\r\n * All drivers operate on this shape internally regardless of whether the caller\r\n * passed a positional TTL, a duration string, or a rich options object.\r\n */\r\nexport type NormalizedSetOptions = {\r\n /**\r\n * Final TTL in seconds — already merged with the driver-level default\r\n * (`this.options.ttl`). `Infinity` means \"no expiration\".\r\n *\r\n * Always populated. Drivers do NOT need to fall back to `this.ttl`\r\n * themselves — `resolveSetOptions` does the merge centrally so that\r\n * every driver respects the configured default without ceremony.\r\n */\r\n ttl: number;\r\n /**\r\n * Inline tag list, or undefined when none were provided.\r\n */\r\n tags?: string[];\r\n /**\r\n * Conflict policy. Defaults to `\"upsert\"`.\r\n */\r\n onConflict: CacheConflictPolicy;\r\n /**\r\n * Optional embedding vector for similarity retrieval. Drivers that do not\r\n * support similarity must throw {@link CacheUnsupportedError} when this is\r\n * present (rather than silently dropping it).\r\n */\r\n vector?: number[];\r\n /**\r\n * Optional freshness deadline as a millisecond timestamp. Set by `swr()`\r\n * to mark when the entry stops being \"fresh\" and becomes\r\n * \"stale-but-revalidatable.\" Drivers route this through\r\n * `prepareDataForStorage` so it persists in the wrapper.\r\n */\r\n staleAt?: number;\r\n};\r\n\r\nconst messages = {\r\n clearing: \"Clearing namespace\",\r\n cleared: \"Namespace cleared\",\r\n fetching: \"Fetching key\",\r\n fetched: \"Key fetched\",\r\n caching: \"Caching key\",\r\n cached: \"Key cached\",\r\n flushing: \"Flushing cache\",\r\n flushed: \"Cache flushed\",\r\n removing: \"Removing key\",\r\n removed: \"Key removed\",\r\n expired: \"Key expired\",\r\n notFound: \"Key not found\",\r\n connecting: \"Connecting to the cache engine.\",\r\n connected: \"Connected to the cache engine.\",\r\n disconnecting: \"Disconnecting from the cache engine.\",\r\n disconnected: \"Disconnected from the cache engine.\",\r\n connectionFailed: \"Failed to connect to the cache engine.\",\r\n error: \"Error occurred\",\r\n};\r\n\r\nexport abstract class BaseCacheDriver<\r\n ClientType,\r\n Options extends Record<string, any>,\r\n> implements CacheDriver<ClientType, Options> {\r\n /**\r\n * CLient driver\r\n */\r\n protected clientDriver!: ClientType;\r\n\r\n /**\r\n * Determine whether to log or not\r\n */\r\n protected shouldLog: boolean = true;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public get client() {\r\n return (this.clientDriver || this) as unknown as ClientType;\r\n }\r\n\r\n /**\r\n * Set logging state\r\n */\r\n public setLoggingState(shouldLog: boolean) {\r\n this.shouldLog = shouldLog;\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * Set client driver\r\n */\r\n public set client(client: ClientType) {\r\n this.clientDriver = client;\r\n }\r\n\r\n /**\r\n * Get the cache driver name\r\n */\r\n public abstract name: string;\r\n\r\n /**\r\n * Options list\r\n */\r\n public options!: Options;\r\n\r\n /**\r\n * Event listeners storage\r\n */\r\n protected eventListeners: Map<CacheEventType, Set<CacheEventHandler>> =\r\n new Map();\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public parseKey(key: CacheKey) {\r\n return parseCacheKey(key, this.options);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public setOptions(options: Options) {\r\n this.options = options || {};\r\n return this;\r\n }\r\n\r\n /**\r\n * Register an event listener\r\n */\r\n public on(event: CacheEventType, handler: CacheEventHandler): this {\r\n if (!this.eventListeners.has(event)) {\r\n this.eventListeners.set(event, new Set());\r\n }\r\n this.eventListeners.get(event)!.add(handler);\r\n return this;\r\n }\r\n\r\n /**\r\n * Remove an event listener\r\n */\r\n public off(event: CacheEventType, handler: CacheEventHandler): this {\r\n const handlers = this.eventListeners.get(event);\r\n if (handlers) {\r\n handlers.delete(handler);\r\n }\r\n return this;\r\n }\r\n\r\n /**\r\n * Register a one-time event listener\r\n */\r\n public once(event: CacheEventType, handler: CacheEventHandler): this {\r\n const onceHandler: CacheEventHandler = async (data) => {\r\n await handler(data);\r\n this.off(event, onceHandler);\r\n };\r\n return this.on(event, onceHandler);\r\n }\r\n\r\n /**\r\n * Emit an event to all registered listeners\r\n */\r\n protected async emit(\r\n event: CacheEventType,\r\n data: Partial<CacheEventData> = {},\r\n ): Promise<void> {\r\n const handlers = this.eventListeners.get(event);\r\n if (!handlers || handlers.size === 0) return;\r\n\r\n const eventData: CacheEventData = {\r\n driver: this.name,\r\n ...data,\r\n };\r\n\r\n // Execute all handlers\r\n const promises: Promise<void>[] = [];\r\n for (const handler of handlers) {\r\n try {\r\n const result = handler(eventData);\r\n if (result instanceof Promise) {\r\n promises.push(result);\r\n }\r\n } catch (error) {\r\n this.logError(`Error in event handler for '${event}'`, error);\r\n }\r\n }\r\n\r\n // Wait for all async handlers\r\n if (promises.length > 0) {\r\n await Promise.allSettled(promises);\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract removeNamespace(namespace: string): Promise<any>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract set(\r\n key: CacheKey,\r\n value: any,\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): Promise<any>;\r\n\r\n /**\r\n * Normalize the 3rd argument of a `set` call into a single shape every driver\r\n * can act on. Handles TTL parsing (number | string | Infinity), `expiresAt` →\r\n * relative TTL conversion, and mutual-exclusion validation.\r\n *\r\n * @throws {CacheConfigurationError} when `ttl` and `expiresAt` are passed together\r\n * or an unparseable duration string is supplied.\r\n */\r\n protected resolveSetOptions(\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): NormalizedSetOptions {\r\n const options = normalizeToOptions(ttlOrOptions);\r\n\r\n return {\r\n ttl: resolveTtl(options.ttl, options.expiresAt, this.ttl),\r\n tags: options.tags,\r\n onConflict: options.onConflict ?? \"upsert\",\r\n vector: options.vector,\r\n staleAt: options.staleAt,\r\n };\r\n }\r\n\r\n /**\r\n * Resolve the union of cache keys associated with any of the given tags.\r\n * Used by `similar()` to narrow the candidate pool before similarity ranking.\r\n *\r\n * Returns `null` when no tags are passed (callers should treat that as \"no filter\").\r\n */\r\n protected async getKeysForTags(\r\n tags: string[] | undefined,\r\n ): Promise<Set<string> | null> {\r\n if (!tags || tags.length === 0) {\r\n return null;\r\n }\r\n\r\n const allKeys = new Set<string>();\r\n for (const tag of tags) {\r\n const tagKey = `cache:tags:${tag}`;\r\n const keys = ((await this.get(tagKey)) as string[] | null) || [];\r\n for (const k of keys) {\r\n allKeys.add(k);\r\n }\r\n }\r\n\r\n return allKeys;\r\n }\r\n\r\n /**\r\n * Apply tag relationships after a successful write. Called by drivers once\r\n * the value is in storage.\r\n */\r\n protected async applyTags(parsedKey: string, tags: string[]): Promise<void> {\r\n if (tags.length === 0) {\r\n return;\r\n }\r\n\r\n const tagged = this.tags(tags);\r\n await (tagged as TaggedCache).storeTagRelationship(parsedKey);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract get(key: CacheKey): Promise<any>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract remove(key: CacheKey): Promise<void>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public abstract flush(): Promise<void>;\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async has(key: CacheKey): Promise<boolean> {\r\n const value = await this.get(key);\r\n // Event is emitted by get() method\r\n return value !== null;\r\n }\r\n\r\n /**\r\n * Lock storage for preventing cache stampede\r\n */\r\n protected locks: Map<string, Promise<any>> = new Map();\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async remember(\r\n key: CacheKey,\r\n ttlOrOptions: CacheTtl | RememberOptions,\r\n callback: () => Promise<any>,\r\n ): Promise<any> {\r\n const parsedKey = this.parseKey(key);\r\n\r\n // The options-form lets callers forward tags / driver-override through to\r\n // the cache-miss write. Normalize both shapes into a single CacheSetOptions\r\n // blob so there's one path from here on.\r\n const setOptions = this.normalizeRememberOptions(ttlOrOptions);\r\n\r\n const cachedValue = await this.get(key);\r\n if (cachedValue) {\r\n return cachedValue;\r\n }\r\n\r\n const existingLock = this.locks.get(parsedKey);\r\n if (existingLock) {\r\n return existingLock;\r\n }\r\n\r\n const promise = callback()\r\n .then(async (result) => {\r\n await this.set(key, result, setOptions);\r\n this.locks.delete(parsedKey);\r\n return result;\r\n })\r\n .catch((err) => {\r\n this.locks.delete(parsedKey);\r\n throw err;\r\n });\r\n\r\n this.locks.set(parsedKey, promise);\r\n return promise;\r\n }\r\n\r\n /**\r\n * Resolve the TTL-or-options arg of `remember` into a `CacheSetOptions` object\r\n * that can be passed straight to `set()`. Keeps the implementation unbranched.\r\n */\r\n protected normalizeRememberOptions(\r\n ttlOrOptions: CacheTtl | RememberOptions,\r\n ): CacheSetOptions {\r\n if (typeof ttlOrOptions === \"number\" || typeof ttlOrOptions === \"string\") {\r\n return { ttl: ttlOrOptions };\r\n }\r\n\r\n return {\r\n ttl: ttlOrOptions.ttl,\r\n tags: ttlOrOptions.tags,\r\n };\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read raw entry, branch on freshness/staleness,\r\n * trigger background refresh in the stale window, fall through to\r\n * `callback` on miss/expiry. Concurrent stale-window callers share a\r\n * single in-flight refresh via {@link locks}.\r\n *\r\n * Drivers without a real {@link getEntry} override degrade gracefully —\r\n * the synthetic entry has no `staleAt`, which the freshness check treats\r\n * as \"always fresh,\" so SWR behaves like a TTL-only cached read on those\r\n * drivers (no background refresh, but no double-fetch either).\r\n */\r\n public async swr<T = any>(\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n ): Promise<T> {\r\n const parsedKey = this.parseKey(key);\r\n const freshSeconds = parseTtl(options.freshTtl);\r\n const staleSeconds = parseTtl(options.staleTtl);\r\n\r\n if (staleSeconds <= freshSeconds) {\r\n throw new Error(\r\n `cache.swr: 'staleTtl' (${staleSeconds}s) must be greater than 'freshTtl' (${freshSeconds}s).`,\r\n );\r\n }\r\n\r\n const entry = await this.getEntry(key);\r\n const now = Date.now();\r\n\r\n const isExpired = entry?.expiresAt !== undefined && entry.expiresAt <= now;\r\n\r\n if (!entry || isExpired) {\r\n return this.swrFetchAndStore<T>(\r\n key,\r\n options,\r\n callback,\r\n freshSeconds,\r\n staleSeconds,\r\n );\r\n }\r\n\r\n const isFresh = entry.staleAt === undefined || entry.staleAt > now;\r\n\r\n if (isFresh) {\r\n return entry.data as T;\r\n }\r\n\r\n this.scheduleSwrRefresh<T>(\r\n parsedKey,\r\n key,\r\n options,\r\n callback,\r\n freshSeconds,\r\n staleSeconds,\r\n );\r\n\r\n return entry.data as T;\r\n }\r\n\r\n /**\r\n * Read the raw {@link CacheData} wrapper for a key, including any\r\n * `expiresAt` / `staleAt` metadata. Default implementation falls back to\r\n * `get()` and synthesizes a metadata-less wrapper — drivers that store\r\n * the wrapper directly (memory, lru, file, redis, pg, mock) override\r\n * this to return real metadata so SWR can branch on freshness.\r\n */\r\n protected async getEntry(key: CacheKey): Promise<CacheData | null> {\r\n const value = await this.get(key);\r\n\r\n if (value === null) {\r\n return null;\r\n }\r\n\r\n return { data: value };\r\n }\r\n\r\n /**\r\n * Remaining lifetime of an existing entry, in seconds — used by TTL-preserving\r\n * writes such as `update()` / `merge()` when the caller passes no explicit\r\n * `ttl`.\r\n *\r\n * - `Infinity` — the entry exists with no expiry (preserve \"never expires\").\r\n * - positive number — seconds left before the entry expires.\r\n * - `undefined` — the key is missing or already past its deadline; the caller\r\n * should fall back to the driver default TTL.\r\n *\r\n * Default reads `expiresAt` from {@link getEntry}, which the metadata-aware\r\n * drivers (memory, lru, mock, pg) populate. Drivers that track TTL natively\r\n * and don't carry `expiresAt` in their payload (Redis) override this.\r\n */\r\n protected async getRemainingTtl(key: CacheKey): Promise<number | undefined> {\r\n const entry = await this.getEntry(key);\r\n\r\n if (!entry) {\r\n return undefined;\r\n }\r\n\r\n if (!entry.expiresAt || entry.expiresAt === Infinity) {\r\n return Infinity;\r\n }\r\n\r\n const remainingSeconds = Math.ceil((entry.expiresAt - Date.now()) / 1000);\r\n\r\n return remainingSeconds > 0 ? remainingSeconds : undefined;\r\n }\r\n\r\n /**\r\n * Block-and-fetch path of `swr()`: invoked on miss or past-`staleTtl`\r\n * expiry. Writes through `set()` with the SWR options translated into\r\n * standard `CacheSetOptions` (ttl = staleTtl, staleAt = now + freshTtl).\r\n */\r\n protected async swrFetchAndStore<T>(\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n freshSeconds: number,\r\n staleSeconds: number,\r\n ): Promise<T> {\r\n const result = await callback();\r\n\r\n await this.set(key, result, {\r\n ttl: staleSeconds,\r\n staleAt: Date.now() + freshSeconds * 1000,\r\n tags: options.tags,\r\n });\r\n\r\n return result;\r\n }\r\n\r\n /**\r\n * Stale-window background refresh. Registers a single in-flight promise\r\n * per parsed key so concurrent SWR callers share one refresh. Failed\r\n * refreshes preserve the stale entry, log via `logError`, and emit on\r\n * `error` — the stale-returning caller never sees the failure.\r\n */\r\n protected scheduleSwrRefresh<T>(\r\n parsedKey: string,\r\n key: CacheKey,\r\n options: CacheSwrOptions,\r\n callback: () => Promise<T>,\r\n freshSeconds: number,\r\n staleSeconds: number,\r\n ): void {\r\n if (this.locks.has(parsedKey)) {\r\n return;\r\n }\r\n\r\n let refresh!: Promise<void>;\r\n refresh = (async () => {\r\n try {\r\n const result = await callback();\r\n\r\n await this.set(key, result, {\r\n ttl: staleSeconds,\r\n staleAt: Date.now() + freshSeconds * 1000,\r\n tags: options.tags,\r\n });\r\n } catch (error) {\r\n this.logError(`SWR background refresh failed for ${parsedKey}`, error);\r\n await this.emit(\"error\", { key: parsedKey, error });\r\n } finally {\r\n if (this.locks.get(parsedKey) === refresh) {\r\n this.locks.delete(parsedKey);\r\n }\r\n }\r\n })();\r\n\r\n this.locks.set(parsedKey, refresh);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async pull(key: CacheKey): Promise<any | null> {\r\n const value = await this.get(key);\r\n if (value !== null) {\r\n await this.remove(key);\r\n }\r\n // Events are emitted by get() and remove() methods\r\n return value;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async forever(key: CacheKey, value: any): Promise<any> {\r\n // Event is emitted by set() method\r\n return this.set(key, value, Infinity);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async increment(key: CacheKey, value: number = 1): Promise<number> {\r\n const current = (await this.get(key)) || 0;\r\n\r\n if (typeof current !== \"number\") {\r\n throw new Error(\r\n `Cannot increment non-numeric value for key: ${this.parseKey(key)}`,\r\n );\r\n }\r\n\r\n const newValue = current + value;\r\n await this.set(key, newValue);\r\n return newValue;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async decrement(key: CacheKey, value: number = 1): Promise<number> {\r\n return this.increment(key, -value);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async many(keys: CacheKey[]): Promise<any[]> {\r\n return Promise.all(keys.map((key) => this.get(key)));\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async setMany(\r\n items: Record<string, any>,\r\n ttl?: number,\r\n ): Promise<void> {\r\n await Promise.all(\r\n Object.entries(items).map(([key, value]) => this.set(key, value, ttl)),\r\n );\r\n }\r\n\r\n /**\r\n * Log the operation\r\n */\r\n protected log(operation: CacheOperationType, key?: string | any) {\r\n if (!this.shouldLog) return;\r\n\r\n if (typeof key === \"string\") {\r\n // this will be likely used with file cache driver as it will convert the dot to slash\r\n // to make it consistent and not to confuse developers we will output the key by making sure it's a dot\r\n key = key.replace(/\\//g, \".\");\r\n }\r\n\r\n if (operation === \"connectionFailed\") {\r\n log.fatal(`cache.${this.name}`, operation, key);\r\n }\r\n\r\n if (operation == \"notFound\" || operation == \"expired\") {\r\n return log.warn(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n if (operation.endsWith(\"ed\")) {\r\n return log.success(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n log.info(\r\n \"cache.\" + this.name,\r\n operation,\r\n (key ? key + \" \" : \"\") + messages[operation],\r\n );\r\n }\r\n\r\n /**\r\n * Log error message\r\n *\r\n * Never logs the raw `error` object — driver connection errors (Redis,\r\n * Postgres, ...) can carry the connection string, including the password,\r\n * in the message/cause. Only a redacted `{ message, code }` shape is\r\n * passed to the structured logger.\r\n */\r\n protected logError(message: string, error?: any) {\r\n if (error) {\r\n log.error(\"cache.\" + this.name, \"error\", message, safeErrorInfo(error));\r\n } else {\r\n log.error(\"cache.\" + this.name, \"error\", message);\r\n }\r\n }\r\n\r\n /**\r\n * Get the default TTL in seconds. Parses human-readable strings (`\"1h\"`, `\"30m\"`)\r\n * from driver options if present; falls back to `Infinity` when no default is set.\r\n */\r\n public get ttl() {\r\n if (this.options.ttl === undefined) {\r\n return Infinity;\r\n }\r\n\r\n return parseTtl(this.options.ttl);\r\n }\r\n\r\n /**\r\n * Get time to live value in milliseconds\r\n */\r\n public getExpiresAt(ttl: number = this.ttl) {\r\n if (ttl) {\r\n return new Date().getTime() + ttl * 1000;\r\n }\r\n }\r\n\r\n /**\r\n * Wrap a value with TTL and optional freshness metadata for backend\r\n * storage. `staleAt` persists alongside `expiresAt` when supplied — used\r\n * by the SWR flow to mark when the entry stops being fresh.\r\n */\r\n protected prepareDataForStorage(data: any, ttl?: number, staleAt?: number) {\r\n const preparedData: CacheData = {\r\n data,\r\n };\r\n\r\n if (ttl) {\r\n preparedData.ttl = ttl;\r\n preparedData.expiresAt = this.getExpiresAt(ttl);\r\n }\r\n\r\n if (staleAt !== undefined) {\r\n preparedData.staleAt = staleAt;\r\n }\r\n\r\n return preparedData;\r\n }\r\n\r\n /**\r\n * Parse fetched data from cache\r\n */\r\n protected async parseCachedData(key: string, data: CacheData) {\r\n this.log(\"fetched\", key);\r\n\r\n if (data.expiresAt && data.expiresAt < Date.now()) {\r\n this.remove(key);\r\n return null;\r\n }\r\n\r\n const value = data.data;\r\n\r\n // Skip cloning for primitives (immutable types)\r\n if (value === null || value === undefined) {\r\n return value;\r\n }\r\n\r\n const type = typeof value;\r\n if (type === \"string\" || type === \"number\" || type === \"boolean\") {\r\n return value;\r\n }\r\n\r\n // Deep clone objects/arrays to prevent cache mutation\r\n try {\r\n return structuredClone(value);\r\n } catch (error) {\r\n this.logError(\r\n `Failed to clone cached value for ${key}, typeof value: ${typeof value}`,\r\n error,\r\n );\r\n throw error;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async connect() {\r\n this.log(\"connecting\");\r\n this.log(\"connected\");\r\n await this.emit(\"connected\");\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async disconnect() {\r\n this.log(\"disconnected\");\r\n await this.emit(\"disconnected\");\r\n }\r\n\r\n /**\r\n * Create a tagged cache instance for the given tags\r\n */\r\n public tags(tags: string[]): any {\r\n return new TaggedCache(tags, this);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read → transform → write under a per-key in-process\r\n * lock. Drivers that can offer stronger semantics (Redis via `WATCH`/`MULTI`)\r\n * should override.\r\n */\r\n public async update<T = any>(\r\n key: CacheKey,\r\n fn: (current: T | null) => T | null | Promise<T | null>,\r\n options: { ttl?: CacheTtl } = {},\r\n ): Promise<T | null> {\r\n const parsedKey = this.parseKey(key);\r\n\r\n // Chain each update onto the previous one for the same key so concurrent\r\n // callers are serialized end-to-end, not merely awakened together when an\r\n // earlier lock resolves.\r\n const previous = this.locks.get(parsedKey) ?? Promise.resolve();\r\n\r\n const next = previous\r\n .catch(() => undefined)\r\n .then(async () => {\r\n const current = (await this.get(key)) as T | null;\r\n const result = await fn(current);\r\n\r\n if (result === null) {\r\n await this.remove(key);\r\n return null;\r\n }\r\n\r\n if (options.ttl !== undefined) {\r\n await this.set(key, result, { ttl: options.ttl });\r\n\r\n return result;\r\n }\r\n\r\n // No explicit TTL → preserve the existing entry's remaining lifetime\r\n // rather than resetting it to the driver default.\r\n const remainingTtl = await this.getRemainingTtl(key);\r\n\r\n if (remainingTtl !== undefined) {\r\n await this.set(key, result, { ttl: remainingTtl });\r\n } else {\r\n await this.set(key, result);\r\n }\r\n\r\n return result;\r\n });\r\n\r\n this.locks.set(parsedKey, next);\r\n\r\n // Clean up the slot once this link finishes — but only if nobody chained\r\n // a follow-up onto it in the meantime.\r\n next.finally(() => {\r\n if (this.locks.get(parsedKey) === next) {\r\n this.locks.delete(parsedKey);\r\n }\r\n });\r\n\r\n return next;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async merge<T extends Record<string, any> = Record<string, any>>(\r\n key: CacheKey,\r\n partial: Partial<T>,\r\n options: { ttl?: CacheTtl } = {},\r\n ): Promise<T> {\r\n const result = await this.update<T>(\r\n key,\r\n (current) => {\r\n const base = (current ?? {}) as T;\r\n return { ...base, ...partial } as T;\r\n },\r\n options,\r\n );\r\n\r\n return result as T;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation: read-mutate-write array backed by the underlying\r\n * cache entry. Concrete drivers (e.g. Redis) override with native commands.\r\n */\r\n public list<T = any>(key: CacheKey): CacheListAccessor<T> {\r\n return new MemoryCacheList<T>(this, key);\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Built on top of `set({ onConflict: \"create\" })` — Redis-native `SET … NX EX`\r\n * under the hood on Redis, emulated via key-existence check on other drivers.\r\n * The lock value is the resolved `owner` (defaults to `pid.<process.pid>`).\r\n *\r\n * Always releases in `finally`, even if `fn` throws — the thrown error\r\n * propagates to the caller unchanged.\r\n */\r\n public async lock<T>(\r\n key: CacheKey,\r\n ttlOrOptions: CacheTtl | Omit<LockOptions, \"driver\">,\r\n fn: () => Promise<T>,\r\n ): Promise<LockOutcome<T>> {\r\n const { ttl, owner } = this.normalizeLockOptions(ttlOrOptions);\r\n const lockOwner = owner ?? `pid.${process.pid}`;\r\n\r\n const setResult = (await this.set(key, lockOwner, {\r\n onConflict: \"create\",\r\n ttl,\r\n })) as CacheSetResult | unknown;\r\n\r\n // `onConflict` drivers return CacheSetResult. Drivers that no-op on set\r\n // (e.g. the null driver) may return anything else — treat that as\r\n // \"acquired\" since there's nothing to collide with.\r\n const wasSet =\r\n typeof setResult === \"object\" &&\r\n setResult !== null &&\r\n \"wasSet\" in setResult\r\n ? (setResult as CacheSetResult).wasSet\r\n : true;\r\n\r\n if (!wasSet) {\r\n return { acquired: false };\r\n }\r\n\r\n try {\r\n const value = await fn();\r\n return { acquired: true, value };\r\n } finally {\r\n await this.remove(key);\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Default implementation throws {@link CacheUnsupportedError}. Drivers that\r\n * support similarity retrieval (memory family, `pg`, `redis` w/ RediSearch)\r\n * override this with a real impl.\r\n */\r\n public async similar<T = any>(\r\n _vector: number[],\r\n _options: CacheSimilarOptions,\r\n ): Promise<CacheSimilarHit<T>[]> {\r\n throw new CacheUnsupportedError(\r\n `'${this.name}' driver does not support similarity retrieval. Use a memory driver, 'pg' (with pgvector), or 'redis' (with RediSearch).`,\r\n );\r\n }\r\n\r\n /**\r\n * Resolve the TTL-or-options arg of `lock` into a uniform shape.\r\n */\r\n protected normalizeLockOptions(\r\n ttlOrOptions: CacheTtl | Omit<LockOptions, \"driver\">,\r\n ): {\r\n ttl: CacheTtl;\r\n owner?: string;\r\n } {\r\n if (typeof ttlOrOptions === \"number\" || typeof ttlOrOptions === \"string\") {\r\n return { ttl: ttlOrOptions };\r\n }\r\n\r\n return { ttl: ttlOrOptions.ttl, owner: ttlOrOptions.owner };\r\n }\r\n}\r\n"],"mappings":";;;;;;;AAuEA,MAAM,WAAW;CACf,UAAU;CACV,SAAS;CACT,UAAU;CACV,SAAS;CACT,SAAS;CACT,QAAQ;CACR,UAAU;CACV,SAAS;CACT,UAAU;CACV,SAAS;CACT,SAAS;CACT,UAAU;CACV,YAAY;CACZ,WAAW;CACX,eAAe;CACf,cAAc;CACd,kBAAkB;CAClB,OAAO;AACT;AAEA,IAAsB,kBAAtB,MAG8C;;mBASb;wCAuC7B,IAAI,IAAI;+BAyLmC,IAAI,IAAI;;;;;CA3NrD,IAAW,SAAS;EAClB,OAAQ,KAAK,gBAAgB;CAC/B;;;;CAKA,AAAO,gBAAgB,WAAoB;EACzC,KAAK,YAAY;EAEjB,OAAO;CACT;;;;CAKA,IAAW,OAAO,QAAoB;EACpC,KAAK,eAAe;CACtB;;;;CAqBA,AAAO,SAAS,KAAe;EAC7B,OAAO,cAAc,KAAK,KAAK,OAAO;CACxC;;;;CAKA,AAAO,WAAW,SAAkB;EAClC,KAAK,UAAU,WAAW,CAAC;EAC3B,OAAO;CACT;;;;CAKA,AAAO,GAAG,OAAuB,SAAkC;EACjE,IAAI,CAAC,KAAK,eAAe,IAAI,KAAK,GAChC,KAAK,eAAe,IAAI,uBAAO,IAAI,IAAI,CAAC;EAE1C,KAAK,eAAe,IAAI,KAAK,CAAC,CAAE,IAAI,OAAO;EAC3C,OAAO;CACT;;;;CAKA,AAAO,IAAI,OAAuB,SAAkC;EAClE,MAAM,WAAW,KAAK,eAAe,IAAI,KAAK;EAC9C,IAAI,UACF,SAAS,OAAO,OAAO;EAEzB,OAAO;CACT;;;;CAKA,AAAO,KAAK,OAAuB,SAAkC;EACnE,MAAM,cAAiC,OAAO,SAAS;GACrD,MAAM,QAAQ,IAAI;GAClB,KAAK,IAAI,OAAO,WAAW;EAC7B;EACA,OAAO,KAAK,GAAG,OAAO,WAAW;CACnC;;;;CAKA,MAAgB,KACd,OACA,OAAgC,CAAC,GAClB;EACf,MAAM,WAAW,KAAK,eAAe,IAAI,KAAK;EAC9C,IAAI,CAAC,YAAY,SAAS,SAAS,GAAG;EAEtC,MAAM,YAA4B;GAChC,QAAQ,KAAK;GACb,GAAG;EACL;EAGA,MAAM,WAA4B,CAAC;EACnC,KAAK,MAAM,WAAW,UACpB,IAAI;GACF,MAAM,SAAS,QAAQ,SAAS;GAChC,IAAI,kBAAkB,SACpB,SAAS,KAAK,MAAM;EAExB,SAAS,OAAO;GACd,KAAK,SAAS,+BAA+B,MAAM,IAAI,KAAK;EAC9D;EAIF,IAAI,SAAS,SAAS,GACpB,MAAM,QAAQ,WAAW,QAAQ;CAErC;;;;;;;;;CAwBA,AAAU,kBACR,cACsB;EACtB,MAAM,UAAU,mBAAmB,YAAY;EAE/C,OAAO;GACL,KAAK,WAAW,QAAQ,KAAK,QAAQ,WAAW,KAAK,GAAG;GACxD,MAAM,QAAQ;GACd,YAAY,QAAQ,cAAc;GAClC,QAAQ,QAAQ;GAChB,SAAS,QAAQ;EACnB;CACF;;;;;;;CAQA,MAAgB,eACd,MAC6B;EAC7B,IAAI,CAAC,QAAQ,KAAK,WAAW,GAC3B,OAAO;EAGT,MAAM,0BAAU,IAAI,IAAY;EAChC,KAAK,MAAM,OAAO,MAAM;GACtB,MAAM,SAAS,cAAc;GAC7B,MAAM,OAAS,MAAM,KAAK,IAAI,MAAM,KAA0B,CAAC;GAC/D,KAAK,MAAM,KAAK,MACd,QAAQ,IAAI,CAAC;EAEjB;EAEA,OAAO;CACT;;;;;CAMA,MAAgB,UAAU,WAAmB,MAA+B;EAC1E,IAAI,KAAK,WAAW,GAClB;EAIF,MADe,KAAK,KAAK,IACb,CAAC,CAAiB,qBAAqB,SAAS;CAC9D;;;;CAoBA,MAAa,IAAI,KAAiC;EAGhD,OAAO,MAFa,KAAK,IAAI,GAAG,MAEf;CACnB;;;;CAUA,MAAa,SACX,KACA,cACA,UACc;EACd,MAAM,YAAY,KAAK,SAAS,GAAG;EAKnC,MAAM,aAAa,KAAK,yBAAyB,YAAY;EAE7D,MAAM,cAAc,MAAM,KAAK,IAAI,GAAG;EACtC,IAAI,aACF,OAAO;EAGT,MAAM,eAAe,KAAK,MAAM,IAAI,SAAS;EAC7C,IAAI,cACF,OAAO;EAGT,MAAM,UAAU,SAAS,CAAC,CACvB,KAAK,OAAO,WAAW;GACtB,MAAM,KAAK,IAAI,KAAK,QAAQ,UAAU;GACtC,KAAK,MAAM,OAAO,SAAS;GAC3B,OAAO;EACT,CAAC,CAAC,CACD,OAAO,QAAQ;GACd,KAAK,MAAM,OAAO,SAAS;GAC3B,MAAM;EACR,CAAC;EAEH,KAAK,MAAM,IAAI,WAAW,OAAO;EACjC,OAAO;CACT;;;;;CAMA,AAAU,yBACR,cACiB;EACjB,IAAI,OAAO,iBAAiB,YAAY,OAAO,iBAAiB,UAC9D,OAAO,EAAE,KAAK,aAAa;EAG7B,OAAO;GACL,KAAK,aAAa;GAClB,MAAM,aAAa;EACrB;CACF;;;;;;;;;;;;;;CAeA,MAAa,IACX,KACA,SACA,UACY;EACZ,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,eAAe,SAAS,QAAQ,QAAQ;EAC9C,MAAM,eAAe,SAAS,QAAQ,QAAQ;EAE9C,IAAI,gBAAgB,cAClB,MAAM,IAAI,MACR,0BAA0B,aAAa,sCAAsC,aAAa,IAC5F;EAGF,MAAM,QAAQ,MAAM,KAAK,SAAS,GAAG;EACrC,MAAM,MAAM,KAAK,IAAI;EAErB,MAAM,YAAY,OAAO,cAAc,UAAa,MAAM,aAAa;EAEvE,IAAI,CAAC,SAAS,WACZ,OAAO,KAAK,iBACV,KACA,SACA,UACA,cACA,YACF;EAKF,IAFgB,MAAM,YAAY,UAAa,MAAM,UAAU,KAG7D,OAAO,MAAM;EAGf,KAAK,mBACH,WACA,KACA,SACA,UACA,cACA,YACF;EAEA,OAAO,MAAM;CACf;;;;;;;;CASA,MAAgB,SAAS,KAA0C;EACjE,MAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;EAEhC,IAAI,UAAU,MACZ,OAAO;EAGT,OAAO,EAAE,MAAM,MAAM;CACvB;;;;;;;;;;;;;;;CAgBA,MAAgB,gBAAgB,KAA4C;EAC1E,MAAM,QAAQ,MAAM,KAAK,SAAS,GAAG;EAErC,IAAI,CAAC,OACH;EAGF,IAAI,CAAC,MAAM,aAAa,MAAM,cAAc,UAC1C,OAAO;EAGT,MAAM,mBAAmB,KAAK,MAAM,MAAM,YAAY,KAAK,IAAI,KAAK,GAAI;EAExE,OAAO,mBAAmB,IAAI,mBAAmB;CACnD;;;;;;CAOA,MAAgB,iBACd,KACA,SACA,UACA,cACA,cACY;EACZ,MAAM,SAAS,MAAM,SAAS;EAE9B,MAAM,KAAK,IAAI,KAAK,QAAQ;GAC1B,KAAK;GACL,SAAS,KAAK,IAAI,IAAI,eAAe;GACrC,MAAM,QAAQ;EAChB,CAAC;EAED,OAAO;CACT;;;;;;;CAQA,AAAU,mBACR,WACA,KACA,SACA,UACA,cACA,cACM;EACN,IAAI,KAAK,MAAM,IAAI,SAAS,GAC1B;EAGF,IAAI;EACJ,WAAW,YAAY;GACrB,IAAI;IACF,MAAM,SAAS,MAAM,SAAS;IAE9B,MAAM,KAAK,IAAI,KAAK,QAAQ;KAC1B,KAAK;KACL,SAAS,KAAK,IAAI,IAAI,eAAe;KACrC,MAAM,QAAQ;IAChB,CAAC;GACH,SAAS,OAAO;IACd,KAAK,SAAS,qCAAqC,aAAa,KAAK;IACrE,MAAM,KAAK,KAAK,SAAS;KAAE,KAAK;KAAW;IAAM,CAAC;GACpD,UAAU;IACR,IAAI,KAAK,MAAM,IAAI,SAAS,MAAM,SAChC,KAAK,MAAM,OAAO,SAAS;GAE/B;EACF,EAAC,CAAE;EAEH,KAAK,MAAM,IAAI,WAAW,OAAO;CACnC;;;;CAKA,MAAa,KAAK,KAAoC;EACpD,MAAM,QAAQ,MAAM,KAAK,IAAI,GAAG;EAChC,IAAI,UAAU,MACZ,MAAM,KAAK,OAAO,GAAG;EAGvB,OAAO;CACT;;;;CAKA,MAAa,QAAQ,KAAe,OAA0B;EAE5D,OAAO,KAAK,IAAI,KAAK,OAAO,QAAQ;CACtC;;;;CAKA,MAAa,UAAU,KAAe,QAAgB,GAAoB;EACxE,MAAM,UAAW,MAAM,KAAK,IAAI,GAAG,KAAM;EAEzC,IAAI,OAAO,YAAY,UACrB,MAAM,IAAI,MACR,+CAA+C,KAAK,SAAS,GAAG,GAClE;EAGF,MAAM,WAAW,UAAU;EAC3B,MAAM,KAAK,IAAI,KAAK,QAAQ;EAC5B,OAAO;CACT;;;;CAKA,MAAa,UAAU,KAAe,QAAgB,GAAoB;EACxE,OAAO,KAAK,UAAU,KAAK,CAAC,KAAK;CACnC;;;;CAKA,MAAa,KAAK,MAAkC;EAClD,OAAO,QAAQ,IAAI,KAAK,KAAK,QAAQ,KAAK,IAAI,GAAG,CAAC,CAAC;CACrD;;;;CAKA,MAAa,QACX,OACA,KACe;EACf,MAAM,QAAQ,IACZ,OAAO,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW,KAAK,IAAI,KAAK,OAAO,GAAG,CAAC,CACvE;CACF;;;;CAKA,AAAU,IAAI,WAA+B,KAAoB;EAC/D,IAAI,CAAC,KAAK,WAAW;EAErB,IAAI,OAAO,QAAQ,UAGjB,MAAM,IAAI,QAAQ,OAAO,GAAG;EAG9B,IAAI,cAAc,oBAChB,IAAI,MAAM,SAAS,KAAK,QAAQ,WAAW,GAAG;EAGhD,IAAI,aAAa,cAAc,aAAa,WAC1C,OAAO,IAAI,KACT,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;EAGF,IAAI,UAAU,SAAS,IAAI,GACzB,OAAO,IAAI,QACT,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;EAGF,IAAI,KACF,WAAW,KAAK,MAChB,YACC,MAAM,MAAM,MAAM,MAAM,SAAS,UACpC;CACF;;;;;;;;;CAUA,AAAU,SAAS,SAAiB,OAAa;EAC/C,IAAI,OACF,IAAI,MAAM,WAAW,KAAK,MAAM,SAAS,SAAS,cAAc,KAAK,CAAC;OAEtE,IAAI,MAAM,WAAW,KAAK,MAAM,SAAS,OAAO;CAEpD;;;;;CAMA,IAAW,MAAM;EACf,IAAI,KAAK,QAAQ,QAAQ,QACvB,OAAO;EAGT,OAAO,SAAS,KAAK,QAAQ,GAAG;CAClC;;;;CAKA,AAAO,aAAa,MAAc,KAAK,KAAK;EAC1C,IAAI,KACF,wBAAO,IAAI,KAAK,EAAC,CAAC,QAAQ,IAAI,MAAM;CAExC;;;;;;CAOA,AAAU,sBAAsB,MAAW,KAAc,SAAkB;EACzE,MAAM,eAA0B,EAC9B,KACF;EAEA,IAAI,KAAK;GACP,aAAa,MAAM;GACnB,aAAa,YAAY,KAAK,aAAa,GAAG;EAChD;EAEA,IAAI,YAAY,QACd,aAAa,UAAU;EAGzB,OAAO;CACT;;;;CAKA,MAAgB,gBAAgB,KAAa,MAAiB;EAC5D,KAAK,IAAI,WAAW,GAAG;EAEvB,IAAI,KAAK,aAAa,KAAK,YAAY,KAAK,IAAI,GAAG;GACjD,KAAK,OAAO,GAAG;GACf,OAAO;EACT;EAEA,MAAM,QAAQ,KAAK;EAGnB,IAAI,UAAU,QAAQ,UAAU,QAC9B,OAAO;EAGT,MAAM,OAAO,OAAO;EACpB,IAAI,SAAS,YAAY,SAAS,YAAY,SAAS,WACrD,OAAO;EAIT,IAAI;GACF,OAAO,gBAAgB,KAAK;EAC9B,SAAS,OAAO;GACd,KAAK,SACH,oCAAoC,IAAI,kBAAkB,OAAO,SACjE,KACF;GACA,MAAM;EACR;CACF;;;;CAKA,MAAa,UAAU;EACrB,KAAK,IAAI,YAAY;EACrB,KAAK,IAAI,WAAW;EACpB,MAAM,KAAK,KAAK,WAAW;CAC7B;;;;CAKA,MAAa,aAAa;EACxB,KAAK,IAAI,cAAc;EACvB,MAAM,KAAK,KAAK,cAAc;CAChC;;;;CAKA,AAAO,KAAK,MAAqB;EAC/B,OAAO,IAAI,YAAY,MAAM,IAAI;CACnC;;;;;;;;CASA,MAAa,OACX,KACA,IACA,UAA8B,CAAC,GACZ;EACnB,MAAM,YAAY,KAAK,SAAS,GAAG;EAOnC,MAAM,QAFW,KAAK,MAAM,IAAI,SAAS,KAAK,QAAQ,QAAQ,EAEzC,CAClB,YAAY,MAAS,CAAC,CACtB,KAAK,YAAY;GAEhB,MAAM,SAAS,MAAM,GAAG,MADD,KAAK,IAAI,GAAG,CACJ;GAE/B,IAAI,WAAW,MAAM;IACnB,MAAM,KAAK,OAAO,GAAG;IACrB,OAAO;GACT;GAEA,IAAI,QAAQ,QAAQ,QAAW;IAC7B,MAAM,KAAK,IAAI,KAAK,QAAQ,EAAE,KAAK,QAAQ,IAAI,CAAC;IAEhD,OAAO;GACT;GAIA,MAAM,eAAe,MAAM,KAAK,gBAAgB,GAAG;GAEnD,IAAI,iBAAiB,QACnB,MAAM,KAAK,IAAI,KAAK,QAAQ,EAAE,KAAK,aAAa,CAAC;QAEjD,MAAM,KAAK,IAAI,KAAK,MAAM;GAG5B,OAAO;EACT,CAAC;EAEH,KAAK,MAAM,IAAI,WAAW,IAAI;EAI9B,KAAK,cAAc;GACjB,IAAI,KAAK,MAAM,IAAI,SAAS,MAAM,MAChC,KAAK,MAAM,OAAO,SAAS;EAE/B,CAAC;EAED,OAAO;CACT;;;;CAKA,MAAa,MACX,KACA,SACA,UAA8B,CAAC,GACnB;EAUZ,OAAO,MATc,KAAK,OACxB,MACC,YAAY;GAEX,OAAO;IAAE,GADK,WAAW,CAAC;IACR,GAAG;GAAQ;EAC/B,GACA,OACF;CAGF;;;;;;;CAQA,AAAO,KAAc,KAAqC;EACxD,OAAO,IAAI,gBAAmB,MAAM,GAAG;CACzC;;;;;;;;;;;CAYA,MAAa,KACX,KACA,cACA,IACyB;EACzB,MAAM,EAAE,KAAK,UAAU,KAAK,qBAAqB,YAAY;EAC7D,MAAM,YAAY,SAAS,OAAO,QAAQ;EAE1C,MAAM,YAAa,MAAM,KAAK,IAAI,KAAK,WAAW;GAChD,YAAY;GACZ;EACF,CAAC;EAYD,IAAI,EANF,OAAO,cAAc,YACrB,cAAc,QACd,YAAY,YACP,UAA6B,SAC9B,OAGJ,OAAO,EAAE,UAAU,MAAM;EAG3B,IAAI;GAEF,OAAO;IAAE,UAAU;IAAM,aADL,GAAG;GACQ;EACjC,UAAU;GACR,MAAM,KAAK,OAAO,GAAG;EACvB;CACF;;;;;;;;CASA,MAAa,QACX,SACA,UAC+B;EAC/B,MAAM,IAAI,sBACR,IAAI,KAAK,KAAK,yHAChB;CACF;;;;CAKA,AAAU,qBACR,cAIA;EACA,IAAI,OAAO,iBAAiB,YAAY,OAAO,iBAAiB,UAC9D,OAAO,EAAE,KAAK,aAAa;EAG7B,OAAO;GAAE,KAAK,aAAa;GAAK,OAAO,aAAa;EAAM;CAC5D;AACF"}
|
|
@@ -19,8 +19,46 @@ declare class FileCacheDriver extends BaseCacheDriver<FileCacheDriver, FileCache
|
|
|
19
19
|
* Get file name
|
|
20
20
|
*/
|
|
21
21
|
get fileName(): string;
|
|
22
|
+
/**
|
|
23
|
+
* Map a parsed cache key (or namespace) to its on-disk directory.
|
|
24
|
+
*
|
|
25
|
+
* The key must become exactly one directory component: `%` and the path
|
|
26
|
+
* separators are percent-encoded so a hostile key (`../../etc`,
|
|
27
|
+
* `..\\..\\evil`) turns into an inert directory name instead of a path
|
|
28
|
+
* traversal, while distinct keys can never collide after encoding. Dots are
|
|
29
|
+
* left untouched — the `.`-delimited namespace scheme is purely logical and
|
|
30
|
+
* only ever produces a single filesystem component here.
|
|
31
|
+
*/
|
|
32
|
+
protected keyDirectory(parsedKey: string): string;
|
|
33
|
+
/**
|
|
34
|
+
* Percent-encode a parsed key into an inert, single-component directory
|
|
35
|
+
* name. Dots are left untouched — see {@link keyDirectory}.
|
|
36
|
+
*/
|
|
37
|
+
protected encodeKeySegment(parsedKey: string): string;
|
|
38
|
+
/**
|
|
39
|
+
* Reverse of {@link encodeKeySegment} — recovers the logical, dot-delimited
|
|
40
|
+
* parsed key from an on-disk directory name. Used by {@link removeNamespace}
|
|
41
|
+
* to test which sibling directories logically belong to a namespace, since
|
|
42
|
+
* dotted keys (`ns.a`) are stored as sibling directories rather than nested
|
|
43
|
+
* ones (see {@link keyDirectory}'s doc comment).
|
|
44
|
+
*/
|
|
45
|
+
protected decodeKeySegment(encoded: string): string;
|
|
46
|
+
/**
|
|
47
|
+
* Resolve `segment` against the cache root and throw when the result lands
|
|
48
|
+
* outside it — the last line of defense against path traversal, independent
|
|
49
|
+
* of how the key was encoded.
|
|
50
|
+
*/
|
|
51
|
+
protected containedPath(segment: string): string;
|
|
22
52
|
/**
|
|
23
53
|
* {@inheritdoc}
|
|
54
|
+
*
|
|
55
|
+
* Dotted keys (`ns.a`) are stored as sibling directories, not nested ones
|
|
56
|
+
* (see {@link keyDirectory}) — a directory literally named `<namespace>`
|
|
57
|
+
* rarely exists on its own. Namespace removal therefore has to scan the
|
|
58
|
+
* cache root's immediate children and remove every directory whose
|
|
59
|
+
* *logical* (decoded) name equals the namespace or starts with
|
|
60
|
+
* `<namespace>.`, mirroring the `key = $1 OR key LIKE $2` boundary
|
|
61
|
+
* semantics the `pg` driver already uses for the same contract.
|
|
24
62
|
*/
|
|
25
63
|
removeNamespace(namespace: string): Promise<this>;
|
|
26
64
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"file-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/file-cache-driver.ts"],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"file-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/file-cache-driver.ts"],"mappings":";;;;cAoBa,eAAA,SACH,eAAA,CAAgB,eAAA,EAAiB,gBAAA,aAC9B,WAAA,CAAY,eAAA,EAAiB,gBAAA;;AAF1C;;EAOS,IAAA;EANiB;;;EAWjB,UAAA,CAAW,OAAA,EAAS,gBAAA;EAAA;;;EAAA,IAahB,SAAA;EA2IiB;;;EAAA,IA5HjB,QAAA;EA0MmB;;;;;;;;;;EAAA,UAtLpB,YAAA,CAAa,SAAA;EA1DD;;;;EAAA,UAkEZ,gBAAA,CAAiB,SAAA;EAlEhB;;;;;;;EAAA,UAgFD,gBAAA,CAAiB,OAAA;EA1ChB;;;;;EAAA,UAsDD,aAAA,CAAc,OAAA;EAZG;;;;;;;;;;;EAyCd,eAAA,CAAgB,SAAA,WAAiB,OAAA;EAyC5C;;;EAHW,GAAA,CACX,GAAA,EAAK,QAAA,EACL,KAAA,OACA,YAAA,GAAe,QAAA,GAAW,eAAA,GACzB,OAAA;EAkEU;;;;;;;;EATA,MAAA,IAAU,OAAA;EA8CN;;;EArCJ,KAAA,IAAS,OAAA;EA0EF;;;;;EAAA,UA/DJ,QAAA,CAAS,GAAA,EAAK,QAAA,GAAW,OAAA,CAAQ,SAAA;EAqG7B;AAAA;;EA3EP,GAAA,CAAI,GAAA,EAAK,QAAA,GAAQ,OAAA;;;;EAqCjB,MAAA,CAAO,GAAA,EAAK,QAAA,GAAQ,OAAA;;;;EAoBpB,KAAA,IAAK,OAAA;;;;EAkBL,OAAA,IAAO,OAAA;AAAA"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { CacheConfigurationError, CacheUnsupportedError } from "../types.mjs";
|
|
1
|
+
import { CacheConfigurationError, CacheError, CacheUnsupportedError } from "../types.mjs";
|
|
2
2
|
import { BaseCacheDriver } from "./base-cache-driver.mjs";
|
|
3
|
-
import { ensureDirectoryAsync, getJsonFileAsync, putJsonFileAsync, removeDirectoryAsync } from "@warlock.js/fs";
|
|
3
|
+
import { ensureDirectoryAsync, getJsonFileAsync, listDirectoriesAsync, putJsonFileAsync, removeDirectoryAsync } from "@warlock.js/fs";
|
|
4
4
|
import path from "path";
|
|
5
5
|
|
|
6
6
|
//#region ../cache/src/drivers/file-cache-driver.ts
|
|
@@ -33,12 +33,74 @@ var FileCacheDriver = class extends BaseCacheDriver {
|
|
|
33
33
|
return "cache.json";
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
+
* Map a parsed cache key (or namespace) to its on-disk directory.
|
|
37
|
+
*
|
|
38
|
+
* The key must become exactly one directory component: `%` and the path
|
|
39
|
+
* separators are percent-encoded so a hostile key (`../../etc`,
|
|
40
|
+
* `..\\..\\evil`) turns into an inert directory name instead of a path
|
|
41
|
+
* traversal, while distinct keys can never collide after encoding. Dots are
|
|
42
|
+
* left untouched — the `.`-delimited namespace scheme is purely logical and
|
|
43
|
+
* only ever produces a single filesystem component here.
|
|
44
|
+
*/
|
|
45
|
+
keyDirectory(parsedKey) {
|
|
46
|
+
return this.containedPath(this.encodeKeySegment(parsedKey));
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Percent-encode a parsed key into an inert, single-component directory
|
|
50
|
+
* name. Dots are left untouched — see {@link keyDirectory}.
|
|
51
|
+
*/
|
|
52
|
+
encodeKeySegment(parsedKey) {
|
|
53
|
+
return parsedKey.replace(/%/g, "%25").replace(/\//g, "%2F").replace(/\\/g, "%5C");
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Reverse of {@link encodeKeySegment} — recovers the logical, dot-delimited
|
|
57
|
+
* parsed key from an on-disk directory name. Used by {@link removeNamespace}
|
|
58
|
+
* to test which sibling directories logically belong to a namespace, since
|
|
59
|
+
* dotted keys (`ns.a`) are stored as sibling directories rather than nested
|
|
60
|
+
* ones (see {@link keyDirectory}'s doc comment).
|
|
61
|
+
*/
|
|
62
|
+
decodeKeySegment(encoded) {
|
|
63
|
+
return encoded.replace(/%2F/g, "/").replace(/%5C/g, "\\").replace(/%25/g, "%");
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Resolve `segment` against the cache root and throw when the result lands
|
|
67
|
+
* outside it — the last line of defense against path traversal, independent
|
|
68
|
+
* of how the key was encoded.
|
|
69
|
+
*/
|
|
70
|
+
containedPath(segment) {
|
|
71
|
+
const base = path.resolve(this.directory);
|
|
72
|
+
const resolved = path.resolve(base, segment);
|
|
73
|
+
const relative = path.relative(base, resolved);
|
|
74
|
+
if (relative === ".." || relative.startsWith(`..${path.sep}`) || path.isAbsolute(relative)) throw new CacheError(`Cache key resolves outside the cache directory: "${segment}"`);
|
|
75
|
+
return resolved;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
36
78
|
* {@inheritdoc}
|
|
79
|
+
*
|
|
80
|
+
* Dotted keys (`ns.a`) are stored as sibling directories, not nested ones
|
|
81
|
+
* (see {@link keyDirectory}) — a directory literally named `<namespace>`
|
|
82
|
+
* rarely exists on its own. Namespace removal therefore has to scan the
|
|
83
|
+
* cache root's immediate children and remove every directory whose
|
|
84
|
+
* *logical* (decoded) name equals the namespace or starts with
|
|
85
|
+
* `<namespace>.`, mirroring the `key = $1 OR key LIKE $2` boundary
|
|
86
|
+
* semantics the `pg` driver already uses for the same contract.
|
|
37
87
|
*/
|
|
38
88
|
async removeNamespace(namespace) {
|
|
89
|
+
const parsedNamespace = this.parseKey(namespace);
|
|
39
90
|
this.log("clearing", namespace);
|
|
40
91
|
try {
|
|
41
|
-
|
|
92
|
+
const root = this.containedPath("");
|
|
93
|
+
if (parsedNamespace === "") {
|
|
94
|
+
await removeDirectoryAsync(root);
|
|
95
|
+
this.log("cleared", namespace);
|
|
96
|
+
return this;
|
|
97
|
+
}
|
|
98
|
+
const prefix = `${parsedNamespace}.`;
|
|
99
|
+
const entries = await listDirectoriesAsync(root).catch(() => []);
|
|
100
|
+
await Promise.all(entries.map(async (entryPath) => {
|
|
101
|
+
const decoded = this.decodeKeySegment(path.basename(entryPath));
|
|
102
|
+
if (decoded === parsedNamespace || decoded.startsWith(prefix)) await removeDirectoryAsync(entryPath);
|
|
103
|
+
}));
|
|
42
104
|
this.log("cleared", namespace);
|
|
43
105
|
} catch (error) {}
|
|
44
106
|
return this;
|
|
@@ -62,7 +124,7 @@ var FileCacheDriver = class extends BaseCacheDriver {
|
|
|
62
124
|
existing: null
|
|
63
125
|
};
|
|
64
126
|
const data = this.prepareDataForStorage(value, ttl, staleAt);
|
|
65
|
-
const fileDirectory =
|
|
127
|
+
const fileDirectory = this.keyDirectory(parsedKey);
|
|
66
128
|
await ensureDirectoryAsync(fileDirectory);
|
|
67
129
|
await putJsonFileAsync(path.resolve(fileDirectory, this.fileName), data);
|
|
68
130
|
if (tags && tags.length > 0) await this.applyTags(parsedKey, tags);
|
|
@@ -102,7 +164,7 @@ var FileCacheDriver = class extends BaseCacheDriver {
|
|
|
102
164
|
*/
|
|
103
165
|
async getEntry(key) {
|
|
104
166
|
const parsedKey = this.parseKey(key);
|
|
105
|
-
const fileDirectory =
|
|
167
|
+
const fileDirectory = this.keyDirectory(parsedKey);
|
|
106
168
|
try {
|
|
107
169
|
const entry = await getJsonFileAsync(path.resolve(fileDirectory, this.fileName));
|
|
108
170
|
if (!entry) return null;
|
|
@@ -118,7 +180,7 @@ var FileCacheDriver = class extends BaseCacheDriver {
|
|
|
118
180
|
async get(key) {
|
|
119
181
|
const parsedKey = this.parseKey(key);
|
|
120
182
|
this.log("fetching", parsedKey);
|
|
121
|
-
const fileDirectory =
|
|
183
|
+
const fileDirectory = this.keyDirectory(parsedKey);
|
|
122
184
|
try {
|
|
123
185
|
const value = await getJsonFileAsync(path.resolve(fileDirectory, this.fileName));
|
|
124
186
|
const result = await this.parseCachedData(parsedKey, value);
|
|
@@ -141,7 +203,7 @@ var FileCacheDriver = class extends BaseCacheDriver {
|
|
|
141
203
|
async remove(key) {
|
|
142
204
|
const parsedKey = this.parseKey(key);
|
|
143
205
|
this.log("removing", parsedKey);
|
|
144
|
-
const fileDirectory =
|
|
206
|
+
const fileDirectory = this.keyDirectory(parsedKey);
|
|
145
207
|
try {
|
|
146
208
|
await removeDirectoryAsync(fileDirectory);
|
|
147
209
|
this.log("removed", parsedKey);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"file-cache-driver.mjs","names":[],"sources":["../../../../../../../cache/src/drivers/file-cache-driver.ts"],"sourcesContent":["import {\r\n ensureDirectoryAsync,\r\n getJsonFileAsync,\r\n putJsonFileAsync,\r\n removeDirectoryAsync,\r\n} from \"@warlock.js/fs\";\r\nimport path from \"path\";\r\nimport type {\r\n CacheData,\r\n CacheDriver,\r\n CacheKey,\r\n CacheSetOptions,\r\n CacheSetResult,\r\n CacheTtl,\r\n FileCacheOptions,\r\n} from \"../types\";\r\nimport { CacheConfigurationError, CacheUnsupportedError } from \"../types\";\r\nimport { BaseCacheDriver } from \"./base-cache-driver\";\r\n\r\nexport class FileCacheDriver\r\n extends BaseCacheDriver<FileCacheDriver, FileCacheOptions>\r\n implements CacheDriver<FileCacheDriver, FileCacheOptions>\r\n{\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public name = \"file\";\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public setOptions(options: FileCacheOptions) {\r\n if (!options.directory) {\r\n throw new CacheConfigurationError(\r\n \"File driver requires 'directory' option to be configured.\",\r\n );\r\n }\r\n\r\n return super.setOptions(options);\r\n }\r\n\r\n /**\r\n * Get the cache directory\r\n */\r\n public get directory() {\r\n const directory = this.options.directory;\r\n\r\n if (typeof directory === \"function\") {\r\n return directory();\r\n }\r\n\r\n throw new CacheConfigurationError(\r\n \"Cache directory is not defined, please define it in the file driver options\",\r\n );\r\n }\r\n\r\n /**\r\n * Get file name\r\n */\r\n public get fileName() {\r\n const fileName = this.options.fileName;\r\n\r\n if (typeof fileName === \"function\") {\r\n return fileName();\r\n }\r\n\r\n return \"cache.json\";\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async removeNamespace(namespace: string) {\r\n this.log(\"clearing\", namespace);\r\n\r\n try {\r\n await removeDirectoryAsync(path.resolve(this.directory, namespace));\r\n\r\n this.log(\"cleared\", namespace);\r\n } catch (error) {\r\n //\r\n }\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async set(\r\n key: CacheKey,\r\n value: any,\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): Promise<any> {\r\n const parsedKey = this.parseKey(key);\r\n const { ttl, tags, onConflict, vector, staleAt } = this.resolveSetOptions(ttlOrOptions);\r\n\r\n if (vector) {\r\n throw new CacheUnsupportedError(\r\n \"'file' driver does not support similarity retrieval — use a memory driver, 'pg' (with pgvector), or 'redis' (with RediSearch).\",\r\n );\r\n }\r\n\r\n this.log(\"caching\", parsedKey);\r\n\r\n const existing = onConflict === \"upsert\" ? null : await this.get(key);\r\n const exists = existing !== null;\r\n\r\n if (onConflict === \"create\" && exists) {\r\n const result: CacheSetResult = { wasSet: false, existing };\r\n return result;\r\n }\r\n\r\n if (onConflict === \"update\" && !exists) {\r\n const result: CacheSetResult = { wasSet: false, existing: null };\r\n return result;\r\n }\r\n\r\n const data = this.prepareDataForStorage(value, ttl, staleAt);\r\n\r\n const fileDirectory = path.resolve(this.directory, parsedKey);\r\n\r\n await ensureDirectoryAsync(fileDirectory);\r\n\r\n await putJsonFileAsync(path.resolve(fileDirectory, this.fileName), data);\r\n\r\n if (tags && tags.length > 0) {\r\n await this.applyTags(parsedKey, tags);\r\n }\r\n\r\n this.log(\"cached\", parsedKey);\r\n\r\n await this.emit(\"set\", { key: parsedKey, value, ttl });\r\n\r\n if (onConflict === \"create\" || onConflict === \"update\") {\r\n const result: CacheSetResult = { wasSet: true, existing: null };\r\n return result;\r\n }\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * File driver does not yet ship with a file-lock primitive, so concurrent\r\n * writers could clobber each other. Rather than ship an unsafe default, we\r\n * throw — consumers can fall back to memory/redis for `update` until a\r\n * proper file lock lands (tracked in `domains/cache/backlog.md`).\r\n */\r\n public async update(): Promise<never> {\r\n throw new CacheUnsupportedError(\r\n \"`update()` is not supported on the file driver. Use the memory or redis driver, or wait for the file-lock primitive (see domains/cache/backlog.md).\",\r\n );\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async merge(): Promise<never> {\r\n throw new CacheUnsupportedError(\r\n \"`merge()` is not supported on the file driver. Use the memory or redis driver.\",\r\n );\r\n }\r\n\r\n /**\r\n * Read the raw {@link CacheData} wrapper from disk, including `staleAt`\r\n * metadata. Returns `null` for missing or expired files — `swr()`\r\n * consumes this to branch on freshness.\r\n */\r\n protected async getEntry(key: CacheKey): Promise<CacheData | null> {\r\n const parsedKey = this.parseKey(key);\r\n const fileDirectory = path.resolve(this.directory, parsedKey);\r\n\r\n try {\r\n const entry = (await getJsonFileAsync(path.resolve(fileDirectory, this.fileName))) as\r\n | CacheData\r\n | undefined;\r\n\r\n if (!entry) {\r\n return null;\r\n }\r\n\r\n if (entry.expiresAt !== undefined && entry.expiresAt <= Date.now()) {\r\n return null;\r\n }\r\n\r\n return entry;\r\n } catch {\r\n return null;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async get(key: CacheKey) {\r\n const parsedKey = this.parseKey(key);\r\n\r\n this.log(\"fetching\", parsedKey);\r\n\r\n const fileDirectory = path.resolve(this.directory, parsedKey);\r\n\r\n try {\r\n const value = await getJsonFileAsync(path.resolve(fileDirectory, this.fileName));\r\n\r\n const result = await this.parseCachedData(parsedKey, value as CacheData);\r\n\r\n if (result === null) {\r\n // Expired\r\n await this.emit(\"miss\", { key: parsedKey });\r\n } else {\r\n // Emit hit event\r\n await this.emit(\"hit\", { key: parsedKey, value: result });\r\n }\r\n\r\n return result;\r\n } catch (error) {\r\n this.log(\"notFound\", parsedKey);\r\n // Emit miss event\r\n await this.emit(\"miss\", { key: parsedKey });\r\n // Await the cleanup so it fully settles before returning. Leaving this\r\n // fire-and-forget let the async directory removal race a follow-up write\r\n // to the same key (e.g. the existence probe inside a `set({ onConflict })`\r\n // call), surfacing as an ENOENT mkdir/rm collision on Windows.\r\n await this.remove(key);\r\n return null;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async remove(key: CacheKey) {\r\n const parsedKey = this.parseKey(key);\r\n this.log(\"removing\", parsedKey);\r\n\r\n const fileDirectory = path.resolve(this.directory, parsedKey);\r\n\r\n try {\r\n await removeDirectoryAsync(fileDirectory);\r\n\r\n this.log(\"removed\", parsedKey);\r\n // Emit removed event\r\n await this.emit(\"removed\", { key: parsedKey });\r\n } catch (error) {\r\n //\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async flush() {\r\n this.log(\"flushing\");\r\n\r\n if (this.options.globalPrefix) {\r\n await this.removeNamespace(\"\");\r\n } else {\r\n await removeDirectoryAsync(this.directory);\r\n }\r\n\r\n this.log(\"flushed\");\r\n\r\n // Emit flushed event\r\n await this.emit(\"flushed\");\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async connect() {\r\n this.log(\"connecting\");\r\n await ensureDirectoryAsync(this.directory);\r\n this.log(\"connected\");\r\n await this.emit(\"connected\");\r\n }\r\n}\r\n"],"mappings":";;;;;;AAmBA,IAAa,kBAAb,cACU,gBAEV;;;cAIgB;;;;;CAKd,AAAO,WAAW,SAA2B;EAC3C,IAAI,CAAC,QAAQ,WACX,MAAM,IAAI,wBACR,2DACF;EAGF,OAAO,MAAM,WAAW,OAAO;CACjC;;;;CAKA,IAAW,YAAY;EACrB,MAAM,YAAY,KAAK,QAAQ;EAE/B,IAAI,OAAO,cAAc,YACvB,OAAO,UAAU;EAGnB,MAAM,IAAI,wBACR,6EACF;CACF;;;;CAKA,IAAW,WAAW;EACpB,MAAM,WAAW,KAAK,QAAQ;EAE9B,IAAI,OAAO,aAAa,YACtB,OAAO,SAAS;EAGlB,OAAO;CACT;;;;CAKA,MAAa,gBAAgB,WAAmB;EAC9C,KAAK,IAAI,YAAY,SAAS;EAE9B,IAAI;GACF,MAAM,qBAAqB,KAAK,QAAQ,KAAK,WAAW,SAAS,CAAC;GAElE,KAAK,IAAI,WAAW,SAAS;EAC/B,SAAS,OAAO,CAEhB;EAEA,OAAO;CACT;;;;CAKA,MAAa,IACX,KACA,OACA,cACc;EACd,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,EAAE,KAAK,MAAM,YAAY,QAAQ,YAAY,KAAK,kBAAkB,YAAY;EAEtF,IAAI,QACF,MAAM,IAAI,sBACR,gIACF;EAGF,KAAK,IAAI,WAAW,SAAS;EAE7B,MAAM,WAAW,eAAe,WAAW,OAAO,MAAM,KAAK,IAAI,GAAG;EACpE,MAAM,SAAS,aAAa;EAE5B,IAAI,eAAe,YAAY,QAE7B,OAAO;GAD0B,QAAQ;GAAO;EACpC;EAGd,IAAI,eAAe,YAAY,CAAC,QAE9B,OAAO;GAD0B,QAAQ;GAAO,UAAU;EAC9C;EAGd,MAAM,OAAO,KAAK,sBAAsB,OAAO,KAAK,OAAO;EAE3D,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,SAAS;EAE5D,MAAM,qBAAqB,aAAa;EAExC,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,GAAG,IAAI;EAEvE,IAAI,QAAQ,KAAK,SAAS,GACxB,MAAM,KAAK,UAAU,WAAW,IAAI;EAGtC,KAAK,IAAI,UAAU,SAAS;EAE5B,MAAM,KAAK,KAAK,OAAO;GAAE,KAAK;GAAW;GAAO;EAAI,CAAC;EAErD,IAAI,eAAe,YAAY,eAAe,UAE5C,OAAO;GAD0B,QAAQ;GAAM,UAAU;EAC7C;EAGd,OAAO;CACT;;;;;;;;;CAUA,MAAa,SAAyB;EACpC,MAAM,IAAI,sBACR,qJACF;CACF;;;;CAKA,MAAa,QAAwB;EACnC,MAAM,IAAI,sBACR,gFACF;CACF;;;;;;CAOA,MAAgB,SAAS,KAA0C;EACjE,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,SAAS;EAE5D,IAAI;GACF,MAAM,QAAS,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,CAAC;GAIhF,IAAI,CAAC,OACH,OAAO;GAGT,IAAI,MAAM,cAAc,UAAa,MAAM,aAAa,KAAK,IAAI,GAC/D,OAAO;GAGT,OAAO;EACT,QAAQ;GACN,OAAO;EACT;CACF;;;;CAKA,MAAa,IAAI,KAAe;EAC9B,MAAM,YAAY,KAAK,SAAS,GAAG;EAEnC,KAAK,IAAI,YAAY,SAAS;EAE9B,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,SAAS;EAE5D,IAAI;GACF,MAAM,QAAQ,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,CAAC;GAE/E,MAAM,SAAS,MAAM,KAAK,gBAAgB,WAAW,KAAkB;GAEvE,IAAI,WAAW,MAEb,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;QAG1C,MAAM,KAAK,KAAK,OAAO;IAAE,KAAK;IAAW,OAAO;GAAO,CAAC;GAG1D,OAAO;EACT,SAAS,OAAO;GACd,KAAK,IAAI,YAAY,SAAS;GAE9B,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;GAK1C,MAAM,KAAK,OAAO,GAAG;GACrB,OAAO;EACT;CACF;;;;CAKA,MAAa,OAAO,KAAe;EACjC,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,KAAK,IAAI,YAAY,SAAS;EAE9B,MAAM,gBAAgB,KAAK,QAAQ,KAAK,WAAW,SAAS;EAE5D,IAAI;GACF,MAAM,qBAAqB,aAAa;GAExC,KAAK,IAAI,WAAW,SAAS;GAE7B,MAAM,KAAK,KAAK,WAAW,EAAE,KAAK,UAAU,CAAC;EAC/C,SAAS,OAAO,CAEhB;CACF;;;;CAKA,MAAa,QAAQ;EACnB,KAAK,IAAI,UAAU;EAEnB,IAAI,KAAK,QAAQ,cACf,MAAM,KAAK,gBAAgB,EAAE;OAE7B,MAAM,qBAAqB,KAAK,SAAS;EAG3C,KAAK,IAAI,SAAS;EAGlB,MAAM,KAAK,KAAK,SAAS;CAC3B;;;;CAKA,MAAa,UAAU;EACrB,KAAK,IAAI,YAAY;EACrB,MAAM,qBAAqB,KAAK,SAAS;EACzC,KAAK,IAAI,WAAW;EACpB,MAAM,KAAK,KAAK,WAAW;CAC7B;AACF"}
|
|
1
|
+
{"version":3,"file":"file-cache-driver.mjs","names":[],"sources":["../../../../../../../cache/src/drivers/file-cache-driver.ts"],"sourcesContent":["import {\r\n ensureDirectoryAsync,\r\n getJsonFileAsync,\r\n listDirectoriesAsync,\r\n putJsonFileAsync,\r\n removeDirectoryAsync,\r\n} from \"@warlock.js/fs\";\r\nimport path from \"path\";\r\nimport type {\r\n CacheData,\r\n CacheDriver,\r\n CacheKey,\r\n CacheSetOptions,\r\n CacheSetResult,\r\n CacheTtl,\r\n FileCacheOptions,\r\n} from \"../types\";\r\nimport { CacheConfigurationError, CacheError, CacheUnsupportedError } from \"../types\";\r\nimport { BaseCacheDriver } from \"./base-cache-driver\";\r\n\r\nexport class FileCacheDriver\r\n extends BaseCacheDriver<FileCacheDriver, FileCacheOptions>\r\n implements CacheDriver<FileCacheDriver, FileCacheOptions>\r\n{\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public name = \"file\";\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public setOptions(options: FileCacheOptions) {\r\n if (!options.directory) {\r\n throw new CacheConfigurationError(\r\n \"File driver requires 'directory' option to be configured.\",\r\n );\r\n }\r\n\r\n return super.setOptions(options);\r\n }\r\n\r\n /**\r\n * Get the cache directory\r\n */\r\n public get directory() {\r\n const directory = this.options.directory;\r\n\r\n if (typeof directory === \"function\") {\r\n return directory();\r\n }\r\n\r\n throw new CacheConfigurationError(\r\n \"Cache directory is not defined, please define it in the file driver options\",\r\n );\r\n }\r\n\r\n /**\r\n * Get file name\r\n */\r\n public get fileName() {\r\n const fileName = this.options.fileName;\r\n\r\n if (typeof fileName === \"function\") {\r\n return fileName();\r\n }\r\n\r\n return \"cache.json\";\r\n }\r\n\r\n /**\r\n * Map a parsed cache key (or namespace) to its on-disk directory.\r\n *\r\n * The key must become exactly one directory component: `%` and the path\r\n * separators are percent-encoded so a hostile key (`../../etc`,\r\n * `..\\\\..\\\\evil`) turns into an inert directory name instead of a path\r\n * traversal, while distinct keys can never collide after encoding. Dots are\r\n * left untouched — the `.`-delimited namespace scheme is purely logical and\r\n * only ever produces a single filesystem component here.\r\n */\r\n protected keyDirectory(parsedKey: string): string {\r\n return this.containedPath(this.encodeKeySegment(parsedKey));\r\n }\r\n\r\n /**\r\n * Percent-encode a parsed key into an inert, single-component directory\r\n * name. Dots are left untouched — see {@link keyDirectory}.\r\n */\r\n protected encodeKeySegment(parsedKey: string): string {\r\n return parsedKey\r\n .replace(/%/g, \"%25\")\r\n .replace(/\\//g, \"%2F\")\r\n .replace(/\\\\/g, \"%5C\");\r\n }\r\n\r\n /**\r\n * Reverse of {@link encodeKeySegment} — recovers the logical, dot-delimited\r\n * parsed key from an on-disk directory name. Used by {@link removeNamespace}\r\n * to test which sibling directories logically belong to a namespace, since\r\n * dotted keys (`ns.a`) are stored as sibling directories rather than nested\r\n * ones (see {@link keyDirectory}'s doc comment).\r\n */\r\n protected decodeKeySegment(encoded: string): string {\r\n return encoded\r\n .replace(/%2F/g, \"/\")\r\n .replace(/%5C/g, \"\\\\\")\r\n .replace(/%25/g, \"%\");\r\n }\r\n\r\n /**\r\n * Resolve `segment` against the cache root and throw when the result lands\r\n * outside it — the last line of defense against path traversal, independent\r\n * of how the key was encoded.\r\n */\r\n protected containedPath(segment: string): string {\r\n const base = path.resolve(this.directory);\r\n const resolved = path.resolve(base, segment);\r\n const relative = path.relative(base, resolved);\r\n\r\n if (\r\n relative === \"..\" ||\r\n relative.startsWith(`..${path.sep}`) ||\r\n path.isAbsolute(relative)\r\n ) {\r\n throw new CacheError(\r\n `Cache key resolves outside the cache directory: \"${segment}\"`,\r\n );\r\n }\r\n\r\n return resolved;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * Dotted keys (`ns.a`) are stored as sibling directories, not nested ones\r\n * (see {@link keyDirectory}) — a directory literally named `<namespace>`\r\n * rarely exists on its own. Namespace removal therefore has to scan the\r\n * cache root's immediate children and remove every directory whose\r\n * *logical* (decoded) name equals the namespace or starts with\r\n * `<namespace>.`, mirroring the `key = $1 OR key LIKE $2` boundary\r\n * semantics the `pg` driver already uses for the same contract.\r\n */\r\n public async removeNamespace(namespace: string) {\r\n const parsedNamespace = this.parseKey(namespace);\r\n\r\n this.log(\"clearing\", namespace);\r\n\r\n try {\r\n const root = this.containedPath(\"\");\r\n\r\n if (parsedNamespace === \"\") {\r\n await removeDirectoryAsync(root);\r\n this.log(\"cleared\", namespace);\r\n return this;\r\n }\r\n\r\n const prefix = `${parsedNamespace}.`;\r\n const entries = await listDirectoriesAsync(root).catch(() => [] as string[]);\r\n\r\n await Promise.all(\r\n entries.map(async (entryPath) => {\r\n const decoded = this.decodeKeySegment(path.basename(entryPath));\r\n\r\n if (decoded === parsedNamespace || decoded.startsWith(prefix)) {\r\n await removeDirectoryAsync(entryPath);\r\n }\r\n }),\r\n );\r\n\r\n this.log(\"cleared\", namespace);\r\n } catch (error) {\r\n //\r\n }\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async set(\r\n key: CacheKey,\r\n value: any,\r\n ttlOrOptions?: CacheTtl | CacheSetOptions,\r\n ): Promise<any> {\r\n const parsedKey = this.parseKey(key);\r\n const { ttl, tags, onConflict, vector, staleAt } = this.resolveSetOptions(ttlOrOptions);\r\n\r\n if (vector) {\r\n throw new CacheUnsupportedError(\r\n \"'file' driver does not support similarity retrieval — use a memory driver, 'pg' (with pgvector), or 'redis' (with RediSearch).\",\r\n );\r\n }\r\n\r\n this.log(\"caching\", parsedKey);\r\n\r\n const existing = onConflict === \"upsert\" ? null : await this.get(key);\r\n const exists = existing !== null;\r\n\r\n if (onConflict === \"create\" && exists) {\r\n const result: CacheSetResult = { wasSet: false, existing };\r\n return result;\r\n }\r\n\r\n if (onConflict === \"update\" && !exists) {\r\n const result: CacheSetResult = { wasSet: false, existing: null };\r\n return result;\r\n }\r\n\r\n const data = this.prepareDataForStorage(value, ttl, staleAt);\r\n\r\n const fileDirectory = this.keyDirectory(parsedKey);\r\n\r\n await ensureDirectoryAsync(fileDirectory);\r\n\r\n await putJsonFileAsync(path.resolve(fileDirectory, this.fileName), data);\r\n\r\n if (tags && tags.length > 0) {\r\n await this.applyTags(parsedKey, tags);\r\n }\r\n\r\n this.log(\"cached\", parsedKey);\r\n\r\n await this.emit(\"set\", { key: parsedKey, value, ttl });\r\n\r\n if (onConflict === \"create\" || onConflict === \"update\") {\r\n const result: CacheSetResult = { wasSet: true, existing: null };\r\n return result;\r\n }\r\n\r\n return this;\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n *\r\n * File driver does not yet ship with a file-lock primitive, so concurrent\r\n * writers could clobber each other. Rather than ship an unsafe default, we\r\n * throw — consumers can fall back to memory/redis for `update` until a\r\n * proper file lock lands (tracked in `domains/cache/backlog.md`).\r\n */\r\n public async update(): Promise<never> {\r\n throw new CacheUnsupportedError(\r\n \"`update()` is not supported on the file driver. Use the memory or redis driver, or wait for the file-lock primitive (see domains/cache/backlog.md).\",\r\n );\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async merge(): Promise<never> {\r\n throw new CacheUnsupportedError(\r\n \"`merge()` is not supported on the file driver. Use the memory or redis driver.\",\r\n );\r\n }\r\n\r\n /**\r\n * Read the raw {@link CacheData} wrapper from disk, including `staleAt`\r\n * metadata. Returns `null` for missing or expired files — `swr()`\r\n * consumes this to branch on freshness.\r\n */\r\n protected async getEntry(key: CacheKey): Promise<CacheData | null> {\r\n const parsedKey = this.parseKey(key);\r\n const fileDirectory = this.keyDirectory(parsedKey);\r\n\r\n try {\r\n const entry = (await getJsonFileAsync(path.resolve(fileDirectory, this.fileName))) as\r\n | CacheData\r\n | undefined;\r\n\r\n if (!entry) {\r\n return null;\r\n }\r\n\r\n if (entry.expiresAt !== undefined && entry.expiresAt <= Date.now()) {\r\n return null;\r\n }\r\n\r\n return entry;\r\n } catch {\r\n return null;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async get(key: CacheKey) {\r\n const parsedKey = this.parseKey(key);\r\n\r\n this.log(\"fetching\", parsedKey);\r\n\r\n const fileDirectory = this.keyDirectory(parsedKey);\r\n\r\n try {\r\n const value = await getJsonFileAsync(path.resolve(fileDirectory, this.fileName));\r\n\r\n const result = await this.parseCachedData(parsedKey, value as CacheData);\r\n\r\n if (result === null) {\r\n // Expired\r\n await this.emit(\"miss\", { key: parsedKey });\r\n } else {\r\n // Emit hit event\r\n await this.emit(\"hit\", { key: parsedKey, value: result });\r\n }\r\n\r\n return result;\r\n } catch (error) {\r\n this.log(\"notFound\", parsedKey);\r\n // Emit miss event\r\n await this.emit(\"miss\", { key: parsedKey });\r\n // Await the cleanup so it fully settles before returning. Leaving this\r\n // fire-and-forget let the async directory removal race a follow-up write\r\n // to the same key (e.g. the existence probe inside a `set({ onConflict })`\r\n // call), surfacing as an ENOENT mkdir/rm collision on Windows.\r\n await this.remove(key);\r\n return null;\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async remove(key: CacheKey) {\r\n const parsedKey = this.parseKey(key);\r\n this.log(\"removing\", parsedKey);\r\n\r\n const fileDirectory = this.keyDirectory(parsedKey);\r\n\r\n try {\r\n await removeDirectoryAsync(fileDirectory);\r\n\r\n this.log(\"removed\", parsedKey);\r\n // Emit removed event\r\n await this.emit(\"removed\", { key: parsedKey });\r\n } catch (error) {\r\n //\r\n }\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async flush() {\r\n this.log(\"flushing\");\r\n\r\n if (this.options.globalPrefix) {\r\n await this.removeNamespace(\"\");\r\n } else {\r\n await removeDirectoryAsync(this.directory);\r\n }\r\n\r\n this.log(\"flushed\");\r\n\r\n // Emit flushed event\r\n await this.emit(\"flushed\");\r\n }\r\n\r\n /**\r\n * {@inheritdoc}\r\n */\r\n public async connect() {\r\n this.log(\"connecting\");\r\n await ensureDirectoryAsync(this.directory);\r\n this.log(\"connected\");\r\n await this.emit(\"connected\");\r\n }\r\n}\r\n"],"mappings":";;;;;;AAoBA,IAAa,kBAAb,cACU,gBAEV;;;cAIgB;;;;;CAKd,AAAO,WAAW,SAA2B;EAC3C,IAAI,CAAC,QAAQ,WACX,MAAM,IAAI,wBACR,2DACF;EAGF,OAAO,MAAM,WAAW,OAAO;CACjC;;;;CAKA,IAAW,YAAY;EACrB,MAAM,YAAY,KAAK,QAAQ;EAE/B,IAAI,OAAO,cAAc,YACvB,OAAO,UAAU;EAGnB,MAAM,IAAI,wBACR,6EACF;CACF;;;;CAKA,IAAW,WAAW;EACpB,MAAM,WAAW,KAAK,QAAQ;EAE9B,IAAI,OAAO,aAAa,YACtB,OAAO,SAAS;EAGlB,OAAO;CACT;;;;;;;;;;;CAYA,AAAU,aAAa,WAA2B;EAChD,OAAO,KAAK,cAAc,KAAK,iBAAiB,SAAS,CAAC;CAC5D;;;;;CAMA,AAAU,iBAAiB,WAA2B;EACpD,OAAO,UACJ,QAAQ,MAAM,KAAK,CAAC,CACpB,QAAQ,OAAO,KAAK,CAAC,CACrB,QAAQ,OAAO,KAAK;CACzB;;;;;;;;CASA,AAAU,iBAAiB,SAAyB;EAClD,OAAO,QACJ,QAAQ,QAAQ,GAAG,CAAC,CACpB,QAAQ,QAAQ,IAAI,CAAC,CACrB,QAAQ,QAAQ,GAAG;CACxB;;;;;;CAOA,AAAU,cAAc,SAAyB;EAC/C,MAAM,OAAO,KAAK,QAAQ,KAAK,SAAS;EACxC,MAAM,WAAW,KAAK,QAAQ,MAAM,OAAO;EAC3C,MAAM,WAAW,KAAK,SAAS,MAAM,QAAQ;EAE7C,IACE,aAAa,QACb,SAAS,WAAW,KAAK,KAAK,KAAK,KACnC,KAAK,WAAW,QAAQ,GAExB,MAAM,IAAI,WACR,oDAAoD,QAAQ,EAC9D;EAGF,OAAO;CACT;;;;;;;;;;;;CAaA,MAAa,gBAAgB,WAAmB;EAC9C,MAAM,kBAAkB,KAAK,SAAS,SAAS;EAE/C,KAAK,IAAI,YAAY,SAAS;EAE9B,IAAI;GACF,MAAM,OAAO,KAAK,cAAc,EAAE;GAElC,IAAI,oBAAoB,IAAI;IAC1B,MAAM,qBAAqB,IAAI;IAC/B,KAAK,IAAI,WAAW,SAAS;IAC7B,OAAO;GACT;GAEA,MAAM,SAAS,GAAG,gBAAgB;GAClC,MAAM,UAAU,MAAM,qBAAqB,IAAI,CAAC,CAAC,YAAY,CAAC,CAAa;GAE3E,MAAM,QAAQ,IACZ,QAAQ,IAAI,OAAO,cAAc;IAC/B,MAAM,UAAU,KAAK,iBAAiB,KAAK,SAAS,SAAS,CAAC;IAE9D,IAAI,YAAY,mBAAmB,QAAQ,WAAW,MAAM,GAC1D,MAAM,qBAAqB,SAAS;GAExC,CAAC,CACH;GAEA,KAAK,IAAI,WAAW,SAAS;EAC/B,SAAS,OAAO,CAEhB;EAEA,OAAO;CACT;;;;CAKA,MAAa,IACX,KACA,OACA,cACc;EACd,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,EAAE,KAAK,MAAM,YAAY,QAAQ,YAAY,KAAK,kBAAkB,YAAY;EAEtF,IAAI,QACF,MAAM,IAAI,sBACR,gIACF;EAGF,KAAK,IAAI,WAAW,SAAS;EAE7B,MAAM,WAAW,eAAe,WAAW,OAAO,MAAM,KAAK,IAAI,GAAG;EACpE,MAAM,SAAS,aAAa;EAE5B,IAAI,eAAe,YAAY,QAE7B,OAAO;GAD0B,QAAQ;GAAO;EACpC;EAGd,IAAI,eAAe,YAAY,CAAC,QAE9B,OAAO;GAD0B,QAAQ;GAAO,UAAU;EAC9C;EAGd,MAAM,OAAO,KAAK,sBAAsB,OAAO,KAAK,OAAO;EAE3D,MAAM,gBAAgB,KAAK,aAAa,SAAS;EAEjD,MAAM,qBAAqB,aAAa;EAExC,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,GAAG,IAAI;EAEvE,IAAI,QAAQ,KAAK,SAAS,GACxB,MAAM,KAAK,UAAU,WAAW,IAAI;EAGtC,KAAK,IAAI,UAAU,SAAS;EAE5B,MAAM,KAAK,KAAK,OAAO;GAAE,KAAK;GAAW;GAAO;EAAI,CAAC;EAErD,IAAI,eAAe,YAAY,eAAe,UAE5C,OAAO;GAD0B,QAAQ;GAAM,UAAU;EAC7C;EAGd,OAAO;CACT;;;;;;;;;CAUA,MAAa,SAAyB;EACpC,MAAM,IAAI,sBACR,qJACF;CACF;;;;CAKA,MAAa,QAAwB;EACnC,MAAM,IAAI,sBACR,gFACF;CACF;;;;;;CAOA,MAAgB,SAAS,KAA0C;EACjE,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,MAAM,gBAAgB,KAAK,aAAa,SAAS;EAEjD,IAAI;GACF,MAAM,QAAS,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,CAAC;GAIhF,IAAI,CAAC,OACH,OAAO;GAGT,IAAI,MAAM,cAAc,UAAa,MAAM,aAAa,KAAK,IAAI,GAC/D,OAAO;GAGT,OAAO;EACT,QAAQ;GACN,OAAO;EACT;CACF;;;;CAKA,MAAa,IAAI,KAAe;EAC9B,MAAM,YAAY,KAAK,SAAS,GAAG;EAEnC,KAAK,IAAI,YAAY,SAAS;EAE9B,MAAM,gBAAgB,KAAK,aAAa,SAAS;EAEjD,IAAI;GACF,MAAM,QAAQ,MAAM,iBAAiB,KAAK,QAAQ,eAAe,KAAK,QAAQ,CAAC;GAE/E,MAAM,SAAS,MAAM,KAAK,gBAAgB,WAAW,KAAkB;GAEvE,IAAI,WAAW,MAEb,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;QAG1C,MAAM,KAAK,KAAK,OAAO;IAAE,KAAK;IAAW,OAAO;GAAO,CAAC;GAG1D,OAAO;EACT,SAAS,OAAO;GACd,KAAK,IAAI,YAAY,SAAS;GAE9B,MAAM,KAAK,KAAK,QAAQ,EAAE,KAAK,UAAU,CAAC;GAK1C,MAAM,KAAK,OAAO,GAAG;GACrB,OAAO;EACT;CACF;;;;CAKA,MAAa,OAAO,KAAe;EACjC,MAAM,YAAY,KAAK,SAAS,GAAG;EACnC,KAAK,IAAI,YAAY,SAAS;EAE9B,MAAM,gBAAgB,KAAK,aAAa,SAAS;EAEjD,IAAI;GACF,MAAM,qBAAqB,aAAa;GAExC,KAAK,IAAI,WAAW,SAAS;GAE7B,MAAM,KAAK,KAAK,WAAW,EAAE,KAAK,UAAU,CAAC;EAC/C,SAAS,OAAO,CAEhB;CACF;;;;CAKA,MAAa,QAAQ;EACnB,KAAK,IAAI,UAAU;EAEnB,IAAI,KAAK,QAAQ,cACf,MAAM,KAAK,gBAAgB,EAAE;OAE7B,MAAM,qBAAqB,KAAK,SAAS;EAG3C,KAAK,IAAI,SAAS;EAGlB,MAAM,KAAK,KAAK,SAAS;CAC3B;;;;CAKA,MAAa,UAAU;EACrB,KAAK,IAAI,YAAY;EACrB,MAAM,qBAAqB,KAAK,SAAS;EACzC,KAAK,IAAI,WAAW;EACpB,MAAM,KAAK,KAAK,WAAW;CAC7B;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redis-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/redis-cache-driver.ts"],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"redis-cache-driver.d.mts","names":[],"sources":["../../../../../../../cache/src/drivers/redis-cache-driver.ts"],"mappings":";;;;;cA2Da,gBAAA,SACH,eAAA,CAAgB,UAAA,QAAkB,YAAA,GAAe,YAAA,aAC9C,WAAA,CAAY,UAAA,QAAkB,YAAA,GAAe,YAAA;;AAF1D;;EAOS,IAAA;EANmC;;;EAWnC,UAAA,CAAW,OAAA,EAAS,YAAA;EAVJ;;;EAuBV,eAAA,CAAgB,SAAA,WAAiB,OAAA;EAuCvC;;;EADM,GAAA,CACX,GAAA,EAAK,QAAA,EACL,KAAA,OACA,YAAA,GAAe,QAAA,GAAW,eAAA,GACzB,OAAA;EAmF2B;;;;EAAA,UAVpB,UAAA,CAAW,SAAA;EAqDC;;;;;;EAAA,UA3CN,QAAA,CAAS,GAAA,EAAK,QAAA,GAAW,OAAA,CAAQ,SAAA;EAiNrB;;;;;;;EAAA,UAxLZ,eAAA,CAAgB,GAAA,EAAK,QAAA,GAAW,OAAA;EA7K1B;;;EA+LT,GAAA,CAAI,GAAA,EAAK,QAAA,GAAQ,OAAA;EAhMY;;;EA+O7B,MAAA,CAAO,GAAA,EAAK,QAAA,GAAQ,OAAA;EA9OQ;;;EA+P5B,KAAA,IAAK,OAAA;EArPS;;;EAuQd,OAAA,IAAO,OAAA;EA1P0B;;;;;;;;EA6TjC,UAAA,IAAU,OAAA;EA1Mb;;;;EA2NG,SAAA,CAAU,GAAA,EAAK,QAAA,EAAU,KAAA,YAAoB,OAAA;EAjNjB;;;;EAoO5B,SAAA,CAAU,GAAA,EAAK,QAAA,EAAU,KAAA,YAAoB,OAAA;EA3MV;;;;EA8NnC,KAAA,CAAM,GAAA,EAAK,QAAA,EAAU,KAAA,OAAY,GAAA,YAAe,OAAA;AAAA"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CacheConfigurationError, CacheUnsupportedError } from "../types.mjs";
|
|
2
|
+
import { safeErrorInfo } from "../utils.mjs";
|
|
2
3
|
import { BaseCacheDriver } from "./base-cache-driver.mjs";
|
|
3
4
|
import { log } from "@warlock.js/logger";
|
|
4
5
|
|
|
@@ -52,8 +53,13 @@ var RedisCacheDriver = class extends BaseCacheDriver {
|
|
|
52
53
|
async removeNamespace(namespace) {
|
|
53
54
|
namespace = this.parseKey(namespace);
|
|
54
55
|
this.log("clearing", namespace);
|
|
55
|
-
const
|
|
56
|
-
|
|
56
|
+
const pattern = namespace.replace(/[\\*?[\]]/g, "\\$&");
|
|
57
|
+
const keys = [];
|
|
58
|
+
if (this.client) for await (const key of this.client.scanIterator({
|
|
59
|
+
MATCH: `${pattern}*`,
|
|
60
|
+
COUNT: 100
|
|
61
|
+
})) keys.push(key);
|
|
62
|
+
if (keys.length === 0) {
|
|
57
63
|
this.log("notFound", namespace);
|
|
58
64
|
return;
|
|
59
65
|
}
|
|
@@ -223,15 +229,15 @@ var RedisCacheDriver = class extends BaseCacheDriver {
|
|
|
223
229
|
const { createClient } = RedisClient;
|
|
224
230
|
this.client = createClient(clientOptions);
|
|
225
231
|
this.client.on("error", (error) => {
|
|
226
|
-
|
|
227
|
-
|
|
232
|
+
const { message } = safeErrorInfo(error);
|
|
233
|
+
if (error.code === "ECONNREFUSED") this.log("connectionFailed", message);
|
|
234
|
+
else this.log("error", message);
|
|
228
235
|
});
|
|
229
236
|
await this.client.connect();
|
|
230
237
|
this.log("connected");
|
|
231
238
|
await this.emit("connected");
|
|
232
239
|
} catch (error) {
|
|
233
|
-
|
|
234
|
-
log.fatal("cache", "redis", error);
|
|
240
|
+
log.fatal("cache", "redis", "Failed to connect", safeErrorInfo(error));
|
|
235
241
|
await this.emit("error", { error });
|
|
236
242
|
}
|
|
237
243
|
}
|