sh-layer3 1.0.2

Continuum Layer 3: Capabilities
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
//! # Workflow Tools
//!
//! 工作流控制工具集,提供检查点保存和恢复功能。
//!
//! 使用 Layer2 CheckpointSystem 实现持久化。

use crate::builtin_tools::BuiltinTool;
use crate::types::{Layer3Result, ToolCategory};
use async_trait::async_trait;
use chrono::Utc;
use std::path::PathBuf;
use std::sync::Arc;

// Layer2 CheckpointSystem integration
use sh_layer2::{CheckpointData, CheckpointId, CheckpointSystemTrait, CheckpointWriter, SessionId};

/// 默认检查点存储路径
fn default_checkpoint_path() -> PathBuf {
    std::env::temp_dir().join("continuum_checkpoints")
}

/// Create Checkpoint Tool
///
/// 保存当前会话状态到检查点文件。
/// 使用 Layer2 CheckpointWriter 实现原子写入和完整性验证。
pub struct CreateCheckpointTool {
    writer: Arc<CheckpointWriter>,
}

impl CreateCheckpointTool {
    /// 创建新工具,使用默认存储路径
    pub fn new() -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(default_checkpoint_path())),
        }
    }

    /// 使用自定义存储路径
    pub fn with_path(path: PathBuf) -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(path)),
        }
    }
}

impl Default for CreateCheckpointTool {
    fn default() -> Self {
        Self::new()
    }
}

#[async_trait]
impl BuiltinTool for CreateCheckpointTool {
    fn name(&self) -> &str {
        "create_checkpoint"
    }

    fn description(&self) -> &str {
        "Create a checkpoint to save current agent state to a file."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "object",
            "properties": {
                "session_id": {
                    "type": "string",
                    "description": "The session ID to checkpoint"
                },
                "trigger": {
                    "type": "string",
                    "description": "Optional: trigger reason for the checkpoint (default: 'manual')"
                },
                "messages": {
                    "type": "array",
                    "description": "Optional: message history to save",
                    "items": {
                        "type": "object",
                        "properties": {
                            "role": { "type": "string" },
                            "content": { "type": "string" }
                        }
                    }
                },
                "iteration": {
                    "type": "integer",
                    "description": "Optional: current iteration number (default: 0)"
                },
                "tokens_used": {
                    "type": "integer",
                    "description": "Optional: tokens used so far (default: 0)"
                }
            },
            "required": ["session_id"]
        })
    }

    fn category(&self) -> ToolCategory {
        ToolCategory::Workflow
    }

    async fn execute(&self, args: serde_json::Value) -> Layer3Result<String> {
        let session_id_str = args["session_id"]
            .as_str()
            .ok_or_else(|| anyhow::anyhow!("Missing session_id parameter"))?;

        let session_id = SessionId::from(session_id_str);
        let trigger = args["trigger"].as_str().unwrap_or("manual");
        let iteration = args["iteration"].as_i64().unwrap_or(0) as i32;
        let tokens_used = args["tokens_used"].as_i64().unwrap_or(0);

        let messages = args["messages"].as_array().cloned().unwrap_or_default();

        let tool_calls_pending = args["tool_calls_pending"]
            .as_array()
            .cloned()
            .unwrap_or_default();

        let tool_results = args
            .get("tool_results")
            .cloned()
            .unwrap_or(serde_json::Value::Null);

        // 构建 CheckpointData (Layer2 格式)
        let checkpoint_data = CheckpointData {
            checkpoint_id: CheckpointId::new(),
            session_id: session_id.clone(),
            created_at: Utc::now(),
            trigger: trigger.to_string(),
            iteration,
            messages,
            tool_calls_pending,
            tool_results,
            tokens_used,
            cost_estimate: 0.0,
            resume_hint: None,
        };

        // 使用 Layer2 CheckpointWriter 保存
        let checkpoint_id = self.writer.save(&checkpoint_data).await?;

        Ok(format!(
            "Checkpoint created: {}\nSession: {}\nTrigger: {}\nIteration: {}",
            checkpoint_id, session_id, trigger, iteration
        ))
    }
}

/// Restore Checkpoint Tool
///
/// 从检查点文件恢复会话状态。
/// 使用 Layer2 CheckpointWriter 实现读取和验证。
pub struct RestoreCheckpointTool {
    writer: Arc<CheckpointWriter>,
}

impl RestoreCheckpointTool {
    /// 创建新工具,使用默认存储路径
    pub fn new() -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(default_checkpoint_path())),
        }
    }

    /// 使用自定义存储路径
    pub fn with_path(path: PathBuf) -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(path)),
        }
    }
}

impl Default for RestoreCheckpointTool {
    fn default() -> Self {
        Self::new()
    }
}

#[async_trait]
impl BuiltinTool for RestoreCheckpointTool {
    fn name(&self) -> &str {
        "restore_checkpoint"
    }

    fn description(&self) -> &str {
        "Restore agent state from a checkpoint file."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "object",
            "properties": {
                "session_id": {
                    "type": "string",
                    "description": "The session ID to restore"
                },
                "checkpoint_id": {
                    "type": "string",
                    "description": "Optional: specific checkpoint ID (default: latest)"
                }
            },
            "required": ["session_id"]
        })
    }

    fn category(&self) -> ToolCategory {
        ToolCategory::Workflow
    }

    async fn execute(&self, args: serde_json::Value) -> Layer3Result<String> {
        let session_id_str = args["session_id"]
            .as_str()
            .ok_or_else(|| anyhow::anyhow!("Missing session_id parameter"))?;

        let session_id = SessionId::from(session_id_str);
        let checkpoint_id_opt = args["checkpoint_id"]
            .as_str()
            .map(|s| CheckpointId(s.to_string()));

        // 使用 Layer2 CheckpointWriter 加载
        let result = self
            .writer
            .load(&session_id, checkpoint_id_opt.as_ref())
            .await?;

        match result {
            Some(checkpoint) => {
                Ok(format!(
                    "Checkpoint restored: {}\nSession: {}\nTrigger: {}\nIteration: {}\nMessages: {}\nTokens used: {}",
                    checkpoint.checkpoint_id,
                    checkpoint.session_id,
                    checkpoint.trigger,
                    checkpoint.iteration,
                    checkpoint.messages.len(),
                    checkpoint.tokens_used
                ))
            }
            None => Err(anyhow::anyhow!(
                "No checkpoints found for session: {}",
                session_id_str
            )),
        }
    }
}

/// List Checkpoints Tool
///
/// 列出会话的所有检查点。
/// 使用 Layer2 CheckpointWriter 实现。
pub struct ListCheckpointsTool {
    writer: Arc<CheckpointWriter>,
}

impl ListCheckpointsTool {
    pub fn new() -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(default_checkpoint_path())),
        }
    }

    pub fn with_path(path: PathBuf) -> Self {
        Self {
            writer: Arc::new(CheckpointWriter::new(path)),
        }
    }
}

impl Default for ListCheckpointsTool {
    fn default() -> Self {
        Self::new()
    }
}

#[async_trait]
impl BuiltinTool for ListCheckpointsTool {
    fn name(&self) -> &str {
        "list_checkpoints"
    }

    fn description(&self) -> &str {
        "List all checkpoints for a session."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        serde_json::json!({
            "type": "object",
            "properties": {
                "session_id": {
                    "type": "string",
                    "description": "The session ID to list checkpoints for"
                }
            },
            "required": ["session_id"]
        })
    }

    fn category(&self) -> ToolCategory {
        ToolCategory::Workflow
    }

    async fn execute(&self, args: serde_json::Value) -> Layer3Result<String> {
        let session_id_str = args["session_id"]
            .as_str()
            .ok_or_else(|| anyhow::anyhow!("Missing session_id parameter"))?;

        let session_id = SessionId::from(session_id_str);

        // 使用 Layer2 CheckpointWriter 列出检查点
        let checkpoints = self.writer.list(&session_id).await?;

        if checkpoints.is_empty() {
            return Ok(format!(
                "No checkpoints found for session: {}",
                session_id_str
            ));
        }

        let mut result = format!("Checkpoints for session {}:\n", session_id_str);
        for (i, meta) in checkpoints.iter().enumerate() {
            result.push_str(&format!(
                "  {}. {} (created: {})\n",
                i + 1,
                meta.checkpoint_id,
                meta.created_at.format("%Y-%m-%d %H:%M:%S")
            ));
        }

        Ok(result)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;
    use tempfile::TempDir;

    #[test]
    fn test_checkpoint_tool_category() {
        let tool = CreateCheckpointTool::new();
        assert_eq!(tool.category(), ToolCategory::Workflow);
    }

    #[test]
    fn test_restore_checkpoint_tool_category() {
        let tool = RestoreCheckpointTool::new();
        assert_eq!(tool.category(), ToolCategory::Workflow);
    }

    #[tokio::test]
    async fn test_create_checkpoint() {
        let temp_dir = TempDir::new().unwrap();
        let tool = CreateCheckpointTool::with_path(temp_dir.path().to_path_buf());

        let result = tool
            .execute(json!({
                "session_id": "test_session",
                "trigger": "manual",
                "messages": [{"role": "user", "content": "hello"}],
                "iteration": 1
            }))
            .await;

        assert!(result.is_ok());
        let output = result.unwrap();
        assert!(output.contains("Checkpoint created"));
        assert!(output.contains("test_session"));
    }

    #[tokio::test]
    async fn test_restore_checkpoint() {
        let temp_dir = TempDir::new().unwrap();
        let create_tool = CreateCheckpointTool::with_path(temp_dir.path().to_path_buf());

        // 先创建检查点
        create_tool
            .execute(json!({
                "session_id": "test_session",
                "messages": [{"role": "user", "content": "test"}]
            }))
            .await
            .unwrap();

        // 然后恢复
        let restore_tool = RestoreCheckpointTool::with_path(temp_dir.path().to_path_buf());
        let result = restore_tool
            .execute(json!({"session_id": "test_session"}))
            .await;

        assert!(result.is_ok());
        let output = result.unwrap();
        assert!(output.contains("Checkpoint restored"));
    }

    #[tokio::test]
    async fn test_restore_nonexistent_checkpoint() {
        let temp_dir = TempDir::new().unwrap();
        let tool = RestoreCheckpointTool::with_path(temp_dir.path().to_path_buf());

        let result = tool
            .execute(json!({"session_id": "nonexistent_session"}))
            .await;

        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("No checkpoints found"));
    }

    #[tokio::test]
    async fn test_list_checkpoints() {
        let temp_dir = TempDir::new().unwrap();
        let create_tool = CreateCheckpointTool::with_path(temp_dir.path().to_path_buf());

        // 创建多个检查点
        create_tool
            .execute(json!({"session_id": "test_session"}))
            .await
            .unwrap();

        let list_tool = ListCheckpointsTool::with_path(temp_dir.path().to_path_buf());
        let result = list_tool
            .execute(json!({"session_id": "test_session"}))
            .await;

        assert!(result.is_ok());
        let output = result.unwrap();
        assert!(output.contains("Checkpoints for session"));
    }
}