Added support for looking up hook callables for the Sentry reporter

Author: agronholm

docs/versionhistory.rst

@@ -3,6 +3,10 @@ Version history
 
 This library adheres to `Semantic Versioning 2.0 <http://semver.org/>`_.
 
+**UNRELEASED**
+
+- Added support for looking up hook callables for the Sentry reporter
+
 **2.1.0** (2023-06-10)
 
 - Removed explicit run-time argument type checks and the ``typeguard`` dependency

pyproject.toml

@@ -42,6 +42,7 @@ test = [
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
+    "pytest-mock",
 ]
 doc = [
     "asphalt-exceptions[sentry,raygun]",

src/asphalt/exceptions/reporters/sentry.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
 import logging
+import sys
+from collections.abc import Callable
 from typing import Any, Sequence
 
 import sentry_sdk
@@ -9,8 +11,20 @@
 
 from asphalt.exceptions.api import ExceptionReporter
 
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:
+    from typing_extensions import TypeAlias
+
 logger = logging.getLogger(__name__)
 
+Event: TypeAlias = "dict[str, Any]"
+Hint: TypeAlias = "dict[str, Any]"
+Breadcrumb: TypeAlias = "dict[str, Any]"
+BreadcrumbHint: TypeAlias = "dict[str, Any]"
+EventProcessor: TypeAlias = "Callable[[Event, Hint], Event | None]"
+BreadcrumbProcessor: TypeAlias = "Callable[[Breadcrumb, BreadcrumbHint], Breadcrumb | None]"
+
 
 class SentryExceptionReporter(ExceptionReporter):
     """
@@ -31,7 +45,11 @@ class SentryExceptionReporter(ExceptionReporter):
     should be a mapping of keyword arguments to their values.
 
     The extras passed to this backend are passed to :func:`sentry_sdk.capture_exception` as keyword
-    arguments.
+    arguments. Two such options have been special cased and can be looked up as a
+    ``module:varname`` reference:
+
+    - ``before_send``
+    - ``before_breadcrumb``
 
     For more information, see the `Sentry SDK documentation`_.
 
@@ -40,8 +58,22 @@ class SentryExceptionReporter(ExceptionReporter):
     """
 
     def __init__(
-        self, integrations: Sequence[Integration | dict[str, Any]] = (), **options
+        self,
+        integrations: Sequence[Integration | dict[str, Any]] = (),
+        before_send: EventProcessor | str | None = None,
+        before_breadcrumb: BreadcrumbProcessor | str | None = None,
+        **options,
     ) -> None:
+        if isinstance(before_send, str):
+            _before_send: EventProcessor | None = resolve_reference(before_send)
+        else:
+            _before_send = before_send
+
+        if isinstance(before_breadcrumb, str):
+            _before_breadcrumb: BreadcrumbProcessor | None = resolve_reference(before_breadcrumb)
+        else:
+            _before_breadcrumb = before_breadcrumb
+
         options.setdefault("environment", "development" if __debug__ else "production")
 
         integrations_: list[Integration] = []
@@ -54,7 +86,12 @@ def __init__(
 
             integrations_.append(integration)
 
-        sentry_sdk.init(integrations=integrations_, **options)
+        sentry_sdk.init(
+            integrations=integrations_,
+            before_send=_before_send,
+            before_breadcrumb=_before_breadcrumb,
+            **options,
+        )
 
     def report_exception(
         self,

tests/reporters/test_sentry.py

@@ -2,6 +2,7 @@
 
 import pytest
 from asphalt.core import Context
+from pytest_mock import MockerFixture
 from sentry_sdk import Transport
 from sentry_sdk.integrations import Integration
 
@@ -18,6 +19,14 @@ def setup_once():
         pass
 
 
+def before_send(event, hint):
+    pass
+
+
+def before_breadcrumb(breadcrumb, hint):
+    pass
+
+
 @pytest.mark.asyncio
 async def test_sentry():
     exception = None
@@ -43,3 +52,16 @@ def test_integrations():
     SentryExceptionReporter(
         dsn="http://username:[email protected]/000000", integrations=integrations
     )
+
+
+def test_hook_lookup(mocker: MockerFixture):
+    init_func = mocker.patch("sentry_sdk.init")
+    SentryExceptionReporter(
+        before_send=f"{__name__}:before_send", before_breadcrumb=f"{__name__}:before_breadcrumb"
+    )
+    init_func.assert_called_once_with(
+        integrations=[],
+        before_send=before_send,
+        before_breadcrumb=before_breadcrumb,
+        environment="development",
+    )