Fix #22: Add Sentry support (#24)

Author: leplatrem

poetry.lock

@@ -17,6 +17,7 @@ atlassian-python-api = "^3.20.1"
 dockerflow = "2022.1.0"
 Jinja2 = "^3.0.3"
 pydantic-yaml = {extras = ["pyyaml","ruamel"], version = "^0.6.1"}
+sentry-sdk = "^1.5.7"
 
 
 [tool.poetry.dev-dependencies]
@@ -54,6 +55,7 @@ testpaths = [
     load-plugins='pylint_pytest'
     ignore='third_party'
     ignore-patterns = "tests/*"
+    extension-pkg-whitelist = "pydantic"
 
 [tool.isort]
 profile = "black"

pyproject.toml

@@ -5,10 +5,12 @@
 import time
 from datetime import datetime
 
+import sentry_sdk
 import uvicorn  # type: ignore
 from fastapi import FastAPI, Request
 from fastapi.responses import RedirectResponse
 from fastapi.staticfiles import StaticFiles
+from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
 
 from src.app.environment import get_settings
 from src.app.log import configure_logging
@@ -17,6 +19,8 @@
 
 settings = get_settings()
 
+configure_logging()
+
 app = FastAPI(
     title="Jira Bugzilla Integration (JBI)",
     description="JBI v2 Platform",
@@ -27,6 +31,11 @@
 app.include_router(jbi_router)
 app.mount("/static", StaticFiles(directory="src/static"), name="static")
 
+sentry_sdk.init(  # pylint: disable=abstract-class-instantiated  # noqa: E0110
+    dsn=settings.sentry_dsn
+)
+app.add_middleware(SentryAsgiMiddleware)
+
 
 @app.get("/", include_in_schema=False)
 def root(request: Request):
@@ -61,12 +70,6 @@ async def request_summary(request: Request, call_next):
     return response
 
 
-@app.on_event("startup")
-def startup_event():
-    """On app startup perform these setup operations"""
-    configure_logging()
-
-
 if __name__ == "__main__":
     uvicorn.run(
         "app:app", host=settings.host, port=settings.port, reload=settings.app_reload

src/app/api.py

@@ -4,8 +4,13 @@
 import json
 from functools import lru_cache
 from pathlib import Path
+from typing import Optional
 
-from pydantic import BaseSettings
+from pydantic import AnyUrl, BaseSettings
+
+
+class SentryDsn(AnyUrl):
+    """Url type to validate Sentry DSN"""
 
 
 class Settings(BaseSettings):
@@ -30,6 +35,9 @@ class Settings(BaseSettings):
     # Logging
     log_level: str = "info"
 
+    # Sentry
+    sentry_dsn: Optional[SentryDsn]
+
 
 @lru_cache()
 def get_settings() -> Settings:

src/app/environment.py

@@ -66,12 +66,6 @@ def execute_action(request: BugzillaWebhookRequest, action_map, settings):
     except IgnoreInvalidRequestError as exception:
         invalid_logger.debug("ignore-invalid-request: %s", exception)
         return JSONResponse(content={"error": str(exception)}, status_code=202)
-    except Exception as exception:  # pylint: disable=broad-except
-        # TODO: Remove when sentry is enabled # pylint: disable=fixme
-        jbi_logger.info(
-            "unknown-exception (%s): %s", type(exception), exception, exc_info=True
-        )
-        raise exception
 
 
 @api_router.post("/bugzilla_webhook")

src/jbi/router.py

@@ -0,0 +1,25 @@
+"""
+Module for testing Sentry integration
+"""
+# pylint: disable=cannot-enumerate-pytest-fixtures
+
+import json
+import os.path
+from unittest.mock import patch
+
+import pytest
+
+from src.jbi.bugzilla import BugzillaWebhookRequest
+
+
+def test_errors_are_reported_to_sentry(
+    anon_client, webhook_request_example: BugzillaWebhookRequest
+):
+    with patch("sentry_sdk.hub.Hub.capture_event") as mocked:
+        with patch("src.jbi.router.execute_action", side_effect=ValueError):
+            with pytest.raises(ValueError):
+                anon_client.post(
+                    "/bugzilla_webhook", data=webhook_request_example.json()
+                )
+
+    assert mocked.called, "Sentry captured the exception"