Merge pull request #690 from jbernal0019/master

Implement async delete for PACS series, feeds, plugin instances and folders

Author: jbernal0019

chris_backend/core/celery.py

@@ -40,6 +40,10 @@
         {'queue': 'periodic'},
     'plugininstances.tasks.delete_plugin_instances_jobs_from_remote':
         {'queue': 'periodic'},
+    'plugininstances.tasks.delete_plugin_instance': {'queue': 'main2'},
+    'feeds.tasks.delete_feed': {'queue': 'main2'},
+    'filebrowser.tasks.delete_folder': {'queue': 'main2'},
+    'pacsfiles.tasks.delete_pacs_series': {'queue': 'main2'},
     'pacsfiles.tasks.send_pacs_query': {'queue': 'main2'},
     'pacsfiles.tasks.register_pacs_series': {'queue': 'main2'}
 }

chris_backend/core/migrations/0003_chrisfolder_deletion_error_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.9 on 2026-02-12 00:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0002_chrisfile_public_chrisfolder_public_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='chrisfolder',
+            name='deletion_error',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='chrisfolder',
+            name='deletion_requested_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='chrisfolder',
+            name='deletion_status',
+            field=models.CharField(choices=[('inactive', 'Inactive'), ('pending', 'Pending'), ('failed', 'Failed')], default='inactive', max_length=10),
+        ),
+    ]

chris_backend/core/models.py

@@ -7,6 +7,7 @@
 from django.db import models
 from django.db.models.functions import Length
 from django.db.models.signals import post_delete
+from django.utils import timezone
 from django.dispatch import receiver
 from django.conf import settings
 from django.contrib.auth.models import User, Group
@@ -35,6 +36,42 @@ def validate_permission(permission):
     return permission
 
 
+class AsyncDeletableModel(models.Model):
+    class DeletionStatus(models.TextChoices):
+        INACTIVE = 'inactive'
+        PENDING = 'pending'
+        FAILED = 'failed'
+
+    deletion_status = models.CharField(max_length=10, choices=DeletionStatus.choices,
+                                       default=DeletionStatus.INACTIVE)
+    deletion_requested_at = models.DateTimeField(null=True, blank=True)
+    deletion_error = models.TextField(blank=True)
+
+    class Meta:
+        abstract = True
+
+    def is_pending_deletion(self) -> bool:
+        return self.deletion_status == self.DeletionStatus.PENDING
+
+    def mark_deletion_pending(self) -> bool:
+        """
+        Returns True if deletion was scheduled by this call.
+        Returns False if it was already pending.
+        """
+        if self.is_pending_deletion():
+            return False
+
+        self.deletion_status = self.DeletionStatus.PENDING
+        self.deletion_requested_at = timezone.now()
+        self.save(update_fields=['deletion_status', 'deletion_requested_at'])
+        return True
+
+    def mark_deletion_failed(self, error: Exception | str):
+        self.deletion_status = self.DeletionStatus.FAILED
+        self.deletion_error = str(error)
+        self.save(update_fields=['deletion_status', 'deletion_error'])
+
+
 class ChrisInstance(models.Model):
     """
     Model class that defines a singleton representing a ChRIS instance.
@@ -71,7 +108,7 @@ def load(cls):
         return obj
 
 
-class ChrisFolder(models.Model):
+class ChrisFolder(AsyncDeletableModel):
     creation_date = models.DateTimeField(auto_now_add=True)
     path = models.CharField(max_length=1024, unique=True)  # folder's path
     public = models.BooleanField(blank=True, default=False, db_index=True)

chris_backend/feeds/migrations/0003_feed_deletion_error_feed_deletion_requested_at_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.2.9 on 2026-02-12 00:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('feeds', '0002_remove_feed_owner_feeduserpermission_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='feed',
+            name='deletion_error',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='feed',
+            name='deletion_requested_at',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='feed',
+            name='deletion_status',
+            field=models.CharField(choices=[('inactive', 'Inactive'), ('pending', 'Pending'), ('failed', 'Failed')], default='inactive', max_length=10),
+        ),
+    ]

chris_backend/feeds/models.py

@@ -8,13 +8,14 @@
 import django_filters
 from django_filters.rest_framework import FilterSet
 
-from core.models import (ChrisFolder, ChrisFile, ChrisLinkFile, FolderGroupPermission,
-                         FolderUserPermission, FileGroupPermission, FileUserPermission,
-                         LinkFileGroupPermission, LinkFileUserPermission)
+from core.models import (AsyncDeletableModel, ChrisFolder, ChrisFile, ChrisLinkFile,
+                         FolderGroupPermission, FolderUserPermission, FileGroupPermission,
+                         FileUserPermission, LinkFileGroupPermission,
+                         LinkFileUserPermission)
 from userfiles.models import UserFile
 
 
-class Feed(models.Model):
+class Feed(AsyncDeletableModel):
     creation_date = models.DateTimeField(auto_now_add=True)
     modification_date = models.DateTimeField(auto_now_add=True)
     name = models.CharField(max_length=200, blank=True, db_index=True)
@@ -197,7 +198,8 @@ class FeedFilter(FilterSet):
     class Meta:
         model = Feed
         fields = ['id', 'name', 'name_exact', 'name_startswith', 'min_id', 'max_id',
-                  'min_creation_date', 'max_creation_date', 'files_fname_icontains']
+                  'min_creation_date', 'max_creation_date', 'files_fname_icontains',
+                  'deletion_status']
 
     def filter_by_fname_icontains(self, queryset, name, value):
         """

chris_backend/feeds/serializers.py

@@ -118,7 +118,8 @@ class Meta:
         fields = ('url', 'id', 'creation_date', 'modification_date', 'name', 'public',
                   'owner_username', 'folder_path', 'created_jobs', 'waiting_jobs',
                   'scheduled_jobs', 'started_jobs', 'registering_jobs',
-                  'finished_jobs',  'errored_jobs', 'cancelled_jobs', 'folder', 'note',
+                  'finished_jobs',  'errored_jobs', 'cancelled_jobs', 'deletion_status',
+                  'deletion_requested_at', 'deletion_error', 'folder', 'note',
                   'group_permissions', 'user_permissions', 'tags', 'taggings',
                   'comments', 'plugin_instances', 'owner')
 

chris_backend/feeds/tasks.py

@@ -0,0 +1,27 @@
+
+import logging
+
+from celery import shared_task
+from .models import Feed
+
+
+logger = logging.getLogger(__name__)
+
+
+@shared_task(bind=True, autoretry_for=(Exception,), retry_kwargs={"max_retries": 3})
+def delete_feed(self, feed_id):
+    try:
+        feed = Feed.objects.get(id=feed_id)
+
+        if not feed.is_pending_deletion():
+            return # idempotent safety
+
+        feed.delete()
+    except Feed.DoesNotExist:
+        pass
+    except Exception as e:
+        Feed.objects.filter(id=feed_id).update(  # atomic update
+            deletion_status=Feed.DeletionStatus.FAILED,
+            deletion_error=str(e)
+        )
+        raise

chris_backend/feeds/tests/test_views.py

@@ -1,17 +1,24 @@
 
 import logging
 import json
+import time
+from unittest import mock
 
-from django.test import TestCase
+from django.test import TestCase, TransactionTestCase, tag
 from django.urls import reverse
 from django.contrib.auth.models import User, Group
 from django.conf import settings
 from rest_framework import status
 
+from celery.contrib.testing.worker import start_worker
+from core.celery import app as celery_app
+from core.celery import task_routes
+
 from plugins.models import PluginMeta, Plugin, ComputeResource
 from plugininstances.models import PluginInstance
 from feeds.models import (Note, Tag, Tagging, Feed, FeedGroupPermission,
                           FeedUserPermission, Comment)
+from feeds import views
 
 
 COMPUTE_RESOURCE_URL = settings.COMPUTE_RESOURCE_URL
@@ -79,7 +86,75 @@ def setUp(self):
     def tearDown(self):
         # re-enable logging
         logging.disable(logging.NOTSET)
-        
+
+
+class TasksViewTests(TransactionTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        logging.disable(logging.WARNING)
+        super().setUpClass()
+        # route tasks to this worker by using the default 'celery' queue
+        # that is exclusively used for the automated tests
+        celery_app.conf.update(task_routes=None)
+        cls.celery_worker = start_worker(celery_app,
+                                         concurrency=1,
+                                         perform_ping_check=False)
+        cls.celery_worker.__enter__()
+
+    @classmethod
+    def tearDownClass(cls):
+        super().tearDownClass()
+        cls.celery_worker.__exit__(None, None, None)
+        # reset routes to the original queues
+        celery_app.conf.update(task_routes=task_routes)
+        logging.disable(logging.NOTSET)
+
+    def setUp(self):
+        # create superuser chris (owner of root folders)
+        self.chris_username = 'chris'
+        self.chris_password = CHRIS_SUPERUSER_PASSWORD
+
+        self.content_type = 'application/vnd.collection+json'
+
+        self.username = 'foo'
+        self.password = 'foopass'
+        self.other_username = 'booo'
+        self.other_password = 'booopass'
+
+        self.plugin_name = "pacspull"
+        self.plugin_type = "fs"
+        self.plugin_parameters = {'mrn': {'type': 'string', 'optional': False},
+                                  'img_type': {'type': 'string', 'optional': True}}
+        self.feedname = "Feed1"
+
+        (self.compute_resource, tf) = ComputeResource.objects.get_or_create(
+            name="host", compute_url=COMPUTE_RESOURCE_URL)
+
+        # create users
+        other_user = User.objects.create_user(username=self.other_username,
+                                              password=self.other_password)
+        user = User.objects.create_user(username=self.username,
+                                        password=self.password)
+
+        # assign predefined group
+        all_grp = Group.objects.get(name='all_users')
+
+        other_user.groups.set([all_grp])
+        user.groups.set([all_grp])
+
+        # create plugin
+        (pl_meta, tf) = PluginMeta.objects.get_or_create(name='pacspull', type='fs')
+        (plugin, tf) = Plugin.objects.get_or_create(meta=pl_meta, version='0.1')
+        plugin.compute_resources.set([self.compute_resource])
+        plugin.save()
+
+        # create a feed by creating a "fs" plugin instance
+        pl_inst = PluginInstance.objects.create(plugin=plugin, owner=user, title='test',
+                                                compute_resource=
+                                                plugin.compute_resources.all()[0])
+        pl_inst.feed.name = self.feedname
+        pl_inst.feed.save()
 
 class NoteDetailViewTests(ViewTests):
     """
@@ -224,7 +299,7 @@ def test_feed_list_query_search_from_other_users_not_listed(self):
         self.assertNotContains(response, "Feed2")
 
 
-class FeedDetailViewTests(ViewTests):
+class FeedDetailViewTests(TasksViewTests):
     """
     Test the feed-detail view.
     """
@@ -274,8 +349,24 @@ def test_feed_update_failure_access_denied(self):
 
     def test_feed_delete_success(self):
         self.client.login(username=self.username, password=self.password)
+
+        with mock.patch.object(views.delete_feed, 'delay',
+                               return_value=None) as delay_mock:
+            response = self.client.delete(self.read_update_delete_url)
+            self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
+
+            # check that the delete_feed task was called with appropriate args
+            delay_mock.assert_called_with(response.data['id'])
+
+    @tag('integration')
+    def test_integration_feed_delete_success(self):
+        self.client.login(username=self.username, password=self.password)
         response = self.client.delete(self.read_update_delete_url)
-        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+        self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
+
+        for _ in range(10):
+            time.sleep(3)
+            if Feed.objects.count() == 0: break
         self.assertEqual(Feed.objects.count(), 0)
 
     def test_feed_delete_failure_unauthenticated(self):

chris_backend/feeds/views.py

@@ -1,7 +1,8 @@
 
 from django.db.models import Q
 from django.shortcuts import get_object_or_404
-from rest_framework import generics, permissions
+from rest_framework import generics, permissions, status
+from rest_framework.response import Response
 from rest_framework.reverse import reverse
 from drf_spectacular.utils import extend_schema, extend_schema_view
 
@@ -14,6 +15,7 @@
 from .serializers import (FeedSerializer, FeedGroupPermissionSerializer,
                           FeedUserPermissionSerializer, NoteSerializer,
                           TagSerializer, TaggingSerializer, CommentSerializer)
+from .tasks import delete_feed
 from .permissions import (
     IsChrisOrFeedOwnerOrHasFeedPermissionOrPublicFeedReadOnly, IsOwnerOrChrisOrReadOnly,
     IsOwnerOrChrisOrHasPermissionOrPublicReadOnly, IsOwnerOrChrisOrHasPermissionReadOnly,
@@ -389,6 +391,19 @@ def retrieve(self, request, *args, **kwargs):
         template_data = {"name": "", "public": ""}
         return services.append_collection_template(response, template_data)
 
+    def destroy(self, request, *args, **kwargs):
+        """
+        Overriden to asyncronously delete the feed and its folder/files from
+        storage.
+        """
+        instance = self.get_object()
+
+        if instance.mark_deletion_pending():
+            delete_feed.delay(instance.id)  # async task
+
+        serializer = self.get_serializer(instance)
+        return Response(serializer.data, status=status.HTTP_202_ACCEPTED)
+
 
 class PublicFeedList(generics.ListAPIView):
     """

chris_backend/filebrowser/serializers.py

@@ -33,6 +33,7 @@ class FileBrowserFolderSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = ChrisFolder
         fields = ('url', 'id', 'creation_date', 'path', 'public', 'owner_username',
+                  'deletion_status', 'deletion_requested_at', 'deletion_error',
                   'parent', 'children', 'files', 'link_files', 'group_permissions',
                   'user_permissions', 'owner')