knafeh 1.1.0

QUIC-based RPC library with Python bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
pub mod pool;
pub mod retry;

use std::sync::atomic::Ordering;
use std::sync::Arc;
use std::time::Duration;

use futures::SinkExt;

use crate::codec::{Codec, DefaultCodec};
use crate::error::{KnafehError, RpcStatusCode};
use crate::rpc::message::{Metadata, RpcRequest, RpcResponse, RpcStatus};
use crate::rpc::middleware::{Interceptor, MiddlewareStack};
use crate::rpc::stream::{rpc_stream_channel, RpcStreamReceiver};
use crate::transport::connection::{
    validate_metadata_key, RPC_HEADER_PREFIX, RPC_STATUS_HEADER, RPC_STATUS_MESSAGE_HEADER,
};
use crate::transport::tls::TlsConfig;

use tokio_quiche::buf_factory::BufFactory;
use tokio_quiche::http3::driver::{InboundFrame, NewClientRequest, OutboundFrame};

use self::pool::{ClientConnectionPool, ConnectionGuard, H3Response};
use self::retry::RetryPolicy;

/// An RPC client that connects to a Knafeh server over QUIC/HTTP3.
pub struct Client {
    pool: Arc<ClientConnectionPool>,
    codec: Arc<dyn Codec>,
    middleware: Arc<MiddlewareStack>,
    retry_policy: RetryPolicy,
}

impl Client {
    /// Create a new client builder.
    pub fn builder() -> ClientBuilder {
        ClientBuilder::new()
    }

    /// Make a unary RPC call.
    pub async fn call(&self, method: &str, body: Vec<u8>) -> Result<RpcResponse, KnafehError> {
        self.call_with_metadata(method, body, Metadata::new()).await
    }

    /// Make a unary RPC call with metadata.
    pub async fn call_with_metadata(
        &self,
        method: &str,
        body: Vec<u8>,
        metadata: Metadata,
    ) -> Result<RpcResponse, KnafehError> {
        let encoded_body = self.codec.encode(&body)?;

        let mut request = RpcRequest {
            method: method.to_string(),
            metadata,
            body: encoded_body,
        };

        self.middleware.apply_request(&mut request).await?;
        validate_metadata(&request.metadata)?;
        let call_timeout = request_timeout(&request.metadata)?;
        let deadline = call_timeout.map(|timeout| tokio::time::Instant::now() + timeout);

        let mut last_error = None;
        let max_attempts = self.retry_policy.max_retries + 1;

        for attempt in 0..max_attempts {
            if attempt > 0 {
                let backoff = self.retry_policy.backoff_for(attempt - 1);
                tracing::debug!(
                    method = method,
                    attempt = attempt,
                    backoff_ms = backoff.as_millis() as u64,
                    "retrying RPC call"
                );
                if let Some(deadline) = deadline {
                    let now = tokio::time::Instant::now();
                    if now >= deadline {
                        return Err(KnafehError::Timeout);
                    }
                    tokio::time::sleep_until(std::cmp::min(now + backoff, deadline)).await;
                    if tokio::time::Instant::now() >= deadline {
                        return Err(KnafehError::Timeout);
                    }
                } else {
                    tokio::time::sleep(backoff).await;
                }
            }

            let attempt_result = match deadline {
                Some(deadline) => tokio::time::timeout_at(deadline, self.execute_call(&request))
                    .await
                    .map_err(|_| KnafehError::Timeout),
                None => Ok(self.execute_call(&request).await),
            };

            match attempt_result {
                Ok(Ok(mut response)) => {
                    // Retry on retryable response status codes (e.g., Unavailable).
                    if RetryPolicy::is_retryable_status(response.status.code)
                        && attempt + 1 < max_attempts
                    {
                        tracing::warn!(
                            method = method,
                            attempt = attempt,
                            status = ?response.status.code,
                            "retryable status"
                        );
                        last_error = Some(KnafehError::Service {
                            code: response.status.code,
                            message: response.status.message.clone(),
                        });
                        continue;
                    }

                    self.middleware.apply_response(&mut response).await?;

                    if response.status.is_ok() {
                        response.body = self.codec.decode(&response.body)?;
                    }
                    return Ok(response);
                }
                Ok(Err(e)) | Err(e) => {
                    if RetryPolicy::is_retryable(&e) && attempt + 1 < max_attempts {
                        tracing::warn!(
                            method = method,
                            attempt = attempt,
                            error = %e,
                            "retryable error"
                        );
                        last_error = Some(e);
                        continue;
                    }
                    return Err(e);
                }
            }
        }

        Err(last_error.unwrap_or(KnafehError::Transport("all retries exhausted".to_string())))
    }

    /// Initiate a server-streaming RPC call.
    ///
    /// Sends the request and returns a receiver that yields decoded response
    /// chunks as they arrive from the server.
    pub async fn server_stream(
        &self,
        method: &str,
        body: Vec<u8>,
    ) -> Result<RpcStreamReceiver, KnafehError> {
        let encoded_body = self.codec.encode(&body)?;

        let mut request = RpcRequest {
            method: method.to_string(),
            metadata: Metadata::new(),
            body: encoded_body,
        };

        self.middleware.apply_request(&mut request).await?;
        validate_metadata(&request.metadata)?;

        let conn_handle = self.pool.acquire().await?;
        let guard = ConnectionGuard::new(Arc::clone(&self.pool), conn_handle.id);

        let request_id = conn_handle
            .inner
            .next_request_id
            .fetch_add(1, Ordering::Relaxed);

        // Register as a streaming request so the event loop hands off the
        // recv channel instead of buffering all frames.
        let (response_tx, response_rx) = tokio::sync::oneshot::channel();
        conn_handle
            .inner
            .register_pending_stream(request_id, response_tx)
            .await;
        let mut pending_guard =
            PendingRequestGuard::streaming(Arc::clone(&conn_handle.inner), request_id);

        // Build headers with server_streaming method kind.
        let h3_headers = self.build_h3_request_headers(&request, "server_streaming");

        let (body_writer, body_rx_opt) = if !request.body.is_empty() {
            let (tx, rx) = tokio::sync::oneshot::channel();
            (Some(tx), Some(rx))
        } else {
            (None, None)
        };

        if conn_handle
            .inner
            .request_sender
            .send(NewClientRequest {
                request_id,
                headers: h3_headers,
                body_writer,
            })
            .is_err()
        {
            return Err(KnafehError::ConnectionClosed);
        }

        // Send request body if present.
        if let Some(body_rx) = body_rx_opt {
            let frame_sender_result = body_rx.await;
            if frame_sender_result.is_err() {
                return Err(KnafehError::ConnectionClosed);
            }
            let mut frame_sender = frame_sender_result.unwrap();
            let buf = BufFactory::buf_from_slice(&request.body);
            if frame_sender
                .send(OutboundFrame::body(buf, true))
                .await
                .is_err()
            {
                return Err(KnafehError::ConnectionClosed);
            }
        }

        // Wait for the initial response headers + recv channel.
        let h3_response = response_rx
            .await
            .map_err(|_| KnafehError::ConnectionClosed)??;
        pending_guard.disarm();

        let (headers, mut recv, read_fin) = match h3_response {
            H3Response::Streaming {
                headers,
                recv,
                read_fin,
            } => (headers, recv, read_fin),
            _ => return Err(KnafehError::Transport("expected streaming response".into())),
        };

        // Check response status.
        let status_code = parse_status_from_headers(&headers)?;
        if status_code != RpcStatusCode::Ok {
            let msg = parse_status_message_from_headers(&headers);
            return Err(KnafehError::Service {
                code: status_code,
                message: msg,
            });
        }

        // Spawn a background task that reads frames and pushes decoded chunks.
        let (stream_tx, stream_rx) = rpc_stream_channel(32);
        let codec = Arc::clone(&self.codec);
        // Transfer connection ownership to the background task.
        let (pool, conn_id) = guard.detach();

        tokio::spawn(async move {
            use bytes::BytesMut;

            use crate::transport::quic_wire::MAX_MESSAGE_SIZE as MAX_CHUNK_SIZE;

            // Accumulate body bytes and extract length-prefixed messages.
            // Uses BytesMut with split_to for O(1) advance instead of
            // Vec::drain which shifts bytes each time.
            let mut accum = BytesMut::new();

            if !read_fin {
                while let Some(frame) = recv.recv().await {
                    if let InboundFrame::Body(data, fin) = frame {
                        accum.extend_from_slice(&data);

                        // Extract complete length-prefixed messages.
                        while accum.len() >= 4 {
                            let len = u32::from_be_bytes([accum[0], accum[1], accum[2], accum[3]])
                                as usize;

                            if len > MAX_CHUNK_SIZE {
                                let _ = stream_tx
                                    .send_error(KnafehError::InvalidMessage(format!(
                                        "stream chunk size {len} exceeds maximum {MAX_CHUNK_SIZE}"
                                    )))
                                    .await;
                                pool.release(conn_id);
                                return;
                            }

                            if accum.len() < 4 + len {
                                break; // Incomplete message, wait for more data.
                            }
                            let _ = accum.split_to(4); // consume length prefix
                            let chunk = accum.split_to(len).to_vec();

                            match codec.decode(&chunk) {
                                Ok(decoded) => {
                                    if stream_tx.send(decoded).await.is_err() {
                                        pool.release(conn_id);
                                        return;
                                    }
                                }
                                Err(e) => {
                                    let _ = stream_tx.send_error(e).await;
                                    pool.release(conn_id);
                                    return;
                                }
                            }
                        }

                        if fin {
                            // Surface error if there are leftover bytes
                            // (truncated frame).
                            if !accum.is_empty() {
                                let _ = stream_tx
                                    .send_error(KnafehError::InvalidMessage(format!(
                                        "stream ended with {} incomplete bytes",
                                        accum.len()
                                    )))
                                    .await;
                            }
                            break;
                        }
                    }
                }
            }
            drop(stream_tx);
            pool.release(conn_id);
        });

        Ok(stream_rx)
    }

    /// Build the full HTTP/3 header list for an RPC request.
    fn build_h3_request_headers(
        &self,
        request: &RpcRequest,
        method_kind: &str,
    ) -> Vec<quiche::h3::Header> {
        let mut headers = vec![
            quiche::h3::Header::new(b":method", b"POST"),
            quiche::h3::Header::new(b":scheme", b"https"),
            quiche::h3::Header::new(b":authority", self.pool.hostname().as_bytes()),
            quiche::h3::Header::new(b":path", format!("/{}", request.method).as_bytes()),
            quiche::h3::Header::new(b"content-type", self.codec.content_type().as_bytes()),
            quiche::h3::Header::new(b"x-rpc-method-kind", method_kind.as_bytes()),
        ];

        for (key, value) in &request.metadata {
            let header_key = if key.starts_with("x-rpc-") {
                key.clone()
            } else {
                format!("x-rpc-{key}")
            };
            headers.push(quiche::h3::Header::new(
                header_key.as_bytes(),
                value.as_bytes(),
            ));
        }

        headers
    }

    /// Internal: execute a single unary RPC call on a pooled connection.
    async fn execute_call(&self, request: &RpcRequest) -> Result<RpcResponse, KnafehError> {
        let conn_handle = self.pool.acquire().await?;
        let _guard = ConnectionGuard::new(Arc::clone(&self.pool), conn_handle.id);

        let request_id = conn_handle
            .inner
            .next_request_id
            .fetch_add(1, Ordering::Relaxed);

        let (response_tx, response_rx) = tokio::sync::oneshot::channel();

        conn_handle
            .inner
            .register_pending(request_id, response_tx)
            .await;
        let mut pending_guard =
            PendingRequestGuard::unary(Arc::clone(&conn_handle.inner), request_id);

        let h3_headers = self.build_h3_request_headers(request, "unary");

        let (body_writer, body_rx_opt) = if !request.body.is_empty() {
            let (tx, rx) = tokio::sync::oneshot::channel();
            (Some(tx), Some(rx))
        } else {
            (None, None)
        };

        if conn_handle
            .inner
            .request_sender
            .send(NewClientRequest {
                request_id,
                headers: h3_headers,
                body_writer,
            })
            .is_err()
        {
            return Err(KnafehError::ConnectionClosed);
        }

        if let Some(body_rx) = body_rx_opt {
            let frame_sender_result = body_rx.await;
            if frame_sender_result.is_err() {
                return Err(KnafehError::ConnectionClosed);
            }
            let mut frame_sender = frame_sender_result.unwrap();
            let buf = BufFactory::buf_from_slice(&request.body);
            if frame_sender
                .send(OutboundFrame::body(buf, true))
                .await
                .is_err()
            {
                return Err(KnafehError::ConnectionClosed);
            }
        }

        let h3_response = response_rx
            .await
            .map_err(|_| KnafehError::ConnectionClosed)??;
        pending_guard.disarm();

        match h3_response {
            H3Response::Complete { headers, body } => parse_h3_response(headers, body),
            _ => Err(KnafehError::Transport("expected unary response".into())),
        }
    }

    /// Get a reference to the connection pool.
    pub fn pool(&self) -> &ClientConnectionPool {
        &self.pool
    }
}

enum PendingRequestKind {
    Unary,
    Streaming,
}

struct PendingRequestGuard {
    inner: Arc<pool::ConnectionInner>,
    request_id: u64,
    kind: PendingRequestKind,
    armed: bool,
}

impl PendingRequestGuard {
    fn unary(inner: Arc<pool::ConnectionInner>, request_id: u64) -> Self {
        Self {
            inner,
            request_id,
            kind: PendingRequestKind::Unary,
            armed: true,
        }
    }

    fn streaming(inner: Arc<pool::ConnectionInner>, request_id: u64) -> Self {
        Self {
            inner,
            request_id,
            kind: PendingRequestKind::Streaming,
            armed: true,
        }
    }

    fn disarm(&mut self) {
        self.armed = false;
    }
}

impl Drop for PendingRequestGuard {
    fn drop(&mut self) {
        if !self.armed {
            return;
        }

        let inner = Arc::clone(&self.inner);
        let request_id = self.request_id;
        let Ok(handle) = tokio::runtime::Handle::try_current() else {
            tracing::debug!(
                request_id,
                "pending request cleanup skipped outside Tokio runtime"
            );
            return;
        };

        match self.kind {
            PendingRequestKind::Unary => {
                handle.spawn(async move {
                    inner.remove_pending(request_id).await;
                });
            }
            PendingRequestKind::Streaming => {
                handle.spawn(async move {
                    inner.remove_pending_stream(request_id).await;
                });
            }
        }
    }
}

fn request_timeout(metadata: &Metadata) -> Result<Option<Duration>, KnafehError> {
    let Some(value) = metadata.get("x-rpc-timeout-ms") else {
        return Ok(None);
    };

    let millis = value.parse::<u64>().map_err(|e| {
        KnafehError::InvalidMessage(format!("invalid x-rpc-timeout-ms metadata: {e}"))
    })?;

    Ok(Some(Duration::from_millis(millis)))
}

// ---------------------------------------------------------------------------
// Response parsing helpers
// ---------------------------------------------------------------------------

fn parse_h3_response(
    headers: Vec<quiche::h3::Header>,
    body: Vec<u8>,
) -> Result<RpcResponse, KnafehError> {
    let status_code = parse_status_from_headers(&headers)?;
    let status_message = parse_status_message_from_headers(&headers);
    let metadata = parse_metadata_from_headers(&headers);

    Ok(RpcResponse {
        status: RpcStatus {
            code: status_code,
            message: status_message,
        },
        metadata,
        body,
    })
}

fn parse_status_from_headers(headers: &[quiche::h3::Header]) -> Result<RpcStatusCode, KnafehError> {
    use quiche::h3::NameValue;
    let status_bytes = RPC_STATUS_HEADER.as_bytes();
    for h in headers {
        if h.name() == status_bytes {
            // Parse single-byte or two-byte ASCII number without String allocation.
            let val = h.value();
            let s = std::str::from_utf8(val).map_err(|e| {
                KnafehError::InvalidMessage(format!("invalid RPC status header UTF-8: {e}"))
            })?;
            let code = s.parse::<u8>().map_err(|e| {
                KnafehError::InvalidMessage(format!("invalid RPC status header value: {e}"))
            })?;
            return Ok(RpcStatusCode::from_u8(code));
        }
    }
    Err(KnafehError::InvalidMessage(format!(
        "missing required {RPC_STATUS_HEADER} header"
    )))
}

fn parse_status_message_from_headers(headers: &[quiche::h3::Header]) -> String {
    use quiche::h3::NameValue;
    let msg_bytes = RPC_STATUS_MESSAGE_HEADER.as_bytes();
    for h in headers {
        if h.name() == msg_bytes {
            return String::from_utf8_lossy(h.value()).into_owned();
        }
    }
    String::new()
}

fn parse_metadata_from_headers(headers: &[quiche::h3::Header]) -> Metadata {
    use quiche::h3::NameValue;
    let prefix = RPC_HEADER_PREFIX.as_bytes();
    let status_bytes = RPC_STATUS_HEADER.as_bytes();
    let msg_bytes = RPC_STATUS_MESSAGE_HEADER.as_bytes();
    let mut metadata = Metadata::new();
    for h in headers {
        let name = h.name();
        // Skip status headers.
        if name == status_bytes || name == msg_bytes {
            continue;
        }
        if name.starts_with(prefix) {
            // Only allocate Strings for actual metadata entries.
            let key = String::from_utf8_lossy(&name[prefix.len()..]).into_owned();
            let value = String::from_utf8_lossy(h.value()).into_owned();
            metadata.insert(key, value);
        }
    }
    metadata
}

fn validate_metadata(metadata: &Metadata) -> Result<(), KnafehError> {
    for key in metadata.keys() {
        validate_metadata_key(key)?;
    }
    Ok(())
}

// ---------------------------------------------------------------------------
// Builder
// ---------------------------------------------------------------------------

/// Builder for configuring and constructing a [`Client`].
pub struct ClientBuilder {
    endpoint: Option<String>,
    tls_config: Option<TlsConfig>,
    codec: Option<Arc<dyn Codec>>,
    middleware: MiddlewareStack,
    pool_size: usize,
    retry_policy: RetryPolicy,
}

impl ClientBuilder {
    fn new() -> Self {
        Self {
            endpoint: None,
            tls_config: None,
            codec: None,
            middleware: MiddlewareStack::new(),
            pool_size: 4,
            retry_policy: RetryPolicy::none(),
        }
    }

    /// Set the server endpoint (e.g., `"localhost:4433"`).
    pub fn endpoint(mut self, endpoint: impl Into<String>) -> Self {
        self.endpoint = Some(endpoint.into());
        self
    }

    /// Set the TLS configuration.
    pub fn tls(mut self, config: TlsConfig) -> Self {
        self.tls_config = Some(config);
        self
    }

    /// Set the codec for request/response serialization.
    pub fn codec(mut self, codec: impl Codec) -> Self {
        self.codec = Some(Arc::new(codec));
        self
    }

    /// Add an interceptor to the middleware stack.
    pub fn add_interceptor(mut self, interceptor: impl Interceptor) -> Self {
        self.middleware.add(Arc::new(interceptor));
        self
    }

    /// Set the connection pool size.
    pub fn pool_size(mut self, size: usize) -> Self {
        self.pool_size = size;
        self
    }

    /// Set the retry policy.
    pub fn retry(mut self, policy: RetryPolicy) -> Self {
        self.retry_policy = policy;
        self
    }

    /// Build the client.
    pub async fn build(self) -> Result<Client, KnafehError> {
        let endpoint = self
            .endpoint
            .ok_or_else(|| KnafehError::Transport("endpoint is required".to_string()))?;

        let tls_config = self.tls_config.unwrap_or_else(TlsConfig::client_insecure);

        let codec = self.codec.unwrap_or_else(|| Arc::new(DefaultCodec::new()));

        let pool = Arc::new(ClientConnectionPool::new(
            endpoint,
            self.pool_size,
            tls_config,
        ));

        Ok(Client {
            pool,
            codec,
            middleware: Arc::new(self.middleware),
            retry_policy: self.retry_policy,
        })
    }
}

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

    #[test]
    fn request_timeout_only_uses_reserved_timeout_header() {
        let mut metadata = Metadata::new();
        metadata.insert("timeout-ms".to_string(), "5".to_string());
        assert_eq!(request_timeout(&metadata).unwrap(), None);

        metadata.insert("x-rpc-timeout-ms".to_string(), "7".to_string());
        assert_eq!(
            request_timeout(&metadata).unwrap(),
            Some(Duration::from_millis(7))
        );
    }
}