Skip to content

fix(review): tolerate added gates and projections, keep mandatory features exact #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alan-TheGentleman merged 1 commit into from
Aug 1, 2026
Merged

fix(review): tolerate added gates and projections, keep mandatory features exact #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions lib/review-integration-v2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,12 +712,17 @@ export function decodeReviewCapabilitiesV2(value: unknown, verifiedExecutableDig
if (selfReportedDigest !== normalizedVerifiedDigest) throw new TypeError("review provider executable digest mismatch");

const advertisedOperations = stringArray(body.operations, "capabilities.operations", { minimum: REQUIRED_OPERATIONS.length, unique: true });
const gates = enumArray(body.gates, REQUIRED_GATES, "capabilities.gates", { minimum: 5, maximum: 5, unique: true });
const projections = enumArray(body.projections, REQUIRED_PROJECTIONS, "capabilities.projections", { minimum: 2, maximum: 2, unique: true });
// Gates and projections are, like operations and schemas, a superset promise
// rather than an exact manifest: a compatible provider release may advertise
// an additional gate or projection name beyond the required floor. Decode as
// a plain string array (not `enumArray` against the known enum) so an
// unknown addition is not rejected before assertSupersetOf can even run.
const advertisedGates = stringArray(body.gates, "capabilities.gates", { minimum: REQUIRED_GATES.length, unique: true });
const advertisedProjections = stringArray(body.projections, "capabilities.projections", { minimum: REQUIRED_PROJECTIONS.length, unique: true });
const advertisedSchemas = stringArray(body.schemas, "capabilities.schemas", { minimum: REQUIRED_SCHEMAS.length, unique: true });
assertSupersetOf(advertisedOperations, REQUIRED_OPERATIONS, "capabilities operations");
assertExactSet(gates, REQUIRED_GATES, "capabilities gates");
assertExactSet(projections, REQUIRED_PROJECTIONS, "capabilities projections");
assertSupersetOf(advertisedGates, REQUIRED_GATES, "capabilities gates");
assertSupersetOf(advertisedProjections, REQUIRED_PROJECTIONS, "capabilities projections");
assertSupersetOf(advertisedSchemas, REQUIRED_SCHEMAS, "capabilities schemas");

const features = exactRecord(body.features, "capabilities.features", ["mandatory", "optional"]);
Expand Down Expand Up @@ -764,8 +769,8 @@ export function decodeReviewCapabilitiesV2(value: unknown, verifiedExecutableDig
buildId,
executableDigest: selfReportedDigest,
operations: new Set(REQUIRED_OPERATIONS),
gates: new Set(gates),
projections: new Set(projections),
gates: new Set(REQUIRED_GATES),
projections: new Set(REQUIRED_PROJECTIONS),
schemas: new Set(REQUIRED_SCHEMAS),
mandatoryFeatures: new Set(mandatoryNames),
optionalFeatures: new Set(optional.filter((feature) => feature.supported && (FEATURE_NAMES as readonly string[]).includes(feature.name)).map((feature) => feature.name)),
Expand Down
17 changes: 11 additions & 6 deletions runtime/review-integration-v2.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,12 +713,17 @@ export function decodeReviewCapabilitiesV2(value , verifiedExecutableDig
if (selfReportedDigest !== normalizedVerifiedDigest) throw new TypeError("review provider executable digest mismatch");

const advertisedOperations = stringArray(body.operations, "capabilities.operations", { minimum: REQUIRED_OPERATIONS.length, unique: true });
const gates = enumArray(body.gates, REQUIRED_GATES, "capabilities.gates", { minimum: 5, maximum: 5, unique: true });
const projections = enumArray(body.projections, REQUIRED_PROJECTIONS, "capabilities.projections", { minimum: 2, maximum: 2, unique: true });
// Gates and projections are, like operations and schemas, a superset promise
// rather than an exact manifest: a compatible provider release may advertise
// an additional gate or projection name beyond the required floor. Decode as
// a plain string array (not `enumArray` against the known enum) so an
// unknown addition is not rejected before assertSupersetOf can even run.
const advertisedGates = stringArray(body.gates, "capabilities.gates", { minimum: REQUIRED_GATES.length, unique: true });
const advertisedProjections = stringArray(body.projections, "capabilities.projections", { minimum: REQUIRED_PROJECTIONS.length, unique: true });
const advertisedSchemas = stringArray(body.schemas, "capabilities.schemas", { minimum: REQUIRED_SCHEMAS.length, unique: true });
assertSupersetOf(advertisedOperations, REQUIRED_OPERATIONS, "capabilities operations");
assertExactSet(gates, REQUIRED_GATES, "capabilities gates");
assertExactSet(projections, REQUIRED_PROJECTIONS, "capabilities projections");
assertSupersetOf(advertisedGates, REQUIRED_GATES, "capabilities gates");
assertSupersetOf(advertisedProjections, REQUIRED_PROJECTIONS, "capabilities projections");
assertSupersetOf(advertisedSchemas, REQUIRED_SCHEMAS, "capabilities schemas");

const features = exactRecord(body.features, "capabilities.features", ["mandatory", "optional"]);
Expand Down Expand Up @@ -765,8 +770,8 @@ export function decodeReviewCapabilitiesV2(value , verifiedExecutableDig
buildId,
executableDigest: selfReportedDigest,
operations: new Set(REQUIRED_OPERATIONS),
gates: new Set(gates),
projections: new Set(projections),
gates: new Set(REQUIRED_GATES),
projections: new Set(REQUIRED_PROJECTIONS),
schemas: new Set(REQUIRED_SCHEMAS),
mandatoryFeatures: new Set(mandatoryNames),
optionalFeatures: new Set(optional.filter((feature) => feature.supported && (FEATURE_NAMES ).includes(feature.name)).map((feature) => feature.name)),
Expand Down
44 changes: 44 additions & 0 deletions tests/review-integration-v2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,50 @@ test("capabilities enforce the exact mandatory feature set while accepting a sup
const extraOperation = clone(source);
(extraOperation.operations as string[]).push("review.future_operation");
assert.doesNotThrow(() => decode(extraOperation));

// mandatory features must stay an exact match: a known-but-optional feature
// name added to the mandatory list must still be rejected. This is the
// contract boundary (unknown_mandatory: "reject") and must not regress when
// gates/projections become additive-tolerant below.
const extraMandatoryUnknownAddition = clone(source);
((extraMandatoryUnknownAddition.features as JsonObject).mandatory as JsonObject[]).push({ name: "bounded_process_waits", supported: true, requires: [] });
assert.throws(() => decode(extraMandatoryUnknownAddition), /mandatory/);
});

test("capabilities gates and projections accept an additive superset beyond the required floor", () => {
const source = fixture<JsonObject>("capabilities.fixture.json");
const decode = (value: unknown) => decodeReviewCapabilitiesV2(value, executableDigest);

const extraGate = clone(source);
(extraGate.gates as string[]).push("future-gate");
const decodedExtraGate = decode(extraGate) as { gates: ReadonlySet<string> };
assert.equal(decodedExtraGate.gates.has("future-gate"), false, "an unknown advertised gate must not leak into internal use");
for (const gate of ["post-apply", "pre-commit", "pre-push", "pre-pr", "release"]) {
assert.equal(decodedExtraGate.gates.has(gate), true, gate);
}
assert.equal(decodedExtraGate.gates.size, 5);

const extraProjection = clone(source);
(extraProjection.projections as string[]).push("future-projection");
const decodedExtraProjection = decode(extraProjection) as { projections: ReadonlySet<string> };
assert.equal(decodedExtraProjection.projections.has("future-projection"), false, "an unknown advertised projection must not leak into internal use");
for (const projection of ["staged", "workspace"]) {
assert.equal(decodedExtraProjection.projections.has(projection), true, projection);
}
assert.equal(decodedExtraProjection.projections.size, 2);
});

test("capabilities gates and projections still enforce the required floor", () => {
const source = fixture<JsonObject>("capabilities.fixture.json");
const decode = (value: unknown) => decodeReviewCapabilitiesV2(value, executableDigest);

const missingGate = clone(source);
missingGate.gates = (missingGate.gates as string[]).filter((gate) => gate !== "release");
assert.throws(() => decode(missingGate), /gates/);

const missingProjection = clone(source);
missingProjection.projections = (missingProjection.projections as string[]).filter((projection) => projection !== "workspace");
assert.throws(() => decode(missingProjection), /projections/);
});

test("START independently binds base/candidate tree and the target-mode overlay pair", () => {
Expand Down
Loading