Merge pull request #176 from Devolutions/WAYK-2567

WAYK-2567: Add endpoint to get logs (GET /diagnostics/logs)

devolutions-gateway/src/http/controllers/diagnostics.rs

@@ -0,0 +1,33 @@
+use crate::config::Config;
+use crate::http::guards::access::{AccessGuard, JetTokenType};
+use crate::http::HttpErrorStatus;
+use jet_proto::token::JetAccessScope;
+use saphir::prelude::*;
+use std::sync::Arc;
+
+pub struct DiagnosticsController {
+    config: Arc<Config>,
+}
+
+impl DiagnosticsController {
+    pub fn new(config: Arc<Config>) -> Self {
+        DiagnosticsController { config }
+    }
+}
+
+#[controller(name = "diagnostics")]
+impl DiagnosticsController {
+    #[get("/logs")]
+    #[guard(
+        AccessGuard,
+        init_expr = r#"JetTokenType::Scope(JetAccessScope::GatewayDiagnosticsRead)"#
+    )]
+    async fn get_logs(&self) -> Result<File, HttpErrorStatus> {
+        let log_file_path = self
+            .config
+            .log_file
+            .as_ref()
+            .ok_or_else(|| HttpErrorStatus::not_found("Log file is not configured"))?;
+        File::open(log_file_path).await.map_err(HttpErrorStatus::internal)
+    }
+}

devolutions-gateway/src/http/controllers/mod.rs

@@ -1,3 +1,4 @@
+pub mod diagnostics;
 pub mod health;
 pub mod http_bridge;
 pub mod jet;

devolutions-gateway/src/http/http_server.rs

@@ -1,4 +1,5 @@
 use crate::config::Config;
+use crate::http::controllers::diagnostics::DiagnosticsController;
 use crate::http::controllers::health::HealthController;
 use crate::http::controllers::http_bridge::HttpBridgeController;
 use crate::http::controllers::jet::JetController;
@@ -36,7 +37,9 @@ pub fn configure_http_server(config: Arc<Config>, jet_associations: JetAssociati
         })
         .configure_router(|router| {
             info!("Loading HTTP controllers");
+            let diagnostics = DiagnosticsController::new(config.clone());
             let health = HealthController::new(config.clone());
+            let http_bridge = HttpBridgeController::new();
             let jet = JetController::new(config.clone(), jet_associations.clone());
             let session = SessionsController;
 
@@ -55,17 +58,16 @@ pub fn configure_http_server(config: Arc<Config>, jet_associations: JetAssociati
             let sogar = SogarController::new(registry_name.as_str(), registry_namespace.as_str());
             let token_controller = TokenController::new(config.clone());
 
-            let http_bridge = HttpBridgeController::new();
-
             info!("Configuring HTTP router");
 
             router
+                .controller(diagnostics)
                 .controller(health)
+                .controller(http_bridge)
                 .controller(jet)
                 .controller(session)
                 .controller(sogar)
                 .controller(token_controller)
-                .controller(http_bridge)
         })
         .configure_listener(|listener| listener.server_name("Devolutions Gateway"))
         .build_stack_only()

devolutions-gateway/src/http/mod.rs

@@ -57,6 +57,11 @@ impl HttpErrorStatus {
     fn bad_gateway<T: Display + Send + 'static>(source: T) -> Self {
         Self::new(StatusCode::BAD_GATEWAY, source)
     }
+
+    #[track_caller]
+    fn not_found<T: Display + Send + 'static>(source: T) -> Self {
+        Self::new(StatusCode::NOT_FOUND, source)
+    }
 }
 
 impl Responder for HttpErrorStatus {

jet-proto/src/token.rs

@@ -73,6 +73,8 @@ pub enum JetAccessScope {
     GatewaySessionsRead,
     #[serde(rename = "gateway.associations.read")]
     GatewayAssociationsRead,
+    #[serde(rename = "gateway.diagnostics.read")]
+    GatewayDiagnosticsRead,
 }
 
 #[derive(Clone, Deserialize)]