-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Move ErrorCode logic to new errcode package #548
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| package errcode | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| ) | ||
|
|
||
| // ErrorCoder is the base interface for ErrorCode and Error allowing | ||
| // users of each to just call ErrorCode to get the real ID of each | ||
| type ErrorCoder interface { | ||
| ErrorCode() ErrorCode | ||
| } | ||
|
|
||
| // ErrorCode represents the error type. The errors are serialized via strings | ||
| // and the integer format may change and should *never* be exported. | ||
| type ErrorCode int | ||
|
|
||
| // ErrorCode just returns itself | ||
| func (ec ErrorCode) ErrorCode() ErrorCode { | ||
| return ec | ||
| } | ||
|
|
||
| // Error returns the ID/Value | ||
| func (ec ErrorCode) Error() string { | ||
| return ec.Descriptor().Value | ||
| } | ||
|
|
||
| // Descriptor returns the descriptor for the error code. | ||
| func (ec ErrorCode) Descriptor() ErrorDescriptor { | ||
| d, ok := errorCodeToDescriptors[ec] | ||
|
|
||
| if !ok { | ||
| return ErrorCodeUnknown.Descriptor() | ||
| } | ||
|
|
||
| return d | ||
| } | ||
|
|
||
| // String returns the canonical identifier for this error code. | ||
| func (ec ErrorCode) String() string { | ||
| return ec.Descriptor().Value | ||
| } | ||
|
|
||
| // Message returned the human-readable error message for this error code. | ||
| func (ec ErrorCode) Message() string { | ||
| return ec.Descriptor().Message | ||
| } | ||
|
|
||
| // MarshalText encodes the receiver into UTF-8-encoded text and returns the | ||
| // result. | ||
| func (ec ErrorCode) MarshalText() (text []byte, err error) { | ||
| return []byte(ec.String()), nil | ||
| } | ||
|
|
||
| // UnmarshalText decodes the form generated by MarshalText. | ||
| func (ec *ErrorCode) UnmarshalText(text []byte) error { | ||
| desc, ok := idToDescriptors[string(text)] | ||
|
|
||
| if !ok { | ||
| desc = ErrorCodeUnknown.Descriptor() | ||
| } | ||
|
|
||
| *ec = desc.Code | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // WithDetail creates a new Error struct based on the passed-in info and | ||
| // set the Detail property appropriately | ||
| func (ec ErrorCode) WithDetail(detail interface{}) Error { | ||
| if err, ok := detail.(error); ok { | ||
| detail = err.Error() | ||
| } | ||
|
|
||
| return Error{ | ||
| Code: ec, | ||
| Detail: detail, | ||
| } | ||
| } | ||
|
|
||
| // Error provides a wrapper around ErrorCode with extra Details provided. | ||
| type Error struct { | ||
| Code ErrorCode `json:"code"` | ||
| Detail interface{} `json:"detail,omitempty"` | ||
| } | ||
|
|
||
| // ErrorCode returns the ID/Value of this Error | ||
| func (e Error) ErrorCode() ErrorCode { | ||
| return e.Code | ||
| } | ||
|
|
||
| // Error returns a human readable representation of the error. | ||
| func (e Error) Error() string { | ||
| return fmt.Sprintf("%s: %s", | ||
| strings.ToLower(strings.Replace(e.Code.String(), "_", " ", -1)), | ||
| e.Code.Message()) | ||
| } | ||
|
|
||
| // Message returned the human-readable error message for this Error | ||
| func (e Error) Message() string { | ||
| return e.Code.Message() | ||
| } | ||
|
|
||
| // ErrorDescriptor provides relevant information about a given error code. | ||
| type ErrorDescriptor struct { | ||
| // Code is the error code that this descriptor describes. | ||
| Code ErrorCode | ||
|
|
||
| // Value provides a unique, string key, often captilized with | ||
| // underscores, to identify the error code. This value is used as the | ||
| // keyed value when serializing api errors. | ||
| Value string | ||
|
|
||
| // Message is a short, human readable decription of the error condition | ||
| // included in API responses. | ||
| Message string | ||
|
|
||
| // Description provides a complete account of the errors purpose, suitable | ||
| // for use in documentation. | ||
| Description string | ||
|
|
||
| // HTTPStatusCode provides the http status code that is associated with | ||
| // this error condition. | ||
| HTTPStatusCode int | ||
| } | ||
|
|
||
| // ParseErrorCode returns the value by the string error code. | ||
| // `ErrorCodeUnknown` will be returned if the error is not known. | ||
| func ParseErrorCode(value string) ErrorCode { | ||
| ed, ok := idToDescriptors[value] | ||
| if ok { | ||
| return ed.Code | ||
| } | ||
|
|
||
| return ErrorCodeUnknown | ||
| } | ||
|
|
||
| // Errors provides the envelope for multiple errors and a few sugar methods | ||
| // for use within the application. | ||
| type Errors []error | ||
|
|
||
| func (errs Errors) Error() string { | ||
| switch len(errs) { | ||
| case 0: | ||
| return "<nil>" | ||
| case 1: | ||
| return errs[0].Error() | ||
| default: | ||
| msg := "errors:\n" | ||
| for _, err := range errs { | ||
| msg += err.Error() + "\n" | ||
| } | ||
| return msg | ||
| } | ||
| } | ||
|
|
||
| // Len returns the current number of errors. | ||
| func (errs Errors) Len() int { | ||
| return len(errs) | ||
| } | ||
|
|
||
| // jsonError extends Error with 'Message' so that we can include the | ||
| // error text, just in case the receiver of the JSON doesn't have this | ||
| // particular ErrorCode registered | ||
| type jsonError struct { | ||
| Code ErrorCode `json:"code"` | ||
| Message string `json:"message"` | ||
| Detail interface{} `json:"detail,omitempty"` | ||
| } | ||
|
|
||
| // MarshalJSON converts slice of error, ErrorCode or Error into a | ||
| // slice of Error - then serializes | ||
| func (errs Errors) MarshalJSON() ([]byte, error) { | ||
| var tmpErrs []jsonError | ||
|
|
||
| for _, daErr := range errs { | ||
| var err Error | ||
|
|
||
| switch daErr.(type) { | ||
| case ErrorCode: | ||
| err = daErr.(ErrorCode).WithDetail(nil) | ||
| case Error: | ||
| err = daErr.(Error) | ||
| default: | ||
| err = ErrorCodeUnknown.WithDetail(daErr) | ||
|
|
||
| } | ||
|
|
||
| tmpErrs = append(tmpErrs, jsonError{ | ||
| Code: err.Code, | ||
| Message: err.Message(), | ||
| Detail: err.Detail, | ||
| }) | ||
| } | ||
|
|
||
| return json.Marshal(tmpErrs) | ||
| } | ||
|
|
||
| // UnmarshalJSON deserializes []Error and then converts it into slice of | ||
| // Error or ErrorCode | ||
| func (errs *Errors) UnmarshalJSON(data []byte) error { | ||
| var tmpErrs []jsonError | ||
|
|
||
| if err := json.Unmarshal(data, &tmpErrs); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var newErrs Errors | ||
| for _, daErr := range tmpErrs { | ||
| if daErr.Detail == nil { | ||
| // Error's w/o details get converted to ErrorCode | ||
| newErrs = append(newErrs, daErr.Code) | ||
| } else { | ||
| // Error's w/ details are untouched | ||
| newErrs = append(newErrs, Error{ | ||
| Code: daErr.Code, | ||
| Detail: daErr.Detail, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| *errs = newErrs | ||
| return nil | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ErrorCodeis missingErrorandErrorCodemethod.Errormakes it implementerrorandErrorCodeimplementsErrorCoderinterface: