Kick off provider endpoint CRUD structure

This structure will handle all the database operations and turn that
into the right models.

Note that for provider endpoints we already have a way of setting these
via configuration, so this is taken into account to output some sample
objects that users can leverage. We probably need to set some hardcoded
IDs sometime in the near future so we can reference these. But for now,
IDs for these are optional.

I also added a `source` field which allows us to tell where these
providers came from.

Signed-off-by: Juan Antonio Osorio <ozz@stacklok.com>

Author: JAORMX

src/codegate/api/v1.py

@@ -1,19 +1,23 @@
+from threading import Lock
 from typing import List, Optional
 
 import requests
 import structlog
-from fastapi import APIRouter, HTTPException, Response
+from fastapi import APIRouter, Depends, HTTPException, Response
 from fastapi.responses import StreamingResponse
 from fastapi.routing import APIRoute
 from pydantic import ValidationError
 
 from codegate import __version__
 from codegate.api import v1_models, v1_processing
 from codegate.db.connection import AlreadyExistsError, DbReader
+from codegate.providers import crud as provendcrud
 from codegate.workspaces import crud
 
 logger = structlog.get_logger("codegate")
 
+mtx = Lock()
+
 v1 = APIRouter()
 wscrud = crud.WorkspaceCrud()
 
@@ -26,26 +30,24 @@ def uniq_name(route: APIRoute):
 
 
 @v1.get("/provider-endpoints", tags=["Providers"], generate_unique_id_function=uniq_name)
-async def list_provider_endpoints(name: Optional[str] = None) -> List[v1_models.ProviderEndpoint]:
+async def list_provider_endpoints(
+    name: Optional[str] = None,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> List[v1_models.ProviderEndpoint]:
     """List all provider endpoints."""
-    # NOTE: This is a dummy implementation. In the future, we should have a proper
-    # implementation that fetches the provider endpoints from the database.
-    return [
-        v1_models.ProviderEndpoint(
-            id=1,
-            name="dummy",
-            description="Dummy provider endpoint",
-            endpoint="http://example.com",
-            provider_type=v1_models.ProviderType.openai,
-            auth_type=v1_models.ProviderAuthType.none,
-        )
-    ]
+    try:
+        return pcrud.list_endpoints()
+    except Exception:
+        raise HTTPException(status_code=500, detail="Internal server error")
 
 
 @v1.get(
     "/provider-endpoints/{provider_id}", tags=["Providers"], generate_unique_id_function=uniq_name
 )
-async def get_provider_endpoint(provider_id: int) -> v1_models.ProviderEndpoint:
+async def get_provider_endpoint(
+    provider_id: int,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> v1_models.ProviderEndpoint:
     """Get a provider endpoint by ID."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
     # implementation that fetches the provider endpoint from the database.
@@ -65,7 +67,10 @@ async def get_provider_endpoint(provider_id: int) -> v1_models.ProviderEndpoint:
     generate_unique_id_function=uniq_name,
     status_code=201,
 )
-async def add_provider_endpoint(request: v1_models.ProviderEndpoint) -> v1_models.ProviderEndpoint:
+async def add_provider_endpoint(
+    request: v1_models.ProviderEndpoint,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> v1_models.ProviderEndpoint:
     """Add a provider endpoint."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
     # implementation that adds the provider endpoint to the database.
@@ -76,7 +81,9 @@ async def add_provider_endpoint(request: v1_models.ProviderEndpoint) -> v1_model
     "/provider-endpoints/{provider_id}", tags=["Providers"], generate_unique_id_function=uniq_name
 )
 async def update_provider_endpoint(
-    provider_id: int, request: v1_models.ProviderEndpoint
+    provider_id: int,
+    request: v1_models.ProviderEndpoint,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
 ) -> v1_models.ProviderEndpoint:
     """Update a provider endpoint by ID."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
@@ -87,7 +94,10 @@ async def update_provider_endpoint(
 @v1.delete(
     "/provider-endpoints/{provider_id}", tags=["Providers"], generate_unique_id_function=uniq_name
 )
-async def delete_provider_endpoint(provider_id: int):
+async def delete_provider_endpoint(
+    provider_id: int,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+):
     """Delete a provider endpoint by id."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
     # implementation that deletes the provider endpoint from the database.
@@ -99,7 +109,10 @@ async def delete_provider_endpoint(provider_id: int):
     tags=["Providers"],
     generate_unique_id_function=uniq_name,
 )
-async def list_models_by_provider(provider_name: str) -> List[v1_models.ModelByProvider]:
+async def list_models_by_provider(
+    provider_name: str,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> List[v1_models.ModelByProvider]:
     """List models by provider."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
     # implementation that fetches the models by provider from the database.
@@ -111,7 +124,9 @@ async def list_models_by_provider(provider_name: str) -> List[v1_models.ModelByP
     tags=["Providers"],
     generate_unique_id_function=uniq_name,
 )
-async def list_all_models_for_all_providers() -> List[v1_models.ModelByProvider]:
+async def list_all_models_for_all_providers(
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> List[v1_models.ModelByProvider]:
     """List all models for all providers."""
     # NOTE: This is a dummy implementation. In the future, we should have a proper
     # implementation that fetches all the models for all providers from the database.
@@ -394,7 +409,10 @@ async def delete_workspace_custom_instructions(workspace_name: str):
     tags=["Workspaces", "Muxes"],
     generate_unique_id_function=uniq_name,
 )
-async def get_workspace_muxes(workspace_name: str) -> List[v1_models.MuxRule]:
+async def get_workspace_muxes(
+    workspace_name: str,
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+) -> List[v1_models.MuxRule]:
     """Get the mux rules of a workspace.
 
     The list is ordered in order of priority. That is, the first rule in the list
@@ -422,7 +440,11 @@ async def get_workspace_muxes(workspace_name: str) -> List[v1_models.MuxRule]:
     generate_unique_id_function=uniq_name,
     status_code=204,
 )
-async def set_workspace_muxes(workspace_name: str, request: List[v1_models.MuxRule]):
+async def set_workspace_muxes(
+    workspace_name: str,
+    request: List[v1_models.MuxRule],
+    pcrud: provendcrud.ProviderCrud = Depends(provendcrud.ProviderCrud),
+):
     """Set the mux rules of a workspace."""
     # TODO: This is a dummy implementation. In the future, we should have a proper
     # implementation that sets the mux rules in the database.

src/codegate/api/v1_models.py

@@ -148,6 +148,8 @@ class ProviderType(str, Enum):
     openai = "openai"
     anthropic = "anthropic"
     vllm = "vllm"
+    ollama = "ollama"
+    lm_studio = "lm_studio"
 
 
 class ProviderAuthType(str, Enum):
@@ -163,19 +165,29 @@ class ProviderAuthType(str, Enum):
     api_key = "api_key"
 
 
+class ProviderEndpointSource(str, Enum):
+    """
+    Represents the different sources of provider endpoints.
+    """
+
+    config = "config"
+    db = "db"
+
+
 class ProviderEndpoint(pydantic.BaseModel):
     """
     Represents a provider's endpoint configuration. This
     allows us to persist the configuration for each provider,
     so we can use this for muxing messages.
     """
 
-    id: int
+    id: Optional[int] = None
     name: str
     description: str = ""
     provider_type: ProviderType
     endpoint: str
     auth_type: ProviderAuthType
+    source: ProviderEndpointSource
 
 
 class ModelByProvider(pydantic.BaseModel):

src/codegate/providers/crud/__init__.py

@@ -0,0 +1,3 @@
+from .crud import ProviderCrud
+
+__all__ = ["ProviderCrud"]

src/codegate/providers/crud/crud.py

@@ -0,0 +1,78 @@
+from typing import List, Optional
+from urllib.parse import urlparse
+
+import structlog
+from pydantic import ValidationError
+
+from codegate.api import v1_models as apimodelsv1
+from codegate.config import Config
+from codegate.db.connection import DbReader, DbRecorder
+
+logger = structlog.get_logger("codegate")
+
+
+class ProviderCrud:
+    """The CRUD operations for the provider endpoint references within
+    Codegate.
+
+    This is meant to handle all the transformations in between the
+    database and the API, as well as other sources of information. All
+    operations should result in the API models being returned.
+    """
+
+    def __init__(self):
+        self._db_reader = DbReader()
+        self._db_writer = DbRecorder()
+        config = Config.get_config()
+        if config is None:
+            logger.warning("OZZ: No configuration found.")
+            provided_urls = {}
+        else:
+            logger.info("OZZ: Using configuration for provider URLs.")
+            provided_urls = config.provider_urls
+
+        self._provider_urls = provided_urls
+
+    def list_endpoints(self) -> List[apimodelsv1.ProviderEndpoint]:
+        """List all the endpoints."""
+
+        endpoints = []
+        for provider_name, provider_url in self._provider_urls.items():
+            provend = self.__provider_endpoint_from_cfg(provider_name, provider_url)
+            if provend is not None:
+                endpoints.append(provend)
+
+        return endpoints
+
+    def __provider_endpoint_from_cfg(
+        self, provider_name: str, provider_url: str
+    ) -> Optional[apimodelsv1.ProviderEndpoint]:
+        """Create a provider endpoint from the config entry."""
+
+        try:
+            _ = urlparse(provider_url)
+        except Exception:
+            logger.warning(
+                "Invalid provider URL", provider_name=provider_name, provider_url=provider_url
+            )
+            return None
+
+        try:
+            return apimodelsv1.ProviderEndpoint(
+                name=provider_name,
+                endpoint=provider_url,
+                descrption=("Endpoint for the {} provided via the CodeGate configuration.").format(
+                    provider_name
+                ),
+                provider_type=provider_name,
+                auth_type=apimodelsv1.ProviderAuthType.none,
+                source=apimodelsv1.ProviderEndpointSource.config,
+            )
+        except ValidationError as err:
+            logger.warning(
+                "Invalid provider name",
+                provider_name=provider_name,
+                provider_url=provider_url,
+                err=str(err),
+            )
+            return None