Use exceptions for handling workspace add error

This stops using the boolean and instead will raise exceptions if
there's an issue adding a workspace. This will help us differentiate if
the operation failed due to a name already being taken, or the name
having invalid characters.

Signed-off-by: Juan Antonio Osorio <[email protected]>

Author: JAORMX

src/codegate/api/v1.py

@@ -3,6 +3,7 @@
 from fastapi.routing import APIRoute
 
 from codegate.api import v1_models
+from codegate.db.connection import AlreadyExistsError
 from codegate.workspaces.crud import WorkspaceCrud
 
 v1 = APIRouter()
@@ -52,13 +53,13 @@ async def activate_workspace(request: v1_models.ActivateWorkspaceRequest, status
 async def create_workspace(request: v1_models.CreateWorkspaceRequest):
     """Create a new workspace."""
     # Input validation is done in the model
-    created = await wscrud.add_workspace(request.name)
+    try:
+        created = await wscrud.add_workspace(request.name)
+    except AlreadyExistsError:
+        raise HTTPException(status_code=409, detail="Workspace already exists")
 
-    # TODO: refactor to use a more specific exception
-    if not created:
-        raise HTTPException(status_code=400, detail="Failed to create workspace")
-
-    return v1_models.Workspace(name=request.name)
+    if created:
+        return v1_models.Workspace(name=created.name)
 
 
 @v1.delete(

src/codegate/db/connection.py

@@ -7,10 +7,11 @@
 import structlog
 from alembic import command as alembic_command
 from alembic.config import Config as AlembicConfig
-from pydantic import BaseModel, ValidationError
+from pydantic import BaseModel
 from sqlalchemy import CursorResult, TextClause, text
 from sqlalchemy.exc import OperationalError
 from sqlalchemy.ext.asyncio import create_async_engine
+from sqlite3 import IntegrityError
 
 from codegate.db.fim_cache import FimCache
 from codegate.db.models import (
@@ -30,6 +31,8 @@
 alert_queue = asyncio.Queue()
 fim_cache = FimCache()
 
+class AlreadyExistsError(Exception):
+    pass
 
 class DbCodeGate:
     _instance = None
@@ -243,11 +246,14 @@ async def record_context(self, context: Optional[PipelineContext]) -> None:
             logger.error(f"Failed to record context: {context}.", error=str(e))
 
     async def add_workspace(self, workspace_name: str) -> Optional[Workspace]:
-        try:
-            workspace = Workspace(id=str(uuid.uuid4()), name=workspace_name)
-        except ValidationError as e:
-            logger.error(f"Failed to create workspace with name: {workspace_name}: {str(e)}")
-            return None
+        """Add a new workspace to the DB.
+
+        This handles validation and insertion of a new workspace.
+
+        It may raise a ValidationError if the workspace name is invalid.
+        or a AlreadyExistsError if the workspace already exists.
+        """
+        workspace = Workspace(id=str(uuid.uuid4()), name=workspace_name)
 
         sql = text(
             """
@@ -256,12 +262,12 @@ async def add_workspace(self, workspace_name: str) -> Optional[Workspace]:
             RETURNING *
             """
         )
+
         try:
             added_workspace = await self._execute_update_pydantic_model(workspace, sql)
-        except Exception as e:
+        except IntegrityError as e:
             logger.error(f"Failed to add workspace: {workspace_name}.", error=str(e))
-            return None
-
+            raise AlreadyExistsError(f"Workspace {workspace_name} already exists.")
         return added_workspace
 
     async def update_session(self, session: Session) -> Optional[Session]:

src/codegate/pipeline/cli/commands.py

@@ -1,7 +1,9 @@
 from abc import ABC, abstractmethod
+from pydantic import ValidationError
 from typing import List
 
 from codegate import __version__
+from codegate.db.connection import AlreadyExistsError
 from codegate.workspaces.crud import WorkspaceCrud
 
 
@@ -69,14 +71,14 @@ async def _add_workspace(self, args: List[str]) -> str:
         if not new_workspace_name:
             return "Please provide a name. Use `codegate workspace add your_workspace_name`"
 
-        workspace_created = await self.workspace_crud.add_workspace(new_workspace_name)
-        if not workspace_created:
-            return (
-                "Something went wrong. Workspace could not be added.\n"
-                "1. Check if the name is alphanumeric and only contains dashes, and underscores.\n"
-                "2. Check if the workspace already exists."
-            )
-        return f"Workspace **{new_workspace_name}** has been added"
+        try:
+            workspace_created = await self.workspace_crud.add_workspace(new_workspace_name)
+        except ValidationError as e:
+            return f"Invalid workspace name: {e}"
+        except AlreadyExistsError as e:
+            return f"Workspace **{new_workspace_name}** already exists"
+
+        return f"Workspace **{workspace_created.name}** has been added"
 
     async def _activate_workspace(self, args: List[str]) -> str:
         """

src/codegate/workspaces/crud.py

@@ -5,12 +5,15 @@
 from codegate.db.models import Session, Workspace, WorkspaceActive, ActiveWorkspace
 
 
+class WorkspaceCrudError(Exception):
+    pass
+
 class WorkspaceCrud:
 
     def __init__(self):
         self._db_reader = DbReader()
 
-    async def add_workspace(self, new_workspace_name: str) -> bool:
+    async def add_workspace(self, new_workspace_name: str) -> Workspace:
         """
         Add a workspace
 
@@ -19,7 +22,7 @@ async def add_workspace(self, new_workspace_name: str) -> bool:
         """
         db_recorder = DbRecorder()
         workspace_created = await db_recorder.add_workspace(new_workspace_name)
-        return bool(workspace_created)
+        return workspace_created
 
     async def get_workspaces(self)-> List[WorkspaceActive]:
         """