rpcnet 0.1.0

RPC library based on QUIC+TLS encryption
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
//! Code generator using quote and proc-macro2.

use crate::codegen::parser::{ServiceDefinition, ServiceType};
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::{FnArg, GenericArgument, PathArguments, ReturnType, Type};

/// Code generator for creating server and client implementations.
pub struct CodeGenerator {
    definition: ServiceDefinition,
}

impl CodeGenerator {
    /// Creates a new code generator with the given service definition.
    pub fn new(definition: ServiceDefinition) -> Self {
        Self { definition }
    }

    /// Generates the server implementation.
    pub fn generate_server(&self) -> TokenStream {
        let trait_name = &self.definition.service_trait.ident;
        let server_name = format_ident!("{}Server", trait_name);
        let handler_trait = format_ident!("{}Handler", trait_name);

        let methods = self.definition.methods();
        let handler_methods = self.generate_handler_methods(&methods);
        let register_methods = self.generate_register_methods(&methods, trait_name);

        // Check if any method uses streaming to add necessary imports
        let has_streaming = methods
            .iter()
            .any(|m| self.is_streaming_request(m) || self.is_streaming_response(m));

        let stream_imports = if has_streaming {
            quote! {
                use futures::Stream;
                use std::pin::Pin;
            }
        } else {
            quote! {}
        };

        quote! {
            use super::types::*;
            use rpcnet::{RpcServer, RpcConfig, RpcError};
            use async_trait::async_trait;
            use std::sync::Arc;
            #stream_imports

            /// Handler trait that users implement for the service.
            #[async_trait]
            pub trait #handler_trait: Send + Sync + 'static {
                #(#handler_methods)*
            }

            /// Generated server that manages RPC registration and routing.
            pub struct #server_name<H: #handler_trait> {
                handler: Arc<H>,
                pub rpc_server: RpcServer,
            }

            impl<H: #handler_trait> #server_name<H> {
                /// Creates a new server with the given handler and configuration.
                pub fn new(handler: H, config: RpcConfig) -> Self {
                    Self {
                        handler: Arc::new(handler),
                        rpc_server: RpcServer::new(config),
                    }
                }

                /// Registers all service methods with the RPC server.
                pub async fn register_all(&mut self) {
                    #(#register_methods)*
                }

                /// Starts the server and begins accepting connections.
                pub async fn serve(mut self) -> Result<(), RpcError> {
                    self.register_all().await;
                    let quic_server = self.rpc_server.bind()?;
                    println!("Server listening on: {:?}", self.rpc_server.socket_addr);
                    self.rpc_server.start(quic_server).await
                }
            }
        }
    }

    /// Generates the client implementation.
    pub fn generate_client(&self) -> TokenStream {
        let trait_name = &self.definition.service_trait.ident;
        let client_name = format_ident!("{}Client", trait_name);

        let methods = self.definition.methods();
        let client_methods = self.generate_client_methods(&methods, trait_name);

        // Check if any method uses streaming to add necessary imports
        let has_streaming = methods
            .iter()
            .any(|m| self.is_streaming_request(m) || self.is_streaming_response(m));

        let stream_imports = if has_streaming {
            quote! {
                use futures::Stream;
                use std::pin::Pin;
            }
        } else {
            quote! {}
        };

        quote! {
            use super::types::*;
            use rpcnet::{RpcClient, RpcConfig, RpcError};
            use std::net::SocketAddr;
            #stream_imports

            /// Generated client for calling service methods.
            pub struct #client_name {
                inner: RpcClient,
            }

            impl #client_name {
                /// Connects to the service at the given address.
                pub async fn connect(addr: SocketAddr, config: RpcConfig) -> Result<Self, RpcError> {
                    let inner = RpcClient::connect(addr, config).await?;
                    Ok(Self { inner })
                }

                #(#client_methods)*
            }
        }
    }

    /// Generates type definitions.
    pub fn generate_types(&self) -> TokenStream {
        let mut type_tokens = Vec::new();

        // Add imports
        for import in &self.definition.imports {
            type_tokens.push(quote! { #import });
        }

        // Add type definitions
        for service_type in self.definition.types.values() {
            match service_type {
                ServiceType::Struct(item_struct) => {
                    type_tokens.push(quote! { #item_struct });
                }
                ServiceType::Enum(item_enum) => {
                    type_tokens.push(quote! { #item_enum });
                }
            }
        }

        quote! {
            //! Type definitions for the service.

            #(#type_tokens)*
        }
    }

    fn generate_handler_methods(&self, methods: &[&syn::TraitItemFn]) -> Vec<TokenStream> {
        methods
            .iter()
            .map(|method| {
                let sig = &method.sig;
                // For the handler trait, we need the exact signature from the service trait
                quote! {
                    #sig;
                }
            })
            .collect()
    }

    fn generate_register_methods(
        &self,
        methods: &[&syn::TraitItemFn],
        service_name: &syn::Ident,
    ) -> Vec<TokenStream> {
        methods
            .iter()
            .map(|method| {
                let method_name = &method.sig.ident;
                let method_str = method_name.to_string();
                let full_method_name = format!("{}.{}", service_name, method_str);

                let is_streaming_req = self.is_streaming_request(method);
                let is_streaming_resp = self.is_streaming_response(method);

                if is_streaming_req && is_streaming_resp {
                    #[allow(unused_variables)]
                    let (request_item_type, response_item_type) = self.extract_streaming_types(method);
                    quote! {
                        {
                            let handler = self.handler.clone();
                            self.rpc_server.register_streaming(#full_method_name, move |request_stream| {
                                let handler = handler.clone();
                                async move {
                                    use futures::StreamExt;

                                    let typed_request_stream = request_stream.map(|bytes| {
                                        bincode::deserialize::<#request_item_type>(&bytes).unwrap()
                                    });

                                    match handler.#method_name(Box::pin(typed_request_stream)).await {
                                        Ok(response_stream) => {
                                            let byte_response_stream = response_stream.map(|item| {
                                                Ok(bincode::serialize(&item).unwrap())
                                            });
                                            Box::pin(byte_response_stream) as Pin<Box<dyn Stream<Item = Result<Vec<u8>, RpcError>> + Send>>
                                        },
                                        Err(e) => {
                                            Box::pin(futures::stream::once(async move { Err(RpcError::StreamError(format!("{:?}", e))) }))
                                        }
                                    }
                                }
                            }).await;
                        }
                    }
                } else {
                    let request_type = self.extract_request_type(method);
                    quote! {
                        {
                            let handler = self.handler.clone();
                            self.rpc_server.register(#full_method_name, move |params| {
                                let handler = handler.clone();
                                async move {
                                    let request: #request_type = bincode::deserialize(&params)
                                        .map_err(RpcError::SerializationError)?;

                                    match handler.#method_name(request).await {
                                        Ok(response) => {
                                            bincode::serialize(&response)
                                                .map_err(RpcError::SerializationError)
                                        }
                                        Err(e) => {
                                            Err(RpcError::StreamError(format!("{:?}", e)))
                                        }
                                    }
                                }
                            }).await;
                        }
                    }
                }
            })
            .collect()
    }

    fn generate_client_methods(
        &self,
        methods: &[&syn::TraitItemFn],
        service_name: &syn::Ident,
    ) -> Vec<TokenStream> {
        methods
            .iter()
            .map(|method| {
                let method_name = &method.sig.ident;
                let method_str = method_name.to_string();
                let full_method_name = format!("{}.{}", service_name, method_str);

                let is_streaming_req = self.is_streaming_request(method);
                let is_streaming_resp = self.is_streaming_response(method);

                if is_streaming_req && is_streaming_resp {
                    #[allow(unused_variables)]
                    let (request_item_type, response_item_type) = self.extract_streaming_types(method);

                    // Build streaming client method
                    let mut client_sig = method.sig.clone();
                    if !client_sig.inputs.is_empty() {
                        client_sig.inputs[0] = syn::parse_quote!(&self);
                    }
                    let (response_type, _error_type) = self.extract_result_types(method);
                    client_sig.output = syn::parse_quote!(-> Result<#response_type, RpcError>);

                    // Extract the parameter name from the signature
                    let param_name = if let Some(FnArg::Typed(pat_type)) = method.sig.inputs.iter().nth(1) {
                        &pat_type.pat
                    } else {
                        panic!("Streaming method must have a request parameter");
                    };

                    quote! {
                        pub #client_sig {
                            use futures::StreamExt;

                            let byte_request_stream = #param_name.map(|item| {
                                bincode::serialize(&item).unwrap()
                            });

                            let byte_response_stream = self.inner.call_streaming(#full_method_name, Box::pin(byte_request_stream)).await?;

                            let typed_response_stream = byte_response_stream.map(|result| {
                                result.and_then(|bytes| {
                                    bincode::deserialize::<#response_item_type>(&bytes)
                                        .map_err(RpcError::SerializationError)
                                })
                            });

                            Ok(Box::pin(typed_response_stream))
                        }
                    }
                } else {
                    let _request_type = self.extract_request_type(method);
                    let (response_type, _error_type) = self.extract_result_types(method);

                    // Build the method signature for the client
                    let mut client_sig = method.sig.clone();
                    // Remove &self and replace with &self (client reference)
                    if !client_sig.inputs.is_empty() {
                        client_sig.inputs[0] = syn::parse_quote!(&self);
                    }
                    // Change return type to Result<ResponseType, RpcError>
                    client_sig.output = syn::parse_quote!(-> Result<#response_type, RpcError>);

                    quote! {
                        pub #client_sig {
                            let params = bincode::serialize(&request)
                                .map_err(RpcError::SerializationError)?;

                            let response_data = self.inner.call(#full_method_name, params).await?;

                            // Deserialize the response
                            bincode::deserialize::<#response_type>(&response_data)
                                .map_err(RpcError::SerializationError)
                        }
                    }
                }
            })
            .collect()
    }

    fn extract_request_type(&self, method: &syn::TraitItemFn) -> TokenStream {
        // Get the second parameter (first is &self)
        if let Some(FnArg::Typed(pat_type)) = method.sig.inputs.iter().nth(1) {
            let ty = &pat_type.ty;
            quote! { #ty }
        } else {
            quote! { () }
        }
    }

    fn extract_result_types(&self, method: &syn::TraitItemFn) -> (TokenStream, TokenStream) {
        // Parse the return type to extract T and E from Result<T, E>
        if let ReturnType::Type(_, ty) = &method.sig.output {
            if let Type::Path(type_path) = &**ty {
                if let Some(segment) = type_path.path.segments.last() {
                    if segment.ident == "Result" {
                        if let PathArguments::AngleBracketed(args) = &segment.arguments {
                            let mut args_iter = args.args.iter();

                            // Get T (response type)
                            let response_type =
                                if let Some(GenericArgument::Type(t)) = args_iter.next() {
                                    quote! { #t }
                                } else {
                                    quote! { () }
                                };

                            // Get E (error type)
                            let error_type =
                                if let Some(GenericArgument::Type(e)) = args_iter.next() {
                                    quote! { #e }
                                } else {
                                    quote! { String }
                                };

                            return (response_type, error_type);
                        }
                    }
                }
            }
        }

        (quote! { () }, quote! { String })
    }

    fn is_streaming_request(&self, method: &syn::TraitItemFn) -> bool {
        if let Some(FnArg::Typed(pat_type)) = method.sig.inputs.iter().nth(1) {
            self.type_contains_stream(&pat_type.ty)
        } else {
            false
        }
    }

    fn is_streaming_response(&self, method: &syn::TraitItemFn) -> bool {
        if let ReturnType::Type(_, ty) = &method.sig.output {
            self.type_contains_stream(ty)
        } else {
            false
        }
    }

    fn extract_streaming_types(&self, method: &syn::TraitItemFn) -> (TokenStream, TokenStream) {
        let request_item = if let Some(FnArg::Typed(pat_type)) = method.sig.inputs.iter().nth(1) {
            self.extract_stream_item_type(&pat_type.ty)
        } else {
            quote! { () }
        };

        let response_item = if let ReturnType::Type(_, ty) = &method.sig.output {
            if let Type::Path(type_path) = &**ty {
                if let Some(segment) = type_path.path.segments.last() {
                    if segment.ident == "Result" {
                        if let PathArguments::AngleBracketed(args) = &segment.arguments {
                            if let Some(GenericArgument::Type(ok_type)) = args.args.first() {
                                return (request_item, self.extract_stream_item_type(ok_type));
                            }
                        }
                    }
                }
            }
            quote! { () }
        } else {
            quote! { () }
        };

        (request_item, response_item)
    }

    #[allow(clippy::only_used_in_recursion)]
    fn extract_stream_item_type(&self, ty: &Type) -> TokenStream {
        match ty {
            Type::Path(type_path) => {
                for seg in &type_path.path.segments {
                    if seg.ident == "Pin" || seg.ident == "Box" {
                        if let PathArguments::AngleBracketed(args) = &seg.arguments {
                            if let Some(GenericArgument::Type(inner_ty)) = args.args.first() {
                                return self.extract_stream_item_type(inner_ty);
                            }
                        }
                    }
                }
                quote! { () }
            }
            Type::TraitObject(trait_obj) => {
                for bound in &trait_obj.bounds {
                    if let syn::TypeParamBound::Trait(trait_bound) = bound {
                        for seg in &trait_bound.path.segments {
                            if seg.ident == "Stream" {
                                if let PathArguments::AngleBracketed(args) = &seg.arguments {
                                    for arg in &args.args {
                                        if let GenericArgument::AssocType(assoc) = arg {
                                            if assoc.ident == "Item" {
                                                let item_ty = &assoc.ty;
                                                return quote! { #item_ty };
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
                quote! { () }
            }
            _ => quote! { () },
        }
    }

    #[allow(clippy::only_used_in_recursion)]
    fn type_contains_stream(&self, ty: &Type) -> bool {
        match ty {
            Type::Path(type_path) => type_path.path.segments.iter().any(|seg| {
                seg.ident == "Stream" || {
                    if let PathArguments::AngleBracketed(args) = &seg.arguments {
                        args.args.iter().any(|arg| {
                            if let GenericArgument::Type(inner_ty) = arg {
                                self.type_contains_stream(inner_ty)
                            } else {
                                false
                            }
                        })
                    } else {
                        false
                    }
                }
            }),
            Type::TraitObject(trait_obj) => trait_obj.bounds.iter().any(|bound| {
                if let syn::TypeParamBound::Trait(trait_bound) = bound {
                    trait_bound
                        .path
                        .segments
                        .iter()
                        .any(|seg| seg.ident == "Stream")
                } else {
                    false
                }
            }),
            _ => false,
        }
    }
}

#[cfg(all(test, feature = "codegen"))]
mod tests {
    use super::*;
    use quote::quote;
    use syn::parse_quote;

    fn sample_generator() -> CodeGenerator {
        let input = r#"
            use rpcnet::prelude::*;

            #[rpc_trait]
            pub trait SampleService {
                async fn do_work(&self, request: WorkRequest) -> Result<WorkResponse, WorkError>;
            }

            pub struct WorkRequest;
            pub struct WorkResponse;
            pub enum WorkError { Failed }
        "#;

        let definition = ServiceDefinition::parse(input).expect("failed to parse sample service");
        CodeGenerator::new(definition)
    }

    #[test]
    fn extract_request_type_returns_declared_type() {
        let generator = sample_generator();
        let method = generator
            .definition
            .methods()
            .into_iter()
            .next()
            .expect("expected method");

        let ty = generator.extract_request_type(method);
        assert_eq!(ty.to_string(), quote!(WorkRequest).to_string());
    }

    #[test]
    fn extract_request_type_defaults_to_unit_when_missing_parameter() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn heartbeat(&self) -> Result<(), WorkError>;
        };

        let ty = generator.extract_request_type(&method);
        assert_eq!(ty.to_string(), quote!(()).to_string());
    }

    #[test]
    fn extract_result_types_returns_response_and_error() {
        let generator = sample_generator();
        let method = generator
            .definition
            .methods()
            .into_iter()
            .next()
            .expect("expected method");

        let (response, error) = generator.extract_result_types(method);
        assert_eq!(response.to_string(), quote!(WorkResponse).to_string());
        assert_eq!(error.to_string(), quote!(WorkError).to_string());
    }

    #[test]
    fn extract_result_types_defaults_when_return_type_not_result() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn metrics(&self) -> ();
        };

        let (response, error) = generator.extract_result_types(&method);
        assert_eq!(response.to_string(), quote!(()).to_string());
        assert_eq!(error.to_string(), quote!(String).to_string());
    }

    #[test]
    fn detects_streaming_request_with_trait_object() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn stream_in(
                &self,
                request: Pin<Box<dyn Stream<Item = String> + Send>>
            ) -> Result<String, WorkError>;
        };

        assert!(generator.is_streaming_request(&method));
        assert!(!generator.is_streaming_response(&method));
    }

    #[test]
    fn detects_streaming_response_with_trait_object() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn stream_out(&self, request: String)
                -> Result<Pin<Box<dyn Stream<Item = String> + Send>>, WorkError>;
        };

        assert!(!generator.is_streaming_request(&method));
        assert!(generator.is_streaming_response(&method));
    }

    #[test]
    fn detects_bidirectional_streaming() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn stream_both(
                &self,
                request: Pin<Box<dyn Stream<Item = String> + Send>>
            ) -> Result<Pin<Box<dyn Stream<Item = String> + Send>>, WorkError>;
        };

        assert!(generator.is_streaming_request(&method));
        assert!(generator.is_streaming_response(&method));
    }

    #[test]
    fn detects_non_streaming_method() {
        let generator = sample_generator();
        let method: syn::TraitItemFn = parse_quote! {
            async fn regular(&self, request: String) -> Result<String, WorkError>;
        };

        assert!(!generator.is_streaming_request(&method));
        assert!(!generator.is_streaming_response(&method));
    }

    #[test]
    fn generates_streaming_server_registration() {
        let input = r#"
            use rpcnet::prelude::*;

            #[rpc_trait]
            pub trait StreamService {
                async fn generate(
                    &self,
                    request: Pin<Box<dyn Stream<Item = String> + Send>>
                ) -> Result<Pin<Box<dyn Stream<Item = String> + Send>>, String>;
            }
        "#;

        let definition = ServiceDefinition::parse(input).expect("failed to parse");
        let generator = CodeGenerator::new(definition);
        let server_code = generator.generate_server();
        let code_str = server_code.to_string();

        assert!(code_str.contains("register_streaming"));
        assert!(code_str.contains("use futures :: Stream"));
        assert!(code_str.contains("use std :: pin :: Pin"));
    }

    #[test]
    fn generates_streaming_client_method() {
        let input = r#"
            use rpcnet::prelude::*;

            #[rpc_trait]
            pub trait StreamService {
                async fn generate(
                    &self,
                    req: Pin<Box<dyn Stream<Item = String> + Send>>
                ) -> Result<Pin<Box<dyn Stream<Item = String> + Send>>, String>;
            }
        "#;

        let definition = ServiceDefinition::parse(input).expect("failed to parse");
        let generator = CodeGenerator::new(definition);
        let client_code = generator.generate_client();
        let code_str = client_code.to_string();

        assert!(code_str.contains("call_streaming"));
        assert!(code_str.contains("use futures :: Stream"));
        assert!(code_str.contains("use std :: pin :: Pin"));
        assert!(code_str.contains("req"));
    }

    #[test]
    fn generates_regular_server_registration_without_streaming_imports() {
        let generator = sample_generator();
        let server_code = generator.generate_server();
        let code_str = server_code.to_string();

        assert!(code_str.contains("register"));
        assert!(!code_str.contains("register_streaming"));
        assert!(!code_str.contains("use futures :: Stream"));
        assert!(!code_str.contains("use std :: pin :: Pin"));
    }

    #[test]
    fn generates_regular_client_method_without_streaming_imports() {
        let generator = sample_generator();
        let client_code = generator.generate_client();
        let code_str = client_code.to_string();

        assert!(code_str.contains("self . inner . call"));
        assert!(!code_str.contains("call_streaming"));
        assert!(!code_str.contains("use futures :: Stream"));
        assert!(!code_str.contains("use std :: pin :: Pin"));
    }
}