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

98.43% Statements 251/255
95.91% Branches 94/98
91.66% Functions 11/12
98.43% Lines 251/255

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 25619x 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 19x 19x 19x 19x 19x 19x 19x 19x 946x 946x 946x 19x 19x 19x 951x 951x 164x 164x 951x 7x 786x 780x 780x 951x 951x 951x 951x 951x 951x 951x 951x 951x 2x 2x 2x 950x 950x 950x 950x 950x 20x 8x 8x 950x 950x 950x 950x 950x 950x 950x 951x 727x 951x 951x 951x 951x 221x 221x 221x 221x 221x 9x 9x 221x 221x 89x 89x 217x 221x 96x 96x 951x 951x 951x 951x 437x 437x 437x 437x 437x 1x 1x 437x 437x 350x 350x 87x 437x 68x 68x 951x 951x 951x 300x 951x 951x 951x 951x 951x 878x 878x 878x 878x 878x 286x 286x 592x 878x 58x 58x 57x 58x 878x 29x 29x 29x 29x 821x 821x 951x 951x 951x   951x 951x 951x 10x 10x 10x 10x 10x   10x 10x 10x 951x 20x 20x 20x 951x 951x 951x 9x 9x 946x 946x 946x 946x 946x 946x 946x 946x 951x 42x 949x 1x 1x 1x 904x 903x 903x 124x 903x 1x 903x 902x 902x 90x 902x 3x 902x     951x 951x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 101x 951x 951x 951x 6x 5x 5x 5x 5x 5x 5x 6x 6x 2x 6x 4x 4x 4x 4x 4x 4x 4x 6x 951x 951x 951x 19x 8x 8x 8x 8x 5x 7x 3x 3x 8x 8x 8x 19x 19x 19x  
// 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_INVALID_ARG_TYPE,
  ERR_STREAM_PREMATURE_CLOSE
} = codes;
const { once } = require('internal/util');
const {
  validateAbortSignal,
  validateFunction,
  validateObject,
} = require('internal/validators');
 
const { Promise } = primordials;
 
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.
    throw new ERR_INVALID_ARG_TYPE('stream', 'Stream', stream);
  }
 
  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;
}
 
function finished(stream, opts) {
  return new Promise((resolve, reject) => {
    eos(stream, opts, (err) => {
      if (err) {
        reject(err);
      } else {
        resolve();
      }
    });
  });
}
 
module.exports = eos;
module.exports.finished = finished;