All files / lib/internal/streams operators.js

97.36% Statements 407/418
96.96% Branches 160/165
95.83% Functions 23/24
97.36% Lines 407/418

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 41922x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 102x 102x 2x 2x 2x 102x 4x 4x 102x 28x 28x 102x 102x 102x 11x 11x 102x 102x 102x 102x 89x 89x 89x 89x 89x 89x 89x 89x 2x 2x 86x 89x 89x 89x 89x 89x 89x 89x 20x 20x 89x 89x 86x 86x 477x 9x 9x 477x 477x 13x 13x 477x 477x 477x 477x 1x 1x 477x 477x     477x 477x 380x 380x 455x 455x 476x 450x 450x 450x 461x 477x 450x 450x 450x 450x 477x 61x 86x 16x 16x 16x 86x 86x 86x 73x 73x 73x 86x 86x 86x 89x 89x 89x 89x 89x 609x 527x 527x 527x 59x 59x 527x 527x 2x 2x 527x 527x 425x 425x 441x 441x 464x 439x 439x 439x 527x 609x 609x 523x 609x 609x 89x 86x 86x 86x 86x 11x 11x 11x 86x 102x 102x 22x 10x 10x 1x 1x 10x 3x 3x 10x 10x 8x 8x 15x 2x 2x 15x 11x 10x 10x 22x 23x 23x 1x 1x 23x 3x 3x 23x 23x 23x 23x 23x 2x 1x 1x 2x 2x 2x 2x 2x 21x 23x 59x 9x 9x 9x 59x 23x 23x 22x 12x 12x 1x 1x 1x 12x 12x 21x 12x 12x 22x 8x 8x 1x 1x 1x 7x 16x 16x 16x 7x 8x 8x 22x 11x 11x 1x 1x 1x 10x 25x 15x 15x 25x 25x 10x 11x 22x 22x 22x 22x 22x       22x 22x 25x 25x 2x 2x 2x 25x 1x 1x 25x 4x 4x 21x 21x 25x 2x 2x 2x     19x 19x 25x 1x 1x 1x 25x 25x 25x 242x 242x 1x 1x 242x 1x 1x 242x 240x 239x 242x 25x     25x 19x 19x 25x 25x 22x 58x 58x 1x 1x 58x 2x 2x 58x 58x 58x 325x 1x 1x 324x 324x 58x 58x 22x 14x 14x 14x 10x 35x 35x 14x 14x 22x 34x 34x 34x 34x 34x 1x 1x 34x 3x 3x 30x 34x 22x 13x 13x 1x 1x 13x 2x 2x 13x 13x 13x 11x     11x 43x 1x 1x 43x 25x 25x 43x 13x 13x 22x 25x 25x 1x 1x 25x 3x 3x 23x 23x 23x 20x 1x 1x 20x 42x 1x 1x 42x 26x 42x 15x 15x 42x 23x 25x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x  
'use strict';
 
const { AbortController } = require('internal/abort_controller');
 
const {
  codes: {
    ERR_INVALID_ARG_TYPE,
    ERR_MISSING_ARGS,
    ERR_OUT_OF_RANGE,
  },
  AbortError,
} = require('internal/errors');
const {
  validateAbortSignal,
  validateInteger,
} = require('internal/validators');
const { kWeakHandler } = require('internal/event_target');
const { finished } = require('internal/streams/end-of-stream');
 
const {
  ArrayPrototypePush,
  MathFloor,
  Number,
  NumberIsNaN,
  Promise,
  PromiseReject,
  PromisePrototypeCatch,
  Symbol,
} = primordials;
 
const kEmpty = Symbol('kEmpty');
const kEof = Symbol('kEof');
 
function map(fn, options) {
  if (typeof fn !== 'function') {
    throw new ERR_INVALID_ARG_TYPE(
      'fn', ['Function', 'AsyncFunction'], fn);
  }
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  let concurrency = 1;
  if (options?.concurrency != null) {
    concurrency = MathFloor(options.concurrency);
  }
 
  validateInteger(concurrency, 'concurrency', 1);
 
  return async function* map() {
    const ac = new AbortController();
    const stream = this;
    const queue = [];
    const signal = ac.signal;
    const signalOpt = { signal };
 
    const abort = () => ac.abort();
    if (options?.signal?.aborted) {
      abort();
    }
 
    options?.signal?.addEventListener('abort', abort);
 
    let next;
    let resume;
    let done = false;
 
    function onDone() {
      done = true;
    }
 
    async function pump() {
      try {
        for await (let val of stream) {
          if (done) {
            return;
          }
 
          if (signal.aborted) {
            throw new AbortError();
          }
 
          try {
            val = fn(val, signalOpt);
          } catch (err) {
            val = PromiseReject(err);
          }
 
          if (val === kEmpty) {
            continue;
          }
 
          if (typeof val?.catch === 'function') {
            val.catch(onDone);
          }
 
          queue.push(val);
          if (next) {
            next();
            next = null;
          }
 
          if (!done && queue.length && queue.length >= concurrency) {
            await new Promise((resolve) => {
              resume = resolve;
            });
          }
        }
        queue.push(kEof);
      } catch (err) {
        const val = PromiseReject(err);
        PromisePrototypeCatch(val, onDone);
        queue.push(val);
      } finally {
        done = true;
        if (next) {
          next();
          next = null;
        }
        options?.signal?.removeEventListener('abort', abort);
      }
    }
 
    pump();
 
    try {
      while (true) {
        while (queue.length > 0) {
          const val = await queue[0];
 
          if (val === kEof) {
            return;
          }
 
          if (signal.aborted) {
            throw new AbortError();
          }
 
          if (val !== kEmpty) {
            yield val;
          }
 
          queue.shift();
          if (resume) {
            resume();
            resume = null;
          }
        }
 
        await new Promise((resolve) => {
          next = resolve;
        });
      }
    } finally {
      ac.abort();
 
      done = true;
      if (resume) {
        resume();
        resume = null;
      }
    }
  }.call(this);
}
 
function asIndexedPairs(options) {
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  return async function* asIndexedPairs() {
    let index = 0;
    for await (const val of this) {
      if (options?.signal?.aborted) {
        throw new AbortError({ cause: options.signal.reason });
      }
      yield [index++, val];
    }
  }.call(this);
}
 
async function some(fn, options) {
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  // https://tc39.es/proposal-iterator-helpers/#sec-iteratorprototype.some
  // Note that some does short circuit but also closes the iterator if it does
  const ac = new AbortController();
  if (options?.signal) {
    if (options.signal.aborted) {
      ac.abort();
    }
    options.signal.addEventListener('abort', () => ac.abort(), {
      [kWeakHandler]: this,
      once: true,
    });
  }
  const mapped = this.map(fn, { ...options, signal: ac.signal });
  for await (const result of mapped) {
    if (result) {
      ac.abort();
      return true;
    }
  }
  return false;
}
 
async function every(fn, options) {
  if (typeof fn !== 'function') {
    throw new ERR_INVALID_ARG_TYPE(
      'fn', ['Function', 'AsyncFunction'], fn);
  }
  // https://en.wikipedia.org/wiki/De_Morgan%27s_laws
  return !(await some.call(this, async (...args) => {
    return !(await fn(...args));
  }, options));
}
 
async function forEach(fn, options) {
  if (typeof fn !== 'function') {
    throw new ERR_INVALID_ARG_TYPE(
      'fn', ['Function', 'AsyncFunction'], fn);
  }
  async function forEachFn(value, options) {
    await fn(value, options);
    return kEmpty;
  }
  // eslint-disable-next-line no-unused-vars
  for await (const unused of this.map(forEachFn, options));
}
 
function filter(fn, options) {
  if (typeof fn !== 'function') {
    throw new ERR_INVALID_ARG_TYPE(
      'fn', ['Function', 'AsyncFunction'], fn);
  }
  async function filterFn(value, options) {
    if (await fn(value, options)) {
      return value;
    }
    return kEmpty;
  }
  return this.map(filterFn, options);
}
 
// Specific to provide better error to reduce since the argument is only
// missing if the stream has no items in it - but the code is still appropriate
class ReduceAwareErrMissingArgs extends ERR_MISSING_ARGS {
  constructor() {
    super('reduce');
    this.message = 'Reduce of an empty stream requires an initial value';
  }
}
 
async function reduce(reducer, initialValue, options) {
  if (typeof reducer !== 'function') {
    throw new ERR_INVALID_ARG_TYPE(
      'reducer', ['Function', 'AsyncFunction'], reducer);
  }
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  let hasInitialValue = arguments.length > 1;
  if (options?.signal?.aborted) {
    const err = new AbortError(undefined, { cause: options.signal.reason });
    this.once('error', () => {}); // The error is already propagated
    await finished(this.destroy(err));
    throw err;
  }
  const ac = new AbortController();
  const signal = ac.signal;
  if (options?.signal) {
    const opts = { once: true, [kWeakHandler]: this };
    options.signal.addEventListener('abort', () => ac.abort(), opts);
  }
  let gotAnyItemFromStream = false;
  try {
    for await (const value of this) {
      gotAnyItemFromStream = true;
      if (options?.signal?.aborted) {
        throw new AbortError();
      }
      if (!hasInitialValue) {
        initialValue = value;
        hasInitialValue = true;
      } else {
        initialValue = await reducer(initialValue, value, { signal });
      }
    }
    if (!gotAnyItemFromStream && !hasInitialValue) {
      throw new ReduceAwareErrMissingArgs();
    }
  } finally {
    ac.abort();
  }
  return initialValue;
}
 
async function toArray(options) {
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  const result = [];
  for await (const val of this) {
    if (options?.signal?.aborted) {
      throw new AbortError(undefined, { cause: options.signal.reason });
    }
    ArrayPrototypePush(result, val);
  }
  return result;
}
 
function flatMap(fn, options) {
  const values = this.map(fn, options);
  return async function* flatMap() {
    for await (const val of values) {
      yield* val;
    }
  }.call(this);
}
 
function toIntegerOrInfinity(number) {
  // We coerce here to align with the spec
  // https://github.com/tc39/proposal-iterator-helpers/issues/169
  number = Number(number);
  if (NumberIsNaN(number)) {
    return 0;
  }
  if (number < 0) {
    throw new ERR_OUT_OF_RANGE('number', '>= 0', number);
  }
  return number;
}
 
function drop(number, options) {
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  number = toIntegerOrInfinity(number);
  return async function* drop() {
    if (options?.signal?.aborted) {
      throw new AbortError();
    }
    for await (const val of this) {
      if (options?.signal?.aborted) {
        throw new AbortError();
      }
      if (number-- <= 0) {
        yield val;
      }
    }
  }.call(this);
}
 
function take(number, options) {
  if (options != null && typeof options !== 'object') {
    throw new ERR_INVALID_ARG_TYPE('options', ['Object']);
  }
  if (options?.signal != null) {
    validateAbortSignal(options.signal, 'options.signal');
  }
 
  number = toIntegerOrInfinity(number);
  return async function* take() {
    if (options?.signal?.aborted) {
      throw new AbortError();
    }
    for await (const val of this) {
      if (options?.signal?.aborted) {
        throw new AbortError();
      }
      if (number-- > 0) {
        yield val;
      } else {
        return;
      }
    }
  }.call(this);
}
 
module.exports.streamReturningOperators = {
  asIndexedPairs,
  drop,
  filter,
  flatMap,
  map,
  take,
};
 
module.exports.promiseReturningOperators = {
  every,
  forEach,
  reduce,
  toArray,
  some,
};