[hermes] Add health probe

Author: ali-behjati

hermes/src/api.rs

@@ -45,6 +45,8 @@ pub async fn run(store: Arc<Store>, mut update_rx: Receiver<()>, rpc_addr: Strin
     let app = app
         .route("/", get(rest::index))
         .route("/live", get(rest::live))
+        .route("/ready", get(rest::ready))
+        .route("/health", get(rest::health))
         .route("/ws", get(ws::ws_route_handler))
         .route("/api/latest_price_feeds", get(rest::latest_price_feeds))
         .route("/api/latest_vaas", get(rest::latest_vaas))

hermes/src/api/rest.rs

@@ -250,17 +250,35 @@ pub async fn get_vaa_ccip(
     }))
 }
 
-// This function implements the `/live` endpoint. It returns a `200` status code. This endpoint is
-// used by the Kubernetes liveness probe.
-pub async fn live() -> Result<impl IntoResponse, std::convert::Infallible> {
-    Ok(())
+pub async fn live() -> Response {
+    (StatusCode::OK, "OK").into_response()
+}
+
+// This endpoint is the same as health and is provided for backward compatibility
+// with the price service.
+pub async fn ready(State(state): State<super::State>) -> Response {
+    match state.store.is_healthy().await {
+        true => (StatusCode::OK, "OK").into_response(),
+        false => (StatusCode::SERVICE_UNAVAILABLE, "Service Unavailable").into_response(),
+    }
+}
+
+// This endpoint serves as a health check for this service. Previously `ready` was used
+// for this purpose, but now health is used because it is more standard.
+pub async fn health(State(state): State<super::State>) -> Response {
+    match state.store.is_healthy().await {
+        true => (StatusCode::OK, "OK").into_response(),
+        false => (StatusCode::SERVICE_UNAVAILABLE, "Service Unavailable").into_response(),
+    }
 }
 
 // This is the index page for the REST service. It will list all the available endpoints.
 // TODO: Dynamically generate this list if possible.
 pub async fn index() -> impl IntoResponse {
     Json([
         "/live",
+        "/ready",
+        "/health",
         "/api/price_feed_ids",
         "/api/latest_price_feeds?ids[]=<price_feed_id>&ids[]=<price_feed_id_2>&..(&verbose=true)(&binary=true)",
         "/api/latest_vaas?ids[]=<price_feed_id>&ids[]=<price_feed_id_2>&...",

hermes/src/store.rs

@@ -50,14 +50,19 @@ use {
         },
         sync::Arc,
         time::{
-            Duration,
             SystemTime,
             UNIX_EPOCH,
         },
     },
-    tokio::sync::{
-        mpsc::Sender,
-        RwLock,
+    tokio::{
+        sync::{
+            mpsc::Sender,
+            RwLock,
+        },
+        time::{
+            Duration,
+            Instant,
+        },
     },
     wormhole_sdk::{
         Address,
@@ -72,10 +77,11 @@ pub mod types;
 pub mod wormhole;
 
 pub struct Store {
-    pub storage:           StorageInstance,
-    pub observed_vaa_seqs: Cache<u64, bool>,
-    pub guardian_set:      RwLock<BTreeMap<u32, GuardianSet>>,
-    pub update_tx:         Sender<()>,
+    pub storage:                  StorageInstance,
+    pub observed_vaa_seqs:        Cache<u64, bool>,
+    pub guardian_set:             RwLock<BTreeMap<u32, GuardianSet>>,
+    pub update_tx:                Sender<()>,
+    pub last_completed_update_at: RwLock<Option<Instant>>,
 }
 
 impl Store {
@@ -88,6 +94,7 @@ impl Store {
                 .build(),
             guardian_set: RwLock::new(Default::default()),
             update_tx,
+            last_completed_update_at: RwLock::new(None),
         })
     }
 
@@ -168,6 +175,11 @@ impl Store {
 
         self.update_tx.send(()).await?;
 
+        self.last_completed_update_at
+            .write()
+            .await
+            .replace(Instant::now());
+
         Ok(())
     }
 
@@ -256,4 +268,16 @@ impl Store {
             .map(|key| PriceIdentifier::new(key.id))
             .collect()
     }
+
+    pub async fn is_healthy(&self) -> bool {
+        const STALENESS_THRESHOLD: Duration = Duration::from_secs(30);
+
+        let last_completed_update_at = self.last_completed_update_at.read().await;
+        match last_completed_update_at.as_ref() {
+            Some(last_completed_update_at) => {
+                last_completed_update_at.elapsed() < STALENESS_THRESHOLD
+            }
+            None => false,
+        }
+    }
 }