Move parameter validation to middleware #1610
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
Pull Request Test Coverage Report for Build 3465708868
💛 - Coveralls |
RobbeSneyders
commented
Nov 14, 2022
| @@ -119,6 +120,15 @@ def resolve_params(self, params, _in): | |||
| else: | |||
| resolved_param[k] = values[-1] | |||
|
|
|||
| if not (is_nullable(param_defn) and is_null(resolved_param[k])): | |||
| try: | |||
| # TODO: coerce types in a single place | |||
There was a problem hiding this comment.
We now coerce the types in three locations
- Here, in the URI parser
- In the parameter validation
- In the form validation
I feel like we should be able to only do this in the URI parsing, but then we need some more work to still propagate the validation errors properly and make sure the URI parsing is used in all cases.
| @@ -206,3 +206,22 @@ def __init__( | |||
| ) | |||
|
|
|||
| super().__init__(title=title, detail=detail, **kwargs) | |||
|
|
|||
|
|
|||
| class TypeValidationError(Exception): | |||
| @@ -25,6 +25,10 @@ def from_operation(cls, operation: AbstractOperation, next_app: ASGIApp): | |||
| async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: | |||
| """Attach operation to scope and pass it to the next app""" | |||
| original_scope = _scope.get() | |||
| # Pass resolved path params along | |||
There was a problem hiding this comment.
Starlette Request relies on this.
| @@ -296,3 +298,53 @@ def extract_content_type( | |||
| mime_type = content_type | |||
| break | |||
| return mime_type, encoding | |||
|
|
|||
|
|
|||
| def coerce_type(param, value, parameter_type, parameter_name=None): | |||
| @@ -0,0 +1,150 @@ | |||
| import logging | |||
| @@ -0,0 +1,155 @@ | |||
| import json | |||
| @@ -0,0 +1,148 @@ | |||
| import collections | |||
There was a problem hiding this comment.
Mostly moved with some small changes.
| @@ -172,7 +172,7 @@ def test_path_parameter_someint__bad(simple_app): | |||
| # non-integer values will not match Flask route | |||
| app_client = simple_app.app.test_client() | |||
| resp = app_client.get("/v1.0/test-int-path/foo") # type: flask.Response | |||
| assert resp.status_code == 404 | |||
| assert resp.status_code == 400, resp.text | |||
There was a problem hiding this comment.
I believe 400 is more correct than 404 when a wrong type of path parameter is passed.
| @@ -706,7 +706,7 @@ def test_oauth_scopes_in_or(security_handler_factory): | |||
|
|
|||
|
|
|||
| def test_form_transformation(api): | |||
| mock_self = mock.Mock(strict_validation=True) | |||
| mock_self = mock.Mock() | |||
There was a problem hiding this comment.
strict_validation for form data is checked by the FormDataValidator, we don't need to include it in the transformation here.
|
Fixes #770 |
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 #1525
This PR follows up on #1588 and #1591 and moves the last part of validation, the parameter validation, to the middleware,