apitally 0.19.0__tar.gz → 0.19.1__tar.gz

{apitally-0.19.0 → apitally-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apitally
-Version: 0.19.0
+Version: 0.19.1
 Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette, Litestar and BlackSheep.
 Project-URL: Homepage, https://apitally.io
 Project-URL: Documentation, https://docs.apitally.io

{apitally-0.19.0 → apitally-0.19.1}/apitally/client/sentry.py

@@ -6,17 +6,22 @@ from typing import Callable, Set
 _tasks: Set[asyncio.Task] = set()
 
 
-def get_sentry_event_id_async(cb: Callable[[str], None]) -> None:
+def get_sentry_event_id_async(cb: Callable[[str], None], raise_on_error: bool = False) -> None:
     try:
-        from sentry_sdk.hub import Hub
+        import sentry_sdk
         from sentry_sdk.scope import Scope
     except ImportError:
+        if raise_on_error:
+            raise
         return  # pragma: no cover
     if not hasattr(Scope, "get_isolation_scope") or not hasattr(Scope, "_last_event_id"):
-        # sentry-sdk < 2.2.0 is not supported
+        if raise_on_error:
+            raise RuntimeError("sentry-sdk < 2.2.0 is not supported")
         return  # pragma: no cover
-    if Hub.current.client is None:
-        return  # sentry-sdk not initialized
+    if not sentry_sdk.is_initialized():
+        if raise_on_error:
+            raise RuntimeError("sentry-sdk not initialized")
+        return
 
     scope = Scope.get_isolation_scope()
     if event_id := scope._last_event_id:

{apitally-0.19.0 → apitally-0.19.1}/apitally/fastapi.py

@@ -1,4 +1,4 @@
-from apitally.starlette import ApitallyConsumer, ApitallyMiddleware, RequestLoggingConfig
+from apitally.starlette import ApitallyConsumer, ApitallyMiddleware, RequestLoggingConfig, set_consumer
 
 
-__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig"]
+__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig", "set_consumer"]

{apitally-0.19.0 → apitally-0.19.1}/apitally/flask.py

@@ -28,7 +28,7 @@ if TYPE_CHECKING:
     from werkzeug.routing.map import Map
 
 
-__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig"]
+__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig", "set_consumer"]
 
 
 class ApitallyMiddleware:
@@ -216,6 +216,10 @@ class ApitallyMiddleware:
         return None
 
 
+def set_consumer(identifier: str, name: Optional[str] = None, group: Optional[str] = None) -> None:
+    g.apitally_consumer = ApitallyConsumer(identifier, name=name, group=group)
+
+
 def _get_startup_data(
     app: Flask, app_version: Optional[str] = None, openapi_url: Optional[str] = None
 ) -> Dict[str, Any]:

{apitally-0.19.0 → apitally-0.19.1}/apitally/litestar.py

@@ -24,7 +24,7 @@ from apitally.client.request_logging import (
 from apitally.common import get_versions, parse_int, try_json_loads
 
 
-__all__ = ["ApitallyPlugin", "ApitallyConsumer", "RequestLoggingConfig"]
+__all__ = ["ApitallyPlugin", "ApitallyConsumer", "RequestLoggingConfig", "set_consumer"]
 
 
 class ApitallyPlugin(InitPluginProtocol):
@@ -287,6 +287,10 @@ class ApitallyPlugin(InitPluginProtocol):
         return None
 
 
+def set_consumer(request: Request, identifier: str, name: Optional[str] = None, group: Optional[str] = None) -> None:
+    request.state.apitally_consumer = ApitallyConsumer(identifier, name=name, group=group)
+
+
 def _get_openapi(app: Litestar) -> str:
     schema = app.openapi_schema.to_schema()
     return json.dumps(schema)

{apitally-0.19.0 → apitally-0.19.1}/apitally/starlette.py

@@ -25,7 +25,7 @@ from apitally.client.request_logging import (
 from apitally.common import get_versions, parse_int, try_json_loads
 
 
-__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig"]
+__all__ = ["ApitallyMiddleware", "ApitallyConsumer", "RequestLoggingConfig", "set_consumer"]
 
 
 class ApitallyMiddleware:
@@ -268,6 +268,10 @@ class ApitallyMiddleware:
         return None
 
 
+def set_consumer(request: Request, identifier: str, name: Optional[str] = None, group: Optional[str] = None) -> None:
+    request.state.apitally_consumer = ApitallyConsumer(identifier, name=name, group=group)
+
+
 def _get_startup_data(
     app: ASGIApp, app_version: Optional[str] = None, openapi_url: Optional[str] = None
 ) -> Dict[str, Any]:

apitally-0.19.1/tests/test_client_sentry.py

@@ -0,0 +1,47 @@
+import time
+from importlib.util import find_spec
+
+import pytest
+
+
+if find_spec("sentry_sdk") is None:
+    pytest.skip("sentry-sdk is not available", allow_module_level=True)
+
+
+def test_get_sentry_event_id_async():
+    import sentry_sdk
+    from sentry_sdk.transport import Transport
+
+    from apitally.client.sentry import get_sentry_event_id_async
+
+    with pytest.raises(RuntimeError, match="not initialized"):
+        get_sentry_event_id_async(lambda _: None, raise_on_error=True)
+
+    class MockTransport(Transport):
+        def __init__(self):
+            super().__init__()
+            self.events = []
+
+        def capture_envelope(self, envelope):
+            self.events.append(envelope)
+
+    transport = MockTransport()
+    sentry_sdk.init(
+        dsn="https://1234567890@sentry.io/1234567890",
+        transport=transport,
+        auto_enabling_integrations=False,
+    )
+
+    event_id = None
+
+    def callback(event_id_: str) -> None:
+        nonlocal event_id
+        event_id = event_id_
+
+    sentry_sdk.capture_message("test")
+    get_sentry_event_id_async(callback, raise_on_error=True)
+    time.sleep(0.01)
+
+    assert event_id is not None
+    assert len(transport.events) == 1
+    assert event_id == transport.events[0].items[0].payload.json["event_id"]

{apitally-0.19.0 → apitally-0.19.1}/tests/test_flask.py

@@ -18,9 +18,9 @@ if TYPE_CHECKING:
 
 @pytest.fixture(scope="module")
 def app(module_mocker: MockerFixture) -> Flask:
-    from flask import Flask, g, request
+    from flask import Flask, request
 
-    from apitally.flask import ApitallyMiddleware, RequestLoggingConfig
+    from apitally.flask import ApitallyMiddleware, RequestLoggingConfig, set_consumer
 
     module_mocker.patch("apitally.client.client_threading.ApitallyClient._instance", None)
     module_mocker.patch("apitally.client.client_threading.ApitallyClient.start_sync_loop")
@@ -41,7 +41,7 @@ def app(module_mocker: MockerFixture) -> Flask:
 
     @app.route("/foo/<bar>")
     def foo_bar(bar: int):
-        g.apitally_consumer = "test"
+        set_consumer("test")
         return f"foo: {bar}", {"Content-Type": "text/plain"}
 
     @app.route("/bar", methods=["POST"])

{apitally-0.19.0 → apitally-0.19.1}/tests/test_litestar.py

@@ -28,7 +28,7 @@ async def app(module_mocker: MockerFixture) -> Litestar:
     from litestar.handlers import get, post
     from litestar.response import Stream
 
-    from apitally.litestar import ApitallyConsumer, ApitallyPlugin, RequestLoggingConfig
+    from apitally.litestar import ApitallyConsumer, ApitallyPlugin, RequestLoggingConfig, set_consumer
 
     async def mocked_handle_shutdown(_):
         # Empty function instead of Mock to avoid the following error in Python 3.10:
@@ -45,7 +45,7 @@ async def app(module_mocker: MockerFixture) -> Litestar:
 
     @get("/foo/{bar:str}")
     async def foo_bar(request: Request, bar: str) -> str:
-        request.state.apitally_consumer = "test2"
+        set_consumer(request, "test2")
         return f"foo: {bar}"
 
     @post("/bar")

{apitally-0.19.0 → apitally-0.19.1}/tests/test_starlette.py

@@ -41,10 +41,10 @@ def get_starlette_app() -> Starlette:
     from starlette.responses import PlainTextResponse, StreamingResponse
     from starlette.routing import Mount, Route
 
-    from apitally.starlette import ApitallyConsumer, ApitallyMiddleware, RequestLoggingConfig
+    from apitally.starlette import ApitallyConsumer, ApitallyMiddleware, RequestLoggingConfig, set_consumer
 
     def foo(request: Request):
-        request.state.apitally_consumer = "test"
+        set_consumer(request, "test")
         return PlainTextResponse("foo")
 
     def foo_bar(request: Request):