fix(aci): Add migration to check group id for exclusion constraint (#88484)

The existing exclusion constraint looks only for overlapping ranges of
(date_started, date_ended). We need to enforce this constraint for each
group, so that no distinct group has two open periods that overlap. The
table itself is expected to have multiple overlapping ranges since we'll
have one row per group.

Author: snigdhas

migrations_lockfile.txt

@@ -17,7 +17,7 @@ remote_subscriptions: 0003_drop_remote_subscription
 
 replays: 0004_index_together
 
-sentry: 0856_monitors_remove_type_column_state
+sentry: 0857_update_group_open_periods_constraint
 
 social_auth: 0002_default_auto_field
 

src/sentry/migrations/0857_update_group_open_periods_constraint.py

@@ -0,0 +1,42 @@
+# Generated by Django 5.1.7 on 2025-04-01 20:22
+
+from django.db import migrations
+
+from sentry.new_migrations.migrations import CheckedMigration
+from sentry.new_migrations.monkey.special import SafeRunSQL
+
+
+class Migration(CheckedMigration):
+    # This flag is used to mark that a migration shouldn't be automatically run in production.
+    # This should only be used for operations where it's safe to run the migration after your
+    # code has deployed. So this should not be used for most operations that alter the schema
+    # of a table.
+    # Here are some things that make sense to mark as post deployment:
+    # - Large data migrations. Typically we want these to be run manually so that they can be
+    #   monitored and not block the deploy for a long period of time while they run.
+    # - Adding indexes to large tables. Since this can take a long time, we'd generally prefer to
+    #   run this outside deployments so that we don't block them. Note that while adding an index
+    #   is a schema change, it's completely safe to run the operation after the code has deployed.
+    # Once deployed, run these manually via: https://develop.sentry.dev/database-migrations/#migration-deployment
+
+    is_post_deployment = False
+
+    dependencies = [
+        ("sentry", "0856_monitors_remove_type_column_state"),
+    ]
+
+    operations = [
+        migrations.RemoveConstraint(
+            model_name="groupopenperiod",
+            name="exclude_open_period_overlap",
+        ),
+        SafeRunSQL(
+            """ALTER TABLE "sentry_groupopenperiod"
+                ADD CONSTRAINT "exclude_open_period_overlap" EXCLUDE USING GIST (
+                    "group_id" gist_int8_ops WITH =,
+                    (TSTZRANGE("date_started", "date_ended", '[)')) WITH &&
+                );""",
+            use_statement_timeout=False,
+            hints={"tables": ["sentry_groupopenperiod"]},
+        ),
+    ]

src/sentry/models/groupopenperiod.py

@@ -1,6 +1,5 @@
 from django.conf import settings
-from django.contrib.postgres.constraints import ExclusionConstraint
-from django.contrib.postgres.fields import DateTimeRangeField, RangeBoundary, RangeOperators
+from django.contrib.postgres.fields import DateTimeRangeField
 from django.db import models
 from django.utils import timezone
 
@@ -44,16 +43,20 @@ class Meta:
             # get all open periods since a certain date
             models.Index(fields=("group", "date_started")),
         )
-        constraints = (
-            ExclusionConstraint(
-                name="exclude_open_period_overlap",
-                expressions=[
-                    (
-                        TsTzRange("date_started", "date_ended", RangeBoundary()),
-                        RangeOperators.OVERLAPS,
-                    )
-                ],
-            ),
-        )
+
+        # This constraint is applied in the db but can't be represented in the model because Django
+        # doesn't support specifying the opsclass needed to use the bigint field (group_id) in the constraint.
+        # constraints = (
+        #     ExclusionConstraint(
+        #         name="exclude_open_period_overlap",
+        #         expressions=[
+        #             (models.F("group"), RangeOperators.EQUAL),
+        #             (
+        #                 TsTzRange("date_started", "date_ended", RangeBoundary()),
+        #                 RangeOperators.OVERLAPS,
+        #             ),
+        #         ],
+        #     ),
+        # )
 
     __repr__ = sane_repr("project_id", "group_id", "date_started", "date_ended", "user_id")