aboutsummaryrefslogtreecommitdiffhomepage
path: root/internal/fmsg/errors.go
blob: bf9884f6bc553ff052eba75225a429985947312c (plain)
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
package fmsg

import (
	"fmt"
	"log"
	"reflect"
	"strings"
)

// baseError implements a basic error container
type baseError struct {
	Err error
}

func (e *baseError) Error() string {
	return e.Err.Error()
}

func (e *baseError) Unwrap() error {
	return e.Err
}

// BaseError implements an error container with a user-facing message
type BaseError struct {
	message string
	baseError
}

// Message returns a user-facing error message
func (e *BaseError) Message() string {
	return e.message
}

// WrapError wraps an error with a corresponding message.
func WrapError(err error, a ...any) error {
	if err == nil {
		return nil
	}
	return wrapError(err, fmt.Sprintln(a...))
}

// WrapErrorSuffix wraps an error with a corresponding message with err at the end of the message.
func WrapErrorSuffix(err error, a ...any) error {
	if err == nil {
		return nil
	}
	return wrapError(err, fmt.Sprintln(append(a, err)...))
}

// WrapErrorFunc wraps an error with a corresponding message returned by f.
func WrapErrorFunc(err error, f func(err error) string) error {
	if err == nil {
		return nil
	}
	return wrapError(err, f(err))
}

func wrapError(err error, message string) *BaseError {
	return &BaseError{message, baseError{err}}
}

var (
	baseErrorType = reflect.TypeFor[*BaseError]()
)

func AsBaseError(err error, target **BaseError) bool {
	v := reflect.ValueOf(err)
	if !v.CanConvert(baseErrorType) {
		return false
	}

	*target = v.Convert(baseErrorType).Interface().(*BaseError)
	return true
}

func PrintBaseError(err error, fallback string) {
	var e *BaseError

	if AsBaseError(err, &e) {
		if msg := e.Message(); strings.TrimSpace(msg) != "" {
			log.Print(msg)
			return
		}
		Verbose("*"+fallback, err)
		return
	}
	log.Println(fallback, err)
}