Introduce a recursive cycle check when writing #345
Merged
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
I noticed that writing can blow up when there are recusrive objects that reference each other. (For example, in HTTP.jl, `Response` and `Request` reference each other) This PR proposes a simple API for the `CompactContext` and `PrettyContext` where `objectid` of objects will be tracked recursively when writing and it's configurable what should be written out when a recursive cycle is detected. Custom contexts can "hook in" to this behavior by subtyping `RecursiveCheckContext` and including the required fields (see docs for new context). Otherwise, there shouldn't be any functional change to APIs in any way.
Codecov Report
@@ Coverage Diff @@
## master #345 +/- ##
==========================================
- Coverage 98.63% 98.44% -0.20%
==========================================
Files 5 5
Lines 441 451 +10
==========================================
+ Hits 435 444 +9
- Misses 6 7 +1
Continue to review full report at Codecov.
|
|
@KristofferC or @fredrikekre, could I bug you to review here? |
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.
I noticed that writing can blow up when there are recusrive objects that reference each other.
(For example, in HTTP.jl,
ResponseandRequestreference each other)This PR proposes a simple API for the
CompactContextandPrettyContextwhereobjectidof objects will be tracked recursively when writing and it's configurablewhat should be written out when a recursive cycle is detected.
Custom contexts can "hook in" to this behavior by subtyping
RecursiveCheckContextandincluding the required fields (see docs for new context). Otherwise, there shouldn't
be any functional change to APIs in any way.
cc: @vilterp (oops, wrong ping the 1st time)