Merge pull request #61 from LAION-AI/59-document-how-to-develop-on-the-backend-api

removed ALLOW_ANY_API_KEY and allow skipping API key check in debug

ansible/dev.yaml

@@ -50,7 +50,7 @@
         network_mode: oasst
         env:
           POSTGRES_HOST: oasst-postgres
-          ALLOW_ANY_API_KEY: "true"
+          DEBUG_ALLOW_ANY_API_KEY: "true"
           MAX_WORKERS: "1"
         ports:
           - 8080:8080

backend/oasst_backend/api/deps.py

@@ -37,21 +37,21 @@ def api_auth(
     db: Session,
 ) -> ApiClient:
 
-    if api_key is not None:
-        if settings.ALLOW_ANY_API_KEY:
-            # make sure that a dummy api key exits in db (foreign key references)
-            ANY_API_KEY_ID = UUID("00000000-1111-2222-3333-444444444444")
-            api_client: ApiClient = db.query(ApiClient).filter(ApiClient.id == ANY_API_KEY_ID).first()
-            if api_client is None:
-                token = token_hex(32)
-                logger.info(f"ANY_API_KEY missing, inserting api_key: {token}")
-                api_client = ApiClient(id=ANY_API_KEY_ID, api_key=token, description="ANY_API_KEY, random token")
-                db.add(api_client)
-                db.commit()
-            return api_client
+    if api_key is None and not settings.DEBUG_SKIP_API_KEY_CHECK:
+        raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail="Could not validate credentials")
 
-        api_client = db.query(ApiClient).filter(ApiClient.api_key == api_key).first()
-        if api_client is not None and api_client.enabled:
-            return api_client
+    if settings.DEBUG_SKIP_API_KEY_CHECK or settings.DEBUG_ALLOW_ANY_API_KEY:
+        # make sure that a dummy api key exits in db (foreign key references)
+        ANY_API_KEY_ID = UUID("00000000-1111-2222-3333-444444444444")
+        api_client: ApiClient = db.query(ApiClient).filter(ApiClient.id == ANY_API_KEY_ID).first()
+        if api_client is None:
+            token = token_hex(32)
+            logger.info(f"ANY_API_KEY missing, inserting api_key: {token}")
+            api_client = ApiClient(id=ANY_API_KEY_ID, api_key=token, description="ANY_API_KEY, random token")
+            db.add(api_client)
+            db.commit()
+        return api_client
 
-    raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail="Could not validate credentials")
+    api_client = db.query(ApiClient).filter(ApiClient.api_key == api_key).first()
+    if api_client is not None and api_client.enabled:
+        return api_client

backend/oasst_backend/config.py

@@ -15,7 +15,8 @@ class Settings(BaseSettings):
     POSTGRES_DB: str = "postgres"
     DATABASE_URI: Optional[PostgresDsn] = None
 
-    ALLOW_ANY_API_KEY: bool = False
+    DEBUG_ALLOW_ANY_API_KEY: bool = False
+    DEBUG_SKIP_API_KEY_CHECK: bool = False
 
     @validator("DATABASE_URI", pre=True)
     def assemble_db_connection(cls, v: Optional[str], values: Dict[str, Any]) -> Any:

scripts/backend-development/run-local.sh

@@ -4,7 +4,7 @@ parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
 # switch to backend directory
 pushd "$parent_path/../../backend"
 
-export ALLOW_ANY_API_KEY=True
+export DEBUG_SKIP_API_KEY_CHECK=True
 
 uvicorn main:app --reload --port 8080 --host 0.0.0.0
 

scripts/frontend-development/docker-compose.yaml

@@ -35,7 +35,7 @@ services:
     image: oasst-backend
     environment:
       - POSTGRES_HOST=db
-      - ALLOW_ANY_API_KEY=True
+      - DEBUG_SKIP_API_KEY_CHECK=True
       - MAX_WORKERS=1
     depends_on:
       db: