Improve performance and reduce memory usage of /openapi/tree #1141
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
darrelmiller
requested review from
irvinesunday,
andrueastman,
baywet,
ddyett,
MIchaelMainer,
nikithauc,
zengin,
MaggieKimani1,
fey101,
adhiambovivian,
danielmbaluka and
rkodev
as code owners
darrelmiller
changed the title
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
baywet
approved these changes
Aug 15, 2022
|
Kudos, SonarCloud Quality Gate passed!
|
|
Thank you @darrelmiller for this fix. From my local tests the tree doesn't render on the browser. The expectation is to be able to render the tree on the browser as well, as is currently in prod.
|
|
I do get the tree to show up once I fixed the launch configuration and made sure an exception pause wasn't being raised (I don't have the connection strings to the storage account) |
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.
Overview
This PR changes the way the
/openapi/treeaction returns the response payload to minimize memory usage.Notes
This change takes advantage of the fact that the ASP.NET Response object provides access to a BodyWriter instance that can be passed to the constructor of Urtf8JsonWriter. This enables the server to construct the JSON response and have it written directly to the network stream without having to have the entire document buffered in memory.
A further enhancement could be made to cache the entire UrlNodeTree rather than reconstructing on every request.
One downside to this approach is that if an exception occurs whilst writing the tree, the HTTP response will already have returned a 200 response.
Testing Instructions
Calling
https://localhost:5001/openapi/tree?graphVersions=v1.0from multiple concurrent threads shows reduced memory usage on the server and shorter time to first byte.