Skip to content

Fix schema incompatibility check take 2 #47

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
andreasjansson merged 6 commits into from
Dec 4, 2025
Merged

Fix schema incompatibility check take 2 #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3c44123
fix: handle inline allOf enum schemas without $ref
andreasjansson Dec 4, 2025
0e7d033
test: add tests for inline allOf enum schemas
andreasjansson Dec 4, 2025
ba5dc00
fix: simplify allOf enum handling since schemas are dereferenced
andreasjansson Dec 4, 2025
1f5a70a
test: update enum tests to use inline allOf (no $ref)
andreasjansson Dec 4, 2025
933d53b
test: update test_multiple_incompatibilities to use inline allOf
andreasjansson Dec 4, 2025
6fb00fa
test: add realistic enum test with full metadata (aspect_ratio example)
andreasjansson Dec 4, 2025
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
7 changes: 3 additions & 4 deletions cog_safe_push/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,9 @@ def check_backwards_compatible(
# We allow defaults to be changed

elif "allOf" in spec:
choice_schema = model_schemas[spec["allOf"][0]["$ref"].split("/")[-1]]
test_choice_schema = test_model_schemas[
spec["allOf"][0]["$ref"].split("/")[-1]
]
choice_schema = spec["allOf"][0]
test_choice_schema = test_spec["allOf"][0]

choice_type = choice_schema["type"]
test_choice_type = test_choice_schema["type"]
if test_choice_type != choice_type:
Expand Down
75 changes: 59 additions & 16 deletions test/test_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,18 +134,17 @@ def test_decreased_maximum():


def test_changed_choice_type():
"""Test enum type change with inline allOf."""
old = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "string", "enum": ["A", "B", "C"]}]}}
),
"choice": {"type": "string", "enum": ["A", "B", "C"]},
"Output": {"type": "string"},
}
new = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "integer", "enum": [1, 2, 3]}]}}
),
"choice": {"type": "integer", "enum": [1, 2, 3]},
"Output": {"type": "string"},
}
with pytest.raises(
Expand All @@ -156,36 +155,34 @@ def test_changed_choice_type():


def test_added_choice():
"""Test adding enum choices is backwards compatible."""
old = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "string", "enum": ["A", "B", "C"]}]}}
),
"choice": {"type": "string", "enum": ["A", "B", "C"]},
"Output": {"type": "string"},
}
new = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "string", "enum": ["A", "B", "C", "D"]}]}}
),
"choice": {"type": "string", "enum": ["A", "B", "C", "D"]},
"Output": {"type": "string"},
}
check_backwards_compatible(new, old, train=False) # Should not raise


def test_removed_choice():
"""Test removing enum choices breaks compatibility."""
old = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "string", "enum": ["A", "B", "C"]}]}}
),
"choice": {"type": "string", "enum": ["A", "B", "C"]},
"Output": {"type": "string"},
}
new = {
"Input": make_input_schema(
{"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]}}
{"choice": {"allOf": [{"type": "string", "enum": ["A", "B"]}]}}
),
"choice": {"type": "string", "enum": ["A", "B"]},
"Output": {"type": "string"},
}
with pytest.raises(
Expand All @@ -194,6 +191,54 @@ def test_removed_choice():
check_backwards_compatible(new, old, train=False)


def test_realistic_enum_with_metadata():
"""Test enum with full realistic metadata (like aspect_ratio)."""
old = {
"Input": make_input_schema(
{
"aspect_ratio": {
"allOf": [
{
"enum": ["1:1", "2:3", "3:2", "4:3", "16:9"],
"type": "string",
"title": "aspect_ratio",
"description": "An enumeration.",
}
],
"default": "1:1",
"x-order": 2,
"description": "Aspect ratio for expansion.",
}
}
),
"Output": {"type": "string", "title": "Output", "format": "uri"},
}
new = {
"Input": make_input_schema(
{
"aspect_ratio": {
"allOf": [
{
"enum": ["1:1", "2:3", "3:2", "4:3"], # removed 16:9
"type": "string",
"title": "aspect_ratio",
"description": "An enumeration.",
}
],
"default": "1:1",
"x-order": 2,
"description": "Aspect ratio for expansion.",
}
}
),
"Output": {"type": "string", "title": "Output", "format": "uri"},
}
with pytest.raises(
IncompatibleSchemaError, match="Input aspect_ratio is missing choices: '16:9'"
):
check_backwards_compatible(new, old, train=False)


def test_new_required_input():
old = {
"Input": make_input_schema({"text": {"type": "string"}}),
Expand Down Expand Up @@ -230,22 +275,20 @@ def test_multiple_incompatibilities():
{
"text": {"type": "string"},
"number": {"type": "integer", "minimum": 0},
"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]},
"choice": {"allOf": [{"type": "string", "enum": ["A", "B", "C"]}]},
}
),
"choice": {"type": "string", "enum": ["A", "B", "C"]},
"Output": {"type": "string"},
}
new = {
"Input": make_input_schema(
{
"text": {"type": "integer"},
"number": {"type": "integer", "minimum": 1},
"choice": {"allOf": [{"$ref": "#/components/schemas/choice"}]},
"choice": {"allOf": [{"type": "string", "enum": ["A", "B"]}]},
"new_required": {"type": "string"},
}
),
"choice": {"type": "string", "enum": ["A", "B"]},
"Output": {"type": "integer"},
}
with pytest.raises(IncompatibleSchemaError) as exc_info:
Expand Down