doc: deprecate (doc-only) http abort related

Refs: #36641
Refs: #36617 (comment)

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 <[email protected]>
Co-authored-by: Rich Trott <[email protected]>
Co-authored-by: Robert Nagy <[email protected]>
Co-authored-by: Antoine du Hamel <[email protected]>

Author: 5 people

doc/api/deprecations.md

@@ -2831,6 +2831,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`
+<!-- YAML
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/36670
+    description: Documentation-only deprecation.
+-->
+
+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#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
@@ -2888,6 +2910,9 @@ for package `"exports"` and `"imports"` pattern resolutions.
 [`fs.read()`]: fs.md#fsreadfd-buffer-offset-length-position-callback
 [`fs.readSync()`]: fs.md#fsreadsyncfd-buffer-offset-length-position
 [`fs.stat()`]: fs.md#fsstatpath-options-callback
+[`http.ClientRequest`]: #http_class_http_clientrequest
+[`http.IncomingMessage`]: #http_class_http_incomingmessage
+[`http.ServerResponse`]: #http_class_http_serverresponse
 [`http.get()`]: http.md#httpgetoptions-callback
 [`http.request()`]: http.md#httprequestoptions-callback
 [`https.get()`]: https.md#httpsgetoptions-callback
@@ -2900,6 +2925,7 @@ for package `"exports"` and `"imports"` pattern resolutions.
 [`process.env`]: process.md#processenv
 [`process.mainModule`]: process.md#processmainmodule
 [`punycode`]: punycode.md
+[`readable.readableEnded`]: stream.md#stream_readable_readableended
 [`request.abort()`]: http.md#requestabort
 [`request.connection`]: http.md#requestconnection
 [`request.destroy()`]: http.md#requestdestroyerror

doc/api/http.md

@@ -407,8 +407,11 @@ body which has been transmitted are equal or not.
 ### Event: `'abort'`
 <!-- YAML
 added: v1.4.1
+deprecated: REPLACEME
 -->
 
+> 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()`.
 
@@ -564,7 +567,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()`][].
 
@@ -645,12 +648,15 @@ in the response to be dropped and the socket to be destroyed.
 ### `request.aborted`
 <!-- YAML
 added: v0.11.14
+deprecated: REPLACEME
 changes:
   - version: v11.0.0
     pr-url: https://github.com/nodejs/node/pull/20230
     description: The `aborted` property is no longer a timestamp number.
 -->
 
+> Stability: 0 - Deprecated. Check [`request.destroyed`][] instead.
+
 * {boolean}
 
 The `request.aborted` property will be `true` if the request has
@@ -1972,8 +1978,11 @@ may be reused multiple times in case of keep-alive.
 ### Event: `'aborted'`
 <!-- YAML
 added: v0.3.8
+deprecated: REPLACEME
 -->
 
+> Stability: 0 - Deprecated. Listen for `'close'` event instead.
+
 Emitted when the request has been aborted.
 
 ### Event: `'close'`
@@ -1986,8 +1995,11 @@ Indicates that the underlying connection was closed.
 ### `message.aborted`
 <!-- YAML
 added: v10.1.0
+deprecated: REPLACEME
 -->
 
+> Stability: 0 - Deprecated. Check `message.destroyed` from {stream.Readable}.
+
 * {boolean}
 
 The `message.aborted` property will be `true` if the request has
@@ -3221,6 +3233,7 @@ try {
 [`outgoingMessage.socket`]: #outgoingmessagesocket
 [`removeHeader(name)`]: #requestremoveheadername
 [`request.destroy()`]: #requestdestroyerror
+[`request.destroyed`]: #http_request_destroyed
 [`request.end()`]: #requestenddata-encoding-callback
 [`request.flushHeaders()`]: #requestflushheaders
 [`request.getHeader()`]: #requestgetheadername