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
// Copyright (c) 2023 MASSA LABS <info@massa.net>

use crate::error::{match_for_io_error, GrpcError};
use crate::server::MassaPublicGrpc;
use futures_util::StreamExt;
use massa_proto_rs::massa::api::v1::{self as grpc_api};
use std::io::ErrorKind;
use std::pin::Pin;
use std::time::Duration;
use tokio::{select, time};
use tonic::{Request, Streaming};
use tracing::{error, warn};

use super::trait_filters_impl::{FilterGrpc, NewEndorsementsFilter};

/// Type declaration for NewEndorsements
pub type NewEndorsementsStreamType = Pin<
    Box<
        dyn futures_util::Stream<Item = Result<grpc_api::NewEndorsementsResponse, tonic::Status>>
            + Send
            + 'static,
    >,
>;

/// Type declaration for NewEndorsementsServer
pub type NewEndorsementsServerStreamType = Pin<
    Box<
        dyn futures_util::Stream<
                Item = Result<grpc_api::NewEndorsementsServerResponse, tonic::Status>,
            > + Send
            + 'static,
    >,
>;

/// Creates a new stream of new produced and received endorsements
pub(crate) async fn new_endorsements(
    grpc: &MassaPublicGrpc,
    request: Request<Streaming<grpc_api::NewEndorsementsRequest>>,
) -> Result<NewEndorsementsStreamType, GrpcError> {
    // Create a channel to handle communication with the client
    let (tx, rx) = tokio::sync::mpsc::channel(grpc.grpc_config.max_channel_size);
    // Get the inner stream from the request
    let mut in_stream = request.into_inner();
    // Subscribe to the new endorsements channel
    let mut subscriber = grpc.pool_broadcasts.endorsement_sender.subscribe();
    // Clone grpc to be able to use it in the spawned task
    let grpc_config = grpc.grpc_config.clone();

    tokio::spawn(async move {
        if let Some(Ok(request)) = in_stream.next().await {
            let mut filter =
                match NewEndorsementsFilter::build_from_request(request.filters, &grpc_config) {
                    Ok(filter) => filter,
                    Err(err) => {
                        error!("failed to get filter: {}", err);
                        // Send the error response back to the client
                        if let Err(e) = tx.send(Err(err.into())).await {
                            error!("failed to send back NewEndorsements error response: {}", e);
                        }
                        return;
                    }
                };

            loop {
                select! {
                    // Receive a new endorsement from the subscriber
                    event = subscriber.recv() => {
                        match event {
                            Ok(massa_endorsement) => {
                                // Check if the endorsement should be sent
                                if let Some(data) = filter.filter_output(massa_endorsement, &grpc_config) {
                                    // Send the new endorsement through the channel
                                    if let Err(e) = tx.send(Ok(grpc_api::NewEndorsementsResponse {
                                        signed_endorsement: Some(data.into())
                                    })).await {
                                        error!("failed to send new endorsement : {}", e);
                                        break;
                                    }
                                }
                            },
                            Err(e) => error!("error on receive new endorsement : {}", e)
                        }
                    },
                    // Receive a new message from the in_stream
                    res = in_stream.next() => {
                        match res {
                            Some(res) => {
                                match res {
                                    Ok(message) => {
                                        // Update current filter
                                        filter = match NewEndorsementsFilter::build_from_request(message.filters, &grpc_config) {
                                            Ok(filter) => filter,
                                            Err(err) => {
                                                error!("failed to get filter: {}", err);
                                                // Send the error response back to the client
                                                if let Err(e) = tx.send(Err(err.into())).await {
                                                    error!("failed to send back NewEndorsements error response: {}", e);
                                                }
                                                return;
                                            }
                                        };
                                    },
                                    Err(err) => {
                                        // Check if the error matches any IO errors
                                        if let Some(io_err) = match_for_io_error(&err) {
                                            if io_err.kind() == ErrorKind::BrokenPipe {
                                                warn!("client disconnected, broken pipe: {}", io_err);
                                                break;
                                            }
                                        }
                                        error!("{}", err);
                                        // Send the error response back to the client
                                        if let Err(e) = tx.send(Err(err)).await {
                                            error!("failed to send back NewEndorsements error response: {}", e);
                                            break;
                                        }
                                    }
                            }
                        },
                            None => {
                                // The client has disconnected
                                break;
                            },
                        }
                    }
                }
            }
        } else {
            error!("empty request");
        }
    });

    // Create a new stream from the received channel
    let out_stream = tokio_stream::wrappers::ReceiverStream::new(rx);

    // Return the new stream of endorsements
    Ok(Box::pin(out_stream) as NewEndorsementsStreamType)
}

/// Creates a new unidirectional stream of new produced and received endorsements
pub(crate) async fn new_endorsements_server(
    grpc: &MassaPublicGrpc,
    request: Request<grpc_api::NewEndorsementsServerRequest>,
) -> Result<NewEndorsementsServerStreamType, GrpcError> {
    // Create a channel to handle communication with the client
    let (tx, rx) = tokio::sync::mpsc::channel(grpc.grpc_config.max_channel_size);
    // Get the inner request
    let request = request.into_inner();
    // Subscribe to the new endorsements channel
    let mut subscriber = grpc.pool_broadcasts.endorsement_sender.subscribe();
    // Clone grpc to be able to use it in the spawned task
    let grpc_config = grpc.grpc_config.clone();

    tokio::spawn(async move {
        let filter = match NewEndorsementsFilter::build_from_request(request.filters, &grpc_config)
        {
            Ok(filter) => filter,
            Err(err) => {
                error!("failed to get filter: {}", err);
                // Send the error response back to the client
                if let Err(e) = tx.send(Err(err.into())).await {
                    error!("failed to send back new endorsement error response: {}", e);
                }
                return;
            }
        };

        // Create a timer that ticks every 10 seconds to check if the client is still connected
        let mut interval = time::interval(Duration::from_secs(
            grpc_config.unidirectional_stream_interval_check,
        ));

        loop {
            select! {
                // Receive a new endorsement from the subscriber
                event = subscriber.recv() => {
                    match event {
                        Ok(massa_endorsement) => {
                            // Check if the endorsement should be sent
                            if let Some(data) = filter.filter_output(massa_endorsement, &grpc_config) {
                                // Send the new endorsement through the channel
                                if let Err(e) = tx.send(Ok(grpc_api::NewEndorsementsServerResponse {
                                    signed_endorsement: Some(data.into())
                                })).await {
                                    error!("failed to send new endorsement : {}", e);
                                    break;
                                }
                            }
                        },
                        Err(e) => error!("error on receive new endorsement : {}", e)
                    }
                },
                _ = interval.tick() => {
                    if tx.is_closed() {
                        // Client disconnected
                        break;
                    }
                }
            }
        }
    });

    // Create a new stream from the received channel
    let out_stream = tokio_stream::wrappers::ReceiverStream::new(rx);

    // Return the new stream of endorsements
    Ok(Box::pin(out_stream) as NewEndorsementsServerStreamType)
}