[REF] error handling compose (#1146)

* make sure headers are added

* test cors headers

* handle all errors in compose

Author: jdkent

compose/backend/neurosynth_compose/__init__.py

@@ -3,13 +3,11 @@
 
 import connexion
 from authlib.integrations.flask_client import OAuth
-from connexion.middleware import MiddlewarePosition
 from connexion.resolver import MethodResolver
-from flask_cors import CORS
 from starlette.middleware.cors import CORSMiddleware
 
 from .database import init_db
-from .resources.auth import handle_auth_error, AuthError
+from .resources.auth import AuthError, handle_auth_error
 
 
 def create_app():
@@ -32,9 +30,7 @@ def create_app():
         "APIKEYINFO_FUNC", app.config.get("APIKEYINFO_FUNC", default_apikey)
     )
 
-    connexion_app.add_middleware(
-        CORSMiddleware,
-        position=MiddlewarePosition.BEFORE_ROUTING,
+    cors_kwargs = dict(
         allow_origins=["*"],
         allow_credentials=True,
         allow_methods=["*"],
@@ -79,10 +75,12 @@ def create_app():
     init_db(app)
 
     app.secret_key = app.config["JWT_SECRET_KEY"]
-    CORS(app)
 
     app.register_error_handler(AuthError, handle_auth_error)
 
+    cors_asgi_app = CORSMiddleware(connexion_app, **cors_kwargs)
+
     app.extensions["connexion_app"] = connexion_app
+    app.extensions["connexion_asgi"] = cors_asgi_app
 
     return app

compose/backend/neurosynth_compose/core.py

@@ -3,6 +3,7 @@
 from .__init__ import create_app
 
 app = create_app()
+asgi_app = app.extensions["connexion_asgi"]
 
 ext_celery = FlaskCeleryExt(app)
 celery_app = ext_celery.celery

compose/backend/neurosynth_compose/tests/request_utils.py

@@ -1,6 +1,8 @@
 import json
 from functools import partialmethod
 
+from starlette.testclient import TestClient as StarletteTestClient
+
 
 class Client(object):
     def __init__(self, token, test_client=None, prepend="", username=None):
@@ -9,32 +11,26 @@ def __init__(self, token, test_client=None, prepend="", username=None):
         if test_client is None:
             from flask import current_app as app
 
+            asgi_app = app.extensions.get("connexion_asgi")
             connexion_app = app.extensions.get("connexion_app")
 
-            if connexion_app is not None:
-                target_app = connexion_app
-                if not getattr(target_app, "test_client", None):
-                    target_app = getattr(target_app, "app", target_app)
-                if not getattr(target_app, "test_client", None):
-                    target_app = getattr(target_app, "_app", target_app)
-                if not getattr(target_app, "test_client", None):
-                    target_app = getattr(target_app, "app", target_app)
-                test_client = target_app.test_client()
+            if asgi_app is not None:
+                test_client = StarletteTestClient(asgi_app)
+            elif connexion_app is not None and hasattr(connexion_app, "test_client"):
+                test_client = connexion_app.test_client()
             else:
                 test_client = app.test_client()
 
-        if hasattr(test_client, "open"):
-            self.client_mode = "flask"
-        else:
-            self.client_mode = "requests"
+        self.client_flask = hasattr(test_client, "open")
+        self.client_mode = "flask" if self.client_flask else "requests"
 
         self.client = test_client
         self.prepend = prepend
         self.token = token
         self.username = username
 
     def close(self):
-        if self.client_flask and hasattr(self.client, "close"):
+        if hasattr(self.client, "close"):
             self.client.close()
 
     def _get_headers(self):

compose/backend/neurosynth_compose/tests/test_cors_headers.py

@@ -0,0 +1,60 @@
+import pytest
+from starlette.testclient import TestClient
+from werkzeug.routing import Rule
+
+from .request_utils import Client
+
+
+@pytest.fixture(scope="module")
+def cors_test_client(app):
+    endpoint_name = "__cors_test_status"
+    if endpoint_name not in app.view_functions:
+        from flask import jsonify
+
+        def _cors_status(status_code):
+            if status_code == 204:
+                return "", 204
+            return jsonify({"status": status_code}), status_code
+
+        app.url_map.add(
+            Rule(
+                "/__test/cors/<int:status_code>",
+                endpoint=endpoint_name,
+                methods=["GET"],
+            )
+        )
+        app.view_functions[endpoint_name] = _cors_status
+
+    client = TestClient(app.extensions["connexion_asgi"])
+    try:
+        yield client
+    finally:
+        client.close()
+
+
+@pytest.fixture
+def anonymous_client():
+    return Client(token=None)
+
+
+@pytest.mark.parametrize(
+    "client_fixture, method, path, expected_status",
+    [
+        ("auth_client", "get", "/api/specifications?page_size=1", 200),
+        ("cors_test_client", "get", "/__test/cors/204", 204),
+        ("cors_test_client", "get", "/__test/cors/400", 400),
+        ("anonymous_client", "post", "/api/annotations", 401),
+        ("cors_test_client", "get", "/__test/cors/404", 404),
+        ("cors_test_client", "get", "/__test/cors/420", 420),
+        ("cors_test_client", "get", "/__test/cors/500", 500),
+    ],
+)
+def test_cors_headers_present(
+    client_fixture, method, path, expected_status, request, user_data
+):
+    client = request.getfixturevalue(client_fixture)
+    headers = {"Origin": "https://client.example"}
+    response = getattr(client, method)(path, headers=headers)
+
+    assert response.status_code == expected_status
+    assert response.headers.get("Access-Control-Allow-Origin") == "*"

compose/docker-compose.dev.yml

@@ -11,10 +11,9 @@ services:
   compose:
     expose:
       - "8000"
-    command: /usr/local/bin/gunicorn -w 2 -b :8000 neurosynth_compose.core:app --log-level debug --timeout 300 --reload
+    command: /usr/local/bin/gunicorn -k uvicorn.workers.UvicornWorker --reload -w 2 -b :8000 neurosynth_compose.core:asgi_app --log-level debug --timeout 300
     restart: "no"
 
   compose_worker:
     volumes:
       - ./neurosynth_compose:/usr/local/lib/python3.10/site-packages/neurosynth_compose
-

compose/docker-compose.yml

@@ -17,7 +17,7 @@ services:
       - ./backend/migrations:/migrations
       - ./:/compose
       - ${FILE_DIR}:/file-data
-    command: /usr/local/bin/gunicorn -w 2 -b :8000 neurosynth_compose.core:app --log-level debug --timeout 120
+    command: /usr/local/bin/gunicorn -k uvicorn.workers.UvicornWorker -w 2 -b :8000 neurosynth_compose.core:asgi_app --log-level debug --timeout 120
     env_file:
       - .env