Merge torrust#1416: Feature: Add listen_url field to the health check API

abfb733 feat: [torrust#1409] add listen_url field to the health check API (Jose Celano)

Pull request description:

  Added an extra `listen_url` field to th health check API endpoint:

  http://127.0.0.1:1313/health_check

  ```json
  {
    "status": "Ok",
    "message": "",
    "details": [
      {
        "listen_url": "http://0.0.0.0:7070/",
        "binding": "0.0.0.0:7070",
        "service_type": "http_tracker",
        "info": "checking http tracker health check at: http://0.0.0.0:7070/health_check",
        "result": {
          "Ok": "200 OK"
        }
      }
    ]
  }
  ```

  It includes the protocol + binding address.

  The `binding` is not removed for back compatibility.

  **NOTICE:** HTTP URLs contain the trailing slash `"listen_url": "http://0.0.0.0:1212/"` because it's the default behavior.

ACKs for top commit:
  josecelano:
    ACK abfb733

Tree-SHA512: 4a063580890add1a06d99d4e41717b01577423a68ac4b492c394b352575b4ed30f93d99c35b9654ac8ba28bd117a8405b6e7dfe1fa5a98e0d93b71c8afea95e9

Author: josecelano

Cargo.lock

@@ -26,6 +26,7 @@ torrust-server-lib = { version = "3.0.0-develop", path = "../server-lib" }
 torrust-tracker-configuration = { version = "3.0.0-develop", path = "../configuration" }
 tower-http = { version = "0", features = ["compression-full", "cors", "propagate-header", "request-id", "trace"] }
 tracing = "0"
+url = "2.5.4"
 
 [dev-dependencies]
 reqwest = { version = "0", features = ["json"] }

packages/axum-health-check-api-server/Cargo.toml

@@ -31,6 +31,7 @@ pub(crate) async fn health_check_handler(State(register): State<ServiceRegistry>
     let jobs = checks.drain(..).map(|c| {
         tokio::spawn(async move {
             CheckReport {
+                listen_url: c.listen_url.clone(),
                 binding: c.binding,
                 info: c.info.clone(),
                 service_type: c.service_type,

packages/axum-health-check-api-server/src/handlers.rs

@@ -1,6 +1,7 @@
 use std::net::SocketAddr;
 
 use serde::{Deserialize, Serialize};
+use url::Url;
 
 #[derive(Copy, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
 pub enum Status {
@@ -11,6 +12,7 @@ pub enum Status {
 
 #[derive(Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
 pub struct CheckReport {
+    pub listen_url: Url,
     pub binding: SocketAddr,
     pub service_type: String,
     pub info: String,

packages/axum-health-check-api-server/src/resources.rs

@@ -25,6 +25,7 @@ use tower_http::request_id::{MakeRequestUuid, SetRequestIdLayer};
 use tower_http::trace::{DefaultMakeSpan, TraceLayer};
 use tower_http::LatencyUnit;
 use tracing::{instrument, Level, Span};
+use url::Url;
 
 use crate::handlers::health_check_handler;
 use crate::HEALTH_CHECK_API_LOG_TARGET;
@@ -101,6 +102,9 @@ pub fn start(
 
     let socket = std::net::TcpListener::bind(bind_to).expect("Could not bind tcp_listener to address.");
     let address = socket.local_addr().expect("Could not get local_addr from tcp_listener.");
+    let protocol = "http"; // The health check API only supports HTTP directly now. Use a reverse proxy for HTTPS.
+    let listen_url =
+        Url::parse(&format!("{protocol}://{address}")).expect("Could not parse internal service url for health check API.");
 
     let handle = Handle::new();
 
@@ -116,7 +120,7 @@ pub fn start(
         .handle(handle)
         .serve(router.into_make_service_with_connect_info::<SocketAddr>());
 
-    tx.send(Started { address })
+    tx.send(Started { listen_url, address })
         .expect("the Health Check API server should not be dropped");
 
     running

packages/axum-health-check-api-server/src/server.rs

@@ -7,6 +7,7 @@ use axum_server::Handle;
 use bittorrent_http_tracker_core::container::HttpTrackerCoreContainer;
 use derive_more::Constructor;
 use futures::future::BoxFuture;
+use reqwest::Url;
 use tokio::sync::oneshot::{Receiver, Sender};
 use torrust_axum_server::custom_axum_server::{self, TimeoutAcceptor};
 use torrust_axum_server::signals::graceful_shutdown;
@@ -63,8 +64,10 @@ impl Launcher {
 
         let tls = self.tls.clone();
         let protocol = if tls.is_some() { "https" } else { "http" };
+        let listen_url =
+            Url::parse(&format!("{protocol}://{address}")).expect("Could not parse internal service url for HTTP tracker.");
 
-        tracing::info!(target: HTTP_TRACKER_LOG_TARGET, "Starting on: {protocol}://{}", address);
+        tracing::info!(target: HTTP_TRACKER_LOG_TARGET, "Starting on: {protocol}://{address}");
 
         let app = router(http_tracker_container, address);
 
@@ -90,7 +93,7 @@ impl Launcher {
         tracing::info!(target: HTTP_TRACKER_LOG_TARGET, "{STARTED_ON}: {protocol}://{}", address);
 
         tx_start
-            .send(Started { address })
+            .send(Started { listen_url, address })
             .expect("the HTTP(s) Tracker service should not be dropped");
 
         running
@@ -177,9 +180,12 @@ impl HttpServer<Stopped> {
             launcher
         });
 
-        let binding = rx_start.await.expect("it should be able to start the service").address;
+        let started = rx_start.await.expect("it should be able to start the service");
 
-        form.send(ServiceRegistration::new(binding, check_fn))
+        let listen_url = started.listen_url;
+        let binding = started.address;
+
+        form.send(ServiceRegistration::new(listen_url, binding, check_fn))
             .expect("it should be able to send service registration");
 
         Ok(HttpServer {
@@ -220,7 +226,7 @@ impl HttpServer<Running> {
 /// This function will return an error if unable to connect.
 /// Or if the request returns an error.
 #[must_use]
-pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
+pub fn check_fn(listen_url: &Url, binding: &SocketAddr) -> ServiceHealthCheckJob {
     let url = format!("http://{binding}/health_check"); // DevSkim: ignore DS137138
 
     let info = format!("checking http tracker health check at: {url}");
@@ -232,7 +238,7 @@ pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
         }
     });
 
-    ServiceHealthCheckJob::new(*binding, info, TYPE_STRING.to_string(), job)
+    ServiceHealthCheckJob::new(listen_url.clone(), *binding, info, TYPE_STRING.to_string(), job)
 }
 
 #[cfg(test)]

packages/axum-http-tracker-server/src/server.rs

@@ -42,6 +42,7 @@ torrust-udp-tracker-server = { version = "3.0.0-develop", path = "../udp-tracker
 tower = { version = "0", features = ["timeout"] }
 tower-http = { version = "0", features = ["compression-full", "cors", "propagate-header", "request-id", "trace"] }
 tracing = "0"
+url = "2"
 
 [dev-dependencies]
 local-ip-address = "0"

packages/axum-rest-tracker-api-server/Cargo.toml

@@ -41,6 +41,7 @@ use torrust_server_lib::registar::{ServiceHealthCheckJob, ServiceRegistration, S
 use torrust_server_lib::signals::{Halted, Started};
 use torrust_tracker_configuration::AccessTokens;
 use tracing::{instrument, Level};
+use url::Url;
 
 use super::routes::router;
 use crate::API_LOG_TARGET;
@@ -148,7 +149,7 @@ impl ApiServer<Stopped> {
 
         let api_server = match rx_start.await {
             Ok(started) => {
-                form.send(ServiceRegistration::new(started.address, check_fn))
+                form.send(ServiceRegistration::new(started.listen_url, started.address, check_fn))
                     .expect("it should be able to send service registration");
 
                 ApiServer {
@@ -195,7 +196,7 @@ impl ApiServer<Running> {
 /// Or if there request returns an error code.
 #[must_use]
 #[instrument(skip())]
-pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
+pub fn check_fn(listen_url: &Url, binding: &SocketAddr) -> ServiceHealthCheckJob {
     let url = format!("http://{binding}/api/health_check"); // DevSkim: ignore DS137138
 
     let info = format!("checking api health check at: {url}");
@@ -206,7 +207,7 @@ pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
             Err(err) => Err(err.to_string()),
         }
     });
-    ServiceHealthCheckJob::new(*binding, info, TYPE_STRING.to_string(), job)
+    ServiceHealthCheckJob::new(listen_url.clone(), *binding, info, TYPE_STRING.to_string(), job)
 }
 
 /// A struct responsible for starting the API server.
@@ -260,8 +261,10 @@ impl Launcher {
 
         let tls = self.tls.clone();
         let protocol = if tls.is_some() { "https" } else { "http" };
+        let listen_url =
+            Url::parse(&format!("{protocol}://{address}")).expect("Could not parse internal service url for tracker API.");
 
-        tracing::info!(target: API_LOG_TARGET, "Starting on {protocol}://{}", address);
+        tracing::info!(target: API_LOG_TARGET, "Starting on: {protocol}://{address}");
 
         let running = Box::pin(async {
             match tls {
@@ -282,10 +285,10 @@ impl Launcher {
             }
         });
 
-        tracing::info!(target: API_LOG_TARGET, "{STARTED_ON} {protocol}://{}", address);
+        tracing::info!(target: API_LOG_TARGET, "{STARTED_ON}: {protocol}://{}", address);
 
         tx_start
-            .send(Started { address })
+            .send(Started { listen_url, address })
             .expect("the HTTP(s) Tracker API service should not be dropped");
 
         running

packages/axum-rest-tracker-api-server/src/server.rs

@@ -18,5 +18,6 @@ derive_more = { version = "2", features = ["as_ref", "constructor", "from"] }
 tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
 tower-http = { version = "0", features = ["compression-full", "cors", "propagate-header", "request-id", "trace"] }
 tracing = "0"
+url = "2.5.4"
 
 [dev-dependencies]

packages/server-lib/Cargo.toml

@@ -10,7 +10,7 @@ use tower_http::LatencyUnit;
 /// ```text
 /// 2024-06-25T12:36:25.025312Z  INFO UDP TRACKER: Started on: udp://0.0.0.0:6969
 /// 2024-06-25T12:36:25.025445Z  INFO HTTP TRACKER: Started on: http://0.0.0.0:7070
-/// 2024-06-25T12:36:25.025527Z  INFO API: Started on http://0.0.0.0:1212
+/// 2024-06-25T12:36:25.025527Z  INFO API: Started on: http://0.0.0.0:1212
 /// 2024-06-25T12:36:25.025580Z  INFO HEALTH CHECK API: Started on: http://127.0.0.1:1313
 /// ```
 pub const STARTED_ON: &str = "Started on";