Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[errors] Replace pkg/errors Fix #54 #59

Merged
merged 11 commits into from
Feb 25, 2018
Merged

[errors] Replace pkg/errors Fix #54 #59

merged 11 commits into from
Feb 25, 2018

Conversation

at15
Copy link
Member

@at15 at15 commented Feb 24, 2018 •
edited
Loading

  • survey
  • interface
    • stack is not that important .... and pkg/errors is using old API
    • multi error is pretty useful
    • we want to have machine readable types, so we can do something in post processing
      • i.e. show a colorful page with stack when developer is using browser ....
  • update errors package usage inside gommon

TODO in next PR

  • support cause
  • support print stack by implementing the fmt.Formatter interface
  • machine readable error types

@at15
[errors] Add survey for wrap and multierror
73da2be 
- #54
- hashicorp/errwrap supports get/check error by message or type and walk
  - which is more handy than just get the root cause
- hashicorp/go-multierror can faltten multierror when append
  - ErrOrNil, because nil pointer is not nil error
  - https://golang.org/doc/faq#nil_error Why is my nil error value not equal to nil?
- uber/multierr
  - [ ] has a atomic value to deal with copy?
  - is trying to integrate with zap
  - suggests return two value when append
at15 added 10 commits February 24, 2018 13:18
@at15
[errors] Add multi error and multi error safe
9c4c2d0 
- safe version is guarded by a mutex, and make a copy of errors when
`Errors` is called
- unsafe (default) version just `errs = append(errs, err)` and return
the underlying slice directly (no copy) when `Errors` is called
- flatten is supported, when append, check if it's a MultiErr interface
@at15
[generator] Add blank between package and header
0f60d4b 
- otherwise the `// Code generated ...` will be treated as package comment
  - this may be intended behavior for protobuf, but not for gommon in
most cases
- [doc] update the doc for most packages, most of them were blank
@at15
[erros] Add ErrorOrNil
512ed03
@at15
[errors] Return false if err in Append(err) is nil
9f32ae6 
- inspired by uber-go/multierr#21
@at15
[errors] Add fresh and wrapped error with stack
868bd42 
- [ ] FIXME: runtime.Frames can only be read once
@at15
[errors] use []runtime.Frame instead of *Frames
c5f53ad 
- when use *runtime.Frames, it can only be read once
- the drawback is, we many not always need the full frames
  - actually a lot of time the full stack is never printed ...
@at15
[errors] Use Stack instead of []runtime.Frame
56eab6d 
- when `Frames()` is not called, *runtime.Frames is not traversed
  - it should increase performance (in theory) ...
@at15
Replace pkg/errors -> gommon/errors
3f88597 
- since the methods are same, `Wrap` and `Wrapf`, most files only need
to change the import path
- all the `WithMessage` are replaced with `Wrap` because we check
existing stack before attach stack to error
@at15
[errors] Use MultiErr in noodle package
d6aae98 
- add `HasError` to avoid writing `ErrorOrNil != nil`
@at15
[doc] Update acknowledgement
9dd1c2c
@at15 at15 merged commit b950eeb into master Feb 25, 2018
@at15 at15 deleted the errors/init branch February 25, 2018 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
pkg/errors type/new-package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@at15