feat: first endpoint: /healthz

Author: bitfl0wer

Cargo.lock

@@ -29,6 +29,7 @@ serde_with = "3.13.0"
 thiserror = "2.0.12"
 chrono = "0.4.41"
 bigdecimal = "0.4.8"
+serde_json = "1.0.140"
 
 [dev-dependencies]
 tokio-test = "0.4"

Cargo.toml

@@ -2,5 +2,66 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+use log::info;
+use poem::http::{Method, StatusCode};
+use poem::listener::TcpListener;
+use poem::middleware::{Cors, NormalizePath};
+use poem::web::Json;
+use poem::{EndpointExt, IntoResponse, Response, Route, Server, handler};
+use serde_json::json;
+
+use crate::config::ApiConfig;
+use crate::database::Database;
+
 /// Admin-only functionality.
 pub(super) mod admin;
+
+#[allow(clippy::expect_used)]
+/// Build the API [Route]s and start a `tokio::task`, which is a poem [Server] processing incoming
+/// HTTP API requests.
+pub(super) fn start_api(api_config: ApiConfig, db: Database) -> tokio::task::JoinHandle<()> {
+    let routes = Route::new()
+        .at("/healthz", healthz)
+        .nest("/.p2/core/", setup_p2_core_routes())
+        .with(NormalizePath::new(poem::middleware::TrailingSlash::Trim))
+        .with(Cors::new().allow_methods(&[
+            Method::CONNECT,
+            Method::GET,
+            Method::POST,
+            Method::PUT,
+            Method::DELETE,
+            Method::PATCH,
+            Method::OPTIONS,
+        ]))
+        .catch_all_error(custom_error)
+        .data(db);
+
+    let handle = tokio::task::spawn(async move {
+        Server::new(TcpListener::bind((api_config.host.as_str().trim(), api_config.port)))
+            .run(routes)
+            .await
+            .expect("Failed to start HTTP server");
+        log::info!("HTTP Server stopped");
+    });
+    info!("Started HTTP API server");
+    handle
+}
+
+/// Catch-all fallback error.
+async fn custom_error(err: poem::Error) -> impl IntoResponse {
+    Json(json! ({
+        "success": false,
+        "message": err.to_string(),
+    }))
+    .with_status(err.status())
+}
+
+#[handler]
+fn healthz() -> impl IntoResponse {
+    Response::builder().status(StatusCode::OK).finish()
+}
+
+/// All routes under `/.p2/core/`.
+fn setup_p2_core_routes() -> Route {
+    Route::new()
+}

src/api/mod.rs

@@ -26,7 +26,7 @@ const TLS_CONFIG_VERIFY_CA: &str = "verify_ca";
 /// PostgreSQL: TLS Required with TLS certificate authority and subject verification
 const TLS_CONFIG_VERIFY_FULL: &str = "verify_full";
 
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 /// The `sonata.toml` configuration file as Rust structs.
 pub struct SonataConfig {
     /// API module configuration
@@ -37,7 +37,7 @@ pub struct SonataConfig {
     pub general: GeneralConfig,
 }
 
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 /// API Module configuration
 pub struct ApiConfig {
     #[serde(flatten)]
@@ -53,7 +53,7 @@ impl Deref for ApiConfig {
     }
 }
 
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 /// Gateway module configuration
 pub struct GatewayConfig {
     #[serde(flatten)]
@@ -69,15 +69,15 @@ impl Deref for GatewayConfig {
     }
 }
 
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 /// General configuration, consisting of database configuration
 pub struct GeneralConfig {
     /// Database configuration, including host, port, password, etc.
     pub database: DatabaseConfig,
 }
 
 #[serde_as]
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 pub struct DatabaseConfig {
     /// How many connections to allocate for this connection pool at maximum.
     /// PostgreSQLs default value is 100.
@@ -98,7 +98,7 @@ pub struct DatabaseConfig {
     pub tls: TlsConfig,
 }
 
-#[derive(Deserialize, Debug)]
+#[derive(Deserialize, Debug, Clone)]
 pub struct ComponentConfig {
     /// Whether this component is enabled.
     pub enabled: bool,
@@ -129,7 +129,7 @@ impl SonataConfig {
     }
 }
 
-#[derive(Debug, Deserialize, Default)]
+#[derive(Debug, Deserialize, Default, Clone)]
 /// TLS configuration modes. Also called `sslconfig` by PostgreSQL. See <https://www.postgresql.org/docs/current/libpq-ssl.html#:~:text=32.1.%C2%A0SSL%20Mode-,descriptions,-sslmode>
 /// for the security implications of this choice.
 pub enum TlsConfig {

src/config/mod.rs

@@ -117,6 +117,13 @@ async fn main() -> StdResult<()> {
         _ => (),
     };
 
+    let mut tasks =
+        vec![api::start_api(SonataConfig::get_or_panic().api.clone(), database.clone())];
+
+    for task in tasks.into_iter() {
+        task.await.unwrap()
+    }
+
     Ok(())
 }