publisher.rs 96.6 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 std::fmt;
use std::sync::atomic::{AtomicU32, Ordering};
6
use std::sync::{Arc, OnceLock};
7
use std::time::Duration;
8

9
use anyhow::Result;
10
11
12
use rmp_serde as rmps;
use serde::Deserialize;
use serde::Serialize;
13
use serde::de::{self, Deserializer, IgnoredAny, MapAccess, SeqAccess, Visitor};
14
15
use tokio::sync::mpsc;
use tokio_util::sync::CancellationToken;
16
17
use zeromq::{Socket, SocketRecv, SubSocket};

18
use dynamo_runtime::metrics::{MetricsHierarchy, prometheus_names::kvstats};
19
20
21
use dynamo_runtime::traits::{
    DistributedRuntimeProvider, events::EventPublisher, events::EventSubscriber,
};
22
23
use dynamo_runtime::{
    component::{Component, Namespace},
24
    transports::nats::{NatsQueue, Slug},
25
};
26
use futures::StreamExt;
27
28

use crate::kv_router::{
29
30
31
    KV_EVENT_SUBJECT, KV_METRICS_SUBJECT, WORKER_KV_INDEXER_BUFFER_SIZE,
    WORKER_KV_INDEXER_QUERY_SUBJECT,
    indexer::{
32
33
        KvIndexerMetrics, LocalKvIndexer, RouterEvent, WorkerKvQueryRequest,
        compute_block_hash_for_seq,
34
    },
35
36
    protocols::*,
};
37
use dynamo_runtime::config::environment_names::nats as env_nats;
38

39
40
41
42
43
44
// Error handling configuration for ZMQ operations
const INITIAL_BACKOFF_MS: u64 = 10;
const MAX_BACKOFF_MS: u64 = 5000;
const MAX_CONSECUTIVE_ERRORS: u32 = 10;
const MAX_BACKOFF_EXPONENT: u32 = 8; // Cap at 2^8 = 256x multiplier to prevent overflow

45
46
47
48
// -------------------------------------------------------------------------
// KV Event Publishers -----------------------------------------------------
// -------------------------------------------------------------------------

49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/// Configure the source of KV events.
/// Currently, only ZMQ is supported.
pub enum KvEventSourceConfig {
    Zmq { endpoint: String, topic: String },
}

/// The source of KV events.
enum KvEventSource {
    Zmq {
        zmq_handle: tokio::task::JoinHandle<()>,
    },
}

impl KvEventSource {
    /// Start the event source from a [`KvEventSourceConfig`].
    fn start(
        component: Component,
66
        kv_block_size: u32,
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
        source_config: KvEventSourceConfig,
        cancellation_token: CancellationToken,
        tx: mpsc::UnboundedSender<KvCacheEvent>,
    ) -> Result<Self> {
        match source_config {
            KvEventSourceConfig::Zmq { endpoint, topic } => {
                let zmq_handle = component
                    .drt()
                    .runtime()
                    .secondary()
                    .spawn(start_zmq_listener(
                        endpoint,
                        topic,
                        tx,
                        cancellation_token.clone(),
                        kv_block_size,
                    ));

                Ok(KvEventSource::Zmq { zmq_handle })
            }
        }
    }

    fn shutdown(&self) {
        match self {
            KvEventSource::Zmq { zmq_handle } => {
                zmq_handle.abort();
            }
        }
    }
}

/// A publisher of KV events.
GuanLuo's avatar
GuanLuo committed
100
pub struct KvEventPublisher {
101
    /// The size of the KV block.
102
    kv_block_size: u32,
103
104
105
106
107
108
    /// The source of KV events.
    /// Can be `None` if all events provided through [`KvEventPublisher::publish`].
    source: Option<KvEventSource>,
    /// The cancellation token.
    cancellation_token: CancellationToken,
    /// The channel to send events to.
109
    tx: mpsc::UnboundedSender<KvCacheEvent>,
110
111
}

GuanLuo's avatar
GuanLuo committed
112
impl KvEventPublisher {
113
114
    pub fn new(
        component: Component,
115
        kv_block_size: u32,
116
        source_config: Option<KvEventSourceConfig>,
117
118
119
120
121
122
123
124
125
    ) -> Result<Self> {
        Self::new_with_local_indexer(component, kv_block_size, source_config, false)
    }

    pub fn new_with_local_indexer(
        component: Component,
        kv_block_size: u32,
        source_config: Option<KvEventSourceConfig>,
        enable_local_indexer: bool,
126
127
128
    ) -> Result<Self> {
        let cancellation_token = CancellationToken::new();

129
130
        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();

Yan Ru Pei's avatar
Yan Ru Pei committed
131
132
133
        // Infer worker_id from component's connection
        let worker_id = component.drt().connection_id();

134
        let component_name = component.name();
135
        tracing::info!(
136
            "Initializing KvEventPublisher for worker {worker_id} in component {component_name}"
137
138
139
140
        );

        if enable_local_indexer {
            tracing::info!(
141
                "LocalKvIndexer enabled for worker {worker_id} in component {component_name}"
142
143
144
            );
        }

145
146
147
148
149
150
151
152
153
154
155
156
        // Create our event source (if any)
        let mut source = None;
        if let Some(config) = source_config {
            source = Some(KvEventSource::start(
                component.clone(),
                kv_block_size,
                config,
                cancellation_token.clone(),
                tx.clone(),
            )?);
        }

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
        // Create local indexer if requested
        let local_indexer = if enable_local_indexer {
            let metrics = Arc::new(KvIndexerMetrics::new_unregistered());
            Some(Arc::new(LocalKvIndexer::new(
                cancellation_token.clone(),
                kv_block_size,
                metrics,
                WORKER_KV_INDEXER_BUFFER_SIZE,
            )))
        } else {
            None
        };

        // Spawn runtime for router->local indexer comm if requested
        let _local_indexer_query_handle = local_indexer.as_ref().map(|local_indexer_ref| {
            let component = component.clone();
            let local_indexer = local_indexer_ref.clone();

            component
                .drt()
                .runtime()
                .secondary()
                .spawn(start_worker_kv_query_service(
                    component,
                    worker_id,
                    local_indexer,
                    cancellation_token.clone(),
                ))
        });

187
188
        // Connect the NatsQueue before passing it to the event processor
        let cancellation_token_clone = cancellation_token.clone();
189
        let local_indexer_clone = local_indexer.clone();
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

        if enable_local_indexer {
            // When local indexer is enabled, use NATS Core (Component) for publishing.
            // This is simpler and doesn't require JetStream durability since recovery
            // is handled via the local indexer's event buffer.
            tracing::info!("Using NATS Core for KV event publishing (local_indexer mode)");
            let component_clone = component.clone();
            component.drt().runtime().secondary().spawn(async move {
                start_event_processor(
                    component_clone,
                    worker_id,
                    cancellation_token_clone,
                    rx,
                    local_indexer_clone,
                )
                .await
            });
        } else {
            // When local indexer is disabled, use JetStream (NatsQueue) for durability.
            let stream_name =
                Slug::slugify(&format!("{}.{}", component.subject(), KV_EVENT_SUBJECT))
                    .to_string()
                    .replace("_", "-");
            let nats_server = std::env::var(env_nats::NATS_SERVER)
                .unwrap_or_else(|_| "nats://localhost:4222".to_string());
            let mut nats_queue = NatsQueue::new_without_consumer(
                stream_name,
                nats_server,
                std::time::Duration::from_secs(60), // 1 minute timeout
            );

            component.drt().runtime().secondary().spawn(async move {
                if let Err(e) = nats_queue.connect().await {
                    tracing::error!("Failed to connect NatsQueue: {e}");
                    return;
                }
                start_event_processor(
                    nats_queue,
                    worker_id,
                    cancellation_token_clone,
                    rx,
                    local_indexer_clone,
                )
                .await
            });
        }
236
237
238
239
240
241
242

        Ok(Self {
            kv_block_size,
            source,
            cancellation_token,
            tx,
        })
243
244
245
246
247
    }

    pub fn publish(&self, event: KvCacheEvent) -> Result<(), mpsc::error::SendError<KvCacheEvent>> {
        self.tx.send(event)
    }
248

249
    pub fn kv_block_size(&self) -> u32 {
250
251
        self.kv_block_size
    }
252

253
254
255
    pub fn shutdown(&mut self) {
        if !self.cancellation_token.is_cancelled() {
            self.cancellation_token.cancel();
256
        }
257

258
259
        if let Some(source) = self.source.take() {
            source.shutdown();
260
261
        }
    }
262
}
263

264
265
266
impl Drop for KvEventPublisher {
    fn drop(&mut self) {
        self.shutdown();
267
268
269
    }
}

270
271
async fn start_event_processor<P: EventPublisher + Send + Sync + 'static>(
    publisher: P,
272
    worker_id: u64,
273
274
    cancellation_token: CancellationToken,
    mut rx: mpsc::UnboundedReceiver<KvCacheEvent>,
275
    local_indexer: Option<Arc<LocalKvIndexer>>,
276
277
278
279
) {
    loop {
        tokio::select! {
            _ = cancellation_token.cancelled() => {
280
                tracing::info!("KV Event source received cancellation signal");
281
282
                break;
            }
283
284
285
            event = rx.recv() => {
                let Some(event) = event else {
                    tracing::debug!("Event processor channel closed.");
286
287
288
                    break;
                };

289
                // Encapsulate in a router event.
Alec's avatar
Alec committed
290
                tracing::trace!("Event processor for worker_id {} processing event: {:?}", worker_id, event.data);
291
                let router_event = RouterEvent::new(worker_id, event);
292
293
294
295
296
297
298
299
300
301
302
303
304
305

                // Apply to local indexer first (if present)
                if let Some(indexer) = &local_indexer {
                    // Adds event into local indexer, and logs it into internal buffer
                    if let Err(e) = indexer.apply_event_with_buffer(router_event.clone()).await {
                        tracing::warn!(
                            "Failed to send event to local indexer for worker {}: {}",
                            worker_id,
                            e
                        );
                    }
                }

                // Then publish to NATS for global distribution
306
307
308
                // Use KV_EVENT_SUBJECT so both JetStream and NATS Core subscribers
                // can receive events on the expected subject.
                if let Err(e) = publisher.publish(KV_EVENT_SUBJECT, &router_event).await {
309
                    tracing::error!("Failed to publish event to NATS: {}", e);
310
                }
311

312
313
314
315
316
            }
        }
    }
}

317
318
319
320
321
322
323
324
325
326
327
328
// Processor for Router -> LocalKvIndexer query service
async fn start_worker_kv_query_service(
    component: Component,
    worker_id: u64,
    local_indexer: Arc<LocalKvIndexer>,
    cancellation_token: CancellationToken,
) {
    // Create NATS subscriber on a subject specific to worker's id
    let subject = format!("{}.{}", WORKER_KV_INDEXER_QUERY_SUBJECT, worker_id);
    let mut subscriber = match component.subscribe(&subject).await {
        Ok(sub) => sub,
        Err(e) => {
329
330
331
332
            tracing::error!(
                "Query service failed to subscribe for worker {worker_id} on subject {subject}: {e}"
            );
            return;
333
334
        }
    };
335
    tracing::info!("Query service listening on NATS for worker {worker_id} on subject {subject}");
336
337
338
339
340

    // Receive query request from router, retrieve event(s) from LocalKvIndexer, return response
    loop {
        tokio::select! {
            _ = cancellation_token.cancelled() => {
341
                tracing::info!("Query service received cancellation signal for worker {worker_id}");
342
343
344
345
346
                break;
            }

            msg = subscriber.next() => {
                let Some(msg) = msg else {
347
                    tracing::warn!("Query service NATS stream ended for worker {worker_id}");
348
349
350
351
352
353
354
                    break;
                };

                // deserialize from msg (async_nats::Message)
                let request: WorkerKvQueryRequest = match serde_json::from_slice(&msg.payload) {
                    Ok(request) => request,
                    Err(e) => {
355
                        tracing::error!("Failed to deserialize WorkerKvQueryRequest for worker {worker_id}: {e}");
356
357
358
359
                        continue;
                    }
                };

360
                tracing::debug!("Received query request for worker {worker_id}: {request:?}");
361

362
363
364
365
                // Query events based on optional start/end ids
                let response = local_indexer
                    .get_events_in_id_range(request.start_event_id, request.end_event_id)
                    .await;
366
367
368
369
370
371

                // Send reply back (if reply subject exists)
                if let Some(reply_subject) = msg.reply {
                    let payload = match serde_json::to_vec(&response) {
                        Ok(p) => p,
                        Err(e) => {
372
                            tracing::error!("Failed to serialize response for worker {worker_id}: {e}");
373
374
375
376
377
378
379
380
381
382
                            continue;
                        }
                    };

                    // Publish through DRT/NATS directly instead of namespace (adds a prefix)
                    if let Err(e) = component
                        .drt()
                        .kv_router_nats_publish(reply_subject.to_string(), payload.into())
                        .await
                    {
383
                        tracing::error!("Failed to send reply for worker {worker_id}: {e}");
384
385
386
387
388
389
390
                    }
                }
            }
        }
    }
}

391
392
393
394
395
396
397
398
/// Calculate exponential backoff duration based on consecutive error count
fn calculate_backoff_ms(consecutive_errors: u32) -> u64 {
    std::cmp::min(
        INITIAL_BACKOFF_MS * 2_u64.pow(consecutive_errors.min(MAX_BACKOFF_EXPONENT)),
        MAX_BACKOFF_MS,
    )
}

Yan Ru Pei's avatar
Yan Ru Pei committed
399
pub async fn start_zmq_listener(
400
401
    zmq_endpoint: String,
    zmq_topic: String,
402
403
    tx: mpsc::UnboundedSender<KvCacheEvent>,
    cancellation_token: CancellationToken,
404
    kv_block_size: u32,
405
406
407
408
409
410
411
) {
    tracing::debug!(
        "KVEventPublisher connecting to ZMQ endpoint {} (topic '{}')",
        zmq_endpoint,
        zmq_topic
    );

412
413
    let warning_count = Arc::new(AtomicU32::new(0));

414
415
416
417
418
419
420
421
422
423
424
425
426
427
    let mut socket = SubSocket::new();

    // Subscribe to the requested topic (empty string == all topics)
    if let Err(e) = socket.subscribe(&zmq_topic).await {
        tracing::error!("Failed to subscribe on ZMQ socket: {}", e);
        return;
    }

    if let Err(e) = socket.connect(&zmq_endpoint).await {
        tracing::error!("Failed to connect ZMQ SUB socket: {}", e);
        return;
    }

    let mut consecutive_errors = 0u32;
Alec's avatar
Alec committed
428
429
430
    #[allow(unused_assignments)]
    let mut exit_reason = "unknown";
    let mut messages_processed = 0u64;
431

Alec's avatar
Alec committed
432
    'main: loop {
433
434
435
436
        tokio::select! {
            biased;

            // Check for cancellation
437
            _ = cancellation_token.cancelled() => {
Alec's avatar
Alec committed
438
439
440
                tracing::debug!("ZMQ listener received cancellation signal");
                exit_reason = "cancellation token cancelled";
                break 'main;
441
442
443
444
445
446
447
448
449
450
451
452
453
454
            }

            // Receive message
            msg_result = socket.recv() => {
                let Ok(msg) = msg_result else {
                    let e = msg_result.unwrap_err();
                    consecutive_errors += 1;

                    if consecutive_errors >= MAX_CONSECUTIVE_ERRORS {
                        tracing::error!(
                            error=%e,
                            consecutive_errors=%consecutive_errors,
                            "Too many consecutive ZMQ errors, terminating listener"
                        );
Alec's avatar
Alec committed
455
456
                        exit_reason = "too many consecutive errors";
                        break 'main;
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
                    }

                    // Simple exponential backoff with max exponent to prevent overflow
                    let backoff_ms = calculate_backoff_ms(consecutive_errors);

                    tracing::warn!(
                        error=%e,
                        consecutive_errors=%consecutive_errors,
                        backoff_ms=%backoff_ms,
                        "Error reading from ZMQ socket, applying exponential backoff"
                    );

                    tokio::time::sleep(Duration::from_millis(backoff_ms)).await;
                    continue;
                };
                // Reset error count on successful message
                consecutive_errors = 0;

                // We expect multipart frames: [topic, seq, payload]
                let mut frames: Vec<Vec<u8>> = msg.into_vec().into_iter().map(|frame| frame.to_vec()).collect();

                if frames.len() != 3 {
479
                    tracing::warn!("Received unexpected ZMQ frame count: expected 3, actual {}", frames.len());
480
481
                    continue;
                }
482
483
484
485

                // Extract the payload and sequence number.
                let payload = frames.pop().unwrap();
                let seq_bytes = frames.pop().unwrap();
486
487

                if seq_bytes.len() != 8 {
488
                    tracing::warn!("Invalid sequence number byte length: expected 8, actual {}", seq_bytes.len());
489
490
491
492
                    continue;
                }

                let seq = u64::from_be_bytes(seq_bytes.try_into().unwrap());
493
494
495
496
497

                // Decode our batch of events.
                let batch_result = rmps::from_slice::<KvEventBatch>(&payload);
                let Ok(batch) = batch_result else {
                    let e = batch_result.unwrap_err();
498
                    tracing::warn!("Failed to decode KVEventBatch msgpack: {e}");
499
500
501
                    continue;
                };

Alec's avatar
Alec committed
502
                tracing::trace!(
Yan Ru Pei's avatar
Yan Ru Pei committed
503
                    "ZMQ listener on {} received batch with {} events (seq={}, dp_rank={})",
Alec's avatar
Alec committed
504
505
                    zmq_endpoint,
                    batch.events.len(),
Yan Ru Pei's avatar
Yan Ru Pei committed
506
                    seq,
507
                    batch.data_parallel_rank.unwrap_or(0)
Alec's avatar
Alec committed
508
                );
Yan Ru Pei's avatar
Yan Ru Pei committed
509

510
                let dp_rank = batch.data_parallel_rank.unwrap_or(0) as u32;
511
                for raw_event in batch.events.into_iter() {
Yan Ru Pei's avatar
Yan Ru Pei committed
512
                    let event = convert_event(raw_event, seq, kv_block_size, dp_rank, &warning_count);
513
514
                    if tx.send(event).is_err() {
                        tracing::warn!("Failed to send message to channel - receiver dropped");
Alec's avatar
Alec committed
515
516
                        exit_reason = "channel receiver dropped";
                        break 'main;
517
                    }
Alec's avatar
Alec committed
518
                    messages_processed += 1;
519
520
521
522
                }
            }
        }
    }
Alec's avatar
Alec committed
523
524
525
526
527
    tracing::debug!(
        "ZMQ listener exiting, reason: {}, messages processed: {}",
        exit_reason,
        messages_processed
    );
528
529
530
}

/// Convert a raw event coming from the ZMQ channel into the internal
531
/// [`KvCacheEvent`] representation used by the router.
532
533
534
fn convert_event(
    raw: RawKvEvent,
    event_id: u64,
535
    kv_block_size: u32,
Yan Ru Pei's avatar
Yan Ru Pei committed
536
    dp_rank: u32,
537
    warning_count: &Arc<AtomicU32>,
538
) -> KvCacheEvent {
539
540
541
542
543
544
545
    match raw {
        RawKvEvent::BlockStored {
            block_hashes,
            parent_block_hash,
            token_ids,
            block_size,
            lora_id,
546
            block_mm_infos,
547
            ..
548
549
        } => {
            let num_block_tokens = vec![block_size as u64; block_hashes.len()];
550
551
552
553
            let block_hashes_u64: Vec<u64> = block_hashes
                .into_iter()
                .map(BlockHashValue::into_u64)
                .collect();
554
            KvCacheEvent {
555
556
                event_id,
                data: KvCacheEventData::Stored(KvCacheStoreData {
557
558
559
                    parent_hash: parent_block_hash
                        .map(BlockHashValue::into_u64)
                        .map(ExternalSequenceBlockHash::from),
560
561
562
563
                    blocks: create_stored_blocks(
                        kv_block_size,
                        &token_ids,
                        &num_block_tokens,
564
                        &block_hashes_u64,
565
566
                        lora_id.unwrap_or(0),
                        warning_count,
567
                        block_mm_infos.as_deref(),
568
569
                    ),
                }),
Yan Ru Pei's avatar
Yan Ru Pei committed
570
                dp_rank,
571
            }
572
        }
573
        RawKvEvent::BlockRemoved { block_hashes, .. } => {
574
575
            let hashes = block_hashes
                .into_iter()
576
                .map(BlockHashValue::into_u64)
577
578
                .map(ExternalSequenceBlockHash::from)
                .collect();
579
            KvCacheEvent {
580
581
582
583
                event_id,
                data: KvCacheEventData::Removed(KvCacheRemoveData {
                    block_hashes: hashes,
                }),
Yan Ru Pei's avatar
Yan Ru Pei committed
584
                dp_rank,
585
            }
586
        }
587
588
589
        RawKvEvent::AllBlocksCleared => KvCacheEvent {
            event_id,
            data: KvCacheEventData::Cleared,
Yan Ru Pei's avatar
Yan Ru Pei committed
590
            dp_rank,
591
        },
592
593
594
595
    }
}

pub fn create_stored_block_from_parts(
596
    kv_block_size: u32,
597
    block_hash: u64,
598
599
    token_ids: &[u32],
    _lora_id: u64,
600
    mm_extra_info: Option<BlockExtraInfo>,
601
) -> KvCacheStoredBlockData {
602
603
604
605
606
    // Compute tokens_hash including MM info if present
    let block_mm_infos = mm_extra_info.as_ref().map(|info| vec![Some(info.clone())]);
    let tokens_hash =
        compute_block_hash_for_seq(token_ids, kv_block_size, block_mm_infos.as_deref())[0];

607
    tracing::trace!(
608
        "Creating stored block: external_block_hash={}, tokens_hash={}, token_ids={:?}, kv_block_size={}, mm_extra_info={:?}",
609
610
611
        block_hash,
        tokens_hash.0,
        token_ids,
612
613
        kv_block_size,
        mm_extra_info
614
    );
615
616
617
    KvCacheStoredBlockData {
        block_hash: ExternalSequenceBlockHash::from(block_hash),
        tokens_hash,
618
        mm_extra_info,
619
620
621
622
    }
}

pub fn create_stored_blocks(
623
    kv_block_size: u32,
624
625
    token_ids: &[u32],
    num_block_tokens: &[u64],
626
    block_hashes: &[u64],
627
628
    lora_id: u64,
    warning_count: &Arc<AtomicU32>,
629
    block_mm_infos: Option<&[Option<BlockExtraInfo>]>,
630
631
632
633
) -> Vec<KvCacheStoredBlockData> {
    let mut blocks: Vec<KvCacheStoredBlockData> = Vec::new();

    let mut token_offset: usize = 0;
634
635
636
    for (block_idx, (num_tokens_it, block_hash_it)) in
        num_block_tokens.iter().zip(block_hashes.iter()).enumerate()
    {
637
638
639
640
641
642
643
644
645
646
647
648
        if *num_tokens_it != kv_block_size as u64 {
            if warning_count.fetch_add(1, Ordering::Relaxed) < 3 {
                tracing::warn!(
                    "Block not published. Block size must be {} tokens to be published. Block size is: {}",
                    kv_block_size,
                    *num_tokens_it
                );
            }
            break;
        }

        let tokens = &token_ids[token_offset..(token_offset + *num_tokens_it as usize)];
649
650
651
652
        let mm_extra_info = block_mm_infos
            .and_then(|infos| infos.get(block_idx))
            .and_then(|opt| opt.clone());

653
654
655
656
657
        blocks.push(create_stored_block_from_parts(
            kv_block_size,
            *block_hash_it,
            tokens,
            lora_id,
658
            mm_extra_info,
659
660
661
662
663
664
665
666
667
668
669
        ));
        token_offset += *num_tokens_it as usize;
    }

    blocks
}

// -------------------------------------------------------------------------
// Types mirroring the Python msgspec-defined structures -------------------
// -------------------------------------------------------------------------

670
#[derive(Debug, Serialize)]
671
672
673
struct KvEventBatch {
    ts: f64,
    events: Vec<RawKvEvent>,
Alec's avatar
Alec committed
674
    #[serde(alias = "dp_rank")]
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
    data_parallel_rank: Option<i32>,
}

impl<'de> Deserialize<'de> for KvEventBatch {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        // Deserialize from array format: [timestamp, [events], data_parallel_rank]
        let arr: (f64, Vec<RawKvEvent>, Option<i32>) = Deserialize::deserialize(deserializer)?;
        Ok(KvEventBatch {
            ts: arr.0,
            events: arr.1,
            data_parallel_rank: arr.2,
        })
    }
691
692
}

693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
#[serde(untagged)]
enum BlockHashValue {
    Signed(i64),
    Unsigned(u64),
}

impl BlockHashValue {
    fn into_u64(self) -> u64 {
        match self {
            BlockHashValue::Signed(v) => v as u64,
            BlockHashValue::Unsigned(v) => v,
        }
    }
}

709
#[derive(Debug, Serialize, Clone)]
710
711
712
#[serde(tag = "type")] // msgspec encodes variant tag as a string when `tag=True`
enum RawKvEvent {
    BlockStored {
713
714
715
716
        /// Block hashes may be emitted as either signed or unsigned 64-bit values.
        /// We normalize them to `u64` while deserializing to support both producers.
        block_hashes: Vec<BlockHashValue>,
        parent_block_hash: Option<BlockHashValue>,
717
718
719
        token_ids: Vec<u32>,
        block_size: usize,
        lora_id: Option<u64>,
720
721
        #[serde(skip_serializing_if = "Option::is_none")]
        medium: Option<String>,
722
723
724
        /// Multimodal extra info for each block (length should match block_hashes)
        #[serde(default, skip_serializing_if = "Option::is_none")]
        block_mm_infos: Option<Vec<Option<BlockExtraInfo>>>,
725
726
    },
    BlockRemoved {
727
728
729
        block_hashes: Vec<BlockHashValue>,
        #[serde(skip_serializing_if = "Option::is_none")]
        medium: Option<String>,
730
731
732
733
    },
    AllBlocksCleared,
}

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
/// Our producers use msgspec with `tag=True` and `array_like=True`, which
/// encodes each event as either a tagged map or a tagged tuple. To be tolerant of
/// additional fields that may be appended in the future, we implement a custom
/// deserializer that ignores unknown keys and any extra positional elements.
///
/// This keeps us compatible with older payloads while safely
/// accepting newer ones that include extra metadata.
impl<'de> Deserialize<'de> for RawKvEvent {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_any(RawKvEventVisitor)
    }
}

struct RawKvEventVisitor;

impl<'de> Visitor<'de> for RawKvEventVisitor {
    type Value = RawKvEvent;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("a kv event encoded as a tagged map or sequence")
    }

    fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
    where
        A: MapAccess<'de>,
    {
        let mut event_type: Option<String> = None;
        let mut block_hashes: Option<Vec<BlockHashValue>> = None;
        let mut parent_block_hash: Option<Option<BlockHashValue>> = None;
        let mut token_ids: Option<Vec<u32>> = None;
        let mut block_size: Option<usize> = None;
        let mut lora_id: Option<Option<u64>> = None;
        let mut medium: Option<Option<String>> = None;
770
        let mut block_mm_infos: Option<Option<Vec<Option<BlockExtraInfo>>>> = None;
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794

        while let Some(key) = map.next_key::<String>()? {
            match key.as_str() {
                "type" => {
                    event_type = Some(map.next_value()?);
                }
                "block_hashes" => {
                    block_hashes = Some(map.next_value()?);
                }
                "parent_block_hash" => {
                    parent_block_hash = Some(map.next_value()?);
                }
                "token_ids" => {
                    token_ids = Some(map.next_value()?);
                }
                "block_size" => {
                    block_size = Some(map.next_value()?);
                }
                "lora_id" => {
                    lora_id = Some(map.next_value()?);
                }
                "medium" => {
                    medium = Some(map.next_value()?);
                }
795
796
797
                "block_mm_infos" => {
                    block_mm_infos = Some(map.next_value()?);
                }
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
                _ => {
                    map.next_value::<IgnoredAny>()?;
                }
            }
        }

        match event_type.as_deref() {
            Some("BlockStored") => {
                let block_hashes =
                    block_hashes.ok_or_else(|| de::Error::missing_field("block_hashes"))?;
                let token_ids = token_ids.ok_or_else(|| de::Error::missing_field("token_ids"))?;
                let block_size =
                    block_size.ok_or_else(|| de::Error::missing_field("block_size"))?;
                Ok(RawKvEvent::BlockStored {
                    block_hashes,
                    parent_block_hash: parent_block_hash.unwrap_or(None),
                    token_ids,
                    block_size,
                    lora_id: lora_id.unwrap_or(None),
                    medium: medium.unwrap_or(None),
818
                    block_mm_infos: block_mm_infos.unwrap_or(None),
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
                })
            }
            Some("BlockRemoved") => {
                let block_hashes =
                    block_hashes.ok_or_else(|| de::Error::missing_field("block_hashes"))?;
                Ok(RawKvEvent::BlockRemoved {
                    block_hashes,
                    medium: medium.unwrap_or(None),
                })
            }
            Some("AllBlocksCleared") => Ok(RawKvEvent::AllBlocksCleared),
            Some(other) => Err(de::Error::unknown_variant(
                other,
                &["BlockStored", "BlockRemoved", "AllBlocksCleared"],
            )),
            None => Err(de::Error::missing_field("type")),
        }
    }

    fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
    where
        A: SeqAccess<'de>,
    {
        let tag: Option<String> = seq.next_element()?;
        let Some(tag) = tag else {
            return Err(de::Error::invalid_length(
                0,
                &"sequence must start with event tag",
            ));
        };

        match tag.as_str() {
            "BlockStored" => {
                let block_hashes: Vec<BlockHashValue> = seq
                    .next_element()?
                    .ok_or_else(|| de::Error::invalid_length(1, &"missing block_hashes"))?;
                let parent_block_hash: Option<BlockHashValue> = seq.next_element()?.unwrap_or(None);
                let token_ids: Vec<u32> = seq
                    .next_element()?
                    .ok_or_else(|| de::Error::invalid_length(3, &"missing token_ids"))?;
                let block_size: usize = seq
                    .next_element()?
                    .ok_or_else(|| de::Error::invalid_length(4, &"missing block_size"))?;
                let lora_id: Option<u64> = seq.next_element()?.unwrap_or(None);
                let medium: Option<String> = seq.next_element()?.unwrap_or(None);
864
865
                let block_mm_infos: Option<Vec<Option<BlockExtraInfo>>> =
                    seq.next_element()?.unwrap_or(None);
866
867
868
869
870
871
872
873
874
875

                while seq.next_element::<IgnoredAny>()?.is_some() {}

                Ok(RawKvEvent::BlockStored {
                    block_hashes,
                    parent_block_hash,
                    token_ids,
                    block_size,
                    lora_id,
                    medium,
876
                    block_mm_infos,
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
                })
            }
            "BlockRemoved" => {
                let block_hashes: Vec<BlockHashValue> = seq
                    .next_element()?
                    .ok_or_else(|| de::Error::invalid_length(1, &"missing block_hashes"))?;
                let medium: Option<String> = seq.next_element()?.unwrap_or(None);

                while seq.next_element::<IgnoredAny>()?.is_some() {}

                Ok(RawKvEvent::BlockRemoved {
                    block_hashes,
                    medium,
                })
            }
            "AllBlocksCleared" => {
                while seq.next_element::<IgnoredAny>()?.is_some() {}
                Ok(RawKvEvent::AllBlocksCleared)
            }
            other => Err(de::Error::unknown_variant(
                other,
                &["BlockStored", "BlockRemoved", "AllBlocksCleared"],
            )),
        }
    }
}

904
905
906
907
// -------------------------------------------------------------------------
// Metrics Publishers ------------------------------------------------------
// -------------------------------------------------------------------------

908
pub struct WorkerMetricsPublisher {
GuanLuo's avatar
GuanLuo committed
909
910
    tx: tokio::sync::watch::Sender<Arc<ForwardPassMetrics>>,
    rx: tokio::sync::watch::Receiver<Arc<ForwardPassMetrics>>,
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
    /// Prometheus gauges for KvStats metrics
    /// We use OnceLock for efficient one-time initialization and lock-free reads
    /// The gauges are set once during register_prometheus_metrics and then only read
    prometheus_gauges: OnceLock<KvStatsPrometheusGauges>,
}

struct KvStatsPrometheusGauges {
    kv_active_blocks_gauge: prometheus::Gauge,
    kv_total_blocks_gauge: prometheus::Gauge,
    gpu_cache_usage_gauge: prometheus::Gauge,
    gpu_prefix_cache_hit_rate_gauge: prometheus::Gauge,
}

impl KvStatsPrometheusGauges {
    /// Create a new KvStatsPrometheusGauges instance with all metrics registered
    fn new(component: &Component) -> Result<Self> {
927
        let kv_active_blocks_gauge = component.metrics().create_gauge(
928
929
930
931
932
            kvstats::ACTIVE_BLOCKS,
            "Number of active KV cache blocks currently in use",
            &[],
        )?;

933
        let kv_total_blocks_gauge = component.metrics().create_gauge(
934
935
936
937
938
            kvstats::TOTAL_BLOCKS,
            "Total number of KV cache blocks available",
            &[],
        )?;

939
        let gpu_cache_usage_gauge = component.metrics().create_gauge(
940
941
942
943
944
            kvstats::GPU_CACHE_USAGE_PERCENT,
            "GPU cache usage as a percentage (0.0-1.0)",
            &[],
        )?;

945
        let gpu_prefix_cache_hit_rate_gauge = component.metrics().create_gauge(
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
            kvstats::GPU_PREFIX_CACHE_HIT_RATE,
            "GPU prefix cache hit rate as a percentage (0.0-1.0)",
            &[],
        )?;

        tracing::info!("Registered KvStats Prometheus metrics");

        Ok(KvStatsPrometheusGauges {
            kv_active_blocks_gauge,
            kv_total_blocks_gauge,
            gpu_cache_usage_gauge,
            gpu_prefix_cache_hit_rate_gauge,
        })
    }

    /// Update all gauges with values from KvStats
    fn update_from_kvstats(&self, kv_stats: &KvStats) {
        self.kv_active_blocks_gauge
            .set(kv_stats.kv_active_blocks as f64);
        self.kv_total_blocks_gauge
            .set(kv_stats.kv_total_blocks as f64);
        self.gpu_cache_usage_gauge
            .set(kv_stats.gpu_cache_usage_perc as f64);
        self.gpu_prefix_cache_hit_rate_gauge
            .set(kv_stats.gpu_prefix_cache_hit_rate as f64);
    }
GuanLuo's avatar
GuanLuo committed
972
973
}

974
impl WorkerMetricsPublisher {
GuanLuo's avatar
GuanLuo committed
975
976
    pub fn new() -> Result<Self> {
        let (tx, rx) = tokio::sync::watch::channel(Arc::new(ForwardPassMetrics::default()));
977
978
979
980
981
        Ok(WorkerMetricsPublisher {
            tx,
            rx,
            prometheus_gauges: OnceLock::new(),
        })
GuanLuo's avatar
GuanLuo committed
982
983
984
985
986
987
    }

    pub fn publish(
        &self,
        metrics: Arc<ForwardPassMetrics>,
    ) -> Result<(), tokio::sync::watch::error::SendError<Arc<ForwardPassMetrics>>> {
988
        tracing::trace!("Publish metrics: {metrics:?}");
989
990
991
992
993
994
995

        // Update Prometheus gauges - OnceLock provides lock-free reads after initialization
        // This is the hot path - we only read the Arc, no locking overhead
        if let Some(gauges) = self.prometheus_gauges.get() {
            gauges.update_from_kvstats(&metrics.kv_stats);
        }

GuanLuo's avatar
GuanLuo committed
996
997
998
        self.tx.send(metrics)
    }

999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
    /// Register KvStats Prometheus metrics with the component's registry
    pub fn register_prometheus_metrics(&self, component: &Component) -> Result<()> {
        // Use get_or_init for thread-safe one-time initialization
        // This will only initialize once, subsequent calls will return immediately
        self.prometheus_gauges.get_or_init(|| {
            KvStatsPrometheusGauges::new(component).expect("Failed to create Prometheus gauges")
        });

        Ok(())
    }

1010
    pub async fn create_endpoint(&self, component: Component) -> Result<()> {
1011
        let worker_id = component.drt().connection_id();
1012
        self.start_nats_metrics_publishing(component.namespace().clone(), worker_id);
1013
        Ok(())
1014
    }
1015
1016
1017
1018
1019

    /// Starts a background task to publish metrics over NATS
    ///
    /// This task monitors metric changes (specifically kv_active_blocks and num_requests_waiting)
    /// and publishes stable metrics to NATS after they've been unchanged for 1ms.
1020
    fn start_nats_metrics_publishing(&self, namespace: Namespace, worker_id: u64) {
1021
1022
1023
1024
        let nats_rx = self.rx.clone();

        tokio::spawn(async move {
            let mut rx = nats_rx;
1025
1026
            let mut last_kv_active_blocks: Option<u64> = Some(0);
            let mut last_num_requests_waiting: Option<u64> = Some(0);
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
            let mut pending_publish: Option<Arc<ForwardPassMetrics>> = None;
            let mut publish_timer =
                Box::pin(tokio::time::sleep(tokio::time::Duration::from_secs(0)));
            publish_timer.as_mut().reset(tokio::time::Instant::now()); // Complete immediately

            loop {
                tokio::select! {
                    // Handle metrics changes
                    result = rx.changed() => {
                        if result.is_err() {
                            tracing::debug!(
                                "Metrics publisher sender dropped, stopping NATS background task"
                            );
                            break;
                        }

                        let metrics = rx.borrow_and_update().clone();

                        // Extract the values we care about
                        let current_kv_active_blocks = metrics.kv_stats.kv_active_blocks;
                        let current_num_requests_waiting =
                            metrics.worker_stats.num_requests_waiting;

                        // Check if these specific metrics have changed
                        let has_changed = match (last_kv_active_blocks, last_num_requests_waiting) {
                            (Some(last_kv), Some(last_requests)) => {
                                last_kv != current_kv_active_blocks
                                    || last_requests != current_num_requests_waiting
                            }
                            _ => true, // First time, consider it changed
                        };

                        // If load metrics changed, schedule a publish
                        if has_changed {
                            pending_publish = Some(metrics.clone());
                            last_kv_active_blocks = Some(current_kv_active_blocks);
                            last_num_requests_waiting = Some(current_num_requests_waiting);

                            // Start the 1ms timer
                            publish_timer.as_mut().reset(
                                tokio::time::Instant::now() + tokio::time::Duration::from_millis(1)
                            );
                        }
                    }
                    // Timer expired - publish if we have pending metrics
                    _ = &mut publish_timer => {
                        if let Some(metrics) = pending_publish.take() {
1074
1075
                            // Create ActiveLoad with only active_decode_blocks (worker doesn't know prefill tokens)
                            let active_load = ActiveLoad {
1076
                                worker_id,
1077
1078
1079
                                dp_rank: metrics.worker_stats.data_parallel_rank.unwrap_or(0),
                                active_decode_blocks: Some(metrics.kv_stats.kv_active_blocks),
                                active_prefill_tokens: None,
1080
1081
1082
                            };

                            if let Err(e) =
1083
                                namespace.publish(KV_METRICS_SUBJECT, &active_load).await
1084
1085
1086
1087
                            {
                                tracing::warn!("Failed to publish metrics over NATS: {}", e);
                            }
                        }
1088
1089
1090
1091
1092
1093

                        // Reset timer to pending state to avoid tight loop
                        // It will be reset to 1ms when metrics actually change
                        publish_timer.as_mut().reset(
                            tokio::time::Instant::now() + tokio::time::Duration::from_secs(3600)
                        );
1094
1095
1096
1097
1098
                    }
                }
            }
        });
    }
1099
1100
}

1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
// -------------------------------------------------------------------------
// Testing -----------------------------------------------------------------
// -------------------------------------------------------------------------

#[cfg(test)]
mod test_event_processing {
    use super::*;
    use crate::kv_router::indexer::compute_block_hash_for_seq;

    // ---------------------------------------------------------------------
    // create_stored_block_from_parts --------------------------------------
    // ---------------------------------------------------------------------
    #[test]
    fn test_create_stored_block_from_parts() {
        let kv_block_size = 4;
        let token_ids = vec![10, 20, 30, 40];
        let blk_hash = 0xdead_beef;

1119
        let stored = create_stored_block_from_parts(kv_block_size, blk_hash, &token_ids, 0, None);
1120

1121
        assert_eq!(stored.block_hash.0, blk_hash);
1122
        let expected_hash = compute_block_hash_for_seq(&token_ids, 4, None)[0];
1123
        assert_eq!(stored.tokens_hash, expected_hash);
1124
        assert!(stored.mm_extra_info.is_none());
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
    }

    // ---------------------------------------------------------------------
    // create_stored_blocks -------------------------------------------------
    // ---------------------------------------------------------------------
    #[test]
    fn test_create_stored_blocks_ok() {
        let kv_block_size = 4;
        // two blocks, each of size 4
        let token_ids = vec![1, 2, 3, 4, 5, 6, 7, 8];
        let num_block_tokens = vec![4_u64, 4_u64];
1136
        let block_hashes = vec![111_u64, 222_u64];
1137
1138
1139
1140
1141
1142
1143
1144

        let blocks = create_stored_blocks(
            kv_block_size,
            &token_ids,
            &num_block_tokens,
            &block_hashes,
            /*lora_id=*/ 0,
            &Arc::new(AtomicU32::new(0)),
1145
            None,
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
        );

        assert_eq!(blocks.len(), 2);
        assert_eq!(blocks[0].block_hash.0, 111);
        assert_eq!(blocks[1].block_hash.0, 222);
    }

    #[test]
    fn test_create_stored_blocks_wrong_size_triggers_warning() {
        let kv_block_size = 4;
        // second block is the wrong size
        let token_ids = vec![1, 2, 3, 4, 5, 6, 7];
        let num_block_tokens = vec![4_u64, 3_u64];
1159
        let block_hashes = vec![111_u64, 222_u64];
1160
1161
1162
1163
1164
1165
1166
1167
1168
        let warning_count = Arc::new(AtomicU32::new(0));

        let blocks = create_stored_blocks(
            kv_block_size,
            &token_ids,
            &num_block_tokens,
            &block_hashes,
            /*lora_id=*/ 0,
            &warning_count,
1169
            None,
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
        );

        // should early-exit as second has mismatch
        assert!(blocks.len() == 1);
        assert!(warning_count.load(Ordering::Relaxed) == 1)
    }

    // ---------------------------------------------------------------------
    // convert_event --------------------------------------------------------
    // ---------------------------------------------------------------------
    #[test]
    fn test_convert_event_block_stored() {
        let kv_block_size = 4;
        let raw_evt = RawKvEvent::BlockStored {
1184
1185
            block_hashes: vec![BlockHashValue::Unsigned(10), BlockHashValue::Unsigned(11)],
            parent_block_hash: Some(BlockHashValue::Unsigned(99)),
1186
1187
1188
            token_ids: vec![1, 2, 3, 4, 5, 6, 7, 8],
            block_size: 4,
            lora_id: Some(0),
1189
            medium: None,
1190
            block_mm_infos: None,
1191
1192
        };

Yan Ru Pei's avatar
Yan Ru Pei committed
1193
        let out = convert_event(raw_evt, 42, kv_block_size, 0, &Arc::new(AtomicU32::new(0)));
1194
        assert!(matches!(out.data, KvCacheEventData::Stored(_)));
1195
1196
1197
1198
1199
1200
    }

    #[test]
    fn test_convert_event_block_removed() {
        let kv_block_size = 4;
        let raw_evt = RawKvEvent::BlockRemoved {
1201
1202
            block_hashes: vec![BlockHashValue::Unsigned(123), BlockHashValue::Signed(456)],
            medium: None,
1203
        };
Yan Ru Pei's avatar
Yan Ru Pei committed
1204
        let out = convert_event(raw_evt, 7, kv_block_size, 0, &Arc::new(AtomicU32::new(0)));
1205

1206
        assert!(matches!(out.data, KvCacheEventData::Removed(_)));
1207
1208
1209
1210
1211
1212
    }

    #[test]
    fn test_convert_event_all_blocks_cleared() {
        let kv_block_size = 4;
        let raw_evt = RawKvEvent::AllBlocksCleared;
Yan Ru Pei's avatar
Yan Ru Pei committed
1213
        let out = convert_event(raw_evt, 1, kv_block_size, 0, &Arc::new(AtomicU32::new(0)));
1214
        assert!(matches!(out.data, KvCacheEventData::Cleared));
1215
1216
1217
1218
1219
1220
    }
}

#[cfg(test)]
mod tests_startup_helpers {
    use super::*;
1221
1222
1223
    use crate::kv_router::KvIndexer;
    use crate::kv_router::indexer::KvIndexerInterface;
    use crate::kv_router::protocols::{ExternalSequenceBlockHash, LocalBlockHash};
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
    use async_trait;
    use bytes::Bytes;
    use std::sync::{Arc, Mutex};
    use zeromq::{PubSocket, Socket, SocketSend, ZmqMessage};

    // Type alias to resolve clippy::type_complexity warning
    type PublishedEvents = Arc<Mutex<Vec<(String, Vec<u8>)>>>;

    //--------------------------------------------------------------------
    // A tiny stand-in for Component that just records every publish call
    //--------------------------------------------------------------------
    #[derive(Default)]
    struct MockComponent {
        published: PublishedEvents,
    }

    impl MockComponent {
        fn new() -> (Self, PublishedEvents) {
            let published = Arc::new(Mutex::new(Vec::new()));
            (
                Self {
                    published: published.clone(),
                },
                published,
            )
        }
    }

    #[async_trait::async_trait]
    impl EventPublisher for MockComponent {
        async fn publish(
            &self,
            event_name: impl AsRef<str> + Send + Sync,
            event: &(impl serde::Serialize + Send + Sync),
1258
        ) -> anyhow::Result<()> {
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
            let bytes = rmp_serde::to_vec(event).unwrap();
            self.published
                .lock()
                .unwrap()
                .push((event_name.as_ref().to_string(), bytes));
            Ok(())
        }

        async fn publish_bytes(
            &self,
            event_name: impl AsRef<str> + Send + Sync,
            bytes: Vec<u8>,
1271
        ) -> anyhow::Result<()> {
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
            self.published
                .lock()
                .unwrap()
                .push((event_name.as_ref().to_string(), bytes));
            Ok(())
        }

        fn subject(&self) -> String {
            "mock.subject".into()
        }
    }

    //--------------------------------------------------------------------
1285
    // Test start_event_processor
1286
1287
    //--------------------------------------------------------------------
    #[tokio::test]
1288
1289
1290
1291
1292
1293
1294
1295
    async fn test_start_event_processor() {
        let (component, published) = MockComponent::new();

        let event = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Removed(KvCacheRemoveData {
                block_hashes: vec![ExternalSequenceBlockHash(1), ExternalSequenceBlockHash(2)],
            }),
Yan Ru Pei's avatar
Yan Ru Pei committed
1296
            dp_rank: 0,
1297
1298
        };

1299
1300
1301
        let token = CancellationToken::new();
        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();
        tx.send(event).unwrap();
1302
1303
        drop(tx);

1304
        let handle = tokio::spawn(start_event_processor(component, 1, token, rx, None));
1305

1306
        tokio::time::timeout(tokio::time::Duration::from_secs(1), handle)
1307
1308
1309
1310
1311
            .await
            .unwrap()
            .unwrap();

        let published = published.lock().unwrap();
1312
1313
        assert_eq!(published.len(), 1);
        let (subject, _) = &published[0];
1314
        assert_eq!(subject, KV_EVENT_SUBJECT);
1315
1316
    }

1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
    //--------------------------------------------------------------------
    // Test start_event_processor with local indexer
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_start_event_processor_with_local_indexer() {
        let (component, published) = MockComponent::new();

        // Create a local indexer
        let token = CancellationToken::new();
        let metrics = Arc::new(KvIndexerMetrics::new_unregistered());
        let local_indexer = Arc::new(LocalKvIndexer::new(token.clone(), 4, metrics, 100));

        // Create BlockStored event
        let event = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Stored(KvCacheStoreData {
                parent_hash: None,
                blocks: vec![
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(100),
                        tokens_hash: LocalBlockHash(200),
1338
                        mm_extra_info: None,
1339
1340
1341
1342
                    },
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(101),
                        tokens_hash: LocalBlockHash(201),
1343
                        mm_extra_info: None,
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
                    },
                ],
            }),
            dp_rank: 0,
        };

        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();
        tx.send(event).unwrap();
        drop(tx);

        // Start event processor with local indexer
        let handle = tokio::spawn(start_event_processor(
            component,
            1,
            token.clone(),
            rx,
            Some(local_indexer.clone()), // arc::clone just increments atomic counters
        ));

        // Wait for processing
        tokio::time::timeout(tokio::time::Duration::from_secs(1), handle)
            .await
            .unwrap()
            .unwrap();

        // Verify event was published to NATS (same as test_start_event_processor)
        {
            let published_events = published.lock().unwrap();
            assert_eq!(published_events.len(), 1);
            let (subject, _) = &published_events[0];
1374
            assert_eq!(subject, KV_EVENT_SUBJECT);
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
        } // drop lock

        // Verify event was applied to local indexer
        // We can check by querying the workers that have blocks
        let get_workers_tx = local_indexer.get_workers_sender();
        let mut found = false;
        for _ in 0..20 {
            // Try up to 20 times (200ms total)
            let (resp_tx, resp_rx) = tokio::sync::oneshot::channel();
            get_workers_tx
                .send(crate::kv_router::indexer::GetWorkersRequest { resp: resp_tx })
                .await
                .unwrap();
            let workers: Vec<u64> = resp_rx.await.unwrap();

            if workers.contains(&1) {
                found = true;
                break;
            }

            // Wait before retrying
            tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;
        }

        // Worker 1 should be in the set (we used worker_id=1)
        assert!(
            found,
            "Worker 1 was not found in the indexer after processing"
        );

        // Cleanup
        token.cancel();
    }

    //--------------------------------------------------------------------
    // Test BlockRemoved event with local indexer
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_event_processor_block_removed_with_local_indexer() {
        let (component, published) = MockComponent::new();

        let token = CancellationToken::new();
        let metrics = Arc::new(KvIndexerMetrics::new_unregistered());
        let local_indexer = Arc::new(LocalKvIndexer::new(token.clone(), 4, metrics, 100));

        // First, store a block
        let store_event = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Stored(KvCacheStoreData {
                parent_hash: None,
                blocks: vec![KvCacheStoredBlockData {
                    block_hash: ExternalSequenceBlockHash(100),
                    tokens_hash: LocalBlockHash(200),
1428
                    mm_extra_info: None,
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
                }],
            }),
            dp_rank: 0,
        };

        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();
        tx.send(store_event).unwrap();

        // Start event processor with local indexer
        let handle = tokio::spawn(start_event_processor(
            component,
            1,
            token.clone(),
            rx,
            Some(local_indexer.clone()),
        ));

        // Then remove same event
        let remove_event = KvCacheEvent {
            event_id: 2,
            data: KvCacheEventData::Removed(KvCacheRemoveData {
                block_hashes: vec![ExternalSequenceBlockHash(100)],
            }),
            dp_rank: 0,
        };
        tx.send(remove_event).unwrap();
        drop(tx);

        tokio::time::timeout(tokio::time::Duration::from_secs(1), handle)
            .await
            .unwrap()
            .unwrap();

        // Local indexer should have no block
        let mut no_blocks = false;
        for _ in 0..20 {
            // Try up to 20 times (200ms total)
            let scores = local_indexer
                .find_matches(vec![LocalBlockHash(200)])
                .await
                .unwrap();
            if scores.scores.is_empty() {
                no_blocks = true;
                break;
            }
            tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;
        }
        assert!(no_blocks, "worker should have no blocks after removal");

        // Global kvindexer should have recieved two events (create/remove)
        let published = published.lock().unwrap();
        assert_eq!(
            published.len(),
            2,
            "expected 2 published events, found {}",
            published.len()
        );

        token.cancel();
    }

    //--------------------------------------------------------------------
    // Test AllBlocksCleared event with local indexer
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_event_processor_all_blocks_cleared_with_local_indexer() {
        let (component, published) = MockComponent::new();

        let token = CancellationToken::new();
        let metrics = Arc::new(KvIndexerMetrics::new_unregistered());
        let local_indexer = Arc::new(LocalKvIndexer::new(token.clone(), 4, metrics, 100));

        // Store a block
        let store_event = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Stored(KvCacheStoreData {
                parent_hash: None,
                blocks: vec![KvCacheStoredBlockData {
                    block_hash: ExternalSequenceBlockHash(100),
                    tokens_hash: LocalBlockHash(200),
1509
                    mm_extra_info: None,
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
                }],
            }),
            dp_rank: 0,
        };

        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();
        tx.send(store_event).unwrap();

        // Clear all blocks
        let clear_event = KvCacheEvent {
            event_id: 2,
            data: KvCacheEventData::Cleared,
            dp_rank: 0,
        };
        tx.send(clear_event).unwrap();
        drop(tx);

        // Create event processor and wait
        let handle = tokio::spawn(start_event_processor(
            component,
            1,
            token.clone(),
            rx,
            Some(local_indexer.clone()),
        ));

        tokio::time::timeout(tokio::time::Duration::from_secs(1), handle)
            .await
            .unwrap()
            .unwrap();

        // Local indexer should have no block
        let mut no_blocks = false;
        for _ in 0..20 {
            // Try up to 20 times (200ms total)
            let scores = local_indexer
                .find_matches(vec![LocalBlockHash(200)])
                .await
                .unwrap();
            if scores.scores.is_empty() {
                no_blocks = true;
                break;
            }
            tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;
        }
        assert!(no_blocks, "worker should have no blocks after clearing");

        // Global kvindexer should have recieved two events (create/remove)
        let published = published.lock().unwrap();
        assert_eq!(
            published.len(),
            2,
            "expected 2 published events, found {}",
            published.len()
        );

        token.cancel();
    }

    //--------------------------------------------------------------------
    // Test that local indexer failure doesn't break NATS publishing
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_event_processor_local_indexer_failure_continues() {
        let (component, published) = MockComponent::new();

        let token = CancellationToken::new();
        let metrics = Arc::new(KvIndexerMetrics::new_unregistered());
        let local_indexer = Arc::new(LocalKvIndexer::new(token.clone(), 4, metrics, 100));

        // cancel indexer immediately to simulate failure
        token.cancel();

        let event = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Removed(KvCacheRemoveData {
                block_hashes: vec![ExternalSequenceBlockHash(1)],
            }),
            dp_rank: 0,
        };

        let new_token = CancellationToken::new();
        let (tx, rx) = mpsc::unbounded_channel::<KvCacheEvent>();
        tx.send(event).unwrap();
        drop(tx);

        // Despite local indexer being cancelled, event processor should continue
        let handle = tokio::spawn(start_event_processor(
            component,
            1,
            new_token,
            rx,
            Some(local_indexer),
        ));

        tokio::time::timeout(tokio::time::Duration::from_secs(1), handle)
            .await
            .unwrap()
            .unwrap();

        // Verify event was still published to NATS despite local indexer failure
        let published_events = published.lock().unwrap();
        assert_eq!(published_events.len(), 1);
    }

1615
1616
1617
1618
1619
1620
1621
    //--------------------------------------------------------------------
    // Test start_zmq_listener without a real socket
    //   (feed it frames through a ZMQ PAIR tcp socket)
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_start_zmq_listener_pushes_to_channel() {
        // Prepare channel that listener should fill
1622
        let (tx, mut rx) = mpsc::unbounded_channel::<KvCacheEvent>();
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637

        // ZMQ TCP endpoint using localhost with fixed port
        let endpoint = "tcp://127.0.0.1:15555";
        let topic = "".to_string(); // subscribe to all

        // Publisher side - set up first
        let mut pub_socket = PubSocket::new();
        pub_socket.bind(endpoint).await.unwrap();

        // Cancellation token so we can stop the listener
        let token = dynamo_runtime::CancellationToken::new();

        // Spawn async listener
        let listener_handle = tokio::spawn({
            let token = token.clone();
1638
            start_zmq_listener(endpoint.to_string(), topic, tx, token, 4)
1639
1640
1641
1642
1643
1644
1645
        });

        // Give time for the connection to establish
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // Send synthetic 3-frame message: [topic, seq(8B), payload]
        let seq: u64 = 77;
1646
1647

        let events = vec![RawKvEvent::BlockStored {
1648
            block_hashes: vec![BlockHashValue::Unsigned(42)],
1649
1650
1651
1652
            parent_block_hash: None,
            token_ids: vec![0, 1, 2, 3],
            block_size: 4,
            lora_id: None,
1653
            medium: None,
1654
            block_mm_infos: None,
1655
1656
        }];

Alec's avatar
Alec committed
1657
1658
1659
        let batch = KvEventBatch {
            ts: 0.0,
            events,
1660
            data_parallel_rank: Some(1),
Alec's avatar
Alec committed
1661
        };
1662
1663

        let payload = Bytes::from(rmps::to_vec(&batch).unwrap());
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680

        let frames = vec![
            Bytes::from(""),
            Bytes::from(seq.to_be_bytes().to_vec()),
            payload.clone(),
        ];

        // Create a proper multipart message
        let msg = ZmqMessage::try_from(frames).expect("Failed to create ZmqMessage");

        // Send the multipart message
        pub_socket.send(msg).await.unwrap();

        // Wait for message to be received
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // Check that we received the message
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
        let event = rx.try_recv().expect("no message received");

        let KvCacheEventData::Stored(KvCacheStoreData {
            parent_hash,
            blocks,
        }) = event.data
        else {
            panic!("expected KvCacheStoreData");
        };

        assert!(parent_hash.is_none());
        assert_eq!(blocks.len(), 1);
        assert_eq!(blocks[0].block_hash.0, 42);
1694
1695
1696
1697
1698

        // Stop the listener
        token.cancel();
        let _ = listener_handle.await;
    }
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744

    //--------------------------------------------------------------------
    // Test distributed recovery: Router queries worker's LocalKvIndexer after outage
    //--------------------------------------------------------------------
    #[tokio::test]
    async fn test_distributed_kvindexer_recovery_from_outage() {
        let worker_1_id = 1u64;
        let block_size = 4u32;
        let token = CancellationToken::new();

        // === SETUP: Worker Components ===
        let (worker_component, worker_published) = MockComponent::new();
        let local_indexer_1 = Arc::new(LocalKvIndexer::new(
            token.clone(),
            block_size,
            Arc::new(KvIndexerMetrics::new_unregistered()),
            100, // buffer size
        ));

        let (worker_tx, worker_rx) = mpsc::unbounded_channel::<KvCacheEvent>();

        // Start worker's event processor
        tokio::spawn(start_event_processor(
            worker_component,
            worker_1_id,
            token.clone(),
            worker_rx,
            Some(local_indexer_1.clone()),
        ));

        // === SETUP: Router Components ===
        let router_indexer = Arc::new(KvIndexer::new(
            token.clone(),
            block_size,
            Arc::new(KvIndexerMetrics::new_unregistered()),
        ));

        // === STEP 1: Normal Operation ===
        let event_1 = KvCacheEvent {
            event_id: 1,
            data: KvCacheEventData::Stored(KvCacheStoreData {
                parent_hash: None,
                blocks: vec![
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(100),
                        tokens_hash: LocalBlockHash(200),
1745
                        mm_extra_info: None,
1746
1747
1748
1749
                    },
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(101),
                        tokens_hash: LocalBlockHash(201),
1750
                        mm_extra_info: None,
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
                    },
                ],
            }),
            dp_rank: 0,
        };

        worker_tx.send(event_1.clone()).unwrap();
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // Simulate JetStream: forward worker's published event to router
        let (subject, bytes) = {
            let published = worker_published.lock().unwrap();
            assert_eq!(published.len(), 1, "Worker should have published 1 event");
            (published[0].0.clone(), published[0].1.clone())
        }; // drop worker_published before await
1766
        assert_eq!(subject, KV_EVENT_SUBJECT);
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810

        let router_event: RouterEvent = rmp_serde::from_slice(&bytes).unwrap();
        router_indexer
            .event_sender()
            .send(router_event)
            .await
            .unwrap();

        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // assert: Router's indexer has event
        let get_workers_tx = router_indexer.get_workers_sender();
        let mut router_has_worker = false;
        for _ in 0..20 {
            let (resp_tx, resp_rx) = tokio::sync::oneshot::channel();
            get_workers_tx
                .send(crate::kv_router::indexer::GetWorkersRequest { resp: resp_tx })
                .await
                .unwrap();
            let workers: Vec<u64> = resp_rx.await.unwrap();
            if workers.contains(&worker_1_id) {
                router_has_worker = true;
                break;
            }
            tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;
        }
        assert!(
            router_has_worker,
            "Router should see worker 1 after normal operation"
        );

        // assert: Worker's local indexer buffered event
        let buffered = local_indexer_1.get_all_events_in_buffer();
        assert_eq!(buffered.len(), 1, "Local indexer should buffer 1 event");

        // === STEP 2 & 3: Simulate Outage - Stop forwarding to router ===
        let event_2 = KvCacheEvent {
            event_id: 2,
            data: KvCacheEventData::Stored(KvCacheStoreData {
                parent_hash: None,
                blocks: vec![
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(100), // Shared prefix
                        tokens_hash: LocalBlockHash(200),
1811
                        mm_extra_info: None,
1812
1813
1814
1815
                    },
                    KvCacheStoredBlockData {
                        block_hash: ExternalSequenceBlockHash(102), // New block
                        tokens_hash: LocalBlockHash(202),
1816
                        mm_extra_info: None,
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
                    },
                ],
            }),
            dp_rank: 0,
        };

        worker_tx.send(event_2.clone()).unwrap(); // send to worker but not to router
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // assert: Worker published event_2 to "NATS" (MockComponent)
        {
            let published = worker_published.lock().unwrap();
            assert_eq!(
                published.len(),
                2,
                "Worker should have published 2 events total"
            );
        }

        // assert: Worker's local indexer has both events
        let buffered = local_indexer_1.get_all_events_in_buffer();
        assert_eq!(
            buffered.len(),
            2,
            "Local indexer should have both events during outage"
        );

        // assert: Router DOESN'T have event_2
        let block_hashes_2 = vec![LocalBlockHash(200), LocalBlockHash(202)];
        let overlap = router_indexer
            .find_matches(block_hashes_2.clone())
            .await
            .unwrap();
        let router_overlap = overlap
            .scores
            .get(&crate::kv_router::protocols::WorkerWithDpRank::from_worker_id(worker_1_id))
            .copied()
            .unwrap_or(0);
        assert_eq!(
            router_overlap, 1,
            "Router should only see 1 shared block (not the new block from event_2)"
        );

1860
1861
1862
1863
        // === STEP 4 & 5: Recovery - Query worker's local indexer for missed events ===
        // In practice, the subscriber detects gaps and triggers recovery automatically.
        // Here we simulate that by querying for events after event_id=1.
        let last_known_id = 1u64; // Router only received event_1
1864
        let response = local_indexer_1
1865
1866
            .get_events_in_id_range(Some(last_known_id + 1), None)
            .await;
1867
1868
1869
1870
1871
        let missed_events = match response {
            crate::kv_router::indexer::WorkerKvQueryResponse::Events(e) => e,
            crate::kv_router::indexer::WorkerKvQueryResponse::TreeDump(e) => e,
            other => panic!("Unexpected response: {:?}", other),
        };
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
        assert_eq!(
            missed_events.len(),
            1,
            "Should get 1 missed event (event_2 with id=2)"
        );

        // Step 5: Apply missed events to router
        for router_event in missed_events {
            router_indexer
                .event_sender()
                .send(router_event)
                .await
                .unwrap();
        }

        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

        // assert: Router now has complete state
        let overlap = router_indexer.find_matches(block_hashes_2).await.unwrap();
        let router_overlap_after = overlap
            .scores
            .get(&crate::kv_router::protocols::WorkerWithDpRank::from_worker_id(worker_1_id))
            .copied()
            .unwrap_or(0);
        assert_eq!(
            router_overlap_after, 2,
            "Router should now see both blocks after recovery"
        );

        token.cancel();
    }
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
}

#[cfg(test)]
mod test_exponential_backoff {
    use super::*;

    #[test]
    fn test_backoff_calculation_progression() {
        // Test the exponential progression
        assert_eq!(calculate_backoff_ms(0), 10); // 10 * 2^0 = 10
        assert_eq!(calculate_backoff_ms(1), 20); // 10 * 2^1 = 20
        assert_eq!(calculate_backoff_ms(2), 40); // 10 * 2^2 = 40
        assert_eq!(calculate_backoff_ms(3), 80); // 10 * 2^3 = 80
        assert_eq!(calculate_backoff_ms(4), 160); // 10 * 2^4 = 160
        assert_eq!(calculate_backoff_ms(5), 320); // 10 * 2^5 = 320
        assert_eq!(calculate_backoff_ms(6), 640); // 10 * 2^6 = 640
        assert_eq!(calculate_backoff_ms(7), 1280); // 10 * 2^7 = 1280
        assert_eq!(calculate_backoff_ms(8), 2560); // 10 * 2^8 = 2560
    }

    #[test]
    fn test_backoff_caps_at_max_exponent() {
        // After MAX_BACKOFF_EXPONENT, should stay at 2^8 = 2560ms
        assert_eq!(calculate_backoff_ms(8), 2560);
        assert_eq!(calculate_backoff_ms(9), 2560); // Same as 8
        assert_eq!(calculate_backoff_ms(100), 2560); // Same as 8
    }

    #[test]
    fn test_backoff_never_exceeds_max() {
        // Even if we somehow had a huge exponent, never exceed MAX_BACKOFF_MS
        for i in 0..20 {
            assert!(calculate_backoff_ms(i) <= MAX_BACKOFF_MS);
        }
    }

    #[test]
    #[allow(clippy::assertions_on_constants)]
    fn test_backoff_constants_are_sane() {
        // Verify our constants make sense together
        assert!(INITIAL_BACKOFF_MS > 0);
        assert!(MAX_BACKOFF_MS > INITIAL_BACKOFF_MS);
        assert!(MAX_BACKOFF_EXPONENT <= 10); // Prevent crazy exponents
        assert!(MAX_CONSECUTIVE_ERRORS > 0);

        // Max calculated value should be less than MAX_BACKOFF_MS
        let max_calculated = INITIAL_BACKOFF_MS * 2_u64.pow(MAX_BACKOFF_EXPONENT);
        assert!(max_calculated <= MAX_BACKOFF_MS);
    }
}
1953

1954
1955
#[cfg(all(test, feature = "integration"))]
mod test_integration_publisher {
1956
    use super::*;
1957
    use crate::kv_router::protocols::{ActiveLoad, ForwardPassMetrics, KvStats, WorkerStats};
1958
1959
    use dynamo_runtime::distributed_test_utils::create_test_drt_async;
    use dynamo_runtime::traits::events::EventSubscriber;
1960
1961
1962
    use futures::StreamExt;

    #[tokio::test]
1963
    #[ignore] // Mark as ignored as requested, because CI's integrations still don't have NATS
1964
1965
    async fn test_metrics_publishing_behavior() -> Result<()> {
        // Set up runtime and namespace
1966
1967
        let drt = create_test_drt_async().await;
        let namespace = drt.namespace("ns2001".to_string())?;
1968
1969
1970

        // Create a subscriber for the metrics events using subscribe_with_type
        let mut subscriber = namespace
1971
            .subscribe_with_type::<ActiveLoad>(KV_METRICS_SUBJECT)
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
            .await
            .unwrap();

        // Create WorkerMetricsPublisher
        let publisher = WorkerMetricsPublisher::new().unwrap();
        let worker_id = 1234;

        // Start NATS metrics publishing
        publisher.start_nats_metrics_publishing(namespace.clone(), worker_id);

        // Allow some time for the background task to start
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        // Test 1: Publish 10 different metrics with 0.5ms intervals
        // Only the last one should be published after 1ms of stability
        for i in 0..10 {
            let metrics = Arc::new(ForwardPassMetrics {
                kv_stats: KvStats {
                    kv_active_blocks: (i * 100) as u64, // Changing load metric
                    kv_total_blocks: 1000,
                    gpu_cache_usage_perc: 0.5,
                    gpu_prefix_cache_hit_rate: 0.8,
                },
                worker_stats: WorkerStats {
                    num_requests_waiting: (i * 10) as u64, // Changing load metric
                    data_parallel_rank: None,
                    request_active_slots: 50,
                    request_total_slots: 100,
                },
                spec_decode_stats: None,
            });

            publisher.publish(metrics).unwrap();
            tokio::time::sleep(tokio::time::Duration::from_micros(100)).await;
        }

        // Wait a bit more than 1ms to ensure the last metric is published
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        // Verify we receive exactly one event with the last metric values
        let result =
            tokio::time::timeout(tokio::time::Duration::from_millis(500), subscriber.next())
                .await
                .unwrap();

        let event = result.unwrap().unwrap(); // Unwrap the Option and the Result
        assert_eq!(event.worker_id, worker_id);
2019
2020
        assert_eq!(event.active_decode_blocks, Some(900)); // Last value: 9 * 100
        assert_eq!(event.active_prefill_tokens, None); // Worker doesn't publish prefill tokens
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059

        // Ensure no more events are waiting
        let no_msg =
            tokio::time::timeout(tokio::time::Duration::from_millis(50), subscriber.next()).await;
        assert!(no_msg.is_err(), "Expected no more messages, but found one");

        // Test 2: Publish 10 more metrics where everything changes EXCEPT the load metrics
        for i in 0..10 {
            let metrics = Arc::new(ForwardPassMetrics {
                kv_stats: KvStats {
                    kv_active_blocks: 900,                         // Keep same as last published
                    kv_total_blocks: 1000 + (i * 100) as u64,      // Change other metrics
                    gpu_cache_usage_perc: 0.3 + (i as f32 * 0.05), // Change other metrics
                    gpu_prefix_cache_hit_rate: 0.7 + (i as f32 * 0.01), // Change other metrics
                },
                worker_stats: WorkerStats {
                    num_requests_waiting: 90, // Keep same as last published
                    data_parallel_rank: None,
                    request_active_slots: 40 + (i * 5) as u64, // Change other metrics
                    request_total_slots: 100 + (i * 10) as u64, // Change other metrics
                },
                spec_decode_stats: None,
            });

            publisher.publish(metrics).unwrap();
            tokio::time::sleep(tokio::time::Duration::from_micros(100)).await;
        }

        // Wait to ensure no events are published
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        // Verify no events are received
        let no_msg =
            tokio::time::timeout(tokio::time::Duration::from_millis(50), subscriber.next()).await;
        assert!(
            no_msg.is_err(),
            "Expected no messages when load metrics don't change"
        );

2060
        drt.shutdown();
2061
2062
2063

        Ok(())
    }
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119

    #[tokio::test]
    #[ignore] // Mark as ignored as requested, because CI's integrations still don't have NATS
    async fn test_kvstats_prometheus_gauge_updates() {
        // Test that publish() updates Prometheus gauges correctly using real Component
        let publisher = WorkerMetricsPublisher::new().unwrap();

        // Create a real DRT and component for integration testing
        let drt = create_test_drt_async().await;
        let namespace = drt.namespace("ns2002".to_string()).unwrap();
        let component = namespace.component("comp2002".to_string()).unwrap();

        // Register Prometheus metrics using the real constructor
        publisher.register_prometheus_metrics(&component).unwrap();

        // Get references to the gauges for testing
        let gauges = publisher.prometheus_gauges.get().unwrap();
        let active_blocks_gauge = gauges.kv_active_blocks_gauge.clone();
        let total_blocks_gauge = gauges.kv_total_blocks_gauge.clone();
        let cache_usage_gauge = gauges.gpu_cache_usage_gauge.clone();
        let hit_rate_gauge = gauges.gpu_prefix_cache_hit_rate_gauge.clone();

        // Create test metrics with specific values
        let test_metrics = Arc::new(ForwardPassMetrics {
            worker_stats: WorkerStats {
                data_parallel_rank: None,
                request_active_slots: 5,
                request_total_slots: 100,
                num_requests_waiting: 2,
            },
            kv_stats: KvStats {
                kv_active_blocks: 42,
                kv_total_blocks: 12894,
                gpu_cache_usage_perc: 0.5,
                gpu_prefix_cache_hit_rate: 0.75,
            },
            spec_decode_stats: None,
        });

        // Test 1: Initial gauge values should be 0
        assert_eq!(active_blocks_gauge.get(), 0.0);
        assert_eq!(total_blocks_gauge.get(), 0.0);
        assert_eq!(cache_usage_gauge.get(), 0.0);
        assert_eq!(hit_rate_gauge.get(), 0.0);

        // Test 2: publish() should update all gauges with correct values
        let result = publisher.publish(test_metrics);
        assert!(result.is_ok());

        // Test 3: Verify gauges were updated correctly
        assert_eq!(active_blocks_gauge.get(), 42.0);
        assert_eq!(total_blocks_gauge.get(), 12894.0);
        assert_eq!(cache_usage_gauge.get(), 0.5);
        assert_eq!(hit_rate_gauge.get(), 0.75);

        // Test 4: Verify metrics are properly registered in the component's registry
2120
        // Component implements MetricsRegistry trait which provides prometheus_expfmt()
2121
        let prometheus_output = component.metrics().prometheus_expfmt().unwrap();
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144

        // Verify metric names are present
        assert!(prometheus_output.contains(kvstats::ACTIVE_BLOCKS));
        assert!(prometheus_output.contains(kvstats::TOTAL_BLOCKS));
        assert!(prometheus_output.contains(kvstats::GPU_CACHE_USAGE_PERCENT));
        assert!(prometheus_output.contains(kvstats::GPU_PREFIX_CACHE_HIT_RATE));

        // Test 5: Verify the prometheus output contains the actual values
        // Print the output to debug format issues
        println!("Prometheus output:\n{}", prometheus_output);

        // Check for metric values - the format includes labels so we need to be more flexible
        assert!(prometheus_output.contains("kvstats_active_blocks"));
        assert!(prometheus_output.contains("42")); // The value should be there
        assert!(prometheus_output.contains("kvstats_total_blocks"));
        assert!(prometheus_output.contains("12894")); // The value should be there
        assert!(prometheus_output.contains("kvstats_gpu_cache_usage_percent"));
        assert!(prometheus_output.contains("kvstats_gpu_prefix_cache_hit_rate"));

        println!(
            "✅ KvStatsPrometheusGauges constructor and publish() work correctly with real Component"
        );
    }
2145
}
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323

#[cfg(all(test, feature = "integration"))]
mod test_integration_publisher_with_kvindexer {
    use super::*;

    use crate::kv_router::scheduler::DefaultWorkerSelector;
    use crate::kv_router::{KvPushRouter, KvRouter, KvRouterConfig};
    use crate::local_model::LocalModelBuilder;
    use crate::local_model::runtime_config::ModelRuntimeConfig;
    use crate::mocker::engine::{MOCKER_COMPONENT, MockVllmEngine};
    use crate::mocker::protocols::MockEngineArgs;
    use crate::protocols::common::llm_backend::{LLMEngineOutput, PreprocessedRequest};
    use crate::protocols::common::{OutputOptions, SamplingOptions, StopConditions};
    use dynamo_runtime::distributed_test_utils::create_test_shared_drt_async;
    use dynamo_runtime::engine::AsyncEngine;
    use dynamo_runtime::pipeline::{Context, PushRouter, RouterMode, network::Ingress};
    use dynamo_runtime::protocols::annotated::Annotated;

    /// Integration test: KvPushRouter end-to-end routing with mock engines.
    #[tokio::test(flavor = "multi_thread")]
    #[ignore] // Requires NATS/etcd. Run with: cargo test --package dynamo-llm --lib --features integration test_distributed_kvindexer_e2e -- --ignored --nocapture
    async fn test_distributed_kvindexer_e2e() -> anyhow::Result<()> {
        const BLOCK_SIZE: u32 = 4;
        const NUM_REQUESTS: usize = 4;

        dynamo_runtime::logging::init();

        // === SETUP: Distributed runtimes and namespaces ===
        let shared_store_dir = tempfile::tempdir()?;
        let shared_store_path = shared_store_dir.path().to_path_buf();

        // Make both runtimes point at the same file-backed storage backend so worker
        // registrations and heartbeats remain visible to every DRT instance.
        let distributed1 = create_test_shared_drt_async(&shared_store_path).await;
        let distributed2 = create_test_shared_drt_async(&shared_store_path).await;
        let component1 = distributed1
            .namespace("test_e2e_router")?
            .component(MOCKER_COMPONENT)?;
        let component2 = distributed2
            .namespace("test_e2e_router")?
            .component(MOCKER_COMPONENT)?;

        // === SETUP: Start mocker workers  ===
        let mocker_args = MockEngineArgs::builder()
            .block_size(BLOCK_SIZE as usize)
            .dp_size(1) // single worker per runtime
            .enable_prefix_caching(true)
            .enable_local_indexer(true) // affects scheduler/publisher args
            .build()?;

        let worker_components = vec![component1.clone(), component2.clone()];
        let mut server_handles = Vec::new();
        let mut worker_ids = Vec::new();

        for comp in worker_components {
            let engine = Arc::new(MockVllmEngine::new(mocker_args.clone()));
            engine.start(comp.clone()).await?;
            tracing::info!("MockVllmEngine started for {:?}", comp);

            // Register MDC with runtime_config so router can discover enable_local_indexer.
            // (Without this step, the MDC-based assert in query_worker() in worker_query.rs will fail.)
            // This inlines code which in the Python path would be performed by:
            // - local_model.rs: LocalModelBuilder::build() sets runtime_config from MockEngineArgs
            // - entrypoint/input/endpoint.rs: LocalModel::attach() registers MDC via discovery
            let endpoint = comp.endpoint("generate");
            let runtime_config = ModelRuntimeConfig {
                enable_local_indexer: true,
                ..Default::default()
            };
            let mut builder = LocalModelBuilder::default();
            builder
                .model_name(Some("mock".to_string()))
                .kv_cache_block_size(Some(BLOCK_SIZE))
                .runtime_config(runtime_config);
            let mut local_model = builder.build().await?;
            local_model
                .attach(
                    &endpoint,
                    crate::model_type::ModelType::Chat,
                    crate::model_type::ModelInput::Tokens,
                    None,
                )
                .await?;

            let ingress = Ingress::for_engine(engine.clone())?;
            let endpoint_component = comp.clone();
            let handle = tokio::spawn(async move {
                if let Err(e) = endpoint_component
                    .endpoint("generate")
                    .endpoint_builder()
                    .handler(ingress)
                    .start()
                    .await
                {
                    tracing::error!("Generate endpoint failed: {e}");
                }
            });
            server_handles.push(handle);
            worker_ids.push(comp.drt().connection_id());
        }
        tracing::info!("Generate endpoint servers launched");

        tokio::time::sleep(Duration::from_millis(500)).await;

        // === SETUP: Build KvPushRouter ===
        let router_distributed = create_test_shared_drt_async(&shared_store_path).await;
        let router_namespace = router_distributed.namespace("test_e2e_router")?;
        let backend_component = router_namespace.component(MOCKER_COMPONENT)?;
        let backend_endpoint = backend_component.endpoint("generate");
        let client = backend_endpoint.client().await?;
        let kv_router_config = KvRouterConfig::default();
        let selector = Box::new(DefaultWorkerSelector::new(Some(kv_router_config)));
        let consumer_id = format!("test-router-{}", router_distributed.connection_id());

        let kv_router: Arc<KvRouter> = Arc::new(
            KvRouter::new(
                backend_endpoint.clone(),
                client.clone(),
                BLOCK_SIZE,
                Some(selector),
                Some(kv_router_config),
                consumer_id,
            )
            .await?,
        );

        let push_router =
               PushRouter::<PreprocessedRequest, Annotated<LLMEngineOutput>>::from_client_with_threshold(
                   client,
                   RouterMode::KV,
                   None,
                   None,
               )
               .await?;

        let kv_push_router = KvPushRouter::new(push_router, kv_router.clone());

        // ===== TEST PART 1: ROUTE & SEND REQUESTS TO WORKERS (ROUTER -> WORKER) =====
        let create_request = |tokens: Vec<u32>| {
            PreprocessedRequest::builder()
                .model("mock".to_string())
                .token_ids(tokens)
                .stop_conditions(StopConditions {
                    max_tokens: Some(10),
                    ..Default::default()
                })
                .sampling_options(SamplingOptions::default())
                .output_options(OutputOptions::default())
                .build()
                .unwrap()
        }; // from mocker/engine.rs

        for i in 0..NUM_REQUESTS {
            tracing::info!("Sending routed request {}", i + 1);
            let tokens = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, i as u32];
            let request = create_request(tokens.clone());

            let response_stream = kv_push_router.generate(Context::new(request)).await?;
            let responses: Vec<Annotated<LLMEngineOutput>> = response_stream.collect().await;
            assert!(
                !responses.is_empty(),
                "Request {} should produce at least one response",
                i + 1
            );
        }

        tracing::info!("KvPushRouter generate() succeeded for {NUM_REQUESTS} requests");

        // ===== TEST PART 2: QUERY WORKER-LOCAL KVINDEXERS DIRECTLY =====
        // TODO: This could be refactored as router function (e.g. router.refresh_from_worker(worker_id))
        // (which should also update the global kvIndexer with the buffer from the local kvIndexer)
        let mut best_worker_info: Option<(u64, usize)> = None;

        // Exactly one worker should have been routed requests. Find that worker
        for &worker_id in &worker_ids {
            let response = kv_router
                .query_worker_local_kv(worker_id, None, None)
                .await?;
2324
2325
2326
2327
2328
2329
            let events = match response {
                crate::kv_router::indexer::WorkerKvQueryResponse::Events(e) => e,
                crate::kv_router::indexer::WorkerKvQueryResponse::TreeDump(e) => e,
                _ => vec![],
            };
            if events.is_empty() {
2330
2331
2332
                continue;
            }

2333
            let event_count = events.len();
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
            tracing::info!(
                worker_id,
                events = event_count,
                "Worker query on worker {worker_id} returned buffered KV events"
            );
            best_worker_info = Some((worker_id, event_count));
            break;
        }

        // Verify that only one worker has KV events in buffer
        let (best_worker_id, best_worker_event_count) =
            best_worker_info.expect("At least one worker should have buffered KV events");

        tracing::info!(
            "Best worker is {best_worker_id} with {best_worker_event_count} buffered KV events"
        );

        for &worker_id in &worker_ids {
            if worker_id == best_worker_id {
                continue;
            }

            let response = kv_router
                .query_worker_local_kv(worker_id, None, None)
                .await?;
2359
2360
2361
2362
2363
            let events = match response {
                crate::kv_router::indexer::WorkerKvQueryResponse::Events(e) => e,
                crate::kv_router::indexer::WorkerKvQueryResponse::TreeDump(e) => e,
                _ => vec![],
            };
2364
            assert!(
2365
                events.is_empty(),
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
                "Worker {worker_id} should not report buffered KV events; best worker {best_worker_id} reported {best_worker_event_count}"
            );
        }

        // === Cleanup ===
        for handle in server_handles {
            handle.abort();
        }
        distributed1.shutdown();
        distributed2.shutdown();
        router_distributed.shutdown();

        Ok(())
    }

    #[tokio::test(flavor = "multi_thread")]
    #[ignore]
    async fn test_distributed_kvindexer_e2e_startup() -> anyhow::Result<()> {
        const BLOCK_SIZE: u32 = 4;

        dynamo_runtime::logging::init();

        // === SETUP: Distributed runtimes and namespaces ===
        let shared_store_dir = tempfile::tempdir()?;
        let shared_store_path = shared_store_dir.path().to_path_buf();

        // Use a unique namespace per test run for full isolation
        let test_namespace = format!("test_e2e_{}", uuid::Uuid::new_v4().simple());

        // Make both runtimes point at the same file-backed storage backend so worker
        // registrations and heartbeats remain visible to every DRT instance.
        let distributed1 = create_test_shared_drt_async(&shared_store_path).await;
        let distributed2 = create_test_shared_drt_async(&shared_store_path).await;
        let component1 = distributed1
            .namespace(&test_namespace)?
            .component(MOCKER_COMPONENT)?;
        let component2 = distributed2
            .namespace(&test_namespace)?
            .component(MOCKER_COMPONENT)?;

        // === SETUP: Start mocker workers  ===
        let mocker_args = MockEngineArgs::builder()
            .block_size(BLOCK_SIZE as usize)
            .dp_size(1) // single worker per runtime
            .enable_prefix_caching(true)
            .enable_local_indexer(true) // affects scheduler/publisher args
            .build()?;

        let worker_components = vec![component1.clone(), component2.clone()];
        let mut server_handles = Vec::new();
        let mut worker_ids = Vec::new();

        for comp in worker_components {
            let engine: Arc<MockVllmEngine> = Arc::new(MockVllmEngine::new(mocker_args.clone()));
            engine.start(comp.clone()).await?;
            tracing::info!("MockVllmEngine started for {:?}", comp);

            // Register MDC with runtime_config so router can discover enable_local_indexer.
            // (Without this step, the MDC-based assert in query_worker() in worker_query.rs will fail.)
            // This inlines code which in the Python path would be performed by:
            // - local_model.rs: LocalModelBuilder::build() sets runtime_config from MockEngineArgs
            // - entrypoint/input/endpoint.rs: LocalModel::attach() registers MDC via discovery
            let endpoint = comp.endpoint("generate");
            let runtime_config = ModelRuntimeConfig {
                enable_local_indexer: true,
                ..Default::default()
            };
            let mut builder = LocalModelBuilder::default();
            builder
                .model_name(Some("mock".to_string()))
                .kv_cache_block_size(Some(BLOCK_SIZE))
                .runtime_config(runtime_config);
            let mut local_model = builder.build().await?;
            local_model
                .attach(
                    &endpoint,
                    crate::model_type::ModelType::Chat,
                    crate::model_type::ModelInput::Tokens,
                    None,
                )
                .await?;

            let ingress = Ingress::for_engine(engine.clone())?;
            let endpoint_component = comp.clone();
            let handle = tokio::spawn(async move {
                if let Err(e) = endpoint_component
                    .endpoint("generate")
                    .endpoint_builder()
                    .handler(ingress)
                    .start()
                    .await
                {
                    tracing::error!("Generate endpoint failed: {e}");
                }
            });
            server_handles.push(handle);
            worker_ids.push(comp.drt().connection_id());
        }
        tracing::info!("Generate endpoint servers launched");

        tokio::time::sleep(Duration::from_millis(500)).await;

        // === STEP 1: Send request to worker_ids[0] to populate its local indexer ===
        // This simulates a situation where KvPushRouter is initialized
        // to route to workers which already have KV events
        let pre_router_distributed = create_test_shared_drt_async(&shared_store_path).await;
        let pre_backend_endpoint = pre_router_distributed
            .namespace(&test_namespace)?
            .component(MOCKER_COMPONENT)?
            .endpoint("generate");
        let pre_client = pre_backend_endpoint.client().await?;

2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
        // Wait for the client to discover both workers
        let discovery_timeout = Duration::from_secs(5);
        let discovery_start = std::time::Instant::now();
        loop {
            let instances = pre_client.instance_source.as_ref().borrow().clone();
            if instances.len() >= 2 {
                tracing::info!("Discovered {} workers", instances.len());
                break;
            }
            if discovery_start.elapsed() > discovery_timeout {
                anyhow::bail!(
                    "Timed out waiting for worker discovery: expected 2, found {}",
                    instances.len()
                );
            }
            tokio::time::sleep(Duration::from_millis(50)).await;
        }

2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
        // Create a PushRouter to send requests directly to a specific worker
        let pre_push_router =
            PushRouter::<PreprocessedRequest, Annotated<LLMEngineOutput>>::from_client_with_threshold(
                pre_client,
                RouterMode::Random, // We'll use direct() so mode doesn't matter
                None,
                None,
            )
            .await?;

        // Force sending one requests each to the two workers
        for &worker_id in &worker_ids {
            let tokens: Vec<u32> = vec![0, 1, 2, 3];
            let request = PreprocessedRequest::builder()
                .model("mock".to_string())
                .token_ids(tokens.clone())
                .sampling_options(SamplingOptions::default())
                .output_options(OutputOptions::default())
                .stop_conditions(StopConditions {
                    max_tokens: Some(5),
                    ..Default::default()
                })
                .build()?;
            let response_stream = pre_push_router
                .direct(Context::new(request), worker_id)
                .await?;
            // Consume the stream to complete the request
            let _responses: Vec<_> = response_stream.collect().await;
            tracing::debug!(
                "Sent request {:?} directly to worker {} to populate its local indexer",
                tokens,
                worker_id
            );
        }
        tokio::time::sleep(Duration::from_millis(1000)).await;

        // === SETUP: Build KvPushRouter ===
        let router_distributed = create_test_shared_drt_async(&shared_store_path).await;
        let router_namespace = router_distributed.namespace(&test_namespace)?;
        let backend_component = router_namespace.component(MOCKER_COMPONENT)?;
        let backend_endpoint = backend_component.endpoint("generate");
        let client = backend_endpoint.client().await?;
        let kv_router_config = KvRouterConfig::default();
        let selector = Box::new(DefaultWorkerSelector::new(Some(kv_router_config)));
        let consumer_id = format!("test-router-{}", router_distributed.connection_id());

        let kv_router: Arc<KvRouter> = Arc::new(
            KvRouter::new(
                backend_endpoint.clone(),
                client.clone(),
                BLOCK_SIZE,
                Some(selector),
                Some(kv_router_config),
                consumer_id,
            )
            .await?,
        );

2554
2555
        // The KvRouter now starts its subscriber asynchronously in a background task
        // that waits for runtime_configs. Poll until events appear or timeout.
2556
2557
        // Each request generates 2 events: input block (parent_hash: None) + output block (parent_hash: Some)
        // With 2 workers, that's 4 events total.
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
        let expected_events = 4;
        let max_wait = Duration::from_secs(10);
        let poll_interval = Duration::from_millis(100);
        let start = std::time::Instant::now();

        let global_kv_events = loop {
            let events = kv_router.indexer.dump_events().await?;
            tracing::debug!("Global KV events ({}): {:?}", events.len(), events);
            if events.len() >= expected_events {
                break events;
            }
            if start.elapsed() > max_wait {
                anyhow::bail!(
                    "Timed out waiting for KV events: expected {}, got {}",
                    expected_events,
                    events.len()
                );
            }
            tokio::time::sleep(poll_interval).await;
        };

        assert_eq!(global_kv_events.len(), expected_events); // 2 workers × 2 events per request (input + output)
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591

        // === Cleanup ===
        for handle in server_handles {
            handle.abort();
        }
        distributed1.shutdown();
        distributed2.shutdown();
        router_distributed.shutdown();

        Ok(())
    }
}