@libp2p/utils 6.7.1 → 6.7.2-a02cb0461
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 +16 -1
- package/dist/index.min.js +6 -1
- package/dist/index.min.js.map +4 -4
- package/dist/src/abstract-message-stream.d.ts +129 -0
- package/dist/src/abstract-message-stream.d.ts.map +1 -0
- package/dist/src/abstract-message-stream.js +389 -0
- package/dist/src/abstract-message-stream.js.map +1 -0
- package/dist/src/abstract-multiaddr-connection.d.ts +26 -0
- package/dist/src/abstract-multiaddr-connection.d.ts.map +1 -0
- package/dist/src/abstract-multiaddr-connection.js +66 -0
- package/dist/src/abstract-multiaddr-connection.js.map +1 -0
- package/dist/src/abstract-stream-muxer.d.ts +53 -0
- package/dist/src/abstract-stream-muxer.d.ts.map +1 -0
- package/dist/src/abstract-stream-muxer.js +169 -0
- package/dist/src/abstract-stream-muxer.js.map +1 -0
- package/dist/src/abstract-stream.d.ts +14 -130
- package/dist/src/abstract-stream.d.ts.map +1 -1
- package/dist/src/abstract-stream.js +39 -321
- package/dist/src/abstract-stream.js.map +1 -1
- package/dist/src/errors.d.ts +8 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/errors.js +8 -0
- package/dist/src/errors.js.map +1 -1
- package/dist/src/index.d.ts +33 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +33 -1
- package/dist/src/index.js.map +1 -1
- package/dist/src/length-prefixed-decoder.d.ts +37 -0
- package/dist/src/length-prefixed-decoder.d.ts.map +1 -0
- package/dist/src/length-prefixed-decoder.js +64 -0
- package/dist/src/length-prefixed-decoder.js.map +1 -0
- package/dist/src/message-queue.d.ts +61 -0
- package/dist/src/message-queue.d.ts.map +1 -0
- package/dist/src/message-queue.js +93 -0
- package/dist/src/message-queue.js.map +1 -0
- package/dist/src/mock-muxer.d.ts +57 -0
- package/dist/src/mock-muxer.d.ts.map +1 -0
- package/dist/src/mock-muxer.js +204 -0
- package/dist/src/mock-muxer.js.map +1 -0
- package/dist/src/mock-stream.d.ts +31 -0
- package/dist/src/mock-stream.d.ts.map +1 -0
- package/dist/src/mock-stream.js +69 -0
- package/dist/src/mock-stream.js.map +1 -0
- package/dist/src/multiaddr/index.d.ts +7 -0
- package/dist/src/multiaddr/index.d.ts.map +1 -0
- package/dist/src/multiaddr/index.js +7 -0
- package/dist/src/multiaddr/index.js.map +1 -0
- package/dist/src/multiaddr-connection-pair.d.ts +25 -0
- package/dist/src/multiaddr-connection-pair.d.ts.map +1 -0
- package/dist/src/multiaddr-connection-pair.js +103 -0
- package/dist/src/multiaddr-connection-pair.js.map +1 -0
- package/dist/src/queue/index.d.ts +5 -0
- package/dist/src/queue/index.d.ts.map +1 -1
- package/dist/src/queue/index.js +24 -9
- package/dist/src/queue/index.js.map +1 -1
- package/dist/src/rate-limiter.d.ts +1 -15
- package/dist/src/rate-limiter.d.ts.map +1 -1
- package/dist/src/rate-limiter.js +1 -14
- package/dist/src/rate-limiter.js.map +1 -1
- package/dist/src/socket-writer.browser.d.ts +2 -0
- package/dist/src/socket-writer.browser.d.ts.map +1 -0
- package/dist/src/socket-writer.browser.js +4 -0
- package/dist/src/socket-writer.browser.js.map +1 -0
- package/dist/src/socket-writer.d.ts +19 -0
- package/dist/src/socket-writer.d.ts.map +1 -0
- package/dist/src/socket-writer.js +43 -0
- package/dist/src/socket-writer.js.map +1 -0
- package/dist/src/stream-pair.d.ts +42 -0
- package/dist/src/stream-pair.d.ts.map +1 -0
- package/dist/src/stream-pair.js +40 -0
- package/dist/src/stream-pair.js.map +1 -0
- package/dist/src/stream-utils.d.ts +199 -0
- package/dist/src/stream-utils.d.ts.map +1 -0
- package/dist/src/stream-utils.js +369 -0
- package/dist/src/stream-utils.js.map +1 -0
- package/package.json +19 -163
- package/src/abstract-message-stream.ts +549 -0
- package/src/abstract-multiaddr-connection.ts +93 -0
- package/src/abstract-stream-muxer.ts +239 -0
- package/src/abstract-stream.ts +51 -464
- package/src/errors.ts +10 -0
- package/src/index.ts +33 -1
- package/src/length-prefixed-decoder.ts +98 -0
- package/src/message-queue.ts +156 -0
- package/src/mock-muxer.ts +304 -0
- package/src/mock-stream.ts +101 -0
- package/src/multiaddr/index.ts +6 -0
- package/src/multiaddr-connection-pair.ts +147 -0
- package/src/queue/index.ts +30 -9
- package/src/rate-limiter.ts +3 -30
- package/src/socket-writer.browser.ts +3 -0
- package/src/socket-writer.ts +64 -0
- package/src/stream-pair.ts +90 -0
- package/src/stream-utils.ts +874 -0
- package/dist/src/abort-options.d.ts +0 -7
- package/dist/src/abort-options.d.ts.map +0 -1
- package/dist/src/abort-options.js +0 -14
- package/dist/src/abort-options.js.map +0 -1
- package/dist/src/array-equals.d.ts +0 -24
- package/dist/src/array-equals.d.ts.map +0 -1
- package/dist/src/array-equals.js +0 -31
- package/dist/src/array-equals.js.map +0 -1
- package/dist/src/close-source.d.ts +0 -4
- package/dist/src/close-source.d.ts.map +0 -1
- package/dist/src/close-source.js +0 -11
- package/dist/src/close-source.js.map +0 -1
- package/dist/src/close.d.ts +0 -21
- package/dist/src/close.d.ts.map +0 -1
- package/dist/src/close.js +0 -49
- package/dist/src/close.js.map +0 -1
- package/dist/src/stream-to-ma-conn.d.ts +0 -23
- package/dist/src/stream-to-ma-conn.d.ts.map +0 -1
- package/dist/src/stream-to-ma-conn.js +0 -75
- package/dist/src/stream-to-ma-conn.js.map +0 -1
- package/dist/typedoc-urls.json +0 -147
- package/src/abort-options.ts +0 -20
- package/src/array-equals.ts +0 -34
- package/src/close-source.ts +0 -14
- package/src/close.ts +0 -65
- package/src/stream-to-ma-conn.ts +0 -105
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { StreamMessageEvent } from '@libp2p/interface';
|
|
2
|
+
import { defaultLogger } from '@libp2p/logger';
|
|
3
|
+
import { multiaddr } from '@multiformats/multiaddr';
|
|
4
|
+
import { pEvent } from 'p-event';
|
|
5
|
+
import { raceSignal } from 'race-signal';
|
|
6
|
+
import { AbstractMultiaddrConnection } from "./abstract-multiaddr-connection.js";
|
|
7
|
+
import { MessageQueue } from "./message-queue.js";
|
|
8
|
+
let multiaddrConnectionId = 0;
|
|
9
|
+
class MockMultiaddrConnection extends AbstractMultiaddrConnection {
|
|
10
|
+
local;
|
|
11
|
+
remote;
|
|
12
|
+
constructor(init) {
|
|
13
|
+
super(init);
|
|
14
|
+
this.local = init.local;
|
|
15
|
+
this.remote = init.remote;
|
|
16
|
+
this.local.addEventListener('drain', () => {
|
|
17
|
+
this.safeDispatchEvent('drain');
|
|
18
|
+
});
|
|
19
|
+
this.remote.addEventListener('message', (evt) => {
|
|
20
|
+
if (this.status !== 'open') {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
this.onData(evt.data);
|
|
24
|
+
});
|
|
25
|
+
this.remote.addEventListener('reset', (evt) => {
|
|
26
|
+
if (this.status !== 'open') {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
this.onRemoteReset();
|
|
30
|
+
});
|
|
31
|
+
this.remote.addEventListener('close', (evt) => {
|
|
32
|
+
this.onTransportClosed();
|
|
33
|
+
});
|
|
34
|
+
this.remote.addEventListener('pause', (evt) => {
|
|
35
|
+
this.local.pause();
|
|
36
|
+
});
|
|
37
|
+
this.remote.addEventListener('resume', (evt) => {
|
|
38
|
+
this.local.resume();
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
sendData(data) {
|
|
42
|
+
const canSendMore = this.local.send(new StreamMessageEvent(data));
|
|
43
|
+
return {
|
|
44
|
+
sentBytes: data.byteLength,
|
|
45
|
+
canSendMore
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
sendReset() {
|
|
49
|
+
this.local.send(new Event('reset'));
|
|
50
|
+
}
|
|
51
|
+
async sendClose(options) {
|
|
52
|
+
if (this.local.needsDrain) {
|
|
53
|
+
await pEvent(this.local, 'drain', {
|
|
54
|
+
signal: options?.signal
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
return raceSignal(new Promise((resolve, reject) => {
|
|
58
|
+
this.local.send(new Event('close'));
|
|
59
|
+
this.local.onIdle().then(resolve, reject);
|
|
60
|
+
}), options?.signal);
|
|
61
|
+
}
|
|
62
|
+
sendPause() {
|
|
63
|
+
this.local.send(new Event('pause'));
|
|
64
|
+
}
|
|
65
|
+
sendResume() {
|
|
66
|
+
this.local.send(new Event('resume'));
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
export function multiaddrConnectionPair(opts = {}) {
|
|
70
|
+
const inboundId = `${multiaddrConnectionId++}`;
|
|
71
|
+
const outboundId = `${multiaddrConnectionId++}`;
|
|
72
|
+
const outboundLog = defaultLogger().forComponent(`libp2p:mock-maconn:outbound:${inboundId}`);
|
|
73
|
+
const inboundLog = defaultLogger().forComponent(`libp2p:mock-maconn:inbound:${outboundId}`);
|
|
74
|
+
const targetA = new MessageQueue({
|
|
75
|
+
...opts,
|
|
76
|
+
log: outboundLog
|
|
77
|
+
});
|
|
78
|
+
const targetB = new MessageQueue({
|
|
79
|
+
...opts,
|
|
80
|
+
log: inboundLog
|
|
81
|
+
});
|
|
82
|
+
return [
|
|
83
|
+
new MockMultiaddrConnection({
|
|
84
|
+
...opts.outbound,
|
|
85
|
+
id: outboundId,
|
|
86
|
+
direction: 'outbound',
|
|
87
|
+
local: targetA,
|
|
88
|
+
remote: targetB,
|
|
89
|
+
remoteAddr: opts?.outbound?.remoteAddr ?? multiaddr(`/ip4/127.0.0.1/tcp/${outboundId}`),
|
|
90
|
+
log: outboundLog
|
|
91
|
+
}),
|
|
92
|
+
new MockMultiaddrConnection({
|
|
93
|
+
...opts.inbound,
|
|
94
|
+
id: inboundId,
|
|
95
|
+
direction: 'inbound',
|
|
96
|
+
local: targetB,
|
|
97
|
+
remote: targetA,
|
|
98
|
+
remoteAddr: opts?.inbound?.remoteAddr ?? multiaddr(`/ip4/127.0.0.1/tcp/${inboundId}`),
|
|
99
|
+
log: inboundLog
|
|
100
|
+
})
|
|
101
|
+
];
|
|
102
|
+
}
|
|
103
|
+
//# sourceMappingURL=multiaddr-connection-pair.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"multiaddr-connection-pair.js","sourceRoot":"","sources":["../../src/multiaddr-connection-pair.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAuBjD,IAAI,qBAAqB,GAAG,CAAC,CAAA;AAE7B,MAAM,uBAAwB,SAAQ,2BAA2B;IACvD,KAAK,CAA+C;IACpD,MAAM,CAAmD;IAEjE,YAAa,IAAiC;QAC5C,KAAK,CAAC,IAAI,CAAC,CAAA;QAEX,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QAEzB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YACxC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC3B,OAAM;YACR,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5C,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC3B,OAAM;YACR,CAAC;YAED,IAAI,CAAC,aAAa,EAAE,CAAA;QACtB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC1B,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5C,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;QACpB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;YAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAE,IAAoB;QAC5B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAA;QAEjE,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,WAAW;SACZ,CAAA;IACH,CAAC;IAED,SAAS;QACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,SAAS,CAAE,OAAsB;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YAC1B,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE;gBAChC,MAAM,EAAE,OAAO,EAAE,MAAM;aACxB,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,UAAU,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;YACnC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC3C,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IACtB,CAAC;IAED,SAAS;QACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;IACrC,CAAC;IAED,UAAU;QACR,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;IACtC,CAAC;CACF;AAOD,MAAM,UAAU,uBAAuB,CAAE,OAAuC,EAAE;IAChF,MAAM,SAAS,GAAG,GAAG,qBAAqB,EAAE,EAAE,CAAA;IAC9C,MAAM,UAAU,GAAG,GAAG,qBAAqB,EAAE,EAAE,CAAA;IAE/C,MAAM,WAAW,GAAG,aAAa,EAAE,CAAC,YAAY,CAAC,+BAA+B,SAAS,EAAE,CAAC,CAAA;IAC5F,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC,YAAY,CAAC,8BAA8B,UAAU,EAAE,CAAC,CAAA;IAE3F,MAAM,OAAO,GAAG,IAAI,YAAY,CAAkC;QAChE,GAAG,IAAI;QACP,GAAG,EAAE,WAAW;KACjB,CAAC,CAAA;IACF,MAAM,OAAO,GAAG,IAAI,YAAY,CAAkC;QAChE,GAAG,IAAI;QACP,GAAG,EAAE,UAAU;KAChB,CAAC,CAAA;IAEF,OAAO;QACL,IAAI,uBAAuB,CAAC;YAC1B,GAAG,IAAI,CAAC,QAAQ;YAChB,EAAE,EAAE,UAAU;YACd,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,IAAI,SAAS,CAAC,sBAAsB,UAAU,EAAE,CAAC;YACvF,GAAG,EAAE,WAAW;SACjB,CAAC;QACF,IAAI,uBAAuB,CAAC;YAC1B,GAAG,IAAI,CAAC,OAAO;YACf,EAAE,EAAE,SAAS;YACb,SAAS,EAAE,SAAS;YACpB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,IAAI,SAAS,CAAC,sBAAsB,SAAS,EAAE,CAAC;YACrF,GAAG,EAAE,UAAU;SAChB,CAAC;KACH,CAAA;AACH,CAAC"}
|
|
@@ -77,6 +77,8 @@ export interface QueueEvents<JobReturnType, JobOptions extends AbortOptions = Ab
|
|
|
77
77
|
completed: CustomEvent<JobReturnType>;
|
|
78
78
|
/**
|
|
79
79
|
* A job has failed
|
|
80
|
+
*
|
|
81
|
+
* @deprecated Listen for the 'failure' event instead - it gives more context and is generally more useful, this event will be removed in a future release
|
|
80
82
|
*/
|
|
81
83
|
error: CustomEvent<Error>;
|
|
82
84
|
/**
|
|
@@ -102,9 +104,12 @@ export declare class Queue<JobReturnType = unknown, JobOptions extends AbortOpti
|
|
|
102
104
|
queue: Array<Job<JobOptions, JobReturnType>>;
|
|
103
105
|
private pending;
|
|
104
106
|
private readonly sort?;
|
|
107
|
+
private paused;
|
|
105
108
|
constructor(init?: QueueInit<JobReturnType, JobOptions>);
|
|
106
109
|
emitEmpty(): void;
|
|
107
110
|
emitIdle(): void;
|
|
111
|
+
pause(): void;
|
|
112
|
+
resume(): void;
|
|
108
113
|
private tryToStartAnother;
|
|
109
114
|
private enqueue;
|
|
110
115
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/queue/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAI9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAC9B,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE9D,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAChD,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;CACzB;AAED,MAAM,WAAW,SAAS,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IACtF;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAA;CAClD;AAED,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAA;AAErE,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAAE,UAAU,GAAG,IAAI;IACzF,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACxC;AAED,MAAM,WAAW,UAAU,CAAC,UAAU,SAAS,YAAY,GAAG,YAAY;IACxE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAA;CACzC;AAED,MAAM,WAAW,eAAe,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IAC5F,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;IACnC,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,eAAe,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IAC5F,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;IACnC,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,WAAW,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IACxF;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,WAAW,CAAA;IAElB;;OAEG;IACH,GAAG,EAAE,WAAW,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;IAErC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/queue/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAI9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAC9B,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE9D,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAChD,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;CACzB;AAED,MAAM,WAAW,SAAS,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IACtF;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAA;CAClD;AAED,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAA;AAErE,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAAE,UAAU,GAAG,IAAI;IACzF,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACxC;AAED,MAAM,WAAW,UAAU,CAAC,UAAU,SAAS,YAAY,GAAG,YAAY;IACxE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAA;CACzC;AAED,MAAM,WAAW,eAAe,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IAC5F,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;IACnC,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,eAAe,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IAC5F,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;IACnC,KAAK,EAAE,KAAK,CAAA;CACb;AAED,MAAM,WAAW,WAAW,CAAC,aAAa,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY;IACxF;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,WAAW,CAAA;IAElB;;OAEG;IACH,GAAG,EAAE,WAAW,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,SAAS,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;IAErC;;;;OAIG;IACH,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAEzB;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAA;IAEhE;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAC,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAA;CACjE;AAED;;;;;GAKG;AACH,qBAAa,KAAK,CAAC,aAAa,GAAG,OAAO,EAAE,UAAU,SAAS,YAAY,GAAG,YAAY,CAAE,SAAQ,iBAAiB,CAAC,WAAW,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACpJ,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAA;IACnD,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAA4C;IAClE,OAAO,CAAC,MAAM,CAAS;gBAEV,IAAI,GAAE,SAAS,CAAC,aAAa,EAAE,UAAU,CAAM;IA2B5D,SAAS,IAAK,IAAI;IAQlB,QAAQ,IAAK,IAAI;IAQjB,KAAK,IAAK,IAAI;IAId,MAAM,IAAK,IAAI;IASf,OAAO,CAAC,iBAAiB;IAsDzB,OAAO,CAAC,OAAO;IAQf;;OAEG;IACG,GAAG,CAAE,EAAE,EAAE,WAAW,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAoCpG;;OAEG;IACH,KAAK,IAAK,IAAI;IAId;;OAEG;IACH,KAAK,IAAK,IAAI;IAQd;;;;OAIG;IACG,OAAO,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IASrD;;;;;;;;;;OAUG;IACG,cAAc,CAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAY3E;;;;;;;OAOG;IACG,MAAM,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IASpD;;OAEG;IACH,IAAI,IAAI,IAAK,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,MAAM,IAAK,MAAM,CAEpB;IAED;;OAEG;IACH,IAAI,OAAO,IAAK,MAAM,CAErB;IAED;;;;;;;;;OASG;IACK,WAAW,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC;CAuD3F"}
|
package/dist/src/queue/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AbortError } from '@libp2p/interface';
|
|
2
2
|
import { pushable } from 'it-pushable';
|
|
3
3
|
import { TypedEventEmitter } from 'main-event';
|
|
4
|
-
import {
|
|
4
|
+
import { pEvent } from 'p-event';
|
|
5
5
|
import { debounce } from '../debounce.js';
|
|
6
6
|
import { QueueFullError } from '../errors.js';
|
|
7
7
|
import { Job } from './job.js';
|
|
@@ -17,11 +17,13 @@ export class Queue extends TypedEventEmitter {
|
|
|
17
17
|
queue;
|
|
18
18
|
pending;
|
|
19
19
|
sort;
|
|
20
|
+
paused;
|
|
20
21
|
constructor(init = {}) {
|
|
21
22
|
super();
|
|
22
23
|
this.concurrency = init.concurrency ?? Number.POSITIVE_INFINITY;
|
|
23
24
|
this.maxSize = init.maxSize ?? Number.POSITIVE_INFINITY;
|
|
24
25
|
this.pending = 0;
|
|
26
|
+
this.paused = false;
|
|
25
27
|
if (init.metricName != null) {
|
|
26
28
|
init.metrics?.registerMetricGroup(init.metricName, {
|
|
27
29
|
calculate: () => {
|
|
@@ -50,7 +52,20 @@ export class Queue extends TypedEventEmitter {
|
|
|
50
52
|
}
|
|
51
53
|
this.safeDispatchEvent('idle');
|
|
52
54
|
}
|
|
55
|
+
pause() {
|
|
56
|
+
this.paused = true;
|
|
57
|
+
}
|
|
58
|
+
resume() {
|
|
59
|
+
if (!this.paused) {
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
this.paused = false;
|
|
63
|
+
this.tryToStartAnother();
|
|
64
|
+
}
|
|
53
65
|
tryToStartAnother() {
|
|
66
|
+
if (this.paused) {
|
|
67
|
+
return false;
|
|
68
|
+
}
|
|
54
69
|
if (this.size === 0) {
|
|
55
70
|
this.emitEmpty();
|
|
56
71
|
if (this.running === 0) {
|
|
@@ -122,7 +137,6 @@ export class Queue extends TypedEventEmitter {
|
|
|
122
137
|
}
|
|
123
138
|
}
|
|
124
139
|
}
|
|
125
|
-
this.safeDispatchEvent('error', { detail: err });
|
|
126
140
|
this.safeDispatchEvent('failure', { detail: { job, error: err } });
|
|
127
141
|
throw err;
|
|
128
142
|
});
|
|
@@ -152,7 +166,7 @@ export class Queue extends TypedEventEmitter {
|
|
|
152
166
|
if (this.size === 0) {
|
|
153
167
|
return;
|
|
154
168
|
}
|
|
155
|
-
await
|
|
169
|
+
await pEvent(this, 'empty', options);
|
|
156
170
|
}
|
|
157
171
|
/**
|
|
158
172
|
* @returns A promise that settles when the queue size is less than the given
|
|
@@ -170,7 +184,8 @@ export class Queue extends TypedEventEmitter {
|
|
|
170
184
|
if (this.size < limit) {
|
|
171
185
|
return;
|
|
172
186
|
}
|
|
173
|
-
await
|
|
187
|
+
await pEvent(this, 'next', {
|
|
188
|
+
...options,
|
|
174
189
|
filter: () => this.size < limit
|
|
175
190
|
});
|
|
176
191
|
}
|
|
@@ -187,7 +202,7 @@ export class Queue extends TypedEventEmitter {
|
|
|
187
202
|
if (this.pending === 0 && this.size === 0) {
|
|
188
203
|
return;
|
|
189
204
|
}
|
|
190
|
-
await
|
|
205
|
+
await pEvent(this, 'idle', options);
|
|
191
206
|
}
|
|
192
207
|
/**
|
|
193
208
|
* Size of the queue including running items
|
|
@@ -236,8 +251,8 @@ export class Queue extends TypedEventEmitter {
|
|
|
236
251
|
stream.push(evt.detail);
|
|
237
252
|
}
|
|
238
253
|
};
|
|
239
|
-
const
|
|
240
|
-
cleanup(evt.detail);
|
|
254
|
+
const onQueueFailure = (evt) => {
|
|
255
|
+
cleanup(evt.detail.error);
|
|
241
256
|
};
|
|
242
257
|
const onQueueIdle = () => {
|
|
243
258
|
cleanup();
|
|
@@ -248,7 +263,7 @@ export class Queue extends TypedEventEmitter {
|
|
|
248
263
|
};
|
|
249
264
|
// add listeners
|
|
250
265
|
this.addEventListener('completed', onQueueJobComplete);
|
|
251
|
-
this.addEventListener('
|
|
266
|
+
this.addEventListener('failure', onQueueFailure);
|
|
252
267
|
this.addEventListener('idle', onQueueIdle);
|
|
253
268
|
options?.signal?.addEventListener('abort', onSignalAbort);
|
|
254
269
|
try {
|
|
@@ -257,7 +272,7 @@ export class Queue extends TypedEventEmitter {
|
|
|
257
272
|
finally {
|
|
258
273
|
// remove listeners
|
|
259
274
|
this.removeEventListener('completed', onQueueJobComplete);
|
|
260
|
-
this.removeEventListener('
|
|
275
|
+
this.removeEventListener('failure', onQueueFailure);
|
|
261
276
|
this.removeEventListener('idle', onQueueIdle);
|
|
262
277
|
options?.signal?.removeEventListener('abort', onSignalAbort);
|
|
263
278
|
// empty the queue for when the user has broken out of a loop early
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/queue/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/queue/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAmH9B;;;;;GAKG;AACH,MAAM,OAAO,KAA+E,SAAQ,iBAAyD;IACpJ,WAAW,CAAQ;IACnB,OAAO,CAAQ;IACf,KAAK,CAAuC;IAC3C,OAAO,CAAQ;IACN,IAAI,CAA6C;IAC1D,MAAM,CAAS;IAEvB,YAAa,OAA6C,EAAE;QAC1D,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,iBAAiB,CAAA;QAC/D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,iBAAiB,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAEnB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE;gBACjD,SAAS,EAAE,GAAG,EAAE;oBACd,OAAO;wBACL,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;wBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;wBACrB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO;qBACzC,CAAA;gBACH,CAAC;aACF,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QAEf,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IACvD,CAAC;IAED,SAAS;QACP,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;IACjC,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YACvB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;IACpB,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,iBAAiB,EAAE,CAAA;IAC1B,CAAC;IAEO,iBAAiB;QACvB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,EAAE,CAAA;YAEhB,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,QAAQ,EAAE,CAAA;YACjB,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,GAA+C,CAAA;YAEnD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBAC1B,GAAG,GAAG,CAAC,CAAA;oBACP,MAAK;gBACP,CAAC;YACH,CAAC;YAED,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAA;YAEhC,IAAI,CAAC,OAAO,EAAE,CAAA;YAEd,KAAK,GAAG,CAAC,GAAG,EAAE;iBACX,OAAO,CAAC,GAAG,EAAE;gBACZ,gCAAgC;gBAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;wBAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;wBACvB,MAAK;oBACP,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,OAAO,EAAE,CAAA;gBACd,IAAI,CAAC,iBAAiB,EAAE,CAAA;gBACxB,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC,CAAC,CAAA;YAEJ,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,OAAO,CAAE,GAAmC;QAClD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEpB,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAE,EAA0C,EAAE,OAAoB;QACzE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,IAAI,cAAc,EAAE,CAAA;QAC5B,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAA4B,EAAE,EAAE,OAAO,CAAC,CAAA;QAC3D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAA;QAC7B,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAExB,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;aACrB,IAAI,CAAC,MAAM,CAAC,EAAE;YACb,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;YACvD,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;YAE9D,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,IAAI,GAAG,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC5B,oEAAoE;gBACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;wBAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;wBACvB,MAAK;oBACP,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;YAElE,MAAM,GAAG,CAAA;QACX,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACvB,GAAG,CAAC,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;QAC7B,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAE,OAAsB;QACnC,0CAA0C;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QAED,MAAM,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAAE,KAAa,EAAE,OAAsB;QACzD,2CAA2C;QAC3C,IAAI,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC;YACtB,OAAM;QACR,CAAC;QAED,MAAM,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE;YACzB,GAAG,OAAO;YACV,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK;SAChC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAE,OAAsB;QAClC,kEAAkE;QAClE,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC1C,OAAM;QACR,CAAC;QAED,MAAM,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,CAAE,WAAW,CAAE,OAAsB;QACzC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAgB;YACrC,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAQ,EAAE;YACpC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBAChB,IAAI,CAAC,KAAK,EAAE,CAAA;YACd,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,EAAE,CAAA;YACd,CAAC;YAED,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACjB,CAAC,CAAA;QAED,MAAM,kBAAkB,GAAG,CAAC,GAA+B,EAAQ,EAAE;YACnE,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACzB,CAAC;QACH,CAAC,CAAA;QAED,MAAM,cAAc,GAAG,CAAC,GAA4D,EAAQ,EAAE;YAC5F,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC,CAAA;QAED,MAAM,WAAW,GAAG,GAAS,EAAE;YAC7B,OAAO,EAAE,CAAA;QACX,CAAC,CAAA;QAED,oDAAoD;QACpD,MAAM,aAAa,GAAG,GAAS,EAAE;YAC/B,OAAO,CAAC,IAAI,UAAU,CAAC,eAAe,CAAC,CAAC,CAAA;QAC1C,CAAC,CAAA;QAED,gBAAgB;QAChB,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;QACtD,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAChD,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QAC1C,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;QAEzD,IAAI,CAAC;YACH,KAAM,CAAC,CAAC,MAAM,CAAA;QAChB,CAAC;gBAAS,CAAC;YACT,mBAAmB;YACnB,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;YACzD,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;YACnD,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YAC7C,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;YAE5D,mEAAmE;YACnE,OAAO,EAAE,CAAA;QACX,CAAC;IACH,CAAC;CACF"}
|
|
@@ -17,18 +17,6 @@ export interface RateLimiterInit {
|
|
|
17
17
|
* @default 0
|
|
18
18
|
*/
|
|
19
19
|
blockDuration?: number;
|
|
20
|
-
/**
|
|
21
|
-
* Execute allowed actions evenly over duration
|
|
22
|
-
*
|
|
23
|
-
* @default false
|
|
24
|
-
*/
|
|
25
|
-
execEvenly?: boolean;
|
|
26
|
-
/**
|
|
27
|
-
* ms, works with execEvenly=true option
|
|
28
|
-
*
|
|
29
|
-
* @default duration * 1000 / points
|
|
30
|
-
*/
|
|
31
|
-
execEvenlyMinDelayMs?: number;
|
|
32
20
|
/**
|
|
33
21
|
* @default "rlflx"
|
|
34
22
|
*/
|
|
@@ -53,11 +41,9 @@ export declare class RateLimiter {
|
|
|
53
41
|
protected points: number;
|
|
54
42
|
protected duration: number;
|
|
55
43
|
protected blockDuration: number;
|
|
56
|
-
protected execEvenly: boolean;
|
|
57
|
-
protected execEvenlyMinDelayMs: number;
|
|
58
44
|
protected keyPrefix: string;
|
|
59
45
|
constructor(opts?: RateLimiterInit);
|
|
60
|
-
consume(key: string, pointsToConsume?: number, options?: GetKeySecDurationOptions):
|
|
46
|
+
consume(key: string, pointsToConsume?: number, options?: GetKeySecDurationOptions): RateLimiterResult;
|
|
61
47
|
penalty(key: string, points?: number, options?: GetKeySecDurationOptions): RateLimiterResult;
|
|
62
48
|
reward(key: string, points?: number, options?: GetKeySecDurationOptions): RateLimiterResult;
|
|
63
49
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;CAC1C;AAED,qBAAa,WAAW;IACtB,SAAgB,aAAa,EAAE,aAAa,CAAA;IAC5C,SAAS,CAAC,MAAM,EAAE,MAAM,CAAA;IACxB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,aAAa,EAAE,MAAM,CAAA;IAC/B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;gBAEd,IAAI,GAAE,eAAoB;IAQvC,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,iBAAiB;IAmB7G,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,iBAAiB;IASpG,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,iBAAiB;IASnG;;;;;OAKG;IACH,KAAK,CAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IAc3D,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAE,MAAU,GAAG,iBAAiB;IAa7E,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAUhD,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,OAAO,CAAC,kBAAkB;IAQ1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAI5B,QAAQ,CAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGjC;AAED,qBAAa,aAAa;IACxB,SAAgB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;;IAMhD,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IA0B3E,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IAiCxE,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAgBhD,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAc9B"}
|
package/dist/src/rate-limiter.js
CHANGED
|
@@ -1,23 +1,18 @@
|
|
|
1
|
-
import delay from 'delay';
|
|
2
1
|
import { RateLimitError } from './errors.js';
|
|
3
2
|
export class RateLimiter {
|
|
4
3
|
memoryStorage;
|
|
5
4
|
points;
|
|
6
5
|
duration;
|
|
7
6
|
blockDuration;
|
|
8
|
-
execEvenly;
|
|
9
|
-
execEvenlyMinDelayMs;
|
|
10
7
|
keyPrefix;
|
|
11
8
|
constructor(opts = {}) {
|
|
12
9
|
this.points = opts.points ?? 4;
|
|
13
10
|
this.duration = opts.duration ?? 1;
|
|
14
11
|
this.blockDuration = opts.blockDuration ?? 0;
|
|
15
|
-
this.execEvenly = opts.execEvenly ?? false;
|
|
16
|
-
this.execEvenlyMinDelayMs = opts.execEvenlyMinDelayMs ?? (this.duration * 1000 / this.points);
|
|
17
12
|
this.keyPrefix = opts.keyPrefix ?? 'rlflx';
|
|
18
13
|
this.memoryStorage = new MemoryStorage();
|
|
19
14
|
}
|
|
20
|
-
|
|
15
|
+
consume(key, pointsToConsume = 1, options = {}) {
|
|
21
16
|
const rlKey = this.getKey(key);
|
|
22
17
|
const secDuration = this._getKeySecDuration(options);
|
|
23
18
|
let res = this.memoryStorage.incrby(rlKey, pointsToConsume, secDuration);
|
|
@@ -30,14 +25,6 @@ export class RateLimiter {
|
|
|
30
25
|
}
|
|
31
26
|
throw new RateLimitError('Rate limit exceeded', res);
|
|
32
27
|
}
|
|
33
|
-
else if (this.execEvenly && res.msBeforeNext > 0 && !res.isFirstInDuration) {
|
|
34
|
-
// Execute evenly
|
|
35
|
-
let delayMs = Math.ceil(res.msBeforeNext / (res.remainingPoints + 2));
|
|
36
|
-
if (delayMs < this.execEvenlyMinDelayMs) {
|
|
37
|
-
delayMs = res.consumedPoints * this.execEvenlyMinDelayMs;
|
|
38
|
-
}
|
|
39
|
-
await delay(delayMs);
|
|
40
|
-
}
|
|
41
28
|
return res;
|
|
42
29
|
}
|
|
43
30
|
penalty(key, points = 1, options = {}) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AA+C5C,MAAM,OAAO,WAAW;IACN,aAAa,CAAe;IAClC,MAAM,CAAQ;IACd,QAAQ,CAAQ;IAChB,aAAa,CAAQ;IACrB,SAAS,CAAQ;IAE3B,YAAa,OAAwB,EAAE;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,CAAA;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,EAAE,CAAA;IAC1C,CAAC;IAED,OAAO,CAAE,GAAW,EAAE,kBAA0B,CAAC,EAAE,UAAoC,EAAE;QACvF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,WAAW,CAAC,CAAA;QACxE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,IAAI,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACrC,uDAAuD;YACvD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;gBACpF,YAAY;gBACZ,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;YAC7E,CAAC;YAED,MAAM,IAAI,cAAc,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAA;QACtD,CAAC;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,OAAO,CAAE,GAAW,EAAE,SAAiB,CAAC,EAAE,UAAoC,EAAE;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAA;QACjE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,MAAM,CAAE,GAAW,EAAE,SAAiB,CAAC,EAAE,UAAoC,EAAE;QAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QAClE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAE,GAAW,EAAE,WAAmB;QACrC,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAA;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA;QAElC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,CAAA;QAEjE,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,KAAK;SACzB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,MAAc,EAAE,cAAsB,CAAC;QACvD,MAAM,UAAU,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAA;QAE1E,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAA;QAE7D,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,MAAM;YACtB,iBAAiB,EAAE,KAAK;SACzB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;QAEpD,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QACrE,CAAC;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,CAAC;IAEO,kBAAkB,CAAE,OAAkC;QAC5D,IAAI,OAAO,EAAE,cAAc,IAAI,IAAI,IAAI,OAAO,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;YACnE,OAAO,OAAO,CAAC,cAAc,CAAA;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IACrE,CAAC;IAED,QAAQ,CAAE,KAAa;QACrB,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;CACF;AAED,MAAM,OAAO,aAAa;IACR,OAAO,CAAyB;IAEhD;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,MAAM,CAAE,GAAW,EAAE,KAAa,EAAE,WAAmB;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,IAAI,IAAI;gBAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBACrD,CAAC,CAAC,CAAC,CAAC,CAAA;YAEN,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;gBACtD,eAAe;gBACf,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAA;gBAEvB,OAAO;oBACL,eAAe,EAAE,CAAC;oBAClB,YAAY,EAAE,eAAe;oBAC7B,cAAc,EAAE,QAAQ,CAAC,KAAK;oBAC9B,iBAAiB,EAAE,KAAK;iBACzB,CAAA;YACH,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;IAC1C,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,KAAa,EAAE,WAAmB;QAClD,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAA;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAClC,CAAC;QAED,MAAM,MAAM,GAAe;YACzB,KAAK;YACL,SAAS,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAC1E,CAAA;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QAE7B,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC1B,CAAC,EAAE,UAAU,CAAC,CAAA;YAEd,IAAK,MAAM,CAAC,SAAiB,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;gBAC3C,MAAM,CAAC,SAAiB,CAAC,KAAK,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;QAED,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,MAAM,CAAC,KAAK;YAC5B,iBAAiB,EAAE,IAAI;SACxB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,IAAI,IAAI;gBAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBACrD,CAAC,CAAC,CAAC,CAAC,CAAA;YACN,OAAO;gBACL,eAAe,EAAE,CAAC;gBAClB,YAAY,EAAE,eAAe;gBAC7B,cAAc,EAAE,QAAQ,CAAC,KAAK;gBAC9B,iBAAiB,EAAE,KAAK;aACzB,CAAA;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEpC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,IAAI,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;gBAC7B,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAExB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"socket-writer.browser.d.ts","sourceRoot":"","sources":["../../src/socket-writer.browser.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,IAAK,IAAI,CAEpC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"socket-writer.browser.js","sourceRoot":"","sources":["../../src/socket-writer.browser.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY;IAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;AAC5C,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import stream from 'node:stream';
|
|
2
|
+
import { Uint8ArrayList } from 'uint8arraylist';
|
|
3
|
+
export interface SocketWriter {
|
|
4
|
+
/**
|
|
5
|
+
* Write any available data into the socket, if the socket's internal write
|
|
6
|
+
* buffer has available capacity
|
|
7
|
+
*/
|
|
8
|
+
pull(): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Write data into the socket, returns false if the socket's internal write
|
|
11
|
+
* buffer is at capacity
|
|
12
|
+
*/
|
|
13
|
+
write(data: Uint8Array | Uint8Array[] | Uint8ArrayList): boolean;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @deprecated delete if unused
|
|
17
|
+
*/
|
|
18
|
+
export declare function socketWriter(socket: stream.Duplex): SocketWriter;
|
|
19
|
+
//# sourceMappingURL=socket-writer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"socket-writer.d.ts","sourceRoot":"","sources":["../../src/socket-writer.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,IAAK,OAAO,CAAA;IAEhB;;;OAGG;IACH,KAAK,CAAE,IAAI,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,cAAc,GAAG,OAAO,CAAA;CAClE;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAE,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,YAAY,CA2CjE"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import stream from 'node:stream';
|
|
2
|
+
import { Uint8ArrayList } from 'uint8arraylist';
|
|
3
|
+
/**
|
|
4
|
+
* @deprecated delete if unused
|
|
5
|
+
*/
|
|
6
|
+
export function socketWriter(socket) {
|
|
7
|
+
const queue = new Uint8ArrayList();
|
|
8
|
+
return {
|
|
9
|
+
pull() {
|
|
10
|
+
if (socket.writableNeedDrain) {
|
|
11
|
+
return false;
|
|
12
|
+
}
|
|
13
|
+
for (const buf of queue) {
|
|
14
|
+
queue.consume(buf.byteLength);
|
|
15
|
+
if (!socket.write(buf)) {
|
|
16
|
+
// continue writing after drain event. this is a synchronous operation
|
|
17
|
+
// so it will not interleave with the `this.writeToSocket()`
|
|
18
|
+
// invocation in this.sendData so all data will be sent in-order
|
|
19
|
+
if (queue.byteLength > 0) {
|
|
20
|
+
socket.once('drain', () => {
|
|
21
|
+
this.pull();
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
return false;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return true;
|
|
28
|
+
},
|
|
29
|
+
write(data) {
|
|
30
|
+
if (Array.isArray(data)) {
|
|
31
|
+
queue.appendAll(data);
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
queue.append(data);
|
|
35
|
+
}
|
|
36
|
+
if (socket.writableNeedDrain) {
|
|
37
|
+
return false;
|
|
38
|
+
}
|
|
39
|
+
return this.pull();
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=socket-writer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"socket-writer.js","sourceRoot":"","sources":["../../src/socket-writer.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAgB/C;;GAEG;AACH,MAAM,UAAU,YAAY,CAAE,MAAqB;IACjD,MAAM,KAAK,GAAG,IAAI,cAAc,EAAE,CAAA;IAElC,OAAO;QACL,IAAI;YACF,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAA;YACd,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;gBACxB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;gBAE7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvB,sEAAsE;oBACtE,4DAA4D;oBAC5D,gEAAgE;oBAChE,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;wBACzB,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;4BACxB,IAAI,CAAC,IAAI,EAAE,CAAA;wBACb,CAAC,CAAC,CAAA;oBACJ,CAAC;oBAED,OAAO,KAAK,CAAA;gBACd,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAA;QACb,CAAC;QAED,KAAK,CAAE,IAAgD;YACrD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACpB,CAAC;YAED,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAA;YACd,CAAC;YAED,OAAO,IAAI,CAAC,IAAI,EAAE,CAAA;QACpB,CAAC;KACF,CAAA;AACH,CAAC"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { MockMultiaddrConnectionInit } from './multiaddr-connection-pair.ts';
|
|
2
|
+
import type { Stream, StreamOptions } from '@libp2p/interface';
|
|
3
|
+
export interface StreamPairOptions {
|
|
4
|
+
/**
|
|
5
|
+
* How long to wait in ms before sending messages
|
|
6
|
+
*
|
|
7
|
+
* @default 1
|
|
8
|
+
*/
|
|
9
|
+
delay?: number;
|
|
10
|
+
/**
|
|
11
|
+
* If more than this many messages are sent within delay, write backpressure
|
|
12
|
+
* will be applied
|
|
13
|
+
*/
|
|
14
|
+
capacity?: number;
|
|
15
|
+
/**
|
|
16
|
+
* Simulate having pre-negotiated a protocol by passing it here
|
|
17
|
+
*/
|
|
18
|
+
protocol?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Configuration options for the outbound stream
|
|
21
|
+
*/
|
|
22
|
+
outbound?: StreamOptions;
|
|
23
|
+
/**
|
|
24
|
+
* Configuration options for underlying outbound connection
|
|
25
|
+
*/
|
|
26
|
+
outboundConnection?: Partial<MockMultiaddrConnectionInit>;
|
|
27
|
+
/**
|
|
28
|
+
* Configuration options for the inbound stream
|
|
29
|
+
*/
|
|
30
|
+
inbound?: StreamOptions;
|
|
31
|
+
/**
|
|
32
|
+
* Configuration options for underlying inbound connection
|
|
33
|
+
*/
|
|
34
|
+
inboundConnection?: Partial<MockMultiaddrConnectionInit>;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Returns two streams connected to each other with a slight delay in sending
|
|
38
|
+
* messages to simulate a network
|
|
39
|
+
*/
|
|
40
|
+
export declare function streamPair(opts?: StreamPairOptions): Promise<[Stream, Stream]>;
|
|
41
|
+
export declare function echoStream(opts?: StreamPairOptions): Promise<Stream>;
|
|
42
|
+
//# sourceMappingURL=stream-pair.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream-pair.d.ts","sourceRoot":"","sources":["../../src/stream-pair.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAE9D,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAA;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAA;IAEzD;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAA;IAEvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAA;CACzD;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAE,IAAI,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA+BzF;AAED,wBAAsB,UAAU,CAAE,IAAI,GAAE,iBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAK/E"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { pEvent } from 'p-event';
|
|
2
|
+
import { mockMuxer } from "./mock-muxer.js";
|
|
3
|
+
import { multiaddrConnectionPair } from "./multiaddr-connection-pair.js";
|
|
4
|
+
import { echo } from "./stream-utils.js";
|
|
5
|
+
/**
|
|
6
|
+
* Returns two streams connected to each other with a slight delay in sending
|
|
7
|
+
* messages to simulate a network
|
|
8
|
+
*/
|
|
9
|
+
export async function streamPair(opts = {}) {
|
|
10
|
+
const [outboundConnection, inboundConnection] = multiaddrConnectionPair({
|
|
11
|
+
...opts,
|
|
12
|
+
outbound: opts.outboundConnection,
|
|
13
|
+
inbound: opts.inboundConnection
|
|
14
|
+
});
|
|
15
|
+
const localMuxer = mockMuxer({
|
|
16
|
+
streamOptions: opts.outbound
|
|
17
|
+
}).createStreamMuxer(outboundConnection);
|
|
18
|
+
const remoteMuxer = mockMuxer({
|
|
19
|
+
streamOptions: opts.inbound
|
|
20
|
+
}).createStreamMuxer(inboundConnection);
|
|
21
|
+
const [inboundStream, outboundStream] = await Promise.all([
|
|
22
|
+
pEvent(remoteMuxer, 'stream').then(evt => {
|
|
23
|
+
return evt.detail;
|
|
24
|
+
}),
|
|
25
|
+
localMuxer.createStream({
|
|
26
|
+
...opts.outbound,
|
|
27
|
+
protocol: opts.protocol
|
|
28
|
+
})
|
|
29
|
+
]);
|
|
30
|
+
return [
|
|
31
|
+
outboundStream,
|
|
32
|
+
inboundStream
|
|
33
|
+
];
|
|
34
|
+
}
|
|
35
|
+
export async function echoStream(opts = {}) {
|
|
36
|
+
const [outbound, inbound] = await streamPair(opts);
|
|
37
|
+
echo(inbound);
|
|
38
|
+
return outbound;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=stream-pair.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"stream-pair.js","sourceRoot":"","sources":["../../src/stream-pair.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AA4CxC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAE,OAA0B,EAAE;IAC5D,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,GAAG,uBAAuB,CAAC;QACtE,GAAG,IAAI;QACP,QAAQ,EAAE,IAAI,CAAC,kBAAkB;QACjC,OAAO,EAAE,IAAI,CAAC,iBAAiB;KAChC,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,SAAS,CAAC;QAC3B,aAAa,EAAE,IAAI,CAAC,QAAQ;KAC7B,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAA;IACxC,MAAM,WAAW,GAAG,SAAS,CAAC;QAC5B,aAAa,EAAE,IAAI,CAAC,OAAO;KAC5B,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;IAEvC,MAAM,CACJ,aAAa,EACb,cAAc,CACf,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpB,MAAM,CAAgC,WAAW,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACtE,OAAO,GAAG,CAAC,MAAM,CAAA;QACnB,CAAC,CAAC;QACF,UAAU,CAAC,YAAY,CAAC;YACtB,GAAG,IAAI,CAAC,QAAQ;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;KACH,CAAC,CAAA;IAEF,OAAO;QACL,cAAc;QACd,aAAa;KACd,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAE,OAA0B,EAAE;IAC5D,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IAClD,IAAI,CAAC,OAAO,CAAC,CAAA;IAEb,OAAO,QAAQ,CAAA;AACjB,CAAC"}
|