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
use crate::{
    exchange::{binance::futures::BinanceFuturesUsd, ftx::Ftx},
    model::SubKind,
    ExchangeId, ExchangeWebSocket, MarketEvent, MarketStream, Subscription, Validator,
};
use barter_integration::{
    error::SocketError,
    model::{InstrumentKind, Symbol},
    Event,
};
use futures::{stream::Map, StreamExt};
use std::{collections::HashMap, time::Duration};
use tokio::sync::mpsc;
use tokio_stream::{wrappers::UnboundedReceiverStream, StreamMap};
use tracing::{error, info, warn};

/// Initial duration that the [`consume`] function should wait before attempting to re-initialise
/// a [`MarketStream`]. This duration will increase exponentially as a result of repeated
/// disconnections with re-initialisation failures.
const STARTING_RECONNECT_BACKOFF_MS: u64 = 125;

/// Collection of exchange [`MarketEvent`] streams.
#[derive(Debug)]
pub struct Streams {
    pub streams: HashMap<ExchangeId, mpsc::UnboundedReceiver<Event<MarketEvent>>>,
}

impl Streams {
    /// Construct a [`StreamBuilder`] for configuring new [`MarketEvent`] [`Streams`].
    pub fn builder() -> StreamBuilder {
        StreamBuilder::new()
    }

    /// Remove an exchange [`MarketEvent`] stream from the [`Streams`] `HashMap`.
    pub fn select(
        &mut self,
        exchange: ExchangeId,
    ) -> Option<mpsc::UnboundedReceiver<Event<MarketEvent>>> {
        self.streams.remove(&exchange)
    }

    /// Join all exchange [`MarketEvent`] streams into a unified [`mpsc::UnboundedReceiver`].
    pub async fn join<Output>(self) -> mpsc::UnboundedReceiver<Output>
    where
        Output: From<Event<MarketEvent>> + Send + 'static,
    {
        let (output_tx, output_rx) = mpsc::unbounded_channel();

        for mut exchange_rx in self.streams.into_values() {
            let output_tx = output_tx.clone();
            tokio::spawn(async move {
                while let Some(event) = exchange_rx.recv().await {
                    let _ = output_tx.send(Output::from(event));
                }
            });
        }

        output_rx
    }

    /// Join all exchange [`MarketEvent`] streams into a unified [`StreamMap`].
    pub async fn join_map<Output>(
        self,
    ) -> StreamMap<
        ExchangeId,
        Map<UnboundedReceiverStream<Event<MarketEvent>>, fn(Event<MarketEvent>) -> Output>,
    >
    where
        Output: From<Event<MarketEvent>> + Send + 'static,
    {
        self.streams
            .into_iter()
            .fold(StreamMap::new(), |mut map, (exchange, rx)| {
                map.insert(exchange, UnboundedReceiverStream::new(rx).map(Output::from));
                map
            })
    }
}

/// Builder to configure and initialise [`Streams`] instances.
#[derive(Debug)]
pub struct StreamBuilder {
    pub exchange_subscriptions: HashMap<ExchangeId, Vec<Subscription>>,
}

impl StreamBuilder {
    /// Construct a new [`StreamBuilder`] instance.
    fn new() -> Self {
        Self {
            exchange_subscriptions: HashMap::new(),
        }
    }

    /// Add a collection of [`Subscription`]s to the [`StreamBuilder`]. Note that the provided
    /// [`Subscription`]s are not actioned until the [`init()`](StreamBuilder::init()) method
    /// is invoked.
    pub fn subscribe<SubIter, Sub>(mut self, subscriptions: SubIter) -> Self
    where
        SubIter: IntoIterator<Item = Sub>,
        Sub: Into<Subscription>,
    {
        subscriptions
            .into_iter()
            .map(Sub::into)
            .for_each(|subscription| {
                self.exchange_subscriptions
                    .entry(subscription.exchange)
                    .or_default()
                    .push(subscription)
            });

        self
    }

    /// Add a set of [`Subscription`]s for an exchange to the [`StreamBuilder`]. Note that the
    /// provided [`Subscription`]s are not actioned until the [`init()`](StreamBuilder::init())
    /// method is invoked.
    pub fn subscribe_exchange<SubIter, S>(
        mut self,
        exchange: ExchangeId,
        subscriptions: SubIter,
    ) -> Self
    where
        SubIter: IntoIterator<Item = (S, S, InstrumentKind, SubKind)>,
        S: Into<Symbol>,
    {
        // Construct Subscriptions from components
        let subscriptions =
            subscriptions
                .into_iter()
                .map(|(base, quote, instrument_kind, kind)| {
                    Subscription::from((exchange, base, quote, instrument_kind, kind))
                });

        // Extend collection of Subscriptions associated with the ExchangeId
        self.exchange_subscriptions
            .entry(exchange)
            .or_default()
            .extend(subscriptions);

        self
    }

    /// Spawn a [`MarketEvent`] consumer loop for each exchange. Each consumer loop distributes
    /// consumed [`MarketEvent`]s to the [`Streams`] `HashMap` (returned by this method).
    pub async fn init(mut self) -> Result<Streams, SocketError> {
        // Validate Subscriptions provided to the StreamBuilder are supported
        self = self.validate()?;

        // Construct HashMap containing a stream receiver for each ExchangeId
        let num_exchanges = self.exchange_subscriptions.len();
        let mut exchange_streams = HashMap::with_capacity(num_exchanges);

        for (exchange, mut subscriptions) in self.exchange_subscriptions {
            // Remove duplicate Subscriptions for this ExchangeId
            subscriptions.sort();
            subscriptions.dedup();

            // Create channel for this ExchangeId stream
            let (exchange_tx, exchange_rx) = mpsc::unbounded_channel();

            // Spawn a MarketStream consumer loop with this exchange's Subscriptions
            match exchange {
                ExchangeId::BinanceFuturesUsd => {
                    tokio::spawn(consume::<ExchangeWebSocket<BinanceFuturesUsd>>(
                        exchange,
                        subscriptions,
                        exchange_tx,
                    ));
                }
                ExchangeId::Ftx => {
                    tokio::spawn(consume::<ExchangeWebSocket<Ftx>>(
                        exchange,
                        subscriptions,
                        exchange_tx,
                    ));
                }
                not_supported => {
                    return Err(SocketError::Subscribe(format!(
                        "Streams::init() does not support: {}",
                        not_supported
                    )))
                }
            }

            // Add exchange Event<MarketData> stream receiver to map
            exchange_streams.insert(exchange, exchange_rx);
        }

        Ok(Streams {
            streams: exchange_streams,
        })
    }
}

impl Validator for StreamBuilder {
    fn validate(self) -> Result<Self, SocketError>
    where
        Self: Sized,
    {
        // Ensure at least one exchange Subscription has been provided
        if self.exchange_subscriptions.is_empty() {
            return Err(SocketError::Subscribe(
                "StreamBuilder contains no Subscription to action".to_owned(),
            ));
        }

        // Validate each Subscription ExchangeId supports the associated Subscription kind
        self.exchange_subscriptions
            .values()
            .flatten()
            .map(|subscription| subscription.validate())
            .collect::<Result<Vec<_>, SocketError>>()?;

        Ok(self)
    }
}

/// Central [`MarketEvent`] consumer loop. Initialises an exchange [`MarketStream`] using a
/// collection of [`Subscription`]s. Consumed events are distributed downstream via the
/// `exchange_tx mpsc::UnboundedSender`. A re-connection mechanism with an exponential backoff
/// policy is utilised to ensure maximum up-time.
pub async fn consume<Stream>(
    exchange: ExchangeId,
    subscriptions: Vec<Subscription>,
    exchange_tx: mpsc::UnboundedSender<Event<MarketEvent>>,
) -> SocketError
where
    Stream: MarketStream,
{
    info!(
        %exchange,
        ?subscriptions,
        policy = "retry connection with exponential backoff",
        "MarketStream consumer loop running",
    );

    // Consumer loop retry parameters
    let mut attempt: u32 = 0;
    let mut backoff_ms: u64 = STARTING_RECONNECT_BACKOFF_MS;

    loop {
        // Increment retry parameters at start of every iteration
        attempt += 1;
        backoff_ms *= 2;
        info!(%exchange, attempt, "attempting to initialise MarketStream");

        // Attempt to initialise MarketStream: if it fails on first attempt return SocketError
        let mut stream = match Stream::init(&subscriptions).await {
            Ok(stream) => {
                info!(%exchange, attempt, "successfully initialised MarketStream");
                attempt = 0;
                backoff_ms = STARTING_RECONNECT_BACKOFF_MS;
                stream
            }
            Err(error) => {
                error!(%exchange, attempt, ?error, "failed to initialise MarketStream");

                // Exit function function if Stream::init failed the first attempt, else retry
                if attempt == 1 {
                    return error;
                } else {
                    continue;
                }
            }
        };

        // Consume Result<Event<MarketData>, SocketError> from MarketStream
        while let Some(event_result) = stream.next().await {
            match event_result {
                // If Ok: send Event<MarketData> to exchange receiver
                Ok(market_event) => {
                    let _ = exchange_tx.send(market_event).map_err(|err| {
                        error!(
                            payload = ?err.0,
                            why = "receiver dropped",
                            "failed to send Event<MarketData> to Exchange receiver"
                        );
                    });
                }
                // If SocketError: log & continue to next Result<Event<MarketData>, SocketError>
                Err(error) => {
                    warn!(
                        %exchange,
                        %error,
                        action = "skipping message",
                        "consumed SocketError from MarketStream",
                    );
                    continue;
                }
            }
        }

        // If MarketStream ends unexpectedly, attempt re-connection after backoff_ms
        warn!(
            %exchange,
            backoff_ms,
            action = "attempt re-connection after backoff",
            "exchange MarketStream unexpectedly ended"
        );
        tokio::time::sleep(Duration::from_millis(backoff_ms)).await;
    }
}

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

    fn stream_builder(subscription: Subscription) -> StreamBuilder {
        StreamBuilder::new().subscribe([subscription])
    }

    #[test]
    fn test_stream_builder_validate() {
        struct TestCase {
            input: StreamBuilder,
            expected: Result<StreamBuilder, SocketError>,
        }

        let cases = vec![
            TestCase {
                // TC0: Invalid StreamBuilder w/ empty subscriptions
                input: StreamBuilder::new(),
                expected: Err(SocketError::Subscribe("".to_string())),
            },
            TestCase {
                // TC1: Valid StreamBuilder w/ valid Binance Spot sub
                input: stream_builder(Subscription {
                    exchange: ExchangeId::Binance,
                    instrument: Instrument::from(("btc", "usd", InstrumentKind::Spot)),
                    kind: SubKind::Trade,
                }),
                expected: Ok(stream_builder(Subscription {
                    exchange: ExchangeId::Binance,
                    instrument: Instrument::from(("btc", "usd", InstrumentKind::Spot)),
                    kind: SubKind::Trade,
                })),
            },
            TestCase {
                // TC1: Invalid StreamBuilder w/ invalid Binance FuturePerpetual sub
                input: stream_builder(Subscription {
                    exchange: ExchangeId::Binance,
                    instrument: Instrument::from(("btc", "usd", InstrumentKind::FuturePerpetual)),
                    kind: SubKind::Trade,
                }),
                expected: Err(SocketError::Subscribe("".to_string())),
            },
        ];

        for (index, test) in cases.into_iter().enumerate() {
            let actual = test.input.validate();

            match (actual, test.expected) {
                (Ok(_), Ok(_)) => {
                    // Test passed
                }
                (Err(_), Err(_)) => {
                    // Test passed
                }
                (actual, expected) => {
                    // Test failed
                    panic!("TC{index} failed because actual != expected. \nActual: {actual:?}\nExpected: {expected:?}\n");
                }
            }
        }
    }
}