# Contract compatibility and rollback rules The blocking tuple is `(buildId, configSchemaVersion, apiContractVersion, assetManifestHash, releaseId)`. Versions are parsed numerically. 1. a change is additive only when it adds an optional field that every reader of the previous version tolerates; see the boundary table below 2. breaking changes require a major version bump or a reader-first deployment 3. persisted cache is discarded unless an explicit tested migration exists 4. an incompatible config or API contract blocks product mount 5. rollback restores HTML, assets, runtime config, API compatibility, and release manifest as one coherent set ## Per-boundary rules Whether "add a field" is safe depends on the reader, not on the writer. Old readers stay alive: several tabs, cached app shells and rollbacks are all supported. At a `REJECT_UNKNOWN` boundary an added field is breaking, so the reader that accepts it must ship before any writer sends it. | Boundary | Reader policy | Adding a field or value | Code | |---|---|---|---| | Runtime config V2 (`/config.json`) | strict object; `CONFIG_SCHEMA_VERSION` is the literal `"2.0"` | breaking | `runtimeConfigV2ArtifactSchema` in `src/contracts/release-artifacts.ts` | | `CAPABILITY_OVERRIDES` | strict; unknown capability rejected | breaking | `capabilityOverrideArtifactSchema` in `src/contracts/release-artifacts.ts` | | `FEATURE_OVERRIDES` | record; unknown feature id ignored | additive | `featureOverrideArtifactSchema` in `src/contracts/release-artifacts.ts` | | Release manifest V2 | strict object | breaking | `releaseManifestV2ArtifactSchema` in `src/contracts/release-artifacts.ts` | | HTTP success/failure envelope (V3 with `responseEnvelope: "ENVELOPE_V1"`) | strict object (`meta` strips) | breaking | `successEnvelopeSchema`, `failureEnvelopeSchema` in `src/adapters/http/backend-envelope.ts` | | HTTP V3 response DTO (a feature's) | `.strip()` drops unknown fields | additive | `ItemDtoSchema` in `contracts/-schemas.ts` of a feature `create:feature` writes | | Realtime envelope | exact key set; unknown `eventType` is `MALFORMED_EVENT` | breaking | `decodeUnsafe` in `src/adapters/realtime/event-codec.ts` | | Browser RPC transport error code | closed vocabulary; unknown code is a protocol violation | breaking | `decodeTransportFailure` in `src/adapters/browser-rpc/browser-rpc-runtime.ts` | | Persisted client storage | versioned key; incompatible value discarded | use a new key version | `defineStorageKey` in `src/contracts/storage-keys.ts` | Turning a response DTO strict changes its row in this table. `check:registries` grades it as breaking (`response-reader-narrowed`) when the FE-REG-SCHEMA row of a `RESPONSE` schema goes from `STRIP_UNKNOWN` to `REJECT_UNKNOWN`, so the change needs registry evidence (1105/07-02). `CAPABILITY_OVERRIDES` and `FEATURE_OVERRIDES` differ on purpose. Feature ids vary per build because each downstream project installs its own features, and one shared config document may cover several builds. The capability set is fixed by the platform version, so an unknown capability means the config was written for a newer platform; it is treated like any other strict config addition. ## Schema change classifier and FE-GATE-014 `classifyObjectSchemaChange` (`src/contracts/compatibility.ts`) answers for a reader built against `before`. It is fail-closed: only a new property under a reader without `additionalProperties: false` is `additive`. A removed or changed property (type, enum, nullable, format, ...), a different required set, or any other changed keyword is `breaking`. Nothing differs: `none`. FE-GATE-014 (`config-compatibility`, `corepack pnpm verify:compatibility`) runs `scripts/check-compatibility.ts`. It does two things: 1. Classifies the hand-written cases in `config/compatibility/fixtures.json` and fails if any result differs from `expected`. 2. Compares the committed baseline `config/compatibility/runtime-config.schema.baseline.json` with the current runtime config schema, which is the same `z.toJSONSchema` output the build writes to `dist/runtime-config.schema.json` (`scripts/generate-build-manifest.ts`). A `breaking` result fails the gate. The baseline stands for the schema that readers of the previous release accept. When a breaking config change is intended, deploy the reader first (or bump the config major version), then run `corepack pnpm verify:compatibility --update-baseline` and commit the new baseline with the change. The result is recorded in `artifacts/release/compatibility.json`. The current `apiContractVersion` check proves release/config coherence, not provider conformance by itself. The target multi-protocol contract set binds REST/OpenAPI artifacts, GraphQL schema and persisted-operation manifests, protobuf source/descriptors/codegen profiles, Connect/gRPC-Web provider profiles, ProtoJSON/HttpRule/generated OpenAPI/gateway artifacts, runtime schema/mapper registries, and server-state policy digests as defined in [API contract, Schema, Mapper, and Server State](../architecture/api-contract-schema-mapper-and-server-state.md). Browser Protobuf and REST Gateway compatibility is further split in [Protobuf browser transport and REST Gateway](../architecture/protobuf-browser-transport-and-rest-gateway.md); binary/JSON/HTTP-route compatibility gates are not interchangeable.