dynamic-throttled-queue 2.0.0 → 2.1.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/README.md
CHANGED
|
@@ -28,6 +28,8 @@ throttle(() => {
|
|
|
28
28
|
|
|
29
29
|
Callbacks can return `false` to signal an error (used for dynamic rate adjustment and retry). Async callbacks (returning a Promise) are also supported — rejections and `false` resolutions count as errors.
|
|
30
30
|
|
|
31
|
+
Set `concurrency` to bound callbacks that are still awaiting asynchronous completion. This limit is independent of the request-start rate; omitting it preserves the existing unlimited in-flight behavior.
|
|
32
|
+
|
|
31
33
|
## Options
|
|
32
34
|
|
|
33
35
|
| Param | Type | Default | Description |
|
|
@@ -39,6 +41,7 @@ Callbacks can return `false` to signal an error (used for dynamic rate adjustmen
|
|
|
39
41
|
| `errors_per_interval` | `number` | `5` | Error threshold per interval before adjusting rate |
|
|
40
42
|
| `back_off` | `boolean` | `false` | Back off for 1 full interval when error threshold is hit |
|
|
41
43
|
| `retry` | `number` | `0` | Number of times to retry failed callbacks |
|
|
44
|
+
| `concurrency` | `number` | — | Maximum callbacks awaiting asynchronous completion; omit for no limit |
|
|
42
45
|
| `compact_threshold` | `number` | `512` | Minimum dead slots before internal queue compaction triggers |
|
|
43
46
|
| `onRateChange` | `(rate: number) => void` | — | Called when the current rate changes |
|
|
44
47
|
|
|
@@ -9,6 +9,8 @@ export type ThrottleOptions = {
|
|
|
9
9
|
errors_per_interval?: number;
|
|
10
10
|
back_off?: boolean;
|
|
11
11
|
retry?: number;
|
|
12
|
+
/** Maximum number of callbacks awaiting asynchronous settlement. Omit for no limit. */
|
|
13
|
+
concurrency?: number;
|
|
12
14
|
/** Minimum dead slots before queue compaction triggers. Default 512. */
|
|
13
15
|
compact_threshold?: number;
|
|
14
16
|
onRateChange?: (rate: number) => void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export function createThrottledQueue(options) {
|
|
2
|
-
const { min_rpi, interval, max_rpi = min_rpi, evenly_spaced = true, back_off = false, retry = 0, compact_threshold = 512, onRateChange, } = options;
|
|
2
|
+
const { min_rpi, interval, max_rpi = min_rpi, evenly_spaced = true, back_off = false, retry = 0, concurrency, compact_threshold = 512, onRateChange, } = options;
|
|
3
3
|
const errors_per_interval = options.errors_per_interval ?? 5;
|
|
4
4
|
if (!Number.isInteger(min_rpi) || min_rpi < 1) {
|
|
5
5
|
throw new Error("min_rpi must be a positive integer");
|
|
@@ -10,6 +10,9 @@ export function createThrottledQueue(options) {
|
|
|
10
10
|
if (typeof interval !== "number" || interval <= 0) {
|
|
11
11
|
throw new Error("interval must be a positive number");
|
|
12
12
|
}
|
|
13
|
+
if (concurrency !== undefined && (!Number.isInteger(concurrency) || concurrency < 1)) {
|
|
14
|
+
throw new Error("concurrency must be a positive integer");
|
|
15
|
+
}
|
|
13
16
|
let current_rpi = Math.ceil((max_rpi + min_rpi) / 2);
|
|
14
17
|
let dyn_interval = evenly_spaced ? interval / current_rpi : interval;
|
|
15
18
|
let dyn_requests_per_interval = evenly_spaced ? 1 : current_rpi;
|
|
@@ -19,6 +22,8 @@ export function createThrottledQueue(options) {
|
|
|
19
22
|
let last_called = 0;
|
|
20
23
|
let timeout;
|
|
21
24
|
let dynTimeout;
|
|
25
|
+
let active_count = 0;
|
|
26
|
+
const max_concurrency = concurrency ?? Infinity;
|
|
22
27
|
const queue = [];
|
|
23
28
|
let head = 0;
|
|
24
29
|
/** Halts timers. Retains unprocessed queue items; next enqueue resumes from where it left off. */
|
|
@@ -45,6 +50,14 @@ export function createThrottledQueue(options) {
|
|
|
45
50
|
}
|
|
46
51
|
}
|
|
47
52
|
}
|
|
53
|
+
function handleSettlement(item, result, resume = false) {
|
|
54
|
+
active_count--;
|
|
55
|
+
handleResult(item, result);
|
|
56
|
+
// A released slot can unblock pending work; dequeue still observes rate pacing.
|
|
57
|
+
if (resume && isRunning && !skippedLast && queue.length > head) {
|
|
58
|
+
dequeue();
|
|
59
|
+
}
|
|
60
|
+
}
|
|
48
61
|
function dequeue() {
|
|
49
62
|
const threshold = last_called + dyn_interval;
|
|
50
63
|
const now = Date.now();
|
|
@@ -53,26 +66,30 @@ export function createThrottledQueue(options) {
|
|
|
53
66
|
timeout = setTimeout(dequeue, threshold - now);
|
|
54
67
|
return;
|
|
55
68
|
}
|
|
69
|
+
// Retries appended by settlement are outside this batch and need another start opportunity.
|
|
56
70
|
const end = Math.min(head + dyn_requests_per_interval, queue.length);
|
|
57
|
-
|
|
58
|
-
|
|
71
|
+
let started = 0;
|
|
72
|
+
while (head < end && active_count < max_concurrency) {
|
|
73
|
+
const item = queue[head++];
|
|
74
|
+
active_count++;
|
|
75
|
+
if (started++ === 0) {
|
|
76
|
+
last_called = Date.now();
|
|
77
|
+
}
|
|
59
78
|
let result;
|
|
60
79
|
try {
|
|
61
80
|
result = item.fn();
|
|
62
81
|
}
|
|
63
82
|
catch {
|
|
64
|
-
|
|
83
|
+
handleSettlement(item, false);
|
|
65
84
|
continue;
|
|
66
85
|
}
|
|
67
86
|
if (result instanceof Promise) {
|
|
68
|
-
void result.then(
|
|
87
|
+
void result.then(value => handleSettlement(item, value, true), () => handleSettlement(item, false, true));
|
|
69
88
|
}
|
|
70
89
|
else {
|
|
71
|
-
|
|
90
|
+
handleSettlement(item, result);
|
|
72
91
|
}
|
|
73
92
|
}
|
|
74
|
-
head = end;
|
|
75
|
-
last_called = Date.now();
|
|
76
93
|
// ponytail: splice is O(n), amortized by only firing when head > half array length
|
|
77
94
|
if (head > compact_threshold && head > queue.length / 2) {
|
|
78
95
|
queue.splice(0, head);
|
|
@@ -82,6 +99,9 @@ export function createThrottledQueue(options) {
|
|
|
82
99
|
stop();
|
|
83
100
|
return;
|
|
84
101
|
}
|
|
102
|
+
if (active_count >= max_concurrency) {
|
|
103
|
+
return;
|
|
104
|
+
}
|
|
85
105
|
timeout = setTimeout(dequeue, dyn_interval);
|
|
86
106
|
}
|
|
87
107
|
function applyRate(newRpi) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dynamic-throttled-queue.js","sourceRoot":"","sources":["../src/dynamic-throttled-queue.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"dynamic-throttled-queue.js","sourceRoot":"","sources":["../src/dynamic-throttled-queue.ts"],"names":[],"mappings":"AA4BA,MAAM,UAAU,oBAAoB,CAAC,OAAwB;IAC3D,MAAM,EACJ,OAAO,EACP,QAAQ,EACR,OAAO,GAAG,OAAO,EACjB,aAAa,GAAG,IAAI,EACpB,QAAQ,GAAG,KAAK,EAChB,KAAK,GAAG,CAAC,EACT,WAAW,EACX,iBAAiB,GAAG,GAAG,EACvB,YAAY,GACb,GAAG,OAAO,CAAC;IAEZ,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAC;IAE7D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,OAAO,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,IAAI,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrE,IAAI,yBAAyB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAChE,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,OAAkD,CAAC;IACvD,IAAI,UAAqD,CAAC;IAC1D,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,MAAM,eAAe,GAAG,WAAW,IAAI,QAAQ,CAAC;IAEhD,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,kGAAkG;IAClG,SAAS,IAAI;QACX,SAAS,GAAG,KAAK,CAAC;QAClB,WAAW,GAAG,KAAK,CAAC;QACpB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,SAAS,CAAC;QACpB,YAAY,CAAC,UAAU,CAAC,CAAC;QACzB,UAAU,GAAG,SAAS,CAAC;QACvB,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACzB,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACjB,IAAI,GAAG,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAED,SAAS,YAAY,CAAC,IAAe,EAAE,MAAsB;QAC3D,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,WAAW,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;oBACtC,KAAK,EAAE,CAAC;gBACV,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,gBAAgB,CAAC,IAAe,EAAE,MAAsB,EAAE,MAAM,GAAG,KAAK;QAC/E,YAAY,EAAE,CAAC;QACf,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE3B,gFAAgF;QAChF,IAAI,MAAM,IAAI,SAAS,IAAI,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YAC/D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IACD,SAAS,OAAO;QACd,MAAM,SAAS,GAAG,WAAW,GAAG,YAAY,CAAC;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,GAAG,GAAG,SAAS,EAAE,CAAC;YACpB,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,SAAS,GAAG,GAAG,CAAC,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,4FAA4F;QAC5F,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACrE,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,GAAG,GAAG,IAAI,YAAY,GAAG,eAAe,EAAE,CAAC;YACpD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAE,CAAC;YAC5B,YAAY,EAAE,CAAC;YACf,IAAI,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;gBACpB,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC3B,CAAC;YAED,IAAI,MAAoC,CAAC;YACzC,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,CAAC;YACD,MAAM,CAAC;gBACL,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC9B,SAAS;YACX,CAAC;YACD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;gBAC9B,KAAK,MAAM,CAAC,IAAI,CACd,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC5C,GAAG,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAC1C,CAAC;YACJ,CAAC;iBACI,CAAC;gBACJ,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,mFAAmF;QACnF,IAAI,IAAI,GAAG,iBAAiB,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxD,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACtB,IAAI,GAAG,CAAC,CAAC;QACX,CAAC;QAED,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACzB,IAAI,EAAE,CAAC;YACP,OAAO;QACT,CAAC;QACD,IAAI,YAAY,IAAI,eAAe,EAAE,CAAC;YACpC,OAAO;QACT,CAAC;QACD,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IACD,SAAS,SAAS,CAAC,MAAc;QAC/B,IAAI,MAAM,KAAK,WAAW;YAAE,OAAO;QACnC,WAAW,GAAG,MAAM,CAAC;QACrB,YAAY,EAAE,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,aAAa,EAAE,CAAC;YAClB,YAAY,GAAG,QAAQ,GAAG,WAAW,CAAC;QACxC,CAAC;aACI,CAAC;YACJ,yBAAyB,GAAG,WAAW,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,kHAAkH;IAClH,SAAS,UAAU;QACjB,UAAU,GAAG,SAAS,CAAC;QACvB,MAAM,UAAU,GAAG,WAAW,CAAC;QAC/B,WAAW,GAAG,KAAK,CAAC;QAEpB,IAAI,WAAW,IAAI,mBAAmB,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC;YAE9C,IAAI,SAAS,IAAI,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;gBACzC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,WAAW,GAAG,IAAI,CAAC;gBACnB,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,QAAQ,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;aACI,IAAI,CAAC,UAAU,IAAI,WAAW,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YACjE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,WAAW,GAAG,CAAC,CAAC;QAEhB,IAAI,SAAS,EAAE,CAAC;YACd,UAAU,GAAG,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,SAAS,KAAK;QACZ,IAAI,WAAW;YAAE,OAAO;QACxB,SAAS,GAAG,IAAI,CAAC;QACjB,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,SAAS,OAAO,CAAC,QAA0B;QACzC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,KAAK,EAAE,CAAC;QACV,CAAC;IACH,CAAC;IAED,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IACpB,uEAAuE;IACvE,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC;IAE9E,OAAO,OAAyB,CAAC;AACnC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dynamic-throttled-queue",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Dynamically throttles arbitrary code to execute between a minimum and maximum number of times per interval. Best for making throttled API requests.",
|
|
6
6
|
"files": [
|
|
@@ -12,21 +12,6 @@
|
|
|
12
12
|
},
|
|
13
13
|
"cjs": false
|
|
14
14
|
},
|
|
15
|
-
"scripts": {
|
|
16
|
-
"build": "zshy",
|
|
17
|
-
"test": "vitest run",
|
|
18
|
-
"test:watch": "vitest",
|
|
19
|
-
"lint:ts": "tsc --noEmit -p tsconfig.json",
|
|
20
|
-
"lint:esl": "eslint --config eslint.config.ts \"src/**/*.{j,t}s{,x}\" --cache --max-warnings=0",
|
|
21
|
-
"lint:esl:fix": "pnpm lint:esl --fix",
|
|
22
|
-
"lint:s": "eslint --config eslint.config.style.ts \"src/**/*.{j,t}s{,x}\" --cache --max-warnings=0",
|
|
23
|
-
"lint:fix": "pnpm lint:s --fix",
|
|
24
|
-
"lint:knip": "knip",
|
|
25
|
-
"lint:jscpd": "jscpd .",
|
|
26
|
-
"lint": "pnpm lint:ts && pnpm lint:esl",
|
|
27
|
-
"lint:e18e": "pnpm dlx @e18e/cli analyze",
|
|
28
|
-
"preinstall": "only-allow pnpm"
|
|
29
|
-
},
|
|
30
15
|
"repository": {
|
|
31
16
|
"type": "git",
|
|
32
17
|
"url": "git+https://github.com/adrianbrowning/dynamic-throttled-queue.git"
|
|
@@ -70,5 +55,25 @@
|
|
|
70
55
|
"types": "./dist/dynamic-throttled-queue.d.ts",
|
|
71
56
|
"default": "./dist/dynamic-throttled-queue.js"
|
|
72
57
|
}
|
|
58
|
+
},
|
|
59
|
+
"dependencies": {
|
|
60
|
+
"@varlock/bumpy": "^1.18.1"
|
|
61
|
+
},
|
|
62
|
+
"scripts": {
|
|
63
|
+
"build": "zshy",
|
|
64
|
+
"test": "vitest run",
|
|
65
|
+
"test:watch": "vitest",
|
|
66
|
+
"lint:ts": "tsc --noEmit -p tsconfig.json",
|
|
67
|
+
"lint:esl": "eslint --config eslint.config.ts \"src/**/*.{j,t}s{,x}\" --cache --max-warnings=0",
|
|
68
|
+
"lint:esl:fix": "pnpm lint:esl --fix",
|
|
69
|
+
"lint:s": "eslint --config eslint.config.style.ts \"src/**/*.{j,t}s{,x}\" --cache --max-warnings=0",
|
|
70
|
+
"lint:fix": "pnpm lint:s --fix",
|
|
71
|
+
"lint:knip": "knip",
|
|
72
|
+
"lint:jscpd": "jscpd .",
|
|
73
|
+
"lint": "pnpm lint:ts && pnpm lint:esl",
|
|
74
|
+
"lint:e18e": "pnpm dlx @e18e/cli analyze",
|
|
75
|
+
"preinstall": "only-allow pnpm",
|
|
76
|
+
"bump": "bumpy add",
|
|
77
|
+
"bump:status": "bumpy status"
|
|
73
78
|
}
|
|
74
|
-
}
|
|
79
|
+
}
|