Convert pystein asgi to use handle_async (#145)

* convert asgi to use async handle

* refactor

* remove externalhttpapp class

* fix mypy

* fix mypy

---------

Co-authored-by: gavin-aguiar <[email protected]>

Author: YunchuWang

azure/functions/__init__.py

@@ -11,8 +11,8 @@
                          Cardinality, AccessRights, HttpMethod,
                          AsgiFunctionApp, WsgiFunctionApp)
 from ._durable_functions import OrchestrationContext, EntityContext
-from .decorators.function_app import (FunctionRegister, TriggerApi, BindingApi,
-                                      ExternalHttpFunctionApp)
+from .decorators.function_app import (FunctionRegister, TriggerApi,
+                                      BindingApi)
 from .extension import (ExtensionMeta, FunctionExtensionException,
                         FuncExtensionBase, AppExtensionBase)
 from ._http_wsgi import WsgiMiddleware
@@ -85,7 +85,6 @@
     'TriggerApi',
     'BindingApi',
     'Blueprint',
-    'ExternalHttpFunctionApp',
     'AsgiFunctionApp',
     'WsgiFunctionApp',
     'DataType',

azure/functions/decorators/__init__.py

@@ -3,7 +3,7 @@
 from .core import Cardinality, AccessRights
 from .function_app import FunctionApp, Function, DecoratorApi, DataType, \
     AuthLevel, Blueprint, AsgiFunctionApp, WsgiFunctionApp, \
-    ExternalHttpFunctionApp, FunctionRegister, TriggerApi, BindingApi
+    FunctionRegister, TriggerApi, BindingApi
 from .http import HttpMethod
 
 __all__ = [
@@ -14,7 +14,6 @@
     'TriggerApi',
     'BindingApi',
     'Blueprint',
-    'ExternalHttpFunctionApp',
     'AsgiFunctionApp',
     'WsgiFunctionApp',
     'DataType',

azure/functions/decorators/function_app.py

@@ -1726,46 +1726,57 @@ class Blueprint(TriggerApi, BindingApi):
     pass
 
 
-class ExternalHttpFunctionApp(FunctionRegister, TriggerApi, ABC):
-    """Interface to extend for building third party http function apps."""
+class AsgiFunctionApp(FunctionRegister, TriggerApi):
+    def __init__(self, app,
+                 http_auth_level: Union[AuthLevel, str] = AuthLevel.FUNCTION):
+        """Constructor of :class:`AsgiFunctionApp` object.
 
-    def _add_http_app(self,
-                      http_middleware: Union[
-                          AsgiMiddleware, WsgiMiddleware],
-                      http_type: str) -> None:
-        """Add a Wsgi or Asgi app integrated http function.
+        :param app: asgi app object.
+        :param http_auth_level: Determines what keys, if any, need to be
+        present
+        on the request in order to invoke the function.
+        """
+        super().__init__(auth_level=http_auth_level)
+        self._add_http_app(AsgiMiddleware(app))
+
+    def _add_http_app(self, asgi_middleware: AsgiMiddleware) -> None:
+        """Add an Asgi app integrated http function.
 
-        :param http_middleware: :class:`AsgiMiddleware` or
-        :class:`WsgiMiddleware` instance.
+        :param asgi_middleware: :class:`AsgiMiddleware` instance.
 
         :return: None
         """
 
-        @self.http_type(http_type=http_type)
+        @self.http_type(http_type='asgi')
         @self.route(methods=(method for method in HttpMethod),
                     auth_level=self.auth_level,
                     route="/{*route}")
-        def http_app_func(req: HttpRequest, context: Context):
-            return http_middleware.handle(req, context)
+        async def http_app_func(req: HttpRequest, context: Context):
+            return await asgi_middleware.handle_async(req, context)
 
 
-class AsgiFunctionApp(ExternalHttpFunctionApp):
+class WsgiFunctionApp(FunctionRegister, TriggerApi):
     def __init__(self, app,
                  http_auth_level: Union[AuthLevel, str] = AuthLevel.FUNCTION):
-        """Constructor of :class:`AsgiFunctionApp` object.
+        """Constructor of :class:`WsgiFunctionApp` object.
 
-        :param app: asgi app object.
+        :param app: wsgi app object.
         """
         super().__init__(auth_level=http_auth_level)
-        self._add_http_app(AsgiMiddleware(app), 'asgi')
+        self._add_http_app(WsgiMiddleware(app))
 
+    def _add_http_app(self,
+                      wsgi_middleware: WsgiMiddleware) -> None:
+        """Add a Wsgi app integrated http function.
 
-class WsgiFunctionApp(ExternalHttpFunctionApp):
-    def __init__(self, app,
-                 http_auth_level: Union[AuthLevel, str] = AuthLevel.FUNCTION):
-        """Constructor of :class:`WsgiFunctionApp` object.
+        :param wsgi_middleware: :class:`WsgiMiddleware` instance.
 
-        :param app: wsgi app object.
+        :return: None
         """
-        super().__init__(auth_level=http_auth_level)
-        self._add_http_app(WsgiMiddleware(app), 'wsgi')
+
+        @self.http_type(http_type='wsgi')
+        @self.route(methods=(method for method in HttpMethod),
+                    auth_level=self.auth_level,
+                    route="/{*route}")
+        def http_app_func(req: HttpRequest, context: Context):
+            return wsgi_middleware.handle(req, context)

tests/decorators/test_function_app.py

@@ -1,5 +1,6 @@
 #  Copyright (c) Microsoft Corporation. All rights reserved.
 #  Licensed under the MIT License.
+import inspect
 import json
 import unittest
 from unittest import mock
@@ -302,8 +303,6 @@ def test_add_asgi(self, add_http_app_mock):
         self.assertIsInstance(add_http_app_mock.call_args[0][0],
                               AsgiMiddleware)
 
-        self.assertEqual(add_http_app_mock.call_args[0][1], 'asgi')
-
     @mock.patch('azure.functions.decorators.function_app.WsgiFunctionApp'
                 '._add_http_app')
     def test_add_wsgi(self, add_http_app_mock):
@@ -313,52 +312,12 @@ def test_add_wsgi(self, add_http_app_mock):
         add_http_app_mock.assert_called_once()
         self.assertIsInstance(add_http_app_mock.call_args[0][0],
                               WsgiMiddleware)
-        self.assertEqual(add_http_app_mock.call_args[0][1], 'wsgi')
-
-    def test_add_http_app(self):
-        app = AsgiFunctionApp(app=object())
-        funcs = app.get_functions()
-        self.assertEqual(len(funcs), 1)
-        func = funcs[0]
 
-        self.assertEqual(func.get_function_name(), "http_app_func")
-
-        raw_bindings = func.get_raw_bindings()
-        raw_trigger = raw_bindings[0]
-        raw_output_binding = raw_bindings[0]
+    def test_add_asgi_app(self):
+        self._test_http_external_app(AsgiFunctionApp(app=object()), True)
 
-        self.assertEqual(json.loads(raw_trigger),
-                         json.loads(
-                             '{"direction": "IN", "type": "httpTrigger", '
-                             '"authLevel": "FUNCTION", "route": "/{*route}", '
-                             '"methods": ["GET", "POST", "DELETE", "HEAD", '
-                             '"PATCH", "PUT", "OPTIONS"], "name": "req"}'))
-        self.assertEqual(json.loads(raw_output_binding), json.loads(
-            '{"direction": "IN", "type": "httpTrigger", "authLevel": '
-            '"FUNCTION", "methods": ["GET", "POST", "DELETE", "HEAD", '
-            '"PATCH", "PUT", "OPTIONS"], "name": "req", "route": "/{'
-            '*route}"}'))
-
-        self.assertEqual(func.get_bindings_dict(), {
-            "bindings": [
-                {
-                    "authLevel": AuthLevel.FUNCTION,
-                    "direction": BindingDirection.IN,
-                    "methods": [HttpMethod.GET, HttpMethod.POST,
-                                HttpMethod.DELETE,
-                                HttpMethod.HEAD,
-                                HttpMethod.PATCH,
-                                HttpMethod.PUT, HttpMethod.OPTIONS],
-                    "name": "req",
-                    "route": "/{*route}",
-                    "type": HTTP_TRIGGER
-                },
-                {
-                    "direction": BindingDirection.OUT,
-                    "name": "$return",
-                    "type": HTTP_OUTPUT
-                }
-            ]})
+    def test_add_wsgi_app(self):
+        self._test_http_external_app(WsgiFunctionApp(app=object()), False)
 
     def test_register_function_app_error(self):
         with self.assertRaises(TypeError) as err:
@@ -567,3 +526,45 @@ def test_wsgi_function_app_is_http_function(self):
 
         self.assertEqual(len(funcs), 1)
         self.assertTrue(funcs[0].is_http_function())
+
+    def _test_http_external_app(self, app, is_async):
+        funcs = app.get_functions()
+        self.assertEqual(len(funcs), 1)
+        func = funcs[0]
+        self.assertEqual(func.get_function_name(), "http_app_func")
+        raw_bindings = func.get_raw_bindings()
+        raw_trigger = raw_bindings[0]
+        raw_output_binding = raw_bindings[0]
+        self.assertEqual(inspect.iscoroutinefunction(func.get_user_function()),
+                         is_async)
+        self.assertEqual(json.loads(raw_trigger),
+                         json.loads(
+                             '{"direction": "IN", "type": "httpTrigger", '
+                             '"authLevel": "FUNCTION", "route": "/{*route}", '
+                             '"methods": ["GET", "POST", "DELETE", "HEAD", '
+                             '"PATCH", "PUT", "OPTIONS"], "name": "req"}'))
+        self.assertEqual(json.loads(raw_output_binding), json.loads(
+            '{"direction": "IN", "type": "httpTrigger", "authLevel": '
+            '"FUNCTION", "methods": ["GET", "POST", "DELETE", "HEAD", '
+            '"PATCH", "PUT", "OPTIONS"], "name": "req", "route": "/{'
+            '*route}"}'))
+        self.assertEqual(func.get_bindings_dict(), {
+            "bindings": [
+                {
+                    "authLevel": AuthLevel.FUNCTION,
+                    "direction": BindingDirection.IN,
+                    "methods": [HttpMethod.GET, HttpMethod.POST,
+                                HttpMethod.DELETE,
+                                HttpMethod.HEAD,
+                                HttpMethod.PATCH,
+                                HttpMethod.PUT, HttpMethod.OPTIONS],
+                    "name": "req",
+                    "route": "/{*route}",
+                    "type": HTTP_TRIGGER
+                },
+                {
+                    "direction": BindingDirection.OUT,
+                    "name": "$return",
+                    "type": HTTP_OUTPUT
+                }
+            ]})