editoast: enhance error logging

Author: leovalais

editoast/src/core/mod.rs

@@ -12,13 +12,27 @@ use std::marker::PhantomData;
 
 use crate::error::Result;
 use async_trait::async_trait;
+use colored::{ColoredString, Colorize};
 use editoast_derive::EditoastError;
 pub use http_client::{HttpClient, HttpClientBuilder};
 use reqwest::Url;
 use serde::{de::DeserializeOwned, Serialize};
 use serde_derive::Deserialize;
 use thiserror::Error;
 
+fn colored_method(method: &reqwest::Method) -> ColoredString {
+    let m = method.as_str();
+    match *method {
+        reqwest::Method::GET => m.green(),
+        reqwest::Method::POST => m.yellow(),
+        reqwest::Method::PUT => m.blue(),
+        reqwest::Method::PATCH => m.magenta(),
+        reqwest::Method::DELETE => m.red(),
+        _ => m.normal(),
+    }
+    .bold()
+}
+
 #[derive(Debug, Clone)]
 pub enum CoreClient {
     Direct(HttpClient),
@@ -48,6 +62,9 @@ impl CoreClient {
         path: &str,
         body: Option<&B>,
     ) -> Result<R::Response> {
+        let method_s = colored_method(&method);
+        log::info!(target: "editoast::coreclient", "{method_s} {path}");
+        log::debug!(target: "editoast::coreclient", "Request content: {body}", body = body.and_then(|b| serde_json::to_string_pretty(b).ok()).unwrap_or_default());
         match self {
             CoreClient::Direct(client) => {
                 let mut request = client.request(method, path);
@@ -65,8 +82,10 @@ impl CoreClient {
                             msg: err.to_string(),
                         })?;
                 if status.is_success() {
+                    log::info!(target: "editoast::coreclient", "{method_s} {path} {status}", status = status.to_string().bold().green());
                     R::from_bytes(bytes.as_ref())
                 } else {
+                    log::error!(target: "editoast::coreclient", "{method_s} {path} {status}", status = status.to_string().bold().red());
                     // We try to deserialize the response as the standard Core error format
                     // If that fails we try to return a generic error containing the raw error
                     let core_error =

editoast/src/error.rs

@@ -1,8 +1,10 @@
 use actix_web::{error::JsonPayloadError, http::StatusCode, HttpResponse, ResponseError};
+use colored::Colorize;
 use diesel::result::Error as DieselError;
 use redis::RedisError;
 use serde::{Deserialize, Serialize};
 use serde_json::{json, Value};
+use std::backtrace::Backtrace;
 use std::collections::HashMap;
 use std::result::Result as StdResult;
 use std::{
@@ -77,6 +79,12 @@ impl ResponseError for InternalError {
     }
 
     fn error_response(&self) -> HttpResponse {
+        log::error!(
+            "[{}] {}: {}",
+            self.error_type.bold(),
+            self.message,
+            Backtrace::capture() // won't log unless RUST_BACKTRACE=1
+        );
         HttpResponse::build(self.status).json(self)
     }
 }