feat: Add WithStack to the errors package #870
Merged
Conversation
This file contains 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
fredcarle
changed the title
Codecov Report
@@ Coverage Diff @@
## develop #870 +/- ##
===========================================
+ Coverage 59.81% 59.82% +0.01%
===========================================
Files 157 157
Lines 17401 17403 +2
===========================================
+ Hits 10408 10412 +4
+ Misses 6056 6055 -1
+ Partials 937 936 -1
|
fredcarle
added
feature
AndrewSisley
approved these changes
Oct 5, 2022
fredcarle
commented
Oct 5, 2022
| func WithStack(err error) error { | ||
| return withStackTrace(err.Error()) | ||
| } | ||
|
|
There was a problem hiding this comment.
I guess we could have keyvals here as well.
There was a problem hiding this comment.
func WithKeyVals(...)?
There was a problem hiding this comment.
no I mean
func WithStack(err error, keyvals ...KV) error {
return withStackTrace(err.Error(), keyvals...)
}There was a problem hiding this comment.
just to be consistent with the other functions
There was a problem hiding this comment.
This way if you want to append keyVals you have to also add a stackTrace - if you add func WithKeyVals(...), you get both options (keyvals noStacktrace, keyvals with stacttrace). Follows the builder pattern and scales better if we end up adding more options. The only other funcs I could see were constructors, which IMO are different to these funcs and thus have no need for extra 'consistency' params.
Cost is super minimal though, and I guess you could add func WithKeyVals(keyvals ...KV) anyway
There was a problem hiding this comment.
Stacktrace are always added. WithKeyvals(...) would have to be a method on the defra error type which would only work it the error passed to the function is a defra error. Not sure there is any advantage to doing that.
There was a problem hiding this comment.
Ah true, as you'd be then going through the hassle of amending an external error, yet leaving it in an inconsistent state to defra errors. Cheers!
Benchmark ResultsSummary
✅ See Better Results...
❌ See Worse Results...
✨ See Unchanged Results...
🐋 See Full Results...
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
idea: use build tag to test this file without |
It can still be tested with |
IMO testing with race is super important here - would be really bad to add a race condition in here. I think this was discussed in the original PR that added the errors package, one option was to break out extra tests to a separate file that doesnt run with |
Benchmark ResultsSummary
✅ See Better Results...
❌ See Worse Results...
✨ See Unchanged Results...
🐋 See Full Results...
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fredcarle
force-pushed
the
fredcarle/feat/error-with-stacktrace
branch
from
655d6d3 to
47ec3e7
Compare
Benchmark ResultsSummary
✅ See Better Results...
❌ See Worse Results...
✨ See Unchanged Results...
🐋 See Full Results...
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shahzadlone
pushed a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
Relevant issue(s) Resolves sourcenetwork#869 Description This PR adds a WithStack function to the errors package to be able to add a stacktrace to a returned error without adding a message. It also fixes the TestErrorIs unit test.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant issue(s)
Resolves #869
Description
This PR adds a
WithStackfunction to the errors package to be able to add a stacktrace to a returned error without adding a message. It also fixes theTestErrorIsunit test.How has this been tested?
Unit test
Specify the platform(s) on which this was tested: