1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
// This file is @generated by prost-build.
/// Handshake message between client and server to indicate the start of transmission.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Handshake {
/// Required field indicating the start of transmission.
#[prost(bool, tag = "1")]
pub sot: bool,
}
/// ReadRequest is the request for reading datum stream from user defined source.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ReadRequest {
/// Required field indicating the request.
#[prost(message, optional, tag = "1")]
pub request: ::core::option::Option<read_request::Request>,
#[prost(message, optional, tag = "2")]
pub handshake: ::core::option::Option<Handshake>,
}
/// Nested message and enum types in `ReadRequest`.
pub mod read_request {
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Request {
/// Required field indicating the number of records to read.
#[prost(uint64, tag = "1")]
pub num_records: u64,
/// Required field indicating the request timeout in milliseconds.
/// uint32 can represent 2^32 milliseconds, which is about 49 days.
/// We don't use uint64 because time.Duration takes int64 as nano seconds. Using uint64 for milli will cause overflow.
#[prost(uint32, tag = "2")]
pub timeout_in_ms: u32,
}
}
/// ReadResponse is the response for reading datum stream from user defined source.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReadResponse {
/// Required field holding the result.
#[prost(message, optional, tag = "1")]
pub result: ::core::option::Option<read_response::Result>,
/// Status of the response. Holds the end of transmission flag and the status code.
#[prost(message, optional, tag = "2")]
pub status: ::core::option::Option<read_response::Status>,
/// Handshake message between client and server to indicate the start of transmission.
#[prost(message, optional, tag = "3")]
pub handshake: ::core::option::Option<Handshake>,
}
/// Nested message and enum types in `ReadResponse`.
pub mod read_response {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Result {
/// Required field holding the payload of the datum.
#[prost(bytes = "vec", tag = "1")]
pub payload: ::prost::alloc::vec::Vec<u8>,
/// Required field indicating the offset information of the datum.
#[prost(message, optional, tag = "2")]
pub offset: ::core::option::Option<super::Offset>,
/// Required field representing the time associated with each datum. It is used for watermarking.
#[prost(message, optional, tag = "3")]
pub event_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional list of keys associated with the datum.
/// Key is the "key" attribute in (key,value) as in the map-reduce paradigm.
/// We add this optional field to support the use case where the user defined source can provide keys for the datum.
/// e.g. Kafka and Redis Stream message usually include information about the keys.
#[prost(string, repeated, tag = "4")]
pub keys: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Optional list of headers associated with the datum.
/// Headers are the metadata associated with the datum.
/// e.g. Kafka and Redis Stream message usually include information about the headers.
#[prost(map = "string, string", tag = "5")]
pub headers: ::std::collections::HashMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Metadata is the metadata of the message
#[prost(message, optional, tag = "6")]
pub metadata: ::core::option::Option<crate::proto::metadata::Metadata>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Status {
/// End of transmission flag.
#[prost(bool, tag = "1")]
pub eot: bool,
#[prost(enumeration = "status::Code", tag = "2")]
pub code: i32,
#[prost(enumeration = "status::Error", optional, tag = "3")]
pub error: ::core::option::Option<i32>,
#[prost(string, optional, tag = "4")]
pub msg: ::core::option::Option<::prost::alloc::string::String>,
}
/// Nested message and enum types in `Status`.
pub mod status {
/// Code to indicate the status of the response.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Code {
Success = 0,
Failure = 1,
}
impl Code {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Success => "SUCCESS",
Self::Failure => "FAILURE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SUCCESS" => Some(Self::Success),
"FAILURE" => Some(Self::Failure),
_ => None,
}
}
}
/// Error to indicate the error type. If the code is FAILURE, then the error field will be populated.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Error {
Unacked = 0,
Other = 1,
}
impl Error {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unacked => "UNACKED",
Self::Other => "OTHER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNACKED" => Some(Self::Unacked),
"OTHER" => Some(Self::Other),
_ => None,
}
}
}
}
}
/// AckRequest is the request for acknowledging datum.
/// It takes a list of offsets to be acknowledged.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AckRequest {
/// Required field holding the request. The list will be ordered and will have the same order as the original Read response.
#[prost(message, optional, tag = "1")]
pub request: ::core::option::Option<ack_request::Request>,
#[prost(message, optional, tag = "2")]
pub handshake: ::core::option::Option<Handshake>,
}
/// Nested message and enum types in `AckRequest`.
pub mod ack_request {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Request {
/// Required field holding the offset to be acked
#[prost(message, repeated, tag = "1")]
pub offsets: ::prost::alloc::vec::Vec<super::Offset>,
}
}
/// AckResponse is the response for acknowledging datum. It contains one empty field confirming
/// the batch of offsets that have been successfully acknowledged. The contract between client and server
/// is that the server will only return the AckResponse if the ack request is successful.
/// If the server hangs during the ack request, the client can decide to timeout and error out the data forwarder.
/// The reason why we define such contract is that we always expect the server to be able to process the ack request.
/// Client is expected to send the AckRequest to the server with offsets that are strictly
/// corresponding to the previously read batch. If the client sends the AckRequest with offsets that are not,
/// it is considered as a client error and the server will not return the AckResponse.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AckResponse {
/// Required field holding the result.
#[prost(message, optional, tag = "1")]
pub result: ::core::option::Option<ack_response::Result>,
/// Handshake message between client and server to indicate the start of transmission.
#[prost(message, optional, tag = "2")]
pub handshake: ::core::option::Option<Handshake>,
}
/// Nested message and enum types in `AckResponse`.
pub mod ack_response {
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Result {
/// Required field indicating the ack request is successful.
#[prost(message, optional, tag = "1")]
pub success: ::core::option::Option<()>,
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NackRequest {
/// Required field holding the request. The list will be ordered and will have the same order as the original Read response.
#[prost(message, optional, tag = "1")]
pub request: ::core::option::Option<nack_request::Request>,
}
/// Nested message and enum types in `NackRequest`.
pub mod nack_request {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Request {
/// Required field holding the offset to be nacked
#[prost(message, repeated, tag = "1")]
pub offsets: ::prost::alloc::vec::Vec<super::Offset>,
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NackResponse {
/// Required field holding the result.
#[prost(message, optional, tag = "1")]
pub result: ::core::option::Option<nack_response::Result>,
}
/// Nested message and enum types in `NackResponse`.
pub mod nack_response {
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Result {
/// Required field indicating the nack request is successful.
#[prost(message, optional, tag = "1")]
pub success: ::core::option::Option<()>,
}
}
/// ReadyResponse is the health check result for user defined source.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ReadyResponse {
/// Required field holding the health check result.
#[prost(bool, tag = "1")]
pub ready: bool,
}
/// PendingResponse is the response for the pending request.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingResponse {
/// Required field holding the result.
#[prost(message, optional, tag = "1")]
pub result: ::core::option::Option<pending_response::Result>,
}
/// Nested message and enum types in `PendingResponse`.
pub mod pending_response {
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Result {
/// Required field holding the number of pending records at the user defined source.
/// A negative count indicates that the pending information is not available.
#[prost(int64, tag = "1")]
pub count: i64,
}
}
/// PartitionsResponse is the response for the partitions request.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PartitionsResponse {
/// Required field holding the result.
#[prost(message, optional, tag = "1")]
pub result: ::core::option::Option<partitions_response::Result>,
}
/// Nested message and enum types in `PartitionsResponse`.
pub mod partitions_response {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Result {
/// Required field holding the list of partitions.
#[prost(int32, repeated, tag = "1")]
pub partitions: ::prost::alloc::vec::Vec<i32>,
}
}
/// Offset is the offset of the datum.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Offset {
/// offset is the offset of the datum. This field is required.
/// We define Offset as a byte array because different input data sources can have different representations for Offset.
/// The only way to generalize it is to define it as a byte array,
/// Such that we can let the UDSource to de-serialize the offset using its own interpretation logics.
#[prost(bytes = "vec", tag = "1")]
pub offset: ::prost::alloc::vec::Vec<u8>,
/// Optional partition_id indicates which partition of the source the datum belongs to.
/// It is useful for sources that have multiple partitions. e.g. Kafka.
/// If the partition_id is not specified, it is assumed that the source has a single partition.
#[prost(int32, tag = "2")]
pub partition_id: i32,
}
/// Generated client implementations.
pub mod source_client {
#![allow(
unused_variables,
dead_code,
missing_docs,
clippy::wildcard_imports,
clippy::let_unit_value,
)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
#[derive(Debug, Clone)]
pub struct SourceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl SourceClient<tonic::transport::Channel> {
/// Attempt to create a new client by connecting to a given endpoint.
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> SourceClient<T>
where
T: tonic::client::GrpcService<tonic::body::Body>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> SourceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::Body>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::Body>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
SourceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Read returns a stream of datum responses.
/// The size of the returned responses is less than or equal to the num_records specified in each ReadRequest.
/// If the request timeout is reached on the server side, the returned responses will contain all the datum that have been read (which could be an empty list).
/// The server will continue to read and respond to subsequent ReadRequests until the client closes the stream.
/// Once it has sent all the datum, the server will send a ReadResponse with the end of transmission flag set to true.
pub async fn read_fn(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::ReadRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ReadResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/source.v1.Source/ReadFn");
let mut req = request.into_streaming_request();
req.extensions_mut().insert(GrpcMethod::new("source.v1.Source", "ReadFn"));
self.inner.streaming(req, path, codec).await
}
/// AckFn acknowledges a stream of datum offsets.
/// When AckFn is called, it implicitly indicates that the datum stream has been processed by the source vertex.
/// The caller (numa) expects the AckFn to be successful, and it does not expect any errors.
/// If there are some irrecoverable errors when the callee (UDSource) is processing the AckFn request,
/// then it is best to crash because there are no other retry mechanisms possible.
/// Clients sends n requests and expects n responses.
pub async fn ack_fn(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::AckRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::AckResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/source.v1.Source/AckFn");
let mut req = request.into_streaming_request();
req.extensions_mut().insert(GrpcMethod::new("source.v1.Source", "AckFn"));
self.inner.streaming(req, path, codec).await
}
/// NackFn negatively acknowledges a batch of offsets. Invoked during a critical error in the mono vertex or pipeline.
/// Unlike AckFn its not a streaming rpc because this is only invoked when there is a critical error (error path).
pub async fn nack_fn(
&mut self,
request: impl tonic::IntoRequest<super::NackRequest>,
) -> std::result::Result<tonic::Response<super::NackResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/source.v1.Source/NackFn");
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("source.v1.Source", "NackFn"));
self.inner.unary(req, path, codec).await
}
/// PendingFn returns the number of pending records at the user defined source.
pub async fn pending_fn(
&mut self,
request: impl tonic::IntoRequest<()>,
) -> std::result::Result<
tonic::Response<super::PendingResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/source.v1.Source/PendingFn",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("source.v1.Source", "PendingFn"));
self.inner.unary(req, path, codec).await
}
/// PartitionsFn returns the list of partitions for the user defined source.
pub async fn partitions_fn(
&mut self,
request: impl tonic::IntoRequest<()>,
) -> std::result::Result<
tonic::Response<super::PartitionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/source.v1.Source/PartitionsFn",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("source.v1.Source", "PartitionsFn"));
self.inner.unary(req, path, codec).await
}
/// IsReady is the heartbeat endpoint for user defined source gRPC.
pub async fn is_ready(
&mut self,
request: impl tonic::IntoRequest<()>,
) -> std::result::Result<tonic::Response<super::ReadyResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/source.v1.Source/IsReady");
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("source.v1.Source", "IsReady"));
self.inner.unary(req, path, codec).await
}
}
}
/// Generated server implementations.
pub mod source_server {
#![allow(
unused_variables,
dead_code,
missing_docs,
clippy::wildcard_imports,
clippy::let_unit_value,
)]
use tonic::codegen::*;
/// Generated trait containing gRPC methods that should be implemented for use with SourceServer.
#[async_trait]
pub trait Source: std::marker::Send + std::marker::Sync + 'static {
/// Server streaming response type for the ReadFn method.
type ReadFnStream: tonic::codegen::tokio_stream::Stream<
Item = std::result::Result<super::ReadResponse, tonic::Status>,
>
+ std::marker::Send
+ 'static;
/// Read returns a stream of datum responses.
/// The size of the returned responses is less than or equal to the num_records specified in each ReadRequest.
/// If the request timeout is reached on the server side, the returned responses will contain all the datum that have been read (which could be an empty list).
/// The server will continue to read and respond to subsequent ReadRequests until the client closes the stream.
/// Once it has sent all the datum, the server will send a ReadResponse with the end of transmission flag set to true.
async fn read_fn(
&self,
request: tonic::Request<tonic::Streaming<super::ReadRequest>>,
) -> std::result::Result<tonic::Response<Self::ReadFnStream>, tonic::Status>;
/// Server streaming response type for the AckFn method.
type AckFnStream: tonic::codegen::tokio_stream::Stream<
Item = std::result::Result<super::AckResponse, tonic::Status>,
>
+ std::marker::Send
+ 'static;
/// AckFn acknowledges a stream of datum offsets.
/// When AckFn is called, it implicitly indicates that the datum stream has been processed by the source vertex.
/// The caller (numa) expects the AckFn to be successful, and it does not expect any errors.
/// If there are some irrecoverable errors when the callee (UDSource) is processing the AckFn request,
/// then it is best to crash because there are no other retry mechanisms possible.
/// Clients sends n requests and expects n responses.
async fn ack_fn(
&self,
request: tonic::Request<tonic::Streaming<super::AckRequest>>,
) -> std::result::Result<tonic::Response<Self::AckFnStream>, tonic::Status>;
/// NackFn negatively acknowledges a batch of offsets. Invoked during a critical error in the mono vertex or pipeline.
/// Unlike AckFn its not a streaming rpc because this is only invoked when there is a critical error (error path).
async fn nack_fn(
&self,
request: tonic::Request<super::NackRequest>,
) -> std::result::Result<tonic::Response<super::NackResponse>, tonic::Status>;
/// PendingFn returns the number of pending records at the user defined source.
async fn pending_fn(
&self,
request: tonic::Request<()>,
) -> std::result::Result<tonic::Response<super::PendingResponse>, tonic::Status>;
/// PartitionsFn returns the list of partitions for the user defined source.
async fn partitions_fn(
&self,
request: tonic::Request<()>,
) -> std::result::Result<
tonic::Response<super::PartitionsResponse>,
tonic::Status,
>;
/// IsReady is the heartbeat endpoint for user defined source gRPC.
async fn is_ready(
&self,
request: tonic::Request<()>,
) -> std::result::Result<tonic::Response<super::ReadyResponse>, tonic::Status>;
}
#[derive(Debug)]
pub struct SourceServer<T> {
inner: Arc<T>,
accept_compression_encodings: EnabledCompressionEncodings,
send_compression_encodings: EnabledCompressionEncodings,
max_decoding_message_size: Option<usize>,
max_encoding_message_size: Option<usize>,
}
impl<T> SourceServer<T> {
pub fn new(inner: T) -> Self {
Self::from_arc(Arc::new(inner))
}
pub fn from_arc(inner: Arc<T>) -> Self {
Self {
inner,
accept_compression_encodings: Default::default(),
send_compression_encodings: Default::default(),
max_decoding_message_size: None,
max_encoding_message_size: None,
}
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> InterceptedService<Self, F>
where
F: tonic::service::Interceptor,
{
InterceptedService::new(Self::new(inner), interceptor)
}
/// Enable decompressing requests with the given encoding.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.accept_compression_encodings.enable(encoding);
self
}
/// Compress responses with the given encoding, if the client supports it.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.send_compression_encodings.enable(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.max_decoding_message_size = Some(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.max_encoding_message_size = Some(limit);
self
}
}
impl<T, B> tonic::codegen::Service<http::Request<B>> for SourceServer<T>
where
T: Source,
B: Body + std::marker::Send + 'static,
B::Error: Into<StdError> + std::marker::Send + 'static,
{
type Response = http::Response<tonic::body::Body>;
type Error = std::convert::Infallible;
type Future = BoxFuture<Self::Response, Self::Error>;
fn poll_ready(
&mut self,
_cx: &mut Context<'_>,
) -> Poll<std::result::Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn call(&mut self, req: http::Request<B>) -> Self::Future {
match req.uri().path() {
"/source.v1.Source/ReadFn" => {
#[allow(non_camel_case_types)]
struct ReadFnSvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::StreamingService<super::ReadRequest>
for ReadFnSvc<T> {
type Response = super::ReadResponse;
type ResponseStream = T::ReadFnStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<tonic::Streaming<super::ReadRequest>>,
) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::read_fn(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = ReadFnSvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/source.v1.Source/AckFn" => {
#[allow(non_camel_case_types)]
struct AckFnSvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::StreamingService<super::AckRequest>
for AckFnSvc<T> {
type Response = super::AckResponse;
type ResponseStream = T::AckFnStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<tonic::Streaming<super::AckRequest>>,
) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::ack_fn(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = AckFnSvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/source.v1.Source/NackFn" => {
#[allow(non_camel_case_types)]
struct NackFnSvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::UnaryService<super::NackRequest>
for NackFnSvc<T> {
type Response = super::NackResponse;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::NackRequest>,
) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::nack_fn(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = NackFnSvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/source.v1.Source/PendingFn" => {
#[allow(non_camel_case_types)]
struct PendingFnSvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::UnaryService<()> for PendingFnSvc<T> {
type Response = super::PendingResponse;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(&mut self, request: tonic::Request<()>) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::pending_fn(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = PendingFnSvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/source.v1.Source/PartitionsFn" => {
#[allow(non_camel_case_types)]
struct PartitionsFnSvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::UnaryService<()>
for PartitionsFnSvc<T> {
type Response = super::PartitionsResponse;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(&mut self, request: tonic::Request<()>) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::partitions_fn(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = PartitionsFnSvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/source.v1.Source/IsReady" => {
#[allow(non_camel_case_types)]
struct IsReadySvc<T: Source>(pub Arc<T>);
impl<T: Source> tonic::server::UnaryService<()> for IsReadySvc<T> {
type Response = super::ReadyResponse;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(&mut self, request: tonic::Request<()>) -> Self::Future {
let inner = Arc::clone(&self.0);
let fut = async move {
<T as Source>::is_ready(&inner, request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let max_decoding_message_size = self.max_decoding_message_size;
let max_encoding_message_size = self.max_encoding_message_size;
let inner = self.inner.clone();
let fut = async move {
let method = IsReadySvc(inner);
let codec = tonic_prost::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
)
.apply_max_message_size_config(
max_decoding_message_size,
max_encoding_message_size,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
_ => {
Box::pin(async move {
let mut response = http::Response::new(
tonic::body::Body::default(),
);
let headers = response.headers_mut();
headers
.insert(
tonic::Status::GRPC_STATUS,
(tonic::Code::Unimplemented as i32).into(),
);
headers
.insert(
http::header::CONTENT_TYPE,
tonic::metadata::GRPC_CONTENT_TYPE,
);
Ok(response)
})
}
}
}
}
impl<T> Clone for SourceServer<T> {
fn clone(&self) -> Self {
let inner = self.inner.clone();
Self {
inner,
accept_compression_encodings: self.accept_compression_encodings,
send_compression_encodings: self.send_compression_encodings,
max_decoding_message_size: self.max_decoding_message_size,
max_encoding_message_size: self.max_encoding_message_size,
}
}
}
/// Generated gRPC service name
pub const SERVICE_NAME: &str = "source.v1.Source";
impl<T> tonic::server::NamedService for SourceServer<T> {
const NAME: &'static str = SERVICE_NAME;
}
}