test: refactor common.expectsError by BridgeAR · Pull Request #31092 · nodejs/node

BridgeAR · 2019-12-25T19:22:30Z

This completely refactors the expectsError behavior: so far it's
almost identical to assert.throws(fn, object) in case it was used
with a function as first argument. It had a magical property check
that allowed to verify a functions type in case the type property
was set. This pattern is now completely removed and assert.throws()
should be used instead.

The main intent for common.expectsError() is to verify error cases
for callback based APIs. This is now more flexible by accepting all
validation possibilities that assert.throws() accepts. No
magical properties exist anymore. This reduces surprising behavior
for developers who are not used to the Node.js core code base.

The custom prefer-common-expectserror eslint rule comes obsolete with
this change and common us used significantly less frequent.

Refs: #30186 (comment)

Most changes are trivial and it should be possible to skim through
most of them.
Files that have been changed more "significantly":

test/parallel/test-crypto.js
test/common/index.js
test/common/README.md
test/parallel/test-eslint-prefer-common-expectserror.js (removed)
test/parallel/test-http-invalid-path-chars.js
test/parallel/test-net-better-error-messages-port-hostname.js
test/parallel/test-net-connect-immediate-finish.js
test/parallel/test-stream-writable-change-default-encoding.js

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

This completely refactors the `expectsError` behavior: so far it's almost identical to `assert.throws(fn, object)` in case it was used with a function as first argument. It had a magical property check that allowed to verify a functions `type` in case `type` was passed used in the validation object. This pattern is now completely removed and `assert.throws()` should be used instead. The main intent for `common.expectsError()` is to verify error cases for callback based APIs. This is now more flexible by accepting all validation possibilites that `assert.throws()` accepts as well. No magical properties exist anymore. This reduces surprising behavior for developers who are not used to the Node.js core code base. This has the side effect that `common` is used significantly less frequent.

nodejs-github-bot · 2019-12-25T19:27:11Z

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

nodejs-github-bot · 2019-12-25T23:49:59Z

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

nodejs-github-bot · 2019-12-27T01:15:49Z

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

This completely refactors the `expectsError` behavior: so far it's almost identical to `assert.throws(fn, object)` in case it was used with a function as first argument. It had a magical property check that allowed to verify a functions `type` in case `type` was passed used in the validation object. This pattern is now completely removed and `assert.throws()` should be used instead. The main intent for `common.expectsError()` is to verify error cases for callback based APIs. This is now more flexible by accepting all validation possibilites that `assert.throws()` accepts as well. No magical properties exist anymore. This reduces surprising behavior for developers who are not used to the Node.js core code base. This has the side effect that `common` is used significantly less frequent. PR-URL: #31092 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

BridgeAR · 2019-12-31T15:04:24Z

Landed in e038d6a 🎉

This custom ESLint rule is unused since nodejs#31092. This commit removes it.

This custom ESLint rule is unused since #31092. This commit removes it. PR-URL: #31147 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This completely refactors the `expectsError` behavior: so far it's almost identical to `assert.throws(fn, object)` in case it was used with a function as first argument. It had a magical property check that allowed to verify a functions `type` in case `type` was passed used in the validation object. This pattern is now completely removed and `assert.throws()` should be used instead. The main intent for `common.expectsError()` is to verify error cases for callback based APIs. This is now more flexible by accepting all validation possibilites that `assert.throws()` accepts as well. No magical properties exist anymore. This reduces surprising behavior for developers who are not used to the Node.js core code base. This has the side effect that `common` is used significantly less frequent. PR-URL: #31092 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

This custom ESLint rule is unused since #31092. This commit removes it. PR-URL: #31147 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

targos · 2020-01-14T13:11:08Z

This needs a backport or other previous PRs to be backported in order to land on v12.x-staging.

This completely refactors the `expectsError` behavior: so far it's almost identical to `assert.throws(fn, object)` in case it was used with a function as first argument. It had a magical property check that allowed to verify a functions `type` in case `type` was passed used in the validation object. This pattern is now completely removed and `assert.throws()` should be used instead. The main intent for `common.expectsError()` is to verify error cases for callback based APIs. This is now more flexible by accepting all validation possibilites that `assert.throws()` accepts as well. No magical properties exist anymore. This reduces surprising behavior for developers who are not used to the Node.js core code base. This has the side effect that `common` is used significantly less frequent. Backport-PR-URL: nodejs#31449 PR-URL: nodejs#31092 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

This completely refactors the `expectsError` behavior: so far it's almost identical to `assert.throws(fn, object)` in case it was used with a function as first argument. It had a magical property check that allowed to verify a functions `type` in case `type` was passed used in the validation object. This pattern is now completely removed and `assert.throws()` should be used instead. The main intent for `common.expectsError()` is to verify error cases for callback based APIs. This is now more flexible by accepting all validation possibilites that `assert.throws()` accepts as well. No magical properties exist anymore. This reduces surprising behavior for developers who are not used to the Node.js core code base. This has the side effect that `common` is used significantly less frequent. Backport-PR-URL: #31449 PR-URL: #31092 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

This custom ESLint rule is unused since nodejs#31092. This commit removes it. PR-URL: nodejs#31147 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

This custom ESLint rule is unused since #31092. This commit removes it. PR-URL: #31147 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

BridgeAR requested a review from Trott December 25, 2019 19:22

nodejs-github-bot added addons Issues and PRs related to native addons. async_hooks Issues and PRs related to the async hooks subsystem. test Issues and PRs related to the tests. labels Dec 25, 2019

BridgeAR removed addons Issues and PRs related to native addons. async_hooks Issues and PRs related to the async hooks subsystem. labels Dec 25, 2019

BridgeAR mentioned this pull request Dec 25, 2019

Replaced 'assert.throws' with 'common.expectsError' #30186

Closed

fixup: add missing doc reference

a419633

Trott approved these changes Dec 26, 2019

View reviewed changes

jasnell approved these changes Dec 26, 2019

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 27, 2019

trivikr approved these changes Dec 29, 2019

View reviewed changes

BridgeAR closed this Dec 31, 2019

cjihrig added a commit to cjihrig/node that referenced this pull request Dec 31, 2019

tools: remove prefer-common-expectserror lint rule

3ac79a0

This custom ESLint rule is unused since nodejs#31092. This commit removes it.

cjihrig mentioned this pull request Dec 31, 2019

tools: remove prefer-common-expectserror lint rule #31147

Closed

2 tasks

BridgeAR mentioned this pull request Jan 7, 2020

v13.6.0 proposal #31238

Merged

targos added the backport-requested-v12.x label Jan 14, 2020

BridgeAR deleted the 2019-12-25-refactor-common-expects-error branch January 20, 2020 12:08

BridgeAR added the backport-open-v12.x label Jan 22, 2020

MylesBorins added backported-to-v12.x and removed backport-open-v12.x labels Apr 3, 2020

codebytere mentioned this pull request Apr 3, 2020

v12.16.2 proposal #32313

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: refactor common.expectsError#31092

test: refactor common.expectsError#31092
BridgeAR wants to merge 2 commits intonodejs:masterfrom
BridgeAR:2019-12-25-refactor-common-expects-error

BridgeAR commented Dec 25, 2019 •

edited

Loading

Uh oh!

nodejs-github-bot commented Dec 25, 2019

Uh oh!

nodejs-github-bot commented Dec 25, 2019

Uh oh!

nodejs-github-bot commented Dec 27, 2019

Uh oh!

BridgeAR commented Dec 31, 2019

Uh oh!

targos commented Jan 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

BridgeAR commented Dec 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

nodejs-github-bot commented Dec 25, 2019

Uh oh!

nodejs-github-bot commented Dec 25, 2019

Uh oh!

nodejs-github-bot commented Dec 27, 2019

Uh oh!

BridgeAR commented Dec 31, 2019

Uh oh!

targos commented Jan 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

BridgeAR commented Dec 25, 2019 •

edited

Loading