Skip to content

Avoid buffering JSON data into a new MemoryStream during parsing #1857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Avoid buffering JSON data into a new MemoryStream during parsing #1857

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e958896
If the input stream is JSON, read directly from stream, otherwise buf…
MaggieKimani1 Oct 3, 2024
e0f20d0
Clean up comment
MaggieKimani1 Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,24 +98,27 @@ public static async Task<ReadResult> LoadAsync(Stream input, string format, Open
Utils.CheckArgumentNull(format, nameof(format));
settings ??= new OpenApiReaderSettings();

MemoryStream bufferedStream;
if (input is MemoryStream stream)
Stream preparedStream;

// Avoid buffering for JSON documents
if (input is MemoryStream || format.Equals(OpenApiConstants.Json, StringComparison.OrdinalIgnoreCase))
{
bufferedStream = stream;
preparedStream = input;
}
else
{
// Buffer stream so that OpenApiTextReaderReader can process it synchronously
// YamlDocument doesn't support async reading.
bufferedStream = new MemoryStream();
await input.CopyToAsync(bufferedStream, 81920, cancellationToken);
bufferedStream.Position = 0;
// Buffer stream for non-JSON formats (e.g., YAML) since they require synchronous reading
preparedStream = new MemoryStream();
await input.CopyToAsync(preparedStream, 81920, cancellationToken);
preparedStream.Position = 0;
}

using var reader = new StreamReader(bufferedStream, default, true, -1, settings.LeaveStreamOpen);
// Use StreamReader to process the prepared stream (buffered for YAML, direct for JSON)
using var reader = new StreamReader(preparedStream, default, true, -1, settings.LeaveStreamOpen);
return await LoadAsync(reader, format, settings, cancellationToken);
}


/// <summary>
/// Loads the TextReader input and parses it into an Open API document.
/// </summary>
Expand Down
Loading