memstead-base 0.8.0

Engine internals for Memstead — store, parser, validators, filesystem-mem engine. Internal library surface consumed by the memstead binaries — pre-1.0, experimental, no API stability promise.
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
//! Strict config parsing for the archive's `.memstead/config.json`.
//!
//! Whitelist projection: `deny_unknown_fields`, required slug-shaped
//! `name`, required semver `version`, required `schema: "<name>@<ver>"`.
//! Schema resolution against the engine's registry happens at load, not
//! here — this module only enforces shape and format integer.

use memstead_schema::{PUBLISHED_MEM_FORMAT, PublishedMemConfig};
use regex::Regex;
use std::sync::OnceLock;

use super::ValidationError;

/// The only shape the archive's `.memstead/config.json` is allowed to
/// take. Author-only fields (writeGuidance, mediums, projections,
/// rules, publish, readMems, vcs, language, community,
/// defaultSchema) are stripped at export. Their presence here means
/// the archive was built before the whitelist export landed, or by
/// hand — surface that specifically so the user knows to re-export
/// rather than debug a raw serde error.
const LEGACY_AUTHOR_FIELDS: &[&str] = &[
    "writeGuidance",
    "mediums",
    "projections",
    "rules",
    "publish",
    "readMems",
    "vcs",
    "language",
    "community",
    "defaultSchema",
];

/// Parse strict config bytes into a `PublishedMemConfig`. Runs every
/// check in this module (shape, legacy detection, format, name,
/// version, schema resolution).
pub fn parse_config_bytes(bytes: &[u8]) -> Result<PublishedMemConfig, ValidationError> {
    let value: serde_json::Value =
        serde_json::from_slice(bytes).map_err(|e| ValidationError::InvalidConfig {
            reason: format!("malformed JSON: {e}"),
        })?;

    if let Some(obj) = value.as_object() {
        for &field in LEGACY_AUTHOR_FIELDS {
            if obj.contains_key(field) {
                return Err(ValidationError::InvalidConfig {
                    reason: "legacy mem format — re-export via `memstead export`".to_string(),
                });
            }
        }
    } else {
        return Err(ValidationError::InvalidConfig {
            reason: "expected a JSON object".to_string(),
        });
    }

    let config: PublishedMemConfig =
        serde_json::from_value(value).map_err(|e| ValidationError::InvalidConfig {
            reason: e.to_string(),
        })?;

    check_format(&config)?;
    check_name(&config.name)?;
    check_version(&config.version)?;

    Ok(config)
}

fn check_format(config: &PublishedMemConfig) -> Result<(), ValidationError> {
    // Readers accept the current format AND format 3 (pre-title/subject:
    // such an archive simply has neither field) — the single shared
    // predicate keeps acceptance from drifting per surface.
    if memstead_schema::published_format_accepted(config.format) {
        return Ok(());
    }
    // `format: 2` archives (top-level `schema/` tree, pre-relocation)
    // are rejected with an actionable re-export hint. Any other
    // mismatch falls through to the generic `UnsupportedFormat`.
    if config.format == 2 {
        return Err(ValidationError::InvalidConfig {
            reason: "legacy mem format (format: 2) — re-export via `memstead export`".to_string(),
        });
    }
    Err(ValidationError::UnsupportedFormat {
        got: config.format,
        expected: PUBLISHED_MEM_FORMAT,
    })
}

fn name_regex() -> &'static Regex {
    static RE: OnceLock<Regex> = OnceLock::new();
    RE.get_or_init(|| Regex::new(r"^[a-z0-9][a-z0-9-]{0,62}[a-z0-9]$").unwrap())
}

fn check_name(name: &str) -> Result<(), ValidationError> {
    if !name_regex().is_match(name) {
        return Err(ValidationError::InvalidName {
            reason: format!("name must match ^[a-z0-9][a-z0-9-]{{0,62}}[a-z0-9]$, got {name:?}"),
        });
    }
    Ok(())
}

/// Guard against a pathological pre-release or build-metadata string
/// that is otherwise free to be arbitrarily long per the semver spec.
const MAX_VERSION_PRE_BUILD: usize = 128;

fn check_version(version: &semver::Version) -> Result<(), ValidationError> {
    let pre_len = version.pre.as_str().len();
    let build_len = version.build.as_str().len();
    if pre_len + build_len > MAX_VERSION_PRE_BUILD {
        return Err(ValidationError::InvalidVersion {
            reason: format!(
                "pre-release + build metadata length {} exceeds cap {}",
                pre_len + build_len,
                MAX_VERSION_PRE_BUILD
            ),
        });
    }
    Ok(())
}

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

    fn ok_config() -> serde_json::Value {
        serde_json::json!({
            "format": PUBLISHED_MEM_FORMAT,
            "name": "example-mem",
            "version": "0.1.0",
            "schema": "default@1.0.0",
        })
    }

    fn parse(value: serde_json::Value) -> Result<PublishedMemConfig, ValidationError> {
        parse_config_bytes(value.to_string().as_bytes())
    }

    #[test]
    fn accepts_minimal_valid_config() {
        let config = parse(ok_config()).unwrap();
        assert_eq!(config.format, PUBLISHED_MEM_FORMAT);
        assert_eq!(config.name, "example-mem");
        assert_eq!(config.version.to_string(), "0.1.0");
    }

    #[test]
    fn rejects_malformed_json() {
        let err = parse_config_bytes(b"not json").unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_non_object_root() {
        let err = parse(serde_json::json!([])).unwrap_err();
        assert!(
            matches!(err, ValidationError::InvalidConfig { reason } if reason.contains("object"))
        );
    }

    #[test]
    fn rejects_legacy_author_fields_with_actionable_message() {
        let mut v = ok_config();
        v["writeGuidance"] = serde_json::json!({});
        let err = parse(v).unwrap_err();
        match err {
            ValidationError::InvalidConfig { reason } => {
                assert!(reason.contains("legacy mem format"), "reason={reason}");
            }
            other => panic!("expected InvalidConfig, got {other:?}"),
        }
    }

    #[test]
    fn rejects_unknown_top_level_key() {
        let mut v = ok_config();
        v["unexpected"] = serde_json::json!(42);
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_missing_format() {
        let mut v = ok_config();
        v.as_object_mut().unwrap().remove("format");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    /// Forge refusal: a publisher cannot smuggle a first-party trust claim
    /// into a mem archive. Trust origin is decided by the consuming
    /// engine (built-in catalogue + writable-mount adoption), never read
    /// from publisher-supplied config, so an archive config that carries an
    /// `origin` (or any first-party-claim) key is an unknown field and the
    /// `deny_unknown_fields` whitelist refuses it with a typed
    /// `InvalidConfig` — no path admits the claim.
    #[test]
    fn rejects_forged_first_party_origin_claim() {
        let mut v = ok_config();
        v["origin"] = serde_json::json!("first-party");
        let err = parse(v).unwrap_err();
        assert!(
            matches!(err, ValidationError::InvalidConfig { .. }),
            "a forged first-party origin claim must be refused with a typed InvalidConfig, got {err:?}"
        );
    }

    #[test]
    fn rejects_wrong_format_version() {
        let mut v = ok_config();
        v["format"] = serde_json::json!(1);
        let err = parse(v).unwrap_err();
        assert!(
            matches!(
                err,
                ValidationError::UnsupportedFormat {
                    got: 1,
                    expected: _
                }
            ),
            "unexpected err: {err:?}"
        );
    }

    #[test]
    fn rejects_format_2_with_actionable_reexport_hint() {
        let mut v = ok_config();
        v["format"] = serde_json::json!(2);
        let err = parse(v).unwrap_err();
        match err {
            ValidationError::InvalidConfig { reason } => {
                assert!(
                    reason.contains("format: 2") && reason.contains("memstead export"),
                    "reason={reason}"
                );
            }
            other => panic!("expected InvalidConfig with re-export hint, got {other:?}"),
        }
    }

    #[test]
    fn rejects_name_uppercase() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("Upper-Case");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_with_space() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("has space");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_leading_hyphen() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("-leading");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_trailing_hyphen() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("trailing-");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_too_long() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("a".repeat(65));
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_with_path_separator() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("scope/name");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_name_with_at_prefix() {
        let mut v = ok_config();
        v["name"] = serde_json::json!("@scope");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidName { .. }));
    }

    #[test]
    fn rejects_missing_schema() {
        let mut v = ok_config();
        v.as_object_mut().unwrap().remove("schema");
        let err = parse(v).unwrap_err();
        // Missing `schema` is a serde error (field required) — surfaces as
        // InvalidConfig before anything else runs.
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_schema_range_syntax() {
        let mut v = ok_config();
        v["schema"] = serde_json::json!("default@^1.0.0");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_schema_without_version() {
        let mut v = ok_config();
        v["schema"] = serde_json::json!("default");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_legacy_types_field() {
        // Legacy `types` is an unknown field under `deny_unknown_fields`.
        let mut v = ok_config();
        v["types"] = serde_json::json!(["spec"]);
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_invalid_semver() {
        let mut v = ok_config();
        v["version"] = serde_json::json!("not-a-version");
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidConfig { .. }));
    }

    #[test]
    fn rejects_pre_release_plus_build_too_long() {
        let mut v = ok_config();
        let long = "a".repeat(130);
        v["version"] = serde_json::json!(format!("0.1.0-{long}"));
        let err = parse(v).unwrap_err();
        assert!(matches!(err, ValidationError::InvalidVersion { .. }));
    }

    /// Format compatibility across the title/subject bump: readers
    /// accept 3 (pre-title/subject — the two live-registry mems) and 4
    /// (current); 1 and 2 keep refusing with their existing errors; an
    /// unknown future format refuses; and an unknown key is still
    /// refused whatever the format says.
    #[test]
    fn format_three_and_four_accepted_older_and_unknown_refused() {
        // Format 3 installs cleanly and simply has no title/subject.
        let mut v3 = ok_config();
        v3["format"] = serde_json::json!(3);
        let parsed = parse(v3).expect("format 3 accepted");
        assert_eq!(parsed.title, None);
        assert_eq!(parsed.subject, None);

        // Format 4 with title + subject parses them.
        let mut v4 = ok_config();
        v4["title"] = serde_json::json!("Einrichtungsbezogene Impfpflicht Deutschland");
        v4["subject"] = serde_json::json!({
            "scope": "Die Impfpflicht in Einrichtungen",
            "method": "Primärquellen, händisch geprüft",
            "exclusions": ["Länderverordnungen nach 2023", "Presseberichte"],
        });
        let parsed = parse(v4).expect("format 4 accepted");
        assert_eq!(
            parsed.title.as_deref(),
            Some("Einrichtungsbezogene Impfpflicht Deutschland")
        );
        let subject = parsed.subject.expect("subject parsed");
        assert_eq!(subject.scope, "Die Impfpflicht in Einrichtungen");
        assert_eq!(
            subject.method.as_deref(),
            Some("Primärquellen, händisch geprüft")
        );
        assert_eq!(
            subject.exclusions,
            vec!["Länderverordnungen nach 2023", "Presseberichte"]
        );

        // Formats 1 and 2 keep their current refusals.
        let mut v2 = ok_config();
        v2["format"] = serde_json::json!(2);
        let err = parse(v2).unwrap_err();
        assert!(
            matches!(err, ValidationError::InvalidConfig { ref reason } if reason.contains("format: 2")),
            "format 2 keeps its actionable refusal: {err:?}"
        );
        let mut v1 = ok_config();
        v1["format"] = serde_json::json!(1);
        assert!(matches!(
            parse(v1).unwrap_err(),
            ValidationError::UnsupportedFormat { got: 1, .. }
        ));

        // An unknown future format refuses — a format-4 archive is not
        // accepted by an un-updated reader, symmetrically.
        let mut v5 = ok_config();
        v5["format"] = serde_json::json!(5);
        assert!(matches!(
            parse(v5).unwrap_err(),
            ValidationError::UnsupportedFormat { got: 5, .. }
        ));

        // An unknown key is still refused (deny_unknown_fields holds).
        let mut smuggle = ok_config();
        smuggle["writeGuidance"] = serde_json::json!({"note": "leak"});
        assert!(matches!(
            parse(smuggle).unwrap_err(),
            ValidationError::InvalidConfig { .. }
        ));
    }
}