All files / lib/internal/streams end-of-stream.js

98.32% Statements 235/239
95.55% Branches 86/90
90.9% Functions 10/11
98.32% Lines 235/239

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 24020x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 894x 894x 894x 20x 20x 20x 897x 897x 156x 156x 897x 5x 740x 736x 736x 896x 896x 896x 896x 896x 897x 897x 897x 897x 1x 1x 1x 897x 897x 897x 897x 897x 20x 8x 8x 897x 897x 897x 897x 897x 897x 897x 897x 674x 897x 897x 897x 897x 220x 220x 220x 220x 220x 9x 9x 220x 220x 88x 88x 216x 220x 96x 96x 897x 897x 897x 897x 387x 387x 387x 387x 387x 1x 1x 387x 387x 301x 301x 387x 387x 67x 67x 897x 897x 897x 301x 897x 897x 897x 897x 897x 831x 831x 831x 831x 831x 287x 287x 544x 831x 58x 58x 57x 58x 831x 29x 29x 29x 29x 458x 458x 897x 897x 897x   897x 897x 897x 10x 10x 10x 10x 10x   10x 10x 10x 897x 20x 20x 20x 897x 897x 897x 9x 9x 897x 897x 897x 897x 897x 897x 897x 897x 897x 42x 895x 1x 1x 1x 852x 851x 851x 125x 851x 1x 851x 850x 850x 90x 850x 4x 850x     894x 894x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 894x 894x 897x 6x 5x 5x 5x 5x 5x 5x 6x 6x 2x 6x 4x 4x 4x 4x 4x 4x 4x 6x 894x 894x 897x 20x 20x  
// Ported from https://github.com/mafintosh/end-of-stream with
// permission from the author, Mathias Buus (@mafintosh).
 
'use strict';
 
const {
  AbortError,
  codes,
} = require('internal/errors');
const {
  ERR_STREAM_PREMATURE_CLOSE
} = codes;
const { once } = require('internal/util');
const {
  validateAbortSignal,
  validateFunction,
  validateObject,
} = require('internal/validators');
 
const {
  isClosed,
  isReadable,
  isReadableNodeStream,
  isReadableFinished,
  isReadableErrored,
  isWritable,
  isWritableNodeStream,
  isWritableFinished,
  isWritableErrored,
  isNodeStream,
  willEmitClose: _willEmitClose,
} = require('internal/streams/utils');
 
function isRequest(stream) {
  return stream.setHeader && typeof stream.abort === 'function';
}
 
const nop = () => {};
 
function eos(stream, options, callback) {
  if (arguments.length === 2) {
    callback = options;
    options = {};
  } else if (options == null) {
    options = {};
  } else {
    validateObject(options, 'options');
  }
  validateFunction(callback, 'callback');
  validateAbortSignal(options.signal, 'options.signal');
 
  callback = once(callback);
 
  const readable = options.readable ?? isReadableNodeStream(stream);
  const writable = options.writable ?? isWritableNodeStream(stream);
 
  if (!isNodeStream(stream)) {
    // TODO: Webstreams.
    // TODO: Throw INVALID_ARG_TYPE.
  }
 
  const wState = stream._writableState;
  const rState = stream._readableState;
 
  const onlegacyfinish = () => {
    if (!stream.writable) {
      onfinish();
    }
  };
 
  // TODO (ronag): Improve soft detection to include core modules and
  // common ecosystem modules that do properly emit 'close' but fail
  // this generic check.
  let willEmitClose = (
    _willEmitClose(stream) &&
    isReadableNodeStream(stream) === readable &&
    isWritableNodeStream(stream) === writable
  );
 
  let writableFinished = isWritableFinished(stream, false);
  const onfinish = () => {
    writableFinished = true;
    // Stream should not be destroyed here. If it is that
    // means that user space is doing something differently and
    // we cannot trust willEmitClose.
    if (stream.destroyed) {
      willEmitClose = false;
    }
 
    if (willEmitClose && (!stream.readable || readable)) {
      return;
    }
 
    if (!readable || readableFinished) {
      callback.call(stream);
    }
  };
 
  let readableFinished = isReadableFinished(stream, false);
  const onend = () => {
    readableFinished = true;
    // Stream should not be destroyed here. If it is that
    // means that user space is doing something differently and
    // we cannot trust willEmitClose.
    if (stream.destroyed) {
      willEmitClose = false;
    }
 
    if (willEmitClose && (!stream.writable || writable)) {
      return;
    }
 
    if (!writable || writableFinished) {
      callback.call(stream);
    }
  };
 
  const onerror = (err) => {
    callback.call(stream, err);
  };
 
  let closed = isClosed(stream);
 
  const onclose = () => {
    closed = true;
 
    const errored = isWritableErrored(stream) || isReadableErrored(stream);
 
    if (errored && typeof errored !== 'boolean') {
      return callback.call(stream, errored);
    }
 
    if (readable && !readableFinished && isReadableNodeStream(stream, true)) {
      if (!isReadableFinished(stream, false))
        return callback.call(stream,
                             new ERR_STREAM_PREMATURE_CLOSE());
    }
    if (writable && !writableFinished) {
      if (!isWritableFinished(stream, false))
        return callback.call(stream,
                             new ERR_STREAM_PREMATURE_CLOSE());
    }
 
    callback.call(stream);
  };
 
  const onrequest = () => {
    stream.req.on('finish', onfinish);
  };
 
  if (isRequest(stream)) {
    stream.on('complete', onfinish);
    if (!willEmitClose) {
      stream.on('abort', onclose);
    }
    if (stream.req) {
      onrequest();
    } else {
      stream.on('request', onrequest);
    }
  } else if (writable && !wState) { // legacy streams
    stream.on('end', onlegacyfinish);
    stream.on('close', onlegacyfinish);
  }
 
  // Not all streams will emit 'close' after 'aborted'.
  if (!willEmitClose && typeof stream.aborted === 'boolean') {
    stream.on('aborted', onclose);
  }
 
  stream.on('end', onend);
  stream.on('finish', onfinish);
  if (options.error !== false) {
    stream.on('error', onerror);
  }
  stream.on('close', onclose);
 
  if (closed) {
    process.nextTick(onclose);
  } else if (wState?.errorEmitted || rState?.errorEmitted) {
    if (!willEmitClose) {
      process.nextTick(onclose);
    }
  } else if (
    !readable &&
    (!willEmitClose || isReadable(stream)) &&
    (writableFinished || isWritable(stream) === false)
  ) {
    process.nextTick(onclose);
  } else if (
    !writable &&
    (!willEmitClose || isWritable(stream)) &&
    (readableFinished || isReadable(stream) === false)
  ) {
    process.nextTick(onclose);
  } else if ((rState && stream.req && stream.aborted)) {
    process.nextTick(onclose);
  }
 
  const cleanup = () => {
    callback = nop;
    stream.removeListener('aborted', onclose);
    stream.removeListener('complete', onfinish);
    stream.removeListener('abort', onclose);
    stream.removeListener('request', onrequest);
    if (stream.req) stream.req.removeListener('finish', onfinish);
    stream.removeListener('end', onlegacyfinish);
    stream.removeListener('close', onlegacyfinish);
    stream.removeListener('finish', onfinish);
    stream.removeListener('end', onend);
    stream.removeListener('error', onerror);
    stream.removeListener('close', onclose);
  };
 
  if (options.signal && !closed) {
    const abort = () => {
      // Keep it because cleanup removes it.
      const endCallback = callback;
      cleanup();
      endCallback.call(
        stream,
        new AbortError(undefined, { cause: options.signal.reason }));
    };
    if (options.signal.aborted) {
      process.nextTick(abort);
    } else {
      const originalCallback = callback;
      callback = once((...args) => {
        options.signal.removeEventListener('abort', abort);
        originalCallback.apply(stream, args);
      });
      options.signal.addEventListener('abort', abort);
    }
  }
 
  return cleanup;
}
 
module.exports = eos;