ref: Refactor transport interface and fix hub init (#44)

Author: mitsuhiko

sentry_sdk/client.py

@@ -11,15 +11,11 @@
     convert_types,
     handle_in_app,
     get_type_name,
-    Dsn,
 )
-from .transport import Transport
+from .transport import make_transport
 from .consts import DEFAULT_OPTIONS, SDK_INFO
 
 
-NO_DSN = object()
-
-
 def get_options(*args, **kwargs):
     if args and (isinstance(args[0], string_types) or args[0] is None):
         dsn = args[0]
@@ -45,21 +41,8 @@ def get_options(*args, **kwargs):
 
 class Client(object):
     def __init__(self, *args, **kwargs):
-        options = get_options(*args, **kwargs)
-
-        dsn = options["dsn"]
-        if dsn is not None:
-            dsn = Dsn(dsn)
-
-        self.options = options
-        self._transport = self.options.pop("transport")
-        if self._transport is None and dsn is not None:
-            self._transport = Transport(
-                dsn=dsn,
-                http_proxy=self.options.pop("http_proxy"),
-                https_proxy=self.options.pop("https_proxy"),
-            )
-            self._transport.start()
+        self.options = options = get_options(*args, **kwargs)
+        self._transport = make_transport(options)
 
         request_bodies = ("always", "never", "small", "medium")
         if options["request_bodies"] not in request_bodies:
@@ -69,18 +52,13 @@ def __init__(self, *args, **kwargs):
                 )
             )
 
+        # XXX: we should probably only do this for the init()ed client
         atexit.register(self.close)
 
     @property
     def dsn(self):
-        """The DSN that created this event."""
-        if self._transport is not None:
-            return self._transport.dsn
-
-    @classmethod
-    def disabled(cls):
-        """Creates a guarnateed to be disabled client."""
-        return cls(NO_DSN)
+        """Returns the configured dsn."""
+        return self.options["dsn"]
 
     def _prepare_event(self, event, hint, scope):
         if event.get("timestamp") is None:

sentry_sdk/hub.py

@@ -82,9 +82,16 @@ def __init__(self, client_or_hub=None, scope=None):
             scope = Scope()
         self._stack = [(client, scope)]
         self._last_event_id = None
+        self._old_hubs = []
 
     def __enter__(self):
-        return _HubManager(self)
+        self._old_hubs.append(Hub.current)
+        _local.set(self)
+        return self
+
+    def __exit__(self, exc_type, exc_value, tb):
+        old = self._old_hubs.pop()
+        _local.set(old)
 
     def run(self, callback):
         """Runs a callback in the context of the hub.  Alternatively the

sentry_sdk/transport.py

@@ -14,6 +14,7 @@
 
 from ._compat import queue
 from .consts import VERSION
+from .utils import Dsn
 
 try:
     from urllib.request import getproxies
@@ -24,10 +25,10 @@
 logger = logging.getLogger(__name__)
 
 
-def _make_pool(dsn, http_proxy, https_proxy):
-    proxy = https_proxy if dsn == "https" else http_proxy
+def _make_pool(parsed_dsn, http_proxy, https_proxy):
+    proxy = https_proxy if parsed_dsn == "https" else http_proxy
     if not proxy:
-        proxy = getproxies().get(dsn.scheme)
+        proxy = getproxies().get(parsed_dsn.scheme)
 
     opts = {"num_pools": 2, "cert_reqs": "CERT_REQUIRED", "ca_certs": certifi.where()}
 
@@ -70,7 +71,7 @@ def send_event(pool, event, auth):
 
 
 def spawn_thread(transport):
-    auth = transport.dsn.to_auth("sentry-python/%s" % VERSION)
+    auth = transport.parsed_dsn.to_auth("sentry-python/%s" % VERSION)
 
     def thread():
         disabled_until = None
@@ -104,10 +105,36 @@ def thread():
 
 
 class Transport(object):
-    def __init__(self, dsn, http_proxy=None, https_proxy=None):
-        self.dsn = dsn
+    def __init__(self, options=None):
+        self.options = options
+        if options and options["dsn"]:
+            self.parsed_dsn = Dsn(options["dsn"])
+        else:
+            self.parsed_dsn = None
+
+    def capture_event(self, event):
+        raise NotImplementedError()
+
+    def close(self):
+        pass
+
+    def drain_events(self, timeout):
+        pass
+
+    def __del__(self):
+        self.close()
+
+
+class HttpTransport(Transport):
+    def __init__(self, options):
+        Transport.__init__(self, options)
         self._queue = None
-        self._pool = _make_pool(dsn, http_proxy=http_proxy, https_proxy=https_proxy)
+        self._pool = _make_pool(
+            self.parsed_dsn,
+            http_proxy=options["http_proxy"],
+            https_proxy=options["https_proxy"],
+        )
+        self.start()
 
     def start(self):
         if self._queue is None:
@@ -139,3 +166,36 @@ def drain_events(self, timeout):
 
     def __del__(self):
         self.close()
+
+
+class _FunctionTransport(Transport):
+    def __init__(self, func):
+        Transport.__init__(self)
+        self._func = func
+
+    def capture_event(self, event):
+        self._func(event)
+
+
+def make_transport(options):
+    ref_transport = options["transport"]
+
+    # If no transport is given, we use the http transport class
+    if ref_transport is None:
+        transport_cls = HttpTransport
+    else:
+        try:
+            issubclass(ref_transport, type)
+        except TypeError:
+            # if we are not a class but we are a callable, assume a
+            # function that acts as capture_event
+            if callable(ref_transport):
+                return _FunctionTransport(ref_transport)
+            # otherwise assume an object fulfilling the transport contract
+            return ref_transport
+        transport_cls = ref_transport
+
+    # if a transport class is given only instanciate it if the dsn is not
+    # empty or None
+    if options["dsn"]:
+        return transport_cls(options)

tests/conftest.py

@@ -6,7 +6,7 @@
 
 import sentry_sdk
 from sentry_sdk._compat import reraise
-from sentry_sdk.client import Transport
+from sentry_sdk.transport import Transport
 
 SEMAPHORE = "./checkouts/semaphore/target/debug/semaphore"
 

tests/test_client.py

@@ -8,21 +8,14 @@
 from sentry_sdk import Hub, Client, configure_scope, capture_message, add_breadcrumb
 from sentry_sdk.hub import HubMeta
 from sentry_sdk.transport import Transport
-from sentry_sdk.utils import Dsn
-from sentry_sdk._compat import reraise
+from sentry_sdk._compat import reraise, text_type
 
 
 class EventCaptured(Exception):
     pass
 
 
 class _TestTransport(Transport):
-    def __init__(self, *a, **kw):
-        pass
-
-    def start(self):
-        pass
-
     def capture_event(self, event):
         raise EventCaptured()
 
@@ -32,10 +25,18 @@ def test_transport_option(monkeypatch):
     dsn2 = "https://[email protected]/124"
     assert str(Client(dsn=dsn).dsn) == dsn
     assert Client().dsn is None
-    assert str(Client(transport=Transport(Dsn(dsn2))).dsn) == dsn2
 
     monkeypatch.setenv("SENTRY_DSN", dsn)
-    assert str(Client(transport=Transport(Dsn(dsn2))).dsn) == dsn2
+    transport = Transport({"dsn": dsn2})
+    assert text_type(transport.parsed_dsn) == dsn2
+    assert str(Client(transport=transport).dsn) == dsn
+
+
+def test_simple_transport():
+    events = []
+    with Hub(Client(transport=events.append)):
+        capture_message("Hello World!")
+    assert events[0]["message"] == "Hello World!"
 
 
 def test_ignore_errors():