Skip to content

Standardize API error responses #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amito wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Standardize API error responses #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions src/neuralnav/api/routes/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ async def deploy_model(request: DeploymentRequest):
yaml_validator.validate_all(result["files"])
logger.info(f"All YAML files validated for deployment: {result['deployment_id']}")
except Exception as e:
logger.error(f"YAML validation failed: {e}")
logger.error(f"YAML validation failed: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Generated YAML validation failed: {str(e)}",
detail="Generated YAML validation failed",
) from e

return DeploymentResponse(
Expand All @@ -118,11 +118,13 @@ async def deploy_model(request: DeploymentRequest):
message=f"Deployment files generated successfully for {result['deployment_id']}",
)

except HTTPException:
raise
except Exception as e:
logger.error(f"Failed to generate deployment: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to generate deployment: {str(e)}",
detail="Failed to generate deployment",
) from e


Expand Down Expand Up @@ -249,10 +251,10 @@ async def deploy_to_cluster(request: DeploymentRequest):
yaml_validator.validate_all(files)
logger.info(f"YAML validation passed for: {deployment_id}")
except Exception as e:
logger.error(f"YAML validation failed: {e}")
logger.error(f"YAML validation failed: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Generated YAML validation failed: {str(e)}",
detail="Generated YAML validation failed",
) from e

# Step 3: Deploy to cluster
Expand All @@ -264,7 +266,7 @@ async def deploy_to_cluster(request: DeploymentRequest):
logger.error(f"Deployment failed: {deployment_result['errors']}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Deployment failed: {deployment_result['errors']}",
detail="Deployment to cluster failed",
)

logger.info(f"Successfully deployed {deployment_id} to cluster")
Expand All @@ -284,7 +286,7 @@ async def deploy_to_cluster(request: DeploymentRequest):
logger.error(f"Failed to deploy to cluster: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to deploy to cluster: {str(e)}",
detail="Failed to deploy to cluster",
) from e


Expand All @@ -309,7 +311,7 @@ async def get_cluster_status():
}
except Exception as e:
logger.error(f"Failed to query cluster status: {e}")
return {"accessible": False, "error": str(e)}
return {"accessible": False, "error": "Failed to connect to cluster"}


@router.get("/deployments/{deployment_id}/k8s-status")
Expand Down Expand Up @@ -343,7 +345,7 @@ async def get_k8s_deployment_status(deployment_id: str):
logger.error(f"Failed to get K8s deployment status: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to get deployment status: {str(e)}",
detail="Failed to get deployment status",
) from e


Expand Down Expand Up @@ -384,7 +386,7 @@ async def get_deployment_yaml(deployment_id: str):
logger.error(f"Failed to retrieve YAML files: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to retrieve YAML files: {str(e)}",
detail="Failed to retrieve YAML files",
) from e


Expand All @@ -408,9 +410,10 @@ async def delete_deployment(deployment_id: str):
result = manager.delete_inferenceservice(deployment_id)

if not result["success"]:
logger.error(f"Failed to delete deployment: {result.get('error', 'Unknown error')}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to delete deployment: {result.get('error', 'Unknown error')}",
detail="Failed to delete deployment",
)

return result
Expand All @@ -421,7 +424,7 @@ async def delete_deployment(deployment_id: str):
logger.error(f"Failed to delete deployment: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to delete deployment: {str(e)}",
detail="Failed to delete deployment",
) from e


Expand Down Expand Up @@ -459,5 +462,5 @@ async def list_all_deployments():
logger.error(f"Failed to list deployments: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to list deployments: {str(e)}",
detail="Failed to list deployments",
) from e
13 changes: 7 additions & 6 deletions src/neuralnav/api/routes/database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ async def db_status():
finally:
conn.close()
except Exception as e:
logger.error(f"Failed to get DB status: {e}")
logger.error(f"Failed to get DB status: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_503_SERVICE_UNAVAILABLE, detail=f"Database not accessible: {e}"
status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
detail="Database not accessible",
) from e


Expand Down Expand Up @@ -95,10 +96,10 @@ async def upload_benchmarks(file: UploadFile = File(...)):
finally:
conn.close()
except Exception as e:
logger.error(f"Failed to load benchmarks: {e}")
logger.error(f"Failed to load benchmarks: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to load benchmarks: {e}",
detail="Failed to load benchmarks",
) from e


Expand Down Expand Up @@ -126,8 +127,8 @@ async def reset_database():
finally:
conn.close()
except Exception as e:
logger.error(f"Failed to reset database: {e}")
logger.error(f"Failed to reset database: {e}", exc_info=True)
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to reset database: {e}",
detail="Failed to reset database",
) from e
Loading