models: add attention set to patches

Patches that needs the attention of a specific user can now be linked to
them by the attention set field.

Attention flags by default are soft deleted.

Signed-off-by: andrepapoti <[email protected]>
Signed-off-by: Victor Accarini <[email protected]>

Author: andrepapoti

patchwork/migrations/0049_add_attention_set_to_patches.py

@@ -0,0 +1,61 @@
+# Generated by Django 5.1.7 on 2025-03-22 05:06
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('patchwork', '0048_series_dependencies'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PatchAttentionSet',
+            fields=[
+                (
+                    'id',
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name='ID',
+                    ),
+                ),
+                ('last_updated', models.DateTimeField(auto_now=True)),
+                ('removed', models.BooleanField(default=False)),
+                (
+                    'removed_reason',
+                    models.CharField(blank=True, max_length=50),
+                ),
+                (
+                    'patch',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to='patchwork.patch',
+                    ),
+                ),
+                (
+                    'user',
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                'unique_together': {('patch', 'user')},
+            },
+        ),
+        migrations.AddField(
+            model_name='patch',
+            name='attention_set',
+            field=models.ManyToManyField(
+                related_name='attention_set',
+                through='patchwork.PatchAttentionSet',
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+    ]

patchwork/models.py

@@ -503,6 +503,9 @@ class Patch(SubmissionMixin):
         null=True,
         on_delete=models.CASCADE,
     )
+    attention_set = models.ManyToManyField(
+        User, through='PatchAttentionSet', related_name='attention_set'
+    )
     state = models.ForeignKey(State, null=True, on_delete=models.CASCADE)
     archived = models.BooleanField(default=False)
     hash = HashField(null=True, blank=True, db_index=True)
@@ -827,6 +830,104 @@ class Meta:
         ]
 
 
+class PatchAttentionSetManager(models.Manager):
+    def get_queryset(self):
+        return super().get_queryset().filter(removed=False)
+
+    def upsert(self, patch, users):
+        """Add or updates deleted attention set entries
+
+        :param patch: patch object to be updated
+        :type patch: Patch
+        :param users: list of users to be added to the attention set list
+        :type users: list[int]
+        """
+        qs = super().get_queryset().filter(patch=patch)
+
+        existing = {
+            obj.user.id: obj for obj in qs.filter(user__in=users).all()
+        }
+        update_list = []
+        for obj in existing.values():
+            if obj.removed:
+                obj.removed = False
+                obj.removed_reason = ''
+                update_list.append(obj)
+        insert_list = [user for user in users if user not in existing.keys()]
+
+        qs.bulk_create(
+            [PatchAttentionSet(patch=patch, user_id=id) for id in insert_list]
+        )
+        qs.bulk_update(update_list, ['removed', 'removed_reason'])
+
+    def soft_delete(self, patch, users, reason=''):
+        """Mark attention set entries as deleted
+
+        :param patch: patch object to be updated
+        :type patch: Patch
+        :param users: list of users to be added to the attention set list
+        :type users: list[int]
+        :param reason: reason for removal
+        :type reason: string
+        """
+        qs = super().get_queryset().filter(patch=patch)
+
+        existing = {
+            obj.user.id: obj for obj in qs.filter(user__in=users).all()
+        }
+        update_list = []
+        for obj in existing.values():
+            if not obj.removed:
+                obj.removed = True
+                obj.removed_reason = reason
+                update_list.append(obj)
+
+        self.bulk_update(update_list, ['removed', 'removed_reason'])
+
+
+class PatchAttentionSet(models.Model):
+    patch = models.ForeignKey(Patch, on_delete=models.CASCADE)
+    user = models.ForeignKey(User, on_delete=models.CASCADE)
+    last_updated = models.DateTimeField(auto_now=True)
+    removed = models.BooleanField(default=False)
+    removed_reason = models.CharField(max_length=50, blank=True)
+
+    objects = PatchAttentionSetManager()
+    raw_objects = models.Manager()
+
+    def delete(self):
+        """Soft deletes an user from the patch attention set"""
+        self.removed = True
+        self.removed_reason = 'reviewed or commented on the patch'
+        self.save()
+
+    def __str__(self):
+        return f'<{self.user} - {self.user.email}>'
+
+    class Meta:
+        unique_together = [('patch', 'user')]
+
+
+def _remove_user_from_patch_attention_set(sender, instance, created, **kwargs):
+    if created:
+        submitter = instance.submitter
+        patch = instance.patch
+        if submitter.user:
+            try:
+                # Don't use the RelatedManager since it will execute a hard
+                # delete
+                PatchAttentionSet.objects.get(
+                    patch=patch, user=submitter.user
+                ).delete()
+            except PatchAttentionSet.DoesNotExist:
+                pass
+
+
+models.signals.post_save.connect(
+    _remove_user_from_patch_attention_set, sender=PatchComment
+)
+
+
 class Series(FilenameMixin, models.Model):
     """A collection of patches."""