pulse-pixelstream-types 0.14.1

Shared Myko entity and command types for the Pulse Pixelstream recording cell.
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

use myko::prelude::*;
use myko_macros::myko_item;

use crate::{FrameCapturePhase, FrameCaptureReceipt, FrameCaptureTarget, StoredCaptureContext};

/// Bridge-owned authoritative status for one stream's capture.
#[myko_item]
pub struct FrameCaptureStatus {
    pub streamer_id: String,
    #[serde(default)]
    pub capture_id: String,
    #[serde(default)]
    pub phase: FrameCapturePhase,
    /// Editorial context echoed back so the UI can label the result.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[ts(type = "unknown")]
    pub capture_context: Option<StoredCaptureContext>,
    #[serde(default)]
    pub target: FrameCaptureTarget,
    /// Generation the bridge actually captured, stamped from Cluster.
    #[serde(default)]
    pub observed_generation: String,
    /// Typed receipts, populated on Complete. Rendered verbatim.
    #[serde(default)]
    pub receipts: Vec<FrameCaptureReceipt>,
    /// Human-readable failure reason when phase is Failed. Cluster's exact
    /// wording, forwarded rather than reinterpreted.
    #[serde(default)]
    pub error: String,
    /// Set when this refusal is one a forced submit could bypass (missing or
    /// stalled frame-progress telemetry). Drives the explicit override the UI
    /// offers; identity checks are never bypassable.
    #[serde(default)]
    pub forceable: bool,
    #[serde(default)]
    pub updated_at_ms: u64,
}

impl FrameCaptureStatus {
    pub fn is_running(&self) -> bool {
        self.phase.is_running()
    }

    /// One-line summary for the chip tooltip.
    pub fn summary(&self) -> String {
        match self.phase {
            FrameCapturePhase::Idle => String::new(),
            FrameCapturePhase::Failed if !self.error.is_empty() => self.error.clone(),
            FrameCapturePhase::Complete => {
                format!("{} artifact(s) captured", self.receipts.len())
            }
            _ => format!("Frame capture on {}", self.target.cluster_name),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{FrameCapturePhase, FrameCaptureReceipt, FrameCaptureTarget};

    fn status_fixture() -> FrameCaptureStatus {
        FrameCaptureStatus {
            id: "render-13".to_owned().into(),
            streamer_id: "render-13".to_owned(),
            capture_id: "capture-1".to_owned(),
            phase: FrameCapturePhase::Idle,
            capture_context: None,
            target: FrameCaptureTarget::default(),
            observed_generation: String::new(),
            receipts: Vec::new(),
            error: String::new(),
            forceable: false,
            updated_at_ms: 0,
        }
    }

    #[test]
    fn summary_prefers_the_failure_reason() {
        let mut status = status_fixture();
        status.phase = FrameCapturePhase::Failed;
        status.error = "cluster generation drifted".to_owned();
        assert_eq!(status.summary(), "cluster generation drifted");
    }

    #[test]
    fn summary_counts_receipts_when_complete() {
        let mut status = status_fixture();
        status.phase = FrameCapturePhase::Complete;
        status.receipts = vec![
            FrameCaptureReceipt::default(),
            FrameCaptureReceipt::default(),
        ];
        assert_eq!(status.summary(), "2 artifact(s) captured");
    }
}