mirror of
https://github.com/denoland/deno.git
synced 2024-11-22 15:06:54 -05:00
232 lines
7 KiB
JavaScript
232 lines
7 KiB
JavaScript
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
// Copyright Joyent and Node contributors. All rights reserved. MIT license.
|
|
// deno-lint-ignore-file
|
|
|
|
import {
|
|
AbortError,
|
|
ERR_STREAM_PREMATURE_CLOSE,
|
|
} from "ext:deno_node/internal/errors.ts";
|
|
import { once } from "ext:deno_node/internal/util.mjs";
|
|
import {
|
|
validateAbortSignal,
|
|
validateFunction,
|
|
validateObject,
|
|
} from "ext:deno_node/internal/validators.mjs";
|
|
import * as process from "ext:deno_node/_process/process.ts";
|
|
|
|
function isRequest(stream) {
|
|
return stream.setHeader && typeof stream.abort === "function";
|
|
}
|
|
|
|
function isServerResponse(stream) {
|
|
return (
|
|
typeof stream._sent100 === "boolean" &&
|
|
typeof stream._removedConnection === "boolean" &&
|
|
typeof stream._removedContLen === "boolean" &&
|
|
typeof stream._removedTE === "boolean" &&
|
|
typeof stream._closed === "boolean"
|
|
);
|
|
}
|
|
|
|
function isReadable(stream) {
|
|
return typeof stream.readable === "boolean" ||
|
|
typeof stream.readableEnded === "boolean" ||
|
|
!!stream._readableState;
|
|
}
|
|
|
|
function isWritable(stream) {
|
|
return typeof stream.writable === "boolean" ||
|
|
typeof stream.writableEnded === "boolean" ||
|
|
!!stream._writableState;
|
|
}
|
|
|
|
function isWritableFinished(stream) {
|
|
if (stream.writableFinished) return true;
|
|
const wState = stream._writableState;
|
|
if (!wState || wState.errored) return false;
|
|
return wState.finished || (wState.ended && wState.length === 0);
|
|
}
|
|
|
|
const nop = () => {};
|
|
|
|
function isReadableEnded(stream) {
|
|
if (stream.readableEnded) return true;
|
|
const rState = stream._readableState;
|
|
if (!rState || rState.errored) return false;
|
|
return rState.endEmitted || (rState.ended && rState.length === 0);
|
|
}
|
|
|
|
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 ||
|
|
(options.readable !== false && isReadable(stream));
|
|
const writable = options.writable ||
|
|
(options.writable !== false && isWritable(stream));
|
|
|
|
const wState = stream._writableState;
|
|
const rState = stream._readableState;
|
|
const state = wState || rState;
|
|
|
|
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 = isServerResponse(stream) || (
|
|
state &&
|
|
state.autoDestroy &&
|
|
state.emitClose &&
|
|
state.closed === false &&
|
|
isReadable(stream) === readable &&
|
|
isWritable(stream) === writable
|
|
);
|
|
|
|
let writableFinished = stream.writableFinished ||
|
|
(wState && wState.finished);
|
|
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 || readableEnded) callback.call(stream);
|
|
};
|
|
|
|
let readableEnded = stream.readableEnded ||
|
|
(rState && rState.endEmitted);
|
|
const onend = () => {
|
|
readableEnded = 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);
|
|
};
|
|
|
|
const onclose = () => {
|
|
if (readable && !readableEnded) {
|
|
if (!isReadableEnded(stream)) {
|
|
return callback.call(stream, new ERR_STREAM_PREMATURE_CLOSE());
|
|
}
|
|
}
|
|
if (writable && !writableFinished) {
|
|
if (!isWritableFinished(stream)) {
|
|
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);
|
|
|
|
// _closed is for OutgoingMessage which is not a proper Writable.
|
|
const closed = (!wState && !rState && stream._closed === true) || (
|
|
(wState && wState.closed) ||
|
|
(rState && rState.closed) ||
|
|
(wState && wState.errorEmitted) ||
|
|
(rState && rState.errorEmitted) ||
|
|
(rState && stream.req && stream.aborted) ||
|
|
(
|
|
(!wState || !willEmitClose || typeof wState.closed !== "boolean") &&
|
|
(!rState || !willEmitClose || typeof rState.closed !== "boolean") &&
|
|
(!writable || (wState && wState.finished)) &&
|
|
(!readable || (rState && rState.endEmitted))
|
|
)
|
|
);
|
|
|
|
if (closed) {
|
|
// TODO(ronag): Re-throw error if errorEmitted?
|
|
// TODO(ronag): Throw premature close as if finished was called?
|
|
// before being closed? i.e. if closed but not errored, ended or finished.
|
|
// TODO(ronag): Throw some kind of error? Does it make sense
|
|
// to call finished() on a "finished" stream?
|
|
// TODO(ronag): willEmitClose?
|
|
process.nextTick(() => {
|
|
callback();
|
|
});
|
|
}
|
|
|
|
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());
|
|
};
|
|
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;
|
|
}
|
|
|
|
export default eos;
|