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.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
refactor(controllers/web): dep-inject payloads with @model_validate (#40796)
chenshiyangd31a7d47bfab
diff --git a/api/controllers/web/message.py b/api/controllers/web/message.pyindex 658cb0f14df..021474c52cb 100644--- a/api/controllers/web/message.py+++ b/api/controllers/web/message.py@@ -2,7 +2,6 @@ import loggingfrom typing import Literalfrom uuid import UUID-from flask import requestfrom pydantic import BaseModel, Field, TypeAdapterfrom sqlalchemy.orm import Sessionfrom werkzeug.exceptions import InternalServerError, NotFound@@ -11,6 +10,7 @@ from controllers.common.controller_schemas import MessageFeedbackPayload, Messagfrom controllers.common.fields import GeneratedAppResponsefrom controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_modelsfrom controllers.console.app.wraps import with_session+from controllers.console.wraps import model_validatefrom controllers.web import web_nsfrom controllers.web.error import (AppMoreLikeThisDisabledError,@@ -77,14 +77,12 @@ class MessageListApi(WebApiResource):})@web_ns.response(200, "Success", web_ns.models[WebMessageInfiniteScrollPagination.__name__])- def get(self, app_model: App, end_user: EndUser):+ @model_validate(MessageListQuery)+ def get(self, query: MessageListQuery, app_model: App, end_user: EndUser):app_mode = AppMode.value_of(app_model.mode)if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT, AppMode.AGENT}:raise NotChatAppError()- raw_args = request.args.to_dict()- query = MessageListQuery.model_validate(raw_args)-try:session = db.session()pagination = MessageService.pagination_by_first_id(@@ -134,11 +132,10 @@ class MessageFeedbackApi(WebApiResource):)@web_ns.response(200, "Feedback submitted successfully", web_ns.models[ResultResponse.__name__])@web_ns.expect(web_ns.models[MessageFeedbackPayload.__name__])- def post(self, app_model: App, end_user: EndUser, message_id: UUID):+ @model_validate(MessageFeedbackPayload)+ def post(self, payload: MessageFeedbackPayload, app_model: App, end_user: EndUser, message_id: UUID):message_id_str = str(message_id)- payload = MessageFeedbackPayload.model_validate(web_ns.payload or {})-try:MessageService.create_feedback(app_model=app_model,@@ -171,15 +168,20 @@ class MessageMoreLikeThisApi(WebApiResource):)@web_ns.response(200, "Success", web_ns.models[GeneratedAppResponse.__name__])@with_session- def get(self, session: Session, app_model: App, end_user: EndUser, message_id: UUID):+ @model_validate(MessageMoreLikeThisQuery)+ def get(+ self,+ query: MessageMoreLikeThisQuery,+ session: Session,+ app_model: App,+ end_user: EndUser,+ message_id: UUID,+ ):if app_model.mode != "completion":raise NotCompletionAppError()message_id_str = str(message_id)- raw_args = request.args.to_dict()- query = MessageMoreLikeThisQuery.model_validate(raw_args)-streaming = query.response_mode == "streaming"try:diff --git a/api/controllers/web/saved_message.py b/api/controllers/web/saved_message.pyindex 99ea48bf7c9..e085b6ece1a 100644--- a/api/controllers/web/saved_message.py+++ b/api/controllers/web/saved_message.py@@ -1,11 +1,11 @@from uuid import UUID-from flask import requestfrom pydantic import TypeAdapterfrom werkzeug.exceptions import NotFoundfrom controllers.common.controller_schemas import SavedMessageCreatePayload, SavedMessageListQueryfrom controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models+from controllers.console.wraps import model_validatefrom controllers.web import web_nsfrom controllers.web.error import NotCompletionAppErrorfrom controllers.web.wraps import WebApiResource@@ -36,13 +36,11 @@ class SavedMessageListApi(WebApiResource):})@web_ns.response(200, "Success", web_ns.models[SavedMessageInfiniteScrollPagination.__name__])- def get(self, app_model: App, end_user: EndUser):+ @model_validate(SavedMessageListQuery)+ def get(self, query: SavedMessageListQuery, app_model: App, end_user: EndUser):if app_model.mode != "completion":raise NotCompletionAppError()- raw_args = request.args.to_dict()- query = SavedMessageListQuery.model_validate(raw_args)-session = db.session()pagination = SavedMessageService.pagination_by_last_id(app_model, end_user, query.last_id, query.limit, session=session@@ -75,12 +73,11 @@ class SavedMessageListApi(WebApiResource):)@web_ns.response(200, "Message saved successfully", web_ns.models[ResultResponse.__name__])@web_ns.expect(web_ns.models[SavedMessageCreatePayload.__name__])- def post(self, app_model: App, end_user: EndUser):+ @model_validate(SavedMessageCreatePayload)+ def post(self, payload: SavedMessageCreatePayload, app_model: App, end_user: EndUser):if app_model.mode != "completion":raise NotCompletionAppError()- payload = SavedMessageCreatePayload.model_validate(web_ns.payload or {})-try:SavedMessageService.save(app_model, end_user, payload.message_id, session=db.session())except MessageNotExistsError:diff --git a/api/tests/unit_tests/controllers/web/test_message_endpoints.py b/api/tests/unit_tests/controllers/web/test_message_endpoints.pyindex eb34738880c..5feea96596d 100644--- a/api/tests/unit_tests/controllers/web/test_message_endpoints.py+++ b/api/tests/unit_tests/controllers/web/test_message_endpoints.py@@ -2,6 +2,7 @@from __future__ import annotations+import inspectfrom unittest.mock import MagicMock, patchfrom uuid import uuid4@@ -9,6 +10,7 @@ import pytestfrom flask import Flaskfrom werkzeug.exceptions import NotFound+from controllers.common.controller_schemas import MessageFeedbackPayloadfrom controllers.web.error import (AppMoreLikeThisDisabledError,NotChatAppError,@@ -17,6 +19,7 @@ from controllers.web.error import (from controllers.web.message import (MessageFeedbackApi,MessageMoreLikeThisApi,+ MessageMoreLikeThisQuery,MessageSuggestedQuestionApi,)from models.enums import EndUserType@@ -42,30 +45,35 @@ def _end_user() -> EndUser:)+# The @model_validate and @with_session decorators wrap the handlers; tests+# call the undecorated function so they can pass a pydantic payload / a fake+# session directly.+_feedback_post = inspect.unwrap(MessageFeedbackApi.post)+_more_like_this_get = inspect.unwrap(MessageMoreLikeThisApi.get)++# ---------------------------------------------------------------------------# MessageFeedbackApi# ---------------------------------------------------------------------------class TestMessageFeedbackApi:@patch("controllers.web.message.MessageService.create_feedback")- @patch("controllers.web.message.web_ns")- def test_feedback_success(self, mock_ns: MagicMock, mock_create: MagicMock, app: Flask) -> None:- mock_ns.payload = {"rating": "like", "content": "great"}+ def test_feedback_success(self, mock_create: MagicMock, app: Flask) -> None:+ payload = MessageFeedbackPayload.model_validate({"rating": "like", "content": "great"})msg_id = uuid4()with app.test_request_context(f"/messages/{msg_id}/feedbacks", method="POST"):- result = MessageFeedbackApi().post(_chat_app(), _end_user(), msg_id)+ result = _feedback_post(MessageFeedbackApi(), payload, _chat_app(), _end_user(), msg_id)assert result == {"result": "success"}mock_create.assert_called_once()@patch("controllers.web.message.MessageService.create_feedback")- @patch("controllers.web.message.web_ns")- def test_feedback_null_rating(self, mock_ns: MagicMock, mock_create: MagicMock, app: Flask) -> None:- mock_ns.payload = {"rating": None}+ def test_feedback_null_rating(self, mock_create: MagicMock, app: Flask) -> None:+ payload = MessageFeedbackPayload.model_validate({"rating": None})msg_id = uuid4()with app.test_request_context(f"/messages/{msg_id}/feedbacks", method="POST"):- result = MessageFeedbackApi().post(_chat_app(), _end_user(), msg_id)+ result = _feedback_post(MessageFeedbackApi(), payload, _chat_app(), _end_user(), msg_id)assert result == {"result": "success"}@@ -73,14 +81,13 @@ class TestMessageFeedbackApi:"controllers.web.message.MessageService.create_feedback",side_effect=MessageNotExistsError(),)- @patch("controllers.web.message.web_ns")- def test_feedback_message_not_found(self, mock_ns: MagicMock, mock_create: MagicMock, app: Flask) -> None:- mock_ns.payload = {"rating": "dislike"}+ def test_feedback_message_not_found(self, mock_create: MagicMock, app: Flask) -> None:+ payload = MessageFeedbackPayload.model_validate({"rating": "dislike"})msg_id = uuid4()with app.test_request_context(f"/messages/{msg_id}/feedbacks", method="POST"):with pytest.raises(NotFound, match="Message Not Exists"):- MessageFeedbackApi().post(_chat_app(), _end_user(), msg_id)+ _feedback_post(MessageFeedbackApi(), payload, _chat_app(), _end_user(), msg_id)# ---------------------------------------------------------------------------@@ -89,18 +96,24 @@ class TestMessageFeedbackApi:class TestMessageMoreLikeThisApi:def test_wrong_mode_raises(self, app: Flask) -> None:msg_id = uuid4()+ query = MessageMoreLikeThisQuery.model_validate({"response_mode": "blocking"})+ session = MagicMock()with app.test_request_context(f"/messages/{msg_id}/more-like-this?response_mode=blocking"):with pytest.raises(NotCompletionAppError):- MessageMoreLikeThisApi().get(_chat_app(), _end_user(), msg_id)+ _more_like_this_get(MessageMoreLikeThisApi(), query, session, _chat_app(), _end_user(), msg_id)@patch("controllers.web.message.helper.compact_generate_response", return_value={"answer": "similar"})@patch("controllers.web.message.AppGenerateService.generate_more_like_this")def test_happy_path(self, mock_gen: MagicMock, mock_compact: MagicMock, app: Flask) -> None:msg_id = uuid4()mock_gen.return_value = "response"+ query = MessageMoreLikeThisQuery.model_validate({"response_mode": "blocking"})+ session = MagicMock()with app.test_request_context(f"/messages/{msg_id}/more-like-this?response_mode=blocking"):- result = MessageMoreLikeThisApi().get(_completion_app(), _end_user(), msg_id)+ result = _more_like_this_get(+ MessageMoreLikeThisApi(), query, session, _completion_app(), _end_user(), msg_id+ )assert result == {"answer": "similar"}@@ -110,9 +123,11 @@ class TestMessageMoreLikeThisApi:)def test_message_not_found(self, mock_gen: MagicMock, app: Flask) -> None:msg_id = uuid4()+ query = MessageMoreLikeThisQuery.model_validate({"response_mode": "blocking"})+ session = MagicMock()with app.test_request_context(f"/messages/{msg_id}/more-like-this?response_mode=blocking"):with pytest.raises(NotFound, match="Message Not Exists"):- MessageMoreLikeThisApi().get(_completion_app(), _end_user(), msg_id)+ _more_like_this_get(MessageMoreLikeThisApi(), query, session, _completion_app(), _end_user(), msg_id)@patch("controllers.web.message.AppGenerateService.generate_more_like_this",@@ -120,9 +135,11 @@ class TestMessageMoreLikeThisApi:)def test_feature_disabled(self, mock_gen: MagicMock, app: Flask) -> None:msg_id = uuid4()+ query = MessageMoreLikeThisQuery.model_validate({"response_mode": "blocking"})+ session = MagicMock()with app.test_request_context(f"/messages/{msg_id}/more-like-this?response_mode=blocking"):with pytest.raises(AppMoreLikeThisDisabledError):- MessageMoreLikeThisApi().get(_completion_app(), _end_user(), msg_id)+ _more_like_this_get(MessageMoreLikeThisApi(), query, session, _completion_app(), _end_user(), msg_id)# ---------------------------------------------------------------------------diff --git a/api/tests/unit_tests/controllers/web/test_message_list.py b/api/tests/unit_tests/controllers/web/test_message_list.pyindex b5d74df65ef..4a1cf603f69 100644--- a/api/tests/unit_tests/controllers/web/test_message_list.py+++ b/api/tests/unit_tests/controllers/web/test_message_list.py@@ -3,6 +3,7 @@from __future__ import annotationsimport builtins+import inspectimport uuidfrom datetime import datetimefrom types import ModuleType, SimpleNamespace@@ -13,6 +14,7 @@ import pytestfrom flask import Flaskfrom flask.views import MethodView+from controllers.common.controller_schemas import MessageListQueryfrom core.entities.execution_extra_content import HumanInputContent# Ensure flask_restx.api finds MethodView during import.@@ -156,7 +158,8 @@ def test_message_list_mapping(app: Flask) -> None:patch.object(message_module.MessageService, "pagination_by_first_id", return_value=pagination) as mock_page,app.test_request_context(f"/messages?conversation_id={conversation_id}&limit=20"),):- response = MessageListApi().get(app_model, end_user)+ query = MessageListQuery.model_validate({"conversation_id": conversation_id, "limit": 20})+ response = inspect.unwrap(MessageListApi.get)(MessageListApi(), query, app_model, end_user)mock_page.assert_called_once_with(app_model, end_user, conversation_id, None, 20, session=ANY)assert response["limit"] == 20diff --git a/api/tests/unit_tests/controllers/web/test_saved_message.py b/api/tests/unit_tests/controllers/web/test_saved_message.pyindex 5cb572b54fd..fdb276f8f5a 100644--- a/api/tests/unit_tests/controllers/web/test_saved_message.py+++ b/api/tests/unit_tests/controllers/web/test_saved_message.py@@ -2,6 +2,7 @@from __future__ import annotations+import inspectfrom types import SimpleNamespacefrom unittest.mock import MagicMock, patchfrom uuid import uuid4@@ -10,6 +11,7 @@ import pytestfrom flask import Flaskfrom werkzeug.exceptions import NotFound+from controllers.common.controller_schemas import SavedMessageCreatePayload, SavedMessageListQueryfrom controllers.web.error import NotCompletionAppErrorfrom controllers.web.saved_message import SavedMessageApi, SavedMessageListApifrom models.enums import EndUserType@@ -34,21 +36,30 @@ def _end_user() -> EndUser:)+# The @model_validate decorator wraps the handler; tests call the undecorated+# function so they can pass the validated pydantic payload directly and skip+# the flask request-parsing step.+_list_get = inspect.unwrap(SavedMessageListApi.get)+_list_post = inspect.unwrap(SavedMessageListApi.post)++# ---------------------------------------------------------------------------# SavedMessageListApi (GET)# ---------------------------------------------------------------------------class TestSavedMessageListApiGet:def test_non_completion_mode_raises(self, app: Flask) -> None:+ query = SavedMessageListQuery.model_validate({})with app.test_request_context("/saved-messages"):with pytest.raises(NotCompletionAppError):- SavedMessageListApi().get(_chat_app(), _end_user())+ _list_get(SavedMessageListApi(), query, _chat_app(), _end_user())@patch("controllers.web.saved_message.SavedMessageService.pagination_by_last_id")def test_happy_path(self, mock_paginate: MagicMock, app: Flask) -> None:mock_paginate.return_value = SimpleNamespace(limit=20, has_more=False, data=[])+ query = SavedMessageListQuery.model_validate({"limit": 20})with app.test_request_context("/saved-messages?limit=20"):- result = SavedMessageListApi().get(_completion_app(), _end_user())+ result = _list_get(SavedMessageListApi(), query, _completion_app(), _end_user())assert result["limit"] == 20assert result["has_more"] is False@@ -59,29 +70,27 @@ class TestSavedMessageListApiGet:# ---------------------------------------------------------------------------class TestSavedMessageListApiPost:def test_non_completion_mode_raises(self, app: Flask) -> None:+ payload = SavedMessageCreatePayload.model_validate({"message_id": str(uuid4())})with app.test_request_context("/saved-messages", method="POST"):with pytest.raises(NotCompletionAppError):- SavedMessageListApi().post(_chat_app(), _end_user())+ _list_post(SavedMessageListApi(), payload, _chat_app(), _end_user())@patch("controllers.web.saved_message.SavedMessageService.save")- @patch("controllers.web.saved_message.web_ns")- def test_save_success(self, mock_ns: MagicMock, mock_save: MagicMock, app: Flask) -> None:- msg_id = str(uuid4())- mock_ns.payload = {"message_id": msg_id}+ def test_save_success(self, mock_save: MagicMock, app: Flask) -> None:+ payload = SavedMessageCreatePayload.model_validate({"message_id": str(uuid4())})with app.test_request_context("/saved-messages", method="POST"):- result = SavedMessageListApi().post(_completion_app(), _end_user())+ result = _list_post(SavedMessageListApi(), payload, _completion_app(), _end_user())assert result["result"] == "success"@patch("controllers.web.saved_message.SavedMessageService.save", side_effect=MessageNotExistsError())- @patch("controllers.web.saved_message.web_ns")- def test_save_not_found(self, mock_ns: MagicMock, mock_save: MagicMock, app: Flask) -> None:- mock_ns.payload = {"message_id": str(uuid4())}+ def test_save_not_found(self, mock_save: MagicMock, app: Flask) -> None:+ payload = SavedMessageCreatePayload.model_validate({"message_id": str(uuid4())})with app.test_request_context("/saved-messages", method="POST"):with pytest.raises(NotFound, match="Message Not Exists"):- SavedMessageListApi().post(_completion_app(), _end_user())+ _list_post(SavedMessageListApi(), payload, _completion_app(), _end_user())# ---------------------------------------------------------------------------