adaptive-concurrency 0.5.0 → 0.6.0

package/dist/limiter/allocation-unavailable-strategies/BlockingBacklogRejection.d.ts

@@ -1,20 +1,20 @@
 import type { LimitAllotment } from "../../LimitAllotment.js";
 import type { AcquireResult, AllotmentUnavailableStrategy } from "../../Limiter.js";
-import type { EnqueueDirection, EnqueueOptions } from "../../utils/LinkedWaiterQueue.js";
+import type { EnqueueOptions } from "../../utils/LinkedWaiterQueue.js";
 export type Waiter<ContextT> = {
     context: ContextT;
     retry: (context: ContextT) => AcquireResult;
     resolve: (allotment: LimitAllotment | undefined) => void;
 };
 export declare const MAX_TIMEOUT: number;
-export type BlockingBacklogRejectionOptions<ContextT, Handle> = {
+export type BlockingBacklogRejectionOptions<ContextT, Handle, EnqueueOptionsT = EnqueueOptions> = {
     backlogSize: number;
     backlogTimeout: number | ((context: ContextT) => number);
-    queue: WaiterQueue<ContextT, Handle>;
-    enqueueDirection: EnqueueDirection | ((context: ContextT) => EnqueueDirection);
+    queue: WaiterQueue<ContextT, Handle, EnqueueOptionsT>;
+    enqueueOptions: EnqueueOptionsT | ((context: ContextT) => EnqueueOptionsT);
 };
-export type WaiterQueue<ContextT, Handle> = {
-    enqueue: (waiter: Waiter<ContextT>, options: EnqueueOptions) => {
+export type WaiterQueue<ContextT, Handle, EnqueueOptionsT = EnqueueOptions> = {
+    enqueue: (waiter: Waiter<ContextT>, options: EnqueueOptionsT) => {
         value: Waiter<ContextT>;
         handle: Handle;
     };
@@ -25,14 +25,14 @@ export type WaiterQueue<ContextT, Handle> = {
     removeByHandle: (handle: Handle) => boolean;
     size: () => number;
 };
-export declare class BlockingBacklogRejection<ContextT, Handle> implements AllotmentUnavailableStrategy<ContextT> {
+export declare class BlockingBacklogRejection<ContextT, Handle, EnqueueOptionsT = EnqueueOptions> implements AllotmentUnavailableStrategy<ContextT> {
     private readonly backlogSize;
     private readonly getBacklogTimeout;
     private readonly getEnqueueOptions;
     private readonly queue;
     private drainInProgress;
     private releaseDuringDrain;
-    constructor(options: BlockingBacklogRejectionOptions<ContextT, Handle>);
+    constructor(options: BlockingBacklogRejectionOptions<ContextT, Handle, EnqueueOptionsT>);
     onAllotmentUnavailable(context: ContextT, retry: (context: ContextT) => AcquireResult, signal?: AbortSignal): Promise<LimitAllotment | undefined>;
     onAllotmentReleased(): Promise<void>;
     onLimitChanged(oldLimit: number, newLimit: number): void;

package/dist/limiter/allocation-unavailable-strategies/BlockingBacklogRejection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlockingBacklogRejection.d.ts","sourceRoot":"","sources":["../../../src/limiter/allocation-unavailable-strategies/BlockingBacklogRejection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,4BAA4B,EAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACf,MAAM,kCAAkC,CAAC;AAE1C,MAAM,MAAM,MAAM,CAAC,QAAQ,IAAI;IAC7B,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,aAAa,CAAC;IAC5C,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,KAAK,IAAI,CAAC;CAC1D,CAAC;AAEF,eAAO,MAAM,WAAW,QAAiB,CAAC;AAE1C,MAAM,MAAM,+BAA+B,CAAC,QAAQ,EAAE,MAAM,IAAI;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IACzD,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrC,gBAAgB,EACZ,gBAAgB,GAChB,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,gBAAgB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,IAAI;IAC1C,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,EACxB,OAAO,EAAE,cAAc,KACpB;QAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,QAAQ,EAAE,MAAM;QAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACxE,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,IAAI,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAEF,qBAAa,wBAAwB,CACnC,QAAQ,EACR,MAAM,CACN,YAAW,4BAA4B,CAAC,QAAQ,CAAC;IACjD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAwC;IAC1E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgC;IACtD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,kBAAkB,CAAS;gBAEvB,OAAO,EAAE,+BAA+B,CAAC,QAAQ,EAAE,MAAM,CAAC;IA6BtE,sBAAsB,CACpB,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,aAAa,EAC3C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAYhC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6C1C,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQxD,OAAO,CAAC,aAAa;IAoCrB,OAAO,CAAC,yBAAyB;CAUlC"}
+{"version":3,"file":"BlockingBacklogRejection.d.ts","sourceRoot":"","sources":["../../../src/limiter/allocation-unavailable-strategies/BlockingBacklogRejection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,4BAA4B,EAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAEvE,MAAM,MAAM,MAAM,CAAC,QAAQ,IAAI;IAC7B,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,aAAa,CAAC;IAC5C,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,KAAK,IAAI,CAAC;CAC1D,CAAC;AAEF,eAAO,MAAM,WAAW,QAAiB,CAAC;AAE1C,MAAM,MAAM,+BAA+B,CACzC,QAAQ,EACR,MAAM,EACN,eAAe,GAAG,cAAc,IAC9B;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC;IACzD,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;IACtD,cAAc,EAAE,eAAe,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK,eAAe,CAAC,CAAC;CAC5E,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,GAAG,cAAc,IAAI;IAC5E,OAAO,EAAE,CACP,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,EACxB,OAAO,EAAE,eAAe,KACrB;QAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,QAAQ,EAAE,MAAM;QAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACxE,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,IAAI,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAEF,qBAAa,wBAAwB,CACnC,QAAQ,EACR,MAAM,EACN,eAAe,GAAG,cAAc,CAChC,YAAW,4BAA4B,CAAC,QAAQ,CAAC;IACjD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgC;IAClE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyC;IAC3E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiD;IACvE,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,kBAAkB,CAAS;gBAGjC,OAAO,EAAE,+BAA+B,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,CAAC;IAiC7E,sBAAsB,CACpB,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,aAAa,EAC3C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAYhC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA6C1C,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAQxD,OAAO,CAAC,aAAa;IAoCrB,OAAO,CAAC,yBAAyB;CAUlC"}

package/dist/limiter/allocation-unavailable-strategies/BlockingBacklogRejection.js

@@ -14,7 +14,7 @@ export class BlockingBacklogRejection {
         this.backlogSize = backlogSize;
         this.queue = options.queue;
         const backlogTimeout = options.backlogTimeout;
-        const enqueueDirection = options.enqueueDirection;
+        const enqueueOptions = options.enqueueOptions;
         this.getBacklogTimeout = (() => {
             if (typeof backlogTimeout === "number") {
                 this.assertTimeoutWithinBounds(backlogTimeout);
@@ -26,10 +26,12 @@ export class BlockingBacklogRejection {
                 return contextTimeout;
             };
         })();
-        this.getEnqueueOptions =
-            typeof enqueueDirection === "function"
-                ? (context) => ({ direction: enqueueDirection(context) })
-                : () => ({ direction: enqueueDirection });
+        if (typeof enqueueOptions === "function") {
+            this.getEnqueueOptions = enqueueOptions;
+        }
+        else {
+            this.getEnqueueOptions = () => enqueueOptions;
+        }
     }
     onAllotmentUnavailable(context, retry, signal) {
         if (signal?.aborted) {

package/dist/limiter/factories/makeBlockingLimiter.js

@@ -7,7 +7,7 @@ export function makeBlockingLimiter(options = {}) {
         allotmentUnavailableStrategy: new BlockingBacklogRejection({
             backlogSize: options.backlogSize ?? Number.POSITIVE_INFINITY,
             backlogTimeout: options.backlogTimeout ?? MAX_TIMEOUT,
-            enqueueDirection: "back",
+            enqueueOptions: { direction: "back" },
             queue: new LinkedWaiterQueue(),
         }),
     });

package/dist/limiter/factories/makeLifoBlockingLimiter.js

@@ -7,7 +7,7 @@ export function makeLifoBlockingLimiter(options = {}) {
         allotmentUnavailableStrategy: new BlockingBacklogRejection({
             backlogSize: options.backlogSize ?? 100,
             backlogTimeout: options.backlogTimeout ?? 1_000,
-            enqueueDirection: "front",
+            enqueueOptions: { direction: "front" },
             queue: new LinkedWaiterQueue(),
         }),
     });

package/dist/limiter/factories/makePartitionedBlockingLimiter.js

@@ -32,7 +32,7 @@ export function makePartitionedBlockingLimiter(options) {
             blockingStrategy: new BlockingBacklogRejection({
                 backlogSize: options.backlogSize ?? Number.POSITIVE_INFINITY,
                 backlogTimeout: options.backlogTimeout ?? MAX_TIMEOUT,
-                enqueueDirection: "back",
+                enqueueOptions: { direction: "back" },
                 queue: new LinkedWaiterQueue(),
             }),
         }),

package/dist/limiter/factories/makePartitionedLifoBlockingLimiter.js

@@ -32,7 +32,7 @@ export function makePartitionedLifoBlockingLimiter(options) {
             blockingStrategy: new BlockingBacklogRejection({
                 backlogSize: options.backlogSize ?? 100,
                 backlogTimeout: options.backlogTimeout ?? 1_000,
-                enqueueDirection: "front",
+                enqueueOptions: { direction: "front" },
                 queue: new LinkedWaiterQueue(),
             }),
         }),

package/dist/utils/LinkedWaiterQueue.d.ts

@@ -3,11 +3,12 @@ declare class ItemHandle {
 export type EnqueueDirection = "front" | "back";
 export type EnqueueOptions = {
     direction: EnqueueDirection;
+    priority?: number | undefined;
 };
 export declare class LinkedWaiterQueue<T extends object> {
-    private head;
-    private tail;
+    private readonly buckets;
     private readonly nodes;
+    private maxPriority;
     private length;
     enqueue(value: T, options: EnqueueOptions): {
         value: T;
@@ -19,8 +20,9 @@ export declare class LinkedWaiterQueue<T extends object> {
     } | undefined;
     removeByHandle(handle: ItemHandle): boolean;
     size(): number;
-    private pushFront;
-    private pushBack;
+    private getOrCreateBucket;
+    private insertInBucket;
+    private unlinkFromBucket;
 }
 export {};
 //# sourceMappingURL=LinkedWaiterQueue.d.ts.map

package/dist/utils/LinkedWaiterQueue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LinkedWaiterQueue.d.ts","sourceRoot":"","sources":["../../src/utils/LinkedWaiterQueue.ts"],"names":[],"mappings":"AAAA,cAAM,UAAU;CAAG;AAEnB,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAC;AAChD,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AASF,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM;IAC7C,OAAO,CAAC,IAAI,CAA4B;IACxC,OAAO,CAAC,IAAI,CAA4B;IACxC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;IAC9D,OAAO,CAAC,MAAM,CAAK;IAEnB,OAAO,CACL,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,cAAc,GACtB;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE;IAoBnC,QAAQ,IAAI;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS;IAUxD,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAuB3C,IAAI,IAAI,MAAM;IAId,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,QAAQ;CAWjB"}
+{"version":3,"file":"LinkedWaiterQueue.d.ts","sourceRoot":"","sources":["../../src/utils/LinkedWaiterQueue.ts"],"names":[],"mappings":"AAAA,cAAM,UAAU;CAAG;AAEnB,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAC;AAChD,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAkBF,qBAAa,iBAAiB,CAAC,CAAC,SAAS,MAAM;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwC;IAChE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;IAC9D,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,MAAM,CAAK;IAEnB,OAAO,CACL,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,cAAc,GACtB;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE;IA0BnC,QAAQ,IAAI;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS;IAcxD,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAa3C,IAAI,IAAI,MAAM;IAId,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,gBAAgB;CA+BzB"}

package/dist/utils/LinkedWaiterQueue.js

@@ -1,35 +1,44 @@
 class ItemHandle {
 }
 export class LinkedWaiterQueue {
-    head;
-    tail;
+    buckets = new Map();
     nodes = new Map();
+    maxPriority;
     length = 0;
     enqueue(value, options) {
         const handle = new ItemHandle();
+        const priority = options.priority ?? 0;
+        if (!Number.isFinite(priority)) {
+            throw new RangeError("priority must be a finite number");
+        }
+        const bucket = this.getOrCreateBucket(priority);
         const node = {
             handle,
             value: value,
+            priority,
             prev: undefined,
             next: undefined,
+            bucket,
         };
         this.nodes.set(handle, node);
-        if (options.direction === "front") {
-            this.pushFront(node);
-        }
-        else {
-            this.pushBack(node);
+        this.insertInBucket(node, options.direction);
+        if (this.maxPriority === undefined || priority > this.maxPriority) {
+            this.maxPriority = priority;
         }
         this.length += 1;
         return { value, handle };
     }
     peekHead() {
-        if (!this.head) {
+        if (this.maxPriority === undefined) {
+            return undefined;
+        }
+        const bucket = this.buckets.get(this.maxPriority);
+        if (!bucket || !bucket.head) {
             return undefined;
         }
         return {
-            value: this.head.value,
-            handle: this.head.handle,
+            value: bucket.head.value,
+            handle: bucket.head.handle,
         };
     }
     removeByHandle(handle) {
@@ -37,44 +46,83 @@ export class LinkedWaiterQueue {
         if (!node)
             return false;
         this.nodes.delete(handle);
+        this.unlinkFromBucket(node);
+        node.prev = undefined;
+        node.next = undefined;
+        this.length -= 1;
+        return true;
+    }
+    size() {
+        return this.length;
+    }
+    getOrCreateBucket(priority) {
+        const existing = this.buckets.get(priority);
+        if (existing) {
+            return existing;
+        }
+        const created = {
+            priority,
+            head: undefined,
+            tail: undefined,
+            size: 0,
+        };
+        this.buckets.set(priority, created);
+        return created;
+    }
+    insertInBucket(node, direction) {
+        const bucket = node.bucket;
+        if (direction === "front") {
+            if (!bucket.head) {
+                bucket.head = node;
+                bucket.tail = node;
+            }
+            else {
+                node.next = bucket.head;
+                bucket.head.prev = node;
+                bucket.head = node;
+            }
+        }
+        else {
+            if (!bucket.tail) {
+                bucket.head = node;
+                bucket.tail = node;
+            }
+            else {
+                node.prev = bucket.tail;
+                bucket.tail.next = node;
+                bucket.tail = node;
+            }
+        }
+        bucket.size += 1;
+    }
+    unlinkFromBucket(node) {
+        const bucket = node.bucket;
         if (node.prev) {
             node.prev.next = node.next;
         }
         else {
-            this.head = node.next;
+            bucket.head = node.next;
         }
         if (node.next) {
             node.next.prev = node.prev;
         }
         else {
-            this.tail = node.prev;
+            bucket.tail = node.prev;
         }
-        node.prev = undefined;
-        node.next = undefined;
-        this.length -= 1;
-        return true;
-    }
-    size() {
-        return this.length;
-    }
-    pushFront(node) {
-        if (!this.head) {
-            this.head = node;
-            this.tail = node;
+        bucket.size -= 1;
+        if (bucket.size > 0) {
             return;
         }
-        node.next = this.head;
-        this.head.prev = node;
-        this.head = node;
-    }
-    pushBack(node) {
-        if (!this.tail) {
-            this.head = node;
-            this.tail = node;
+        this.buckets.delete(bucket.priority);
+        if (this.maxPriority !== bucket.priority) {
             return;
         }
-        node.prev = this.tail;
-        this.tail.next = node;
-        this.tail = node;
+        let newMax;
+        for (const priority of this.buckets.keys()) {
+            if (newMax === undefined || priority > newMax) {
+                newMax = priority;
+            }
+        }
+        this.maxPriority = newMax;
     }
 }

package/package.json

@@ -9,7 +9,7 @@
     "dynamic rate limiting"
   ],
   "author": "Ethan Resnick <ethan.resnick@gmail.com>",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "type": "module",
   "exports": {
     ".": {
@@ -20,15 +20,14 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "test": "node --import tsx --test \"src/**/*.test.ts\"",
-    "prepublishOnly": "pnpm build"
-  },
   "devDependencies": {
     "tsx": "^4.19.0",
     "type-fest": "^5.5.0",
     "type-party": "^0.7.3",
     "typescript": "^6.0.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node --import tsx --test \"src/**/*.test.ts\""
   }
-}
+}