README.md

WrappErrors

Package wrapperrors provides simple error handling primitives. Although Go has a good error handling approach, sometimes it is difficult to handle them appropiatly. This package has been created for such purpose, allowing to define differents errors types and use them in the entire application.

go get github.com/felipewom/go-wrapperrors

Defining errors types

First of all, it has to be defined the differents types of errors that are going to be used in the application. This could be done as global variables somewhere in the project using the function errors.Define which receive an internal code and generate a new error type.

In the following example all the error types definitions are being done in a package called errorsdefinitions.

package errorsdefinitions

import (
	"github.com/felipewom/go-wrapperrors/wrapperrors"
	"net/http"
)

var (
	Internal       = wrapperrors.Define("internal", http.StatusInternalServerError)
	NotFound       = wrapperrors.Define("not_found", http.StatusNotFound)
	InvalidPayload = wrapperrors.Define("invalid_payload", http.StatusBadRequest)
)

Creating a new error

The funcion wrapperrors.New creates a new error based on a previously defined error. For example, if we want to return a not found error we can do it as follow.

package errorsdefinitions

import (
	"errors"
	"github.com/felipewom/go-wrapperrors/wrapperrors"
)

func ReturnError() error {
	return wrapperrors.New("not_found", errors.New("the resource has not been found"))
}

Let us see a more interested example:

type Car struct {
    ID      string
    Name    string
}

// GetCar retrieves the car with the given id
func GetCar(id string) (Car, error) {
    car := Car{}
    err := db.QueryRow("SELECT id, name FROM car WHERE id = ?", id).Scan(&car.ID, &person.Name)
    if err == nil {
        return car, nil
    }
    if err == sql.ErrNoRows {
        return Car{}, wrapperrors.FromDefinition(errorsdefinitions.NotFound, err).WithMessage("car has not been found in the database")
    }
    return Car{}, wrapperrors.FromDefinition(errorsdefinitions.Internal, err).WithMessage("get car from database has failed")
}

Wrapping an error

The function wrapperrors.Wrap wraps an error with a new message but keeps the same error type. In some cases, we actually want to do is to return an error of the same type but with a different message, so for those such cases this function is intented to be used.

func GetPersonEmail(id string) (string, error) {
    person, err := GetPerson(id)
    if err != nil {
        return "", wrapperrors.Wrap(err, "the person could not be retrieve")
    }
    return person.Email, nil
}

Is

The function wrapperrors.Is checks if a given error is an error of some type.

func GetPersonEmail(id string) (string, error) {
    person, err := GetPerson(id)
    if err == nil {
        return person.Email, nil
    }
    if wrapperrors.Is(err, apperrors.NotFound) {
        return "", nil
    }
    return wrapperrors.Wrap(err, "get person has failed")
}

Error() and String()

There are two functions that allows us to print the error information: wrapperrors.Error and wrapperrors.String. The first one only returns the error message and the second one returns a string with the underlying information such as the internal code and the stacktrace among others.

func main() {
    email, err := GetPersonEmail("123")
    if err != nil {
        log.Error(err)
        fmt.Printf("error: %s", err.Error())
    }
    println("the person e-mail is "+email)
}

If the person is not found, then the following output will be printed in the console.

error: [sql: no rows in result set]

And the following log is printed

{"code": ["not_found"], "message": ["car has not been found in the database"], "status": [{"message": "Not Found", "code": 404}], "cause": "sql: no rows in result set"}

Author

• Felipe Moura · [email protected]

License

MIT