Return async task result

Author: mvdbeek

client/src/api/schema/schema.ts

@@ -7463,6 +7463,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published: boolean;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.
@@ -7586,6 +7591,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published: boolean;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.
@@ -9974,6 +9984,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published?: boolean | null;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.
@@ -10213,6 +10228,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published?: boolean | null;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.
@@ -15492,6 +15512,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published: boolean;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.
@@ -15613,6 +15638,11 @@ export interface components {
              * @description Whether this resource is currently publicly available to all users.
              */
             published: boolean;
+            /**
+             * Purge Task
+             * @description Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.
+             */
+            purge_task?: components["schemas"]["AsyncTaskResultSummary"] | null;
             /**
              * Purged
              * @description Whether this item has been permanently removed.

lib/galaxy/celery/tasks.py

@@ -121,7 +121,7 @@ def purge_datasets(
     dataset_manager.purge_datasets(request)
 
 
-@galaxy_task(ignore_result=True, action="purge all datasets in a history")
+@galaxy_task(action="purge all datasets in a history")
 def purge_history_datasets(
     sa_session: galaxy_scoped_session,
     dataset_manager: DatasetManager,

lib/galaxy/managers/histories.py

@@ -298,14 +298,16 @@ def purge(self, item, flush=True, **kwargs):
 
             request = PurgeHistoryDatasetsTaskRequest(history_id=item.id)
             user = item.user
-            purge_history_datasets.delay(request=request, task_user_id=user.id if user else None)
+            result = purge_history_datasets.delay(request=request, task_user_id=user.id if user else None)
         else:
+            result = None
             for hda in item.datasets:
                 if not hda.purged:
                     self.hda_manager.purge(hda, flush=True, **kwargs)
 
         # Now mark the history as purged
         super().purge(item, flush=flush, **kwargs)
+        return result
 
     # .... current
     # TODO: make something to bypass the anon user + current history permissions issue

lib/galaxy/schema/schema.py

@@ -1435,6 +1435,11 @@ class HistorySummary(Model, WithModelClass):
     tags: TagCollection
     update_time: datetime = UpdateTimeField
     preferred_object_store_id: Optional[str] = PreferredObjectStoreIdField
+    purge_task: Optional["AsyncTaskResultSummary"] = Field(
+        None,
+        title="Purge Task",
+        description="Summary of the async task purging datasets in this history. Only present when purge is performed via a background task.",
+    )
 
 
 class HistoryActiveContentCounts(Model):
@@ -3997,6 +4002,13 @@ class AsyncTaskResultSummary(Model):
     )
 
 
+HistorySummary.model_rebuild()
+HistoryDetailed.model_rebuild()
+CustomHistoryView.model_rebuild()
+ArchivedHistorySummary.model_rebuild()
+ArchivedHistoryDetailed.model_rebuild()
+CustomArchivedHistoryView.model_rebuild()
+
 ToolRequestIdField = Field(title="ID", description="Encoded ID of the role")
 
 

lib/galaxy/webapps/galaxy/services/histories.py

@@ -454,10 +454,14 @@ def delete(
         """
         history = self.manager.get_mutable(history_id, trans.user, current_history=trans.history)
         if purge:
-            self.manager.purge(history)
+            result = self.manager.purge(history)
         else:
+            result = None
             self.manager.delete(history)
-        return self._serialize_history(trans, history, serialization_params)
+        rval = self._serialize_history(trans, history, serialization_params)
+        if result is not None:
+            rval["purge_task"] = async_task_summary(result)
+        return rval
 
     def undelete(
         self,

test/integration/test_purge_datasets.py

@@ -4,10 +4,7 @@
     Optional,
 )
 
-from galaxy_test.base.populators import (
-    DatasetPopulator,
-    wait_on,
-)
+from galaxy_test.base.populators import DatasetPopulator
 from galaxy_test.driver import integration_util
 
 
@@ -95,31 +92,30 @@ def test_purge_history_removes_underlying_datasets_from_disk(self):
         # Purge the entire history
         purge_response = self._delete(f"histories/{self.test_history_id}", data={"purge": True}, json=True)
         self._assert_status_code_is_ok(purge_response)
+        purge_result = purge_response.json()
 
         # Verify history is purged
-        history_response = self._get(f"histories/{self.test_history_id}").json()
-        assert history_response["purged"]
-        assert history_response["deleted"]
+        assert purge_result["purged"]
+        assert purge_result["deleted"]
+
+        # Verify the response contains a purge_task with an id
+        assert "purge_task" in purge_result
+        purge_task = purge_result["purge_task"]
+        assert "id" in purge_task
+        purge_task_id = purge_task["id"]
+
+        # Wait for the celery task to complete via the tasks API
+        self.dataset_populator.wait_on_task_id(purge_task_id)
 
-        # Verify HDAs are marked as purged
+        # After task completion, HDAs should be purged and files deleted
         self.dataset_populator.wait_for_purge(self.test_history_id, hda1_id)
         self.dataset_populator.wait_for_purge(self.test_history_id, hda2_id)
-
-        # Wait for underlying dataset files to be removed from disk.
-        # With batched history purging, HDAs are marked purged synchronously
-        # but the actual file deletion happens via a batched celery task.
-        self._wait_for_file_deleted(dataset_file1)
-        self._wait_for_file_deleted(dataset_file2)
+        assert not self._file_exists_on_disk(dataset_file1)
+        assert not self._file_exists_on_disk(dataset_file2)
 
     def _get_underlying_dataset_on_disk(self, hda_id: str) -> Optional[str]:
         detailed_response = self._get(f"datasets/{hda_id}", admin=True).json()
         return detailed_response.get("file_name")
 
     def _file_exists_on_disk(self, filename: Optional[str]) -> bool:
         return os.path.isfile(filename) if filename else False
-
-    def _wait_for_file_deleted(self, filename: Optional[str], timeout: int = 10):
-        def _check():
-            return True if not self._file_exists_on_disk(filename) else None
-
-        wait_on(_check, f"file {filename} to be deleted", timeout=timeout)