Uh oh!
There was an error while loading. Please reload this page.
Refactor readers to reduce surface area - #1975
Merged
Merged
Conversation
Maggie Kimani (MaggieKimani1)
marked this pull request as draft
November 28, 2024 15:51
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Maggie Kimani (MaggieKimani1)
marked this pull request as ready for review
December 2, 2024 11:19
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
| { | ||
| throw new InvalidOperationException($"Could not download the file at {url}", ex); | ||
| // YAML or other non-JSON format; copy remaining input to a new stream. | ||
| preparedStream = new MemoryStream(); |
Check warning
Code scanning / CodeQL
Missing Dispose call on local IDisposable
| { | ||
| throw new InvalidOperationException($"Could not open the file at {url}", ex); | ||
| // Buffer stream for non-JSON formats (e.g., YAML) since they require synchronous reading | ||
| preparedStream = new MemoryStream(); |
Check warning
Code scanning / CodeQL
Missing Dispose call on local IDisposable
Closed
Vincent Biret (baywet)
requested changes
Dec 20, 2024
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Copilot reviewed 15 out of 30 changed files in this pull request and generated 2 comments.
Files not reviewed (15)
- test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs: Evaluated as low risk
- src/Microsoft.OpenApi.Hidi/OpenApiService.cs: Evaluated as low risk
- src/Microsoft.OpenApi/Interfaces/IOpenApiReader.cs: Evaluated as low risk
- src/Microsoft.OpenApi/Models/OpenApiDocument.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDiscriminatorTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiEncodingTests.cs: Evaluated as low risk
- src/Microsoft.OpenApi.Readers/OpenApiYamlReader.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiCallbackTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiExampleTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiSchemaTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiDocumentTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiDocumentTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/OpenApiDiagnosticTests.cs: Evaluated as low risk
- test/Microsoft.OpenApi.Readers.Tests/OpenApiReaderTests/UnsupportedSpecVersionTests.cs: Evaluated as low risk
Comments suppressed due to low confidence (3)
src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs:332
- The method
PrepareStreamForReadingAsyncmight read the entire stream into memory, which could be inefficient for very large streams. Consider adding a check to handle large streams more efficiently.
private static async Task<(Stream, string)> PrepareStreamForReadingAsync(Stream input, string format, CancellationToken token = default)
src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs:79
- The method ReadAsync(JsonNode, OpenApiReaderSettings, string, CancellationToken) has been removed. Replace it with Read(JsonNode, OpenApiReaderSettings, string).
return await ReadAsync(jsonNode, settings, cancellationToken: cancellationToken);
src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs:145
- Ensure that the external references loading functionality is still covered elsewhere in the codebase, as the LoadExternalRefsAsync method has been removed.
return Read(jsonNode, settings);
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
|
Vincent Biret (baywet)
requested changes
Dec 20, 2024
Vincent Biret (baywet)
left a comment
Member
There was a problem hiding this comment.
Thank you for making the changes!
Vincent Biret (baywet)
approved these changes
Dec 20, 2024
Vincent Biret (baywet)
left a comment
Member
There was a problem hiding this comment.
(clicked the wrong button 🤦)
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 freeto 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.
Fixes#1954
fixes#1951
Fixes#1964
Fixes#1917
fixes#1918
closes#1958
closes#1929