mirror of https://github.com/status-im/js-waku.git
chore: add iterator timeout and unblock main thread (#1357)
* add iterator timeout * add idle state to generator * add js-doc and iterator option
This commit is contained in:
parent
bc2615e0ad
commit
ef87af6e7a
|
@ -48,7 +48,12 @@ describe("Util: toAsyncIterator", () => {
|
|||
const messageText = "hey, what's up?";
|
||||
const sent = { payload: utf8ToBytes(messageText) };
|
||||
|
||||
const { iterator } = await toAsyncIterator(waku.filter, TestDecoder);
|
||||
const { iterator } = await toAsyncIterator(
|
||||
waku.filter,
|
||||
TestDecoder,
|
||||
{},
|
||||
{ timeoutMs: 1000 }
|
||||
);
|
||||
|
||||
await waku.lightPush.send(TestEncoder, sent);
|
||||
const { value } = await iterator.next();
|
||||
|
@ -60,7 +65,12 @@ describe("Util: toAsyncIterator", () => {
|
|||
|
||||
it("handles multiple messages", async function () {
|
||||
this.timeout(10000);
|
||||
const { iterator } = await toAsyncIterator(waku.filter, TestDecoder);
|
||||
const { iterator } = await toAsyncIterator(
|
||||
waku.filter,
|
||||
TestDecoder,
|
||||
{},
|
||||
{ timeoutMs: 1000 }
|
||||
);
|
||||
|
||||
await waku.lightPush.send(TestEncoder, {
|
||||
payload: utf8ToBytes("Filtering works!"),
|
||||
|
@ -78,7 +88,12 @@ describe("Util: toAsyncIterator", () => {
|
|||
|
||||
it("unsubscribes", async function () {
|
||||
this.timeout(10000);
|
||||
const { iterator, stop } = await toAsyncIterator(waku.filter, TestDecoder);
|
||||
const { iterator, stop } = await toAsyncIterator(
|
||||
waku.filter,
|
||||
TestDecoder,
|
||||
{},
|
||||
{ timeoutMs: 1000 }
|
||||
);
|
||||
|
||||
await waku.lightPush.send(TestEncoder, {
|
||||
payload: utf8ToBytes("This should be received"),
|
||||
|
|
|
@ -7,11 +7,29 @@ import type {
|
|||
Unsubscribe,
|
||||
} from "@waku/interfaces";
|
||||
|
||||
type IteratorOptions = {
|
||||
timeoutMs?: number;
|
||||
iteratorDelay?: number;
|
||||
};
|
||||
|
||||
const FRAME_RATE = 60;
|
||||
|
||||
/**
|
||||
* Function that transforms IReceiver subscription to iterable stream of data.
|
||||
* @param receiver - object that allows to be subscribed to;
|
||||
* @param decoder - parameter to be passed to receiver for subscription;
|
||||
* @param options - options for receiver for subscription;
|
||||
* @param iteratorOptions - optional configuration for iterator;
|
||||
* @returns iterator and stop function to terminate it.
|
||||
*/
|
||||
export async function toAsyncIterator<T extends IDecodedMessage>(
|
||||
receiver: IReceiver,
|
||||
decoder: IDecoder<T> | IDecoder<T>[],
|
||||
options?: ProtocolOptions
|
||||
options?: ProtocolOptions,
|
||||
iteratorOptions?: IteratorOptions
|
||||
): Promise<IAsyncIterator<T>> {
|
||||
const iteratorDelay = iteratorOptions?.iteratorDelay ?? FRAME_RATE;
|
||||
|
||||
const messages: T[] = [];
|
||||
|
||||
let unsubscribe: undefined | Unsubscribe;
|
||||
|
@ -23,8 +41,18 @@ export async function toAsyncIterator<T extends IDecodedMessage>(
|
|||
options
|
||||
);
|
||||
|
||||
const isWithTimeout = Number.isInteger(iteratorOptions?.timeoutMs);
|
||||
const timeoutMs = iteratorOptions?.timeoutMs ?? 0;
|
||||
const startTime = Date.now();
|
||||
|
||||
async function* iterator(): AsyncIterator<T> {
|
||||
while (true) {
|
||||
if (isWithTimeout && Date.now() - startTime >= timeoutMs) {
|
||||
return;
|
||||
}
|
||||
|
||||
await wait(iteratorDelay);
|
||||
|
||||
const message = messages.shift() as T;
|
||||
|
||||
if (!unsubscribe && messages.length === 0) {
|
||||
|
@ -49,3 +77,9 @@ export async function toAsyncIterator<T extends IDecodedMessage>(
|
|||
},
|
||||
};
|
||||
}
|
||||
|
||||
function wait(ms: number): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
setTimeout(resolve, ms);
|
||||
});
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue