Skip to content
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.

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

stream: need to cleanup event listeners if last stream is readable #41954

Merged
merged 2 commits into from
Feb 15, 2022
Merged

stream: need to cleanup event listeners if last stream is readable #41954

merged 2 commits into from
Feb 15, 2022

Conversation

meixg
Copy link
Member

@meixg meixg commented Feb 13, 2022

fix: #35452

const {pipeline, Duplex, PassThrough, Writable} = require('stream');

const a = new PassThrough();
a.end('foobar');

const b = new Duplex({
    write(chunk, encoding, callback) {
        callback();
    }
});

pipeline(a, b, error => {
    if (error) {
        throw error;
    }
    console.log(b.listenerCount('error'));
    setTimeout(() => {
        console.log(b.listenerCount('error'));
        b.destroy(new Error('no way'));
    }, 100);
});

output:

0
0
node:events:505
      throw er; // Unhandled 'error' event
      ^

Error: no way

@ronag @mcollina

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/streams

@nodejs-github-bot nodejs-github-bot added the needs-ci PRs that need a full CI run. label Feb 13, 2022
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a unit test?

Copy link
Member

@ronag ronag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has subtle problems. I think a possible solution is to just cleanup the listeners for the last stream.

@meixg
Copy link
Member Author

meixg commented Feb 13, 2022

This has subtle problems. I think a possible solution is to just cleanup the listeners for the last stream.

This change uses an isLastStream variable to only process the last stream.

@meixg
Copy link
Member Author

meixg commented Feb 13, 2022

Can you please add a unit test?

Unit test added :)

Copy link
Member

@ronag ronag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to check if the stream is readable at the end before the cleanup.

@meixg
Copy link
Member Author

meixg commented Feb 13, 2022

You need to check if the stream is readable at the end before the cleanup.

I checked at the beginning using .readable,will this change between the end?

@ronag
Copy link
Member

ronag commented Feb 13, 2022

I don't think this will work properly. There are a lot of edge cases that are not handled. I would recommend to not try and to only partly achieve a behaviour and cause lots of unexpected edge cases.

If this is behaviour is important than you can achieve it with something like:

const ret = pipeline(...)
const dst = new PassThrough()
ret.on('error', err => dst.destroy(err)).pipe(dst)

finished = true;
destroyImpl.destroyer(stream, err || new ERR_STREAM_DESTROYED('pipe'));
return {
callback: (err) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
callback: (err) => {
destroy: (err) => {

Comment on lines 205 to 207
while (lastStreamCleanup && lastStreamCleanup.length) {
lastStreamCleanup.shift()();
}
Copy link
Member

@ronag ronag Feb 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
while (lastStreamCleanup && lastStreamCleanup.length) {
lastStreamCleanup.shift()();
}
lastStreamCleanup.forEach(fn => fn());

Comment on lines 223 to 228
const { callback, cleanup } = destroyer(stream, reading, writing);
destroys.push(callback);

if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(cleanup);
}
Copy link
Member

@ronag ronag Feb 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const { callback, cleanup } = destroyer(stream, reading, writing);
destroys.push(callback);
if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(cleanup);
}
const { destroy, cleanup } = destroyer(stream, reading, writing);
destroys.push(destroy);
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
}

Comment on lines 242 to 246
if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(() => {
stream.removeListener('error', onError);
});
}
Copy link
Member

@ronag ronag Feb 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(() => {
stream.removeListener('error', onError);
});
}
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(() => {
stream.removeListener('error', onError);
});
}

@@ -285,12 +309,15 @@ function pipelineImpl(streams, callback, opts) {

ret = pt;

destroys.push(destroyer(ret, false, true));
destroys.push(destroyer(ret, false, true).callback);
Copy link
Member

@ronag ronag Feb 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
destroys.push(destroyer(ret, false, true).callback);
const { destroy, cleanup } = (destroyer(ret, false, true)
destroys.push(destroy);
if (isLastStream) {
lastStreamCleanup.push(cleanup);
}

Comment on lines 318 to 320
if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(cleanup);
}
Copy link
Member

@ronag ronag Feb 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (lastStreamCleanup && isLastStream) {
lastStreamCleanup.push(cleanup);
}
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
}

Copy link
Member

@ronag ronag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe ok. A little scary. Added some fixes.

Copy link
Member

@ronag ronag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will also need a doc update.

Apply suggestions from code review.
Add test case for async generators.
Update doc.
@meixg
Copy link
Member Author

meixg commented Feb 13, 2022

Maybe ok. A little scary. Added some fixes.

Applied suggestions from code review, and added a test case for async generators.

The doc is updated too.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@nodejs-github-bot
Copy link
Collaborator

@meixg

This comment was marked as resolved.

@nodejs-github-bot
Copy link
Collaborator

@meixg

This comment was marked as resolved.

@meixg
Copy link
Member Author

meixg commented Feb 15, 2022

Can you help me with this CI? @ronag

@ronag ronag added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 15, 2022
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Feb 15, 2022
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/41954
✔  Done loading data for nodejs/node/pull/41954
----------------------------------- PR info ------------------------------------
Title      stream: need to cleanup event listeners if last stream is readable (#41954)
Author     Xuguang Mei  (@meixg)
Branch     meixg:stream-meixg -> nodejs:master
Labels     stream, semver-major, author ready, needs-ci
Commits    2
 - stream: need to cleanup event listeners if last stream is readable
 - stream: need to cleanup event listeners if last stream is readable
Committers 1
 - meixg 
PR-URL: https://github.com/nodejs/node/pull/41954
Fixes: https://github.com/nodejs/node/issues/35452
Reviewed-By: Robert Nagy 
Reviewed-By: Matteo Collina 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/41954
Fixes: https://github.com/nodejs/node/issues/35452
Reviewed-By: Robert Nagy 
Reviewed-By: Matteo Collina 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sun, 13 Feb 2022 08:44:23 GMT
   ✔  Approvals: 2
   ✔  - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/41954#pullrequestreview-881018526
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/41954#pullrequestreview-881044648
   ✖  This PR needs to wait 25 more minutes to land
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2022-02-15T07:54:47Z: https://ci.nodejs.org/job/node-test-pull-request/42575/
- Querying data for job/node-test-pull-request/42575/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/1845761432

@meixg
Copy link
Member Author

meixg commented Feb 15, 2022

This PR needs to wait 25 more minutes to land

can land now :)

@ronag ronag added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Feb 15, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 15, 2022
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/41954
✔  Done loading data for nodejs/node/pull/41954
----------------------------------- PR info ------------------------------------
Title      stream: need to cleanup event listeners if last stream is readable (#41954)
Author     Xuguang Mei  (@meixg)
Branch     meixg:stream-meixg -> nodejs:master
Labels     stream, semver-major, author ready, needs-ci
Commits    2
 - stream: need to cleanup event listeners if last stream is readable
 - stream: need to cleanup event listeners if last stream is readable
Committers 1
 - meixg 
PR-URL: https://github.com/nodejs/node/pull/41954
Fixes: https://github.com/nodejs/node/issues/35452
Reviewed-By: Robert Nagy 
Reviewed-By: Matteo Collina 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/41954
Fixes: https://github.com/nodejs/node/issues/35452
Reviewed-By: Robert Nagy 
Reviewed-By: Matteo Collina 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sun, 13 Feb 2022 08:44:23 GMT
   ✔  Approvals: 2
   ✔  - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/41954#pullrequestreview-881018526
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/41954#pullrequestreview-881044648
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2022-02-15T08:19:08Z: https://ci.nodejs.org/job/node-test-pull-request/42575/
- Querying data for job/node-test-pull-request/42575/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/master up to date...
From https://github.com/nodejs/node
 * branch                  master     -> FETCH_HEAD
✔  origin/master is now up-to-date
- Downloading patch for 41954
From https://github.com/nodejs/node
 * branch                  refs/pull/41954/merge -> FETCH_HEAD
✔  Fetched commits as cc505a505a16..97fb400489ed
--------------------------------------------------------------------------------
[master c8109f4cf6] stream: need to cleanup event listeners if last stream is readable
 Author: meixg 
 Date: Sun Feb 13 16:38:29 2022 +0800
 2 files changed, 92 insertions(+), 11 deletions(-)
 create mode 100644 test/parallel/test-stream-pipeline-listeners.js
[master 32dd26b122] stream: need to cleanup event listeners if last stream is readable
 Author: meixg 
 Date: Mon Feb 14 00:36:12 2022 +0800
 3 files changed, 54 insertions(+), 27 deletions(-)
   ✔  Patches applied
There are 2 commits in the PR. Attempting autorebase.
Rebasing (2/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
stream: need to cleanup event listeners if last stream is readable

fix: #35452

PR-URL: #41954
Fixes: #35452
Reviewed-By: Robert Nagy [email protected]
Reviewed-By: Matteo Collina [email protected]

[detached HEAD 54d48f479e] stream: need to cleanup event listeners if last stream is readable
Author: meixg [email protected]
Date: Sun Feb 13 16:38:29 2022 +0800
2 files changed, 92 insertions(+), 11 deletions(-)
create mode 100644 test/parallel/test-stream-pipeline-listeners.js
Rebasing (3/4)
Rebasing (4/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
stream: need to cleanup event listeners if last stream is readable

Apply suggestions from code review.
Add test case for async generators.
Update doc.

PR-URL: #41954
Fixes: #35452
Reviewed-By: Robert Nagy [email protected]
Reviewed-By: Matteo Collina [email protected]

[detached HEAD a0db88ebcc] stream: need to cleanup event listeners if last stream is readable
Author: meixg [email protected]
Date: Mon Feb 14 00:36:12 2022 +0800
3 files changed, 54 insertions(+), 27 deletions(-)

Successfully rebased and updated refs/heads/master.

ℹ Use --fixupAll option, squash the PR manually or land the PR from the command line.

https://github.com/nodejs/node/actions/runs/1845985560

@nodejs-github-bot nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Feb 15, 2022
@meixg
Copy link
Member Author

meixg commented Feb 15, 2022

May need to use "commit-queue-squash"

@ronag ronag added commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Feb 15, 2022
@meixg
Copy link
Member Author

meixg commented Feb 15, 2022

Seems that the "commit-queue-squash" needs to work with "commit-queue"

@ronag ronag added the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 15, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 15, 2022
@nodejs-github-bot nodejs-github-bot merged commit 9fb7ac3 into nodejs:master Feb 15, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 9fb7ac3

@meixg
Copy link
Member Author

meixg commented Feb 15, 2022

thanks! @ronag

@meixg meixg deleted the stream-meixg branch February 15, 2022 10:19
BethGriggs added a commit that referenced this pull request Apr 18, 2022
Notable Changes:

Deprecations and Removals:

- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (#42607)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (#41896)
- (SEMVER-MAJOR) stream: remove thenable support (Robert Nagy)
  (#40773)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (#41479)

fetch (experimental):

An experimental fetch API is available on the global scope by default.
The implementation is based upon https://undici.nodejs.org/#/,
an HTTP/1.1 client written for Node.js by contributors to the project.

Through this addition, the following globals are made available: `fetch`
, `FormData`, `Headers`, `Request`, `Response`.

Disable this API with the `--no-experimental-fetch` command-line flag.

Contributed by Michaël Zasso in #41811.

HTTP Timeouts:

`server.headersTimeout`, which limits the amount of time the parser will
wait to receive the complete HTTP headers, is now set to `60000` (60
seconds) by default.

`server.requestTimeout`, which sets the timeout value in milliseconds
for receiving the entire request from the client, is now set to `300000`
(5 minutes) by default.

If these timeouts expire, the server responds with status 408 without
forwarding the request to the request listener and then closes the
connection.

Both timeouts must be set to a non-zero value to protect against
potential Denial-of-Service attacks in case the server is deployed
without a reverse proxy in front.

Contributed by Paolo Insogna in #41263.

Test Runner module (experimental):

The `node:test` module facilitates the creation of JavaScript tests that
report results in TAP format. This module is only available under the
`node:` scheme.

Contributed by Colin Ihrig in #42325.

Toolchain and Compiler Upgrades:

- Prebuilt binaries for Linux are now built on Red Hat Enterprise Linux
  (RHEL) 8 and are compatible with Linux distributions based on glibc
  2.28 or later, for example, Debian 10, RHEL 8, Ubuntu 20.04.
- Prebuilt binaries for macOS now require macOS 10.15 or later.
- For AIX the minimum supported architecture has been raised from Power
  7 to Power 8.

Prebuilt binaries for 32-bit Windows will initially not be available due
to issues building the V8 dependency in Node.js. We hope to restore
32-bit Windows binaries for Node.js 18 with a future V8 update.

Node.js does not support running on operating systems that are no longer
supported by their vendor. For operating systems where their vendor has
planned to end support earlier than April 2025, such as Windows 8.1
(January 2023) and Windows Server 2012 R2 (October 2023), support for
Node.js 18 will end at the earlier date.

Full details about the supported toolchains and compilers are documented
in the Node.js `BUILDING.md` file.

Contributed by Richard Lau in #42292,
#42604 and #42659
, and Michaël Zasso in #42105 and
#42666.

V8 10.1:

The V8 engine is updated to version 10.1, which is part of Chromium 101.
Compared to the version included in Node.js 17.9.0, the following new
features are included:

- The `findLast` and `findLastIndex` array methods.
- Improvements to the `Intl.Locale` API.
- The `Intl.supportedValuesOf` function.
- Improved performance of class fields and private class methods (the
  initialization of them is now as fast as ordinary property stores).

The data format returned by the serialization API (`v8.serialize(value)`)
has changed, and cannot be deserialized by earlier versions of Node.js.
On the other hand, it is still possible to deserialize the previous
format, as the API is backwards-compatible.

Contributed by Michaël Zasso in #42657.

Web Streams API (experimental):

Node.js now exposes the experimental implementation of the Web Streams
API on the global scope. This means the following APIs are now globally
available:

- `ReadableStream`, `ReadableStreamDefaultReader`,
`ReadableStreamBYOBReader`, `ReadableStreamBYOBRequest`,
`ReadableByteStreamController`, `ReadableStreamDefaultController`,
`TransformStream`, `TransformStreamDefaultController`, `WritableStream`,
`WritableStreamDefaultWriter`, `WritableStreamDefaultController`,
`ByteLengthQueuingStrategy`, `CountQueuingStrategy`, `TextEncoderStream`,
`TextDecoderStream`, `CompressionStream`, `DecompressionStream`.

Contributed James Snell in #39062,
and Antoine du Hamel in #42225.

Other Notable Changes:

- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (#41270)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (#41305)
- doc: add RafaelGSS to collaborators
  (RafaelGSS) (#42718)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (#42163)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (#41271)

Semver-Major Commits:

- (SEMVER-MAJOR) assert,util: compare RegExp.lastIndex while using deep
  equal checks
  (Ruben Bridgewater) (#41020)
- (SEMVER-MAJOR) buffer: refactor `byteLength` to remove outdated
  optimizations
  (Rongjian Zhang) (#38545)
- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (#41270)
- (SEMVER-MAJOR) buffer: graduate Blob from experimental
  (James M Snell) (#41270)
- (SEMVER-MAJOR) build: make x86 Windows support temporarily
  experimental
  (Michaël Zasso) (#42666)
- (SEMVER-MAJOR) build: bump macOS deployment target to 10.15
  (Richard Lau) (#42292)
- (SEMVER-MAJOR) build: downgrade Windows 8.1 and server 2012 R2 to
  experimental
  (Michaël Zasso) (#42105)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (#41305)
- (SEMVER-MAJOR) cluster: make `kill` to be just `process.kill`
  (Bar Admoni) (#34312)
- (SEMVER-MAJOR) crypto: cleanup validation
  (Mohammed Keyvanzadeh) (#39841)
- (SEMVER-MAJOR) crypto: prettify othername in PrintGeneralName
  (Tobias Nießen) (#42123)
- (SEMVER-MAJOR) crypto: fix X509Certificate toLegacyObject
  (Tobias Nießen) (#42124)
- (SEMVER-MAJOR) crypto: use RFC2253 format in PrintGeneralName
  (Tobias Nießen) (#42002)
- (SEMVER-MAJOR) crypto: change default check(Host|Email) behavior
  (Tobias Nießen) (#41600)
- (SEMVER-MAJOR) deps: V8: cherry-pick semver-major commits from 10.2
  (Michaël Zasso) (#42657)
- (SEMVER-MAJOR) deps: update V8 to 10.1.124.6
  (Michaël Zasso) (#42657)
- (SEMVER-MAJOR) deps: update V8 to 9.8.177.9
  (Michaël Zasso) (#41610)
- (SEMVER-MAJOR) deps: update V8 to 9.7.106.18
  (Michaël Zasso) (#40907)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) doc: update minimum glibc requirements for Linux
  (Richard Lau) (#42659)
- (SEMVER-MAJOR) doc: update AIX minimum supported arch
  (Richard Lau) (#42604)
- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (#42607)
- (SEMVER-MAJOR) http: refactor headersTimeout and requestTimeout logic
  (Paolo Insogna) (#41263)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (#42163)
- (SEMVER-MAJOR) lib: enable fetch by default
  (Michaël Zasso) (#41811)
- (SEMVER-MAJOR) lib: replace validator and error
  (Mohammed Keyvanzadeh) (#41678)
- (SEMVER-MAJOR) module,repl: support 'node:'-only core modules
  (Colin Ihrig) (#42325)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) process: disallow some uses of Object.defineProperty()
  on process.env
  (Himself65) (#28006)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (#41896)
- (SEMVER-MAJOR) readline: fix question still called after closed
  (Xuguang Mei) (#42464)
- (SEMVER-MAJOR) stream: remove thenable support
  (Robert Nagy) (#40773)
- (SEMVER-MAJOR) stream: expose web streams globals, remove runtime
  experimental warning
  (Antoine du Hamel) (#42225)
- (SEMVER-MAJOR) stream: need to cleanup event listeners if last stream
  is readable
  (Xuguang Mei) (#41954)
- (SEMVER-MAJOR) stream: revert revert `map` spec compliance
  (Benjamin Gruenbaum) (#41933)
- (SEMVER-MAJOR) stream: throw invalid arg type from End Of Stream
  (Jithil P Ponnan) (#41766)
- (SEMVER-MAJOR) stream: don't emit finish after destroy
  (Robert Nagy) (#40852)
- (SEMVER-MAJOR) stream: add errored and closed props
  (Robert Nagy) (#40696)
- (SEMVER-MAJOR) test: add initial test module
  (Colin Ihrig) (#42325)
- (SEMVER-MAJOR) timers: refactor internal classes to ES2015 syntax
  (Rabbit) (#37408)
- (SEMVER-MAJOR) tls: represent registeredID numerically always
  (Tobias Nießen) (#41561)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (#41479)
- (SEMVER-MAJOR) url: throw on NULL in IPv6 hostname
  (Rich Trott) (#42313)
- (SEMVER-MAJOR) v8: make v8.writeHeapSnapshot() error codes consistent
  (Darshan Sen) (#42577)
- (SEMVER-MAJOR) v8: make writeHeapSnapshot throw if fopen fails
  (Antonio Román) (#41373)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (#41271)

PR-URL: #42262
BethGriggs added a commit that referenced this pull request Apr 19, 2022
Notable Changes:

Deprecations and Removals:

- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (#42607)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (#41896)
- (SEMVER-MAJOR) stream: remove thenable support (Robert Nagy)
  (#40773)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (#41479)

fetch (experimental):

An experimental fetch API is available on the global scope by default.
The implementation is based upon https://undici.nodejs.org/#/,
an HTTP/1.1 client written for Node.js by contributors to the project.

Through this addition, the following globals are made available: `fetch`
, `FormData`, `Headers`, `Request`, `Response`.

Disable this API with the `--no-experimental-fetch` command-line flag.

Contributed by Michaël Zasso in #41811.

HTTP Timeouts:

`server.headersTimeout`, which limits the amount of time the parser will
wait to receive the complete HTTP headers, is now set to `60000` (60
seconds) by default.

`server.requestTimeout`, which sets the timeout value in milliseconds
for receiving the entire request from the client, is now set to `300000`
(5 minutes) by default.

If these timeouts expire, the server responds with status 408 without
forwarding the request to the request listener and then closes the
connection.

Both timeouts must be set to a non-zero value to protect against
potential Denial-of-Service attacks in case the server is deployed
without a reverse proxy in front.

Contributed by Paolo Insogna in #41263.

Test Runner module (experimental):

The `node:test` module facilitates the creation of JavaScript tests that
report results in TAP format. This module is only available under the
`node:` scheme.

Contributed by Colin Ihrig in #42325.

Toolchain and Compiler Upgrades:

- Prebuilt binaries for Linux are now built on Red Hat Enterprise Linux
  (RHEL) 8 and are compatible with Linux distributions based on glibc
  2.28 or later, for example, Debian 10, RHEL 8, Ubuntu 20.04.
- Prebuilt binaries for macOS now require macOS 10.15 or later.
- For AIX the minimum supported architecture has been raised from Power
  7 to Power 8.

Prebuilt binaries for 32-bit Windows will initially not be available due
to issues building the V8 dependency in Node.js. We hope to restore
32-bit Windows binaries for Node.js 18 with a future V8 update.

Node.js does not support running on operating systems that are no longer
supported by their vendor. For operating systems where their vendor has
planned to end support earlier than April 2025, such as Windows 8.1
(January 2023) and Windows Server 2012 R2 (October 2023), support for
Node.js 18 will end at the earlier date.

Full details about the supported toolchains and compilers are documented
in the Node.js `BUILDING.md` file.

Contributed by Richard Lau in #42292,
#42604 and #42659
, and Michaël Zasso in #42105 and
#42666.

V8 10.1:

The V8 engine is updated to version 10.1, which is part of Chromium 101.
Compared to the version included in Node.js 17.9.0, the following new
features are included:

- The `findLast` and `findLastIndex` array methods.
- Improvements to the `Intl.Locale` API.
- The `Intl.supportedValuesOf` function.
- Improved performance of class fields and private class methods (the
  initialization of them is now as fast as ordinary property stores).

The data format returned by the serialization API (`v8.serialize(value)`)
has changed, and cannot be deserialized by earlier versions of Node.js.
On the other hand, it is still possible to deserialize the previous
format, as the API is backwards-compatible.

Contributed by Michaël Zasso in #42657.

Web Streams API (experimental):

Node.js now exposes the experimental implementation of the Web Streams
API on the global scope. This means the following APIs are now globally
available:

- `ReadableStream`, `ReadableStreamDefaultReader`,
`ReadableStreamBYOBReader`, `ReadableStreamBYOBRequest`,
`ReadableByteStreamController`, `ReadableStreamDefaultController`,
`TransformStream`, `TransformStreamDefaultController`, `WritableStream`,
`WritableStreamDefaultWriter`, `WritableStreamDefaultController`,
`ByteLengthQueuingStrategy`, `CountQueuingStrategy`, `TextEncoderStream`,
`TextDecoderStream`, `CompressionStream`, `DecompressionStream`.

Contributed James Snell in #39062,
and Antoine du Hamel in #42225.

Other Notable Changes:

- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (#41270)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (#41305)
- doc: add RafaelGSS to collaborators
  (RafaelGSS) (#42718)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (#42163)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (#41271)

Semver-Major Commits:

- (SEMVER-MAJOR) assert,util: compare RegExp.lastIndex while using deep
  equal checks
  (Ruben Bridgewater) (#41020)
- (SEMVER-MAJOR) buffer: refactor `byteLength` to remove outdated
  optimizations
  (Rongjian Zhang) (#38545)
- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (#41270)
- (SEMVER-MAJOR) buffer: graduate Blob from experimental
  (James M Snell) (#41270)
- (SEMVER-MAJOR) build: make x86 Windows support temporarily
  experimental
  (Michaël Zasso) (#42666)
- (SEMVER-MAJOR) build: bump macOS deployment target to 10.15
  (Richard Lau) (#42292)
- (SEMVER-MAJOR) build: downgrade Windows 8.1 and server 2012 R2 to
  experimental
  (Michaël Zasso) (#42105)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (#41305)
- (SEMVER-MAJOR) cluster: make `kill` to be just `process.kill`
  (Bar Admoni) (#34312)
- (SEMVER-MAJOR) crypto: cleanup validation
  (Mohammed Keyvanzadeh) (#39841)
- (SEMVER-MAJOR) crypto: prettify othername in PrintGeneralName
  (Tobias Nießen) (#42123)
- (SEMVER-MAJOR) crypto: fix X509Certificate toLegacyObject
  (Tobias Nießen) (#42124)
- (SEMVER-MAJOR) crypto: use RFC2253 format in PrintGeneralName
  (Tobias Nießen) (#42002)
- (SEMVER-MAJOR) crypto: change default check(Host|Email) behavior
  (Tobias Nießen) (#41600)
- (SEMVER-MAJOR) deps: V8: cherry-pick semver-major commits from 10.2
  (Michaël Zasso) (#42657)
- (SEMVER-MAJOR) deps: update V8 to 10.1.124.6
  (Michaël Zasso) (#42657)
- (SEMVER-MAJOR) deps: update V8 to 9.8.177.9
  (Michaël Zasso) (#41610)
- (SEMVER-MAJOR) deps: update V8 to 9.7.106.18
  (Michaël Zasso) (#40907)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) doc: update minimum glibc requirements for Linux
  (Richard Lau) (#42659)
- (SEMVER-MAJOR) doc: update AIX minimum supported arch
  (Richard Lau) (#42604)
- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (#42607)
- (SEMVER-MAJOR) http: refactor headersTimeout and requestTimeout logic
  (Paolo Insogna) (#41263)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (#42163)
- (SEMVER-MAJOR) lib: enable fetch by default
  (Michaël Zasso) (#41811)
- (SEMVER-MAJOR) lib: replace validator and error
  (Mohammed Keyvanzadeh) (#41678)
- (SEMVER-MAJOR) module,repl: support 'node:'-only core modules
  (Colin Ihrig) (#42325)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (#41431)
- (SEMVER-MAJOR) process: disallow some uses of Object.defineProperty()
  on process.env
  (Himself65) (#28006)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (#41896)
- (SEMVER-MAJOR) readline: fix question still called after closed
  (Xuguang Mei) (#42464)
- (SEMVER-MAJOR) stream: remove thenable support
  (Robert Nagy) (#40773)
- (SEMVER-MAJOR) stream: expose web streams globals, remove runtime
  experimental warning
  (Antoine du Hamel) (#42225)
- (SEMVER-MAJOR) stream: need to cleanup event listeners if last stream
  is readable
  (Xuguang Mei) (#41954)
- (SEMVER-MAJOR) stream: revert revert `map` spec compliance
  (Benjamin Gruenbaum) (#41933)
- (SEMVER-MAJOR) stream: throw invalid arg type from End Of Stream
  (Jithil P Ponnan) (#41766)
- (SEMVER-MAJOR) stream: don't emit finish after destroy
  (Robert Nagy) (#40852)
- (SEMVER-MAJOR) stream: add errored and closed props
  (Robert Nagy) (#40696)
- (SEMVER-MAJOR) test: add initial test module
  (Colin Ihrig) (#42325)
- (SEMVER-MAJOR) timers: refactor internal classes to ES2015 syntax
  (Rabbit) (#37408)
- (SEMVER-MAJOR) tls: represent registeredID numerically always
  (Tobias Nießen) (#41561)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (#41479)
- (SEMVER-MAJOR) url: throw on NULL in IPv6 hostname
  (Rich Trott) (#42313)
- (SEMVER-MAJOR) v8: make v8.writeHeapSnapshot() error codes consistent
  (Darshan Sen) (#42577)
- (SEMVER-MAJOR) v8: make writeHeapSnapshot throw if fopen fails
  (Antonio Román) (#41373)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (#41271)

PR-URL: #42262
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
Notable Changes:

Deprecations and Removals:

- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (nodejs#42607)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (nodejs#41431)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (nodejs#41896)
- (SEMVER-MAJOR) stream: remove thenable support (Robert Nagy)
  (nodejs#40773)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (nodejs#41479)

fetch (experimental):

An experimental fetch API is available on the global scope by default.
The implementation is based upon https://undici.nodejs.org/#/,
an HTTP/1.1 client written for Node.js by contributors to the project.

Through this addition, the following globals are made available: `fetch`
, `FormData`, `Headers`, `Request`, `Response`.

Disable this API with the `--no-experimental-fetch` command-line flag.

Contributed by Michaël Zasso in nodejs#41811.

HTTP Timeouts:

`server.headersTimeout`, which limits the amount of time the parser will
wait to receive the complete HTTP headers, is now set to `60000` (60
seconds) by default.

`server.requestTimeout`, which sets the timeout value in milliseconds
for receiving the entire request from the client, is now set to `300000`
(5 minutes) by default.

If these timeouts expire, the server responds with status 408 without
forwarding the request to the request listener and then closes the
connection.

Both timeouts must be set to a non-zero value to protect against
potential Denial-of-Service attacks in case the server is deployed
without a reverse proxy in front.

Contributed by Paolo Insogna in nodejs#41263.

Test Runner module (experimental):

The `node:test` module facilitates the creation of JavaScript tests that
report results in TAP format. This module is only available under the
`node:` scheme.

Contributed by Colin Ihrig in nodejs#42325.

Toolchain and Compiler Upgrades:

- Prebuilt binaries for Linux are now built on Red Hat Enterprise Linux
  (RHEL) 8 and are compatible with Linux distributions based on glibc
  2.28 or later, for example, Debian 10, RHEL 8, Ubuntu 20.04.
- Prebuilt binaries for macOS now require macOS 10.15 or later.
- For AIX the minimum supported architecture has been raised from Power
  7 to Power 8.

Prebuilt binaries for 32-bit Windows will initially not be available due
to issues building the V8 dependency in Node.js. We hope to restore
32-bit Windows binaries for Node.js 18 with a future V8 update.

Node.js does not support running on operating systems that are no longer
supported by their vendor. For operating systems where their vendor has
planned to end support earlier than April 2025, such as Windows 8.1
(January 2023) and Windows Server 2012 R2 (October 2023), support for
Node.js 18 will end at the earlier date.

Full details about the supported toolchains and compilers are documented
in the Node.js `BUILDING.md` file.

Contributed by Richard Lau in nodejs#42292,
nodejs#42604 and nodejs#42659
, and Michaël Zasso in nodejs#42105 and
nodejs#42666.

V8 10.1:

The V8 engine is updated to version 10.1, which is part of Chromium 101.
Compared to the version included in Node.js 17.9.0, the following new
features are included:

- The `findLast` and `findLastIndex` array methods.
- Improvements to the `Intl.Locale` API.
- The `Intl.supportedValuesOf` function.
- Improved performance of class fields and private class methods (the
  initialization of them is now as fast as ordinary property stores).

The data format returned by the serialization API (`v8.serialize(value)`)
has changed, and cannot be deserialized by earlier versions of Node.js.
On the other hand, it is still possible to deserialize the previous
format, as the API is backwards-compatible.

Contributed by Michaël Zasso in nodejs#42657.

Web Streams API (experimental):

Node.js now exposes the experimental implementation of the Web Streams
API on the global scope. This means the following APIs are now globally
available:

- `ReadableStream`, `ReadableStreamDefaultReader`,
`ReadableStreamBYOBReader`, `ReadableStreamBYOBRequest`,
`ReadableByteStreamController`, `ReadableStreamDefaultController`,
`TransformStream`, `TransformStreamDefaultController`, `WritableStream`,
`WritableStreamDefaultWriter`, `WritableStreamDefaultController`,
`ByteLengthQueuingStrategy`, `CountQueuingStrategy`, `TextEncoderStream`,
`TextDecoderStream`, `CompressionStream`, `DecompressionStream`.

Contributed James Snell in nodejs#39062,
and Antoine du Hamel in nodejs#42225.

Other Notable Changes:

- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (nodejs#41270)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (nodejs#41305)
- doc: add RafaelGSS to collaborators
  (RafaelGSS) (nodejs#42718)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (nodejs#42163)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (nodejs#41431)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (nodejs#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (nodejs#41271)

Semver-Major Commits:

- (SEMVER-MAJOR) assert,util: compare RegExp.lastIndex while using deep
  equal checks
  (Ruben Bridgewater) (nodejs#41020)
- (SEMVER-MAJOR) buffer: refactor `byteLength` to remove outdated
  optimizations
  (Rongjian Zhang) (nodejs#38545)
- (SEMVER-MAJOR) buffer: expose Blob as a global
  (James M Snell) (nodejs#41270)
- (SEMVER-MAJOR) buffer: graduate Blob from experimental
  (James M Snell) (nodejs#41270)
- (SEMVER-MAJOR) build: make x86 Windows support temporarily
  experimental
  (Michaël Zasso) (nodejs#42666)
- (SEMVER-MAJOR) build: bump macOS deployment target to 10.15
  (Richard Lau) (nodejs#42292)
- (SEMVER-MAJOR) build: downgrade Windows 8.1 and server 2012 R2 to
  experimental
  (Michaël Zasso) (nodejs#42105)
- (SEMVER-MAJOR) child\_process: improve argument validation
  (Rich Trott) (nodejs#41305)
- (SEMVER-MAJOR) cluster: make `kill` to be just `process.kill`
  (Bar Admoni) (nodejs#34312)
- (SEMVER-MAJOR) crypto: cleanup validation
  (Mohammed Keyvanzadeh) (nodejs#39841)
- (SEMVER-MAJOR) crypto: prettify othername in PrintGeneralName
  (Tobias Nießen) (nodejs#42123)
- (SEMVER-MAJOR) crypto: fix X509Certificate toLegacyObject
  (Tobias Nießen) (nodejs#42124)
- (SEMVER-MAJOR) crypto: use RFC2253 format in PrintGeneralName
  (Tobias Nießen) (nodejs#42002)
- (SEMVER-MAJOR) crypto: change default check(Host|Email) behavior
  (Tobias Nießen) (nodejs#41600)
- (SEMVER-MAJOR) deps: V8: cherry-pick semver-major commits from 10.2
  (Michaël Zasso) (nodejs#42657)
- (SEMVER-MAJOR) deps: update V8 to 10.1.124.6
  (Michaël Zasso) (nodejs#42657)
- (SEMVER-MAJOR) deps: update V8 to 9.8.177.9
  (Michaël Zasso) (nodejs#41610)
- (SEMVER-MAJOR) deps: update V8 to 9.7.106.18
  (Michaël Zasso) (nodejs#40907)
- (SEMVER-MAJOR) dns: remove `dns.lookup` and `dnsPromises.lookup`
  options type coercion
  (Antoine du Hamel) (nodejs#41431)
- (SEMVER-MAJOR) doc: update minimum glibc requirements for Linux
  (Richard Lau) (nodejs#42659)
- (SEMVER-MAJOR) doc: update AIX minimum supported arch
  (Richard Lau) (nodejs#42604)
- (SEMVER-MAJOR) fs: runtime deprecate string coercion in `fs.write`,
  `fs.writeFileSync`
  (Livia Medeiros) (nodejs#42607)
- (SEMVER-MAJOR) http: refactor headersTimeout and requestTimeout logic
  (Paolo Insogna) (nodejs#41263)
- (SEMVER-MAJOR) http: make TCP noDelay enabled by default
  (Paolo Insogna) (nodejs#42163)
- (SEMVER-MAJOR) lib: enable fetch by default
  (Michaël Zasso) (nodejs#41811)
- (SEMVER-MAJOR) lib: replace validator and error
  (Mohammed Keyvanzadeh) (nodejs#41678)
- (SEMVER-MAJOR) module,repl: support 'node:'-only core modules
  (Colin Ihrig) (nodejs#42325)
- (SEMVER-MAJOR) net: make `server.address()` return an integer for
  `family`
  (Antoine du Hamel) (nodejs#41431)
- (SEMVER-MAJOR) process: disallow some uses of Object.defineProperty()
  on process.env
  (Himself65) (nodejs#28006)
- (SEMVER-MAJOR) process: runtime deprecate multipleResolves
  (Benjamin Gruenbaum) (nodejs#41896)
- (SEMVER-MAJOR) readline: fix question still called after closed
  (Xuguang Mei) (nodejs#42464)
- (SEMVER-MAJOR) stream: remove thenable support
  (Robert Nagy) (nodejs#40773)
- (SEMVER-MAJOR) stream: expose web streams globals, remove runtime
  experimental warning
  (Antoine du Hamel) (nodejs#42225)
- (SEMVER-MAJOR) stream: need to cleanup event listeners if last stream
  is readable
  (Xuguang Mei) (nodejs#41954)
- (SEMVER-MAJOR) stream: revert revert `map` spec compliance
  (Benjamin Gruenbaum) (nodejs#41933)
- (SEMVER-MAJOR) stream: throw invalid arg type from End Of Stream
  (Jithil P Ponnan) (nodejs#41766)
- (SEMVER-MAJOR) stream: don't emit finish after destroy
  (Robert Nagy) (nodejs#40852)
- (SEMVER-MAJOR) stream: add errored and closed props
  (Robert Nagy) (nodejs#40696)
- (SEMVER-MAJOR) test: add initial test module
  (Colin Ihrig) (nodejs#42325)
- (SEMVER-MAJOR) timers: refactor internal classes to ES2015 syntax
  (Rabbit) (nodejs#37408)
- (SEMVER-MAJOR) tls: represent registeredID numerically always
  (Tobias Nießen) (nodejs#41561)
- (SEMVER-MAJOR) tls: move tls.parseCertString to end-of-life
  (Tobias Nießen) (nodejs#41479)
- (SEMVER-MAJOR) url: throw on NULL in IPv6 hostname
  (Rich Trott) (nodejs#42313)
- (SEMVER-MAJOR) v8: make v8.writeHeapSnapshot() error codes consistent
  (Darshan Sen) (nodejs#42577)
- (SEMVER-MAJOR) v8: make writeHeapSnapshot throw if fopen fails
  (Antonio Román) (nodejs#41373)
- (SEMVER-MAJOR) worker: expose BroadcastChannel as a global
  (James M Snell) (nodejs#41271)
- (SEMVER-MAJOR) worker: graduate BroadcastChannel to supported
  (James M Snell) (nodejs#41271)

PR-URL: nodejs#42262
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. needs-ci PRs that need a full CI run. semver-major PRs that contain breaking changes and should be released in the next major version. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pipeline leaves a hanging error handler
5 participants