Skip to content

ref: Use deque for breadcrumbs #71

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.

Sign up for GitHub

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
untitaker merged 2 commits into from
Sep 21, 2018
Merged

ref: Use deque for breadcrumbs #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4390fdd
ref: Use deque for breadcrumbs
untitaker Sep 21, 2018
57874ba
fix: Python 2 compat
untitaker Sep 21, 2018
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
2 changes: 1 addition & 1 deletion sentry_sdk/hub.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def add_breadcrumb(self, crumb=None, hint=None, **kwargs):
else:
logger.info("before breadcrumb dropped breadcrumb (%s)", original_crumb)
while len(scope._breadcrumbs) > client.options["max_breadcrumbs"]:
scope._breadcrumbs.pop(0)
scope._breadcrumbs.popleft()

def push_scope(self, callback=None):
"""Pushes a new layer on the scope stack. Returns a context manager
Expand Down
7 changes: 5 additions & 2 deletions sentry_sdk/scope.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
from copy import copy
from collections import deque

from sentry_sdk.utils import logger, capture_internal_exceptions


Expand Down Expand Up @@ -84,7 +87,7 @@ def clear(self):
self._contexts = {}
self._extras = {}

self._breadcrumbs = []
self._breadcrumbs = deque()

def add_event_processor(self, func):
""""Register a scope local event processor on the scope.
Expand Down Expand Up @@ -170,7 +173,7 @@ def __copy__(self):
rv._contexts = dict(self._contexts)
rv._extras = dict(self._extras)

rv._breadcrumbs = list(self._breadcrumbs)
rv._breadcrumbs = copy(self._breadcrumbs)
rv._event_processors = list(self._event_processors)
rv._error_processors = list(self._error_processors)

Expand Down
22 changes: 18 additions & 4 deletions tests/test_basics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,32 @@ def test_push_scope_null_client(sentry_init, capture_events):
assert len(events) == 0


def test_breadcrumbs_overflow(sentry_init, capture_events):
def test_breadcrumbs(sentry_init, capture_events):
sentry_init(max_breadcrumbs=10)
events = capture_events()

for i in range(20):
add_breadcrumb(
category="auth", message="Authenticated user %s" % i, level="info"
)

events = capture_events()

capture_exception(ValueError())

event, = events

assert len(event["breadcrumbs"]) == 10
assert "user 10" in event["breadcrumbs"][0]["message"]
assert "user 19" in event["breadcrumbs"][-1]["message"]

del events[:]

for i in range(2):
add_breadcrumb(
category="auth", message="Authenticated user %s" % i, level="info"
)

with configure_scope() as scope:
scope.clear()

capture_exception(ValueError())
event, = events
assert len(event["breadcrumbs"]) == 0