velo 0.4.0

Velo distributed-systems runtime: active messaging, peer discovery, streaming, rendezvous, and queue backends
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
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
512
513
514
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
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
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
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
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
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
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
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
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
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
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! gRPC transport implementation using tonic bidirectional streaming.
//!
//! This transport wraps the same framing protocol used by TCP/UDS transports
//! inside gRPC `FramedData` messages. Outbound messages are sent via a
//! `VeloStreamingClient` bidi stream; inbound messages arrive through the
//! tonic server (`VeloStreamingService`).

use crate::observability::{Direction, TransportRejection};
use anyhow::{Context, Result};
use bytes::Bytes;
use dashmap::DashMap;
use std::net::SocketAddr;
use std::sync::{Arc, OnceLock};
use std::time::Duration;
use tokio_stream::wrappers::ReceiverStream;
use tracing::{debug, error, info, warn};

use crate::transports::tcp::TcpFrameCodec;
use crate::transports::transport::{
    HealthCheckError, SendBackpressure, ShutdownState, TransportError, TransportErrorHandler,
    try_send_or_backpressure,
};
use crate::transports::utils::interfaces::{
    InterfaceEndpoint, InterfaceFilter, parse_endpoints, resolve_advertise_endpoints,
    select_best_endpoint,
};
use velo_ext::{MessageType, PeerInfo, Transport, TransportAdapter, TransportKey, WorkerAddress};

use super::proto;
use super::proto::velo_streaming_client::VeloStreamingClient;
use super::proto::velo_streaming_server::VeloStreamingServer;
use super::server::VeloStreamingService;

/// gRPC transport using tonic bidirectional streaming.
///
/// Follows the same structural patterns as `TcpTransport`: lazy per-peer
/// connections via `DashMap`, writer tasks fed through flume channels, and
/// 3-phase graceful shutdown.
pub struct GrpcTransport {
    /// Transport identity key (e.g. `"grpc"`).
    key: TransportKey,
    /// Address to bind the tonic server to.
    bind_addr: SocketAddr,
    /// Advertised address included in `WorkerAddress`.
    local_address: WorkerAddress,

    /// Registered peer addresses (instance_id -> socket address).
    peers: Arc<DashMap<crate::InstanceId, SocketAddr>>,
    /// Active outbound connections (instance_id -> writer handle).
    connections: Arc<DashMap<crate::InstanceId, ConnectionHandle>>,

    /// Tokio runtime handle, set during `start()`.
    runtime: OnceLock<tokio::runtime::Handle>,

    /// Per-transport cancellation token for writer tasks.
    cancel_token: tokio_util::sync::CancellationToken,
    /// Shared shutdown coordinator, set during `start()`.
    shutdown_state: OnceLock<ShutdownState>,

    /// Backpressure capacity for per-connection writer channels.
    channel_capacity: usize,
    /// Timeout for outbound gRPC connections.
    connect_timeout: Duration,

    /// Transport adapter for routing inbound frames (set during `start()`).
    adapter: OnceLock<TransportAdapter>,

    /// Optional pre-bound listener (used for tests to avoid port races).
    listener: std::sync::Mutex<Option<std::net::TcpListener>>,

    /// Cached local interfaces for endpoint selection.
    local_interfaces: OnceLock<Vec<InterfaceEndpoint>>,

    /// NUMA hint for topology-aware NIC selection.
    numa_hint: Option<u32>,

    /// Shared observability collectors, installed by the backend.
    metrics: OnceLock<std::sync::Arc<dyn velo_ext::TransportObservability>>,
}

/// Handle to a connection's writer task.
#[derive(Clone)]
struct ConnectionHandle {
    tx: flume::Sender<SendTask>,
}

/// Task sent to the writer task containing frame data.
struct SendTask {
    msg_type: MessageType,
    header: Bytes,
    payload: Bytes,
    on_error: Arc<dyn TransportErrorHandler>,
}

impl SendTask {
    fn on_error(self, error: impl Into<String>) {
        self.on_error
            .on_error(self.header, self.payload, error.into());
    }
}

impl GrpcTransport {
    /// Get or create a connection to a peer (lazy initialization).
    fn get_or_create_connection(&self, instance_id: crate::InstanceId) -> Result<ConnectionHandle> {
        // Fast path: connection already exists and is alive.
        if let Some(handle) = self.connections.get(&instance_id) {
            if !handle.tx.is_disconnected() {
                return Ok(handle.clone());
            }
            // Stale -- drop guard before mutating the map.
            drop(handle);
            self.connections
                .remove_if(&instance_id, |_, h| h.tx.is_disconnected());
            self.update_connection_gauge();
        }

        let rt = self.runtime.get().ok_or(TransportError::NotStarted)?;
        // Atomic check-and-insert via entry API.
        let handle = match self.connections.entry(instance_id) {
            dashmap::mapref::entry::Entry::Occupied(mut entry) => {
                if !entry.get().tx.is_disconnected() {
                    entry.get().clone()
                } else {
                    let handle = self.create_connection(instance_id, rt)?;
                    entry.insert(handle.clone());
                    self.update_connection_gauge();
                    handle
                }
            }
            dashmap::mapref::entry::Entry::Vacant(entry) => {
                let handle = self.create_connection(instance_id, rt)?;
                entry.insert(handle.clone());
                self.update_connection_gauge();
                handle
            }
        };

        Ok(handle)
    }

    /// Create a new connection handle and spawn the writer task.
    fn create_connection(
        &self,
        instance_id: crate::InstanceId,
        rt: &tokio::runtime::Handle,
    ) -> Result<ConnectionHandle> {
        let addr = *self
            .peers
            .get(&instance_id)
            .ok_or(TransportError::PeerNotRegistered(instance_id))?
            .value();

        let (tx, rx) = flume::bounded(self.channel_capacity);
        let handle = ConnectionHandle { tx };

        let cancel = self.cancel_token.clone();
        let conns = Arc::clone(&self.connections);
        let connect_timeout = self.connect_timeout;
        let channel_capacity = self.channel_capacity;
        let adapter = self.adapter.get().cloned();
        let metrics = self.metrics.get().cloned();
        let transport_name = self.key.to_string();

        rt.spawn(connection_writer_task(
            addr,
            instance_id,
            rx,
            conns,
            cancel,
            connect_timeout,
            channel_capacity,
            adapter,
            metrics,
            transport_name,
        ));

        debug!("Created new gRPC connection to {} ({})", instance_id, addr);
        Ok(handle)
    }

    fn update_peer_gauge(&self) {
        if let Some(metrics) = self.metrics.get() {
            metrics.set_registered_peers(self.peers.len());
        }
    }

    fn update_connection_gauge(&self) {
        if let Some(metrics) = self.metrics.get() {
            metrics.set_active_connections(self.connections.len());
        }
    }

    /// Slow path: establish (or reuse) a connection, then enqueue via the
    /// shared backpressure helper.
    fn slow_path_send(
        &self,
        instance_id: crate::InstanceId,
        send_msg: SendTask,
    ) -> Result<(), SendBackpressure> {
        if self.runtime.get().is_none() {
            send_msg.on_error("Transport not started");
            return Ok(());
        }
        let handle = match self.get_or_create_connection(instance_id) {
            Ok(h) => h,
            Err(e) => {
                send_msg.on_error(format!("Failed to create connection: {}", e));
                return Ok(());
            }
        };
        let r = try_send_or_backpressure(
            &handle.tx,
            send_msg,
            |msg| msg.on_error("Connection closed immediately"),
            |msg| msg.on_error("Connection closed"),
        );
        if let Some(m) = self.metrics.get()
            && r.is_err()
        {
            m.record_send_backpressure();
        }
        r
    }
}

impl Transport for GrpcTransport {
    fn key(&self) -> TransportKey {
        self.key.clone()
    }

    fn address(&self) -> WorkerAddress {
        self.local_address.clone()
    }

    fn register(&self, peer_info: PeerInfo) -> Result<(), TransportError> {
        let endpoint = peer_info
            .worker_address()
            .get_entry(&self.key)
            .map_err(|_| TransportError::NoEndpoint)?
            .ok_or(TransportError::NoEndpoint)?;

        // Parse endpoints (supports both new multi-endpoint and legacy formats)
        let remote_endpoints = parse_endpoints(&endpoint).map_err(|e| {
            error!("Failed to parse gRPC endpoint: {}", e);
            TransportError::InvalidEndpoint
        })?;

        // Lazy-init local interfaces for endpoint selection
        let local = self.local_interfaces.get_or_init(|| {
            resolve_advertise_endpoints(self.bind_addr, &InterfaceFilter::All).unwrap_or_default()
        });

        // Select best endpoint based on NUMA + subnet affinity
        let addr = select_best_endpoint(&remote_endpoints, local, self.numa_hint)
            .ok_or(TransportError::InvalidEndpoint)?;

        self.peers.insert(peer_info.instance_id(), addr);
        self.update_peer_gauge();
        debug!("Registered peer {} at {}", peer_info.instance_id(), addr);

        Ok(())
    }

    #[inline]
    fn send_message(
        &self,
        instance_id: crate::InstanceId,
        header: Bytes,
        payload: Bytes,
        message_type: MessageType,
        on_error: Arc<dyn TransportErrorHandler>,
    ) -> Result<(), SendBackpressure> {
        let send_msg = SendTask {
            msg_type: message_type,
            header,
            payload,
            on_error,
        };

        // Fast path: try existing connection.
        if let Some(handle) = self.connections.get(&instance_id) {
            match handle.tx.try_send(send_msg) {
                Ok(()) => return Ok(()),
                Err(flume::TrySendError::Full(send_msg)) => {
                    if let Some(m) = self.metrics.get() {
                        m.record_send_backpressure();
                    }
                    let tx = handle.tx.clone();
                    return Err(SendBackpressure::new(Box::pin(async move {
                        if let Err(flume::SendError(m)) = tx.send_async(send_msg).await {
                            m.on_error("Connection closed");
                        }
                    })));
                }
                Err(flume::TrySendError::Disconnected(send_msg_out)) => {
                    drop(handle);
                    self.connections
                        .remove_if(&instance_id, |_, h| h.tx.is_disconnected());
                    self.update_connection_gauge();
                    return self.slow_path_send(instance_id, send_msg_out);
                }
            }
        }
        self.slow_path_send(instance_id, send_msg)
    }

    fn start(
        &self,
        _instance_id: crate::InstanceId,
        channels: TransportAdapter,
        rt: tokio::runtime::Handle,
    ) -> futures::future::BoxFuture<'_, anyhow::Result<()>> {
        self.runtime.set(rt.clone()).ok();
        self.shutdown_state
            .set(channels.shutdown_state.clone())
            .ok();
        self.adapter.set(channels.clone()).ok();

        let bind_addr = self.bind_addr;
        let shutdown_state = channels.shutdown_state.clone();
        let listener = self
            .listener
            .lock()
            .expect("Listener mutex poisoned")
            .take();

        Box::pin(async move {
            // Use pre-bound listener if provided, otherwise bind to the address.
            let std_listener = if let Some(l) = listener {
                l
            } else {
                std::net::TcpListener::bind(bind_addr).context("Failed to bind gRPC listener")?
            };
            let local_addr = std_listener
                .local_addr()
                .context("Failed to get local address")?;
            std_listener
                .set_nonblocking(true)
                .context("Failed to set listener to non-blocking")?;

            let incoming = tokio::net::TcpListener::from_std(std_listener)
                .context("Failed to convert std TcpListener to tokio TcpListener")?;
            let incoming = tokio_stream::wrappers::TcpListenerStream::new(incoming);

            let svc = VeloStreamingService::new(
                channels,
                shutdown_state.clone(),
                self.key.to_string(),
                self.metrics.get().cloned(),
            );
            let teardown_token = shutdown_state.teardown_token().clone();

            rt.spawn(async move {
                if let Err(e) = tonic::transport::Server::builder()
                    .add_service(VeloStreamingServer::new(svc))
                    .serve_with_incoming_shutdown(incoming, teardown_token.cancelled())
                    .await
                {
                    error!("gRPC server error: {}", e);
                }
            });

            info!("gRPC transport started on {}", local_addr);

            Ok(())
        })
    }

    fn begin_drain(&self) {
        // Per-frame gate in the server handler handles drain -- no-op here.
    }

    fn shutdown(&self) {
        info!("Shutting down gRPC transport");

        if let Some(state) = self.shutdown_state.get() {
            state.teardown_token().cancel();
        }
        self.cancel_token.cancel();
        self.connections.clear();
        self.update_connection_gauge();
    }

    fn set_observability(
        &self,
        observability: std::sync::Arc<dyn velo_ext::TransportObservability>,
    ) {
        let _ = self.metrics.set(observability);
        self.update_peer_gauge();
        self.update_connection_gauge();
    }

    fn check_health(
        &self,
        instance_id: crate::InstanceId,
        timeout: Duration,
    ) -> std::pin::Pin<
        Box<dyn std::future::Future<Output = Result<(), HealthCheckError>> + Send + '_>,
    > {
        Box::pin(async move {
            let connection_exists = self.connections.contains_key(&instance_id);

            if let Some(handle) = self.connections.get(&instance_id) {
                if !handle.tx.is_disconnected() {
                    return Ok(());
                }
                drop(handle);
                self.connections
                    .remove_if(&instance_id, |_, h| h.tx.is_disconnected());
            }

            let addr = *self
                .peers
                .get(&instance_id)
                .ok_or(HealthCheckError::PeerNotRegistered)?
                .value();

            let url = format!("http://{}", addr);
            let endpoint = tonic::transport::Endpoint::from_shared(url)
                .map_err(|_| HealthCheckError::ConnectionFailed)?
                .connect_timeout(timeout);

            match tokio::time::timeout(timeout, endpoint.connect()).await {
                Ok(Ok(_channel)) => {
                    if connection_exists {
                        Ok(())
                    } else {
                        Err(HealthCheckError::NeverConnected)
                    }
                }
                Ok(Err(_)) => Err(HealthCheckError::ConnectionFailed),
                Err(_) => Err(HealthCheckError::Timeout),
            }
        })
    }
}

/// Connection writer task for gRPC transport.
///
/// Establishes a bidi stream via `VeloStreamingClient`, sends outbound frames,
/// and spawns a reader task for the response stream. Cleanup (draining queued
/// messages and removing the stale map entry) always runs, even on connect failure.
#[allow(clippy::too_many_arguments)]
async fn connection_writer_task(
    addr: SocketAddr,
    instance_id: crate::InstanceId,
    rx: flume::Receiver<SendTask>,
    connections: Arc<DashMap<crate::InstanceId, ConnectionHandle>>,
    cancel_token: tokio_util::sync::CancellationToken,
    connect_timeout: Duration,
    channel_capacity: usize,
    adapter: Option<TransportAdapter>,
    metrics: Option<std::sync::Arc<dyn velo_ext::TransportObservability>>,
    transport_name: String,
) -> Result<()> {
    let result = connection_writer_inner(
        addr,
        instance_id,
        &rx,
        &cancel_token,
        connect_timeout,
        channel_capacity,
        adapter,
        metrics.clone(),
        &transport_name,
    )
    .await;

    // Drain queued messages and notify their error handlers.
    while let Ok(msg) = rx.try_recv() {
        msg.on_error("Connection closed");
    }

    // Drop the receiver so our sender half becomes disconnected, then remove
    // the stale entry. The predicate ensures we only remove our own entry.
    drop(rx);
    connections.remove_if(&instance_id, |_, h| h.tx.is_disconnected());
    if let Some(metrics) = metrics.as_ref() {
        metrics.set_active_connections(connections.len());
    }

    debug!("gRPC connection to {} ({}) closed", instance_id, addr);

    result
}

/// Inner loop: connect, open bidi stream, and send frames until the channel
/// closes or a send error occurs.
#[allow(clippy::too_many_arguments)]
async fn connection_writer_inner(
    addr: SocketAddr,
    instance_id: crate::InstanceId,
    rx: &flume::Receiver<SendTask>,
    cancel_token: &tokio_util::sync::CancellationToken,
    connect_timeout: Duration,
    channel_capacity: usize,
    adapter: Option<TransportAdapter>,
    metrics: Option<std::sync::Arc<dyn velo_ext::TransportObservability>>,
    transport_name: &str,
) -> Result<()> {
    debug!("gRPC connecting to {}", addr);

    let url = format!("http://{}", addr);
    let endpoint = tonic::transport::Endpoint::from_shared(url.clone())
        .context("invalid endpoint URL")?
        .connect_timeout(connect_timeout);
    let channel = tokio::select! {
        _ = cancel_token.cancelled() => return Ok(()),
        res = tokio::time::timeout(connect_timeout, endpoint.connect()) => {
            res.context("gRPC connect timeout")?.context("gRPC connect failed")?
        },
    };

    let mut client = VeloStreamingClient::new(channel);

    // Create mpsc channel to feed the outbound side of the bidi stream.
    let (mpsc_tx, mpsc_rx) = tokio::sync::mpsc::channel::<proto::FramedData>(channel_capacity);

    let response = client
        .stream(ReceiverStream::new(mpsc_rx))
        .await
        .context("failed to open gRPC bidi stream")?;
    let mut response_stream = response.into_inner();

    debug!("gRPC connected to {} ({})", instance_id, addr);

    // Spawn a reader task that consumes the response stream from the server.
    if let Some(adapter) = adapter {
        let metrics = metrics.clone();
        let transport_name = transport_name.to_string();
        #[cfg(not(feature = "distributed-tracing"))]
        let _ = &transport_name;
        tokio::spawn(async move {
            loop {
                match response_stream.message().await {
                    Ok(Some(framed_data)) => {
                        if let Ok(msg_type) =
                            TcpFrameCodec::parse_message_type_from_preamble(&framed_data.preamble)
                        {
                            let sender = match msg_type {
                                MessageType::ShuttingDown | MessageType::Response => {
                                    &adapter.response_stream
                                }
                                MessageType::Ack | MessageType::Event => &adapter.event_stream,
                                MessageType::Message => &adapter.message_stream,
                            };
                            if let Some(metrics) = metrics.as_ref() {
                                #[cfg(feature = "distributed-tracing")]
                                let span = tracing::debug_span!(
                                    "velo.transport.receive",
                                    transport = transport_name.as_str(),
                                    message_type = crate::transports::message_type_label(msg_type),
                                    bytes = framed_data.header.len() + framed_data.payload.len()
                                );
                                #[cfg(feature = "distributed-tracing")]
                                let _entered = span.enter();

                                metrics.record_frame(
                                    Direction::Inbound,
                                    crate::transports::message_type_label(msg_type),
                                    framed_data.header.len() + framed_data.payload.len(),
                                );
                            }
                            if sender
                                .send_async((
                                    Bytes::from(framed_data.header),
                                    Bytes::from(framed_data.payload),
                                ))
                                .await
                                .is_err()
                            {
                                if let Some(metrics) = metrics.as_ref() {
                                    metrics.record_rejection(TransportRejection::RouteFailed);
                                }
                                break;
                            }
                        } else if let Some(metrics) = metrics.as_ref() {
                            metrics.record_rejection(TransportRejection::DecodeError);
                        }
                    }
                    Ok(None) => break,
                    Err(e) => {
                        warn!("gRPC response stream error from {}: {}", instance_id, e);
                        break;
                    }
                }
            }
        });
    }

    // Main send loop: receive from flume, wrap in FramedData, send via mpsc.
    loop {
        let msg = tokio::select! {
            _ = cancel_token.cancelled() => break,
            res = rx.recv_async() => match res {
                Ok(msg) => msg,
                Err(_) => break,
            },
        };

        let preamble = match TcpFrameCodec::build_preamble(
            msg.msg_type,
            msg.header.len() as u32,
            msg.payload.len() as u32,
        ) {
            Ok(p) => p,
            Err(e) => {
                error!(
                    "Failed to build preamble for {} ({}): {}",
                    instance_id, addr, e
                );
                msg.on_error(format!("Failed to build preamble: {}", e));
                continue;
            }
        };

        let framed = proto::FramedData {
            preamble: preamble.to_vec(),
            header: msg.header.to_vec(),
            payload: msg.payload.to_vec(),
        };

        if mpsc_tx.send(framed).await.is_err() {
            error!(
                "gRPC send channel closed for {} ({}), reconnecting",
                instance_id, addr
            );
            msg.on_error("gRPC send channel closed");
            break;
        }
    }

    Ok(())
}

/// Parse a gRPC endpoint string into a `SocketAddr` (legacy format, used in tests).
#[cfg(test)]
fn parse_grpc_endpoint(endpoint: &[u8]) -> Result<SocketAddr> {
    use std::net::ToSocketAddrs;

    let endpoint_str = std::str::from_utf8(endpoint).context("endpoint is not valid UTF-8")?;

    let addr_str = endpoint_str.strip_prefix("grpc://").unwrap_or(endpoint_str);

    let mut addrs = addr_str
        .to_socket_addrs()
        .context("failed to parse socket address")?;

    addrs
        .next()
        .ok_or_else(|| anyhow::anyhow!("no addresses resolved"))
}

/// Builder for `GrpcTransport`.
pub struct GrpcTransportBuilder {
    bind_addr: Option<SocketAddr>,
    key: Option<TransportKey>,
    channel_capacity: usize,
    connect_timeout: Duration,
    listener: Option<std::net::TcpListener>,
    interface_filter: InterfaceFilter,
    numa_hint: Option<u32>,
}

impl GrpcTransportBuilder {
    /// Create a new builder with default settings.
    pub fn new() -> Self {
        Self {
            bind_addr: None,
            key: None,
            channel_capacity: 256,
            connect_timeout: Duration::from_secs(5),
            listener: None,
            interface_filter: InterfaceFilter::default(),
            numa_hint: None,
        }
    }

    /// Set the bind address for the gRPC server.
    pub fn bind_addr(mut self, addr: SocketAddr) -> Self {
        self.bind_addr = Some(addr);
        self
    }

    /// Set the transport key (default: `"grpc"`).
    pub fn key(mut self, key: TransportKey) -> Self {
        self.key = Some(key);
        self
    }

    /// Set the channel capacity for backpressure (default: 256).
    pub fn channel_capacity(mut self, capacity: usize) -> Self {
        self.channel_capacity = capacity;
        self
    }

    /// Set the connect timeout for outbound connections (default: 5s).
    pub fn connect_timeout(mut self, timeout: Duration) -> Self {
        self.connect_timeout = timeout;
        self
    }

    /// Set the interface selection filter for multi-NIC environments.
    pub fn interface_filter(mut self, filter: InterfaceFilter) -> Self {
        self.interface_filter = filter;
        self
    }

    /// Set the NUMA node hint for topology-aware NIC selection.
    ///
    /// Callers typically resolve this via `dynamo_memory::numa::get_device_numa_node(gpu_id)`.
    pub fn numa_hint(mut self, node: u32) -> Self {
        self.numa_hint = Some(node);
        self
    }

    /// Use a pre-bound TcpListener instead of binding to a specific address.
    ///
    /// This is useful for tests where you want to bind to port 0 and get an OS-assigned
    /// port without creating a race condition between binding and starting the transport.
    pub fn from_listener(mut self, listener: std::net::TcpListener) -> Result<Self> {
        if self.bind_addr.is_some() {
            anyhow::bail!(
                "Cannot use both bind_addr() and from_listener() - they are mutually exclusive"
            );
        }
        let addr = listener
            .local_addr()
            .context("Failed to get local address from listener")?;
        self.bind_addr = Some(addr);
        self.listener = Some(listener);
        Ok(self)
    }

    /// Build the `GrpcTransport`.
    pub fn build(self) -> Result<GrpcTransport> {
        let key = self.key.unwrap_or_else(|| TransportKey::from("grpc"));

        // If we have a listener, use its address; otherwise pre-bind to resolve port 0.
        let (bind_addr, listener) = if let Some(listener) = self.listener {
            let addr = listener.local_addr()?;
            (addr, Some(listener))
        } else {
            let requested = self
                .bind_addr
                .unwrap_or_else(|| "0.0.0.0:0".parse().unwrap());
            let std_listener = std::net::TcpListener::bind(requested)
                .context("Failed to pre-bind gRPC listener")?;
            let actual = std_listener.local_addr()?;
            (actual, Some(std_listener))
        };

        // Resolve advertise endpoints (multi-interface discovery)
        let endpoints = resolve_advertise_endpoints(bind_addr, &self.interface_filter)?;

        // Warn if NUMA hint conflicts with interface filter
        if let (Some(numa), InterfaceFilter::ByName(name)) =
            (self.numa_hint, &self.interface_filter)
        {
            for ep in &endpoints {
                if let Some(ep_numa) = ep.numa_node
                    && ep_numa != numa as i32
                {
                    warn!(
                        "NIC {} is on NUMA node {} but GPU NUMA hint is {}",
                        name, ep_numa, numa
                    );
                }
            }
        }

        let encoded =
            rmp_serde::to_vec(&endpoints).context("Failed to encode interface endpoints")?;
        let mut addr_builder = crate::transports::address::WorkerAddressBuilder::new();
        addr_builder.add_entry(key.clone(), encoded)?;
        let local_address = addr_builder.build()?;

        Ok(GrpcTransport {
            key,
            bind_addr,
            local_address,
            peers: Arc::new(DashMap::new()),
            connections: Arc::new(DashMap::new()),
            runtime: OnceLock::new(),
            cancel_token: tokio_util::sync::CancellationToken::new(),
            shutdown_state: OnceLock::new(),
            channel_capacity: self.channel_capacity,
            connect_timeout: self.connect_timeout,
            adapter: OnceLock::new(),
            listener: std::sync::Mutex::new(listener),
            local_interfaces: OnceLock::new(),
            numa_hint: self.numa_hint,
            metrics: OnceLock::new(),
        })
    }
}

impl Default for GrpcTransportBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::transports::address::WorkerAddressBuilder;
    use std::sync::atomic::{AtomicUsize, Ordering};
    use velo_ext::PeerInfo;

    struct TrackingErrorHandler {
        count: AtomicUsize,
    }

    impl TrackingErrorHandler {
        fn new() -> Self {
            Self {
                count: AtomicUsize::new(0),
            }
        }

        fn error_count(&self) -> usize {
            self.count.load(Ordering::SeqCst)
        }
    }

    impl TransportErrorHandler for TrackingErrorHandler {
        fn on_error(&self, _: Bytes, _: Bytes, _: String) {
            self.count.fetch_add(1, Ordering::SeqCst);
        }
    }

    fn make_grpc_peer(addr: SocketAddr) -> PeerInfo {
        let instance_id = crate::InstanceId::new_v4();
        let mut builder = WorkerAddressBuilder::new();
        builder
            .add_entry("grpc", format!("grpc://{}", addr).into_bytes())
            .unwrap();
        PeerInfo::new(instance_id, builder.build().unwrap())
    }

    #[test]
    fn test_parse_grpc_endpoint() {
        let addr = parse_grpc_endpoint(b"grpc://127.0.0.1:5555").unwrap();
        assert_eq!(addr.port(), 5555);

        let addr = parse_grpc_endpoint(b"127.0.0.1:6666").unwrap();
        assert_eq!(addr.port(), 6666);

        assert!(parse_grpc_endpoint(b"invalid").is_err());
    }

    #[test]
    fn test_builder_default_prebinds() {
        // Builder without explicit bind_addr should pre-bind to 0.0.0.0:0
        let result = GrpcTransportBuilder::new().build();
        assert!(result.is_ok());
    }

    #[test]
    fn test_builder_with_bind_addr() {
        let addr = "127.0.0.1:0".parse().unwrap();
        let result = GrpcTransportBuilder::new().bind_addr(addr).build();
        assert!(result.is_ok());
    }

    #[test]
    fn test_builder_custom_key() {
        let addr = "127.0.0.1:0".parse().unwrap();
        let transport = GrpcTransportBuilder::new()
            .bind_addr(addr)
            .key(TransportKey::from("my-grpc"))
            .build()
            .unwrap();
        assert_eq!(transport.key(), TransportKey::from("my-grpc"));
    }

    #[test]
    fn test_register_peer_legacy_format() {
        let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
        let transport = GrpcTransportBuilder::new()
            .from_listener(listener)
            .unwrap()
            .build()
            .unwrap();

        let peer_addr: SocketAddr = "127.0.0.1:9999".parse().unwrap();
        let peer = make_grpc_peer(peer_addr);
        let iid = peer.instance_id();

        transport.register(peer).unwrap();
        assert!(transport.peers.contains_key(&iid));
    }

    #[test]
    fn test_register_peer_no_endpoint() {
        let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
        let transport = GrpcTransportBuilder::new()
            .from_listener(listener)
            .unwrap()
            .build()
            .unwrap();

        // Create a peer with a "tcp" entry, not "grpc"
        let instance_id = crate::InstanceId::new_v4();
        let mut builder = WorkerAddressBuilder::new();
        builder
            .add_entry("tcp", b"tcp://127.0.0.1:1234".to_vec())
            .unwrap();
        let peer = PeerInfo::new(instance_id, builder.build().unwrap());

        let result = transport.register(peer);
        assert!(matches!(result, Err(TransportError::NoEndpoint)));
    }

    #[test]
    fn test_send_message_not_started() {
        let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
        let transport = GrpcTransportBuilder::new()
            .from_listener(listener)
            .unwrap()
            .build()
            .unwrap();

        let error_handler = Arc::new(TrackingErrorHandler::new());
        transport
            .send_message(
                crate::InstanceId::new_v4(),
                Bytes::from_static(b"header"),
                Bytes::from_static(b"payload"),
                MessageType::Message,
                error_handler.clone(),
            )
            .expect("send returns Ok and reports via on_error");

        assert_eq!(error_handler.error_count(), 1);
    }

    #[test]
    fn test_builder_multi_endpoint_format() {
        let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
        let addr = listener.local_addr().unwrap();
        let transport = GrpcTransportBuilder::new()
            .from_listener(listener)
            .unwrap()
            .build()
            .unwrap();

        // The address should contain msgpack-encoded endpoints
        let wa = transport.address();
        let raw = wa.get_entry("grpc").unwrap().unwrap();
        let endpoints: Vec<InterfaceEndpoint> = rmp_serde::from_slice(&raw).unwrap();
        assert!(!endpoints.is_empty());
        for ep in &endpoints {
            assert_eq!(ep.port, addr.port());
        }
    }
}