Support Sanic #1250

ioggstream · 2020-06-11T11:08:34Z

Fixes #496 .

Changes proposed in this pull request:

support Sanic
creating a sanic_api.py and sanic_app.py modules
add relevant tests

kigawas · 2020-10-26T05:53:47Z

Is it ready to merge? Looks good to me

…nic-poc-1

update Sanic poc with master

ioggstream · 2020-10-26T10:03:48Z

connexion/http_facts.py

@@ -11,5 +11,5 @@
    "options",
    "head",
    "patch",
-    "trace"
+#    "trace"  #  FIXME: rpolli


@kigawas Sanic does not support trace. Ideas welcome!

Trace method is rather rare, do we really need it?

It's in connexion code, so we should ask them. @dtkav

ioggstream · 2020-10-26T10:05:02Z

tests/conftest.py

@@ -11,7 +11,7 @@
 logging.basicConfig(level=logging.DEBUG)

 TEST_FOLDER = pathlib.Path(__file__).parent
-FIXTURES_FOLDER = TEST_FOLDER / 'fixtures'
+FIXTURES_FOLDER = TEST_FOLDER / "fixtures"


@kigawas iiuc we both like black but I'd limit this kind of changes on connexion repo :)

ioggstream#3

ioggstream · 2020-10-26T10:08:51Z

@kigawas still there are tests failing, and more should be added.
A discussion with the connexion community should be started to check they are interested in supporting sanic.

kigawas · 2020-10-26T14:07:42Z

@kigawas still there are tests failing, and more should be added.
A discussion with the connexion community should be started to check they are interested in supporting sanic.

Lots of errors like TypeError: Can't instantiate abstract class SanicApi with abstract methods make_security_handler_factory

Maybe it's better to add flake8, black and mypy to make life easier

kigawas · 2020-10-27T06:33:08Z

@kigawas still there are tests failing, and more should be added.
A discussion with the connexion community should be started to check they are interested in supporting sanic.

--- a/connexion/apis/abstract.py
+++ b/connexion/apis/abstract.py
@@ -37,7 +37,8 @@ class AbstractAPI(metaclass=AbstractAPIMeta):
     def __init__(self, specification, base_path=None, arguments=None,
                  validate_responses=False, strict_validation=False, resolver=None,
                  auth_all_paths=False, debug=False, resolver_error_handler=None,
-                 validator_map=None, pythonic_params=False, pass_context_arg_name=None, options=None):
+                 validator_map=None, pythonic_params=False, pass_context_arg_name=None, options=None,
+                 ):
         """
         :type specification: pathlib.Path | dict
         :type base_path: str | None
@@ -101,6 +102,8 @@ class AbstractAPI(metaclass=AbstractAPIMeta):
         logger.debug('pass_context_arg_name: %s', pass_context_arg_name)
         self.pass_context_arg_name = pass_context_arg_name

+        self.security_handler_factory = self.make_security_handler_factory(pass_context_arg_name)
+
         if self.options.openapi_spec_available:
             self.add_openapi_json()
             self.add_openapi_yaml()
@@ -143,6 +146,11 @@ class AbstractAPI(metaclass=AbstractAPIMeta):
         Adds a 404 error handler to authenticate and only expose the 404 status if the security validation pass.
         """

+    @staticmethod
+    @abc.abstractmethod
+    def make_security_handler_factory(pass_context_arg_name):
+        """ Create SecurityHandlerFactory to create all security check handlers """
+
     def add_operation(self, path, method):
         """
         Adds one operation to the api.

Solution

index d2050b1..feb095d 100644
--- a/connexion/apis/flask_api.py
+++ b/connexion/apis/flask_api.py
@@ -9,6 +9,7 @@ from connexion.handlers import AuthErrorHandler
 from connexion.jsonifier import Jsonifier
 from connexion.lifecycle import ConnexionRequest, ConnexionResponse
 from connexion.utils import is_json_mimetype, yamldumper
+from connexion.security import FlaskSecurityHandlerFactory
 from werkzeug.local import LocalProxy

 logger = logging.getLogger('connexion.apis.flask_api')
@@ -16,6 +17,11 @@ logger = logging.getLogger('connexion.apis.flask_api')

 class FlaskApi(AbstractAPI):

+    @staticmethod
+    def make_security_handler_factory(pass_context_arg_name):
+        """ Create default SecurityHandlerFactory to create all security check handlers """
+        return FlaskSecurityHandlerFactory(pass_context_arg_name)
+
     def _set_base_path(self, base_path):
         super(FlaskApi, self)._set_base_path(base_path)
         self._set_blueprint()

kigawas · 2020-10-27T07:30:44Z

@ioggstream

We are actively using this PR and it works pretty well, but there also come several bugs like

For the value in url query, only the last character or number will get passed into handlers (like abc=123&def=456, you'll only get {'abc': '3', 'def': '6'})
For uuid arguments, an extra dot appears (like you'll get .dc1332bd-c104-4d6f-b3ee-8ea83dccb028 instead of dc1332bd-c104-4d6f-b3ee-8ea83dccb028. Probably this is a connexion bug)

ioggstream · 2020-10-27T07:37:17Z

@ioggstream

We are actively using this PR and it works pretty well, but there also come several bugs ...
That's great! Happy that it works...

I am happy to review and merge your patches, but we really need to engage with connexion folks to continue :)

For the value in url query, only the last character or number will get passed into handlers (like abc=123&def=456, you'll only get {'abc': '3', 'def': '6'})

For uuid arguments, an extra dot appears

kigawas · 2020-10-27T07:49:18Z

I am happy to review and merge your patches, but we really need to engage with connexion folks to continue :)

@zalando @hjacobs

I apologise if it bothers you, but it'd be really nice to support sanic 😃

remove aiohttp jinja2

kigawas · 2020-11-06T05:16:04Z

This pr would fix most of the errors mentioned above, except one.

ioggstream#4

Here is the pytest result (for only tests/sanic/test_sanic_bootstrap.py)

=============================================================================== short test summary info ================================================================================
FAILED tests/sanic/test_sanic_bootstrap.py::test_app_with_different_uri_parser - AssertionError: assert ['d'] == ['a', 'b', 'c']
===================================================================== 1 failed, 42 passed, 2654 warnings in 10.84s =====================================================================

For full log: https://gist.github.com/kigawas/b26a4905d4f7118bd70ed8c532fd2321

fix build error

ioggstream · 2020-11-09T17:23:08Z

connexion/security/__init__.py

@@ -5,3 +5,5 @@
 # concrete
 from .flask_security_handler_factory import FlaskSecurityHandlerFactory  # NOQA
 from .aiohttp_security_handler_factory import AioHttpSecurityHandlerFactory  # NOQA
+


@kigawas can we remove this space?

ioggstream · 2020-11-09T17:24:23Z

connexion/security/async_security_handler_factory.py

@@ -3,8 +3,6 @@
 import functools
 import logging

-import aiohttp


@kigawas can you PR this separately to the main connexion branch so that we don't mess with files we are not going to change?

Since the sanic dependencies do not include aiohttp, it's better to remove this to avoid potential import error

#1320

pr proposed

@kigawas I understand, but let's push on #1320 and remove this change from this PR so we don't have to rebase :)

No worries, I'll update later

Tzvika-m · 2021-02-28T13:17:03Z

Is this still active?
Would be super useful (:
Thanks!

kigawas · 2021-03-02T11:59:17Z

Is this still active?
Would be super useful (:
Thanks!

This PR should work itself, but the maintenance of this repo is not active I guess

ioggstream · 2021-03-02T14:14:56Z

Hi folks, if there is some interest in the connexion community we can continue to work on it....

RobbeSneyders · 2023-02-17T16:52:22Z

Connexion 3.0 will support ASGI frameworks out of the box. See #1395

ioggstream added 7 commits June 11, 2020 14:41

Working error handlers and api spec.

49d03a4

More tests.

d86e77e

Working mocks.

7a7e7f1

Pass request to each sanic request via the context.

1384647

fix missing methods

e032476

Running ui tests.

e3d0430

isort

0300a77

ioggstream force-pushed the sanic-poc branch from 4ceb5b1 to 0300a77 Compare June 17, 2020 11:07

ioggstream added 2 commits June 17, 2020 18:58

Schema validation the sanic way.

badfdef

add sanic in tox.ini

11df083

kigawas and others added 3 commits October 26, 2020 14:58

Merge branch 'master' of https://github.com/zalando/connexion into sa…

03f4cb4

…nic-poc-1

remove aiohttp jinja2

cd78f69

Merge pull request #1 from kigawas/sanic-poc-1

a1bafd7

update Sanic poc with master

ioggstream commented Oct 26, 2020

View reviewed changes

ioggstream and others added 2 commits October 28, 2020 09:26

Merge pull request #2 from kigawas/sanic-poc-remove-aiohttp

3bec9f5

remove aiohttp jinja2

fix build error

90cac20

Merge pull request #4 from kigawas/sanic-poc-fix-build-error

01964b9

fix build error

ioggstream commented Nov 9, 2020

View reviewed changes

kigawas mentioned this pull request Dec 10, 2020

Alternative for openapi-core berislavlopac/pyotr#15

Open

RobbeSneyders mentioned this pull request Jun 21, 2021

Moving Connexion forward #1365

Closed

RobbeSneyders closed this Feb 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Sanic #1250

Support Sanic #1250

ioggstream commented Jun 11, 2020

kigawas commented Oct 26, 2020

ioggstream Oct 26, 2020

kigawas Oct 27, 2020

ioggstream Oct 27, 2020

ioggstream Oct 26, 2020

kigawas Oct 27, 2020

ioggstream commented Oct 26, 2020

kigawas commented Oct 26, 2020

kigawas commented Oct 27, 2020 •

edited

Loading

kigawas commented Oct 27, 2020 •

edited

Loading

ioggstream commented Oct 27, 2020

kigawas commented Oct 27, 2020

kigawas commented Nov 6, 2020 •

edited

Loading

ioggstream Nov 9, 2020

ioggstream Nov 9, 2020

kigawas Nov 10, 2020

kigawas Nov 10, 2020

ioggstream Nov 10, 2020

kigawas Nov 10, 2020

Tzvika-m commented Feb 28, 2021

kigawas commented Mar 2, 2021

ioggstream commented Mar 2, 2021

RobbeSneyders commented Feb 17, 2023

Support Sanic #1250

Support Sanic #1250

Conversation

ioggstream commented Jun 11, 2020

kigawas commented Oct 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ioggstream commented Oct 26, 2020

kigawas commented Oct 26, 2020

kigawas commented Oct 27, 2020 • edited Loading

kigawas commented Oct 27, 2020 • edited Loading

ioggstream commented Oct 27, 2020

kigawas commented Oct 27, 2020

kigawas commented Nov 6, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tzvika-m commented Feb 28, 2021

kigawas commented Mar 2, 2021

ioggstream commented Mar 2, 2021

RobbeSneyders commented Feb 17, 2023

kigawas commented Oct 27, 2020 •

edited

Loading

kigawas commented Oct 27, 2020 •

edited

Loading

kigawas commented Nov 6, 2020 •

edited

Loading