Create new optional request option for customizing local cache behavior

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 
 ### Added
+- Create new optional request option for customizing local cache behavior
 - Allow passing request config to VBase's getJSON method
 
 ## [6.46.0] - 2023-10-25

src/HttpClient/middlewares/cache.ts

@@ -107,11 +107,14 @@ export const cacheMiddleware = ({ type, storage }: CacheOptions) => {
     })
 
 
+    const { localCacheOptions } = ctx.config
+
     const cacheReadSpan = createCacheSpan(cacheType, 'read', tracer, span)
     let cached: void | Cached
     try {
-      const cacheHasWithSegment = await storage.has(keyWithSegment)
-      cached = cacheHasWithSegment ? await storage.get(keyWithSegment) : await storage.get(key)
+      const cacheHasWithSegment = await storage.has(keyWithSegment, localCacheOptions)
+      const keyToUse = cacheHasWithSegment ? keyWithSegment : key
+      cached = await storage.get(keyToUse, undefined, localCacheOptions)
     } catch (error) {
       ErrorReport.create({ originalError: error }).injectOnSpan(cacheReadSpan)
       logger?.warn({ message: 'Error reading from the HttpClient cache', error })
@@ -223,13 +226,18 @@ export const cacheMiddleware = ({ type, storage }: CacheOptions) => {
 
       const cacheWriteSpan = createCacheSpan(cacheType, 'write', tracer, span)
       try {
-        await storage.set(setKey, {
-          etag,
-          expiration,
-          response: {data: cacheableData, headers, status},
-          responseEncoding,
-          responseType,
-        })
+        await storage.set(
+          setKey,
+          {
+            etag,
+            expiration,
+            response: {data: cacheableData, headers, status},
+            responseEncoding,
+            responseType,
+          },
+          undefined,
+          localCacheOptions
+        )
 
         span?.log({
           event: HttpLogEvents.LOCAL_CACHE_SAVED,

src/HttpClient/typings.ts

@@ -51,8 +51,11 @@ export interface RequestConfig extends AxiosRequestConfig, RequestTracingConfig
   responseEncoding?: BufferEncoding
   nullIfNotFound?: boolean
   ignoreRecorder?: boolean
+  localCacheOptions?: LocalCacheOptions
 }
 
+export type LocalCacheOptions = Record<string, unknown>
+
 export interface CacheHit {
   disk?: 0 | 1
   memory?: 0 | 1

src/caches/CacheLayer.ts

@@ -1,8 +1,9 @@
+import { LocalCacheOptions } from '../HttpClient'
 import { FetchResult } from './typings'
 
 export interface CacheLayer<K, V> {
-  get (key: K, fetcher?: () => Promise<FetchResult<V>>): Promise<V | void> | V | void,
-  has (key: K): Promise<boolean> | boolean,
-  set (key: K, value: V, maxAge?: number | void): Promise<boolean> | boolean,
+  get (key: K, fetcher?: () => Promise<FetchResult<V>>, options?: LocalCacheOptions): Promise<V | void> | V | void,
+  has (key: K, options?: LocalCacheOptions): Promise<boolean> | boolean,
+  set (key: K, value: V, maxAge?: number | void, options?: LocalCacheOptions): Promise<boolean> | boolean,
   getStats? (name?: string): any,
 }