plainx-sentry 0.10.1__py3-none-any.whl → 0.11.0__py3-none-any.whl

plainx/sentry/CHANGELOG.md

@@ -1,5 +1,18 @@
 # plainx-sentry changelog
 
+## [0.11.0](https://github.com/davegaeddert/plainx-sentry/releases/v0.11.0) (2026-02-05)
+
+### What's changed
+
+- Added `SentryMiddleware` for automatic request and user context on Sentry events ([950df07](https://github.com/davegaeddert/plainx-sentry/commit/950df07))
+- Now requires Python 3.13+ ([dbfb0d7](https://github.com/davegaeddert/plainx-sentry/commit/dbfb0d7))
+- Added type annotations throughout the codebase ([dbfb0d7](https://github.com/davegaeddert/plainx-sentry/commit/dbfb0d7))
+
+### Upgrade instructions
+
+- Ensure you are running Python 3.13 or higher
+- Add `SentryMiddleware` to your middleware stack after `SessionMiddleware` for automatic request/user context
+
 ## [0.7.0](https://github.com/davegaeddert/plainx-sentry/releases/plainx-sentry@0.7.0) (2025-07-19)
 
 ### What's changed

plainx/sentry/config.py

@@ -11,7 +11,7 @@ from sentry_sdk.integrations.opentelemetry import SentryPropagator, SentrySpanPr
 class PlainxSentryConfig(PackageConfig):
     label = "plainxsentry"
 
-    def ready(self):
+    def ready(self) -> None:
         if settings.SENTRY_DSN and settings.SENTRY_AUTO_INIT:
             sentry_sdk.init(
                 settings.SENTRY_DSN,

plainx/sentry/middleware.py

@@ -0,0 +1,73 @@
+from typing import Any
+
+import sentry_sdk
+from plain.auth import get_request_user
+from plain.http import HttpMiddleware
+from plain.http.request import Request
+from plain.http.response import Response
+from sentry_sdk.scope import should_send_default_pii
+
+
+def _build_request_info(request: Request) -> dict[str, Any]:
+    """Build request context dictionary for Sentry events."""
+    try:
+        url = request.build_absolute_uri()
+    except Exception:
+        url = request.path
+
+    request_info = {
+        "method": request.method,
+        "url": url,
+        "query_string": request.query_string,
+    }
+
+    if should_send_default_pii():
+        request_info["headers"] = dict(request.headers)
+        request_info["cookies"] = dict(request.cookies)
+
+    return request_info
+
+
+def _build_user_info(user: Any) -> dict[str, Any]:
+    """Build user context dictionary for Sentry events."""
+    user_info = {"id": str(user.id)}
+
+    if should_send_default_pii():
+        if email := getattr(user, "email", None):
+            user_info["email"] = email
+        if username := getattr(user, "username", None):
+            user_info["username"] = username
+
+    return user_info
+
+
+class SentryMiddleware(HttpMiddleware):
+    """
+    Middleware that registers a Sentry event processor for request/user context.
+
+    Add this to your MIDDLEWARE setting after SessionMiddleware:
+
+        MIDDLEWARE = [
+            ...
+            "plain.sessions.middleware.SessionMiddleware",
+            "plainx.sentry.middleware.SentryMiddleware",
+            ...
+        ]
+    """
+
+    def process_request(self, request: Request) -> Response:
+        def event_processor(
+            event: dict[str, Any], hint: dict[str, Any]
+        ) -> dict[str, Any]:
+            if "request" not in event:
+                event["request"] = _build_request_info(request)
+
+            if "user" not in event:
+                user = get_request_user(request)
+                if user:
+                    event["user"] = _build_user_info(user)
+
+            return event
+
+        sentry_sdk.get_current_scope().add_event_processor(event_processor)
+        return self.get_response(request)

plainx/sentry/templates.py

@@ -1,4 +1,7 @@
+from typing import Any
+
 import sentry_sdk
+from jinja2.runtime import Context
 from plain.auth import get_request_user
 from plain.runtime import settings
 from plain.templates import register_template_extension
@@ -10,7 +13,9 @@ class SentryJSExtension(InclusionTagExtension):
     tags = {"sentry_js"}
     template_name = "sentry/js.html"
 
-    def get_context(self, context, *args, **kwargs):
+    def get_context(
+        self, context: Context, *args: Any, **kwargs: Any
+    ) -> Context | dict[str, Any]:
         if not settings.SENTRY_DSN:
             return {}
 
@@ -45,7 +50,10 @@ class SentryJSExtension(InclusionTagExtension):
 class SentryFeedbackExtension(SentryJSExtension):
     tags = {"sentry_feedback"}
 
-    def get_context(self, context, *args, **kwargs):
-        context = super().get_context(context, *args, **kwargs)
-        context["sentry_dialog_event_id"] = sentry_sdk.last_event_id()
-        return context
+    def get_context(
+        self, context: Context, *args: Any, **kwargs: Any
+    ) -> dict[str, Any]:
+        parent_result = super().get_context(context, *args, **kwargs)
+        result: dict[str, Any] = dict(parent_result)
+        result["sentry_dialog_event_id"] = sentry_sdk.last_event_id()
+        return result

{plainx_sentry-0.10.1.dist-info → plainx_sentry-0.11.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: plainx-sentry
-Version: 0.10.1
+Version: 0.11.0
 Author-email: Dave Gaeddert <dave.gaeddert@gmail.com>
-Requires-Python: >=3.11
+Requires-Python: >=3.13
 Requires-Dist: plain-auth>=0.16.0
 Requires-Dist: plain-sessions>=0.27.0
 Requires-Dist: sentry-sdk[opentelemetry]>=2.24.0
@@ -47,6 +47,27 @@ In Heroku, for example:
 heroku config:set SENTRY_DSN=<your-DSN>
 ```
 
+## User and request context
+
+To attach user and request context to errors, add the middleware:
+
+```python
+# settings.py
+MIDDLEWARE = [
+    ...
+    "plain.sessions.middleware.SessionMiddleware",
+    "plainx.sentry.middleware.SentryMiddleware",  # After SessionMiddleware
+    ...
+]
+```
+
+This attaches to errors:
+
+- **User context**: ID, email, username
+- **Request context**: URL, method, query string, headers, cookies
+
+Email, username, headers, and cookies require `SENTRY_PII_ENABLED=True` (the default).
+
 ## Configuration
 
 [Look at the `default_settings.py` for all available settings.](./plainx/sentry/default_settings.py)

plainx_sentry-0.11.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+plainx/sentry/CHANGELOG.md,sha256=Gw_klbDvuQEfHs9aP8z6B7tuntKjCiqd2m7vHNahBHs,1051
+plainx/sentry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plainx/sentry/config.py,sha256=Oqdj__9aAPiSOcv5zCzKfek7W8Wt9jDVU6Ok1J7lm7I,1581
+plainx/sentry/default_settings.py,sha256=DNX6OQ0-BqfjyWuszW7JnZhiDn0tGtS3Fa2W7VbTIF8,564
+plainx/sentry/middleware.py,sha256=d5ROMQo4Kbu7BqziVtX0NBSYdnQ6bwAsF685jp9dlxE,2156
+plainx/sentry/templates.py,sha256=Wx94C6rS0SeebdwxP0HnrwGxVvBOHr3sBXTuZeK8D2s,2092
+plainx/sentry/templates/sentry/js.html,sha256=c38ltOa6RZWqElLbC6yeH82yxTCmSnZtloaqI7zxE2M,550
+plainx_sentry-0.11.0.dist-info/METADATA,sha256=h1sHBOeiJOGE3Iiap4BKdLMpGMhQlXTo6ePZypBrsJk,2022
+plainx_sentry-0.11.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+plainx_sentry-0.11.0.dist-info/RECORD,,

{plainx_sentry-0.10.1.dist-info → plainx_sentry-0.11.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

plainx_sentry-0.10.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-plainx/sentry/CHANGELOG.md,sha256=kE1atfmZkThPdQ5fS7yylRMc_REJXel9zLjrDNgiGoc,373
-plainx/sentry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plainx/sentry/config.py,sha256=mtA9uyFtXgGqaUI-wraG06klKA5fNzTKunS2DNm1KK8,1573
-plainx/sentry/default_settings.py,sha256=DNX6OQ0-BqfjyWuszW7JnZhiDn0tGtS3Fa2W7VbTIF8,564
-plainx/sentry/templates.py,sha256=HW3WJqdkh3SXCuon6i2Kj6Ip9lASr0lDeSi_V8KCuZ0,1864
-plainx/sentry/templates/sentry/js.html,sha256=c38ltOa6RZWqElLbC6yeH82yxTCmSnZtloaqI7zxE2M,550
-plainx_sentry-0.10.1.dist-info/METADATA,sha256=VP0eZhUn7lE6vIm29xUIPbqje50XF4GswfbeyHUTiGw,1515
-plainx_sentry-0.10.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plainx_sentry-0.10.1.dist-info/RECORD,,