feat(github-growth): manually cascade delete after hiding repo (#53018)

Author: cathteng

src/sentry/api/endpoints/organization_repository_details.py

@@ -12,6 +12,7 @@
 from sentry.constants import ObjectStatus
 from sentry.models import Commit, Integration, Repository, ScheduledDeletion
 from sentry.services.hybrid_cloud import coerce_id_from
+from sentry.tasks.repository import repository_cascade_delete_on_hide
 
 
 class RepositorySerializer(serializers.Serializer):
@@ -89,6 +90,8 @@ def put(self, request: Request, organization, repo_id) -> Response:
                 ):
                     repo.reset_pending_deletion_field_names()
                     repo.delete_pending_deletion_option()
+                elif repo.status == ObjectStatus.HIDDEN and old_status != repo.status:
+                    repository_cascade_delete_on_hide.apply_async(kwargs={"repo_id": repo.id})
 
         return Response(serialize(repo, request.user))
 

src/sentry/deletions/base.py

@@ -8,6 +8,27 @@
 _leaf_re = re.compile(r"^(UserReport|Event|Group)(.+)")
 
 
+def _delete_children(manager, relations, transaction_id=None, actor_id=None):
+    # Ideally this runs through the deletion manager
+    for relation in relations:
+        task = manager.get(
+            transaction_id=transaction_id,
+            actor_id=actor_id,
+            task=relation.task,
+            **relation.params,
+        )
+
+        # If we want smaller tasks then this also has to return when has_more is true.
+        # This could significant increase the number of tasks we spawn. Get better estimates
+        # by collecting metrics.
+        has_more = True
+        while has_more:
+            has_more = task.chunk()
+            if has_more:
+                metrics.incr("deletions.should_spawn", tags={"task": type(task).__name__})
+    return False
+
+
 class BaseRelation:
     def __init__(self, params, task):
         self.task = task
@@ -126,24 +147,7 @@ def delete_instance_bulk(self, instance_list):
             self.delete_instance(instance)
 
     def delete_children(self, relations):
-        # Ideally this runs through the deletion manager
-        for relation in relations:
-            task = self.manager.get(
-                transaction_id=self.transaction_id,
-                actor_id=self.actor_id,
-                task=relation.task,
-                **relation.params,
-            )
-
-            # If we want smaller tasks then this also has to return when has_more is true.
-            # This could significant increase the number of tasks we spawn. Get better estimates
-            # by collecting metrics.
-            has_more = True
-            while has_more:
-                has_more = task.chunk()
-                if has_more:
-                    metrics.incr("deletions.should_spawn", tags={"task": type(task).__name__})
-        return False
+        return _delete_children(self.manager, relations, self.transaction_id, self.actor_id)
 
     def mark_deletion_in_progress(self, instance_list):
         pass

src/sentry/deletions/defaults/repository.py

@@ -4,6 +4,16 @@
 from ..base import ModelDeletionTask, ModelRelation
 
 
+def _get_repository_child_relations(instance):
+    from sentry.models import Commit, PullRequest, RepositoryProjectPathConfig
+
+    return [
+        ModelRelation(Commit, {"repository_id": instance.id}),
+        ModelRelation(PullRequest, {"repository_id": instance.id}),
+        ModelRelation(RepositoryProjectPathConfig, {"repository_id": instance.id}),
+    ]
+
+
 class RepositoryDeletionTask(ModelDeletionTask):
     def should_proceed(self, instance):
         """
@@ -12,13 +22,7 @@ def should_proceed(self, instance):
         return instance.status in {ObjectStatus.PENDING_DELETION, ObjectStatus.DELETION_IN_PROGRESS}
 
     def get_child_relations(self, instance):
-        from sentry.models import Commit, PullRequest, RepositoryProjectPathConfig
-
-        return [
-            ModelRelation(Commit, {"repository_id": instance.id}),
-            ModelRelation(PullRequest, {"repository_id": instance.id}),
-            ModelRelation(RepositoryProjectPathConfig, {"repository_id": instance.id}),
-        ]
+        return _get_repository_child_relations(instance)
 
     def delete_instance(self, instance):
         # TODO child_relations should also send pending_delete so we

src/sentry/tasks/repository.py

@@ -0,0 +1,31 @@
+from sentry.deletions import default_manager
+from sentry.deletions.base import _delete_children
+from sentry.deletions.defaults.repository import _get_repository_child_relations
+from sentry.models.repository import Repository
+from sentry.tasks.base import instrumented_task
+
+
+@instrumented_task(name="sentry.models.repository_cascade_delete_on_hide", acks_late=True)
+def repository_cascade_delete_on_hide(repo_id: int) -> None:
+    # Manually cause a deletion cascade.
+    # This should be called after setting a repo's status
+    # to ObjectStatus.HIDDEN.
+    # References RepositoryDeletionTask and BaseDeletionTask logic.
+
+    try:
+        repo = Repository.objects.get(id=repo_id)
+    except Repository.DoesNotExist:
+        return
+
+    has_more = True
+
+    while has_more:
+        # get child relations
+        child_relations = _get_repository_child_relations(repo)
+        # extend relations
+        child_relations = child_relations + [
+            rel(repo) for rel in default_manager.dependencies[Repository]
+        ]
+        # no need to filter relations; delete them
+        if child_relations:
+            has_more = _delete_children(manager=default_manager, relations=child_relations)

tests/sentry/api/endpoints/test_organization_repository_details.py

@@ -267,6 +267,25 @@ def test_put_hide_repo(self):
         repo = Repository.objects.get(id=repo.id)
         assert repo.status == ObjectStatus.HIDDEN
 
+    def test_put_hide_repo_with_commits(self):
+        self.login_as(user=self.user)
+
+        org = self.create_organization(owner=self.user, name="baz")
+        repo = Repository.objects.create(
+            name="example", organization_id=org.id, external_id="abc123"
+        )
+        Commit.objects.create(repository_id=repo.id, key="a" * 40, organization_id=org.id)
+
+        url = reverse("sentry-api-0-organization-repository-details", args=[org.slug, repo.id])
+
+        with self.tasks():
+            response = self.client.put(url, data={"status": "hidden"})
+            assert response.status_code == 200
+
+        repo = Repository.objects.get(id=repo.id)
+        assert repo.status == ObjectStatus.HIDDEN
+        assert len(Commit.objects.filter(repository_id=repo.id)) == 0
+
     def test_put_cancel_deletion_duplicate_exists(self):
         self.login_as(user=self.user)