From c3516db643af20396ea981393431646f1a3ef123 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Mon, 23 Dec 2024 02:02:20 -0800 Subject: [PATCH] ref(flags): register LD hook in setup instead of init, and don't check for initialization (#3890) --------- Co-authored-by: Anton Pirker --- sentry_sdk/integrations/launchdarkly.py | 14 ++++++------- .../launchdarkly/test_launchdarkly.py | 21 +++++++++---------- 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/sentry_sdk/integrations/launchdarkly.py b/sentry_sdk/integrations/launchdarkly.py index a9eef9e1a9..066464cc22 100644 --- a/sentry_sdk/integrations/launchdarkly.py +++ b/sentry_sdk/integrations/launchdarkly.py @@ -20,6 +20,7 @@ class LaunchDarklyIntegration(Integration): identifier = "launchdarkly" + _ld_client = None # type: LDClient | None def __init__(self, ld_client=None): # type: (LDClient | None) -> None @@ -27,20 +28,19 @@ def __init__(self, ld_client=None): :param client: An initialized LDClient instance. If a client is not provided, this integration will attempt to use the shared global instance. """ + self.__class__._ld_client = ld_client + + @staticmethod + def setup_once(): + # type: () -> None try: - client = ld_client or ldclient.get() + client = LaunchDarklyIntegration._ld_client or ldclient.get() except Exception as exc: raise DidNotEnable("Error getting LaunchDarkly client. " + repr(exc)) - if not client.is_initialized(): - raise DidNotEnable("LaunchDarkly client is not initialized.") - # Register the flag collection hook with the LD client. client.add_hook(LaunchDarklyHook()) - @staticmethod - def setup_once(): - # type: () -> None scope = sentry_sdk.get_current_scope() scope.add_error_processor(flag_error_processor) diff --git a/tests/integrations/launchdarkly/test_launchdarkly.py b/tests/integrations/launchdarkly/test_launchdarkly.py index f66a4219ec..e7576bb469 100644 --- a/tests/integrations/launchdarkly/test_launchdarkly.py +++ b/tests/integrations/launchdarkly/test_launchdarkly.py @@ -168,10 +168,14 @@ async def runner(): } -def test_launchdarkly_integration_did_not_enable(monkeypatch): - # Client is not passed in and set_config wasn't called. - # TODO: Bad practice to access internals like this. We can skip this test, or remove this - # case entirely (force user to pass in a client instance). +def test_launchdarkly_integration_did_not_enable(sentry_init, uninstall_integration): + """ + Setup should fail when using global client and ldclient.set_config wasn't called. + + We're accessing ldclient internals to set up this test, so it might break if launchdarkly's + implementation changes. + """ + ldclient._reset_client() try: ldclient.__lock.lock() @@ -179,11 +183,6 @@ def test_launchdarkly_integration_did_not_enable(monkeypatch): finally: ldclient.__lock.unlock() + uninstall_integration(LaunchDarklyIntegration.identifier) with pytest.raises(DidNotEnable): - LaunchDarklyIntegration() - - # Client not initialized. - client = LDClient(config=Config("sdk-key")) - monkeypatch.setattr(client, "is_initialized", lambda: False) - with pytest.raises(DidNotEnable): - LaunchDarklyIntegration(ld_client=client) + sentry_init(integrations=[LaunchDarklyIntegration()])