@nxtedition/cache 2.0.7 → 2.1.1

package/lib/index.d.ts

@@ -5,6 +5,9 @@ export interface DatabaseOptions {
     timeout?: number;
     maxSize?: number;
 }
+export interface LockOptions {
+    minTimeout?: number;
+}
 export interface Serializer<V> {
     serialize: (value: V) => Buffer | Uint8Array | string;
     deserialize: (data: Buffer | string) => V;
@@ -12,6 +15,7 @@ export interface Serializer<V> {
 export interface CacheOptions<V> {
     ttl?: number | ((value: V, key: string) => number);
     stale?: number | ((value: V, key: string) => number);
+    lock?: LockOptions | false | null;
     memory?: MemoryOptions | false | null;
     database?: DatabaseOptions | false | null;
     serializer?: Serializer<V>;
@@ -28,15 +32,15 @@ declare global {
         stats: Cache['stats'];
     }[];
 }
-export declare class Cache<V = unknown, A extends unknown[] = unknown[]> extends EventEmitter {
+export declare class Cache<V = unknown, A extends unknown[] = [string]> extends EventEmitter {
     #private;
-    constructor(location: string, valueSelector: (...args: A) => V | PromiseLike<V>, keySelector: (...args: A) => string, opts?: CacheOptions<V>);
+    constructor(location: string, valueSelector?: (...args: A) => V | PromiseLike<V>, keySelector?: (...args: A) => string, opts?: CacheOptions<V>);
     get stats(): {
         lock: {
             timeout: number;
             mean: number;
             stddev: number;
-        };
+        } | undefined;
         dedupe: {
             size: number;
         };

package/lib/index.js

@@ -36,6 +36,10 @@ const dbs = new Set                 ()
                                   
                   
                   
+ 
+
+                              
+                     
  
 
                                 
@@ -49,6 +53,7 @@ const defaultSerializer                  = {
     return ArrayBuffer.isView(value) ? (value              ) : JSON.stringify(value)
   },
   deserialize(data) {
+    // eslint-disable-next-line typescript-eslint/no-unsafe-argument
     return ArrayBuffer.isView(data) ? data : JSON.parse(data)
   },
 }
@@ -56,6 +61,7 @@ const defaultSerializer                  = {
                                   
                                                     
                                                       
+                                   
                                        
                                            
                             
@@ -73,7 +79,7 @@ const defaultSerializer                  = {
 const VERSION = 5
 const MAX_DURATION = 365000000e3
 
-export class Cache                                               extends EventEmitter {
+export class Cache                                              extends EventEmitter {
   #memory                       
   #dedupe = new Map                    ()
   #closed = false
@@ -85,10 +91,11 @@ export class Cache                                               extends EventEm
   #stale                                 
   #serializer               
 
-  #lockMean = 5
-  #lockVar = 0
-  #lockTimeout = 10
   #lockId = randomUUID()
+  #lockVar = 0
+  #lockMean         = 5
+  #lockTimeout         = 10
+  #lockMinTimeout         = 1
 
   #location        
   #database                      = null
@@ -114,8 +121,8 @@ export class Cache                                               extends EventEm
 
   constructor(
     location        ,
-    valueSelector                                    ,
-    keySelector                        ,
+    valueSelector                                     ,
+    keySelector                         ,
     opts                  ,
   ) {
     super()
@@ -124,15 +131,15 @@ export class Cache                                               extends EventEm
     }
     this.#location = location
 
-    if (typeof valueSelector !== 'function') {
+    if (valueSelector !== undefined && typeof valueSelector !== 'function') {
       throw new TypeError('valueSelector must be a function')
     }
-    this.#valueSelector = valueSelector
+    this.#valueSelector = valueSelector ?? (() => undefined                )
 
-    if (typeof keySelector !== 'function') {
+    if (keySelector !== undefined && typeof keySelector !== 'function') {
       throw new TypeError('keySelector must be a function')
     }
-    this.#keySelector = keySelector
+    this.#keySelector = keySelector ?? ((...args   ) => JSON.stringify(args))
 
     if (typeof opts?.ttl === 'number' || opts?.ttl === undefined) {
       const ttl = opts?.ttl ?? Number.MAX_SAFE_INTEGER
@@ -152,6 +159,24 @@ export class Cache                                               extends EventEm
       throw new TypeError('stale must be a undefined, number or a function')
     }
 
+    if (opts?.lock === false || opts?.lock === null) {
+      this.#lockMinTimeout = -1
+      this.#lockTimeout = -1
+      this.#lockMean = -1
+    } else if (opts?.lock !== undefined) {
+      if (typeof opts.lock !== 'object' || opts.lock === null) {
+        throw new TypeError('lock must be an object')
+      }
+      if (opts.lock.minTimeout !== undefined) {
+        if (typeof opts.lock.minTimeout !== 'number') {
+          throw new TypeError('lock.minTimeout must be a number')
+        }
+        this.#lockMinTimeout = Math.max(0, opts.lock.minTimeout)
+        this.#lockTimeout = this.#lockMinTimeout
+        this.#lockMean = this.#lockTimeout / 1.2
+      }
+    }
+
     if (opts?.serializer !== undefined) {
       if (typeof opts.serializer !== 'object' || opts.serializer === null) {
         throw new TypeError('serializer must be an object')
@@ -178,7 +203,6 @@ export class Cache                                               extends EventEm
         this.#database.exec(`
           PRAGMA journal_mode = WAL;
           PRAGMA synchronous = NORMAL;
-          PRAGMA temp_store = memory;
           PRAGMA cache_size = -${Math.ceil(maxSize / 1024 / 8)};
           PRAGMA mmap_size = ${maxSize};
           PRAGMA max_page_count = ${Math.ceil(maxSize / 4096)};
@@ -276,11 +300,14 @@ export class Cache                                               extends EventEm
     }
 
     return {
-      lock: {
-        timeout: this.#lockTimeout,
-        mean: this.#lockMean,
-        stddev: Math.sqrt(this.#lockVar),
-      },
+      lock:
+        this.#lockTimeout >= 0
+          ? {
+              timeout: this.#lockTimeout,
+              mean: this.#lockMean,
+              stddev: Math.sqrt(this.#lockVar),
+            }
+          : undefined,
       dedupe: { size: this.#dedupe.size },
       memory: this.#memory?.stats,
       database,
@@ -348,6 +375,7 @@ export class Cache                                               extends EventEm
       this.#memory?.purgeStale(Date.now())
       this.#purgeStaleQuery?.run(Date.now())
       this.#lockPurgeQuery?.run(Date.now() - 3_600_000)
+      this.#database?.exec('PRAGMA optimize')
     } catch (err) {
       this.#emitError(err         )
     }
@@ -428,15 +456,17 @@ export class Cache                                               extends EventEm
       return { async: true, value: existing }
     }
 
-    // Another process holds the lock — wait for the value instead of calling valueSelector.
-    // Use deferred pattern so #waitForValue can check promise identity to detect delete+get races.
-    const lockResult = this.#tryAcquireLock(key)
-    if (typeof lockResult === 'number') {
-      const { promise, resolve, reject } = Promise.withResolvers   ()
-      promise.catch(noop)
-      this.#dedupe.set(key, promise)
-      this.#waitForValue(args, key, lockResult, promise).then(resolve, reject)
-      return { async: true, value: promise }
+    if (this.#lockTimeout >= 0) {
+      // Another process holds the lock — wait for the value instead of calling valueSelector.
+      // Use deferred pattern so #waitForValue can check promise identity to detect delete+get races.
+      const lockResult = this.#tryAcquireLock(key)
+      if (typeof lockResult === 'number') {
+        const { promise, resolve, reject } = Promise.withResolvers   ()
+        promise.catch(noop)
+        this.#dedupe.set(key, promise)
+        this.#waitForValue(args, key, lockResult, promise).then(resolve, reject)
+        return { async: true, value: promise }
+      }
     }
 
     const res = this.#fetch(args)
@@ -505,7 +535,7 @@ export class Cache                                               extends EventEm
       throw new TypeError('ttl must be nully or a positive integer')
     }
 
-    const staleValue = Math.min(MAX_DURATION, this.#stale(value, key) ?? Number.MAX_SAFE_INTEGER)
+    const staleValue = Math.min(MAX_DURATION, this.#stale(value, key) ?? Infinity)
     if (!Number.isFinite(staleValue) || staleValue < 0) {
       throw new TypeError('stale must be nully or a positive integer')
     }
@@ -629,7 +659,7 @@ export class Cache                                               extends EventEm
     this.#lockMean += alpha * diff
     this.#lockVar = (1 - alpha) * (this.#lockVar + alpha * diff * diff)
     this.#lockTimeout = Math.max(
-      10,
+      this.#lockMinTimeout,
       Math.min(1_000, Math.ceil(this.#lockMean * 1.2 + Math.sqrt(this.#lockVar) * 3)),
     )
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/cache",
-  "version": "2.0.7",
+  "version": "2.1.1",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -30,5 +30,5 @@
     "tsd": "^0.33.0",
     "typescript": "^5.9.3"
   },
-  "gitHead": "c9b449408262ca9431467193d624f1a043d669bb"
+  "gitHead": "3b68f317345f4e74459689d2a82fb0a5cc785d1f"
 }