feat(releases): allow finalized query in releases endpoint (#87997)

closes #86258

allow query `finalized:true` or `finalized:false` on the `/releases/`
endpoint
a release is finalized if its `dateReleased` property is set.

Author: michellewzhang

src/sentry/api/endpoints/organization_releases.py

@@ -17,7 +17,7 @@
 from sentry.api.bases.organization import OrganizationReleasesBaseEndpoint
 from sentry.api.exceptions import ConflictError, InvalidRepository
 from sentry.api.paginator import MergingOffsetPaginator, OffsetPaginator
-from sentry.api.release_search import RELEASE_FREE_TEXT_KEY, parse_search_query
+from sentry.api.release_search import FINALIZED_KEY, RELEASE_FREE_TEXT_KEY, parse_search_query
 from sentry.api.serializers import serialize
 from sentry.api.serializers.rest_framework import (
     ReleaseHeadCommitSerializer,
@@ -78,6 +78,12 @@ def add_date_filter_to_queryset(queryset, filter_params):
 def _filter_releases_by_query(queryset, organization, query, filter_params):
     search_filters = parse_search_query(query)
     for search_filter in search_filters:
+        if search_filter.key.name == FINALIZED_KEY:
+            if search_filter.value.value == "true":
+                queryset = queryset.filter(date_released__isnull=False)
+            elif search_filter.value.value == "false":
+                queryset = queryset.filter(date_released__isnull=True)
+
         if search_filter.key.name == RELEASE_FREE_TEXT_KEY:
             query_q = Q(version__icontains=query)
             suffix_match = _release_suffix.match(query)
@@ -267,6 +273,7 @@ def get(self, request: Request, organization) -> Response:
         health_stat = request.GET.get("healthStat") or "sessions"
         summary_stats_period = request.GET.get("summaryStatsPeriod") or "14d"
         health_stats_period = request.GET.get("healthStatsPeriod") or ("24h" if with_health else "")
+
         if summary_stats_period not in STATS_PERIODS:
             raise ParseError(detail=get_stats_period_detail("summaryStatsPeriod", STATS_PERIODS))
         if health_stats_period and health_stats_period not in STATS_PERIODS:

src/sentry/api/release_search.py

@@ -11,6 +11,7 @@
 )
 
 RELEASE_FREE_TEXT_KEY = "release_free_text"
+FINALIZED_KEY = "finalized"
 INVALID_SEMVER_MESSAGE = (
     'Invalid format of semantic version. For searching non-semver releases, use "release:" instead.'
 )
@@ -23,6 +24,7 @@
         SEMVER_ALIAS,
         SEMVER_BUILD_ALIAS,
         SEMVER_PACKAGE_ALIAS,
+        FINALIZED_KEY,
     },
     allow_boolean=False,
     free_text_key=RELEASE_FREE_TEXT_KEY,

tests/sentry/api/endpoints/test_organization_releases.py

@@ -8,6 +8,7 @@
 from django.utils import timezone
 
 from sentry.api.endpoints.organization_releases import ReleaseSerializerWithProjects
+from sentry.api.release_search import FINALIZED_KEY
 from sentry.api.serializers.rest_framework.release import ReleaseHeadCommitSerializer
 from sentry.auth import access
 from sentry.constants import BAD_RELEASE_CHARS, MAX_COMMIT_LENGTH, MAX_VERSION_LENGTH
@@ -1067,6 +1068,42 @@ def test_semver_filter(self):
         )
         assert [r["version"] for r in response.data] == [release_2.version, release_1.version]
 
+    def test_finalized_filter(self):
+        self.login_as(user=self.user)
+
+        release_1 = self.create_release(
+            version="[email protected]", date_released=datetime(2013, 8, 13, 3, 8, 24, 880386, tzinfo=UTC)
+        )
+        release_2 = self.create_release(version="[email protected]", date_released=None)
+        release_3 = self.create_release(version="[email protected]", date_released=None)
+        release_4 = self.create_release(version="[email protected]")
+
+        url = reverse(
+            "sentry-api-0-organization-releases",
+            kwargs={"organization_id_or_slug": self.organization.slug},
+        )
+        response = self.client.get(url + f"?query={FINALIZED_KEY}:true", format="json")
+
+        assert response.status_code == 200, response.content
+        assert len(response.data) == 1
+        assert [r["version"] for r in response.data] == [release_1.version]
+
+        response = self.client.get(url + f"?query={FINALIZED_KEY}:false", format="json")
+        assert [r["version"] for r in response.data] == [
+            release_4.version,
+            release_3.version,
+            release_2.version,
+        ]
+
+        # if anything besides "true" or "false" is parsed, return all releases
+        response = self.client.get(url + f"?query={FINALIZED_KEY}:wrong_value", format="json")
+        assert [r["version"] for r in response.data] == [
+            release_4.version,
+            release_3.version,
+            release_2.version,
+            release_1.version,
+        ]
+
     def test_release_stage_filter(self):
         self.login_as(user=self.user)