12997997443

Committed 27 Jan 2025 08:45PM UTC coverage: 82.568% (-0.1%) from 82.694%

Build # 12997997443

Build Type

push

github

Committed by

web-flow

Commit Message

more consistent pending count for messages in an iterator that doesn't include any pushed functions or the current message being processed by the iterator. (#194)

Signed-off-by: Alberto Ricart <alberto@synadia.com>

Coverage Stats

2156 of 2957 branches covered (72.91%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

9193 of 10788 relevant lines covered (85.22%)

823797.52 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.4

/core/src/queued_iterator.ts

/*
 * Copyright 2020-2022 The NATS Authors
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { Deferred } from "./util.ts";
import { deferred } from "./util.ts";
import type { QueuedIterator } from "./core.ts";
import type { CallbackFn, Dispatcher } from "./core.ts";
import { InvalidOperationError } from "./errors.ts";

export class QueuedIteratorImpl<T> implements QueuedIterator<T>, Dispatcher<T> {
  inflight: number;
  processed: number;
  // this is updated by the protocol
  received: number;
  noIterator: boolean;
  iterClosed: Deferred<void | Error>;
  done: boolean;
  signal: Deferred<void>;
  yields: (T | CallbackFn)[];
  filtered: number;
  pendingFiltered: number;
  ctx?: unknown;
  _data?: unknown; //data is for use by extenders in any way they like
  err?: Error;
  time: number;
  profile: boolean;
  yielding: boolean;
  didBreak: boolean;

  constructor() {
    this.inflight = 0;
    this.filtered = 0;
    this.pendingFiltered = 0;
    this.processed = 0;
    this.received = 0;
    this.noIterator = false;
    this.done = false;
    this.signal = deferred<void>();
    this.yields = [];
    this.iterClosed = deferred<void | Error>();
    this.time = 0;
    this.yielding = false;
    this.didBreak = false;
    this.profile = false;
  }

  [Symbol.asyncIterator](): AsyncIterator<T> {
    return this.iterate();
  }

  push(v: T | CallbackFn): void {
    if (this.done) {
      return;
    }
    // if they `break` from a `for await`, any signaling that is pushed via
    // a function is not handled this can prevent closed promises from
    // resolving downstream.
    if (this.didBreak) {
      if (typeof v === "function") {
        const cb = v as CallbackFn;
        try {
          cb();
        } catch (_) {
          // ignored
        }
      }
      return;
    }
    if (typeof v === "function") {
      this.pendingFiltered++;
    }
    this.yields.push(v);
    this.signal.resolve();
  }

  async *iterate(): AsyncIterableIterator<T> {
    if (this.noIterator) {
      throw new InvalidOperationError(
        "iterator cannot be used when a callback is registered",
      );
    }
    if (this.yielding) {
      throw new InvalidOperationError("iterator is already yielding");
    }
    this.yielding = true;
    try {
      while (true) {
        if (this.yields.length === 0) {
          await this.signal;
        }
        if (this.err) {
          throw this.err;
        }
        const yields = this.yields;
        this.inflight = yields.length;
        this.yields = [];
        for (let i = 0; i < yields.length; i++) {
          if (typeof yields[i] === "function") {
            this.pendingFiltered--;
            const fn = yields[i] as CallbackFn;
            try {
              fn();
            } catch (err) {
              // failed on the invocation - fail the iterator
              // so they know to fix the callback
              throw err;
            }
            // fn could have also set an error
            if (this.err) {
              throw this.err;
            }
            continue;
          }

          this.processed++;
          this.inflight--;
          const start = this.profile ? Date.now() : 0;
          yield yields[i] as T;
          this.time = this.profile ? Date.now() - start : 0;
        }
        // yielding could have paused and microtask
        // could have added messages. Prevent allocations
        // if possible
        if (this.done) {
          break;
        } else if (this.yields.length === 0) {
          yields.length = 0;
          this.yields = yields;
          this.signal = deferred();
        }
      }
    } finally {
      // the iterator used break/return
      this.didBreak = true;
      this.stop();
    }
  }

  stop(err?: Error): void {
    if (this.done) {
      return;
    }
    this.err = err;
    this.done = true;
    this.signal.resolve();
    this.iterClosed.resolve(err);
  }

  getProcessed(): number {
    return this.noIterator ? this.received : this.processed;
  }

  getPending(): number {
    return this.yields.length + this.inflight - this.pendingFiltered;
  }

  getReceived(): number {
    return this.received - this.filtered;
  }
}

1	/*
2	* Copyright 2020-2022 The NATS Authors
3	* Licensed under the Apache License, Version 2.0 (the "License");
4	* you may not use this file except in compliance with the License.
5	* You may obtain a copy of the License at
6	*
7	* http://www.apache.org/licenses/LICENSE-2.0
8	*
9	* Unless required by applicable law or agreed to in writing, software
10	* distributed under the License is distributed on an "AS IS" BASIS,
11	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	* See the License for the specific language governing permissions and
13	* limitations under the License.
14	*/
15	import type { Deferred } from "./util.ts";
16	import { deferred } from "./util.ts";	55✔
17	import type { QueuedIterator } from "./core.ts";
18	import type { CallbackFn, Dispatcher } from "./core.ts";
19	import { InvalidOperationError } from "./errors.ts";	55✔
20
21	export class QueuedIteratorImpl<T> implements QueuedIterator<T>, Dispatcher<T> {	55✔
22	inflight: number;	54✔
23	processed: number;	2,264✔
24	// this is updated by the protocol
25	received: number;	2,264✔
26	noIterator: boolean;	2,264✔
27	iterClosed: Deferred<void \| Error>;	2,264✔
28	done: boolean;	2,264✔
29	signal: Deferred<void>;	2,264✔
30	yields: (T \| CallbackFn)[];	2,264✔
31	filtered: number;	2,264✔
32	pendingFiltered: number;	2,264✔
33	ctx?: unknown;	2,264✔
34	_data?: unknown; //data is for use by extenders in any way they like	2,264✔
35	err?: Error;	2,264✔
36	time: number;	2,264✔
37	profile: boolean;	2,264✔
38	yielding: boolean;	2,264✔
39	didBreak: boolean;	54✔
40
41	constructor() {	54✔
42	this.inflight = 0;	2,264✔
43	this.filtered = 0;	2,264✔
44	this.pendingFiltered = 0;	2,264✔
45	this.processed = 0;	2,264✔
46	this.received = 0;	2,264✔
47	this.noIterator = false;	2,264✔
48	this.done = false;	2,264✔
49	this.signal = deferred<void>();	2,264✔
50	this.yields = [];	2,264✔
51	this.iterClosed = deferred<void \| Error>();	2,264✔
52	this.time = 0;	2,264✔
53	this.yielding = false;	2,264✔
54	this.didBreak = false;	2,264✔
55	this.profile = false;	2,264✔
56	}	2,264✔
57
58	[Symbol.asyncIterator](): AsyncIterator<T> {	109✔
59	return this.iterate();	882✔
60	}	882✔
61
62	push(v: T \| CallbackFn): void {	54✔
63	if (this.done) {	264,434✔
64	return;	264,734✔
65	}	264,734✔
66	// if they `break` from a `for await`, any signaling that is pushed via
67	// a function is not handled this can prevent closed promises from
68	// resolving downstream.
69	if (this.didBreak) {	7,071✔
70	if (typeof v === "function") {	7,246✔
71	const cb = v as CallbackFn;	7,246✔
72	try {	7,246✔
73	cb();	7,246✔
74	} catch (_) {	×
75	// ignored
76	}	×
77	}	7,246✔
78	return;	7,246✔
79	}	7,246✔
80	if (typeof v === "function") {	264,434✔
81	this.pendingFiltered++;	266,309✔
82	}	266,309✔
83	this.yields.push(v);	528,339✔
84	this.signal.resolve();	528,339✔
85	}	264,434✔
86
87	async *iterate(): AsyncIterableIterator<T> {	54✔
88	if (this.noIterator) {	690✔
89	throw new InvalidOperationError(	693✔
90	"iterator cannot be used when a callback is registered",	693✔
91	);
92	}	693✔
93	if (this.yielding) {	169!
94	throw new InvalidOperationError("iterator is already yielding");	170✔
95	}	170✔
96	this.yielding = true;	1,517✔
97	try {	1,517✔
98	while (true) {	882✔
99	if (this.yields.length === 0) {	3,328✔
100	await this.signal;	5,441✔
101	}	6,776✔
102	if (this.err) {	885!
103	throw this.err;	892✔
104	}	892✔
105	const yields = this.yields;	5,476✔
106	this.inflight = yields.length;	5,476✔
107	this.yields = [];	5,476✔
108	for (let i = 0; i < yields.length; i++) {	3,328✔
109	if (typeof yields[i] === "function") {	266,384✔
110	this.pendingFiltered--;	267,625✔
111	const fn = yields[i] as CallbackFn;	267,625✔
112	try {	267,625✔
113	fn();	267,625✔
114	} catch (err) {	266,496!
115	// failed on the invocation - fail the iterator
116	// so they know to fix the callback
117	throw err;	266,502✔
118	}	266,502✔
119	// fn could have also set an error
120	if (this.err) {	266,731!
121	throw this.err;	266,756✔
122	}	266,756✔
123	continue;	268,797✔
124	}	268,797✔
125
126	this.processed++;	784,939✔
127	this.inflight--;	784,939✔
UNCOV 128	const start = this.profile ? Date.now() : 0;	182!
129	yield yields[i] as T;	266,384✔
130	this.time = this.profile ? Date.now() - start : 0;	182!
131	}	266,384✔
132	// yielding could have paused and microtask
133	// could have added messages. Prevent allocations
134	// if possible
135	if (this.done) {	4,827✔
136	break;	7,398✔
137	} else if (this.yields.length === 0) {	6,824✔
138	yields.length = 0;	9,955✔
139	this.yields = yields;	9,955✔
140	this.signal = deferred();	9,955✔
141	}	9,955✔
142	}	3,328✔
143	} finally {	882✔
144	// the iterator used break/return
145	this.didBreak = true;	1,679✔
146	this.stop();	1,679✔
147	}	1,679✔
148	}	882✔
149
150	stop(err?: Error): void {	54✔
151	if (this.done) {	2,324✔
152	return;	3,242✔
153	}	3,242✔
154	this.err = err;	4,346✔
155	this.done = true;	4,346✔
156	this.signal.resolve();	4,346✔
157	this.iterClosed.resolve(err);	4,346✔
158	}	2,324✔
159
160	getProcessed(): number {	52✔
161	return this.noIterator ? this.received : this.processed;	111✔
162	}	118✔
163
164	getPending(): number {	51✔
165	return this.yields.length + this.inflight - this.pendingFiltered;	206✔
166	}	206✔
167
168	getReceived(): number {	52✔
169	return this.received - this.filtered;	203✔
170	}	203✔
171	}	55✔

nats-io / nats.js / 12997997443

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous