Skip to content

feat: Make client pickleable #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions sentry_sdk/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
33 changes: 1 addition & 32 deletions tests/test_client.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down
43 changes: 43 additions & 0 deletions tests/test_transport.py
Original file line number Diff line number Diff line change
@@ -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