fix: upgrade dependencies on v2 branch

The main goal was upgrading werkzeug for CVE-2024-34069. After switching to python 3.12, it proved more difficult with changes to setuptools, etc. I decided to pull the pyproject from the main, and utilize that, alone with updated dependencies. Small changes were needed in various api changes, notably: - flask change of request_ctx - swagger_ui_bundle version change, default_template_dir change - aiohttp middleware api slightly changed - flask json change, using flask.json.provider I believe these changes will have minimal impact to users, but the changes are likely breaking for some, specifically, the move to latest flask. fixes spec-first#1969 Signed-off-by: Mike Marchetti <[email protected]>
mfmarche · Nov 9, 2024 · a2c3165 · a2c3165
1 parent 6a859b3
commit a2c3165
Show file tree

Hide file tree

Showing 12 changed files with 3,213 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,284 @@
+ <a id="top"></a>
+ <p align="center">
+     <img src="https://raw.githubusercontent.com/spec-first/connexion/main/docs/images/logo_banner.svg" width="100%"/>
+ </p>
+ <p align="center">
+     <a href="https://pypi.org/project/connexion"><img alt="coveralls" src="https://img.shields.io/pypi/status/connexion.svg?style=flat-square&color=brightgreen"></a>
+     <a href="https://pypi.org/project/connexion"><img alt="PyPI version" src="https://img.shields.io/pypi/v/connexion?color=brightgreen&style=flat-square"></a>
+     <a href="https://pypistats.org/packages/connexion"><img alt="PyPI" src="https://img.shields.io/pypi/dm/connexion?style=flat-square&color=brightgreen"></a>
+     <a href="https://github.com/spec-first/connexion/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/connexion?style=flat-square&color=brightgreen"></a>
+     <a href="https://github.com/spec-first/connexion/actions/workflows/pipeline.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/spec-first/connexion/pipeline.yml?style=flat-square"></a>
+     <a href="https://coveralls.io/github/spec-first/connexion?branch=main"><img alt="Coveralls" src="https://img.shields.io/coverallsCoverage/github/spec-first/connexion?style=flat-square"></a>
+     <br>
+     <br>
+     <a href="https://connexion.readthedocs.io/en/stable/"><strong>Explore the docs »</strong></a>
+ </p>
+
+---
+
+Connexion is a modern Python web framework that makes spec-first and api-first development easy.
+You describe your API in an [OpenAPI][OpenAPI] (or [Swagger][Swagger]) specification with as much 
+detail as you want and Connexion will guarantee that it works as you specified.
+
+It works either standalone, or in combination with any ASGI or WSGI-compatible framework!
+
+<p align="center">
+   <br>
+   <a href="https://connexion.readthedocs.io/en/latest/v3.html"><strong>📢 Connexion 3 was recently released! Read about the changes here »</strong></a>
+   <br>
+   <br>
+</p>
+
+## ✨ Features
+
+Connexion provides the following functionality **based on your specification**:
+
+- 🚏 **Automatic route registration**, no ``@route`` decorators needed
+- 🔒 **Authentication**, split from your application logic
+- 🔎 **Request and response validation** of headers, parameters, and body
+- 📬 **Parameter parsing and injection**, no request object needed
+- 📨 **Response serialization**, you can return regular Python objects
+- 📺 **A Swagger UI console** with live documentation and ‘try it out’ feature
+- 🧩 **Pluggability**, in all dimensions
+
+Connexion also **helps you write your OpenAPI specification** and develop against it by providing a command line interface which lets you test and mock your specification.
+
+```shell
+   connexion run openapi.yaml
+```
+
+ <p align="right">(<a href="#top">back to top</a>)</p>
+
+
+## 🫶 Sponsors
+
+<a href="https://www.ml6.eu"><img src="https://raw.githubusercontent.com/spec-first/connexion/main/docs/images/sponsors/ML6.png" title=ML6 height="100"></a>
+<a href="https://www.devmark.ai/fern/?utm_source=connexion&utm_loc=readme&utm_type=logo"><img src="https://raw.githubusercontent.com/spec-first/connexion/main/docs/images/sponsors/Fern.png" title=Fern height="100"></a>
+
+Sponsors help us dedicate time to maintain Connexion. Want to help?
+
+<a href="https://github.com/sponsors/spec-first"><strong>Explore the options »</strong></a>
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## 🪤 Why Connexion
+
+With Connexion, you write the spec first. Connexion then calls your Python
+code, handling the mapping from the specification to the code. This
+incentivizes you to write the specification so that all of your
+developers can understand what your API does, even before you write a
+single line of code.
+
+If multiple teams depend on your APIs, you can use Connexion to easily
+send them the documentation of your API. This guarantees that your API will
+follow the specification that you wrote. This is a different process from
+the one offered by most frameworks, which generate a specification
+*after* you've written the code.
+Some disadvantages of generating specifications based on code is that
+they often end up lacking details or mix your documentation with the implementation
+logic of your application.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## ⚒️ How to Use
+
+### Installation
+
+You can install connexion using pip:
+
+```shell
+    $ pip install connexion
+```
+
+Connexion provides 'extras' with optional dependencies to unlock additional features:
+
+- `swagger-ui`: Enables a Swagger UI console for your application.
+- `uvicorn`: Enables to run the your application using `app.run()` for
+  development instead of using an external ASGI server.
+- `flask`: Enables the `FlaskApp` to build applications compatible with the Flask
+  ecosystem.
+
+You can install them as follows:
+
+```shell
+    $ pip install connexion[swagger-ui]
+    $ pip install connexion[swagger-ui,uvicorn]
+```
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Creating your application
+
+Connexion can be used either as a standalone application or as a middleware wrapping an existing
+ASGI (or WSGI) application written using a different framework. The standalone application can be
+built using either the `AsyncApp` or `FlaskApp`.
+
+- The `AsyncApp` is a lightweight application with native asynchronous support. Use it if you
+  are starting a new project and have no specific reason to use one of the other options.
+
+  ```Python
+      from connexion import AsyncApp
+
+      app = AsyncApp(__name__)
+  ```
+
+- The `FlaskApp` leverages the `Flask` framework, which is useful if you're migrating from
+  connexion 2.X or you want to leverage the `Flask` ecosystem.
+
+  ```python
+      from connexion import FlaskApp
+
+      app = FlaskApp(__name__)
+  ```
+
+- The `ConnexionMiddleware` can be wrapped around any existing ASGI or WSGI application.
+  Use it if you already have an application written in a different framework and want to add
+  functionality provided by connexion
+
+  ```python
+      from asgi_framework import App
+      from connexion import ConnexionMiddleware
+
+      app = App(__name__)
+      app = ConnexionMiddleware(app)
+  ```
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Registering an API
+
+While you can register individual routes on your application, Connexion really shines when you
+register an API defined by an OpenAPI (or Swagger) specification.
+The operation described in your specification is automatically linked to your Python view function via the ``operationId``
+
+**run.py**
+
+```python
+   def post_greeting(name: str, greeting: str):  # Paramaeters are automatically unpacked
+       return f"{greeting} {name}", 200          # Responses are automatically serialized
+
+   app.add_api("openapi.yaml")
+```
+
+**openapi.yaml**
+
+```yaml
+   ...
+   paths:
+     /greeting/{name}:
+       post:
+         operationId: run.post_greeting
+         responses:
+           200:
+             content:
+               text/plain:
+                 schema:
+                   type: string
+         parameters:
+           - name: name
+             in: path
+             required: true
+             schema:
+               type: string
+           - name: greeting
+             in: query
+             required: true
+             schema:
+               type: string
+```
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Running your application
+
+If you installed connexion using `connexion[uvicorn]`, you can run it using the
+`run` method. This is only recommended for development:
+
+```python
+    app.run()
+```
+
+In production, run your application using an ASGI server such as `uvicorn`. If you defined your
+`app` in a python module called `run.py`, you can run it as follows:
+
+```shell
+    $ uvicorn run:app
+```
+
+Or with gunicorn:
+
+```shell
+    $ gunicorn -k uvicorn.workers.UvicornWorker run:app
+```
+
+----
+
+Now you're able to run and use Connexion!
+
+See the [examples][examples] folder for more examples.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## 📜 Changes
+
+A full changelog is maintained on the [GitHub releases page][Releases].
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## 🤲 Contributing
+
+We welcome your ideas, issues, and pull requests. Just follow the
+usual/standard GitHub practices.
+
+For easy development, install connexion using poetry with all extras, and
+install the pre-commit hooks to automatically run black formatting and static analysis checks.
+
+```shell
+    pip install poetry
+    poetry install --all-extras
+    pre-commit install
+```
+
+You can find out more about how Connexion works and where to apply your changes by having a look
+at our [architecture][Architecture].
+
+Unless you explicitly state otherwise in advance, any non trivial
+contribution intentionally submitted for inclusion in this project by you
+to the steward of this repository shall be under the
+terms and conditions of Apache License 2.0 written below, without any
+additional copyright information, terms or conditions.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## 🙏 Thanks
+
+We'd like to thank all of Connexion's contributors for working on this
+project, Swagger/OpenAPI for their support, and Zalando for originally developing and releasing Connexion.
+
+## 📚 Recommended Resources
+
+About the advantages of working spec-first:
+
+* [Blog Atlassian][Blog Atlassian]
+* [API guidelines Zalando][API guidelines Zalando]
+* [Blog ML6][Blog ML6]
+* [Blog Zalando][Blog Zalando]
+
+Tools to help you work spec-first:
+
+* [Online swagger editor][Online swagger editor]
+* [VS Code plugin][VS Code plugin]
+* [Pycharm plugin][Pycharm plugin]
+
+[OpenAPI]: https://openapis.org/
+[Swagger]: http://swagger.io/open-source-integrations/
+[Blog atlassian]: https://www.atlassian.com/blog/technology/spec-first-api-development
+[Blog ML6]: https://blog.ml6.eu/why-we-decided-to-help-maintain-connexion-c9f449877083
+[Blog Zalando]: https://engineering.zalando.com/posts/2016/12/crafting-effective-microservices-in-python.html
+[API guidelines Zalando]: https://opensource.zalando.com/restful-api-guidelines/#api-first
+[Online swagger editor]: https://editor.swagger.io/
+[VS Code plugin]: https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
+[Pycharm plugin]: https://plugins.jetbrains.com/plugin/14837-openapi-swagger-editor
+[examples]: https://github.com/spec-first/connexion/blob/main/examples
+[Releases]: https://github.com/spec-first/connexion/releases
+[Architecture]: https://github.com/spec-first/connexion/blob/main/docs/images/architecture.png
diff --git a/connexion/apis/flask_api.py b/connexion/apis/flask_api.py
@@ -9,6 +9,7 @@
 from typing import Any
 
 import flask
+from flask.globals import request_ctx
 import werkzeug.exceptions
 from werkzeug.local import LocalProxy
 
@@ -36,7 +37,7 @@ def _set_base_path(self, base_path):
 
     def _set_blueprint(self):
         logger.debug('Creating API blueprint: %s', self.base_path)
-        endpoint = flask_utils.flaskify_endpoint(self.base_path)
+        endpoint = flask_utils.flaskify_endpoint(self.base_path) or "/"
         self.blueprint = flask.Blueprint(endpoint, __name__, url_prefix=self.base_path,
                                          template_folder=str(self.options.openapi_console_ui_from_dir))
 
@@ -233,7 +234,7 @@ def get_request(cls, *args, **params):
         :rtype: ConnexionRequest
         """
         context_dict = {}
-        setattr(flask._request_ctx_stack.top, 'connexion_context', context_dict)
+        setattr(request_ctx, "connexion_context", context_dict)
         flask_request = flask.request
         request = ConnexionRequest(
             flask_request.url,
@@ -265,7 +266,7 @@ def _set_jsonifier(cls):
 
 
 def _get_context():
-    return getattr(flask._request_ctx_stack.top, 'connexion_context')
+    return getattr(request_ctx, "connexion_context")
 
 
 context = LocalProxy(_get_context)

diff --git a/connexion/apps/flask_app.py b/connexion/apps/flask_app.py
@@ -5,12 +5,14 @@
 import datetime
 import logging
 import pathlib
+import json
 from decimal import Decimal
 from types import FunctionType  # NOQA
 
 import flask
 import werkzeug.exceptions
-from flask import json, signals
+from flask import signals
+from flask.json.provider import DefaultJSONProvider
 
 from ..apis.flask_api import FlaskApi
 from ..exceptions import ProblemException
@@ -33,7 +35,7 @@ def __init__(self, import_name, server='flask', extra_files=None, **kwargs):
 
     def create_app(self):
         app = flask.Flask(self.import_name, **self.server_args)
-        app.json_encoder = FlaskJSONEncoder
+        app.json = FlaskJSONProvider(app)
         app.url_map.converters['float'] = NumberConverter
         app.url_map.converters['int'] = IntegerConverter
         return app
@@ -150,6 +152,29 @@ def run(self,
             raise Exception(f'Server {self.server} not recognized')
 
 
+class FlaskJSONProvider(DefaultJSONProvider):
+    def __init__(self, app):
+        super().__init__(app)
+
+    def default(self, o):
+        if isinstance(o, datetime.datetime):
+            if o.tzinfo:
+                # eg: '2015-09-25T23:14:42.588601+00:00'
+                return o.isoformat("T")
+            else:
+                # No timezone present - assume UTC.
+                # eg: '2015-09-25T23:14:42.588601Z'
+                return o.isoformat("T") + "Z"
+
+        if isinstance(o, datetime.date):
+            return o.isoformat()
+
+        if isinstance(o, Decimal):
+            return float(o)
+
+        return super().default(o)
+
+
 class FlaskJSONEncoder(json.JSONEncoder):
     def default(self, o):
         if isinstance(o, datetime.datetime):

diff --git a/connexion/options.py b/connexion/options.py
@@ -6,9 +6,9 @@
 from typing import Optional  # NOQA
 
 try:
-    from swagger_ui_bundle import swagger_ui_2_path, swagger_ui_3_path
+    from swagger_ui_bundle import swagger_ui_path as default_template_dir
 except ImportError:
-    swagger_ui_2_path = swagger_ui_3_path = None
+    default_template_dir = None
 
 from connexion.decorators.uri_parsing import AbstractURIParser
 
@@ -28,10 +28,10 @@ def __init__(self, options=None, oas_version=(2,)):
         self.oas_version = oas_version
         if self.oas_version >= (3, 0, 0):
             self.openapi_spec_name = '/openapi.json'
-            self.swagger_ui_local_path = swagger_ui_3_path
+            self.swagger_ui_local_path = default_template_dir
         else:
             self.openapi_spec_name = '/swagger.json'
-            self.swagger_ui_local_path = swagger_ui_2_path
+            self.swagger_ui_local_path = default_template_dir
 
         if options:
             self._options.update(filter_values(options))