feat: Add suggestion message to API exception response

src/backend/base/langflow/api/utils.py

@@ -3,6 +3,8 @@
 from typing import TYPE_CHECKING, Optional
 
 from fastapi import HTTPException
+from langflow.exceptions.api import exceptionBody
+from langflow.services.database.models.flow.utils import get_outdated_components
 from sqlmodel import Session
 
 from langflow.graph.graph.base import Graph
@@ -205,3 +207,20 @@
     if hasattr(exc, "body"):
         return exc.body["message"]
     return str(exc)
+
+
+def get_suggestion_messsage(outdated_components: list[str]):
+    """Get the suggestion message for the outdated components."""
+    message = f"The flow contains {len(outdated_components)} outdated components. we recommend updating the following components: "
+    for component in outdated_components:
+        message += f"{component}, "
+    return message
+
+
+def from_exc_and_flow(exc: str | list[str], flow: Flow) -> exceptionBody:
+    body = {"message": str(exc)}
+    outdated_components = get_outdated_components(flow)
+    if outdated_components:
+        body["suggestion"] = get_suggestion_messsage(outdated_components)
+    excep = ExceptionBody(**body)
+    return excep

src/backend/base/langflow/api/v1/endpoints.py

@@ -23,7 +23,7 @@
 )
 from langflow.custom.custom_component.component import Component
 from langflow.custom.utils import build_custom_component_template, get_instance_name
-from langflow.exceptions.api import InvalidChatInputException
+from langflow.exceptions.api import APIException, InvalidChatInputException
 from langflow.graph.graph.base import Graph
 from langflow.graph.schema import RunOutputs
 from langflow.helpers.flow import get_flow_by_id_or_endpoint_name
@@ -260,7 +260,9 @@
             raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=str(exc)) from exc
         else:
             logger.exception(exc)
-            raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc)) from exc
+            raise APIException(
+                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=from_exc_and_flow(exc, flow)
+            ) from exc
     except InvalidChatInputException as exc:
         logger.error(exc)
         raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail=str(exc)) from exc
@@ -275,7 +277,10 @@
                 runErrorMessage=str(exc),
             ),
         )
-        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, detail=str(exc)) from exc
+        logger.exception(exc)
+        raise APIException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=from_exc_and_flow(exc, flow)
+        ) from exc
 
 
 @router.post("/webhook/{flow_id_or_name}", response_model=dict, status_code=HTTPStatus.ACCEPTED)

src/backend/base/langflow/exceptions/api.py

@@ -1,2 +1,20 @@
+from fastapi import HTTPException
+from pydantic import BaseModel
+
+
 class InvalidChatInputException(Exception):
     pass
+
+
+# create a pidantic documentation for this class
+class ExceptionBody(BaseModel):
+    message: str | list[str]
+    traceback: str | list[str] | None = None
+    description: str | list[str] | None = None
+    code: str | None = None
+    suggestion: str | list[str] | None = None
+
+
+class APIException(HTTPException):
+    def __init__(self, exception: exceptionBody, status_code: int = 500):
+        super().__init__(status_code=status_code, detail=exception.model_dump_json())

src/backend/base/langflow/services/database/models/flow/utils.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from fastapi import Depends
+from langflow.utils.version import get_version_info
 from sqlmodel import Session
 from sqlalchemy import delete
 
@@ -43,3 +44,24 @@ def get_all_webhook_components_in_flow(flow_data: dict | None):
     if not flow_data:
         return []
     return [node for node in flow_data.get("nodes", []) if "Webhook" in node.get("id")]
+
+
+def get_components_versions(flow: Flow):
+    versions = {}
+    nodes = flow.data.get("nodes", [])
+    for node in nodes:
+        data = node.get("data", {})
+        data_node = data.get("node", {})
+        if "lf_version" in data_node:
+            versions[node["id"]] = data_node["lf_version"]
+    return versions
+
+
+def get_outdated_components(flow: Flow):
+    component_versions = get_components_versions(flow)
+    lf_version = get_version_info()["version"]
+    outdated_components = []
+    for key, value in component_versions.items():
+        if value != lf_version:
+            outdated_components.append(key)
+    return outdated_components