Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

handling Integrity Errors in V2 serializers (#773)

alibad2fe9f86cd
diff --git a/backend/api_v2/serializers.py b/backend/api_v2/serializers.py
index 88cc22dfb..4c9a85318 100644
--- a/backend/api_v2/serializers.py
+++ b/backend/api_v2/serializers.py
@@ -14,15 +14,31 @@ from rest_framework.serializers import (
Serializer,
ValidationError,
)
+from utils.serializer.integrity_error_mixin import IntegrityErrorMixin
from backend.serializers import AuditSerializer
-class APIDeploymentSerializer(AuditSerializer):
+class APIDeploymentSerializer(IntegrityErrorMixin, AuditSerializer):
class Meta:
model = APIDeployment
fields = "__all__"
+ unique_error_message_map: dict[str, dict[str, str]] = {
+ "unique_api_name": {
+ "field": "api_name",
+ "message": (
+ "This API name is already in use. Please select a different name."
+ ),
+ },
+ "api_deployment_api_endpoint_key": {
+ "field": "api_name",
+ "message": (
+ "This API name is already in use. Please select a different name."
+ ),
+ },
+ }
+
def validate_api_name(self, value: str) -> str:
api_name_validator = RegexValidator(
regex=r"^[a-zA-Z0-9_-]+$",
diff --git a/backend/pipeline_v2/serializers/crud.py b/backend/pipeline_v2/serializers/crud.py
index 39420e7dd..80a136c36 100644
--- a/backend/pipeline_v2/serializers/crud.py
+++ b/backend/pipeline_v2/serializers/crud.py
@@ -13,6 +13,7 @@ from pipeline_v2.models import Pipeline
from rest_framework import serializers
from rest_framework.serializers import SerializerMethodField
from scheduler.helper import SchedulerHelper
+from utils.serializer.integrity_error_mixin import IntegrityErrorMixin
from utils.serializer_utils import SerializerUtils
from workflow_manager.endpoint_v2.models import WorkflowEndpoint
@@ -23,7 +24,7 @@ logger = logging.getLogger(__name__)
DEPLOYMENT_ENDPOINT = settings.API_DEPLOYMENT_PATH_PREFIX + "/pipeline"
-class PipelineSerializer(AuditSerializer):
+class PipelineSerializer(IntegrityErrorMixin, AuditSerializer):
api_endpoint = SerializerMethodField()
@@ -31,6 +32,19 @@ class PipelineSerializer(AuditSerializer):
model = Pipeline
fields = "__all__"
+ unique_error_message_map: dict[str, dict[str, str]] = {
+ "unique_pipeline_name": {
+ "field": "pipeline_name",
+ "message": (
+ "This pipeline name is already in use. Please select a different name."
+ ),
+ },
+ "unique_pipeline_entity": {
+ "field": "pipeline_type",
+ "message": ("Duplicate pipeline"),
+ },
+ }
+
def validate_cron_string(self, value: Optional[str] = None) -> Optional[str]:
"""Validate the cron string provided in the serializer data.
diff --git a/backend/prompt_studio/prompt_studio_core_v2/serializers.py b/backend/prompt_studio/prompt_studio_core_v2/serializers.py
index 2e6b53ba1..c8371967c 100644
--- a/backend/prompt_studio/prompt_studio_core_v2/serializers.py
+++ b/backend/prompt_studio/prompt_studio_core_v2/serializers.py
@@ -12,6 +12,7 @@ from prompt_studio.prompt_studio_v2.models import ToolStudioPrompt
from prompt_studio.prompt_studio_v2.serializers import ToolStudioPromptSerializer
from rest_framework import serializers
from utils.FileValidator import FileValidator
+from utils.serializer.integrity_error_mixin import IntegrityErrorMixin
from backend.serializers import AuditSerializer
@@ -20,7 +21,7 @@ from .models import CustomTool
logger = logging.getLogger(__name__)
-class CustomToolSerializer(AuditSerializer):
+class CustomToolSerializer(IntegrityErrorMixin, AuditSerializer):
shared_users = serializers.PrimaryKeyRelatedField(
queryset=User.objects.all(), required=False, allow_null=True, many=True
)
@@ -29,6 +30,15 @@ class CustomToolSerializer(AuditSerializer):
model = CustomTool
fields = "__all__"
+ unique_error_message_map: dict[str, dict[str, str]] = {
+ "unique_tool_name": {
+ "field": "tool_name",
+ "message": (
+ "This tool name is already in use. Please select a different name."
+ ),
+ }
+ }
+
def to_representation(self, instance): # type: ignore
data = super().to_representation(instance)
try:
diff --git a/backend/utils/serializer/integrity_error_mixin.py b/backend/utils/serializer/integrity_error_mixin.py
new file mode 100644
index 000000000..876227d94
--- /dev/null
+++ b/backend/utils/serializer/integrity_error_mixin.py
@@ -0,0 +1,36 @@
+from django.db import IntegrityError
+from rest_framework.exceptions import ValidationError
+
+
+class IntegrityErrorMixin:
+ """Mixin to handle IntegrityError across multiple serializers for unique
+ constraint violations."""
+
+ unique_error_message_map: dict[str, dict[str, str]] = {}
+
+ def save(self, **kwargs):
+ try:
+ return super().save(**kwargs)
+ except IntegrityError as e:
+ self.handle_integrity_error(e)
+
+ def handle_integrity_error(self, error):
+ """General method to handle IntegrityError based on the
+ unique_error_message_map.
+
+ Each serializer or model can define its specific unique
+ constraint violations and error messages.
+ """
+ for (
+ unique_field,
+ field_error_message_map,
+ ) in self.unique_error_message_map.items():
+ if unique_field in str(error):
+ field = field_error_message_map.get("field")
+ message = field_error_message_map.get("message")
+ raise ValidationError({field: message})
+
+ # Default message if the error doesn't match any known unique constraints
+ raise ValidationError(
+ {"detail": "An error occurred while saving. Please try again."}
+ )
diff --git a/backend/workflow_manager/endpoint_v2/models.py b/backend/workflow_manager/endpoint_v2/models.py
index 2659a3b6f..f884de384 100644
--- a/backend/workflow_manager/endpoint_v2/models.py
+++ b/backend/workflow_manager/endpoint_v2/models.py
@@ -3,9 +3,17 @@ import uuid
from connector_v2.models import ConnectorInstance
from django.db import models
from utils.models.base_model import BaseModel
+from utils.user_context import UserContext
from workflow_manager.workflow_v2.models.workflow import Workflow
+class WorkflowEndpointModelManager(models.Manager):
+ def get_queryset(self):
+ # Validating organization
+ organization = UserContext.get_organization()
+ return super().get_queryset().filter(workflow__organization=organization)
+
+
class WorkflowEndpoint(BaseModel):
class EndpointType(models.TextChoices):
SOURCE = "SOURCE", "Source connector"
@@ -39,6 +47,10 @@ class WorkflowEndpoint(BaseModel):
configuration = models.JSONField(
blank=True, null=True, db_comment="Configuration in JSON format"
)
+
+ # Manager
+ objects = WorkflowEndpointModelManager()
+
connector_instance = models.ForeignKey(
ConnectorInstance,
on_delete=models.CASCADE,
diff --git a/backend/workflow_manager/workflow_v2/serializers.py b/backend/workflow_manager/workflow_v2/serializers.py
index 0f4c8c3d6..436b88530 100644
--- a/backend/workflow_manager/workflow_v2/serializers.py
+++ b/backend/workflow_manager/workflow_v2/serializers.py
@@ -13,6 +13,7 @@ from rest_framework.serializers import (
)
from tool_instance_v2.serializers import ToolInstanceSerializer
from tool_instance_v2.tool_instance_helper import ToolInstanceHelper
+from utils.serializer.integrity_error_mixin import IntegrityErrorMixin
from workflow_manager.endpoint_v2.models import WorkflowEndpoint
from workflow_manager.workflow_v2.constants import WorkflowExecutionKey, WorkflowKey
from workflow_manager.workflow_v2.exceptions import WorkflowGenerationError
@@ -27,7 +28,7 @@ from backend.serializers import AuditSerializer
logger = logging.getLogger(__name__)
-class WorkflowSerializer(AuditSerializer):
+class WorkflowSerializer(IntegrityErrorMixin, AuditSerializer):
tool_instances = ToolInstanceSerializer(many=True, read_only=True)
class Meta:
@@ -39,6 +40,13 @@ class WorkflowSerializer(AuditSerializer):
},
}
+ unique_error_message_map: dict[str, dict[str, str]] = {
+ "unique_workflow_name": {
+ "field": "workflow_name",
+ "message": "A workflow with this name already exists.",
+ }
+ }
+
def to_representation(self, instance: Workflow) -> dict[str, str]:
representation: dict[str, str] = super().to_representation(instance)
representation[WorkflowKey.WF_NAME] = instance.workflow_name
diff --git a/backend/workflow_manager/workflow_v2/views.py b/backend/workflow_manager/workflow_v2/views.py
index 3d37da92e..0961e4e1a 100644
--- a/backend/workflow_manager/workflow_v2/views.py
+++ b/backend/workflow_manager/workflow_v2/views.py
@@ -108,10 +108,10 @@ class WorkflowViewSet(viewsets.ModelViewSet):
Raises: WorkflowGenerationError
"""
+ workflow = serializer.save(
+ is_active=True,
+ )
try:
- workflow = serializer.save(
- is_active=True,
- )
WorkflowEndpointUtils.create_endpoints_for_workflow(workflow)
# NOTE: Add default connector here if needed
except Exception as e: