Browse Source

fix(github-comments): make PullRequestComment group_ids col an int array (#50874)

Cathy Teng 1 year ago
parent
commit
9a4adb092c

+ 1 - 1
migrations_lockfile.txt

@@ -6,5 +6,5 @@ To resolve this, rebase against latest master and regenerate your migration. Thi
 will then be regenerated, and you should be able to merge without conflicts.
 
 nodestore: 0002_nodestore_no_dictfield
-sentry: 0485_remove_scheduled_job
+sentry: 0486_integer_pr_comment_issue_list
 social_auth: 0001_initial

+ 39 - 0
src/sentry/migrations/0486_integer_pr_comment_issue_list.py

@@ -0,0 +1,39 @@
+# Generated by Django 2.2.28 on 2023-06-13 22:27
+
+import django.contrib.postgres.fields
+from django.db import migrations
+
+import sentry.db.models.fields.bounded
+from sentry.new_migrations.migrations import CheckedMigration
+
+
+class Migration(CheckedMigration):
+    # This flag is used to mark that a migration shouldn't be automatically run in production. For
+    # the most part, 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 dangerous:
+    # - Large data migrations. Typically we want these to be run manually by ops 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
+    #   have ops run this and not block the deploy. Note that while adding an index is a schema
+    #   change, it's completely safe to run the operation after the code has deployed.
+    is_dangerous = False
+    checked = False
+
+    dependencies = [
+        ("sentry", "0485_remove_scheduled_job"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="pullrequestcomment",
+            name="group_ids",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=sentry.db.models.fields.bounded.BoundedBigIntegerField(),
+                default=None,
+                size=None,
+            ),
+            preserve_default=False,
+        ),
+    ]

+ 2 - 2
src/sentry/models/pullrequest.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 from typing import Any, Mapping
 
+from django.contrib.postgres.fields import ArrayField as DjangoArrayField
 from django.db import models
 from django.db.models.signals import post_save
 from django.utils import timezone
 
 from sentry.db.models import (
-    ArrayField,
     BaseManager,
     BoundedBigIntegerField,
     BoundedPositiveIntegerField,
@@ -98,7 +98,7 @@ class PullRequestComment(Model):
     pull_request = FlexibleForeignKey("sentry.PullRequest", unique=True)
     created_at = models.DateTimeField()
     updated_at = models.DateTimeField()
-    group_ids = ArrayField()
+    group_ids = DjangoArrayField(BoundedBigIntegerField())
 
     class Meta:
         app_label = "sentry"

+ 1 - 1
tests/sentry/tasks/integrations/github/test_pr_comment.py

@@ -349,7 +349,7 @@ class TestCommentWorkflow(GithubCommentTestCase):
             == f'{{"body": "## Suspect Issues\\nThis pull request has been deployed and Sentry has observed the following issues:\\n\\n- \\u203c\\ufe0f **issue1** `issue1` [View Issue](http://testserver/organizations/foo/issues/{groups[0]}/)\\n- \\u203c\\ufe0f **issue2** `issue2` [View Issue](http://testserver/organizations/foobar/issues/{groups[1]}/)\\n\\n<sub>Did you find this useful? React with a \\ud83d\\udc4d or \\ud83d\\udc4e</sub>"}}'.encode()
         )
         pull_request_comment.refresh_from_db()
-        assert pull_request_comment.group_ids == [str(g.id) for g in Group.objects.all()]
+        assert pull_request_comment.group_ids == [g.id for g in Group.objects.all()]
         assert pull_request_comment.updated_at == timezone.now()
 
     @patch("sentry.tasks.integrations.github.pr_comment.get_top_5_issues_by_count")