layercache 1.2.1 → 1.2.2

package/packages/nestjs/dist/index.d.ts

@@ -156,6 +156,7 @@ interface CacheSingleFlightExecutionOptions {
     leaseMs: number;
     waitTimeoutMs: number;
     pollIntervalMs: number;
+    renewIntervalMs?: number;
 }
 interface CacheSingleFlightCoordinator {
     execute<T>(key: string, options: CacheSingleFlightExecutionOptions, worker: () => Promise<T>, waiter: () => Promise<T>): Promise<T>;
@@ -189,6 +190,7 @@ interface CacheStackOptions {
     singleFlightLeaseMs?: number;
     singleFlightTimeoutMs?: number;
     singleFlightPollMs?: number;
+    singleFlightRenewIntervalMs?: number;
     /**
      * Maximum number of entries in `accessProfiles` and `circuitBreakers` maps
      * before the oldest entries are pruned. Prevents unbounded memory growth.
@@ -219,6 +221,8 @@ interface CacheRateLimitOptions {
     maxConcurrent?: number;
     intervalMs?: number;
     maxPerInterval?: number;
+    scope?: 'global' | 'key' | 'fetcher';
+    bucketKey?: string;
 }
 interface CacheWriteBehindOptions {
     flushIntervalMs?: number;
@@ -527,6 +531,7 @@ declare class CacheStack extends EventEmitter {
     private validateWriteOptions;
     private validateLayerNumberOption;
     private validatePositiveNumber;
+    private validateRateLimitOptions;
     private validateNonNegativeNumber;
     private validateCacheKey;
     private validateTtlPolicy;

package/packages/nestjs/dist/index.js

@@ -562,11 +562,12 @@ var CircuitBreakerManager = class {
 
 // ../../src/internal/FetchRateLimiter.ts
 var FetchRateLimiter = class {
-  active = 0;
   queue = [];
-  startedAt = [];
+  buckets = /* @__PURE__ */ new Map();
+  fetcherBuckets = /* @__PURE__ */ new WeakMap();
+  nextFetcherBucketId = 0;
   drainTimer;
-  async schedule(options, task) {
+  async schedule(options, context, task) {
     if (!options) {
       return task();
     }
@@ -575,7 +576,13 @@ var FetchRateLimiter = class {
       return task();
     }
     return new Promise((resolve, reject) => {
-      this.queue.push({ options: normalized, task, resolve, reject });
+      this.queue.push({
+        bucketKey: this.resolveBucketKey(normalized, context),
+        options: normalized,
+        task,
+        resolve,
+        reject
+      });
       this.drain();
     });
   }
@@ -589,63 +596,109 @@ var FetchRateLimiter = class {
     return {
       maxConcurrent,
       intervalMs,
-      maxPerInterval
+      maxPerInterval,
+      scope: options.scope ?? "global",
+      bucketKey: options.bucketKey
     };
   }
+  resolveBucketKey(options, context) {
+    if (options.bucketKey) {
+      return `custom:${options.bucketKey}`;
+    }
+    if (options.scope === "key") {
+      return `key:${context.key}`;
+    }
+    if (options.scope === "fetcher") {
+      const existing = this.fetcherBuckets.get(context.fetcher);
+      if (existing) {
+        return existing;
+      }
+      const bucket = `fetcher:${this.nextFetcherBucketId}`;
+      this.nextFetcherBucketId += 1;
+      this.fetcherBuckets.set(context.fetcher, bucket);
+      return bucket;
+    }
+    return "global";
+  }
   drain() {
     if (this.drainTimer) {
       clearTimeout(this.drainTimer);
       this.drainTimer = void 0;
     }
     while (this.queue.length > 0) {
-      const next = this.queue[0];
-      if (!next) {
+      let nextIndex = -1;
+      let nextWaitMs = Number.POSITIVE_INFINITY;
+      for (let index = 0; index < this.queue.length; index += 1) {
+        const next2 = this.queue[index];
+        if (!next2) {
+          continue;
+        }
+        const waitMs = this.waitTime(next2.bucketKey, next2.options);
+        if (waitMs <= 0) {
+          nextIndex = index;
+          break;
+        }
+        nextWaitMs = Math.min(nextWaitMs, waitMs);
+      }
+      if (nextIndex < 0) {
+        if (Number.isFinite(nextWaitMs)) {
+          this.drainTimer = setTimeout(() => {
+            this.drainTimer = void 0;
+            this.drain();
+          }, nextWaitMs);
+          this.drainTimer.unref?.();
+        }
         return;
       }
-      const waitMs = this.waitTime(next.options);
-      if (waitMs > 0) {
-        this.drainTimer = setTimeout(() => {
-          this.drainTimer = void 0;
-          this.drain();
-        }, waitMs);
-        this.drainTimer.unref?.();
+      const next = this.queue.splice(nextIndex, 1)[0];
+      if (!next) {
         return;
       }
-      this.queue.shift();
-      this.active += 1;
-      this.startedAt.push(Date.now());
+      const bucket = this.bucketState(next.bucketKey);
+      bucket.active += 1;
+      bucket.startedAt.push(Date.now());
       void next.task().then(next.resolve, next.reject).finally(() => {
-        this.active -= 1;
+        bucket.active -= 1;
         this.drain();
       });
     }
   }
-  waitTime(options) {
+  waitTime(bucketKey, options) {
+    const bucket = this.bucketState(bucketKey);
     const now = Date.now();
-    if (options.maxConcurrent && this.active >= options.maxConcurrent) {
+    if (options.maxConcurrent && bucket.active >= options.maxConcurrent) {
       return 1;
     }
     if (!options.intervalMs || !options.maxPerInterval) {
       return 0;
     }
-    this.prune(now, options.intervalMs);
-    if (this.startedAt.length < options.maxPerInterval) {
+    this.prune(bucket, now, options.intervalMs);
+    if (bucket.startedAt.length < options.maxPerInterval) {
       return 0;
     }
-    const oldest = this.startedAt[0];
+    const oldest = bucket.startedAt[0];
     if (!oldest) {
       return 0;
     }
     return Math.max(1, options.intervalMs - (now - oldest));
   }
-  prune(now, intervalMs) {
-    while (this.startedAt.length > 0) {
-      const startedAt = this.startedAt[0];
+  prune(bucket, now, intervalMs) {
+    while (bucket.startedAt.length > 0) {
+      const startedAt = bucket.startedAt[0];
       if (startedAt === void 0 || now - startedAt < intervalMs) {
         break;
       }
-      this.startedAt.shift();
+      bucket.startedAt.shift();
+    }
+  }
+  bucketState(bucketKey) {
+    const existing = this.buckets.get(bucketKey);
+    if (existing) {
+      return existing;
     }
+    const bucket = { active: 0, startedAt: [] };
+    this.buckets.set(bucketKey, bucket);
+    return bucket;
   }
 };
 
@@ -1751,6 +1804,7 @@ var CacheStack = class extends EventEmitter {
     try {
       fetched = await this.fetchRateLimiter.schedule(
         options?.fetcherRateLimit ?? this.options.fetcherRateLimit,
+        { key, fetcher },
         fetcher
       );
       this.circuitBreakerManager.recordSuccess(key);
@@ -2008,7 +2062,8 @@ var CacheStack = class extends EventEmitter {
     return {
       leaseMs: this.options.singleFlightLeaseMs ?? DEFAULT_SINGLE_FLIGHT_LEASE_MS,
       waitTimeoutMs: this.options.singleFlightTimeoutMs ?? DEFAULT_SINGLE_FLIGHT_TIMEOUT_MS,
-      pollIntervalMs: this.options.singleFlightPollMs ?? DEFAULT_SINGLE_FLIGHT_POLL_MS
+      pollIntervalMs: this.options.singleFlightPollMs ?? DEFAULT_SINGLE_FLIGHT_POLL_MS,
+      renewIntervalMs: this.options.singleFlightRenewIntervalMs
     };
   }
   async deleteKeys(keys) {
@@ -2213,6 +2268,8 @@ var CacheStack = class extends EventEmitter {
     this.validatePositiveNumber("singleFlightLeaseMs", this.options.singleFlightLeaseMs);
     this.validatePositiveNumber("singleFlightTimeoutMs", this.options.singleFlightTimeoutMs);
     this.validatePositiveNumber("singleFlightPollMs", this.options.singleFlightPollMs);
+    this.validatePositiveNumber("singleFlightRenewIntervalMs", this.options.singleFlightRenewIntervalMs);
+    this.validateRateLimitOptions("fetcherRateLimit", this.options.fetcherRateLimit);
     this.validateAdaptiveTtlOptions(this.options.adaptiveTtl);
     this.validateCircuitBreakerOptions(this.options.circuitBreaker);
     if (this.options.generation !== void 0) {
@@ -2232,6 +2289,7 @@ var CacheStack = class extends EventEmitter {
     this.validateTtlPolicy("options.ttlPolicy", options.ttlPolicy);
     this.validateAdaptiveTtlOptions(options.adaptiveTtl);
     this.validateCircuitBreakerOptions(options.circuitBreaker);
+    this.validateRateLimitOptions("options.fetcherRateLimit", options.fetcherRateLimit);
   }
   validateLayerNumberOption(name, value) {
     if (value === void 0) {
@@ -2256,6 +2314,20 @@ var CacheStack = class extends EventEmitter {
       throw new Error(`${name} must be a positive finite number.`);
     }
   }
+  validateRateLimitOptions(name, options) {
+    if (!options) {
+      return;
+    }
+    this.validatePositiveNumber(`${name}.maxConcurrent`, options.maxConcurrent);
+    this.validatePositiveNumber(`${name}.intervalMs`, options.intervalMs);
+    this.validatePositiveNumber(`${name}.maxPerInterval`, options.maxPerInterval);
+    if (options.scope && !["global", "key", "fetcher"].includes(options.scope)) {
+      throw new Error(`${name}.scope must be one of "global", "key", or "fetcher".`);
+    }
+    if (options.bucketKey !== void 0 && options.bucketKey.length === 0) {
+      throw new Error(`${name}.bucketKey must not be empty.`);
+    }
+  }
   validateNonNegativeNumber(name, value) {
     if (!Number.isFinite(value) || value < 0) {
       throw new Error(`${name} must be a non-negative finite number.`);