[OCaml][Fix] Unreferenced enum + Direct recursive types#23005
[OCaml][Fix] Unreferenced enum + Direct recursive types#23005sir4ur0n wants to merge 6 commits intoOpenAPITools:masterfrom
Conversation
Problem: The OCaml client generator threw IllegalArgumentException: Unreferenced enum when encountering enums inside composed schemas (anyOf/allOf/oneOf). Root Causes: 1. The enum collection logic didn't traverse into composed schemas 2. The enum hashing used order-dependent string concatenation, causing lookups to fail when enum values appeared in different orders 3. Enums directly within composed schema branches (not in properties) weren't collected Solution: 1. Added composed schema support: - New `collectEnumSchemasFromComposed()` method handles `anyOf/allOf/oneOf` - New `collectEnumSchemasFromList()` method recursively processes composed schema branches - Enums directly in composed schemas (not just in properties) are now collected 2. Refactored enum hashing to use Set: - Changed from comma-joined strings to `TreeSet<String>` for order-independent, collision-free hashing - Handles edge cases like empty string enums `""` 3. Added test case: - Tests enums in nested composed schemas - Tests enum with empty string value in anyOf
42aac2b to
067bd6b
Compare
834c084 to
47680b2
Compare
There was a problem hiding this comment.
3 issues found across 49 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/client/petstore/ocaml-recursion-test/README.md">
<violation number="1" location="samples/client/petstore/ocaml-recursion-test/README.md:1">
P2: Malformed Markdown header - title text should be on the same line as the `#` marker</violation>
</file>
<file name="samples/client/petstore/ocaml-recursion-test/src/models/required_recursion.ml">
<violation number="1" location="samples/client/petstore/ocaml-recursion-test/src/models/required_recursion.ml:18">
P1: Syntax error in generated OCaml record: `[@key]` attributes are misplaced after field separators (`;`). Attributes must be placed after the field type and BEFORE the semicolon, e.g., `value: string [@key "value"];`. The current placement will cause compilation failure and break JSON serialization.</violation>
</file>
<file name="samples/client/petstore/ocaml-enum-in-composed-schema/src/models/test_model.ml">
<violation number="1" location="samples/client/petstore/ocaml-enum-in-composed-schema/src/models/test_model.ml:17">
P0: Incorrect placement of `[@key]` attributes breaks JSON serialization mappings</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| option [@default None] | ||
|
|
||
|
|
||
| ; [@key "name"] |
There was a problem hiding this comment.
P0: Incorrect placement of [@key] attributes breaks JSON serialization mappings
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/ocaml-enum-in-composed-schema/src/models/test_model.ml, line 17:
<comment>Incorrect placement of `[@key]` attributes breaks JSON serialization mappings</comment>
<file context>
@@ -0,0 +1,38 @@
+ option [@default None]
+
+
+ ; [@key "name"]
+ config: Test_model_config.t
+
</file context>
There was a problem hiding this comment.
What? How does that break JSON serialization mappings?
This is exactly the same as all the existing code and it works fine.
See e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/ocaml/src/models/pet.ml#L18
It works perfectly fine as far as OCaml compilation is concerned.
You have to consider with proper formatting, the line is
name : string option; [@default None] [@key "name"]which works.
|
|
||
|
|
||
|
|
||
| ; [@key "value"] |
There was a problem hiding this comment.
P1: Syntax error in generated OCaml record: [@key] attributes are misplaced after field separators (;). Attributes must be placed after the field type and BEFORE the semicolon, e.g., value: string [@key "value"];. The current placement will cause compilation failure and break JSON serialization.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/ocaml-recursion-test/src/models/required_recursion.ml, line 18:
<comment>Syntax error in generated OCaml record: `[@key]` attributes are misplaced after field separators (`;`). Attributes must be placed after the field type and BEFORE the semicolon, e.g., `value: string [@key "value"];`. The current placement will cause compilation failure and break JSON serialization.</comment>
<file context>
@@ -0,0 +1,33 @@
+
+
+
+ ; [@key "value"]
+ parent: t
+
</file context>
| @@ -0,0 +1,44 @@ | |||
| # | |||
There was a problem hiding this comment.
P2: Malformed Markdown header - title text should be on the same line as the # marker
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/ocaml-recursion-test/README.md, line 1:
<comment>Malformed Markdown header - title text should be on the same line as the `#` marker</comment>
<file context>
@@ -0,0 +1,44 @@
+#
+Test for direct recursive types in OCaml generator.
+
</file context>
A -> A)anyOf/oneOf/allOfwere not correctly detectedPR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)@cgensoul @wing328
CI fails for seemingly unrelated reasons but I can't manually restart it.
Summary by cubic
Fixes crashes in the OCaml client generator when enums appear in anyOf/allOf/oneOf, and adds robust support for direct self-recursive models across properties, arrays, and maps. Adds targeted tests and samples, and updates CI to OCaml 5.3.
Bug Fixes
New Features
Written for commit f3e7e8d. Summary will update on new commits.