fix: adds health check for indexer (#653)

Adds a health check for the indexer service to ensure it is ready before proceeding.

This change introduces a generic function to wait for a service to become ready via health check.

The changes modify the LocalNet startup process to wait for both algod and indexer to be healthy before considering the LocalNet fully started.

Author: aorumbayev

poetry.lock

@@ -202,7 +202,7 @@ def up(self) -> None:
             bad_return_code_error_message="Failed to start LocalNet",
         )
         logger.debug("AlgoKit LocalNet started, waiting for health check")
-        if _wait_for_algod():
+        if _wait_for_algod() and _wait_for_indexer():
             logger.info("Started; execute `algokit explore` to explore LocalNet in a web user interface.")
         else:
             logger.warning("AlgoKit LocalNet failed to return a successful health check")
@@ -305,34 +305,63 @@ def check_docker_compose_for_new_image_versions(self) -> None:
 DEFAULT_ALGOD_PORT = 4001
 DEFAULT_INDEXER_PORT = 8980
 DEFAULT_WAIT_FOR_ALGOD = 60
+DEFAULT_WAIT_FOR_INDEXER = 60
 DEFAULT_HEALTH_TIMEOUT = 1
 ALGOD_HEALTH_URL = f"{DEFAULT_ALGOD_SERVER}:{DEFAULT_ALGOD_PORT}/v2/status"
+INDEXER_HEALTH_URL = f"{DEFAULT_INDEXER_SERVER}:{DEFAULT_INDEXER_PORT}/health"
 INDEXER_IMAGE = "algorand/indexer:latest"
 ALGORAND_IMAGE = "algorand/algod:latest"
 CONDUIT_IMAGE = "algorand/conduit:latest"
 
 
-def _wait_for_algod() -> bool:
-    end_time = time.time() + DEFAULT_WAIT_FOR_ALGOD
+def _wait_for_service(
+    url: str,
+    token: str,
+    header_name: str,
+    service_name: str,
+    timeout: int = DEFAULT_WAIT_FOR_ALGOD,
+) -> bool:
+    """Generic function to wait for a service to become ready via health check."""
+    end_time = time.time() + timeout
     last_exception: httpx.RequestError | None = None
     while time.time() < end_time:
         try:
-            health = httpx.get(
-                ALGOD_HEALTH_URL, timeout=DEFAULT_HEALTH_TIMEOUT, headers={"X-Algo-API-Token": DEFAULT_ALGOD_TOKEN}
-            )
+            health = httpx.get(url, timeout=DEFAULT_HEALTH_TIMEOUT, headers={header_name: token})
         except httpx.RequestError as ex:
             last_exception = ex
         else:
             if health.is_success:
-                logger.debug("AlgoKit LocalNet health check successful, algod is ready")
+                logger.debug(f"AlgoKit LocalNet health check successful, {service_name} is ready")
                 return True
             logger.debug(f"AlgoKit LocalNet health check returned {health.status_code}, waiting")
         time.sleep(DEFAULT_HEALTH_TIMEOUT)
     if last_exception:
-        logger.debug("AlgoKit LocalNet health request failed", exc_info=last_exception)
+        logger.debug(f"AlgoKit LocalNet health request failed for {service_name}", exc_info=last_exception)
     return False
 
 
+def _wait_for_algod() -> bool:
+    """Wait for algod service to become ready."""
+    return _wait_for_service(
+        ALGOD_HEALTH_URL,
+        DEFAULT_ALGOD_TOKEN,
+        "X-Algo-API-Token",
+        "algod",
+        DEFAULT_WAIT_FOR_ALGOD,
+    )
+
+
+def _wait_for_indexer() -> bool:
+    """Wait for indexer service to become ready."""
+    return _wait_for_service(
+        INDEXER_HEALTH_URL,
+        DEFAULT_INDEXER_TOKEN,
+        "X-Indexer-API-Token",
+        "indexer",
+        DEFAULT_WAIT_FOR_INDEXER,
+    )
+
+
 def get_config_json() -> str:
     return (
         '{ "Version": 12, "GossipFanout": 1, "EndpointAddress": "0.0.0.0:8080", "DNSBootstrapID": "",'

src/algokit/core/sandbox.py

@@ -5,6 +5,7 @@
 import pytest
 from algokit.core.sandbox import (
     ALGOD_HEALTH_URL,
+    INDEXER_HEALTH_URL,
     get_algod_network_template,
     get_config_json,
     get_docker_compose_yml,
@@ -28,6 +29,7 @@ def _normalize_output(output: str) -> str:
 @pytest.fixture()
 def _health_success(httpx_mock: HTTPXMock) -> None:
     httpx_mock.add_response(url=ALGOD_HEALTH_URL)
+    httpx_mock.add_response(url=INDEXER_HEALTH_URL)
 
 
 @pytest.fixture()

tests/goal/test_goal.py

@@ -13,6 +13,8 @@ DEBUG: Running '{container_engine} compose up --detach --quiet-pull --wait' in '
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.
 Opening Bash console on the algod node; execute `exit` to return to original console
 DEBUG: Running '{container_engine} exec -it -w /root algokit_sandbox_algod bash' in '{current_working_directory}'

tests/goal/test_goal.test_goal_console_algod_not_created.approved.txt

@@ -1,7 +1,7 @@
 import json
 
 import pytest
-from algokit.core.sandbox import ALGOD_HEALTH_URL, ALGORAND_IMAGE, INDEXER_IMAGE
+from algokit.core.sandbox import ALGOD_HEALTH_URL, ALGORAND_IMAGE, INDEXER_HEALTH_URL, INDEXER_IMAGE
 from pytest_httpx import HTTPXMock
 from pytest_mock import MockerFixture
 
@@ -12,12 +12,14 @@
 @pytest.fixture(autouse=True)
 def _algod_health_fast_timings(mocker: MockerFixture) -> None:
     mocker.patch("algokit.core.sandbox.DEFAULT_WAIT_FOR_ALGOD", 0.1)
+    mocker.patch("algokit.core.sandbox.DEFAULT_WAIT_FOR_INDEXER", 0.1)
     mocker.patch("algokit.core.sandbox.DEFAULT_HEALTH_TIMEOUT", 0.1)
 
 
 @pytest.fixture()
 def _health_success(httpx_mock: HTTPXMock) -> None:
     httpx_mock.add_response(url=ALGOD_HEALTH_URL)
+    httpx_mock.add_response(url=INDEXER_HEALTH_URL)
 
 
 @pytest.fixture()

tests/localnet/conftest.py

@@ -23,6 +23,8 @@ docker: STDERR
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.
 
 {app_config}/sandbox/docker-compose.yml

tests/localnet/test_localnet_reset.test_localnet_reset_with_existing_sandbox_with_out_of_date_config.approved.txt

@@ -22,4 +22,6 @@ docker: STDERR
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.

tests/localnet/test_localnet_reset.test_localnet_reset_with_existing_sandbox_with_up_to_date_config.approved.txt

@@ -20,4 +20,6 @@ docker: STDERR
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.

tests/localnet/test_localnet_reset.test_localnet_reset_with_existing_sandbox_with_up_to_date_config_with_pull.approved.txt

@@ -16,4 +16,6 @@ docker: STDERR
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.

tests/localnet/test_localnet_reset.test_localnet_reset_with_named_sandbox_config.approved.txt

@@ -14,6 +14,8 @@ docker: STDERR
 DEBUG: AlgoKit LocalNet started, waiting for health check
 HTTP Request: GET http://localhost:4001/v2/status "HTTP/1.1 200 OK"
 DEBUG: AlgoKit LocalNet health check successful, algod is ready
+HTTP Request: GET http://localhost:8980/health "HTTP/1.1 200 OK"
+DEBUG: AlgoKit LocalNet health check successful, indexer is ready
 Started; execute `algokit explore` to explore LocalNet in a web user interface.
 ----
 {app_config}/sandbox/docker-compose.yml: