exterr

Пакет для отображения user-friendly ошибок как для разработчика, так и для пользователя

Для чего

При использовании стандартного интерфейса Error в Golang сложно отследить тип ошибки и место его появления, а трассировка недостаточно информативна (или наоборот, даёт избыточную информацию). Также есть необходимость исключить выдачу во фронтенд код и ошибки состояния (напрмер, при неудачном подключении в базе данных). Библиотека позволяет упростить и унифицировать обработку ошибок.

Особенности

• Соответствие стандартному интерфейсу Error;
• Возможность добавить код ошибки для более удобной обработки в коде;
• Возможность добавить альтернативное описание для внешних сервисов;
• Кастомизированный stacktrace:
  • Сырой (raw string);
  • Тегированный (tagged);
  • В формате JSON.

Установка

go get github.com/alexmolinanasaev/exterr

Импорт в проект

import (
	"github.com/alexmolinanasaev/exterr"
)

Основные функции:

// Ошибка с описанием
// Пример: exterr.New("SQL error!")
func New(msg string) ErrExtender

// Ошибка с форматированной строкой описания
// Пример: exterr.Newf("ERROR: %s", desc)
func Newf(format string, a ...interface{}) ErrExtender

// Добавление к стандартному Error (err) описания msg "{msg}:{err}"
// Пример: exterr.NewWithErr("Auth error", err)
func NewWithErr(msg string, err error) ErrExtender

// Добавление альтернативного описания
// Пример: exterr.NewWithAlt("sql no rows", "<SQL_NO_ROWS>")
func NewWithAlt(msg, altMsg string) ErrExtender

// Добавление номера (ErrType) к ошибке
// Пример: exterr.NewWithType("sql no rows", "user not found", 1005)
func NewWithType(msg, altMsg string, t ErrType) ErrExtender

// Добавление описания и строки stacktrace к уже существующеу ErrExtender'у
// Пример: exterr.NewWithExtErr("auth fail", err)
func NewWithExtErr(msg string, extErr ErrExtender) ErrExtender

// Функция добавляет содержимое другого ErrExtender'а
// Пример: err.Wrap(err2)
func (e *extendedErr) Wrap(w ErrExtender) ErrExtender

// Вывод stacktrace в виде строки, где все строки stacktrace разделены символом '/'
// Формат: пакет:файл:функция:номер_строки
func (e *extendedErr) TraceRawString() string

// Вывод stacktrace в виде строки с тегами, где все строки stacktrace разделены символом '/'
// Формат строки: {pkg}пакет:{file}файл:{function}функция:{line}номер_строки
func (e *extendedErr) TraceTagged() string

// Вывод stacktrace в виде JSON-строки
func (e *extendedErr) TraceJSON() string

// Добавляет к текущему stacktrace ошибки новую запись (с номером строки, где была вызвана функция AddTraceRow())
func (e *extendedErr) AddTraceRow() ErrExtender

Работа со stacktrace

Начальный stacktrace формирует 1 строку в месте создания ошибки и может быть дополнен:

• с помощью функции NewWithExtErr() с добавлением описания ошибки
• с помощью функции AddTraceRow()

func DatabaseInit() error {
    DB, err := sql.Open("mysql", "user:password@/test_db")
    if err != nil {
		return exterr.NewWithType("connection problem", "<SQL_CONNECTION_ERROR>", 1001)
	}
}

func main() {
    err := DatabaseInit()
    if err != nil {
        // Вариант #1: с использованием NewWithExtErr() и добавлением описания ошибки
        // Результат: "db init error:connection problem" и 2 строки stacktrace
        log.Fatal(NewWithExtErr("db init error", err))
        
        // Вариант #2: с использованием AddTrace()
        // Результат: "connection problem"  и 2 строки stacktrace
        err.AddTraceRow()
        log.Fatal(err)
    }
}

Тестирование

Тесты расположены в каталоге /tests.

cd tests
go test