feat: Add /logs route to view logs

Author: angrynode

src/database/operation.rs

@@ -1,11 +1,12 @@
 use chrono::{DateTime, Utc};
+use derive_more::Display;
 use serde::{Deserialize, Serialize};
 
 use crate::extractors::user::User;
 use crate::routes::category::CategoryForm;
 
 /// Type of operation applied to the database.
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Display, Serialize, Deserialize)]
 pub enum OperationType {
     Create,
     Update,
@@ -18,7 +19,7 @@ pub struct OperationId {
     pub name: String,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Display, Serialize, Deserialize)]
 pub enum Table {
     Category,
 }
@@ -32,6 +33,12 @@ pub enum Operation {
     Category(CategoryForm),
 }
 
+impl std::fmt::Display for Operation {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", &serde_json::to_string(self).unwrap())
+    }
+}
+
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct OperationLog {
     pub user: Option<User>,

src/lib.rs

@@ -22,6 +22,7 @@ pub fn router(state: state::AppState) -> Router {
         .route("/progress/{view_request}", get(routes::progress::progress))
         .route("/category", get(routes::category::index))
         .route("/category", post(routes::category::create))
+        .route("/logs", get(routes::logs::index))
         // Register static assets routes
         .nest("/assets", static_router())
         // Insert request timing

src/routes/logs.rs

@@ -0,0 +1,29 @@
+use askama::Template;
+use askama_web::WebTemplate;
+use axum::extract::State;
+
+use crate::database::operation::OperationLog;
+use crate::extractors::user::User;
+use crate::state::{AppState, AppStateContext, error::AppStateError};
+
+#[derive(Template, WebTemplate)]
+#[template(path = "logs.html")]
+pub struct LogTemplate {
+    pub state: AppStateContext,
+    pub logs: Vec<OperationLog>,
+    pub user: Option<User>,
+}
+
+pub async fn index(
+    State(app_state): State<AppState>,
+    user: Option<User>,
+) -> Result<LogTemplate, AppStateError> {
+    let app_state_context = app_state.context().await?;
+    let logs = app_state.logger.read().await?;
+
+    Ok(LogTemplate {
+        state: app_state_context,
+        logs,
+        user,
+    })
+}

src/routes/mod.rs

@@ -1,3 +1,4 @@
 pub mod category;
 pub mod index;
+pub mod logs;
 pub mod progress;

src/state/logger.rs

@@ -1,9 +1,10 @@
 use camino::Utf8PathBuf;
 use snafu::prelude::*;
 use tokio::fs::{File, OpenOptions};
-use tokio::io::AsyncWriteExt;
+use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
 use tokio::sync::RwLock;
 
+use std::io::SeekFrom;
 use std::sync::Arc;
 
 use crate::database::operation::OperationLog;
@@ -35,6 +36,11 @@ pub enum LoggerError {
         path: Utf8PathBuf,
         source: serde_json::Error,
     },
+    #[snafu(display("Other IO error with operaitons log {path}"))]
+    IO {
+        path: Utf8PathBuf,
+        source: std::io::Error,
+    },
 }
 
 #[derive(Clone, Debug)]
@@ -84,4 +90,39 @@ impl Logger {
 
         Ok(())
     }
+
+    pub async fn read(&self) -> Result<Vec<OperationLog>, AppStateError> {
+        // When in append mode, the cursor may be set to the end of file
+        // so start again from the beginning
+        let mut s = String::new();
+        {
+            let mut handle = self.handle.write().await;
+            handle
+                .seek(SeekFrom::Start(0))
+                .await
+                .context(IOSnafu {
+                    path: self.path.to_path_buf(),
+                })
+                .context(state_error::LoggerSnafu)?;
+
+            handle
+                .read_to_string(&mut s)
+                .await
+                .context(ReadSnafu {
+                    path: self.path.to_path_buf(),
+                })
+                .context(state_error::LoggerSnafu)?;
+        }
+
+        // Now that we have dropped the RwLock, parse the results
+        s.lines()
+            .map(|entry| {
+                serde_json::from_str(entry)
+                    .context(ParseSnafu {
+                        path: self.path.to_path_buf(),
+                    })
+                    .context(state_error::LoggerSnafu)
+            })
+            .collect()
+    }
 }

templates/logs.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% block main %}
+<h1 class="title" style="text-align: center;">Logs</h1>
+
+{% for log in logs %}
+<details>
+<summary>
+{{ log.date }} {% if let Some(log_user) = log.user %}{{ log_user }}{% endif %}{{ log.operation }} on table {{ log.table }}: {{ log.operation_id.name }} ({{ log.operation_id.object_id }})
+</summary>
+{{ log.operation_form }}
+</details>
+{% endfor %}
+{% endblock %}