Repository navigation
fix(contracts): describe producer-emitted members in compose output schemas - #224
Merged
Merged
Conversation
…chemas
Three composition output schemas reused a caller-input structure for a
member that their producer always re-serializes, so they admitted values
the producer never emits:
- registry-consumer-proof-input-compose: a materialized
registryConsumerInput now requires input.releaseAuthorityInput and
describes it with the release-authority input structure of
schemaVersion 3, refined to channel registry_release, rolloutClaim
false, a non-null registryAuthority and a present non-null package
publishConfigRegistry. Build materializes registryConsumerInput only
for a passed composition, and a passed composition requires these
values. The previous schema admitted any JSON value or no value there.
- requirement-coverage-input-compose and requirement-context-compose: a
non-null proof-binding selection now requires changedPaths, ownerIds
and requirementIds, which requirementbinding.InputValue always emits.
The refinement applies only to these two output schemas; snapshot and
binding input admission keep the members optional.
ContractIds and wire schemaVersions are unchanged, and the three
commands emit the same JSON output bytes as before. In the contract only the
three output definitions, the root definition digests that reference
them and the native source digests of the five edited packages change;
the generated Go projections follow.
Command help pages name structural JSON Schemas instead of root JSON
shapes among the surfaces that proofkit/cli-contract.v2.json owns.
LICENSE names the Go standard library among the bundled BSD-3-Clause
components; the reproduced Go Authors notice already covered it.
The 0.17.0 change record now declares where the unsupported-field count
reaches stdout, rollback text redaction in gradual-adoption reports as a
breaking change, the new static HTML anchor IDs, the changed
requirement-browser-server non-claim and the element-wise
conformance-profile nonClaims comparison. It corrects the embedding
instruction for variant schemas, scopes the native-evidence-guidance
change to help, moves the native test observation rule to source-checkout
coverage tooling, declares the structural-text corrections of
directions that 0.16.0 already published and the corrections above, the
help stanza and the LICENSE text, extends the migration step for
consumers keyed on changed values, and adds one known limitation on
output schema precision. The record has 33 breaking changes and 11
additions, and the pinned copy in the releasechange test is regenerated
from it.
Tests:
- The consumer-evidence oracle refuses a passed composition output whose
releaseAuthorityInput is absent, 0, {}, [0], "x" or null, or carries
schemaVersion 2, channel tarball_pilot, rolloutClaim true, a null
registryAuthority or a null or absent publishConfigRegistry, while the
registry-consumer input schema still admits each of these children. Its
generic boundary sweep now walks the composed release-authority input.
- The inventory-coverage oracle refuses an empty selection or a missing
selection member in real coverage-compose and context-compose outputs,
while the receiving coverage-view and context-slice input schemas still
admit them.
- The commandcontractgen test pins the composed structure to the
registry-consumer and release-authority owner projections plus exactly
these refinements.
- The four oracles that replay recorded help streams declare the help
stanza delta.
- Re-pinned from test output after confirming the cause: the public CLI
ABI hash, eleven compact union hashes of contract records whose native
source digests or root definition digest changed, and the
coverage-compose output mutant record, which gains the three required
selection members.
- The repository LICENSE test requires the bundled-components line to name
the Go standard library.
Members of the refined structures that keep the input structure's
domain:
- registry-consumer-proof-input-compose: registryConsumerInput.proof
stays optional and nullable and keeps the input domains of its
members, although a passed composition fixes its nine lock and pack
booleans, releaseAuthorityReportKind, releaseAuthorityState and
tempConsumerLocation; the composed release-authority input keeps an
optional registryPublishDryRunProofId and the input domains of
manifestPrivate, dependencyPinType and the three consumerContract
booleans.
- requirement-coverage-input-compose and requirement-context-compose: the
selection stays optional and nullable with nullable members,
bindings[].witnessSelectors stays nullable, and witnessCommands keep
the singular environmentClass alternative.
Other output structures embed a caller-input structure for a member
their producer emits and are not refined by this change:
- requirement-coverage-input-compose: requirementSource,
compactProofContract, coverageUniverse, ownerInvariantRegistry,
localEnvironmentPolicy and options.
- requirement-context-compose: projections.specTree and
projections.requirementSources.
- requirement-context-slice, and the one-shot submitted context of
requirement-browser-server and view: proof-binding fragment members.
- selective-gate-obligation-decision-input, requirement-impact-input-compose
and requirement-source-conversion: the whole output.
- requirement-proof-source-set: the compact proof contract it emits.
- requirement-authoring-plan: the requirement source preview.
- requirement-source-view, the requirementCoverage rows of
requirement-coverage-view and requirement-semantic-diff: members built
from requirement-source input sub-shapes, not audited member by member.
Optional, nullable or alternative members at these sites may admit values
the producer never emits; the new known limitation covers them.
Follow-ups outside this change:
- The release SBOM lists no component for the statically linked Go
standard library.
- No CI job executes the Linux arm64 binary or the aarch64 wheel.
- The README workspace screenshot predates later workspace UI changes.
- The statements of REQ-PROOFKIT-WORKFLOW-011, REQ-PROOFKIT-WORKFLOW-018,
REQ-PROOFKIT-PACKAGE-002, REQ-PROOFKIT-SPEC-011 and
REQ-PROOFKIT-QUALITY-004 and three overview lines still use root-shape
terminology for contract declarations; requirement statement changes
need owner impact and proof-binding review.
Proof on this tree:
A local npm run check on darwin/arm64 passed (exit 0) on tree 397c987 with npm 12.2.0,
CPython 3.15.0 and Go 1.27.2: 561/561 browser cases in Chromium, Firefox and
WebKit with zero retries.
Contributor
Author
|
Reviewed candidate: The following corrections are justified; these are not runtime producer fixes:
Independent checks include the affected eight Go packages, 59 CLI/schema oracle tests with zero failures/skips, generator freshness, three intentionally failing predecessor-schema controls, and 79 main/head comparisons with identical exit code, stdout and stderr. The complete local |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pre-release corrections for 0.17.0. A read-only release-readiness review of
main(the reviewed stack after #222) found that three compose output schemas understate what their producers always emit, that the change record misstates or omits some consumer-visible changes, and two small shipped-text gaps. This single commit fixes them before the 0.17.0 subject is tagged.What changes
Output schemas (no contractId, schemaVersion or output-byte change).
registry-consumer-proof-input-compose:registryConsumerInput.input.releaseAuthorityInputwas published as an optional value of any type, although the producer always emits the admitted release-authority input. It is now required and described by the schemaVersion 3 release-authority input structure, with channelregistry_release,rolloutClaimfalse and the non-null registry members.requirement-coverage-input-composeandrequirement-context-compose: the bindingselectionnow requireschangedPaths,ownerIdsandrequirementIds, which the producer always emits.Change record (
release/change-record.v2.json, pinned copy inrecord_test.go).gradual-adoptionandadoption-contract-envelope --mode adoption, and the changed anchor IDs of static HTML views, with migration steps.$defsembedding migration advice; some variants also reference owner-named root$defs.Shipped text. CLI help says the contract publishes structural JSON Schemas instead of "root JSON shapes".
LICENSEnames the Go standard library among the bundled BSD-3-Clause components, and a test requires it.Compatibility
Not breaking. Command behavior and JSON output bytes are unchanged; the help pages differ only by the corrected phrase. Contract identities are unchanged under the contract-identity rule.
Proof
npm run checkon darwin/arm64 passed (exit 0) on tree397c987e8043with npm 12.2.0, CPython 3.15.0 and Go 1.27.2: 561/561 browser cases in Chromium, Firefox and WebKit with zero retries.commandcontractgentest refuse the impossible values the old schemas accepted, and pass on every real output; the LICENSE test fails on the previous LICENSE.Non-claims