micro/errors/errors.go

225 lines
5.3 KiB
Go
Raw Normal View History

// Package errors provides a way to return detailed information
// for an RPC request error. The error is normally JSON encoded.
package errors // import "go.unistack.org/micro/v3/errors"
2015-01-14 02:31:27 +03:00
import (
"encoding/json"
"fmt"
2015-01-14 02:31:27 +03:00
"net/http"
)
var (
// ErrBadRequest returns then requests contains invalid data
ErrBadRequest = &Error{Code: 400}
// ErrUnauthorized returns then user have unauthorized call
ErrUnauthorized = &Error{Code: 401}
// ErrForbidden returns then user have not access the resource
ErrForbidden = &Error{Code: 403}
// ErrNotFound returns then user specify invalid endpoint
ErrNotFound = &Error{Code: 404}
// ErrMethodNotAllowed returns then user try to get invalid method
ErrMethodNotAllowed = &Error{Code: 405}
// ErrTimeout returns then timeout exceeded
ErrTimeout = &Error{Code: 408}
// ErrConflict returns then request create duplicate resource
ErrConflict = &Error{Code: 409}
// ErrInternalServerError returns then server cant process request because of internal error
ErrInternalServerError = &Error{Code: 500}
// ErNotImplemented returns then server does not have desired endpoint method
ErNotImplemented = &Error{Code: 501}
// ErrBadGateway returns then server cant process request
ErrBadGateway = &Error{Code: 502}
// ErrServiceUnavailable returns then service unavailable
ErrServiceUnavailable = &Error{Code: 503}
// ErrGatewayTimeout returns then server have long time to process request
ErrGatewayTimeout = &Error{Code: 504}
)
// Error type
type Error struct {
// ID holds error id or service, usually someting like my_service or id
ID string
// Detail holds some useful details about error
Detail string
// Status usually holds text of http status
Status string
// Code holds error code
Code int32
}
2015-01-14 02:31:27 +03:00
// Error satisfies error interface
2015-01-14 02:31:27 +03:00
func (e *Error) Error() string {
b, _ := json.Marshal(e)
return string(b)
}
// New generates a custom error
2015-01-14 02:31:27 +03:00
func New(id, detail string, code int32) error {
return &Error{
ID: id,
2015-01-14 02:31:27 +03:00
Code: code,
Detail: detail,
Status: http.StatusText(int(code)),
}
}
// Parse tries to parse a JSON string into an error. If that
// fails, it will set the given string as the error detail.
2015-01-14 02:31:27 +03:00
func Parse(err string) *Error {
e := new(Error)
errr := json.Unmarshal([]byte(err), e)
2015-01-14 02:31:27 +03:00
if errr != nil {
e.Detail = err
}
return e
}
// BadRequest generates a 400 error.
func BadRequest(id, format string, a ...interface{}) error {
2015-01-14 02:31:27 +03:00
return &Error{
ID: id,
2015-01-14 02:31:27 +03:00
Code: 400,
Detail: fmt.Sprintf(format, a...),
2015-01-14 02:31:27 +03:00
Status: http.StatusText(400),
}
}
// Unauthorized generates a 401 error.
func Unauthorized(id, format string, a ...interface{}) error {
2015-01-14 02:31:27 +03:00
return &Error{
ID: id,
2015-01-14 02:31:27 +03:00
Code: 401,
Detail: fmt.Sprintf(format, a...),
2015-01-14 02:31:27 +03:00
Status: http.StatusText(401),
}
}
// Forbidden generates a 403 error.
func Forbidden(id, format string, a ...interface{}) error {
2015-01-14 02:31:27 +03:00
return &Error{
ID: id,
2015-01-14 02:31:27 +03:00
Code: 403,
Detail: fmt.Sprintf(format, a...),
2015-01-14 02:31:27 +03:00
Status: http.StatusText(403),
}
}
// NotFound generates a 404 error.
func NotFound(id, format string, a ...interface{}) error {
2015-01-14 02:31:27 +03:00
return &Error{
ID: id,
2015-01-14 02:31:27 +03:00
Code: 404,
Detail: fmt.Sprintf(format, a...),
2015-01-14 02:31:27 +03:00
Status: http.StatusText(404),
}
}
// MethodNotAllowed generates a 405 error.
func MethodNotAllowed(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 405,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(405),
}
}
2018-11-25 12:41:28 +03:00
// Timeout generates a 408 error.
func Timeout(id, format string, a ...interface{}) error {
2015-01-14 02:31:27 +03:00
return &Error{
ID: id,
2018-11-25 12:41:28 +03:00
Code: 408,
Detail: fmt.Sprintf(format, a...),
2018-11-25 12:41:28 +03:00
Status: http.StatusText(408),
2015-01-14 02:31:27 +03:00
}
}
// Conflict generates a 409 error.
func Conflict(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 409,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(409),
}
}
2018-11-25 12:41:28 +03:00
// InternalServerError generates a 500 error.
func InternalServerError(id, format string, a ...interface{}) error {
return &Error{
ID: id,
2018-11-25 12:41:28 +03:00
Code: 500,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(500),
}
}
// NotImplemented generates a 501 error
func NotImplemented(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 501,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(501),
}
}
// BadGateway generates a 502 error
func BadGateway(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 502,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(502),
}
}
// ServiceUnavailable generates a 503 error
func ServiceUnavailable(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 503,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(503),
}
}
// GatewayTimeout generates a 504 error
func GatewayTimeout(id, format string, a ...interface{}) error {
return &Error{
ID: id,
Code: 504,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(504),
}
}
// Equal tries to compare errors
func Equal(err1 error, err2 error) bool {
verr1, ok1 := err1.(*Error)
verr2, ok2 := err2.(*Error)
if ok1 != ok2 {
return false
}
if !ok1 {
return err1 == err2
}
if verr1.Code != verr2.Code {
return false
}
return true
}
// FromError try to convert go error to *Error
func FromError(err error) *Error {
if verr, ok := err.(*Error); ok && verr != nil {
return verr
}
return Parse(err.Error())
}