summaryrefslogtreecommitdiff
path: root/ext/node/polyfills/internal/streams/end-of-stream.mjs
diff options
context:
space:
mode:
authorBartek IwaƄczuk <biwanczuk@gmail.com>2023-02-14 17:38:45 +0100
committerGitHub <noreply@github.com>2023-02-14 17:38:45 +0100
commitd47147fb6ad229b1c039aff9d0959b6e281f4df5 (patch)
tree6e9e790f2b9bc71b5f0c9c7e64b95cae31579d58 /ext/node/polyfills/internal/streams/end-of-stream.mjs
parent1d00bbe47e2ca14e2d2151518e02b2324461a065 (diff)
feat(ext/node): embed std/node into the snapshot (#17724)
This commit moves "deno_std/node" in "ext/node" crate. The code is transpiled and snapshotted during the build process. During the first pass a minimal amount of work was done to create the snapshot, a lot of code in "ext/node" depends on presence of "Deno" global. This code will be gradually fixed in the follow up PRs to migrate it to import relevant APIs from "internal:" modules. Currently the code from snapshot is not used in any way, and all Node/npm compatibility still uses code from "https://deno.land/std/node" (or from the location specified by "DENO_NODE_COMPAT_URL"). This will also be handled in a follow up PRs. --------- Co-authored-by: crowlkats <crowlkats@toaxl.com> Co-authored-by: Divy Srivastava <dj.srivastava23@gmail.com> Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
Diffstat (limited to 'ext/node/polyfills/internal/streams/end-of-stream.mjs')
-rw-r--r--ext/node/polyfills/internal/streams/end-of-stream.mjs229
1 files changed, 229 insertions, 0 deletions
diff --git a/ext/node/polyfills/internal/streams/end-of-stream.mjs b/ext/node/polyfills/internal/streams/end-of-stream.mjs
new file mode 100644
index 000000000..b5c380d56
--- /dev/null
+++ b/ext/node/polyfills/internal/streams/end-of-stream.mjs
@@ -0,0 +1,229 @@
+// 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 "internal:deno_node/polyfills/internal/errors.ts";
+import { once } from "internal:deno_node/polyfills/internal/util.mjs";
+import {
+ validateAbortSignal,
+ validateFunction,
+ validateObject,
+} from "internal:deno_node/polyfills/internal/validators.mjs";
+import * as process from "internal:deno_node/polyfills/_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;