-
Notifications
You must be signed in to change notification settings - Fork 809
/
trans_errors.go
132 lines (117 loc) · 3.92 KB
/
trans_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
/*
* Copyright 2021 CloudWeGo Authors
*
* 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
*
* http://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.
*/
package remote
import (
"errors"
"fmt"
"github.com/cloudwego/kitex/pkg/kerrors"
)
// corresponding with thrift TApplicationException, cannot change it
const (
UnknownApplicationException = 0
UnknownMethod = 1
InvalidMessageTypeException = 2
WrongMethodName = 3
BadSequenceID = 4
MissingResult = 5
InternalError = 6
ProtocolError = 7
InvalidTransform = 8
InvalidProtocol = 9
UnsupportedClientType = 10
)
var defaultTransErrorMessage = map[int32]string{
UnknownApplicationException: "unknown application exception",
UnknownMethod: "unknown method",
InvalidMessageTypeException: "invalid message type",
WrongMethodName: "wrong method name",
BadSequenceID: "bad sequence ID",
MissingResult: "missing result",
InternalError: "unknown internal error",
ProtocolError: "unknown protocol error",
InvalidTransform: "Invalid transform",
InvalidProtocol: "Invalid protocol",
UnsupportedClientType: "Unsupported client type",
}
// TransError is the error that can be transmitted, it corresponds to TApplicationException in Thrift
type TransError struct {
message string
typeID int32
rawErr error
}
// Error implements the error interface.
func (e TransError) Error() string {
if e.message != "" {
return e.message
}
return defaultTransErrorMessage[e.typeID]
}
// TypeID return err type id
func (e TransError) TypeID() int32 {
return e.typeID
}
// Unwrap the transError to expose raw error
func (e TransError) Unwrap() error {
return e.rawErr
}
// Is to check if inner error that transError wrap is target error
func (e TransError) Is(target error) bool {
return e == target || errors.Is(e.rawErr, target)
}
// AppendMessage append extra msg for TransError
func (e TransError) AppendMessage(extraMsg string) *TransError {
if extraMsg == "" {
return &e
}
msg := fmt.Sprintf("%s %s", e.message, extraMsg)
// should not modify origin error
return &TransError{message: msg, typeID: e.typeID, rawErr: e.rawErr}
}
// NewTransErrorWithMsg to build TransError with typeID and errMsg
func NewTransErrorWithMsg(typeID int32, message string) *TransError {
return &TransError{message: message, typeID: typeID}
}
// NewTransError to build TransError with typeID and rawErr.
// rawErr can be used by errors.Is(target) to check err type, like read timeout.
func NewTransError(typeID int32, err error) *TransError {
if e, ok := err.(*TransError); ok {
return e
}
// biz error should add biz info which is convenient to be recognized by client side
if errors.Is(err, kerrors.ErrBiz) {
if e, ok := errors.Unwrap(err).(*TransError); ok {
e = e.AppendMessage(fmt.Sprintf("[%s]", kerrors.ErrBiz.Error()))
return e
}
}
if typeID == InternalError {
// try to get more specific err type if typeID is InternalError
if tID, ok := err.(TypeId); ok {
typeID = tID.TypeId()
} else if tID, ok := err.(TypeID); ok {
typeID = tID.TypeID()
}
}
return &TransError{message: err.Error(), typeID: typeID, rawErr: err}
}
// TypeId is used to assert Error with has 'TypeID() int32'
type TypeID interface {
TypeID() int32
}
// TypeId is used to assert Error with has 'TypeId() int32' like TApplicationException
type TypeId interface {
TypeId() int32
}