Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/sentry/apidocs/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,13 @@ def get_old_json_components(filename: str) -> Any:
"url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/profiling/&template=api_error_template.md",
},
},
{
"name": "Flags",
"description": "Endpoints for retrieving feature flag change logs",
"x-display-description": False,
"externalDocs": {
"description": "Found an error? Let us know.",
"url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/flags/&template=api_error_template.md",
},
},
]
32 changes: 32 additions & 0 deletions src/sentry/apidocs/examples/flag_examples.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
from drf_spectacular.utils import OpenApiExample

flag_log_example = {
"id": 1,
"action": "updated",
"createdAt": "2024-01-01T05:12:33.000000+00:00",
"createdBy": "jane.doe@example.com",
"createdByType": "email",
"flag": "new-checkout-flow",
"provider": "launchdarkly",
"tags": {"environment": "production"},
}


class FlagExamples:
LIST_FLAG_LOGS = [
OpenApiExample(
"List an organization's flag logs",
value={"data": [flag_log_example]},
status_codes=["200"],
response_only=True,
)
]

GET_FLAG_LOG = [
OpenApiExample(
"Retrieve a flag log",
value={"data": flag_log_example},
status_codes=["200"],
response_only=True,
)
]
45 changes: 45 additions & 0 deletions src/sentry/apidocs/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,51 @@ class DataForwarderParams:
)


class FlagParams:
FLAG_LOG_ID = OpenApiParameter(
name="flag_log_id",
location="path",
required=True,
type=int,
description="The ID of the flag log entry you'd like to retrieve.",
)
FLAG = OpenApiParameter(
name="flag",
location="query",
required=False,
type=str,
many=True,
description="The name of a feature flag to filter by. Repeat the parameter to match multiple flags.",
)
PROVIDER = OpenApiParameter(
name="provider",
location="query",
required=False,
type=str,
many=True,
enum=["generic", "flagpole", "launchdarkly", "unleash", "statsig", "unknown"],
description="The flag provider to filter by. Use `unknown` to match logs without a provider. Repeat the parameter to match multiple providers.",
)
SORT = OpenApiParameter(
name="sort",
location="query",
required=False,
type=str,
description="""The field to sort results by.

Available fields are:
- `action`
- `createdAt`
- `createdBy`
- `createdByType`
- `flag`
- `provider`

Prefix with `-` to sort in descending order.
""",
)


class SentryAppParams:
SENTRY_APP_ID_OR_SLUG = OpenApiParameter(
name="sentry_app_id_or_slug",
Expand Down
84 changes: 74 additions & 10 deletions src/sentry/flags/endpoints/logs.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from datetime import datetime
from typing import Any, TypedDict
from typing import Any, Literal, TypedDict

from django.db.models import Q
from drf_spectacular.utils import extend_schema
from rest_framework import serializers as rest_serializers
from rest_framework.exceptions import ParseError
from rest_framework.request import Request
Expand All @@ -16,27 +17,45 @@
from sentry.api.serializers import Serializer, register, serialize
from sentry.api.serializers.rest_framework.base import camel_to_snake_case
from sentry.api.utils import get_date_range_from_params
from sentry.apidocs.constants import (
RESPONSE_BAD_REQUEST,
RESPONSE_FORBIDDEN,
RESPONSE_NOT_FOUND,
RESPONSE_UNAUTHORIZED,
)
from sentry.apidocs.examples.flag_examples import FlagExamples
from sentry.apidocs.parameters import CursorQueryParam, FlagParams, GlobalParams, VisibilityParams
from sentry.apidocs.utils import inline_sentry_response_serializer
from sentry.flags.models import (
PROVIDER_MAP,
ActionEnum,
CreatedByTypeEnum,
FlagAuditLogModel,
ProviderEnum,
ProviderName,
)
from sentry.models.organization import Organization


class FlagAuditLogModelSerializerResponse(TypedDict):
id: int
action: str
action: Literal["created", "deleted", "updated"]
createdAt: datetime
createdBy: str | None
createdByType: str | None
createdByType: Literal["email", "id", "name"] | None
flag: str
provider: str | None
provider: ProviderName | None
tags: dict[str, Any]


class FlagLogIndexResponse(TypedDict):
data: list[FlagAuditLogModelSerializerResponse]


class FlagLogDetailsResponse(TypedDict):
data: FlagAuditLogModelSerializerResponse


@register(FlagAuditLogModel)
class FlagAuditLogModelSerializer(Serializer[FlagAuditLogModelSerializerResponse]):
def serialize(self, obj, attrs, user, **kwargs) -> FlagAuditLogModelSerializerResponse:
Expand Down Expand Up @@ -88,11 +107,38 @@ def validate_sort(self, value: str | None) -> str | None:


@cell_silo_endpoint
@extend_schema(tags=["Flags"])
class OrganizationFlagLogIndexEndpoint(OrganizationEndpoint):
owner = ApiOwner.FLAG
publish_status = {"GET": ApiPublishStatus.PRIVATE}

def get(self, request: Request, organization: Organization) -> Response:
publish_status = {"GET": ApiPublishStatus.PUBLIC}

@extend_schema(
operation_id="listOrganizationFlagLogs",
summary="List an Organization's Flag Logs",
parameters=[
GlobalParams.ORG_ID_OR_SLUG,
GlobalParams.START,
GlobalParams.END,
GlobalParams.STATS_PERIOD,
FlagParams.FLAG,
FlagParams.PROVIDER,
FlagParams.SORT,
VisibilityParams.PER_PAGE,
CursorQueryParam,
],
responses={
200: inline_sentry_response_serializer("ListFlagLogsResponse", FlagLogIndexResponse),
400: RESPONSE_BAD_REQUEST,
401: RESPONSE_UNAUTHORIZED,
403: RESPONSE_FORBIDDEN,
},
examples=FlagExamples.LIST_FLAG_LOGS,
)
def get(self, request: Request, organization: Organization) -> Response[FlagLogIndexResponse]:
"""
Return a paginated list of feature flag changes (creations, updates and deletions)
recorded for an organization within the requested time range.
"""
start, end = get_date_range_from_params(request.GET)
if start is None or end is None:
raise ParseError(detail="Invalid date range")
Expand Down Expand Up @@ -137,11 +183,29 @@ def get(self, request: Request, organization: Organization) -> Response:


@cell_silo_endpoint
@extend_schema(tags=["Flags"])
class OrganizationFlagLogDetailsEndpoint(OrganizationEndpoint):
owner = ApiOwner.FLAG
publish_status = {"GET": ApiPublishStatus.PRIVATE}

def get(self, request: Request, organization: Organization, flag_log_id: int) -> Response:
publish_status = {"GET": ApiPublishStatus.PUBLIC}

@extend_schema(
operation_id="retrieveOrganizationFlagLog",
summary="Retrieve an Organization's Flag Log",
parameters=[GlobalParams.ORG_ID_OR_SLUG, FlagParams.FLAG_LOG_ID],
responses={
200: inline_sentry_response_serializer("GetFlagLogResponse", FlagLogDetailsResponse),
401: RESPONSE_UNAUTHORIZED,
403: RESPONSE_FORBIDDEN,
404: RESPONSE_NOT_FOUND,
},
examples=FlagExamples.GET_FLAG_LOG,
)
def get(
self, request: Request, organization: Organization, flag_log_id: int
) -> Response[FlagLogDetailsResponse]:
"""
Return a single feature flag change recorded for an organization.
"""
try:
model = FlagAuditLogModel.objects.filter(
id=flag_log_id,
Expand Down
6 changes: 5 additions & 1 deletion src/sentry/flags/models.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from enum import Enum
from typing import Literal

from django.conf import settings
from django.db import models
Expand Down Expand Up @@ -55,6 +56,9 @@ def to_string(cls, integer):
}


ProviderName = Literal["generic", "flagpole", "launchdarkly", "unleash", "statsig"]


class ProviderEnum(Enum):
GENERIC = 0
FLAGPOLE = 1
Expand All @@ -63,7 +67,7 @@ class ProviderEnum(Enum):
STATSIG = 4

@classmethod
def to_string(cls, integer) -> str:
def to_string(cls, integer) -> ProviderName:
if integer == 0:
return "generic"
if integer == 1:
Expand Down
64 changes: 64 additions & 0 deletions tests/apidocs/endpoints/flags/test_logs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
from datetime import datetime, timezone

from django.test.client import RequestFactory
from django.urls import reverse

from fixtures.apidocs_test_case import APIDocsTestCase
from sentry.flags.models import PROVIDER_MAP, FlagAuditLogModel


class OrganizationFlagLogsDocs(APIDocsTestCase):
def setUp(self) -> None:
self.flag_log = FlagAuditLogModel.objects.create(
action=2,
created_at=datetime.now(timezone.utc),
created_by="a@b.com",
created_by_type=0,
flag="hello",
organization_id=self.organization.id,
provider=PROVIDER_MAP["launchdarkly"],
tags={"environment": "production"},
)
self.login_as(user=self.user)

def test_list(self) -> None:
url = reverse(
"sentry-api-0-organization-flag-logs",
kwargs={"organization_id_or_slug": self.organization.slug},
)
response = self.client.get(url)
request = RequestFactory().get(url)

assert response.status_code == 200
assert len(response.data["data"]) == 1
self.validate_schema(request, response)

def test_list_no_provider(self) -> None:
self.flag_log.provider = None
self.flag_log.created_by = None
self.flag_log.created_by_type = None
self.flag_log.save()

url = reverse(
"sentry-api-0-organization-flag-logs",
kwargs={"organization_id_or_slug": self.organization.slug},
)
response = self.client.get(url)
request = RequestFactory().get(url)

assert response.status_code == 200
self.validate_schema(request, response)

def test_get(self) -> None:
url = reverse(
"sentry-api-0-organization-flag-log",
kwargs={
"organization_id_or_slug": self.organization.slug,
"flag_log_id": self.flag_log.id,
},
)
response = self.client.get(url)
request = RequestFactory().get(url)

assert response.status_code == 200
self.validate_schema(request, response)
13 changes: 13 additions & 0 deletions tests/sentry/seer/endpoints/test_organization_agent_token.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from sentry.api.endpoints.seer_models import SEER_MODELS_CACHE_KEY
from sentry.apidocs.hooks import CustomEndpointEnumerator
from sentry.attachments.base import CachedAttachment
from sentry.flags.models import PROVIDER_MAP, ActionEnum, CreatedByTypeEnum, FlagAuditLogModel
from sentry.incidents.models.alert_rule import AlertRuleDetectionType
from sentry.incidents.utils.subscription_limits import METRIC_SUBSCRIPTION_FEATURE_FLAGS
from sentry.issues.endpoints.group_tags import GroupTagsEndpoint
Expand Down Expand Up @@ -906,6 +907,16 @@ def _resource(self, name: str) -> Any:
provider="segment",
config={"write_key": "matrix-key"},
)
elif name == "flag_log":
resource = FlagAuditLogModel.objects.create(
action=ActionEnum.UPDATED.value,
created_by="permission-matrix@example.com",
created_by_type=CreatedByTypeEnum.EMAIL.value,
flag="permission-matrix-flag",
organization_id=self.org.id,
provider=PROVIDER_MAP["generic"],
tags={"environment": "production"},
)
Comment on lines +911 to +919

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.

Maybe a bit surprising this doesn't go through Factories like the other fixtures, but 🤷🏻‍♂️

elif name == "detector_condition_group":
resource = self.create_data_condition_group(organization_id=self.org.id)
elif name == "external_team":
Expand Down Expand Up @@ -1127,6 +1138,8 @@ def _path_value(
return str(self._resource("integration").id)
if placeholder == "data_forwarder_id":
return str(self._resource("data_forwarder").id)
if placeholder == "flag_log_id":
return str(self._resource("flag_log").id)
if placeholder == "external_team_id":
return str(self._resource("external_team").id)
if placeholder == "external_user_id":
Expand Down
Loading