All files / lib/internal/streams operators.js

98.67% Statements 297/301
97.19% Branches 104/107
100% Functions 18/18
98.67% Lines 297/301

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 30219x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 88x 88x 2x 2x 2x 88x 88x 4x 4x 81x 81x 88x 11x 11x 88x 88x 88x 88x 88x 88x 88x 88x 88x 88x 88x 2x 2x 88x 88x 88x 88x 88x 88x 88x 88x 20x 20x 88x 88x 76x 76x 356x 8x 8x 356x 356x 13x 13x 356x 356x 356x 356x 1x 1x 335x 356x     356x 356x 263x 263x 353x 353x 355x 330x 330x 330x 335x 356x 330x 330x 330x 330x 356x 52x 76x 16x 16x 16x 76x 76x 76x 64x 64x 64x 76x 76x 76x 88x 88x 88x 88x 88x 470x 398x 398x 398x 50x 50x 398x 398x 2x 2x 327x 340x 305x 305x 322x 322x 345x 320x 320x 320x 398x 470x 470x 394x 470x 470x 88x 76x 76x 76x 76x 10x 10x 10x 76x 88x 19x 21x 21x 21x 21x 21x 2x 1x 1x 2x 2x 2x 2x 2x 21x 21x 59x 9x 9x 9x 59x 21x 21x 19x 10x 10x 1x 1x 1x 10x 10x 21x 10x 10x 19x 8x 8x 1x 1x 1x 8x 16x 16x 16x 8x 8x 8x 19x 11x 11x 1x 1x 1x 9x 25x 15x 15x 25x 25x 9x 11x 19x 48x 48x 48x 316x 1x 1x 315x 315x 41x 48x 19x 13x 13x 35x 35x 13x 19x 32x 32x 32x 32x 32x 1x 1x 32x 3x 3x 28x 32x 19x 11x 11x 11x 11x     11x 43x 1x 1x 43x 25x 23x 43x 11x 11x 19x 19x 21x 21x 21x 18x 1x 1x 18x 37x 1x 1x 37x 23x 37x 13x 13x 37x 21x 21x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x  
'use strict';
 
const { AbortController } = require('internal/abort_controller');
 
const {
  codes: {
    ERR_INVALID_ARG_TYPE,
    ERR_OUT_OF_RANGE,
  },
  AbortError,
} = require('internal/errors');
const { validateInteger } = require('internal/validators');
const { kWeakHandler } = require('internal/event_target');
 
const {
  ArrayPrototypePush,
  MathFloor,
  Number,
  NumberIsNaN,
  Promise,
  PromiseReject,
  PromisePrototypeCatch,
  Symbol,
} = primordials;
 
const kEmpty = Symbol('kEmpty');
const kEof = Symbol('kEof');
 
async 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']);
  }
 
  let concurrency = 1;
  if (options?.concurrency != null) {
    concurrency = MathFloor(options.concurrency);
  }
 
  validateInteger(concurrency, 'concurrency', 1);
 
  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;
    }
  }
}
 
async function some(fn, options) {
  // 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 (x) => {
    return !(await fn(x));
  }, 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));
}
 
async 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;
  }
  yield* this.map(filterFn, options);
}
 
async function toArray(options) {
  const result = [];
  for await (const val of this) {
    if (options?.signal?.aborted) {
      throw new AbortError({ cause: options.signal.reason });
    }
    ArrayPrototypePush(result, val);
  }
  return result;
}
 
async function* flatMap(fn, options) {
  for await (const val of this.map(fn, options)) {
    yield* val;
  }
}
 
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) {
  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) {
  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 = {
  drop,
  filter,
  flatMap,
  map,
  take,
};
 
module.exports.promiseReturningOperators = {
  every,
  forEach,
  toArray,
  some,
};