-
Notifications
You must be signed in to change notification settings - Fork 9
/
errorx.go
602 lines (504 loc) · 12.5 KB
/
errorx.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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
package errorx
import (
"encoding/json"
"errors"
"fmt"
"reflect"
"strconv"
"strings"
"time"
)
const (
LcauseBy = 1 << iota
LdateTime
Llongfile
)
// an Error instance wraps an official error and storage its stackTrace.
// When tries to wrap the origin error to another, logic does like:
//
// if er := f(); er!=nil{
// log.Println(er.Error())
// return errors.New("inner service error")
// }
//
// 'ReGenerated' should be set true and different errors should be saved in 'Errors',and the 'stackTrace' should include
// all stackTraces above.But in this case,'Error.E' only point to the origin one
// It's ok to storage both official error and 'Error'
type Error struct {
// Each wrap will add index 1
index int
// core error // saves origin error
// basic
E error
StackTraces []string // Deprecated,保留了字段防止外部应用直接使用引起无法编译问题
stackTracesV2 []stackline // 新版堆栈路径
isServiceErr bool
serviceErrcode int
serviceErrmsg string
// do not use context, it's tracking bug on development
Context map[string]interface{}
Header map[string][]string
// upper
ReGenerated bool
Errors []error
Flag int
Keyword string
}
func (e *Error) wrapStackLine(desc string) {
trace := stackDepth3()
if len(e.stackTracesV2) == 0 {
e.stackTracesV2 = make([]stackline, 0, 10)
}
e.stackTracesV2 = append([]stackline{{
trace: trace,
desc: desc,
}}, e.stackTracesV2...)
}
func (e *Error) wrapStackLineWithTrace(trace string, desc string) {
if len(e.stackTracesV2) == 0 {
e.stackTracesV2 = make([]stackline, 0, 10)
}
e.stackTracesV2 = append([]stackline{{
trace: trace,
desc: desc,
}}, e.stackTracesV2...)
}
func (e Error) Stack() []string {
var rs = make([]string, 0, 10)
for _, v := range e.stackTracesV2 {
tmp := fmt.Sprintf("%s %s", v.trace, v.desc)
rs = append(rs, tmp)
}
return rs
}
func (e Error) String() string {
return e.Error()
}
// set header for an error obj
// SetHeader is safe whether e.Header is nil or not
func (e *Error) SetHeader(key string, value string) {
if e.Header == nil {
e.Header = make(map[string][]string, 0)
}
if e.Header[key] == nil {
e.Header[key] = make([]string, 0, 10)
}
if len(e.Header[key]) == 0 {
e.Header[key] = append(e.Header[key], value)
} else {
e.Header[key][0] = value
}
}
// GetHeader is safe wheter header is nil
func (e Error) GetHeader(key string) string {
if e.Header == nil {
return ""
}
if e.Header[key] == nil || len(e.Header[key]) == 0 {
return ""
}
return e.Header[key][0]
}
func Empty() Error {
return empty()
}
func empty() Error {
return Error{
index: 0,
E: nil,
StackTraces: make([]string, 0, 30),
stackTracesV2: make([]stackline, 0, 10),
Context: make(map[string]interface{}, 0),
ReGenerated: false,
Errors: make([]error, 0, 30),
Flag: Llongfile | LcauseBy | LdateTime,
}
}
func (e Error) Error() string {
var header = ""
if len(e.Header) != 0 {
buf, _ := json.MarshalIndent(e.Header, " ", " ")
header += fmt.Sprintf("header:\n%s\n", buf)
}
rs := fmt.Sprintf("%s%s\n", header, e.StackTraceValue())
if len(e.Context) != 0 {
buf, _ := json.MarshalIndent(e.Context, " ", " ")
rs += fmt.Sprintf("context:\n%s\n", buf)
}
return rs
}
func (e Error) BasicError() string {
if e.E != nil {
return e.E.Error()
}
return ""
}
// return its stacktrace
func (e Error) StackTrace() string {
return e.StackTraceValue()
}
// New an error with header info
func NewWithHeader(e error, header map[string]interface{}) error {
if e == nil {
return nil
}
er := New(e).(Error)
for k, v := range header {
er.SetHeader(k, ToString(v))
}
return er
}
func NewWithAttach(e error, msg interface{}) error {
if e == nil {
return nil
}
msg = ToString(msg)
er := New(e).(Error)
er.SetHeader("attach", msg.(string))
return er
}
// New a error
func New(e error) error {
if e == nil {
return nil
}
tmp := empty()
tmp.E = e
tmp.wrapStackLine(e.Error())
return tmp
}
// print error stack trace
// e.Flag only controls 'Error' type or official error which has been wrapped to 'Error'.
// e.Flag only controls stack trace inner an Error type ,rather than some stack trace which has been init by api NewFromStackTrace([]string,string)
func (e Error) PrintStackTrace() string {
return e.StackTraceValue()
}
func (e Error) StackTraceValue() string {
rs := make([]string, 0, 10)
for _, v := range e.stackTracesV2 {
tmp := fmt.Sprintf("%s %s", v.trace, v.desc)
rs = append(rs, tmp)
}
return strings.Join(rs, " | ")
}
// wrap an official error to Error type
// function do the same as New()
// New() or Wrap() depends on its semantics. mixing them is also correct.
func Wrap(e error) error {
if e == nil {
return nil
}
switch v := e.(type) {
case Error:
v.wrapStackLine("")
v.index++
return v
case ServiceError:
errorX := Empty()
errorX.E = e
errorX.isServiceErr = true
errorX.serviceErrcode = v.Errcode
errorX.serviceErrmsg = v.Errmsg
errorX.wrapStackLine(v.Errmsg)
return errorX
case error:
errorX := empty()
errorX.E = e
errorX.Errors = append(errorX.Errors, e)
errorX.wrapStackLine(e.Error())
return errorX
}
return Wrap(errors.New("invalid error type,error type should be official or errorx.Error"))
}
func NewFromStringWithDepth(msg string, depth int) error {
e := empty()
e.E = fmt.Errorf("%s", msg)
e.wrapStackLine(msg)
return e
}
// new an error from string with header
func NewFromStringWithHeader(msg string, header map[string]interface{}) error {
var tmp = make([]string, 0, 10)
for k, v := range header {
pair := fmt.Sprintf("%s=%v", k, v)
tmp = append(tmp, pair)
}
headerInfo := strings.Join(tmp, " ")
info := fmt.Sprintf("%s err=%s", headerInfo, msg)
e := empty()
e.E = fmt.Errorf("%s", msg)
e.wrapStackLine(info)
return e
}
// new a error from a well format string with header
func NewFromStringWithHeaderf(format string, msg string, header map[string]interface{}) error {
var tmp = make([]string, 0, 10)
for k, v := range header {
pair := fmt.Sprintf("%s=%v", k, v)
tmp = append(tmp, pair)
}
headerInfo := strings.Join(tmp, " ")
info := fmt.Sprintf("%s err=%s", headerInfo, msg)
e := empty()
e.E = fmt.Errorf("%s", msg)
e.wrapStackLine(info)
return e
}
// Deprecated: using NewFromStringf
func NewFromStringWithAttach(msg string, attach interface{}) error {
info := fmt.Sprintf("err=%s attach=%v", msg, attach)
e := empty()
e.E = fmt.Errorf("%s", msg)
e.wrapStackLine(info)
return e
}
// Deprecated: using NewFromStringf
func NewFromStringWithAttachf(format string, msg string, attach interface{}) error {
info := fmt.Sprintf("err=%s attach=%v", msg, attach)
e := empty()
e.E = fmt.Errorf("%s", msg)
e.wrapStackLine(info)
return e
}
// new an error from string
func NewFromString(msg string) error {
v := empty()
v.E = fmt.Errorf("%s", msg)
v.wrapStackLine(msg)
return v
}
// new a error from a well format string
func NewFromStringf(format string, args ...interface{}) error {
v := findErr(args...)
v.wrapStackLine(fmt.Sprintf(format, args...))
return v
}
func findErr(args ...interface{}) Error {
var e Error
if len(args) > 0 {
for _, v := range args {
if tmp, ok := v.(Error); ok {
e = tmp
// 找到了底层错误,则返回该错误
return e
}
}
return empty()
}
return empty()
}
// Deprecated: using WrapContext
func NewWithParam(e error, params ...interface{}) error {
if e == nil {
return nil
}
if len(params) == 0 {
tmp := empty()
tmp.E = e
tmp.wrapStackLine(e.Error())
return tmp
}
var infoarr = make([]string, 0, 10)
for i, v := range params {
pair := fmt.Sprintf("param%d=%v", i, v)
infoarr = append(infoarr, pair)
}
paraminfo := strings.Join(infoarr, " ")
tmp := empty()
tmp.E = e
tmp.wrapStackLine(fmt.Sprintf("%s %s", e.Error(), paraminfo))
return tmp
}
func NewFromStringWithParam(msg string, params ...interface{}) error {
if len(params) == 0 {
tmp := empty()
tmp.E = fmt.Errorf("%s", msg)
tmp.wrapStackLine(msg)
return tmp
}
var infoarr = make([]string, 0, 10)
for i, v := range params {
pair := fmt.Sprintf("param%d=%v", i, v)
infoarr = append(infoarr, pair)
}
paraminfo := strings.Join(infoarr, " ")
tmp := empty()
tmp.E = fmt.Errorf("%s", msg)
tmp.wrapStackLine(fmt.Sprintf("%s %s", msg, paraminfo))
return tmp
}
// group series of error to a single error
func GroupErrors(es ...error) error {
tmp := empty()
infoarr := make([]string, 0, 10)
for i, v := range es {
if v == nil {
continue
}
pair := fmt.Sprintf("error_%d=%s", i, v.Error())
infoarr = append(infoarr, pair)
}
tmp.wrapStackLine(fmt.Sprintf("Group Errors %s", strings.Join(infoarr, " ")))
return tmp
}
// new an error with existed stacktrace and generate the new error with new msg
func NewFromStackTrace(stackTrace []string, msg string) error {
e := empty()
for _, v := range stackTrace {
e.wrapStackLineWithTrace(v, msg)
}
return e
}
func WrapContext(e error, ctx map[string]interface{}) error {
if e == nil {
return nil
}
var infoparams = make([]string, 0, 10)
for k, v := range ctx {
argone := fmt.Sprintf("%s=%v", k, v)
infoparams = append(infoparams, argone)
}
ctxinfo := strings.Join(infoparams, " ")
switch v := e.(type) {
case Error:
v.wrapStackLine(ctxinfo)
v.index++
return v
case ServiceError:
errorX := Empty()
errorX.E = e
errorX.isServiceErr = true
errorX.serviceErrcode = v.Errcode
errorX.serviceErrmsg = v.Errmsg
errorX.wrapStackLine(fmt.Sprintf("errno=%d errmsg=%s %s", v.Errcode, v.Errmsg, ctxinfo))
return errorX
case error:
errorX := empty()
errorX.E = e
errorX.Errors = append(errorX.Errors, e)
errorX.wrapStackLine(fmt.Sprintf("%s %s", e.Error(), ctxinfo))
return errorX
}
return Wrap(errors.New("invalid error type,error type should be official or errorx.Error"))
}
// Decrecated
func ReGen(old error, new error) error {
return new
}
// return an Error regardless of e's type
func MustWrap(e error) Error {
switch v := e.(type) {
case Error:
return v
case error:
return New(v).(Error)
}
return Empty()
}
// generate an error key word.
// key word is used to help save errors in database
// It's suggested to set unique(date, keyword), when error with same keyword in a day,database only saves field 'times'
// rather than another error record
func (e Error) GenerateKeyword() string {
arr := e.stackTracesV2
if len(arr) == 0 {
return "no stack"
}
core := strings.TrimSpace(arr[0].trace)
return generateKeyWord(core)
}
// generate key word to an error type
func GenerateKeyword(e error) string {
switch v := e.(type) {
case Error:
return v.GenerateKeyword()
case error:
return generateKeyWord(e.Error())
}
return generateKeyWord(e.Error())
}
// generate key word ruled:
// time out from mysql database -> tofmd
// connection panic from exception -> cpfe
func generateKeyWord(in string) string {
arr := Split(in, " ")
var result string
for _, v := range arr {
result += string(v[0])
}
return result
}
// Split better strings.Split,对 a,,,,,,,b,,c 以","进行切割成[a,b,c]
func Split(s string, sub string) []string {
var rs = make([]string, 0, 20)
tmp := ""
Split2(s, sub, &tmp, &rs)
return rs
}
// Split2 附属于Split,可独立使用
func Split2(s string, sub string, tmp *string, rs *[]string) {
s = strings.Trim(s, sub)
if !strings.Contains(s, sub) {
*tmp = s
*rs = append(*rs, *tmp)
return
}
for i := range s {
if string(s[i]) == sub {
*tmp = s[:i]
*rs = append(*rs, *tmp)
s = s[i+1:]
Split2(s, sub, tmp, rs)
return
}
}
}
func ToString(arg interface{}) string {
tmp := reflect.Indirect(reflect.ValueOf(arg)).Interface()
switch v := tmp.(type) {
case int:
return strconv.Itoa(v)
case int8:
return strconv.FormatInt(int64(v), 10)
case int16:
return strconv.FormatInt(int64(v), 10)
case int32:
return strconv.FormatInt(int64(v), 10)
case int64:
return strconv.FormatInt(v, 10)
case string:
return v
case float32:
return strconv.FormatFloat(float64(v), 'f', -1, 32)
case float64:
return strconv.FormatFloat(v, 'f', -1, 64)
case time.Time:
return v.Format("2006-01-02 15:04:05")
case fmt.Stringer:
return v.String()
default:
return ""
}
}
func IsError(src error, dest error) (string, bool) {
if src == nil {
return "", false
}
if dest == nil {
return "", false
}
switch v := src.(type) {
case Error:
if v.E == nil {
return "", false
}
if v.E.Error() == dest.Error() {
return dest.Error(), true
}
case error:
if v.Error() == dest.Error() {
return dest.Error(), true
}
}
return "", false
}