Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
114 changes: 57 additions & 57 deletions generated/bundled_spec.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion hooks/pre_gen/0100_patch_bundled_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,14 @@ def flatten_schema(self, schema: SpecNode) -> SpecNode:
if merged_props:
new_schema["properties"] = merged_props
if merged_required:
new_schema["required"] = list(merged_required)
# Deterministic ordering — merged_required is a set
# whose Python iteration order is hash-randomised
# across processes. Without sorting, every
# regeneration flips `required:` array order in the
# bundled spec, producing perpetual content-free
# merge conflicts. Mirrors the same fix applied
# upstream in camunda-schema-bundler 2.4.2 (#35).
new_schema["required"] = sorted(merged_required)

# If we have a oneOf, removing the explicit type: object allows the union to work
# even if some options are primitives (like string vs object filter)
Expand Down
51 changes: 51 additions & 0 deletions tests/unit/test_patch_bundled_spec_determinism.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
"""Generation must be deterministic: the allOf flattener's merged `required` list."""

import importlib.util
from pathlib import Path
from typing import Any

_HOOK = (
Path(__file__).resolve().parents[2]
/ "hooks"
/ "pre_gen"
/ "0100_patch_bundled_spec.py"
)
_spec = importlib.util.spec_from_file_location("patch_bundled_spec", _HOOK)
assert _spec is not None and _spec.loader is not None
patch_bundled_spec = importlib.util.module_from_spec(_spec)
_spec.loader.exec_module(patch_bundled_spec)


def test_flattened_allof_required_is_sorted() -> None:
# A set's iteration order depends on PYTHONHASHSEED, so emitting it unsorted
# reorders `required:` in generated/bundled_spec.yaml on every regeneration.
names = [
"zeta",
"alpha",
"kappa",
"beta",
"omega",
"delta",
"eta",
"gamma",
"iota",
"theta",
]
schema: dict[str, Any] = {
"allOf": [
{
"type": "object",
"properties": {n: {"type": "string"} for n in names[:5]},
"required": names[:5],
},
{
"type": "object",
"properties": {n: {"type": "string"} for n in names[5:]},
"required": names[5:],
},
]
}

flattened = patch_bundled_spec.SpecFlattener({}).flatten_schema(schema)

assert flattened["required"] == sorted(names)
Loading