sui_indexer_alt_framework/ingestion/
broadcaster.rs

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
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use std::sync::Arc;

use futures::future::try_join_all;
use tokio::{sync::mpsc, task::JoinHandle};
use tokio_stream::wrappers::ReceiverStream;
use tokio_util::sync::CancellationToken;
use tracing::{error, info};

use crate::{
    ingestion::error::Error, task::TrySpawnStreamExt,
    types::full_checkpoint_content::CheckpointData,
};

use super::{client::IngestionClient, IngestionConfig};

/// The broadcaster task is responsible for taking a stream of checkpoint sequence numbers from
/// `checkpoint_rx`, fetching them using the `client` and disseminating them to all subscribers in
/// `subscribers`.
///
/// The task will shut down if the `cancel` token is signalled, or if the `checkpoint_rx` channel
/// closes.
pub(super) fn broadcaster(
    config: IngestionConfig,
    client: IngestionClient,
    checkpoint_rx: mpsc::Receiver<u64>,
    subscribers: Vec<mpsc::Sender<Arc<CheckpointData>>>,
    cancel: CancellationToken,
) -> JoinHandle<()> {
    tokio::spawn(async move {
        info!("Starting ingestion broadcaster");
        let retry_interval = config.retry_interval();

        match ReceiverStream::new(checkpoint_rx)
            .try_for_each_spawned(/* limit */ config.ingest_concurrency, |cp| {
                let client = client.clone();
                let subscribers = subscribers.clone();

                // One clone is for the supervisor to signal a cancel if it detects a
                // subscriber that wants to wind down ingestion, and the other is to pass to
                // each worker to detect cancellation.
                let supervisor_cancel = cancel.clone();
                let cancel = cancel.clone();

                async move {
                    // Repeatedly retry if the checkpoint is not found, assuming that we are at the
                    // tip of the network and it will become available soon.
                    let checkpoint = client.wait_for(cp, retry_interval, &cancel).await?;

                    let futures = subscribers.iter().map(|s| s.send(checkpoint.clone()));
                    if try_join_all(futures).await.is_err() {
                        info!("Subscription dropped, signalling shutdown");
                        supervisor_cancel.cancel();
                        Err(Error::Cancelled)
                    } else {
                        Ok(())
                    }
                }
            })
            .await
        {
            Ok(()) => {
                info!("Checkpoints done, stopping ingestion broadcaster");
            }

            Err(Error::Cancelled) => {
                info!("Shutdown received, stopping ingestion broadcaster");
            }

            Err(e) => {
                error!("Ingestion broadcaster failed: {}", e);
                cancel.cancel();
            }
        }
    })
}