test_datasette_sentry.py

from datasette.app import Datasette
from datasette import hookimpl
from datasette.plugins import pm
import pytest


@pytest.mark.asyncio
@pytest.mark.parametrize("configured", (True, False))
@pytest.mark.parametrize("sample_rate", (None, 1.0, 0.0))
async def test_logs_errors_to_sentry(configured, sample_rate):
    class ErrorPlugin:
        __name__ = "ErrorPlugin"

        @hookimpl
        def register_routes(self):
            return (("/error", lambda: 1 / 0),)

    pm.register(ErrorPlugin(), name="undo")
    try:
        # Rest of test goes here
        if configured:
            settings = {
                "dsn": "https://demo@sentry.io/1234",
                "capture_events": True,
            }
            if sample_rate is not None:
                settings["sample_rate"] = sample_rate
            ds = Datasette(metadata={"plugins": {"datasette-sentry": settings}})
        else:
            ds = Datasette()
        await ds.invoke_startup()
        response = await ds.client.get("/error")
        assert response.status_code == 500
        if configured:
            if sample_rate == 0.0:
                # Should not send to Sentry
                assert not ds._datasette_sentry_events
            else:
                # Should have captured an event (but not an envelope)
                assert len(ds._datasette_sentry_envelopes) == 0
                assert len(ds._datasette_sentry_events) == 1
                event = ds._datasette_sentry_events[0]
                assert (
                    event["request"].items()
                    >= {
                        "method": "GET",
                        "query_string": None,
                        "url": "http://localhost/error",
                    }.items()
                )
        else:
            assert not hasattr(ds, "_datasette_sentry_events")
            assert not hasattr(ds, "_datasette_sentry_envelopes")
    finally:
        pm.unregister(name="undo")


@pytest.mark.asyncio
@pytest.mark.parametrize("configured", (False, True))
@pytest.mark.parametrize("traces_sample_rate", (None, 1.0, 0.0))
async def test_tracing(configured, traces_sample_rate):
    config = {
        "enable_tracing": configured,
        "capture_events": True,
        "dsn": "https://demo@sentry.io/1234",
    }
    if traces_sample_rate is not None:
        config["traces_sample_rate"] = traces_sample_rate
    ds = Datasette(metadata={"plugins": {"datasette-sentry": config}})
    await ds.invoke_startup()
    response = await ds.client.get("/-/versions")
    assert response.status_code == 200
    if configured and traces_sample_rate != 0.0:
        # Should have captured a trace envelope
        assert len(ds._datasette_sentry_envelopes) == 1
        envelope = ds._datasette_sentry_envelopes[0]
        assert (
            envelope.items[0].payload.json["transaction"]
            == "http://localhost:None/-/versions"
        )
    else:
        assert len(ds._datasette_sentry_envelopes) == 0