Skip to content

armgit / meet

Public Imported from GitHub
0

Open source video conferencing app powered by LiveKit. Built with Django and React.

🔒️(summary) scrub Sentry events and breadcrumbs

Florent Chehab72d964656c36
diff --git a/src/summary/summary/core/sentry.py b/src/summary/summary/core/sentry.py
index d6a6c8f1..0244efaa 100644
--- a/src/summary/summary/core/sentry.py
+++ b/src/summary/summary/core/sentry.py
@@ -1,9 +1,12 @@
"""Sentry configuration."""
+import re
+
import sentry_sdk
from sentry_sdk.scrubber import DEFAULT_DENYLIST, DEFAULT_PII_DENYLIST, EventScrubber
from summary.core.config import get_settings
+from summary.core.privacy import redact_url
# Exact names (case-insensitive) of variables and dict keys to redact.
SENSITIVE_DATA_DENYLIST = [
@@ -90,5 +93,45 @@ def init_sentry() -> None:
# Task creation requests carry the content to summarize.
max_request_body_size="never",
include_local_variables=True,
+ before_send=before_send,
+ before_send_transaction=before_send,
+ before_breadcrumb=before_breadcrumb,
event_scrubber=build_event_scrubber(),
)
+
+
+def _scrub_strings(value):
+ """Remove URL credentials, queries and fragments throughout an event."""
+ if isinstance(value, str):
+ return re.sub(
+ r"https?://[^\s\"'<>]+",
+ lambda m: redact_url(m.group()),
+ value,
+ flags=re.IGNORECASE,
+ )
+ if isinstance(value, dict):
+ return {key: _scrub_strings(item) for key, item in value.items()}
+ if isinstance(value, list):
+ return [_scrub_strings(item) for item in value]
+ return value
+
+
+def before_send(event, hint):
+ """Keep exception types and stacks, but discard untrusted message text."""
+ del hint
+ event.pop("message", None)
+ event.pop("logentry", None)
+ request = event.get("request", {})
+ request.pop("data", None)
+ request.pop("query_string", None)
+ for exception in event.get("exception", {}).get("values", []):
+ exception["value"] = "[Filtered]"
+ return _scrub_strings(event)
+
+
+def before_breadcrumb(crumb, hint):
+ """Drop arbitrary breadcrumb text and scrub URLs in structured data."""
+ del hint
+ crumb.pop("message", None)
+ crumb.pop("data", None)
+ return _scrub_strings(crumb)
diff --git a/src/summary/tests/unit/test_privacy.py b/src/summary/tests/unit/test_privacy.py
index 8b19dd11..7ec43020 100644
--- a/src/summary/tests/unit/test_privacy.py
+++ b/src/summary/tests/unit/test_privacy.py
@@ -9,6 +9,7 @@ import requests
from summary.core import analytics, celery_worker, webhook_service
from summary.core.llm_service import LLMException, LLMService
from summary.core.privacy import redact_url
+from summary.core.sentry import before_breadcrumb, before_send
from summary.core.shared_models import SummarizeWebhookSuccessPayload
CANARY = "sensitive-canary"
@@ -20,6 +21,52 @@ def test_url_redaction():
assert redact_url(URL) == "https://example.com/file?[redacted]"
+def test_sentry_scrubs_events_and_breadcrumbs():
+ """Untrusted exception messages and breadcrumb data never leave in events."""
+ event = {
+ "request": {"url": URL, "data": CANARY, "query_string": CANARY},
+ "exception": {
+ "values": [
+ {
+ "type": "ValueError",
+ "value": CANARY,
+ "stacktrace": {"frames": [{"vars": {"job_id": "job-1"}}]},
+ }
+ ]
+ },
+ "extra": {"url": URL},
+ }
+ result = before_send(event, {})
+ assert CANARY not in str(result)
+ assert result["exception"]["values"][0]["type"] == "ValueError"
+ assert result["exception"]["values"][0]["stacktrace"]["frames"][0]["vars"] == {
+ "job_id": "job-1"
+ }
+ assert before_breadcrumb({"message": CANARY, "data": {"url": URL}}, {}) == {}
+
+
[email protected]("scheme", ["http", "HTTP", "hTtP", "https", "HTTPS", "hTtPs"])
+def test_sentry_url_scrubbing_is_case_insensitive(scheme):
+ """Scheme casing cannot bypass redaction of URLs nested in event strings."""
+ event = {
+ "extra": {
+ "nested": [
+ {
+ "detail": (
+ f"prefix <{scheme}://user:[email protected]/Path"
+ f"?signature={CANARY}#fragment> suffix"
+ )
+ }
+ ]
+ }
+ }
+ result = before_send(event, {})
+ assert result["extra"]["nested"][0]["detail"] == (
+ f"prefix <{scheme.lower()}://example.com/Path?[redacted]> suffix"
+ )
+ assert CANARY not in str(result)
+
+
def test_llm_exception_does_not_include_upstream_message(caplog):
"""LLM failures retain their category without logging upstream text."""
observability = Mock(is_enabled=False)
diff --git a/src/summary/tests/unit/test_sentry.py b/src/summary/tests/unit/test_sentry.py
index 5ec3c634..76fa21dd 100644
--- a/src/summary/tests/unit/test_sentry.py
+++ b/src/summary/tests/unit/test_sentry.py
@@ -1,27 +1,32 @@
"""Tests for the Sentry configuration.
Each test raises an error from code handling meeting content and inspects the
-event Sentry would send: the content must be redacted, while harmless local
-variables are kept for debugging.
+event Sentry would send: sensitive content is redacted and useful locals remain.
"""
import json
+import logging
from collections.abc import Callable, Iterator
+from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
+from threading import Thread
from unittest.mock import Mock
import httpx
import openai
import pytest
+import requests
import sentry_sdk
from botocore.exceptions import ClientError
from botocore.stub import Stubber
+from sentry_sdk.integrations.logging import LoggingIntegration
+from sentry_sdk.integrations.stdlib import StdlibIntegration
from sentry_sdk.transport import Transport
-from summary.core import file_service
+from summary.core import file_service, webhook_service
from summary.core import sentry as sentry_module
-from summary.core.file_service import FileService
+from summary.core.file_service import FileService, FileServiceException
from summary.core.llm_service import LLMException, LLMService
-from summary.core.shared_models import WhisperXResponse
+from summary.core.shared_models import SummarizeWebhookSuccessPayload, WhisperXResponse
CANARY = "CANARY-MEETING-CONTENT"
@@ -51,8 +56,14 @@ def sentry_events() -> Iterator[SentryEvents]:
transport=transport,
send_default_pii=False,
include_local_variables=True,
+ before_send=sentry_module.before_send,
+ before_breadcrumb=sentry_module.before_breadcrumb,
event_scrubber=sentry_module.build_event_scrubber(),
default_integrations=False,
+ integrations=[
+ LoggingIntegration(level=logging.DEBUG, event_level=None),
+ StdlibIntegration(),
+ ],
)
def flush() -> list[str]:
@@ -63,6 +74,125 @@ def sentry_events() -> Iterator[SentryEvents]:
sentry_sdk.init() # Disable Sentry for the following tests
+def missing_recording_url() -> Iterator[str]:
+ """Serve a deterministic 404 through the real instrumented HTTP client."""
+
+ class MissingRecordingHandler(BaseHTTPRequestHandler):
+ def do_GET(self):
+ self.send_response(404)
+ self.end_headers()
+
+ def log_message(self, format, *args):
+ pass
+
+ with ThreadingHTTPServer(("127.0.0.1", 0), MissingRecordingHandler) as server:
+ thread = Thread(target=server.serve_forever, daemon=True)
+ thread.start()
+ try:
+ yield (
+ f"http://127.0.0.1:{server.server_port}/recordings/recording-123.mp4"
+ f"?X-Amz-Credential={CANARY}-credential"
+ f"&X-Amz-Signature={CANARY}-signature"
+ )
+ finally:
+ server.shutdown()
+ thread.join()
+
+
+def test_sentry_download_404_excludes_signed_url(
+ sentry_events: SentryEvents, missing_recording_url: str, caplog
+) -> None:
+ """A failed download excludes signed URLs from logs, locals and breadcrumbs."""
+ with caplog.at_level(logging.INFO):
+ try:
+ FileService()._download_from_cloud_storage_url(missing_recording_url)
+ except FileServiceException as exc:
+ assert exc.__cause__ is None
+ assert exc.__suppress_context__
+ sentry_sdk.capture_exception()
+ else:
+ pytest.fail("the download should have failed")
+
+ [event] = sentry_events()
+ assert CANARY not in event
+ assert CANARY not in caplog.text
+ assert "/recordings/recording-123.mp4?[redacted]" in caplog.text
+ parsed = json.loads(event)
+ assert [item["type"] for item in parsed["exception"]["values"]] == [
+ "FileServiceException"
+ ]
+ download_vars = next(
+ frame_vars for frame_vars in _local_vars(event) if "extension" in frame_vars
+ )
+ assert download_vars["extension"] == "'.mp4'"
+ assert download_vars["cloud_storage_url"] == "[Filtered]"
+ breadcrumbs = parsed["breadcrumbs"]["values"]
+ assert any(crumb.get("type") == "http" for crumb in breadcrumbs)
+ assert any(
+ crumb.get("category") == "summary.core.file_service" for crumb in breadcrumbs
+ )
+ assert all("message" not in crumb and "data" not in crumb for crumb in breadcrumbs)
+
+
+def test_sentry_chained_http_error_excludes_signed_url(
+ sentry_events: SentryEvents, missing_recording_url: str
+) -> None:
+ """Sentry also filters signed URLs in explicitly chained HTTP errors."""
+ try:
+ try:
+ response = requests.get(missing_recording_url, timeout=5)
+ response.raise_for_status()
+ except requests.HTTPError as exc:
+ raise FileServiceException("Download failed") from exc
+ except FileServiceException:
+ sentry_sdk.capture_exception()
+
+ [event] = sentry_events()
+ assert CANARY not in event
+ exceptions = json.loads(event)["exception"]["values"]
+ assert [item["type"] for item in exceptions] == [
+ "HTTPError",
+ "FileServiceException",
+ ]
+ assert all(item["value"] == "[Filtered]" for item in exceptions)
+
+
+def test_sentry_excludes_webhook_debug_content(
+ sentry_events: SentryEvents, monkeypatch, settings_override, caplog
+) -> None:
+ """Raw DEBUG responses stay in application logs and out of Sentry events."""
+ monkeypatch.setattr(webhook_service, "settings", settings_override)
+ signed_url = f"https://storage.example.com/result?signature={CANARY}"
+ response = Mock(status_code=200)
+ response.json.return_value = {
+ "id": "document-123",
+ "content": CANARY,
+ "url": signed_url,
+ }
+ monkeypatch.setattr(webhook_service.requests, "post", Mock(return_value=response))
+ with caplog.at_level(logging.DEBUG):
+ webhook_service.call_webhook_v2(
+ tenant_id="test-tenant",
+ payload=SummarizeWebhookSuccessPayload(
+ job_id="job", summary_data_url=signed_url
+ ),
+ )
+ try:
+ raise RuntimeError("A later failure")
+ except RuntimeError:
+ sentry_sdk.capture_exception()
+
+ assert CANARY in caplog.text
+ [event] = sentry_events()
+ assert CANARY not in event
+ assert any(
+ crumb.get("category") == "summary.core.webhook_service"
+ and crumb.get("level") == "debug"
+ for crumb in json.loads(event)["breadcrumbs"]["values"]
+ )
+
+
def _transcript() -> WhisperXResponse:
return WhisperXResponse.model_validate(
{
@@ -121,7 +251,7 @@ def s3_stubber(monkeypatch: pytest.MonkeyPatch) -> Iterator[Stubber]:
def test_sentry_store_transcript_failure_redacts_transcript(
sentry_events: SentryEvents, s3_stubber: Stubber
) -> None:
- """A failed S3 upload does not send the transcript, but keeps the job id."""
+ """A failed S3 upload redacts the transcript while retaining useful locals."""
s3_stubber.add_client_error("put_object", service_error_code="InvalidDigest")
try: