fix: readyz returns 503 (#5516)

Co-authored-by: Hubert <[email protected]>
Co-authored-by: Guillaume Potier <[email protected]>

Author: 3 people

scripts/tests/api_compare/docker-compose.yml

@@ -17,6 +17,7 @@ services:
     command:
       - |
         set -euxo pipefail
+        forest --version
         # fetch parameter files
         forest-tool fetch-params --keys
         # if there are some files in the data directory, then we don't need to fetch the snapshot

scripts/tests/calibnet_eth_mapping_check.sh

@@ -6,7 +6,6 @@ set -eu
 
 source "$(dirname "$0")/harness.sh"
 
-export FOREST_CHAIN_INDEXER_ENABLED=1
 forest_init
 
 FOREST_URL='http://127.0.0.1:2345/rpc/v1'

scripts/tests/calibnet_other_check.sh

@@ -41,3 +41,12 @@ echo "Test subcommand: net info"
 $FOREST_CLI_PATH net info
 
 $FOREST_CLI_PATH sync wait # allow the node to re-sync
+
+echo "Test subcommand: healthcheck live"
+$FOREST_CLI_PATH healthcheck live --wait
+
+echo "Test subcommand: healthcheck healthy"
+$FOREST_CLI_PATH healthcheck healthy --wait
+
+echo "Test subcommand: healthcheck ready"
+$FOREST_CLI_PATH healthcheck ready --wait

scripts/tests/harness.sh

@@ -3,17 +3,18 @@
 # the Forest tests. It is meant to be sourced by other scripts and not
 # executed directly.
 
-FOREST_PATH="forest"
-FOREST_CLI_PATH="forest-cli"
-FOREST_WALLET_PATH="forest-wallet"
-FOREST_TOOL_PATH="forest-tool"
+export FOREST_CHAIN_INDEXER_ENABLED="1"
+
+export FOREST_PATH="forest"
+export FOREST_CLI_PATH="forest-cli"
+export FOREST_WALLET_PATH="forest-wallet"
+export FOREST_TOOL_PATH="forest-tool"
 
 TMP_DIR=$(mktemp --directory)
 LOG_DIRECTORY=$TMP_DIR/logs
 
 export TMP_DIR
 export LOG_DIRECTORY
-export FOREST_WALLET_PATH
 
 function forest_import_non_calibnet_snapshot {
   echo "Importing a non calibnet snapshot"

src/cli/subcommands/healthcheck_cmd.rs

@@ -76,9 +76,24 @@ impl HealthcheckCommand {
         );
 
         for _ in ticker {
-            let response = reqwest::get(&url).await?;
-            let status = response.status();
-            let text = response.text().await?;
+            let (status, text) = {
+                match reqwest::get(&url).await {
+                    Ok(response) => {
+                        let status = response.status();
+                        let text = match response.text().await {
+                            Ok(t) => t,
+                            Err(e) if wait => e.to_string(),
+                            Err(e) => anyhow::bail!("{e}"),
+                        };
+                        (status, text)
+                    }
+                    Err(e) if wait => {
+                        eprintln!("{e}");
+                        (http::StatusCode::INTERNAL_SERVER_ERROR, "".into())
+                    }
+                    Err(e) => anyhow::bail!("{e}"),
+                }
+            };
 
             println!("{}", text);
 

src/daemon/mod.rs

@@ -387,13 +387,16 @@ async fn maybe_start_health_check_service(
             peer_manager: p2p_service.peer_manager().clone(),
             settings_store: ctx.db.writer().clone(),
         };
-        let listener =
-            tokio::net::TcpListener::bind(forest_state.config.client.healthcheck_address).await?;
+        let healthcheck_address = forest_state.config.client.healthcheck_address;
+        info!("Healthcheck endpoint will listen at {healthcheck_address}");
+        let listener = tokio::net::TcpListener::bind(healthcheck_address).await?;
         services.spawn(async move {
             crate::health::init_healthcheck_server(forest_state, listener)
                 .await
                 .context("Failed to initiate healthcheck server")
         });
+    } else {
+        info!("Healthcheck service is disabled");
     }
     Ok(())
 }

src/health/endpoints.rs

@@ -165,15 +165,20 @@ fn check_peers_connected(state: &ForestState, acc: &mut MessageAccumulator) -> b
 }
 
 fn check_eth_mappings_up_to_date(state: &ForestState, acc: &mut MessageAccumulator) -> bool {
-    match state.settings_store.eth_mapping_up_to_date() {
-        Ok(Some(true)) => {
-            acc.push_ok("eth mappings up to date");
-            true
-        }
-        Ok(None) | Ok(Some(false)) | Err(_) => {
-            acc.push_err("no eth mappings");
-            false
+    if state.config.chain_indexer.enable_indexer {
+        match state.settings_store.eth_mapping_up_to_date() {
+            Ok(Some(true)) => {
+                acc.push_ok("eth mappings up to date");
+                true
+            }
+            Ok(None) | Ok(Some(false)) | Err(_) => {
+                acc.push_err("no eth mappings");
+                false
+            }
         }
+    } else {
+        acc.push_err("eth mappings disabled");
+        true
     }
 }