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: expose web streams globals, remove runtime experimental warning #42225

Merged
merged 1 commit into from
Apr 4, 2022

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Mar 5, 2022

The web streams implementation seems to be quite stable, this PR propose to mark it as stable and to expose its class on the global object.

/cc @jasnell

Fixes: #40950

@aduh95 aduh95 added semver-major PRs that contain breaking changes and should be released in the next major version. web streams labels Mar 5, 2022
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/startup

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. labels Mar 5, 2022
@aduh95 aduh95 mentioned this pull request Mar 5, 2022
24 tasks
doc/api/webstreams.md Outdated Show resolved Hide resolved
Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

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

I think it's probably too soon and web-streams still aren't used enough "in the wild" to graduate. I think there are also a few open bugs like. #39756

@benjamingr
Copy link
Member

@aduh95 @jasnell that issue was just an example of an open web-streams issue. I just don't think they've seen enough adoption to be "stable" yet.

That said it's a spec and any violation is a bug fix anyway so I guess the "API" is stable (if probably still buggy?)

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 6, 2022

@benjamingr yes, that was my understanding :)
I'm opening this PR now so it can land in v18.0.0, but it doesn't have to, we could wait for v19.0.0 (or even later) if you think v18.x is too soon. I have a personal preference for landing it earlier because v18.x will be LTS and not having them as globals might slow down their adoption, but I'm happy to defer to @nodejs/streams judgement.

@targos
Copy link
Member

targos commented Mar 6, 2022

@benjamingr do you think it's too soon for stable status, for exposing as globals, or both?

@benjamingr
Copy link
Member

benjamingr commented Mar 6, 2022

do you think it's too soon for stable status, for exposing as globals, or both?

The stable status though that's just "we are giving users an API and telling them it's stable even though it isn't battle-tested and probably still has more bugs than other stable APIs". If we're OK with that then the API surface itself won't change (other than the spec itself changing).

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.

I'm +1 in marking them as stable. I'm -1 as exposing them as globals. I guess is that these adds quite a bit of work to our bootstrap without significant win for our users.

I might be ok with some form of lazy-load but I'm unsure if it's possible.

I'd also add that our implementation is likely quite slow, so I'm unsure if we should promote their usage. Ref. nodejs/undici#1203.

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.

I was supposed to hit the request change button.

@vweevers
Copy link
Contributor

vweevers commented Mar 6, 2022

[globals don't have a] significant win for our users.

It hurts adoption. As an example, level-web-stream needs a conditional import and also in turn has to explain this to consumers. Globals would be a clear win here.

I'd also add that our implementation is likely quite slow

I can confirm (from a quick benchmark so I won't share numbers). That can be added to documentation though. Web streams have immense value even if they are slower. Let users make the choice.

@mcollina
Copy link
Member

mcollina commented Mar 6, 2022

@vweevers you quoted only half of the paragraph. In this PR, there are quite a number of files that would be loaded during the bootstrap of Node.js.

Most users (currently) do not use those APIs so this loading cost is not well spent.

@vweevers
Copy link
Contributor

vweevers commented Mar 6, 2022

If the lack of globals hurts adoption (that's debatable ofc) then there will be less users to justify the cost of globals. To be fair, there are other ways to increase adoption - for me it was @jasnell's talk at Node Congress about a standard library for JS. That talk pushed me to try out web streams, and the lack of globals was just a minor snag.

Is there a plan to reduce the bootstrap cost (with snapshots?) or is it an indefinite blocker?

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 6, 2022

I guess is that these adds quite a bit of work to our bootstrap without significant win for our users.

Is it still true with snapshot? IIRC lazy loading has no upside (and has the downside of having more overhead), except to avoid circular dependencies.
Is there a way to measure the difference? Looking at the time it takes for make test to complete, it seems that PR doesn't have any noticeable impact on bootstrap performance (from 19'43" for acc11c9 to 19'28" for fc80fac).

In this PR, there are quite a number of files that would be loaded during the bootstrap of Node.js.

It adds three, based on https://github.com/nodejs/node/pull/42225/files#diff-eeda4d549f43051fb9ffbc8286e838ebfd607bae681dfc55a76679e6705124f9.

@lin72h
Copy link

lin72h commented Mar 7, 2022

+1 for expose Stream as global.

Reason 1:
Many future API like WebTransport, based on it, and I believe there'll be more to come

Reason 2:
Stream based programming model have been increasing popular inside or outside JS community, make it global, ease transition from community to Nodejs, examples are
Apple's Combine framework
IBM's red-node
React Flow
Video community's Touchdesigner
Audio community's bespoke

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 11, 2022

Benchmark CI: https://ci.nodejs.org/view/Node.js%20benchmark/job/benchmark-node-micro-benchmarks/1103/

No significant perf regression detected
                                                                                  confidence improvement accuracy (*)   (**)  (***)
misc/startup.js mode='process' script='benchmark/fixtures/require-builtins' dur=1                 0.25 %       ±1.67% ±2.22% ±2.89%
misc/startup.js mode='process' script='benchmark/fixtures/require-cachable' dur=1                 0.82 %       ±1.57% ±2.09% ±2.73%
misc/startup.js mode='process' script='test/fixtures/semicolon' dur=1                     **      1.68 %       ±1.25% ±1.67% ±2.18%
misc/startup.js mode='worker' script='benchmark/fixtures/require-builtins' dur=1                 -0.46 %       ±2.66% ±3.55% ±4.64%
misc/startup.js mode='worker' script='benchmark/fixtures/require-cachable' dur=1           *      2.60 %       ±2.14% ±2.85% ±3.71%
misc/startup.js mode='worker' script='test/fixtures/semicolon' dur=1                              0.35 %       ±1.70% ±2.27% ±2.95%

Be aware that when doing many comparisons the risk of a false-positive
result increases. In this case, there are 6 comparisons, you can thus
expect the following amount of false-positive results:
  0.30 false positives, when considering a   5% risk acceptance (*, **, ***),
  0.06 false positives, when considering a   1% risk acceptance (**, ***),
  0.01 false positives, when considering a 0.1% risk acceptance (***)

@Jamesernator
Copy link

Jamesernator commented Mar 12, 2022

It would seem a bit odd to have Blob and fetch/Response to graduate to globals but not streams given that both blob.stream() and response.body both expose ReadableStream instances.

Copy link
Member

@GeoffreyBooth GeoffreyBooth left a comment

Choose a reason for hiding this comment

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

+1 to improved compatibility with browsers, and enabling more code that can run without modification in both environments. Especially since this doesn’t seem to entail any performance costs per #42225 (comment), I don’t see why we shouldn’t land this?

@jasnell
Copy link
Member

jasnell commented Mar 14, 2022

@mcollina:

I'm +1 in marking them as stable. I'm -1 as exposing them as globals. I guess is that these adds quite a bit of work to our bootstrap without significant win for our users... I might be ok with some form of lazy-load but I'm unsure if it's possible.

If these are loaded as part of the startup snapshot then there really shouldn't be much cost at all during bootstrap.

I'd also add that our implementation is likely quite slow, so I'm unsure if we should promote their usage. Ref. nodejs/undici#1203.

That's a separate issue that should not block them graduating from experimental. Yes, the performance can be improved and node.js streams are definitely still faster, but graduation from experimental should not be gated on that factor at all.

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 24, 2022

@mcollina Can you clarify your position on this given the last comments? Adding the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label to make sure we don't forget to discuss it further before the v18.0.0 semver cutoff.

@aduh95 aduh95 added the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Mar 24, 2022
@mcollina
Copy link
Member

Yeah, I changed a bit my mind given the statement.
I'm +1 in exposing them as globals but not marking them stable as I would not recommend folks to use them right now (nodejs/undici#1203).
I would also remove the experimental warning.

@ronag
Copy link
Member

ronag commented Mar 31, 2022

I think we are also missing some fixes that might be semver-majory.

@apapirovski
Copy link
Member

apapirovski commented Mar 31, 2022

@mcollina in terms of performance, I think we should have some sort of criteria for what qualifies as good enough to no longer be labeled as experimental in the docs. (If that's the only reason it's marked as experimental for now.)

Overall, I'm -0 on removing the experimental warning if we actually don't believe the performance is good enough for production usage. Especially if we're making this global and this is an API that isn't Node specific, folks might just use it without even checking our documentation. It feels like we're relinquishing our responsibility for producing an easy-to-use runtime and pushing off that responsibility to the user.

@mcollina
Copy link
Member

Overall, I'm -0 on removing the experimental warning if we actually don't believe the performance is good enough for production usage. Especially if we're making this global and this is an API that isn't Node specific, folks might just use it without even checking our documentation. It feels like we're relinquishing our responsibility for producing an easy-to-use runtime and pushing off that responsibility to the user.

That's exactly my intent. Most developers won't care about performance but just about Web compatibility. As for Web compatibility goes, I think our implementation is solid, possibly it needs some work (see #42225 (comment)).

My take is that we need more feedback from people. Folks will not use it with the big warning in the console.

@jasnell
Copy link
Member

jasnell commented Mar 31, 2022

+1 on making it global. -1 on graduating it. It's complex enough that it should remain experimental for a while, just in case

@aduh95 aduh95 changed the title stream: graduate web streams from experimental and expose as globals stream: expose web streams globals, remove runtime experimental warning Mar 31, 2022
@apapirovski
Copy link
Member

apapirovski commented Mar 31, 2022

Most developers won't care about performance but just about Web compatibility.

I think that somewhat depends on the use-case. I would consider streams to be one of the main performance-sensitive pieces in Node.js but perhaps I'm mistaken. That said, IMO your undici-fetch story kinda highlights a similar concern.

@aduh95
Copy link
Contributor Author

aduh95 commented Apr 3, 2022

@mcollina does this look good to you now?

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

@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Apr 3, 2022
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 3, 2022
@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@aduh95 aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. and removed tsc-agenda Issues and PRs to discuss during the meetings of the TSC. labels Apr 4, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 4, 2022
@nodejs-github-bot nodejs-github-bot merged commit 560cbc5 into nodejs:master Apr 4, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 560cbc5

@aduh95 aduh95 deleted the global-web-streams branch April 4, 2022 08:41
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
PR-URL: nodejs#42225
Fixes: nodejs#40950
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Mestery <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Geoffrey Booth <[email protected]>
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. 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. tools Issues and PRs related to the tools directory. web streams
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Graduate WHATWG Streams from Experimental?