feat: Send envelopes to the envelope endpoint (getsentry#730)

mitsuhiko · untitaker · rhcarvalho · web-flow · commit e083488494ad · 2020-06-26T11:51:19.000+02:00
Add Auth.get_api_url and keep Auth.store_api_url, with a deprecation notice.

While we don't consider Auth to be part of the public API, the contract is not
very clear. Auth.store_api_url is kept to prevent unnecessarily breaking
downstream uses.

Since we don't have any existing use of Python's DeprecationWarning, nor
any other system in place to communicate deprecation, we start with just
a note in the docstring.

Co-authored-by: Markus Unterwaditzer &lt;markus@unterwaditzer.net&gt;
Co-authored-by: Rodolfo Carvalho &lt;rodolfo.carvalho@sentry.io&gt;
diff --git a/sentry_sdk/_types.py b/sentry_sdk/_types.py
@@ -35,3 +35,4 @@
         "default", "error", "crash", "transaction", "security", "attachment", "session"
     ]
     SessionStatus = Literal["ok", "exited", "crashed", "abnormal"]
+    EndpointType = Literal["store", "envelope"]
diff --git a/sentry_sdk/transport.py b/sentry_sdk/transport.py
@@ -27,7 +27,7 @@
     from urllib3.poolmanager import PoolManager  # type: ignore
     from urllib3.poolmanager import ProxyManager
 
-    from sentry_sdk._types import Event
+    from sentry_sdk._types import Event, EndpointType
 
     DataCategory = Optional[str]
 
@@ -163,6 +163,7 @@ def _send_request(
         self,
         body,  # type: bytes
         headers,  # type: Dict[str, str]
+        endpoint_type="store",  # type: EndpointType
     ):
         # type: (...) -> None
         headers.update(
@@ -172,7 +173,10 @@ def _send_request(
             }
         )
         response = self._pool.request(
-            "POST", str(self._auth.store_api_url), body=body, headers=headers
+            "POST",
+            str(self._auth.get_api_url(endpoint_type)),
+            body=body,
+            headers=headers,
         )
 
         try:
@@ -258,6 +262,7 @@ def _send_envelope(
                 "Content-Type": "application/x-sentry-envelope",
                 "Content-Encoding": "gzip",
             },
+            endpoint_type="envelope",
         )
         return None
 
diff --git a/sentry_sdk/utils.py b/sentry_sdk/utils.py
@@ -25,7 +25,7 @@
     from typing import Union
     from typing import Type
 
-    from sentry_sdk._types import ExcInfo
+    from sentry_sdk._types import ExcInfo, EndpointType
 
 epoch = datetime(1970, 1, 1)
 
@@ -200,12 +200,23 @@ def __init__(
     @property
     def store_api_url(self):
         # type: () -> str
+        """Returns the API url for storing events.
+
+        Deprecated: use get_api_url instead.
+        """
+        return self.get_api_url(type="store")
+
+    def get_api_url(
+        self, type="store"  # type: EndpointType
+    ):
+        # type: (...) -> str
         """Returns the API url for storing events."""
-        return "%s://%s%sapi/%s/store/" % (
+        return "%s://%s%sapi/%s/%s/" % (
             self.scheme,
             self.host,
             self.path,
             self.project_id,
+            type,
         )
 
     def to_header(self, timestamp=None):
diff --git a/tests/utils/test_general.py b/tests/utils/test_general.py
@@ -84,20 +84,31 @@ def test_filename():
 
 
 @pytest.mark.parametrize(
-    "given,expected",
+    "given,expected_store,expected_envelope",
     [
-        ("https://foobar@sentry.io/123", "https://sentry.io/api/123/store/"),
-        ("https://foobar@sentry.io/bam/123", "https://sentry.io/bam/api/123/store/"),
+        (
+            "https://foobar@sentry.io/123",
+            "https://sentry.io/api/123/store/",
+            "https://sentry.io/api/123/envelope/",
+        ),
+        (
+            "https://foobar@sentry.io/bam/123",
+            "https://sentry.io/bam/api/123/store/",
+            "https://sentry.io/bam/api/123/envelope/",
+        ),
         (
             "https://foobar@sentry.io/bam/baz/123",
             "https://sentry.io/bam/baz/api/123/store/",
+            "https://sentry.io/bam/baz/api/123/envelope/",
         ),
     ],
 )
-def test_parse_dsn_paths(given, expected):
+def test_parse_dsn_paths(given, expected_store, expected_envelope):
     dsn = Dsn(given)
     auth = dsn.to_auth()
-    assert auth.store_api_url == expected
+    assert auth.store_api_url == expected_store
+    assert auth.get_api_url("store") == expected_store
+    assert auth.get_api_url("envelope") == expected_envelope
 
 
 @pytest.mark.parametrize(

Original file line number	Diff line number	Diff line change
`@@ -35,3 +35,4 @@`
`35`	`35`	`"default", "error", "crash", "transaction", "security", "attachment", "session"`
`36`	`36`	`]`
`37`	`37`	`SessionStatus = Literal["ok", "exited", "crashed", "abnormal"]`
	`38`	`+ EndpointType = Literal["store", "envelope"]`