gotosocial/internal/gtserror/withcode.go

// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package gtserror

import (
	"fmt"
	"net/http"
	"strings"
)

// Custom http response codes + text that
// aren't included in the net/http package.
const (
	StatusClientClosedRequest     = 499
	StatusTextClientClosedRequest = "Client Closed Request"
)

// WithCode wraps an internal error with an http code, and a 'safe' version of
// the error that can be served to clients without revealing internal business logic.
//
// A typical use of this error would be to first log the Original error, then return
// the Safe error and the StatusCode to an API caller.
type WithCode interface {
	// Unwrap returns the original error.
	// This should *NEVER* be returned to a client as it may contain sensitive information.
	Unwrap() error

	// Error serializes the original internal error for debugging within the GoToSocial logs.
	// This should *NEVER* be returned to a client as it may contain sensitive information.
	Error() string

	// Safe returns the API-safe version of the error for serialization towards a client.
	// There's not much point logging this internally because it won't contain much helpful information.
	Safe() string

	// Code returns the status code for serving to a client.
	Code() int
}

type withCode struct {
	err  error
	safe string
	code int
}

func (e *withCode) Unwrap() error {
	return e.err
}

func (e *withCode) Error() string {
	return e.err.Error()
}

func (e *withCode) Safe() string {
	return e.safe
}

func (e *withCode) Code() int {
	return e.code
}

// NewWithCode returns a new gtserror.WithCode that implements the error interface
// with given HTTP status code, providing status message of "${httpStatus}: ${msg}".
func NewWithCode(code int, msg string) WithCode {
	return &withCode{
		err:  newAt(3, msg),
		safe: http.StatusText(code) + ": " + msg,
		code: code,
	}
}

// NewfWithCode returns a new formatted gtserror.WithCode that implements the error interface
// with given HTTP status code, provided formatted status message of "${httpStatus}: ${msg}".
func NewfWithCode(code int, msgf string, args ...any) WithCode {
	msg := fmt.Sprintf(msgf, args...)
	return &withCode{
		err:  newAt(3, msg),
		safe: http.StatusText(code) + ": " + msg,
		code: code,
	}
}

// NewWithCodeSafe returns a new gtserror.WithCode wrapping error with given HTTP status
// code, hiding error message externally, providing status message of "${httpStatus}: ${safe}".
func NewWithCodeSafe(code int, err error, safe string) WithCode {
	return &withCode{
		err:  err,
		safe: http.StatusText(code) + ": " + safe,
		code: code,
	}
}

// WrapWithCode returns a new gtserror.WithCode wrapping error with given HTTP
// status code, hiding error message externally, providing standard status message.
func WrapWithCode(code int, err error) WithCode {
	return &withCode{
		err:  err,
		safe: http.StatusText(code),
		code: code,
	}
}

// NewErrorBadRequest returns an ErrorWithCode 400 with the given original error and optional help text.
func NewErrorBadRequest(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusBadRequest)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusBadRequest,
	}
}

// NewErrorUnauthorized returns an ErrorWithCode 401 with the given original error and optional help text.
func NewErrorUnauthorized(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusUnauthorized)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusUnauthorized,
	}
}

// NewErrorForbidden returns an ErrorWithCode 403 with the given original error and optional help text.
func NewErrorForbidden(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusForbidden)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusForbidden,
	}
}

// NewErrorNotFound returns an ErrorWithCode 404 with the given original error and optional help text.
func NewErrorNotFound(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusNotFound)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusNotFound,
	}
}

// NewErrorInternalError returns an ErrorWithCode 500 with the given original error and optional help text.
func NewErrorInternalError(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusInternalServerError)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusInternalServerError,
	}
}

// NewErrorConflict returns an ErrorWithCode 409 with the given original error and optional help text.
func NewErrorConflict(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusConflict)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusConflict,
	}
}

// NewErrorNotAcceptable returns an ErrorWithCode 406 with the given original error and optional help text.
func NewErrorNotAcceptable(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusNotAcceptable)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusNotAcceptable,
	}
}

// NewErrorUnprocessableEntity returns an ErrorWithCode 422 with the given original error and optional help text.
func NewErrorUnprocessableEntity(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusUnprocessableEntity)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusUnprocessableEntity,
	}
}

// NewErrorGone returns an ErrorWithCode 410 with the given original error and optional help text.
func NewErrorGone(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusGone)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusGone,
	}
}

// NewErrorNotImplemented returns an ErrorWithCode 501 with the given original error and optional help text.
func NewErrorNotImplemented(original error, helpText ...string) WithCode {
	safe := http.StatusText(http.StatusNotImplemented)
	if len(helpText) > 0 {
		safe = safe + ": " + strings.Join(helpText, ": ")
	}
	return &withCode{
		err:  original,
		safe: safe,
		code: http.StatusNotImplemented,
	}
}

// NewErrorClientClosedRequest returns an ErrorWithCode 499 with the given original error.
// This error type should only be used when an http caller has already hung up their request.
// See: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#nginx
func NewErrorClientClosedRequest(original error) WithCode {
	return &withCode{
		err:  original,
		safe: StatusTextClientClosedRequest,
		code: StatusClientClosedRequest,
	}
}

// NewErrorRequestTimeout returns an ErrorWithCode 408 with the given original error.
// This error type should only be used when the server has decided to hang up a client
// request after x amount of time, to avoid keeping extremely slow client requests open.
func NewErrorRequestTimeout(original error) WithCode {
	return &withCode{
		err:  original,
		safe: http.StatusText(http.StatusRequestTimeout),
		code: http.StatusRequestTimeout,
	}
}