rapid_web/

logger.rs

use actix_web::{
	dev::{forward_ready, Service, ServiceRequest, ServiceResponse, Transform},
	http::header::HeaderValue,
	Error,
};
use colorful::{Color, Colorful};
use futures_util::future::LocalBoxFuture;
use log::info;
use std::future::{ready, Ready};
use std::io::Write;

pub fn init_logger() {
	pretty_env_logger::formatted_builder()
		.filter_level(log::LevelFilter::Info)
		.filter(Some("actix_server"), log::LevelFilter::Error)
		.format(|buf, record| writeln!(buf, "{}: {}", record.level().to_string().color(Color::Cyan), record.args()))
		.try_init()
		.ok();
}

/// An enum for selecting a RapidLogger output type
///
/// # The RapidLogger has 3 different logging formats/variants
/// 1. `RapidLogger::minimal`
/// 2. `RapidLogger::detailed`
/// 3. `RapidLogger::verbose`
///
/// # Example output
/// INFO  rapid_web::logger > REQUEST GET /hello HTTP/1.1
/// INFO  rapid_web::logger > RESPONSE 200 OK
#[derive(Copy, Clone)]
pub enum LoggerType {
	Minimal,
	Detailed,
	Verbose,
}

pub struct RapidLogger {
	logger_type: LoggerType,
}

/// Simple Middleware for logging request and response summaries to the console/terminal.
///
/// This middleware uses the `log` crate to output its logs and is enabled by default but can optionally be turned off as needed
///
/// # The RapidLogger has 3 different logging formats/variants
/// 1. `RapidLogger::minimal`
/// 2. `RapidLogger::detailed`
/// 3. `RapidLogger::verbose`
///
/// # Example output
/// INFO  rapid_web::logger > REQUEST GET /hello HTTP/1.1
/// INFO  rapid_web::logger > RESPONSE 200 OK
impl RapidLogger {
	pub fn minimal() -> Self {
		Self {
			logger_type: LoggerType::Minimal,
		}
	}

	pub fn detailed() -> Self {
		Self {
			logger_type: LoggerType::Detailed,
		}
	}

	pub fn verbose() -> Self {
		Self {
			logger_type: LoggerType::Verbose,
		}
	}

	fn minimal_request_logs(req: &ServiceRequest) {
		let request_method = req.method().to_string().color(Color::LightBlue);
		let request_path = req.path();
		let request_http = req.version();

		let logs = format!("REQUEST {} {} {:?}", request_method, request_path, request_http);
		info!("{}", logs);
	}

	fn minimal_response_logs<B>(res: &ServiceResponse<B>) {
		let response_status = res.status().to_string().color(Color::LightCyan);

		info!("RESPONSE {}", response_status);
	}

	fn detailed_request_logs(req: &ServiceRequest) {
		let request_method = req.method().to_string().color(Color::LightBlue);
		let request_path = req.path();
		let request_http = req.version();
		let request_headers = req
			.headers()
			.keys()
			.map(|key| (key.to_string(), req.headers().get(key.to_string()).unwrap()))
			.collect::<Vec<(String, &HeaderValue)>>();
		let is_secure = req.app_config().secure();
		let request_connection_info = req.connection_info();
		let request_uri = format!("{}{}", request_connection_info.host(), request_path);
		let agent = match req.headers().get("user-agent") {
			Some(agent) => agent.to_str().unwrap(),
			None => "Not Found",
		};

		let logs = format!(
			"REQUEST {} {} {} {:?} {} {} {}",
			request_method,
			request_path,
			request_uri,
			request_http,
			format!("{}{:?}", "headers=".color(Color::LightBlue), request_headers),
			format!("{}{}", "is_secure=".color(Color::LightBlue), is_secure),
			format!("{}{}", "agent=".color(Color::LightBlue), agent)
		);
		info!("{}", logs);
	}

	fn detailed_response_logs<B>(res: &ServiceResponse<B>) {
		let response_status = res.status().to_string().color(Color::LightCyan);
		let response_headers = {
			let headers = res
				.headers()
				.keys()
				.map(|key| (key.to_string(), res.headers().get(key.to_string()).unwrap()))
				.collect::<Vec<(String, &HeaderValue)>>();

			if headers.len() == 0 {
				"No Headers".to_string()
			} else {
				headers
					.iter()
					.map(|(key, value)| format!("{}: {}", key, value.to_str().unwrap()))
					.collect::<Vec<String>>()
					.join(", ")
			}
		};

		let logs = format!(
			"RESPONSE {} {}",
			response_status,
			format!("{}{:?}", "headers=".color(Color::LightCyan), response_headers)
		);
		info!("{}", logs);
	}

	// TODO: verbose will likely not be used becuase it is basically the same as detailed logs
	// Currently, it exists for users that don't want formatted logs with the default rapid gradient colors (and for us to experiment with other logging techniques)
	fn verbose_request_logs(req: &ServiceRequest) {
		let is_secure = req.app_config().secure();
		info!("{} {} {:?} is_secure={}", "[rapid-web::logger]", "REQUEST", req.request(), is_secure);
	}

	fn verbose_response_logs<B>(res: &ServiceResponse<B>) {
		let response_status = res.status();
		let response_headers = res.headers();

		// TODO: eventually it would be nice to log response logs here as well (currently actix-web does not support this very well)
		info!("{} {} {:?} {:?}", "[rapid-web::logger]", "RESPONSE", response_status, response_headers);
	}

	fn get_request_logs(req: &ServiceRequest, logger_type: LoggerType) {
		match logger_type {
			LoggerType::Minimal => Self::minimal_request_logs(req),
			LoggerType::Detailed => Self::detailed_request_logs(req),
			LoggerType::Verbose => Self::verbose_request_logs(req),
		}
	}

	fn get_response_logs<B>(res: &ServiceResponse<B>, logger_type: LoggerType) {
		match logger_type {
			LoggerType::Minimal => Self::minimal_response_logs(res),
			LoggerType::Detailed => Self::detailed_response_logs(res),
			LoggerType::Verbose => Self::verbose_response_logs(res),
		}
	}
}

impl<S, B> Transform<S, ServiceRequest> for RapidLogger
where
	S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
	S::Future: 'static,
	B: 'static + actix_web::body::MessageBody,
{
	type Response = ServiceResponse<B>;
	type Error = Error;
	type InitError = ();
	type Transform = RapidLoggerMiddleware<S>;
	type Future = Ready<Result<Self::Transform, Self::InitError>>;

	fn new_transform(&self, service: S) -> Self::Future {
		ready(Ok(RapidLoggerMiddleware {
			service,
			log_type: self.logger_type,
		}))
	}
}

pub struct RapidLoggerMiddleware<S> {
	service: S,
	log_type: LoggerType,
}

impl<S, B> Service<ServiceRequest> for RapidLoggerMiddleware<S>
where
	S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
	S::Future: 'static,
	B: 'static + actix_web::body::MessageBody,
{
	type Response = ServiceResponse<B>;
	type Error = Error;
	type Future = LocalBoxFuture<'static, Result<Self::Response, Self::Error>>;

	forward_ready!(service);

	fn call(&self, req: ServiceRequest) -> Self::Future {
		let cloned_log_type = self.log_type.clone();

		// Log all of the request logs to the users console
		RapidLogger::get_request_logs(&req, cloned_log_type);
		let fut = self.service.call(req);

		Box::pin(async move {
			let res = fut.await?;
			// Log all of the response logs to the users console
			RapidLogger::get_response_logs(&res, cloned_log_type);
			Ok(res)
		})
	}
}