feat: Make client pickleable (getsentry#439)

untitaker · web-flow · commit b7e32c57d8f6 · 2019-08-07T11:17:45.000+02:00
* feat: Make client pickleable

* ref: Wrap pickle state in dict

* fix: Encoding
diff --git a/sentry_sdk/client.py b/sentry_sdk/client.py
@@ -74,23 +74,37 @@ class _Client(object):
     """
 
     def __init__(self, *args, **kwargs):
-        # type: (*Optional[str], **Any) -> None
+        # type: (*Any, **Any) -> None
+        self.options = get_options(*args, **kwargs)  # type: Dict[str, Any]
+        self._init_impl()
+
+    def __getstate__(self):
+        # type: () -> Any
+        return {"options": self.options}
+
+    def __setstate__(self, state):
+        # type: (Any) -> None
+        self.options = state["options"]
+        self._init_impl()
+
+    def _init_impl(self):
+        # type: () -> None
         old_debug = _client_init_debug.get(False)
         try:
-            self.options = options = get_options(*args, **kwargs)  # type: ignore
-            _client_init_debug.set(options["debug"])
-            self.transport = make_transport(options)
+            _client_init_debug.set(self.options["debug"])
+            self.transport = make_transport(self.options)
 
             request_bodies = ("always", "never", "small", "medium")
-            if options["request_bodies"] not in request_bodies:
+            if self.options["request_bodies"] not in request_bodies:
                 raise ValueError(
                     "Invalid value for request_bodies. Must be one of {}".format(
                         request_bodies
                     )
                 )
 
             self.integrations = setup_integrations(
-                options["integrations"], with_defaults=options["default_integrations"]
+                self.options["integrations"],
+                with_defaults=self.options["default_integrations"],
             )
         finally:
             _client_init_debug.set(old_debug)
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -1,21 +1,12 @@
 # coding: utf-8
 import json
-import logging
 import pytest
 import subprocess
 import sys
 import time
 
-from datetime import datetime
 from textwrap import dedent
-from sentry_sdk import (
-    Hub,
-    Client,
-    configure_scope,
-    capture_message,
-    add_breadcrumb,
-    capture_exception,
-)
+from sentry_sdk import Hub, Client, configure_scope, capture_message, capture_exception
 from sentry_sdk.hub import HubMeta
 from sentry_sdk.transport import Transport
 from sentry_sdk._compat import reraise, text_type, PY2
@@ -359,28 +350,6 @@ def callback(scope):
     assert not calls
 
 
-@pytest.mark.parametrize("debug", (True, False))
-def test_transport_works(httpserver, request, capsys, caplog, debug):
-    httpserver.serve_content("ok", 200)
-    caplog.set_level(logging.DEBUG)
-
-    client = Client(
-        "http://foobar@{}/123".format(httpserver.url[len("http://") :]), debug=debug
-    )
-    Hub.current.bind_client(client)
-    request.addfinalizer(lambda: Hub.current.bind_client(None))
-
-    add_breadcrumb(level="info", message="i like bread", timestamp=datetime.now())
-    capture_message("löl")
-    client.close()
-
-    out, err = capsys.readouterr()
-    assert not err and not out
-    assert httpserver.requests
-
-    assert any("Sending event" in record.msg for record in caplog.records) == debug
-
-
 @pytest.mark.tests_internal_exceptions
 def test_client_debug_option_enabled(sentry_init, caplog):
     sentry_init(debug=True)
diff --git a/tests/test_transport.py b/tests/test_transport.py
@@ -0,0 +1,43 @@
+# coding: utf-8
+import logging
+import pickle
+
+from datetime import datetime
+
+import pytest
+
+from sentry_sdk import Hub, Client, add_breadcrumb, capture_message
+
+
+@pytest.fixture(params=[True, False])
+def make_client(request):
+    def inner(*args, **kwargs):
+        client = Client(*args, **kwargs)
+        if request.param:
+            client = pickle.loads(pickle.dumps(client))
+
+        return client
+
+    return inner
+
+
+@pytest.mark.parametrize("debug", (True, False))
+def test_transport_works(httpserver, request, capsys, caplog, debug, make_client):
+    httpserver.serve_content("ok", 200)
+    caplog.set_level(logging.DEBUG)
+
+    client = make_client(
+        "http://foobar@{}/123".format(httpserver.url[len("http://") :]), debug=debug
+    )
+    Hub.current.bind_client(client)
+    request.addfinalizer(lambda: Hub.current.bind_client(None))
+
+    add_breadcrumb(level="info", message="i like bread", timestamp=datetime.now())
+    capture_message("löl")
+    client.close()
+
+    out, err = capsys.readouterr()
+    assert not err and not out
+    assert httpserver.requests
+
+    assert any("Sending event" in record.msg for record in caplog.records) == debug
