sockudo-adapter 4.2.0

Connection adapters and horizontal scaling for Sockudo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
use crate::horizontal_adapter::{BroadcastMessage, RequestBody, ResponseBody};
use crate::horizontal_transport::{HorizontalTransport, TransportConfig, TransportHandlers};
use async_nats::{Client as NatsClient, ConnectOptions as NatsOptions, Subject};
use async_trait::async_trait;
use bytes::Bytes;
use futures::StreamExt;
use sockudo_core::error::{Error, Result};
use sockudo_core::metrics::MetricsInterface;
use sockudo_core::options::NatsAdapterConfig;
use std::sync::Arc;
use std::sync::OnceLock;
use std::sync::atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering};
use std::time::Duration;
use tokio::sync::Notify;
use tracing::{debug, error, info, warn};

const NATS_SYS_SERVER_PING_SUBJECT: &str = "$SYS.REQ.SERVER.PING";

/// Metrics for tracking message processing and drops
#[derive(Debug, Default)]
pub struct TransportMetrics {
    pub messages_received: AtomicU64,
    pub messages_processed: AtomicU64,
    pub messages_dropped_parse_error: AtomicU64,
}

impl TransportMetrics {
    pub fn new() -> Self {
        Self::default()
    }

    #[inline]
    pub fn record_received(&self) {
        self.messages_received.fetch_add(1, Ordering::Relaxed);
    }

    #[inline]
    pub fn record_processed(&self) {
        self.messages_processed.fetch_add(1, Ordering::Relaxed);
    }

    #[inline]
    pub fn record_parse_error(&self) {
        self.messages_dropped_parse_error
            .fetch_add(1, Ordering::Relaxed);
    }

    pub fn snapshot(&self) -> (u64, u64, u64) {
        (
            self.messages_received.load(Ordering::Relaxed),
            self.messages_processed.load(Ordering::Relaxed),
            self.messages_dropped_parse_error.load(Ordering::Relaxed),
        )
    }
}

/// NATS transport implementation
pub struct NatsTransport {
    client: NatsClient,
    broadcast_subject: String,
    request_subject: String,
    response_subject: String,
    config: NatsAdapterConfig,
    /// Metrics for tracking message processing
    metrics: Arc<TransportMetrics>,
    metrics_driver: Arc<OnceLock<Arc<dyn MetricsInterface + Send + Sync>>>,
    shutdown: Arc<Notify>,
    is_running: Arc<AtomicBool>,
    owner_count: Arc<AtomicUsize>,
}

impl NatsTransport {
    /// Get transport metrics for monitoring
    pub fn get_metrics(&self) -> Arc<TransportMetrics> {
        self.metrics.clone()
    }

    async fn discover_node_count_via_system_ping(&self) -> Result<Option<usize>> {
        let reply_subject = self.client.new_inbox();
        let mut responses = self
            .client
            .subscribe(reply_subject.clone())
            .await
            .map_err(|e| Error::Internal(format!("Failed to subscribe for NATS discovery: {e}")))?;

        self.client
            .publish_with_reply(
                Subject::from(NATS_SYS_SERVER_PING_SUBJECT),
                reply_subject,
                Bytes::new(),
            )
            .await
            .map_err(|e| {
                Error::Internal(format!("Failed to publish NATS discovery request: {e}"))
            })?;

        let max_wait_ms = self.config.request_timeout_ms.clamp(
            self.config.discovery_idle_wait_ms,
            self.config.discovery_max_wait_ms,
        );
        let max_wait = Duration::from_millis(max_wait_ms);
        let idle_wait = Duration::from_millis(self.config.discovery_idle_wait_ms);
        let start = tokio::time::Instant::now();
        let mut count = 0usize;

        loop {
            let elapsed = start.elapsed();
            if elapsed >= max_wait {
                break;
            }

            let remaining = max_wait.saturating_sub(elapsed);
            let wait_for = if count == 0 {
                remaining
            } else {
                remaining.min(idle_wait)
            };

            match tokio::time::timeout(wait_for, responses.next()).await {
                Ok(Some(_message)) => count += 1,
                Ok(None) | Err(_) => break,
            }
        }

        if count > 0 {
            debug!("Detected {} NATS server(s) via system ping", count);
            Ok(Some(count))
        } else {
            debug!(
                "NATS system discovery returned no responses; falling back to configured/default node count"
            );
            Ok(None)
        }
    }
}

impl TransportConfig for NatsAdapterConfig {
    fn request_timeout_ms(&self) -> u64 {
        self.request_timeout_ms
    }

    fn prefix(&self) -> &str {
        &self.prefix
    }
}

#[async_trait]
impl HorizontalTransport for NatsTransport {
    type Config = NatsAdapterConfig;

    async fn new(config: Self::Config) -> Result<Self> {
        info!(
            "NATS transport config: servers={:?}, prefix={}, request_timeout={}ms, connection_timeout={}ms",
            config.servers, config.prefix, config.request_timeout_ms, config.connection_timeout_ms
        );
        debug!(
            "NATS transport credentials: username={:?}, password={:?}, token={:?}",
            config.username, config.password, config.token
        );

        // Build NATS Options
        let mut nats_options = NatsOptions::new();

        // Set credentials conditionally
        if let (Some(username), Some(password)) =
            (config.username.as_deref(), config.password.as_deref())
        {
            nats_options =
                nats_options.user_and_password(username.to_string(), password.to_string());
        } else if let Some(token) = config.token.as_deref() {
            nats_options = nats_options.token(token.to_string());
        }

        // Set connection timeout
        nats_options =
            nats_options.connection_timeout(Duration::from_millis(config.connection_timeout_ms));

        // Connect to NATS
        let client = nats_options
            .connect(&config.servers)
            .await
            .map_err(|e| Error::Internal(format!("Failed to connect to NATS: {e}")))?;

        // Build subject names
        let broadcast_subject = format!("{}.broadcast", config.prefix);
        let request_subject = format!("{}.requests", config.prefix);
        let response_subject = format!("{}.responses", config.prefix);

        Ok(Self {
            client,
            broadcast_subject,
            request_subject,
            response_subject,
            config,
            metrics: Arc::new(TransportMetrics::new()),
            metrics_driver: Arc::new(OnceLock::new()),
            shutdown: Arc::new(Notify::new()),
            is_running: Arc::new(AtomicBool::new(true)),
            owner_count: Arc::new(AtomicUsize::new(1)),
        })
    }

    async fn publish_broadcast(&self, message: &BroadcastMessage) -> Result<()> {
        let message_data = sonic_rs::to_vec(message)
            .map_err(|e| Error::Other(format!("Failed to serialize broadcast message: {e}")))?;

        self.client
            .publish(
                Subject::from(self.broadcast_subject.clone()),
                message_data.into(),
            )
            .await
            .map_err(|e| Error::Internal(format!("Failed to publish broadcast: {e}")))?;

        debug!("Published broadcast message via NATS");
        Ok(())
    }

    async fn publish_request(&self, request: &RequestBody) -> Result<()> {
        let request_data = sonic_rs::to_vec(request)
            .map_err(|e| Error::Other(format!("Failed to serialize request: {e}")))?;

        self.client
            .publish(
                Subject::from(self.request_subject.clone()),
                request_data.into(),
            )
            .await
            .map_err(|e| Error::Internal(format!("Failed to publish request: {e}")))?;

        debug!("Broadcasted request {} via NATS", request.request_id);
        Ok(())
    }

    async fn publish_response(&self, response: &ResponseBody) -> Result<()> {
        let response_data = sonic_rs::to_vec(response)
            .map_err(|e| Error::Other(format!("Failed to serialize response: {e}")))?;

        self.client
            .publish(
                Subject::from(self.response_subject.clone()),
                response_data.into(),
            )
            .await
            .map_err(|e| Error::Internal(format!("Failed to publish response: {e}")))?;

        debug!("Published response via NATS");
        Ok(())
    }

    async fn start_listeners(&self, handlers: TransportHandlers) -> Result<()> {
        let client = self.client.clone();
        let broadcast_subject = self.broadcast_subject.clone();
        let request_subject = self.request_subject.clone();
        let response_subject = self.response_subject.clone();
        let response_client = self.client.clone();
        let metrics_broadcast = self.metrics.clone();
        let metrics_request = self.metrics.clone();
        let metrics_response = self.metrics.clone();
        let metrics_driver_broadcast = self.metrics_driver.clone();
        let metrics_driver_request = self.metrics_driver.clone();
        let metrics_driver_response = self.metrics_driver.clone();
        let shutdown_broadcast = self.shutdown.clone();
        let shutdown_request = self.shutdown.clone();
        let shutdown_response = self.shutdown.clone();
        let running_broadcast = self.is_running.clone();
        let running_request = self.is_running.clone();
        let running_response = self.is_running.clone();

        // Subscribe to broadcast channel
        let mut broadcast_subscription = client
            .subscribe(Subject::from(broadcast_subject.clone()))
            .await
            .map_err(|e| {
                Error::Internal(format!("Failed to subscribe to broadcast subject: {e}"))
            })?;

        // Subscribe to requests channel
        let mut request_subscription = client
            .subscribe(Subject::from(request_subject.clone()))
            .await
            .map_err(|e| Error::Internal(format!("Failed to subscribe to request subject: {e}")))?;

        // Subscribe to responses channel
        let mut response_subscription = client
            .subscribe(Subject::from(response_subject.clone()))
            .await
            .map_err(|e| {
                Error::Internal(format!("Failed to subscribe to response subject: {e}"))
            })?;

        info!(
            "NATS transport listening on subjects: {}, {}, {}",
            broadcast_subject, request_subject, response_subject
        );

        // Spawn a task to handle broadcast messages
        let broadcast_handler = handlers.on_broadcast.clone();
        tokio::spawn(async move {
            loop {
                if !running_broadcast.load(Ordering::Relaxed) {
                    break;
                }
                let msg = tokio::select! {
                    _ = shutdown_broadcast.notified() => break,
                    msg = broadcast_subscription.next() => msg,
                };
                let Some(msg) = msg else {
                    break;
                };
                metrics_broadcast.record_received();
                match sonic_rs::from_slice::<BroadcastMessage>(&msg.payload) {
                    Ok(broadcast) => {
                        broadcast_handler(broadcast).await;
                        metrics_broadcast.record_processed();
                    }
                    Err(e) => {
                        metrics_broadcast.record_parse_error();
                        if let Some(metrics) = metrics_driver_broadcast.get() {
                            metrics.mark_horizontal_transport_message_dropped("nats");
                        }
                        let payload_preview =
                            String::from_utf8_lossy(&msg.payload[..msg.payload.len().min(200)]);
                        error!(
                            "Failed to parse broadcast message: {} - payload preview: {}",
                            e, payload_preview
                        );
                    }
                }
            }
            warn!("Broadcast subscription ended unexpectedly");
        });

        // Spawn a task to handle request messages
        let request_handler = handlers.on_request.clone();
        tokio::spawn(async move {
            loop {
                if !running_request.load(Ordering::Relaxed) {
                    break;
                }
                let msg = tokio::select! {
                    _ = shutdown_request.notified() => break,
                    msg = request_subscription.next() => msg,
                };
                let Some(msg) = msg else {
                    break;
                };
                metrics_request.record_received();
                match sonic_rs::from_slice::<RequestBody>(&msg.payload) {
                    Ok(request) => {
                        let response_result = request_handler(request).await;

                        if let Ok(response) = response_result
                            && let Ok(response_data) = sonic_rs::to_vec(&response)
                            && let Err(e) = response_client
                                .publish(
                                    Subject::from(response_subject.clone()),
                                    response_data.into(),
                                )
                                .await
                        {
                            warn!("Failed to publish response: {}", e);
                        }
                        metrics_request.record_processed();
                    }
                    Err(e) => {
                        metrics_request.record_parse_error();
                        if let Some(metrics) = metrics_driver_request.get() {
                            metrics.mark_horizontal_transport_message_dropped("nats");
                        }
                        let payload_preview =
                            String::from_utf8_lossy(&msg.payload[..msg.payload.len().min(200)]);
                        error!(
                            "Failed to parse request message: {} - payload preview: {}",
                            e, payload_preview
                        );
                    }
                }
            }
            warn!("Request subscription ended unexpectedly");
        });

        // Spawn a task to handle response messages
        let response_handler = handlers.on_response.clone();
        tokio::spawn(async move {
            loop {
                if !running_response.load(Ordering::Relaxed) {
                    break;
                }
                let msg = tokio::select! {
                    _ = shutdown_response.notified() => break,
                    msg = response_subscription.next() => msg,
                };
                let Some(msg) = msg else {
                    break;
                };
                metrics_response.record_received();
                match sonic_rs::from_slice::<ResponseBody>(&msg.payload) {
                    Ok(response) => {
                        response_handler(response).await;
                        metrics_response.record_processed();
                    }
                    Err(e) => {
                        metrics_response.record_parse_error();
                        if let Some(metrics) = metrics_driver_response.get() {
                            metrics.mark_horizontal_transport_message_dropped("nats");
                        }
                        let payload_preview =
                            String::from_utf8_lossy(&msg.payload[..msg.payload.len().min(200)]);
                        error!(
                            "Failed to parse response message: {} - payload preview: {}",
                            e, payload_preview
                        );
                    }
                }
            }
            warn!("Response subscription ended unexpectedly");
        });

        Ok(())
    }

    async fn get_node_count(&self) -> Result<usize> {
        // If nodes_number is explicitly set, use that value
        if let Some(nodes) = self.config.nodes_number {
            return Ok(nodes as usize);
        }

        match self.discover_node_count_via_system_ping().await {
            Ok(Some(nodes)) => Ok(nodes.max(1)),
            Ok(None) => Ok(1),
            Err(error) => {
                warn!(
                    "NATS node discovery via system ping failed: {}. Falling back to 1 node",
                    error
                );
                Ok(1)
            }
        }
    }

    async fn check_health(&self) -> Result<()> {
        // Check if the NATS client connection is still active
        // NATS client maintains internal health state
        let state = self.client.connection_state();
        match state {
            async_nats::connection::State::Connected => Ok(()),
            async_nats::connection::State::Disconnected => Err(
                sockudo_core::error::Error::Connection("NATS client is disconnected".to_string()),
            ),
            other_state => Err(sockudo_core::error::Error::Connection(format!(
                "NATS client in transitional state: {other_state:?}"
            ))),
        }
    }

    fn set_metrics(&self, metrics: Arc<dyn MetricsInterface + Send + Sync>) {
        let _ = self.metrics_driver.set(metrics);
    }
}

impl Drop for NatsTransport {
    fn drop(&mut self) {
        if self.owner_count.fetch_sub(1, Ordering::AcqRel) == 1 {
            self.is_running.store(false, Ordering::Relaxed);
            self.shutdown.notify_waiters();
        }
    }
}

impl Clone for NatsTransport {
    fn clone(&self) -> Self {
        self.owner_count.fetch_add(1, Ordering::Relaxed);
        Self {
            client: self.client.clone(),
            broadcast_subject: self.broadcast_subject.clone(),
            request_subject: self.request_subject.clone(),
            response_subject: self.response_subject.clone(),
            config: self.config.clone(),
            metrics: self.metrics.clone(),
            metrics_driver: self.metrics_driver.clone(),
            shutdown: self.shutdown.clone(),
            is_running: self.is_running.clone(),
            owner_count: self.owner_count.clone(),
        }
    }
}