enzious / actix-web-thiserror

A crate that extends the thiserror crate functionality to automatically return a proper actix-web response.

actix-web-thiserror

A crate that extends the thiserror crate functionality to automatically return a proper actix-web response.

Documentation

• API Documentation

Error definition

use actix_web_thiserror::ResponseError;
use thiserror::Error;

#[derive(Debug, Error, ResponseError)]
pub enum Base64ImageError {
  #[response(reason = "INVALID_IMAGE_FORMAT")]
  #[error("invalid image format")]
  InvalidImageFormat,
  #[response(reason = "INVALID_STRING")]
  #[error("invalid string")]
  InvalidString,
}

Error implementation

pub async fn error_test() -> Result<HttpResponse, Error> {
  Err(Base64ImageError::InvalidImageFormat)?
}

Error response

The reason is a string that may be given to the client in some form to explain the error, if appropriate. Here it is as an enum that can be localized.

Note: This response has been formatted by a ResponseTransform. To specify a custom ResponseTransform, implement ResponseTransform and add #[response(transform = custom)] under your derive.

{
    "result": 0,
    "reason": "INVALID_IMAGE_FORMAT"
}

Error logging

The error text automatically prints to the log when the error is returned out through a http response.

Apr 23 02:19:35.211 ERROR Response error: invalid image format
    Base64ImageError(InvalidImageFormat), place: example/src/handler.rs:5 example::handler

actix-web-thiserror's Issues

Default status code from Err should be 500

When returning from an actix-web endpoint an Err(T) where T: impl ResponseError, the expected default error should be, in my opinion, 500 InternalServerError.

This should be a relatively simple fix by changing this line: https://github.com/enzious/actix-web-thiserror/blob/47ba43d42f87a4deba8d24b57361f6680ba9ca70/actix-web-thiserror-derive/src/response_error.rs#LL197C46-L197C46

Reliance upon using dependencies.

In order to use the ResponseError derive macro, the user must use actix_web::http, thiserror::Error, log::Error. This is not ideal, and you should not do this.

Whenever possible, use a full import within your macro to avoid issues and having to use these dependencies.

For example, instead of http::StatusCode, use actix_web::http::StatusCode.