bound maximum serialization depth to < 128, similar to serde_json #1757
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
SerPolicy now tracks node depth and omits array items or object properties which would violate a bound on maximum document depth. This is largely motivated by serde_json: in all conditions, we never want to emit a document which cannot be parsed by serde_json. The serde_json limit of 128 is generous so we follow their lead.
When these occur, it can be tedious to track down which binding caused the failure. Adding the source or target collection name is key debugging info to aide in investigations.
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.
Restrict the maximum serialization depth of documents to < 128, which guarantees they can be parsed by serde_json and other tools like
jqwhich limit maximum recursion.We want this to be universal, because we never want serde_json to be unable to parse collection documents or loaded
flow_documentcolumns, and its limit on maximum depth has well-founded motivations: it would be inappropriate to, for example, completely disable limits on recursion, so we follow serde_json's lead in this regard.Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
(anything that might help someone review this PR)
This change is