formualizer-sheetport 0.5.3

SheetPort runtime: bind manifests to workbooks, validate IO, and run sessions deterministically
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

use crate::SheetPortError;
use crate::runtime::{EvalOptions, SheetPort};
use crate::value::{InputUpdate, OutputSnapshot};
use formualizer_eval::engine::RecalcPlan;

type ProgressCallback<'a> = Box<dyn FnMut(BatchProgress<'_>) + Send + 'a>;

/// Execution options for batch runs.
#[derive(Default)]
pub struct BatchOptions<'a> {
    pub eval: EvalOptions,
    pub concurrency: Option<usize>,
    pub progress: Option<ProgressCallback<'a>>,
}

/// Progress information emitted during batch execution.
#[derive(Debug, Clone)]
pub struct BatchProgress<'a> {
    pub completed: usize,
    pub total: usize,
    pub scenario_id: &'a str,
}

/// Input payload for a single batch scenario.
#[derive(Debug, Clone)]
pub struct BatchInput {
    pub id: String,
    pub update: InputUpdate,
}

impl BatchInput {
    pub fn new(id: impl Into<String>, update: InputUpdate) -> Self {
        Self {
            id: id.into(),
            update,
        }
    }
}

/// Result for a single batch scenario.
#[derive(Debug, Clone)]
pub struct BatchResult {
    pub id: String,
    pub outputs: OutputSnapshot,
}

pub struct BatchExecutor<'a> {
    sheetport: &'a mut SheetPort<'a>,
    baseline_update: InputUpdate,
    options: BatchOptions<'a>,
    plan: RecalcPlan,
}

impl<'a> BatchExecutor<'a> {
    pub(crate) fn new(
        sheetport: &'a mut SheetPort<'a>,
        baseline_update: InputUpdate,
        options: BatchOptions<'a>,
        plan: RecalcPlan,
    ) -> Self {
        Self {
            sheetport,
            baseline_update,
            options,
            plan,
        }
    }

    pub fn run<I>(&mut self, scenarios: I) -> Result<Vec<BatchResult>, SheetPortError>
    where
        I: IntoIterator<Item = BatchInput>,
    {
        let cases: Vec<BatchInput> = scenarios.into_iter().collect();
        let total = cases.len();
        let mut results = Vec::with_capacity(total);

        for (idx, case) in cases.into_iter().enumerate() {
            let BatchInput { id, update } = case;
            self.sheetport.write_inputs(self.baseline_update.clone())?;
            if !update.is_empty() {
                self.sheetport.write_inputs(update)?;
            }
            let outputs = self
                .sheetport
                .evaluate_with_plan(&self.plan, self.options.eval.clone())?;
            if let Some(callback) = self.options.progress.as_mut() {
                callback(BatchProgress {
                    completed: idx + 1,
                    total,
                    scenario_id: &id,
                });
            }
            results.push(BatchResult { id, outputs });
        }

        // Restore baseline after all scenarios.
        self.sheetport.write_inputs(self.baseline_update.clone())?;

        Ok(results)
    }
}