Fix Mutation of API Spec #537
Merged
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
Add failing test case for cdimascio#535. The problem manifests itself when calling `middleware()` with an object multiple times, as the object itself is mutated which might cause errors on subsequent calls. In this specific example, the parameters for GET /ping/{value} are modified in such a way that a second call will cause a validation error. This happens in `preprocessPathLevelParameters`.
Clone the API specification passed to the `middleware()` function. This avoids mutating the `apiSpec` parameter passed to that function, which can lead to unexpected behaviour. Fixes cdimascio#535.
cdimascio
approved these changes
Feb 14, 2021
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.
Fixes #535
I found the line that mutates the parameters causing the error here: https://github.com/cdimascio/express-openapi-validator/blob/v4.10.11/src/middlewares/parsers/schema.preprocessor.ts#L489
It doesn't seem easy to change that behaviour thoug. About the idea of using a set, this seems to me like it could hide some actual errors. So I opted for just cloning the spec passed to
middleware(). That should avoid other unexpected behaviour, too.