http: doc deprecate abort and improve docs #32807

ronag · 2020-04-13T09:04:11Z

Doc deprecates ClientRequest.abort in favor of
ClientRequest.destroy. Also improves event order
documentation for abort and destroy.

Refs: #32225

Please note that destroy() and abort() slightly differ in the
case of ... called before a socket is assigned .... I'm not sure where we landed in regards to whether or not to address this difference in #32225. This PR is based on the current (master) state of things.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

ronag · 2020-04-13T09:05:07Z

doc/api/http.md

+
+* (`req.abort()` called here)
+* `'abort'`
+* `'close'`


This req.abort() variant was previously not documented.

ronag · 2020-04-13T09:05:33Z

doc/api/http.md

+* (`req.destroy()` called here)
+* `'error'` with an error with message `'Error: socket hang up'` and code
+  `'ECONNRESET'`
+* `'close'`


req.destroy() behaves different than req.abort() in this case

ronag · 2020-04-13T09:06:42Z

@nodejs/http

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: nodejs#32225

ronag · 2020-04-13T09:25:53Z

@himself65: What does the 👀 mean? 😄

himself65 · 2020-04-13T09:31:27Z

@himself65: What does the 👀 mean? 😄

I noticed and still reviewing.😀

mcollina

lgtm

ronag · 2020-04-13T10:33:01Z

Does this require a semver-major label?

nodejs-github-bot · 2020-04-13T10:33:41Z

CI: https://ci.nodejs.org/job/node-test-pull-request/30679/

mcollina · 2020-04-13T10:34:49Z

Yes

ronag · 2020-04-13T11:08:32Z

Added missing docs for request.destroyed and request.destroy(). If this doesn't land on 14.x I will open a backport PR without the deprecation changes.

doc/api/http.md

Co-Authored-By: Anna Henningsen <[email protected]>

nodejs-github-bot · 2020-04-13T13:18:58Z

CI: https://ci.nodejs.org/job/node-test-pull-request/30684/

ronag · 2020-04-26T21:51:49Z

Landed in 5ee1e31

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: #32225 PR-URL: #32807 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: #32225 PR-URL: #32807 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: #32225 PR-URL: #32807 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: #32225 PR-URL: #32807 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Zeyu Yang <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

Notable changes: - deps: upgrade openssl sources to 1.1.1g (Hassaan Pasha) [#32971](#32971) - doc: add juanarbol as collaborator (Juan José Arboleda) [#32906](#32906) - http: doc deprecate abort and improve docs (Robert Nagy) [#32807](#32807) - module: do not warn when accessing `__esModule` of unfinished exports (Anna Henningsen) [#33048](#33048) - n-api: detect deadlocks in thread-safe function (Gabriel Schulhof) [#32860](#32860) - src: deprecate embedder APIs with replacements (Anna Henningsen) [#32858](#32858) - stream: - don't emit end after close (Robert Nagy) [#33076](#33076) - don't wait for close on legacy streams (Robert Nagy) [#33058](#33058) - pipeline should only destroy un-finished streams (Robert Nagy) [#32968](#32968) PR-URL: #33103

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

Notable changes: - deps: upgrade openssl sources to 1.1.1g (Hassaan Pasha) [#32971](#32971) - doc: add juanarbol as collaborator (Juan José Arboleda) [#32906](#32906) - http: doc deprecate abort and improve docs (Robert Nagy) [#32807](#32807) - module: do not warn when accessing `__esModule` of unfinished exports (Anna Henningsen) [#33048](#33048) - n-api: detect deadlocks in thread-safe function (Gabriel Schulhof) [#32860](#32860) - src: deprecate embedder APIs with replacements (Anna Henningsen) [#32858](#32858) - stream: - don't emit end after close (Robert Nagy) [#33076](#33076) - don't wait for close on legacy streams (Robert Nagy) [#33058](#33058) - pipeline should only destroy un-finished streams (Robert Nagy) [#32968](#32968) - vm: add importModuleDynamically option to compileFunction (Gus Caplan) [#32985](#32985) PR-URL: #33103

notable change: - node: use `request.destroy()|request.destroyed` instead of `request.abort()|request.aborted` follow: nodejs/node#32807 - package update

notable change: - node: use `request.destroy()|request.destroyed` instead of `request.abort()|request.aborted` follow: nodejs/node#32807 - add: `extractTgzOrTarAsync` to `module/Software/7z` - script explorer compress code - package update

Notable changes: - deps: upgrade openssl sources to 1.1.1g (Hassaan Pasha) [#32971](#32971) - doc: add juanarbol as collaborator (Juan José Arboleda) [#32906](#32906) - http: doc deprecate abort and improve docs (Robert Nagy) [#32807](#32807) - module: do not warn when accessing `__esModule` of unfinished exports (Anna Henningsen) [#33048](#33048) - n-api: detect deadlocks in thread-safe function (Gabriel Schulhof) [#32860](#32860) - src: deprecate embedder APIs with replacements (Anna Henningsen) [#32858](#32858) - stream: - don't emit end after close (Robert Nagy) [#33076](#33076) - don't wait for close on legacy streams (Robert Nagy) [#33058](#33058) - pipeline should only destroy un-finished streams (Robert Nagy) [#32968](#32968) - vm: add importModuleDynamically option to compileFunction (Gus Caplan) [#32985](#32985) PR-URL: #33103

notable change: - deprecated: `objectDeleteUndefined` from `common/immutable/Object` - deprecated: node: `requestAsync` from `node/net` - deprecated: node: `urlString` option in `createWebSocketClient` from `node/server/WebSocket/WebSocketClient` - break: sort `Async*` code: - use `AsyncFuncQueue` instead of `AsyncTaskQueue` (previous one) - use `AsyncLane` with `Async*Queue` support instead of `AsyncTaskLane` (previous one) - use `AsyncTaskQueue` instead of `AsyncTaskRunner` - use `AsyncTaskQueue + AsyncLane` instead of `AsyncTaskRunnerCluster` - break: use `prettyStringifyTreeNode` instead of `prettyStringifyTree` - break: node: mass code sort for `node/file/`: - drop `node/file/function`, use `fs` directly - default to `getPathLstat` so most symlink will be kept - sort `node/file/Directory`: - use `getDirInfoList` instead of `getDirectorySubInfoList` - use `getDirInfoTree` instead of `getDirectoryInfoTree` - use `walkDirInfoTreeAsync` instead of `walkDirectoryInfoTree` - use `walkDirInfoTreeBottomUpAsync` instead of `walkDirectoryInfoTreeBottomUp` - use `copyDirInfoTree` instead of `copyDirectoryInfoTree` - use `renameDirInfoTree` instead of `renameDirectoryInfoTree` - use `deleteDirInfoTree` instead of `deleteDirectoryInfoTree` - break: node: mass code sort in `node/data/Stream`: - use `readableStreamToBufferAsync` instead of `receiveBufferAsync` from `node/data/Buffer` - use `writeBufferToStreamAsync` instead of `sendBufferAsync` from `node/data/Buffer` - use `waitStreamStopAsync(setupStreamPipe( ... ))` instead of `pipeStreamAsync` - use `readlineOfStreamAsync` instead of `createReadlineFromStreamAsync` - break: node: use `getDefaultOpenCommandList` instead of `getDefaultOpen` - break: node: use `request.destroy()|request.destroyed` instead of `request.abort()|request.aborted` follow: nodejs/node#32807 - break: node: use `response.writableEnded` (need `nodejs@>=12.9`) - break: browser: use `onProgressUpload/onProgressDownload` instead of `onUploadProgress/onDownloadProgress` for `fetchLikeRequest` - fix: ci: git CRLF config & longer test timeout - fix: ci: patch `libgbm1` for `puppeteer@3`, check: puppeteer/puppeteer#5674 - fix: better handle WebSocket `doUpgradeSocket` error - fix: sanity test for `nodejs@14` - fix: flaky test `fetchLikeRequest() option: timeout` in `net.test.js` - fix: code lint for `eslint-config-almost-standard-v14` - add: `onProgressUpload/onProgressDownload` for both `fetchLikeRequest` - add: `AsyncTask` and `AsyncTaskQueue` - add: `catchPromise` to `common/error` - add: `.sanity.test` for some peace of mind - add: `typeNameOf` to `common/format` - add: tree-like structure support in `common/data/Tree` - add: node: support pass `ReadableStream` as `body` to `fetchLikeRequest` - add: node: `isReadableStream/isWritableStream` - add: node: `ResolveCommand` moved from `@dr-js/node` - add: node: TLS server session ticket rotation - add: browser: `browser/net.test.js` - add: bin: percent for mode `fetch` - ci: update `.gitignore` & `.github/workflows/ci-test.yml` - better `error.stack` for `withTimeoutPromise|withTimeoutAsync` - simplify `createInsideOutPromise` code - sort test file naming - package update notable change from `0.2.1-dev.*`: - add: `isRegExp|regexp` in `common/check|verify` - add: `createMarkReplacer` to `common/string` - add: node: `closeAsync|readAsync|writeAsync|readlinkAsync|symlinkAsync` to `node/file/function` - add: node: `resolvePath` to `createOptionGetter` in `node/module/Option/preset` - fix: node: leaked `error` event in `createReadlineFromStreamAsync` - node: update `buffer.readUInt*()` usage for removed `noAssert` since `nodejs@10` - node: sort `node/module/Option/preset` code - sort build script - package update

notable change: - deprecated: use `PATH_RENAME` instead of `PATH_MOVE` - deprecated: `fileTLS*` option of `configureServerPack` from `module/ServerPack`, use `TLSSNIConfig|TLSDHParam` instead - deprecated: bin: `file-TLS-*` option, use `TLS-SNI-config|TLS-dhparam` instead - break: use `ResolveCommand` from `@dr-js/core` - break: use `request.destroy()|request.destroyed` instead of `request.abort()|request.aborted` follow: nodejs/node#32807 - break: drop `TaskAction` module and `TaskRunner` feature to allow later to add improved version - break: bin: merge `compress/extract` to use `module/Software/archive` - break: bin: use `TLS-SNI-config` instead of `https` to enable https - add: `REGEXP_AUTO|REGEXP_T7Z|REGEXP_TXZ` to `module/Software/archive` - add: `REGEXP_NPM_TAR|extractPackageJson` to `module/Software/npmTar` - add: `toPackageTgzName` to `module/Software/npm` - add: `AuthCommonOption` to `server/feature/Auth/option` to allow set `authKey` - add: `RuntimeDump` for getting runtime heap status & use `setupPackageSIGUSR2` - add: `module/Software/archive` and `module/Software/npmTar` - add: `module/TerminalStatusBar` - add: `module/TerminalColor` & `module/Software/npm` from `@dr-js/dev` - add: `createCommandWrap` for `module/Software/7z|git|tar` to allow reset command - add: feature: `WebSocketTunnelDev` (under DEV) - fix: code lint for `eslint-config-almost-standard-v14` - ci: run on all 3 platform & test `nodejs@14` - script sort - package update notable change from `0.2.1-dev.*`: - add: `module/FsPack` - add: `module/ResolveCommand` - add: `module/RunDetached` - add: `resolveCommand|resolveCommandAsync` and `pingRaceUrlList|pingStatUrlList` - add: explorer: add route `/timestamp` for server time & ping - add: bin: mode `ping-race|ping-stat` & option `debug-route` - fix: `TLSSNIConfig` value normalize in `ServerPack` - sort script - package update

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 13, 2020

ronag commented Apr 13, 2020

View reviewed changes

ronag requested review from mcollina, bnoordhuis and himself65 April 13, 2020 09:06

http: doc deprecate abort and improve docs

69a8af0

Doc deprecates ClientRequest.abort in favor of ClientRequest.destroy. Also improves event order documentation for abort and destroy. Refs: nodejs#32225

ronag force-pushed the http-docs-deprecate-abort branch from e291307 to 69a8af0 Compare April 13, 2020 09:08

fixup: lint

00f23ee

mcollina approved these changes Apr 13, 2020

View reviewed changes

mcollina requested review from mcollina and a team April 13, 2020 10:23

ronag added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 13, 2020

mcollina added the semver-major PRs that contain breaking changes and should be released in the next major version. label Apr 13, 2020

himself65 approved these changes Apr 13, 2020

View reviewed changes

ronag force-pushed the http-docs-deprecate-abort branch from 7dfe4c7 to 78553bd Compare April 13, 2020 11:06

fixup: docs

083ad2e

ronag force-pushed the http-docs-deprecate-abort branch from 78553bd to 083ad2e Compare April 13, 2020 11:08

addaleax approved these changes Apr 13, 2020

View reviewed changes

doc/api/http.md Outdated Show resolved Hide resolved

doc/api/http.md Outdated Show resolved Hide resolved

ronag and others added 2 commits April 13, 2020 15:16

Apply suggestions from code review

08e542a

Co-Authored-By: Anna Henningsen <[email protected]>

fixup: further details

72b2694

addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 13, 2020

ronag closed this Apr 26, 2020

BethGriggs mentioned this pull request Apr 27, 2020

v14.1.0 proposal #33103

Merged

richardlau mentioned this pull request Apr 27, 2020

doc: assign missing deprecation code #33109

Closed

3 tasks

addaleax pushed a commit that referenced this pull request Apr 27, 2020

doc: assign missing deprecation code

76ba950

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

BridgeAR added the backport-blocked-v13.x label Apr 28, 2020

BethGriggs pushed a commit that referenced this pull request Apr 28, 2020

doc: assign missing deprecation code

00c3ed9

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

BridgeAR pushed a commit that referenced this pull request Apr 28, 2020

doc: assign missing deprecation code

fc9191a

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

BridgeAR pushed a commit that referenced this pull request Apr 28, 2020

doc: assign missing deprecation code

386d158

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

BridgeAR mentioned this pull request Apr 28, 2020

v13.14.0 proposal #33122

Merged

BethGriggs pushed a commit that referenced this pull request Apr 28, 2020

doc: assign missing deprecation code

fa5848e

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

BethGriggs pushed a commit that referenced this pull request Apr 28, 2020

doc: assign missing deprecation code

343c6ac

Signed-off-by: Richard Lau <[email protected]> PR-URL: #33109 Refs: #32807 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Beth Griggs <[email protected]>

dr-js added a commit to dr-js/dr-js that referenced this pull request Apr 29, 2020

@dr-js/[email protected]

3394803

notable change: - node: use `request.destroy()|request.destroyed` instead of `request.abort()|request.aborted` follow: nodejs/node#32807 - package update

targos added the dont-land-on-v12.x label May 7, 2020

aduh95 mentioned this pull request Oct 6, 2020

doc: fix deprecation history #35455

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http: doc deprecate abort and improve docs #32807

http: doc deprecate abort and improve docs #32807

ronag commented Apr 13, 2020 •

edited

Loading

ronag Apr 13, 2020 •

edited

Loading

ronag Apr 13, 2020

ronag commented Apr 13, 2020

ronag commented Apr 13, 2020 •

edited

Loading

himself65 commented Apr 13, 2020

mcollina left a comment

ronag commented Apr 13, 2020

nodejs-github-bot commented Apr 13, 2020

mcollina commented Apr 13, 2020

ronag commented Apr 13, 2020

nodejs-github-bot commented Apr 13, 2020

ronag commented Apr 26, 2020

http: doc deprecate abort and improve docs #32807

http: doc deprecate abort and improve docs #32807

Conversation

ronag commented Apr 13, 2020 • edited Loading

Checklist

ronag Apr 13, 2020 • edited Loading

Choose a reason for hiding this comment

ronag Apr 13, 2020

Choose a reason for hiding this comment

ronag commented Apr 13, 2020

ronag commented Apr 13, 2020 • edited Loading

himself65 commented Apr 13, 2020

mcollina left a comment

Choose a reason for hiding this comment

ronag commented Apr 13, 2020

nodejs-github-bot commented Apr 13, 2020

mcollina commented Apr 13, 2020

ronag commented Apr 13, 2020

nodejs-github-bot commented Apr 13, 2020

ronag commented Apr 26, 2020

ronag commented Apr 13, 2020 •

edited

Loading

ronag Apr 13, 2020 •

edited

Loading

ronag commented Apr 13, 2020 •

edited

Loading