perf(modules): Don't re-serialize the installed modules on every event

Fixes #8090

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Author: 2 people

sentry_sdk/integrations/modules.py

@@ -6,11 +6,28 @@
 from sentry_sdk.utils import _get_installed_modules
 
 if TYPE_CHECKING:
-    from typing import Any
+    from typing import Any, Dict, Optional
 
     from sentry_sdk._types import Event
 
 
+class _InstalledModules(dict):  # type: ignore[type-arg]
+    def __sentry_repr__(self) -> "Dict[str, str]":
+        return dict(self)
+
+
+_installed_modules: "Optional[_InstalledModules]" = None
+
+
+def _get_installed_modules_for_event() -> _InstalledModules:
+    global _installed_modules
+
+    if _installed_modules is None:
+        _installed_modules = _InstalledModules(_get_installed_modules())
+
+    return _installed_modules
+
+
 class ModulesIntegration(Integration):
     identifier = "modules"
 
@@ -24,5 +41,5 @@ def processor(event: "Event", hint: "Any") -> "Event":
             if sentry_sdk.get_client().get_integration(ModulesIntegration) is None:
                 return event
 
-            event["modules"] = _get_installed_modules()
+            event["modules"] = _get_installed_modules_for_event()
             return event

tests/integrations/modules/test_modules.py

@@ -1,5 +1,7 @@
 import sentry_sdk
-from sentry_sdk.integrations.modules import ModulesIntegration
+from sentry_sdk.integrations.modules import ModulesIntegration, _InstalledModules
+from sentry_sdk.serializer import _Serializer, serialize
+from sentry_sdk.utils import _get_installed_modules
 
 
 def test_basic(sentry_init, capture_events):
@@ -9,5 +11,40 @@ def test_basic(sentry_init, capture_events):
     sentry_sdk.capture_exception(ValueError())
 
     (event,) = events
-    assert "sentry-sdk" in event["modules"]
-    assert "pytest" in event["modules"]
+    assert event["modules"] == _get_installed_modules()
+
+
+def test_before_send_modules_mutations_do_not_leak(sentry_init, capture_events):
+    modules_seen = []
+
+    def before_send(event, hint):
+        assert type(event["modules"]) is dict
+        modules_seen.append(event["modules"].copy())
+        event["modules"]["sentry-sdk"] = "mutated"
+        return event
+
+    sentry_init(integrations=[ModulesIntegration()], before_send=before_send)
+    events = capture_events()
+
+    sentry_sdk.capture_exception(ValueError())
+    sentry_sdk.capture_exception(ValueError())
+
+    assert len(events) == 2
+    assert modules_seen == [_get_installed_modules(), _get_installed_modules()]
+
+
+def test_installed_modules_are_not_recursively_serialized(monkeypatch):
+    original_serialize_node = _Serializer._serialize_node
+    segments = []
+
+    def counting_serialize_node(self, obj, *args, **kwargs):
+        segments.append(kwargs.get("segment"))
+        return original_serialize_node(self, obj, *args, **kwargs)
+
+    monkeypatch.setattr(_Serializer, "_serialize_node", counting_serialize_node)
+
+    event = serialize({"modules": _InstalledModules({"package": "1.0"})})
+
+    assert event["modules"] == {"package": "1.0"}
+    assert segments.count("modules") == 1
+    assert "package" not in segments