rework conditional loading of the OAS plugins #11585
Merged
Conversation
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
viren-nadkarni
approved these changes
Sep 27, 2024
| @@ -92,6 +95,7 @@ def __call__(self, chain: HandlerChain, context: RequestContext, response: Respo | |||
| if not config.OPENAPI_VALIDATE_REQUEST: | |||
| return | |||
|
|
|||
| hasattr(self, "open_apis") or self._load_specs() | |||
There was a problem hiding this comment.
It might be cleaner to move the conditional into _load_specs() but yes, it will impact the performance due to the extra call
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.
Motivation
When we introduced the validation for the internal endpoints based on the OpenAPI specs, we made sure the correspondent plugins and specs wouldn't be loaded if at least one between
OPENAPI_VALIDATE_REQUESTorOPENAPI_VALIDATE_RESPONSE.The idea was to avoid this step, when unnecessary.
However, this is an issue if we turn these config variables when the container is already started, and the chain initialized.
In such a case, the calls to the validators fail because the instance variable
open_apishasn't been initialized (I came across this while writing some tests).To support the later activation of the validation at runtime, we slightly reworked the loading logic.
Changes
open_apisattribute and eventually perform the loading.