ast: Marshal non-string object keys when converting to interface{} #2577
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
Previously, when OPA attempted to convert an ast.Object to interface{}
it would error if the ast.Object contained any keys that were not
ast.String values. This behaviour was implemented because JSON only
supports object keys as strings.
This commit changes the conversion implementation to simply JSON
marshal non-string object keys when they are encountered. This way
we avoid runtime errors which can be difficult to debug.
Fixes open-policy-agent#516
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
|
cc @timothyhinrichs @srenatus @jaspervdj-luminal tagging a few folks on this change to get thoughts. |
patrick-east
approved these changes
Jul 24, 2020
|
Seems good to me. Gives us more flexibility inside of Rego AND moves us toward fewer runtime errors. |
jaspervdj-luminal
approved these changes
Jul 24, 2020
srenatus
approved these changes
Jul 25, 2020
srenatus
reviewed
Jul 26, 2020
| } | ||
| vi, err := ValueToInterface(v.Value, resolver) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| buf[asStr] = vi | ||
| buf[str] = vi |
There was a problem hiding this comment.
In case of a clash ({"1":0, 1:0}), the key processed second will overwrite the one processed first, right?
I see no solid solution here, only ways to make it less likely, like marshaling the example thing to {"[1]":0,"1":0}.
There was a problem hiding this comment.
Tried it briefly to verify:
> { 1: true, "1": false, "{}": "foo", {}: "bar" }
{
"1": false,
"{}": "bar"
}
>There was a problem hiding this comment.
Nice find. Agreed, there's no good solution here. I think this is still better than having policy evaluation return an error. I'm going to go ahead and merge.
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.
Previously, when OPA attempted to convert an ast.Object to interface{}
it would error if the ast.Object contained any keys that were not
ast.String values. This behaviour was implemented because JSON only
supports object keys as strings.
This commit changes the conversion implementation to simply JSON
marshal non-string object keys when they are encountered. This way
we avoid runtime errors which can be difficult to debug.
Fixes #516
Signed-off-by: Torin Sandall torinsandall@gmail.com