Files
faunosteo/crates/core/tests/characterisation.rs
bchanot 20d03cf7fd fix(domain): refuse lone UTF-16 surrogates instead of replacing them (L1)
serde_json already refuses a lone surrogate escape; the U+FFFD pre-pass
is gone and parse_json classifies the refusal (strict escape scan, on
failure only) so callers name it: closed kind lone_surrogate from
operation inputs, sheet.check, draft.restore and archive.import.
Oracles untouched: the two L1 cases and the Zod verdict now assert that
TypeScript kept the surrogate and Rust refuses the text.
2026-10-14 21:49:28 +02:00

256 lines
10 KiB
Rust

//! The Rust report and archive functions against what the TypeScript domain did on the same
//! inputs (`crates/core/tests/oracles/characterisation.json`, written by
//! `packages/domain/tests/r2-characterisation.test.ts`), and the Rust contracts against the
//! accept / refuse verdicts of the Zod schemas (`verdicts.json`).
#![allow(clippy::disallowed_methods, clippy::unwrap_used, clippy::expect_used)]
mod common;
use faunosteo_core::domain::archive::{
Branding, PdfLabelSet, ReportArchiveEnvelope, SheetSnapshot, assert_snapshot,
build_sheet_snapshot, read_archive_document,
};
use faunosteo_core::domain::js::{JsonReadError, parse_json};
use faunosteo_core::domain::report::v2::ReportV2;
use faunosteo_core::domain::report::{
ReadFailure, Report, ReportMigrationMap, read_report_document, rebase_report_on_sheet,
};
use faunosteo_core::domain::sheet::{BundledSheetData, LoadedSheet, Reference};
use faunosteo_core::json::to_js_pretty;
use serde::Serialize;
use serde_json::{Map, Value, json};
fn oracle(name: &str) -> (String, Value) {
common::oracle_file(name)
}
/// A case input as the core reads it; a lone surrogate refuses it whole (L1).
fn read_input(text: &str) -> Result<Value, Value> {
parse_json(text).map_err(|error| match error {
JsonReadError::LoneSurrogate { .. } => json!({ "kind": "lone_surrogate" }),
JsonReadError::Syntax(error) => panic!("unreadable oracle input: {error}"),
})
}
/// Object keys sorted at every level: equality whatever the declared field order.
fn sorted(value: &Value) -> Value {
match value {
Value::Object(map) => {
let mut keys: Vec<&String> = map.keys().collect();
keys.sort();
let mut out = Map::new();
for key in keys {
out.insert(key.clone(), sorted(&map[key]));
}
Value::Object(out)
}
Value::Array(items) => Value::Array(items.iter().map(sorted).collect()),
other => other.clone(),
}
}
fn pretty<T: Serialize>(value: &T) -> String {
to_js_pretty(value).unwrap()
}
struct Context {
maps: Map<String, Value>,
sheets: Map<String, Value>,
}
impl Context {
fn map(&self, case: &Value) -> ReportMigrationMap {
let name = case["map"].as_str().unwrap_or("test");
let text = self.maps[name].as_str().unwrap();
serde_json::from_value(parse_json(text).unwrap()).unwrap()
}
fn sheet(&self, case: &Value) -> LoadedSheet {
let bundle = self.sheets[case["sheet"].as_str().unwrap()].clone();
let data: BundledSheetData = serde_json::from_value(bundle).unwrap();
LoadedSheet::from_bundle(data).unwrap()
}
}
fn read_error(failure: &ReadFailure) -> Value {
match failure {
ReadFailure::UnsupportedVersion(found) => {
json!({ "kind": "unsupported_version", "found": found })
}
ReadFailure::Invalid(_) => json!({ "kind": "invalid" }),
}
}
/// What Rust returns for a case: `Ok(output)` or `Err(error)` in the oracle's shapes.
fn run(context: &Context, case: &Value) -> Result<Value, Value> {
let input = read_input(case["input"].as_str().unwrap())?;
match case["fn"].as_str().unwrap() {
"readReport" => read_report_document(&input, &context.map(case))
.map(|o| serde_json::to_value(o).unwrap())
.map_err(|f| read_error(&f)),
"readArchive" => read_archive_document(&input, &context.map(case))
.map(|o| serde_json::to_value(o).unwrap())
.map_err(|f| read_error(&f)),
"rebase" => {
let archived = case["archived"]
.as_str()
.map(|t| assert_snapshot(&parse_json(t).unwrap()).unwrap());
let report: Report = serde_json::from_value(input).unwrap();
rebase_report_on_sheet(&report, &context.sheet(case), archived.as_ref())
.map(|o| serde_json::to_value(o).unwrap())
.map_err(|f| read_error(&f))
}
"buildSnapshot" => {
let report: Report = serde_json::from_value(input).unwrap();
Ok(serde_json::to_value(build_sheet_snapshot(&context.sheet(case), &report)).unwrap())
}
"assertSnapshot" => assert_snapshot(&input)
.map(|s| serde_json::to_value(s).unwrap())
.map_err(|r| json!({ "kind": r })),
other => panic!("unknown fn {other}"),
}
}
/// The comparison of one case; `None` when Rust matches the TypeScript.
fn mismatch(context: &Context, case: &Value) -> Option<String> {
let name = case["name"].as_str().unwrap();
let actual = run(context, case);
match (&actual, case.get("output"), case.get("error")) {
(Ok(out), Some(expected), None) => {
// The archive's PDF labels follow the engine's dictionary order in Rust and the
// Zod key order in TypeScript (D-R11): compared without the order there.
let exact = !name.starts_with("readArchive");
let same = if exact {
pretty(out) == pretty(expected)
} else {
pretty(&sorted(out)) == pretty(&sorted(expected))
&& pretty(&out["report"]) == pretty(&expected["report"])
};
(!same).then(|| format!("{name}: output differs\n rust: {}", pretty(out)))
}
(Err(error), None, Some(expected)) => {
// Through the JavaScript printer: a found version 4 reads 4 on both sides.
(pretty(error) != pretty(expected))
.then(|| format!("{name}: error {error} != {expected}"))
}
_ => Some(format!(
"{name}: rust {actual:?} vs ts output/error mismatch"
)),
}
}
fn cases(with_rules: bool) -> (Context, Vec<Value>) {
let (_, value) = oracle("characterisation.json");
let context = Context {
maps: value["maps"].as_object().unwrap().clone(),
sheets: value["sheets"].as_object().unwrap().clone(),
};
let list = value["cases"]
.as_array()
.unwrap()
.iter()
.filter(|c| c.get("needsRules").is_some() == with_rules && c.get("l1").is_none())
.cloned()
.collect();
(context, list)
}
#[test]
fn rust_does_what_the_typescript_did() {
let (context, list) = cases(false);
assert!(list.len() > 80, "{} cases", list.len());
let failures: Vec<String> = list.iter().filter_map(|c| mismatch(&context, c)).collect();
assert!(failures.is_empty(), "{}", failures.join("\n"));
}
/// The cases whose outcome is a sheet integrity rule: they need the real rules of
/// `sheet/validate.rs` (fork A) instead of the stub this branch carried.
#[test]
fn rust_does_what_the_typescript_did_with_the_integrity_rules() {
let (context, list) = cases(true);
assert!(!list.is_empty());
let failures: Vec<String> = list.iter().filter_map(|c| mismatch(&context, c)).collect();
assert!(failures.is_empty(), "{}", failures.join("\n"));
}
/// Decision L1 (owner, 2026-10-14): where `JSON.parse` kept a lone surrogate (the frozen
/// TypeScript output still carries the `\\ud800` escape), Rust refuses the input whole with
/// `lone_surrogate` instead of altering it; no output, no U+FFFD.
#[test]
fn lone_surrogates_are_refused_never_replaced() {
let (raw, value) = oracle("characterisation.json");
let backslash = char::from(92);
let lone_escape = format!("{backslash}ud800");
let context = cases(false).0;
let flagged: Vec<&Value> = value["cases"]
.as_array()
.unwrap()
.iter()
.filter(|c| c.get("l1").is_some())
.collect();
assert_eq!(flagged.len(), 2);
for case in flagged {
let name = case["name"].as_str().unwrap();
let line = raw.lines().find(|l| l.contains(name)).unwrap();
let output = &line[line.find("\"output\"").unwrap()..];
assert!(
output.contains(&lone_escape),
"{name}: TS output keeps the lone surrogate"
);
assert_eq!(
run(&context, case),
Err(json!({ "kind": "lone_surrogate" })),
"{name}: Rust refuses the text"
);
}
}
fn verdict(schema: &str, input: &Value) -> bool {
let input = input.clone();
match schema {
"Report" => serde_json::from_value::<Report>(input).is_ok(),
"ReportV2" => serde_json::from_value::<ReportV2>(input).is_ok(),
"MigrationMap" => serde_json::from_value::<ReportMigrationMap>(input).is_ok(),
"Branding" => serde_json::from_value::<Branding>(input).is_ok(),
"PdfLabelSet" => serde_json::from_value::<PdfLabelSet>(input).is_ok(),
"SheetSnapshot" => serde_json::from_value::<SheetSnapshot>(input).is_ok(),
"Envelope" => serde_json::from_value::<ReportArchiveEnvelope>(input).is_ok(),
"Reference" => serde_json::from_value::<Reference>(input).is_ok(),
other => panic!("unknown schema {other}"),
}
}
#[test]
fn the_contracts_accept_and_refuse_what_zod_does() {
let (_, list) = oracle("verdicts.json");
let list = list.as_array().unwrap();
assert!(list.len() > 500, "{} verdicts", list.len());
// L1: the one input Zod accepted with a lone surrogate is refused by the reader instead.
let (lone, readable): (Vec<&Value>, Vec<&Value>) = list
.iter()
.partition(|v| read_input(v["input"].as_str().unwrap()).is_err());
assert_eq!(lone.len(), 1);
assert_eq!(lone[0]["name"], "lone surrogate in a comment");
assert_eq!(lone[0]["accepted"], true);
let failures: Vec<String> = readable
.iter()
.filter_map(|v| {
let schema = v["schema"].as_str().unwrap();
let input = parse_json(v["input"].as_str().unwrap()).unwrap();
let expected = v["accepted"].as_bool().unwrap();
(verdict(schema, &input) != expected).then(|| {
format!(
"{schema} / {}: zod accepted={expected}",
v["name"].as_str().unwrap()
)
})
})
.collect();
assert!(
failures.is_empty(),
"{} mismatches:\n{}",
failures.len(),
failures.join("\n")
);
}