sentry/tests/snuba/api/endpoints/test_organization_stats_summary.py

from __future__ import annotations

import functools
from datetime import datetime, timedelta, timezone
from typing import Any

from django.urls import reverse

from sentry.constants import DataCategory
from sentry.testutils.cases import APITestCase, OutcomesSnubaTest
from sentry.testutils.helpers.datetime import freeze_time
from sentry.utils.outcomes import Outcome


class OrganizationStatsSummaryTest(APITestCase, OutcomesSnubaTest):
    def setUp(self):
        super().setUp()
        self.now = datetime(2021, 3, 14, 12, 27, 28, tzinfo=timezone.utc)

        self.login_as(user=self.user)

        self.org = self.organization
        self.org.flags.allow_joinleave = False
        self.org.save()

        self.org2 = self.create_organization()
        self.org3 = self.create_organization()

        self.project = self.create_project(
            name="bar", teams=[self.create_team(organization=self.org, members=[self.user])]
        )
        self.project2 = self.create_project(
            name="foo", teams=[self.create_team(organization=self.org, members=[self.user])]
        )
        self.project3 = self.create_project(organization=self.org2)

        self.user2 = self.create_user(is_superuser=False)
        self.create_member(user=self.user2, organization=self.organization, role="member", teams=[])
        self.create_member(user=self.user2, organization=self.org3, role="member", teams=[])
        self.project4 = self.create_project(
            name="users2sproj",
            teams=[self.create_team(organization=self.org, members=[self.user2])],
        )

        self.store_outcomes(
            {
                "org_id": self.org.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project.id,
                "outcome": Outcome.ACCEPTED,
                "reason": "none",
                "category": DataCategory.ERROR,
                "quantity": 1,
            },
            5,
        )
        self.store_outcomes(
            {
                "org_id": self.org.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project.id,
                "outcome": Outcome.ACCEPTED,
                "reason": "none",
                "category": DataCategory.DEFAULT,  # test that this shows up under error
                "quantity": 1,
            }
        )

        self.store_outcomes(
            {
                "org_id": self.org.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project.id,
                "outcome": Outcome.RATE_LIMITED,
                "reason": "smart_rate_limit",
                "category": DataCategory.ATTACHMENT,
                "quantity": 1024,
            }
        )
        self.store_outcomes(
            {
                "org_id": self.org.id,
                "timestamp": self.now - timedelta(hours=1),
                "project_id": self.project2.id,
                "outcome": Outcome.RATE_LIMITED,
                "reason": "smart_rate_limit",
                "category": DataCategory.TRANSACTION,
                "quantity": 1,
            }
        )

    def do_request(self, query, user=None, org=None):
        self.login_as(user=user or self.user)
        url = reverse(
            "sentry-api-0-organization-stats-summary",
            kwargs={"organization_id_or_slug": (org or self.organization).slug},
        )
        return self.client.get(url, query, format="json")

    def test_empty_request(self):
        response = self.do_request({})
        assert response.status_code == 400, response.content
        assert response.data == {"detail": 'At least one "field" is required.'}

    def test_inaccessible_project(self):
        response = self.do_request({"project": [self.project3.id]})

        assert response.status_code == 403, response.content
        assert response.data == {"detail": "You do not have permission to perform this action."}

    def test_no_projects_available(self):
        response = self.do_request(
            {
                "groupBy": ["project"],
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "transaction"],
            },
            user=self.user2,
            org=self.org3,
        )

        assert response.status_code == 400, response.content
        assert response.data == {
            "detail": "No projects available",
        }

    def test_unknown_field(self):
        response = self.do_request(
            {
                "field": ["summ(qarntenty)"],
                "statsPeriod": "1d",
                "interval": "1d",
            }
        )

        assert response.status_code == 400, response.content
        assert response.data == {
            "detail": 'Invalid field: "summ(qarntenty)"',
        }

    def test_no_end_param(self):
        response = self.do_request(
            {"field": ["sum(quantity)"], "interval": "1d", "start": "2021-03-14T00:00:00Z"}
        )

        assert response.status_code == 400, response.content
        assert response.data == {"detail": "start and end are both required"}

    @freeze_time(datetime(2021, 3, 14, 12, 27, 28, tzinfo=timezone.utc))
    def test_future_request(self):
        response = self.do_request(
            {
                "field": ["sum(quantity)"],
                "interval": "1h",
                "category": ["error"],
                "start": "2021-03-14T15:30:00",
                "end": "2021-03-14T16:30:00",
            }
        )
        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-14T12:00:00Z",
            "end": "2021-03-14T17:00:00Z",
            "projects": [],
        }

    def test_unknown_category(self):
        response = self.do_request(
            {
                "field": ["sum(quantity)"],
                "statsPeriod": "1d",
                "interval": "1d",
                "category": "scoobydoo",
            }
        )

        assert response.status_code == 400, response.content
        assert response.data == {
            "detail": 'Invalid category: "scoobydoo"',
        }

    def test_unknown_outcome(self):
        response = self.do_request(
            {
                "field": ["sum(quantity)"],
                "statsPeriod": "1d",
                "interval": "1d",
                "category": "error",
                "outcome": "scoobydoo",
            }
        )

        assert response.status_code == 400, response.content
        assert response.data == {
            "detail": 'Invalid outcome: "scoobydoo"',
        }

    def test_resolution_invalid(self):
        self.login_as(user=self.user)
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "1d",
                "interval": "bad_interval",
            }
        )

        assert response.status_code == 400, response.content

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_attachment_filter_only(self):
        response = self.do_request(
            {
                "project": [-1],
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "attachment"],
            }
        )

        assert response.status_code == 400, response.content
        assert response.data == {
            "detail": "if filtering by attachment no other category may be present"
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_user_all_accessible(self):
        response = self.do_request(
            {
                "project": self.project.id,
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "transaction"],
            },
            user=self.user2,
        )

        assert response.status_code == 403
        response = self.do_request(
            {
                "project": [-1],
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "transaction"],
            },
            user=self.user2,
        )

        assert response.status_code == 200
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_no_project_access(self):
        user = self.create_user(is_superuser=False)
        self.create_member(user=user, organization=self.organization, role="member", teams=[])

        response = self.do_request(
            {
                "project": [self.project.id],
                "statsPeriod": "1d",
                "interval": "1d",
                "category": ["error", "transaction"],
                "field": ["sum(quantity)"],
            },
            org=self.organization,
            user=user,
        )

        assert response.status_code == 403, response.content
        assert response.data == {"detail": "You do not have permission to perform this action."}

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_open_membership_semantics(self):
        self.org.flags.allow_joinleave = True
        self.org.save()
        response = self.do_request(
            {
                "project": [-1],
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "transaction"],
                "groupBy": ["project"],
            },
            user=self.user2,
        )

        assert response.status_code == 200
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "error",
                            "outcomes": {
                                "abuse": 0,
                                "accepted": 6,
                                "cardinality_limited": 0,
                                "client_discard": 0,
                                "filtered": 0,
                                "invalid": 0,
                                "rate_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(quantity)": 6},
                        }
                    ],
                },
                {
                    "id": self.project2.id,
                    "slug": self.project2.slug,
                    "stats": [
                        {
                            "category": "transaction",
                            "outcomes": {
                                "abuse": 0,
                                "accepted": 0,
                                "cardinality_limited": 0,
                                "client_discard": 0,
                                "filtered": 0,
                                "invalid": 0,
                                "rate_limited": 1,
                            },
                            "totals": {"dropped": 1, "sum(quantity)": 1},
                        }
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_org_simple(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "2d",
                "interval": "1d",
                "field": ["sum(quantity)"],
            }
        )

        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-12T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "attachment",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 1024,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 1024, "sum(quantity)": 1024},
                        },
                        {
                            "category": "error",
                            "outcomes": {
                                "accepted": 6,
                                "filtered": 0,
                                "rate_limited": 0,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(quantity)": 6},
                        },
                    ],
                },
                {
                    "id": self.project2.id,
                    "slug": self.project2.slug,
                    "stats": [
                        {
                            "category": "transaction",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 1,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 1, "sum(quantity)": 1},
                        }
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_org_multiple_fields(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "2d",
                "interval": "1d",
                "field": ["sum(quantity)", "sum(times_seen)"],
            }
        )

        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-12T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "attachment",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 1025,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {
                                "dropped": 1025,
                                "sum(quantity)": 1024,
                                "sum(times_seen)": 1,
                            },
                        },
                        {
                            "category": "error",
                            "outcomes": {
                                "accepted": 12,
                                "filtered": 0,
                                "rate_limited": 0,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(quantity)": 6, "sum(times_seen)": 6},
                        },
                    ],
                },
                {
                    "id": self.project2.id,
                    "slug": self.project2.slug,
                    "stats": [
                        {
                            "category": "transaction",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 2,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 2, "sum(quantity)": 1, "sum(times_seen)": 1},
                        }
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_org_project_totals_per_project(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response_per_group = make_request(
            {
                "statsPeriod": "1d",
                "interval": "1h",
                "field": ["sum(times_seen)"],
                "category": ["error", "transaction"],
            }
        )

        assert response_per_group.status_code == 200, response_per_group.content
        assert response_per_group.data == {
            "start": "2021-03-13T12:00:00Z",
            "end": "2021-03-14T13:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "error",
                            "outcomes": {
                                "abuse": 0,
                                "accepted": 6,
                                "cardinality_limited": 0,
                                "client_discard": 0,
                                "filtered": 0,
                                "invalid": 0,
                                "rate_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(times_seen)": 6},
                        }
                    ],
                },
                {
                    "id": self.project2.id,
                    "slug": self.project2.slug,
                    "stats": [
                        {
                            "category": "transaction",
                            "outcomes": {
                                "abuse": 0,
                                "accepted": 0,
                                "cardinality_limited": 0,
                                "client_discard": 0,
                                "filtered": 0,
                                "invalid": 0,
                                "rate_limited": 1,
                            },
                            "totals": {"dropped": 1, "sum(times_seen)": 1},
                        }
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_project_filter(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "project": self.project.id,
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": ["error", "transaction"],
            }
        )

        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "error",
                            "outcomes": {
                                "abuse": 0,
                                "accepted": 6,
                                "cardinality_limited": 0,
                                "client_discard": 0,
                                "filtered": 0,
                                "invalid": 0,
                                "rate_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(quantity)": 6},
                        },
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_reason_filter(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(times_seen)"],
                "reason": ["spike_protection"],
                "groupBy": ["category"],
            }
        )

        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "attachment",
                            "reason": "spike_protection",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 1,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 1, "sum(times_seen)": 1},
                        }
                    ],
                },
                {
                    "id": self.project2.id,
                    "slug": self.project2.slug,
                    "stats": [
                        {
                            "category": "transaction",
                            "reason": "spike_protection",
                            "outcomes": {
                                "accepted": 0,
                                "filtered": 0,
                                "rate_limited": 1,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 1, "sum(times_seen)": 1},
                        }
                    ],
                },
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_outcome_filter(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "outcome": "accepted",
                "category": ["error", "transaction"],
            }
        )
        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "error",
                            "outcomes": {
                                "accepted": 6,
                            },
                            "totals": {"sum(quantity)": 6},
                        }
                    ],
                }
            ],
        }

    @freeze_time("2021-03-14T12:27:28.303Z")
    def test_category_filter(self):
        make_request = functools.partial(
            self.client.get,
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]),
        )
        response = make_request(
            {
                "statsPeriod": "1d",
                "interval": "1d",
                "field": ["sum(quantity)"],
                "category": "error",
            }
        )
        assert response.status_code == 200, response.content
        assert response.data == {
            "start": "2021-03-13T00:00:00Z",
            "end": "2021-03-15T00:00:00Z",
            "projects": [
                {
                    "id": self.project.id,
                    "slug": self.project.slug,
                    "stats": [
                        {
                            "category": "error",
                            "outcomes": {
                                "accepted": 6,
                                "filtered": 0,
                                "rate_limited": 0,
                                "invalid": 0,
                                "abuse": 0,
                                "client_discard": 0,
                                "cardinality_limited": 0,
                            },
                            "totals": {"dropped": 0, "sum(quantity)": 6},
                        }
                    ],
                }
            ],
        }

    def test_download(self):
        req: dict[str, Any] = {
            "statsPeriod": "2d",
            "interval": "1d",
            "field": ["sum(quantity)", "sum(times_seen)"],
            "download": True,
        }
        response = self.client.get(
            reverse("sentry-api-0-organization-stats-summary", args=[self.org.slug]), req
        )

        assert response.headers["Content-Type"] == "text/csv"
        assert response.headers["Content-Disposition"] == 'attachment; filename="stats_summary.csv"'
        assert response.status_code == 200