Fix: Crashes when parsing diff for very large specs #388
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
|
|
joschi
reviewed
Jun 22, 2022
Comment on lines
+12
to
+13
| @JsonIgnore private OpenAPI oldSpecOpenApi; | ||
| @JsonIgnore private OpenAPI newSpecOpenApi; |
There was a problem hiding this comment.
This would change the output of the JSON renderer and remove the copy of the old and new OpenAPI specifications from the document.
Was this intentional?
There was a problem hiding this comment.
I'm fine with removing/ignoring these fields since none of the other output renderers is using them, but I want to make sure this was intentional on your end. 😉
There was a problem hiding this comment.
Yes it was. IMO that information is redundant as they are the inputs to the tool. Plus in the case of large files it makes the output unnecessarily large.
Co-authored-by: Jochen Schalanda <[email protected]>
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.
Issue:
When calculating diffs between two large Swagger specs(~123k loc) the tool will crash when writing the output to a JSON file. As shown in the screenshot this is due to the tool, first converting the
ChangedOpenAPIobject to a JSON string and then writing this string to a file. Because this string is massive it violates the max UTF16 string size.Solution:
Write the diff directly to a the output file and also omit the
oldSpecOpenApiandnewSpecOpenApiwhen writing the output as an optimization. These fields are irrelevant for the diff output.