Skip to content

assert: support custom errors#15304

Closed
geek wants to merge 1 commit intonodejs:masterfrom
geek:assert
Closed

assert: support custom errors#15304
geek wants to merge 1 commit intonodejs:masterfrom
geek:assert

Conversation

@geek
Copy link
Member

@geek geek commented Sep 10, 2017

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
Affected core subsystem(s)

assert - support a way to provide a custom Error type for assertions. This will help make assert more useful for validating types and ranges.

@geek geek requested a review from cjihrig September 10, 2017 01:47
@nodejs-github-bot nodejs-github-bot added the assert Issues and PRs related to the assert subsystem. label Sep 10, 2017
cjihrig
cjihrig approved these changes Sep 10, 2017
View reviewed changes
Copy link
Contributor

@cjihrig cjihrig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a few suggestions. I think this is a useful change (helping with code coverage in modules using assert, and improving error types).

doc/api/assert.md Outdated
Copy link
Contributor

@cjihrig cjihrig Sep 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

f -> If

test/parallel/test-assert.js Outdated
Copy link
Contributor

@cjihrig cjihrig Sep 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you store the RangeError in a variable, you can just assert that e equals it.

test/parallel/test-assert.js Outdated
Copy link
Contributor

@cjihrig cjihrig Sep 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For these tests involving try...catch, we don't know if the assertions were actually run. Can you add checks like these

vsemozhetbyt
vsemozhetbyt reviewed Sep 10, 2017
View reviewed changes
doc/api/assert.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Sep 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eq ual -> equal

@cjihrig cjihrig added the semver-major PRs that contain breaking changes and should be released in the next major version. label Sep 10, 2017
@geek
Copy link
Member Author

geek commented Sep 11, 2017

@cjihrig @vsemozhetbyt thanks for the feedback... updated!

BridgeAR
BridgeAR approved these changes Sep 11, 2017
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I like the idea a lot!
LGTM but I think it would be nice to use common.expectsError

test/parallel/test-assert.js
threw = true;
assert.ok(e instanceof RangeError, 'Incorrect error type thrown');
}
assert.ok(threw);
Copy link
Member

@BridgeAR BridgeAR Sep 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would actually be nice to use common.expectsError here. The test would be smaller in that case. You can check some other use cases as a reference.

Copy link
Member Author

@geek geek Sep 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the suggestion. I tried expectsError, but for this simple case it didn't make the code any cleaner/shorter/simpler. I'm keeping it as is for now.

@cjihrig
Copy link
Contributor

cjihrig commented Sep 12, 2017

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

@cjihrig
Copy link
Contributor

cjihrig commented Sep 12, 2017

Landed in e13d1df. Thanks!

@cjihrig cjihrig closed this Sep 12, 2017
cjihrig pushed a commit that referenced this pull request Sep 12, 2017
@geek @cjihrig
assert: support custom errors
e13d1df 
This commit adds special handling of Error instances when passed
as the message argument to assert functions. With this commit,
if an Error is passed as the message, then that Error is thrown
instead of an AssertionError.

PR-URL: #15304
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@geek geek deleted the assert branch September 12, 2017 19:06
@refack
Copy link
Contributor

refack commented Sep 12, 2017

I like the concept of this PR, but I think it was rushed.

  1. semver-majors need two TSC approvals (this one has only @cjihrig's)
  2. expectsError conceptualy should be used to validate internal/errors since theoretically it should assert that an err.code exists.
  3. The assert module, although it has been unfrozen, should get some extra attention, since it's a fundamental language construct (and we might want to hoist it into spec).

(I'm not saying it should be reverted, but I do suggest we tweak it a bit before 9.0.0)

@cjihrig
Copy link
Contributor

cjihrig commented Sep 12, 2017

@refack, definitely my bad on item 1. I apologize for that.

Regarding item 2, that is how the surrounding tests in that file are written, so I don't necessarily think that is wrong. Maybe that could be a good first contribution.

I don't really have any comment on item 3 other than the PR being open sufficiently long enough.

I do suggest we tweak it a bit before 9.0.0

Do you want to submit a follow up PR?

Again, my apologies for item 1.

@refack
Copy link
Contributor

refack commented Sep 12, 2017

I do suggest we tweak it a bit before 9.0.0
Do you want to submit a follow up PR?

I totally agree there's nothing bad in this PR (on the contrary, I see it's usufulness).
I'll try to either open a PR or a first-contribution issue.

addaleax pushed a commit to addaleax/node that referenced this pull request Sep 13, 2017
@geek @addaleax
assert: support custom errors
2a206e8 
This commit adds special handling of Error instances when passed
as the message argument to assert functions. With this commit,
if an Error is passed as the message, then that Error is thrown
instead of an AssertionError.

PR-URL: nodejs#15304
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@jasnell jasnell mentioned this pull request Oct 30, 2017
Merged
@azu azu mentioned this pull request Nov 1, 2017
Open
@bradennapier bradennapier mentioned this pull request Nov 3, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cjihrig cjihrig cjihrig approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

+1 more reviewer

@vsemozhetbyt vsemozhetbyt vsemozhetbyt left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

assert Issues and PRs related to the assert subsystem. semver-major PRs that contain breaking changes and should be released in the next major version.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@geek @cjihrig @refack @BridgeAR @vsemozhetbyt @nodejs-github-bot