fix(gen-jsonschema): fix allOf $ref schema naming and sort closure bugs#526
Merged
Peefy merged 1 commit intokcl-lang:mainfrom Mar 1, 2026
Merged
fix(gen-jsonschema): fix allOf $ref schema naming and sort closure bugs#526Peefy merged 1 commit intokcl-lang:mainfrom
Peefy merged 1 commit intokcl-lang:mainfrom
Conversation
Three bugs in the JSON schema to KCL generator caused schemas using the
allOf + placeholder-properties pattern (e.g., cloud-init) to produce
incorrect output:
1. Sort closure variable shadowing: sort.SliceStable closures used i,j
parameter names that shadowed the outer loop variable, causing $ref
(order 0) to sort after properties (order 2), so properties were
converted before allOf refs could merge in real types.
2. Empty placeholder properties not replaced: when merging allOf member
properties into an existing schema, properties with empty keyword
sets (placeholder schemas like "count": {}) were silently skipped
instead of being replaced with the typed schema from the allOf member.
3. $ref residue causing wrong schema names: the first $ref encountered
in an allOf fell through to default: and was stored in s.Keywords
rather than resolved, causing the main keyword loop to later set
reference = "#/$defs/first_ref" and derive the schema name from it
instead of from $id or the filename. Fixed by adding case
*jsonschema.Ref: to the outer allOf switch so all refs are always
resolved into schs immediately.
Adds a minimal regression test (allof-placeholder-props) and the
previously missing cloud-init/expect.k test fixture.
Signed-off-by: Richard Hillmann <[email protected]>
a0f9385 to
affefee
Compare
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
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.
hint: This bug was solved with the help of AI (Claude)
I discovered this problem when generating schemas for cloud-init: https://github.com/canonical/cloud-init/blob/main/cloudinit/config/schemas/schema-cloud-config-v1.json
Three bugs in the JSON schema to KCL generator caused schemas using the allOf + placeholder-properties pattern (e.g., cloud-init) to produce incorrect output:
Sort closure variable shadowing: sort.SliceStable closures used i,j parameter names that shadowed the outer loop variable, causing $ref (order 0) to sort after properties (order 2), so properties were converted before allOf refs could merge in real types.
Empty placeholder properties not replaced: when merging allOf member properties into an existing schema, properties with empty keyword sets (placeholder schemas like "count": {}) were silently skipped instead of being replaced with the typed schema from the allOf member.
$ref residue causing wrong schema names: the first $ref encountered in an allOf fell through to default: and was stored in s.Keywords rather than resolved, causing the main keyword loop to later set reference = "#/$defs/first_ref" and derive the schema name from it instead of from $id or the filename. Fixed by adding case *jsonschema.Ref: to the outer allOf switch so all refs are always resolved into schs immediately.
Adds a minimal regression test (allof-placeholder-props) and the previously missing cloud-init/expect.k test fixture.
1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):
2. What is the scope of this PR (e.g. component or file name):
3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):
4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):
5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links: