lib.rs 36.4 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
5
use futures::StreamExt;
use once_cell::sync::OnceCell;
6
use pyo3::IntoPyObjectExt;
7
use pyo3::exceptions::PyStopAsyncIteration;
8
use pyo3::types::{PyDict, PyString};
9
use pyo3::{exceptions::PyException, prelude::*};
10
use rand::seq::IteratorRandom as _;
11
use rs::pipeline::network::Ingress;
12
use std::net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4};
13
use std::path::PathBuf;
14
use std::time::Duration;
15
16
use std::{fmt::Display, sync::Arc};
use tokio::sync::Mutex;
17
use tracing::{Instrument, info_span};
18

Neelay Shah's avatar
Neelay Shah committed
19
use dynamo_runtime::{
Ryan Olson's avatar
Ryan Olson committed
20
    self as rs, logging,
21
    pipeline::{
22
23
        EngineStream, ManyOut, SingleIn, context::Context as RsContext,
        network::egress::push_router::RouterMode as RsRouterMode,
24
    },
25
    protocols::annotated::Annotated as RsAnnotated,
26
    traits::DistributedRuntimeProvider,
27
28
};

Neelay Shah's avatar
Neelay Shah committed
29
use dynamo_llm::{self as llm_rs};
30
31
use dynamo_llm::{entrypoint::RouterConfig, kv_router::KvRouterConfig};

32
33
use crate::llm::local_model::ModelRuntimeConfig;

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#[pyclass(eq, eq_int)]
#[derive(Clone, Debug, PartialEq)]
pub enum RouterMode {
    RoundRobin,
    Random,
    KV,
}

impl From<RouterMode> for RsRouterMode {
    fn from(mode: RouterMode) -> Self {
        match mode {
            RouterMode::RoundRobin => Self::RoundRobin,
            RouterMode::Random => Self::Random,
            RouterMode::KV => Self::KV,
        }
    }
}
51

52
mod context;
53
mod engine;
54
mod http;
55
mod llm;
56
mod parsers;
57
mod planner;
58
mod prometheus_metrics;
59
mod prometheus_names;
60
61
62
63
64
65
66
67

type JsonServerStreamingIngress =
    Ingress<SingleIn<serde_json::Value>, ManyOut<RsAnnotated<serde_json::Value>>>;

static INIT: OnceCell<()> = OnceCell::new();

const DEFAULT_ANNOTATED_SETTING: Option<bool> = Some(true);

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
// Helper to create client span - always emit spans for consistency
fn create_client_span(
    operation: &str,
    request_id: &str,
    trace_context: Option<&dynamo_runtime::logging::DistributedTraceContext>,
) -> tracing::Span {
    if let Some(ctx) = trace_context {
        info_span!(
            "client_request",
            operation = operation,
            request_id = request_id,
            trace_id = ctx.trace_id.as_str(),
            parent_id = ctx.span_id.as_str(),
            x_request_id = ctx.x_request_id.as_deref().unwrap_or(""),
            x_dynamo_request_id = ctx.x_dynamo_request_id.as_deref().unwrap_or(""),
            tracestate = ctx.tracestate.as_deref().unwrap_or("")
        )
    } else {
        info_span!(
            "client_request",
            operation = operation,
            request_id = request_id,
        )
    }
}

// Helper to get appropriate span for instrumentation - always emit spans
fn get_span_for_context(context: &context::Context, operation: &str) -> tracing::Span {
    create_client_span(operation, context.inner().id(), context.trace_context())
}

// Helper to create span for direct method with instance_id
fn get_span_for_direct_context(
    context: &context::Context,
    operation: &str,
    instance_id: &str,
) -> tracing::Span {
    if let Some(trace_ctx) = context.trace_context() {
        info_span!(
            "client_request",
            operation = operation,
            request_id = context.inner().id(),
            instance_id = instance_id,
            trace_id = trace_ctx.trace_id.as_str(),
            parent_id = trace_ctx.span_id.as_str(),
            x_request_id = trace_ctx.x_request_id.as_deref().unwrap_or(""),
            x_dynamo_request_id = trace_ctx.x_dynamo_request_id.as_deref().unwrap_or(""),
            tracestate = trace_ctx.tracestate.as_deref().unwrap_or("")
        )
    } else {
        info_span!(
            "client_request",
            operation = operation,
            request_id = context.inner().id(),
            instance_id = instance_id,
        )
    }
}

127
128
129
130
131
/// A Python module implemented in Rust. The name of this function must match
/// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to
/// import the module.
#[pymodule]
fn _core(m: &Bound<'_, PyModule>) -> PyResult<()> {
Ryan Olson's avatar
Ryan Olson committed
132
    logging::init();
Yan Ru Pei's avatar
Yan Ru Pei committed
133
    m.add_function(wrap_pyfunction!(llm::kv::compute_block_hash_for_seq_py, m)?)?;
Ryan Olson's avatar
Ryan Olson committed
134
    m.add_function(wrap_pyfunction!(log_message, m)?)?;
135
    m.add_function(wrap_pyfunction!(register_llm, m)?)?;
136
137
    m.add_function(wrap_pyfunction!(llm::entrypoint::make_engine, m)?)?;
    m.add_function(wrap_pyfunction!(llm::entrypoint::run_input, m)?)?;
138

139
140
141
142
143
144
145
    m.add_class::<DistributedRuntime>()?;
    m.add_class::<CancellationToken>()?;
    m.add_class::<Namespace>()?;
    m.add_class::<Component>()?;
    m.add_class::<Endpoint>()?;
    m.add_class::<Client>()?;
    m.add_class::<AsyncResponseStream>()?;
146
    m.add_class::<llm::disagg_router::DisaggregatedRouter>()?;
147
148
149
    m.add_class::<llm::entrypoint::EntrypointArgs>()?;
    m.add_class::<llm::entrypoint::EngineConfig>()?;
    m.add_class::<llm::entrypoint::EngineType>()?;
150
151
    m.add_class::<llm::entrypoint::RouterConfig>()?;
    m.add_class::<llm::entrypoint::KvRouterConfig>()?;
152
    m.add_class::<llm::kv::WorkerMetricsPublisher>()?;
153
    m.add_class::<llm::model_card::ModelDeploymentCard>()?;
154
    m.add_class::<llm::local_model::ModelRuntimeConfig>()?;
155
156
    m.add_class::<llm::preprocessor::OAIChatPreprocessor>()?;
    m.add_class::<llm::backend::Backend>()?;
157
158
    m.add_class::<llm::kv::OverlapScores>()?;
    m.add_class::<llm::kv::KvIndexer>()?;
159
    m.add_class::<llm::kv::ApproxKvIndexer>()?;
160
161
162
    m.add_class::<llm::kv::EndpointKvMetrics>()?;
    m.add_class::<llm::kv::AggregatedMetrics>()?;
    m.add_class::<llm::kv::KvMetricsAggregator>()?;
163
    m.add_class::<llm::kv::KvEventPublisher>()?;
Yan Ru Pei's avatar
Yan Ru Pei committed
164
165
    m.add_class::<llm::kv::RadixTree>()?;
    m.add_class::<llm::kv::ZmqKvEventListener>()?;
166
167
    m.add_class::<llm::kv::ZmqKvEventPublisher>()?;
    m.add_class::<llm::kv::ZmqKvEventPublisherConfig>()?;
168
    m.add_class::<llm::kv::KvRecorder>()?;
169
170
    m.add_class::<http::HttpService>()?;
    m.add_class::<http::HttpAsyncEngine>()?;
171
    m.add_class::<context::Context>()?;
172
    m.add_class::<ModelType>()?;
173
    m.add_class::<ModelInput>()?;
174
175
176
177
    m.add_class::<llm::kv::ForwardPassMetrics>()?;
    m.add_class::<llm::kv::WorkerStats>()?;
    m.add_class::<llm::kv::KvStats>()?;
    m.add_class::<llm::kv::SpecDecodeStats>()?;
178
179
    m.add_class::<llm::kv::KvPushRouter>()?;
    m.add_class::<llm::kv::KvPushRouterStream>()?;
180
    m.add_class::<RouterMode>()?;
181
    m.add("__version__", env!("CARGO_PKG_VERSION"))?;
182
183
184
    m.add_class::<planner::VirtualConnectorCoordinator>()?;
    m.add_class::<planner::VirtualConnectorClient>()?;
    m.add_class::<planner::PlannerDecision>()?;
185
186

    engine::add_to_module(m)?;
187
    parsers::add_to_module(m)?;
188
    prometheus_names::add_to_module(m)?;
189

190
191
192
193
194
    m.add_class::<prometheus_metrics::PyRuntimeMetrics>()?;
    let prometheus_metrics = PyModule::new(m.py(), "prometheus_metrics")?;
    prometheus_metrics::add_to_module(&prometheus_metrics)?;
    m.add_submodule(&prometheus_metrics)?;

195
196
197
    #[cfg(feature = "block-manager")]
    llm::block_manager::add_to_module(m)?;

198
199
200
201
202
203
204
205
206
207
    Ok(())
}

pub fn to_pyerr<E>(err: E) -> PyErr
where
    E: Display,
{
    PyException::new_err(format!("{}", err))
}

Ryan Olson's avatar
Ryan Olson committed
208
209
210
211
212
213
214
/// Log a message from Python with file and line info
#[pyfunction]
#[pyo3(text_signature = "(level, message, module, file, line)")]
fn log_message(level: &str, message: &str, module: &str, file: &str, line: u32) {
    logging::log_message(level, message, module, file, line);
}

215
#[pyfunction]
216
#[pyo3(signature = (model_input, model_type, endpoint, model_path, model_name=None, context_length=None, kv_cache_block_size=None, router_mode=None, migration_limit=0, runtime_config=None, user_data=None, custom_template_path=None))]
217
#[allow(clippy::too_many_arguments)]
218
219
fn register_llm<'p>(
    py: Python<'p>,
220
    model_input: ModelInput,
221
    model_type: ModelType,
222
223
224
    endpoint: Endpoint,
    model_path: &str,
    model_name: Option<&str>,
225
226
    context_length: Option<u32>,
    kv_cache_block_size: Option<u32>,
227
    router_mode: Option<RouterMode>,
228
    migration_limit: u32,
229
    runtime_config: Option<ModelRuntimeConfig>,
230
    user_data: Option<&Bound<'p, PyDict>>,
231
    custom_template_path: Option<&str>,
232
) -> PyResult<Bound<'p, PyAny>> {
233
234
235
    let model_input = match model_input {
        ModelInput::Text => llm_rs::model_type::ModelInput::Text,
        ModelInput::Tokens => llm_rs::model_type::ModelInput::Tokens,
236
        ModelInput::Tensor => llm_rs::model_type::ModelInput::Tensor,
237
238
    };

239
240
    let model_type_obj = model_type.inner;

241
242
    let inner_path = model_path.to_string();
    let model_name = model_name.map(|n| n.to_string());
243
244
245
    let router_mode = router_mode.unwrap_or(RouterMode::RoundRobin);
    let router_config = RouterConfig::new(router_mode.into(), KvRouterConfig::default());

246
247
248
249
250
251
252
253
254
255
256
257
258
    // Early validation of custom template path
    let custom_template_path_owned = custom_template_path
        .map(|s| {
            let path = PathBuf::from(s);
            if !path.exists() {
                return Err(PyErr::new::<pyo3::exceptions::PyFileNotFoundError, _>(
                    format!("Custom template file does not exist: {}", path.display()),
                ));
            }
            Ok(path)
        })
        .transpose()?;

259
260
261
262
263
264
265
    let user_data_json = user_data
        .map(|dict| pythonize::depythonize(dict))
        .transpose()
        .map_err(|err| {
            PyErr::new::<PyException, _>(format!("Failed to convert user_data: {}", err))
        })?;

266
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
267
268
269
270
271
        let mut builder = dynamo_llm::local_model::LocalModelBuilder::default();
        builder
            .model_path(Some(PathBuf::from(inner_path)))
            .model_name(model_name)
            .context_length(context_length)
272
            .kv_cache_block_size(kv_cache_block_size)
273
            .router_config(Some(router_config))
274
            .migration_limit(Some(migration_limit))
275
            .runtime_config(runtime_config.unwrap_or_default().inner)
276
277
            .user_data(user_data_json)
            .custom_template_path(custom_template_path_owned);
278
        // Download from HF, load the ModelDeploymentCard
279
        let mut local_model = builder.build().await.map_err(to_pyerr)?;
280
281
        // Advertise ourself on etcd so ingress can find us
        local_model
282
            .attach(&endpoint.inner, model_type_obj, model_input)
283
284
285
286
287
288
289
            .await
            .map_err(to_pyerr)?;

        Ok(())
    })
}

290
291
#[pyclass]
#[derive(Clone)]
Ryan Olson's avatar
Ryan Olson committed
292
pub struct DistributedRuntime {
293
294
295
296
    inner: rs::DistributedRuntime,
    event_loop: PyObject,
}

Ryan Olson's avatar
Ryan Olson committed
297
298
impl DistributedRuntime {
    #[allow(dead_code)]
299
    pub(crate) fn inner(&self) -> &rs::DistributedRuntime {
Ryan Olson's avatar
Ryan Olson committed
300
301
302
303
        &self.inner
    }
}

304
#[pyclass]
305
#[derive(Clone)]
306
307
308
309
310
struct CancellationToken {
    inner: rs::CancellationToken,
}

#[pyclass]
311
#[derive(Clone)]
312
313
314
315
316
317
struct Namespace {
    inner: rs::component::Namespace,
    event_loop: PyObject,
}

#[pyclass]
318
#[derive(Clone)]
319
320
321
322
323
324
struct Component {
    inner: rs::component::Component,
    event_loop: PyObject,
}

#[pyclass]
325
#[derive(Clone)]
326
327
328
329
330
331
struct Endpoint {
    inner: rs::component::Endpoint,
    event_loop: PyObject,
}

#[pyclass]
332
#[derive(Clone)]
333
struct Client {
334
    router: rs::pipeline::PushRouter<serde_json::Value, RsAnnotated<serde_json::Value>>,
335
336
}

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
#[pyclass]
#[derive(Clone, PartialEq)]
struct ModelType {
    inner: llm_rs::model_type::ModelType,
}

#[pymethods]
#[allow(non_upper_case_globals)]
impl ModelType {
    #[classattr]
    const Chat: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Chat,
    };
    #[classattr]
    const Completions: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Completions,
    };
    #[classattr]
    const Embedding: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Embedding,
    };
358
359
360
361
    #[classattr]
    const TensorBased: Self = ModelType {
        inner: llm_rs::model_type::ModelType::TensorBased,
    };
362
363
364
365
366
367
368
369
370
371
372
373

    fn __or__(&self, other: &Self) -> Self {
        ModelType {
            inner: self.inner | other.inner,
        }
    }

    fn __str__(&self) -> String {
        self.inner.to_string()
    }
}

374
375
#[pyclass(eq, eq_int)]
#[derive(Clone, PartialEq)]
376
377
378
enum ModelInput {
    Text = 1,
    Tokens = 2,
379
    Tensor = 3,
380
381
}

382
383
384
#[pymethods]
impl DistributedRuntime {
    #[new]
385
    fn new(event_loop: PyObject, is_static: bool) -> PyResult<Self> {
386
        let worker = rs::Worker::from_settings().map_err(to_pyerr)?;
387
        INIT.get_or_try_init(|| {
388
            let primary = worker.tokio_runtime()?;
389
390
391
392
393
394
            pyo3_async_runtimes::tokio::init_with_runtime(primary)
                .map_err(|e| rs::error!("failed to initialize pyo3 static runtime: {:?}", e))?;
            rs::OK(())
        })
        .map_err(to_pyerr)?;

395
        let runtime = worker.runtime().clone();
396

397
398
399
400
401
402
403
404
405
406
407
        let inner =
            if is_static {
                runtime.secondary().block_on(
                    rs::DistributedRuntime::from_settings_without_discovery(runtime),
                )
            } else {
                runtime
                    .secondary()
                    .block_on(rs::DistributedRuntime::from_settings(runtime))
            };
        let inner = inner.map_err(to_pyerr)?;
408
409
410
411

        Ok(DistributedRuntime { inner, event_loop })
    }

Ryan Olson's avatar
Ryan Olson committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
    #[staticmethod]
    fn detached(py: Python) -> PyResult<Self> {
        let rt = rs::Worker::runtime_from_existing().map_err(to_pyerr)?;
        let handle = rt.primary();

        let inner = handle
            .block_on(rs::DistributedRuntime::from_settings(rt))
            .map_err(to_pyerr)?;

        Ok(DistributedRuntime {
            inner,
            event_loop: py.None(),
        })
    }

427
428
429
430
431
432
433
434
435
    /// Remove everything in an etcd namespace.
    /// Will be removed once we can clear the MDC automatically.
    fn temp_clear_namespace<'p>(&self, py: Python<'p>, name: String) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            inner.temp_clear_namespace(&name).await.map_err(to_pyerr)
        })
    }

436
437
438
439
440
441
442
    fn namespace(&self, name: String) -> PyResult<Namespace> {
        Ok(Namespace {
            inner: self.inner.namespace(name).map_err(to_pyerr)?,
            event_loop: self.event_loop.clone(),
        })
    }

443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
    /// Allocate a contiguous block of ports from the specified range and atomically reserve them.
    /// Returns a list of all allocated ports in order.
    #[pyo3(signature = (namespace, port_min, port_max, block_size, context=None))]
    fn allocate_port_block<'p>(
        &self,
        py: Python<'p>,
        namespace: &str,
        port_min: u16,
        port_max: u16,
        block_size: u16,
        context: Option<String>, // Optional info to store alongside the reservation
    ) -> PyResult<Bound<'p, PyAny>> {
        const MAX_ALLOCATE_ATTEMPTS: usize = 100;
        if block_size == 0 {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
                "Block size must be at least 1",
            ));
        }

        let Some(etcd_client) = self.inner.etcd_client() else {
            return Err(PyErr::new::<PyException, _>(
                "Static workers should not need to reserve ports",
            ));
        };

        let min = port_min;
        let max = port_max;

        // Compute maximum valid starting port (inclusive)
        let max_start_port = max.saturating_sub(block_size.saturating_sub(1));
        if max_start_port < min {
            return Err(PyErr::new::<PyException, _>(format!(
                "Port range {min}-{max} is too small for block size {block_size}",
            )));
        }

        // Randomize candidate starting ports to reduce contention/races
        let candidate_count =
            (max_start_port - port_min + 1).min(MAX_ALLOCATE_ATTEMPTS as u16) as usize;
        let mut rng = rand::rng();
        let candidate_ports: Vec<u16> =
            (port_min..=max_start_port).choose_multiple(&mut rng, candidate_count);

        let local_ip = match local_ip() {
            Ok(ip) => ip,
            Err(err) => {
                return Err(PyErr::new::<PyException, _>(format!(
                    "Failed fetching local IP address: {err}"
                )));
            }
        };

        let context_bytes = context.map(|s| s.as_bytes().to_vec()).unwrap_or_default();
        let namespace = namespace.to_owned();

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            for (attempt_idx, start_port) in candidate_ports.into_iter().enumerate() {
                let end_port_exclusive = start_port + block_size;
                let ports_to_reserve: Vec<u16> = (start_port..end_port_exclusive).collect();

                // Hold/bind all ports in the block
                let mut sockets = Vec::with_capacity(ports_to_reserve.len());
                let mut bind_failed = false;

                for &port in &ports_to_reserve {
                    match bind_tcp_port(port) {
                        Ok(sock) => sockets.push(sock),
                        Err(e) => {
                            tracing::error!(
512
513
514
                                "Failed to bind to port block starting at {start_port} (attempt {}): {e}",
                                attempt_idx + 1,
                            );
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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
                            bind_failed = true;
                            break;
                        }
                    }
                }

                if bind_failed {
                    // Let previously bound sockets drop here
                    if attempt_idx < candidate_count - 1 {
                        tokio::time::sleep(Duration::from_millis(10)).await;
                    }
                    continue;
                }

                // With sockets held, reserve in ETCD
                let mut reserved_keys = Vec::with_capacity(ports_to_reserve.len());
                let mut reservation_failed = false;
                for port in &ports_to_reserve {
                    let key = make_port_key(&namespace, local_ip, *port).map_err(to_pyerr)?;

                    if let Err(e) = etcd_client
                        .kv_create(&key, context_bytes.clone(), None)
                        .await
                    {
                        tracing::error!(
                            "Failed to reserve port block starting at {start_port} (attempt {}): {e}",
                            attempt_idx + 1,
                        );
                        reservation_failed = true;
                        break;
                    }
                    reserved_keys.push(key);
                }

                if reservation_failed {
                    // Cleanup partial reservations
                    for key in reserved_keys {
                        if let Err(e) = etcd_client.kv_delete(key.as_str(), None).await {
                            tracing::warn!("Failed to cleanup reserved port {key}: {e}");
                        }
                    }

                    // Sockets automatically released via RAII
                    if attempt_idx < candidate_count - 1 {
                        tokio::time::sleep(Duration::from_millis(10)).await;
                    }
                    continue;
                }

                // Success - sockets will be released automatically
                tracing::debug!("Reserved port block {ports_to_reserve:?}");
                return Ok(ports_to_reserve);
            }

            Err(PyErr::new::<PyException, _>(format!(
570
571
                "Failed to allocate and reserve a port block of size {block_size} from range {min}-{max} after {candidate_count} attempts"
            )))
572
573
574
        })
    }

575
576
577
578
579
580
581
    fn shutdown(&self) {
        self.inner.runtime().shutdown();
    }

    fn event_loop(&self) -> PyObject {
        self.event_loop.clone()
    }
582
583
584
585
586

    fn child_token(&self) -> CancellationToken {
        let inner = self.inner.runtime().child_token();
        CancellationToken { inner }
    }
587
588
}

589
590
591
592
593
594
595
596
597
598
599
600
601
602
// Bind a TCP port and return a socket held until dropped.
fn bind_tcp_port(port: u16) -> std::io::Result<socket2::Socket> {
    let sock = socket2::Socket::new(
        socket2::Domain::IPV4,
        socket2::Type::STREAM,
        Some(socket2::Protocol::TCP),
    )?;
    sock.set_reuse_address(true)?;
    let addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, port));
    sock.bind(&addr.into())?;
    Ok(sock)
}

fn make_port_key(namespace: &str, node_ip: IpAddr, port: u16) -> anyhow::Result<String> {
603
    Ok(format!("v1/{namespace}/ports/{node_ip}/{port}"))
604
605
606
607
608
609
610
611
612
613
614
615
}

fn local_ip() -> Result<IpAddr, local_ip_address::Error> {
    local_ip_address::local_ip().or_else(|err| match err {
        local_ip_address::Error::LocalIpAddressNotFound => {
            // Fall back to IPv6 if no IPv4 addresses are found
            local_ip_address::local_ipv6()
        }
        _ => Err(err),
    })
}

616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
#[pymethods]
impl CancellationToken {
    fn cancel(&self) {
        self.inner.cancel();
    }

    fn cancelled<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let token = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            token.cancelled().await;
            Ok(())
        })
    }
}

#[pymethods]
impl Component {
    fn endpoint(&self, name: String) -> PyResult<Endpoint> {
        let inner = self.inner.endpoint(name);
        Ok(Endpoint {
            inner,
            event_loop: self.event_loop.clone(),
        })
    }

    fn create_service<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let builder = self.inner.service_builder();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            let _ = builder.create().await.map_err(to_pyerr)?;
            Ok(())
        })
    }
648
649
650
651
652
653

    /// Get a RuntimeMetrics helper for creating Prometheus metrics
    #[getter]
    fn metrics(&self) -> prometheus_metrics::PyRuntimeMetrics {
        prometheus_metrics::PyRuntimeMetrics::from_component(self.inner.clone())
    }
654
655
656
657
}

#[pymethods]
impl Endpoint {
658
    #[pyo3(signature = (generator, graceful_shutdown = true, metrics_labels = None, health_check_payload = None))]
659
660
661
662
    fn serve_endpoint<'p>(
        &self,
        py: Python<'p>,
        generator: PyObject,
663
        graceful_shutdown: Option<bool>,
664
        metrics_labels: Option<Vec<(String, String)>>,
665
        health_check_payload: Option<&Bound<'p, PyDict>>,
666
667
668
669
670
671
    ) -> PyResult<Bound<'p, PyAny>> {
        let engine = Arc::new(engine::PythonAsyncEngine::new(
            generator,
            self.event_loop.clone(),
        )?);
        let ingress = JsonServerStreamingIngress::for_engine(engine).map_err(to_pyerr)?;
672
673
674
675
676
677
678
679
680
681
682
683
684

        // Convert Python dict to serde_json::Value if provided and validate it's an object
        let health_payload_json = health_check_payload
            .map(|dict| pythonize::depythonize::<serde_json::Value>(dict))
            .transpose()
            .map_err(|err| {
                pyo3::exceptions::PyTypeError::new_err(format!(
                    "Failed to convert health_check_payload: {}",
                    err
                ))
            })?;

        // Require an object/dict
685
686
687
688
689
690
        if let Some(ref payload) = health_payload_json
            && !payload.is_object()
        {
            return Err(pyo3::exceptions::PyTypeError::new_err(
                "health_check_payload must be a JSON object (dict)",
            ));
691
692
693
        }

        let mut builder = self
694
695
696
697
            .inner
            .endpoint_builder()
            .metrics_labels(metrics_labels)
            .handler(ingress);
698
699
700
701
702

        if let Some(payload) = health_payload_json {
            builder = builder.health_check_payload(payload);
        }

703
        let graceful_shutdown = graceful_shutdown.unwrap_or(true);
704
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
705
706
707
708
709
            builder
                .graceful_shutdown(graceful_shutdown)
                .start()
                .await
                .map_err(to_pyerr)?;
710
711
712
713
            Ok(())
        })
    }

714
715
716
    fn client<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
717
            let client = inner.client().await.map_err(to_pyerr)?;
718
719
720
721
722
723
            let push_router = rs::pipeline::PushRouter::<
                serde_json::Value,
                RsAnnotated<serde_json::Value>,
            >::from_client(client, Default::default())
            .await
            .map_err(to_pyerr)?;
724
725
726
            Ok(Client {
                router: push_router,
            })
727
728
        })
    }
729
730

    fn lease_id(&self) -> i64 {
731
732
733
734
735
        self.inner
            .drt()
            .primary_lease()
            .map(|l| l.id())
            .unwrap_or(0)
736
    }
737
738
739
740
741
742

    /// Get a RuntimeMetrics helper for creating Prometheus metrics
    #[getter]
    fn metrics(&self) -> prometheus_metrics::PyRuntimeMetrics {
        prometheus_metrics::PyRuntimeMetrics::from_endpoint(self.inner.clone())
    }
743
744
745
746
747
748
749
750
751
752
753
}

#[pymethods]
impl Namespace {
    fn component(&self, name: String) -> PyResult<Component> {
        let inner = self.inner.component(name).map_err(to_pyerr)?;
        Ok(Component {
            inner,
            event_loop: self.event_loop.clone(),
        })
    }
754
755
756
757
758
759

    /// Get a RuntimeMetrics helper for creating Prometheus metrics
    #[getter]
    fn metrics(&self) -> prometheus_metrics::PyRuntimeMetrics {
        prometheus_metrics::PyRuntimeMetrics::from_namespace(self.inner.clone())
    }
760
761
762
763
}

#[pymethods]
impl Client {
764
765
766
767
    /// Get list of current instances.
    /// Replaces endpoint_ids.
    fn instance_ids(&self) -> Vec<i64> {
        self.router.client.instance_ids()
768
769
    }

770
771
772
    /// Wait for an instance to be available for work.
    /// Replaces wait_for_endpoints.
    fn wait_for_instances<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
773
        let inner = self.router.client.clone();
774
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
775
            inner
776
                .wait_for_instances()
777
778
779
                .await
                .map(|v| v.into_iter().map(|cei| cei.id()).collect::<Vec<i64>>())
                .map_err(to_pyerr)
780
781
782
783
        })
    }

    /// Issue a request to the endpoint using the default routing strategy.
784
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
785
786
787
788
789
    fn generate<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
790
        context: Option<context::Context>,
791
    ) -> PyResult<Bound<'p, PyAny>> {
792
        if self.router.client.is_static() {
793
            self.r#static(py, request, annotated, context)
794
        } else {
795
            self.random(py, request, annotated, context)
796
        }
797
798
799
    }

    /// Send a request to the next endpoint in a round-robin fashion.
800
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
801
802
803
804
805
    fn round_robin<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
806
        context: Option<context::Context>,
807
808
809
810
811
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
812
        let client = self.router.clone();
813
814

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
815
816
            let stream = match context {
                Some(context) => {
817
818
819
820
821
822
823
                    let request_ctx = RsContext::with_id(request, context.inner().id().to_string());

                    // Always instrument with appropriate span (none if no trace context)
                    let span = get_span_for_context(&context, "round_robin");
                    let stream_future = client.round_robin(request_ctx).instrument(span);

                    let stream = stream_future.await.map_err(to_pyerr)?;
824
825
826
827
828
                    context.inner().link_child(stream.context());
                    stream
                }
                _ => client.round_robin(request.into()).await.map_err(to_pyerr)?,
            };
829
830
831
832
833
834
835
836
837
            tokio::spawn(process_stream(stream, tx));
            Ok(AsyncResponseStream {
                rx: Arc::new(Mutex::new(rx)),
                annotated,
            })
        })
    }

    /// Send a request to a random endpoint.
838
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
839
840
841
842
843
    fn random<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
844
        context: Option<context::Context>,
845
846
847
848
849
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
850
        let client = self.router.clone();
851
852

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
853
854
            let stream = match context {
                Some(context) => {
855
856
857
858
859
860
                    let request_ctx = RsContext::with_id(request, context.inner().id().to_string());

                    let span = get_span_for_context(&context, "random");
                    let stream_future = client.random(request_ctx).instrument(span);

                    let stream = stream_future.await.map_err(to_pyerr)?;
861
862
863
864
865
                    context.inner().link_child(stream.context());
                    stream
                }
                _ => client.random(request.into()).await.map_err(to_pyerr)?,
            };
866
867
868
869
870
871
872
873
874
            tokio::spawn(process_stream(stream, tx));
            Ok(AsyncResponseStream {
                rx: Arc::new(Mutex::new(rx)),
                annotated,
            })
        })
    }

    /// Directly send a request to a specific endpoint.
875
    #[pyo3(signature = (request, instance_id, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
876
877
878
879
    fn direct<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
880
        instance_id: i64,
881
        annotated: Option<bool>,
882
        context: Option<context::Context>,
883
884
885
886
887
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
888
        let client = self.router.clone();
889
890

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
891
892
            let stream = match context {
                Some(context) => {
893
894
895
896
897
898
899
                    let request_ctx = RsContext::with_id(request, context.inner().id().to_string());

                    let span =
                        get_span_for_direct_context(&context, "direct", &instance_id.to_string());
                    let stream_future = client.direct(request_ctx, instance_id).instrument(span);

                    let stream = stream_future.await.map_err(to_pyerr)?;
900
901
902
903
904
905
906
907
                    context.inner().link_child(stream.context());
                    stream
                }
                _ => client
                    .direct(request.into(), instance_id)
                    .await
                    .map_err(to_pyerr)?,
            };
908
909
910
911
912
913
914
915
916

            tokio::spawn(process_stream(stream, tx));

            Ok(AsyncResponseStream {
                rx: Arc::new(Mutex::new(rx)),
                annotated,
            })
        })
    }
917
918

    /// Directly send a request to a pre-defined static worker
919
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
920
921
922
923
924
    fn r#static<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
925
        context: Option<context::Context>,
926
927
928
929
930
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
931
        let client = self.router.clone();
932
933

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
934
935
            let stream = match context {
                Some(context) => {
936
937
938
939
940
941
                    let request_ctx = RsContext::with_id(request, context.inner().id().to_string());

                    let span = get_span_for_context(&context, "static");
                    let stream_future = client.r#static(request_ctx).instrument(span);

                    let stream = stream_future.await.map_err(to_pyerr)?;
942
943
944
945
946
                    context.inner().link_child(stream.context());
                    stream
                }
                _ => client.r#static(request.into()).await.map_err(to_pyerr)?,
            };
947
948
949
950
951
952
953
954
955

            tokio::spawn(process_stream(stream, tx));

            Ok(AsyncResponseStream {
                rx: Arc::new(Mutex::new(rx)),
                annotated,
            })
        })
    }
956
957
958
}

async fn process_stream(
959
    stream: EngineStream<RsAnnotated<serde_json::Value>>,
960
961
962
963
964
    tx: tokio::sync::mpsc::Sender<RsAnnotated<PyObject>>,
) {
    let mut stream = stream;
    while let Some(response) = stream.next().await {
        // Convert the response to a PyObject using Python's GIL
965
        let annotated: RsAnnotated<serde_json::Value> = response;
966
        let annotated: RsAnnotated<PyObject> = annotated.map_data(|data| {
967
            Python::with_gil(|py| match pythonize::pythonize(py, &data) {
968
969
                Ok(pyobj) => Ok(pyobj.into()),
                Err(e) => Err(e.to_string()),
970
            })
971
972
973
974
975
976
        });

        let is_error = annotated.is_error();

        // Send the PyObject through the channel or log an error
        if let Err(e) = tx.send(annotated).await {
977
            tracing::error!("Failed to send response: {:?}", e);
978
            break;
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
        }

        if is_error {
            break;
        }
    }
}

#[pyclass]
struct AsyncResponseStream {
    rx: Arc<Mutex<tokio::sync::mpsc::Receiver<RsAnnotated<PyObject>>>>,
    annotated: bool,
}

#[pymethods]
impl AsyncResponseStream {
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__aiter__")]
    fn aiter(slf: PyRef<Self>, py: Python) -> PyResult<Py<PyAny>> {
        slf.into_py_any(py)
    }
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__anext__")]
    fn next<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let rx = self.rx.clone();
        let annotated = self.annotated;

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            loop {
                let value = rx.lock().await.recv().await;
                match value {
                    Some(pyobj) => {
                        let pyobj = match pyobj.ok() {
                            Ok(pyobj) => pyobj,
                            Err(e) => {
                                return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(e));
                            }
                        };

                        if annotated {
                            let object = Annotated { inner: pyobj };
                            #[allow(deprecated)]
                            let object = Python::with_gil(|py| object.into_py(py));
                            return Ok(object);
                        } else {
                            match pyobj.data {
                                Some(data) => return Ok(data),
                                None => continue,
                            }
                        }
                    }
                    None => return Err(PyStopAsyncIteration::new_err("Stream exhausted")),
                }
            }
        })
    }
}

#[pyclass]
struct Annotated {
    inner: RsAnnotated<PyObject>,
}

#[pymethods]
impl Annotated {
    #[new]
    fn new(data: PyObject) -> Self {
        Annotated {
            inner: RsAnnotated::from_data(data),
        }
    }

    fn is_error(&self) -> bool {
        self.inner.is_error()
    }

    fn data(&self) -> Option<PyObject> {
        self.inner.data.clone()
    }

    fn event(&self) -> Option<String> {
        self.inner.event.clone()
    }

    fn comments(&self) -> Option<Vec<String>> {
        self.inner.comment.clone()
    }

    fn id(&self) -> Option<String> {
        self.inner.id.clone()
    }

    #[pyo3(name = "__repr__")]
    fn _repr(&self, py: Python) -> String {
        let data = self.inner.data.clone().map(|obj| {
            obj.call_method0(py, "__repr__")
                .and_then(|repr_obj| repr_obj.extract::<Py<PyString>>(py))
                .map(|py_str| py_str.to_string_lossy(py).into_owned())
                .unwrap_or_else(|_| "<failed_repr>".to_string())
        });

        format!(
            "Annotated(data={}, event={}, comment={:?}, id={})",
            data.unwrap_or_else(|| "<no_data>".to_string()),
            self.inner.event.as_deref().unwrap_or("None"),
            self.inner.comment.as_deref().unwrap_or(&[]),
            self.inner.id.as_deref().unwrap_or("None")
        )
    }
}