Flask request user support (#432)

* ConnexionRequest.context proxied to flask.request instance

* Add type annotations for FlaskRequestContextProxy

* Sort imports

* Sort imports

* Remove unnecessary code

connexion/apis/flask_api.py

@@ -225,7 +225,8 @@ def _get_flask_response(cls, response, mimetype):
             return cls._build_flask_response(mimetype=mimetype, data=response)
 
     @classmethod
-    def get_request(cls, **params):
+    def get_request(cls, *args, **params):
+        # type: (*Any, **Any) -> ConnexionRequest
         """Gets ConnexionRequest instance for the operation handler
         result. Status Code and Headers for response.  If only body
         data is returned by the endpoint function, then the status
@@ -234,19 +235,20 @@ def get_request(cls, **params):
         If the returned object is a flask.Response then it will just
         pass the information needed to recreate it.
 
-        :type operation_handler_result: flask.Response | (flask.Response, int) | (flask.Response, int, dict)
         :rtype: ConnexionRequest
         """
-        request = flask.request
+        flask_request = flask.request
         request = ConnexionRequest(
-            request.url, request.method,
-            headers=request.headers,
-            form=request.form,
-            query=request.args,
-            body=request.get_data(),
-            json=request.get_json(silent=True),
-            files=request.files,
-            path_params=params
+            flask_request.url,
+            flask_request.method,
+            headers=flask_request.headers,
+            form=flask_request.form,
+            query=flask_request.args,
+            body=flask_request.get_data(),
+            json=flask_request.get_json(silent=True),
+            files=flask_request.files,
+            path_params=params,
+            context=FlaskRequestContextProxy()
         )
         logger.debug('Getting data and status code',
                      extra={
@@ -255,3 +257,21 @@ def get_request(cls, **params):
                          'url': request.url
                      })
         return request
+
+
+class FlaskRequestContextProxy(object):
+    """"Proxy assignments from `ConnexionRequest.context`
+    to `flask.request` instance.
+    """
+    def __init__(self):
+        self.values = {}
+
+    def __setitem__(self, key, value):
+        # type: (str, Any) -> None
+        logger.debug('Setting "%s" attribute in flask.request', key)
+        setattr(flask.request, key, value)
+        self.values[key] = value
+
+    def items(self):
+        # type: () -> list
+        return self.values.items()

connexion/decorators/parameter.py

@@ -7,6 +7,7 @@
 import inflection
 import six
 
+from ..request import ConnexionRequest  # NOQA
 from ..utils import all_json, boolean, is_null, is_nullable
 
 try:
@@ -115,6 +116,7 @@ def sanitize_param(name):
 
     @functools.wraps(function)
     def wrapper(request):
+        # type: (ConnexionRequest) -> Any
         logger.debug('Function Arguments: %s', arguments)
         kwargs = {}
 
@@ -186,10 +188,10 @@ def wrapper(request):
 
         # add context info (e.g. from security decorator)
         for key, value in request.context.items():
-            if not has_kwargs and key not in arguments:
-                logger.debug("Context parameter '%s' not in function arguments", key)
-            else:
+            if has_kwargs or key in arguments:
                 kwargs[key] = value
+            else:
+                logger.debug("Context parameter '%s' not in function arguments", key)
         return function(**kwargs)
 
     return wrapper

tests/api/test_secure_api.py

@@ -78,6 +78,10 @@ def test_security(oauth_requests, secure_endpoint_app):
     assert get_bye_good_auth.status_code == 200
     assert get_bye_good_auth.data == b'Goodbye hjacobs (Secure!)'
 
+    headers = {"Authorization": "Bearer 100"}
+    get_bye_from_flask = app_client.get('/v1.0/byesecure-from-flask', headers=headers)  # type: flask.Response
+    assert get_bye_from_flask.data == b'Goodbye test-user (Secure!)'
+
 
 def test_checking_that_client_token_has_all_necessary_scopes(
         oauth_requests, secure_endpoint_app):

tests/fakeapi/hello.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 
+import flask
 from flask import jsonify, redirect
 
 from connexion import NoContent, ProblemException, problem
@@ -69,6 +70,11 @@ def get_flask_response_tuple():
 def get_bye_secure(name, user, token_info):
     return 'Goodbye {name} (Secure: {user})'.format(name=name, user=user)
 
+
+def get_bye_secure_from_flask():
+    return 'Goodbye {user} (Secure!)'.format(user=flask.request.user)
+
+
 def get_bye_secure_ignoring_context(name):
     return 'Goodbye {name} (Secure!)'.format(name=name)
 

tests/fixtures/secure_endpoint/swagger.yaml

@@ -44,6 +44,22 @@ paths:
           required: true
           type: string
 
+  /byesecure-from-flask:
+    get:
+      summary: Generate goodbye
+      description: ""
+      operationId: fakeapi.hello.get_bye_secure_from_flask
+      security:
+        - oauth:
+          - myscope
+      produces:
+        - text/plain
+      responses:
+        200:
+          description: goodbye response
+          schema:
+            type: string
+
   /byesecure-ignoring-context/{name}:
     get:
       summary: Generate goodbye