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(models): pass session into Workflow accessors (#41464)
jjj-n09054169c421
diff --git a/api/controllers/console/app/workflow.py b/api/controllers/console/app/workflow.pyindex 31853a123a2..c7e51f663a4 100644--- a/api/controllers/console/app/workflow.py+++ b/api/controllers/console/app/workflow.py@@ -353,7 +353,7 @@ class WorkflowResponse(ResponseModel):return [_serialize_environment_variable(item) for item in value]-class _WorkflowResponseSource:+class WorkflowResponseSource:def __init__(self, workflow: Workflow, *, session: Session) -> None:self._workflow = workflowself._session = session@@ -590,7 +590,8 @@ class DraftWorkflowApi(Resource):"""# fetch draft workflow by app_modelworkflow_service = WorkflowService()- workflow = workflow_service.get_draft_workflow(app_model=app_model, session=db.session())+ session = db.session()+ workflow = workflow_service.get_draft_workflow(app_model=app_model, session=session)if not workflow:raise DraftWorkflowNotExist()@@ -599,9 +600,11 @@ class DraftWorkflowApi(Resource):# Return workflow with response-only Agent node job projection so the# front-end can treat draft graph node data as the editing source.- response = WorkflowResponse.model_validate(workflow, from_attributes=True).model_dump(mode="json")+ response = WorkflowResponse.model_validate(+ WorkflowResponseSource(workflow, session=session), from_attributes=True+ ).model_dump(mode="json")response["graph"] = WorkflowAgentPublishService.project_draft_bindings_to_graph(- session=db.session(),+ session=session,draft_workflow=workflow,)return response@@ -1283,13 +1286,14 @@ class PublishedWorkflowApi(Resource):"""# fetch published workflow by app_modelworkflow_service = WorkflowService()- workflow = workflow_service.get_published_workflow(app_model=app_model, session=db.session())+ session = db.session()+ workflow = workflow_service.get_published_workflow(app_model=app_model, session=session)# return workflow, if not found, return Noneif workflow is None:return None- return dump_response(WorkflowResponse, workflow)+ return dump_response(WorkflowResponse, WorkflowResponseSource(workflow, session=session))@console_ns.expect(console_ns.models[PublishWorkflowPayload.__name__])@console_ns.response(200, "Workflow published successfully", console_ns.models[WorkflowPublishResponse.__name__])@@ -1512,7 +1516,7 @@ class PublishedAllWorkflowApi(Resource):)return WorkflowPaginationResponse.model_validate({- "items": [_WorkflowResponseSource(workflow, session=session) for workflow in workflows],+ "items": [WorkflowResponseSource(workflow, session=session) for workflow in workflows],"page": page,"limit": limit,"has_more": has_more,@@ -1606,7 +1610,7 @@ class WorkflowByIdApi(Resource):if not workflow:raise NotFound("Workflow not found")- response = dump_response(WorkflowResponse, _WorkflowResponseSource(workflow, session=session))+ response = dump_response(WorkflowResponse, WorkflowResponseSource(workflow, session=session))return responsediff --git a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_workflow.py b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_workflow.pyindex 7c5e0cff893..432e83cc099 100644--- a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_workflow.py+++ b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_workflow.py@@ -26,6 +26,7 @@ from controllers.console.app.workflow import (DefaultBlockConfigsResponse,WorkflowPaginationResponse,WorkflowResponse,+ WorkflowResponseSource,)from controllers.console.app.wraps import with_sessionfrom controllers.console.datasets.wraps import get_rag_pipeline, load_rag_pipeline@@ -202,14 +203,15 @@ class DraftRagPipelineApi(Resource):Get draft rag pipeline's workflow"""# fetch draft workflow by app_model- rag_pipeline_service = RagPipelineService(db.session())+ session = db.session()+ rag_pipeline_service = RagPipelineService(session)workflow = rag_pipeline_service.get_draft_workflow(pipeline=pipeline)if not workflow:raise DraftWorkflowNotExist()# return workflow, if not found, return 404- return dump_response(WorkflowResponse, workflow)+ return dump_response(WorkflowResponse, WorkflowResponseSource(workflow, session=session))@setup_required@login_required@@ -548,14 +550,15 @@ class PublishedRagPipelineApi(Resource):if not pipeline.is_published:return None# fetch published workflow by pipeline- rag_pipeline_service = RagPipelineService(db.session())+ session = db.session()+ rag_pipeline_service = RagPipelineService(session)workflow = rag_pipeline_service.get_published_workflow(pipeline=pipeline)# return workflow, if not found, return Noneif workflow is None:return None- return dump_response(WorkflowResponse, workflow)+ return dump_response(WorkflowResponse, WorkflowResponseSource(workflow, session=session))@console_ns.response(200, "Success", console_ns.models[RagPipelineWorkflowPublishResponse.__name__])@setup_required@@ -684,7 +687,7 @@ class PublishedAllRagPipelineApi(Resource):return WorkflowPaginationResponse.model_validate({- "items": workflows,+ "items": [WorkflowResponseSource(workflow, session=session) for workflow in workflows],"page": page,"limit": limit,"has_more": has_more,@@ -763,7 +766,7 @@ class RagPipelineByIdApi(Resource):if not workflow:raise NotFound("Workflow not found")- return dump_response(WorkflowResponse, workflow)+ return dump_response(WorkflowResponse, WorkflowResponseSource(workflow, session=session))@console_ns.response(204, "Workflow deleted successfully")@setup_requireddiff --git a/api/controllers/console/snippets/snippet_workflow.py b/api/controllers/console/snippets/snippet_workflow.pyindex 309a9d9ea1a..c293dc60e77 100644--- a/api/controllers/console/snippets/snippet_workflow.py+++ b/api/controllers/console/snippets/snippet_workflow.py@@ -19,6 +19,7 @@ from controllers.console.app.workflow import (WorkflowPaginationResponse,WorkflowPublishResponse,WorkflowResponse,+ WorkflowResponseSource,WorkflowRestoreResponse,)from controllers.console.snippets.payloads import (@@ -179,9 +180,12 @@ class SnippetDraftWorkflowApi(Resource):raise DraftWorkflowNotExist()workflow.conversation_variables = []- response = SnippetWorkflowResponse.model_validate(workflow, from_attributes=True).model_dump(mode="json")+ session = db.session()+ response = SnippetWorkflowResponse.model_validate(+ WorkflowResponseSource(workflow, session=session), from_attributes=True+ ).model_dump(mode="json")response["graph"] = WorkflowAgentPublishService.project_draft_bindings_to_graph(- session=db.session(),+ session=session,draft_workflow=workflow,)response["input_fields"] = snippet.input_fields_list@@ -274,7 +278,9 @@ class SnippetPublishedWorkflowApi(Resource):if not workflow:return None- response = SnippetWorkflowResponse.model_validate(workflow, from_attributes=True).model_dump(mode="json")+ response = SnippetWorkflowResponse.model_validate(+ WorkflowResponseSource(workflow, session=db.session()), from_attributes=True+ ).model_dump(mode="json")response["input_fields"] = snippet.input_fields_listreturn response@@ -365,15 +371,15 @@ class SnippetPublishedAllWorkflowApi(Resource):limit=req_data.limit,)- response = SnippetWorkflowPaginationResponse.model_validate(- {- "items": workflows,- "page": req_data.page,- "limit": req_data.limit,- "has_more": has_more,- },- from_attributes=True,- ).model_dump(mode="json")+ response = SnippetWorkflowPaginationResponse.model_validate(+ {+ "items": [WorkflowResponseSource(workflow, session=session) for workflow in workflows],+ "page": req_data.page,+ "limit": req_data.limit,+ "has_more": has_more,+ },+ from_attributes=True,+ ).model_dump(mode="json")for item in response["items"]:item["input_fields"] = snippet.input_fields_listreturn response@@ -464,9 +470,11 @@ class SnippetWorkflowByIdApi(Resource):if not workflow:raise NotFound("Workflow not found")- response = SnippetWorkflowResponse.model_validate(workflow, from_attributes=True).model_dump(mode="json")- response["input_fields"] = snippet.input_fields_list- return response+ response = SnippetWorkflowResponse.model_validate(+ WorkflowResponseSource(workflow, session=session), from_attributes=True+ ).model_dump(mode="json")+ response["input_fields"] = snippet.input_fields_list+ return response@console_ns.doc("delete_snippet_workflow_by_id")@console_ns.doc(description="Delete a published snippet workflow version")diff --git a/api/models/workflow.py b/api/models/workflow.pyindex 954f1787c28..95159da2bd8 100644--- a/api/models/workflow.py+++ b/api/models/workflow.py@@ -297,18 +297,16 @@ class Workflow(Base): # bugworkflow.updated_at = workflow.created_atreturn workflow- @property- def created_by_account(self) -> Account | None:- return self.get_created_by_account(session=db.session())+ def created_by_account(self, session: orm.Session) -> Account | None:+ return self.get_created_by_account(session=session)- def get_created_by_account(self, *, session: orm.Session) -> Account | None:+ def get_created_by_account(self, session: orm.Session) -> Account | None:return session.get(Account, self.created_by)- @property- def updated_by_account(self) -> Account | None:- return self.get_updated_by_account(session=db.session())+ def updated_by_account(self, session: orm.Session) -> Account | None:+ return self.get_updated_by_account(session=session)- def get_updated_by_account(self, *, session: orm.Session) -> Account | None:+ def get_updated_by_account(self, session: orm.Session) -> Account | None:return session.get(Account, self.updated_by) if self.updated_by else None@property@@ -564,18 +562,17 @@ class Workflow(Base): # bugreturn helper.generate_text_hash(json.dumps(entity, sort_keys=True))- @property@deprecated(- "This property is not accurate for determining if a workflow is published as a tool."+ "This method is not accurate for determining if a workflow is published as a tool.""It only checks if there's a WorkflowToolProvider for the app, ""not if this specific workflow version is the one being used by the tool.")- def tool_published(self) -> bool:- return self.get_tool_published(session=db.session())+ def tool_published(self, session: orm.Session) -> bool:+ return self.get_tool_published(session=session)- def get_tool_published(self, *, session: orm.Session) -> bool:+ def get_tool_published(self, session: orm.Session) -> bool:"""- DEPRECATED: This property is not accurate for determining if a workflow is published as a tool.+ DEPRECATED: This method is not accurate for determining if a workflow is published as a tool.It only checks if there's a WorkflowToolProvider for the app, not if this specific workflow versionis the one being used by the tool.diff --git a/api/tests/unit_tests/controllers/console/app/test_workflow.py b/api/tests/unit_tests/controllers/console/app/test_workflow.pyindex e4e30edd21d..5a5bf81336d 100644--- a/api/tests/unit_tests/controllers/console/app/test_workflow.py+++ b/api/tests/unit_tests/controllers/console/app/test_workflow.py@@ -78,6 +78,9 @@ def _make_workflow(**overrides):)for key, value in overrides.items():setattr(workflow, key, value)+ workflow.get_created_by_account = Mock(return_value=workflow.created_by_account)+ workflow.get_updated_by_account = Mock(return_value=workflow.updated_by_account)+ workflow.get_tool_published = Mock(return_value=workflow.tool_published)return workflow@@ -617,6 +620,25 @@ def test_draft_workflow_get_serializes_response_model(monkeypatch: pytest.Monkey]+def test_published_workflow_get_uses_session_aware_response_source(monkeypatch: pytest.MonkeyPatch) -> None:+ workflow = _make_workflow()+ session = Mock(spec=Session)+ monkeypatch.setattr(workflow_module, "db", SimpleNamespace(session=Mock(return_value=session)))+ monkeypatch.setattr(+ workflow_module, "WorkflowService", lambda: SimpleNamespace(get_published_workflow=lambda **_kwargs: workflow)+ )++ api = workflow_module.PublishedWorkflowApi()+ handler = inspect.unwrap(api.get)++ response = handler(api, app_model=SimpleNamespace(id="app"))++ assert response["id"] == "workflow-1"+ workflow.get_created_by_account.assert_called_once_with(session=session)+ workflow.get_updated_by_account.assert_called_once_with(session=session)+ workflow.get_tool_published.assert_called_once_with(session=session)++def test_pipeline_variable_response_accepts_legacy_file_field_names() -> None:response = workflow_module.PipelineVariableResponse.model_validate({diff --git a/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py b/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.pyindex ad4de5468ab..8af0e633620 100644--- a/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py+++ b/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py@@ -37,6 +37,32 @@ def _snippet(**overrides) -> CustomizedSnippet:return CustomizedSnippet(**data)+def _workflow(**overrides) -> SimpleNamespace:+ data = {+ "id": "workflow-1",+ "graph_dict": {"nodes": [], "edges": []},+ "features_dict": {},+ "unique_hash": "hash-1",+ "version": "2024-01-01 00:00:00",+ "marked_name": "v1",+ "marked_comment": "first version",+ "created_by_account": None,+ "created_at": datetime(2024, 1, 1),+ "updated_by_account": None,+ "updated_at": datetime(2024, 1, 1),+ "tool_published": False,+ "environment_variables": [],+ "conversation_variables": [],+ "rag_pipeline_variables": [],+ }+ data.update(overrides)+ workflow = SimpleNamespace(**data)+ workflow.get_created_by_account = Mock(return_value=workflow.created_by_account)+ workflow.get_updated_by_account = Mock(return_value=workflow.updated_by_account)+ workflow.get_tool_published = Mock(return_value=workflow.tool_published)+ return workflow++@pytest.fixture(autouse=True)def _patch_snippet_service_factory(monkeypatch: pytest.MonkeyPatch, sqlite_engine: Engine) -> None:snippet_session_maker = sessionmaker(bind=sqlite_engine, expire_on_commit=False)@@ -114,6 +140,34 @@ def test_draft_workflow_get_raises_when_missing(app: Flask, monkeypatch: pytest.handler(api, snippet=snippet)+def test_draft_workflow_get_uses_session_aware_response_source(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:+ workflow = _workflow()+ snippet = _snippet()+ session = Mock(spec=Session)+ monkeypatch.setattr(snippet_workflow_module, "db", SimpleNamespace(session=Mock(return_value=session)))+ monkeypatch.setattr(+ snippet_workflow_module,+ "_snippet_service",+ lambda: SimpleNamespace(get_draft_workflow=Mock(return_value=workflow)),+ )+ monkeypatch.setattr(+ snippet_workflow_module.WorkflowAgentPublishService,+ "project_draft_bindings_to_graph",+ Mock(return_value=workflow.graph_dict),+ )++ api = snippet_workflow_module.SnippetDraftWorkflowApi()+ handler = unwrap(api.get)++ with app.test_request_context("/snippets/snippet-1/workflows/draft"):+ response = handler(api, snippet=snippet)++ assert response["id"] == "workflow-1"+ workflow.get_created_by_account.assert_called_once_with(session=session)+ workflow.get_updated_by_account.assert_called_once_with(session=session)+ workflow.get_tool_published.assert_called_once_with(session=session)++def test_draft_workflow_post_returns_400_for_invalid_graph(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:user = _account("account-1")snippet = _snippet()@@ -161,6 +215,29 @@ def test_published_workflow_get_returns_none_when_not_published(app) -> None:assert handler(api, snippet=SimpleNamespace(id="snippet-1", is_published=False)) is None+def test_published_workflow_get_uses_session_aware_response_source(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:+ workflow = _workflow()+ session = Mock(spec=Session)+ snippet = SimpleNamespace(id="snippet-1", is_published=True, input_fields_list=[])+ monkeypatch.setattr(snippet_workflow_module, "db", SimpleNamespace(session=Mock(return_value=session)))+ monkeypatch.setattr(+ snippet_workflow_module,+ "_snippet_service",+ lambda: SimpleNamespace(get_published_workflow=Mock(return_value=workflow)),+ )++ api = snippet_workflow_module.SnippetPublishedWorkflowApi()+ handler = unwrap(api.get)++ with app.test_request_context("/snippets/snippet-1/workflows/publish"):+ response = handler(api, snippet=snippet)++ assert response["id"] == "workflow-1"+ workflow.get_created_by_account.assert_called_once_with(session=session)+ workflow.get_updated_by_account.assert_called_once_with(session=session)+ workflow.get_tool_published.assert_called_once_with(session=session)++@pytest.mark.parametrize("sqlite_session", [(CustomizedSnippet,)], indirect=True)def test_published_workflow_post_returns_400_when_publish_fails(app: Flask,@@ -247,23 +324,7 @@ def test_list_published_snippet_workflows_includes_input_fields(monkeypatch: pytest.MonkeyPatch,sqlite_engine: Engine,) -> None:- workflow = SimpleNamespace(- id="workflow-1",- graph_dict={"nodes": [], "edges": []},- features_dict={},- unique_hash="hash-1",- version="2024-01-01 00:00:00",- marked_name="",- marked_comment="",- created_by_account=None,- created_at=datetime(2024, 1, 1),- updated_by_account=None,- updated_at=datetime(2024, 1, 1),- tool_published=False,- environment_variables=[],- conversation_variables=[],- rag_pipeline_variables=[],- )+ workflow = _workflow(marked_name="", marked_comment="")input_fields = [{"variable": "query", "type": "text"}]snippet = _snippet(input_fields=json.dumps(input_fields))@@ -406,23 +467,7 @@ def test_update_published_snippet_workflow_returns_updated_workflow(monkeypatch: pytest.MonkeyPatch,sqlite_session: Session,) -> None:- workflow = SimpleNamespace(- id="workflow-1",- graph_dict={"nodes": [], "edges": []},- features_dict={},- unique_hash="hash-1",- version="2024-01-01 00:00:00",- marked_name="v1",- marked_comment="first version",- created_by_account=None,- created_at=datetime(2024, 1, 1),- updated_by_account=None,- updated_at=datetime(2024, 1, 1),- tool_published=False,- environment_variables=[],- conversation_variables=[],- rag_pipeline_variables=[],- )+ workflow = _workflow()user = _account("account-1")input_fields = [{"variable": "query", "type": "text"}]snippet = _snippet(input_fields=json.dumps(input_fields))diff --git a/api/tests/unit_tests/models/test_workflow.py b/api/tests/unit_tests/models/test_workflow.pyindex ed6d4ed88c7..4e77e3e80cb 100644--- a/api/tests/unit_tests/models/test_workflow.py+++ b/api/tests/unit_tests/models/test_workflow.py@@ -175,7 +175,7 @@ def test_to_dict():@pytest.mark.parametrize("sqlite_session", [(Workflow, Account)], indirect=True)-def test_workflow_account_getters_use_caller_session(sqlite_session: Session):+def test_workflow_account_accessors_use_caller_session(sqlite_session: Session):created_account = Account(name="Created Account", email="[email protected]")created_account.id = "created-account-id"updated_account = Account(name="Updated Account", email="[email protected]")@@ -197,12 +197,12 @@ def test_workflow_account_getters_use_caller_session(sqlite_session: Session):sqlite_session.add_all([decoy_account, updated_account, workflow, created_account])sqlite_session.flush()- assert workflow.get_created_by_account(session=sqlite_session) is created_account- assert workflow.get_updated_by_account(session=sqlite_session) is updated_account+ assert workflow.created_by_account(sqlite_session) is created_account+ assert workflow.updated_by_account(sqlite_session) is updated_account@pytest.mark.parametrize("sqlite_session", [(Workflow, WorkflowToolProvider)], indirect=True)-def test_workflow_tool_published_getter_uses_caller_session(sqlite_session: Session):+def test_workflow_tool_published_accessor_uses_caller_session(sqlite_session: Session):workflow = Workflow(tenant_id="tenant_id",app_id="app_id",@@ -237,7 +237,8 @@ def test_workflow_tool_published_getter_uses_caller_session(sqlite_session: Sesssqlite_session.add_all([decoy_provider, workflow, matching_provider])sqlite_session.flush()- assert workflow.get_tool_published(session=sqlite_session) is True+ with pytest.warns(DeprecationWarning, match="not accurate"):+ assert workflow.tool_published(sqlite_session) is Truedef test_normalize_environment_variable_mappings_converts_full_mask_to_hidden_value():