feat: add custom json marshaler for sdk.Statement #1936
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
jrschumacher
reviewed
Mar 4, 2025
Comment on lines
+136
to
+147
| if s.Format == "json-structured" { | ||
| raw := json.RawMessage(s.Value) | ||
| var tmp interface{} | ||
| // Attempt to decode Value to validate it's actual json | ||
| if err := json.Unmarshal(raw, &tmp); err == nil { | ||
| aux.Value = raw | ||
| } else { | ||
| aux.Value = s.Value | ||
| } | ||
| } else { | ||
| aux.Value = s.Value | ||
| } |
There was a problem hiding this comment.
I reviewed our implementation of assertions compared to our spec, and it looks like we missed the enum of the statement.format. I've raised this with our architects, and we're going to review the alignment of the ZTDF/BaseTDF spec with the official SDKs (Go, Java, and Web).
I'd suggest implementing the marshaling within your PEP to support this in the short term. Something like:
type MyStatement struct {
opentdf.Statement
}
func (s *MyStatement) MarshalJSON() ([]byte, error) {
// ...
}There was a problem hiding this comment.
Alternatively you should be able to just marshal the data since we have the json tags on the Statement.
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.
Proposed Changes
If you agree with this change, I'm happy to add tests.
I assume it's a good idea to try to decode the value to make sure it's actual json. I just wasn't sure whether we should return an error if not or if we should just use the value as string.
Opinions?
Checklist
Testing Instructions