lndhub.go/lib/responses/errors.go

package responses

import (
	"encoding/json"
	"net/http"

	"github.com/getsentry/sentry-go"
	sentryecho "github.com/getsentry/sentry-go/echo"
	"github.com/labstack/echo/v4"
)

type ErrorResponse struct {
	Error   bool   `json:"error"`
	Code    int    `json:"code"`
	Message string `json:"message"`
}

var GeneralServerError = ErrorResponse{
	Error:   true,
	Code:    6,
	Message: "Something went wrong. Please try again later",
}

var BadArgumentsError = ErrorResponse{
	Error:   true,
	Code:    8,
	Message: "Bad arguments",
}

var BadAuthError = ErrorResponse{
	Error:   true,
	Code:    1,
	Message: "bad auth",
}

var NotEnoughBalanceError = ErrorResponse{
	Error:   true,
	Code:    2,
	Message: "not enough balance. Make sure you have at least 1%% reserved for potential fees",
}

func HTTPErrorHandler(err error, c echo.Context) {
	if c.Response().Committed {
		return
	}
	c.Logger().Error(err)
	if hub := sentryecho.GetHubFromContext(c); hub != nil && isErrAllowedForSentry(err) {
		hub.WithScope(func(scope *sentry.Scope) {
			scope.SetExtra("UserID", c.Get("UserID"))
			hub.CaptureException(err)
		})
	}
	code := http.StatusInternalServerError
	if he, ok := err.(*echo.HTTPError); ok {
		code = he.Code
		c.JSON(code, he.Message)
	} else {
		c.JSON(http.StatusInternalServerError, GeneralServerError)
	}
	// TODO: use an error matching the error code
}

// this is a simple way to try to convert err.Message interface
// to ErrorResponse without external packages
func errToErrorResponse(err error) *ErrorResponse {
	httpError, ok := err.(*echo.HTTPError)
	if !ok {
		return nil
	}

	responseJson, err := json.Marshal(httpError.Message)
	if err != nil {
		return nil
	}

	errorResponse := &ErrorResponse{}
	err = json.Unmarshal(responseJson, errorResponse)
	if err != nil {
		return nil
	}

	return errorResponse
}

// currently only bad auth errors are not allowed
func isErrAllowedForSentry(err error) bool {
	errResponse := errToErrorResponse(err)

	return errResponse == nil || errResponse.Code != BadAuthError.Code
}