Implement basic soft deletion for workspaces

JAORMX · JAORMX · commit b40cef7e8832 · 2025-01-20T15:46:51.000+02:00
this adds a `deleted_at` column to workspaces that implements a basic
soft-deletion mechanism. All relevant queries have been modified to reflect this.

At the moment, there is no hard deletion of workspaces; this will be
implemented in the future.

We also have no way of showing "archived" or "soft-deleted" workspaces.
This will come in due time.

Signed-off-by: Juan Antonio Osorio &lt;ozz@stacklok.com&gt;
diff --git a/migrations/versions/8e4b4b8d1a88_add_soft_delete.py b/migrations/versions/8e4b4b8d1a88_add_soft_delete.py
@@ -0,0 +1,30 @@
+"""add soft delete
+
+Revision ID: 8e4b4b8d1a88
+Revises: 5c2f3eee5f90
+Create Date: 2025-01-20 14:08:40.851647
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "8e4b4b8d1a88"
+down_revision: Union[str, None] = "5c2f3eee5f90"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.execute(
+        """
+        ALTER TABLE workspaces
+        ADD COLUMN deleted_at DATETIME DEFAULT NULL;
+        """
+    )
+
+
+def downgrade() -> None:
+    op.execute("ALTER TABLE workspaces DROP COLUMN deleted_at;")
diff --git a/src/codegate/api/v1.py b/src/codegate/api/v1.py
@@ -79,8 +79,14 @@ async def create_workspace(request: v1_models.CreateWorkspaceRequest) -> v1_mode
     "/workspaces/{workspace_name}",
     tags=["Workspaces"],
     generate_unique_id_function=uniq_name,
-    status_code=204,
 )
 async def delete_workspace(workspace_name: str):
     """Delete a workspace by name."""
-    raise NotImplementedError
+    try:
+        _ = await wscrud.soft_delete_workspace(workspace_name)
+    except crud.WorkspaceDoesNotExistError:
+        return HTTPException(status_code=404, detail="Workspace does not exist")
+    except Exception:
+        return HTTPException(status_code=500, detail="Internal server error")
+
+    return Response(status_code=204)
diff --git a/src/codegate/db/connection.py b/src/codegate/db/connection.py
@@ -290,6 +290,20 @@ async def update_session(self, session: Session) -> Optional[Session]:
         active_session = await self._execute_update_pydantic_model(session, sql, should_raise=True)
         return active_session
 
+    async def soft_delete_workspace(self, workspace: Workspace) -> Optional[Workspace]:
+        sql = text(
+            """
+            UPDATE workspaces
+            SET deleted_at = CURRENT_TIMESTAMP
+            WHERE id = :id
+            RETURNING *
+            """
+        )
+        deleted_workspace = await self._execute_update_pydantic_model(
+            workspace, sql, should_raise=True
+        )
+        return deleted_workspace
+
 
 class DbReader(DbCodeGate):
 
@@ -387,18 +401,19 @@ async def get_workspaces(self) -> List[WorkspaceActive]:
                 w.id, w.name, s.active_workspace_id
             FROM workspaces w
             LEFT JOIN sessions s ON w.id = s.active_workspace_id
+            WHERE w.deleted_at IS NULL
             """
         )
         workspaces = await self._execute_select_pydantic_model(WorkspaceActive, sql)
         return workspaces
 
-    async def get_workspace_by_name(self, name: str) -> List[Workspace]:
+    async def get_workspace_by_name(self, name: str) -> Workspace:
         sql = text(
             """
             SELECT
                 id, name
             FROM workspaces
-            WHERE name = :name
+            WHERE name = :name AND deleted_at IS NULL
             """
         )
         conditions = {"name": name}
diff --git a/src/codegate/pipeline/cli/commands.py b/src/codegate/pipeline/cli/commands.py
@@ -46,6 +46,7 @@ def __init__(self):
             "list": self._list_workspaces,
             "add": self._add_workspace,
             "activate": self._activate_workspace,
+            "remove": self._remove_workspace,
         }
 
     async def _list_workspaces(self, *args: List[str]) -> str:
@@ -104,6 +105,25 @@ async def _activate_workspace(self, args: List[str]) -> str:
             return "An error occurred while activating the workspace"
         return f"Workspace **{workspace_name}** has been activated"
 
+    async def _remove_workspace(self, args: List[str]) -> str:
+        """
+        Remove a workspace
+        """
+        if args is None or len(args) == 0:
+            return "Please provide a name. Use `codegate workspace remove workspace_name`"
+
+        workspace_name = args[0]
+        if not workspace_name:
+            return "Please provide a name. Use `codegate workspace remove workspace_name`"
+
+        try:
+            await self.workspace_crud.soft_delete_workspace(workspace_name)
+        except crud.WorkspaceDoesNotExistError:
+            return f"Workspace **{workspace_name}** does not exist"
+        except Exception:
+            return "An error occurred while removing the workspace"
+        return f"Workspace **{workspace_name}** has been removed"
+
     async def run(self, args: List[str]) -> str:
         if not args:
             return "Please provide a command. Use `codegate workspace -h` to see available commands"
diff --git a/src/codegate/workspaces/crud.py b/src/codegate/workspaces/crud.py
@@ -1,6 +1,8 @@
 import datetime
 from typing import List, Optional, Tuple
 
+import structlog
+
 from codegate.db.connection import DbReader, DbRecorder
 from codegate.db.models import ActiveWorkspace, Session, Workspace, WorkspaceActive
 
@@ -68,10 +70,6 @@ async def _is_workspace_active(
     async def activate_workspace(self, workspace_name: str):
         """
         Activate a workspace
-
-        Will return:
-        - True if the workspace was activated
-        - False if the workspace is already active or does not exist
         """
         is_active, session, workspace = await self._is_workspace_active(workspace_name)
         if is_active:
@@ -82,3 +80,28 @@ async def activate_workspace(self, workspace_name: str):
         db_recorder = DbRecorder()
         await db_recorder.update_session(session)
         return
+
+    async def soft_delete_workspace(self, workspace_name: str):
+        """
+        Soft delete a workspace
+        """
+        if workspace_name == "":
+            raise WorkspaceCrudError("Workspace name cannot be empty.")
+        if workspace_name == "default":
+            raise WorkspaceCrudError("Cannot delete default workspace.")
+
+        selected_workspace = await self._db_reader.get_workspace_by_name(workspace_name)
+        if not selected_workspace:
+            raise WorkspaceDoesNotExistError(f"Workspace {workspace_name} does not exist.")
+
+        # Check if workspace is active, if it is, make the default workspace active
+        active_workspace = await self._db_reader.get_active_workspace()
+        if active_workspace and active_workspace.id == selected_workspace.id:
+            _ = await self.activate_workspace("default")
+
+        db_recorder = DbRecorder()
+        try:
+            _ = await db_recorder.soft_delete_workspace(selected_workspace)
+        except Exception as e:
+            raise WorkspaceCrudError(f"Error deleting workspace {workspace_name}")
+        return
