All files / lib/internal/streams utils.js

94.13% Statements 273/290
85.27% Branches 139/163
100% Functions 22/22
94.13% Lines 273/290

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 29122x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 3133x 3133x 3133x 3133x 3133x 3080x 3080x 68x 3133x 3133x 3133x 3133x 3133x 22x 2344x 2344x 2344x 2344x 2344x 2344x 2344x 2344x 22x 19x 19x 19x 19x 19x 1x 19x 19x 22x 6095x 6095x 6095x 6094x 6094x 6094x 6094x 131x 6094x 6095x 6095x 22x 606x 606x 606x 606x 604x 606x 606x 22x 1158x 1158x 1158x 1158x 1158x 1158x 1158x 22x 22x 216x 216x 216x 216x 216x 216x 214x 216x 22x 22x 969x 969x 969x 607x 969x 969x 385x 385x 385x 969x 969x 22x 22x 14x 14x 14x 14x 14x 14x 12x 14x 22x 22x 1239x 1239x 1238x 1239x 1239x 1070x 1092x 1067x 1239x 1239x 22x 374x 374x 374x 354x 354x 374x 374x 374x 22x 733x 733x 733x 217x 733x 733x 733x 22x 100x 100x     100x 100x     100x 100x 93x 93x 7x 100x 4x 4x 4x 4x 100x 22x 874x 874x     874x 874x     874x 874x 874x 22x 740x 740x     740x 740x     740x 740x 740x 22x 940x 940x     940x 940x 903x 903x 938x 938x 938x 938x 938x 940x 37x 940x     37x 940x 22x 22x 15x 15x 940x 22x 34x 34x 34x 34x 34x 34x 34x 34x 22x 36x 36x 36x 12x 36x 36x 22x 155x 155x 155x 155x 4x 155x 155x 22x 940x 940x 940x 940x 940x 940x 940x 940x 928x 928x 928x 831x 940x 940x 22x 15x 15x 15x 8x 15x 15x 22x 10x 10x 10x 10x 10x 10x 10x 10x   10x 10x 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  
'use strict';
 
const {
  Symbol,
  SymbolAsyncIterator,
  SymbolIterator,
} = primordials;
 
const kDestroyed = Symbol('kDestroyed');
const kIsErrored = Symbol('kIsErrored');
const kIsReadable = Symbol('kIsReadable');
const kIsDisturbed = Symbol('kIsDisturbed');
 
function isReadableNodeStream(obj, strict = false) {
  return !!(
    obj &&
    typeof obj.pipe === 'function' &&
    typeof obj.on === 'function' &&
    (
      !strict ||
      (typeof obj.pause === 'function' && typeof obj.resume === 'function')
    ) &&
    (!obj._writableState || obj._readableState?.readable !== false) && // Duplex
    (!obj._writableState || obj._readableState) // Writable has .pipe.
  );
}
 
function isWritableNodeStream(obj) {
  return !!(
    obj &&
    typeof obj.write === 'function' &&
    typeof obj.on === 'function' &&
    (!obj._readableState || obj._writableState?.writable !== false) // Duplex
  );
}
 
function isDuplexNodeStream(obj) {
  return !!(
    obj &&
    (typeof obj.pipe === 'function' && obj._readableState) &&
    typeof obj.on === 'function' &&
    typeof obj.write === 'function'
  );
}
 
function isNodeStream(obj) {
  return (
    obj &&
    (
      obj._readableState ||
      obj._writableState ||
      (typeof obj.write === 'function' && typeof obj.on === 'function') ||
      (typeof obj.pipe === 'function' && typeof obj.on === 'function')
    )
  );
}
 
function isIterable(obj, isAsync) {
  if (obj == null) return false;
  if (isAsync === true) return typeof obj[SymbolAsyncIterator] === 'function';
  if (isAsync === false) return typeof obj[SymbolIterator] === 'function';
  return typeof obj[SymbolAsyncIterator] === 'function' ||
    typeof obj[SymbolIterator] === 'function';
}
 
function isDestroyed(stream) {
  if (!isNodeStream(stream)) return null;
  const wState = stream._writableState;
  const rState = stream._readableState;
  const state = wState || rState;
  return !!(stream.destroyed || stream[kDestroyed] || state?.destroyed);
}
 
// Have been end():d.
function isWritableEnded(stream) {
  if (!isWritableNodeStream(stream)) return null;
  if (stream.writableEnded === true) return true;
  const wState = stream._writableState;
  if (wState?.errored) return false;
  if (typeof wState?.ended !== 'boolean') return null;
  return wState.ended;
}
 
// Have emitted 'finish'.
function isWritableFinished(stream, strict) {
  if (!isWritableNodeStream(stream)) return null;
  if (stream.writableFinished === true) return true;
  const wState = stream._writableState;
  if (wState?.errored) return false;
  if (typeof wState?.finished !== 'boolean') return null;
  return !!(
    wState.finished ||
    (strict === false && wState.ended === true && wState.length === 0)
  );
}
 
// Have been push(null):d.
function isReadableEnded(stream) {
  if (!isReadableNodeStream(stream)) return null;
  if (stream.readableEnded === true) return true;
  const rState = stream._readableState;
  if (!rState || rState.errored) return false;
  if (typeof rState?.ended !== 'boolean') return null;
  return rState.ended;
}
 
// Have emitted 'end'.
function isReadableFinished(stream, strict) {
  if (!isReadableNodeStream(stream)) return null;
  const rState = stream._readableState;
  if (rState?.errored) return false;
  if (typeof rState?.endEmitted !== 'boolean') return null;
  return !!(
    rState.endEmitted ||
    (strict === false && rState.ended === true && rState.length === 0)
  );
}
 
function isReadable(stream) {
  if (stream && stream[kIsReadable] != null) return stream[kIsReadable];
  if (typeof stream?.readable !== 'boolean') return null;
  if (isDestroyed(stream)) return false;
  return isReadableNodeStream(stream) &&
    stream.readable &&
    !isReadableFinished(stream);
}
 
function isWritable(stream) {
  if (typeof stream?.writable !== 'boolean') return null;
  if (isDestroyed(stream)) return false;
  return isWritableNodeStream(stream) &&
    stream.writable &&
    !isWritableEnded(stream);
}
 
function isFinished(stream, opts) {
  if (!isNodeStream(stream)) {
    return null;
  }
 
  if (isDestroyed(stream)) {
    return true;
  }
 
  if (opts?.readable !== false && isReadable(stream)) {
    return false;
  }
 
  if (opts?.writable !== false && isWritable(stream)) {
    return false;
  }
 
  return true;
}
 
function isWritableErrored(stream) {
  if (!isNodeStream(stream)) {
    return null;
  }
 
  if (stream.writableErrored) {
    return stream.writableErrored;
  }
 
  return stream._writableState?.errored ?? null;
}
 
function isReadableErrored(stream) {
  if (!isNodeStream(stream)) {
    return null;
  }
 
  if (stream.readableErrored) {
    return stream.readableErrored;
  }
 
  return stream._readableState?.errored ?? null;
}
 
function isClosed(stream) {
  if (!isNodeStream(stream)) {
    return null;
  }
 
  if (typeof stream.closed === 'boolean') {
    return stream.closed;
  }
 
  const wState = stream._writableState;
  const rState = stream._readableState;
 
  if (
    typeof wState?.closed === 'boolean' ||
    typeof rState?.closed === 'boolean'
  ) {
    return wState?.closed || rState?.closed;
  }
 
  if (typeof stream._closed === 'boolean' && isOutgoingMessage(stream)) {
    return stream._closed;
  }
 
  return null;
}
 
function isOutgoingMessage(stream) {
  return (
    typeof stream._closed === 'boolean' &&
    typeof stream._defaultKeepAlive === 'boolean' &&
    typeof stream._removedConnection === 'boolean' &&
    typeof stream._removedContLen === 'boolean'
  );
}
 
function isServerResponse(stream) {
  return (
    typeof stream._sent100 === 'boolean' &&
    isOutgoingMessage(stream)
  );
}
 
function isServerRequest(stream) {
  return (
    typeof stream._consuming === 'boolean' &&
    typeof stream._dumped === 'boolean' &&
    stream.req?.upgradeOrConnect === undefined
  );
}
 
function willEmitClose(stream) {
  if (!isNodeStream(stream)) return null;
 
  const wState = stream._writableState;
  const rState = stream._readableState;
  const state = wState || rState;
 
  return (!state && isServerResponse(stream)) || !!(
    state &&
    state.autoDestroy &&
    state.emitClose &&
    state.closed === false
  );
}
 
function isDisturbed(stream) {
  return !!(stream && (
    stream[kIsDisturbed] ??
    (stream.readableDidRead || stream.readableAborted)
  ));
}
 
function isErrored(stream) {
  return !!(stream && (
    stream[kIsErrored] ??
    stream.readableErrored ??
    stream.writableErrored ??
    stream._readableState?.errorEmitted ??
    stream._writableState?.errorEmitted ??
    stream._readableState?.errored ??
    stream._writableState?.errored
  ));
}
 
module.exports = {
  kDestroyed,
  isDisturbed,
  kIsDisturbed,
  isErrored,
  kIsErrored,
  isReadable,
  kIsReadable,
  isClosed,
  isDestroyed,
  isDuplexNodeStream,
  isFinished,
  isIterable,
  isReadableNodeStream,
  isReadableEnded,
  isReadableFinished,
  isReadableErrored,
  isNodeStream,
  isWritable,
  isWritableNodeStream,
  isWritableEnded,
  isWritableFinished,
  isWritableErrored,
  isServerRequest,
  isServerResponse,
  willEmitClose,
};