fix(crons): Serialize the config type correctly (#85211)

Applies the serialization to the config that the frontend has been typed
to expect. Specifically the schedule type being served as an integer,
but expected as a string.

Author: leeandher

src/sentry/monitors/serializers.py

@@ -1,7 +1,7 @@
 from collections import defaultdict
 from collections.abc import MutableMapping, Sequence
 from datetime import datetime
-from typing import Any, Literal, TypedDict
+from typing import Any, Literal, TypedDict, cast
 
 from django.db.models import prefetch_related_objects
 
@@ -17,6 +17,7 @@
     MonitorEnvironment,
     MonitorIncident,
     MonitorStatus,
+    ScheduleType,
 )
 from sentry.monitors.processing_errors.errors import (
     CheckinProcessingError,
@@ -276,7 +277,7 @@ class MonitorCheckInSerializerResponse(MonitorCheckInSerializerResponseOptional)
     duration: int
     dateCreated: datetime
     expectedTime: datetime
-    monitorConfig: Any
+    monitorConfig: MonitorConfigSerializerResponse
 
 
 @register(MonitorCheckIn)
@@ -330,14 +331,19 @@ def get_attrs(self, item_list, user, **kwargs):
         return attrs
 
     def serialize(self, obj, attrs, user, **kwargs) -> MonitorCheckInSerializerResponse:
+        config = obj.monitor_config.copy() if obj.monitor_config else {}
+        if "schedule_type" in config:
+            # XXX: We don't use monitor.get_schedule_type_display() in case it differs from the
+            # config saved on the check-in
+            config["schedule_type"] = ScheduleType.get_name(config["schedule_type"])
         result: MonitorCheckInSerializerResponse = {
             "id": str(obj.guid),
             "environment": attrs["environment_name"],
             "status": obj.get_status_display(),
             "duration": obj.duration,
             "dateCreated": obj.date_added,
             "expectedTime": obj.expected_time,
-            "monitorConfig": obj.monitor_config or {},
+            "monitorConfig": cast(MonitorConfigSerializerResponse, config),
         }
 
         if self._expand("groups"):

src/sentry/testutils/fixtures.py

@@ -26,6 +26,7 @@
 from sentry.models.team import Team
 from sentry.monitors.models import (
     Monitor,
+    MonitorCheckIn,
     MonitorEnvironment,
     MonitorIncident,
     MonitorType,
@@ -465,6 +466,9 @@ def create_monitor_environment(self, **kwargs):
     def create_monitor_incident(self, **kwargs):
         return MonitorIncident.objects.create(**kwargs)
 
+    def create_monitor_checkin(self, **kwargs):
+        return MonitorCheckIn.objects.create(**kwargs)
+
     def create_external_user(self, user=None, organization=None, integration=None, **kwargs):
         if not user:
             user = self.user

tests/sentry/monitors/endpoints/test_base_monitor_checkin_index.py

@@ -5,7 +5,7 @@
 
 from sentry.models.environment import Environment
 from sentry.models.group import Group
-from sentry.monitors.models import CheckInStatus, MonitorCheckIn, MonitorStatus
+from sentry.monitors.models import CheckInStatus, MonitorCheckIn, MonitorStatus, ScheduleType
 from sentry.testutils.cases import MonitorTestCase
 from sentry.testutils.helpers.datetime import freeze_time
 from sentry.testutils.skips import requires_snuba
@@ -225,3 +225,42 @@ def test_trace_ids(self):
         assert resp.data[0]["groups"] == []
         assert resp.data[1]["id"] == str(checkin1.guid)
         assert resp.data[1]["groups"] == [{"id": group.id, "shortId": group.qualified_short_id}]
+
+    def test_serializes_monitor_config_correctly(self):
+        monitor = self.create_monitor(project=self.project)
+        config = {
+            "schedule": "0 0 * * *",
+            "schedule_type": ScheduleType.CRONTAB,
+            "timezone": "US/Arizona",
+            "max_runtime": None,
+            "checkin_margin": None,
+        }
+        monitor_environment = self._create_monitor_environment(monitor)
+        self.create_monitor_checkin(
+            monitor=monitor,
+            monitor_environment=monitor_environment,
+            project_id=self.project.id,
+            date_added=monitor.date_added - timedelta(minutes=2),
+            status=CheckInStatus.OK,
+            monitor_config=config,
+        )
+        # Mutating the monitor config to test that the check-in config is used
+        monitor.config = {
+            "schedule": "0 * * * *",
+            "schedule_type": ScheduleType.INTERVAL,
+            "timezone": "CA/Toronto",
+            "max_runtime": 1000,
+            "checkin_margin": 100,
+        }
+        monitor.save()
+        response = self.get_success_response(
+            self.project.organization.slug,
+            monitor.slug,
+        )
+        assert response.data[0]["monitorConfig"]["schedule_type"] == ScheduleType.get_name(
+            config["schedule_type"]
+        )
+        assert response.data[0]["monitorConfig"]["schedule"] == config["schedule"]
+        assert response.data[0]["monitorConfig"]["timezone"] == config["timezone"]
+        assert response.data[0]["monitorConfig"]["max_runtime"] == config["max_runtime"]
+        assert response.data[0]["monitorConfig"]["checkin_margin"] == config["checkin_margin"]