This repository has been archived by the owner on Jan 12, 2024. It is now read-only.
Make DisplayableException more serialization-friendly #776
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.
Fixes https://dev.azure.com/ms-quantum/Quantum%20Program/_workitems/edit/44472
Serializing
DisplayableException
to JSON causes anOutOfMemoryException
to be thrown.JSON tracing shows hundreds of objects referenced through
StackFrame
attempted to be serialized:On principle I don't think an object designed to be serialized/displayed should have references to complicated types such as
StackFrame
. So I'm introducing aDisplayableStackFrame
, a simple struct.Additionally I'm cleaning up a few areas that I thought looked odd - where we were serializing the same string slightly differently, unnecessary null handling, etc.
Considered, and rejected:
DisplayableException
: designing the object to be simple in the first place seems like a more sensible approachcapture_diagnostics
)