devboy-skills 0.28.1

Skills subsystem for devboy-tools — SKILL.md frontmatter parser, install/upgrade lifecycle, manifest model (ADR-012/014).
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

//! [`EmbeddedSkillSource`] — baseline skills compiled into the binary.
//!
//! The on-disk layout is the `skills/` tree at the repository root. At
//! build time [`rust_embed`] pulls every `SKILL.md` under that tree into
//! the binary so installed users never need the repository itself.
//!
//! The matching install-time historical hash registry lives next to this
//! module (see [`crate::manifest::HistoricalHashes`]) — the two are kept
//! in lock-step so an upgrade can tell whether a file on disk is the
//! current shipped version, a previous shipped version (safe to
//! auto-upgrade), or a user modification.

use std::collections::BTreeMap;

use async_trait::async_trait;
use rust_embed::RustEmbed;

use crate::error::{Result, SkillError};
use crate::skill::{Skill, SkillSummary};
use crate::source::SkillSource;

/// Embedder wrapper around the in-crate `skills/` directory.
///
/// The `RustEmbed` folder path is relative to the crate root. The tree
/// lives inside the crate (at `crates/devboy-skills/skills/`) so that
/// `cargo publish` can package it — see ADR-022 for the rationale.
#[derive(RustEmbed)]
#[folder = "skills/"]
#[include = "*/*/SKILL.md"]
struct BaselineAssets;

/// Source that reads skills embedded into the binary at build time.
#[derive(Default, Clone)]
pub struct EmbeddedSkillSource;

impl EmbeddedSkillSource {
    /// Create a new embedded source. Construction is free — all work
    /// happens on `list` / `load`.
    pub fn new() -> Self {
        Self
    }

    /// Iterate over the (skill-name, file-bytes) pairs produced by the
    /// embedder, skipping anything that does not match the
    /// `<category>/<skill>/SKILL.md` shape.
    fn iter() -> impl Iterator<Item = (String, Vec<u8>)> {
        BaselineAssets::iter().filter_map(|path| {
            let path_str = path.as_ref().to_string();
            // Expect exactly three path segments (category, skill, SKILL.md).
            let parts: Vec<&str> = path_str.split('/').collect();
            if parts.len() != 3 || parts[2] != "SKILL.md" {
                return None;
            }
            let skill_dir = parts[1].to_string();
            BaselineAssets::get(&path_str).map(|f| (skill_dir, f.data.into_owned()))
        })
    }

    fn load_skill(name: &str) -> Result<Skill> {
        let contents = Self::iter()
            .find(|(n, _)| n == name)
            .map(|(_, bytes)| bytes)
            .ok_or_else(|| SkillError::NotFound {
                name: name.to_string(),
                source_name: "embedded",
            })?;
        let text = String::from_utf8(contents).map_err(|e| SkillError::InvalidFieldType {
            skill: name.to_string(),
            field: "<body>",
            reason: format!("SKILL.md is not valid UTF-8: {e}"),
        })?;
        Skill::parse(name, &text)
    }

    /// Return every embedded skill, keyed by skill name. Useful for
    /// callers that want to iterate without going through
    /// [`SkillSource::list`].
    pub fn all() -> Result<BTreeMap<String, Skill>> {
        let mut out = BTreeMap::new();
        for (name, bytes) in Self::iter() {
            let text = String::from_utf8(bytes).map_err(|e| SkillError::InvalidFieldType {
                skill: name.clone(),
                field: "<body>",
                reason: format!("SKILL.md is not valid UTF-8: {e}"),
            })?;
            out.insert(name.clone(), Skill::parse(&name, &text)?);
        }
        Ok(out)
    }
}

#[async_trait]
impl SkillSource for EmbeddedSkillSource {
    fn name(&self) -> &'static str {
        "embedded"
    }

    async fn list(&self) -> Result<Vec<SkillSummary>> {
        let mut summaries = Vec::new();
        for (name, bytes) in Self::iter() {
            let text = String::from_utf8(bytes).map_err(|e| SkillError::InvalidFieldType {
                skill: name.clone(),
                field: "<body>",
                reason: format!("SKILL.md is not valid UTF-8: {e}"),
            })?;
            let skill = Skill::parse(&name, &text)?;
            summaries.push(SkillSummary::from(&skill));
        }
        summaries.sort_by(|a, b| (a.category, &a.name).cmp(&(b.category, &b.name)));
        Ok(summaries)
    }

    async fn load(&self, name: &str) -> Result<Skill> {
        Self::load_skill(name)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn list_returns_empty_or_valid_before_any_skills_ship() {
        // Until the first baseline skill lands under `skills/`, the
        // embedder has nothing to produce. Either way, `list` must not
        // error — it just returns an empty vec or a set of valid
        // summaries.
        let source = EmbeddedSkillSource::new();
        let summaries = source.list().await.expect("list should not fail");
        for s in &summaries {
            assert!(!s.name.is_empty());
            assert!(!s.description.is_empty());
        }
    }

    #[tokio::test]
    async fn load_missing_skill_returns_not_found() {
        let source = EmbeddedSkillSource::new();
        let err = source.load("does-not-exist").await.unwrap_err();
        assert!(
            matches!(
                err,
                SkillError::NotFound {
                    source_name: "embedded",
                    ..
                }
            ),
            "expected NotFound(embedded), got {err:?}"
        );
    }

    #[test]
    fn source_name_is_embedded() {
        let source = EmbeddedSkillSource::new();
        assert_eq!(source.name(), "embedded");
    }

    #[test]
    fn all_returns_every_embedded_skill() {
        // `all()` should match `iter()` in shape: every entry parses as
        // a Skill with a non-empty name and a category consistent with
        // the on-disk folder tree (`skills/<NN-category>/<skill>/SKILL.md`).
        let all = EmbeddedSkillSource::all().expect("embedded skills parse");
        for (name, skill) in &all {
            assert_eq!(name, skill.name(), "map key matches skill name");
            assert!(!skill.frontmatter.description.is_empty());
            assert!(skill.version() > 0);
        }
        // `list()` covers every skill `all()` does, just as summaries.
        let summaries = tokio::runtime::Runtime::new()
            .unwrap()
            .block_on(EmbeddedSkillSource::new().list())
            .unwrap();
        assert_eq!(summaries.len(), all.len());
    }

    #[tokio::test]
    async fn load_returns_parsed_skill_for_known_name() {
        // Pick whichever skill `all()` produces first — avoids tying the
        // test to a specific skill that may be renamed later.
        let all = EmbeddedSkillSource::all().unwrap();
        let Some((name, _)) = all.iter().next() else {
            // If the catalogue is empty for some build, the earlier
            // `list_returns_empty_or_valid_before_any_skills_ship`
            // test already covers that case.
            return;
        };
        let source = EmbeddedSkillSource::new();
        let skill = source.load(name).await.expect("known skill loads");
        assert_eq!(skill.name(), name);
    }

    #[tokio::test]
    async fn list_is_sorted_by_category_then_name() {
        let source = EmbeddedSkillSource::new();
        let summaries = source.list().await.unwrap();
        for pair in summaries.windows(2) {
            let (a, b) = (&pair[0], &pair[1]);
            let ord = (a.category, a.name.as_str()).cmp(&(b.category, b.name.as_str()));
            assert!(
                ord == std::cmp::Ordering::Less || ord == std::cmp::Ordering::Equal,
                "summaries not sorted: {} then {}",
                a.name,
                b.name
            );
        }
    }
}