distributed.rs 32.2 KB
Newer Older
1
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
// SPDX-License-Identifier: Apache-2.0
Ryan Olson's avatar
Ryan Olson committed
3

4
5
6
use crate::component::{
    self, Component, ComponentBuilder, Endpoint, Instance, Namespace, RoutingOccupancyState,
};
7
use crate::config::environment_names::tcp_response_stream;
8
use crate::pipeline::PipelineError;
9
use crate::pipeline::network::manager::NetworkManager;
10
use crate::service::{ServiceClient, ServiceSet};
11
use crate::storage::kv;
12
use crate::{discovery, system_status_server, transports};
Ryan Olson's avatar
Ryan Olson committed
13
use crate::{
14
    discovery::Discovery,
15
16
    metrics::PrometheusUpdateCallback,
    metrics::{MetricsHierarchy, MetricsRegistry},
Ryan Olson's avatar
Ryan Olson committed
17
18
19
    transports::{etcd, nats, tcp},
};

20
use super::utils::GracefulShutdownTracker;
21
22
use crate::SystemHealth;
use crate::runtime::Runtime;
Ryan Olson's avatar
Ryan Olson committed
23

24
// Used instead of std::cell::OnceCell because get_or_try_init there is nightly
25
use async_once_cell::OnceCell;
26

27
use std::fmt;
28
use std::sync::{Arc, OnceLock, Weak};
29
use std::time::Duration;
30
use tokio::sync::watch::Receiver;
31
32

use anyhow::Result;
Ryan Olson's avatar
Ryan Olson committed
33
34
use derive_getters::Dissolve;
use figment::error;
35
36
use std::collections::HashMap;
use tokio::sync::Mutex;
37
use tokio_util::sync::CancellationToken;
Ryan Olson's avatar
Ryan Olson committed
38

39
type InstanceMap = HashMap<Endpoint, Weak<Receiver<Vec<Instance>>>>;
40
type RoutingOccupancyMap = HashMap<Endpoint, Weak<RoutingOccupancyState>>;
41

42
43
44
45
46
47
48
49
/// Distributed [Runtime] which provides access to shared resources across the cluster, this includes
/// communication protocols and transports.
#[derive(Clone)]
pub struct DistributedRuntime {
    // local runtime
    runtime: Runtime,

    nats_client: Option<transports::nats::Client>,
50
    network_manager: Arc<NetworkManager>,
51
52
    tcp_server: Arc<OnceCell<Arc<transports::tcp::server::TcpStreamServer>>>,
    system_status_server: Arc<OnceLock<Arc<system_status_server::SystemStatusServerInfo>>>,
53
    request_plane: RequestPlaneMode,
54
55
56
57

    // Service discovery client
    discovery_client: Arc<dyn discovery::Discovery>,

58
59
60
61
    // Discovery metadata (only used for Kubernetes backend)
    // Shared with system status server to expose via /metadata endpoint
    discovery_metadata: Option<Arc<tokio::sync::RwLock<discovery::DiscoveryMetadata>>>,

62
63
64
65
66
67
68
    // local registry for components
    // the registry allows us to use share runtime resources across instances of the same component object.
    // take for example two instances of a client to the same remote component. The registry allows us to use
    // a single endpoint watcher for both clients, this keeps the number background tasking watching specific
    // paths in etcd to a minimum.
    component_registry: component::Registry,

69
    instance_sources: Arc<tokio::sync::Mutex<InstanceMap>>,
70
    routing_occupancy_states: Arc<tokio::sync::Mutex<RoutingOccupancyMap>>,
71
72
73
74

    // Health Status
    system_health: Arc<parking_lot::Mutex<SystemHealth>>,

75
76
77
    // Local endpoint registry for in-process calls
    local_endpoint_registry: crate::local_endpoint_registry::LocalEndpointRegistry,

78
79
    // This hierarchy's own metrics registry
    metrics_registry: MetricsRegistry,
80
81
82

    // Registry for /engine/* route callbacks
    engine_routes: crate::engine_routes::EngineRouteRegistry,
83
84
}

85
impl MetricsHierarchy for DistributedRuntime {
86
87
88
89
    fn basename(&self) -> String {
        "".to_string() // drt has no basename. Basename only begins with the Namespace.
    }

90
91
92
93
94
95
    fn parent_hierarchies(&self) -> Vec<&dyn MetricsHierarchy> {
        vec![] // drt is the root, so no parent hierarchies
    }

    fn get_metrics_registry(&self) -> &MetricsRegistry {
        &self.metrics_registry
96
97
98
    }
}

Ryan Olson's avatar
Ryan Olson committed
99
100
101
102
103
104
impl std::fmt::Debug for DistributedRuntime {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "DistributedRuntime")
    }
}

Ryan Olson's avatar
Ryan Olson committed
105
106
impl DistributedRuntime {
    pub async fn new(runtime: Runtime, config: DistributedConfig) -> Result<Self> {
107
        let (discovery_backend, nats_config, request_plane) = config.dissolve();
Ryan Olson's avatar
Ryan Olson committed
108

109
110
111
112
        let nats_client = match nats_config {
            Some(nc) => Some(nc.connect().await?),
            None => None,
        };
Ryan Olson's avatar
Ryan Olson committed
113

114
        // Start system status server for health and metrics if enabled in configuration
115
116
117
118
119
120
121
122
        let config = crate::config::RuntimeConfig::from_settings().unwrap_or_default();
        // IMPORTANT: We must extract cancel_token from runtime BEFORE moving runtime into the struct below.
        // This is because after moving, runtime is no longer accessible in this scope (ownership rules).
        let cancel_token = if config.system_server_enabled() {
            Some(runtime.clone().child_token())
        } else {
            None
        };
123
124
        let starting_health_status = config.starting_health_status.clone();
        let use_endpoint_health_status = config.use_endpoint_health_status.clone();
125
126
        let health_endpoint_path = config.system_health_path.clone();
        let live_endpoint_path = config.system_live_path.clone();
127
        let system_health = Arc::new(parking_lot::Mutex::new(SystemHealth::new(
128
129
            starting_health_status,
            use_endpoint_health_status,
130
131
            health_endpoint_path,
            live_endpoint_path,
132
        )));
133

134
        // Initialize discovery client based on backend configuration
135
136
        let (discovery_client, discovery_metadata) = match discovery_backend {
            DiscoveryBackend::Kubernetes => {
137
138
139
140
141
142
143
144
145
146
147
148
149
150
                tracing::info!("Initializing Kubernetes discovery backend");
                let metadata = Arc::new(tokio::sync::RwLock::new(
                    crate::discovery::DiscoveryMetadata::new(),
                ));
                let client = crate::discovery::KubeDiscoveryClient::new(
                    metadata.clone(),
                    runtime.primary_token(),
                )
                .await
                .inspect_err(
                    |err| tracing::error!(%err, "Failed to initialize Kubernetes discovery client"),
                )?;
                (Arc::new(client) as Arc<dyn Discovery>, Some(metadata))
            }
151
            DiscoveryBackend::KvStore(kv_selector) => {
152
                tracing::info!("Initializing KV store discovery backend: {kv_selector}");
153
154
155
156
157
158
159
160
161
162
                let runtime_clone = runtime.clone();
                let store = match kv_selector {
                    kv::Selector::Etcd(etcd_config) => {
                        let etcd_client = etcd::Client::new(*etcd_config, runtime_clone).await.inspect_err(|err|
                            tracing::error!(%err, "Could not connect to etcd. Pass `--discovery-backend ..` to use a different backend or start etcd."))?;
                        kv::Manager::etcd(etcd_client)
                    }
                    kv::Selector::File(root) => kv::Manager::file(runtime.primary_token(), root),
                    kv::Selector::Memory => kv::Manager::memory(),
                };
163
164
                use crate::discovery::KVStoreDiscovery;
                (
165
166
                    Arc::new(KVStoreDiscovery::new(store, runtime.primary_token()))
                        as Arc<dyn Discovery>,
167
168
169
                    None,
                )
            }
170
171
        };

172
        let component_registry = component::Registry::new();
173

174
175
176
177
178
179
180
181
        // NetworkManager for request plane
        let network_manager = NetworkManager::new(
            runtime.child_token(),
            nats_client.clone().map(|c| c.client().clone()),
            component_registry.clone(),
            request_plane,
        );

182
        let distributed_runtime = Self {
Ryan Olson's avatar
Ryan Olson committed
183
            runtime,
184
            network_manager: Arc::new(network_manager),
Ryan Olson's avatar
Ryan Olson committed
185
186
            nats_client,
            tcp_server: Arc::new(OnceCell::new()),
187
            system_status_server: Arc::new(OnceLock::new()),
188
            discovery_client,
189
            discovery_metadata,
190
            component_registry,
191
            instance_sources: Arc::new(Mutex::new(HashMap::new())),
192
            routing_occupancy_states: Arc::new(Mutex::new(HashMap::new())),
193
            metrics_registry: crate::MetricsRegistry::new(),
194
            system_health,
195
            request_plane,
196
            local_endpoint_registry: crate::local_endpoint_registry::LocalEndpointRegistry::new(),
197
            engine_routes: crate::engine_routes::EngineRouteRegistry::new(),
198
199
        };

200
201
202
203
204
205
        // Initialize the uptime gauge in SystemHealth
        distributed_runtime
            .system_health
            .lock()
            .initialize_uptime_gauge(&distributed_runtime)?;

206
207
208
209
210
211
212
213
214
215
216
217
        // Register an update callback so the uptime gauge is refreshed before
        // every Prometheus scrape (both system status server and frontend).
        {
            let system_health = distributed_runtime.system_health.clone();
            distributed_runtime
                .metrics_registry
                .add_update_callback(std::sync::Arc::new(move || {
                    system_health.lock().update_uptime_gauge();
                    Ok(())
                }));
        }

218
        // Handle system status server initialization
219
        if let Some(cancel_token) = cancel_token {
220
            // System server is enabled - start both the state and HTTP server
221
            let host = config.system_host.clone();
222
            let port = config.system_port as u16;
223

224
            // Start system status server (it creates SystemStatusState internally)
225
            match crate::system_status_server::spawn_system_status_server(
226
227
228
229
                &host,
                port,
                cancel_token,
                Arc::new(distributed_runtime.clone()),
230
                distributed_runtime.discovery_metadata.clone(),
231
232
233
            )
            .await
            {
234
                Ok((addr, handle)) => {
235
                    tracing::info!("System status server started successfully on {addr}");
236

237
238
239
240
241
242
                    // Store system status server information
                    let system_status_server_info =
                        crate::system_status_server::SystemStatusServerInfo::new(
                            addr,
                            Some(handle),
                        );
243

244
                    // Initialize the system_status_server field
245
                    distributed_runtime
246
247
248
                        .system_status_server
                        .set(Arc::new(system_status_server_info))
                        .expect("System status server info should only be set once");
249
250
                }
                Err(e) => {
251
                    tracing::error!("System status server startup failed: {e}");
252
                }
253
            }
254
        } else {
255
            // System server HTTP is disabled, but uptime metrics are still being tracked via SystemHealth
256
257
258
            tracing::debug!(
                "System status server HTTP endpoints disabled, but uptime metrics are being tracked"
            );
259
260
        }

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
        // Start health check manager if enabled
        if config.health_check_enabled {
            let health_check_config = crate::health_check::HealthCheckConfig {
                canary_wait_time: std::time::Duration::from_secs(config.canary_wait_time_secs),
                request_timeout: std::time::Duration::from_secs(
                    config.health_check_request_timeout_secs,
                ),
            };

            // Start the health check manager (spawns per-endpoint monitoring tasks)
            match crate::health_check::start_health_check_manager(
                distributed_runtime.clone(),
                Some(health_check_config),
            )
            .await
            {
                Ok(()) => tracing::info!(
                    "Health check manager started (canary_wait_time: {}s, request_timeout: {}s)",
                    config.canary_wait_time_secs,
                    config.health_check_request_timeout_secs
                ),
282
                Err(e) => tracing::error!("Health check manager failed to start: {e}"),
283
284
285
            }
        }

286
        Ok(distributed_runtime)
Ryan Olson's avatar
Ryan Olson committed
287
288
289
    }

    pub async fn from_settings(runtime: Runtime) -> Result<Self> {
290
        let config = DistributedConfig::from_settings();
Ryan Olson's avatar
Ryan Olson committed
291
292
293
294
295
296
297
        Self::new(runtime, config).await
    }

    pub fn runtime(&self) -> &Runtime {
        &self.runtime
    }

298
299
300
301
    pub fn primary_token(&self) -> CancellationToken {
        self.runtime.primary_token()
    }

302
303
304
305
306
307
308
309
310
311
312
    // TODO: Don't hand out pointers, instead have methods to use the registry in friendly ways
    // (without being aware of async locks and so on)
    pub fn component_registry(&self) -> &component::Registry {
        &self.component_registry
    }

    // TODO: Don't hand out pointers, instead provide system health related services.
    pub fn system_health(&self) -> Arc<parking_lot::Mutex<SystemHealth>> {
        self.system_health.clone()
    }

313
314
315
316
317
318
319
    /// Get the local endpoint registry for in-process endpoint calls
    pub fn local_endpoint_registry(
        &self,
    ) -> &crate::local_endpoint_registry::LocalEndpointRegistry {
        &self.local_endpoint_registry
    }

320
321
322
323
324
    /// Get the engine route registry for registering custom /engine/* routes
    pub fn engine_routes(&self) -> &crate::engine_routes::EngineRouteRegistry {
        &self.engine_routes
    }

325
    pub fn connection_id(&self) -> u64 {
326
        self.discovery_client.instance_id()
Ryan Olson's avatar
Ryan Olson committed
327
328
329
330
    }

    pub fn shutdown(&self) {
        self.runtime.shutdown();
331
        self.discovery_client.shutdown();
Ryan Olson's avatar
Ryan Olson committed
332
333
334
335
    }

    /// Create a [`Namespace`]
    pub fn namespace(&self, name: impl Into<String>) -> Result<Namespace> {
336
        Namespace::new(self.clone(), name.into())
Ryan Olson's avatar
Ryan Olson committed
337
338
    }

339
340
341
    /// Returns the discovery interface for service registration and discovery
    pub fn discovery(&self) -> Arc<dyn Discovery> {
        self.discovery_client.clone()
342
343
    }

344
    pub async fn tcp_server(&self) -> Result<Arc<tcp::server::TcpStreamServer>> {
Ryan Olson's avatar
Ryan Olson committed
345
346
347
        Ok(self
            .tcp_server
            .get_or_try_init(async move {
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
                let port = match std::env::var(tcp_response_stream::DYN_TCP_RESPONSE_STREAM_PORT) {
                    Ok(p) => p.parse::<u16>().map_err(|_| {
                        PipelineError::Generic(format!(
                            "invalid {}: '{}' is not a valid port number",
                            tcp_response_stream::DYN_TCP_RESPONSE_STREAM_PORT,
                            p
                        ))
                    })?,
                    Err(_) => 0,
                };
                let interface = std::env::var(tcp_response_stream::DYN_TCP_RESPONSE_STREAM_HOST)
                    .ok()
                    .filter(|h| !h.is_empty());

                let host_suffix = interface
                    .as_ref()
                    .map_or(String::new(), |h| format!(" on host {h}"));
                if port == 0 {
                    tracing::info!(
                        "TCP response stream server using OS-assigned port{host_suffix}"
                    );
                } else {
                    tracing::info!(
                        "TCP response stream server using fixed port {port}{host_suffix}"
                    );
                }

                let options = tcp::server::ServerOptions { port, interface };
Ryan Olson's avatar
Ryan Olson committed
376
                let server = tcp::server::TcpStreamServer::new(options).await?;
377
                Ok::<_, PipelineError>(server)
Ryan Olson's avatar
Ryan Olson committed
378
379
380
381
382
            })
            .await?
            .clone())
    }

383
    /// Get the network manager
384
385
386
    ///
    /// The network manager consolidates all network configuration and provides
    /// unified access to request plane servers and clients.
387
388
    pub fn network_manager(&self) -> Arc<NetworkManager> {
        self.network_manager.clone()
389
390
391
392
393
394
395
396
397
    }

    /// Get the request plane server (convenience method)
    ///
    /// This is a shortcut for `network_manager().await?.server().await`.
    pub async fn request_plane_server(
        &self,
    ) -> Result<Arc<dyn crate::pipeline::network::ingress::unified_server::RequestPlaneServer>>
    {
398
        self.network_manager().server().await
Ryan Olson's avatar
Ryan Olson committed
399
400
    }

401
402
403
404
405
    /// Get system status server information if available
    pub fn system_status_server_info(
        &self,
    ) -> Option<Arc<crate::system_status_server::SystemStatusServerInfo>> {
        self.system_status_server.get().cloned()
406
407
    }

408
409
410
411
412
    /// How the frontend should talk to the backend.
    pub fn request_plane(&self) -> RequestPlaneMode {
        self.request_plane
    }

413
414
415
    pub fn child_token(&self) -> CancellationToken {
        self.runtime.child_token()
    }
416

417
418
419
420
    pub(crate) fn graceful_shutdown_tracker(&self) -> Arc<GracefulShutdownTracker> {
        self.runtime.graceful_shutdown_tracker()
    }

421
    pub fn instance_sources(&self) -> Arc<Mutex<InstanceMap>> {
422
423
        self.instance_sources.clone()
    }
424

425
426
427
428
    pub(crate) fn routing_occupancy_states(&self) -> Arc<Mutex<RoutingOccupancyMap>> {
        self.routing_occupancy_states.clone()
    }

429
430
    /// TODO: This is a temporary KV router measure for component/component.rs EventPublisher impl for
    /// Component, to allow it to publish to NATS. KV Router is the only user.
431
432
433
    ///
    /// When NATS is not available (e.g., running in approximate mode with --no-kv-events),
    /// this function returns Ok(()) silently since publishing is optional in that mode.
434
    pub async fn kv_router_nats_publish(
435
436
437
438
439
        &self,
        subject: String,
        payload: bytes::Bytes,
    ) -> anyhow::Result<()> {
        let Some(nats_client) = self.nats_client.as_ref() else {
440
            // NATS not available - this is expected in approximate mode (--no-kv-events)
441
            tracing::trace!("Skipping NATS publish (NATS not configured): {subject}");
442
            return Ok(());
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
        };
        Ok(nats_client.client().publish(subject, payload).await?)
    }

    /// TODO: This is a temporary KV router measure for component/component.rs EventSubscriber impl for
    /// Component, to allow it to subscribe to NATS. KV Router is the only user.
    pub(crate) async fn kv_router_nats_subscribe(
        &self,
        subject: String,
    ) -> Result<async_nats::Subscriber> {
        let Some(nats_client) = self.nats_client.as_ref() else {
            anyhow::bail!("KV router's EventSubscriber requires NATS");
        };
        Ok(nats_client.client().subscribe(subject).await?)
    }

459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
    /// TODO (karenc): This is a temporary KV router measure for worker query requests.
    /// Allows KV Router to perform request/reply with workers. (versus the pub/sub pattern above)
    /// KV Router is the only user, made public for use in dynamo-llm crate
    pub async fn kv_router_nats_request(
        &self,
        subject: String,
        payload: bytes::Bytes,
        timeout: std::time::Duration,
    ) -> anyhow::Result<async_nats::Message> {
        let Some(nats_client) = self.nats_client.as_ref() else {
            anyhow::bail!("KV router's request requires NATS");
        };
        let response =
            tokio::time::timeout(timeout, nats_client.client().request(subject, payload))
                .await
                .map_err(|_| anyhow::anyhow!("Request timed out after {:?}", timeout))??;
        Ok(response)
    }

478
479
480
    /// DEPRECATED: This method exists only for NATS request plane support.
    /// Once everything uses the TCP request plane, this can be removed along with
    /// the NATS service registration infrastructure.
481
482
483
484
485
486
487
488
489
490
    ///
    /// Returns a receiver that signals when the NATS service registration is complete.
    /// The caller should use `blocking_recv()` to wait for completion.
    pub fn register_nats_service(
        &self,
        component: Component,
    ) -> tokio::sync::mpsc::Receiver<Result<(), String>> {
        // Create a oneshot-style channel (capacity 1) to signal completion
        let (tx, rx) = tokio::sync::mpsc::channel::<Result<(), String>>(1);

491
492
493
494
        let drt = self.clone();
        self.runtime().secondary().spawn(async move {
            let service_name = component.service_name();

495
496
497
498
499
500
501
502
503
504
505
506
            // Pre-check to save cost of creating the service, but don't hold the lock
            if drt
                .component_registry()
                .inner
                .lock()
                .await
                .services
                .contains_key(&service_name)
            {
                // The NATS service is per component, but it is called from `serve_endpoint`, and there
                // are often multiple endpoints for a component (e.g. `clear_kv_blocks` and `generate`).
                tracing::trace!("Service {service_name} already exists");
507
508
                // Signal success - service already exists
                let _ = tx.send(Ok(())).await;
509
510
                return;
            }
511

512
513
            let Some(nats_client) = drt.nats_client.as_ref() else {
                tracing::error!("Cannot create NATS service without NATS.");
514
515
516
                let _ = tx
                    .send(Err("Cannot create NATS service without NATS".to_string()))
                    .await;
517
518
519
520
521
522
523
524
                return;
            };
            let description = None;
            let nats_service = match crate::component::service::build_nats_service(
                nats_client,
                &component,
                description,
            )
525
            .await
526
527
528
529
            {
                Ok(service) => service,
                Err(err) => {
                    tracing::error!(error = %err, component = service_name, "Failed to build NATS service");
530
                    let _ = tx.send(Err(format!("Failed to build NATS service: {err}"))).await;
531
532
533
                    return;
                }
            };
534

535
536
537
538
            let mut guard = drt.component_registry().inner.lock().await;
            if !guard.services.contains_key(&service_name) {
                // Normal case
                guard.services.insert(service_name.clone(), nats_service);
539

540
                tracing::info!("Added NATS service {service_name}");
541

542
543
544
545
546
547
548
                drop(guard);
            } else {
                drop(guard);
                let _ = nats_service.stop().await;
                // The NATS service is per component, but it is called from `serve_endpoint`, and there
                // are often multiple endpoints for a component (e.g. `clear_kv_blocks` and `generate`).
                // TODO: Is this still true?
549
            }
550
551
552

            // Signal completion - service registered successfully
            let _ = tx.send(Ok(())).await;
553
        });
554
555

        rx
556
    }
Ryan Olson's avatar
Ryan Olson committed
557
558
}

559
560
561
562
563
564
565
566
567
/// Selects which discovery backend to use and, for KV store backends, which KV store.
#[derive(Clone, Debug)]
pub enum DiscoveryBackend {
    /// Use Kubernetes API for service discovery (no KV store needed)
    Kubernetes,
    /// Use a KV store (etcd, file, or memory) for service discovery
    KvStore(kv::Selector),
}

Ryan Olson's avatar
Ryan Olson committed
568
569
#[derive(Dissolve)]
pub struct DistributedConfig {
570
    pub discovery_backend: DiscoveryBackend,
571
    pub nats_config: Option<nats::ClientOptions>,
572
    pub request_plane: RequestPlaneMode,
Ryan Olson's avatar
Ryan Olson committed
573
574
575
}

impl DistributedConfig {
576
    pub fn from_settings() -> DistributedConfig {
577
        let request_plane = RequestPlaneMode::from_env();
578
579
580
581
582
583
584
585
586
        // NATS is used for more than just NATS request-plane RPC:
        // - KV router events (JetStream or NATS core + local indexer)
        // - inter-router replica sync (NATS core)
        //
        // Historically we only connected to NATS when the request plane was NATS, which made
        // `DYN_REQUEST_PLANE=tcp|http` incompatible with KV routing modes that rely on NATS.
        // If a NATS server is configured via env, enable the client regardless of request plane.
        let nats_enabled = request_plane.is_nats()
            || std::env::var(crate::config::environment_names::nats::NATS_SERVER).is_ok();
587

588
589
590
591
        // DYN_DISCOVERY_BACKEND selects the discovery mechanism
        // Valid values: "kubernetes", "etcd" (default), "file", "mem"
        let backend_str =
            std::env::var("DYN_DISCOVERY_BACKEND").unwrap_or_else(|_| "etcd".to_string());
592

593
594
595
596
597
598
599
600
601
602
603
604
605
606
        let discovery_backend = match backend_str.as_str() {
            "kubernetes" => {
                tracing::info!("Using Kubernetes discovery backend");
                DiscoveryBackend::Kubernetes
            }
            other => {
                let selector: kv::Selector = other.parse().unwrap_or_else(|_| {
                    panic!(
                        "Unknown DYN_DISCOVERY_BACKEND value: '{other}'. \
                         Valid options: kubernetes, etcd, file, mem"
                    )
                });
                DiscoveryBackend::KvStore(selector)
            }
607
608
        };

Ryan Olson's avatar
Ryan Olson committed
609
        DistributedConfig {
610
            discovery_backend,
611
            nats_config: if nats_enabled {
612
613
614
615
616
                Some(nats::ClientOptions::default())
            } else {
                None
            },
            request_plane,
Ryan Olson's avatar
Ryan Olson committed
617
618
        }
    }
Ryan Olson's avatar
Ryan Olson committed
619
620

    pub fn for_cli() -> DistributedConfig {
621
622
623
624
        let etcd_config = etcd::ClientOptions {
            attach_lease: false,
            ..Default::default()
        };
625
        let request_plane = RequestPlaneMode::from_env();
626
627
        let nats_enabled = request_plane.is_nats()
            || std::env::var(crate::config::environment_names::nats::NATS_SERVER).is_ok();
628
        DistributedConfig {
629
            discovery_backend: DiscoveryBackend::KvStore(kv::Selector::Etcd(Box::new(etcd_config))),
630
            nats_config: if nats_enabled {
631
632
633
634
635
                Some(nats::ClientOptions::default())
            } else {
                None
            },
            request_plane,
636
637
        }
    }
638
639
640
641
642

    /// A DistributedConfig that isn't distributed, for when the frontend and backend are in the
    /// same process.
    pub fn process_local() -> DistributedConfig {
        DistributedConfig {
643
            discovery_backend: DiscoveryBackend::KvStore(kv::Selector::Memory),
644
645
646
647
648
649
            nats_config: None,
            // This won't be used in process local, so we likely need a "none" option to
            // communicate that and avoid opening the ports.
            request_plane: RequestPlaneMode::Tcp,
        }
    }
650
651
652
653
654
}

/// Request plane transport mode configuration
///
/// This determines how requests are distributed from routers to workers:
655
/// - `Nats`: Use NATS for request distribution (legacy)
656
/// - `Http`: Use HTTP/2 for request distribution
657
/// - `Tcp`: Use raw TCP for request distribution with msgpack support (default)
658
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
659
pub enum RequestPlaneMode {
660
    /// Use NATS for request plane
661
662
663
664
    Nats,
    /// Use HTTP/2 for request plane
    Http,
    /// Use raw TCP for request plane with msgpack support
665
    #[default]
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
    Tcp,
}

impl fmt::Display for RequestPlaneMode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Nats => write!(f, "nats"),
            Self::Http => write!(f, "http"),
            Self::Tcp => write!(f, "tcp"),
        }
    }
}

impl std::str::FromStr for RequestPlaneMode {
    type Err = anyhow::Error;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "nats" => Ok(Self::Nats),
            "http" => Ok(Self::Http),
            "tcp" => Ok(Self::Tcp),
            _ => Err(anyhow::anyhow!(
                "Invalid request plane mode: '{}'. Valid options are: 'nats', 'http', 'tcp'",
                s
            )),
691
        }
Ryan Olson's avatar
Ryan Olson committed
692
    }
Ryan Olson's avatar
Ryan Olson committed
693
}
694

695
696
697
698
699
700
701
702
703
impl RequestPlaneMode {
    /// Get the request plane mode from environment variable (uncached)
    /// Reads from `DYN_REQUEST_PLANE` environment variable.
    fn from_env() -> Self {
        std::env::var("DYN_REQUEST_PLANE")
            .ok()
            .and_then(|s| s.parse().ok())
            .unwrap_or_default()
    }
704
705
706
707

    pub fn is_nats(&self) -> bool {
        matches!(self, RequestPlaneMode::Nats)
    }
708
709
}

710
pub mod distributed_test_utils {
711
712
    //! Common test helper functions for DistributedRuntime tests

713
    /// Helper function to create a DRT instance for integration-only tests.
714
    /// Uses from_current to leverage existing tokio runtime
715
    /// Note: Settings are read from environment variables inside DistributedRuntime::from_settings
716
    #[cfg(feature = "integration")]
717
    pub async fn create_test_drt_async() -> super::DistributedRuntime {
718
        use crate::transports::nats;
719

720
        let rt = crate::Runtime::from_current().unwrap();
721
        let config = super::DistributedConfig {
722
723
724
            discovery_backend: super::DiscoveryBackend::KvStore(
                crate::storage::kv::Selector::Memory,
            ),
725
            nats_config: Some(nats::ClientOptions::default()),
726
            request_plane: crate::distributed::RequestPlaneMode::default(),
727
728
        };
        super::DistributedRuntime::new(rt, config).await.unwrap()
729
    }
730
731
732
733
734
735
736
737
738
739

    /// Helper function to create a DRT instance which points at
    /// a (shared) file-backed KV store and ephemeral NATS transport so that
    /// multiple DRT instances may observe the same registration state.
    /// NOTE: This gets around the fact that create_test_drt_async() is
    /// hardcoded to spin up a memory-backed discovery store
    /// which means we can't share discovery state across runtimes.
    pub async fn create_test_shared_drt_async(
        store_path: &std::path::Path,
    ) -> super::DistributedRuntime {
740
        use crate::transports::nats;
741
742
743

        let rt = crate::Runtime::from_current().unwrap();
        let config = super::DistributedConfig {
744
745
746
            discovery_backend: super::DiscoveryBackend::KvStore(
                crate::storage::kv::Selector::File(store_path.to_path_buf()),
            ),
747
748
749
750
751
            nats_config: Some(nats::ClientOptions::default()),
            request_plane: crate::distributed::RequestPlaneMode::default(),
        };
        super::DistributedRuntime::new(rt, config).await.unwrap()
    }
752
}
753

754
#[cfg(all(test, feature = "integration"))]
755
mod tests {
756
    use super::RequestPlaneMode;
757
758
759
760
    use super::distributed_test_utils::create_test_drt_async;

    #[tokio::test]
    async fn test_drt_uptime_after_delay_system_disabled() {
761
        use crate::config::environment_names::runtime::system as env_system;
762
        // Test uptime with system status server disabled
763
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, None::<&str>)], async {
764
765
766
767
768
769
770
            // Start a DRT
            let drt = create_test_drt_async().await;

            // Wait 50ms
            tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;

            // Check that uptime is 50+ ms
771
            let uptime = drt.system_health.lock().uptime();
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
            assert!(
                uptime >= std::time::Duration::from_millis(50),
                "Expected uptime to be at least 50ms, but got {:?}",
                uptime
            );

            println!(
                "✓ DRT uptime test passed (system disabled): uptime = {:?}",
                uptime
            );
        })
        .await;
    }

    #[tokio::test]
    async fn test_drt_uptime_after_delay_system_enabled() {
788
        use crate::config::environment_names::runtime::system as env_system;
789
        // Test uptime with system status server enabled
790
        temp_env::async_with_vars([(env_system::DYN_SYSTEM_PORT, Some("8081"))], async {
791
792
793
794
795
796
797
            // Start a DRT
            let drt = create_test_drt_async().await;

            // Wait 50ms
            tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;

            // Check that uptime is 50+ ms
798
            let uptime = drt.system_health.lock().uptime();
799
800
801
802
803
804
805
806
807
808
809
810
811
            assert!(
                uptime >= std::time::Duration::from_millis(50),
                "Expected uptime to be at least 50ms, but got {:?}",
                uptime
            );

            println!(
                "✓ DRT uptime test passed (system enabled): uptime = {:?}",
                uptime
            );
        })
        .await;
    }
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847

    #[test]
    fn test_request_plane_mode_from_str() {
        assert_eq!(
            "nats".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Nats
        );
        assert_eq!(
            "http".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Http
        );
        assert_eq!(
            "tcp".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Tcp
        );
        assert_eq!(
            "NATS".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Nats
        );
        assert_eq!(
            "HTTP".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Http
        );
        assert_eq!(
            "TCP".parse::<RequestPlaneMode>().unwrap(),
            RequestPlaneMode::Tcp
        );
        assert!("invalid".parse::<RequestPlaneMode>().is_err());
    }

    #[test]
    fn test_request_plane_mode_display() {
        assert_eq!(RequestPlaneMode::Nats.to_string(), "nats");
        assert_eq!(RequestPlaneMode::Http.to_string(), "http");
        assert_eq!(RequestPlaneMode::Tcp.to_string(), "tcp");
    }
848
}