Skip to content

schema-compatibility-harness.md

Latest commit

 

History

History
27 lines (20 loc) · 1.23 KB

schema-compatibility-harness.md

File metadata and controls

27 lines (20 loc) · 1.23 KB
Raw

Schema Compatibility Harness

The generated-schema harness enforces thrift and protobuf compatibility rules mechanically for changes under gensrc/.

Source of Truth

  • Checker: build-support/check_gensrc_schema_compatibility.py
  • Tests: build-support/test_check_gensrc_schema_compatibility.py
  • Reviewed exceptions: build-support/schema_compatibility_waivers.json
  • Schema sources: gensrc/thrift/*.thrift, gensrc/proto/*.proto

Commands

python3 -m unittest build-support/test_check_gensrc_schema_compatibility.py
python3 build-support/check_gensrc_schema_compatibility.py --mode changed --base origin/main
python3 build-support/check_gensrc_schema_compatibility.py --mode full --base origin/main

Working Rules

  • New thrift struct fields and thrift RPC params or throws entries must be explicit optional.
  • New proto2 fields must be optional or repeated.
  • New proto3 singular fields must use explicit optional; repeated and map remain allowed.
  • Field-number changes, type changes, and cardinality changes fail the harness.
  • Field deletions require a checked-in waiver entry with matching signature, rationale, and owner.
  • Remove stale waivers as soon as the compatibility exception is no longer needed.