Don't use singleton

Author: codetheweb

seamapi/seam.py

@@ -73,11 +73,10 @@ def __init__(
         self.should_report_exceptions = should_report_exceptions
 
         if self.should_report_exceptions:
-            sentry_sdk.init(
+            self.sentry_client = sentry_sdk.Hub(sentry_sdk.Client(
                 dsn=get_sentry_dsn(),
-                default_integrations=False,
-            )
-            sentry_sdk.set_context("sdk_info", {
+            ))
+            self.sentry_client.scope.set_context("sdk_info", {
                 "repository": "https://github.com/seamapi/python",
                 "version": pkg_resources.get_distribution("seamapi").version,
                 "endpoint": self.api_url,
@@ -107,7 +106,7 @@ def make_request(self, method: str, path: str, **kwargs):
 
         if self.should_report_exceptions and response.status_code:
             # Add breadcrumb
-            sentry_sdk.add_breadcrumb(
+            self.sentry_client.add_breadcrumb(
                 category="http",
                 level="info",
                 data={

seamapi/utils/report_error.py

@@ -1,5 +1,4 @@
 from seamapi.types import SeamAPIException
-import sentry_sdk
 
 """
 A decorator for model methods that will report errors to Sentry (if enabled).
@@ -11,7 +10,7 @@ def wrapper(self, *args, **kwargs):
       return f(self, *args, **kwargs)
     except Exception as error:
       if self.seam.should_report_exceptions and type(error) is not SeamAPIException:
-        sentry_sdk.capture_exception(error)
+        self.seam.sentry_client.capture_exception(error)
 
       raise error
   return wrapper

tests/conftest.py

@@ -68,3 +68,41 @@ def seam(seam_backend: Any, dotenv_fixture: Any):
     seam = Seam(api_url=seam_backend.url, api_key=seam_backend.sandbox_api_key)
     seam.make_request("POST", "/workspaces/reset_sandbox")
     yield seam
+
+@pytest.fixture
+def fake_sentry(monkeypatch):
+    sentry_dsn = "https://[email protected]/123"
+
+    monkeypatch.setenv("SENTRY_DSN", sentry_dsn)
+
+    sentry_init_args = {}
+    sentry_capture_exception_calls = []
+    sentry_add_breadcrumb_calls = []
+    class TestSentryClient(object):
+        def __init__(self, *args, **kwargs):
+            sentry_init_args.update(kwargs)
+        def set_context(self, *args, **kwargs):
+            pass
+
+    monkeypatch.setattr("sentry_sdk.Client", TestSentryClient)
+
+    class TestSentryScope(object):
+        def set_context(self, *args, **kwargs):
+            pass
+
+    class TestSentryHub(object):
+        def __init__(self, *args, **kwargs):
+          self.scope = TestSentryScope()
+        def capture_exception(self, *args, **kwargs):
+          sentry_capture_exception_calls.append((args, kwargs))
+        def add_breadcrumb(self, *args, **kwargs):
+            sentry_add_breadcrumb_calls.append((args, kwargs))
+
+    monkeypatch.setattr("sentry_sdk.Hub", TestSentryHub)
+
+    yield {
+        "sentry_init_args": sentry_init_args,
+        "sentry_capture_exception_calls": sentry_capture_exception_calls,
+        "sentry_add_breadcrumb_calls": sentry_add_breadcrumb_calls,
+        "sentry_dsn": sentry_dsn,
+    }

tests/test_sentry_errors.py

@@ -3,7 +3,7 @@
 
 
 @responses.activate
-def test_sends_error_to_sentry(seam: Seam, monkeypatch):
+def test_sends_error_to_sentry(seam: Seam, fake_sentry):
     rsp = responses.Response(
       method="GET",
       url=seam.api_url + "/devices/list",
@@ -13,42 +13,31 @@ def test_sends_error_to_sentry(seam: Seam, monkeypatch):
     )
     responses.add(rsp)
 
-    sentry_init_args = {}
-    sentry_dsn = "https://sentry.io/123"
-    monkeypatch.setenv("SENTRY_DSN", sentry_dsn)
-    monkeypatch.setattr("sentry_sdk.init", lambda *a, **kw: sentry_init_args.update(kw))
-
     client_with_sentry = Seam(
       api_key=seam.api_key,
       api_url=seam.api_url,
       should_report_exceptions=True,
     )
 
-    assert sentry_init_args["dsn"] == sentry_dsn
-    assert sentry_init_args["default_integrations"] is False
-
-    sentry_capture_exception_calls = []
-    monkeypatch.setattr("sentry_sdk.capture_exception", lambda *a, **kw: sentry_capture_exception_calls.append((a, kw)))
+    assert fake_sentry["sentry_init_args"]["dsn"] == fake_sentry["sentry_dsn"]
 
-    sentry_add_breadcrumb_calls = []
-    monkeypatch.setattr("sentry_sdk.add_breadcrumb", lambda *a, **kw: sentry_add_breadcrumb_calls.append((a, kw)))
     try:
       client_with_sentry.devices.list()
       assert False
-    except:
+    except Exception as error:
       pass
 
     assert rsp.call_count == 1
 
-    assert len(sentry_capture_exception_calls) == 1
-    assert type(sentry_capture_exception_calls[0][0][0]) is KeyError
+    assert len(fake_sentry["sentry_capture_exception_calls"]) == 1
+    assert type(fake_sentry["sentry_capture_exception_calls"][0][0][0]) is KeyError
 
-    assert len(sentry_add_breadcrumb_calls) == 1
-    assert sentry_add_breadcrumb_calls[0][1]['category'] == "http"
-    assert sentry_add_breadcrumb_calls[0][1]["data"]["request_id"] == "1234"
+    assert len(fake_sentry["sentry_add_breadcrumb_calls"]) == 1
+    assert fake_sentry["sentry_add_breadcrumb_calls"][0][1]['category'] == "http"
+    assert fake_sentry["sentry_add_breadcrumb_calls"][0][1]["data"]["request_id"] == "1234"
 
 @responses.activate
-def test_skips_sentry_reporting(seam: Seam, monkeypatch):
+def test_skips_sentry_reporting(seam: Seam, fake_sentry):
     rsp = responses.Response(
       method="GET",
       url=seam.api_url + "/devices/list",
@@ -57,17 +46,11 @@ def test_skips_sentry_reporting(seam: Seam, monkeypatch):
     )
     responses.add(rsp)
 
-    monkeypatch.setenv("SENTRY_DSN", "https://sentry.io/123")
-    monkeypatch.setattr("sentry_sdk.init", lambda *a, **kw: None)
-
     client_without_sentry = Seam(
       api_key=seam.api_key,
       api_url=seam.api_url,
     )
 
-    sentry_capture_exception_calls = []
-    monkeypatch.setattr("sentry_sdk.capture_exception", lambda *a, **kw: sentry_capture_exception_calls.append((a, kw)))
-
     try:
       client_without_sentry.devices.list()
       assert False
@@ -76,29 +59,21 @@ def test_skips_sentry_reporting(seam: Seam, monkeypatch):
 
     assert rsp.call_count == 1
 
-    assert len(sentry_capture_exception_calls) == 0
-
-def test_skips_report_for_known_error(seam: Seam, monkeypatch):
-    sentry_init_args = {}
-    sentry_dsn = "https://sentry.io/123"
-    monkeypatch.setenv("SENTRY_DSN", sentry_dsn)
-    monkeypatch.setattr("sentry_sdk.init", lambda *a, **kw: sentry_init_args.update(kw))
+    assert len(fake_sentry["sentry_capture_exception_calls"]) == 0
 
+def test_skips_report_for_known_error(seam: Seam, fake_sentry):
     client_without_sentry = Seam(
       api_key=seam.api_key,
       api_url=seam.api_url,
       should_report_exceptions=True
     )
 
-    assert sentry_init_args["dsn"] == sentry_dsn
-
-    sentry_capture_exception_calls = []
-    monkeypatch.setattr("sentry_sdk.capture_exception", lambda *a, **kw: sentry_capture_exception_calls.append((a, kw)))
+    assert fake_sentry["sentry_init_args"]["dsn"] == fake_sentry["sentry_dsn"]
 
     try:
       client_without_sentry.devices.get("123")
       assert False
     except:
       pass
 
-    assert len(sentry_capture_exception_calls) == 0
+    assert len(fake_sentry["sentry_capture_exception_calls"]) == 0