forked from micro/micro
-
Notifications
You must be signed in to change notification settings - Fork 1
/
errors.go
executable file
·211 lines (186 loc) · 5.16 KB
/
errors.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Original source: github.com/micro/go-micro/v3/errors/errors.go
// Package errors provides a way to return detailed information
// for an RPC request error. The error is normally JSON encoded.
package errors
import (
"encoding/json"
"fmt"
"net/http"
)
type Error struct {
RequestId string `json:"request_id,omitempty"`
Detail string `json:"detail,omitempty"`
Status string `json:"status,omitempty"`
Code int32 `json:"code,omitempty"`
Id string `json:"id,omitempty"`
}
func (e *Error) Error() string {
b, _ := json.Marshal(e)
return string(b)
}
// New generates a custom error.
func New(id, detail string, code int32) error {
return &Error{
Id: id,
Code: code,
Detail: detail,
Status: http.StatusText(int(code)),
}
}
// FromError try to convert go error to *Error
func FromError(err error) *Error {
if err == nil {
return nil
}
if verr, ok := err.(*Error); ok && verr != nil {
return verr
}
return Parse(err.Error())
}
// Parse tries to parse a JSON string into an error. If that
// fails, it will set the given string as the error detail.
func Parse(err string, id ...string) *Error {
e := new(Error)
if e1 := json.Unmarshal([]byte(err), e); e1 != nil {
e.Detail = err
}
if len(id) > 0 {
e.RequestId = id[0]
}
return e
}
// BadRequest generates a 400 error.
func BadRequest(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusBadRequest,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusBadRequest),
}
}
// Unauthorized generates a 401 error.
func Unauthorized(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusUnauthorized,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusUnauthorized),
}
}
// Forbidden generates a 403 error.
func Forbidden(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusForbidden,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusForbidden),
}
}
// NotFound generates a 404 error.
func NotFound(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusNotFound,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusNotFound),
}
}
// MethodNotAllowed generates a 405 error.
func MethodNotAllowed(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusMethodNotAllowed,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusMethodNotAllowed),
}
}
// Timeout generates a 408 error.
func Timeout(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusRequestTimeout,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusRequestTimeout),
}
}
// Conflict generates a 409 error.
func Conflict(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusConflict,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusConflict),
}
}
// InternalServerError generates a 500 error.
func InternalServerError(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusInternalServerError,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusInternalServerError),
}
}
// NotImplemented generates a 501 error
func NotImplemented(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusNotImplemented,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusNotImplemented),
}
}
// BadGateway generates a 502 error
func BadGateway(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusBadGateway,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusBadGateway),
}
}
// ServiceUnavailable generates a 503 error
func ServiceUnavailable(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusServiceUnavailable,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusServiceUnavailable),
}
}
// GatewayTimeout generates a 504 error
func GatewayTimeout(id, format string, a ...interface{}) error {
return &Error{
Id: id,
Code: http.StatusGatewayTimeout,
Detail: fmt.Sprintf(format, a...),
Status: http.StatusText(http.StatusGatewayTimeout),
}
}
// 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
}