ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

ref(api): Remove store endpoint - #2656

Merged
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint
Jan 29, 2024
Merged

ref(api): Remove store endpoint#2656
szokeasaurusrex merged 31 commits into
sentry-sdk-2.0from
szokeasaurusrex/remove-store-endpoint

Conversation

@szokeasaurusrex

@szokeasaurusrexszokeasaurusrex commented Jan 18, 2024

Copy link
Copy Markdown
Member

Summary

This change removes all usages of the deprecated store endpoint from the Python SDK. From now on, events that were previously sent to the store endpoint will now be sent as envelopes to the envelope endpoint.

Breaking API changes

  • sentry_sdk.transport.Transport is now an abstract base class, and therefore, it cannot be instantiated directly. Subclasses must implement the capture_envelope method.
  • sentry_sdk.utils.Auth.store_api_url has been removed.
  • sentry_sdk.utils.Auth.get_api_url's now accepts a sentry_sdk.consts.EndpointType enum instead of a string as its only parameter. Supplying this parameter is currently unnecessary, since the parameter's default value is the only possible sentry_sdk.consts.EndpointType value.

Backwards-compatible API changes

  • sentry_sdk.transport.Transport.capture_event has been deprecated. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
  • Passing a function to sentry_sdk.init's transport keyword argument has been deprecated. If you wish to provide a custom transport, please pass a sentry_sdk.transport.Transport instance or a subclass.

Other changes

  • sentry_sdk.transport.HttpTransport._send_event has been removed, and uses of this method have been removed from the codebase, including from tests.
  • Cleaned up some transport-related test code

FixesGH-1957


General Notes

Thank you for contributing to sentry-python!

Please add tests to validate your changes, and lint your code using tox -e linters.

Running the test suite on your PR might require maintainer approval. Some tests (AWS Lambda) additionally require a maintainer to add a special label to run and will fail if the label is not present.

For maintainers

Sensitive test suites require maintainer review to ensure that tests do not compromise our secrets. This review must be repeated after any code revisions.

Before running sensitive test suites, please carefully check the PR. Then, apply the Trigger: tests using secrets label. The label will be removed after any code changes to enforce our policy requiring maintainers to review all code revisions before running sensitive tests.

Comment threadtests/conftest.py Outdated
Comment threadsentry_sdk/transport.py Outdated
@cleptric
cleptric self-requested a review January 18, 2024 16:34
@szokeasaurusrexszokeasaurusrex linked an issue Jan 19, 2024 that may be closed by this pull request
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 22, 2024 14:33

@cleptriccleptric left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-python/blob/sentry-sdk-2.0/sentry_sdk/scope.py#L613-L629

This can also be cleaned up.

  • Remove the has_tracing_enabled check
  • We do not need to set the replay context anymore; this was a workaround applying to the /store endpoint only

Comment threadsentry_sdk/scope.py Outdated

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general. Left a couple of comments.

Also, there's a migration guide on the 2.0 branch, please update it and add to this PR.

Comment threadsentry_sdk/transport.py Outdated
@@ -1,12 +1,16 @@
from __future__ import print_function

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this on the 2.0 branch because there's no Python 2 support anymore

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch – I think Git somehow put this line in when I was splitting the TransportABC stuff into a separate PR


events = []
envelopes = []
envelope_item = []

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep calling this envelopes? That's the usual convention in our tests. Or maybe at least envelope_items, since it's a collection of items rather than one item?

@szokeasaurusrexszokeasaurusrexJan 24, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the change because we are actually capturing envelope Items here, not Envelopes. The previous naming confused me when I was looking at the tests, because I thought these were Envelope objects, and I thought I would have to somehow manually extract the events (i.e. Items) from them. The name envelope_items makes it clear that we are dealing with Item objects, not Envelope objects, here.

I believe the that in the "usual convention" you are referring to, we are capturing the envelopes using the capture_envelopes fixture, which returns a list[Envelope]. Therefore, while the envelopes name is the appropriate choice in those cases, the distinct envelope_items name here is warranted because here we have a list[Item], which we need to handle differently.

You are right though, we should be calling this variable envelope_items rather than envelope_item. I will make this change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's go with envelope_items 👍🏻

Comment threadtests/integrations/gcp/test_gcp.py
Comment threadtests/test_client.py
@szokeasaurusrex
szokeasaurusrex marked this pull request as draft January 24, 2024 15:03
@szokeasaurusrex
szokeasaurusrex marked this pull request as ready for review January 25, 2024 15:06

@antonpirkerantonpirker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As you walked me through the changes already, this looks good to me!

@sentrivanasentrivana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see one comment about the migration guide, otherwise LGTM

Comment threadMIGRATION_GUIDE.md Outdated
@szokeasaurusrex
szokeasaurusrex merged commit ddb4a29 into sentry-sdk-2.0Jan 29, 2024
@szokeasaurusrex
szokeasaurusrex deleted the szokeasaurusrex/remove-store-endpoint branch January 29, 2024 17:19
@szokeasaurusrexszokeasaurusrex mentioned this pull request Feb 13, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sun-setting the /store endpoint

4 participants

@szokeasaurusrex@antonpirker@cleptric@sentrivana