From 8c76fa5f8ecf03c3fa8343680ab7347673afc0ce Mon Sep 17 00:00:00 2001 From: dr-js Date: Tue, 5 Oct 2021 09:34:40 +0800 Subject: [PATCH] doc: deprecate (doc-only) http abort related MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Refs: https://github.com/nodejs/node/pull/36641 Refs: https://github.com/nodejs/node/issues/36617#issuecomment-751443964 Documentation-only deprecate `.aborted` property and `'abort'`, `'aborted'` event in `http`, and suggest using the corresponding Stream API instead. Co-authored-by: Michaël Zasso Co-authored-by: Rich Trott Co-authored-by: Robert Nagy Co-authored-by: Antoine du Hamel PR-URL: https://github.com/nodejs/node/pull/36670 Reviewed-By: Robert Nagy Reviewed-By: James M Snell Reviewed-By: Matteo Collina --- doc/api/deprecations.md | 26 ++++++++++++++++++++++++++ doc/api/http.md | 15 ++++++++++++++- 2 files changed, 40 insertions(+), 1 deletion(-) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index cd37c7a0b30953..4f5cd1c761e9e5 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2827,6 +2827,28 @@ Type: Documentation-only (supports [`--pending-deprecation`][]) The remapping of specifiers ending in `"/"` like `import 'pkg/x/'` is deprecated for package `"exports"` and `"imports"` pattern resolutions. +### DEP0XXX: `.aborted` property and `'abort'`, `'aborted'` event in `http` + + +Type: Documentation-only + +Move to {Stream} API instead, as the [`http.ClientRequest`][], +[`http.ServerResponse`][], and [`http.IncomingMessage`][] are all stream-based. +Check `stream.destroyed` instead of the `.aborted` property, and listen for +`'close'` instead of `'abort'`, `'aborted'` event. + +The `.aborted` property and `'abort'` event are only useful for detecting +`.abort()` calls. For closing a request early, use the Stream +`.destroy([error])` then check the `.destroyed` property and `'close'` event +should have the same effect. The receiving end should also check the +[`readable.readableEnded`][] value on [`http.IncomingMessage`][] to get whether +it was an aborted or graceful destroy. + [Legacy URL API]: url.md#url_legacy_url_api [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 @@ -2884,6 +2906,9 @@ for package `"exports"` and `"imports"` pattern resolutions. [`fs.read()`]: fs.md#fs_fs_read_fd_buffer_offset_length_position_callback [`fs.readSync()`]: fs.md#fs_fs_readsync_fd_buffer_offset_length_position [`fs.stat()`]: fs.md#fs_fs_stat_path_options_callback +[`http.ClientRequest`]: #http_class_http_clientrequest +[`http.IncomingMessage`]: #http_class_http_incomingmessage +[`http.ServerResponse`]: #http_class_http_serverresponse [`http.get()`]: http.md#http_http_get_options_callback [`http.request()`]: http.md#http_http_request_options_callback [`https.get()`]: https.md#https_https_get_options_callback @@ -2896,6 +2921,7 @@ for package `"exports"` and `"imports"` pattern resolutions. [`process.env`]: process.md#process_process_env [`process.mainModule`]: process.md#process_process_mainmodule [`punycode`]: punycode.md +[`readable.readableEnded`]: stream.md#stream_readable_readableended [`request.abort()`]: http.md#http_request_abort [`request.connection`]: http.md#http_request_connection [`request.destroy()`]: http.md#http_request_destroy_error diff --git a/doc/api/http.md b/doc/api/http.md index 5b441248b7ed10..9e4c94a86ff6cd 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -405,8 +405,11 @@ body which has been transmitted are equal or not. ### Event: `'abort'` +> Stability: 0 - Deprecated. Listen for the `'close'` event instead. + Emitted when the request has been aborted by the client. This event is only emitted on the first call to `abort()`. @@ -562,7 +565,7 @@ added: v0.7.8 --> Emitted when the underlying socket times out from inactivity. This only notifies -that the socket has been idle. The request must be aborted manually. +that the socket has been idle. The request must be destroyed manually. See also: [`request.setTimeout()`][]. @@ -643,12 +646,15 @@ in the response to be dropped and the socket to be destroyed. ### `request.aborted` +> Stability: 0 - Deprecated. Check [`request.destroyed`][] instead. + * {boolean} The `request.aborted` property will be `true` if the request has @@ -1984,8 +1990,11 @@ may be reused multiple times in case of keep-alive. ### Event: `'aborted'` +> Stability: 0 - Deprecated. Listen for `'close'` event instead. + Emitted when the request has been aborted. ### Event: `'close'` @@ -1998,8 +2007,11 @@ Indicates that the underlying connection was closed. ### `message.aborted` +> Stability: 0 - Deprecated. Check `message.destroyed` from {stream.Readable}. + * {boolean} The `message.aborted` property will be `true` if the request has @@ -3231,6 +3243,7 @@ try { [`outgoingMessage.socket`]: #http_outgoingmessage_socket [`removeHeader(name)`]: #http_request_removeheader_name [`request.destroy()`]: #http_request_destroy_error +[`request.destroyed`]: #http_request_destroyed [`request.end()`]: #http_request_end_data_encoding_callback [`request.flushHeaders()`]: #http_request_flushheaders [`request.getHeader()`]: #http_request_getheader_name