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(api): inject sessions into RAG pipeline console controllers (#45605)

Evan5d0c0b665744
diff --git a/api/controllers/console/datasets/rag_pipeline/datasource_auth.py b/api/controllers/console/datasets/rag_pipeline/datasource_auth.py
index 5bc592a4b20..b2cdc780aef 100644
--- a/api/controllers/console/datasets/rag_pipeline/datasource_auth.py
+++ b/api/controllers/console/datasets/rag_pipeline/datasource_auth.py
@@ -3,12 +3,14 @@ from typing import Any
from flask import make_response, redirect, request
from flask_restx import Resource
from pydantic import BaseModel, Field
+from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden, NotFound
from configs import dify_config
from controllers.common.fields import SimpleResultResponse
from controllers.common.rbac import RBACCheck, Workspace
from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models
+from controllers.common.session import with_session
from controllers.console import console_ns
from controllers.console.wraps import (
RBACPermission,
@@ -25,7 +27,6 @@ from core.plugin.entities.plugin_daemon import PluginOAuthAuthorizationUrlRespon
from core.plugin.impl.oauth import OAuthHandler
from core.tools.entities.common_entities import I18nObject
from extensions.ext_application_services import application_services
-from extensions.ext_database import db
from fields.base import ResponseModel
from graphon.model_runtime.errors.validate import CredentialsValidateFailedError
from libs.helper import dump_response
@@ -379,8 +380,11 @@ class DatasourceAuthDeleteApi(Resource):
@edit_permission_required
@rbac_permission_required(RBACCheck(RBACPermission.CREDENTIAL_MANAGE, Workspace()))
@with_current_tenant_id
+ @with_session
@model_validate(DatasourceCredentialDeletePayload)
- def post(self, req_data: DatasourceCredentialDeletePayload, current_tenant_id: str, provider_id: str):
+ def post(
+ self, req_data: DatasourceCredentialDeletePayload, session: Session, current_tenant_id: str, provider_id: str
+ ):
datasource_provider_id = DatasourceProviderID(provider_id)
plugin_id = datasource_provider_id.plugin_id
provider_name = datasource_provider_id.provider_name
@@ -391,7 +395,7 @@ class DatasourceAuthDeleteApi(Resource):
auth_id=req_data.credential_id,
provider=provider_name,
plugin_id=plugin_id,
- session=db.session(),
+ session=session,
)
return SimpleResultResponse(result="success").model_dump(mode="json"), 200
@@ -436,11 +440,12 @@ class DatasourceAuthListApi(Resource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- def get(self, current_tenant_id: str, user: Account):
+ @with_session(write=False)
+ def get(self, session: Session, current_tenant_id: str, user: Account):
datasource_provider_service = application_services().data_sources.providers
datasources = datasource_provider_service.get_all_datasource_credentials(
tenant_id=current_tenant_id,
- session=db.session(),
+ session=session,
user=user,
credential_query=application_services().credential_queries,
)
@@ -459,11 +464,12 @@ class DatasourceHardCodeAuthListApi(Resource):
@account_initialization_required
@with_current_user
@with_current_tenant_id
- def get(self, current_tenant_id: str, user: Account):
+ @with_session(write=False)
+ def get(self, session: Session, current_tenant_id: str, user: Account):
datasource_provider_service = application_services().data_sources.providers
datasources = datasource_provider_service.get_hard_code_datasource_credentials(
tenant_id=current_tenant_id,
- session=db.session(),
+ session=session,
user=user,
credential_query=application_services().credential_queries,
)
diff --git a/api/controllers/console/datasets/rag_pipeline/datasource_content_preview.py b/api/controllers/console/datasets/rag_pipeline/datasource_content_preview.py
index 048f5cf858d..452df31c6f5 100644
--- a/api/controllers/console/datasets/rag_pipeline/datasource_content_preview.py
+++ b/api/controllers/console/datasets/rag_pipeline/datasource_content_preview.py
@@ -4,13 +4,14 @@ from flask_restx import ( # type: ignore
Resource, # type: ignore
)
from pydantic import BaseModel
+from sqlalchemy.orm import Session
from controllers.common.schema import register_schema_models
+from controllers.common.session import with_session
from controllers.console import console_ns
from controllers.console.datasets.wraps import get_rag_pipeline
from controllers.console.wraps import account_initialization_required, model_validate, setup_required, with_current_user
from extensions.ext_application_services import application_services
-from extensions.ext_database import db
from libs.login import login_required
from models import Account
from models.dataset import Pipeline
@@ -35,15 +36,23 @@ class DataSourceContentPreviewApi(Resource):
@account_initialization_required
@get_rag_pipeline
@with_current_user
+ @with_session
@model_validate(DatasourceContentPreviewPayload)
- def post(self, req_data: DatasourceContentPreviewPayload, current_user: Account, pipeline: Pipeline, node_id: str):
+ def post(
+ self,
+ req_data: DatasourceContentPreviewPayload,
+ session: Session,
+ current_user: Account,
+ pipeline: Pipeline,
+ node_id: str,
+ ):
"""
Run datasource content preview
"""
inputs = req_data.inputs
datasource_type = req_data.datasource_type
- rag_pipeline_service = RagPipelineService(db.session())
+ rag_pipeline_service = RagPipelineService(session)
preview_content = rag_pipeline_service.run_datasource_node_preview(
pipeline=pipeline,
node_id=node_id,
diff --git a/api/controllers/console/datasets/rag_pipeline/rag_pipeline.py b/api/controllers/console/datasets/rag_pipeline/rag_pipeline.py
index 6ae8232288d..079e927f24d 100644
--- a/api/controllers/console/datasets/rag_pipeline/rag_pipeline.py
+++ b/api/controllers/console/datasets/rag_pipeline/rag_pipeline.py
@@ -29,7 +29,6 @@ from controllers.console.wraps import (
with_current_tenant_id,
with_current_user,
)
-from extensions.ext_database import db
from fields.base import ResponseModel
from libs.helper import dump_response
from libs.login import login_required
@@ -169,17 +168,19 @@ class CustomizedPipelineTemplateApi(Resource):
@enterprise_license_required
@with_current_user
@with_current_tenant_id
+ @with_session
@model_validate(CustomizedPipelineTemplatePayload)
def patch(
self,
req_data: CustomizedPipelineTemplatePayload,
+ session: Session,
current_tenant_id: str,
current_user: Account,
template_id: str,
) -> tuple[str, int]:
pipeline_template_info = PipelineTemplateInfoEntity.model_validate(req_data.model_dump())
RagPipelineService.update_customized_pipeline_template(
- template_id, pipeline_template_info, current_user, current_tenant_id, session=db.session()
+ template_id, pipeline_template_info, current_user, current_tenant_id, session=session
)
return "", 204
@@ -189,8 +190,9 @@ class CustomizedPipelineTemplateApi(Resource):
@account_initialization_required
@enterprise_license_required
@with_current_tenant_id
- def delete(self, current_tenant_id: str, template_id: str) -> tuple[str, int]:
- RagPipelineService.delete_customized_pipeline_template(template_id, current_tenant_id, session=db.session())
+ @with_session
+ def delete(self, session: Session, current_tenant_id: str, template_id: str) -> tuple[str, int]:
+ RagPipelineService.delete_customized_pipeline_template(template_id, current_tenant_id, session=session)
return "", 204
@setup_required
@@ -225,14 +227,15 @@ class PublishCustomizedPipelineTemplateApi(Resource):
@with_current_user
@get_rag_pipeline
@rbac_permission_required(RBACCheck(RBACPermission.DATASET_PIPELINE_RELEASE, DatasetByPipeline()))
+ @with_session
@model_validate(CustomizedPipelineTemplatePayload)
def post(
self,
req_data: CustomizedPipelineTemplatePayload,
+ session: Session,
current_user: Account,
pipeline: Pipeline,
) -> tuple[str, int]:
- session = db.session()
dataset = get_pipeline_dataset(pipeline, session=session)
if dataset is None:
raise NotFound("Dataset not found")
diff --git a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
index 4ed6cb5a3e4..1de3347b5a3 100644
--- a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
+++ b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
@@ -1,10 +1,12 @@
from flask_restx import Resource
from pydantic import BaseModel
+from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden
import services
from configs import dify_config
from controllers.common.schema import JsonResponseWithStatus, register_response_schema_models, register_schema_models
+from controllers.common.session import with_session
from controllers.console import console_ns
from controllers.console.datasets.error import DatasetNameDuplicateError
from controllers.console.datasets.rag_pipeline.rag_pipeline_import import RagPipelineImportResponse
@@ -16,7 +18,6 @@ from controllers.console.wraps import (
with_current_tenant_id,
with_current_user,
)
-from extensions.ext_database import db
from fields.dataset_fields import (
DatasetDetailResponse,
)
@@ -56,10 +57,12 @@ class CreateRagPipelineDatasetApi(Resource):
@cloud_edition_billing_rate_limit_check("knowledge")
@with_current_user
@with_current_tenant_id
+ @with_session
@model_validate(RagPipelineDatasetImportPayload)
def post(
self,
req_data: RagPipelineDatasetImportPayload,
+ session: Session,
current_tenant_id: str,
current_user: Account,
) -> JsonResponseWithStatus:
@@ -79,7 +82,7 @@ class CreateRagPipelineDatasetApi(Resource):
yaml_content=req_data.yaml_content,
)
try:
- rag_pipeline_dsl_service = RagPipelineDslService(db.session())
+ rag_pipeline_dsl_service = RagPipelineDslService(session)
import_info = rag_pipeline_dsl_service.create_rag_pipeline_dataset(
tenant_id=current_tenant_id,
rag_pipeline_dataset_create_entity=rag_pipeline_dataset_create_entity,
@@ -90,9 +93,10 @@ class CreateRagPipelineDatasetApi(Resource):
current_tenant_id,
dataset_id,
rag_pipeline_dataset_create_entity.partial_member_list,
- db.session(),
+ session,
)
- db.session.commit()
+ # Commit before the RBAC sync below, which runs outside this session.
+ session.commit()
except services.errors.dataset.DatasetNameDuplicateError as caught_error:
raise DatasetNameDuplicateError() from caught_error
@@ -122,11 +126,11 @@ class CreateEmptyRagPipelineDatasetApi(Resource):
@cloud_edition_billing_rate_limit_check("knowledge")
@with_current_user
@with_current_tenant_id
- def post(self, current_tenant_id: str, current_user: Account) -> JsonResponseWithStatus:
+ @with_session
+ def post(self, session: Session, current_tenant_id: str, current_user: Account) -> JsonResponseWithStatus:
# The role of the current user in the ta table must be admin, owner, or editor, or dataset_operator
if not current_user.is_dataset_editor:
raise Forbidden()
- session = db.session()
dataset = DatasetService.create_empty_rag_pipeline_dataset(
tenant_id=current_tenant_id,
rag_pipeline_dataset_create_entity=RagPipelineDatasetCreateEntity(
diff --git a/api/tests/e2e_tests/containers/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py b/api/tests/e2e_tests/containers/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
index 034379520db..e82e7053808 100644
--- a/api/tests/e2e_tests/containers/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
+++ b/api/tests/e2e_tests/containers/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
@@ -48,7 +48,7 @@ def test_create_empty_rag_pipeline_dataset_serializes_persisted_models(
),
):
response, status = unwrap(CreateEmptyRagPipelineDatasetApi().post)(
- CreateEmptyRagPipelineDatasetApi(), tenant_id, MagicMock(is_dataset_editor=True)
+ CreateEmptyRagPipelineDatasetApi(), db_session_with_containers, tenant_id, MagicMock(is_dataset_editor=True)
)
assert status == 201
diff --git a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_auth.py b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_auth.py
index 6045b0b1816..cc6502336d9 100644
--- a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_auth.py
+++ b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_auth.py
@@ -2,7 +2,7 @@ import inspect
from datetime import UTC, datetime
from importlib import import_module
from types import SimpleNamespace
-from unittest.mock import ANY, MagicMock, patch
+from unittest.mock import MagicMock, patch
import pytest
from flask import Flask
@@ -565,7 +565,7 @@ class TestDatasourceAuth:
class TestDatasourceAuthDeleteApi:
- def test_delete_success(self, app: Flask):
+ def test_delete_success(self, app: Flask, unbound_session: Session):
api = DatasourceAuthDeleteApi()
method = inspect.unwrap(api.post)
@@ -581,7 +581,7 @@ class TestDatasourceAuthDeleteApi:
) as remove_datasource_credentials,
):
req_data = DatasourceCredentialDeletePayload.model_validate(payload)
- response, status = method(api, req_data, "tenant-1", _PROVIDER_ID)
+ response, status = method(api, req_data, unbound_session, "tenant-1", _PROVIDER_ID)
assert response == _success_response()
assert status == 200
@@ -590,10 +590,10 @@ class TestDatasourceAuthDeleteApi:
auth_id="cred-1",
provider="notion",
plugin_id="langgenius/notion_datasource",
- session=ANY,
+ session=unbound_session,
)
- def test_delete_missing_credential_id(self, app: Flask):
+ def test_delete_missing_credential_id(self, app: Flask, unbound_session: Session):
api = DatasourceAuthDeleteApi()
method = inspect.unwrap(api.post)
@@ -606,7 +606,13 @@ class TestDatasourceAuthDeleteApi:
with pytest.raises(
ValueError, match="1 validation error for DatasourceCredentialDeletePayload\\\ncredential_id"
):
- method(api, DatasourceCredentialDeletePayload.model_validate(payload), "tenant-1", "notion")
+ method(
+ api,
+ DatasourceCredentialDeletePayload.model_validate(payload),
+ unbound_session,
+ "tenant-1",
+ "notion",
+ )
class TestDatasourceAuthUpdateApi:
@@ -711,7 +717,7 @@ class TestDatasourceAuthUpdateApi:
class TestDatasourceAuthListApi:
- def test_list_success(self, app: Flask):
+ def test_list_success(self, app: Flask, unbound_session: Session):
api = DatasourceAuthListApi()
method = inspect.unwrap(api.get)
user = MagicMock(id="user-1")
@@ -724,15 +730,16 @@ class TestDatasourceAuthListApi:
return_value=[_datasource_auth()],
) as get_all,
):
- response, status = method(api, "tenant-1", user)
+ response, status = method(api, unbound_session, "tenant-1", user)
assert status == 200
assert response == {"result": [_datasource_auth()]}
# user is threaded through so list_datasource_credentials applies the
# visibility filter for the current viewer.
assert get_all.call_args.kwargs["user"] is user
+ assert get_all.call_args.kwargs["session"] is unbound_session
- def test_auth_list_empty(self, app: Flask):
+ def test_auth_list_empty(self, app: Flask, unbound_session: Session):
api = DatasourceAuthListApi()
method = inspect.unwrap(api.get)
user = MagicMock(id="user-1")
@@ -745,12 +752,12 @@ class TestDatasourceAuthListApi:
return_value=[],
),
):
- response, status = method(api, "tenant-1", user)
+ response, status = method(api, unbound_session, "tenant-1", user)
assert status == 200
assert response["result"] == []
- def test_hardcode_list_empty(self, app: Flask):
+ def test_hardcode_list_empty(self, app: Flask, unbound_session: Session):
api = DatasourceHardCodeAuthListApi()
method = inspect.unwrap(api.get)
user = MagicMock(id="user-1")
@@ -763,14 +770,14 @@ class TestDatasourceAuthListApi:
return_value=[],
),
):
- response, status = method(api, "tenant-1", user)
+ response, status = method(api, unbound_session, "tenant-1", user)
assert status == 200
assert response["result"] == []
class TestDatasourceHardCodeAuthListApi:
- def test_list_success(self, app: Flask):
+ def test_list_success(self, app: Flask, unbound_session: Session):
api = DatasourceHardCodeAuthListApi()
method = inspect.unwrap(api.get)
user = MagicMock(id="user-1")
@@ -783,10 +790,11 @@ class TestDatasourceHardCodeAuthListApi:
return_value=[_datasource_auth()],
) as get_hardcode,
):
- response, status = method(api, "tenant-1", user)
+ response, status = method(api, unbound_session, "tenant-1", user)
assert status == 200
assert get_hardcode.call_args.kwargs["user"] is user
+ assert get_hardcode.call_args.kwargs["session"] is unbound_session
class TestDatasourceAuthOauthCustomClient:
diff --git a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_content_preview.py b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_content_preview.py
index 958bd7dc91d..37f70ff8e6b 100644
--- a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_content_preview.py
+++ b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_datasource_content_preview.py
@@ -3,6 +3,7 @@ from unittest.mock import ANY, MagicMock, patch
import pytest
from flask import Flask
+from sqlalchemy.orm import Session
from controllers.console import console_ns
from controllers.console.datasets.rag_pipeline.datasource_content_preview import (
@@ -27,7 +28,7 @@ class TestDataSourceContentPreviewApi:
"credential_id": "cred-1",
}
- def test_post_success(self, app: Flask) -> None:
+ def test_post_success(self, app: Flask, unbound_session: Session) -> None:
api = DataSourceContentPreviewApi()
method = unwrap(api.post)
@@ -48,11 +49,12 @@ class TestDataSourceContentPreviewApi:
patch(
"controllers.console.datasets.rag_pipeline.datasource_content_preview.RagPipelineService",
return_value=service_instance,
- ),
+ ) as service_cls,
):
req_data = DatasourceContentPreviewPayload.model_validate(payload)
- response, status = method(api, req_data, account, pipeline, node_id)
+ response, status = method(api, req_data, unbound_session, account, pipeline, node_id)
+ service_cls.assert_called_once_with(unbound_session)
service_instance.run_datasource_node_preview.assert_called_once_with(
pipeline=pipeline,
node_id=node_id,
@@ -66,7 +68,7 @@ class TestDataSourceContentPreviewApi:
assert status == 200
assert response == preview_result
- def test_post_invalid_payload(self, app: Flask) -> None:
+ def test_post_invalid_payload(self, app: Flask, unbound_session: Session) -> None:
api = DataSourceContentPreviewApi()
method = unwrap(api.post)
@@ -83,9 +85,16 @@ class TestDataSourceContentPreviewApi:
patch.object(type(console_ns), "payload", payload),
):
with pytest.raises(ValueError, match=r"datasource_type\n\s+Field required"):
- method(api, DatasourceContentPreviewPayload.model_validate(payload), account, pipeline, "node-1")
-
- def test_post_without_credential_id(self, app: Flask) -> None:
+ method(
+ api,
+ DatasourceContentPreviewPayload.model_validate(payload),
+ unbound_session,
+ account,
+ pipeline,
+ "node-1",
+ )
+
+ def test_post_without_credential_id(self, app: Flask, unbound_session: Session) -> None:
api = DataSourceContentPreviewApi()
method = unwrap(api.post)
@@ -110,7 +119,7 @@ class TestDataSourceContentPreviewApi:
),
):
req_data = DatasourceContentPreviewPayload.model_validate(payload)
- response, status = method(api, req_data, account, pipeline, "node-1")
+ response, status = method(api, req_data, unbound_session, account, pipeline, "node-1")
service_instance.run_datasource_node_preview.assert_called_once()
assert status == 200
diff --git a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline.py b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline.py
index 8b9d692e757..08c237d8093 100644
--- a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline.py
+++ b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline.py
@@ -191,7 +191,7 @@ class TestPipelineTemplateDetailApi:
class TestCustomizedPipelineTemplateApi:
- def test_patch_validates_payload_and_returns_empty_204(self, app: Flask) -> None:
+ def test_patch_validates_payload_and_returns_empty_204(self, app: Flask, unbound_session: Session) -> None:
api = CustomizedPipelineTemplateApi()
method = unwrap(api.patch)
payload = _payload()
@@ -207,7 +207,7 @@ class TestCustomizedPipelineTemplateApi:
*,
session,
) -> None:
- del session
+ assert session is unbound_session
service_calls.append((template_id, template_info, current_user, current_tenant_id))
with (
@@ -216,7 +216,12 @@ class TestCustomizedPipelineTemplateApi:
patch.object(module.RagPipelineService, "update_customized_pipeline_template", side_effect=update_template),
):
response, status = method(
- api, CustomizedPipelineTemplatePayload.model_validate(payload), tenant_id, account, "template-1"
+ api,
+ CustomizedPipelineTemplatePayload.model_validate(payload),
+ unbound_session,
+ tenant_id,
+ account,
+ "template-1",
)
assert (response, status) == ("", 204)
@@ -234,7 +239,7 @@ class TestCustomizedPipelineTemplateApi:
"icon_url": None,
}
- def test_patch_defaults_missing_icon_info_before_service_call(self, app: Flask) -> None:
+ def test_patch_defaults_missing_icon_info_before_service_call(self, app: Flask, unbound_session: Session) -> None:
api = CustomizedPipelineTemplateApi()
method = unwrap(api.patch)
payload: dict[str, object] = {
@@ -253,7 +258,7 @@ class TestCustomizedPipelineTemplateApi:
*,
session,
) -> None:
- del session
+ assert session is unbound_session
service_calls.append((template_id, template_info, current_user, current_tenant_id))
with (
@@ -262,7 +267,12 @@ class TestCustomizedPipelineTemplateApi:
patch.object(module.RagPipelineService, "update_customized_pipeline_template", side_effect=update_template),
):
response, status = method(
- api, CustomizedPipelineTemplatePayload.model_validate(payload), tenant_id, account, "template-1"
+ api,
+ CustomizedPipelineTemplatePayload.model_validate(payload),
+ unbound_session,
+ tenant_id,
+ account,
+ "template-1",
)
assert (response, status) == ("", 204)
@@ -278,21 +288,21 @@ class TestCustomizedPipelineTemplateApi:
"icon_url": None,
}
- def test_delete_returns_empty_204(self, app: Flask) -> None:
+ def test_delete_returns_empty_204(self, app: Flask, unbound_session: Session) -> None:
api = CustomizedPipelineTemplateApi()
method = unwrap(api.delete)
tenant_id = "tenant-1"
deleted_templates: list[tuple[str, str]] = []
def delete_template(template_id: str, current_tenant_id: str, *, session) -> None:
- del session
+ assert session is unbound_session
deleted_templates.append((template_id, current_tenant_id))
with (
app.test_request_context("/rag/pipeline/customized/templates/template-1", method="DELETE"),
patch.object(module.RagPipelineService, "delete_customized_pipeline_template", side_effect=delete_template),
):
- response, status = method(api, tenant_id, "template-1")
+ response, status = method(api, unbound_session, tenant_id, "template-1")
assert (response, status) == ("", 204)
assert deleted_templates == [("template-1", tenant_id)]
@@ -365,7 +375,7 @@ class TestPublishCustomizedPipelineTemplateApi:
[check] = rbac_checks(PublishCustomizedPipelineTemplateApi.post)
assert check.scene == module.RBACPermission.DATASET_PIPELINE_RELEASE
- def test_post_validates_payload_and_returns_empty_204(self) -> None:
+ def test_post_validates_payload_and_returns_empty_204(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
payload = _payload()
@@ -379,10 +389,12 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module.DatasetService, "check_dataset_permission") as legacy_acl,
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
):
- response, status = method(api, CustomizedPipelineTemplatePayload.model_validate(payload), account, pipeline)
+ response, status = method(
+ api, CustomizedPipelineTemplatePayload.model_validate(payload), unbound_session, account, pipeline
+ )
assert (response, status) == ("", 204)
- publish.assert_called_once_with(pipeline, dataset, payload, account, session=ANY)
+ publish.assert_called_once_with(pipeline, dataset, payload, account, session=unbound_session)
legacy_acl.assert_not_called()
@pytest.mark.parametrize(
@@ -399,6 +411,7 @@ class TestPublishCustomizedPipelineTemplateApi:
self,
payload: dict[str, object],
expected_icon_info: dict[str, object | None],
+ unbound_session: Session,
) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
@@ -411,13 +424,15 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module, "get_pipeline_dataset", return_value=dataset),
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
):
- response, status = method(api, CustomizedPipelineTemplatePayload.model_validate(payload), account, pipeline)
+ response, status = method(
+ api, CustomizedPipelineTemplatePayload.model_validate(payload), unbound_session, account, pipeline
+ )
assert (response, status) == ("", 204)
- publish.assert_called_once_with(pipeline, dataset, ANY, account, session=ANY)
+ publish.assert_called_once_with(pipeline, dataset, ANY, account, session=unbound_session)
assert publish.call_args.args[2]["icon_info"] == expected_icon_info
- def test_post_translates_missing_owned_resource_to_not_found(self) -> None:
+ def test_post_translates_missing_owned_resource_to_not_found(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
payload = _payload()
@@ -432,9 +447,11 @@ class TestPublishCustomizedPipelineTemplateApi:
),
pytest.raises(NotFound, match="Workflow not found"),
):
- method(api, CustomizedPipelineTemplatePayload.model_validate(payload), _account(), _pipeline())
+ method(
+ api, CustomizedPipelineTemplatePayload.model_validate(payload), unbound_session, _account(), _pipeline()
+ )
- def test_post_allows_legacy_dataset_operator_after_dataset_acl(self) -> None:
+ def test_post_allows_legacy_dataset_operator_after_dataset_acl(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
account = _account()
@@ -449,13 +466,15 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module.DatasetService, "check_dataset_permission") as check_permission,
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
):
- response = method(api, CustomizedPipelineTemplatePayload.model_validate(payload), account, pipeline)
+ response = method(
+ api, CustomizedPipelineTemplatePayload.model_validate(payload), unbound_session, account, pipeline
+ )
assert response == ("", 204)
assert check_permission.call_args.args[:2] == (dataset, account)
- publish.assert_called_once_with(pipeline, dataset, payload, account, session=ANY)
+ publish.assert_called_once_with(pipeline, dataset, payload, account, session=unbound_session)
- def test_post_rejects_legacy_non_editor_before_dataset_acl(self) -> None:
+ def test_post_rejects_legacy_non_editor_before_dataset_acl(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
account = _account()
@@ -468,12 +487,14 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
pytest.raises(Forbidden),
):
- method(api, CustomizedPipelineTemplatePayload.model_validate(_payload()), account, _pipeline())
+ method(
+ api, CustomizedPipelineTemplatePayload.model_validate(_payload()), unbound_session, account, _pipeline()
+ )
check_permission.assert_not_called()
publish.assert_not_called()
- def test_post_rejects_legacy_dataset_acl_before_publish(self) -> None:
+ def test_post_rejects_legacy_dataset_acl_before_publish(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
account = _account()
@@ -490,11 +511,13 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
pytest.raises(Forbidden, match="Dataset is private"),
):
- method(api, CustomizedPipelineTemplatePayload.model_validate(_payload()), account, _pipeline())
+ method(
+ api, CustomizedPipelineTemplatePayload.model_validate(_payload()), unbound_session, account, _pipeline()
+ )
publish.assert_not_called()
- def test_post_rejects_missing_legacy_dataset_before_publish(self) -> None:
+ def test_post_rejects_missing_legacy_dataset_before_publish(self, unbound_session: Session) -> None:
api = PublishCustomizedPipelineTemplateApi()
method = unwrap(api.post)
account = _account()
@@ -507,7 +530,9 @@ class TestPublishCustomizedPipelineTemplateApi:
patch.object(module.RagPipelineService, "publish_customized_pipeline_template") as publish,
pytest.raises(NotFound, match="Dataset not found"),
):
- method(api, CustomizedPipelineTemplatePayload.model_validate(_payload()), account, _pipeline())
+ method(
+ api, CustomizedPipelineTemplatePayload.model_validate(_payload()), unbound_session, account, _pipeline()
+ )
check_permission.assert_not_called()
publish.assert_not_called()
diff --git a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
index eef7b21225e..bf632f55d94 100644
--- a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
+++ b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
@@ -7,6 +7,7 @@ from unittest.mock import MagicMock, patch
import pytest
from flask import Flask
+from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden
import services
@@ -37,7 +38,7 @@ class TestCreateRagPipelineDatasetApi:
def _valid_payload(self) -> dict[str, str]:
return {"yaml_content": "name: test"}
- def test_post_success(self, app: Flask) -> None:
+ def test_post_success(self, app: Flask, unbound_session: Session) -> None:
api = CreateRagPipelineDatasetApi()
method = unwrap(api.post)
@@ -62,10 +63,13 @@ class TestCreateRagPipelineDatasetApi:
patch(
"controllers.console.datasets.rag_pipeline.rag_pipeline_datasets.RagPipelineDslService",
return_value=mock_service,
- ),
+ ) as dsl_service_cls,
):
- response, status = method(api, RagPipelineDatasetImportPayload.model_validate(payload), "tenant-1", user)
+ response, status = method(
+ api, RagPipelineDatasetImportPayload.model_validate(payload), unbound_session, "tenant-1", user
+ )
+ dsl_service_cls.assert_called_once_with(unbound_session)
assert status == 201
assert response == {
"id": "import-1",
@@ -77,7 +81,7 @@ class TestCreateRagPipelineDatasetApi:
"error": "",
}
- def test_post_success_syncs_creator_under_rbac(self, app: Flask) -> None:
+ def test_post_success_syncs_creator_under_rbac(self, app: Flask, unbound_session: Session) -> None:
"""RBAC: RAG-pipeline dataset create must keep the creator bound to their own dataset.
Regression guard for the #42430 flip to automatic_include_workspace_members=False:
@@ -102,10 +106,12 @@ class TestCreateRagPipelineDatasetApi:
mock_service = MagicMock()
mock_service.create_rag_pipeline_dataset.return_value = import_info
+ events: list[str] = []
with (
app.test_request_context("/", json=payload),
patch.object(type(console_ns), "payload", payload),
+ patch.object(unbound_session, "commit", side_effect=lambda: events.append("commit")),
config_overrides_context(RBAC_ENABLED=True),
patch(
"controllers.console.datasets.rag_pipeline.rag_pipeline_datasets.RagPipelineDslService",
@@ -115,17 +121,22 @@ class TestCreateRagPipelineDatasetApi:
"controllers.console.datasets.rag_pipeline.rag_pipeline_datasets.enterprise_rbac_service.RBACService.DatasetAccess.replace_whitelist"
),
patch(
- "controllers.console.datasets.rag_pipeline.rag_pipeline_datasets.enterprise_rbac_service.try_sync_creator_access_policy_member_bindings"
+ "controllers.console.datasets.rag_pipeline.rag_pipeline_datasets.enterprise_rbac_service.try_sync_creator_access_policy_member_bindings",
+ side_effect=lambda *_args: events.append("sync_creator"),
) as sync_creator,
):
- response, status = method(api, RagPipelineDatasetImportPayload.model_validate(payload), "tenant-1", user)
+ response, status = method(
+ api, RagPipelineDatasetImportPayload.model_validate(payload), unbound_session, "tenant-1", user
+ )
assert status == 201
assert sync_creator.called, "RAG pipeline create must sync the creator's own access"
sync_creator.assert_called_once_with("tenant-1", user.id, rbac_contracts.RBACResourceType.DATASET, "ds-1")
assert response["dataset_id"] == "ds-1"
+ # The RBAC service runs outside the request session, so the dataset must be committed first.
+ assert events == ["commit", "sync_creator"]
- def test_post_forbidden_non_editor(self, app: Flask) -> None:
+ def test_post_forbidden_non_editor(self, app: Flask, unbound_session: Session) -> None:
api = CreateRagPipelineDatasetApi()
method = unwrap(api.post)
@@ -137,9 +148,9 @@ class TestCreateRagPipelineDatasetApi:
patch.object(type(console_ns), "payload", payload),
):
with pytest.raises(Forbidden):
- method(api, RagPipelineDatasetImportPayload.model_validate(payload), "tenant-1", user)
+ method(api, RagPipelineDatasetImportPayload.model_validate(payload), unbound_session, "tenant-1", user)
- def test_post_dataset_name_duplicate(self, app: Flask) -> None:
+ def test_post_dataset_name_duplicate(self, app: Flask, unbound_session: Session) -> None:
api = CreateRagPipelineDatasetApi()
method = unwrap(api.post)
@@ -158,9 +169,9 @@ class TestCreateRagPipelineDatasetApi:
),
):
with pytest.raises(DatasetNameDuplicateError):
- method(api, RagPipelineDatasetImportPayload.model_validate(payload), "tenant-1", user)
+ method(api, RagPipelineDatasetImportPayload.model_validate(payload), unbound_session, "tenant-1", user)
- def test_post_invalid_payload(self, app: Flask) -> None:
+ def test_post_invalid_payload(self, app: Flask, unbound_session: Session) -> None:
api = CreateRagPipelineDatasetApi()
method = unwrap(api.post)
@@ -174,11 +185,11 @@ class TestCreateRagPipelineDatasetApi:
with pytest.raises(
ValueError, match="1 validation error for RagPipelineDatasetImportPayload\\\nyaml_content"
):
- method(api, RagPipelineDatasetImportPayload.model_validate(payload), "tenant-1", user)
+ method(api, RagPipelineDatasetImportPayload.model_validate(payload), unbound_session, "tenant-1", user)
class TestCreateEmptyRagPipelineDatasetApi:
- def test_post_forbidden_non_editor(self, app: Flask) -> None:
+ def test_post_forbidden_non_editor(self, app: Flask, unbound_session: Session) -> None:
api = CreateEmptyRagPipelineDatasetApi()
method = unwrap(api.post)
@@ -186,4 +197,4 @@ class TestCreateEmptyRagPipelineDatasetApi:
with app.test_request_context("/"):
with pytest.raises(Forbidden):
- method(api, "tenant-1", user)
+ method(api, unbound_session, "tenant-1", user)