All files / lib/internal/streams destroy.js

97.33% Statements 329/338
96.24% Branches 128/133
100% Functions 17/17
97.33% Lines 329/338

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 33926x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 204605x 204605x 4691x 4691x 4691x 4691x 1461x 1461x 4691x 2964x 2964x 4691x 204605x 26x 26x 26x 116031x 116031x 116031x 116031x 116031x 116031x 116031x 13720x 2x 2x 13720x 13720x 13720x 102311x 102311x 102311x 102311x 102311x 102311x 103830x 81953x 81953x 103843x 102001x 102001x 102311x 102311x 116031x 123x 123x 123x 116020x 102188x 102188x 102311x 102311x 116031x 26x 102311x 102311x 102311x 102311x 102294x     102294x 102294x 102294x 102294x 102294x 102294x 102294x 102294x 81951x 81951x 102294x 101986x 101986x 102294x 102294x 7x 7x 102294x 102294x 1703x 102194x 100591x 100591x 102294x 102311x 102311x 102311x     102311x 26x 1703x 1703x 1703x 1703x 26x 102206x 102206x 102206x 102206x 102206x 81863x 81863x 102206x 101901x 101901x 102206x 102206x 65701x 65701x 102206x 26x 1722x 1722x 1722x 1722x 1722x 3x 3x 1719x 1719x 1520x 1520x 1719x 1630x 1630x 1719x 1719x 1722x 26x 43750x 43750x 43750x 43750x 43750x 43748x 43748x 43748x 43748x 43748x 43748x 43748x 43748x 43748x 43748x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 43750x 26x 144x 144x 144x 144x 144x 144x 144x 144x 144x 144x 144x 22x 22x 122x 144x 144x 19x 19x 19x 19x 19x 11x 11x 19x 11x 11x 19x 7x 19x 12x 12x 19x 144x 26x 196765x 196765x 194425x 194425x 2340x 2340x 2340x 2340x 196745x 2260x 2260x 196765x 82x 82x 2340x 2340x 2340x 2956x 2x 2x 2x 2338x 2338x 196765x 26x 2337x 2337x 2337x 2337x 2336x 2x 2x 2x 2334x 2334x 2334x 2334x 2336x 2336x 2336x 2255x 2255x 2336x 80x 80x 2334x 2336x 123x 2335x 14x 2210x 2197x 2197x 2336x 2337x 2337x 2337x 2337x     2337x 26x 2196x 2196x 2196x 26x 330x 330x 330x 26x 1x 1x 1x 26x 1x 1x 1x 1x 26x 26x 613x 613x 446x 446x 167x 613x 106x 106x 167x 167x 486x 2x 2x 486x   165x 2x 165x 159x 163x 3x 3x 3x 1x 1x     167x 486x 11x 11x 613x 26x 26x 26x 26x 26x 26x 26x 26x  
'use strict';
 
const {
  aggregateTwoErrors,
  codes: {
    ERR_MULTIPLE_CALLBACK,
  },
  AbortError,
} = require('internal/errors');
const {
  Symbol,
} = primordials;
const {
  kDestroyed,
  isDestroyed,
  isFinished,
  isServerRequest
} = require('internal/streams/utils');
 
const kDestroy = Symbol('kDestroy');
const kConstruct = Symbol('kConstruct');
 
function checkError(err, w, r) {
  if (err) {
    // Avoid V8 leak, https://github.com/nodejs/node/pull/34103#issuecomment-652002364
    err.stack; // eslint-disable-line no-unused-expressions
 
    if (w && !w.errored) {
      w.errored = err;
    }
    if (r && !r.errored) {
      r.errored = err;
    }
  }
}
 
// Backwards compat. cb() is undocumented and unused in core but
// unfortunately might be used by modules.
function destroy(err, cb) {
  const r = this._readableState;
  const w = this._writableState;
  // With duplex streams we use the writable side for state.
  const s = w || r;
 
  if ((w && w.destroyed) || (r && r.destroyed)) {
    if (typeof cb === 'function') {
      cb();
    }
 
    return this;
  }
 
 
  // We set destroyed to true before firing error callbacks in order
  // to make it re-entrance safe in case destroy() is called within callbacks
  checkError(err, w, r);
 
  if (w) {
    w.destroyed = true;
  }
  if (r) {
    r.destroyed = true;
  }
 
  // If still constructing then defer calling _destroy.
  if (!s.constructed) {
    this.once(kDestroy, function(er) {
      _destroy(this, aggregateTwoErrors(er, err), cb);
    });
  } else {
    _destroy(this, err, cb);
  }
 
  return this;
}
 
function _destroy(self, err, cb) {
  let called = false;
 
  function onDestroy(err) {
    if (called) {
      return;
    }
    called = true;
 
    const r = self._readableState;
    const w = self._writableState;
 
    checkError(err, w, r);
 
    if (w) {
      w.closed = true;
    }
    if (r) {
      r.closed = true;
    }
 
    if (typeof cb === 'function') {
      cb(err);
    }
 
    if (err) {
      process.nextTick(emitErrorCloseNT, self, err);
    } else {
      process.nextTick(emitCloseNT, self);
    }
  }
  try {
    self._destroy(err || null, onDestroy);
  } catch (err) {
    onDestroy(err);
  }
}
 
function emitErrorCloseNT(self, err) {
  emitErrorNT(self, err);
  emitCloseNT(self);
}
 
function emitCloseNT(self) {
  const r = self._readableState;
  const w = self._writableState;
 
  if (w) {
    w.closeEmitted = true;
  }
  if (r) {
    r.closeEmitted = true;
  }
 
  if ((w && w.emitClose) || (r && r.emitClose)) {
    self.emit('close');
  }
}
 
function emitErrorNT(self, err) {
  const r = self._readableState;
  const w = self._writableState;
 
  if ((w && w.errorEmitted) || (r && r.errorEmitted)) {
    return;
  }
 
  if (w) {
    w.errorEmitted = true;
  }
  if (r) {
    r.errorEmitted = true;
  }
 
  self.emit('error', err);
}
 
function undestroy() {
  const r = this._readableState;
  const w = this._writableState;
 
  if (r) {
    r.constructed = true;
    r.closed = false;
    r.closeEmitted = false;
    r.destroyed = false;
    r.errored = null;
    r.errorEmitted = false;
    r.reading = false;
    r.ended = r.readable === false;
    r.endEmitted = r.readable === false;
  }
 
  if (w) {
    w.constructed = true;
    w.destroyed = false;
    w.closed = false;
    w.closeEmitted = false;
    w.errored = null;
    w.errorEmitted = false;
    w.finalCalled = false;
    w.prefinished = false;
    w.ended = w.writable === false;
    w.ending = w.writable === false;
    w.finished = w.writable === false;
  }
}
 
function errorOrDestroy(stream, err, sync) {
  // We have tests that rely on errors being emitted
  // in the same tick, so changing this is semver major.
  // For now when you opt-in to autoDestroy we allow
  // the error to be emitted nextTick. In a future
  // semver major update we should change the default to this.
 
  const r = stream._readableState;
  const w = stream._writableState;
 
  if ((w && w.destroyed) || (r && r.destroyed)) {
    return this;
  }
 
  if ((r && r.autoDestroy) || (w && w.autoDestroy))
    stream.destroy(err);
  else if (err) {
    // Avoid V8 leak, https://github.com/nodejs/node/pull/34103#issuecomment-652002364
    err.stack; // eslint-disable-line no-unused-expressions
 
    if (w && !w.errored) {
      w.errored = err;
    }
    if (r && !r.errored) {
      r.errored = err;
    }
    if (sync) {
      process.nextTick(emitErrorNT, stream, err);
    } else {
      emitErrorNT(stream, err);
    }
  }
}
 
function construct(stream, cb) {
  if (typeof stream._construct !== 'function') {
    return;
  }
 
  const r = stream._readableState;
  const w = stream._writableState;
 
  if (r) {
    r.constructed = false;
  }
  if (w) {
    w.constructed = false;
  }
 
  stream.once(kConstruct, cb);
 
  if (stream.listenerCount(kConstruct) > 1) {
    // Duplex
    return;
  }
 
  process.nextTick(constructNT, stream);
}
 
function constructNT(stream) {
  let called = false;
 
  function onConstruct(err) {
    if (called) {
      errorOrDestroy(stream, err ?? new ERR_MULTIPLE_CALLBACK());
      return;
    }
    called = true;
 
    const r = stream._readableState;
    const w = stream._writableState;
    const s = w || r;
 
    if (r) {
      r.constructed = true;
    }
    if (w) {
      w.constructed = true;
    }
 
    if (s.destroyed) {
      stream.emit(kDestroy, err);
    } else if (err) {
      errorOrDestroy(stream, err, true);
    } else {
      process.nextTick(emitConstructNT, stream);
    }
  }
 
  try {
    stream._construct(onConstruct);
  } catch (err) {
    onConstruct(err);
  }
}
 
function emitConstructNT(stream) {
  stream.emit(kConstruct);
}
 
function isRequest(stream) {
  return stream && stream.setHeader && typeof stream.abort === 'function';
}
 
function emitCloseLegacy(stream) {
  stream.emit('close');
}
 
function emitErrorCloseLegacy(stream, err) {
  stream.emit('error', err);
  process.nextTick(emitCloseLegacy, stream);
}
 
// Normalize destroy for legacy.
function destroyer(stream, err) {
  if (!stream || isDestroyed(stream)) {
    return;
  }
 
  if (!err && !isFinished(stream)) {
    err = new AbortError();
  }
 
  // TODO: Remove isRequest branches.
  if (isServerRequest(stream)) {
    stream.socket = null;
    stream.destroy(err);
  } else if (isRequest(stream)) {
    stream.abort();
  } else if (isRequest(stream.req)) {
    stream.req.abort();
  } else if (typeof stream.destroy === 'function') {
    stream.destroy(err);
  } else if (typeof stream.close === 'function') {
    // TODO: Don't lose err?
    stream.close();
  } else if (err) {
    process.nextTick(emitErrorCloseLegacy, stream);
  } else {
    process.nextTick(emitCloseLegacy, stream);
  }
 
  if (!stream.destroyed) {
    stream[kDestroyed] = true;
  }
}
 
module.exports = {
  construct,
  destroyer,
  destroy,
  undestroy,
  errorOrDestroy
};