ic-query 0.30.2

Internet Computer query library for 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
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

//! Module: cache::status::locks
//!
//! Responsibility: inspect refresh locks and project their generic status rows.
//! Does not own: lock acquisition, directory traversal, or operator cleanup.
//! Boundary: evaluates only serialized lock evidence and caller-supplied time.

use super::{
    super::{CacheRefreshLockStatus, CacheRefreshLockStatusRow},
    header::component_from_path,
};
use crate::{
    CacheFileError,
    cache_file::{RefreshLockEvidence, inspect_refresh_lock},
    subnet_catalog::format_utc_timestamp_secs,
};
use std::path::Path;

struct RefreshLockRowContext<'path> {
    root: &'path Path,
    path: &'path Path,
    relative: &'path Path,
    relative_path: String,
    size_bytes: u64,
}

impl<'path> RefreshLockRowContext<'path> {
    fn new(root: &'path Path, path: &'path Path, size_bytes: u64) -> Self {
        let relative = path.strip_prefix(root).unwrap_or(path);
        Self {
            root,
            path,
            relative,
            relative_path: relative.display().to_string(),
            size_bytes,
        }
    }
}

pub(super) fn refresh_lock_status_row(
    root: &Path,
    path: &Path,
    now_unix_secs: u64,
) -> Result<CacheRefreshLockStatusRow, CacheFileError> {
    let size_bytes = crate::cache_file::open_managed_file(root, path)?
        .map(|file| {
            file.metadata()
                .map(|metadata| metadata.len())
                .map_err(|source| CacheFileError::OpenManagedPath {
                    root: root.to_path_buf(),
                    path: path.to_path_buf(),
                    source,
                })
        })
        .transpose()?
        .unwrap_or(0);
    let context = RefreshLockRowContext::new(root, path, size_bytes);
    let evidence = match inspect_refresh_lock(root, path) {
        Ok(evidence) => evidence,
        Err(
            error @ (CacheFileError::ParseRefreshLock { .. }
            | CacheFileError::InvalidRefreshLock { .. }),
        ) => {
            return Ok(invalid_refresh_lock_row(context, error.to_string()));
        }
        Err(error) => return Err(error),
    };
    let now_unix_ms = now_unix_secs.saturating_mul(1_000);
    let Some(age_unix_ms) = now_unix_ms.checked_sub(evidence.started_at_unix_ms) else {
        return Ok(invalid_refresh_lock_evidence_row(
            context,
            evidence,
            "refresh lock acquisition timestamp is in the future".to_string(),
        ));
    };
    let status = if age_unix_ms > evidence.stale_after_seconds.saturating_mul(1_000) {
        CacheRefreshLockStatus::Stale
    } else {
        CacheRefreshLockStatus::Active
    };
    Ok(refresh_lock_evidence_row(
        context,
        evidence,
        status,
        Some(age_unix_ms / 1_000),
        None,
    ))
}

fn invalid_refresh_lock_row(
    context: RefreshLockRowContext<'_>,
    error: String,
) -> CacheRefreshLockStatusRow {
    CacheRefreshLockStatusRow {
        component: component_from_path(context.relative),
        refresh_lock_path: context.path.display().to_string(),
        relative_path: context.relative_path,
        status: CacheRefreshLockStatus::Invalid,
        schema_version: None,
        network: None,
        pid: None,
        started_at_unix_ms: None,
        started_at: None,
        age_seconds: None,
        stale_after_seconds: None,
        target_path: None,
        size_bytes: context.size_bytes,
        error: Some(error),
    }
}

fn invalid_refresh_lock_evidence_row(
    context: RefreshLockRowContext<'_>,
    evidence: RefreshLockEvidence,
    error: String,
) -> CacheRefreshLockStatusRow {
    refresh_lock_evidence_row(
        context,
        evidence,
        CacheRefreshLockStatus::Invalid,
        None,
        Some(error),
    )
}

fn refresh_lock_evidence_row(
    context: RefreshLockRowContext<'_>,
    evidence: RefreshLockEvidence,
    status: CacheRefreshLockStatus,
    age_seconds: Option<u64>,
    error: Option<String>,
) -> CacheRefreshLockStatusRow {
    let target = Path::new(&evidence.target_path);
    let component_path = target
        .strip_prefix(context.root)
        .unwrap_or(context.relative);
    CacheRefreshLockStatusRow {
        component: component_from_path(component_path),
        refresh_lock_path: context.path.display().to_string(),
        relative_path: context.relative_path,
        status,
        schema_version: Some(evidence.schema_version),
        network: Some(evidence.network),
        pid: Some(evidence.pid),
        started_at_unix_ms: Some(evidence.started_at_unix_ms),
        started_at: Some(format_utc_timestamp_secs(
            evidence.started_at_unix_ms / 1_000,
        )),
        age_seconds,
        stale_after_seconds: Some(evidence.stale_after_seconds),
        target_path: Some(evidence.target_path),
        size_bytes: context.size_bytes,
        error,
    }
}