Unverified Commit 10303060 authored by mvdbeek's avatar mvdbeek
Browse files

Support stop_job param in query string 

Fixes jobs not stopping in user interface when all outputs are deleted.
parent e2e223a8

lib/galaxy/webapps/galaxy/api/history_contents.py

+7 −0
Original line number Diff line number Diff line
@@ -713,6 +713,12 @@ class FastAPIHistoryContents: 
            description="When deleting a dataset collection, whether to also delete containing datasets.",

            deprecated=True,

        ),

        stop_job: Optional[bool] = Query(

            default=False,

            title="Stop Job",

            description="Whether to stop the creating job if all outputs of the job have been deleted.",

            deprecated=True,

        ),

        payload: DeleteHistoryContentPayload = Body(None),

    ):

        """
@@ -725,6 +731,7 @@ class FastAPIHistoryContents: 
            payload = DeleteHistoryContentPayload()

        payload.purge = payload.purge or purge is True

        payload.recursive = payload.recursive or recursive is True

        payload.stop_job = payload.stop_job or stop_job is True

        rval = self.service.delete(

            trans,

            id=id,

lib/galaxy_test/api/test_datasets.py

+10 −1
Original line number Diff line number Diff line
@@ -338,6 +338,13 @@ class DatasetsApiTestCase(ApiTestCase): 


    @skip_without_tool("cat_data_and_sleep")

    def test_delete_cancels_job(self):

        self._run_cancel_job(use_query_params=False)



    @skip_without_tool("cat_data_and_sleep")

    def test_delete_cancels_job_with_query_params(self):

        self._run_cancel_job(use_query_params=True)



    def _run_cancel_job(self, use_query_params=False):

        hda_id = self.dataset_populator.new_dataset(self.history_id)["id"]

        inputs = {

            "input1": {"src": "hda", "id": hda_id},
@@ -355,7 +362,9 @@ class DatasetsApiTestCase(ApiTestCase): 
        assert job_details["state"] in ("new", "queued", "running"), job_details



        # Use stop_job to cancel the creating job

        delete_response = self.dataset_populator.delete_dataset(self.history_id, output_hda_id, stop_job=True)

        delete_response = self.dataset_populator.delete_dataset(

            self.history_id, output_hda_id, stop_job=True, use_query_params=use_query_params

        )

        self._assert_status_code_is_ok(delete_response)

        deleted_hda = delete_response.json()

        assert deleted_hda["deleted"], deleted_hda

lib/galaxy_test/base/populators.py

+5 −1
Original line number Diff line number Diff line
@@ -597,8 +597,12 @@ class BaseDatasetPopulator(BasePopulator): 
        purge: bool = False,

        stop_job: bool = False,

        wait_for_purge: bool = False,

        use_query_params: bool = False,

    ) -> Response:

        dataset_url = f"histories/{history_id}/contents/{content_id}"

        if use_query_params:

            delete_response = self._delete(f"{dataset_url}?purge={purge}&stop_job={stop_job}")

        else:

            delete_response = self._delete(dataset_url, {"purge": purge, "stop_job": stop_job}, json=True)

        delete_response.raise_for_status()

        if wait_for_purge and delete_response.status_code == 202: