Detect cyclic references during JSONObject/JSONArray serialization - #1075
Open
arimu1 wants to merge 2 commits into
Open
Detect cyclic references during JSONObject/JSONArray serialization#1075arimu1 wants to merge 2 commits into
arimu1 wants to merge 2 commits into
Conversation
Thread an identity-based serialization stack through write paths so programmatic cycles throw JSONException instead of StackOverflowError. Re-throw cyclic-reference JSONException from toString() while preserving existing null-return behavior for other serialization failures. Fixes stleary#1056
… contract Add package-private CyclicReferenceException and detect cycles via instanceof instead of message matching. Re-throw only cyclic failures from no-arg toString(); other JSONException paths still return null. Strengthen tests with typed assertions, BrokenToString null checks, and mixed object/array cycle. Fixes review feedback on stleary#1075
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
IdentityHashMap-backedSet) throughJSONObject.write,JSONArray.write, andwriteValueso programmatic self-references and mutual cycles throwJSONExceptioninstead ofStackOverflowError.JSONExceptionfromtoString()while preserving the existing null-return behavior for other serialization failures.Fixes #1056
Notes on depth limiting
This PR focuses on cycle detection for programmatically constructed
JSONObject/JSONArraygraphs (the reproducer in #1056). Deep-but-acyclic parsed JSON that can still overflow the stack during serialization (see @JeewoongKim's fuzz note) is left as a follow-up: applyingmaxNestingDepthon the write path would need a separate design decision about whether serialization should share parser configuration.Test plan
mvn test(800 tests, 0 failures)JSONObject.toString()→JSONExceptionJSONExceptionJSONArray.toString()→JSONExceptionJSONObject.valueToString()on cyclic graph →JSONExceptionJSONObject↔JSONArraycycle → typedCyclicReferenceExceptionBrokenToStringvalues still yieldnullfrom no-argtoString()