FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

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

/ node Public

test: refactor common.expectsError - #31092

Closed
BridgeAR wants to merge 2 commits into
nodejs:masterfrom
BridgeAR:2019-12-25-refactor-common-expects-error
ConversationCommits (2)ChecksFiles changed
Closed

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

Conversation

BridgeAR commented Dec 25, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

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

test: refactor common.expectsError
f71f226 
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.
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

nodejs-github-bot commented Dec 25, 2019

Copy link
Copy Markdown
Collaborator

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

BridgeAR mentioned this pull request Dec 25, 2019
Closed

nodejs-github-bot commented Dec 25, 2019

Copy link
Copy Markdown
Collaborator

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

nodejs-github-bot commented Dec 27, 2019

Copy link
Copy Markdown
Collaborator

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

BridgeAR added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Dec 27, 2019
BridgeAR added a commit that referenced this pull request Dec 31, 2019
test: refactor common.expectsError
e038d6a 
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 commented Dec 31, 2019

Copy link
Copy Markdown
Member Author

Landed in e038d6a 🎉

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
Closed
2 tasks
Trott pushed a commit that referenced this pull request Jan 2, 2020
tools: remove prefer-common-expectserror lint rule
b8d2ba6 
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 added a commit that referenced this pull request Jan 3, 2020
test: refactor common.expectsError
efa0bd8 
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 pushed a commit that referenced this pull request Jan 3, 2020
tools: remove prefer-common-expectserror lint rule
c23bbc6 
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 mentioned this pull request Jan 7, 2020
Merged

targos commented Jan 14, 2020

Copy link
Copy Markdown
Member

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

BridgeAR deleted the 2019-12-25-refactor-common-expects-error branch January 20, 2020 12:08
MylesBorins pushed a commit to sxa/node that referenced this pull request Apr 1, 2020
test: refactor common.expectsError
7e1c8e6 
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>
MylesBorins pushed a commit that referenced this pull request Apr 1, 2020
test: refactor common.expectsError
d568efc 
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>
codebytere mentioned this pull request Apr 3, 2020
Merged
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
tools: remove prefer-common-expectserror lint rule
13fbe01 
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>
targos pushed a commit that referenced this pull request Apr 28, 2020
tools: remove prefer-common-expectserror lint rule
9cf9cb4 
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>
snyk-bot mentioned this pull request Jun 1, 2021
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
Trott Trott approved these changes
trivikr trivikr approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. test Issues and PRs related to the tests.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL