ic-query 0.75.10

Internet Computer query library for CloudEngine, NNS, SNS, ICRC, system canisters, and public network metadata
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

//! Module: snapshot_cache::refresh
//!
//! Responsibility: run paged snapshot refresh adapters.
//! Does not own: source APIs, cache publication, refresh-attempt schemas, or process output.
//! Boundary: emits structured progress while driving page fetches and attempt writes.

use super::PagedCollectionPage;
use crate::{QueryProgress, QueryProgressEvent, QueryProgressState};

///
/// PagedSnapshotRefresh
///
/// Command-specific adapter for running a complete paged snapshot refresh.
///

pub trait PagedSnapshotRefresh {
    type Complete;
    type Error;

    /// Family diagnostic retained when a page ceiling prevents API exhaustion.
    const PAGE_LIMIT_REASON: &'static str = "max pages reached before API exhaustion";

    fn progress_text(&self) -> String;
    /// Format family-owned progress without changing the shared lifecycle state.
    fn progress_text_for_state(&self, state: QueryProgressState) -> String {
        let text = self.progress_text();
        match state {
            QueryProgressState::Running => text,
            QueryProgressState::Stopped => format!("{text} stopped before completion"),
            QueryProgressState::Failed => format!("{text} failed"),
            QueryProgressState::Stalled => format!("{text} stalled"),
            QueryProgressState::Complete => format!("{text} complete"),
        }
    }

    fn max_pages_reached(&self) -> bool;
    fn incomplete_refresh_error(&self, reason: &'static str) -> Self::Error;
    fn fetch_next_page(
        &mut self,
    ) -> crate::report::SourceFuture<'_, Result<PagedCollectionPage, Self::Error>>;
    /// Persist admitted progress from adapter state when this collection has a page sidecar.
    fn write_running_attempt(&self) -> Result<(), Self::Error> {
        Ok(())
    }
    fn into_complete(self) -> Self::Complete;
}

/// Run a complete paged snapshot refresh and emit structured progress events.
pub async fn run_paged_snapshot_refresh_with_progress<Refresh>(
    mut refresh: Refresh,
    progress: &mut dyn QueryProgress,
) -> Result<Refresh::Complete, Refresh::Error>
where
    Refresh: PagedSnapshotRefresh,
{
    report_progress(
        progress,
        refresh.progress_text_for_state(QueryProgressState::Running),
        QueryProgressState::Running,
    );

    loop {
        if refresh.max_pages_reached() {
            report_progress(
                progress,
                refresh.progress_text_for_state(QueryProgressState::Stopped),
                QueryProgressState::Stopped,
            );
            return Err(refresh.incomplete_refresh_error(Refresh::PAGE_LIMIT_REASON));
        }

        let page = match refresh.fetch_next_page().await.and_then(|page| {
            refresh.write_running_attempt()?;
            Ok(page)
        }) {
            Ok(page) => page,
            Err(err) => {
                report_progress(
                    progress,
                    refresh.progress_text_for_state(QueryProgressState::Failed),
                    QueryProgressState::Failed,
                );
                return Err(err);
            }
        };
        report_progress(
            progress,
            refresh.progress_text_for_state(QueryProgressState::Running),
            QueryProgressState::Running,
        );

        if page.collection_exhausted {
            break;
        }
        if page.has_no_new_rows() {
            report_progress(
                progress,
                refresh.progress_text_for_state(QueryProgressState::Stalled),
                QueryProgressState::Stalled,
            );
            return Err(refresh.incomplete_refresh_error(
                "page returned no new rows while advertising another cursor",
            ));
        }
    }

    report_progress(
        progress,
        refresh.progress_text_for_state(QueryProgressState::Complete),
        QueryProgressState::Complete,
    );
    Ok(refresh.into_complete())
}

fn report_progress(progress: &mut dyn QueryProgress, text: String, state: QueryProgressState) {
    progress.report(QueryProgressEvent::PagedRefresh { text, state });
}