feat(dashboards): Expose All Projects ID through project filter (#95246)

Ensures that when a dashboard has "All Projects" selected in their
dashboard filters (as opposed to specific projects, or "My Projects"),
that the list endpoint also returns `[-1]` in the response.

This was discovered because we weren't exposing the projects data
before, but in the new table work it is visible and I noticed it wasn't
coming through.

Author: narsaynorath

src/sentry/api/serializers/models/dashboard.py

@@ -7,7 +7,6 @@
 from django.db.models import prefetch_related_objects
 
 from sentry.api.serializers import Serializer, register, serialize
-from sentry.constants import ALL_ACCESS_PROJECTS
 from sentry.models.dashboard import Dashboard, DashboardFavoriteUser
 from sentry.models.dashboard_permissions import DashboardPermissions
 from sentry.models.dashboard_widget import (
@@ -275,6 +274,10 @@ def get_attrs(self, item_list, user, **kwargs):
             result[dashboard]["is_favorited"] = dashboard.id in favorited_dashboard_ids
             result[dashboard]["projects"] = list(dashboard.projects.values_list("id", flat=True))
 
+            filters = dashboard.get_filters()
+            if filters and filters.get("projects"):
+                result[dashboard]["projects"] = filters["projects"]
+
         return result
 
     def serialize(self, obj, attrs, user, **kwargs) -> DashboardListResponse:
@@ -340,22 +343,21 @@ def get_attrs(self, item_list, user, **kwargs):
     def serialize(self, obj, attrs, user, **kwargs) -> DashboardDetailsResponse:
         from sentry.api.serializers.rest_framework.base import camel_to_snake_case
 
+        dashboard_filters = obj.get_filters()
         data: DashboardDetailsResponse = {
             "id": str(obj.id),
             "title": obj.title,
             "dateCreated": obj.date_added,
             "createdBy": user_service.serialize_many(filter={"user_ids": [obj.created_by_id]})[0],
             "widgets": attrs["widgets"],
-            "projects": [project.id for project in obj.projects.all()],
+            "projects": dashboard_filters.get("projects", []),
             "filters": {},
             "permissions": serialize(obj.permissions) if hasattr(obj, "permissions") else None,
             "isFavorited": user.id in obj.favorited_by,
         }
 
+        # TODO: The logic for obtaining these filters will be moved to the Dashboard model.
         if obj.filters is not None:
-            if obj.filters.get("all_projects"):
-                data["projects"] = list(ALL_ACCESS_PROJECTS)
-
             for tl_key in ("environment", "period", "utc"):
                 if obj.filters.get(tl_key) is not None:
                     data[tl_key] = obj.filters[tl_key]

src/sentry/models/dashboard.py

@@ -10,6 +10,7 @@
 from django.utils import timezone
 
 from sentry.backup.scopes import RelocationScope
+from sentry.constants import ALL_ACCESS_PROJECT_ID
 from sentry.db.models import FlexibleForeignKey, Model, region_silo_model, sane_repr
 from sentry.db.models.base import DefaultFieldsModel
 from sentry.db.models.fields.bounded import BoundedBigIntegerField
@@ -320,6 +321,23 @@ def incremental_title(cls, organization, name):
 
         return f"{base_name} copy {next_copy_number}"
 
+    def get_filters(self) -> dict[str, Any]:
+        """
+        Returns the filters for the dashboard.
+
+        This is used to colocate any specific logic for producing dashboard filters,
+        such as handling the all_projects filter.
+        """
+        projects = (
+            [ALL_ACCESS_PROJECT_ID]
+            if self.filters and self.filters.get("all_projects")
+            else list(self.projects.values_list("id", flat=True))
+        )
+
+        return {
+            "projects": projects,
+        }
+
 
 @region_silo_model
 class DashboardTombstone(Model):

tests/sentry/api/endpoints/test_organization_dashboards.py

@@ -46,6 +46,11 @@ def assert_equal_dashboards(self, dashboard, data):
             widget_displays.append(DashboardWidgetDisplayTypes.get_type_name(widget.display_type))
 
         assert data["widgetDisplay"] == widget_displays
+
+        filters = dashboard.get_filters()
+        if filters and filters.get("projects"):
+            assert data.get("projects") == filters["projects"]
+
         assert "widgets" not in data
 
     def test_get(self):
@@ -718,6 +723,19 @@ def test_get_shared_dashboards_across_organizations(self):
         values = [row["title"] for row in response.data]
         assert values == ["General", "Initial dashboard"]
 
+    def test_get_with_all_projects_filter(self):
+        Dashboard.objects.create(
+            title="Dashboard with all projects filter",
+            organization=self.organization,
+            created_by_id=self.user.id,
+            filters={"all_projects": True},
+        )
+        response = self.client.get(self.url, data={"query": "Dashboard with all projects filter"})
+        assert response.status_code == 200, response.content
+        assert len(response.data) == 1
+        assert response.data[0]["title"] == "Dashboard with all projects filter"
+        assert response.data[0].get("projects") == [-1]
+
     def test_post(self):
         response = self.do_request("post", self.url, data={"title": "Dashboard from Post"})
         assert response.status_code == 201