11 KiB
Schema-validity burndown
The standing plan for closing the largest XSTS conformance gap. Autopilot
contract: follow this document iteration by iteration, each as its own PR with
a critic pass, until invalid-schemas-accepted is driven down to its
irreducible tail. Do not deviate to new features while this is open.
The problem (measured 2026-06-13, 2006-11-06 archive)
| Bucket | Count | Reading |
|---|---|---|
| valid-schemas-rejected | 72 -> 0 | production target is 0: rejecting a correct schema is the most user-hostile defect (#148). Particle-restriction over-rejection fixed: pointless maxOccurs=0 particles removed, content-free restriction of an EMPTY base, empty-derived emptiable-base, and (#163) the pairwise check over the normalized content model with occurrence subsumption applied only to same-kind pairings (cross-kind element/group, group/element, group/wildcard match occurrence inside, by effective total range / member). #164 resolved element-ref namespaces by prefix binding (the particlesJj/Jk/Jm/Jn/Js, particlesQ/R cluster, -28). Content-free (maxOccurs=0) derived groups and substitution-group declaration order closed particlesW006/elemZ027_a; the W3C MapAndSum rule (Sequence:Choice, #165) closed particlesV003. The false-positive schema bucket is now zero. |
| invalid-schemas-accepted | 2461 -> 43 | we rarely catch a bad one (facet, default/fixed value, particle-restriction name+type, id, structural content-model, UPA determinism, content order, identity-constraint XPath-subset, wildcard-namespace, final/block, simpleType content, group/wildcard and group/element cardinality, element-ref namespace, sequence/choice MapAndSum, circular type derivation, circular group/attributeGroup/substitution references, attribute-use uniqueness and single-ID, type-excludes-inline-type, ID-typed value-constraint exclusion, all-group reference placement, substitution-member type derivation, default/fixed mutual exclusion, elementTypeRestrictionOK NameAndTypeOK union checks, prohibited attribute type-check bypass, keyref arity verification, top-level group/attributeGroup local-attribute checks, simpleType restriction structure and prefix binding checks, namespace-aware reference resolution checks, simpleType variety constraints on list itemType and union memberTypes, targetNamespace scope matching on local schema references, substitution group exclusions based on element final and schema finalDefault attributes, cross-container component-name and identity-constraint uniqueness checks, notation declarations and notation enumeration restrictions, xml:lang and xml:space on documentation/appinfo elements, duplicate schema container validation across separate files with identical content, schema element order, import constraints validation, facet applicability per base type, fractionDigits constraints on integer types, ordered duration range bounds, built-in list non-emptiness constraints, simpleContent inline type restriction, complexContent mixed-agreement checks, substitution-head anySimpleType member-content checks, substitution-group closure barriers for block="substitution", and global element-ref declaration metadata in NameAndTypeOK landed). |
| valid-instances-rejected | 233 -> 0 | false-positive instance bucket is now zero. |
| invalid-instances-accepted | 160 -> 31 | instance side remains open; see the XSTS false-negative tail plan for the current 31-case split. |
One-sentence diagnosis: the validator runs its instance-validity rules but not its schema-validity rules. It compiles what it understands and ignores the rest, so ~18% of the invalid-schema corpus is accepted silently.
Source split of the 2461: 2323 Microsoft, 138 Sun. The Microsoft mass spreads across every category (DataTypes 703, ComplexType 262, IdentityConstraint 221, SimpleType 139, ModelGroups 137, Attribute 124, Particles 118, Wildcards 97, Element 96, Notations 84, Group 82, Regex 74, Schema 61, AttributeGroup 52, Additional 39, Annotations 30, Errata 4). No single root cause; this is a campaign of distinct schema-component constraints.
Where the checks belong
Schema-validity findings are reported at compile time, through
PureXML.Validation.XSDSchema.consistencyErrors(...) (called from
SchemaDocument.Document.init), which already throws SchemaError.inconsistent
when a named type violates a rule. New rule families are added there (or in a
sibling validation composed into it), never at instance-validation time. The
existing pattern: collect ALL findings, report them together.
Priority order (highest leverage first, measured)
Each iteration targets one self-contained rule family with a clean root cause.
- Facet-definition validity (XSD Part 2 §4.3). Mostly done (2461 -> 1789).
Landed: length-family facet values must be
nonNegativeInteger(totalDigitsapositiveInteger);lengthexcludesminLength/maxLength;minLength<=maxLength;fractionDigits<=totalDigits. Value-bound facets (min/maxInclusive,min/maxExclusive) andenumerationvalues must be valid in the base value space;InclusiveexcludesExclusiveon each side; lower bound may not exceed (nor, if exclusive, equal) the upper. (The bound-value check exposed and fixed agMonth--MM--lexical gap.) Still open in this family: facet applicability per base (fractionDigitsonly on decimal-derived,lengthonly on string/binary/list, etc.);whiteSpacemay not weaken an inherited value; facet repetition. Inherited-facet co-occurrence (across derivation steps) is deliberately not checked yet (current pass reads only the local restriction). idattribute validity (xs:ID). Done (1789 -> 1688). Theidattribute on any XSD component is xs:ID: each value must be a valid NCName and unique within the schema document. Walks the schema-document tree, skippingappinfo/documentationforeign content and treating only the unprefixedidas the component identifier. Broad reach (idA-idK, attgA, attB, ctA).- Component-name uniqueness. Done (909 -> 891). Global type (one space for
simpleType+complexType), element, attribute, model-group, attribute-group names
unique; identity-constraint names unique per document; keyref
referresolves to a key/unique (SchemaNameUniqueness.swift). - Resolvable references. Done (1092 -> 1051).
type/base/itemType/memberTypestypes,element/attribute/group/attributeGroupref, and elementsubstitutionGroupmust resolve to a declared component or a built-in (SchemaReferences.swift), matched by local name, skipped whenimport/include/redefinemay supply externals. Still open: keyrefreferresolution; the context-sensitive applicability rules (formon a global decl,refexcludingname/type). - Facet applicability per base (the open facet-family tail): which facets
a base admits (
fractionDigitsonly on decimal-derived,lengthonly on string/binary/list, etc.), and a fixed facet may not be changed. - Schema-for-schemas structural validity. Content-model pass done
(1688 -> 1313, -375). A data-driven
allowedChildrentable (the schema-for- schemas child content model) rejects disallowed children, multi/misplacedannotation, and identity constraints missing selector/field, via one general mechanism (SchemaStructure.swift). Attribute value validity also landed (enumerated attributes,minOccurs/maxOccurs; 1313 -> 1190), plus name/reference lexical validity (namean NCName;type/base/ref/itemType/refer/substitutionGroupQNames; 1190 -> 1129), pluspatternregex validity (compile each pattern; reject only unambiguous syntax errors, tolerating engine gaps; 1129 -> 1092), plus complexType content-model shape (one simpleContent/complexContent, exclusive with model groups/attributes; one model group; 1051 -> 997), plus particle minOccurs <= maxOccurs (997 -> 977), plus named-group exactly-one-compositor (977 -> 956), plus attribute applicability (allowed-attributes-per-component table + ref/name/type exclusion; 956 -> 925), plus Element Declarations Consistent (same-name elements in one content model share a type; 925 -> 909). Still open: attribute applicability (which attributes each component admits, e.g.formis prohibited on a global declaration,refexcludesname); child order beyond the leading annotation; and particle / model-group semantic rules (Unique Particle Attribution, Particle-Valid-Restriction completeness).
Per-iteration protocol (the PR-critic-loop)
Read docs/production-readiness.md first, every iteration, and hold the change
to its four stoppers and checklist. The target for all four XSTS buckets is 0,
both directions; valid-rejected is not an acceptable baseline. Durability
(commit, ff-merge, push, mirror) is part of done.
For each cluster, on a fresh branch off main:
- Scope & measure. Identify the cluster's cases in
/tmp/xsts-failures.txt; read a sample of the actual invalid schemas to pin the exact rule(s). State the rule in one sentence (first principles). - Implement at the owning layer (compile-time consistency check). Make impossible states unrepresentable where it helps; no special-case bandaids.
- Unit tests for the rule: a valid schema passes, each invalid form is rejected with a located, specific message. Swift Testing.
- Gates (all must pass):
bash scripts/check-style.sh,bash scripts/check-namespacing.sh,swiftformat . --config .swiftformat --lint,swiftlint --config .swiftlint.yml --strict,swift build,swift test,bash scripts/check-wasm.sh. - XSTS ratchet.
XSTS_ROOT=/private/tmp/xsts/xmlschema2006-11-06 swift test -c release --filter XSTS.invalid-schemas-acceptedmust fall; no other bucket may rise (hard gate). Update the pinned baselines inTests/XSTSSuiteTests.swiftto the new numbers. - Critic pass (mandatory before merge). Spawn an independent reviewer over
git diff main...HEAD: correctness (does the rule over- or under-reject? spec citation), removed-behavior, cross-file impact, and altitude (is this a bandaid or the real rule?). Treat findings adversarially; fix every real one and re-run gates + XSTS. A finding that the rule is too aggressive (a valid schema now rejected) is a release blocker. - Document & commit. CHANGELOG entry with the before/after XSTS numbers;
update this file's priority table and
docs/xsts-deviations.md. Commit<type>(schema): …, then fast-forward merge tomain(local only; never push, per policy). Delete the branch.
Invariants
- The ratchet only falls. A rising bucket is a regression and blocks the merge.
- Disclosed limits are fine; silent debt is the violation. Until the schema side
is solid the README must state the conformance numbers and what is not yet
checked, and the package stays
0.x. - Apple/Swift-native only; no external SwiftPM deps; macOS + Linux + WASI.