feat: Allow superadmins to transfer project ownership (#229)

* Allow superadmins to change project ownership permission --------- Co-authored-by: mgonnav <[email protected]>
bitmakerla · Oct 23, 2024 · 5da817d · 5da817d
1 parent 44ad862
commit 5da817d
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 24 deletions.
diff --git a/estela-api/api/serializers/auth.py b/estela-api/api/serializers/auth.py
@@ -73,7 +73,8 @@ class UserProfileSerializer(serializers.HyperlinkedModelSerializer):
 
     class Meta:
         model = User
-        fields = ["username", "email", "password"]
+        fields = ["username", "email", "password", "is_superuser"]
+        read_only_fields = ["is_superuser"]
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

diff --git a/estela-api/api/serializers/project.py b/estela-api/api/serializers/project.py
@@ -121,6 +121,7 @@ class ProjectUpdateSerializer(serializers.ModelSerializer):
         ("ADMIN", "Admin"),
         ("DEVELOPER", "Developer"),
         ("VIEWER", "Viewer"),
+        ("OWNER", "Owner")
     ]
     pid = serializers.UUIDField(
         read_only=True, help_text="A UUID identifying this project."

diff --git a/estela-api/api/views/project.py b/estela-api/api/views/project.py
@@ -151,6 +151,19 @@ def update(self, request, *args, **kwargs):
                 instance.users.remove(affected_user)
                 description = f"removed user {user_email}."
             elif action == "update":
+                if permission == Permission.OWNER_PERMISSION:
+                    if not is_superuser:
+                        raise PermissionDenied(
+                            {"permission": "You do not have permission to do this."}
+                        )
+                    old_owner = instance.users.filter(
+                        permission__permission=Permission.OWNER_PERMISSION
+                    ).get()
+                    instance.users.remove(old_owner)
+                    instance.users.add(
+                        old_owner,
+                        through_defaults={"permission": Permission.ADMIN_PERMISSION},
+                    )
                 instance.users.remove(affected_user)
                 instance.users.add(
                     affected_user, through_defaults={"permission": permission}

diff --git a/estela-api/docs/api.yaml b/estela-api/docs/api.yaml
@@ -1709,6 +1709,12 @@ definitions:
         title: Password
         type: string
         minLength: 1
+      is_superuser:
+        title: Superuser status
+        description: Designates that this user has all permissions without explicitly
+          assigning them.
+        type: boolean
+        readOnly: true
   User:
     required:
       - username
@@ -1966,6 +1972,7 @@ definitions:
           - ADMIN
           - DEVELOPER
           - VIEWER
+          - OWNER
       data_status:
         title: Data status
         description: New data status.

diff --git a/estela-web/src/pages/ProjectMemberPage/index.tsx b/estela-web/src/pages/ProjectMemberPage/index.tsx
@@ -40,6 +40,7 @@ interface ProjectMemberPageState {
     newUser: string;
     members: MemberState[];
     permission: ProjectUpdatePermissionEnum;
+    changeRolePermissions: ProjectUpdatePermissionEnum[];
 }
 
 interface RouteParams {
@@ -58,6 +59,11 @@ export class ProjectMemberPage extends Component<RouteComponentProps<RouteParams
         newUser: "",
         permission: ProjectUpdatePermissionEnum.Viewer,
         members: [],
+        changeRolePermissions: [
+            ProjectUpdatePermissionEnum.Admin,
+            ProjectUpdatePermissionEnum.Developer,
+            ProjectUpdatePermissionEnum.Viewer,
+        ],
     };
     apiService = ApiService();
     projectId: string = this.props.match.params.projectId;
@@ -90,6 +96,23 @@ export class ProjectMemberPage extends Component<RouteComponentProps<RouteParams
         },
     ];
 
+    verifyIsSuperuser = (): void => {
+        const requestParams = { username: AuthService.getUserUsername() || "" };
+        this.apiService.apiAuthProfileRead(requestParams).then(
+            (response) => {
+                this.setState({
+                    changeRolePermissions:
+                        response.isSuperuser === true
+                            ? [...this.state.changeRolePermissions, ProjectUpdatePermissionEnum.Owner]
+                            : [...this.state.changeRolePermissions],
+                });
+            },
+            (error: unknown) => {
+                error;
+            },
+        );
+    };
+
     updateInfo = (): void => {
         const requestParams: ApiProjectsReadRequest = { pid: this.projectId };
         this.apiService.apiProjectsRead(requestParams).then(
@@ -117,6 +140,7 @@ export class ProjectMemberPage extends Component<RouteComponentProps<RouteParams
     };
 
     async componentDidMount(): Promise<void> {
+        this.verifyIsSuperuser();
         this.updateInfo();
     }
 
@@ -324,27 +348,15 @@ export class ProjectMemberPage extends Component<RouteComponentProps<RouteParams
                                             defaultValue={ProjectUpdatePermissionEnum.Viewer}
                                             onChange={this.handleSelectChange}
                                         >
-                                            <Option
-                                                key={1}
-                                                className="hover:bg-button-hover hover:text-estela"
-                                                value={ProjectUpdatePermissionEnum.Admin}
-                                            >
-                                                Admin
-                                            </Option>
-                                            <Option
-                                                key={2}
-                                                className="hover:bg-button-hover hover:text-estela"
-                                                value={ProjectUpdatePermissionEnum.Developer}
-                                            >
-                                                Developer
-                                            </Option>
-                                            <Option
-                                                key={3}
-                                                className="hover:bg-button-hover hover:text-estela"
-                                                value={ProjectUpdatePermissionEnum.Viewer}
-                                            >
-                                                Viewer
-                                            </Option>
+                                            {this.state.changeRolePermissions.map((permission, index) => (
+                                                <Option
+                                                    key={index}
+                                                    className="hover:bg-button-hover hover:text-estela"
+                                                    value={permission}
+                                                >
+                                                    {permission[0] + permission.slice(1).toLowerCase()}
+                                                </Option>
+                                            ))}
                                         </Select>
                                         <Row className="mt-6 w-full grid grid-cols-2" justify="center">
                                             <Button

diff --git a/estela-web/src/services/api/generated-api/models/ProjectUpdate.ts b/estela-web/src/services/api/generated-api/models/ProjectUpdate.ts
@@ -114,7 +114,8 @@ export enum ProjectUpdateFrameworkEnum {
 export enum ProjectUpdatePermissionEnum {
     Admin = 'ADMIN',
     Developer = 'DEVELOPER',
-    Viewer = 'VIEWER'
+    Viewer = 'VIEWER',
+    Owner = 'OWNER'
 }/**
 * @export
 * @enum {string}

diff --git a/estela-web/src/services/api/generated-api/models/UserProfile.ts b/estela-web/src/services/api/generated-api/models/UserProfile.ts
@@ -37,6 +37,12 @@ export interface UserProfile {
      * @memberof UserProfile
      */
     password: string;
+    /**
+     * Designates that this user has all permissions without explicitly assigning them.
+     * @type {boolean}
+     * @memberof UserProfile
+     */
+    readonly isSuperuser?: boolean;
 }
 
 export function UserProfileFromJSON(json: any): UserProfile {
@@ -52,6 +58,7 @@ export function UserProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'username': json['username'],
         'email': json['email'],
         'password': json['password'],
+        'isSuperuser': !exists(json, 'is_superuser') ? undefined : json['is_superuser'],
     };
 }
 

diff --git a/queueing/Dockerfile b/queueing/Dockerfile
@@ -1,5 +1,5 @@
 # Build Stage
-FROM python:3.9-slim as builder
+FROM python:3.9-slim AS builder
 
 ENV PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1