feat(flags): Add LaunchDarkly Integration

requirements-linting.txt

@@ -16,3 +16,4 @@ pep8-naming
 pre-commit # local linting
 httpcore
 openfeature-sdk
+launchdarkly-server-sdk

scripts/split-tox-gh-actions/split-tox-gh-actions.py

@@ -125,6 +125,7 @@
         "tornado",
     ],
     "Miscellaneous": [
+        "ldclient",
         "loguru",
         "openfeature",
         "opentelemetry",

sentry_sdk/integrations/launchdarkly.py

@@ -0,0 +1,72 @@
+from typing import TYPE_CHECKING
+import sentry_sdk
+
+from sentry_sdk.integrations import DidNotEnable, Integration
+
+try:
+    import ldclient
+    from ldclient.hook import Hook
+
+    if TYPE_CHECKING:
+        from ldclient import LDClient
+        from ldclient.hook import EvaluationSeriesContext, Metadata
+        from ldclient.evaluation import EvaluationDetail
+
+        from sentry_sdk._types import Event, ExcInfo
+        from typing import Any, Optional
+except ImportError:
+    raise DidNotEnable("LaunchDarkly is not installed")
+
+
+class LaunchDarklyIntegration(Integration):
+    identifier = "launchdarkly"
+
+    @staticmethod
+    def get_ldclient():
+        # type: () -> LDClient
+        try:
+            client = ldclient.get()
+        except Exception as exc:
+            sentry_sdk.capture_exception(exc)
+            raise DidNotEnable(
+                "Failed to find LaunchDarkly client instance. " + str(exc)
+            )
+
+        if client and client.is_initialized():
+            return client
+        raise DidNotEnable("LaunchDarkly client is not initialized")
+
+    @staticmethod
+    def setup_once():
+        # type: () -> None
+        def error_processor(event, _exc_info):
+            # type: (Event, ExcInfo) -> Optional[Event]
+            scope = sentry_sdk.get_current_scope()
+            event["contexts"]["flags"] = {"values": scope.flags.get()}
+            return event
+
+        scope = sentry_sdk.get_current_scope()
+        scope.add_error_processor(error_processor)
+
+        # Register the hook with the global launchdarkly client.
+        client = LaunchDarklyIntegration.get_ldclient()
+        client.add_hook(LaunchDarklyHook())
+
+
+class LaunchDarklyHook(Hook):
+
+    @property
+    def metadata(self):
+        # type: () -> Metadata
+        return Metadata(name="sentry-on-error-hook")
+
+    def after_evaluation(self, series_context, data, detail):
+        # type: (EvaluationSeriesContext, dict[Any, Any], EvaluationDetail) -> dict[Any, Any]
+        if isinstance(detail.value, bool):
+            flags = sentry_sdk.get_current_scope().flags
+            flags.set(series_context.key, detail.value)
+        return data
+
+    def before_evaluation(self, _series_context, data):
+        # type: (EvaluationSeriesContext, dict[Any, Any]) -> dict[Any, Any]
+        return data  # No-op.

setup.py

@@ -63,6 +63,7 @@ def get_file_text(file_name):
         "huey": ["huey>=2"],
         "huggingface_hub": ["huggingface_hub>=0.22"],
         "langchain": ["langchain>=0.0.210"],
+        "ldclient": ["launchdarkly-server-sdk>=9.8.0"],
         "litestar": ["litestar>=2.0.0"],
         "loguru": ["loguru>=0.5"],
         "openai": ["openai>=1.0.0", "tiktoken>=0.3.0"],

tests/integrations/launchdarkly/__init__.py

@@ -0,0 +1,3 @@
+import pytest
+
+pytest.importorskip("ldclient")

tox.ini

@@ -167,6 +167,9 @@ envlist =
     {py3.9,py3.11,py3.12}-langchain-latest
     {py3.9,py3.11,py3.12}-langchain-notiktoken
 
+    # LaunchDarkly
+    {py3.8,py3.9,py3.10,py3.11,py3.12}-launchdarkly-latest
+
     # Litestar
     # litestar 2.0.0 is the earliest version that supports Python < 3.12
     {py3.8,py3.11}-litestar-v{2.0}
@@ -520,6 +523,9 @@ deps =
     langchain-notiktoken: langchain-openai
     langchain-notiktoken: openai>=1.6.1
 
+    # LaunchDarkly
+    launchdarkly-latest: launchdarkly-server-sdk~=9.8.0
+
     # Litestar
     litestar: pytest-asyncio
     litestar: python-multipart
@@ -727,6 +733,7 @@ setenv =
     huey: TESTPATH=tests/integrations/huey
     huggingface_hub: TESTPATH=tests/integrations/huggingface_hub
     langchain: TESTPATH=tests/integrations/langchain
+    launchdarkly: TESTPATH=tests/integrations/launchdarkly
     litestar: TESTPATH=tests/integrations/litestar
     loguru: TESTPATH=tests/integrations/loguru
     openai: TESTPATH=tests/integrations/openai