Unverified Commit 2dc7eccf authored by Marius van den Beek's avatar Marius van den Beek Committed by GitHub
Browse files

Merge pull request #18105 from mvdbeek/make_purge_query_parameter 

[23.2] Allow purge query param, deprecate purge body param
parents a7af3526 40b31516

client/src/api/schema/schema.ts

+8 −2
Original line number Diff line number Diff line
@@ -9576,9 +9576,11 @@ export interface components { 
        UserDeletionPayload: {

            /**

             * Purge user

             * @description Purge the user

             * @deprecated

             * @description Purge the user. Deprecated, please use the `purge` query parameter instead.

             * @default false

             */

            purge: boolean;

            purge?: boolean;

        };

        /** UserEmail */

        UserEmail: {
@@ -18633,6 +18635,10 @@ export interface operations { 
    delete_user_api_users__user_id__delete: {

        /** Delete a user. Only admins can delete others or purge users. */

        parameters: {

            /** @description Whether to definitely remove this user. Only deleted users can be purged. */

            query?: {

                purge?: boolean;

            };

            /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */

            header?: {

                "run-as"?: string;

lib/galaxy/managers/users.py

+4 −3
Original line number Diff line number Diff line
@@ -227,6 +227,7 @@ class UserManager(base.ModelManager, deletable.PurgableManagerMixin): 
            if self.app.config.redact_email_during_deletion:

                role.name = role.name.replace(user.email, email_hash)

                role.description = role.description.replace(user.email, email_hash)

            self.session().add(role)

        private_role.name = email_hash

        private_role.description = f"Private Role for {email_hash}"

        self.session().add(private_role)

lib/galaxy/schema/schema.py

+6 −1
Original line number Diff line number Diff line
@@ -351,7 +351,12 @@ class RemoteUserCreationPayload(Model): 




class UserDeletionPayload(Model):

    purge: bool = Field(default=Required, title="Purge user", description="Purge the user")

    purge: bool = Field(

        default=False,

        title="Purge user",

        description="Purge the user. Deprecated, please use the `purge` query parameter instead.",

        deprecated=True,

    )





class FavoriteObject(Model):

lib/galaxy/tool_util/verify/interactor.py

+2 −2
Original line number Diff line number Diff line
@@ -938,10 +938,10 @@ class GalaxyInteractorApi: 
        kwd["timeout"] = kwd.pop("timeout", util.DEFAULT_SOCKET_TIMEOUT)

        return requests.post(url, **kwd)



    def _delete(self, path, data=None, key=None, headers=None, admin=False, anon=False, json=False):

    def _delete(self, path, data=None, key=None, headers=None, admin=False, anon=False, json=False, params=None):

        headers = self.api_key_header(key=key, admin=admin, anon=anon, headers=headers)

        url = self.get_api_url(path)

        kwd = self._prepare_request_params(data=data, as_json=json, headers=headers)

        kwd = self._prepare_request_params(data=data, as_json=json, params=params, headers=headers)

        kwd["timeout"] = kwd.pop("timeout", util.DEFAULT_SOCKET_TIMEOUT)

        return requests.delete(url, **kwd)

lib/galaxy/webapps/galaxy/api/users.py

+10 −6
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ from fastapi import ( 
)

from markupsafe import escape

from pydantic import Required

from typing_extensions import Annotated



from galaxy import (

    exceptions,
@@ -135,7 +136,6 @@ RecalculateDiskUsageResponseDescriptions = { 
    },

}



UserDeletionBody = Body(default=None, title="Purge user", description="Purge the user.")

UserUpdateBody = Body(default=Required, title="Update user", description="The user values to update.")

FavoriteObjectBody = Body(

    default=Required, title="Set favorite", description="The id of an object the user wants to favorite."
@@ -656,13 +656,17 @@ class FastAPIUsers: 
        self,

        trans: ProvidesUserContext = DependsOnTrans,

        user_id: DecodedDatabaseIdField = UserIdPathParamQueryParam,

        payload: Optional[UserDeletionPayload] = UserDeletionBody,

        purge: Annotated[

            bool,

            Query(

                title="Purge user",

                description="Whether to definitely remove this user. Only deleted users can be purged.",

            ),

        ] = False,

        payload: Optional[UserDeletionPayload] = None,

    ) -> DetailedUserModel:

        user_to_update = self.service.user_manager.by_id(user_id)

        if payload:

            purge = payload.purge

        else:

            purge = False

        purge = payload and payload.purge or purge

        if trans.user_is_admin:

            if purge:

                log.debug("Purging user %s", user_to_update)