8000 feat(sessions): Remove deprecated functions · getsentry/sentry-python@ef1bc38 · GitHub
[go: up one dir, main page]
Skip to content

Commit ef1bc38

Browse files
szokeasaurusrexszokeasaurusrex
committed
feat(sessions): Remove deprecated functions
Remove the deprecated functions from `sessions.py` (this includes all Hub-based logic) and all tests for these functions. BREAKING CHANGE: Remove `sentry_sdk.sessions.auto_session_tracking`. BREAKING CHANGE: Remove `sentry_sdk.sessions.is_auto_session_tracking_enabled`. BREAKING CHANGE: Remove `sentry_sdk.sessions.is_auto_session_tracking_enabled_scope`. BREAKING CHANGE: Remove `sentry_sdk.sessions.is_auto_session_tracking_enabled_scope`. Closes: #3416
1 parent c76e1d7 commit ef1bc38

File tree

2 files changed

+1
-189
lines changed

2 files changed

+1
-189
lines changed

‎sentry_sdk/sessions.py

Lines changed: 0 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import os
22
import time
3-
import warnings
43
from threading import Thread, Lock
54
from contextlib import contextmanager
65

@@ -17,75 +16,6 @@
1716
from typing import Generator
1817
from typing import List
1918
from typing import Optional
20-
from typing import Union
21-
22-
23-
def is_auto_session_tracking_enabled(hub=None):
24-
# type: (Optional[sentry_sdk.Hub]) -> Union[Any, bool, None]
25-
"""DEPRECATED: Utility function to find out if session tracking is enabled."""
26-
27-
# Internal callers should use private _is_auto_session_tracking_enabled, instead.
28-
warnings.warn(
29-
"This function is deprecated and will be removed in the next major release. "
30-
"There is no public API replacement.",
31-
DeprecationWarning,
32-
stacklevel=2,
33-
)
34-
35-
if hub is None:
36-
hub = sentry_sdk.Hub.current
37-
38-
should_track = hub.scope._force_auto_session_tracking
39-
40-
if should_track is None:
41-
client_options = hub.client.options if hub.client else {}
42-
should_track = client_options.get("auto_session_tracking", False)
43-
44-
return should_track
45-
46-
47-
@contextmanager
48-
def auto_session_tracking(hub=None, session_mode="application"):
49-
# type: (Optional[sentry_sdk.Hub], str) -> Generator[None, None, None]
50-
"""DEPRECATED: Use track_session instead
51-
Starts and stops a session automatically around a block.
52-
"""
53-
warnings.warn(
54-
"This function is deprecated and will be removed in the next major release. "
55-
"Use track_session instead.",
56-
DeprecationWarning,
57-
stacklevel=2,
58-
)
59-
60-
if hub is None:
61-
hub = sentry_sdk.Hub.current
62-
with warnings.catch_warnings():
63-
warnings.simplefilter("ignore", DeprecationWarning)
64-
should_track = is_auto_session_tracking_enabled(hub)
65-
if should_track:
66-
hub.start_session(session_mode=session_mode)
67-
try:
68-
yield
69-
finally:
70-
if should_track:
71-
hub.end_session()
72-
73-
74-
def is_auto_session_tracking_enabled_scope(scope):
75-
# type: (sentry_sdk.Scope) -> bool
76-
"""
77-
DEPRECATED: Utility function to find out if session tracking is enabled.
78-
"""
79-
80-
warnings.warn(
81-
"This function is deprecated and will be removed in the next major release. "
82-
"There is no public API replacement.",
83-
DeprecationWarning,
84-
stacklevel=2,
85-
)
86-
87-
# Internal callers should use private _is_auto_session_tracking_enabled, instead.
88-
return _is_auto_session_tracking_enabled(scope)
8919

9020

9121
def _is_auto_session_tracking_enabled(scope):
@@ -102,23 +32,6 @@ def _is_auto_session_tracking_enabled(scope):
10232
return should_track
10333

10434

105-
@contextmanager
106-
def auto_session_tracking_scope(scope, session_mode="application"):
107-
# type: (sentry_sdk.Scope, str) -> Generator[None, None, None]
108-
"""DEPRECATED: This function is a deprecated alias for track_session.
109-
Starts and stops a session automatically around a block.
110-
"""
111-
112-
warnings.warn(
113-
"This function is a deprecated alias for track_session and will be removed in the next major release.",
114-
DeprecationWarning,
115-
stacklevel=2,
116-
)
117-
118-
with track_session(scope, session_mode=session_mode):
119-
yield
120-
121-
12235
@contextmanager
12336
def track_session(scope, session_mode="application"):
12437
# type: (sentry_sdk.Scope, str) -> Generator[None, None, None]

‎tests/test_sessions.py

Lines changed: 1 addition & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from unittest import mock
22

33
import sentry_sdk
4-
from sentry_sdk.sessions import auto_session_tracking, track_session
4+
from sentry_sdk.sessions import track_session
55

66

77
def sorted_aggregates(item):
@@ -83,47 +83,6 @@ def test_aggregates(sentry_init, capture_envelopes):
8383
assert aggregates[0]["errored"] == 1
8484

8585

86-
def test_aggregates_deprecated(
87-
sentry_init, capture_envelopes, suppress_deprecation_warnings
88-
):
89-
sentry_init(
90-
release="fun-release",
91-
environment="not-fun-env",
92-
)
93-
envelopes = capture_envelopes()
94-
95-
with auto_session_tracking(session_mode="request"):
96-
with sentry_sdk.new_scope() as scope:
97-
try:
98-
scope.set_user({"id": "42"})
99-
raise Exception("all is wrong")
100-
except Exception:
101-
sentry_sdk.capture_exception()
102-
103-
with auto_session_tracking(session_mode="request"):
104-
pass
105-
106-
sentry_sdk.get_isolation_scope().start_session(session_mode="request")
107-
sentry_sdk.get_isolation_scope().end_session()
108-
sentry_sdk.flush()
109-
110-
assert len(envelopes) == 2
111-
assert envelopes[0].get_event() is not None
112-
113-
sess = envelopes[1]
114-
assert len(sess.items) == 1
115-
sess_event = sess.items[0].payload.json
116-
assert sess_event["attrs"] == {
117-
"release": "fun-release",
118-
"environment": "not-fun-env",
119-
}
120-
121-
aggregates = sorted_aggregates(sess_event)
122-
assert len(aggregates) == 1
123-
assert aggregates[0]["exited"] == 2
124-
assert aggregates[0]["errored"] == 1
125-
126-
12786
def test_aggregates_explicitly_disabled_session_tracking_request_mode(
12887
sentry_init, capture_envelopes
12988
):
@@ -157,38 +116,6 @@ def test_aggregates_explicitly_disabled_session_tracking_request_mode(
157116
assert "errored" not in aggregates[0]
158117

159118

160-
def test_aggregates_explicitly_disabled_session_tracking_request_mode_deprecated(
161-
sentry_init, capture_envelopes, suppress_deprecation_warnings
162-
):
163-
sentry_init(
164-
release="fun-release", environment="not-fun-env", auto_session_tracking=False
165-
)
166-
envelopes = capture_envelopes()
167-
168-
with auto_session_tracking(session_mode="request"):
169-
with sentry_sdk.new_scope():
170-
try:
171-
raise Exception("all is wrong")
172-
except Exception:
173-
sentry_sdk.capture_exception()
174-
175-
with auto_session_tracking(session_mode="request"):
176-
pass
177-
178-
sentry_sdk.get_isolation_scope().start_session(session_mode="request")
179-
sentry_sdk.get_isolation_scope().end_session()
180-
sentry_sdk.flush()
181-
182-
sess = envelopes[1]
183-
assert len(sess.items) == 1
184-
sess_event = sess.items[0].payload.json
185-
186-
aggregates = sorted_aggregates(sess_event)
187-
assert len(aggregates) == 1
188-
assert aggregates[0]["exited"] == 1
189-
assert "errored" not in aggregates[0]
190-
191-
192119
def test_no_thread_on_shutdown_no_errors(sentry_init):
193120
sentry_init(
194121
release="fun-release",
@@ -214,31 +141,3 @@ def test_no_thread_on_shutdown_no_errors(sentry_init):
214141
sentry_sdk.get_isolation_scope().start_session(session_mode="request")
215142
sentry_sdk.get_isolation_scope().end_session()
216143
sentry_sdk.flush()
217-
218-
219-
def test_no_thread_on_shutdown_no_errors_deprecated(
220-
sentry_init, suppress_deprecation_warnings
221-
):
222-
sentry_init(
223-
release="fun-release",
224-
environment="not-fun-env",
225-
)
226-
227-
# make it seem like the interpreter is shutting down
228-
with mock.patch(
229-
"threading.Thread.start",
230-
side_effect=RuntimeError("can't create new thread at interpreter shutdown"),
231-
):
232-
with auto_session_tracking(session_mode="request"):
233-
with sentry_sdk.new_scope():
234-
try:
235-
raise Exception("all is wrong")
236-
except Exception:
237-
sentry_sdk.capture_exception()
238-
239-
with auto_session_tracking(session_mode="request"):
240-
pass
241-
242-
sentry_sdk.get_isolation_scope().start_session(session_mode="request")
243-
sentry_sdk.get_isolation_scope().end_session()
244-
sentry_sdk.flush()

0 commit comments

Comments
 (0)
0