zeph-core 0.22.2

Core agent loop, configuration, context builder, metrics, and vault for Zeph
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
// SPDX-FileCopyrightText: 2026 Andrei G <bug-ops>
// SPDX-License-Identifier: MIT OR Apache-2.0

//! `/experiment` slash-command handler for the agent loop.

use std::fmt::Write as _;
use std::sync::Arc;

use super::{Agent, error::AgentError};
use crate::channel::Channel;
use zeph_experiments::{
    BenchmarkSet, Evaluator, ExperimentEngine, ExperimentSource, GridStep, SearchSpace,
};

impl<C: Channel> Agent<C> {
    /// Build an [`ExperimentEngine`] from validated config, returning `Err(message)` on failure.
    async fn build_experiment_engine(
        &mut self,
        config: crate::config::ExperimentConfig,
    ) -> Result<ExperimentEngine, String> {
        let benchmark_path = if let Some(p) = &config.benchmark_file {
            p.clone()
        } else {
            return Err("experiments.benchmark_file is not set in config.".to_owned());
        };

        // Load benchmark via spawn_blocking: from_file uses blocking std::fs I/O
        // (canonicalize, metadata, read_to_string), which must not run on the async worker.
        let benchmark =
            tokio::task::spawn_blocking(move || BenchmarkSet::from_file(&benchmark_path))
                .await
                .map_err(|e| format!("Benchmark load task panicked: {e}"))?
                .map_err(|e| format!("Failed to load benchmark: {e}"))?;

        let provider_arc = Arc::new(self.provider.clone());
        // Use a dedicated eval provider when `eval_provider` is configured, so the judge is
        // independent from the agent under test. Fall back to the primary provider otherwise.
        let judge_arc = self
            .services
            .experiments
            .eval_provider
            .as_ref()
            .map_or_else(|| Arc::clone(&provider_arc), |p| Arc::new(p.clone()));
        let evaluator = Evaluator::new(judge_arc, benchmark, config.eval_budget_tokens)
            .map_err(|e| format!("Failed to create evaluator: {e}"))?
            .with_tolerate_subject_errors(config.tolerate_subject_errors);

        let generator = Box::new(GridStep::new(SearchSpace::default()));
        // Use the pre-built baseline snapshot that reflects actual runtime config values.
        // Set via Agent::with_experiment(); defaults to ConfigSnapshot::default()
        // when not explicitly provided.
        let baseline = self.services.experiments.baseline.clone();
        let memory = self.services.memory.persistence.memory.clone();

        Ok(
            ExperimentEngine::new(evaluator, generator, provider_arc, baseline, config, memory)
                .with_source(ExperimentSource::Manual),
        )
    }

    /// Dispatch `/experiment` returning output as a string instead of writing to the channel.
    ///
    /// All `Arc` clones are extracted before `.await` so `&mut self` is not held across await
    /// boundaries, making the returned future `Send`.
    pub(super) async fn handle_experiment_command_as_string(
        &mut self,
        input: &str,
    ) -> Result<String, AgentError> {
        let args = input.strip_prefix("/experiment").unwrap_or("").trim();
        match args {
            "" | "status" => self.experiment_status().await,
            "stop" => Ok(self.experiment_stop()),
            "report" => self.experiment_report().await,
            "best" => self.experiment_best().await,
            _ if args == "start" || args.starts_with("start ") => {
                let max_override = args
                    .strip_prefix("start")
                    .and_then(|s| s.trim().parse::<u32>().ok());
                Ok(self.experiment_start(max_override).await)
            }
            _ => Ok(
                "Unknown /experiment subcommand. Available: /experiment start [N], \
                 /experiment stop, /experiment status, /experiment report, /experiment best"
                    .to_owned(),
            ),
        }
    }

    async fn experiment_status(&mut self) -> Result<String, AgentError> {
        let running = self
            .services
            .experiments
            .cancel
            .as_ref()
            .is_some_and(|t| !t.is_cancelled());
        let mut msg = if running {
            String::from("Experiment: **running**. Use `/experiment stop` to cancel.")
        } else {
            String::from("Experiment: **idle**. Use `/experiment start [N]` to begin.")
        };
        let memory = self.services.memory.persistence.memory.clone();
        if let Some(memory) = memory {
            let rows = memory.sqlite().list_experiment_results(None, 1).await?;
            if let Some(latest) = rows.first()
                && let Some(summary) = memory
                    .sqlite()
                    .experiment_session_summary(&latest.session_id)
                    .await?
            {
                let sid_len = summary.session_id.len().min(11);
                let _ = write!(
                    msg,
                    "\nLast session: `{}` | {} experiments | {} accepted | best delta: {:.3}",
                    &summary.session_id[..sid_len],
                    summary.total,
                    summary.accepted_count,
                    summary.best_delta,
                );
            }
        }
        Ok(msg)
    }

    fn experiment_stop(&mut self) -> String {
        match &self.services.experiments.cancel {
            Some(token) if !token.is_cancelled() => {
                token.cancel();
                if let Some(h) = self.services.experiments.handle.take() {
                    h.abort();
                }
                self.services.experiments.cancel = None;
                "Experiment session cancelled. Results so far are saved.".to_owned()
            }
            _ => "No experiment is currently running.".to_owned(),
        }
    }

    async fn experiment_report(&mut self) -> Result<String, AgentError> {
        let memory = self.services.memory.persistence.memory.clone();
        let Some(memory) = memory else {
            return Ok("Memory is not enabled — cannot query experiment results.".to_owned());
        };
        let rows = memory.sqlite().list_experiment_results(None, 50).await?;
        if rows.is_empty() {
            return Ok("No experiment results found.".to_owned());
        }
        let mut out = String::from("**Experiment Results** (last 50, newest first)\n\n```\n");
        let _ = writeln!(
            out,
            "{:<8} {:<12} {:<20} {:<8} {:<8} {:<8} {:<8}",
            "ID", "Session", "Parameter", "Delta", "Baseline", "Candidate", "Accepted"
        );
        for r in &rows {
            let sid_len = r.session_id.len().min(11);
            let _ = writeln!(
                out,
                "{:<8} {:<12} {:<20} {:<8.3} {:<8.3} {:<8.3} {:<8}",
                r.id,
                &r.session_id[..sid_len],
                r.parameter,
                r.delta,
                r.baseline_score,
                r.candidate_score,
                if r.accepted { "yes" } else { "no" },
            );
        }
        out.push_str("```");
        Ok(out)
    }

    async fn experiment_best(&mut self) -> Result<String, AgentError> {
        let memory = self.services.memory.persistence.memory.clone();
        let Some(memory) = memory else {
            return Ok("Memory is not enabled — cannot query experiment results.".to_owned());
        };
        let row = memory.sqlite().best_experiment_result(None).await?;
        let msg = match row {
            None => "No accepted experiment results found yet.".to_owned(),
            Some(r) => {
                let sid_len = r.session_id.len().min(11);
                format!(
                    "**Best experiment result**\n\
                     - Session: `{}`\n\
                     - Parameter: `{}`\n\
                     - Delta: `{:.3}` ({:.3}{:.3})\n\
                     - Source: `{}`\n\
                     - At: {}",
                    &r.session_id[..sid_len],
                    r.parameter,
                    r.delta,
                    r.baseline_score,
                    r.candidate_score,
                    r.source,
                    r.created_at,
                )
            }
        };
        Ok(msg)
    }

    async fn experiment_start(&mut self, max_override: Option<u32>) -> String {
        if self
            .services
            .experiments
            .cancel
            .as_ref()
            .is_some_and(|t| !t.is_cancelled())
        {
            return "Experiment already running. Use /experiment stop to cancel.".to_owned();
        }
        let mut config = self.services.experiments.config.clone();
        if !config.enabled {
            return "Experiments are disabled. Set `experiments.enabled = true` in config and restart."
                .to_owned();
        }
        if let Some(n) = max_override {
            config.max_experiments = n;
        }
        if let Err(e) = config.validate() {
            return format!("Experiment config is invalid: {e}");
        }
        let max_n = config.max_experiments;
        let engine = match self.build_experiment_engine(config).await {
            Ok(e) => e,
            Err(msg) => return msg,
        };
        let cancel = engine.cancel_token();
        self.services.experiments.cancel = Some(cancel);
        let notify_tx = self.services.experiments.notify_tx.clone();
        // Routed through TaskSupervisor for observability and graceful shutdown. The handle is
        // stored in ExperimentState so shutdown() can abort it if the CancellationToken is not
        // observed in time (e.g. the task is blocked on I/O).
        let task_handle = self.runtime.lifecycle.task_supervisor.spawn_oneshot(
            std::sync::Arc::from("agent.experiments.session"),
            move || async move {
                let mut engine = engine;
                let msg = match engine.run().await {
                    Ok(report) => {
                        let accepted = report.results.iter().filter(|r| r.accepted).count();
                        let wall_secs =
                            f64::from(u32::try_from(report.wall_time_ms).unwrap_or(u32::MAX))
                                / 1000.0;
                        format!(
                            "Experiment session `{}` complete: {}/{} accepted, \
                                 baseline {:.3}{:.3} (improvement {:.3}), {wall_secs:.1}s{}",
                            &report.session_id[..report.session_id.len().min(8)],
                            accepted,
                            report.results.len(),
                            report.baseline_score,
                            report.final_score,
                            report.total_improvement,
                            if report.cancelled { " [cancelled]" } else { "" },
                        )
                    }
                    Err(e) => format!("Experiment session failed: {e}"),
                };
                let _ = notify_tx.send(msg).await;
            },
        );
        self.services.experiments.handle = Some(task_handle);
        format!(
            "Experiment session starting (max {max_n} experiments). \
             Use /experiment stop to cancel. Results will be shown when complete."
        )
    }
}

#[cfg(test)]
mod tests {
    use super::super::agent_tests::{
        MockChannel, MockToolExecutor, create_test_registry, mock_provider,
    };
    use super::*;

    fn make_agent() -> Agent<MockChannel> {
        Agent::new(
            mock_provider(vec![]),
            MockChannel::new(vec![]),
            create_test_registry(),
            None,
            5,
            MockToolExecutor::no_tools(),
        )
    }

    #[tokio::test]
    async fn unknown_subcommand_returns_help() {
        let mut agent = make_agent();
        let result = agent
            .handle_experiment_command_as_string("/experiment foobar")
            .await
            .unwrap();
        assert!(
            result.contains("Unknown /experiment"),
            "expected help text, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn start_when_disabled_returns_error() {
        let mut agent = make_agent();
        // Default config has enabled = false.
        let result = agent
            .handle_experiment_command_as_string("/experiment start")
            .await
            .unwrap();
        assert!(
            result.contains("disabled"),
            "expected disabled message, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn stop_when_not_running_returns_not_running() {
        let mut agent = make_agent();
        let result = agent
            .handle_experiment_command_as_string("/experiment stop")
            .await
            .unwrap();
        assert!(
            result.contains("No experiment is currently running"),
            "expected not-running message, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn status_when_idle_returns_idle() {
        let mut agent = make_agent();
        let result = agent
            .handle_experiment_command_as_string("/experiment status")
            .await
            .unwrap();
        assert!(
            result.contains("idle"),
            "expected idle status, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn empty_subcommand_returns_status() {
        let mut agent = make_agent();
        let result = agent
            .handle_experiment_command_as_string("/experiment")
            .await
            .unwrap();
        // Empty subcommand maps to status (idle when no experiment running).
        assert!(
            result.contains("idle"),
            "expected idle status for empty subcommand, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn start_while_running_returns_already_running() {
        use tokio_util::sync::CancellationToken;

        let mut agent = make_agent();
        // Simulate a running experiment by inserting a live cancel token.
        agent.services.experiments.cancel = Some(CancellationToken::new());

        let result = agent
            .handle_experiment_command_as_string("/experiment start")
            .await
            .unwrap();
        assert!(
            result.contains("already running"),
            "expected already-running guard, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn report_without_memory_returns_error() {
        let mut agent = make_agent();
        // No memory wired → should return the "not enabled" message.
        let result = agent
            .handle_experiment_command_as_string("/experiment report")
            .await
            .unwrap();
        assert!(
            result.contains("Memory is not enabled"),
            "expected no-memory message, got: {result:?}"
        );
    }

    #[tokio::test]
    async fn best_without_memory_returns_error() {
        let mut agent = make_agent();
        let result = agent
            .handle_experiment_command_as_string("/experiment best")
            .await
            .unwrap();
        assert!(
            result.contains("Memory is not enabled"),
            "expected no-memory message, got: {result:?}"
        );
    }

    /// Verify that `tolerate_subject_errors` from `ExperimentConfig` is forwarded to
    /// `Evaluator::with_tolerate_subject_errors` in `build_experiment_engine`.
    ///
    /// Uses a real temporary benchmark TOML so the code reaches the `.with_tolerate_subject_errors`
    /// call site. Success (no error returned) confirms the builder chain is invoked correctly;
    /// the underlying field value is passed through without transformation.
    #[tokio::test]
    async fn build_experiment_engine_forwards_tolerate_subject_errors() {
        use std::io::Write as _;
        use zeph_config::ExperimentConfig;

        let mut f = tempfile::NamedTempFile::new().unwrap();
        writeln!(f, "[[cases]]\nprompt = \"hello\"").unwrap();

        let config = ExperimentConfig {
            enabled: true,
            benchmark_file: Some(f.path().to_path_buf()),
            tolerate_subject_errors: true,
            ..ExperimentConfig::default()
        };

        let mut agent = make_agent();
        // build_experiment_engine must succeed and silently forward the flag to the Evaluator.
        let result = agent.build_experiment_engine(config).await;
        assert!(
            result.is_ok(),
            "build_experiment_engine must succeed with a valid benchmark file"
        );
    }

    /// Verify that a missing benchmark file surfaces its error through the
    /// `spawn_blocking(...).await.map_err(...)?.map_err(...)?` chain, rather than being
    /// swallowed or turned into a panic message by the async conversion.
    #[tokio::test]
    async fn build_experiment_engine_missing_benchmark_file_surfaces_error() {
        use zeph_config::ExperimentConfig;

        let config = ExperimentConfig {
            enabled: true,
            benchmark_file: Some(std::path::PathBuf::from("/nonexistent/path/benchmark.toml")),
            ..ExperimentConfig::default()
        };

        let mut agent = make_agent();
        match agent.build_experiment_engine(config).await {
            Err(msg) => assert!(
                msg.contains("Failed to load benchmark"),
                "expected benchmark-load error to surface through spawn_blocking, got: {msg}"
            ),
            Ok(_) => {
                panic!("expected build_experiment_engine to fail for a missing benchmark file")
            }
        }
    }
}