Merge pull request #108 from bento-platform/feat/use-flask-logger-if-…

…avail

[WIP] feat: use flask built-in logger if no logger set in flask authz middleware

bento_lib/auth/middleware/base.py

@@ -24,7 +24,7 @@ def __init__(
         self._verify_ssl: bool = not debug_mode
 
         self._enabled: bool = enabled
-        self._logger = logger or logging.getLogger(__name__)
+        self._logger: logging.Logger | None = logger
 
         self._drs_compat: bool = drs_compat
         self._sr_compat: bool = sr_compat
@@ -61,8 +61,12 @@ def _extract_token_and_build_headers(
         self.check_require_token(require_token, tkn_header)
         return {"Authorization": tkn_header} if tkn_header else {}
 
+    def _log_error(self, message: str):
+        if self._logger:
+            self._logger.error(message)
+
     def _gen_exc_non_200_error_from_authz(self, code: int, content: bytes):
-        self._logger.error(f"Got non-200 response from authorization service: {code} {content}")
+        self._log_error(f"Got non-200 response from authorization service: {code} {content}")
         # Generic error - don't leak errors from authz service!
         raise BentoAuthException("Error from authz service", status_code=500)
 

bento_lib/auth/middleware/django.py

@@ -1,3 +1,5 @@
+import logging
+
 from asgiref.sync import iscoroutinefunction, markcoroutinefunction
 from django.http import JsonResponse, HttpRequest, HttpResponse
 from typing import Awaitable, Callable
@@ -12,6 +14,13 @@
 
 
 class DjangoAuthMiddleware(BaseAuthMiddleware):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # If no logger was passed, create a new logger
+        if self._logger is None:
+            self._logger = logging.getLogger(__name__)
+
     def get_authz_header_value(self, request: HttpRequest) -> str | None:
         return request.headers.get("Authorization")
 

bento_lib/auth/middleware/fastapi.py

@@ -1,3 +1,5 @@
+import logging
+
 from fastapi import Depends, FastAPI, Request, Response, status
 from fastapi.responses import JSONResponse
 from typing import Awaitable, Callable
@@ -18,8 +20,14 @@ def attach(self, app: FastAPI):
         Attach the middleware to an application. Must be called in order for requests to be checked.
         :param app: A FastAPI application.
         """
+
+        # Attach our instance's dispatch method to the FastAPI instance as a middleware function
         app.middleware("http")(self.dispatch)
 
+        # If no logger was passed, create a new logger
+        if self._logger is None:
+            self._logger = logging.getLogger(__name__)
+
     async def dispatch(self, request: Request, call_next: Callable[[Request], Awaitable[Response]]) -> Response:
         if not self.enabled or request.method == "OPTIONS":
             # - Skip checks if the authorization middleware is disabled

bento_lib/auth/middleware/flask.py

@@ -19,9 +19,13 @@ def attach(self, app: Flask):
         Attach the middleware to an application. Must be called in order for requests to be checked.
         :param app: A Flask application.
         """
+
         app.before_request(self.middleware_pre)
         app.after_request(self.middleware_post)
 
+        if self._logger is None:
+            self._logger = app.logger
+
     def middleware_pre(self) -> None:
         if self.enabled:
             g.bento_determined_authz = False

tests/test_platform_django.py

@@ -12,6 +12,12 @@
 )
 
 
+def test_django_authz_logger_init():
+    from bento_lib.auth.middleware.django import DjangoAuthMiddleware
+    mw = DjangoAuthMiddleware("https://bento-auth.local")
+    assert mw._logger is not None
+
+
 @pytest.mark.parametrize(authz_test_case_params, authz_test_cases)
 @responses.activate
 def test_django_auth(

tests/test_platform_fastapi.py

@@ -205,6 +205,14 @@ def _expect_error(r: HttpxResponse, code: int, msg: str):
     assert data["errors"][0]["message"] == msg
 
 
+def test_fastapi_middleware_init_logger():
+    inst = FastApiAuthMiddleware(bento_authz_service_url="https://bento-auth.local")
+    inst._log_error("doesn't appear")
+    inst.attach(FastAPI())  # should create a logger if not specified
+    inst._log_error("does appear")
+    assert inst._logger is not None
+
+
 def test_fastapi_http_exception_404(test_client: TestClient):
     _expect_error(test_client.get("/get-404"), 404, "Hello")
 

tests/test_platform_flask.py

@@ -148,6 +148,13 @@ def auth_disabled_post_private():
 # -----------------------------------------------------------------------------
 
 
+def test_flask_middleware_init_logger():
+    inst = FlaskAuthMiddleware(bento_authz_service_url="https://bento-auth.local")
+    app = Flask(__name__)
+    inst.attach(app)
+    assert inst._logger == app.logger
+
+
 def test_flask_errors(flask_client):
     # non-existent endpoint
 

tox.ini

@@ -12,4 +12,5 @@ skip_install = true
 commands =
     pip install -r requirements.txt
     pytest -svv --cov=bento_lib --cov-branch {posargs}
+    coverage html
     flake8 ./bento_lib ./tests