fix: Add support for recursive json schema elements to prevent fatal error #5167
+257
−67
Conversation
This file contains 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
|
Looks like it's got a race condition, converting to draft until it's fixed. |
liamg
force-pushed
the
liamg-recursive-schema-support
branch
from
d6316ed to
66fa711
Compare
|
...fixed now 🥳 |
srenatus
reviewed
Sep 22, 2022
| // | ||
| // We'd get this result: | ||
| // | ||
| // GetRulesDynamicWithOpts("data[x]", RulesOptions{IncludeHiddenModules: true}) => [rule1, rule2, rule3] | ||
| // GetRulesDynamicWithOpts("data[x]", RulesOptions{IncludeHiddenModules: true}) => [rule1, rule2, rule3] | ||
| // | ||
| // Without the options, it would be excluded. |
There was a problem hiding this comment.
☝️ These are automatically done through go 1.19's formatter -- it's not related to this PR, but someone's got to commit it eventually. So I'm ok if that someone is you 😀
| expectedErrors: []string{ | ||
| "undefined function foo", | ||
| }, | ||
| },*/ | ||
| { |
There was a problem hiding this comment.
🙈 this is weird, but presumably also the code formatter. Let's roll with it.
| @@ -7332,3 +7333,121 @@ func TestKeepModules(t *testing.T) { | |||
| } | |||
| }) | |||
| } | |||
|
|
|||
| // see https://github.com/open-policy-agent/opa/issues/5166 | |||
There was a problem hiding this comment.
I think keeping the issue link in the commit message is good enough. But it doesn't hurt much to have it twice, either.
liamg
force-pushed
the
liamg-recursive-schema-support
branch
from
66fa711 to
43c8f01
Compare
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
srenatus
approved these changes
Sep 22, 2022
…error Resolves open-policy-agent#5166 Signed-off-by: Liam Galvin <liam.galvin@aquasec.com>
liamg
force-pushed
the
liamg-recursive-schema-support
branch
from
43c8f01 to
03993a1
Compare
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.
This adds support for recursive json schemas, such as:
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://github.com/open-policy-agent/opa/issues/5166", "type": "object", "properties": { "Something": { "$ref": "#/$defs/X" } }, "$defs": { "X": { "type": "object", "properties": { "Y": { "$ref": "#/$defs/Y" } } }, "Y": { "type": "object", "properties": { "X": { "$ref": "#/$defs/X" } } } } }The
parseSchemamethod now hangs from aschemaParserstruct. This allows the use of a cache that can be populated with definitions as they are seen, to prevent them being reparsed later. They are added to cache before they are completely parsed, otherwise the recursive crash would still occur. Thus they are added to the cache with all properties without values, then the values are added in by reference after the subsequent child tree parse.I've added a couple of tests that cover my use case, as well as a schema parsing test (this already passed before my changes - the compile time analysis of the schema is the problem) for good measure.
Happy to change whatever or discuss an alternative approach, just shout (I'm on the OPA slack)
Resolves #5166
Signed-off-by: Liam Galvin liam.galvin@aquasec.com