apcore 0.22.0

Schema-driven module standard for AI-perceivable interfaces
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

// APCore Protocol — Version negotiation
// Spec reference: Protocol version compatibility checks

use crate::errors::{ErrorCode, ModuleError, VersionIncompatibleError};

/// A parsed semver version with optional prerelease suffix.
#[derive(Debug, Clone, PartialEq, Eq)]
struct SemVer {
    major: u64,
    minor: u64,
    patch: u64,
    /// `None` means a release version; `Some(tag)` means a prerelease.
    prerelease: Option<String>,
}

impl SemVer {
    /// Format back to a version string.
    fn to_string_repr(&self) -> String {
        match &self.prerelease {
            Some(pre) => format!("{}.{}.{}-{}", self.major, self.minor, self.patch, pre),
            None => format!("{}.{}.{}", self.major, self.minor, self.patch),
        }
    }
}

/// Semver ordering: major > minor > patch, then prerelease < release.
/// Among prereleases with the same major.minor.patch, compare lexicographically.
impl Ord for SemVer {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.major
            .cmp(&other.major)
            .then(self.minor.cmp(&other.minor))
            .then(self.patch.cmp(&other.patch))
            .then(match (&self.prerelease, &other.prerelease) {
                (None, None) => std::cmp::Ordering::Equal,
                // Release > prerelease
                (None, Some(_)) => std::cmp::Ordering::Greater,
                (Some(_), None) => std::cmp::Ordering::Less,
                (Some(a), Some(b)) => a.cmp(b),
            })
    }
}

impl PartialOrd for SemVer {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

/// Parse a semver string into a `SemVer` struct.
///
/// Accepts versions like `"1.2.3"` and `"1.2.3-alpha"`.
fn parse_semver(version: &str) -> Option<SemVer> {
    let parts: Vec<&str> = version.split('.').collect();
    if parts.len() != 3 {
        return None;
    }
    let major = parts[0].parse::<u64>().ok()?;
    let minor = parts[1].parse::<u64>().ok()?;

    // The patch segment may contain a prerelease suffix: "3-alpha"
    let (patch, prerelease) = if let Some(dash_pos) = parts[2].find('-') {
        let patch_str = &parts[2][..dash_pos];
        let pre_str = &parts[2][dash_pos + 1..];
        if pre_str.is_empty() {
            return None;
        }
        (patch_str.parse::<u64>().ok()?, Some(pre_str.to_string()))
    } else {
        (parts[2].parse::<u64>().ok()?, None)
    };

    Some(SemVer {
        major,
        minor,
        patch,
        prerelease,
    })
}

/// Negotiate a compatible protocol version between a declared version and
/// the SDK version (Algorithm A14).
///
/// Returns the effective version string, or an error if the versions are
/// incompatible (major mismatch or declared minor exceeds SDK minor).
pub fn negotiate_version(declared_version: &str, sdk_version: &str) -> Result<String, ModuleError> {
    let declared = parse_semver(declared_version).ok_or_else(|| {
        ModuleError::new(
            ErrorCode::VersionIncompatible,
            format!("Invalid declared version: {declared_version}"),
        )
    })?;

    let sdk = parse_semver(sdk_version).ok_or_else(|| {
        ModuleError::new(
            ErrorCode::VersionIncompatible,
            format!("Invalid SDK version: {sdk_version}"),
        )
    })?;

    // Major mismatch -> error
    if declared.major != sdk.major {
        let err = VersionIncompatibleError {
            message: format!(
                "Major version mismatch: declared {declared_version} vs SDK {sdk_version}"
            ),
        };
        return Err(err.to_module_error());
    }

    // Declared minor > SDK minor -> error (SDK too old)
    if declared.minor > sdk.minor {
        let err = VersionIncompatibleError {
            message: format!(
                "Declared minor version {} exceeds SDK minor version {} (SDK too old)",
                declared.minor, sdk.minor
            ),
        };
        return Err(err.to_module_error());
    }

    // Declared minor < SDK minor -> return declared (backward compat)
    if declared.minor < sdk.minor {
        return Ok(declared_version.to_string());
    }

    // Same minor -> return max(declared, sdk)
    let effective = std::cmp::max(&declared, &sdk);
    Ok(effective.to_string_repr())
}

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

    #[test]
    fn test_parse_semver_basic() {
        let v = parse_semver("1.2.3").unwrap();
        assert_eq!(v.major, 1);
        assert_eq!(v.minor, 2);
        assert_eq!(v.patch, 3);
        assert_eq!(v.prerelease, None);
    }

    #[test]
    fn test_parse_semver_with_prerelease() {
        let v = parse_semver("1.0.0-alpha").unwrap();
        assert_eq!(v.major, 1);
        assert_eq!(v.minor, 0);
        assert_eq!(v.patch, 0);
        assert_eq!(v.prerelease, Some("alpha".to_string()));
    }

    #[test]
    fn test_parse_semver_invalid_too_few_parts() {
        assert!(parse_semver("1.2").is_none());
    }

    #[test]
    fn test_parse_semver_invalid_too_many_parts() {
        assert!(parse_semver("1.2.3.4").is_none());
    }

    #[test]
    fn test_parse_semver_invalid_non_numeric() {
        assert!(parse_semver("a.b.c").is_none());
    }

    #[test]
    fn test_parse_semver_empty_prerelease_rejected() {
        assert!(parse_semver("1.0.0-").is_none());
    }

    #[test]
    fn test_semver_ordering_major() {
        let v1 = parse_semver("1.0.0").unwrap();
        let v2 = parse_semver("2.0.0").unwrap();
        assert!(v1 < v2);
    }

    #[test]
    fn test_semver_ordering_minor() {
        let v1 = parse_semver("1.1.0").unwrap();
        let v2 = parse_semver("1.2.0").unwrap();
        assert!(v1 < v2);
    }

    #[test]
    fn test_semver_ordering_patch() {
        let v1 = parse_semver("1.0.1").unwrap();
        let v2 = parse_semver("1.0.2").unwrap();
        assert!(v1 < v2);
    }

    #[test]
    fn test_semver_prerelease_less_than_release() {
        let pre = parse_semver("1.0.0-alpha").unwrap();
        let rel = parse_semver("1.0.0").unwrap();
        assert!(pre < rel);
    }

    #[test]
    fn test_semver_prerelease_lexicographic() {
        let alpha = parse_semver("1.0.0-alpha").unwrap();
        let beta = parse_semver("1.0.0-beta").unwrap();
        assert!(alpha < beta);
    }

    #[test]
    fn test_semver_to_string_repr() {
        let v = parse_semver("1.2.3").unwrap();
        assert_eq!(v.to_string_repr(), "1.2.3");

        let v_pre = parse_semver("1.2.3-rc1").unwrap();
        assert_eq!(v_pre.to_string_repr(), "1.2.3-rc1");
    }

    #[test]
    fn test_negotiate_same_version() {
        let result = negotiate_version("1.2.3", "1.2.3").unwrap();
        assert_eq!(result, "1.2.3");
    }

    #[test]
    fn test_negotiate_declared_older_minor() {
        let result = negotiate_version("1.1.0", "1.3.0").unwrap();
        assert_eq!(result, "1.1.0");
    }

    #[test]
    fn test_negotiate_declared_newer_minor_fails() {
        let result = negotiate_version("1.5.0", "1.3.0");
        assert!(result.is_err());
        assert_eq!(result.unwrap_err().code, ErrorCode::VersionIncompatible);
    }

    #[test]
    fn test_negotiate_major_mismatch_fails() {
        let result = negotiate_version("2.0.0", "1.0.0");
        assert!(result.is_err());
        assert_eq!(result.unwrap_err().code, ErrorCode::VersionIncompatible);
    }

    #[test]
    fn test_negotiate_same_minor_higher_sdk_patch() {
        let result = negotiate_version("1.2.0", "1.2.5").unwrap();
        assert_eq!(result, "1.2.5");
    }

    #[test]
    fn test_negotiate_same_minor_higher_declared_patch() {
        let result = negotiate_version("1.2.5", "1.2.0").unwrap();
        assert_eq!(result, "1.2.5");
    }

    #[test]
    fn test_negotiate_prerelease_vs_release_same_version() {
        let result = negotiate_version("1.2.0-alpha", "1.2.0").unwrap();
        assert_eq!(result, "1.2.0");
    }

    #[test]
    fn test_negotiate_invalid_declared_version() {
        let result = negotiate_version("not.a.version", "1.0.0");
        assert!(result.is_err());
    }

    #[test]
    fn test_negotiate_invalid_sdk_version() {
        let result = negotiate_version("1.0.0", "bad");
        assert!(result.is_err());
    }
}