system_status_server.rs 33.8 KB
Newer Older
1
2
3
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

4
use crate::config::HealthStatus;
5
6
7
use crate::config::environment_names::logging as env_logging;
use crate::config::environment_names::runtime::canary as env_canary;
use crate::config::environment_names::runtime::system as env_system;
8
use crate::logging::make_request_span;
9
use crate::metrics::MetricsHierarchy;
10
use crate::metrics::prometheus_names::{nats_client, nats_service};
11
use crate::traits::DistributedRuntimeProvider;
12
use axum::{Router, http::StatusCode, response::IntoResponse, routing::get};
13
use serde_json::json;
14
use std::collections::HashMap;
15
use std::sync::{Arc, OnceLock};
16
use std::time::Instant;
17
use tokio::{net::TcpListener, task::JoinHandle};
18
use tokio_util::sync::CancellationToken;
19
use tower_http::trace::TraceLayer;
20

21
/// System status server information containing socket address and handle
22
#[derive(Debug)]
23
pub struct SystemStatusServerInfo {
24
25
26
27
    pub socket_addr: std::net::SocketAddr,
    pub handle: Option<Arc<JoinHandle<()>>>,
}

28
impl SystemStatusServerInfo {
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    pub fn new(socket_addr: std::net::SocketAddr, handle: Option<JoinHandle<()>>) -> Self {
        Self {
            socket_addr,
            handle: handle.map(Arc::new),
        }
    }

    pub fn address(&self) -> String {
        self.socket_addr.to_string()
    }

    pub fn hostname(&self) -> String {
        self.socket_addr.ip().to_string()
    }

    pub fn port(&self) -> u16 {
        self.socket_addr.port()
    }
}

49
impl Clone for SystemStatusServerInfo {
50
51
52
53
54
55
56
57
    fn clone(&self) -> Self {
        Self {
            socket_addr: self.socket_addr,
            handle: self.handle.clone(),
        }
    }
}

58
/// System status server state containing the distributed runtime reference
59
pub struct SystemStatusState {
60
61
    // global drt registry is for printing out the entire Prometheus format output
    root_drt: Arc<crate::DistributedRuntime>,
62
63
    // Discovery metadata (only for Kubernetes backend)
    discovery_metadata: Option<Arc<tokio::sync::RwLock<crate::discovery::DiscoveryMetadata>>>,
64
65
}

66
impl SystemStatusState {
67
    /// Create new system status server state with the provided distributed runtime
68
69
70
71
72
73
74
75
    pub fn new(
        drt: Arc<crate::DistributedRuntime>,
        discovery_metadata: Option<Arc<tokio::sync::RwLock<crate::discovery::DiscoveryMetadata>>>,
    ) -> anyhow::Result<Self> {
        Ok(Self {
            root_drt: drt,
            discovery_metadata,
        })
76
77
78
79
80
81
    }

    /// Get a reference to the distributed runtime
    pub fn drt(&self) -> &crate::DistributedRuntime {
        &self.root_drt
    }
82
83
84
85
86
87
88

    /// Get a reference to the discovery metadata if available
    pub fn discovery_metadata(
        &self,
    ) -> Option<&Arc<tokio::sync::RwLock<crate::discovery::DiscoveryMetadata>>> {
        self.discovery_metadata.as_ref()
    }
89
90
}

91
92
/// Start system status server with metrics support
pub async fn spawn_system_status_server(
93
94
95
96
    host: &str,
    port: u16,
    cancel_token: CancellationToken,
    drt: Arc<crate::DistributedRuntime>,
97
    discovery_metadata: Option<Arc<tokio::sync::RwLock<crate::discovery::DiscoveryMetadata>>>,
98
) -> anyhow::Result<(std::net::SocketAddr, tokio::task::JoinHandle<()>)> {
99
    // Create system status server state with the provided distributed runtime
100
    let server_state = Arc::new(SystemStatusState::new(drt, discovery_metadata)?);
101
102
    let health_path = server_state
        .drt()
103
        .system_health()
104
        .lock()
105
106
        .health_path()
        .to_string();
107
108
    let live_path = server_state
        .drt()
109
        .system_health()
110
        .lock()
111
112
        .live_path()
        .to_string();
113
114

    let app = Router::new()
115
        .route(
116
            &health_path,
117
118
            get({
                let state = Arc::clone(&server_state);
119
                move || health_handler(state)
120
121
122
            }),
        )
        .route(
123
            &live_path,
124
125
            get({
                let state = Arc::clone(&server_state);
126
                move || health_handler(state)
127
128
            }),
        )
129
130
131
132
        .route(
            "/metrics",
            get({
                let state = Arc::clone(&server_state);
133
                move || metrics_handler(state)
134
            }),
135
        )
136
137
138
139
140
141
142
        .route(
            "/metadata",
            get({
                let state = Arc::clone(&server_state);
                move || metadata_handler(state)
            }),
        )
143
144
145
146
147
        .fallback(|| async {
            tracing::info!("[fallback handler] called");
            (StatusCode::NOT_FOUND, "Route not found").into_response()
        })
        .layer(TraceLayer::new_for_http().make_span_with(make_request_span));
148
149

    let address = format!("{}:{}", host, port);
150
    tracing::info!("[spawn_system_status_server] binding to: {}", address);
151
152
153
154
155

    let listener = match TcpListener::bind(&address).await {
        Ok(listener) => {
            // get the actual address and port, print in debug level
            let actual_address = listener.local_addr()?;
156
            tracing::info!(
157
                "[spawn_system_status_server] system status server bound to: {}",
158
159
160
                actual_address
            );
            (listener, actual_address)
161
162
163
164
165
166
        }
        Err(e) => {
            tracing::error!("Failed to bind to address {}: {}", address, e);
            return Err(anyhow::anyhow!("Failed to bind to address: {}", e));
        }
    };
167
    let (listener, actual_address) = listener;
168
169

    let observer = cancel_token.child_token();
170
171
172
173
174
175
    // Spawn the server in the background and return the handle
    let handle = tokio::spawn(async move {
        if let Err(e) = axum::serve(listener, app)
            .with_graceful_shutdown(observer.cancelled_owned())
            .await
        {
176
            tracing::error!("System status server error: {}", e);
177
178
        }
    });
179

180
    Ok((actual_address, handle))
181
182
}

183
/// Health handler with optional active health checking
184
185
#[tracing::instrument(skip_all, level = "trace")]
async fn health_handler(state: Arc<SystemStatusState>) -> impl IntoResponse {
186
    // Get basic health status
187
188
189
190
191
    let system_health = state.drt().system_health();
    let system_health_lock = system_health.lock();
    let (healthy, endpoints) = system_health_lock.get_health_status();
    let uptime = Some(system_health_lock.uptime());
    drop(system_health_lock);
192
193
194
195
196
197
198
199
200
201
202

    let healthy_string = if healthy { "ready" } else { "notready" };
    let status_code = if healthy {
        StatusCode::OK
    } else {
        StatusCode::SERVICE_UNAVAILABLE
    };

    let response = json!({
        "status": healthy_string,
        "uptime": uptime,
203
        "endpoints": endpoints,
204
205
206
207
208
    });

    tracing::trace!("Response {}", response.to_string());

    (status_code, response.to_string())
209
}
210
211

/// Metrics handler with DistributedRuntime uptime
212
213
#[tracing::instrument(skip_all, level = "trace")]
async fn metrics_handler(state: Arc<SystemStatusState>) -> impl IntoResponse {
214
    // Update the uptime gauge with current value
215
    state.drt().system_health().lock().update_uptime_gauge();
216

217
218
219
220
221
222
    // Get all metrics from DistributedRuntime
    // Note: In the new hierarchy-based architecture, metrics are automatically registered
    // at all parent levels, so DRT's metrics include all metrics from children
    // (Namespace, Component, Endpoint). The prometheus_expfmt() method also executes
    // all update callbacks and expfmt callbacks before returning the metrics.
    let response = match state.drt().metrics().prometheus_expfmt() {
223
        Ok(r) => r,
224
        Err(e) => {
225
            tracing::error!("Failed to get metrics from registry: {}", e);
226
            return (
227
                StatusCode::INTERNAL_SERVER_ERROR,
228
                "Failed to get metrics".to_string(),
229
230
231
232
233
            );
        }
    };

    (StatusCode::OK, response)
234
235
}

236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/// Metadata handler
#[tracing::instrument(skip_all, level = "trace")]
async fn metadata_handler(state: Arc<SystemStatusState>) -> impl IntoResponse {
    // Check if discovery metadata is available
    let metadata = match state.discovery_metadata() {
        Some(metadata) => metadata,
        None => {
            tracing::debug!("Metadata endpoint called but no discovery metadata available");
            return (
                StatusCode::NOT_FOUND,
                "Discovery metadata not available".to_string(),
            )
                .into_response();
        }
    };

    // Read the metadata
    let metadata_guard = metadata.read().await;

    // Serialize to JSON
    match serde_json::to_string(&*metadata_guard) {
        Ok(json) => {
            tracing::trace!("Returning metadata: {} bytes", json.len());
            (StatusCode::OK, json).into_response()
        }
        Err(e) => {
            tracing::error!("Failed to serialize metadata: {}", e);
            (
                StatusCode::INTERNAL_SERVER_ERROR,
                "Failed to serialize metadata".to_string(),
            )
                .into_response()
        }
    }
}

272
// Regular tests: cargo test system_status_server --lib
273
274
275
#[cfg(test)]
mod tests {
    use super::*;
276
    use tokio::time::Duration;
277

278
    // This is a basic test to verify the HTTP server is working before testing other more complicated tests
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
    #[tokio::test]
    async fn test_http_server_lifecycle() {
        let cancel_token = CancellationToken::new();
        let cancel_token_for_server = cancel_token.clone();

        // Test basic HTTP server lifecycle without DistributedRuntime
        let app = Router::new().route("/test", get(|| async { (StatusCode::OK, "test") }));

        // start HTTP server
        let server_handle = tokio::spawn(async move {
            let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
            let _ = axum::serve(listener, app)
                .with_graceful_shutdown(cancel_token_for_server.cancelled_owned())
                .await;
        });

295
        // server starts immediately, no need to wait
296
297
298
299
300
301
302
303
304
305
306

        // cancel token
        cancel_token.cancel();

        // wait for the server to shut down
        let result = tokio::time::timeout(Duration::from_secs(5), server_handle).await;
        assert!(
            result.is_ok(),
            "HTTP server should shut down when cancel token is cancelled"
        );
    }
307
308
309
310
311
312
}

// Integration tests: cargo test system_status_server --lib --features integration
#[cfg(all(test, feature = "integration"))]
mod integration_tests {
    use super::*;
313
314
    use crate::config::environment_names::logging as env_logging;
    use crate::config::environment_names::runtime::canary as env_canary;
315
    use crate::distributed::distributed_test_utils::create_test_drt_async;
316
    use crate::metrics::MetricsHierarchy;
317
318
319
320
    use anyhow::Result;
    use rstest::rstest;
    use std::sync::Arc;
    use tokio::time::Duration;
321

322
    #[tokio::test]
323
324
    async fn test_uptime_from_system_health() {
        // Test that uptime is available from SystemHealth
325
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, None::<&str>)], async {
326
327
            let drt = create_test_drt_async().await;

328
            // Get uptime from SystemHealth
329
            let uptime = drt.system_health().lock().uptime();
330
331
332
333
334
            // Uptime should exist (even if close to zero)
            assert!(uptime.as_nanos() > 0 || uptime.is_zero());

            // Sleep briefly and check uptime increases
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
335
            let uptime_after = drt.system_health().lock().uptime();
336
            assert!(uptime_after > uptime);
337
338
339
340
        })
        .await;
    }

341
    #[tokio::test]
342
343
    async fn test_runtime_metrics_initialization_and_namespace() {
        // Test that metrics have correct namespace
344
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, None::<&str>)], async {
345
            let drt = create_test_drt_async().await;
346
            // SystemStatusState is already created in distributed.rs
347
            // so we don't need to create it again here
348

349
            // The uptime_seconds metric should already be registered and available
350
            let response = drt.metrics().prometheus_expfmt().unwrap();
351
            println!("Full metrics response:\n{}", response);
352

353
354
355
            // Filter out NATS client metrics for comparison
            let filtered_response: String = response
                .lines()
356
357
358
                .filter(|line| {
                    !line.contains(nats_client::PREFIX) && !line.contains(nats_service::PREFIX)
                })
359
360
                .collect::<Vec<_>>()
                .join("\n");
361

362
363
364
365
366
367
368
369
370
371
372
373
374
            // Check that uptime_seconds metric is present with correct namespace
            assert!(
                filtered_response.contains("# HELP dynamo_component_uptime_seconds"),
                "Should contain uptime_seconds help text"
            );
            assert!(
                filtered_response.contains("# TYPE dynamo_component_uptime_seconds gauge"),
                "Should contain uptime_seconds type"
            );
            assert!(
                filtered_response.contains("dynamo_component_uptime_seconds"),
                "Should contain uptime_seconds metric with correct namespace"
            );
375
376
        })
        .await;
377
378
379
    }

    #[tokio::test]
380
381
    async fn test_uptime_gauge_updates() {
        // Test that the uptime gauge is properly updated and increases over time
382
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, None::<&str>)], async {
383
384
            let drt = create_test_drt_async().await;

385
            // Get initial uptime
386
            let initial_uptime = drt.system_health().lock().uptime();
387

388
            // Update the gauge with initial value
389
            drt.system_health().lock().update_uptime_gauge();
390

391
            // Sleep for 100ms
392
            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
393
394

            // Get uptime after sleep
395
            let uptime_after_sleep = drt.system_health().lock().uptime();
396
397

            // Update the gauge again
398
            drt.system_health().lock().update_uptime_gauge();
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

            // Verify uptime increased by at least 100ms
            let elapsed = uptime_after_sleep - initial_uptime;
            assert!(
                elapsed >= std::time::Duration::from_millis(100),
                "Uptime should have increased by at least 100ms after sleep, but only increased by {:?}",
                elapsed
            );
        })
        .await;
    }

    #[tokio::test]
    async fn test_http_requests_fail_when_system_disabled() {
        // Test that system status server is not running when disabled
414
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, None::<&str>)], async {
415
416
417
418
            let drt = create_test_drt_async().await;

            // Verify that system status server info is None when disabled
            let system_info = drt.system_status_server_info();
419
            assert!(
420
                system_info.is_none(),
421
                "System status server should not be running when disabled"
422
            );
423

424
            println!("✓ System status server correctly disabled when not enabled");
425
426
        })
        .await;
427
    }
428

429
430
431
432
433
434
    /// This test verifies the health and liveness endpoints of the system status server.
    /// It checks that the endpoints respond with the correct HTTP status codes and bodies
    /// based on the initial health status and any custom endpoint paths provided via environment variables.
    /// The test is parameterized using multiple #[case] attributes to cover various scenarios,
    /// including different initial health states ("ready" and "notready"), default and custom endpoint paths,
    /// and expected response codes and bodies.
435
    #[rstest]
436
437
438
439
440
441
442
443
444
445
446
    #[case("ready", 200, "ready", None, None, 3)]
    #[case("notready", 503, "notready", None, None, 3)]
    #[case("ready", 200, "ready", Some("/custom/health"), Some("/custom/live"), 5)]
    #[case(
        "notready",
        503,
        "notready",
        Some("/custom/health"),
        Some("/custom/live"),
        5
    )]
447
    #[tokio::test]
448
    #[cfg(feature = "integration")]
449
450
451
452
    async fn test_health_endpoints(
        #[case] starting_health_status: &'static str,
        #[case] expected_status: u16,
        #[case] expected_body: &'static str,
453
454
455
        #[case] custom_health_path: Option<&'static str>,
        #[case] custom_live_path: Option<&'static str>,
        #[case] expected_num_tests: usize,
456
457
458
459
460
461
462
    ) {
        use std::sync::Arc;
        // use tokio::io::{AsyncReadExt, AsyncWriteExt};
        // use reqwest for HTTP requests

        // Closure call is needed here to satisfy async_with_vars

463
464
        crate::logging::init();

465
466
        #[allow(clippy::redundant_closure_call)]
        temp_env::async_with_vars(
467
            [
468
                (env_system::DYN_SYSTEM_PORT, Some("0")),
469
                (
470
                    env_system::DYN_SYSTEM_STARTING_HEALTH_STATUS,
471
472
                    Some(starting_health_status),
                ),
473
474
                (env_system::DYN_SYSTEM_HEALTH_PATH, custom_health_path),
                (env_system::DYN_SYSTEM_LIVE_PATH, custom_live_path),
475
            ],
476
            (async || {
477
                let drt = Arc::new(create_test_drt_async().await);
478
479
480
481
482
483
484

                // Get system status server info from DRT (instead of manually spawning)
                let system_info = drt
                    .system_status_server_info()
                    .expect("System status server should be started by DRT");
                let addr = system_info.socket_addr;

485
                let client = reqwest::Client::new();
486
487
488

                // Prepare test cases
                let mut test_cases = vec![];
489
490
491
492
493
494
495
496
497
498
                match custom_health_path {
                    None => {
                        // When using default paths, test the default paths
                        test_cases.push(("/health", expected_status, expected_body));
                    }
                    Some(chp) => {
                        // When using custom paths, default paths should not exist
                        test_cases.push(("/health", 404, "Route not found"));
                        test_cases.push((chp, expected_status, expected_body));
                    }
499
                }
500
501
502
503
504
505
506
507
508
509
                match custom_live_path {
                    None => {
                        // When using default paths, test the default paths
                        test_cases.push(("/live", expected_status, expected_body));
                    }
                    Some(clp) => {
                        // When using custom paths, default paths should not exist
                        test_cases.push(("/live", 404, "Route not found"));
                        test_cases.push((clp, expected_status, expected_body));
                    }
510
511
512
513
514
                }
                test_cases.push(("/someRandomPathNotFoundHere", 404, "Route not found"));
                assert_eq!(test_cases.len(), expected_num_tests);

                for (path, expect_status, expect_body) in test_cases {
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
                    println!("[test] Sending request to {}", path);
                    let url = format!("http://{}{}", addr, path);
                    let response = client.get(&url).send().await.unwrap();
                    let status = response.status();
                    let body = response.text().await.unwrap();
                    println!(
                        "[test] Response for {}: status={}, body={:?}",
                        path, status, body
                    );
                    assert_eq!(
                        status, expect_status,
                        "Response: status={}, body={:?}",
                        status, body
                    );
                    assert!(
                        body.contains(expect_body),
                        "Response: status={}, body={:?}",
                        status,
                        body
                    );
                }
            })(),
        )
        .await;
    }

541
542
543
544
545
546
547
548
549
    #[tokio::test]
    async fn test_health_endpoint_tracing() -> Result<()> {
        use std::sync::Arc;

        // Closure call is needed here to satisfy async_with_vars

        #[allow(clippy::redundant_closure_call)]
        let _ = temp_env::async_with_vars(
            [
550
551
552
553
                (env_system::DYN_SYSTEM_PORT, Some("0")),
                (env_system::DYN_SYSTEM_STARTING_HEALTH_STATUS, Some("ready")),
                (env_logging::DYN_LOGGING_JSONL, Some("1")),
                (env_logging::DYN_LOG, Some("trace")),
554
555
556
557
558
559
560
            ],
            (async || {
                // TODO Add proper testing for
                // trace id and parent id

                crate::logging::init();

561
                let drt = Arc::new(create_test_drt_async().await);
562
563
564
565
566
567

                // Get system status server info from DRT (instead of manually spawning)
                let system_info = drt
                    .system_status_server_info()
                    .expect("System status server should be started by DRT");
                let addr = system_info.socket_addr;
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
                let client = reqwest::Client::new();
                for path in [("/health"), ("/live"), ("/someRandomPathNotFoundHere")] {
                    let traceparent_value =
                        "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01";
                    let tracestate_value = "vendor1=opaqueValue1,vendor2=opaqueValue2";
                    let mut headers = reqwest::header::HeaderMap::new();
                    headers.insert(
                        reqwest::header::HeaderName::from_static("traceparent"),
                        reqwest::header::HeaderValue::from_str(traceparent_value)?,
                    );
                    headers.insert(
                        reqwest::header::HeaderName::from_static("tracestate"),
                        reqwest::header::HeaderValue::from_str(tracestate_value)?,
                    );
                    let url = format!("http://{}{}", addr, path);
                    let response = client.get(&url).headers(headers).send().await.unwrap();
                    let status = response.status();
                    let body = response.text().await.unwrap();
                    tracing::info!(body = body, status = status.to_string());
                }

                Ok::<(), anyhow::Error>(())
            })(),
        )
        .await;
        Ok(())
    }

596
    #[tokio::test]
597
598
599
600
601
602
603
    async fn test_health_endpoint_with_changing_health_status() {
        // Test health endpoint starts in not ready status, then becomes ready
        // when endpoints are created (DYN_SYSTEM_USE_ENDPOINT_HEALTH_STATUS=generate)
        const ENDPOINT_NAME: &str = "generate";
        const ENDPOINT_HEALTH_CONFIG: &str = "[\"generate\"]";
        temp_env::async_with_vars(
            [
604
605
606
                (env_system::DYN_SYSTEM_PORT, Some("0")),
                (env_system::DYN_SYSTEM_STARTING_HEALTH_STATUS, Some("notready")),
                (env_system::DYN_SYSTEM_USE_ENDPOINT_HEALTH_STATUS, Some(ENDPOINT_HEALTH_CONFIG)),
607
608
            ],
            async {
609
                let drt = Arc::new(create_test_drt_async().await);
610
611
612
613
614
615
616

                // Check if system status server was started
                let system_info_opt = drt.system_status_server_info();

                // Ensure system status server was spawned by DRT
                assert!(
                    system_info_opt.is_some(),
617
                    "System status server was not spawned by DRT. Expected DRT to spawn server when DYN_SYSTEM_PORT is set to a positive value, but system_status_server_info() returned None. Environment: DYN_SYSTEM_PORT={:?}",
618
                    std::env::var(env_system::DYN_SYSTEM_PORT)
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
                );

                // Get the system status server info from DRT - this should never fail now due to above check
                let system_info = system_info_opt.unwrap();
                let addr = system_info.socket_addr;

                // Initially check health - should be not ready
                let client = reqwest::Client::new();
                let health_url = format!("http://{}/health", addr);

                let response = client.get(&health_url).send().await.unwrap();
                let status = response.status();
                let body = response.text().await.unwrap();

                // Health should be not ready (503) initially
                assert_eq!(status, 503, "Health should be 503 (not ready) initially, got: {}", status);
                assert!(body.contains("\"status\":\"notready\""), "Health should contain status notready");

                // Now create a namespace, component, and endpoint to make the system healthy
                let namespace = drt.namespace("ns1234").unwrap();
639
                let component = namespace.component("comp1234").unwrap();
640
641
642
643
644
645
646
647

                // Create a simple test handler
                use crate::pipeline::{async_trait, network::Ingress, AsyncEngine, AsyncEngineContextProvider, Error, ManyOut, SingleIn};
                use crate::protocols::annotated::Annotated;

                struct TestHandler;

                #[async_trait]
648
649
                impl AsyncEngine<SingleIn<String>, ManyOut<Annotated<String>>, anyhow::Error> for TestHandler {
                    async fn generate(&self, input: SingleIn<String>) -> anyhow::Result<ManyOut<Annotated<String>>> {
650
651
652
653
654
655
656
657
658
659
660
661
                        let (data, ctx) = input.into_parts();
                        let response = Annotated::from_data(format!("You responded: {}", data));
                        Ok(crate::pipeline::ResponseStream::new(
                            Box::pin(crate::stream::iter(vec![response])),
                            ctx.context()
                        ))
                    }
                }

                // Create the ingress and start the endpoint service
                let ingress = Ingress::for_engine(std::sync::Arc::new(TestHandler)).unwrap();

662
663
                // Start the service and endpoint with a health check payload
                // This will automatically register the endpoint for health monitoring
664
                tokio::spawn(async move {
665
                    let _ = component.endpoint(ENDPOINT_NAME)
666
667
                        .endpoint_builder()
                        .handler(ingress)
668
669
670
                        .health_check_payload(serde_json::json!({
                            "test": "health_check"
                        }))
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
                        .start()
                        .await;
                });

                // Hit health endpoint 200 times to verify consistency
                let mut success_count = 0;
                let mut failures = Vec::new();

                for i in 1..=200 {
                    let response = client.get(&health_url).send().await.unwrap();
                    let status = response.status();
                    let body = response.text().await.unwrap();

                    if status == 200 && body.contains("\"status\":\"ready\"") {
                        success_count += 1;
                    } else {
                        failures.push((i, status.as_u16(), body.clone()));
                        if failures.len() <= 5 {  // Only log first 5 failures
                            tracing::warn!("Request {}: status={}, body={}", i, status, body);
                        }
                    }
                }

                tracing::info!("Health endpoint test results: {}/200 requests succeeded", success_count);
                if !failures.is_empty() {
                    tracing::warn!("Failed requests: {}", failures.len());
                }
698

699
700
701
702
703
                // Expect at least 150 out of 200 requests to be successful
                assert!(success_count >= 150, "Expected at least 150 out of 200 requests to succeed, but only {} succeeded", success_count);
            },
        )
        .await;
704
705
    }

706
    #[tokio::test]
707
    async fn test_spawn_system_status_server_endpoints() {
708
        // use reqwest for HTTP requests
709
        temp_env::async_with_vars(
710
            [
711
712
                (env_system::DYN_SYSTEM_PORT, Some("0")),
                (env_system::DYN_SYSTEM_STARTING_HEALTH_STATUS, Some("ready")),
713
            ],
714
            async {
715
                let drt = Arc::new(create_test_drt_async().await);
716
717
718
719
720
721

                // Get system status server info from DRT (instead of manually spawning)
                let system_info = drt
                    .system_status_server_info()
                    .expect("System status server should be started by DRT");
                let addr = system_info.socket_addr;
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
                let client = reqwest::Client::new();
                for (path, expect_200, expect_body) in [
                    ("/health", true, "ready"),
                    ("/live", true, "ready"),
                    ("/someRandomPathNotFoundHere", false, "Route not found"),
                ] {
                    println!("[test] Sending request to {}", path);
                    let url = format!("http://{}{}", addr, path);
                    let response = client.get(&url).send().await.unwrap();
                    let status = response.status();
                    let body = response.text().await.unwrap();
                    println!(
                        "[test] Response for {}: status={}, body={:?}",
                        path, status, body
                    );
                    if expect_200 {
                        assert_eq!(status, 200, "Response: status={}, body={:?}", status, body);
                    } else {
                        assert_eq!(status, 404, "Response: status={}, body={:?}", status, body);
                    }
                    assert!(
                        body.contains(expect_body),
                        "Response: status={}, body={:?}",
                        status,
                        body
                    );
748
                }
749
                // DRT handles server cleanup automatically
750
751
752
            },
        )
        .await;
753
    }
754
755
756
757
758
759
760
761
762

    #[cfg(feature = "integration")]
    #[tokio::test]
    async fn test_health_check_with_payload_and_timeout() {
        // Test the complete health check flow with the new canary-based system:
        crate::logging::init();

        temp_env::async_with_vars(
            [
763
                (env_system::DYN_SYSTEM_PORT, Some("0")),
764
                (
765
766
767
768
769
                    env_system::DYN_SYSTEM_STARTING_HEALTH_STATUS,
                    Some("notready"),
                ),
                (
                    env_system::DYN_SYSTEM_USE_ENDPOINT_HEALTH_STATUS,
770
771
772
773
                    Some("[\"test.endpoint\"]"),
                ),
                // Enable health check with short intervals for testing
                ("DYN_HEALTH_CHECK_ENABLED", Some("true")),
774
                (env_canary::DYN_CANARY_WAIT_TIME, Some("1")), // Send canary after 1 second of inactivity
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
                ("DYN_HEALTH_CHECK_REQUEST_TIMEOUT", Some("1")), // Immediately timeout to mimic unresponsiveness
                ("RUST_LOG", Some("info")),                      // Enable logging for test
            ],
            async {
                let drt = Arc::new(create_test_drt_async().await);

                // Get system status server info
                let system_info = drt
                    .system_status_server_info()
                    .expect("System status server should be started");
                let addr = system_info.socket_addr;

                let client = reqwest::Client::new();
                let health_url = format!("http://{}/health", addr);

                // Register an endpoint with health check payload
                let endpoint = "test.endpoint";
                let health_check_payload = serde_json::json!({
                    "prompt": "health check test",
                    "_health_check": true
                });

                // Register the endpoint and its health check payload
                {
799
800
801
                    let system_health = drt.system_health();
                    let system_health_lock = system_health.lock();
                    system_health_lock.register_health_check_target(
802
803
804
805
806
807
                        endpoint,
                        crate::component::Instance {
                            component: "test_component".to_string(),
                            endpoint: "health".to_string(),
                            namespace: "test_namespace".to_string(),
                            instance_id: 1,
808
                            transport: crate::component::TransportType::Nats(endpoint.to_string()),
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
                        },
                        health_check_payload.clone(),
                    );
                }

                // Check initial health - should be ready (default state)
                let response = client.get(&health_url).send().await.unwrap();
                let status = response.status();
                let body = response.text().await.unwrap();
                assert_eq!(status, 503, "Should be unhealthy initially (default state)");
                assert!(
                    body.contains("\"status\":\"notready\""),
                    "Should show notready status initially"
                );

                // Set endpoint to healthy state
825
                drt.system_health()
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
                    .lock()
                    .set_endpoint_health_status(endpoint, HealthStatus::Ready);

                // Check health again - should now be healthy
                let response = client.get(&health_url).send().await.unwrap();
                let status = response.status();
                let body = response.text().await.unwrap();

                assert_eq!(status, 200, "Should be healthy due to recent response");
                assert!(
                    body.contains("\"status\":\"ready\""),
                    "Should show ready status after response"
                );

                // Verify the endpoint status in SystemHealth directly
                let endpoint_status = drt
842
                    .system_health()
843
844
845
846
847
848
849
850
851
852
853
                    .lock()
                    .get_endpoint_health_status(endpoint);
                assert_eq!(
                    endpoint_status,
                    Some(HealthStatus::Ready),
                    "SystemHealth should show endpoint as Ready after response"
                );
            },
        )
        .await;
    }
854
}