Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

refactor(service_api): dep-inject segment payloads with @model_validate (#41571)

Eddy ZHANGa5445f24245a
diff --git a/api/controllers/service_api/dataset/segment.py b/api/controllers/service_api/dataset/segment.py
index ded5365ea58..7585e5f3dc1 100644
--- a/api/controllers/service_api/dataset/segment.py
+++ b/api/controllers/service_api/dataset/segment.py
@@ -15,6 +15,7 @@ from controllers.common.schema import (
register_schema_models,
)
from controllers.common.session import with_session
+from controllers.console.wraps import model_validate
from controllers.service_api import service_api_ns
from controllers.service_api.app.error import ProviderNotInitializeError
from controllers.service_api.wraps import (
@@ -406,7 +407,16 @@ class DatasetSegmentApi(DatasetApiResource):
@cloud_edition_billing_resource_check("vector_space", "dataset")
@cloud_edition_billing_rate_limit_check("knowledge", "dataset")
@with_session
- def post(self, session: Session, tenant_id: str, dataset_id: UUID, document_id: UUID, segment_id: UUID):
+ @model_validate(SegmentUpdatePayload)
+ def post(
+ self,
+ payload: SegmentUpdatePayload,
+ session: Session,
+ tenant_id: str,
+ dataset_id: UUID,
+ document_id: UUID,
+ segment_id: UUID,
+ ):
_, current_tenant_id = current_account_with_tenant()
dataset_id_str = str(dataset_id)
# check dataset
@@ -441,8 +451,6 @@ class DatasetSegmentApi(DatasetApiResource):
segment_id_str = str(segment_id)
_, segment = _get_segment_for_document(session, dataset, document, segment_id_str)
- payload = SegmentUpdatePayload.model_validate(service_api_ns.payload or {})
-
updated_segment = SegmentService.update_segment(payload.segment, segment, document, dataset, session)
summary = SummaryIndexService.get_segment_summary(
segment_id=updated_segment.id, dataset_id=dataset_id_str, session=session
@@ -549,7 +557,16 @@ class ChildChunkApi(DatasetApiResource):
@cloud_edition_billing_knowledge_limit_check("add_segment", "dataset")
@cloud_edition_billing_rate_limit_check("knowledge", "dataset")
@with_session
- def post(self, session: Session, tenant_id: str, dataset_id: UUID, document_id: UUID, segment_id: UUID):
+ @model_validate(ChildChunkCreatePayload)
+ def post(
+ self,
+ payload: ChildChunkCreatePayload,
+ session: Session,
+ tenant_id: str,
+ dataset_id: UUID,
+ document_id: UUID,
+ segment_id: UUID,
+ ):
_, current_tenant_id = current_account_with_tenant()
"""Create child chunk."""
dataset_id_str = str(dataset_id)
@@ -586,9 +603,6 @@ class ChildChunkApi(DatasetApiResource):
except ProviderTokenNotInitError as ex:
raise ProviderNotInitializeError(ex.description)
- # validate args
- payload = ChildChunkCreatePayload.model_validate(service_api_ns.payload or {})
-
try:
child_chunk = SegmentService.create_child_chunk(payload.content, segment, document, dataset, session)
except ChildChunkIndexingServiceError as e:
@@ -765,8 +779,10 @@ class DatasetChildChunkApi(DatasetApiResource):
@cloud_edition_billing_knowledge_limit_check("add_segment", "dataset")
@cloud_edition_billing_rate_limit_check("knowledge", "dataset")
@with_session
+ @model_validate(ChildChunkUpdatePayload)
def patch(
self,
+ payload: ChildChunkUpdatePayload,
session: Session,
tenant_id: str,
dataset_id: UUID,
@@ -799,9 +815,6 @@ class DatasetChildChunkApi(DatasetApiResource):
if not child_chunk:
raise NotFound("Child chunk not found.")
- # validate args
- payload = ChildChunkUpdatePayload.model_validate(service_api_ns.payload or {})
-
try:
child_chunk = SegmentService.update_child_chunk(
payload.content, child_chunk, segment, document, dataset, session
diff --git a/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_segment.py b/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_segment.py
index 8273e179e2f..fc5d540ce72 100644
--- a/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_segment.py
+++ b/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_segment.py
@@ -16,12 +16,13 @@ Focus on:
import inspect
import uuid
+from collections.abc import Callable
from unittest.mock import ANY, Mock, patch
import pytest
from flask import Flask
from sqlalchemy.orm import Session
-from werkzeug.exceptions import NotFound
+from werkzeug.exceptions import NotFound, UnprocessableEntity
from controllers.service_api.dataset.segment import (
ChildChunkApi,
@@ -2265,3 +2266,69 @@ class TestDatasetChildChunkApiDelete(SQLiteEndpointTest):
segment_id=segment_id,
child_chunk_id="cc-id",
)
+
+
+class TestModelValidateDecorator(SQLiteEndpointTest):
+ """The endpoint tests above supply valid bodies, so this is what covers the decorators."""
+
+ @staticmethod
+ def _setup_billing_mocks(mock_validate_token: Mock, mock_feature_svc: Mock, tenant_id: str) -> None:
+ """Configure mocks to neutralise billing/auth decorators."""
+ mock_validate_token.return_value = _api_token(tenant_id)
+
+ mock_features = Mock()
+ mock_features.billing.enabled = False
+ mock_feature_svc.get_features.return_value = mock_features
+
+ mock_vector_space = Mock()
+ mock_vector_space.limit = 10
+ mock_vector_space.size = 0
+ mock_feature_svc.get_vector_space.return_value = mock_vector_space
+
+ mock_rate_limit = Mock()
+ mock_rate_limit.enabled = False
+ mock_feature_svc.get_knowledge_rate_limit.return_value = mock_rate_limit
+
+ @pytest.mark.parametrize(
+ ("call", "route", "method"),
+ [
+ (
+ lambda: DatasetSegmentApi().post(
+ tenant_id="t", dataset_id="d", document_id="doc-id", segment_id="seg-id"
+ ),
+ "/datasets/d/documents/doc-id/segments/seg-id",
+ "POST",
+ ),
+ (
+ lambda: ChildChunkApi().post(tenant_id="t", dataset_id="d", document_id="doc-id", segment_id="seg-id"),
+ "/datasets/d/documents/doc-id/segments/seg-id/child_chunks",
+ "POST",
+ ),
+ (
+ lambda: DatasetChildChunkApi().patch(
+ tenant_id="t", dataset_id="d", document_id="doc-id", segment_id="seg-id", child_chunk_id="cc-id"
+ ),
+ "/datasets/d/documents/doc-id/segments/seg-id/child_chunks/cc-id",
+ "PATCH",
+ ),
+ ],
+ )
+ @patch("controllers.service_api.wraps.FeatureService")
+ @patch("controllers.service_api.wraps.validate_and_get_api_token")
+ def test_invalid_body_is_rejected_before_the_handler_runs(
+ self,
+ mock_validate_token: Mock,
+ mock_feature_svc: Mock,
+ app: Flask,
+ mock_tenant: Mock,
+ call: Callable[[], object],
+ route: str,
+ method: str,
+ ) -> None:
+ self._setup_billing_mocks(mock_validate_token, mock_feature_svc, mock_tenant.id)
+
+ with app.test_request_context(route, method=method, json={}, headers={"Authorization": "Bearer test_token"}):
+ with pytest.raises(UnprocessableEntity) as exc_info:
+ call()
+
+ assert exc_info.value.code == 422