Skip to content

http: Make OutgoingMessage more streamlike #45672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aduh95 merged 10 commits into from
Dec 2, 2022
Merged

http: Make OutgoingMessage more streamlike #45672

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1047db4
http: Make OutgoingMessage more streamlike
ronag Nov 29, 2022
7813900
fixup
ronag Nov 29, 2022
8d247a5
fixup
ronag Nov 29, 2022
e0a4a31
fixuP
ronag Nov 29, 2022
c9a76ba
fixuP
ronag Nov 29, 2022
2a412af
fixup: tests
ronag Nov 29, 2022
3b3fbb5
fiuxp
ronag Nov 29, 2022
25d952b
fiuxp
ronag Nov 29, 2022
305ade0
Apply suggestions from code review
ronag Nov 30, 2022
fd82016
fixup
ronag Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
http: Make OutgoingMessage more streamlike 
Implement missing getters error & closed. Add support for
proper "writable" check through isWritable helper.

We cannot fix the OutgoingMessage.writable propery as that
will break the ecosystem.
  • Loading branch information
@ronag
ronag committed Nov 29, 2022
commit 1047db40277adbf7930a24c664f5edfad283f759
24 changes: 23 additions & 1 deletion lib/_http_outgoing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ const assert = require('internal/assert');
const EE = require('events');
const Stream = require('stream');
const internalUtil = require('internal/util');
const { kIsWritable } = require('internal/streams/utils');
const { kOutHeaders, utcDate, kNeedDrain } = require('internal/http');
const { Buffer } = require('buffer');
const {
Expand Down Expand Up @@ -88,6 +89,7 @@ const kCorked = Symbol('corked');
const kUniqueHeaders = Symbol('kUniqueHeaders');
const kBytesWritten = Symbol('kBytesWritten');
const kEndCalled = Symbol('kEndCalled');
const kErrored = Symbol('errored');

const nop = () => {};

Expand Down Expand Up @@ -146,11 +148,29 @@ function OutgoingMessage() {

this._keepAliveTimeout = 0;

this._onPendingData = nop;
this[kErrored] = null;
}
ObjectSetPrototypeOf(OutgoingMessage.prototype, Stream.prototype);
ObjectSetPrototypeOf(OutgoingMessage, Stream);

ObjectDefineProperty(OutgoingMessage.prototype, kIsWritable, {
get() {
return !this.destroyed && !this[kErrored] && !this.finished;
}
});

ObjectDefineProperty(OutgoingMessage.prototype, 'errored', {
get() {
return this[kErrored];
}
});

ObjectDefineProperty(OutgoingMessage.prototype, 'closed', {
get() {
return this._closed;
}
});

ObjectDefineProperty(OutgoingMessage.prototype, 'writableFinished', {
__proto__: null,
get() {
Expand Down Expand Up @@ -320,6 +340,8 @@ OutgoingMessage.prototype.destroy = function destroy(error) {
}
this.destroyed = true;

this[kErrored] = error;

if (this.socket) {
this.socket.destroy(error);
} else {
Expand Down
3 changes: 3 additions & 0 deletions lib/internal/streams/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const {
const kDestroyed = Symbol('kDestroyed');
const kIsErrored = Symbol('kIsErrored');
const kIsReadable = Symbol('kIsReadable');
const kIsWritable = Symbol('kIsWritable');
const kIsDisturbed = Symbol('kIsDisturbed');

function isReadableNodeStream(obj, strict = false) {
Expand Down Expand Up @@ -126,6 +127,7 @@ function isReadable(stream) {
}

function isWritable(stream) {
if (stream && stream[kIsWritable] != null) return stream[kIsWritable];
if (typeof stream?.writable !== 'boolean') return null;
if (isDestroyed(stream)) return false;
return isWritableNodeStream(stream) &&
Expand Down Expand Up @@ -262,6 +264,7 @@ function isErrored(stream) {
}

module.exports = {
kIsWritable,
kDestroyed,
isDisturbed,
kIsDisturbed,
Expand Down
1 change: 1 addition & 0 deletions lib/stream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ const Stream = module.exports = require('internal/streams/legacy').Stream;
Stream.isDisturbed = utils.isDisturbed;
Stream.isErrored = utils.isErrored;
Stream.isReadable = utils.isReadable;
Stream.isWritable = utils.isWritable;
Stream.Readable = require('internal/streams/readable');
for (const key of ObjectKeys(streamReturningOperators)) {
const op = streamReturningOperators[key];
Expand Down