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): thin console app controllers and separate application boundaries (#42671)

Byron.wang635143cb883d
diff --git a/api/controllers/console/agent/roster.py b/api/controllers/console/agent/roster.py
index 27e81239f48..576b9be7987 100644
--- a/api/controllers/console/agent/roster.py
+++ b/api/controllers/console/agent/roster.py
@@ -84,7 +84,7 @@ from services.agent.observability_service import (
AgentStatisticsQueryParams,
)
from services.agent.roster_service import AgentRosterService
-from services.app_service import AgentAppPublicationCounts, AppListParams, AppService, CreateAppParams
+from services.app_service import AgentAppPublicationCounts, AppListParams, AppResponseView, AppService, CreateAppParams
from services.enterprise import rbac_service as enterprise_rbac_service
from services.enterprise.enterprise_service import EnterpriseService
from services.entities.agent_entities import ComposerSavePayload, RosterListQuery
@@ -411,9 +411,8 @@ def _serialize_agent_app_detail(
roster_service = _agent_roster_service(session)
payload = GenericAppDetailWithSite.model_validate(
- app_model,
+ AppResponseView(app_model, session=session),
from_attributes=True,
- context={"session": session},
).model_dump(mode="json")
agent = (
session.scalar(
@@ -506,9 +505,8 @@ def _serialize_agent_app_pagination(
"limit": app_pagination.per_page,
"total": app_pagination.total,
"has_more": app_pagination.has_next,
- "data": app_pagination.items,
+ "data": [AppResponseView(app, session=session) for app in app_pagination.items],
},
- context={"session": session},
).model_dump(mode="json")
payload["publication_counts"] = {
"published": publication_counts.published,
diff --git a/api/controllers/console/app/app.py b/api/controllers/console/app/app.py
index 9bf89145992..9d624b71ab0 100644
--- a/api/controllers/console/app/app.py
+++ b/api/controllers/console/app/app.py
@@ -1,18 +1,13 @@
-import logging
import uuid
-from collections.abc import Sequence
-from datetime import datetime
-from typing import Any, Literal, Self
+from http import HTTPStatus
+from typing import Literal, Self, override
-from flask import send_file
+from flask import request, send_file
from flask_restx import Resource
-from pydantic import AliasChoices, BaseModel, Field, ValidationInfo, computed_field, field_validator, model_validator
-from sqlalchemy import select
-from sqlalchemy.orm import Session
+from pydantic import BaseModel, Field, field_validator, model_validator
from werkzeug.exceptions import BadRequest, Forbidden, NotFound
from configs import dify_config
-from controllers.common.app_access import resolve_app_access_filter
from controllers.common.fields import RedirectUrlResponse, SimpleResultResponse
from controllers.common.rbac import AgentBehindApp, PlainApp, RBACCheck, Workspace
from controllers.common.schema import (
@@ -23,54 +18,66 @@ from controllers.common.schema import (
register_schema_models,
)
from controllers.console import console_ns
-from controllers.console.app.error import TracingProviderUnavailableError
-from controllers.console.app.wraps import get_app_model, with_session
+from controllers.console.app.error import AppNotFoundError, TracingProviderUnavailableError
+from controllers.console.flask_admission import console_account_admission
from controllers.console.workspace.models import LoadBalancingPayload
from controllers.console.wraps import (
RBACPermission,
- account_initialization_required,
- cloud_edition_billing_resource_check,
- edit_permission_required,
- enterprise_license_required,
- is_admin_or_owner_required,
- model_validate,
- rbac_permission_required,
- setup_required,
- with_current_tenant_id,
- with_current_user,
- with_current_user_id,
+ validate_request,
)
from core.file.remote_file_metadata import FileInfo
-from core.ops.exceptions import TraceProviderNotInstalledError
-from core.ops.ops_trace_manager import OpsTraceManager
from core.rag.entities import PreProcessingRule, Rule, Segmentation
from core.rag.retrieval.retrieval_methods import RetrievalMethod
-from core.trigger.constants import TRIGGER_NODE_TYPES
-from enums import DeploymentEdition
from extensions.ext_application_services import application_services
-from extensions.ext_database import db
-from fields.base import ResponseModel
+from fields.app_fields import (
+ AppDetail,
+ AppDetailSiteResponse,
+ AppDetailWithSite,
+ AppExportResponse,
+ AppImportResponse,
+ AppModelConfigResponse,
+ AppPagination,
+ AppPartial,
+ AppTraceResponse,
+ DeletedTool,
+ ModelConfigPartial,
+ RecentAppListResponse,
+ RecentAppResponse,
+ Tag,
+ WorkflowPartial,
+)
from graphon.enums import WorkflowExecutionStatus
from libs.flask_restx_compat import BINARY_RESPONSE_MEDIA_TYPES_VENDOR_KEY
-from libs.helper import build_icon_url, dump_response, to_timestamp
-from libs.login import login_required
-from models import Account, App, DatasetPermissionEnum, Workflow
-from models.model import AppMode, IconType
-from services.agent.roster_package_exporter import RosterAgentPackageExporter
-from services.app_dsl_service import AppDslService
-from services.app_package_service import AppPackageService
-from services.app_service import (
+from libs.helper import dump_response
+from libs.url_utils import normalize_api_base_url
+from machinery.context import RequestContext
+from models import DatasetPermissionEnum
+from models.account import TenantAccountRole
+from models.model import IconType
+from services.app.console_service import (
+ AppExportAgentNotFoundError,
+ AppExportPaidPlanRequiredError,
+ ConsoleAppNotFoundError,
+ CreatorsPlatformDisabledError,
+ InvalidAppAccessModesError,
+ InvalidAppExportError,
+)
+from services.app_tracing_config_service import (
+ AppTracingConfigInvalidProviderError,
+ AppTracingConfigProviderUnavailableError,
+)
+from services.entities.app_entities import (
+ AppExportOptions,
AppListParams,
AppListSortBy,
- AppResponseView,
- AppService,
+ AppRecord,
+ AppTraceSettings,
+ CopyAppParams,
CreateAppParams,
- RecentAppMode,
StarredAppListParams,
+ UpdateAppParams,
)
-from services.enterprise import rbac_service as enterprise_rbac_service
-from services.enterprise.enterprise_service import EnterpriseService
-from services.entities.dsl_entities import DslImportWarning, ImportStatus
+from services.entities.dsl_entities import ImportStatus
from services.entities.knowledge_entities.knowledge_entities import (
DataSource,
InfoList,
@@ -84,15 +91,9 @@ from services.entities.knowledge_entities.knowledge_entities import (
WeightVectorSetting,
)
from services.errors.account import NoPermissionError
-from services.feature_service import FeatureService
-from services.system_feature_service import SystemFeatureService
-from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
-
-ALLOW_CREATE_APP_MODES = ["chat", "agent-chat", "advanced-chat", "workflow", "completion"]
register_enum_models(console_ns, IconType)
-_logger = logging.getLogger(__name__)
AppListMode = Literal["completion", "chat", "advanced-chat", "workflow", "agent-chat", "agent", "channel", "all"]
DEFAULT_APP_LIST_MODE: AppListMode = "all"
APP_LIST_QUERY_ARRAY_FIELDS = ("tag_ids", "creator_ids")
@@ -238,348 +239,6 @@ class AppTracePayload(BaseModel):
return value
-class AppTraceResponse(ResponseModel):
- enabled: bool = False
- tracing_provider: str | None = None
-
-
-class Tag(ResponseModel):
- id: str
- name: str
- type: str
-
-
-class WorkflowPartial(ResponseModel):
- id: str
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class ModelConfigPartial(ResponseModel):
- model: Any | None = Field(default=None, validation_alias=AliasChoices("model_dict", "model"))
- pre_prompt: str | None = None
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class AppModelConfigResponse(ResponseModel):
- opening_statement: str | None = None
- suggested_questions: Any | None = Field(
- default=None, validation_alias=AliasChoices("suggested_questions_list", "suggested_questions")
- )
- suggested_questions_after_answer: Any | None = Field(
- default=None,
- validation_alias=AliasChoices("suggested_questions_after_answer_dict", "suggested_questions_after_answer"),
- )
- speech_to_text: Any | None = Field(
- default=None, validation_alias=AliasChoices("speech_to_text_dict", "speech_to_text")
- )
- text_to_speech: Any | None = Field(
- default=None, validation_alias=AliasChoices("text_to_speech_dict", "text_to_speech")
- )
- retriever_resource: Any | None = Field(
- default=None, validation_alias=AliasChoices("retriever_resource_dict", "retriever_resource")
- )
- annotation_reply: Any | None = Field(
- default=None, validation_alias=AliasChoices("annotation_reply_dict", "annotation_reply")
- )
- more_like_this: Any | None = Field(
- default=None, validation_alias=AliasChoices("more_like_this_dict", "more_like_this")
- )
- sensitive_word_avoidance: Any | None = Field(
- default=None, validation_alias=AliasChoices("sensitive_word_avoidance_dict", "sensitive_word_avoidance")
- )
- external_data_tools: Any | None = Field(
- default=None, validation_alias=AliasChoices("external_data_tools_list", "external_data_tools")
- )
- model: Any | None = Field(default=None, validation_alias=AliasChoices("model_dict", "model"))
- user_input_form: Any | None = Field(
- default=None, validation_alias=AliasChoices("user_input_form_list", "user_input_form")
- )
- dataset_query_variable: str | None = None
- pre_prompt: str | None = None
- agent_mode: Any | None = Field(default=None, validation_alias=AliasChoices("agent_mode_dict", "agent_mode"))
- prompt_type: str | None = None
- chat_prompt_config: Any | None = Field(
- default=None, validation_alias=AliasChoices("chat_prompt_config_dict", "chat_prompt_config")
- )
- completion_prompt_config: Any | None = Field(
- default=None, validation_alias=AliasChoices("completion_prompt_config_dict", "completion_prompt_config")
- )
- dataset_configs: Any | None = Field(
- default=None, validation_alias=AliasChoices("dataset_configs_dict", "dataset_configs")
- )
- file_upload: Any | None = Field(default=None, validation_alias=AliasChoices("file_upload_dict", "file_upload"))
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class AppDetailSiteResponse(ResponseModel):
- access_token: str | None = Field(default=None, validation_alias="code")
- code: str | None = None
- title: str | None = None
- icon_type: str | IconType | None = None
- icon: str | None = None
- icon_background: str | None = None
- description: str | None = None
- default_language: str | None = None
- chat_color_theme: str | None = None
- chat_color_theme_inverted: bool | None = None
- customize_domain: str | None = None
- copyright: str | None = None
- privacy_policy: str | None = None
- input_placeholder: str | None = None
- custom_disclaimer: str | None = None
- customize_token_strategy: str | None = None
- prompt_public: bool | None = None
- app_base_url: str | None = None
- show_workflow_steps: bool | None = None
- use_icon_as_answer_icon: bool | None = None
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
-
- @computed_field(return_type=str | None) # type: ignore
- @property
- def icon_url(self) -> str | None:
- return build_icon_url(self.icon_type, self.icon)
-
- @field_validator("icon_type", mode="before")
- @classmethod
- def _normalize_icon_type(cls, value: str | IconType | None) -> str | None:
- if isinstance(value, IconType):
- return value.value
- return value
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class DeletedTool(ResponseModel):
- type: str
- tool_name: str
- provider_id: str
-
-
-class AppResponseModel(ResponseModel):
- @model_validator(mode="before")
- @classmethod
- def _use_request_session(cls, value: Any, info: ValidationInfo) -> Any:
- if not isinstance(value, App):
- return value
- if info.context is None or "session" not in info.context:
- raise ValueError("session context is required to serialize an App")
- return AppResponseView(value, session=info.context["session"])
-
-
-class AppPartial(AppResponseModel):
- id: str
- name: str
- max_active_requests: int | None = None
- description: str | None = Field(default=None, validation_alias=AliasChoices("desc_or_prompt", "description"))
- mode: str = Field(validation_alias="mode_compatible_with_agent")
- icon_type: str | None = None
- icon: str | None = None
- icon_background: str | None = None
- model_config_: ModelConfigPartial | None = Field(
- default=None,
- validation_alias=AliasChoices("app_model_config", "model_config"),
- alias="model_config",
- )
- workflow: WorkflowPartial | None = None
- use_icon_as_answer_icon: bool | None = None
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
- tags: list[Tag] = Field(default_factory=list)
- access_mode: str | None = None
- create_user_name: str | None = None
- author_name: str | None = None
- has_draft_trigger: bool | None = None
- permission_keys: list[str] = Field(default_factory=list)
- # For Agent App type: the roster Agent backing this app (None otherwise).
- bound_agent_id: str | None = None
- # For Agent App responses exposed through /agent.
- app_id: str | None = None
- is_starred: bool = False
- maintainer: str | None = None
-
- @computed_field(return_type=str | None) # type: ignore
- @property
- def icon_url(self) -> str | None:
- return build_icon_url(self.icon_type, self.icon)
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class RecentAppResponse(ResponseModel):
- id: str
- name: str
- icon_type: IconType | None = None
- icon: str | None = None
- icon_background: str | None = None
- mode: RecentAppMode
- author_name: str | None = None
- updated_at: int
- permission_keys: list[str] = Field(default_factory=list)
- maintainer: str | None = None
-
- @computed_field(return_type=str | None) # type: ignore[prop-decorator]
- @property
- def icon_url(self) -> str | None:
- return build_icon_url(self.icon_type, self.icon)
-
- @field_validator("updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int) -> int:
- return to_timestamp(value)
-
-
-class RecentAppListResponse(ResponseModel):
- data: list[RecentAppResponse]
-
-
-class AppDetail(AppResponseModel):
- id: str
- name: str
- description: str | None = None
- mode: str = Field(validation_alias="mode_compatible_with_agent")
- icon: str | None = None
- icon_background: str | None = None
- enable_site: bool
- enable_api: bool
- model_config_: AppModelConfigResponse | None = Field(
- default=None,
- validation_alias=AliasChoices("app_model_config", "model_config"),
- alias="model_config",
- )
- workflow: WorkflowPartial | None = None
- tracing: Any | None = None
- use_icon_as_answer_icon: bool | None = None
- created_by: str | None = None
- created_at: int | None = None
- updated_by: str | None = None
- updated_at: int | None = None
- access_mode: str | None = None
- tags: list[Tag] = Field(default_factory=list)
- permission_keys: list[str] = Field(default_factory=list)
- maintainer: str | None = None
-
- @field_validator("created_at", "updated_at", mode="before")
- @classmethod
- def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
- return to_timestamp(value)
-
-
-class AppDetailWithSite(AppDetail):
- icon_type: str | None = None
- api_base_url: str | None = None
- max_active_requests: int | None = None
- deleted_tools: list[DeletedTool] = Field(default_factory=list)
- site: AppDetailSiteResponse | None = None
- # For Agent App type: the roster Agent backing this app (None otherwise).
- bound_agent_id: str | None = None
- # For Agent App responses exposed through /agent.
- app_id: str | None = None
-
- @computed_field(return_type=str | None) # type: ignore
- @property
- def icon_url(self) -> str | None:
- return build_icon_url(self.icon_type, self.icon)
-
-
-class AppPagination(ResponseModel):
- page: int
- limit: int = Field(validation_alias=AliasChoices("per_page", "limit"))
- total: int
- has_more: bool = Field(validation_alias=AliasChoices("has_next", "has_more"))
- data: list[AppPartial] = Field(validation_alias=AliasChoices("items", "data"))
-
-
-class AppExportResponse(ResponseModel):
- data: str
-
-
-class AppImportResponse(ResponseModel):
- id: str
- status: ImportStatus
- app_id: str | None = None
- app_mode: str | None = None
- current_dsl_version: str
- imported_dsl_version: str = ""
- error: str = ""
- warnings: list[DslImportWarning] = Field(default_factory=list)
-
-
-def _enrich_app_list_items(session: Session, *, apps: Sequence[App], tenant_id: str) -> None:
- if SystemFeatureService.is_webapp_auth_enabled():
- app_ids = [str(app.id) for app in apps]
- res = EnterpriseService.WebAppAuth.batch_get_app_access_mode_by_id(app_ids=app_ids)
- if len(res) != len(app_ids):
- raise BadRequest("Invalid app id in webapp auth")
-
- for app in apps:
- if str(app.id) in res:
- app.access_mode = res[str(app.id)].access_mode
-
- workflow_capable_app_ids = [str(app.id) for app in apps if app.mode in {"workflow", "advanced-chat"}]
- draft_trigger_app_ids: set[str] = set()
- if workflow_capable_app_ids:
- draft_workflows = (
- session.execute(
- select(Workflow).where(
- Workflow.version == Workflow.VERSION_DRAFT,
- Workflow.app_id.in_(workflow_capable_app_ids),
- Workflow.tenant_id == tenant_id,
- )
- )
- .scalars()
- .all()
- )
- trigger_node_types = TRIGGER_NODE_TYPES
- for workflow in draft_workflows:
- node_id = None
- try:
- for node_id, node_data in workflow.walk_nodes():
- if node_data.get("type") in trigger_node_types:
- draft_trigger_app_ids.add(str(workflow.app_id))
- break
- except Exception:
- _logger.exception("error while walking nodes, workflow_id=%s, node_id=%s", workflow.id, node_id)
- continue
-
- for app in apps:
- app.has_draft_trigger = str(app.id) in draft_trigger_app_ids
-
-
register_enum_models(console_ns, RetrievalMethod, WorkflowExecutionStatus, DatasetPermissionEnum)
register_response_schema_models(
console_ns,
@@ -638,414 +297,209 @@ register_response_schema_models(
)
+_EDIT_ROLES = frozenset({TenantAccountRole.OWNER, TenantAccountRole.ADMIN, TenantAccountRole.EDITOR})
+_ADMIN_ROLES = frozenset({TenantAccountRole.OWNER, TenantAccountRole.ADMIN})
+
+
+def _app_detail_response(app: AppRecord) -> AppDetailWithSite:
+ """Resolve transport URLs here so repositories work without a Flask request."""
+ response = AppDetailWithSite.model_validate(app, from_attributes=True)
+ response.api_base_url = normalize_api_base_url(dify_config.SERVICE_API_URL or request.host_url.rstrip("/"))
+ if response.site is not None:
+ response.site.app_base_url = dify_config.APP_WEB_URL or request.url_root.rstrip("/")
+ return response
+
+
+class AppResource(Resource):
+ """Translate application failures at the HTTP boundary for all app routes."""
+
+ @override
+ def dispatch_request(self, *args, **kwargs):
+ try:
+ return super().dispatch_request(*args, **kwargs)
+ except AppExportAgentNotFoundError as error:
+ raise NotFound(str(error)) from error
+ except ConsoleAppNotFoundError as error:
+ raise AppNotFoundError() from error
+ except (InvalidAppExportError, InvalidAppAccessModesError) as error:
+ raise BadRequest(str(error)) from error
+ except (AppExportPaidPlanRequiredError, NoPermissionError) as error:
+ raise Forbidden(str(error)) from error
+ except CreatorsPlatformDisabledError as error:
+ return {"error": str(error)}, HTTPStatus.FORBIDDEN
+ except AppTracingConfigInvalidProviderError as error:
+ raise ValueError(str(error)) from error
+
+
@console_ns.route("/apps")
-class AppListApi(Resource):
+class AppListApi(AppResource):
@console_ns.doc("list_apps")
@console_ns.doc(description="Get list of applications with pagination and filtering")
@console_ns.doc(params=query_params_from_model(AppListQuery))
- @console_ns.response(200, "Success", console_ns.models[AppPagination.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_session(write=False)
- @with_current_user_id
- @with_current_tenant_id
- def get(self, current_tenant_id: str, current_user_id: str, session: Session):
- """Get app list"""
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[AppPagination.__name__])
+ @console_account_admission(require_valid_enterprise_license=True)
+ def get(self, context: RequestContext):
args = query_params_from_request(AppListQuery, list_fields=APP_LIST_QUERY_ARRAY_FIELDS)
- params = AppListParams(
- page=args.page,
- limit=args.limit,
- mode=args.mode,
- sort_by=args.sort_by,
- name=args.name,
- tag_ids=args.tag_ids,
- creator_ids=args.creator_ids,
- is_created_by_me=args.is_created_by_me,
- )
-
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
- current_tenant_id,
- current_user_id,
- session=session,
- )
- if dify_config.RBAC_ENABLED:
- access_filter = resolve_app_access_filter(
- current_tenant_id,
- current_user_id,
- session=session,
- permissions=permissions,
- )
- access_filter.apply_to_params(params)
-
- # get app list
- app_service = AppService()
- app_pagination = app_service.get_paginate_apps(current_user_id, current_tenant_id, params, session)
- if not app_pagination:
- response = AppPagination(page=args.page, limit=args.limit, total=0, has_more=False, data=[])
- return response.model_dump(mode="json"), 200
-
- app_ids = [str(app.id) for app in app_pagination.items]
- permission_keys_map = permissions.app.permission_keys_by_resource_ids(app_ids)
- _enrich_app_list_items(session, apps=app_pagination.items, tenant_id=current_tenant_id)
-
- pagination_model = AppPagination.model_validate(
- app_pagination,
- from_attributes=True,
- context={"session": session},
- )
- if app_pagination.items:
- pagination_model = pagination_model.model_copy(
- update={
- "data": [
- item.model_copy(update={"permission_keys": permission_keys_map.get(item.id, [])})
- for item in pagination_model.data
- ]
- }
- )
- return pagination_model.model_dump(mode="json"), 200
+ params = AppListParams.model_validate(args.model_dump())
+ return dump_response(
+ AppPagination, application_services().apps.console.list_apps(context, params)
+ ), HTTPStatus.OK
@console_ns.doc("create_app")
@console_ns.doc(description="Create a new application")
@console_ns.expect(console_ns.models[CreateAppPayload.__name__])
- @console_ns.response(201, "App created successfully", console_ns.models[AppDetailWithSite.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @console_ns.response(400, "Invalid request parameters")
- @setup_required
- @login_required
- @account_initialization_required
- @rbac_permission_required(RBACCheck(RBACPermission.APP_CREATE_AND_MANAGEMENT, Workspace()))
- @cloud_edition_billing_resource_check("apps")
- @edit_permission_required
- @with_current_user
- @with_current_tenant_id
- @with_session
- @model_validate(CreateAppPayload)
- def post(self, req_data: CreateAppPayload, session: Session, current_tenant_id: str, current_user: Account):
- """Create app"""
- params = CreateAppParams(
- name=req_data.name,
- description=req_data.description,
- mode=req_data.mode,
- icon_type=req_data.icon_type,
- icon=req_data.icon,
- icon_background=req_data.icon_background,
- )
-
- app_service = AppService()
- app = app_service.create_app(current_tenant_id, params, current_user, session=session)
- permission_keys_map = enterprise_rbac_service.RBACService.AppPermissions.batch_get(
- current_tenant_id,
- current_user.id,
- [str(app.id)],
- session=session,
- )
- app_detail = AppDetailWithSite.model_validate(
- app,
- from_attributes=True,
- context={"session": session},
- ).model_copy(update={"permission_keys": permission_keys_map.get(str(app.id), [])})
-
- if dify_config.RBAC_ENABLED:
- enterprise_rbac_service.RBACService.AppAccess.replace_whitelist(
- current_tenant_id,
- current_user.id,
- str(app.id),
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
- )
-
- initialize_created_app_rbac_access_task.delay(current_tenant_id, current_user.id, app_id=app.id)
-
- return app_detail.model_dump(mode="json"), 201
+ @console_ns.response(HTTPStatus.CREATED, "App created successfully", console_ns.models[AppDetailWithSite.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_ns.response(HTTPStatus.BAD_REQUEST, "Invalid request parameters")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ billing_resource="apps",
+ rbac_checks=[RBACCheck(RBACPermission.APP_CREATE_AND_MANAGEMENT, Workspace())],
+ )
+ def post(self, context: RequestContext):
+ payload = validate_request(CreateAppPayload)
+ params = CreateAppParams.model_validate(payload.model_dump())
+ response = _app_detail_response(application_services().apps.console.create(context, params))
+ return dump_response(AppDetailWithSite, response), HTTPStatus.CREATED
@console_ns.route("/apps/recent")
-class RecentAppListApi(Resource):
+class RecentAppListApi(AppResource):
@console_ns.doc("list_recent_apps")
@console_ns.doc(description="Get recently modified apps for the home Continue Work section")
@console_ns.doc(params=query_params_from_model(RecentAppListQuery))
- @console_ns.response(200, "Success", console_ns.models[RecentAppListResponse.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_session(write=False)
- @with_current_user_id
- @with_current_tenant_id
- def get(self, current_tenant_id: str, current_user_id: str, session: Session):
- """Return the lightweight app cards needed by the Explore home page."""
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[RecentAppListResponse.__name__])
+ @console_account_admission(require_valid_enterprise_license=True)
+ def get(self, context: RequestContext):
args = query_params_from_request(RecentAppListQuery)
- params = AppListParams(limit=args.limit)
-
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
- current_tenant_id,
- current_user_id,
- session=session,
- )
- if dify_config.RBAC_ENABLED:
- access_filter = resolve_app_access_filter(
- current_tenant_id,
- current_user_id,
- session=session,
- permissions=permissions,
- )
- access_filter.apply_to_params(params)
-
- recent_apps = AppService().get_recent_apps(current_user_id, current_tenant_id, params, session)
- permission_keys_map = permissions.app.permission_keys_by_resource_ids([app.id for app in recent_apps])
- response_items = [
- RecentAppResponse.model_validate(app, from_attributes=True).model_copy(
- update={"permission_keys": permission_keys_map.get(app.id, [])}
- )
- for app in recent_apps
- ]
- return dump_response(RecentAppListResponse, {"data": response_items}), 200
+ return dump_response(
+ RecentAppListResponse, {"data": application_services().apps.console.recent(context, args.limit)}
+ ), HTTPStatus.OK
@console_ns.route("/apps/starred")
-class StarredAppListApi(Resource):
+class StarredAppListApi(AppResource):
@console_ns.doc("list_starred_apps")
@console_ns.doc(description="Get applications starred by the current account")
@console_ns.doc(params=query_params_from_model(StarredAppListQuery))
- @console_ns.response(200, "Success", console_ns.models[AppPagination.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_session(write=False)
- @with_current_user_id
- @with_current_tenant_id
- def get(self, current_tenant_id: str, current_user_id: str, session: Session):
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[AppPagination.__name__])
+ @console_account_admission(require_valid_enterprise_license=True)
+ def get(self, context: RequestContext):
args = query_params_from_request(StarredAppListQuery, list_fields=APP_LIST_QUERY_ARRAY_FIELDS)
- params = StarredAppListParams(
- page=args.page,
- limit=args.limit,
- mode=args.mode,
- sort_by=args.sort_by,
- name=args.name,
- tag_ids=args.tag_ids,
- creator_ids=args.creator_ids,
- is_created_by_me=args.is_created_by_me,
- )
-
- app_pagination = AppService().get_paginate_starred_apps(current_user_id, current_tenant_id, params, session)
- if not app_pagination:
- empty = AppPagination(page=args.page, limit=args.limit, total=0, has_more=False, data=[])
- return empty.model_dump(mode="json"), 200
-
- _enrich_app_list_items(session, apps=app_pagination.items, tenant_id=current_tenant_id)
- return (
- AppPagination.model_validate(
- app_pagination,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json"),
- 200,
- )
+ params = StarredAppListParams.model_validate(args.model_dump())
+ return dump_response(
+ AppPagination, application_services().apps.console.list_apps(context, params)
+ ), HTTPStatus.OK
@console_ns.route("/apps/<uuid:app_id>/star")
-class AppStarApi(Resource):
+class AppStarApi(AppResource):
@console_ns.doc("star_app")
@console_ns.doc(description="Star an application for the current account")
@console_ns.doc(params={"app_id": "Application ID"})
- @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
- @console_ns.response(404, "App not found")
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_current_user_id
- @with_session
- @get_app_model(mode=None)
- def post(self, session: Session, current_user_id: str, app_model: App):
- AppService.star_app(app=app_model, account_id=current_user_id, session=session)
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[SimpleResultResponse.__name__])
+ @console_ns.response(HTTPStatus.NOT_FOUND, "App not found")
+ @console_account_admission(require_valid_enterprise_license=True)
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ application_services().apps.console.set_starred(context, str(app_id), True)
return SimpleResultResponse(result="success").model_dump(mode="json")
@console_ns.doc("unstar_app")
@console_ns.doc(description="Remove the current account's star from an application")
@console_ns.doc(params={"app_id": "Application ID"})
- @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
- @console_ns.response(404, "App not found")
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_current_user_id
- @with_session
- @get_app_model(mode=None)
- def delete(self, session: Session, current_user_id: str, app_model: App):
- AppService.unstar_app(app=app_model, account_id=current_user_id, session=session)
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[SimpleResultResponse.__name__])
+ @console_ns.response(HTTPStatus.NOT_FOUND, "App not found")
+ @console_account_admission(require_valid_enterprise_license=True)
+ def delete(self, context: RequestContext, app_id: uuid.UUID):
+ application_services().apps.console.set_starred(context, str(app_id), False)
return SimpleResultResponse(result="success").model_dump(mode="json")
@console_ns.route("/apps/<uuid:app_id>")
-class AppApi(Resource):
+class AppApi(AppResource):
@console_ns.doc("get_app_detail")
@console_ns.doc(description="Get application details")
@console_ns.doc(params={"app_id": "Application ID"})
- @console_ns.response(200, "Success", console_ns.models[AppDetailWithSite.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @enterprise_license_required
- @with_current_user
- @with_current_tenant_id
- @with_session(write=False)
- @get_app_model(mode=None)
- def get(self, session: Session, current_tenant_id: str, current_user: Account, app_model: App):
- """Get app detail"""
- app_service = AppService()
-
- app_model = app_service.get_app(app_model, session=session)
-
- if SystemFeatureService.is_webapp_auth_enabled():
- app_setting = EnterpriseService.WebAppAuth.get_app_access_mode_by_id(app_id=str(app_model.id))
- app_model.access_mode = app_setting.access_mode
-
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
- current_tenant_id,
- current_user.id,
- app_id=str(app_model.id),
- session=session,
- )
- permission_keys_map = permissions.app.permission_keys_by_resource_ids([str(app_model.id)])
-
- response_model = AppDetailWithSite.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_copy(update={"permission_keys": permission_keys_map.get(str(app_model.id), [])})
- return response_model.model_dump(mode="json")
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[AppDetailWithSite.__name__])
+ @console_account_admission(require_valid_enterprise_license=True)
+ def get(self, context: RequestContext, app_id: uuid.UUID):
+ response = _app_detail_response(application_services().apps.console.get(context, str(app_id)))
+ return dump_response(AppDetailWithSite, response)
@console_ns.doc("update_app")
@console_ns.doc(description="Update application details")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[UpdateAppPayload.__name__])
- @console_ns.response(200, "App updated successfully", console_ns.models[AppDetailWithSite.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @console_ns.response(400, "Invalid request parameters")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_EDIT, PlainApp()), RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp())
+ @console_ns.response(HTTPStatus.OK, "App updated successfully", console_ns.models[AppDetailWithSite.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_ns.response(HTTPStatus.BAD_REQUEST, "Invalid request parameters")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_EDIT, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model(mode=None)
- @model_validate(UpdateAppPayload)
- def put(self, req_data: UpdateAppPayload, session: Session, app_model: App):
- """Update app"""
-
- app_service = AppService()
-
- args_dict: AppService.ArgsDict = {
- "name": req_data.name,
- "description": req_data.description or "",
- "icon_type": req_data.icon_type,
- "icon": req_data.icon or "",
- "icon_background": req_data.icon_background or "",
- "use_icon_as_answer_icon": req_data.use_icon_as_answer_icon or False,
- "max_active_requests": req_data.max_active_requests or 0,
- }
- app_model = app_service.update_app(app_model, args_dict, session=session)
- return AppDetailWithSite.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json")
+ def put(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(UpdateAppPayload)
+ params = UpdateAppParams(
+ name=payload.name,
+ description=payload.description or "",
+ icon_type=payload.icon_type,
+ icon=payload.icon or "",
+ icon_background=payload.icon_background or "",
+ use_icon_as_answer_icon=payload.use_icon_as_answer_icon or False,
+ max_active_requests=payload.max_active_requests or 0,
+ )
+ response = _app_detail_response(application_services().apps.console.update(context, str(app_id), params))
+ return dump_response(AppDetailWithSite, response)
@console_ns.doc("delete_app")
@console_ns.doc(description="Delete application")
@console_ns.doc(params={"app_id": "Application ID"})
- @console_ns.response(204, "App deleted successfully")
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_DELETE, PlainApp()), RBACCheck(RBACPermission.AGENT_DELETE, AgentBehindApp())
+ @console_ns.response(HTTPStatus.NO_CONTENT, "App deleted successfully")
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_DELETE, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_DELETE, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model
- def delete(self, session: Session, app_model: App):
- """Delete app"""
- app_service = AppService()
- app_service.delete_app(app_model, session=session)
-
- return "", 204
+ def delete(self, context: RequestContext, app_id: uuid.UUID):
+ application_services().apps.console.delete(context, str(app_id))
+ return "", HTTPStatus.NO_CONTENT
@console_ns.route("/apps/<uuid:app_id>/copy")
-class AppCopyApi(Resource):
+class AppCopyApi(AppResource):
@console_ns.doc("copy_app")
@console_ns.doc(description="Create a copy of an existing application")
@console_ns.doc(params={"app_id": "Application ID to copy"})
@console_ns.expect(console_ns.models[CopyAppPayload.__name__])
- @console_ns.response(201, "App copied successfully", console_ns.models[AppDetailWithSite.__name__])
- @console_ns.response(202, "App copy requires confirmation", console_ns.models[AppImportResponse.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(RBACCheck(RBACPermission.APP_CREATE_AND_MANAGEMENT, PlainApp()))
- @with_current_user
- @with_current_tenant_id
- @with_session
- @get_app_model(mode=None)
- @model_validate(CopyAppPayload)
- def post(
- self,
- req_data: CopyAppPayload,
- session: Session,
- current_tenant_id: str,
- current_user: Account,
- app_model: App,
- ):
- """Copy app"""
- # The role of the current user in the ta table must be admin, owner, or editor
-
- import_service = AppDslService(session)
- try:
- result, app = import_service.copy_app(
- app_model=app_model,
- account=current_user,
- tenant_id=current_tenant_id,
- name=req_data.name,
- description=req_data.description,
- icon_type=req_data.icon_type,
- icon=req_data.icon,
- icon_background=req_data.icon_background,
- )
- except NoPermissionError as e:
- raise Forbidden(str(e))
+ @console_ns.response(HTTPStatus.CREATED, "App copied successfully", console_ns.models[AppDetailWithSite.__name__])
+ @console_ns.response(
+ HTTPStatus.ACCEPTED, "App copy requires confirmation", console_ns.models[AppImportResponse.__name__]
+ )
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES, rbac_checks=[RBACCheck(RBACPermission.APP_CREATE_AND_MANAGEMENT, PlainApp())]
+ )
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(CopyAppPayload)
+ result, copied = application_services().apps.console.copy(
+ context, str(app_id), CopyAppParams.model_validate(payload.model_dump())
+ )
if result.status == ImportStatus.FAILED:
- return dump_response(AppImportResponse, result), 400
+ return dump_response(AppImportResponse, result), HTTPStatus.BAD_REQUEST
if result.status == ImportStatus.PENDING:
- return dump_response(AppImportResponse, result), 202
- if not app:
- raise NotFound("App not found")
-
- permission_keys_map = enterprise_rbac_service.RBACService.AppPermissions.batch_get(
- current_tenant_id,
- current_user.id,
- [str(app.id)],
- session=session,
- )
- response_model = AppDetailWithSite.model_validate(
- app,
- from_attributes=True,
- context={"session": session},
- ).model_copy(update={"permission_keys": permission_keys_map.get(str(app.id), [])})
- return response_model.model_dump(mode="json"), 201
+ return dump_response(AppImportResponse, result), HTTPStatus.ACCEPTED
+ assert copied is not None
+ return dump_response(AppDetailWithSite, _app_detail_response(copied)), HTTPStatus.CREATED
@console_ns.route("/apps/<uuid:app_id>/export")
-class AppExportApi(Resource):
+class AppExportApi(AppResource):
@console_ns.doc("export_app")
@console_ns.doc(description="Export application configuration as DSL")
@console_ns.doc(params={"app_id": "Application ID to export"})
@@ -1054,277 +508,173 @@ class AppExportApi(Resource):
produces=["application/json", "application/zip"],
vendor={BINARY_RESPONSE_MEDIA_TYPES_VENDOR_KEY: ["application/zip"]},
)
- @console_ns.response(200, "App exported successfully", console_ns.models[AppExportResponse.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, PlainApp()),
- RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, AgentBehindApp()),
+ @console_ns.response(HTTPStatus.OK, "App exported successfully", console_ns.models[AppExportResponse.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, AgentBehindApp()),
+ ],
)
- @get_app_model
- @model_validate(AppExportQuery)
- def get(self, req_data: AppExportQuery, app_model: App):
- """Export app"""
-
- if req_data.version_id is not None:
- if app_model.mode != AppMode.AGENT:
- raise BadRequest("version_id is only available for Agent Apps")
- if (
- dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD
- and not FeatureService.get_workspace_plan(app_model.tenant_id).is_paid
- ):
- raise Forbidden("This feature requires a paid plan.")
-
- if req_data.format != "yaml":
- if app_model.mode == AppMode.AGENT:
- agent_id = app_model.bound_agent_id_with_session(session=db.session())
- if agent_id is None:
- raise NotFound("Agent not found")
- exported = RosterAgentPackageExporter().export(
- tenant_id=app_model.tenant_id, agent_id=agent_id, version_id=req_data.version_id
- )
- else:
- exported = AppPackageService().export_app(
- app_model=app_model,
- include_secret=req_data.include_secret,
- workflow_id=req_data.workflow_id,
- )
- try:
- archive_response = send_file(
- exported.archive, mimetype="application/zip", as_attachment=True, download_name=exported.filename
- )
- except Exception:
- exported.close()
- raise
- archive_response.call_on_close(exported.close)
- return archive_response
-
- response = AppExportResponse(
- data=AppDslService.export_dsl(
- app_model=app_model,
- session=db.session(),
- include_secret=req_data.include_secret,
- workflow_id=req_data.workflow_id,
- version_id=req_data.version_id,
- )
+ def get(self, context: RequestContext, app_id: uuid.UUID):
+ query = validate_request(AppExportQuery)
+ exported = application_services().apps.console.export(
+ context, str(app_id), AppExportOptions(**query.model_dump())
)
- return response.model_dump(mode="json")
+ if isinstance(exported, str):
+ return AppExportResponse(data=exported).model_dump(mode="json")
+ try:
+ response = send_file(
+ exported.archive, mimetype="application/zip", as_attachment=True, download_name=exported.filename
+ )
+ except Exception:
+ exported.close()
+ raise
+ response.call_on_close(exported.close)
+ return response
@console_ns.route("/apps/<uuid:app_id>/publish-to-creators-platform")
-class AppPublishToCreatorsPlatformApi(Resource):
- @console_ns.response(200, "Success", console_ns.models[RedirectUrlResponse.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, PlainApp()),
- RBACCheck(RBACPermission.AGENT_RELEASE_AND_VERSION, AgentBehindApp()),
+class AppPublishToCreatorsPlatformApi(AppResource):
+ @console_ns.response(HTTPStatus.OK, "Success", console_ns.models[RedirectUrlResponse.__name__])
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_RELEASE_AND_VERSION, AgentBehindApp()),
+ ],
)
- @with_current_user_id
- @get_app_model(mode=None)
- def post(self, current_user_id: str, app_model: App):
- """Publish app to Creators Platform"""
- from core.helper.creators import get_redirect_url, upload_dsl
-
- if not dify_config.CREATORS_PLATFORM_FEATURES_ENABLED:
- return {"error": "Creators Platform features are not enabled"}, 403
-
- dsl_content = AppDslService.export_dsl(app_model=app_model, session=db.session(), include_secret=False)
- dsl_bytes = dsl_content.encode("utf-8")
-
- claim_code = upload_dsl(dsl_bytes)
- # TODO: Move this configuration and OAuth orchestration into the Creators Platform application service
- # when that domain is refactored. This controller-level integration is a temporary compatibility bridge.
- oauth_code = None
- client_id = dify_config.CREATORS_PLATFORM_OAUTH_CLIENT_ID or ""
- if client_id:
- authorization = application_services().oauth_server.issue_authorization_code(
- client_id=client_id,
- account_id=current_user_id,
- )
- oauth_code = authorization.code
- redirect_url = get_redirect_url(claim_code, oauth_code=oauth_code)
-
- return RedirectUrlResponse(redirect_url=redirect_url).model_dump(mode="json")
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ url = application_services().apps.console.publish(context, str(app_id))
+ return RedirectUrlResponse(redirect_url=url).model_dump(mode="json")
@console_ns.route("/apps/<uuid:app_id>/name")
-class AppNameApi(Resource):
+class AppNameApi(AppResource):
@console_ns.doc("check_app_name")
@console_ns.doc(description="Check if app name is available")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[AppNamePayload.__name__])
- @console_ns.response(200, "Name availability checked", console_ns.models[AppDetail.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_EDIT, PlainApp()), RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp())
+ @console_ns.response(HTTPStatus.OK, "Name availability checked", console_ns.models[AppDetail.__name__])
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_EDIT, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model(mode=None)
- @model_validate(AppNamePayload)
- def post(self, req_data: AppNamePayload, session: Session, app_model: App):
-
- app_service = AppService()
- app_model = app_service.update_app_name(app_model, req_data.name, session=session)
- return AppDetail.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json")
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(AppNamePayload)
+ return dump_response(AppDetail, application_services().apps.console.rename(context, str(app_id), payload.name))
@console_ns.route("/apps/<uuid:app_id>/icon")
-class AppIconApi(Resource):
+class AppIconApi(AppResource):
@console_ns.doc("update_app_icon")
@console_ns.doc(description="Update application icon")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[AppIconPayload.__name__])
- @console_ns.response(200, "Icon updated successfully", console_ns.models[AppDetail.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_EDIT, PlainApp()), RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp())
+ @console_ns.response(HTTPStatus.OK, "Icon updated successfully", console_ns.models[AppDetail.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_EDIT, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_EDIT, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model(mode=None)
- @model_validate(AppIconPayload)
- def post(self, req_data: AppIconPayload, session: Session, app_model: App):
-
- app_service = AppService()
- app_model = app_service.update_app_icon(
- app_model,
- req_data.icon or "",
- req_data.icon_background or "",
- req_data.icon_type,
- session=session,
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(AppIconPayload)
+ result = application_services().apps.console.update_icon(
+ context,
+ str(app_id),
+ icon=payload.icon or "",
+ icon_background=payload.icon_background or "",
+ icon_type=payload.icon_type,
)
- return AppDetail.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json")
+ return dump_response(AppDetail, result)
@console_ns.route("/apps/<uuid:app_id>/site-enable")
-class AppSiteStatus(Resource):
+class AppSiteStatus(AppResource):
@console_ns.doc("update_app_site_status")
@console_ns.doc(description="Enable or disable app site")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[AppSiteStatusPayload.__name__])
- @console_ns.response(200, "Site status updated successfully", console_ns.models[AppDetail.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_RELEASE_AND_VERSION, PlainApp()),
- RBACCheck(RBACPermission.AGENT_ACCESS_POINT_MANAGE, AgentBehindApp()),
+ @console_ns.response(HTTPStatus.OK, "Site status updated successfully", console_ns.models[AppDetail.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_RELEASE_AND_VERSION, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_ACCESS_POINT_MANAGE, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model(mode=None)
- @model_validate(AppSiteStatusPayload)
- def post(self, req_data: AppSiteStatusPayload, session: Session, app_model: App):
-
- app_service = AppService()
- app_model = app_service.update_app_site_status(app_model, req_data.enable_site, session=session)
- return AppDetail.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json")
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(AppSiteStatusPayload)
+ return dump_response(
+ AppDetail, application_services().apps.console.set_site_enabled(context, str(app_id), payload.enable_site)
+ )
@console_ns.route("/apps/<uuid:app_id>/api-enable")
-class AppApiStatus(Resource):
+class AppApiStatus(AppResource):
@console_ns.doc("update_app_api_status")
@console_ns.doc(description="Enable or disable app API")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[AppApiStatusPayload.__name__])
- @console_ns.response(200, "API status updated successfully", console_ns.models[AppDetail.__name__])
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @is_admin_or_owner_required
- @account_initialization_required
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_RELEASE_AND_VERSION, PlainApp()),
- RBACCheck(RBACPermission.AGENT_ACCESS_POINT_MANAGE, AgentBehindApp()),
+ @console_ns.response(HTTPStatus.OK, "API status updated successfully", console_ns.models[AppDetail.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_ADMIN_ROLES,
+ rbac_checks=[
+ RBACCheck(RBACPermission.APP_RELEASE_AND_VERSION, PlainApp()),
+ RBACCheck(RBACPermission.AGENT_ACCESS_POINT_MANAGE, AgentBehindApp()),
+ ],
)
- @with_session
- @get_app_model(mode=None)
- @model_validate(AppApiStatusPayload)
- def post(self, req_data: AppApiStatusPayload, session: Session, app_model: App):
-
- app_service = AppService()
- app_model = app_service.update_app_api_status(app_model, req_data.enable_api, session=session)
- return AppDetail.model_validate(
- app_model,
- from_attributes=True,
- context={"session": session},
- ).model_dump(mode="json")
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(AppApiStatusPayload)
+ return dump_response(
+ AppDetail, application_services().apps.console.set_api_enabled(context, str(app_id), payload.enable_api)
+ )
@console_ns.route("/apps/<uuid:app_id>/trace")
-class AppTraceApi(Resource):
+class AppTraceApi(AppResource):
@console_ns.doc("get_app_trace")
@console_ns.doc(description="Get app tracing configuration")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.response(
- 200,
+ HTTPStatus.OK,
"Trace configuration retrieved successfully",
console_ns.models[AppTraceResponse.__name__],
)
- @setup_required
- @login_required
- @account_initialization_required
- @with_session
- @rbac_permission_required(RBACCheck(RBACPermission.APP_VIEW_LAYOUT, PlainApp()))
- @get_app_model
- def get(self, session: Session, app_model: App):
- """Get app trace"""
- app_trace_config = OpsTraceManager.get_app_tracing_config(app_model.id, session)
-
- return dump_response(AppTraceResponse, app_trace_config)
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.APP_VIEW_LAYOUT, PlainApp())])
+ def get(self, context: RequestContext, app_id: uuid.UUID):
+ return dump_response(AppTraceResponse, application_services().apps.console.get_trace(context, str(app_id)))
@console_ns.doc("update_app_trace")
@console_ns.doc(description="Update app tracing configuration")
@console_ns.doc(params={"app_id": "Application ID"})
@console_ns.expect(console_ns.models[AppTracePayload.__name__])
@console_ns.response(
- 200,
+ HTTPStatus.OK,
"Trace configuration updated successfully",
console_ns.models[SimpleResultResponse.__name__],
)
- @console_ns.response(403, "Insufficient permissions")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(RBACCheck(RBACPermission.APP_TRACING_CONFIG, PlainApp()))
- @get_app_model
- @model_validate(AppTracePayload)
- def post(self, req_data: AppTracePayload, app_model: App):
- # add app trace
-
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient permissions")
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES, rbac_checks=[RBACCheck(RBACPermission.APP_TRACING_CONFIG, PlainApp())]
+ )
+ def post(self, context: RequestContext, app_id: uuid.UUID):
+ payload = validate_request(AppTracePayload)
try:
- OpsTraceManager.update_app_tracing_config(
- app_id=app_model.id,
- enabled=req_data.enabled,
- tracing_provider=req_data.tracing_provider,
+ application_services().apps.console.set_trace(
+ context,
+ str(app_id),
+ AppTraceSettings(**payload.model_dump()),
)
- except TraceProviderNotInstalledError as error:
+ except AppTracingConfigProviderUnavailableError as error:
raise TracingProviderUnavailableError() from error
-
return SimpleResultResponse(result="success").model_dump(mode="json")
diff --git a/api/controllers/console/app/app_import.py b/api/controllers/console/app/app_import.py
index 0ba35c9cffb..dad5dd41592 100644
--- a/api/controllers/console/app/app_import.py
+++ b/api/controllers/console/app/app_import.py
@@ -1,68 +1,37 @@
+from http import HTTPStatus
from typing import BinaryIO, Literal, cast
-from uuid import uuid4
from flask import request
from flask_restx import Resource
-from pydantic import BaseModel, Field
-from sqlalchemy.orm import Session
+from pydantic import Field
from werkzeug.exceptions import Forbidden
-from configs import dify_config
from controllers.common.rbac import PlainApp, RBACCheck, Workspace
from controllers.common.schema import register_enum_models, register_response_schema_models, register_schema_models
-from controllers.console.app.wraps import get_app_model
-from controllers.console.wraps import (
- RBACPermission,
- account_initialization_required,
- cloud_edition_billing_resource_check,
- edit_permission_required,
- rbac_permission_required,
- setup_required,
- validate_request,
- with_current_user,
-)
+from controllers.console.app.error import AppNotFoundError
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.wraps import RBACPermission, validate_request
from core.plugin.entities.plugin import PluginDependency
-from extensions.ext_database import db
-from extensions.ext_redis import redis_client
+from extensions.ext_application_services import application_services
from fields.base import ResponseModel
-from libs.login import current_account_with_tenant, login_required
-from models.account import Account
-from models.model import App, AppMode
+from machinery.context import RequestContext
+from models.account import TenantAccountRole
from services.agent.errors import InvalidRosterAgentPackageError
-from services.agent.roster_package_importer import RosterAgentPackageImporter
-from services.app_dsl_service import (
- IMPORT_INFO_REDIS_KEY_PREFIX,
- AppDslService,
- Import,
- PendingData,
-)
-from services.app_import_source import download_app_import_source, try_read_yaml
-from services.app_package_service import AppPackageService, PreparedAppPackage
-from services.enterprise.enterprise_service import EnterpriseService
-from services.entities.dsl_entities import CheckDependenciesResult, ImportStatus
+from services.app.console_service import ConsoleAppNotFoundError
+from services.entities.dsl_entities import AppImportParams, CheckDependenciesResult, Import, ImportStatus
from services.errors.account import NoPermissionError
-from services.system_feature_service import SystemFeatureService
from .. import console_ns
-from .permission_keys import get_app_permission_keys
-class AppImportPayload(BaseModel):
- mode: str = Field(..., description="Import mode")
- yaml_content: str | None = Field(None)
- yaml_url: str | None = Field(None)
- name: str | None = Field(None)
- description: str | None = Field(None)
- icon_type: str | None = Field(None)
- icon: str | None = Field(None)
- icon_background: str | None = Field(None)
- app_id: str | None = Field(None)
+class AppImportPayload(AppImportParams):
+ pass
class RosterAgentPackageConflictResponse(ResponseModel):
code: str
message: str
- status: Literal[409] = 409
+ status: Literal[HTTPStatus.CONFLICT] = HTTPStatus.CONFLICT
leaked_dependencies: list[PluginDependency] = Field(default_factory=list)
@@ -71,22 +40,7 @@ register_schema_models(console_ns, AppImportPayload, Import, CheckDependenciesRe
register_response_schema_models(console_ns, RosterAgentPackageConflictResponse)
-def _current_user_and_tenant_id(current_user: Account | None) -> tuple[Account, str | None]:
- if current_user is None:
- account, tenant_id = current_account_with_tenant()
- return account, str(tenant_id) if tenant_id else None
-
- current_tenant_id = getattr(current_user, "current_tenant_id", None)
- if current_tenant_id:
- return current_user, str(current_tenant_id)
-
- current_tenant = getattr(current_user, "current_tenant", None)
- current_tenant_object_id = getattr(current_tenant, "id", None)
- if current_tenant_object_id:
- return current_user, str(current_tenant_object_id)
-
- account, fallback_tenant_id = current_account_with_tenant()
- return account, str(fallback_tenant_id) if fallback_tenant_id else None
+_EDIT_ROLES = frozenset({TenantAccountRole.OWNER, TenantAccountRole.ADMIN, TenantAccountRole.EDITOR})
@console_ns.route("/apps/imports")
@@ -120,218 +74,70 @@ class AppImportApi(Resource):
}
},
)
- @console_ns.response(200, "Import completed", console_ns.models[Import.__name__])
- @console_ns.response(202, "Import pending confirmation", console_ns.models[Import.__name__])
- @console_ns.response(400, "Import failed", console_ns.models[Import.__name__])
- @console_ns.response(403, "Insufficient import or plugin installation permissions")
+ @console_ns.response(HTTPStatus.OK, "Import completed", console_ns.models[Import.__name__])
+ @console_ns.response(HTTPStatus.ACCEPTED, "Import pending confirmation", console_ns.models[Import.__name__])
+ @console_ns.response(HTTPStatus.BAD_REQUEST, "Import failed", console_ns.models[Import.__name__])
+ @console_ns.response(HTTPStatus.FORBIDDEN, "Insufficient import or plugin installation permissions")
@console_ns.response(
- 409, "Agent name conflict or missing plugins", console_ns.models[RosterAgentPackageConflictResponse.__name__]
+ HTTPStatus.CONFLICT,
+ "Agent name conflict or missing plugins",
+ console_ns.models[RosterAgentPackageConflictResponse.__name__],
)
- @console_ns.response(413, "Roster Agent package exceeds the size limit")
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @with_current_user
- def post(self, current_user: Account):
+ @console_ns.response(HTTPStatus.REQUEST_ENTITY_TOO_LARGE, "Roster Agent package exceeds the size limit")
+ @console_account_admission(allowed_roles=_EDIT_ROLES)
+ def post(self, context: RequestContext):
+ source: BinaryIO | None = None
if request.mimetype == "multipart/form-data":
- return self._import_package(current_user)
- payload = validate_request(AppImportPayload)
- if payload.mode == "yaml-url" and payload.yaml_url:
- return self._import_url(payload, current_user)
- return self._import_dsl(payload, current_user)
-
- @rbac_permission_required(
- RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, Workspace()),
- RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, Workspace()),
- )
- def _import_url(self, payload: AppImportPayload, current_user: Account):
- with download_app_import_source(payload.yaml_url or "") as source:
- content = try_read_yaml(source)
- if content is not None:
- return self._import_dsl(
- payload.model_copy(update={"mode": "yaml-content", "yaml_content": content, "yaml_url": None}),
- current_user,
- )
- return self._import_package(current_user, payload, source)
-
- def _import_package(
- self, current_user: Account, payload: AppImportPayload | None = None, source: BinaryIO | None = None
- ):
- if source is None:
uploaded = request.files.get("file")
if uploaded is None or not uploaded.filename:
raise InvalidRosterAgentPackageError("App package file is required")
if not uploaded.filename.lower().endswith(".ifpkg"):
raise InvalidRosterAgentPackageError("App package file must use the .ifpkg extension")
source = cast(BinaryIO, uploaded.stream)
- package = AppPackageService().read_package(source)
- if package is not None:
- with package:
- if payload is None:
- payload = AppImportPayload.model_validate({**request.form.to_dict(), "mode": "yaml-content"})
- return self._import_dsl(
- payload.model_copy(update={"mode": "yaml-content", "yaml_content": package.dsl, "yaml_url": None}),
- current_user,
- package=package,
- )
- return self._import_agent_package(current_user, source, payload)
-
- @rbac_permission_required(RBACCheck(RBACPermission.AGENT_CREATE, Workspace()))
- @rbac_permission_required(RBACCheck(RBACPermission.AGENT_IMPORT_EXPORT_DSL, Workspace()))
- def _import_agent_package(self, current_user: Account, source: BinaryIO, payload: AppImportPayload | None = None):
- app_id = payload.app_id if payload is not None else request.form.get("app_id")
- if app_id:
- raise InvalidRosterAgentPackageError("Roster Agent package import does not support overwriting an App")
- account, tenant_id = _current_user_and_tenant_id(current_user)
- if tenant_id is None:
- raise Forbidden("Current workspace is required")
- importer = RosterAgentPackageImporter()
- result = importer.import_package(source=source, tenant_id=tenant_id, account=account)
- return Import(
- id=str(uuid4()),
- status=ImportStatus.COMPLETED_WITH_WARNINGS if result.warnings else ImportStatus.COMPLETED,
- app_id=result.app_id,
- app_mode=AppMode.AGENT,
- warnings=result.warnings,
- ).model_dump(mode="json"), 200
-
- @cloud_edition_billing_resource_check("apps")
- @rbac_permission_required(RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, Workspace()))
- def _import_dsl(
- self,
- req_data: AppImportPayload,
- current_user: Account | None = None,
- *,
- package: PreparedAppPackage | None = None,
- ):
- current_user = current_user if current_user is not None else _current_user_and_tenant_id(None)[0]
-
- # AppDslService performs internal commits for some creation paths, so use a plain
- # Session here instead of nesting it inside sessionmaker(...).begin().
- with Session(db.engine, expire_on_commit=False) as session:
- import_service = AppDslService(session)
- # Import app
- account = current_user
- try:
- result = import_service.import_app(
- account=account,
- import_mode=req_data.mode,
- yaml_content=req_data.yaml_content,
- yaml_url=req_data.yaml_url,
- name=req_data.name,
- description=req_data.description,
- icon_type=req_data.icon_type,
- icon=req_data.icon,
- icon_background=req_data.icon_background,
- app_id=req_data.app_id,
- package=package,
- )
- except NoPermissionError as e:
- raise Forbidden(str(e))
- if result.status == ImportStatus.FAILED:
- session.rollback()
- else:
- session.commit()
-
- is_created_app = req_data.app_id is None and result.status in {
- ImportStatus.COMPLETED,
- ImportStatus.COMPLETED_WITH_WARNINGS,
- }
- if dify_config.RBAC_ENABLED and is_created_app and result.app_id:
- current_user, current_tenant_id = _current_user_and_tenant_id(current_user)
- if current_tenant_id:
- result.permission_keys = get_app_permission_keys(
- current_tenant_id,
- current_user.id,
- result.app_id,
- )
-
- if result.app_id and SystemFeatureService.is_webapp_auth_enabled():
- # update web app setting as private
- EnterpriseService.WebAppAuth.update_app_access_mode(result.app_id, "private")
- # Return appropriate status code based on result
- status = result.status
- match status:
- case ImportStatus.FAILED:
- return result.model_dump(mode="json"), 400
- case ImportStatus.PENDING:
- return result.model_dump(mode="json"), 202
- case ImportStatus.COMPLETED | ImportStatus.COMPLETED_WITH_WARNINGS:
- return result.model_dump(mode="json"), 200
+ payload = AppImportPayload.model_validate({**request.form.to_dict(), "mode": "yaml-content"})
+ else:
+ payload = validate_request(AppImportPayload)
+ try:
+ result = application_services().apps.console.import_app(context, payload, source=source)
+ except NoPermissionError as exc:
+ raise Forbidden(str(exc)) from exc
+ status_code = {ImportStatus.FAILED: HTTPStatus.BAD_REQUEST, ImportStatus.PENDING: HTTPStatus.ACCEPTED}.get(
+ result.status, HTTPStatus.OK
+ )
+ return result.model_dump(mode="json"), status_code
@console_ns.route("/apps/imports/<string:import_id>/confirm")
class AppImportConfirmApi(Resource):
- @console_ns.response(200, "Import confirmed", console_ns.models[Import.__name__])
- @console_ns.response(400, "Import failed", console_ns.models[Import.__name__])
- @setup_required
- @login_required
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, Workspace()))
- @with_current_user
- def post(self, current_user: Account | None = None, import_id: str = ""):
- current_user = current_user if current_user is not None else _current_user_and_tenant_id(None)[0]
- redis_key = f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}"
- pending_data_raw = redis_client.get(redis_key)
- pending_data: PendingData | None = None
- if pending_data_raw:
- pending_data = PendingData.model_validate_json(pending_data_raw)
-
- with Session(db.engine, expire_on_commit=False) as session:
- import_service = AppDslService(session)
- # Confirm import
- account = current_user
- try:
- result = import_service.confirm_import(import_id=import_id, account=account)
- except NoPermissionError as e:
- raise Forbidden(str(e))
- if result.status == ImportStatus.FAILED:
- session.rollback()
- else:
- session.commit()
-
- is_created_app = bool(
- pending_data
- and pending_data.app_id is None
- and result.status
- in {
- ImportStatus.COMPLETED,
- ImportStatus.COMPLETED_WITH_WARNINGS,
- }
- )
- if dify_config.RBAC_ENABLED and is_created_app and result.app_id:
- current_user, current_tenant_id = _current_user_and_tenant_id(current_user)
- if current_tenant_id:
- result.permission_keys = get_app_permission_keys(
- current_tenant_id,
- current_user.id,
- result.app_id,
- )
-
- # Return appropriate status code based on result
- if result.status == ImportStatus.FAILED:
- return result.model_dump(mode="json"), 400
- return result.model_dump(mode="json"), 200
+ @console_ns.response(HTTPStatus.OK, "Import confirmed", console_ns.models[Import.__name__])
+ @console_ns.response(HTTPStatus.BAD_REQUEST, "Import failed", console_ns.models[Import.__name__])
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, Workspace())],
+ )
+ def post(self, context: RequestContext, import_id: str):
+ try:
+ result = application_services().apps.console.confirm_import(context, import_id)
+ except NoPermissionError as exc:
+ raise Forbidden(str(exc)) from exc
+ status_code = HTTPStatus.BAD_REQUEST if result.status == ImportStatus.FAILED else HTTPStatus.OK
+ return result.model_dump(mode="json"), status_code
@console_ns.route("/apps/imports/<string:app_id>/check-dependencies")
class AppImportCheckDependenciesApi(Resource):
@console_ns.response(
- 200,
+ HTTPStatus.OK,
"Dependencies checked",
console_ns.models[CheckDependenciesResult.__name__],
)
- @setup_required
- @login_required
- @get_app_model
- @account_initialization_required
- @edit_permission_required
- @rbac_permission_required(RBACCheck(RBACPermission.APP_VIEW_LAYOUT, PlainApp()))
- def get(self, app_model: App):
- with Session(db.engine, expire_on_commit=False) as session:
- import_service = AppDslService(session)
- result = import_service.check_dependencies(app_model=app_model)
-
- return result.model_dump(mode="json"), 200
+ @console_account_admission(
+ allowed_roles=_EDIT_ROLES,
+ rbac_checks=[RBACCheck(RBACPermission.APP_VIEW_LAYOUT, PlainApp())],
+ )
+ def get(self, context: RequestContext, app_id: str):
+ try:
+ result = application_services().apps.console.check_import_dependencies(context, app_id)
+ except ConsoleAppNotFoundError as exc:
+ raise AppNotFoundError() from exc
+ return result.model_dump(mode="json"), HTTPStatus.OK
diff --git a/api/controllers/console/app/workflow.py b/api/controllers/console/app/workflow.py
index c8aac9d7d96..c646589f126 100644
--- a/api/controllers/console/app/workflow.py
+++ b/api/controllers/console/app/workflow.py
@@ -21,7 +21,6 @@ from werkzeug.exceptions import BadRequest, Forbidden, InternalServerError, NotF
import services
from configs import dify_config
-from controllers.common.app_access import resolve_app_access_filter
from controllers.common.controller_schemas import DefaultBlockConfigQuery, WorkflowListQuery, WorkflowUpdatePayload
from controllers.common.errors import InvalidArgumentError
from controllers.common.fields import GeneratedAppResponse, NewAppResponse, SimpleResultResponse
@@ -96,6 +95,7 @@ from models.model import AppMode
from models.workflow import Workflow
from repositories.workflow_collaboration_repository import WORKFLOW_ONLINE_USERS_PREFIX
from services.agent.retirement_service import WorkflowAgentRetirementService
+from services.app.access import resolve_app_access_filter
from services.app_generate_service import AppGenerateService
from services.errors.app import IsDraftWorkflowError, WorkflowHashNotEqualError, WorkflowNotFoundError
from services.errors.llm import InvokeRateLimitError
diff --git a/api/controllers/console/datasets/datasets.py b/api/controllers/console/datasets/datasets.py
index 8e3c24d19c3..f84d55ebec3 100644
--- a/api/controllers/console/datasets/datasets.py
+++ b/api/controllers/console/datasets/datasets.py
@@ -1,5 +1,6 @@
from dataclasses import dataclass
from datetime import datetime
+from http import HTTPStatus
from typing import Any
from uuid import UUID
@@ -55,10 +56,9 @@ from libs.login import login_required
from libs.pagination import clamp_pagination
from libs.url_utils import normalize_api_base_url
from machinery.context import RequestContext
-from models import Account, App, Dataset, Document, UploadFile
+from models import Account, Dataset, Document, UploadFile
from models.dataset import DatasetPermission, DatasetPermissionEnum, DatasetQuery
from models.provider_ids import ModelProviderID
-from services.app_service import AppService
from services.dataset_ref_service import DatasetRefService
from services.dataset_service import DatasetPermissionService, DatasetService, DocumentService
from services.enterprise import rbac_service as enterprise_rbac_service
@@ -269,21 +269,6 @@ class RelatedAppResponse(ResponseModel):
return self
-@dataclass(frozen=True)
-class _RelatedAppResponseSource:
- """Expose the compatible app mode through the request's database session."""
-
- app: App
- session: Session
-
- @property
- def mode_compatible_with_agent(self) -> str:
- return self.app.mode_compatible_with_agent_with_session(session=self.session)
-
- def __getattr__(self, name: str) -> Any:
- return getattr(self.app, name) # guard-ignore: no-new-getattr -- delegates model fields
-
-
class RelatedAppListResponse(ResponseModel):
data: list[RelatedAppResponse]
total: int
@@ -452,7 +437,9 @@ class DatasetListApi(Resource):
@console_ns.doc("get_datasets")
@console_ns.doc(description="Get list of datasets")
@console_ns.doc(params=query_params_from_model(ConsoleDatasetListQuery))
- @console_ns.response(200, "Datasets retrieved successfully", console_ns.models[DatasetListResponse.__name__])
+ @console_ns.response(
+ HTTPStatus.OK, "Datasets retrieved successfully", console_ns.models[DatasetListResponse.__name__]
+ )
@setup_required
@login_required
@account_initialization_required
@@ -527,6 +514,7 @@ class DatasetListApi(Resource):
query.keyword,
query.tag_ids,
query.include_all,
+ tags=application_services().tags,
accessible_dataset_ids=accessible_dataset_ids,
include_own_datasets=include_own_datasets,
)
@@ -591,7 +579,7 @@ class DatasetListApi(Resource):
"total": total,
"page": effective_page,
}
- return dump_response(DatasetListResponse, response), 200
+ return dump_response(DatasetListResponse, response), HTTPStatus.OK
@console_ns.doc("create_dataset")
@console_ns.doc(description="Create a new dataset")
@@ -1030,7 +1018,7 @@ class DatasetRelatedAppListApi(Resource):
@console_ns.doc(description="Get applications related to dataset")
@console_ns.doc(params={"dataset_id": "Dataset ID"})
@console_ns.response(
- 200,
+ HTTPStatus.OK,
"Related apps retrieved successfully",
console_ns.models[RelatedAppListResponse.__name__],
)
@@ -1053,13 +1041,11 @@ class DatasetRelatedAppListApi(Resource):
app_dataset_joins = DatasetService.get_related_apps(dataset.id, session)
- related_apps = []
- for app_dataset_join in app_dataset_joins:
- app_model = AppService.get_app_by_id(app_dataset_join.app_id, session)
- if app_model:
- related_apps.append(_RelatedAppResponseSource(app=app_model, session=session))
+ related_apps = application_services().apps.queries.related_apps(
+ dataset.tenant_id, [join.app_id for join in app_dataset_joins]
+ )
- return dump_response(RelatedAppListResponse, {"data": related_apps, "total": len(related_apps)}), 200
+ return dump_response(RelatedAppListResponse, {"data": related_apps, "total": len(related_apps)}), HTTPStatus.OK
@console_ns.route("/datasets/<uuid:dataset_id>/indexing-status")
diff --git a/api/controllers/console/flask_admission.py b/api/controllers/console/flask_admission.py
index bcf99578a5b..cb923fb4606 100644
--- a/api/controllers/console/flask_admission.py
+++ b/api/controllers/console/flask_admission.py
@@ -2,6 +2,7 @@
from collections.abc import Callable, Sequence
from functools import wraps
+from http import HTTPStatus
from typing import Concatenate
from flask import Response, abort, request
@@ -11,6 +12,7 @@ from configs import dify_config
from controllers.common.rbac import RBAC_CHECKS_ATTR, RBACCheck, enforce_rbac_checks
from controllers.console.wraps import (
account_initialization_required,
+ cloud_edition_billing_resource_check,
enable_change_email,
enterprise_license_required,
setup_required,
@@ -50,6 +52,7 @@ def console_account_admission[T, **P, R](
require_oauth_bearer_enabled: bool = False,
allowed_roles: frozenset[TenantAccountRole] | None = None,
rbac_checks: Sequence[RBACCheck] | None = None,
+ billing_resource: str | None = None,
) -> Callable[
[Callable[Concatenate[T, RequestContext, P], R]],
Callable[Concatenate[T, P], R | Response],
@@ -59,12 +62,15 @@ def console_account_admission[T, **P, R](
All combinations use this decorator factory. Requirements are data, while
the execution order stays fixed: edition, setup, login/CSRF, optional
account initialization, optional enterprise license and feature checks,
- role/RBAC checks, then context construction.
+ role/RBAC checks, then context construction and optional billing-resource
+ admission.
"""
def decorator(
view: Callable[Concatenate[T, RequestContext, P], R],
) -> Callable[Concatenate[T, P], R | Response]:
+ admitted_view = cloud_edition_billing_resource_check(billing_resource)(view) if billing_resource else view
+
@wraps(view, updated=())
def inject_request_context(self: T, /, *args: P.args, **kwargs: P.kwargs) -> R:
account_with_tenant = current_account_with_tenant()
@@ -85,7 +91,7 @@ def console_account_admission[T, **P, R](
request_id=get_request_id(),
trace_id=get_trace_id() or request.headers.get("X-Trace-Id"),
)
- return view(self, request_context, *args, **kwargs)
+ return admitted_view(self, request_context, *args, **kwargs)
if rbac_checks is not None:
setattr(inject_request_context, RBAC_CHECKS_ATTR, rbac_checks)
@@ -108,7 +114,7 @@ def console_account_admission[T, **P, R](
@wraps(view)
def enforce_edition(self: T, /, *args: P.args, **kwargs: P.kwargs) -> R | Response:
if dify_config.DEPLOYMENT_EDITION not in editions:
- abort(404)
+ abort(HTTPStatus.NOT_FOUND)
return admitted(self, *args, **kwargs)
return enforce_edition
diff --git a/api/controllers/console/workspace/snippets.py b/api/controllers/console/workspace/snippets.py
index ec69ddf85ea..310199482ff 100644
--- a/api/controllers/console/workspace/snippets.py
+++ b/api/controllers/console/workspace/snippets.py
@@ -1,4 +1,5 @@
import logging
+from http import HTTPStatus
from urllib.parse import quote
from uuid import UUID
@@ -35,6 +36,7 @@ from controllers.console.wraps import (
)
from core.db.session_factory import session_factory
from core.plugin.entities.plugin import PluginDependency
+from extensions.ext_application_services import application_services
from fields.base import ResponseModel
from fields.snippet_fields import (
SnippetListItemResponse,
@@ -115,7 +117,9 @@ register_response_schema_models(
class CustomizedSnippetsApi(Resource):
@console_ns.doc("list_customized_snippets")
@console_ns.doc(params=query_params_from_model(SnippetListQuery))
- @console_ns.response(200, "Snippets retrieved successfully", console_ns.models[SnippetPaginationResponse.__name__])
+ @console_ns.response(
+ HTTPStatus.OK, "Snippets retrieved successfully", console_ns.models[SnippetPaginationResponse.__name__]
+ )
@setup_required
@login_required
@account_initialization_required
@@ -135,6 +139,7 @@ class CustomizedSnippetsApi(Resource):
is_published=query.is_published,
creators=query.creators,
tag_ids=query.tag_ids,
+ tags=application_services().tags,
)
return dump_response(
@@ -146,7 +151,7 @@ class CustomizedSnippetsApi(Resource):
"total": total,
"has_more": has_more,
},
- ), 200
+ ), HTTPStatus.OK
@console_ns.doc("create_customized_snippet")
@console_ns.expect(console_ns.models.get(CreateSnippetPayload.__name__))
diff --git a/api/controllers/inner_api/app/dsl.py b/api/controllers/inner_api/app/dsl.py
index 80e514855ee..5f3d50f4750 100644
--- a/api/controllers/inner_api/app/dsl.py
+++ b/api/controllers/inner_api/app/dsl.py
@@ -5,23 +5,24 @@ to attribute the created app; workspace/membership validation is done by the
Go admin-api caller.
"""
+from http import HTTPStatus
from uuid import UUID
from flask import request
from flask_restx import Resource
from pydantic import BaseModel, Field, ValidationError, field_validator
-from sqlalchemy import select
-from sqlalchemy.orm import Session
from controllers.common.schema import query_params_from_model, register_schema_model
from controllers.console.wraps import model_validate, setup_required
from controllers.inner_api import inner_api_ns
from controllers.inner_api.wraps import enterprise_inner_api_only
+from core.logging.context import get_request_id, get_trace_id
+from extensions.ext_application_services import application_services
from extensions.ext_database import db
-from models import Account, App
-from models.account import AccountStatus
+from libs.helper import dump_response
+from models import App
from services.app_dsl_service import AppDslService
-from services.entities.dsl_entities import ImportMode, ImportStatus
+from services.entities.dsl_entities import AppImportParams, Import, ImportMode, ImportStatus
from services.errors.app import IsDraftWorkflowError, WorkflowNotFoundError
@@ -55,40 +56,36 @@ class EnterpriseAppDSLImport(Resource):
@inner_api_ns.expect(inner_api_ns.models[InnerAppDSLImportPayload.__name__])
@inner_api_ns.doc(
responses={
- 200: "Import completed",
- 202: "Import pending (DSL version mismatch requires confirmation)",
- 400: "Import failed (business error)",
- 404: "Creator account not found or inactive",
+ HTTPStatus.OK: "Import completed",
+ HTTPStatus.ACCEPTED: "Import pending (DSL version mismatch requires confirmation)",
+ HTTPStatus.BAD_REQUEST: "Import failed (business error)",
+ HTTPStatus.NOT_FOUND: "Creator account not found or inactive",
}
)
@model_validate(InnerAppDSLImportPayload)
def post(self, args: InnerAppDSLImportPayload, workspace_id: str):
"""Import a DSL into a workspace on behalf of a specified creator."""
- account = _get_active_account(args.creator_email)
- if account is None:
- return {"message": f"account '{args.creator_email}' not found or inactive"}, 404
-
- with Session(db.engine, expire_on_commit=False) as session:
- account.set_tenant_id_with_session(workspace_id, session=session)
- dsl_service = AppDslService(session)
- result = dsl_service.import_app(
- account=account,
- import_mode=ImportMode.YAML_CONTENT,
+ result = application_services().apps.imports.import_as_creator(
+ workspace_id=workspace_id,
+ creator_email=args.creator_email,
+ params=AppImportParams(
+ mode=ImportMode.YAML_CONTENT,
yaml_content=args.yaml_content,
name=args.name,
description=args.description,
- )
- if result.status == ImportStatus.FAILED:
- session.rollback()
- else:
- session.commit()
+ ),
+ request_id=get_request_id(),
+ trace_id=get_trace_id(),
+ )
+ if result is None:
+ return {"message": f"account '{args.creator_email}' not found or inactive"}, HTTPStatus.NOT_FOUND
if result.status == ImportStatus.FAILED:
- return result.model_dump(mode="json"), 400
+ return dump_response(Import, result), HTTPStatus.BAD_REQUEST
if result.status == ImportStatus.PENDING:
- return result.model_dump(mode="json"), 202
- return result.model_dump(mode="json"), 200
+ return dump_response(Import, result), HTTPStatus.ACCEPTED
+ return dump_response(Import, result), HTTPStatus.OK
@inner_api_ns.route("/enterprise/apps/<string:app_id>/dsl")
@@ -141,14 +138,3 @@ class EnterpriseAppDSLExport(Resource):
return {"code": "workflow_version_not_published", "message": str(exc), "status": 400}, 400
return {"data": data}, 200
-
-
-def _get_active_account(email: str) -> Account | None:
- """Look up an active account by email.
-
- Workspace membership is already validated by the Go admin-api caller.
- """
- account = db.session.scalar(select(Account).where(Account.email == email).limit(1))
- if account is None or account.status != AccountStatus.ACTIVE:
- return None
- return account
diff --git a/api/controllers/openapi/__init__.py b/api/controllers/openapi/__init__.py
index 7a0c3270362..241f954f3e6 100644
--- a/api/controllers/openapi/__init__.py
+++ b/api/controllers/openapi/__init__.py
@@ -93,8 +93,7 @@ from controllers.openapi._models import (
WorkspaceSummaryResponse,
)
from fields.file_fields import FileResponse
-from services.app_dsl_service import Import
-from services.entities.dsl_entities import CheckDependenciesResult
+from services.entities.dsl_entities import CheckDependenciesResult, Import
register_schema_models(
openapi_ns,
diff --git a/api/controllers/openapi/_contract.py b/api/controllers/openapi/_contract.py
index 97497b2e305..bcd16c046fb 100644
--- a/api/controllers/openapi/_contract.py
+++ b/api/controllers/openapi/_contract.py
@@ -154,6 +154,7 @@ def endpoint(
body: type[BaseModel] | None = None,
returns: ReturnSpec | Sequence[ReturnSpec] | None = None,
edition: frozenset[DeploymentEdition] | None = None,
+ account_context: bool = False,
internal: bool = False,
deprecated: bool = False,
examples: Sequence[Example] = (),
@@ -163,6 +164,11 @@ def endpoint(
``view.__handler__`` (the bare handler) and ``view.__spec__`` (the exact
`EndpointSpec` instance the router runs).
+ ``account_context=True`` supplies a framework-neutral ``RequestContext`` after
+ account/workspace admission and releases the authentication session before
+ the handler. It is for account endpoints whose application services own
+ persistence; other endpoints retain the lazy ORM-backed ``Context``.
+
``returns`` takes one ``(code, model, description)`` or several; a route
that stacked N ``@returns`` today declares them here in the same top-to-bottom
order and gets the identical nesting back — first entry outermost, last entry
@@ -181,6 +187,7 @@ def endpoint(
spec = EndpointSpec(
requirements=requirements,
edition=edition,
+ account_context=account_context,
catalog=CatalogMeta(
op=op,
kind=kind,
diff --git a/api/controllers/openapi/app_dsl.py b/api/controllers/openapi/app_dsl.py
index b9698bd7221..ee62b583a76 100644
--- a/api/controllers/openapi/app_dsl.py
+++ b/api/controllers/openapi/app_dsl.py
@@ -1,7 +1,9 @@
from __future__ import annotations
+from http import HTTPStatus
+from uuid import UUID
+
from flask_restx import Resource
-from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden
from constants.oauth_bearer import Scope
@@ -25,10 +27,12 @@ from controllers.openapi.auth.requirements import (
CheckWorkspaceRole,
)
from controllers.openapi.auth.subjects import AccountSubject
+from extensions.ext_application_services import application_services
from extensions.ext_database import db
+from machinery.context import RequestContext
from models.account import TenantAccountRole
-from services.app_dsl_service import AppDslService, Import
-from services.entities.dsl_entities import CheckDependenciesResult, ImportStatus
+from services.app_dsl_service import AppDslService
+from services.entities.dsl_entities import AppImportParams, CheckDependenciesResult, Import, ImportStatus
from services.errors.account import NoPermissionError
from services.errors.app import WorkflowNotFoundError
@@ -61,6 +65,7 @@ class AppDslImportApi(Resource):
"""
@endpoint(
+ account_context=True,
op="console_app.dsl.import",
kind=Kind.OBJECT,
summary="Import an app from DSL text or URL",
@@ -87,44 +92,27 @@ class AppDslImportApi(Resource):
),
body=AppDslImportPayload,
returns=(
- (200, AppDslImportResponse, "Import completed"),
- (202, AppDslImportResponse, "Import pending confirmation"),
- (400, AppDslImportResponse, "Import failed"),
+ (HTTPStatus.OK, AppDslImportResponse, "Import completed"),
+ (HTTPStatus.ACCEPTED, AppDslImportResponse, "Import pending confirmation"),
+ (HTTPStatus.BAD_REQUEST, AppDslImportResponse, "Import failed"),
),
)
- def post(self, ctx: Context, workspace_id: str, *, body: AppDslImportPayload):
- account = ctx.account
-
- with Session(db.engine, expire_on_commit=False) as session:
- service = AppDslService(session)
- try:
- result = service.import_app(
- account=account,
- import_mode=body.mode,
- yaml_content=body.yaml_content,
- yaml_url=body.yaml_url,
- name=body.name,
- description=body.description,
- icon_type=body.icon_type,
- icon=body.icon,
- icon_background=body.icon_background,
- app_id=body.app_id,
- )
- except NoPermissionError as exc:
- raise Forbidden(str(exc)) from exc
- if result.status == ImportStatus.FAILED:
- session.rollback()
- else:
- session.commit()
+ def post(self, ctx: RequestContext, workspace_id: str, *, body: AppDslImportPayload):
+ try:
+ result = application_services().apps.imports.import_app(
+ ctx, AppImportParams.model_validate(body.model_dump())
+ )
+ except NoPermissionError as exc:
+ raise Forbidden(str(exc)) from exc
response = _import_response(result, workspace_id=workspace_id)
match result.status:
case ImportStatus.FAILED:
- return response, 400
+ return response, HTTPStatus.BAD_REQUEST
case ImportStatus.PENDING:
- return response, 202
+ return response, HTTPStatus.ACCEPTED
case _:
- return response, 200
+ return response, HTTPStatus.OK
@openapi_ns.route("/workspaces/<string:workspace_id>/apps/imports/<string:import_id>:confirm")
@@ -140,6 +128,7 @@ class AppDslImportConfirmApi(Resource):
"""
@endpoint(
+ account_context=True,
op="console_app.dsl.import_confirm",
kind=Kind.OBJECT,
summary="Confirm a pending DSL import",
@@ -151,25 +140,17 @@ class AppDslImportConfirmApi(Resource):
CheckRBACPermission(RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, Workspace())),
CheckWorkspaceRole(frozenset({TenantAccountRole.EDITOR, TenantAccountRole.ADMIN, TenantAccountRole.OWNER})),
),
- returns=((200, Import, "Import confirmed"), (400, Import, "Import failed")),
+ returns=((HTTPStatus.OK, Import, "Import confirmed"), (HTTPStatus.BAD_REQUEST, Import, "Import failed")),
)
- def post(self, ctx: Context, workspace_id: str, import_id: str):
- account = ctx.account
-
- with Session(db.engine, expire_on_commit=False) as session:
- service = AppDslService(session)
- try:
- result = service.confirm_import(import_id=import_id, account=account)
- except NoPermissionError as exc:
- raise Forbidden(str(exc)) from exc
- if result.status == ImportStatus.FAILED:
- session.rollback()
- else:
- session.commit()
+ def post(self, ctx: RequestContext, workspace_id: str, import_id: str):
+ try:
+ result = application_services().apps.imports.confirm_import(ctx, import_id)
+ except NoPermissionError as exc:
+ raise Forbidden(str(exc)) from exc
if result.status == ImportStatus.FAILED:
- return result, 400
- return result, 200
+ return result, HTTPStatus.BAD_REQUEST
+ return result, HTTPStatus.OK
@openapi_ns.route("/apps/<string:app_id>/dsl")
@@ -231,6 +212,7 @@ class AppDslCheckDependenciesApi(Resource):
"""
@endpoint(
+ account_context=True,
op="console_app.dependencies.check",
kind=Kind.OBJECT,
summary="Check plugin dependencies of an app",
@@ -243,11 +225,9 @@ class AppDslCheckDependenciesApi(Resource):
CheckRBACPermission(RBACCheck(RBACPermission.APP_IMPORT_EXPORT_DSL, PlainApp())),
CheckWorkspaceRole(frozenset({TenantAccountRole.EDITOR, TenantAccountRole.ADMIN, TenantAccountRole.OWNER})),
),
- returns=(200, CheckDependenciesResult, "Dependencies checked"),
+ returns=(HTTPStatus.OK, CheckDependenciesResult, "Dependencies checked"),
)
- def get(self, ctx: Context, app_id: str):
- with Session(db.engine, expire_on_commit=False) as session:
- service = AppDslService(session)
- result = service.check_dependencies(app_model=ctx.app)
+ def get(self, ctx: RequestContext, app_id: str):
+ result = application_services().apps.imports.check_dependencies(ctx, str(UUID(app_id)))
- return result, 200
+ return result, HTTPStatus.OK
diff --git a/api/controllers/openapi/apps.py b/api/controllers/openapi/apps.py
index f01838e37e7..099f19ca785 100644
--- a/api/controllers/openapi/apps.py
+++ b/api/controllers/openapi/apps.py
@@ -3,6 +3,7 @@
from __future__ import annotations
import uuid as _uuid
+from http import HTTPStatus
from typing import Any
from flask_restx import Resource
@@ -10,7 +11,6 @@ from sqlalchemy.orm import Session
from configs import dify_config
from constants.oauth_bearer import Scope
-from controllers.common.app_access import AppAccessFilter, resolve_app_access_filter
from controllers.common.fields import Parameters
from controllers.common.rbac import PlainApp, RBACCheck, RBACPermission
from controllers.openapi import openapi_ns
@@ -36,14 +36,16 @@ from controllers.openapi.auth.requirements import (
from controllers.openapi.auth.subjects import AccountSubject
from controllers.service_api.app.error import AppUnavailableError
from core.app.app_config.common.parameters_mapping import get_parameters_from_feature_dict
+from extensions.ext_application_services import application_services
from models import App
from models.enums import AppStatus
from models.model import AppMode
from services.account_service import TenantService
-from services.app_service import AppListParams, AppService
+from services.app.access import AppAccessFilter, resolve_app_access_filter
+from services.entities.app_entities import AppListParams, AppSummary
-def _is_listable(app: App) -> bool:
+def _is_listable(app: AppSummary) -> bool:
"""Whether the openapi app face exposes this app (curated, listable types only)."""
return app.mode in SUPPORTED_APP_TYPES
@@ -147,7 +149,7 @@ class AppListApi(Resource):
CheckWorkspaceMember(),
),
query=AppListQuery,
- returns=(200, AppListResponse, "App list"),
+ returns=(HTTPStatus.OK, AppListResponse, "App list"),
)
def get(self, ctx: Context, *, query: AppListQuery):
workspace_id = query.workspace_id
@@ -171,7 +173,7 @@ class AppListApi(Resource):
tenant_name: str | None = None
if parsed_uuid is not None:
- app: App | None = AppService.get_visible_app_by_id(str(parsed_uuid), ctx.session)
+ app = application_services().apps.queries.get_visible_app_by_id(str(parsed_uuid), workspace_id)
if app is None or str(app.tenant_id) != workspace_id:
return empty
if not _is_listable(app):
@@ -208,7 +210,7 @@ class AppListApi(Resource):
access_filter.apply_to_params(params)
- pagination = AppService().get_paginate_apps(account_id, workspace_id, params, ctx.session)
+ pagination = application_services().apps.queries.get_paginate_apps(account_id, workspace_id, params)
if pagination is None:
return empty
diff --git a/api/controllers/openapi/apps_permitted_external.py b/api/controllers/openapi/apps_permitted_external.py
index f6b094c7338..a94dfc46808 100644
--- a/api/controllers/openapi/apps_permitted_external.py
+++ b/api/controllers/openapi/apps_permitted_external.py
@@ -7,6 +7,8 @@ EE blueprint chain so this module is unreachable there.
from __future__ import annotations
+from http import HTTPStatus
+
from flask_restx import Resource
from constants.oauth_bearer import Scope
@@ -29,11 +31,11 @@ from controllers.openapi.auth.requirements import (
)
from controllers.openapi.auth.subjects import ExternalSsoSubject
from enums import DeploymentEdition
-from models import App
+from extensions.ext_application_services import application_services
from models.enums import AppStatus
from services.account_service import TenantService
-from services.app_service import AppService
from services.enterprise.app_permitted_service import list_permitted_apps
+from services.entities.app_entities import AppSummary
_ENTERPRISE_ONLY = frozenset({DeploymentEdition.ENTERPRISE})
@@ -50,7 +52,7 @@ class PermittedExternalAppsListApi(Resource):
CheckScope(Scope.APPS_READ_PERMITTED_EXTERNAL),
),
query=PermittedExternalAppsListQuery,
- returns=(200, PermittedExternalAppsListResponse, "Permitted external apps list"),
+ returns=(HTTPStatus.OK, PermittedExternalAppsListResponse, "Permitted external apps list"),
edition=_ENTERPRISE_ONLY,
)
def get(self, ctx: Context, *, query: PermittedExternalAppsListQuery):
@@ -67,8 +69,8 @@ class PermittedExternalAppsListApi(Resource):
)
return env
- apps_by_id: dict[str, App] = {
- str(a.id): a for a in AppService.find_visible_apps_by_ids(page_result.app_ids, ctx.session)
+ apps_by_id: dict[str, AppSummary] = {
+ str(a.id): a for a in application_services().apps.queries.find_visible_apps_by_ids(page_result.app_ids)
}
tenant_ids = list({str(a.tenant_id) for a in apps_by_id.values()})
tenants_by_id = {str(t.id): t for t in TenantService.get_tenants_by_ids(tenant_ids, session=ctx.session)}
diff --git a/api/controllers/openapi/auth/pipelines.py b/api/controllers/openapi/auth/pipelines.py
index 516de2f4c0a..80b58559002 100644
--- a/api/controllers/openapi/auth/pipelines.py
+++ b/api/controllers/openapi/auth/pipelines.py
@@ -21,8 +21,10 @@ from controllers.openapi.auth.requirements import (
)
from controllers.openapi.auth.spec import EndpointSpec
from controllers.openapi.auth.subjects import AccountSubject, ExternalSsoSubject, Subject
+from core.logging.context import get_request_id, get_trace_id
from enums import DeploymentEdition
from libs.oauth_bearer import AuthContext, reset_auth_ctx, set_auth_ctx
+from machinery.context import RequestContext
from models.account import Account
from models.model import EndUser
@@ -54,6 +56,11 @@ class Pipeline:
for requirement in sorted(spec.requirements + self.fixed, key=lambda item: item.rank):
requirement.run(subject, ctx, session)
with mounted(subject, auth, ctx):
+ if spec.account_context:
+ request_context = RequestContext(get_request_id(), get_trace_id(), ctx.account.id, ctx.workspace.id)
+ session.commit()
+ session.close()
+ return call(ctx=request_context)
return call(ctx=ctx)
diff --git a/api/controllers/openapi/auth/router.py b/api/controllers/openapi/auth/router.py
index 2a6f56b23bd..b0a5fa396ef 100644
--- a/api/controllers/openapi/auth/router.py
+++ b/api/controllers/openapi/auth/router.py
@@ -57,9 +57,9 @@ class AuthRouter:
subject = subject_from_auth(auth)
pipeline = pipeline_for_subject(subject)
- # One session spans the loaders and the handler, so the objects the
- # requirements load stay attached while the handler reads them. It is
- # finalised here, like `with_session` does, until repositories own it.
+ # ORM-backed endpoints share the admission session with the handler.
+ # Account-context endpoints materialize identity and release it in the
+ # pipeline, before calling services that own their transactions.
with session_factory.create_session() as session:
ctx = Context(subject, session, dict(request.view_args or {}))
try:
diff --git a/api/controllers/openapi/auth/spec.py b/api/controllers/openapi/auth/spec.py
index adf0dc399a1..4a8f97c8c71 100644
--- a/api/controllers/openapi/auth/spec.py
+++ b/api/controllers/openapi/auth/spec.py
@@ -67,6 +67,7 @@ class EndpointSpec:
requirements: tuple[Requirement, ...]
catalog: CatalogMeta
edition: frozenset[DeploymentEdition] | None = None
+ account_context: bool = False
def allows(self, edition: DeploymentEdition) -> bool:
"""Whether this deployment exposes the route at all. `edition is None`
diff --git a/api/controllers/service_api/dataset/dataset.py b/api/controllers/service_api/dataset/dataset.py
index 653aaa97197..00c8d18894d 100644
--- a/api/controllers/service_api/dataset/dataset.py
+++ b/api/controllers/service_api/dataset/dataset.py
@@ -1,3 +1,4 @@
+from http import HTTPStatus
from typing import Annotated, Any, Literal, override
from uuid import UUID
@@ -34,6 +35,7 @@ from controllers.service_api.wraps import (
)
from core.plugin.impl.model_runtime_factory import create_plugin_provider_manager
from core.rag.index_processor.constant.index_type import IndexTechniqueType
+from extensions.ext_application_services import application_services
from fields.base import ResponseModel
from fields.dataset_fields import (
DatasetDetailPrefetch,
@@ -417,20 +419,20 @@ class DatasetListApi(DatasetApiResource):
description="Returns a paginated list of knowledge bases. Supports filtering by keyword and tags.",
tags=["Knowledge Bases"],
responses={
- 200: "List of knowledge bases.",
+ HTTPStatus.OK: "List of knowledge bases.",
},
)
@service_api_ns.doc("list_datasets")
@service_api_ns.doc(description="List all datasets")
@service_api_ns.doc(
responses={
- 200: "Datasets retrieved successfully",
- 401: "Unauthorized - invalid API token",
+ HTTPStatus.OK: "Datasets retrieved successfully",
+ HTTPStatus.UNAUTHORIZED: "Unauthorized - invalid API token",
}
)
@service_api_ns.doc(params=query_params_from_model(DatasetListQuery))
@service_api_ns.response(
- 200,
+ HTTPStatus.OK,
"Datasets retrieved successfully",
service_api_ns.models[DatasetListResponse.__name__],
)
@@ -453,6 +455,7 @@ class DatasetListApi(DatasetApiResource):
query.keyword,
query.tag_ids,
query.include_all,
+ tags=application_services().tags,
)
# check embedding setting
assert isinstance(current_user, Account)
@@ -486,7 +489,7 @@ class DatasetListApi(DatasetApiResource):
"total": total,
"page": effective_page,
}
- return _dump_service_dataset_list(response), 200
+ return _dump_service_dataset_list(response), HTTPStatus.OK
@service_api_ns.doc(
summary="Create an Empty Knowledge Base",
diff --git a/api/controllers/web/login.py b/api/controllers/web/login.py
index b95178327de..fad4fc0f513 100644
--- a/api/controllers/web/login.py
+++ b/api/controllers/web/login.py
@@ -1,4 +1,5 @@
import logging
+from http import HTTPStatus
from flask import make_response, request
from flask_restx import Resource
@@ -30,8 +31,9 @@ from controllers.console.wraps import (
setup_required,
)
from controllers.web import web_ns
-from controllers.web.wraps import decode_jwt_token
+from controllers.web.wraps import decode_jwt_token, resolve_web_app_id
from enums import DeploymentEdition
+from extensions.ext_application_services import application_services
from extensions.ext_database import db
from libs.helper import EmailStr, extract_remote_ip
from libs.passport import PassportService
@@ -41,7 +43,6 @@ from libs.token import (
extract_webapp_access_token,
)
from services.account_service import AccountService
-from services.app_service import AppService
from services.entities.auth_audit_entities import LoginFailureReason
from services.entities.auth_entities import LoginPayloadBase
from services.webapp_auth_service import WebAppAuthService
@@ -136,11 +137,11 @@ class LoginStatusApi(Resource):
@web_ns.doc(params=query_params_from_model(LoginStatusQuery))
@web_ns.doc(
responses={
- 200: "Login status",
- 401: "Login status",
+ HTTPStatus.OK: "Login status",
+ HTTPStatus.UNAUTHORIZED: "Login status",
}
)
- @web_ns.response(200, "Login status", web_ns.models[LoginStatusResponse.__name__])
+ @web_ns.response(HTTPStatus.OK, "Login status", web_ns.models[LoginStatusResponse.__name__])
@model_validate(LoginStatusQuery)
def get(self, query: LoginStatusQuery):
app_code = query.app_code
@@ -148,10 +149,10 @@ class LoginStatusApi(Resource):
token = extract_webapp_access_token(request)
if not app_code:
return LoginStatusResponse(logged_in=bool(token), app_logged_in=False).model_dump(mode="json")
- app_id = AppService.get_app_id_by_code(app_code, session=db.session())
+ app_id = resolve_web_app_id(app_code)
is_public = (
dify_config.DEPLOYMENT_EDITION != DeploymentEdition.ENTERPRISE
- or not WebAppAuthService.is_app_require_permission_check(app_id=app_id, session=db.session())
+ or not application_services().webapp_access.requires_permission_check(app_id)
)
user_logged_in = False
diff --git a/api/controllers/web/wraps.py b/api/controllers/web/wraps.py
index d6aac7e97c6..dd875ac889b 100644
--- a/api/controllers/web/wraps.py
+++ b/api/controllers/web/wraps.py
@@ -9,18 +9,22 @@ from sqlalchemy import select
from werkzeug.exceptions import BadRequest, NotFound, Unauthorized
from constants import HEADER_NAME_APP_CODE
-from controllers.web.error import WebAppAuthAccessDeniedError, WebAppAuthRequiredError
+from controllers.web.error import (
+ WebAppAccessServiceUnavailableError,
+ WebAppAuthAccessDeniedError,
+ WebAppAuthRequiredError,
+ WebAppNotFoundError,
+)
from core.db.session_factory import session_factory
from core.logging.context import set_identity_context
-from extensions.ext_database import db
+from extensions.ext_application_services import application_services
from libs.passport import PassportService
from libs.token import extract_webapp_passport
from models.model import App, EndUser, Site
-from services.app_service import AppService
from services.enterprise.enterprise_service import EnterpriseService, WebAppAccessMode, WebAppSettings
from services.system_feature_service import SystemFeatureService
from services.web_passport_gateways import resolve_web_app_auth_type
-from services.webapp_auth_service import WebAppAuthService
+from services.webapp_access_query_service import WebAppAccessAppNotFoundError, WebAppAccessUnavailableError
def validate_jwt_token[**P, R](
@@ -44,6 +48,16 @@ def validate_jwt_token[**P, R](
return decorator
+def resolve_web_app_id(app_code: str) -> str:
+ """Translate app lookup failures at the WebApp authentication boundary."""
+ try:
+ return application_services().webapp_access.get_app_id_by_code(app_code)
+ except WebAppAccessAppNotFoundError as exc:
+ raise WebAppNotFoundError() from exc
+ except WebAppAccessUnavailableError as exc:
+ raise WebAppAccessServiceUnavailableError() from exc
+
+
def decode_jwt_token(app_code: str | None = None, user_id: str | None = None) -> tuple[App, EndUser]:
webapp_auth_enabled = SystemFeatureService.is_webapp_auth_enabled()
if not app_code:
@@ -77,7 +91,7 @@ def decode_jwt_token(app_code: str | None = None, user_id: str | None = None) ->
app_web_auth_enabled = False
webapp_settings = None
if webapp_auth_enabled:
- app_id = AppService.get_app_id_by_code(app_code, session=db.session())
+ app_id = resolve_web_app_id(app_code)
webapp_settings = EnterpriseService.WebAppAuth.get_app_access_mode_by_id(app_id)
if not webapp_settings:
raise NotFound("Web app settings not found.")
@@ -91,7 +105,7 @@ def decode_jwt_token(app_code: str | None = None, user_id: str | None = None) ->
if webapp_auth_enabled:
if not app_code:
raise Unauthorized("Please re-login to access the web app.")
- app_id = AppService.get_app_id_by_code(app_code, session=db.session())
+ app_id = resolve_web_app_id(app_code)
app_web_auth_enabled = (
EnterpriseService.WebAppAuth.get_app_access_mode_by_id(app_id=app_id).access_mode
!= WebAppAccessMode.PUBLIC
@@ -142,10 +156,8 @@ def _validate_user_accessibility(
if auth_type != expected_auth_type:
raise WebAppAuthRequiredError()
- if WebAppAuthService.is_app_require_permission_check(
- access_mode=webapp_settings.access_mode, session=db.session()
- ):
- app_id = AppService.get_app_id_by_code(app_code, session=db.session())
+ if application_services().webapp_access.is_permission_check_required(webapp_settings.access_mode):
+ app_id = resolve_web_app_id(app_code)
if not EnterpriseService.WebAppAuth.is_user_allowed_to_access_webapp(user_id, app_id):
raise WebAppAuthAccessDeniedError()
diff --git a/api/core/ops/ops_trace_manager.py b/api/core/ops/ops_trace_manager.py
index 6402311864e..449e84d1699 100644
--- a/api/core/ops/ops_trace_manager.py
+++ b/api/core/ops/ops_trace_manager.py
@@ -582,48 +582,6 @@ class OpsTraceManager:
return app_model_config
- @classmethod
- def update_app_tracing_config(cls, app_id: str, enabled: bool, tracing_provider: str | None):
- """
- Update app tracing config
- :param app_id: app id
- :param enabled: enabled
- :param tracing_provider: tracing provider (None when disabling)
- :return:
- """
- # auth check
- if tracing_provider is not None:
- if tracing_provider not in TracingProviderEnum:
- raise ValueError(f"Invalid tracing provider: {tracing_provider}")
- if enabled:
- provider_config_map[tracing_provider]
-
- app_config: App | None = db.session.get(App, app_id)
- if not app_config:
- raise ValueError("App not found")
- app_config.tracing = json.dumps(
- {
- "enabled": enabled,
- "tracing_provider": tracing_provider,
- }
- )
- db.session.commit()
-
- @classmethod
- def get_app_tracing_config(cls, app_id: str, session: Session):
- """
- Get app tracing config
- :param app_id: app id
- :return:
- """
- app: App | None = session.get(App, app_id)
- if not app:
- raise ValueError("App not found")
- if not app.tracing:
- return {"enabled": False, "tracing_provider": None}
- app_trace_config = _app_tracing_config_adapter.validate_json(app.tracing)
- return app_trace_config
-
@staticmethod
def check_trace_config_is_effective(tracing_config: dict[str, Any], tracing_provider: str):
"""
diff --git a/api/events/event_handlers/create_installed_app_when_app_created.py b/api/events/event_handlers/create_installed_app_when_app_created.py
index 672ce6b7956..7b0358364d7 100644
--- a/api/events/event_handlers/create_installed_app_when_app_created.py
+++ b/api/events/event_handlers/create_installed_app_when_app_created.py
@@ -5,9 +5,11 @@ from services.app_creation_records import create_installed_app_record
@app_was_created.connect
-def handle(sender, *, session: Session, **kwargs) -> None:
- """Create an installed app when an app is created."""
- if kwargs.get("created_records_initialized"):
+def handle(sender, *, session: Session | None = None, created_records_initialized: bool = False, **kwargs) -> None:
+ """Create the installation in the caller's transaction unless it was already initialized."""
+ if created_records_initialized:
return
+ if session is None:
+ raise TypeError("session is required to initialize app creation records")
app = sender
create_installed_app_record(app=app, session=session)
diff --git a/api/events/event_handlers/create_site_record_when_app_created.py b/api/events/event_handlers/create_site_record_when_app_created.py
index 9b9b0450adf..45eff122321 100644
--- a/api/events/event_handlers/create_site_record_when_app_created.py
+++ b/api/events/event_handlers/create_site_record_when_app_created.py
@@ -5,10 +5,12 @@ from services.app_creation_records import create_site_record
@app_was_created.connect
-def handle(sender, *, session: Session, **kwargs) -> None:
- """Create site record when an app is created."""
- if kwargs.get("created_records_initialized"):
+def handle(sender, *, session: Session | None = None, created_records_initialized: bool = False, **kwargs) -> None:
+ """Create the site in the caller's transaction unless it was already initialized."""
+ if created_records_initialized:
return
+ if session is None:
+ raise TypeError("session is required to initialize app creation records")
app = sender
account = kwargs.get("account")
if account is not None:
diff --git a/api/extensions/application_services/app.py b/api/extensions/application_services/app.py
index b2faa315bd6..cd53aeebd71 100644
--- a/api/extensions/application_services/app.py
+++ b/api/extensions/application_services/app.py
@@ -1,10 +1,59 @@
-"""Compose App API access dependencies."""
+"""Composition of App use cases."""
+
+from dataclasses import dataclass
from sqlalchemy.orm import Session, sessionmaker
+from repositories.account_repository import SQLAlchemyAccountRepository
from repositories.app.api_key_repository import AppApiKeyRepository
+from repositories.app.console_repository import ConsoleAppRepository
+from services.agent.roster_package_exporter import RosterAgentPackageExporter
+from services.agent.roster_package_importer import RosterAgentPackageImporter
from services.api_token_service import ApiTokenCache
from services.app.api_key_service import AppApiKeyService
+from services.app.console_gateway import AppLifecycleGateway, AppTransferGateway, EnterpriseConsoleAppAccess
+from services.app.console_service import ConsoleAppService
+from services.app.creators_platform_gateway import CreatorsPlatformGateway
+from services.app.import_service import AppImportService
+from services.app.query_service import AppQueryService
+from services.app_dsl_service import AppDslService
+from services.app_package_service import AppPackageService
+from services.app_tracing_config_gateway import OpsTraceManagerGateway
+from services.oauth_server_service import OAuthServerService
+
+
+@dataclass(frozen=True, slots=True)
+class AppServices:
+ imports: AppImportService
+ console: ConsoleAppService
+ queries: AppQueryService
+
+
+def build_app_services(
+ *,
+ database_client: sessionmaker[Session],
+ oauth: OAuthServerService,
+) -> AppServices:
+ repository = ConsoleAppRepository(session_factory=database_client)
+ transfers = AppTransferGateway(
+ session_factory=database_client,
+ dsl_factory=AppDslService,
+ packages=AppPackageService(),
+ agent_packages=RosterAgentPackageExporter(),
+ agent_importer=RosterAgentPackageImporter(),
+ )
+ return AppServices(
+ imports=AppImportService(accounts=SQLAlchemyAccountRepository(database_client), definitions=transfers),
+ console=ConsoleAppService(
+ apps=repository,
+ access=EnterpriseConsoleAppAccess(session_factory=database_client),
+ transfers=transfers,
+ creators=CreatorsPlatformGateway(oauth=oauth),
+ tracing=OpsTraceManagerGateway(),
+ lifecycle=AppLifecycleGateway(session_factory=database_client),
+ ),
+ queries=AppQueryService(apps=repository),
+ )
def build_app_api_key_service(*, database_client: sessionmaker[Session]) -> AppApiKeyService:
diff --git a/api/extensions/ext_application_services.py b/api/extensions/ext_application_services.py
index ea0d90f1d3b..af28bae4933 100644
--- a/api/extensions/ext_application_services.py
+++ b/api/extensions/ext_application_services.py
@@ -24,7 +24,7 @@ from core.schemas.schema_manager import SchemaManager
from core.tools.tool_file_manager import ToolFileManager
from enums import DeploymentEdition, WebAppAccessMode
from extensions.application_services.agent import AgentAppServices, build_agent_app_services
-from extensions.application_services.app import build_app_api_key_service
+from extensions.application_services.app import AppServices, build_app_api_key_service, build_app_services
from extensions.application_services.knowledge import build_dataset_api_key_service
from extensions.ext_redis import RedisClientWrapper, redis_client
from extensions.ext_storage import storage
@@ -362,6 +362,7 @@ class ApplicationServices:
app_api_keys: AppApiKeyService
dataset_api_keys: DatasetApiKeyService
account_activation: AccountActivationService
+ apps: AppServices
app_definitions: AppDefinitionQueryService
app_preview_details: AppPreviewDetails
app_previews: AppPreviewQueryService
@@ -627,6 +628,7 @@ def build_application_services(
workflow_node_execution_repository = DifyAPIRepositoryFactory.create_api_workflow_node_execution_repository(
session_maker=database_client
)
+ oauth_server = _build_oauth_server_service(database_client=database_client, redis=redis)
return ApplicationServices(
accounts=AccountServices(
access=AccountAccessService(
@@ -782,6 +784,10 @@ def build_application_services(
enabled=dify_config.RBAC_ENABLED,
),
),
+ apps=build_app_services(
+ database_client=database_client,
+ oauth=oauth_server,
+ ),
agent_apps=build_agent_app_services(database_client=database_client),
advanced_prompt_templates=AdvancedPromptTemplateService(),
app_definitions=app_definitions,
@@ -892,7 +898,7 @@ def build_application_services(
files=UploadFileDeliveryQueryRepository(session_factory=database_client),
storage=storage,
),
- oauth_server=_build_oauth_server_service(database_client=database_client, redis=redis),
+ oauth_server=oauth_server,
oauth_device=_build_oauth_device_service(
database_client=database_client,
redis=redis,
diff --git a/api/fields/app_fields.py b/api/fields/app_fields.py
new file mode 100644
index 00000000000..9a446971274
--- /dev/null
+++ b/api/fields/app_fields.py
@@ -0,0 +1,302 @@
+"""Shared Console app response schemas for materialized application results."""
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import AliasChoices, Field, computed_field, field_validator
+
+from fields.base import ResponseModel
+from libs.helper import build_icon_url, to_timestamp
+from models.model import IconType
+from services.entities.app_entities import RecentAppMode
+from services.entities.dsl_entities import DslImportWarning, ImportStatus
+
+
+class AppTraceResponse(ResponseModel):
+ enabled: bool = False
+ tracing_provider: str | None = None
+
+
+class Tag(ResponseModel):
+ id: str
+ name: str
+ type: str
+
+
+class WorkflowPartial(ResponseModel):
+ id: str
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class ModelConfigPartial(ResponseModel):
+ model: Any | None = Field(default=None, validation_alias=AliasChoices("model_dict", "model"))
+ pre_prompt: str | None = None
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class AppModelConfigResponse(ResponseModel):
+ opening_statement: str | None = None
+ suggested_questions: Any | None = Field(
+ default=None, validation_alias=AliasChoices("suggested_questions_list", "suggested_questions")
+ )
+ suggested_questions_after_answer: Any | None = Field(
+ default=None,
+ validation_alias=AliasChoices("suggested_questions_after_answer_dict", "suggested_questions_after_answer"),
+ )
+ speech_to_text: Any | None = Field(
+ default=None, validation_alias=AliasChoices("speech_to_text_dict", "speech_to_text")
+ )
+ text_to_speech: Any | None = Field(
+ default=None, validation_alias=AliasChoices("text_to_speech_dict", "text_to_speech")
+ )
+ retriever_resource: Any | None = Field(
+ default=None, validation_alias=AliasChoices("retriever_resource_dict", "retriever_resource")
+ )
+ annotation_reply: Any | None = Field(
+ default=None, validation_alias=AliasChoices("annotation_reply_dict", "annotation_reply")
+ )
+ more_like_this: Any | None = Field(
+ default=None, validation_alias=AliasChoices("more_like_this_dict", "more_like_this")
+ )
+ sensitive_word_avoidance: Any | None = Field(
+ default=None, validation_alias=AliasChoices("sensitive_word_avoidance_dict", "sensitive_word_avoidance")
+ )
+ external_data_tools: Any | None = Field(
+ default=None, validation_alias=AliasChoices("external_data_tools_list", "external_data_tools")
+ )
+ model: Any | None = Field(default=None, validation_alias=AliasChoices("model_dict", "model"))
+ user_input_form: Any | None = Field(
+ default=None, validation_alias=AliasChoices("user_input_form_list", "user_input_form")
+ )
+ dataset_query_variable: str | None = None
+ pre_prompt: str | None = None
+ agent_mode: Any | None = Field(default=None, validation_alias=AliasChoices("agent_mode_dict", "agent_mode"))
+ prompt_type: str | None = None
+ chat_prompt_config: Any | None = Field(
+ default=None, validation_alias=AliasChoices("chat_prompt_config_dict", "chat_prompt_config")
+ )
+ completion_prompt_config: Any | None = Field(
+ default=None, validation_alias=AliasChoices("completion_prompt_config_dict", "completion_prompt_config")
+ )
+ dataset_configs: Any | None = Field(
+ default=None, validation_alias=AliasChoices("dataset_configs_dict", "dataset_configs")
+ )
+ file_upload: Any | None = Field(default=None, validation_alias=AliasChoices("file_upload_dict", "file_upload"))
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class AppDetailSiteResponse(ResponseModel):
+ access_token: str | None = Field(default=None, validation_alias="code")
+ code: str | None = None
+ title: str | None = None
+ icon_type: str | IconType | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ description: str | None = None
+ default_language: str | None = None
+ chat_color_theme: str | None = None
+ chat_color_theme_inverted: bool | None = None
+ customize_domain: str | None = None
+ copyright: str | None = None
+ privacy_policy: str | None = None
+ input_placeholder: str | None = None
+ custom_disclaimer: str | None = None
+ customize_token_strategy: str | None = None
+ prompt_public: bool | None = None
+ app_base_url: str | None = None
+ show_workflow_steps: bool | None = None
+ use_icon_as_answer_icon: bool | None = None
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+
+ @computed_field(return_type=str | None) # type: ignore
+ @property
+ def icon_url(self) -> str | None:
+ return build_icon_url(self.icon_type, self.icon)
+
+ @field_validator("icon_type", mode="before")
+ @classmethod
+ def _normalize_icon_type(cls, value: str | IconType | None) -> str | None:
+ if isinstance(value, IconType):
+ return value.value
+ return value
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class DeletedTool(ResponseModel):
+ type: str
+ tool_name: str
+ provider_id: str
+
+
+class AppPartial(ResponseModel):
+ id: str
+ name: str
+ max_active_requests: int | None = None
+ description: str | None = Field(default=None, validation_alias=AliasChoices("desc_or_prompt", "description"))
+ mode: str = Field(validation_alias="mode_compatible_with_agent")
+ icon_type: str | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ model_config_: ModelConfigPartial | None = Field(
+ default=None,
+ validation_alias=AliasChoices("app_model_config", "model_config"),
+ alias="model_config",
+ )
+ workflow: WorkflowPartial | None = None
+ use_icon_as_answer_icon: bool | None = None
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+ tags: list[Tag] = Field(default_factory=list)
+ access_mode: str | None = None
+ create_user_name: str | None = None
+ author_name: str | None = None
+ has_draft_trigger: bool | None = None
+ permission_keys: list[str] = Field(default_factory=list)
+ # For Agent App type: the roster Agent backing this app (None otherwise).
+ bound_agent_id: str | None = None
+ # For Agent App responses exposed through /agent.
+ app_id: str | None = None
+ is_starred: bool = False
+ maintainer: str | None = None
+
+ @computed_field(return_type=str | None) # type: ignore
+ @property
+ def icon_url(self) -> str | None:
+ return build_icon_url(self.icon_type, self.icon)
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class RecentAppResponse(ResponseModel):
+ id: str
+ name: str
+ icon_type: IconType | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ mode: RecentAppMode
+ author_name: str | None = None
+ updated_at: int
+ permission_keys: list[str] = Field(default_factory=list)
+ maintainer: str | None = None
+
+ @computed_field(return_type=str | None) # type: ignore[prop-decorator]
+ @property
+ def icon_url(self) -> str | None:
+ return build_icon_url(self.icon_type, self.icon)
+
+ @field_validator("updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int) -> int:
+ return to_timestamp(value)
+
+
+class RecentAppListResponse(ResponseModel):
+ data: list[RecentAppResponse]
+
+
+class AppDetail(ResponseModel):
+ id: str
+ name: str
+ description: str | None = None
+ mode: str = Field(validation_alias="mode_compatible_with_agent")
+ icon: str | None = None
+ icon_background: str | None = None
+ enable_site: bool
+ enable_api: bool
+ model_config_: AppModelConfigResponse | None = Field(
+ default=None,
+ validation_alias=AliasChoices("app_model_config", "model_config"),
+ alias="model_config",
+ )
+ workflow: WorkflowPartial | None = None
+ tracing: Any | None = None
+ use_icon_as_answer_icon: bool | None = None
+ created_by: str | None = None
+ created_at: int | None = None
+ updated_by: str | None = None
+ updated_at: int | None = None
+ access_mode: str | None = None
+ tags: list[Tag] = Field(default_factory=list)
+ permission_keys: list[str] = Field(default_factory=list)
+ maintainer: str | None = None
+
+ @field_validator("created_at", "updated_at", mode="before")
+ @classmethod
+ def _normalize_timestamp(cls, value: datetime | int | None) -> int | None:
+ return to_timestamp(value)
+
+
+class AppDetailWithSite(AppDetail):
+ icon_type: str | None = None
+ api_base_url: str | None = None
+ max_active_requests: int | None = None
+ deleted_tools: list[DeletedTool] = Field(default_factory=list)
+ site: AppDetailSiteResponse | None = None
+ # For Agent App type: the roster Agent backing this app (None otherwise).
+ bound_agent_id: str | None = None
+ # For Agent App responses exposed through /agent.
+ app_id: str | None = None
+
+ @computed_field(return_type=str | None) # type: ignore
+ @property
+ def icon_url(self) -> str | None:
+ return build_icon_url(self.icon_type, self.icon)
+
+
+class AppPagination(ResponseModel):
+ page: int
+ limit: int = Field(validation_alias=AliasChoices("per_page", "limit"))
+ total: int
+ has_more: bool = Field(validation_alias=AliasChoices("has_next", "has_more"))
+ data: list[AppPartial] = Field(validation_alias=AliasChoices("items", "data"))
+
+
+class AppExportResponse(ResponseModel):
+ data: str
+
+
+class AppImportResponse(ResponseModel):
+ id: str
+ status: ImportStatus
+ app_id: str | None = None
+ app_mode: str | None = None
+ current_dsl_version: str
+ imported_dsl_version: str = ""
+ error: str = ""
+ warnings: list[DslImportWarning] = Field(default_factory=list)
diff --git a/api/openapi/markdown/console-openapi.md b/api/openapi/markdown/console-openapi.md
index 06894457de6..5442befdf80 100644
--- a/api/openapi/markdown/console-openapi.md
+++ b/api/openapi/markdown/console-openapi.md
@@ -1497,8 +1497,6 @@ Get advanced prompt templates based on app mode and model configuration
| 400 | Invalid request parameters | |
### [GET] /apps
-**Get app list**
-
Get list of applications with pagination and filtering
#### Parameters
@@ -1521,8 +1519,6 @@ Get list of applications with pagination and filtering
| 200 | Success | **application/json**: [AppPagination](#apppagination)<br> |
### [POST] /apps
-**Create app**
-
Create a new application
#### Request Body
@@ -1585,8 +1581,6 @@ Create a new application
| 400 | Import failed | **application/json**: [Import](#import)<br> |
### [GET] /apps/recent
-**Return the lightweight app cards needed by the Explore home page**
-
Get recently modified apps for the home Continue Work section
#### Parameters
@@ -1639,8 +1633,6 @@ Get workflow online users
| 200 | Workflow online users retrieved successfully | **application/json**: [WorkflowOnlineUsersResponse](#workflowonlineusersresponse)<br> |
### [DELETE] /apps/{app_id}
-**Delete app**
-
Delete application
#### Parameters
@@ -1657,8 +1649,6 @@ Delete application
| 403 | Insufficient permissions |
### [GET] /apps/{app_id}
-**Get app detail**
-
Get application details
#### Parameters
@@ -1674,8 +1664,6 @@ Get application details
| 200 | Success | **application/json**: [AppDetailWithSite](#appdetailwithsite)<br> |
### [PUT] /apps/{app_id}
-**Update app**
-
Update application details
#### Parameters
@@ -2681,8 +2669,6 @@ Convert Completion App to Workflow App
| 403 | Permission denied | |
### [POST] /apps/{app_id}/copy
-**Copy app**
-
Create a copy of an existing application
#### Parameters
@@ -2706,8 +2692,6 @@ Create a copy of an existing application
| 403 | Insufficient permissions | |
### [GET] /apps/{app_id}/export
-**Export app**
-
Export application configuration as DSL
#### Parameters
@@ -2859,8 +2843,6 @@ Check if app name is available
| 200 | Name availability checked | **application/json**: [AppDetail](#appdetail)<br> |
### [POST] /apps/{app_id}/publish-to-creators-platform
-**Publish app to Creators Platform**
-
#### Parameters
| Name | Located in | Description | Required | Schema |
@@ -3220,8 +3202,6 @@ Get available TTS voices for a specific language
| 400 | Invalid language parameter | |
### [GET] /apps/{app_id}/trace
-**Get app trace**
-
Get app tracing configuration
#### Parameters
diff --git a/api/repositories/app/console_repository.py b/api/repositories/app/console_repository.py
new file mode 100644
index 00000000000..a6d52435482
--- /dev/null
+++ b/api/repositories/app/console_repository.py
@@ -0,0 +1,967 @@
+"""Console app persistence, reusing the established app queries and write operations.
+
+Console operations own short Sessions and materialize response records before
+closing them. Shared model queries accept an explicit caller-owned Session for
+existing use cases that still need attached models.
+"""
+
+from __future__ import annotations
+
+import json
+import logging
+from collections.abc import Sequence
+from dataclasses import replace
+from datetime import datetime
+from typing import Any, cast, override
+
+import sqlalchemy as sa
+from pydantic import TypeAdapter
+from sqlalchemy import ColumnElement, delete, select
+from sqlalchemy.exc import IntegrityError
+from sqlalchemy.orm import Session, sessionmaker
+
+from core.agent.publish_visibility import agent_has_workflow_callable_active_snapshot
+from core.trigger.constants import TRIGGER_NODE_TYPES
+from libs.datetime_utils import naive_utc_now
+from libs.pagination import PaginatedResult, paginate_query
+from machinery.context import RequestContext
+from models.account import Account, Tenant
+from models.agent import (
+ APP_BACKED_AGENT_SOURCES,
+ Agent,
+ AgentIconType,
+ AgentScope,
+ AgentStatus,
+ AgentWorkspaceBinding,
+ WorkflowAgentBindingType,
+ WorkflowAgentNodeBinding,
+)
+from models.enums import AppStatus
+from models.model import App, AppMode, AppModelConfig, AppStar, IconType
+from models.skill import AgentSkillBinding
+from models.workflow import Workflow
+from repositories.app.response import app_record, app_summary
+from repositories.tag_repository import TagRepository
+from services.agent.errors import (
+ AgentAccessNotReadyError,
+ AgentNameConflictError,
+)
+from services.app.console_service import ConsoleAppNotFoundError, ConsoleApps
+from services.app.query_service import AppQueryStore
+from services.app_creation_records import create_installed_app_record, create_site_record
+from services.entities.app_entities import (
+ RECENT_APP_MODES,
+ AppChange,
+ AppCreationSettings,
+ AppDeletion,
+ AppEvent,
+ AppListBaseParams,
+ AppListParams,
+ AppListSortBy,
+ AppPage,
+ AppRecord,
+ AppReference,
+ AppSummary,
+ AppTraceSettings,
+ AppUpdateArguments,
+ CreateAppParams,
+ RecentAppListItem,
+ RecentAppMode,
+ StarredAppListParams,
+ UpdateAppParams,
+)
+from services.errors.account import NoPermissionError
+from services.openapi.visibility import apply_openapi_gate, is_openapi_visible
+
+logger = logging.getLogger(__name__)
+_app_trace_settings_adapter = TypeAdapter(AppTraceSettings)
+
+
+def find_console_app(session: Session, *, workspace_id: str, app_id: str) -> App | None:
+ """Shared normal-app lookup, including the hidden workflow backing-app gate."""
+ app = session.scalar(
+ select(App)
+ .where(
+ App.id == app_id,
+ App.tenant_id == workspace_id,
+ App.status == AppStatus.NORMAL,
+ )
+ .limit(1)
+ )
+ if app is not None:
+ binding = app.agent_app_binding_with_session(session=session, include_archived=True)
+ if binding is not None and binding.scope == AgentScope.WORKFLOW_ONLY:
+ return None
+ return app
+
+
+def require_console_app(session: Session, context: RequestContext, app_id: str) -> App:
+ app = find_console_app(session, workspace_id=context.active_workspace_id, app_id=app_id)
+ if app is None:
+ raise ConsoleAppNotFoundError("App not found")
+ return app
+
+
+def console_app_actor(session: Session, context: RequestContext) -> Account:
+ account = session.get(Account, context.account_id)
+ tenant = session.get(Tenant, context.active_workspace_id)
+ if account is None or tenant is None:
+ raise NoPermissionError("Workspace membership not found")
+ account.set_current_tenant_with_session(tenant, session=session)
+ if account.current_tenant_id != context.active_workspace_id:
+ raise NoPermissionError("Workspace membership not found")
+ return account
+
+
+class ConsoleAppRepository(ConsoleApps, AppQueryStore):
+ def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
+ self._session_factory = session_factory
+
+ @override
+ def find_visible_app(self, app_id: str, tenant_id: str) -> AppSummary | None:
+ with self._session_factory() as session:
+ app = self.get_visible_app_by_id(app_id, session)
+ return app_summary(app) if app is not None and app.tenant_id == tenant_id else None
+
+ @override
+ def find_visible_apps(self, app_ids: Sequence[str]) -> list[AppSummary]:
+ with self._session_factory() as session:
+ return [app_summary(app) for app in self.find_visible_apps_by_ids(app_ids, session)]
+
+ @override
+ def query_apps(self, user_id: str, tenant_id: str, params: AppListParams) -> PaginatedResult[AppSummary] | None:
+ with self._session_factory() as session:
+ page = self.get_paginate_apps(user_id, tenant_id, params, session)
+ if page is None:
+ return None
+ return PaginatedResult(
+ items=[app_summary(app) for app in page.items],
+ total=page.total,
+ page=page.page,
+ per_page=page.per_page,
+ )
+
+ @override
+ def related_apps(self, tenant_id: str, app_ids: Sequence[str]) -> list[AppRecord]:
+ if not app_ids:
+ return []
+ with self._session_factory() as session:
+ apps = session.scalars(select(App).where(App.tenant_id == tenant_id, App.id.in_(app_ids))).all()
+ records = {app.id: app_record(app, session=session) for app in apps}
+ return [records[app_id] for app_id in app_ids if app_id in records]
+
+ @override
+ def list_apps(self, context: RequestContext, params: AppListParams | StarredAppListParams) -> AppPage:
+ with self._session_factory() as session:
+ if isinstance(params, StarredAppListParams):
+ page = self.get_paginate_starred_apps(
+ context.account_id,
+ context.active_workspace_id,
+ params,
+ session,
+ )
+ else:
+ page = self.get_paginate_apps(
+ context.account_id,
+ context.active_workspace_id,
+ params,
+ session,
+ )
+ if page is None:
+ return AppPage(page=params.page, limit=params.limit, total=0, has_more=False, data=[])
+ trigger_app_ids = self._draft_trigger_app_ids(session, context.active_workspace_id, page.items)
+ return AppPage(
+ page=page.page,
+ limit=page.per_page,
+ total=page.total,
+ has_more=page.has_next,
+ data=[
+ replace(
+ app_record(app, session=session),
+ has_draft_trigger=app.id in trigger_app_ids,
+ )
+ for app in page.items
+ ],
+ )
+
+ @override
+ def recent(self, context: RequestContext, params: AppListParams) -> list[RecentAppListItem]:
+ with self._session_factory() as session:
+ return self.get_recent_apps(context.account_id, context.active_workspace_id, params, session)
+
+ @override
+ def get(self, context: RequestContext, app_id: str) -> AppRecord:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ return app_record(app, session=session, projection="detail-with-site")
+
+ @override
+ def update(self, context: RequestContext, app_id: str, params: UpdateAppParams) -> AppRecord:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ changes: AppUpdateArguments = {
+ "name": params.name,
+ "description": params.description,
+ "icon_type": params.icon_type,
+ "icon": params.icon,
+ "icon_background": params.icon_background,
+ "use_icon_as_answer_icon": params.use_icon_as_answer_icon,
+ "max_active_requests": params.max_active_requests,
+ "role": params.role,
+ }
+ app = self.update_app(app, changes, account_id=context.account_id, session=session)
+ return app_record(app, session=session, projection="detail-with-site")
+
+ @override
+ def rename(self, context: RequestContext, app_id: str, name: str) -> AppRecord:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ app = self.update_app_name(app, name, account_id=context.account_id, session=session)
+ return app_record(app, session=session, projection="detail")
+
+ @override
+ def update_icon(
+ self, context: RequestContext, app_id: str, *, icon: str, icon_background: str, icon_type: str | None
+ ) -> AppRecord:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ app = self.update_app_icon(
+ app,
+ icon,
+ icon_background,
+ icon_type,
+ account_id=context.account_id,
+ session=session,
+ )
+ return app_record(app, session=session, projection="detail")
+
+ @override
+ def set_site_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppChange:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ changed = app.enable_site != enabled
+ app = self.update_app_site_status(app, enabled, account_id=context.account_id, session=session)
+ return AppChange(app_record(app, session=session, projection="detail"), changed)
+
+ @override
+ def set_api_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppChange:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ changed = app.enable_api != enabled
+ app = self.update_app_api_status(app, enabled, account_id=context.account_id, session=session)
+ return AppChange(app_record(app, session=session, projection="detail"), changed)
+
+ @override
+ def set_starred(self, context: RequestContext, app_id: str, starred: bool) -> None:
+ with self._session_factory.begin() as session:
+ app = require_console_app(session, context, app_id)
+ if starred:
+ self.star_app(app=app, account_id=context.account_id, session=session)
+ else:
+ self.unstar_app(app=app, account_id=context.account_id, session=session)
+
+ @override
+ def get_reference(self, context: RequestContext, app_id: str) -> AppReference:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ return AppReference(
+ id=app.id, name=app.name, mode=app.mode, bound_agent_id=app.bound_agent_id_with_session(session=session)
+ )
+
+ @override
+ def get_trace(self, context: RequestContext, app_id: str) -> AppTraceSettings:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ return _app_trace_settings_adapter.validate_json(app.tracing) if app.tracing else AppTraceSettings()
+
+ @override
+ def set_trace(self, context: RequestContext, app_id: str, settings: AppTraceSettings) -> None:
+ with self._session_factory.begin() as session:
+ app = require_console_app(session, context, app_id)
+ app.tracing = json.dumps({"enabled": settings.enabled, "tracing_provider": settings.tracing_provider})
+
+ @staticmethod
+ def _draft_trigger_app_ids(session: Session, workspace_id: str, apps: list[App]) -> set[str]:
+ workflow_app_ids = [app.id for app in apps if app.mode in {"workflow", "advanced-chat"}]
+ result: set[str] = set()
+ if not workflow_app_ids:
+ return result
+ workflows = session.scalars(
+ select(Workflow).where(
+ Workflow.version == Workflow.VERSION_DRAFT,
+ Workflow.app_id.in_(workflow_app_ids),
+ Workflow.tenant_id == workspace_id,
+ )
+ )
+ for workflow in workflows:
+ node_id = None
+ try:
+ for node_id, node_data in workflow.walk_nodes():
+ if node_data.get("type") in TRIGGER_NODE_TYPES:
+ result.add(workflow.app_id)
+ break
+ except Exception:
+ logger.exception("error while walking nodes, workflow_id=%s, node_id=%s", workflow.id, node_id)
+ return result
+
+ @staticmethod
+ def _agent_app_exists_filter(tenant_id: str, *, is_published: bool | None = None) -> sa.Exists:
+ agent_filters = [
+ Agent.tenant_id == tenant_id,
+ Agent.app_id == App.id,
+ Agent.scope == AgentScope.ROSTER,
+ Agent.source.in_(APP_BACKED_AGENT_SOURCES),
+ Agent.status == AgentStatus.ACTIVE,
+ ]
+ if is_published is not None:
+ has_published_config = sa.and_(
+ Agent.active_config_snapshot_id.is_not(None),
+ Agent.active_config_is_published.is_(True),
+ )
+ agent_filters.append(has_published_config if is_published else sa.not_(has_published_config))
+
+ return sa.exists().where(*agent_filters).correlate(App)
+
+ @staticmethod
+ def _build_app_list_filters(
+ user_id: str, tenant_id: str, params: AppListBaseParams, session: Session
+ ) -> list[sa.ColumnElement[bool]]:
+ filters = [App.tenant_id == tenant_id, App.is_universal == False]
+
+ if params.mode == "workflow":
+ filters.append(App.mode == AppMode.WORKFLOW)
+ elif params.mode == "completion":
+ filters.append(App.mode == AppMode.COMPLETION)
+ elif params.mode == "chat":
+ filters.append(App.mode == AppMode.CHAT)
+ elif params.mode == "advanced-chat":
+ filters.append(App.mode == AppMode.ADVANCED_CHAT)
+ elif params.mode == "agent-chat":
+ filters.append(App.mode == AppMode.AGENT_CHAT)
+ elif params.mode == "agent":
+ filters.append(App.mode == AppMode.AGENT)
+ publication_filter = params.agent_is_published if isinstance(params, AppListParams) else None
+ filters.append(ConsoleAppRepository._agent_app_exists_filter(tenant_id, is_published=publication_filter))
+ elif params.mode == "all":
+ filters.append(App.mode != AppMode.AGENT)
+
+ if isinstance(params, AppListParams):
+ if params.status:
+ filters.append(App.status == params.status)
+ # OpenAPI surface visibility gate. Pushed into the query so
+ # `pagination.total` reflects only apps the openapi caller can
+ # actually reach; post-filtering by enable_api after the page
+ # arrives would make `total` page-dependent.
+ if params.openapi_visible:
+ filters.append(App.enable_api.is_(True))
+
+ if params.is_created_by_me:
+ filters.append(App.created_by == user_id)
+ elif params.accessible_app_ids is not None:
+ accessible_filter: ColumnElement[bool] = App.id.in_(params.accessible_app_ids)
+ if params.include_own_apps:
+ accessible_filter = sa.or_(App.maintainer == user_id, accessible_filter)
+ filters.append(accessible_filter)
+ if params.creator_ids:
+ filters.append(App.created_by.in_(params.creator_ids))
+ if params.name:
+ from libs.helper import escape_like_pattern
+
+ name = params.name[:30]
+ escaped_name = escape_like_pattern(name)
+ filters.append(App.name.ilike(f"%{escaped_name}%", escape="\\"))
+ if params.tag_ids and len(params.tag_ids) > 0:
+ target_ids = TagRepository.get_target_ids_by_tag_ids(
+ "app", tenant_id, params.tag_ids, session, match_all=True
+ )
+ if target_ids and len(target_ids) > 0:
+ filters.append(App.id.in_(target_ids))
+ else:
+ return []
+
+ return filters
+
+ @staticmethod
+ def _build_app_list_order_by(sort_by: AppListSortBy) -> sa.ColumnElement[Any]:
+ return {
+ "last_modified": App.updated_at.desc(),
+ "recently_created": App.created_at.desc(),
+ "earliest_created": App.created_at.asc(),
+ }[sort_by]
+
+ @staticmethod
+ def get_starred_app_ids(
+ session: Session,
+ *,
+ tenant_id: str,
+ account_id: str,
+ app_ids: Sequence[str],
+ ) -> set[str]:
+ """Return app IDs starred by this account within the tenant."""
+ if not app_ids:
+ return set()
+
+ starred_app_ids = session.scalars(
+ select(AppStar.app_id).where(
+ AppStar.tenant_id == tenant_id,
+ AppStar.account_id == account_id,
+ AppStar.app_id.in_(list(app_ids)),
+ )
+ ).all()
+ return set(starred_app_ids)
+
+ @staticmethod
+ def get_console_app_by_id(app_id: str, workspace_id: str, session: Session) -> App | None:
+ return find_console_app(session, workspace_id=workspace_id, app_id=app_id)
+
+ @staticmethod
+ def get_visible_app_by_id(
+ app_id: str,
+ session: Session,
+ ) -> App | None:
+ app = session.get(App, app_id)
+ if not app or app.status != "normal" or not is_openapi_visible(app):
+ return None
+ return app
+
+ @staticmethod
+ def find_visible_apps_by_ids(
+ app_ids: Sequence[str],
+ session: Session,
+ ) -> list[App]:
+ if not app_ids:
+ return []
+ return list(session.execute(apply_openapi_gate(select(App).where(App.id.in_(list(app_ids))))).scalars().all())
+
+ @classmethod
+ def get_paginate_apps(
+ cls,
+ user_id: str,
+ tenant_id: str,
+ params: AppListParams,
+ session: Session,
+ ) -> PaginatedResult | None:
+ """
+ Get app list with pagination, filters, and explicit sort order.
+ :param user_id: user id
+ :param tenant_id: tenant id
+ :param params: query parameters
+ :return:
+ """
+ filters = cls._build_app_list_filters(user_id, tenant_id, params, session)
+ if not filters:
+ return None
+
+ order_by = cls._build_app_list_order_by(params.sort_by)
+
+ app_models = paginate_query(
+ sa.select(App).where(*filters).order_by(order_by),
+ page=params.page,
+ per_page=params.limit,
+ session=session,
+ )
+
+ app_ids = [str(app.id) for app in app_models.items]
+ starred_app_ids = cls.get_starred_app_ids(
+ session=session,
+ tenant_id=tenant_id,
+ account_id=user_id,
+ app_ids=app_ids,
+ )
+ for app in app_models.items:
+ app.is_starred = str(app.id) in starred_app_ids
+
+ return app_models
+
+ @classmethod
+ def get_recent_apps(
+ cls,
+ user_id: str,
+ tenant_id: str,
+ params: AppListParams,
+ session: Session,
+ ) -> list[RecentAppListItem]:
+ """Return recently modified apps as one lightweight, non-paginated projection."""
+ filters = cls._build_app_list_filters(user_id, tenant_id, params, session)
+ if not filters:
+ return []
+
+ stmt = (
+ sa.select(
+ App.id,
+ App.name,
+ App.icon_type,
+ App.icon,
+ App.icon_background,
+ App.mode,
+ Account.name.label("author_name"),
+ App.updated_at,
+ App.maintainer,
+ )
+ .outerjoin(Account, Account.id == App.created_by)
+ .where(*filters, App.mode.in_(RECENT_APP_MODES))
+ .order_by(App.updated_at.desc())
+ .limit(params.limit)
+ )
+ rows = session.execute(stmt).all()
+
+ return [
+ RecentAppListItem(
+ id=str(app_id),
+ name=name,
+ icon_type=icon_type,
+ icon=icon,
+ icon_background=icon_background,
+ mode=cast(RecentAppMode, mode),
+ author_name=author_name,
+ updated_at=updated_at,
+ maintainer=maintainer,
+ )
+ for (
+ app_id,
+ name,
+ icon_type,
+ icon,
+ icon_background,
+ mode,
+ author_name,
+ updated_at,
+ maintainer,
+ ) in rows
+ ]
+
+ @classmethod
+ def get_paginate_starred_apps(
+ cls,
+ user_id: str,
+ tenant_id: str,
+ params: StarredAppListParams,
+ session: Session,
+ ) -> PaginatedResult | None:
+ """
+ Get apps starred by the current account with pagination, filters, and explicit sort order.
+ """
+ filters = cls._build_app_list_filters(user_id, tenant_id, params, session)
+ if not filters:
+ return None
+
+ order_by = cls._build_app_list_order_by(params.sort_by)
+ app_models = paginate_query(
+ sa.select(App)
+ .join(
+ AppStar,
+ sa.and_(
+ AppStar.tenant_id == App.tenant_id,
+ AppStar.app_id == App.id,
+ AppStar.account_id == user_id,
+ ),
+ )
+ .where(AppStar.tenant_id == tenant_id, *filters)
+ .order_by(order_by),
+ page=params.page,
+ per_page=params.limit,
+ session=session,
+ )
+
+ for app in app_models.items:
+ app.is_starred = True
+
+ return app_models
+
+ @staticmethod
+ def star_app(*, app: App, account_id: str, session: Session) -> None:
+ """Create the account's app star if it does not already exist."""
+ existing_star = session.scalar(
+ select(AppStar)
+ .where(
+ AppStar.tenant_id == app.tenant_id,
+ AppStar.app_id == app.id,
+ AppStar.account_id == account_id,
+ )
+ .limit(1)
+ )
+ if existing_star:
+ return
+
+ session.add(AppStar(tenant_id=app.tenant_id, app_id=app.id, account_id=account_id))
+
+ @staticmethod
+ def unstar_app(*, app: App, account_id: str, session: Session) -> None:
+ """Remove the account's app star if present."""
+ existing_star = session.scalar(
+ select(AppStar)
+ .where(
+ AppStar.tenant_id == app.tenant_id,
+ AppStar.app_id == app.id,
+ AppStar.account_id == account_id,
+ )
+ .limit(1)
+ )
+ if not existing_star:
+ return
+
+ session.delete(existing_star)
+
+ @staticmethod
+ def insert_app_record(
+ tenant_id: str, params: CreateAppParams, account: Account, settings: AppCreationSettings, *, session: Session
+ ) -> App:
+ """Persist the App aggregate and required records before any external creation hooks."""
+ app_mode = AppMode.value_of(params.mode)
+ app = App(**settings.app)
+ app.name = params.name
+ app.description = params.description or ""
+ app.mode = app_mode
+ app.icon_type = IconType(params.icon_type) if params.icon_type else IconType.EMOJI
+ app.icon = params.icon
+ app.icon_background = params.icon_background
+ app.tenant_id = tenant_id
+ app.api_rph = params.api_rph
+ app.api_rpm = params.api_rpm
+ app.max_active_requests = params.max_active_requests
+ app.created_by = account.id
+ app.maintainer = account.id
+ app.updated_by = account.id
+
+ session.add(app)
+ session.flush()
+
+ if settings.model_config:
+ app_model_config = AppModelConfig(
+ **settings.model_config, app_id=app.id, created_by=account.id, updated_by=account.id
+ )
+ session.add(app_model_config)
+ session.flush()
+
+ app.app_model_config_id = app_model_config.id
+ elif app_mode == AppMode.AGENT:
+ # An Agent App keeps its model / prompt / tools in the bound Agent
+ # Soul, so the app_model_config row carries no model — only the
+ # app-level presentation features the PRD requires (conversation
+ # opener, follow-up suggestions, citations, moderation, annotation).
+ # They default to disabled/empty here and are read by both the
+ # webapp /parameters endpoint and the chat pipeline. agent_mode is
+ # left unset so App.is_agent stays False (this is the new Agent App
+ # type, not a legacy function-call/react agent).
+ agent_app_model_config = AppModelConfig(app_id=app.id, created_by=account.id, updated_by=account.id)
+ session.add(agent_app_model_config)
+ session.flush()
+
+ app.app_model_config_id = agent_app_model_config.id
+
+ create_site_record(app=app, account=account, session=session)
+ create_installed_app_record(app=app, session=session)
+ return app
+
+ @staticmethod
+ def _get_backing_agent(app: App, *, session: Session) -> Agent | None:
+ if app.mode != AppMode.AGENT:
+ return None
+ return session.scalar(
+ select(Agent).where(
+ Agent.tenant_id == app.tenant_id,
+ Agent.app_id == app.id,
+ Agent.scope == AgentScope.ROSTER,
+ Agent.source.in_(APP_BACKED_AGENT_SOURCES),
+ Agent.status == AgentStatus.ACTIVE,
+ )
+ )
+
+ @staticmethod
+ def _to_agent_icon_type(icon_type: IconType | str | None) -> AgentIconType | None:
+ if icon_type is None:
+ return None
+ value = icon_type.value if isinstance(icon_type, IconType) else icon_type
+ return AgentIconType(value)
+
+ @classmethod
+ def _sync_backing_agent_identity(
+ cls,
+ app: App,
+ *,
+ name: str | None = None,
+ description: str | None = None,
+ role: str | None = None,
+ icon_type: IconType | str | None = None,
+ icon: str | None = None,
+ icon_background: str | None = None,
+ account_id: str | None = None,
+ updated_at: datetime | None = None,
+ session: Session,
+ ) -> None:
+ """Keep the Roster identity aligned with its Agent App shell.
+
+ Agent Soul remains versioned through Composer. This helper only mirrors
+ user-facing identity fields, including the roster role/persona label,
+ so Roster and Agent Console do not drift.
+
+ Role omission is intentional: ``role=None`` preserves the backing
+ Agent's current role, while ``role=""`` explicitly clears it.
+ """
+ agent = cls._get_backing_agent(app, session=session)
+ if agent is None:
+ return
+
+ if name is not None:
+ agent.name = name
+ if description is not None:
+ agent.description = description
+ if role is not None:
+ agent.role = role
+ if icon_type is not None:
+ agent.icon_type = cls._to_agent_icon_type(icon_type)
+ if icon is not None:
+ agent.icon = icon
+ if icon_background is not None:
+ agent.icon_background = icon_background
+ agent.updated_by = account_id
+ if updated_at is not None:
+ agent.updated_at = updated_at
+
+ @staticmethod
+ def _commit_app_identity_update(app: App, *, session: Session) -> None:
+ try:
+ session.commit()
+ except IntegrityError as exc:
+ session.rollback()
+ if app.mode == AppMode.AGENT:
+ raise AgentNameConflictError() from exc
+ raise
+
+ @classmethod
+ def update_app(cls, app: App, args: AppUpdateArguments, *, account_id: str, session: Session) -> App:
+ """
+ Update app
+ :param app: App instance
+ :param args: request args
+ :return: App instance
+ """
+ app.name = args["name"]
+ app.description = args["description"]
+ icon_type = args.get("icon_type")
+ if icon_type is None:
+ resolved_icon_type = app.icon_type
+ else:
+ resolved_icon_type = IconType(icon_type)
+
+ app.icon_type = resolved_icon_type
+ app.icon = args["icon"]
+ app.icon_background = args["icon_background"]
+ app.use_icon_as_answer_icon = args.get("use_icon_as_answer_icon", False)
+ app.max_active_requests = args.get("max_active_requests")
+ app.updated_by = account_id
+ app.updated_at = naive_utc_now()
+ cls._sync_backing_agent_identity(
+ app,
+ name=app.name,
+ description=app.description,
+ # Omitted role must stay omitted here: None means "preserve current
+ # backing-agent role", while an empty string is an explicit clear.
+ role=args.get("role"),
+ icon_type=app.icon_type,
+ icon=app.icon,
+ icon_background=app.icon_background,
+ account_id=account_id,
+ updated_at=app.updated_at,
+ session=session,
+ )
+ cls._commit_app_identity_update(app, session=session)
+
+ return app
+
+ @classmethod
+ def update_app_name(cls, app: App, name: str, *, account_id: str, session: Session) -> App:
+ """
+ Update app name
+ :param app: App instance
+ :param name: new name
+ :return: App instance
+ """
+ app.name = name
+ app.updated_by = account_id
+ app.updated_at = naive_utc_now()
+ cls._sync_backing_agent_identity(
+ app,
+ name=app.name,
+ account_id=account_id,
+ updated_at=app.updated_at,
+ session=session,
+ )
+ cls._commit_app_identity_update(app, session=session)
+
+ return app
+
+ @classmethod
+ def update_app_icon(
+ cls,
+ app: App,
+ icon: str,
+ icon_background: str,
+ icon_type: IconType | str | None = None,
+ *,
+ account_id: str,
+ session: Session,
+ ) -> App:
+ """
+ Update app icon
+ :param app: App instance
+ :param icon: new icon
+ :param icon_background: new icon_background
+ :param icon_type: new icon type
+ :return: App instance
+ """
+ app.icon = icon
+ app.icon_background = icon_background
+ if icon_type is not None:
+ app.icon_type = icon_type if isinstance(icon_type, IconType) else IconType(icon_type)
+ app.updated_by = account_id
+ app.updated_at = naive_utc_now()
+ cls._sync_backing_agent_identity(
+ app,
+ icon_type=app.icon_type,
+ icon=app.icon,
+ icon_background=app.icon_background,
+ account_id=account_id,
+ updated_at=app.updated_at,
+ session=session,
+ )
+ session.commit()
+
+ return app
+
+ @staticmethod
+ def is_agent_app_access_ready(app: App, *, session: Session) -> bool:
+ """Return whether an Agent App has a publish-visible active snapshot."""
+
+ if app.mode != AppMode.AGENT:
+ return True
+ agent = session.scalar(
+ select(Agent)
+ .where(
+ Agent.tenant_id == app.tenant_id,
+ Agent.app_id == app.id,
+ Agent.scope == AgentScope.ROSTER,
+ Agent.source.in_(APP_BACKED_AGENT_SOURCES),
+ Agent.status == AgentStatus.ACTIVE,
+ )
+ .limit(1)
+ )
+ return bool(agent and agent_has_workflow_callable_active_snapshot(session=session, agent=agent))
+
+ @classmethod
+ def ensure_agent_app_access_ready(cls, app: App, *, session: Session) -> None:
+ if not cls.is_agent_app_access_ready(app, session=session):
+ raise AgentAccessNotReadyError()
+
+ @classmethod
+ def update_app_site_status(cls, app: App, enable_site: bool, *, account_id: str, session: Session) -> App:
+ """
+ Update app site status
+ :param app: App instance
+ :param enable_site: enable site status
+ :return: App instance
+ """
+ if enable_site:
+ cls.ensure_agent_app_access_ready(app, session=session)
+ if enable_site == app.enable_site:
+ return app
+ app.enable_site = enable_site
+ app.updated_by = account_id
+ app.updated_at = naive_utc_now()
+ session.commit()
+
+ return app
+
+ @classmethod
+ def update_app_api_status(cls, app: App, enable_api: bool, *, account_id: str, session: Session) -> App:
+ """
+ Update app api status
+ :param app: App instance
+ :param enable_api: enable api status
+ :return: App instance
+ """
+ if enable_api:
+ cls.ensure_agent_app_access_ready(app, session=session)
+ if enable_api == app.enable_api:
+ return app
+
+ app.enable_api = enable_api
+ app.updated_by = account_id
+ app.updated_at = naive_utc_now()
+ session.commit()
+
+ return app
+
+ @classmethod
+ def delete_app_record(cls, app: App, *, account_id: str | None, session: Session) -> AppDeletion:
+ """Stage App deletion; the lifecycle adapter retires Agent resources in the same transaction."""
+ app_event = AppEvent(app.id, app.tenant_id, str(app.mode))
+ backing_agent = cls._get_backing_agent(app, session=session)
+ workflow_agent_ids = set(
+ session.scalars(
+ select(Agent.id).where(
+ Agent.tenant_id == app.tenant_id,
+ Agent.app_id == app.id,
+ Agent.scope == AgentScope.WORKFLOW_ONLY,
+ Agent.status == AgentStatus.ACTIVE,
+ )
+ ).all()
+ )
+ if app.mode in (AppMode.WORKFLOW, AppMode.ADVANCED_CHAT):
+ workflow_agent_ids.update(
+ agent_id
+ for agent_id in session.scalars(
+ select(WorkflowAgentNodeBinding.agent_id).where(
+ WorkflowAgentNodeBinding.tenant_id == app.tenant_id,
+ WorkflowAgentNodeBinding.app_id == app.id,
+ WorkflowAgentNodeBinding.binding_type == WorkflowAgentBindingType.INLINE_AGENT,
+ WorkflowAgentNodeBinding.agent_id.is_not(None),
+ )
+ ).all()
+ if agent_id
+ )
+ session.execute(
+ delete(WorkflowAgentNodeBinding).where(
+ WorkflowAgentNodeBinding.tenant_id == app.tenant_id,
+ WorkflowAgentNodeBinding.app_id == app.id,
+ )
+ )
+ agent_ids_to_unbind = set(workflow_agent_ids)
+ if backing_agent is not None:
+ agent_ids_to_unbind.add(backing_agent.id)
+ if agent_ids_to_unbind:
+ session.execute(
+ delete(AgentSkillBinding).where(
+ AgentSkillBinding.tenant_id == app.tenant_id,
+ AgentSkillBinding.agent_id.in_(agent_ids_to_unbind),
+ )
+ )
+ if backing_agent is not None:
+ now = naive_utc_now()
+ backing_agent.status = AgentStatus.ARCHIVED
+ backing_agent.archived_by = account_id
+ backing_agent.archived_at = now
+ backing_agent.updated_by = account_id
+ backing_agent.updated_at = now
+
+ retired_binding_ids: list[str] = []
+ retired_snapshot_ids: list[str] = []
+ if backing_agent is not None:
+ bindings = session.scalars(
+ select(AgentWorkspaceBinding).where(
+ AgentWorkspaceBinding.tenant_id == app.tenant_id,
+ AgentWorkspaceBinding.agent_id == backing_agent.id,
+ )
+ ).all()
+ retired_binding_ids = [binding.id for binding in bindings]
+
+ session.delete(app)
+ result = AppDeletion(
+ app_event,
+ workflow_agent_ids,
+ [],
+ retired_binding_ids,
+ retired_snapshot_ids,
+ backing_agent.id if backing_agent else None,
+ )
+ return result
diff --git a/api/repositories/app/response.py b/api/repositories/app/response.py
new file mode 100644
index 00000000000..2206738e9a5
--- /dev/null
+++ b/api/repositories/app/response.py
@@ -0,0 +1,139 @@
+"""Materialize app response data while the repository Session is open."""
+
+from collections.abc import Mapping, Sequence
+from typing import Any, Literal
+from uuid import UUID
+
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+from models.model import App, Site, load_annotation_reply_config
+from models.tools import ApiToolProvider
+from services.entities.app_entities import AppRecord, AppSummary, AppToolReference
+
+
+def app_summary(app: App) -> AppSummary:
+ return AppSummary(
+ id=app.id,
+ tenant_id=app.tenant_id,
+ name=app.name,
+ description=app.description,
+ mode=app.mode,
+ status=app.status,
+ updated_at=app.updated_at,
+ maintainer=app.maintainer,
+ )
+
+
+def app_record(
+ app: App, *, session: Session, projection: Literal["list", "detail", "detail-with-site"] = "list"
+) -> AppRecord:
+ """Materialize the requested projection without resolving request-dependent URLs."""
+ detail = projection != "list"
+ with_site = projection == "detail-with-site"
+ config = app.app_model_config_with_session(session=session)
+ model_config: dict[str, Any] | None = None
+ if config is not None:
+ model_config = {
+ "model": config.model_dict,
+ "pre_prompt": config.pre_prompt,
+ "created_by": config.created_by,
+ "created_at": config.created_at,
+ "updated_by": config.updated_by,
+ "updated_at": config.updated_at,
+ }
+ if detail:
+ model_config.update(config.to_dict(annotation_reply=load_annotation_reply_config(session, app.id)))
+ workflow = app.workflow_with_session(session=session)
+ workflow_data = (
+ None
+ if workflow is None
+ else {
+ "id": workflow.id,
+ "created_by": workflow.created_by,
+ "created_at": workflow.created_at,
+ "updated_by": workflow.updated_by,
+ "updated_at": workflow.updated_at,
+ }
+ )
+ site = app.site_with_session(session=session) if with_site else None
+ site_data = (
+ None
+ if site is None
+ else {
+ column.name: getattr(site, column.name) # guard-ignore: no-new-getattr -- SQLAlchemy mapped columns
+ for column in Site.__table__.columns
+ }
+ )
+ return AppRecord(
+ id=app.id,
+ name=app.name,
+ mode_compatible_with_agent=app.mode_compatible_with_agent_with_session(session=session),
+ description=app.description,
+ desc_or_prompt=None if detail else app.desc_or_prompt_with_session(session=session),
+ icon_type=app.icon_type,
+ icon=app.icon,
+ icon_background=app.icon_background,
+ enable_site=app.enable_site,
+ enable_api=app.enable_api,
+ max_active_requests=app.max_active_requests,
+ use_icon_as_answer_icon=app.use_icon_as_answer_icon,
+ created_by=app.created_by,
+ created_at=app.created_at,
+ updated_by=app.updated_by,
+ updated_at=app.updated_at,
+ maintainer=app.maintainer,
+ author_name=None if detail else app.author_name_with_session(session=session),
+ app_model_config=model_config,
+ workflow=workflow_data,
+ site=site_data,
+ tracing=app.tracing,
+ bound_agent_id=app.bound_agent_id_with_session(session=session) if projection != "detail" else None,
+ tags=[{"id": tag.id, "name": tag.name, "type": tag.type} for tag in app.tags_with_session(session=session)],
+ tool_references=load_app_tool_references(
+ tenant_id=app.tenant_id, tools=config.agent_mode_dict.get("tools", []), session=session
+ )
+ if with_site and config
+ else (),
+ is_starred=bool(app.__dict__.get("is_starred", False)),
+ )
+
+
+def load_app_tool_references(
+ *, tenant_id: str, tools: Sequence[Mapping[str, Any]], session: Session
+) -> tuple[AppToolReference, ...]:
+ """Load API provider existence without resolving plugin or hardcoded builtin providers."""
+ references: list[AppToolReference] = []
+ api_provider_ids: list[str] = []
+ for tool in tools:
+ if len(tool) < 4:
+ continue
+ provider_type = tool.get("provider_type", "")
+ provider_id = tool.get("provider_id", "")
+ if provider_type == "api":
+ try:
+ UUID(provider_id)
+ except (ValueError, TypeError, AttributeError):
+ continue
+ api_provider_ids.append(provider_id)
+ elif provider_type != "builtin":
+ continue
+ references.append(AppToolReference(provider_type, provider_id, tool["tool_name"]))
+
+ existing_ids = (
+ set(
+ session.scalars(
+ select(ApiToolProvider.id).where(
+ ApiToolProvider.tenant_id == tenant_id, ApiToolProvider.id.in_(api_provider_ids)
+ )
+ )
+ )
+ if api_provider_ids
+ else set()
+ )
+ return tuple(
+ AppToolReference(ref.provider_type, ref.provider_id, ref.tool_name, ref.provider_id in existing_ids)
+ if ref.provider_type == "api"
+ else ref
+ for ref in references
+ )
diff --git a/api/repositories/tag_repository.py b/api/repositories/tag_repository.py
index 9e019990005..1bebcc82761 100644
--- a/api/repositories/tag_repository.py
+++ b/api/repositories/tag_repository.py
@@ -215,3 +215,66 @@ class TagRepository(TagStore):
if session.scalar(stmt.limit(1)) is None:
raise TagBindingTargetNotFoundError(binding.type)
+
+ @override
+ def find_target_ids(
+ self, *, tenant_id: str, tag_type: str, tag_ids: list[str], match_all: bool = False
+ ) -> list[str]:
+ with self._session_factory() as session:
+ return [
+ target_id
+ for target_id in self.get_target_ids_by_tag_ids(
+ tag_type, tenant_id, tag_ids, session, match_all=match_all
+ )
+ if target_id is not None
+ ]
+
+ @staticmethod
+ def get_target_ids_by_tag_ids(
+ tag_type: str | TagType,
+ current_tenant_id: str,
+ tag_ids: list[str],
+ session: Session,
+ *,
+ match_all: bool = False,
+ ):
+ """
+ Return target IDs bound to tags for the given tenant and resource type.
+
+ By default this preserves the legacy "match any tag" behavior and returns one target ID per matching
+ binding. When match_all is enabled, every requested tag must exist for the tenant/type and each returned
+ target must be bound to all requested tags.
+ """
+ # Check if tag_ids is not empty to avoid WHERE false condition
+ if not tag_ids:
+ return []
+ # Deduplicate repeated query params so match_all counts each requested tag once.
+ requested_tag_ids = list(dict.fromkeys(tag_ids))
+ tags = session.scalars(
+ select(Tag.id).where(
+ Tag.id.in_(requested_tag_ids),
+ Tag.tenant_id == current_tenant_id,
+ Tag.type == tag_type,
+ )
+ ).all()
+ if not tags:
+ return []
+ tag_ids = list(tags)
+ # Check if tag_ids is not empty to avoid WHERE false condition
+ if not tag_ids:
+ return []
+ if match_all:
+ if len(tag_ids) != len(requested_tag_ids):
+ return []
+ return session.scalars(
+ select(TagBinding.target_id)
+ .where(TagBinding.tag_id.in_(tag_ids), TagBinding.tenant_id == current_tenant_id)
+ .group_by(TagBinding.target_id)
+ .having(func.count(sa.distinct(TagBinding.tag_id)) == len(tag_ids))
+ ).all()
+ tag_bindings = session.scalars(
+ select(TagBinding.target_id).where(
+ TagBinding.tag_id.in_(tag_ids), TagBinding.tenant_id == current_tenant_id
+ )
+ ).all()
+ return tag_bindings
diff --git a/api/services/app/__init__.py b/api/services/app/__init__.py
index 357df5c774c..32cb237c245 100644
--- a/api/services/app/__init__.py
+++ b/api/services/app/__init__.py
@@ -1 +1 @@
-"""Application services owned by the App domain."""
+"""Application services and adapters owned by the App domain."""
diff --git a/api/controllers/common/app_access.py b/api/services/app/access.py
similarity index 98%
rename from api/controllers/common/app_access.py
rename to api/services/app/access.py
index bfb3f0fc40a..2fc44d0e6d6 100644
--- a/api/controllers/common/app_access.py
+++ b/api/services/app/access.py
@@ -9,8 +9,8 @@ from sqlalchemy.orm import Session
from services.enterprise import rbac_service as enterprise_rbac_service
if TYPE_CHECKING:
- from services.app_service import AppListBaseParams
from services.enterprise.rbac_service import MyPermissionsResponse
+ from services.entities.app_entities import AppListBaseParams
# Permission keys (dot-notation, from MyPermissionsResponse) that grant
# list/preview access to an app. Keep this the single source of truth for both
diff --git a/api/services/app/console_gateway.py b/api/services/app/console_gateway.py
new file mode 100644
index 00000000000..bff597559c4
--- /dev/null
+++ b/api/services/app/console_gateway.py
@@ -0,0 +1,410 @@
+"""Adapters for app permissions, existing DSL operations and package exporters."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from contextlib import AbstractContextManager
+from dataclasses import dataclass, replace
+from typing import BinaryIO, Literal, override
+from uuid import UUID
+
+from sqlalchemy.exc import IntegrityError
+from sqlalchemy.orm import Session, sessionmaker
+
+from configs import dify_config
+from core.rbac import RBACPermission
+from enums import DeploymentEdition
+from events.app_event import app_was_updated
+from machinery.context import RequestContext
+from models.account import Account
+from models.agent import AgentIconType
+from models.model import AppMode
+from repositories.app.console_repository import ConsoleAppRepository, console_app_actor, require_console_app
+from repositories.app.response import app_record
+from services.agent.errors import AgentNameConflictError
+from services.agent.home_snapshot_service import AgentHomeSnapshotService
+from services.agent.roster_package_entities import RosterAgentPackageExport
+from services.agent.roster_package_exporter import RosterAgentPackageExporter
+from services.agent.roster_package_importer import RosterAgentPackageImporter
+from services.agent.roster_service import AgentRosterService
+from services.agent.workspace_service import AgentWorkspaceService
+from services.app.access import AppAccessFilter, resolve_app_access_filter
+from services.app.console_service import (
+ AppLifecycle,
+ AppPermissions,
+ AppTransfers,
+ ConsoleAppAccess,
+ InvalidAppAccessModesError,
+)
+from services.app.import_service import AppDefinitionImports
+from services.app.response_gateway import AppResponseGateway
+from services.app_dsl_service import IMPORT_INFO_REDIS_KEY_PREFIX, AppDslService, PendingData
+from services.app_import_source import download_app_import_source, try_read_yaml
+from services.app_package_service import AppPackageService
+from services.app_service import AppService
+from services.enterprise import rbac_service
+from services.enterprise.enterprise_service import EnterpriseService
+from services.entities.app_entities import (
+ AppCreationSettings,
+ AppDeletion,
+ AppEvent,
+ AppExportOptions,
+ AppListParams,
+ AppRecord,
+ CreateAppParams,
+ ImportedAppPackage,
+)
+from services.entities.dsl_entities import (
+ AppImportPackage,
+ AppImportParams,
+ CheckDependenciesResult,
+ Import,
+ ImportStatus,
+)
+from services.errors.account import NoPermissionError
+from services.feature_service import FeatureService
+from services.system_feature_service import SystemFeatureService
+from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
+
+
+@dataclass(frozen=True)
+class ConsoleAppPermissions(AppPermissions):
+ snapshot: rbac_service.MyPermissionsResponse
+ access_filter: AppAccessFilter
+
+ @override
+ def filter_list(self, params: AppListParams) -> AppListParams:
+ params = params.model_copy(deep=True)
+ self.access_filter.apply_to_params(params)
+ return params
+
+ @override
+ def keys_for(self, app_ids: list[str]) -> dict[str, list[str]]:
+ return self.snapshot.app.permission_keys_by_resource_ids(app_ids)
+
+
+class EnterpriseConsoleAppAccess(ConsoleAppAccess):
+ @override
+ def require_import(self, context: RequestContext, kind: Literal["url", "dsl", "agent"]) -> None:
+ if kind == "dsl" and dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD:
+ apps = FeatureService.get_features(context.active_workspace_id, exclude_vector_space=True).apps
+ if 0 < apps.limit <= apps.size:
+ raise NoPermissionError("The number of apps has reached the limit of your subscription.")
+ if not dify_config.RBAC_ENABLED:
+ return
+ permissions = (
+ (RBACPermission.AGENT_CREATE, RBACPermission.AGENT_IMPORT_EXPORT_DSL)
+ if kind == "agent"
+ else (RBACPermission.APP_IMPORT_EXPORT_DSL, RBACPermission.AGENT_IMPORT_EXPORT_DSL)
+ if kind == "url"
+ else (RBACPermission.APP_IMPORT_EXPORT_DSL,)
+ )
+ checks = (
+ rbac_service.RBACService.CheckAccess.check(
+ context.active_workspace_id, context.account_id, scene=permission, resource_type=None, resource_id=None
+ )
+ for permission in permissions
+ )
+ allowed = any(checks) if kind == "url" else all(checks)
+ if not allowed:
+ raise NoPermissionError("You do not have permission to import this App")
+
+ @override
+ def imported_permissions(self, context: RequestContext, app_id: str) -> list[str]:
+ return self.created_permissions(context, app_id) if dify_config.RBAC_ENABLED else []
+
+ @override
+ def initialize_import_access(self, app_id: str) -> None:
+ if SystemFeatureService.is_webapp_auth_enabled():
+ EnterpriseService.WebAppAuth.update_app_access_mode(app_id, "private")
+
+ @override
+ def inherit_access(self, source_app_id: str, app_id: str) -> None:
+ if not SystemFeatureService.is_webapp_auth_enabled():
+ return
+ try:
+ access_mode = EnterpriseService.WebAppAuth.get_app_access_mode_by_id(source_app_id).access_mode
+ except Exception:
+ # Old apps without settings default to public, matching the access fallback.
+ access_mode = "public"
+ EnterpriseService.WebAppAuth.update_app_access_mode(app_id, access_mode)
+
+ def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
+ self._session_factory = session_factory
+
+ @override
+ def permissions(self, context: RequestContext, *, app_id: str | None = None) -> ConsoleAppPermissions:
+ with self._session_factory() as session:
+ permissions = rbac_service.RBACService.MyPermissions.get(
+ context.active_workspace_id,
+ context.account_id,
+ app_id=app_id,
+ session=session,
+ )
+ access_filter = AppAccessFilter.unrestricted()
+ if dify_config.RBAC_ENABLED and app_id is None:
+ access_filter = resolve_app_access_filter(
+ context.active_workspace_id,
+ context.account_id,
+ session=session,
+ permissions=permissions,
+ )
+ return ConsoleAppPermissions(permissions, access_filter)
+
+ @override
+ def created_permissions(self, context: RequestContext, app_id: str) -> list[str]:
+ with self._session_factory() as session:
+ keys = rbac_service.RBACService.AppPermissions.batch_get(
+ context.active_workspace_id,
+ context.account_id,
+ [app_id],
+ session=session,
+ )
+ return keys.get(app_id, [])
+
+ @override
+ def initialize_created_app(self, context: RequestContext, app_id: str) -> None:
+ if dify_config.RBAC_ENABLED:
+ rbac_service.RBACService.AppAccess.replace_whitelist(
+ context.active_workspace_id,
+ context.account_id,
+ app_id,
+ rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ )
+ initialize_created_app_rbac_access_task.delay(
+ context.active_workspace_id, context.account_id, app_id=app_id
+ )
+
+ @override
+ def access_modes(self, app_ids: list[str]) -> dict[str, str]:
+ if not SystemFeatureService.is_webapp_auth_enabled():
+ return {}
+ settings = EnterpriseService.WebAppAuth.batch_get_app_access_mode_by_id(app_ids=app_ids)
+ if len(settings) != len(app_ids):
+ raise InvalidAppAccessModesError("Invalid app id in webapp auth")
+ return {app_id: setting.access_mode for app_id, setting in settings.items()}
+
+ @override
+ def access_mode(self, app_id: str) -> str | None:
+ if not SystemFeatureService.is_webapp_auth_enabled():
+ return None
+ return EnterpriseService.WebAppAuth.get_app_access_mode_by_id(app_id=app_id).access_mode
+
+ @override
+ def can_export_version(self, workspace_id: str) -> bool:
+ return (
+ dify_config.DEPLOYMENT_EDITION != DeploymentEdition.CLOUD
+ or FeatureService.get_workspace_plan(workspace_id).is_paid
+ )
+
+
+class AppTransferGateway(AppTransfers, AppDefinitionImports):
+ def __init__(
+ self,
+ *,
+ session_factory: sessionmaker[Session],
+ dsl_factory: Callable[[Session], AppDslService],
+ packages: AppPackageService,
+ agent_packages: RosterAgentPackageExporter,
+ agent_importer: RosterAgentPackageImporter,
+ ) -> None:
+ self._session_factory = session_factory
+ self._dsl_factory = dsl_factory
+ self._packages = packages
+ self._agent_packages = agent_packages
+ self._agent_importer = agent_importer
+
+ @override
+ def download_import(self, url: str) -> AbstractContextManager[BinaryIO]:
+ return download_app_import_source(url)
+
+ @override
+ def read_import_yaml(self, source: BinaryIO) -> str | None:
+ return try_read_yaml(source)
+
+ @override
+ def read_app_package(self, source: BinaryIO) -> AppImportPackage | None:
+ return self._packages.read_package(source)
+
+ def _import_actor(self, context: RequestContext) -> Account:
+ with self._session_factory() as session:
+ return console_app_actor(session, context)
+
+ @override
+ def import_dsl(
+ self,
+ context: RequestContext,
+ params: AppImportParams,
+ *,
+ as_copy: bool = False,
+ package: AppImportPackage | None = None,
+ ) -> Import:
+ account = self._import_actor(context)
+ with self._session_factory() as session:
+ result = self._dsl_factory(session).import_app(
+ account=account,
+ import_mode=params.mode,
+ yaml_content=params.yaml_content,
+ yaml_url=params.yaml_url,
+ name=params.name,
+ description=params.description,
+ icon_type=params.icon_type,
+ icon=params.icon,
+ icon_background=params.icon_background,
+ app_id=params.app_id,
+ package=package,
+ )
+ if result.status == ImportStatus.FAILED or (as_copy and result.status == ImportStatus.PENDING):
+ session.rollback()
+ else:
+ session.commit()
+ return result
+
+ @override
+ def confirm_import(self, context: RequestContext, import_id: str) -> tuple[Import, bool]:
+ from extensions.ext_redis import redis_client
+
+ raw = redis_client.get(f"{IMPORT_INFO_REDIS_KEY_PREFIX}{import_id}")
+ pending = PendingData.model_validate_json(raw) if raw else None
+ result = self.confirm_definition(context, import_id)
+ return result, pending is not None and pending.app_id is None
+
+ @override
+ def confirm_definition(self, context: RequestContext, import_id: str) -> Import:
+ account = self._import_actor(context)
+ with self._session_factory() as session:
+ result = self._dsl_factory(session).confirm_import(import_id=import_id, account=account)
+ if result.status == ImportStatus.FAILED:
+ session.rollback()
+ else:
+ session.commit()
+ return result
+
+ @override
+ def import_agent_package(self, context: RequestContext, source: BinaryIO) -> ImportedAppPackage:
+ account = self._import_actor(context)
+ result = self._agent_importer.import_package(
+ source=source,
+ tenant_id=context.active_workspace_id,
+ account=account,
+ )
+ return ImportedAppPackage(result.app_id, result.agent_id, result.warnings)
+
+ @override
+ def check_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult:
+ return AppDslService.check_app_dependencies(tenant_id=context.active_workspace_id, app_id=app_id)
+
+ @override
+ def export_dsl(self, context: RequestContext, app_id: str, options: AppExportOptions) -> str:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ dsl = self._dsl_factory(session)
+ prepared = dsl.load_export_data(
+ app_model=app,
+ session=session,
+ include_secret=options.include_secret,
+ workflow_id=options.workflow_id,
+ version_id=options.version_id,
+ )
+ return dsl.serialize_export_data(prepared)
+
+ @override
+ def export_app_package(
+ self, context: RequestContext, app_id: str, options: AppExportOptions
+ ) -> RosterAgentPackageExport:
+ with self._session_factory() as session:
+ app = require_console_app(session, context, app_id)
+ return self._packages.export_app(
+ app_model=app, include_secret=options.include_secret, workflow_id=options.workflow_id
+ )
+
+ @override
+ def export_agent_package(
+ self, *, workspace_id: str, agent_id: str, version_id: UUID | None
+ ) -> RosterAgentPackageExport:
+ return self._agent_packages.export(tenant_id=workspace_id, agent_id=agent_id, version_id=version_id)
+
+
+class AppLifecycleGateway(AppLifecycle):
+ """Integrate App persistence with existing Agent transaction participants.
+
+ Agent services retain their current API. Their database-only operations join
+ the App transaction; notification and resource cleanup run after it closes.
+ """
+
+ def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
+ self._session_factory = session_factory
+
+ @override
+ def create(self, context: RequestContext, params: CreateAppParams, settings: AppCreationSettings) -> AppRecord:
+ with self._session_factory.begin() as session:
+ account = console_app_actor(session, context)
+ app = ConsoleAppRepository.insert_app_record(
+ context.active_workspace_id, params, account, settings, session=session
+ )
+ if app.mode == AppMode.AGENT:
+ initial_soul = AppService.prepare_agent_soul(context.active_workspace_id, session=session)
+ try:
+ AgentRosterService(session).create_backing_agent_for_app(
+ tenant_id=context.active_workspace_id,
+ account_id=context.account_id,
+ app_id=app.id,
+ name=params.name,
+ description=params.description or "",
+ role=params.agent_role,
+ icon_type=AgentIconType(params.icon_type) if params.icon_type else None,
+ icon=params.icon,
+ icon_background=params.icon_background,
+ initial_soul=initial_soul,
+ )
+ except IntegrityError as exc:
+ raise AgentNameConflictError() from exc
+ return app_record(app, session=session, projection="detail-with-site")
+
+ @override
+ def delete(self, context: RequestContext, app_id: str) -> AppDeletion:
+ with self._session_factory.begin() as session:
+ app = require_console_app(session, context, app_id)
+ deleted = ConsoleAppRepository.delete_app_record(app, account_id=context.account_id, session=session)
+ for binding_id in deleted.binding_ids:
+ AgentWorkspaceService.retire_binding(
+ session=session, tenant_id=context.active_workspace_id, binding_id=binding_id
+ )
+ snapshots = (
+ AgentHomeSnapshotService.retire_all_for_agent(
+ session=session, tenant_id=context.active_workspace_id, agent_id=deleted.backing_agent_id
+ )
+ if deleted.backing_agent_id is not None
+ else []
+ )
+ workspaces = AgentWorkspaceService.retire_all_for_app(
+ session=session, tenant_id=context.active_workspace_id, app_id=app_id
+ )
+ return replace(deleted, home_snapshot_ids=snapshots, workspace_ids=workspaces)
+
+ @override
+ def prepare_creation(self, context: RequestContext, params: CreateAppParams) -> AppCreationSettings:
+ return AppService.prepare_creation(context.active_workspace_id, params)
+
+ @override
+ def created(self, context: RequestContext, app: AppRecord) -> None:
+ AppService.notify_created_app(
+ event=AppEvent(app.id, context.active_workspace_id, app.mode_compatible_with_agent),
+ account_id=context.account_id,
+ backing_agent_id=app.bound_agent_id,
+ )
+
+ @override
+ def updated(self, context: RequestContext, app: AppRecord) -> None:
+ app_was_updated.send(AppEvent(app.id, context.active_workspace_id, app.mode_compatible_with_agent))
+
+ @override
+ def deleted(self, context: RequestContext, deleted: AppDeletion) -> None:
+ AppService.notify_deleted_app(deleted, account_id=context.account_id)
+
+ @override
+ def present(self, context: RequestContext, app: AppRecord, *, mask_credentials: bool = False) -> AppRecord:
+ app = replace(
+ app, deleted_tools=AppResponseGateway.find_deleted_tools(context.active_workspace_id, app.tool_references)
+ )
+ return AppResponseGateway.mask_record(context, app) if mask_credentials else app
diff --git a/api/services/app/console_service.py b/api/services/app/console_service.py
new file mode 100644
index 00000000000..b4929e78f9a
--- /dev/null
+++ b/api/services/app/console_service.py
@@ -0,0 +1,390 @@
+"""Console app use cases with explicit identity and framework-neutral ports."""
+
+from __future__ import annotations
+
+from contextlib import AbstractContextManager, closing
+from dataclasses import replace
+from typing import BinaryIO, Literal, Protocol
+from uuid import UUID, uuid4
+
+from machinery.context import RequestContext
+from services.agent.errors import InvalidRosterAgentPackageError
+from services.agent.roster_package_entities import RosterAgentPackageExport
+from services.entities.app_entities import (
+ AppChange,
+ AppCreationSettings,
+ AppDeletion,
+ AppExportOptions,
+ AppListParams,
+ AppPage,
+ AppRecord,
+ AppReference,
+ AppTraceSettings,
+ CopyAppParams,
+ CreateAppParams,
+ ImportedAppPackage,
+ RecentAppListItem,
+ StarredAppListParams,
+ UpdateAppParams,
+)
+from services.entities.dsl_entities import (
+ AppImportPackage,
+ AppImportParams,
+ CheckDependenciesResult,
+ Import,
+ ImportStatus,
+)
+
+
+class ConsoleAppNotFoundError(Exception):
+ pass
+
+
+class AppExportAgentNotFoundError(ConsoleAppNotFoundError):
+ pass
+
+
+class InvalidAppExportError(ValueError):
+ pass
+
+
+class AppExportPaidPlanRequiredError(Exception):
+ pass
+
+
+class CreatorsPlatformDisabledError(Exception):
+ pass
+
+
+class InvalidAppAccessModesError(ValueError):
+ pass
+
+
+class AppPermissions(Protocol):
+ def filter_list(self, params: AppListParams) -> AppListParams: ...
+
+ def keys_for(self, app_ids: list[str]) -> dict[str, list[str]]: ...
+
+
+class ConsoleAppAccess(Protocol):
+ def require_import(self, context: RequestContext, kind: Literal["url", "dsl", "agent"]) -> None: ...
+
+ def imported_permissions(self, context: RequestContext, app_id: str) -> list[str]: ...
+
+ def initialize_import_access(self, app_id: str) -> None: ...
+
+ def inherit_access(self, source_app_id: str, app_id: str) -> None: ...
+
+ def permissions(self, context: RequestContext, *, app_id: str | None = None) -> AppPermissions: ...
+
+ def created_permissions(self, context: RequestContext, app_id: str) -> list[str]: ...
+
+ def initialize_created_app(self, context: RequestContext, app_id: str) -> None: ...
+
+ def access_modes(self, app_ids: list[str]) -> dict[str, str]: ...
+
+ def access_mode(self, app_id: str) -> str | None: ...
+
+ def can_export_version(self, workspace_id: str) -> bool: ...
+
+
+class ConsoleApps(Protocol):
+ def list_apps(self, context: RequestContext, params: AppListParams | StarredAppListParams) -> AppPage: ...
+
+ def recent(self, context: RequestContext, params: AppListParams) -> list[RecentAppListItem]: ...
+
+ def get(self, context: RequestContext, app_id: str) -> AppRecord: ...
+
+ def update(self, context: RequestContext, app_id: str, params: UpdateAppParams) -> AppRecord: ...
+
+ def rename(self, context: RequestContext, app_id: str, name: str) -> AppRecord: ...
+
+ def update_icon(
+ self, context: RequestContext, app_id: str, *, icon: str, icon_background: str, icon_type: str | None
+ ) -> AppRecord: ...
+
+ def set_site_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppChange: ...
+
+ def set_api_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppChange: ...
+
+ def set_starred(self, context: RequestContext, app_id: str, starred: bool) -> None: ...
+
+ def get_reference(self, context: RequestContext, app_id: str) -> AppReference: ...
+
+ def get_trace(self, context: RequestContext, app_id: str) -> AppTraceSettings: ...
+
+ def set_trace(self, context: RequestContext, app_id: str, settings: AppTraceSettings) -> None: ...
+
+
+class AppTransfers(Protocol):
+ def download_import(self, url: str) -> AbstractContextManager[BinaryIO]: ...
+
+ def read_import_yaml(self, source: BinaryIO) -> str | None: ...
+
+ def read_app_package(self, source: BinaryIO) -> AppImportPackage | None: ...
+
+ def import_dsl(
+ self,
+ context: RequestContext,
+ params: AppImportParams,
+ *,
+ as_copy: bool = False,
+ package: AppImportPackage | None = None,
+ ) -> Import: ...
+
+ def confirm_import(self, context: RequestContext, import_id: str) -> tuple[Import, bool]: ...
+
+ def import_agent_package(self, context: RequestContext, source: BinaryIO) -> ImportedAppPackage: ...
+
+ def check_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult: ...
+
+ def export_dsl(self, context: RequestContext, app_id: str, options: AppExportOptions) -> str: ...
+
+ def export_app_package(
+ self, context: RequestContext, app_id: str, options: AppExportOptions
+ ) -> RosterAgentPackageExport: ...
+
+ def export_agent_package(
+ self, *, workspace_id: str, agent_id: str, version_id: UUID | None
+ ) -> RosterAgentPackageExport: ...
+
+
+class CreatorsPlatform(Protocol):
+ def require_enabled(self) -> None: ...
+
+ def upload(self, dsl: str) -> str: ...
+
+ def authorize(self, account_id: str) -> str | None: ...
+
+ def redirect_url(self, claim_code: str, oauth_code: str | None) -> str: ...
+
+
+class AppTraceProvider(Protocol):
+ def validate_provider(self, tracing_provider: str) -> None: ...
+
+ def require_provider_available(self, tracing_provider: str) -> None: ...
+
+
+class AppLifecycle(Protocol):
+ def create(self, context: RequestContext, params: CreateAppParams, settings: AppCreationSettings) -> AppRecord: ...
+
+ def delete(self, context: RequestContext, app_id: str) -> AppDeletion: ...
+
+ def prepare_creation(self, context: RequestContext, params: CreateAppParams) -> AppCreationSettings: ...
+
+ def created(self, context: RequestContext, app: AppRecord) -> None: ...
+
+ def updated(self, context: RequestContext, app: AppRecord) -> None: ...
+
+ def deleted(self, context: RequestContext, deleted: AppDeletion) -> None: ...
+
+ def present(self, context: RequestContext, app: AppRecord, *, mask_credentials: bool = False) -> AppRecord: ...
+
+
+class ConsoleAppService:
+ def __init__(
+ self,
+ *,
+ apps: ConsoleApps,
+ access: ConsoleAppAccess,
+ transfers: AppTransfers,
+ creators: CreatorsPlatform,
+ tracing: AppTraceProvider,
+ lifecycle: AppLifecycle,
+ ) -> None:
+ self._apps = apps
+ self._access = access
+ self._transfers = transfers
+ self._creators = creators
+ self._tracing = tracing
+ self._lifecycle = lifecycle
+
+ def import_app(self, context: RequestContext, params: AppImportParams, *, source: BinaryIO | None = None) -> Import:
+ if source is not None:
+ return self._import_package(context, params, source)
+ if params.mode == "yaml-url" and params.yaml_url:
+ self._access.require_import(context, "url")
+ with self._transfers.download_import(params.yaml_url) as downloaded:
+ content = self._transfers.read_import_yaml(downloaded)
+ if content is None:
+ return self._import_package(context, params, downloaded)
+ params = params.model_copy(update={"mode": "yaml-content", "yaml_content": content, "yaml_url": None})
+ return self._import_dsl(context, params)
+
+ def _import_package(self, context: RequestContext, params: AppImportParams, source: BinaryIO) -> Import:
+ package = self._transfers.read_app_package(source)
+ if package is not None:
+ with closing(package):
+ return self._import_dsl(
+ context,
+ params.model_copy(update={"mode": "yaml-content", "yaml_content": package.dsl, "yaml_url": None}),
+ package=package,
+ )
+ self._access.require_import(context, "agent")
+ if params.app_id:
+ raise InvalidRosterAgentPackageError("Roster Agent package import does not support overwriting an App")
+ result = self._transfers.import_agent_package(context, source)
+ return Import(
+ id=str(uuid4()),
+ status=ImportStatus.COMPLETED_WITH_WARNINGS if result.warnings else ImportStatus.COMPLETED,
+ app_id=result.app_id,
+ app_mode="agent",
+ warnings=result.warnings,
+ )
+
+ def _import_dsl(
+ self, context: RequestContext, params: AppImportParams, *, package: AppImportPackage | None = None
+ ) -> Import:
+ self._access.require_import(context, "dsl")
+ result = self._transfers.import_dsl(context, params, package=package)
+ self._set_import_permissions(context, result, created=params.app_id is None)
+ if result.app_id:
+ self._access.initialize_import_access(result.app_id)
+ return result
+
+ def confirm_import(self, context: RequestContext, import_id: str) -> Import:
+ result, created = self._transfers.confirm_import(context, import_id)
+ self._set_import_permissions(context, result, created=created)
+ return result
+
+ def _set_import_permissions(self, context: RequestContext, result: Import, *, created: bool) -> None:
+ if (
+ created
+ and result.app_id
+ and result.status in {ImportStatus.COMPLETED, ImportStatus.COMPLETED_WITH_WARNINGS}
+ ):
+ result.permission_keys = self._access.imported_permissions(context, result.app_id)
+
+ def check_import_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult:
+ self._apps.get_reference(context, app_id)
+ return self._transfers.check_dependencies(context, app_id)
+
+ def list_apps(self, context: RequestContext, params: AppListParams | StarredAppListParams) -> AppPage:
+ permissions = None
+ if isinstance(params, AppListParams):
+ permissions = self._access.permissions(context)
+ params = permissions.filter_list(params)
+ page = self._apps.list_apps(context, params)
+ if not page.data:
+ return page
+ app_ids = [app.id for app in page.data]
+ modes = self._access.access_modes(app_ids)
+ keys = permissions.keys_for(app_ids) if permissions is not None else {}
+ return replace(
+ page,
+ data=[
+ replace(app, access_mode=modes.get(app.id), permission_keys=keys.get(app.id, [])) for app in page.data
+ ],
+ )
+
+ def recent(self, context: RequestContext, limit: int) -> list[RecentAppListItem]:
+ permissions = self._access.permissions(context)
+ apps = self._apps.recent(context, permissions.filter_list(AppListParams(limit=limit)))
+ keys = permissions.keys_for([app.id for app in apps])
+ return [replace(app, permission_keys=keys.get(app.id, [])) for app in apps]
+
+ def get(self, context: RequestContext, app_id: str) -> AppRecord:
+ app = self._lifecycle.present(context, self._apps.get(context, app_id), mask_credentials=True)
+ access_mode = self._access.access_mode(app.id)
+ keys = self._access.permissions(context, app_id=app.id).keys_for([app.id])
+ return replace(app, access_mode=access_mode, permission_keys=keys.get(app.id, []))
+
+ def create(self, context: RequestContext, params: CreateAppParams) -> AppRecord:
+ settings = self._lifecycle.prepare_creation(context, params)
+ app = self._lifecycle.create(context, params, settings)
+ self._lifecycle.created(context, app)
+ keys = self._access.created_permissions(context, app.id)
+ self._access.initialize_created_app(context, app.id)
+ return self._lifecycle.present(context, replace(app, permission_keys=keys))
+
+ def update(self, context: RequestContext, app_id: str, params: UpdateAppParams) -> AppRecord:
+ app = self._apps.update(context, app_id, params)
+ self._lifecycle.updated(context, app)
+ return self._lifecycle.present(context, app)
+
+ def rename(self, context: RequestContext, app_id: str, name: str) -> AppRecord:
+ app = self._apps.rename(context, app_id, name)
+ self._lifecycle.updated(context, app)
+ return app
+
+ def update_icon(
+ self, context: RequestContext, app_id: str, *, icon: str, icon_background: str, icon_type: str | None
+ ) -> AppRecord:
+ app = self._apps.update_icon(context, app_id, icon=icon, icon_background=icon_background, icon_type=icon_type)
+ self._lifecycle.updated(context, app)
+ return app
+
+ def set_site_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppRecord:
+ result = self._apps.set_site_enabled(context, app_id, enabled)
+ if result.changed:
+ self._lifecycle.updated(context, result.app)
+ return result.app
+
+ def set_api_enabled(self, context: RequestContext, app_id: str, enabled: bool) -> AppRecord:
+ result = self._apps.set_api_enabled(context, app_id, enabled)
+ if result.changed:
+ self._lifecycle.updated(context, result.app)
+ return result.app
+
+ def delete(self, context: RequestContext, app_id: str) -> None:
+ deleted = self._lifecycle.delete(context, app_id)
+ self._lifecycle.deleted(context, deleted)
+
+ def set_starred(self, context: RequestContext, app_id: str, starred: bool) -> None:
+ self._apps.set_starred(context, app_id, starred)
+
+ def copy(self, context: RequestContext, app_id: str, params: CopyAppParams) -> tuple[Import, AppRecord | None]:
+ dsl = self._transfers.export_dsl(context, app_id, AppExportOptions(include_secret=True))
+ result = self._transfers.import_dsl(
+ context,
+ AppImportParams(mode="yaml-content", yaml_content=dsl, **params.model_dump()),
+ as_copy=True,
+ )
+ if result.status in {ImportStatus.FAILED, ImportStatus.PENDING}:
+ return result, None
+ if result.app_id is None:
+ raise ConsoleAppNotFoundError
+ app = self._apps.get(context, result.app_id)
+ self._access.inherit_access(app_id, app.id)
+ app = replace(app, permission_keys=self._access.created_permissions(context, app.id))
+ return result, self._lifecycle.present(context, app)
+
+ def export(self, context: RequestContext, app_id: str, options: AppExportOptions) -> str | RosterAgentPackageExport:
+ app = self._apps.get_reference(context, app_id)
+ if options.version_id is not None:
+ if app.mode != "agent":
+ raise InvalidAppExportError("version_id is only available for Agent Apps")
+ if not self._access.can_export_version(context.active_workspace_id):
+ raise AppExportPaidPlanRequiredError("This feature requires a paid plan.")
+ if options.format == "yaml":
+ return self._transfers.export_dsl(context, app.id, options)
+ if app.mode == "agent":
+ if app.bound_agent_id is None:
+ raise AppExportAgentNotFoundError("Agent not found")
+ return self._transfers.export_agent_package(
+ workspace_id=context.active_workspace_id,
+ agent_id=app.bound_agent_id,
+ version_id=options.version_id,
+ )
+ return self._transfers.export_app_package(context, app.id, options)
+
+ def publish(self, context: RequestContext, app_id: str) -> str:
+ # Validate ownership before producing external effects, including feature rejection.
+ self._apps.get_reference(context, app_id)
+ self._creators.require_enabled()
+ dsl = self._transfers.export_dsl(context, app_id, AppExportOptions(include_secret=False))
+ claim_code = self._creators.upload(dsl)
+ code = self._creators.authorize(context.account_id)
+ return self._creators.redirect_url(claim_code, code)
+
+ def get_trace(self, context: RequestContext, app_id: str) -> AppTraceSettings:
+ return self._apps.get_trace(context, app_id)
+
+ def set_trace(self, context: RequestContext, app_id: str, settings: AppTraceSettings) -> None:
+ self._apps.get_reference(context, app_id)
+ if settings.tracing_provider is not None:
+ if settings.enabled:
+ self._tracing.require_provider_available(settings.tracing_provider)
+ else:
+ self._tracing.validate_provider(settings.tracing_provider)
+ self._apps.set_trace(context, app_id, settings)
diff --git a/api/services/app/creators_platform_gateway.py b/api/services/app/creators_platform_gateway.py
new file mode 100644
index 00000000000..5c52ba8b1a2
--- /dev/null
+++ b/api/services/app/creators_platform_gateway.py
@@ -0,0 +1,33 @@
+"""Creators Platform uploads, redirects and OAuth authorization adapter."""
+
+from typing import override
+
+from configs import dify_config
+from core.helper import creators
+from services.app.console_service import CreatorsPlatform, CreatorsPlatformDisabledError
+from services.oauth_server_service import OAuthServerService
+
+
+class CreatorsPlatformGateway(CreatorsPlatform):
+ def __init__(self, *, oauth: OAuthServerService) -> None:
+ self._oauth = oauth
+
+ @override
+ def require_enabled(self) -> None:
+ if not dify_config.CREATORS_PLATFORM_FEATURES_ENABLED:
+ raise CreatorsPlatformDisabledError("Creators Platform features are not enabled")
+
+ @override
+ def upload(self, dsl: str) -> str:
+ return creators.upload_dsl(dsl.encode("utf-8"))
+
+ @override
+ def authorize(self, account_id: str) -> str | None:
+ client_id = dify_config.CREATORS_PLATFORM_OAUTH_CLIENT_ID
+ if not client_id:
+ return None
+ return self._oauth.issue_authorization_code(client_id=client_id, account_id=account_id).code
+
+ @override
+ def redirect_url(self, claim_code: str, oauth_code: str | None) -> str:
+ return creators.get_redirect_url(claim_code, oauth_code=oauth_code)
diff --git a/api/services/app/import_service.py b/api/services/app/import_service.py
new file mode 100644
index 00000000000..4d327153db1
--- /dev/null
+++ b/api/services/app/import_service.py
@@ -0,0 +1,49 @@
+"""DSL import use cases shared by account and delegated enterprise callers."""
+
+from typing import Protocol
+
+from machinery.context import RequestContext
+from services.entities.account_entities import AccountSnapshot
+from services.entities.dsl_entities import AppImportParams, CheckDependenciesResult, Import
+
+
+class ImportAccounts(Protocol):
+ def find_by_email(self, email: str) -> AccountSnapshot | None: ...
+
+
+class AppDefinitionImports(Protocol):
+ def import_dsl(self, context: RequestContext, params: AppImportParams) -> Import: ...
+
+ def confirm_definition(self, context: RequestContext, import_id: str) -> Import: ...
+
+ def check_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult: ...
+
+
+class AppImportService:
+ def __init__(self, *, accounts: ImportAccounts, definitions: AppDefinitionImports) -> None:
+ self._accounts = accounts
+ self._definitions = definitions
+
+ def import_app(self, context: RequestContext, params: AppImportParams) -> Import:
+ return self._definitions.import_dsl(context, params)
+
+ def import_as_creator(
+ self,
+ *,
+ workspace_id: str,
+ creator_email: str,
+ params: AppImportParams,
+ request_id: str,
+ trace_id: str | None,
+ ) -> Import | None:
+ account = self._accounts.find_by_email(creator_email)
+ if account is None or account.status != "active" or account.email != creator_email:
+ return None
+ context = RequestContext(request_id, trace_id, account.id, workspace_id)
+ return self.import_app(context, params)
+
+ def confirm_import(self, context: RequestContext, import_id: str) -> Import:
+ return self._definitions.confirm_definition(context, import_id)
+
+ def check_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult:
+ return self._definitions.check_dependencies(context, app_id)
diff --git a/api/services/app/query_service.py b/api/services/app/query_service.py
new file mode 100644
index 00000000000..a6dcfb445ec
--- /dev/null
+++ b/api/services/app/query_service.py
@@ -0,0 +1,36 @@
+"""App discovery and access checks over materialized data."""
+
+from collections.abc import Sequence
+from typing import Protocol
+
+from libs.pagination import PaginatedResult
+from services.entities.app_entities import AppListParams, AppRecord, AppSummary
+
+
+class AppQueryStore(Protocol):
+ def find_visible_app(self, app_id: str, tenant_id: str) -> AppSummary | None: ...
+
+ def find_visible_apps(self, app_ids: Sequence[str]) -> list[AppSummary]: ...
+
+ def query_apps(self, user_id: str, tenant_id: str, params: AppListParams) -> PaginatedResult[AppSummary] | None: ...
+
+ def related_apps(self, tenant_id: str, app_ids: Sequence[str]) -> list[AppRecord]: ...
+
+
+class AppQueryService:
+ def __init__(self, *, apps: AppQueryStore) -> None:
+ self._apps = apps
+
+ def get_visible_app_by_id(self, app_id: str, tenant_id: str) -> AppSummary | None:
+ return self._apps.find_visible_app(app_id, tenant_id)
+
+ def find_visible_apps_by_ids(self, app_ids: Sequence[str]) -> list[AppSummary]:
+ return self._apps.find_visible_apps(app_ids)
+
+ def get_paginate_apps(
+ self, user_id: str, tenant_id: str, params: AppListParams
+ ) -> PaginatedResult[AppSummary] | None:
+ return self._apps.query_apps(user_id, tenant_id, params)
+
+ def related_apps(self, tenant_id: str, app_ids: Sequence[str]) -> list[AppRecord]:
+ return self._apps.related_apps(tenant_id, app_ids)
diff --git a/api/services/app/response_gateway.py b/api/services/app/response_gateway.py
new file mode 100644
index 00000000000..1eeb3b5a833
--- /dev/null
+++ b/api/services/app/response_gateway.py
@@ -0,0 +1,61 @@
+"""App response enrichment through tool runtimes and plugin metadata."""
+
+from collections.abc import Mapping
+from copy import deepcopy
+from dataclasses import replace
+from typing import cast
+
+from pydantic import JsonValue
+
+from core.agent.tool_configuration import mask_agent_tool_parameters
+from core.plugin.plugin_service import PluginService
+from core.tools.tool_manager import ToolManager
+from machinery.context import RequestContext
+from models.model import AppMode
+from models.provider_ids import GenericProviderID
+from services.entities.app_entities import AppRecord, AppToolReference
+
+
+class AppResponseGateway:
+ @staticmethod
+ def find_deleted_tools(tenant_id: str, references: tuple[AppToolReference, ...]) -> list[dict[str, str]]:
+ """Resolve builtin tool availability from detached references, without a database session."""
+ providers: dict[str, GenericProviderID] = {}
+ existence: dict[str, bool] = {}
+ for ref in references:
+ if ref.provider_type != "builtin" or ref.provider_id in providers:
+ continue
+ try:
+ try:
+ ToolManager.get_hardcoded_provider(ref.provider_id)
+ is_hardcoded = True
+ except Exception:
+ is_hardcoded = False
+ providers[ref.provider_id] = GenericProviderID(ref.provider_id, is_hardcoded)
+ except Exception:
+ continue
+ if is_hardcoded:
+ existence[ref.provider_id] = True
+ remote_providers = {key: provider for key, provider in providers.items() if not provider.is_hardcoded}
+ if remote_providers:
+ states = PluginService.check_tools_existence(tenant_id, list(remote_providers.values()))
+ existence.update(zip(remote_providers, states, strict=True))
+ return [
+ {"type": ref.provider_type, "tool_name": ref.tool_name, "provider_id": ref.provider_id}
+ for ref in references
+ if (ref.provider_type == "api" and ref.exists is False)
+ or (ref.provider_type == "builtin" and existence.get(ref.provider_id) is False)
+ ]
+
+ @staticmethod
+ def mask_record(context: RequestContext, app: AppRecord) -> AppRecord:
+ if app.mode_compatible_with_agent != AppMode.AGENT_CHAT or app.app_model_config is None:
+ return app
+ config = deepcopy(app.app_model_config)
+ config["agent_mode"] = mask_agent_tool_parameters(
+ agent_mode=cast(Mapping[str, JsonValue], config.get("agent_mode", {})),
+ tenant_id=context.active_workspace_id,
+ app_id=app.id,
+ user_id=context.account_id,
+ )
+ return replace(app, app_model_config=config)
diff --git a/api/services/app_dsl_service.py b/api/services/app_dsl_service.py
index 76e508abb58..10be610f172 100644
--- a/api/services/app_dsl_service.py
+++ b/api/services/app_dsl_service.py
@@ -52,14 +52,15 @@ from services.agent.dsl_service import AgentDslService
from services.agent.package_resource_exporter import AgentPackageResourceExporter
from services.agent.retirement_service import WorkflowAgentRetirementService
from services.agent.workflow_publish_service import WorkflowAgentPublishService
-from services.app_package_service import PreparedAppPackage
from services.dsl_content import DSL_MAX_SIZE, dsl_content_size
from services.dsl_version import check_version_compatibility
-from services.enterprise.enterprise_service import EnterpriseService
from services.enterprise.rbac_service import RBACService
from services.entities.dsl_entities import (
+ AppDslExportData,
+ AppImportPackage,
CheckDependenciesResult,
DslImportWarning,
+ Import,
ImportMode,
ImportStatus,
PendingImportOwner,
@@ -73,7 +74,6 @@ from services.icon_configuration import (
is_valid_image_icon,
)
from services.plugin.dependencies_analysis import DependenciesAnalysisService
-from services.system_feature_service import SystemFeatureService
from services.workflow_draft_variable_service import WorkflowDraftVariableService
from services.workflow_service import WorkflowService
@@ -85,18 +85,6 @@ IMPORT_INFO_REDIS_EXPIRY = 10 * 60 # 10 minutes
CURRENT_DSL_VERSION = CURRENT_APP_DSL_VERSION
-class Import(BaseModel):
- id: str
- status: ImportStatus
- app_id: str | None = None
- app_mode: str | None = None
- permission_keys: list[str] = Field(default_factory=list)
- current_dsl_version: str = CURRENT_DSL_VERSION
- imported_dsl_version: str = ""
- error: str = ""
- warnings: list[DslImportWarning] = Field(default_factory=list)
-
-
class PendingData(PendingImportOwner):
import_mode: str
yaml_content: str
@@ -121,55 +109,6 @@ class AppDslService:
self._session = session
self._warnings = []
- def copy_app(
- self,
- *,
- app_model: App,
- account: Account,
- tenant_id: str,
- name: str | None = None,
- description: str | None = None,
- icon_type: str | None = None,
- icon: str | None = None,
- icon_background: str | None = None,
- ) -> tuple[Import, App | None]:
- """Copy an app, finalizing the import before inheriting external access settings.
-
- Failed and pending imports roll back the current transaction. Completed
- imports commit before external I/O, then load the copy in the caller's tenant.
- """
- if app_model.tenant_id != tenant_id or account.current_tenant_id != tenant_id:
- raise NoPermissionError("App does not belong to the current workspace")
-
- original_app_id = app_model.id
- yaml_content = self.export_dsl(app_model=app_model, session=self._session, include_secret=True)
- result = self.import_app(
- account=account,
- import_mode=ImportMode.YAML_CONTENT,
- yaml_content=yaml_content,
- name=name,
- description=description,
- icon_type=icon_type,
- icon=icon,
- icon_background=icon_background,
- )
- if result.status in {ImportStatus.FAILED, ImportStatus.PENDING}:
- self._session.rollback()
- return result, None
- self._session.commit()
-
- if result.app_id and SystemFeatureService.is_webapp_auth_enabled():
- try:
- original_settings = EnterpriseService.WebAppAuth.get_app_access_mode_by_id(original_app_id)
- access_mode = original_settings.access_mode
- except Exception:
- # Old apps without settings default to public, matching the access fallback.
- access_mode = "public"
- EnterpriseService.WebAppAuth.update_app_access_mode(result.app_id, access_mode)
-
- app = self._session.scalar(select(App).where(App.id == result.app_id, App.tenant_id == tenant_id))
- return result, app
-
def import_app(
self,
*,
@@ -184,7 +123,7 @@ class AppDslService:
icon_background: str | None = None,
app_id: str | None = None,
import_app_id: str | None = None,
- package: PreparedAppPackage | None = None,
+ package: AppImportPackage | None = None,
) -> Import:
"""Import an App DSL, materializing validated archive resources before database writes."""
self._warnings = []
@@ -286,7 +225,7 @@ class AppDslService:
error="Missing app data in YAML content",
)
- if package is not None and (package.agent_resources or package.icons):
+ if package is not None and package.has_resources:
tenant_id = account.current_tenant_id
if tenant_id is None:
raise ValueError("Current tenant is not set")
@@ -299,10 +238,9 @@ class AppDslService:
raise ValueError("App not found")
self._validate_workflow_overwrite(target, data)
package.materialize_icons(data=data, tenant_id=tenant_id, account_id=account.id)
- if package.agent_resources:
- data["agent_packages"], self._warnings = package.materialize_agents(
- tenant_id=tenant_id, account_id=account.id
- )
+ agents, self._warnings = package.materialize_agents(tenant_id=tenant_id, account_id=account.id)
+ if agents:
+ data["agent_packages"] = agents
content = yaml.safe_dump(data, allow_unicode=True)
# If app_id is provided, check if it exists
@@ -506,8 +444,12 @@ class AppDslService:
app_model: App,
) -> CheckDependenciesResult:
"""Check dependencies"""
+ return self.check_app_dependencies(tenant_id=app_model.tenant_id, app_id=app_model.id)
+
+ @staticmethod
+ def check_app_dependencies(*, tenant_id: str, app_id: str) -> CheckDependenciesResult:
# Get dependencies from Redis
- redis_key = f"{CHECK_DEPENDENCIES_REDIS_KEY_PREFIX}{app_model.id}"
+ redis_key = f"{CHECK_DEPENDENCIES_REDIS_KEY_PREFIX}{app_id}"
dependencies = redis_client.get(redis_key)
if not dependencies:
return CheckDependenciesResult()
@@ -517,7 +459,7 @@ class AppDslService:
# Get leaked dependencies
leaked_dependencies = DependenciesAnalysisService.get_leaked_dependencies(
- tenant_id=app_model.tenant_id, dependencies=dependencies.dependencies
+ tenant_id=tenant_id, dependencies=dependencies.dependencies
)
return CheckDependenciesResult(
leaked_dependencies=leaked_dependencies,
@@ -802,19 +744,30 @@ class AppDslService:
workflow_id: str | None = None,
version_id: uuid.UUID | None = None,
) -> str:
- return yaml.dump(
- cls.export_data(
+ """
+ Export app
+ :param app_model: App instance
+ :param session: Database session used to load export data
+ :param include_secret: Whether include secret variable
+ :param workflow_id: Optional published workflow version to export
+ :param version_id: Optional published Agent version to export
+ :raises AgentVersionNotFoundError: If the selected Agent version is unavailable or not visible in history
+ :raises WorkflowNotFoundError: If the selected workflow version does not exist
+ :raises IsDraftWorkflowError: If the selected workflow is a draft
+ :return:
+ """
+ return cls.serialize_export_data(
+ cls.load_export_data(
app_model,
session=session,
include_secret=include_secret,
workflow_id=workflow_id,
version_id=version_id,
- ),
- allow_unicode=True,
+ )
)
@classmethod
- def export_data(
+ def load_export_data(
cls,
app_model: App,
*,
@@ -823,20 +776,8 @@ class AppDslService:
workflow_id: str | None = None,
version_id: uuid.UUID | None = None,
resource_exporter: AgentPackageResourceExporter | None = None,
- ) -> dict[str, Any]:
- """
- Build the App definition before serializing it as YAML or a resource archive.
- :param app_model: App instance
- :param session: Database session used to load export data
- :param include_secret: Whether include secret variable
- :param workflow_id: Optional published workflow version to export
- :param version_id: Optional published Agent version to export
- :param resource_exporter: Optional collector for workflow Agent assets in App archives
- :raises AgentVersionNotFoundError: If the selected Agent version is unavailable or not visible in history
- :raises WorkflowNotFoundError: If the selected workflow version does not exist
- :raises IsDraftWorkflowError: If the selected workflow is a draft
- :return:
- """
+ ) -> AppDslExportData:
+ """Load portable data using the caller's transaction, without requesting plugin dependencies."""
app_mode = AppMode.value_of(app_model.mode)
if app_mode == AppMode.AGENT:
@@ -846,14 +787,12 @@ class AppDslService:
app_model,
package_ref=package_ref,
packages=packages,
- dependencies=DependenciesAnalysisService.generate_dependencies(
- tenant_id=app_model.tenant_id, dependencies=dependencies
- ),
+ dependencies=[],
).model_dump(mode="json")
else:
export_data = make_app_dsl(app_model)
if app_mode in {AppMode.ADVANCED_CHAT, AppMode.WORKFLOW}:
- cls._append_workflow_export_data(
+ dependencies = cls._append_workflow_export_data(
export_data=export_data,
app_model=app_model,
include_secret=include_secret,
@@ -862,9 +801,19 @@ class AppDslService:
resource_exporter=resource_exporter,
)
else:
- cls._append_model_config_export_data(export_data, app_model, session=session)
+ dependencies = cls._append_model_config_export_data(export_data, app_model, session=session)
+
+ return AppDslExportData(app_model.tenant_id, export_data, dependencies)
- return export_data
+ @staticmethod
+ def serialize_export_data(prepared: AppDslExportData) -> str:
+ """Resolve plugin metadata and serialize materialized data; no Session is required."""
+ dependencies = DependenciesAnalysisService.generate_dependencies(
+ tenant_id=prepared.tenant_id, dependencies=prepared.dependency_identifiers
+ )
+ export_data = dict(prepared.data)
+ export_data["dependencies"] = [jsonable_encoder(item.model_dump()) for item in dependencies]
+ return yaml.dump(export_data, allow_unicode=True)
@classmethod
def _append_workflow_export_data(
@@ -876,7 +825,7 @@ class AppDslService:
session: Session,
workflow_id: str | None = None,
resource_exporter: AgentPackageResourceExporter | None = None,
- ):
+ ) -> list[str]:
"""
Append workflow export data
:param export_data: export data
@@ -934,12 +883,7 @@ class AppDslService:
export_data["agent_packages"] = {
key: package.model_dump(mode="json") for key, package in agent_packages.items()
}
- export_data["dependencies"] = [
- jsonable_encoder(d.model_dump())
- for d in DependenciesAnalysisService.generate_dependencies(
- tenant_id=app_model.tenant_id, dependencies=dependencies
- )
- ]
+ return dependencies
def _status_with_warnings(self, status: ImportStatus) -> ImportStatus:
if status == ImportStatus.COMPLETED and self._warnings:
@@ -947,7 +891,9 @@ class AppDslService:
return status
@classmethod
- def _append_model_config_export_data(cls, export_data: dict[str, Any], app_model: App, *, session: Session) -> None:
+ def _append_model_config_export_data(
+ cls, export_data: dict[str, Any], app_model: App, *, session: Session
+ ) -> list[str]:
"""
Append model config export data
:param export_data: export data
@@ -971,12 +917,7 @@ class AppDslService:
export_data["model_config"] = model_config
dependencies = cls._extract_dependencies_from_model_config(model_config)
- export_data["dependencies"] = [
- jsonable_encoder(d.model_dump())
- for d in DependenciesAnalysisService.generate_dependencies(
- tenant_id=app_model.tenant_id, dependencies=dependencies
- )
- ]
+ return dependencies
@classmethod
def _extract_dependencies_from_workflow(cls, workflow: Workflow) -> list[str]:
diff --git a/api/services/app_package_service.py b/api/services/app_package_service.py
index 3fd44f42ae4..f99538e0a76 100644
--- a/api/services/app_package_service.py
+++ b/api/services/app_package_service.py
@@ -73,6 +73,10 @@ class PreparedAppPackage(PreparedPackageArchive):
agent_resources: dict[str, AgentPackageResources]
icons: list[PackageIcon] = field(default_factory=list)
+ @property
+ def has_resources(self) -> bool:
+ return bool(self.agent_resources or self.icons)
+
def materialize_icons(self, *, data: dict[str, Any], tenant_id: str, account_id: str) -> None:
importer = AgentPackageResourceImporter()
for ref, resources in self.agent_resources.items():
@@ -211,20 +215,20 @@ class AppPackageService(RosterAgentPackageReader):
resources = AgentPackageResourceExporter()
with session_factory.create_session() as session:
- data = AppDslService.export_data(
+ prepared = AppDslService.load_export_data(
app_model=app_model,
session=session,
include_secret=include_secret,
workflow_id=workflow_id,
resource_exporter=resources,
)
- resources.collect_icon(session=session, tenant_id=app_model.tenant_id, metadata=data["app"])
+ resources.collect_icon(session=session, tenant_id=app_model.tenant_id, metadata=prepared.data["app"])
resources.collect_workspace_skills()
if resources.packages:
- data["agent_packages"] = {
+ prepared.data["agent_packages"] = {
ref: package.model_dump(mode="json") for ref, package in resources.packages.items()
}
- return self.export(dsl=yaml.dump(data, allow_unicode=True), name=app_model.name, resources=resources)
+ return self.export(dsl=AppDslService.serialize_export_data(prepared), name=app_model.name, resources=resources)
def export(
self, *, dsl: str, name: str, resources: AgentPackageResourceExporter | None = None
diff --git a/api/services/app_service.py b/api/services/app_service.py
index 193f6cb05c5..642e188f79a 100644
--- a/api/services/app_service.py
+++ b/api/services/app_service.py
@@ -3,10 +3,10 @@ import logging
from collections.abc import Callable, Mapping, Sequence
from dataclasses import dataclass
from datetime import datetime
-from typing import Any, Literal, NotRequired, TypedDict, cast, override
+from typing import Any, NotRequired, TypedDict, cast, override
import sqlalchemy as sa
-from pydantic import BaseModel, Field, JsonValue
+from pydantic import JsonValue
from sqlalchemy import ColumnElement, delete, select
from sqlalchemy.exc import IntegrityError
from sqlalchemy.orm import Session
@@ -49,6 +49,16 @@ from services.agent.workspace_service import AgentWorkspaceService
from services.billing_service import BillingService
from services.enterprise import rbac_service as enterprise_rbac_service
from services.enterprise.enterprise_service import EnterpriseService
+from services.entities.app_entities import (
+ AgentAppPublicationCounts,
+ AppCreationSettings,
+ AppDeletion,
+ AppEvent,
+ AppListBaseParams,
+ AppListParams,
+ AppListSortBy,
+ CreateAppParams,
+)
from services.model_provider_service import ModelProviderService
from services.openapi.visibility import apply_openapi_gate, is_openapi_visible
from services.rbac_agent_access_service import initialize_agent_rbac_access
@@ -59,22 +69,6 @@ from tasks.remove_app_and_related_data_task import remove_app_and_related_data_t
logger = logging.getLogger(__name__)
-AppListSortBy = Literal["last_modified", "recently_created", "earliest_created"]
-RecentAppMode = Literal[
- AppMode.COMPLETION,
- AppMode.WORKFLOW,
- AppMode.CHAT,
- AppMode.ADVANCED_CHAT,
- AppMode.AGENT_CHAT,
-]
-RECENT_APP_MODES: tuple[RecentAppMode, ...] = (
- AppMode.COMPLETION,
- AppMode.WORKFLOW,
- AppMode.CHAT,
- AppMode.ADVANCED_CHAT,
- AppMode.AGENT_CHAT,
-)
-
@dataclass(frozen=True)
class _CreatedApp:
@@ -108,61 +102,6 @@ _CREATED_APP_ACCESS_INITIALIZERS: dict[AppMode, Callable[[_CreatedApp], None]] =
}
-class AppListBaseParams(BaseModel):
- page: int = Field(default=1, ge=1)
- limit: int = Field(default=20, ge=1, le=100)
- mode: Literal["completion", "chat", "advanced-chat", "workflow", "agent-chat", "agent", "channel", "all"] = "all"
- sort_by: AppListSortBy = "last_modified"
- name: str | None = None
- tag_ids: list[str] | None = None
- creator_ids: list[str] | None = None
- is_created_by_me: bool | None = None
- accessible_app_ids: list[str] | None = None
- include_own_apps: bool = False
-
-
-class AppListParams(AppListBaseParams):
- status: str | None = None
- openapi_visible: bool = False
- agent_is_published: bool | None = None
-
-
-class StarredAppListParams(AppListBaseParams):
- pass
-
-
-@dataclass(frozen=True)
-class AgentAppPublicationCounts:
- published: int
- drafts: int
-
-
-@dataclass(frozen=True)
-class RecentAppListItem:
- id: str
- name: str
- icon_type: IconType | None
- icon: str | None
- icon_background: str | None
- mode: RecentAppMode
- author_name: str | None
- updated_at: datetime
- maintainer: str | None
-
-
-class CreateAppParams(BaseModel):
- name: str = Field(min_length=1)
- description: str | None = None
- mode: Literal["chat", "agent-chat", "agent", "advanced-chat", "workflow", "completion"]
- agent_role: str = Field(default="", max_length=255)
- icon_type: str | None = None
- icon: str | None = None
- icon_background: str | None = None
- api_rph: int = 0
- api_rpm: int = 0
- max_active_requests: int | None = None
-
-
class AppModelConfigResponseView:
"""Expose AppModelConfig response properties through the request session."""
@@ -423,132 +362,25 @@ class AppService:
return AgentAppPublicationCounts(published=int(published_count), drafts=int(draft_count))
- def get_recent_apps(
- self,
- user_id: str,
- tenant_id: str,
- params: AppListParams,
- session: Session,
- ) -> list[RecentAppListItem]:
- """Return recently modified apps as one lightweight, non-paginated projection."""
- filters = self._build_app_list_filters(user_id, tenant_id, params, session)
- if not filters:
- return []
-
- stmt = (
- sa.select(
- App.id,
- App.name,
- App.icon_type,
- App.icon,
- App.icon_background,
- App.mode,
- Account.name.label("author_name"),
- App.updated_at,
- App.maintainer,
- )
- .outerjoin(Account, Account.id == App.created_by)
- .where(*filters, App.mode.in_(RECENT_APP_MODES))
- .order_by(App.updated_at.desc())
- .limit(params.limit)
- )
- rows = session.execute(stmt).all()
-
- return [
- RecentAppListItem(
- id=str(app_id),
- name=name,
- icon_type=icon_type,
- icon=icon,
- icon_background=icon_background,
- mode=cast(RecentAppMode, mode),
- author_name=author_name,
- updated_at=updated_at,
- maintainer=maintainer,
- )
- for (
- app_id,
- name,
- icon_type,
- icon,
- icon_background,
- mode,
- author_name,
- updated_at,
- maintainer,
- ) in rows
- ]
-
- def get_paginate_starred_apps(
- self,
- user_id: str,
- tenant_id: str,
- params: StarredAppListParams,
- session: Session,
- ) -> PaginatedResult | None:
- """
- Get apps starred by the current account with pagination, filters, and explicit sort order.
- """
- filters = self._build_app_list_filters(user_id, tenant_id, params, session)
- if not filters:
- return None
-
- order_by = self._build_app_list_order_by(params.sort_by)
- app_models = paginate_query(
- sa.select(App)
- .join(
- AppStar,
- sa.and_(
- AppStar.tenant_id == App.tenant_id,
- AppStar.app_id == App.id,
- AppStar.account_id == user_id,
- ),
- )
- .where(AppStar.tenant_id == tenant_id, *filters)
- .order_by(order_by),
- page=params.page,
- per_page=params.limit,
- session=session,
- )
-
- for app in app_models.items:
- app.is_starred = True
-
- return app_models
-
- @staticmethod
- def star_app(*, app: App, account_id: str, session: Session) -> None:
- """Create the account's app star if it does not already exist."""
- existing_star = session.scalar(
- select(AppStar)
- .where(
- AppStar.tenant_id == app.tenant_id,
- AppStar.app_id == app.id,
- AppStar.account_id == account_id,
- )
- .limit(1)
- )
- if existing_star:
- return
-
- session.add(AppStar(tenant_id=app.tenant_id, app_id=app.id, account_id=account_id))
-
@staticmethod
- def unstar_app(*, app: App, account_id: str, session: Session) -> None:
- """Remove the account's app star if present."""
- existing_star = session.scalar(
- select(AppStar)
- .where(
- AppStar.tenant_id == app.tenant_id,
- AppStar.app_id == app.id,
- AppStar.account_id == account_id,
+ def prepare_agent_soul(tenant_id: str, *, session: Session) -> AgentSoulConfig | None:
+ """Build the initial Agent Soul from the workspace default model, when available."""
+ default_model = ModelProviderService().get_default_model_selection(tenant_id, ModelType.LLM, session=session)
+ if default_model is None:
+ return None
+ agent_provider, agent_model = default_model
+ try:
+ provider_id = ModelProviderID(agent_provider)
+ except ValueError:
+ logger.warning("Invalid Agent default model, tenant_id: %s", tenant_id, exc_info=True)
+ return None
+ return AgentSoulConfig(
+ model=AgentSoulModelConfig(
+ plugin_id=provider_id.plugin_id,
+ model_provider=str(provider_id),
+ model=agent_model,
)
- .limit(1)
)
- if not existing_star:
- return
-
- session.delete(existing_star)
def create_app(
self,
@@ -566,22 +398,7 @@ class AppService:
"""
app_mode = AppMode.value_of(params.mode)
app_template = default_app_templates[app_mode]
- initial_agent_soul: AgentSoulConfig | None = None
- if app_mode == AppMode.AGENT:
- default_model = ModelProviderService().get_default_model_selection(
- tenant_id, ModelType.LLM, session=session
- )
- if default_model is not None:
- agent_provider, agent_model = default_model
- try:
- provider_id = ModelProviderID(agent_provider)
- initial_agent_soul = AgentSoulConfig(
- model=AgentSoulModelConfig(
- plugin_id=provider_id.plugin_id, model_provider=str(provider_id), model=agent_model
- )
- )
- except ValueError:
- logger.warning("Invalid Agent default model, tenant_id: %s", tenant_id, exc_info=True)
+ initial_agent_soul = self.prepare_agent_soul(tenant_id, session=session) if app_mode == AppMode.AGENT else None
# get model config
default_model_config = app_template.get("model_config")
@@ -932,69 +749,6 @@ class AppService:
return app
- def update_app_name(self, app: App, name: str, *, session: Session) -> App:
- """
- Update app name
- :param app: App instance
- :param name: new name
- :return: App instance
- """
- assert current_user is not None
- app.name = name
- app.updated_by = current_user.id
- app.updated_at = naive_utc_now()
- self._sync_backing_agent_identity(
- app,
- name=app.name,
- account_id=current_user.id,
- updated_at=app.updated_at,
- session=session,
- )
- self._commit_app_identity_update(app, session=session)
-
- app_was_updated.send(app)
-
- return app
-
- def update_app_icon(
- self,
- app: App,
- icon: str,
- icon_background: str,
- icon_type: IconType | str | None = None,
- *,
- session: Session,
- ) -> App:
- """
- Update app icon
- :param app: App instance
- :param icon: new icon
- :param icon_background: new icon_background
- :param icon_type: new icon type
- :return: App instance
- """
- assert current_user is not None
- app.icon = icon
- app.icon_background = icon_background
- if icon_type is not None:
- app.icon_type = icon_type if isinstance(icon_type, IconType) else IconType(icon_type)
- app.updated_by = current_user.id
- app.updated_at = naive_utc_now()
- self._sync_backing_agent_identity(
- app,
- icon_type=app.icon_type,
- icon=app.icon,
- icon_background=app.icon_background,
- account_id=current_user.id,
- updated_at=app.updated_at,
- session=session,
- )
- session.commit()
-
- app_was_updated.send(app)
-
- return app
-
@staticmethod
def is_agent_app_access_ready(app: App, *, session: Session) -> bool:
"""Return whether an Agent App has a publish-visible active snapshot."""
@@ -1019,27 +773,6 @@ class AppService:
if not cls.is_agent_app_access_ready(app, session=session):
raise AgentAccessNotReadyError()
- def update_app_site_status(self, app: App, enable_site: bool, *, session: Session) -> App:
- """
- Update app site status
- :param app: App instance
- :param enable_site: enable site status
- :return: App instance
- """
- if enable_site:
- self.ensure_agent_app_access_ready(app, session=session)
- if enable_site == app.enable_site:
- return app
- assert current_user is not None
- app.enable_site = enable_site
- app.updated_by = current_user.id
- app.updated_at = naive_utc_now()
- session.commit()
-
- app_was_updated.send(app)
-
- return app
-
def update_app_api_status(self, app: App, enable_api: bool, *, session: Session) -> App:
"""
Update app api status
@@ -1186,25 +919,115 @@ class AppService:
BillingService.clean_billing_info_cache(app.tenant_id)
@staticmethod
- def get_app_code_by_id(app_id: str, *, session: Session) -> str:
- """
- Get app code by app id
- :param app_id: app id
- :return: app code
- """
- site = session.scalar(select(Site).where(Site.app_id == app_id).limit(1))
- if not site:
- raise ValueError(f"App with id {app_id} not found")
- return str(site.code)
+ def prepare_creation(tenant_id: str, params: CreateAppParams) -> AppCreationSettings:
+ app_mode = AppMode.value_of(params.mode)
+ app_template = default_app_templates[app_mode]
+
+ # get model config
+ default_model_config = app_template.get("model_config")
+ default_model_config = default_model_config.copy() if default_model_config else None
+ if default_model_config and "model" in default_model_config:
+ default_model_dict = default_model_config["model"]
+ # get model provider
+ model_manager = ModelManager.for_tenant(tenant_id=tenant_id)
+
+ # get default model instance
+ try:
+ model_instance = model_manager.get_default_model_instance(tenant_id=tenant_id, model_type=ModelType.LLM)
+ except (ProviderTokenNotInitError, LLMBadRequestError):
+ model_instance = None
+ except Exception:
+ logger.exception("Get default model instance failed, tenant_id: %s", tenant_id)
+ model_instance = None
+
+ if model_instance is not None:
+ if (
+ model_instance.model_name == default_model_config["model"]["name"]
+ and model_instance.provider == default_model_config["model"]["provider"]
+ ):
+ default_model_dict = default_model_config["model"]
+ else:
+ llm_model = cast(LargeLanguageModel, model_instance.model_type_instance)
+ try:
+ model_schema = llm_model.get_model_schema(model_instance.model_name, model_instance.credentials)
+ if model_schema is None:
+ raise ValueError(f"model schema not found for model {model_instance.model_name}")
+ except Exception:
+ # A removed provider model must not prevent creating an app.
+ logger.warning(
+ "Default model schema is unavailable, tenant_id: %s, provider: %s, model: %s",
+ tenant_id,
+ model_instance.provider,
+ model_instance.model_name,
+ exc_info=True,
+ )
+ model_instance = None
+ else:
+ default_model_dict = {
+ "provider": model_instance.provider,
+ "name": model_instance.model_name,
+ "mode": model_schema.model_properties.get(ModelPropertyKey.MODE),
+ "completion_params": {},
+ }
+ if model_instance is None:
+ try:
+ provider, model = model_manager.get_default_provider_model_name(
+ tenant_id=tenant_id, model_type=ModelType.LLM
+ )
+ except Exception:
+ logger.exception("Get default provider model failed, tenant_id: %s", tenant_id)
+ provider = default_model_config["model"].get("provider")
+ model = default_model_config["model"].get("name")
+
+ if provider:
+ default_model_config["model"]["provider"] = provider
+ if model:
+ default_model_config["model"]["name"] = model
+ default_model_dict = default_model_config["model"]
+
+ default_model_config["model"] = json.dumps(default_model_dict)
+
+ return AppCreationSettings(dict(app_template["app"]), default_model_config)
@staticmethod
- def get_app_id_by_code(app_code: str, *, session: Session) -> str:
- """
- Get app id by app code
- :param app_code: app code
- :return: app id
- """
- site = session.scalar(select(Site).where(Site.code == app_code).limit(1))
- if not site:
- raise ValueError(f"App with code {app_code} not found")
- return str(site.app_id)
+ def notify_created_app(*, event: AppEvent, account_id: str, backing_agent_id: str | None) -> None:
+ app_was_created.send(event, created_records_initialized=True)
+ initialize_access = _CREATED_APP_ACCESS_INITIALIZERS.get(AppMode(event.mode), _initialize_created_app_access)
+ initialize_access(_CreatedApp(event.tenant_id, account_id, event.id, backing_agent_id))
+ if SystemFeatureService.is_webapp_auth_enabled():
+ EnterpriseService.WebAppAuth.update_app_access_mode(event.id, "private")
+ if dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD:
+ BillingService.clean_billing_info_cache(event.tenant_id)
+
+ @staticmethod
+ def notify_deleted_app(deleted: AppDeletion, *, account_id: str | None) -> None:
+ app = deleted.app
+ app_was_deleted.send(app)
+ try:
+ remove_app_and_related_data_task.delay(tenant_id=app.tenant_id, app_id=app.id)
+ except Exception:
+ logger.exception(
+ "Failed to enqueue App cleanup",
+ extra={"tenant_id": app.tenant_id, "app_id": app.id},
+ )
+ raise
+
+ WorkflowAgentRetirementService.retire_unowned(
+ tenant_id=app.tenant_id,
+ agent_ids=deleted.workflow_agent_ids,
+ account_id=account_id,
+ )
+ enqueue_agent_resource_collection(
+ tenant_id=app.tenant_id,
+ workspace_ids=deleted.workspace_ids,
+ binding_ids=deleted.binding_ids,
+ home_snapshot_ids=deleted.home_snapshot_ids,
+ purge_agent_ids=[deleted.backing_agent_id] if deleted.backing_agent_id is not None else [],
+ )
+
+ # clean up web app settings
+ if SystemFeatureService.is_webapp_auth_enabled():
+ EnterpriseService.WebAppAuth.cleanup_webapp(app.id)
+
+ if dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD:
+ BillingService.clean_billing_info_cache(app.tenant_id)
diff --git a/api/services/app_tracing_config_gateway.py b/api/services/app_tracing_config_gateway.py
index 348cbd2ff5b..eb696f35afb 100644
--- a/api/services/app_tracing_config_gateway.py
+++ b/api/services/app_tracing_config_gateway.py
@@ -38,6 +38,9 @@ class OpsTraceManagerGateway(TracingConfigProviderGateway):
if tracing_provider not in TracingProviderEnum:
raise AppTracingConfigInvalidProviderError(tracing_provider)
+ def require_provider_available(self, tracing_provider: str) -> None:
+ self._provider_config(tracing_provider)
+
@override
def prepare_new_config(
self,
diff --git a/api/services/dataset_service.py b/api/services/dataset_service.py
index a0a0344c5e7..ec824b5afcf 100644
--- a/api/services/dataset_service.py
+++ b/api/services/dataset_service.py
@@ -91,7 +91,7 @@ from services.feature_service import FeatureService
from services.file_service import FileService
from services.knowledge.dataset_access import DatasetAccess
from services.rag_pipeline.rag_pipeline import RagPipelineService
-from services.tag_service import TagService
+from services.tag_application_service import TagTargetQuery
from services.vector_service import VectorService
from tasks.add_document_to_index_task import add_document_to_index_task
from tasks.batch_clean_document_task import batch_clean_document_task
@@ -259,6 +259,8 @@ class DatasetService:
include_all=False,
accessible_dataset_ids: list[str] | None = None,
include_own_datasets: bool = False,
+ *,
+ tags: TagTargetQuery,
):
"""Return visible datasets for a tenant, using the injected session for auxiliary permission lookups."""
query = select(Dataset).where(Dataset.tenant_id == tenant_id).order_by(Dataset.created_at.desc(), Dataset.id)
@@ -339,11 +341,10 @@ class DatasetService:
# Check if tag_ids is not empty to avoid WHERE false condition
if tag_ids and len(tag_ids) > 0:
if tenant_id is not None:
- target_ids = TagService.get_target_ids_by_tag_ids(
- "knowledge",
- tenant_id,
- tag_ids,
- session,
+ target_ids = tags.find_target_ids(
+ tag_type="knowledge",
+ tenant_id=tenant_id,
+ tag_ids=tag_ids,
match_all=True,
)
else:
diff --git a/api/services/entities/app_entities.py b/api/services/entities/app_entities.py
new file mode 100644
index 00000000000..5d65893bd83
--- /dev/null
+++ b/api/services/entities/app_entities.py
@@ -0,0 +1,237 @@
+"""Shared application contracts, independent of service implementations."""
+
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Any, Literal, NotRequired, TypedDict
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+from models.model import AppMode, IconType
+from services.entities.dsl_entities import DslImportWarning
+
+AppListSortBy = Literal["last_modified", "recently_created", "earliest_created"]
+RecentAppMode = Literal[
+ AppMode.COMPLETION,
+ AppMode.WORKFLOW,
+ AppMode.CHAT,
+ AppMode.ADVANCED_CHAT,
+ AppMode.AGENT_CHAT,
+]
+RECENT_APP_MODES: tuple[RecentAppMode, ...] = (
+ AppMode.COMPLETION,
+ AppMode.WORKFLOW,
+ AppMode.CHAT,
+ AppMode.ADVANCED_CHAT,
+ AppMode.AGENT_CHAT,
+)
+
+
+class AppListBaseParams(BaseModel):
+ page: int = Field(default=1, ge=1)
+ limit: int = Field(default=20, ge=1, le=100)
+ mode: Literal["completion", "chat", "advanced-chat", "workflow", "agent-chat", "agent", "channel", "all"] = "all"
+ sort_by: AppListSortBy = "last_modified"
+ name: str | None = None
+ tag_ids: list[str] | None = None
+ creator_ids: list[str] | None = None
+ is_created_by_me: bool | None = None
+ accessible_app_ids: list[str] | None = None
+ include_own_apps: bool = False
+
+
+class AppListParams(AppListBaseParams):
+ status: str | None = None
+ openapi_visible: bool = False
+ agent_is_published: bool | None = None
+
+
+class StarredAppListParams(AppListBaseParams):
+ pass
+
+
+@dataclass(frozen=True)
+class AgentAppPublicationCounts:
+ published: int
+ drafts: int
+
+
+@dataclass(frozen=True, slots=True)
+class AppSummary:
+ id: str
+ tenant_id: str
+ name: str
+ description: str
+ mode: AppMode
+ status: str
+ updated_at: datetime | None
+ maintainer: str | None
+
+
+@dataclass(frozen=True)
+class RecentAppListItem:
+ id: str
+ name: str
+ icon_type: IconType | None
+ icon: str | None
+ icon_background: str | None
+ mode: RecentAppMode
+ author_name: str | None
+ updated_at: datetime
+ maintainer: str | None
+ permission_keys: list[str] = field(default_factory=list)
+
+
+class CreateAppParams(BaseModel):
+ name: str = Field(min_length=1)
+ description: str | None = None
+ mode: Literal["chat", "agent-chat", "agent", "advanced-chat", "workflow", "completion"]
+ agent_role: str = Field(default="", max_length=255)
+ icon_type: str | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ api_rph: int = 0
+ api_rpm: int = 0
+ max_active_requests: int | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppToolReference:
+ provider_type: str
+ provider_id: str
+ tool_name: str
+ # API providers are resolved in the repository; builtin providers are resolved by the gateway.
+ exists: bool | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppRecord:
+ """Fully materialized app data; no ORM instances or deferred reads."""
+
+ id: str
+ name: str
+ mode_compatible_with_agent: str
+ description: str | None = None
+ desc_or_prompt: str | None = None
+ icon_type: str | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ enable_site: bool = False
+ enable_api: bool = False
+ max_active_requests: int | None = None
+ use_icon_as_answer_icon: bool = False
+ created_by: str | None = None
+ created_at: datetime | None = None
+ updated_by: str | None = None
+ updated_at: datetime | None = None
+ maintainer: str | None = None
+ author_name: str | None = None
+ app_model_config: dict[str, Any] | None = None
+ workflow: dict[str, Any] | None = None
+ site: dict[str, Any] | None = None
+ tracing: str | None = None
+ bound_agent_id: str | None = None
+ tags: list[dict[str, str]] = field(default_factory=list)
+ deleted_tools: list[dict[str, str]] = field(default_factory=list)
+ tool_references: tuple[AppToolReference, ...] = ()
+ access_mode: str | None = None
+ permission_keys: list[str] = field(default_factory=list)
+ has_draft_trigger: bool | None = None
+ is_starred: bool = False
+
+
+@dataclass(frozen=True, slots=True)
+class AppPage:
+ page: int
+ limit: int
+ total: int
+ has_more: bool
+ data: list[AppRecord]
+
+
+class UpdateAppParams(BaseModel):
+ role: str | None = None
+ name: str
+ description: str = ""
+ icon_type: IconType | None = None
+ icon: str = ""
+ icon_background: str = ""
+ use_icon_as_answer_icon: bool = False
+ max_active_requests: int = 0
+
+
+class CopyAppParams(BaseModel):
+ name: str | None = None
+ description: str | None = None
+ icon_type: IconType | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppExportOptions:
+ format: Literal["yaml", "ifpkg"] | None = None
+ include_secret: bool = False
+ workflow_id: str | None = None
+ version_id: UUID | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppReference:
+ id: str
+ name: str
+ mode: str
+ bound_agent_id: str | None
+
+
+@dataclass(frozen=True, slots=True)
+class AppTraceSettings:
+ enabled: bool = False
+ tracing_provider: str | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppCreationSettings:
+ app: dict[str, Any]
+ model_config: dict[str, Any] | None
+
+
+@dataclass(frozen=True, slots=True)
+class AppEvent:
+ id: str
+ tenant_id: str
+ mode: str
+
+
+@dataclass(frozen=True, slots=True)
+class AppDeletion:
+ app: AppEvent
+ workflow_agent_ids: set[str]
+ workspace_ids: list[str]
+ binding_ids: list[str]
+ home_snapshot_ids: list[str]
+ backing_agent_id: str | None
+
+
+@dataclass(frozen=True, slots=True)
+class AppChange:
+ app: AppRecord
+ changed: bool
+
+
+class AppUpdateArguments(TypedDict):
+ name: str
+ description: str
+ icon_type: IconType | str | None
+ icon: str
+ icon_background: str
+ use_icon_as_answer_icon: bool
+ max_active_requests: int
+ role: NotRequired[str | None]
+
+
+@dataclass(frozen=True, slots=True)
+class ImportedAppPackage:
+ app_id: str
+ agent_id: str
+ warnings: list[DslImportWarning]
diff --git a/api/services/entities/dsl_entities.py b/api/services/entities/dsl_entities.py
index 3cdb0d5c42e..cf596114078 100644
--- a/api/services/entities/dsl_entities.py
+++ b/api/services/entities/dsl_entities.py
@@ -1,5 +1,6 @@
+from dataclasses import dataclass
from enum import StrEnum
-from typing import Any
+from typing import Any, Protocol
from pydantic import BaseModel, ConfigDict, Field
@@ -20,6 +21,27 @@ class ImportStatus(StrEnum):
FAILED = "failed"
+class AppImportParams(BaseModel):
+ mode: str = Field(..., description="Import mode")
+ yaml_content: str | None = None
+ yaml_url: str | None = None
+ name: str | None = None
+ description: str | None = None
+ icon_type: str | None = None
+ icon: str | None = None
+ icon_background: str | None = None
+ app_id: str | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class AppDslExportData:
+ """Materialized export input; remote dependencies can be resolved after closing the read transaction."""
+
+ tenant_id: str
+ data: dict[str, Any]
+ dependency_identifiers: list[str]
+
+
class PendingImportOwner(BaseModel):
model_config = ConfigDict(hide_input_in_errors=True)
@@ -39,6 +61,35 @@ class DslImportWarning(BaseModel):
details: dict[str, Any] = Field(default_factory=dict)
+class AppImportPackage(Protocol):
+ """Validated App archive used by import orchestration and resource materialization."""
+
+ dsl: str
+
+ @property
+ def has_resources(self) -> bool: ...
+
+ def materialize_icons(self, *, data: dict[str, Any], tenant_id: str, account_id: str) -> None: ...
+
+ def materialize_agents(
+ self, *, tenant_id: str, account_id: str
+ ) -> tuple[dict[str, Any], list[DslImportWarning]]: ...
+
+ def close(self) -> None: ...
+
+
+class Import(BaseModel):
+ id: str
+ status: ImportStatus
+ app_id: str | None = None
+ app_mode: str | None = None
+ permission_keys: list[str] = Field(default_factory=list)
+ current_dsl_version: str = CURRENT_APP_DSL_VERSION
+ imported_dsl_version: str = ""
+ error: str = ""
+ warnings: list[DslImportWarning] = Field(default_factory=list)
+
+
class CheckDependenciesResult(BaseModel):
leaked_dependencies: list[PluginDependency] = Field(default_factory=list)
diff --git a/api/services/snippet_service.py b/api/services/snippet_service.py
index 51ca4bf9369..18103701581 100644
--- a/api/services/snippet_service.py
+++ b/api/services/snippet_service.py
@@ -41,7 +41,7 @@ from repositories.factory import DifyAPIRepositoryFactory
from services.agent.retirement_service import WorkflowAgentRetirementService
from services.errors.app import IsDraftWorkflowError, WorkflowHashNotEqualError, WorkflowNotFoundError
from services.errors.workflow_service import DraftWorkflowDeletionError, WorkflowInUseError
-from services.tag_service import TagService
+from services.tag_application_service import TagTargetQuery
from services.workflow_node_execution_trace_service import (
WorkflowNodeExecutionTrace,
assemble_workflow_node_execution_traces,
@@ -212,6 +212,7 @@ class SnippetService:
is_published: bool | None = None,
creators: list[str] | None = None,
tag_ids: list[str] | None = None,
+ tags: TagTargetQuery,
) -> tuple[Sequence[CustomizedSnippet], int, bool]:
"""
Get paginated list of snippets with optional search.
@@ -243,7 +244,7 @@ class SnippetService:
stmt = stmt.where(CustomizedSnippet.created_by.in_(creators))
if tag_ids:
- target_ids = TagService.get_target_ids_by_tag_ids("snippet", tenant_id, tag_ids, session, match_all=True)
+ target_ids = tags.find_target_ids(tag_type="snippet", tenant_id=tenant_id, tag_ids=tag_ids, match_all=True)
if target_ids:
stmt = stmt.where(CustomizedSnippet.id.in_(target_ids))
else:
diff --git a/api/services/tag_application_service.py b/api/services/tag_application_service.py
index e599de6295e..f1c46ca4cbe 100644
--- a/api/services/tag_application_service.py
+++ b/api/services/tag_application_service.py
@@ -30,7 +30,13 @@ class TagBindingInput(NamedTuple):
type: TagKind
-class TagStore(Protocol):
+class TagTargetQuery(Protocol):
+ def find_target_ids(
+ self, *, tenant_id: str, tag_type: str, tag_ids: list[str], match_all: bool = False
+ ) -> list[str]: ...
+
+
+class TagStore(TagTargetQuery, Protocol):
def list_tags(self, workspace_id: str, tag_type: str, keyword: str | None) -> Sequence[TagSummary]: ...
def get_tag_type(self, workspace_id: str, tag_id: str) -> str | None: ...
@@ -75,6 +81,11 @@ class TagApplicationService:
def __init__(self, *, tags: TagStore) -> None:
self._tags = tags
+ def find_target_ids(
+ self, *, tenant_id: str, tag_type: str, tag_ids: list[str], match_all: bool = False
+ ) -> list[str]:
+ return self._tags.find_target_ids(tenant_id=tenant_id, tag_type=tag_type, tag_ids=tag_ids, match_all=match_all)
+
def list_tags(self, context: RequestContext, tag_type: str, keyword: str | None = None) -> tuple[TagSummary, ...]:
return tuple(self._tags.list_tags(context.active_workspace_id, tag_type, keyword))
diff --git a/api/services/webapp_access_query_service.py b/api/services/webapp_access_query_service.py
index 0adfc8e3fdc..ea9fe70a42b 100644
--- a/api/services/webapp_access_query_service.py
+++ b/api/services/webapp_access_query_service.py
@@ -50,14 +50,18 @@ class WebAppAccessQueryService:
self._get_access_modes: WebAppAccessModesQuery = get_access_modes
self._get_user_permissions: WebAppUserPermissionsQuery = get_user_permissions
+ def get_app_id_by_code(self, app_code: str) -> str:
+ app_id = self._access.find_app_id_by_code(app_code)
+ if app_id is None:
+ raise WebAppAccessAppNotFoundError(f"App with code {app_code} not found")
+ return app_id
+
def get_access_mode(self, *, app_id: str | None, app_code: str | None) -> WebAppAccessMode:
if not self._webapp_auth_enabled:
return WebAppAccessMode.PUBLIC
if app_code:
- app_id = self._access.find_app_id_by_code(app_code)
- if app_id is None:
- raise WebAppAccessAppNotFoundError
+ app_id = self.get_app_id_by_code(app_code)
if not app_id:
raise WebAppAccessReferenceRequiredError("appId or appCode must be provided")
@@ -65,7 +69,11 @@ class WebAppAccessQueryService:
return self._access_mode_for_app(app_id)
def requires_permission_check(self, app_id: str) -> bool:
- return self._access_mode_for_app(app_id) in _PERMISSION_CHECK_MODES
+ return self.is_permission_check_required(self._access_mode_for_app(app_id))
+
+ @staticmethod
+ def is_permission_check_required(access_mode: str) -> bool:
+ return access_mode in _PERMISSION_CHECK_MODES
def is_user_allowed(self, *, user_id: str, app_id: str) -> bool:
if not self._webapp_auth_enabled:
diff --git a/api/services/webapp_auth_service.py b/api/services/webapp_auth_service.py
index 600c2b5e84f..e26394dba5b 100644
--- a/api/services/webapp_auth_service.py
+++ b/api/services/webapp_auth_service.py
@@ -14,8 +14,6 @@ from models import Account, AccountStatus
from models.enums import EndUserType
from models.model import App, EndUser, Site
from services.account_service import AccountService
-from services.app_service import AppService
-from services.enterprise.enterprise_service import PERMISSION_CHECK_MODES, EnterpriseService
from services.errors.account import AccountLoginError, AccountNotFoundError, AccountPasswordError
from tasks.mail_email_code_login import send_email_code_login_mail_task
@@ -124,26 +122,3 @@ class WebAppAuthService:
token: str = PassportService().issue(payload)
return token
-
- @classmethod
- def is_app_require_permission_check(
- cls, app_code: str | None = None, app_id: str | None = None, access_mode: str | None = None, *, session: Session
- ) -> bool:
- """
- Check if the app requires permission check based on its access mode.
- """
- if access_mode:
- return access_mode in PERMISSION_CHECK_MODES
-
- if not app_code and not app_id:
- raise ValueError("Either app_code or app_id must be provided.")
-
- if app_code:
- app_id = AppService.get_app_id_by_code(app_code, session=session)
- if not app_id:
- raise ValueError("App ID could not be determined from the provided app_code.")
-
- webapp_settings = EnterpriseService.WebAppAuth.get_app_access_mode_by_id(app_id)
- if webapp_settings and webapp_settings.access_mode in PERMISSION_CHECK_MODES:
- return True
- return False
diff --git a/api/tests/test_containers_integration_tests/controllers/openapi/test_app_dsl.py b/api/tests/test_containers_integration_tests/controllers/openapi/test_app_dsl.py
index 39e9ef61be2..fa195f29160 100644
--- a/api/tests/test_containers_integration_tests/controllers/openapi/test_app_dsl.py
+++ b/api/tests/test_containers_integration_tests/controllers/openapi/test_app_dsl.py
@@ -18,6 +18,7 @@ from controllers.openapi.app_dsl import (
AppDslImportApi,
AppDslImportConfirmApi,
)
+from machinery.context import RequestContext
from models import Account, App
from models.model import AppModelConfig
from services.account_service import AccountService, TenantService
@@ -112,7 +113,7 @@ class TestDslImport:
with app.test_request_context(f"/openapi/v1/workspaces/{tenant.id}/apps/imports", method="POST"):
result, code = api.post.__handler__(
api,
- context_for(account, session=db_session_with_containers, view_args={"workspace_id": tenant.id}),
+ RequestContext("test-request", None, account.id, tenant.id),
tenant.id,
body=body,
)
@@ -134,7 +135,7 @@ class TestDslImport:
with app.test_request_context(f"/openapi/v1/workspaces/{tenant.id}/apps/imports", method="POST"):
result, code = api.post.__handler__(
api,
- context_for(account, session=db_session_with_containers, view_args={"workspace_id": tenant.id}),
+ RequestContext("test-request", None, account.id, tenant.id),
tenant.id,
body=body,
)
@@ -159,7 +160,7 @@ class TestDslImport:
with app.test_request_context(f"/openapi/v1/workspaces/{tenant.id}/apps/imports", method="POST"):
result, code = api.post.__handler__(
api,
- context_for(account, session=db_session_with_containers, view_args={"workspace_id": tenant.id}),
+ RequestContext("test-request", None, account.id, tenant.id),
tenant.id,
body=body,
)
@@ -185,11 +186,7 @@ class TestDslImportConfirm:
):
result, code = api.post.__handler__(
api,
- context_for(
- account,
- session=db_session_with_containers,
- view_args={"workspace_id": tenant.id, "import_id": import_id},
- ),
+ RequestContext("test-request", None, account.id, tenant.id),
tenant.id,
import_id,
)
@@ -262,7 +259,7 @@ class TestDslCheckDependencies:
with app.test_request_context(f"/openapi/v1/apps/{app_model.id}/dependencies:check"):
result, code = api.get.__handler__(
api,
- context_for(account, session=db_session_with_containers, view_args={"app_id": app_model.id}),
+ RequestContext("test-request", None, account.id, app_model.tenant_id),
app_model.id,
)
diff --git a/api/tests/test_containers_integration_tests/controllers/web/test_wraps.py b/api/tests/test_containers_integration_tests/controllers/web/test_wraps.py
index 5bda3738af5..394ea794185 100644
--- a/api/tests/test_containers_integration_tests/controllers/web/test_wraps.py
+++ b/api/tests/test_containers_integration_tests/controllers/web/test_wraps.py
@@ -114,7 +114,9 @@ class TestValidateUserAccessibility:
)
@patch("controllers.web.wraps.EnterpriseService.get_app_sso_settings_last_update_time")
- @patch("controllers.web.wraps.WebAppAuthService.is_app_require_permission_check", return_value=False)
+ @patch(
+ "services.webapp_access_query_service.WebAppAccessQueryService.is_permission_check_required", return_value=False
+ )
def test_external_auth_type_checks_sso_update_time(
self, mock_perm_check: MagicMock, mock_sso_time: MagicMock
) -> None:
@@ -132,7 +134,9 @@ class TestValidateUserAccessibility:
)
@patch("controllers.web.wraps.EnterpriseService.get_workspace_sso_settings_last_update_time")
- @patch("controllers.web.wraps.WebAppAuthService.is_app_require_permission_check", return_value=False)
+ @patch(
+ "services.webapp_access_query_service.WebAppAccessQueryService.is_permission_check_required", return_value=False
+ )
def test_internal_auth_type_checks_workspace_sso_update_time(
self, mock_perm_check: MagicMock, mock_workspace_sso: MagicMock
) -> None:
@@ -150,7 +154,9 @@ class TestValidateUserAccessibility:
)
@patch("controllers.web.wraps.EnterpriseService.get_app_sso_settings_last_update_time")
- @patch("controllers.web.wraps.WebAppAuthService.is_app_require_permission_check", return_value=False)
+ @patch(
+ "services.webapp_access_query_service.WebAppAccessQueryService.is_permission_check_required", return_value=False
+ )
def test_external_auth_passes_when_granted_after_sso_update(
self, mock_perm_check: MagicMock, mock_sso_time: MagicMock
) -> None:
@@ -167,8 +173,10 @@ class TestValidateUserAccessibility:
)
@patch("controllers.web.wraps.EnterpriseService.WebAppAuth.is_user_allowed_to_access_webapp", return_value=False)
- @patch("controllers.web.wraps.AppService.get_app_id_by_code", return_value="app-id-1")
- @patch("controllers.web.wraps.WebAppAuthService.is_app_require_permission_check", return_value=True)
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.get_app_id_by_code", return_value="app-id-1")
+ @patch(
+ "services.webapp_access_query_service.WebAppAccessQueryService.is_permission_check_required", return_value=True
+ )
def test_permission_check_denies_unauthorized_user(
self, mock_perm: MagicMock, mock_app_id: MagicMock, mock_allowed: MagicMock
) -> None:
@@ -192,7 +200,7 @@ class TestValidateUserAccessibility:
],
)
@patch("controllers.web.wraps.EnterpriseService.WebAppAuth.is_user_allowed_to_access_webapp")
- @patch("controllers.web.wraps.WebAppAuthService.is_app_require_permission_check")
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.is_permission_check_required")
def test_auth_type_must_match_current_access_mode(
self,
mock_permission_check: MagicMock,
@@ -261,7 +269,7 @@ class TestDecodeJwtToken:
@patch("controllers.web.wraps._validate_user_accessibility")
@patch("controllers.web.wraps._validate_webapp_token")
@patch("controllers.web.wraps.EnterpriseService.WebAppAuth.get_app_access_mode_by_id")
- @patch("controllers.web.wraps.AppService.get_app_id_by_code")
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.get_app_id_by_code")
@patch("controllers.web.wraps.SystemFeatureService.is_webapp_auth_enabled")
@patch("controllers.web.wraps.PassportService")
@patch("controllers.web.wraps.extract_webapp_passport")
diff --git a/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py b/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
index 74f9572bb34..f1e104c98c1 100644
--- a/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
+++ b/api/tests/test_containers_integration_tests/services/test_app_dsl_service.py
@@ -863,18 +863,32 @@ class TestAppDslService:
# ── Export ─────────────────────────────────────────────────────────
- def test_export_dsl_delegates_by_mode(self, monkeypatch: pytest.MonkeyPatch, db_session_with_containers: Session):
+ def test_export_dsl_delegates_by_mode(
+ self,
+ monkeypatch: pytest.MonkeyPatch,
+ db_session_with_containers: Session,
+ mock_external_service_dependencies,
+ ):
workflow_calls: list[bool] = []
model_calls: list[bool] = []
+
+ def append_workflow(**_kwargs: Any) -> list[str]:
+ workflow_calls.append(True)
+ return []
+
+ def append_model(*_args: Any, **_kwargs: Any) -> list[str]:
+ model_calls.append(True)
+ return []
+
monkeypatch.setattr(
AppDslService,
"_append_workflow_export_data",
- lambda **_kwargs: workflow_calls.append(True),
+ append_workflow,
)
monkeypatch.setattr(
AppDslService,
"_append_model_config_export_data",
- lambda *_args, **_kwargs: model_calls.append(True),
+ append_model,
)
workflow_app = _app_stub(
@@ -893,12 +907,15 @@ class TestAppDslService:
assert model_calls == [True]
def test_export_dsl_preserves_icon_and_icon_type(
- self, monkeypatch: pytest.MonkeyPatch, db_session_with_containers: Session
+ self,
+ monkeypatch: pytest.MonkeyPatch,
+ db_session_with_containers: Session,
+ mock_external_service_dependencies,
):
monkeypatch.setattr(
AppDslService,
"_append_workflow_export_data",
- lambda **_kwargs: None,
+ lambda **_kwargs: [],
)
emoji_app = _app_stub(
@@ -1393,22 +1410,8 @@ class TestAppDslService:
"_extract_dependencies_from_workflow",
lambda *_args, **_kwargs: ["dep-1"],
)
- monkeypatch.setattr(
- app_dsl_service.DependenciesAnalysisService,
- "generate_dependencies",
- lambda *, tenant_id, dependencies: [
- SimpleNamespace(
- model_dump=lambda: {
- "tenant": tenant_id,
- "dep": dependencies[0],
- }
- )
- ],
- )
- monkeypatch.setattr(app_dsl_service, "jsonable_encoder", lambda x: x)
-
export_data: dict = {}
- AppDslService._append_workflow_export_data(
+ dependencies = AppDslService._append_workflow_export_data(
export_data=export_data,
app_model=_app_stub(),
include_secret=False,
@@ -1427,7 +1430,7 @@ class TestAppDslService:
assert nodes[4]["data"]["webhook_url"] == ""
assert nodes[4]["data"]["webhook_debug_url"] == ""
assert nodes[5]["data"]["subscription_id"] == ""
- assert export_data["dependencies"] == [{"tenant": _DEFAULT_TENANT_ID, "dep": "dep-1"}]
+ assert dependencies == ["dep-1"]
def test_append_workflow_export_data_missing_workflow_raises(
self, monkeypatch: pytest.MonkeyPatch, db_session_with_containers: Session
@@ -1453,20 +1456,6 @@ class TestAppDslService:
"_extract_dependencies_from_model_config",
lambda *_args, **_kwargs: ["dep-1"],
)
- monkeypatch.setattr(
- app_dsl_service.DependenciesAnalysisService,
- "generate_dependencies",
- lambda *, tenant_id, dependencies: [
- SimpleNamespace(
- model_dump=lambda: {
- "tenant": tenant_id,
- "dep": dependencies[0],
- }
- )
- ],
- )
- monkeypatch.setattr(app_dsl_service, "jsonable_encoder", lambda x: x)
-
app_model_config = MagicMock(app_id="app-1")
app_model_config.to_dict.return_value = {"agent_mode": {"tools": [{"credential_id": "secret"}]}}
app_model = _app_stub(id="app-1", app_model_config_id="config-1")
@@ -1476,9 +1465,9 @@ class TestAppDslService:
monkeypatch.setattr(app_dsl_service, "load_annotation_reply_config", lambda *_args: annotation_reply)
export_data: dict = {}
- AppDslService._append_model_config_export_data(export_data, app_model, session=session)
+ dependencies = AppDslService._append_model_config_export_data(export_data, app_model, session=session)
assert export_data["model_config"]["agent_mode"]["tools"] == [{}]
- assert export_data["dependencies"] == [{"tenant": _DEFAULT_TENANT_ID, "dep": "dep-1"}]
+ assert dependencies == ["dep-1"]
session.get.assert_called_once_with(AppModelConfig, "config-1")
app_model_config.to_dict.assert_called_once_with(annotation_reply=annotation_reply)
diff --git a/api/tests/test_containers_integration_tests/services/test_app_service.py b/api/tests/test_containers_integration_tests/services/test_app_service.py
index 76a67efb3b6..d0aff28dec4 100644
--- a/api/tests/test_containers_integration_tests/services/test_app_service.py
+++ b/api/tests/test_containers_integration_tests/services/test_app_service.py
@@ -9,8 +9,8 @@ from sqlalchemy.orm import Session
from constants.model_template import default_app_templates
from models import Account
-from models.enums import AppStatus, CustomizeTokenStrategy
-from models.model import App, IconType, Site
+from models.model import App, IconType
+from repositories.app.console_repository import ConsoleAppRepository
from services.account_service import AccountService, TenantService
from tests.test_containers_integration_tests.helpers import generate_valid_password
@@ -373,8 +373,8 @@ class TestAppService:
session=db_session_with_containers,
)
- app_service.star_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
- app_service.star_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
+ ConsoleAppRepository.star_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
+ ConsoleAppRepository.star_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
db_session_with_containers.commit()
star_count = db_session_with_containers.scalar(
@@ -390,7 +390,7 @@ class TestAppService:
assert starred_by_app_id[starred_app.id] is True
assert starred_by_app_id[unstarred_app.id] is False
- app_service.unstar_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
+ ConsoleAppRepository.unstar_app(app=starred_app, account_id=account.id, session=db_session_with_containers)
db_session_with_containers.commit()
paginated_apps = app_service.get_paginate_apps(
@@ -419,7 +419,8 @@ class TestAppService:
TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
tenant = account.current_tenant
- from services.app_service import AppService, CreateAppParams, StarredAppListParams
+ from services.app_service import AppService, CreateAppParams
+ from services.entities.app_entities import StarredAppListParams
app_service = AppService()
oldest_created_app = app_service.create_app(
@@ -447,9 +448,11 @@ class TestAppService:
session=db_session_with_containers,
)
- app_service.star_app(app=oldest_created_app, account_id=account.id, session=db_session_with_containers)
- app_service.star_app(app=newest_modified_app, account_id=account.id, session=db_session_with_containers)
- app_service.star_app(app=newest_created_app, account_id=account.id, session=db_session_with_containers)
+ ConsoleAppRepository.star_app(app=oldest_created_app, account_id=account.id, session=db_session_with_containers)
+ ConsoleAppRepository.star_app(
+ app=newest_modified_app, account_id=account.id, session=db_session_with_containers
+ )
+ ConsoleAppRepository.star_app(app=newest_created_app, account_id=account.id, session=db_session_with_containers)
timestamp_by_app_id = {
oldest_created_app.id: (datetime(2026, 1, 1, 10, 0, 0), datetime(2026, 1, 1, 10, 0, 0)),
@@ -463,7 +466,7 @@ class TestAppService:
)
db_session_with_containers.commit()
- last_modified_apps = app_service.get_paginate_starred_apps(
+ last_modified_apps = ConsoleAppRepository.get_paginate_starred_apps(
account.id, tenant.id, StarredAppListParams(page=1, limit=10, mode="chat"), db_session_with_containers
)
assert last_modified_apps is not None
@@ -475,7 +478,7 @@ class TestAppService:
assert all(app.is_starred for app in last_modified_apps.items)
assert unstarred_app.id not in {app.id for app in last_modified_apps.items}
- recently_created_apps = app_service.get_paginate_starred_apps(
+ recently_created_apps = ConsoleAppRepository.get_paginate_starred_apps(
account.id,
tenant.id,
StarredAppListParams(page=1, limit=10, mode="chat", sort_by="recently_created"),
@@ -488,7 +491,7 @@ class TestAppService:
"Oldest Created Starred App",
]
- earliest_created_apps = app_service.get_paginate_starred_apps(
+ earliest_created_apps = ConsoleAppRepository.get_paginate_starred_apps(
account.id,
tenant.id,
StarredAppListParams(page=1, limit=10, mode="chat", sort_by="earliest_created"),
@@ -875,182 +878,6 @@ class TestAppService:
session=db_session_with_containers,
)
- def test_update_app_name_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
- """
- Test successful app name update.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_params = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🎯",
- icon_background="#45B7D1",
- )
-
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_params, account, session=db_session_with_containers)
-
- # Store original name
- original_name = app.name
-
- # Update app name
- new_name = "New App Name"
- mock_current_user = create_autospec(Account, instance=True)
- mock_current_user.id = account.id
- mock_current_user.current_tenant_id = account.current_tenant_id
-
- with patch("services.app_service.current_user", mock_current_user):
- updated_app = app_service.update_app_name(app, new_name, session=db_session_with_containers)
-
- assert updated_app.name == new_name
- assert updated_app.updated_by == account.id
-
- # Verify other fields remain unchanged
- assert updated_app.description == app.description
- assert updated_app.mode == app.mode
- assert updated_app.tenant_id == app.tenant_id
- assert updated_app.created_by == app.created_by
-
- def test_update_app_icon_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
- """
- Test successful app icon update.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_params = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🎯",
- icon_background="#45B7D1",
- )
-
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_params, account, session=db_session_with_containers)
-
- # Store original values
- original_icon = app.icon
- original_icon_background = app.icon_background
-
- # Update app icon
- new_icon = "🌟"
- new_icon_background = "#FFD93D"
- new_icon_type = "image"
- mock_current_user = create_autospec(Account, instance=True)
- mock_current_user.id = account.id
- mock_current_user.current_tenant_id = account.current_tenant_id
-
- with patch("services.app_service.current_user", mock_current_user):
- updated_app = app_service.update_app_icon(
- app, new_icon, new_icon_background, new_icon_type, session=db_session_with_containers
- )
-
- assert updated_app.icon == new_icon
- assert updated_app.icon_background == new_icon_background
- assert str(updated_app.icon_type).lower() == new_icon_type
- assert updated_app.updated_by == account.id
-
- # Verify other fields remain unchanged
- assert updated_app.name == app.name
- assert updated_app.description == app.description
- assert updated_app.mode == app.mode
- assert updated_app.tenant_id == app.tenant_id
- assert updated_app.created_by == app.created_by
-
- def test_update_app_site_status_success(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test successful app site status update.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_args = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🌐",
- icon_background="#74B9FF",
- )
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_args, account, session=db_session_with_containers)
-
- # Store original site status
- original_site_status = app.enable_site
-
- # Update site status to disabled
- mock_current_user = create_autospec(Account, instance=True)
- mock_current_user.id = account.id
- mock_current_user.current_tenant_id = account.current_tenant_id
-
- with patch("services.app_service.current_user", mock_current_user):
- updated_app = app_service.update_app_site_status(app, False, session=db_session_with_containers)
- assert updated_app.enable_site is False
- assert updated_app.updated_by == account.id
-
- # Update site status back to enabled
- with patch("services.app_service.current_user", mock_current_user):
- updated_app = app_service.update_app_site_status(updated_app, True, session=db_session_with_containers)
- assert updated_app.enable_site is True
- assert updated_app.updated_by == account.id
-
- # Verify other fields remain unchanged
- assert updated_app.name == app.name
- assert updated_app.description == app.description
- assert updated_app.mode == app.mode
- assert updated_app.tenant_id == app.tenant_id
- assert updated_app.created_by == app.created_by
-
def test_update_app_api_status_success(
self, db_session_with_containers: Session, mock_external_service_dependencies
):
@@ -1111,59 +938,6 @@ class TestAppService:
assert updated_app.tenant_id == app.tenant_id
assert updated_app.created_by == app.created_by
- def test_update_app_site_status_no_change(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test app site status update when status doesn't change.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_args = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🔄",
- icon_background="#FD79A8",
- )
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_args, account, session=db_session_with_containers)
-
- # Store original values
- original_site_status = app.enable_site
- original_updated_at = app.updated_at
-
- # Update site status to the same value (no change)
- updated_app = app_service.update_app_site_status(app, original_site_status, session=db_session_with_containers)
-
- # Verify app is returned unchanged
- assert updated_app.id == app.id
- assert updated_app.enable_site == original_site_status
- assert updated_app.updated_at == original_updated_at
-
- # Verify other fields remain unchanged
- assert updated_app.name == app.name
- assert updated_app.description == app.description
- assert updated_app.mode == app.mode
- assert updated_app.tenant_id == app.tenant_id
- assert updated_app.created_by == app.created_by
-
def test_delete_app_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
"""
Test successful app deletion.
@@ -1274,97 +1048,6 @@ class TestAppService:
deleted_app = db_session_with_containers.query(App).filter_by(id=app_id).first()
assert deleted_app is None
- def test_get_app_code_by_id_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
- """
- Test successful app code retrieval by app ID.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_args = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🔗",
- icon_background="#FDCB6E",
- )
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_args, account, session=db_session_with_containers)
-
- # Get app code by ID
- app_code = AppService.get_app_code_by_id(app.id, session=db_session_with_containers)
-
- # Verify app code was retrieved correctly
- # Note: Site would be created when App is created, site.code is auto-generated
- assert app_code is not None
- assert len(app_code) > 0
-
- def test_get_app_id_by_code_success(self, db_session_with_containers: Session, mock_external_service_dependencies):
- """
- Test successful app ID retrieval by app code.
- """
- fake = Faker()
-
- # Create account and tenant first
- account = AccountService.create_account(
- email=fake.email(),
- name=fake.name(),
- interface_language="en-US",
- password=generate_valid_password(fake),
- session=db_session_with_containers,
- )
- TenantService.create_owner_tenant_if_not_exist(account, name=fake.company(), session=db_session_with_containers)
- tenant = account.current_tenant
-
- # Create app first
- # Import here to avoid circular dependency
- from services.app_service import AppService, CreateAppParams
-
- app_args = CreateAppParams(
- name=fake.company(),
- description=fake.text(max_nb_chars=100),
- mode="chat",
- icon_type="emoji",
- icon="🆔",
- icon_background="#E84393",
- )
- app_service = AppService()
- app = app_service.create_app(tenant.id, app_args, account, session=db_session_with_containers)
-
- # Create a site for the app
- site = Site(
- app_id=app.id,
- code=fake.postalcode(),
- title=fake.company(),
- status=AppStatus.NORMAL,
- default_language="en-US",
- customize_token_strategy=CustomizeTokenStrategy.UUID,
- )
-
- db_session_with_containers.add(site)
- db_session_with_containers.commit()
-
- # Get app ID by code
- app_id = AppService.get_app_id_by_code(site.code, session=db_session_with_containers)
-
- # Verify app ID was retrieved correctly
- assert app_id == app.id
-
def test_create_app_invalid_mode(self, db_session_with_containers: Session, mock_external_service_dependencies):
"""
Test app creation with invalid mode.
@@ -1530,23 +1213,3 @@ class TestAppService:
assert paginated_apps is not None
assert paginated_apps.total == 1
assert all("50%" in app.name for app in paginated_apps.items)
-
- def test_get_app_code_by_id_not_found(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """Test get_app_code_by_id raises ValueError when site is missing."""
- from uuid import uuid4
-
- from services.app_service import AppService
-
- with pytest.raises(ValueError, match="not found"):
- AppService.get_app_code_by_id(str(uuid4()), session=db_session_with_containers)
-
- def test_get_app_id_by_code_not_found(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """Test get_app_id_by_code raises ValueError when code does not exist."""
- from services.app_service import AppService
-
- with pytest.raises(ValueError, match="not found"):
- AppService.get_app_id_by_code("nonexistent-code", session=db_session_with_containers)
diff --git a/api/tests/test_containers_integration_tests/services/test_dataset_service_retrieval.py b/api/tests/test_containers_integration_tests/services/test_dataset_service_retrieval.py
index 2ee72415137..ed8e11e52c4 100644
--- a/api/tests/test_containers_integration_tests/services/test_dataset_service_retrieval.py
+++ b/api/tests/test_containers_integration_tests/services/test_dataset_service_retrieval.py
@@ -16,6 +16,7 @@ from uuid import uuid4
from sqlalchemy.orm import Session
from core.rag.index_processor.constant.index_type import IndexTechniqueType
+from extensions.ext_application_services import application_services
from models import AccountStatus, CreatorUserRole, TenantStatus
from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
from models.dataset import (
@@ -228,7 +229,9 @@ class TestDatasetServiceGetDatasets:
)
# Act
- datasets, total = DatasetService.get_datasets(page, per_page, db_session_with_containers, tenant_id=tenant.id)
+ datasets, total = DatasetService.get_datasets(
+ page, per_page, db_session_with_containers, tenant_id=tenant.id, tags=application_services().tags
+ )
# Assert
assert len(datasets) == 5
@@ -259,7 +262,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page, per_page, db_session_with_containers, tenant_id=tenant.id, search=search
+ page,
+ per_page,
+ db_session_with_containers,
+ tenant_id=tenant.id,
+ search=search,
+ tags=application_services().tags,
)
# Assert
@@ -305,7 +313,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page, per_page, db_session_with_containers, tenant_id=tenant.id, tag_ids=tag_ids
+ page,
+ per_page,
+ db_session_with_containers,
+ tenant_id=tenant.id,
+ tag_ids=tag_ids,
+ tags=application_services().tags,
)
# Assert
@@ -332,7 +345,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page, per_page, db_session_with_containers, tenant_id=tenant.id, tag_ids=tag_ids
+ page,
+ per_page,
+ db_session_with_containers,
+ tenant_id=tenant.id,
+ tag_ids=tag_ids,
+ tags=application_services().tags,
)
# Assert
@@ -364,7 +382,7 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page, per_page, db_session_with_containers, tenant_id=tenant.id, user=None
+ page, per_page, db_session_with_containers, tenant_id=tenant.id, user=None, tags=application_services().tags
)
# Assert
@@ -397,6 +415,7 @@ class TestDatasetServiceGetDatasets:
tenant_id=tenant.id,
user=owner,
include_all=True,
+ tags=application_services().tags,
)
# Assert
@@ -419,7 +438,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page=1, per_page=20, session=db_session_with_containers, tenant_id=tenant.id, user=user
+ page=1,
+ per_page=20,
+ session=db_session_with_containers,
+ tenant_id=tenant.id,
+ user=user,
+ tags=application_services().tags,
)
# Assert
@@ -445,7 +469,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page=1, per_page=20, session=db_session_with_containers, tenant_id=tenant.id, user=user
+ page=1,
+ per_page=20,
+ session=db_session_with_containers,
+ tenant_id=tenant.id,
+ user=user,
+ tags=application_services().tags,
)
# Assert
@@ -474,7 +503,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page=1, per_page=20, session=db_session_with_containers, tenant_id=tenant.id, user=user
+ page=1,
+ per_page=20,
+ session=db_session_with_containers,
+ tenant_id=tenant.id,
+ user=user,
+ tags=application_services().tags,
)
# Assert
@@ -503,7 +537,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page=1, per_page=20, session=db_session_with_containers, tenant_id=tenant.id, user=operator
+ page=1,
+ per_page=20,
+ session=db_session_with_containers,
+ tenant_id=tenant.id,
+ user=operator,
+ tags=application_services().tags,
)
# Assert
@@ -528,7 +567,12 @@ class TestDatasetServiceGetDatasets:
# Act
datasets, total = DatasetService.get_datasets(
- page=1, per_page=20, session=db_session_with_containers, tenant_id=tenant.id, user=operator
+ page=1,
+ per_page=20,
+ session=db_session_with_containers,
+ tenant_id=tenant.id,
+ user=operator,
+ tags=application_services().tags,
)
# Assert
diff --git a/api/tests/test_containers_integration_tests/services/test_tag_service.py b/api/tests/test_containers_integration_tests/services/test_tag_service.py
index 86b635ac23d..65239609a2a 100644
--- a/api/tests/test_containers_integration_tests/services/test_tag_service.py
+++ b/api/tests/test_containers_integration_tests/services/test_tag_service.py
@@ -9,6 +9,7 @@ from sqlalchemy.orm import Session
from werkzeug.exceptions import NotFound
from core.rag.index_processor.constant.index_type import IndexTechniqueType
+from extensions.ext_application_services import application_services
from models import Account, AccountStatus, Tenant, TenantAccountJoin, TenantAccountRole, TenantStatus
from models.dataset import Dataset
from models.enums import DataSourceType, TagType
@@ -338,8 +339,12 @@ def test_get_target_ids_by_tag_ids_success(
db_session_with_containers, tags=tags_to_bind, target_id=dataset.id, tenant_id=tenant.id, user_id=account.id
)
+ # The application service reads through its own repository session.
+ db_session_with_containers.commit()
tag_ids = [tag.id for tag in tags]
- result = TagService.get_target_ids_by_tag_ids(TagType.KNOWLEDGE, tenant.id, tag_ids, db_session_with_containers)
+ result = application_services().tags.find_target_ids(
+ tag_type=TagType.KNOWLEDGE, tenant_id=tenant.id, tag_ids=tag_ids
+ )
assert result is not None
assert len(result) == 3
@@ -361,7 +366,7 @@ def test_get_target_ids_by_tag_ids_empty_tag_ids(
account, tenant = _create_account_with_tenant(db_session_with_containers)
_set_current_user(current_user_stub, account, tenant)
- result = TagService.get_target_ids_by_tag_ids(TagType.KNOWLEDGE, tenant.id, [], db_session_with_containers)
+ result = application_services().tags.find_target_ids(tag_type=TagType.KNOWLEDGE, tenant_id=tenant.id, tag_ids=[])
assert result == []
@@ -372,7 +377,7 @@ def test_get_target_ids_by_tag_ids_empty_snippet_tag_ids(
account, tenant = _create_account_with_tenant(db_session_with_containers)
_set_current_user(current_user_stub, account, tenant)
- result = TagService.get_target_ids_by_tag_ids(TagType.SNIPPET, tenant.id, [], db_session_with_containers)
+ result = application_services().tags.find_target_ids(tag_type=TagType.SNIPPET, tenant_id=tenant.id, tag_ids=[])
assert result == []
@@ -402,19 +407,17 @@ def test_get_target_ids_by_tag_ids_match_all(
user_id=account.id,
)
+ # The application service reads through its own repository session.
+ db_session_with_containers.commit()
tag_ids = [tag.id for tag in tags]
- result = TagService.get_target_ids_by_tag_ids(
- TagType.KNOWLEDGE, tenant.id, tag_ids, db_session_with_containers, match_all=True
+ result = application_services().tags.find_target_ids(
+ tag_type=TagType.KNOWLEDGE, tenant_id=tenant.id, tag_ids=tag_ids, match_all=True
)
assert result == [dataset_with_all_tags.id]
- missing_tag_result = TagService.get_target_ids_by_tag_ids(
- TagType.KNOWLEDGE,
- tenant.id,
- [tags[0].id, str(uuid.uuid4())],
- db_session_with_containers,
- match_all=True,
+ missing_tag_result = application_services().tags.find_target_ids(
+ tag_type=TagType.KNOWLEDGE, tenant_id=tenant.id, tag_ids=[tags[0].id, str(uuid.uuid4())], match_all=True
)
assert missing_tag_result == []
@@ -427,8 +430,8 @@ def test_get_target_ids_by_tag_ids_no_matching_tags(
non_existent_tag_ids = [str(uuid.uuid4()), str(uuid.uuid4())]
- result = TagService.get_target_ids_by_tag_ids(
- TagType.KNOWLEDGE, tenant.id, non_existent_tag_ids, db_session_with_containers
+ result = application_services().tags.find_target_ids(
+ tag_type=TagType.KNOWLEDGE, tenant_id=tenant.id, tag_ids=non_existent_tag_ids
)
assert result == []
diff --git a/api/tests/test_containers_integration_tests/services/test_webapp_auth_service.py b/api/tests/test_containers_integration_tests/services/test_webapp_auth_service.py
index b9bc82f4132..6242a574226 100644
--- a/api/tests/test_containers_integration_tests/services/test_webapp_auth_service.py
+++ b/api/tests/test_containers_integration_tests/services/test_webapp_auth_service.py
@@ -1,6 +1,6 @@
import time
import uuid
-from unittest.mock import ANY, patch
+from unittest.mock import patch
import pytest
from faker import Faker
@@ -26,26 +26,16 @@ class TestWebAppAuthService:
patch("services.webapp_auth_service.PassportService") as mock_passport_service,
patch("services.webapp_auth_service.TokenManager") as mock_token_manager,
patch("services.webapp_auth_service.send_email_code_login_mail_task") as mock_mail_task,
- patch("services.webapp_auth_service.AppService") as mock_app_service,
- patch("services.webapp_auth_service.EnterpriseService") as mock_enterprise_service,
):
# Setup default mock returns
mock_passport_service.return_value.issue.return_value = "mock_jwt_token"
mock_token_manager.generate_token.return_value = "mock_token"
mock_token_manager.get_token_data.return_value = {"code": "123456"}
mock_mail_task.delay.return_value = None
- mock_app_service.get_app_id_by_code.return_value = "mock_app_id"
- mock_enterprise_service.WebAppAuth.get_app_access_mode_by_id.return_value = type(
- "MockWebAppAuth", (), {"access_mode": "private"}
- )()
- # Note: get_app_access_mode_by_code method was removed in refactoring
-
yield {
"passport_service": mock_passport_service,
"token_manager": mock_token_manager,
"mail_task": mock_mail_task,
- "app_service": mock_app_service,
- "enterprise_service": mock_enterprise_service,
}
def _create_test_account_and_tenant(self, db_session_with_containers: Session, mock_external_service_dependencies):
@@ -736,93 +726,3 @@ class TestWebAppAuthService:
WebAppAuthService.create_end_user(site.code, "[email protected]", db_session_with_containers)
assert "App not found." in str(exc_info.value)
-
- def test_is_app_require_permission_check_with_access_mode_private(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test permission check requirement for private access mode.
-
- This test verifies:
- - Proper permission check requirement for private mode
- - Correct return value
- - Mock service integration
- """
- # Arrange: Setup test with private access mode
-
- # Act: Execute permission check requirement test
- result = WebAppAuthService.is_app_require_permission_check(
- access_mode="private", session=db_session_with_containers
- )
-
- # Assert: Verify correct result
- assert result is True
-
- def test_is_app_require_permission_check_with_access_mode_public(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test permission check requirement for public access mode.
-
- This test verifies:
- - Proper permission check requirement for public mode
- - Correct return value
- - Mock service integration
- """
- # Arrange: Setup test with public access mode
-
- # Act: Execute permission check requirement test
- result = WebAppAuthService.is_app_require_permission_check(
- access_mode="public", session=db_session_with_containers
- )
-
- # Assert: Verify correct result
- assert result is False
-
- def test_is_app_require_permission_check_with_app_code(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test permission check requirement using app code.
-
- This test verifies:
- - Proper permission check requirement using app code
- - Correct return value
- - Mock service integration
- """
- # Arrange: Setup mock for app service
- mock_external_service_dependencies["app_service"].get_app_id_by_code.return_value = "mock_app_id"
-
- # Act: Execute permission check requirement test
- result = WebAppAuthService.is_app_require_permission_check(
- app_code="mock_app_code", session=db_session_with_containers
- )
-
- # Assert: Verify correct result
- assert result is True
-
- # Verify mock service was called correctly
- mock_external_service_dependencies["app_service"].get_app_id_by_code.assert_called_once_with(
- "mock_app_code", session=ANY
- )
- mock_external_service_dependencies[
- "enterprise_service"
- ].WebAppAuth.get_app_access_mode_by_id.assert_called_once_with("mock_app_id")
-
- def test_is_app_require_permission_check_no_parameters(
- self, db_session_with_containers: Session, mock_external_service_dependencies
- ):
- """
- Test permission check requirement with no parameters.
-
- This test verifies:
- - Proper error handling when no parameters provided
- - Correct exception type and message
- """
- # Arrange: No parameters provided
-
- # Act & Assert: Verify proper error handling
- with pytest.raises(ValueError) as exc_info:
- WebAppAuthService.is_app_require_permission_check(session=db_session_with_containers)
-
- assert "Either app_code or app_id must be provided." in str(exc_info.value)
diff --git a/api/tests/unit_tests/conftest.py b/api/tests/unit_tests/conftest.py
index 6b164bae118..059c7621f1a 100644
--- a/api/tests/unit_tests/conftest.py
+++ b/api/tests/unit_tests/conftest.py
@@ -1,7 +1,10 @@
+from __future__ import annotations
+
import os
import shutil
from collections.abc import Callable, Iterator
from pathlib import Path
+from typing import TYPE_CHECKING
from unittest.mock import MagicMock, patch
import pytest
@@ -43,6 +46,10 @@ from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
from models.base import TypeBase
from tests.unit_tests.config_override import apply_config_overrides
+if TYPE_CHECKING:
+ from extensions.application_services.app import AppServices
+ from services.tag_application_service import TagApplicationService
+
def _patch_redis_clients_on_loaded_modules() -> None:
"""Ensure any module-level redis_client references point to the shared redis_mock."""
@@ -239,3 +246,23 @@ def persist_service_api_dataset_owner(
"""Persist the tenant-owner mapping resolved by dataset-token authentication."""
session.add_all([tenant, tenant_account_join])
session.commit()
+
+
+def app_services(sqlite_session_factory: sessionmaker[Session]) -> AppServices:
+ from extensions.application_services.app import build_app_services
+ from extensions.ext_application_services import _build_oauth_server_service
+ from extensions.ext_redis import redis_client
+
+ return build_app_services(
+ database_client=sqlite_session_factory,
+ oauth=_build_oauth_server_service(database_client=sqlite_session_factory, redis=redis_client),
+ )
+
+
+def application_tags(sqlite_session_factory: sessionmaker[Session]) -> TagApplicationService:
+ from repositories.tag_repository import TagRepository
+ from services.tag_application_service import TagApplicationService
+
+ return TagApplicationService(tags=TagRepository(sqlite_session_factory))
diff --git a/api/tests/unit_tests/controllers/common/test_app_access.py b/api/tests/unit_tests/controllers/common/test_app_access.py
index 940a7ee909c..1a1d85ec098 100644
--- a/api/tests/unit_tests/controllers/common/test_app_access.py
+++ b/api/tests/unit_tests/controllers/common/test_app_access.py
@@ -1,17 +1,16 @@
-"""Unit tests for controllers.common.app_access RBAC app-id access filtering."""
+"""Unit tests for services.app.access RBAC app-id access filtering."""
from __future__ import annotations
import pytest
from sqlalchemy.orm import Session
-from controllers.common.app_access import (
+from services.app.access import (
APP_LIST_PERMISSION_KEYS,
AppAccessFilter,
has_app_list_permission,
resolve_app_access_filter,
)
-from services.app_service import AppListParams
from services.enterprise.rbac_service import (
MyPermissionsResponse,
ResourcePermissionKeys,
@@ -19,8 +18,9 @@ from services.enterprise.rbac_service import (
ResourceWhitelistResources,
WorkspacePermissionSnapshot,
)
+from services.entities.app_entities import AppListParams
-_RBAC_MODULE = "controllers.common.app_access.enterprise_rbac_service"
+_RBAC_MODULE = "services.app.access.enterprise_rbac_service"
def _permissions(
diff --git a/api/tests/unit_tests/controllers/conftest.py b/api/tests/unit_tests/controllers/conftest.py
new file mode 100644
index 00000000000..c24a06ff520
--- /dev/null
+++ b/api/tests/unit_tests/controllers/conftest.py
@@ -0,0 +1,65 @@
+"""Explicit App service composition for controller tests that use app queries."""
+
+from dataclasses import dataclass
+
+import pytest
+from flask import Flask
+from sqlalchemy.orm import Session, sessionmaker
+
+from extensions.application_services.app import AppServices
+from extensions.ext_application_services import (
+ _batch_get_enterprise_webapp_access_modes,
+ _batch_get_enterprise_webapp_user_permissions,
+ _get_enterprise_webapp_access_mode,
+ _is_enterprise_webapp_user_allowed,
+)
+from repositories.app.console_repository import ConsoleAppRepository
+from repositories.webapp_access_query_repository import WebAppAccessQueryRepository
+from services.app.console_service import ConsoleAppService
+from services.app.import_service import AppImportService
+from services.app.query_service import AppQueryService
+from services.tag_application_service import TagApplicationService
+from services.webapp_access_query_service import WebAppAccessQueryService
+
+
+@dataclass
+class AppQueryTestServices:
+ console: ConsoleAppService
+ imports: AppImportService
+ queries: AppQueryService
+
+
+@dataclass(frozen=True)
+class ControllerTestServices:
+ apps: AppQueryTestServices
+ tags: TagApplicationService
+ webapp_access: WebAppAccessQueryService
+
+
+def app_query_services(
+ app_services: AppServices,
+ application_tags: TagApplicationService,
+ app: Flask,
+ sqlite_session_factory: sessionmaker[Session],
+ monkeypatch: pytest.MonkeyPatch,
+) -> ControllerTestServices:
+ repository = ConsoleAppRepository(session_factory=sqlite_session_factory)
+ services = ControllerTestServices(
+ tags=application_tags,
+ apps=AppQueryTestServices(
+ console=app_services.console,
+ imports=app_services.imports,
+ queries=AppQueryService(apps=repository),
+ ),
+ webapp_access=WebAppAccessQueryService(
+ access=WebAppAccessQueryRepository(session_factory=sqlite_session_factory),
+ webapp_auth_enabled=True,
+ access_mode_for_app=_get_enterprise_webapp_access_mode,
+ is_user_allowed_for_app=_is_enterprise_webapp_user_allowed,
+ get_access_modes=_batch_get_enterprise_webapp_access_modes,
+ get_user_permissions=_batch_get_enterprise_webapp_user_permissions,
+ ),
+ )
+ monkeypatch.setitem(app.extensions, "application_services", services)
+ return services
diff --git a/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py b/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
index 78b84398d4f..17b8254c2db 100644
--- a/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
+++ b/api/tests/unit_tests/controllers/console/agent/test_agent_controllers.py
@@ -64,8 +64,8 @@ from core.app.entities.app_invoke_entities import InvokeFrom
from enums import CloudPlan, DeploymentEdition
from models.account import Account, TenantAccountRole
from models.agent import Agent, AgentConfigDraftType, AgentScope, AgentSource, AgentStatus
-from models.enums import ApiTokenType, ConversationFromSource
-from models.model import ApiToken, App, AppMode, Conversation, IconType, Message
+from models.enums import ApiTokenType, ConversationFromSource, CustomizeTokenStrategy, TagType
+from models.model import ApiToken, App, AppMode, Conversation, IconType, Message, Site, Tag, TagBinding
from services.entities.agent_entities import (
ComposerSavePayload,
ComposerSaveStrategy,
@@ -322,6 +322,24 @@ def test_agent_app_list_and_create_use_agent_route(
app: Flask, monkeypatch: pytest.MonkeyPatch, account_id: str, sqlite_session: Session
) -> None:
captured: dict[str, object] = {}
+ listed_app = _app_detail_obj(id="app-list")
+ created_app = _app_detail_obj(id="app-created", enable_site=True)
+ tag = Tag(tenant_id="tenant-1", type=TagType.APP, name="Agent tag", created_by=account_id)
+ sqlite_session.add_all([listed_app, created_app, tag])
+ sqlite_session.flush()
+ sqlite_session.add_all(
+ [
+ Site(
+ app_id=created_app.id,
+ code="agent-site-code",
+ title="Agent web app",
+ default_language="en-US",
+ customize_token_strategy=CustomizeTokenStrategy.NOT_ALLOW,
+ ),
+ TagBinding(tenant_id="tenant-1", tag_id=tag.id, target_id=listed_app.id, created_by=account_id),
+ ]
+ )
+ sqlite_session.flush()
permissions = roster_controller.enterprise_rbac_service.MyPermissionsResponse(
agent=roster_controller.enterprise_rbac_service.ResourcePermissionSnapshot(
overrides=[
@@ -361,7 +379,7 @@ def test_agent_app_list_and_create_use_agent_route(
per_page=10,
total=1,
has_next=False,
- items=[_app_detail_obj(id="app-list", bound_agent_id="agent-list")],
+ items=[listed_app],
)
def get_agent_publication_counts(self, user_id: str, tenant_id: str, params, session):
@@ -371,7 +389,7 @@ def test_agent_app_list_and_create_use_agent_route(
def create_app(self, tenant_id: str, params, current_user: object, *, session: object) -> object:
captured["create"] = {"tenant_id": tenant_id, "params": params, "current_user": current_user}
- return _app_detail_obj(id="app-created", bound_agent_id="agent-created")
+ return created_app
monkeypatch.setattr(roster_controller, "AppService", FakeAppService)
monkeypatch.setattr(
@@ -467,6 +485,7 @@ def test_agent_app_list_and_create_use_agent_route(
assert listed["data"][0]["debug_conversation_id"] == "debug-conversation-list"
assert listed["data"][0]["permission_keys"] == ["agent.acl.preview"]
assert listed["data"][0]["role"] == "List role"
+ assert listed["data"][0]["tags"] == [{"id": tag.id, "name": "Agent tag", "type": "app"}]
assert listed["data"][0]["active_config_is_published"] is False
assert listed["data"][0]["reference_count"] == 2
assert listed["data"][0]["published_reference_count"] == 1
@@ -510,6 +529,10 @@ def test_agent_app_list_and_create_use_agent_route(
assert created["app_id"] == "app-created"
assert created["debug_conversation_id"] == "debug-conversation-created"
assert created["role"] == "Created role"
+ assert created["enable_site"] is True
+ assert created["site"]["code"] == "agent-site-code"
+ assert created["site"]["access_token"] == "agent-site-code"
+ assert created["site"]["title"] == "Agent web app"
assert "active_config_is_published" not in created
assert "bound_agent_id" not in created
create_call = cast(dict[str, object], captured["create"])
diff --git a/api/tests/unit_tests/controllers/console/app/test_app_apis.py b/api/tests/unit_tests/controllers/console/app/test_app_apis.py
index 263f1d4d4dd..fb728374c13 100644
--- a/api/tests/unit_tests/controllers/console/app/test_app_apis.py
+++ b/api/tests/unit_tests/controllers/console/app/test_app_apis.py
@@ -15,7 +15,6 @@ from sqlalchemy import Engine
from sqlalchemy.orm import Session
from werkzeug.exceptions import BadRequest, NotFound
-from controllers.console import console_ns
from controllers.console.app import (
annotation as annotation_module,
)
@@ -85,7 +84,6 @@ from services.app_tracing_config_service import (
AppTracingConfigNotFoundError,
AppTracingConfigVerificationFailedError,
)
-from tests.unit_tests.config_override import apply_config_overrides
APP_ID = "11111111-1111-1111-1111-111111111111"
TENANT_ID = "22222222-2222-2222-2222-222222222222"
@@ -258,131 +256,6 @@ class TestCompletionEndpoints:
)
-class TestAppEndpoints:
- def test_publish_to_creators_platform_issues_oauth_code_through_application_service(
- self,
- database_app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- ) -> None:
- api = app_module.AppPublishToCreatorsPlatformApi()
- method = unwrap(api.post)
- oauth_server = MagicMock()
- oauth_server.issue_authorization_code.return_value = MagicMock(code="oauth-code-1")
- services = MagicMock(oauth_server=oauth_server)
-
- apply_config_overrides(
- monkeypatch,
- CREATORS_PLATFORM_FEATURES_ENABLED=True,
- CREATORS_PLATFORM_OAUTH_CLIENT_ID="client-1",
- )
- monkeypatch.setattr(app_module, "application_services", lambda: services)
- monkeypatch.setattr(app_module.AppDslService, "export_dsl", MagicMock(return_value="app: demo"))
-
- with (
- database_app.test_request_context(),
- patch("core.helper.creators.upload_dsl", return_value="claim-1"),
- patch("core.helper.creators.get_redirect_url", return_value="https://creators.example.com") as redirect,
- ):
- response = method(api, USER_ID, _make_app())
-
- assert response == {"redirect_url": "https://creators.example.com"}
- oauth_server.issue_authorization_code.assert_called_once_with(
- client_id="client-1",
- account_id=USER_ID,
- )
- redirect.assert_called_once_with("claim-1", oauth_code="oauth-code-1")
-
- def test_app_put_should_preserve_icon_type_when_payload_omits_it(
- self, app: Flask, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
- ):
- api = app_module.AppApi()
- method = unwrap(api.put)
- payload = {
- "name": "Updated App",
- "description": "Updated description",
- "icon": "🤖",
- "icon_background": "#FFFFFF",
- }
- app_service = MagicMock()
- app_service.update_app.return_value = _make_app()
- response_model = MagicMock()
- response_model.model_dump.return_value = {"id": "app-1"}
-
- monkeypatch.setattr(app_module, "AppService", lambda: app_service)
- monkeypatch.setattr(app_module.AppDetailWithSite, "model_validate", MagicMock(return_value=response_model))
-
- with (
- app.test_request_context("/console/api/apps/app-1", method="PUT", json=payload),
- patch.object(type(console_ns), "payload", payload),
- ):
- response = method(
- api,
- app_module.UpdateAppPayload(
- name="Updated App",
- description="Updated description",
- icon="🤖",
- icon_background="#FFFFFF",
- ),
- unbound_session,
- app_model=_make_app(icon_type=app_module.IconType.EMOJI),
- )
-
- assert response == {"id": "app-1"}
- assert app_service.update_app.call_args.args[1]["icon_type"] is None
-
- def test_update_app_payload_should_reject_empty_icon_type(self):
- with pytest.raises(ValidationError):
- app_module.UpdateAppPayload.model_validate(
- {
- "name": "Updated App",
- "description": "Updated description",
- "icon_type": "",
- "icon": "🤖",
- "icon_background": "#FFFFFF",
- }
- )
-
- def test_app_icon_post_should_forward_icon_type(
- self, app: Flask, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
- ):
- api = app_module.AppIconApi()
- method = unwrap(api.post)
- payload = {
- "icon": "https://example.com/icon.png",
- "icon_type": "image",
- "icon_background": "#FFFFFF",
- }
- app_service = MagicMock()
- app_service.update_app_icon.return_value = _make_app()
- response_model = MagicMock()
- response_model.model_dump.return_value = {"id": "app-1"}
-
- monkeypatch.setattr(app_module, "AppService", lambda: app_service)
- monkeypatch.setattr(app_module.AppDetail, "model_validate", MagicMock(return_value=response_model))
-
- with (
- app.test_request_context("/console/api/apps/app-1/icon", method="POST", json=payload),
- patch.object(type(console_ns), "payload", payload),
- ):
- response = method(
- api,
- app_module.AppIconPayload(
- icon="https://example.com/icon.png",
- icon_type=app_module.IconType.IMAGE,
- icon_background="#FFFFFF",
- ),
- unbound_session,
- app_model=_make_app(),
- )
-
- assert response == {"id": "app-1"}
- assert app_service.update_app_icon.call_args.args[1:] == (
- payload["icon"],
- payload["icon_background"],
- app_module.IconType.IMAGE,
- )
-
-
class TestOpsTraceEndpoints:
def test_ops_trace_query_basic(self):
query = TraceProviderQuery(tracing_provider="langfuse")
diff --git a/api/tests/unit_tests/controllers/console/app/test_app_import_api.py b/api/tests/unit_tests/controllers/console/app/test_app_import_api.py
index c09d24cffcc..074d0adb78a 100644
--- a/api/tests/unit_tests/controllers/console/app/test_app_import_api.py
+++ b/api/tests/unit_tests/controllers/console/app/test_app_import_api.py
@@ -1,436 +1,218 @@
-"""Unit tests for console app import endpoints."""
-
-from __future__ import annotations
+"""Console imports finalize persistence before publishing permissions and access settings."""
from collections.abc import Iterator
-from dataclasses import dataclass
from inspect import unwrap
-from unittest.mock import MagicMock
+from uuid import uuid4
import pytest
from flask import Flask
from sqlalchemy import Engine, event
-from sqlalchemy.orm import Session
-
-from controllers.console.app import app_import as app_import_module
-from models.account import Account, Tenant
-from models.base import TypeBase
-from models.engine import db
+from sqlalchemy.orm import Session, sessionmaker
+from werkzeug.exceptions import Forbidden
+
+from controllers.console.app import app_import as controller
+from controllers.console.app.error import AppNotFoundError
+from extensions.ext_redis import redis_client
+from machinery.context import RequestContext
+from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
from models.model import App, AppMode
-from services.app_dsl_service import ImportStatus
-from services.entities.dsl_entities import CheckDependenciesResult
-from tests.unit_tests.config_override import apply_config_overrides
-
-
-def _unwrap(func):
- bound_self = getattr(func, "__self__", None)
- while hasattr(func, "__wrapped__"):
- func = func.__wrapped__
- if bound_self is not None:
- return func.__get__(bound_self, bound_self.__class__)
- return func
-
-
-class _Result:
- def __init__(
- self,
- status: ImportStatus,
- app_id: str | None = "app-1",
- permission_keys: list[str] | None = None,
- ):
- self.status = status
- self.app_id = app_id
- self.permission_keys = permission_keys or []
-
- def model_dump(self, mode: str = "json"):
- return {"status": self.status, "app_id": self.app_id, "permission_keys": self.permission_keys}
-
-
-def _install_features(monkeypatch: pytest.MonkeyPatch, enabled: bool) -> None:
- monkeypatch.setattr(app_import_module.SystemFeatureService, "is_webapp_auth_enabled", lambda: enabled)
-
-
-def _make_account(account_id: str = "u1") -> Account:
- account = Account(name="Test User", email="[email protected]")
- account.id = account_id
- tenant = Tenant(name="Test Tenant")
- tenant.id = "tenant-1"
- account._current_tenant = tenant
- return account
-
-
-def app() -> Iterator[Flask]:
- app = Flask(__name__)
- app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
- db.init_app(app)
-
- with app.app_context():
- yield app
+from services.app.console_gateway import EnterpriseConsoleAppAccess
+from services.app_dsl_service import AppDslService, PendingData
+from services.enterprise.enterprise_service import EnterpriseService
+from services.entities.dsl_entities import Import, ImportStatus
+from services.errors.account import NoPermissionError
+from services.plugin.dependencies_analysis import DependenciesAnalysisService
+from services.system_feature_service import SystemFeatureService
@pytest.fixture
-def sqlite_app_engine(app: Flask) -> Engine:
- engine = db.engine
- TypeBase.metadata.create_all(engine, tables=[TypeBase.metadata.tables[App.__tablename__]])
- return engine
-
-
-@dataclass
-class TransactionEvents:
- commits: int = 0
- rollbacks: int = 0
+def import_context(sqlite_session_factory: sessionmaker[Session]) -> RequestContext:
+ account_id, tenant_id = str(uuid4()), str(uuid4())
+ account = Account(name="Importer", email="[email protected]")
+ account.id = account_id
+ tenant = Tenant(name="Workspace")
+ tenant.id = tenant_id
+ with sqlite_session_factory.begin() as session:
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(tenant_id=tenant_id, account_id=account_id, role=TenantAccountRole.OWNER),
+ ]
+ )
+ return RequestContext("import-request", None, account_id, tenant_id)
@pytest.fixture
-def transaction_events() -> TransactionEvents:
- """Observe transaction decisions while keeping the controller on a real SQLAlchemy session."""
-
- observed = TransactionEvents()
+def connections(sqlite_engine: Engine) -> Iterator[set[object]]:
+ checked_out: set[object] = set()
- def record_commit(_session: Session) -> None:
- observed.commits += 1
+ def checkout(connection: object, *_args: object) -> None:
+ checked_out.add(connection)
- def record_rollback(_session: Session) -> None:
- observed.rollbacks += 1
+ def checkin(connection: object, *_args: object) -> None:
+ checked_out.remove(connection)
- event.listen(Session, "after_commit", record_commit)
- event.listen(Session, "after_rollback", record_rollback)
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
try:
- yield observed
+ yield checked_out
+ assert not checked_out
finally:
- event.remove(Session, "after_commit", record_commit)
- event.remove(Session, "after_rollback", record_rollback)
-
-
-def _install_persisting_service_result(
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
[email protected]("app_query_services")
[email protected]("confirm", [False, True])
[email protected]("overwrite", [False, True])
[email protected]("status", list(ImportStatus))
+def test_import_transaction_and_response_contract(
+ app: Flask,
+ sqlite_session_factory: sessionmaker[Session],
+ import_context: RequestContext,
+ connections: set[object],
monkeypatch: pytest.MonkeyPatch,
- *,
- method_name: str,
- result: _Result,
-) -> str:
- app_id = result.app_id or "rolled-back-app"
-
- def _return_result(import_service: app_import_module.AppDslService, *_args, **_kwargs):
- import_service._session.add(
+ config_overrides,
+ status: ImportStatus,
+ overwrite: bool,
+ confirm: bool,
+) -> None:
+ config_overrides(RBAC_ENABLED=True, DEPLOYMENT_EDITION="COMMUNITY")
+ monkeypatch.setattr("services.app.console_gateway.rbac_service.RBACService.CheckAccess.check", lambda *a, **k: True)
+ app_id = str(uuid4())
+ result = Import(id="import-1", status=status, app_id=app_id)
+ pending = PendingData(
+ tenant_id=import_context.active_workspace_id,
+ account_id=import_context.account_id,
+ import_mode="yaml-content",
+ yaml_content="app: {}",
+ app_id=app_id if overwrite else None,
+ )
+ monkeypatch.setattr(redis_client, "get", lambda _key: pending.model_dump_json())
+
+ def persist(dsl: AppDslService, *, account: Account, **_kwargs) -> Import:
+ assert not connections, "Actor lookup must release its connection before starting the DSL operation"
+ assert account.id == import_context.account_id
+ assert account.current_tenant_id == import_context.active_workspace_id
+ dsl._session.add(
App(
id=app_id,
- tenant_id="tenant-1",
- name="Imported App",
+ tenant_id=account.current_tenant_id,
+ name="Imported",
mode=AppMode.WORKFLOW,
enable_site=True,
enable_api=True,
)
)
+ dsl._session.flush()
return result
- monkeypatch.setattr(app_import_module.AppDslService, method_name, _return_result)
- return app_id
-
-
-def _assert_app_persistence(sqlite_app_engine: Engine, app_id: str, *, persisted: bool) -> None:
- with Session(sqlite_app_engine) as session:
- assert (session.get(App, app_id) is not None) is persisted
-
-
-class TestAppImportApi:
- @pytest.fixture
- def api(self):
- return app_import_module.AppImportApi()
-
- def test_import_post_returns_failed_status_and_rolls_back(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = unwrap(api._import_dsl)
-
- _install_features(monkeypatch, enabled=False)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="import_app",
- result=_Result(ImportStatus.FAILED, app_id=None),
- )
-
- with app.test_request_context("/console/api/apps/imports", method="POST", json={"mode": "yaml-content"}):
- response, status = method(api, app_import_module.AppImportPayload(mode="yaml-content"), _make_account())
-
- assert transaction_events.rollbacks == 1
- assert transaction_events.commits == 0
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=False)
- assert status == 400
- assert response["status"] == ImportStatus.FAILED
-
- def test_import_post_returns_pending_status_and_commits(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = unwrap(api._import_dsl)
-
- _install_features(monkeypatch, enabled=False)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="import_app",
- result=_Result(ImportStatus.PENDING),
- )
-
- with app.test_request_context("/console/api/apps/imports", method="POST", json={"mode": "yaml-content"}):
- response, status = method(api, app_import_module.AppImportPayload(mode="yaml-content"), _make_account())
-
- assert transaction_events.commits == 1
- assert transaction_events.rollbacks == 0
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- assert status == 202
- assert response["status"] == ImportStatus.PENDING
-
- def test_import_post_updates_webapp_auth_when_enabled(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = unwrap(api._import_dsl)
-
- _install_features(monkeypatch, enabled=True)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="import_app",
- result=_Result(ImportStatus.COMPLETED, app_id="app-123"),
- )
- update_access = MagicMock()
- monkeypatch.setattr(app_import_module.EnterpriseService.WebAppAuth, "update_app_access_mode", update_access)
-
- with app.test_request_context("/console/api/apps/imports", method="POST", json={"mode": "yaml-content"}):
- response, status = method(api, app_import_module.AppImportPayload(mode="yaml-content"), _make_account())
-
- assert transaction_events.commits == 1
- assert transaction_events.rollbacks == 0
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- update_access.assert_called_once_with("app-123", "private")
- assert status == 200
- assert response["status"] == ImportStatus.COMPLETED
-
- def test_import_post_attaches_permission_keys_when_creating_new_app_and_rbac_enabled(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = _unwrap(api._import_dsl)
-
- _install_features(monkeypatch, enabled=False)
- monkeypatch.setattr(
- app_import_module,
- "current_account_with_tenant",
- lambda: (_make_account(), "tenant-1"),
- )
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="import_app",
- result=_Result(ImportStatus.COMPLETED, app_id="app-123"),
- )
- monkeypatch.setattr(
- app_import_module,
- "get_app_permission_keys",
- lambda tenant_id, account_id, app_id: ["app.acl.view_layout", "app.acl.edit"],
- )
-
- with app.test_request_context("/console/api/apps/imports", method="POST", json={"mode": "yaml-content"}):
- response, status = method(app_import_module.AppImportPayload(mode="yaml-content"))
-
- assert transaction_events.commits == 1
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- assert status == 200
- assert response["permission_keys"] == ["app.acl.view_layout", "app.acl.edit"]
-
- def test_import_post_does_not_attach_permission_keys_when_overwriting_existing_app(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = _unwrap(api._import_dsl)
-
- _install_features(monkeypatch, enabled=False)
- monkeypatch.setattr(
- app_import_module,
- "current_account_with_tenant",
- lambda: (_make_account(), "tenant-1"),
- )
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="import_app",
- result=_Result(ImportStatus.COMPLETED, app_id="app-123"),
- )
- monkeypatch.setattr(
- app_import_module,
- "get_app_permission_keys",
- lambda *_args, **_kwargs: ["app.acl.view_layout", "app.acl.edit"],
- )
-
- with app.test_request_context(
- "/console/api/apps/imports",
- method="POST",
- json={"mode": "yaml-content", "app_id": "existing-app"},
- ):
- response, status = method(app_import_module.AppImportPayload(mode="yaml-content", app_id="existing-app"))
-
- assert transaction_events.commits == 1
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- assert status == 200
- assert response["permission_keys"] == []
-
-
-class TestAppImportConfirmApi:
- @pytest.fixture
- def api(self):
- return app_import_module.AppImportConfirmApi()
-
- def test_import_confirm_returns_failed_status_and_rolls_back(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = unwrap(api.post)
-
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="confirm_import",
- result=_Result(ImportStatus.FAILED),
- )
-
- with app.test_request_context("/console/api/apps/imports/import-1/confirm", method="POST"):
- response, status = method(api, _make_account(), import_id="import-1")
-
- assert transaction_events.rollbacks == 1
- assert transaction_events.commits == 0
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=False)
- assert status == 400
- assert response["status"] == ImportStatus.FAILED
-
- def test_import_confirm_attaches_permission_keys_when_creating_new_app_and_rbac_enabled(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = _unwrap(api.post)
-
- monkeypatch.setattr(
- app_import_module,
- "current_account_with_tenant",
- lambda: (_make_account(), "tenant-1"),
- )
- redis_get = MagicMock(
- return_value=(
- b'{"tenant_id":"tenant-1","account_id":"u1","import_mode":"yaml-content",'
- b'"yaml_content":"app: {}","app_id":null,'
- b'"name":null,"description":null,"icon_type":null,"icon":null,"icon_background":null}'
+ monkeypatch.setattr(AppDslService, "confirm_import" if confirm else "import_app", persist)
+ permissions: list[str] = []
+ access_updates: list[tuple[str, str]] = []
+
+ def get_permissions(_self, context: RequestContext, imported_id: str) -> list[str]:
+ assert not connections
+ assert context == import_context
+ with sqlite_session_factory() as session:
+ assert session.get(App, imported_id) is not None
+ permissions.append(imported_id)
+ return ["app.acl.view_layout"]
+
+ def update_access(imported_id: str, access_mode: str) -> None:
+ assert not connections, "WebApp access initialization must follow transaction completion"
+ access_updates.append((imported_id, access_mode))
+
+ monkeypatch.setattr(EnterpriseConsoleAppAccess, "created_permissions", get_permissions)
+ monkeypatch.setattr(SystemFeatureService, "is_webapp_auth_enabled", lambda: True)
+ monkeypatch.setattr(EnterpriseService.WebAppAuth, "update_app_access_mode", update_access)
+ with app.test_request_context(
+ method="POST",
+ json={
+ "mode": "yaml-content",
+ "yaml_content": "app: {}",
+ "app_id": app_id if overwrite else None,
+ },
+ ):
+ if confirm:
+ api = controller.AppImportConfirmApi()
+ response, status_code = unwrap(api.post)(api, import_context, import_id="import-1")
+ else:
+ api = controller.AppImportApi()
+ response, status_code = unwrap(api.post)(api, import_context)
+ with sqlite_session_factory() as session:
+ assert (session.get(App, app_id) is not None) is (status != ImportStatus.FAILED)
+ completed = status in {ImportStatus.COMPLETED, ImportStatus.COMPLETED_WITH_WARNINGS}
+ assert permissions == ([app_id] if completed and not overwrite else [])
+ assert response["permission_keys"] == (["app.acl.view_layout"] if permissions else [])
+ assert access_updates == ([] if confirm else [(app_id, "private")])
+ assert status_code == (
+ 400 if status == ImportStatus.FAILED else 202 if status == ImportStatus.PENDING and not confirm else 200
+ )
+
+
[email protected]("app_query_services")
[email protected]("missing", [False, True])
+def test_check_dependencies_releases_database_before_plugin_io(
+ app: Flask,
+ import_context: RequestContext,
+ sqlite_session_factory: sessionmaker[Session],
+ connections: set[object],
+ monkeypatch: pytest.MonkeyPatch,
+ missing: bool,
+) -> None:
+ app_id = str(uuid4())
+ if not missing:
+ with sqlite_session_factory.begin() as session:
+ session.add(
+ App(
+ id=app_id,
+ tenant_id=import_context.active_workspace_id,
+ name="Imported",
+ mode=AppMode.CHAT,
+ enable_site=True,
+ enable_api=True,
+ )
)
- )
- monkeypatch.setattr(app_import_module.redis_client, "get", redis_get)
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="confirm_import",
- result=_Result(ImportStatus.COMPLETED, app_id="app-456"),
- )
- monkeypatch.setattr(
- app_import_module,
- "get_app_permission_keys",
- lambda tenant_id, account_id, app_id: ["app.acl.view_layout", "app.acl.edit"],
- )
-
- with app.test_request_context("/console/api/apps/imports/import-1/confirm", method="POST"):
- response, status = method(import_id="import-1")
-
- assert transaction_events.commits == 1
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- assert status == 200
- assert response["permission_keys"] == ["app.acl.view_layout", "app.acl.edit"]
- redis_get.assert_called_once_with("app_import_info:import-1")
-
- def test_import_confirm_does_not_attach_permission_keys_when_overwriting_existing_app(
- self,
- api,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_app_engine: Engine,
- transaction_events: TransactionEvents,
- ) -> None:
- method = _unwrap(api.post)
-
- monkeypatch.setattr(
- app_import_module,
- "current_account_with_tenant",
- lambda: (_make_account(), "tenant-1"),
- )
- monkeypatch.setattr(
- app_import_module.redis_client,
- "get",
- lambda *_args, **_kwargs: (
- b'{"tenant_id":"tenant-1","account_id":"u1","import_mode":"yaml-content",'
- b'"yaml_content":"app: {}","app_id":"existing-app",'
- b'"name":null,"description":null,"icon_type":null,"icon":null,"icon_background":null}'
- ),
- )
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- app_id = _install_persisting_service_result(
- monkeypatch,
- method_name="confirm_import",
- result=_Result(ImportStatus.COMPLETED, app_id="app-456"),
- )
- monkeypatch.setattr(
- app_import_module,
- "get_app_permission_keys",
- lambda *_args, **_kwargs: ["app.acl.view_layout", "app.acl.edit"],
- )
-
- with app.test_request_context("/console/api/apps/imports/import-1/confirm", method="POST"):
- response, status = method(import_id="import-1")
-
- assert transaction_events.commits == 1
- _assert_app_persistence(sqlite_app_engine, app_id, persisted=True)
- assert status == 200
- assert response["permission_keys"] == []
-
-
-class TestAppImportCheckDependenciesApi:
- def test_import_check_dependencies_returns_result(
- self,
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- ) -> None:
- api = app_import_module.AppImportCheckDependenciesApi()
- method = unwrap(api.get)
- monkeypatch.setattr(
- app_import_module.AppDslService,
- "check_dependencies",
- lambda *_args, **_kwargs: CheckDependenciesResult(leaked_dependencies=[]),
- )
-
- with app.test_request_context("/console/api/apps/imports/app-1/check-dependencies", method="GET"):
- response, status = method(api, app_model=App(id="app-1"))
-
- assert status == 200
- assert response["leaked_dependencies"] == []
+ monkeypatch.setattr(redis_client, "get", lambda _key: '{"dependencies":[]}')
+ called = []
+
+ def check(*, tenant_id: str, dependencies):
+ assert not connections
+ assert tenant_id == import_context.active_workspace_id
+ called.append(dependencies)
+ return []
+
+ monkeypatch.setattr(DependenciesAnalysisService, "get_leaked_dependencies", check)
+ api = controller.AppImportCheckDependenciesApi()
+ with app.test_request_context():
+ if missing:
+ with pytest.raises(AppNotFoundError):
+ unwrap(api.get)(api, import_context, app_id=app_id)
+ assert called == []
+ else:
+ response, code = unwrap(api.get)(api, import_context, app_id=app_id)
+ assert code == 200
+ assert response == {"leaked_dependencies": []}
+ assert called == [[]]
+
+
[email protected]("confirm", [False, True])
+def test_permission_errors_are_mapped_at_http_boundary(
+ app_query_services, app: Flask, monkeypatch, confirm: bool
+) -> None:
+ def denied(*_args, **_kwargs):
+ raise NoPermissionError("Import denied")
+
+ monkeypatch.setattr(app_query_services.apps.console, "confirm_import" if confirm else "import_app", denied)
+ context = RequestContext("request", None, "actor", "workspace")
+ with app.test_request_context(method="POST", json={"mode": "yaml-content"}):
+ if confirm:
+ api = controller.AppImportConfirmApi()
+ with pytest.raises(Forbidden, match="Import denied"):
+ unwrap(api.post)(api, context, import_id="import-1")
+ else:
+ api = controller.AppImportApi()
+ with pytest.raises(Forbidden, match="Import denied"):
+ unwrap(api.post)(api, context)
diff --git a/api/tests/unit_tests/controllers/console/app/test_app_response_models.py b/api/tests/unit_tests/controllers/console/app/test_app_response_models.py
index b1cfa160f60..ff51ca8dd05 100644
--- a/api/tests/unit_tests/controllers/console/app/test_app_response_models.py
+++ b/api/tests/unit_tests/controllers/console/app/test_app_response_models.py
@@ -1,183 +1,37 @@
-from __future__ import annotations
+"""App request contracts and serialization of materialized response data."""
-import builtins
import json
-import sys
-from collections.abc import Callable
+from dataclasses import replace
from datetime import datetime
-from importlib import util
-from pathlib import Path
-from types import ModuleType, SimpleNamespace
-from unittest.mock import MagicMock
import pytest
from flask import Flask
-from flask.views import MethodView
from pydantic import ValidationError
from sqlalchemy.orm import Session
from werkzeug.datastructures import MultiDict
+from controllers.console.app import app as controller
+from fields import app_fields
+from libs.pagination import PaginatedResult
from models.account import Account
from models.enums import CustomizeTokenStrategy, TagType
from models.model import App, AppMode, AppModelConfig, IconType, Site, Tag, TagBinding
from models.workflow import Workflow, WorkflowType
-from services.app_service import RecentAppListItem
+from repositories.app.response import app_record
+from services.app_service import AppResponseView
-# kombu references MethodView as a global when importing celery/kombu pools.
-if not hasattr(builtins, "MethodView"):
- builtins.MethodView = MethodView # type: ignore[attr-defined]
-
-class _ConsoleModule(ModuleType):
- console_ns: object
- api: object | None
- bp: object | None
- app: ModuleType
-
-
-def _unwrap(func):
- bound_self = getattr(func, "__self__", None)
- while hasattr(func, "__wrapped__"):
- func = func.__wrapped__
- if bound_self is not None:
- return func.__get__(bound_self, bound_self.__class__)
- return func
-
-
[email protected](scope="module")
def app_module():
- module_name = "controllers.console.app.app"
- root = Path(__file__).resolve().parents[5]
- module_path = root / "controllers" / "console" / "app" / "app.py"
-
- class _StubNamespace:
- def __init__(self):
- self.models: dict[str, object] = {}
- self.payload = None
-
- def schema_model(self, name, schema):
- self.models[name] = schema
- return schema
-
- def model(self, name, model_dict=None, **kwargs):
- """Register a model with the namespace (flask-restx compatibility)."""
- if model_dict is not None:
- self.models[name] = model_dict
- return model_dict
-
- def _decorator(self, obj):
- return obj
-
- def doc(self, *args, **kwargs):
- return self._decorator
-
- def expect(self, *args, **kwargs):
- return self._decorator
-
- def response(self, *args, **kwargs):
- return self._decorator
-
- def route(self, *args, **kwargs):
- def decorator(obj):
- return obj
-
- return decorator
-
- stub_namespace = _StubNamespace()
-
- original_modules: dict[str, ModuleType | None] = {
- "controllers.console": sys.modules.get("controllers.console"),
- "controllers.console.app": sys.modules.get("controllers.console.app"),
- "controllers.common.schema": sys.modules.get("controllers.common.schema"),
- module_name: sys.modules.get(module_name),
- }
- stubbed_modules: list[tuple[str, ModuleType | None]] = []
-
- console_module = _ConsoleModule("controllers.console")
- console_module.__path__ = [str(root / "controllers" / "console")]
- console_module.console_ns = stub_namespace
- console_module.api = None
- console_module.bp = None
- sys.modules["controllers.console"] = console_module
-
- app_package = ModuleType("controllers.console.app")
- app_package.__path__ = [str(root / "controllers" / "console" / "app")]
- sys.modules["controllers.console.app"] = app_package
- console_module.app = app_package
-
- def _stub_module(name: str, attrs: dict[str, object]) -> None:
- original = sys.modules.get(name)
- module = ModuleType(name)
- for key, value in attrs.items():
- setattr(module, key, value)
- sys.modules[name] = module
- stubbed_modules.append((name, original))
-
- class _OpsTraceManager:
- @staticmethod
- def get_app_tracing_config(app_id: str) -> dict[str, object]:
- return {}
-
- @staticmethod
- def update_app_tracing_config(app_id: str, **kwargs) -> None:
- return None
-
- _stub_module(
- "core.ops.ops_trace_manager",
- {
- "OpsTraceManager": _OpsTraceManager,
- "TraceQueueManager": object,
- "TraceTask": object,
- "TracingProviderConfigEntry": dict,
- "provider_config_map": {},
- },
- )
-
- spec = util.spec_from_file_location(module_name, module_path)
- assert spec is not None
- module = util.module_from_spec(spec)
- sys.modules[module_name] = module
-
- assert spec.loader is not None
- spec.loader.exec_module(module)
-
- try:
- yield module
- finally:
- for name, original in reversed(stubbed_modules):
- if original is not None:
- sys.modules[name] = original
- else:
- sys.modules.pop(name, None)
- for name, original in original_modules.items():
- if original is not None:
- sys.modules[name] = original
- else:
- sys.modules.pop(name, None)
-
-
[email protected](scope="module")
-def app_models(app_module):
- return SimpleNamespace(
- AppDetailWithSite=app_module.AppDetailWithSite,
- AppPagination=app_module.AppPagination,
- AppPartial=app_module.AppPartial,
- )
-
+ return controller
[email protected](autouse=True)
-def patch_signed_url(monkeypatch: pytest.MonkeyPatch, app_module: ModuleType) -> None:
- """Ensure icon URL generation uses a deterministic helper for tests."""
- def _fake_build_icon_url(_icon_type, key: str | None) -> str | None:
- if key is None:
- return None
- icon_type = str(_icon_type).lower()
- if icon_type != "image":
- return None
- return f"signed:{key}"
-
- monkeypatch.setattr(app_module, "build_icon_url", _fake_build_icon_url)
+def app_models(monkeypatch):
+ monkeypatch.setattr(
+ app_fields, "build_icon_url", lambda kind, icon: f"signed:{icon}" if kind == IconType.IMAGE else None
+ )
+ return app_fields
def _ts(hour: int = 12) -> datetime:
@@ -432,9 +286,8 @@ def test_app_partial_serialization_uses_aliases(app_models, sqlite_session: Sess
app_obj.description = "Prompt snippet"
serialized = AppPartial.model_validate(
- app_obj,
+ replace(app_record(app_obj, session=sqlite_session), permission_keys=app_obj.permission_keys),
from_attributes=True,
- context={"session": sqlite_session},
).model_dump(mode="json")
assert serialized["description"] == "Prompt snippet"
@@ -470,13 +323,15 @@ def test_app_detail_with_site_includes_nested_serialization(
assert model_config is not None
model_config.opening_statement = "hi"
model_config.retriever_resource = json.dumps({"enabled": True})
- monkeypatch.setattr("services.app_service.load_annotation_reply_config", lambda _session, _app_id: {})
+ monkeypatch.setattr("repositories.app.response.load_annotation_reply_config", lambda _session, _app_id: {})
with app.test_request_context("/"):
serialized = AppDetailWithSite.model_validate(
- app_obj,
+ replace(
+ app_record(app_obj, session=sqlite_session, projection="detail-with-site"),
+ permission_keys=app_obj.permission_keys,
+ ),
from_attributes=True,
- context={"session": sqlite_session},
).model_dump(mode="json")
assert serialized["icon_url"] == "signed:detail-icon"
@@ -491,7 +346,7 @@ def test_app_detail_with_site_includes_nested_serialization(
def test_app_response_view_uses_the_caller_session_for_query_backed_fields(
- app_module, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
+ monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
app_obj = _persist_response_graph(sqlite_session)
decoy_tenant_id = "00000000-0000-0000-0000-000000000002"
@@ -509,10 +364,15 @@ def test_app_response_view_uses_the_caller_session_for_query_backed_fields(
]
)
sqlite_session.commit()
- load_annotation_reply = MagicMock(return_value={"enabled": False})
+ calls = []
+
+ def load_annotation_reply(session, app_id):
+ calls.append((session, app_id))
+ return {"enabled": False}
+
monkeypatch.setattr("services.app_service.load_annotation_reply_config", load_annotation_reply)
- view = app_module.AppResponseView(app_obj, session=sqlite_session)
+ view = AppResponseView(app_obj, session=sqlite_session)
site = view.site
workflow = view.workflow
model_config = view.app_model_config
@@ -529,7 +389,7 @@ def test_app_response_view_uses_the_caller_session_for_query_backed_fields(
assert view.author_name == "Creator"
assert model_config is not None
assert model_config.annotation_reply_dict == {"enabled": False}
- load_annotation_reply.assert_called_once_with(sqlite_session, APP_ID)
+ assert calls == [(sqlite_session, APP_ID)]
def test_app_pagination_aliases_per_page_and_has_next(app_models, sqlite_session: Session):
@@ -549,18 +409,16 @@ def test_app_pagination_aliases_per_page_and_has_next(app_models, sqlite_session
icon="🙂",
created_at=_ts(16),
)
- pagination = SimpleNamespace(
+ pagination = PaginatedResult(
page=2,
per_page=10,
total=50,
- has_next=True,
- items=[item_one, item_two],
+ items=[app_record(item, session=sqlite_session) for item in (item_one, item_two)],
)
serialized = AppPagination.model_validate(
pagination,
from_attributes=True,
- context={"session": sqlite_session},
).model_dump(mode="json")
assert serialized["page"] == 2
@@ -569,569 +427,3 @@ def test_app_pagination_aliases_per_page_and_has_next(app_models, sqlite_session
assert len(serialized["data"]) == 2
assert serialized["data"][0]["icon_url"] == "signed:first-icon"
assert serialized["data"][1]["icon_url"] is None
-
-
-def test_app_list_uses_injected_session_for_draft_workflows(
- app: Flask,
- app_module: ModuleType,
- monkeypatch: pytest.MonkeyPatch,
- sqlite_session: Session,
-) -> None:
- api = app_module.AppListApi()
- method = _unwrap(api.get)
- app_item = _app(
- app_id="app-1",
- tenant_id="tenant-1",
- name="Workflow App",
- mode=AppMode.WORKFLOW,
- )
- app_pagination = SimpleNamespace(page=1, per_page=20, total=1, has_next=False, items=[app_item])
- workflow = Workflow(
- id="workflow-1",
- tenant_id="tenant-1",
- app_id="app-1",
- type=WorkflowType.WORKFLOW,
- version=Workflow.VERSION_DRAFT,
- graph=json.dumps({"nodes": [{"id": "trigger-1", "data": {"type": "trigger-webhook"}}], "edges": []}),
- features=json.dumps({}),
- created_by="user-1",
- environment_variables=[],
- conversation_variables=[],
- )
- sqlite_session.add(workflow)
- sqlite_session.commit()
-
- monkeypatch.setattr(
- app_module,
- "AppService",
- lambda: SimpleNamespace(get_paginate_apps=lambda *_args, **_kwargs: app_pagination),
- )
- monkeypatch.setattr(
- app_module,
- "SystemFeatureService",
- SimpleNamespace(is_webapp_auth_enabled=lambda: False),
- )
- get_permissions = MagicMock(
- return_value=app_module.enterprise_rbac_service.MyPermissionsResponse(
- app=app_module.enterprise_rbac_service.ResourcePermissionSnapshot(
- overrides=[
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-1",
- permission_keys=["app.acl.edit"],
- )
- ]
- )
- )
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- get_permissions,
- )
- with app.test_request_context("/console/api/apps?page=1&limit=20", method="GET"):
- response, status = method("tenant-1", "user-1", sqlite_session)
-
- assert status == 200
- assert response["data"][0]["has_draft_trigger"] is True
- get_permissions.assert_called_once_with("tenant-1", "user-1", session=sqlite_session)
- assert response["data"][0]["permission_keys"] == ["app.acl.edit"]
-
-
-def test_app_create_api_attaches_permission_keys(
- app, app_module, sqlite_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppListApi.post
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- app_obj = _app(
- app_id="app-new",
- tenant_id="tenant-1",
- name="Created App",
- description="Summary",
- mode=AppMode.ADVANCED_CHAT,
- )
-
- with app.test_request_context("/apps", method="POST", json={}):
- with pytest.MonkeyPatch.context() as monkeypatch:
- app_module.console_ns.payload = {
- "name": "Created App",
- "description": "Summary",
- "mode": "advanced-chat",
- }
- monkeypatch.setattr(
- app_module,
- "AppService",
- lambda: SimpleNamespace(create_app=lambda tenant_id, params, user, session: app_obj),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppPermissions,
- "batch_get",
- lambda tenant_id, account_id, app_ids, session: {"app-new": ["app.acl.view_layout", "app.acl.edit"]},
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "replace_whitelist",
- MagicMock(),
- )
- monkeypatch.setattr(app_module.initialize_created_app_rbac_access_task, "delay", MagicMock())
- resp, status = method(
- app_module.AppListApi(),
- app_module.CreateAppPayload(
- name="Created App",
- description="Summary",
- mode="advanced-chat",
- ),
- sqlite_session,
- "tenant-1",
- _account(account_id="acct-1"),
- )
-
- assert status == 201
- assert resp["permission_keys"] == ["app.acl.view_layout", "app.acl.edit"]
-
-
-def test_app_list_api_attaches_permission_keys(
- app, app_module, sqlite_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- app_obj = _app(
- app_id="app-1",
- tenant_id="tenant-1",
- name="List App",
- created_at=_ts(15),
- )
- pagination = SimpleNamespace(page=1, per_page=20, total=1, has_next=False, items=[app_obj])
- get_paginate_apps = MagicMock(return_value=pagination)
-
- with app.test_request_context("/apps"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(
- app_module.AppService,
- "get_paginate_apps",
- get_paginate_apps,
- )
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(
- app=app_module.enterprise_rbac_service.ResourcePermissionSnapshot(
- default_permission_keys=["app.preview", "app.acl.view_layout"],
- overrides=[
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-1",
- permission_keys=["app.acl.view_layout", "app.acl.edit"],
- )
- ],
- )
- ),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "whitelist_resources",
- lambda tenant_id, account_id: SimpleNamespace(unrestricted=True, resource_ids=[]),
- )
-
- resp, status = method(app_module.AppListApi(), "tenant-1", "acct-1", sqlite_session)
-
- assert status == 200
- params = get_paginate_apps.call_args.args[2]
- assert params.accessible_app_ids is None
- assert params.is_created_by_me is None
- assert resp["data"][0]["permission_keys"] == ["app.acl.view_layout", "app.acl.edit"]
-
-
-def test_recent_app_list_api_returns_only_home_card_fields(
- app,
- app_module,
- unbound_session: Session,
- config_overrides: Callable[..., None],
-):
- config_overrides(RBAC_ENABLED=False)
- method = app_module.RecentAppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- recent_app = RecentAppListItem(
- id="app-1",
- name="Recent App",
- icon_type=IconType.EMOJI,
- icon="🚀",
- icon_background="#FFFFFF",
- mode="chat",
- author_name="Recent Author",
- updated_at=_ts(15),
- maintainer="acct-1",
- )
- get_recent_apps = MagicMock(return_value=[recent_app])
-
- with app.test_request_context("/apps/recent?limit=8"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(app_module.AppService, "get_recent_apps", get_recent_apps)
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(
- app=app_module.enterprise_rbac_service.ResourcePermissionSnapshot(
- overrides=[
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-1",
- permission_keys=["app.acl.monitor"],
- )
- ]
- )
- ),
- )
-
- resp, status = method(app_module.RecentAppListApi(), "tenant-1", "acct-1", unbound_session)
-
- assert status == 200
- assert resp == {
- "data": [
- {
- "id": "app-1",
- "name": "Recent App",
- "icon_type": "emoji",
- "icon": "🚀",
- "icon_background": "#FFFFFF",
- "mode": "chat",
- "author_name": "Recent Author",
- "updated_at": int(_ts(15).timestamp()),
- "permission_keys": ["app.acl.monitor"],
- "maintainer": "acct-1",
- "icon_url": None,
- }
- ]
- }
- params = get_recent_apps.call_args.args[2]
- assert params.limit == 8
- assert "total" not in resp
- assert "description" not in resp["data"][0]
- assert "tags" not in resp["data"][0]
- assert "workflow" not in resp["data"][0]
-
-
[email protected]("mode", ["channel", "rag-pipeline", "agent"])
-def test_recent_app_response_rejects_non_home_app_modes(app_module, mode: str) -> None:
- with pytest.raises(ValidationError):
- app_module.RecentAppResponse.model_validate(
- {
- "id": "app-1",
- "name": "Recent App",
- "mode": mode,
- "updated_at": _ts(),
- }
- )
-
-
-def test_recent_app_list_api_applies_rbac_visibility_filter(
- app, app_module, unbound_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.RecentAppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- get_recent_apps = MagicMock(return_value=[])
- with app.test_request_context("/apps/recent"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(app_module.AppService, "get_recent_apps", get_recent_apps)
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(
- workspace=app_module.enterprise_rbac_service.WorkspacePermissionSnapshot(
- permission_keys=["app.create_and_management"]
- )
- ),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "whitelist_resources",
- lambda tenant_id, account_id: SimpleNamespace(
- unrestricted=False,
- resource_ids=["app-shared"],
- ),
- )
-
- resp, status = method(app_module.RecentAppListApi(), "tenant-1", "acct-1", unbound_session)
-
- assert status == 200
- assert resp == {"data": []}
- params = get_recent_apps.call_args.args[2]
- assert params.accessible_app_ids == ["app-shared"]
- assert params.include_own_apps is False
-
-
-def test_app_list_api_limits_to_apps_created_by_current_user_without_view_permission(
- app, app_module, unbound_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- pagination = SimpleNamespace(page=1, per_page=20, total=0, has_next=False, items=[])
- get_paginate_apps = MagicMock(return_value=pagination)
-
- with app.test_request_context("/apps"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(app_module.AppService, "get_paginate_apps", get_paginate_apps)
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(
- workspace=app_module.enterprise_rbac_service.WorkspacePermissionSnapshot(
- permission_keys=["app.create_and_management"]
- )
- ),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "whitelist_resources",
- lambda tenant_id, account_id: SimpleNamespace(resource_ids=["app-shared", "app-not-permitted"]),
- )
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
-
- resp, status = method(app_module.AppListApi(), "tenant-1", "acct-1", unbound_session)
-
- assert status == 200
- assert resp["data"] == []
- params = get_paginate_apps.call_args.args[2]
- assert params.accessible_app_ids == ["app-not-permitted", "app-shared"]
- assert params.include_own_apps is False
- assert params.is_created_by_me is None
-
-
-def test_app_list_api_limits_to_preview_overrides_without_manage_own_permission(
- app, app_module, unbound_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- pagination = SimpleNamespace(page=1, per_page=20, total=0, has_next=False, items=[])
- get_paginate_apps = MagicMock(return_value=pagination)
-
- with app.test_request_context("/apps"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(app_module.AppService, "get_paginate_apps", get_paginate_apps)
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(
- app=app_module.enterprise_rbac_service.ResourcePermissionSnapshot(
- overrides=[
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-acl-shared",
- permission_keys=["app.acl.preview"],
- ),
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-full",
- permission_keys=["app.full_access"],
- ),
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-shared",
- permission_keys=["app.preview"],
- ),
- ]
- )
- ),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "whitelist_resources",
- lambda tenant_id, account_id: SimpleNamespace(resource_ids=["app-whitelist-only"]),
- )
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
-
- method(app_module.AppListApi(), "tenant-1", "acct-1", unbound_session)
-
- params = get_paginate_apps.call_args.args[2]
- assert params.accessible_app_ids == ["app-whitelist-only"]
- assert params.include_own_apps is False
- assert params.is_created_by_me is None
-
-
-def test_app_list_api_returns_no_apps_without_workspace_or_resource_view_permission(
- app, app_module, unbound_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppListApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- pagination = SimpleNamespace(page=1, per_page=20, total=0, has_next=False, items=[])
- get_paginate_apps = MagicMock(return_value=pagination)
-
- with app.test_request_context("/apps"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(app_module.AppService, "get_paginate_apps", get_paginate_apps)
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- lambda tenant_id, account_id, session: app_module.enterprise_rbac_service.MyPermissionsResponse(),
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppAccess,
- "whitelist_resources",
- lambda tenant_id, account_id: SimpleNamespace(resource_ids=["app-not-permitted"]),
- )
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
-
- method(app_module.AppListApi(), "tenant-1", "acct-1", unbound_session)
-
- params = get_paginate_apps.call_args.args[2]
- assert params.accessible_app_ids == ["app-not-permitted"]
- assert params.include_own_apps is False
- assert params.is_created_by_me is None
-
-
-def test_app_detail_api_attaches_current_user_permission_keys(
- app, app_module, sqlite_session: Session, config_overrides: Callable[..., None]
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppApi.get
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- app_obj = _app(
- app_id="app-1",
- tenant_id="tenant-1",
- name="Detail App",
- description="Summary",
- )
-
- with app.test_request_context("/apps/app-1"):
- with pytest.MonkeyPatch.context() as monkeypatch:
- get_app = MagicMock(return_value=app_obj)
- monkeypatch.setattr(app_module, "AppService", lambda: SimpleNamespace(get_app=get_app))
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
- get_permissions = MagicMock(
- return_value=app_module.enterprise_rbac_service.MyPermissionsResponse(
- app=app_module.enterprise_rbac_service.ResourcePermissionSnapshot(
- overrides=[
- app_module.enterprise_rbac_service.ResourcePermissionKeys(
- resource_id="app-1",
- permission_keys=[
- "app.acl.view_layout",
- "app.acl.edit",
- "app.acl.deploy",
- "app.acl.monitor",
- ],
- )
- ]
- )
- )
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.MyPermissions,
- "get",
- get_permissions,
- )
-
- resp = method(
- app_module.AppApi(),
- sqlite_session,
- "tenant-1",
- _account(account_id="acct-1"),
- app_model=app_obj,
- )
-
- get_app.assert_called_once_with(app_obj, session=sqlite_session)
- get_permissions.assert_called_once_with("tenant-1", "acct-1", app_id="app-1", session=sqlite_session)
- assert resp["permission_keys"] == [
- "app.acl.view_layout",
- "app.acl.edit",
- "app.acl.deploy",
- "app.acl.monitor",
- ]
-
-
-def test_app_copy_api_attaches_permission_keys(
- app,
- app_module,
- sqlite_session: Session,
- config_overrides: Callable[..., None],
-):
- config_overrides(RBAC_ENABLED=True)
- method = app_module.AppCopyApi.post
- while hasattr(method, "__wrapped__"):
- method = method.__wrapped__
-
- app_obj = App(
- id="00000000-0000-0000-0000-000000000101",
- tenant_id="00000000-0000-0000-0000-000000000102",
- name="Copied App",
- description="Summary",
- mode=AppMode.WORKFLOW,
- icon_type=IconType.EMOJI,
- icon="copy",
- icon_background="#ffffff",
- enable_site=True,
- enable_api=True,
- )
- sqlite_session.add(app_obj)
- sqlite_session.commit()
-
- import_result = SimpleNamespace(status=app_module.ImportStatus.COMPLETED, app_id=app_obj.id)
-
- with app.test_request_context("/apps/app-original/copy", method="POST", json={}):
- with pytest.MonkeyPatch.context() as monkeypatch:
- monkeypatch.setattr(
- app_module,
- "AppDslService",
- lambda *_args, **_kwargs: SimpleNamespace(
- copy_app=lambda **_kwargs: (import_result, app_obj),
- ),
- )
- monkeypatch.setattr(
- app_module.SystemFeatureService,
- "is_webapp_auth_enabled",
- lambda: False,
- )
- monkeypatch.setattr(
- app_module.enterprise_rbac_service.RBACService.AppPermissions,
- "batch_get",
- lambda tenant_id, account_id, app_ids, session: {app_obj.id: ["app.acl.view_layout", "app.acl.edit"]},
- )
-
- resp, status = method(
- app_module.AppCopyApi(),
- app_module.CopyAppPayload(),
- sqlite_session,
- "tenant-1",
- _account(account_id="acct-1"),
- app_model=_app(app_id="app-original", tenant_id="tenant-1"),
- )
-
- assert status == 201
- assert sqlite_session.get(App, app_obj.id) is not None
- assert resp["permission_keys"] == ["app.acl.view_layout", "app.acl.edit"]
diff --git a/api/tests/unit_tests/controllers/console/app/test_console_app_api.py b/api/tests/unit_tests/controllers/console/app/test_console_app_api.py
new file mode 100644
index 00000000000..a497bcd1fd0
--- /dev/null
+++ b/api/tests/unit_tests/controllers/console/app/test_console_app_api.py
@@ -0,0 +1,325 @@
+"""Transport contracts for the Console app application boundary."""
+
+import inspect
+from collections.abc import Callable
+from dataclasses import dataclass, field, replace
+from io import BytesIO
+from typing import cast
+from uuid import UUID
+
+import pytest
+from flask import Flask, Response
+from flask_restx import Resource
+from werkzeug.exceptions import BadRequest, Forbidden
+
+from controllers.console import flask_admission
+from controllers.console.app import app as controller
+from controllers.console.app.error import AppNotFoundError
+from libs.login import AccountWithTenant
+from machinery.context import RequestContext
+from models.account import Account, TenantAccountRole
+from services.agent.roster_package_entities import RosterAgentPackageExport
+from services.app.console_service import (
+ AppExportPaidPlanRequiredError,
+ ConsoleAppNotFoundError,
+ CreatorsPlatformDisabledError,
+ InvalidAppExportError,
+)
+from services.entities.app_entities import (
+ AppExportOptions,
+ AppListParams,
+ AppPage,
+ AppRecord,
+ AppTraceSettings,
+ CopyAppParams,
+ CreateAppParams,
+ StarredAppListParams,
+ UpdateAppParams,
+)
+from services.entities.dsl_entities import Import, ImportStatus
+from tests.unit_tests.config_override import apply_config_overrides
+
+APP_ID = UUID("11111111-1111-1111-1111-111111111111")
+CONTEXT = RequestContext("request", "trace", "actor", "workspace")
+RECORD = AppRecord(str(APP_ID), "Example", "chat")
+
+
+@dataclass
+class AppBoundary:
+ calls: list[tuple[object, ...]] = field(default_factory=list)
+ status: ImportStatus = ImportStatus.COMPLETED
+ exported: str | RosterAgentPackageExport = "dsl"
+ record: AppRecord = RECORD
+
+ def list_apps(self, context: RequestContext, params: AppListParams | StarredAppListParams) -> AppPage:
+ self.calls.append(("list", context, params))
+ return AppPage(params.page, params.limit, 1, False, [RECORD])
+
+ def create(self, context: RequestContext, params: CreateAppParams) -> AppRecord:
+ self.calls.append(("create", context, params))
+ return RECORD
+
+ def get(self, context: RequestContext, app_id: str) -> AppRecord:
+ self.calls.append(("get", context, app_id))
+ return self.record
+
+ def update(self, context: RequestContext, app_id: str, params: UpdateAppParams) -> AppRecord:
+ self.calls.append(("update", context, app_id, params))
+ return RECORD
+
+ def update_icon(self, context: RequestContext, app_id: str, **kwargs: object) -> AppRecord:
+ self.calls.append(("icon", context, app_id, kwargs))
+ return RECORD
+
+ def copy(self, context: RequestContext, app_id: str, params: CopyAppParams) -> tuple[Import, AppRecord | None]:
+ self.calls.append(("copy", context, app_id, params))
+ return Import(id="import", status=self.status), RECORD
+
+ def export(self, context: RequestContext, app_id: str, options: AppExportOptions) -> str | RosterAgentPackageExport:
+ self.calls.append(("export", context, app_id, options))
+ return self.exported
+
+ def publish(self, context: RequestContext, app_id: str) -> str:
+ self.calls.append(("publish", context, app_id))
+ return "https://creators.example.com"
+
+ def delete(self, context: RequestContext, app_id: str) -> None:
+ self.calls.append(("delete", context, app_id))
+
+ def set_trace(self, context: RequestContext, app_id: str, settings: AppTraceSettings) -> None:
+ self.calls.append(("trace", context, app_id, settings))
+
+
+@dataclass
+class AppServices:
+ console: AppBoundary
+
+
+@dataclass
+class Services:
+ apps: AppServices
+
+
+def boundary(monkeypatch: pytest.MonkeyPatch) -> AppBoundary:
+ boundary = AppBoundary()
+ monkeypatch.setattr(controller, "application_services", lambda: Services(AppServices(boundary)))
+ return boundary
+
+
+def invoke(resource: type[Resource], method: Callable[..., object], **kwargs: object) -> object:
+ return inspect.unwrap(method)(resource(), CONTEXT, **kwargs)
+
+
+def test_list_parses_repeated_filters_and_serializes_materialized_page(app: Flask, boundary: AppBoundary) -> None:
+ tag = str(APP_ID)
+ with app.test_request_context(f"/?page=2&limit=5&tag_ids={tag}&is_created_by_me=true"):
+ data, status = cast(tuple[dict[str, object], int], invoke(controller.AppListApi, controller.AppListApi.get))
+ assert status == 200
+ assert data["page"] == 2
+ assert data["limit"] == 5
+ assert boundary.calls[0][1] is CONTEXT
+ params = boundary.calls[0][2]
+ assert isinstance(params, AppListParams)
+ assert params.tag_ids == [tag]
+ assert params.is_created_by_me is True
+
+
[email protected]("configured", [True, False])
+def test_detail_resolves_urls_at_the_http_boundary(
+ app: Flask, boundary: AppBoundary, config_overrides: Callable[..., None], configured: bool
+) -> None:
+ config_overrides(
+ SERVICE_API_URL="https://api.example.com" if configured else "",
+ APP_WEB_URL="https://apps.example.com" if configured else "",
+ )
+ boundary.record = replace(RECORD, site={"code": "site", "title": "Example"})
+ with app.test_request_context("/", base_url="https://console.example.com/"):
+ response = cast(dict[str, object], invoke(controller.AppApi, controller.AppApi.get, app_id=APP_ID))
+ assert response["api_base_url"] == (
+ "https://api.example.com/v1" if configured else "https://console.example.com/v1"
+ )
+ site = response["site"]
+ assert isinstance(site, dict)
+ assert site["app_base_url"] == ("https://apps.example.com" if configured else "https://console.example.com")
+
+
[email protected]("icon_type", [None, "image"])
+def test_update_preserves_icon_type_omission_and_forwards_explicit_identity(
+ app: Flask, boundary: AppBoundary, icon_type: str | None
+) -> None:
+ payload = {"name": "Updated", "icon": "image-id"}
+ if icon_type is not None:
+ payload["icon_type"] = icon_type
+ with app.test_request_context("/", method="POST", json=payload):
+ data = cast(dict[str, object], invoke(controller.AppApi, controller.AppApi.put, app_id=APP_ID))
+ assert data["id"] == str(APP_ID)
+ assert boundary.calls[0][1:3] == (CONTEXT, str(APP_ID))
+ params = boundary.calls[0][3]
+ assert isinstance(params, UpdateAppParams)
+ assert params.icon_type == icon_type
+
+
+def test_icon_body_and_trace_body_are_parsed(app: Flask, boundary: AppBoundary) -> None:
+ with app.test_request_context("/", method="POST", json={"icon_type": "image", "icon": "image-id"}):
+ invoke(controller.AppIconApi, controller.AppIconApi.post, app_id=APP_ID)
+ assert boundary.calls[-1][-1] == {"icon_type": "image", "icon": "image-id", "icon_background": ""}
+ with app.test_request_context("/", method="POST", json={"enabled": True, "tracing_provider": "langfuse"}):
+ assert invoke(controller.AppTraceApi, controller.AppTraceApi.post, app_id=APP_ID) == {"result": "success"}
+ assert boundary.calls[-1] == ("trace", CONTEXT, str(APP_ID), AppTraceSettings(True, "langfuse"))
+
+
+ ("status", "expected"),
+ [
+ (ImportStatus.FAILED, 400),
+ (ImportStatus.PENDING, 202),
+ (ImportStatus.COMPLETED, 201),
+ (ImportStatus.COMPLETED_WITH_WARNINGS, 201),
+ ],
+)
+def test_copy_preserves_import_status_responses(
+ app: Flask, boundary: AppBoundary, status: ImportStatus, expected: int
+) -> None:
+ boundary.status = status
+ with app.test_request_context("/", method="POST", json={"name": "Copy"}):
+ data, code = cast(
+ tuple[dict[str, object], int], invoke(controller.AppCopyApi, controller.AppCopyApi.post, app_id=APP_ID)
+ )
+ assert code == expected
+ assert data["id"] == ("import" if expected != 201 else str(APP_ID))
+
+
+def test_export_serializes_yaml_and_closes_archive_on_response_close(app: Flask, boundary: AppBoundary) -> None:
+ with app.test_request_context("/?format=yaml&include_secret=true"):
+ assert invoke(controller.AppExportApi, controller.AppExportApi.get, app_id=APP_ID) == {"data": "dsl"}
+ options = boundary.calls[-1][-1]
+ assert isinstance(options, AppExportOptions)
+ assert options.include_secret is True
+ archive = BytesIO(b"zip")
+ boundary.exported = RosterAgentPackageExport(archive=archive, filename="example.ifpkg", size=3)
+ with app.test_request_context("/"):
+ response = invoke(controller.AppExportApi, controller.AppExportApi.get, app_id=APP_ID)
+ assert isinstance(response, Response)
+ assert response.mimetype == "application/zip"
+ assert "example.ifpkg" in response.headers["Content-Disposition"]
+ response.close()
+ assert archive.closed
+
+
+def test_export_closes_archive_when_send_file_fails(
+ app: Flask, boundary: AppBoundary, monkeypatch: pytest.MonkeyPatch
+) -> None:
+ archive = BytesIO(b"zip")
+ boundary.exported = RosterAgentPackageExport(archive=archive, filename="example.ifpkg", size=3)
+
+ def fail(*_args: object, **_kwargs: object) -> None:
+ raise OSError("delivery failed")
+
+ monkeypatch.setattr(controller, "send_file", fail)
+ with app.test_request_context("/"), pytest.raises(OSError):
+ invoke(controller.AppExportApi, controller.AppExportApi.get, app_id=APP_ID)
+ assert archive.closed
+
+
+def test_publish_delegates_and_delete_has_no_body(app: Flask, boundary: AppBoundary) -> None:
+ with app.test_request_context("/"):
+ assert invoke(
+ controller.AppPublishToCreatorsPlatformApi, controller.AppPublishToCreatorsPlatformApi.post, app_id=APP_ID
+ ) == {
+ "redirect_url": "https://creators.example.com",
+ }
+ assert invoke(controller.AppApi, controller.AppApi.delete, app_id=APP_ID) == ("", 204)
+ assert boundary.calls == [("publish", CONTEXT, str(APP_ID)), ("delete", CONTEXT, str(APP_ID))]
+
+
+ ("error", "expected"),
+ [
+ (ConsoleAppNotFoundError(), AppNotFoundError),
+ (InvalidAppExportError("invalid version"), BadRequest),
+ (AppExportPaidPlanRequiredError("paid plan required"), Forbidden),
+ ],
+)
+def test_application_errors_are_translated_at_transport_boundary(
+ monkeypatch: pytest.MonkeyPatch, error: Exception, expected: type[Exception]
+) -> None:
+ def fail(*_args: object, **_kwargs: object) -> None:
+ raise error
+
+ monkeypatch.setattr(Resource, "dispatch_request", fail)
+ with pytest.raises(expected):
+ controller.AppResource().dispatch_request()
+
+
+def test_disabled_creators_preserves_error_body(monkeypatch: pytest.MonkeyPatch) -> None:
+ def fail(*_args: object, **_kwargs: object) -> None:
+ raise CreatorsPlatformDisabledError("Creators Platform features are not enabled")
+
+ monkeypatch.setattr(Resource, "dispatch_request", fail)
+ assert controller.AppResource().dispatch_request() == ({"error": "Creators Platform features are not enabled"}, 403)
+
+
+ "method",
+ [
+ controller.AppApi.put,
+ controller.AppApi.delete,
+ controller.AppCopyApi.post,
+ controller.AppExportApi.get,
+ controller.AppNameApi.post,
+ controller.AppIconApi.post,
+ controller.AppSiteStatus.post,
+ controller.AppApiStatus.post,
+ controller.AppTraceApi.post,
+ ],
+)
+def test_mutations_reject_read_only_role_at_admission(
+ app: Flask, monkeypatch: pytest.MonkeyPatch, method: Callable[..., object]
+) -> None:
+ account = Account(name="Reader", email="[email protected]")
+ account.role = TenantAccountRole.NORMAL
+ apply_config_overrides(monkeypatch, RBAC_ENABLED=False)
+ monkeypatch.setattr(
+ flask_admission,
+ "current_account_with_tenant",
+ lambda: AccountWithTenant(account=account, tenant_id="workspace"),
+ )
+ injector = inspect.unwrap(method, stop=lambda f: "allowed_roles" in inspect.getclosurevars(f).nonlocals)
+ with app.test_request_context(), pytest.raises(Forbidden):
+ injector(None, app_id=APP_ID)
+
+
+def test_create_quota_is_part_of_admission_and_precedes_application_call(
+ app: Flask, boundary: AppBoundary, monkeypatch: pytest.MonkeyPatch
+) -> None:
+ from services.entities.feature_entities import FeatureModel, LimitationModel
+
+ account = Account(name="Editor", email="[email protected]")
+ account.role = TenantAccountRole.EDITOR
+ account.id = CONTEXT.account_id
+ identity = AccountWithTenant(account=account, tenant_id=CONTEXT.active_workspace_id)
+ apply_config_overrides(monkeypatch, DEPLOYMENT_EDITION="CLOUD", RBAC_ENABLED=False)
+ monkeypatch.setattr(flask_admission, "current_account_with_tenant", lambda: identity)
+ monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: identity)
+ monkeypatch.setattr(flask_admission, "enforce_rbac_checks", lambda **_kwargs: None)
+ monkeypatch.setattr(
+ "controllers.console.wraps.FeatureService.get_features",
+ lambda *_args, **_kwargs: FeatureModel(apps=LimitationModel(size=1, limit=1)),
+ )
+ injector = inspect.unwrap(
+ controller.AppListApi.post, stop=lambda f: "allowed_roles" in inspect.getclosurevars(f).nonlocals
+ )
+ with app.test_request_context(method="POST", json={"name": "Example", "mode": "chat"}), pytest.raises(Forbidden):
+ injector(controller.AppListApi())
+ assert boundary.calls == []
+
+
+def test_request_validation_retains_422_and_redacts_submitted_values(app: Flask, boundary: AppBoundary) -> None:
+ from werkzeug.exceptions import UnprocessableEntity
+
+ with app.test_request_context(method="PUT", json={"name": "", "icon": "private-input"}):
+ with pytest.raises(UnprocessableEntity) as error:
+ invoke(controller.AppApi, controller.AppApi.put, app_id=APP_ID)
+ assert "private-input" not in (error.value.description or "")
+ assert boundary.calls == []
diff --git a/api/tests/unit_tests/controllers/console/app/test_ops_trace_api.py b/api/tests/unit_tests/controllers/console/app/test_ops_trace_api.py
index e19d82c9a3b..11eca206243 100644
--- a/api/tests/unit_tests/controllers/console/app/test_ops_trace_api.py
+++ b/api/tests/unit_tests/controllers/console/app/test_ops_trace_api.py
@@ -25,7 +25,6 @@ from controllers.console.app.error import (
TracingProviderUnavailableError,
UnsupportedTracingProviderError,
)
-from core.ops.exceptions import TraceProviderNotInstalledError
from libs.exception import BaseHTTPException
from libs.login import AccountWithTenant
from machinery.context import RequestContext
@@ -141,22 +140,32 @@ def test_trace_config_without_sdk_can_be_read_when_absent_or_deleted(
configs.delete.assert_called_once_with(workspace_id=WORKSPACE_ID, app_id=APP_ID, tracing_provider="weave")
-def test_enable_tracing_maps_missing_dependency_to_unavailable(app: Flask) -> None:
- missing_dependency = TraceProviderNotInstalledError("weave", "wandb")
+def test_enable_tracing_maps_missing_dependency_to_unavailable(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
+ unavailable = AppTracingConfigProviderUnavailableError()
+ console_apps = MagicMock()
+ console_apps.set_trace.side_effect = unavailable
+ monkeypatch.setattr(
+ app_module,
+ "application_services",
+ lambda: SimpleNamespace(apps=SimpleNamespace(console=console_apps)),
+ )
with (
- patch.object(app_module.OpsTraceManager, "update_app_tracing_config", side_effect=missing_dependency),
- app.test_request_context("/"),
+ app.test_request_context(
+ "/",
+ method="POST",
+ json={"enabled": True, "tracing_provider": "weave"},
+ ),
pytest.raises(TracingProviderUnavailableError) as caught,
):
_original(app_module.AppTraceApi.post)(
app_module.AppTraceApi(),
- app_module.AppTracePayload(enabled=True, tracing_provider="weave"),
- SimpleNamespace(id=APP_ID),
+ _request_context(),
+ UUID(APP_ID),
)
assert caught.value.code == 400
assert caught.value.error_code == "tracing_provider_unavailable"
- assert caught.value.__cause__ is missing_dependency
+ assert caught.value.__cause__ is unavailable
@pytest.mark.parametrize("method", _MUTATION_METHODS)
diff --git a/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py b/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py
index 73c81206e7c..122efedda3d 100644
--- a/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py
+++ b/api/tests/unit_tests/controllers/console/app/test_roster_package_routes.py
@@ -1,41 +1,31 @@
import io
import zipfile
from collections.abc import Callable
+from dataclasses import dataclass, field
from inspect import unwrap
-from types import SimpleNamespace
-from unittest.mock import ANY, Mock
-from uuid import UUID
+from typing import BinaryIO, cast
+from uuid import uuid4
import httpx
import pytest
-import yaml
from flask import Flask
from pydantic import ValidationError
-from werkzeug.exceptions import BadRequest, Forbidden
+from sqlalchemy.orm import Session, sessionmaker
+from werkzeug.exceptions import Forbidden
from controllers.console.app import app as app_module
from controllers.console.app import app_import as import_module
from core.rbac import RBACPermission
-from enums import CloudPlan, DeploymentEdition
-from models.account import Account, Tenant
-from models.model import App, AppMode
+from machinery.context import RequestContext
+from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
from services import app_import_source
from services.agent.errors import InvalidRosterAgentPackageError
from services.agent.roster_package_importer import RosterAgentPackageImportResult
-from services.app_package_service import AppPackageService
-from services.entities.dsl_entities import DslImportWarning
-
-
-def _mock_download(monkeypatch: pytest.MonkeyPatch, content: bytes | None = None) -> Mock:
- fetch = Mock(
- return_value=httpx.Response(
- 200,
- content=content if content is not None else _roster_archive().getvalue(),
- request=httpx.Request("GET", "https://example.com/download"),
- )
- )
- monkeypatch.setattr(app_import_source.remote_fetcher, "make_request", fetch)
- return fetch
+from services.app.console_gateway import AppTransferGateway
+from services.app_package_service import AppPackageService, PreparedAppPackage
+from services.entities.dsl_entities import AppImportPackage, AppImportParams, DslImportWarning, Import, ImportStatus
+from services.entities.feature_entities import FeatureModel, LimitationModel
+from tests.unit_tests.controllers.conftest import ControllerTestServices
def _roster_archive() -> io.BytesIO:
@@ -46,29 +36,103 @@ def _roster_archive() -> io.BytesIO:
return source
-def _account() -> Account:
+def _mock_download(monkeypatch: pytest.MonkeyPatch, content: bytes | None = None) -> list[str]:
+ calls: list[str] = []
+
+ def fetch(method: str, url: str, **_kwargs: object) -> httpx.Response:
+ calls.append(url)
+ return httpx.Response(
+ 200,
+ content=content if content is not None else _roster_archive().getvalue(),
+ request=httpx.Request(method, url),
+ )
+
+ monkeypatch.setattr(app_import_source.remote_fetcher, "make_request", fetch)
+ return calls
+
+
+@dataclass(frozen=True)
+class AgentImportCall:
+ tenant_id: str
+ account: Account
+ content: bytes
+
+
+@dataclass
+class Imports:
+ context: RequestContext
+ dsl_calls: list[AppImportParams] = field(default_factory=list)
+ packages: list[PreparedAppPackage] = field(default_factory=list)
+ agent_calls: list[AgentImportCall] = field(default_factory=list)
+ status: ImportStatus = ImportStatus.COMPLETED
+ warnings: list[DslImportWarning] = field(default_factory=list)
+
+ def dsl(
+ self, context: RequestContext, params: AppImportParams, *, package: AppImportPackage | None = None
+ ) -> Import:
+ assert context == self.context
+ self.dsl_calls.append(params)
+ if package is not None:
+ assert isinstance(package, PreparedAppPackage)
+ assert not package.archive.closed
+ self.packages.append(package)
+ return Import(id="import-1", status=self.status, app_id="app-1")
+
+ def agent(self, *, source: BinaryIO, tenant_id: str, account: Account) -> RosterAgentPackageImportResult:
+ self.agent_calls.append(AgentImportCall(tenant_id, account, source.read()))
+ return RosterAgentPackageImportResult(app_id="app-1", agent_id="agent-1", warnings=self.warnings)
+
+
+def imports(
+ app_query_services: ControllerTestServices,
+ sqlite_session_factory: sessionmaker[Session],
+ monkeypatch: pytest.MonkeyPatch,
+ config_overrides: Callable[..., None],
+) -> Imports:
+ config_overrides(RBAC_ENABLED=False, DEPLOYMENT_EDITION="COMMUNITY")
+ actor, tenant = str(uuid4()), str(uuid4())
account = Account(name="Importer", email="[email protected]")
- account._current_tenant = Tenant(name="Workspace")
- account._current_tenant.id = "tenant-1"
- return account
+ account.id = actor
+ workspace = Tenant(name="Workspace")
+ workspace.id = tenant
+ with sqlite_session_factory.begin() as session:
+ session.add_all(
+ [
+ account,
+ workspace,
+ TenantAccountJoin(tenant_id=tenant, account_id=actor, role=TenantAccountRole.OWNER),
+ ]
+ )
+ result = Imports(RequestContext("request", None, actor, tenant))
+ transfers = app_query_services.apps.console._transfers
+ assert isinstance(transfers, AppTransferGateway)
+ monkeypatch.setattr(transfers, "import_dsl", result.dsl)
+ monkeypatch.setattr(transfers._agent_importer, "import_package", result.agent)
+ monkeypatch.setattr("services.app.console_gateway.SystemFeatureService.is_webapp_auth_enabled", lambda: False)
+ return result
-def test_existing_import_route_dispatches_json_without_changing_payload(
- app: Flask, monkeypatch: pytest.MonkeyPatch
-) -> None:
+def _post(
+ app: Flask,
+ imports: Imports,
+ *,
+ json: dict[str, object] | None = None,
+ data: dict[str, object] | None = None,
+) -> tuple[dict[str, object], int]:
api = import_module.AppImportApi()
- import_dsl = Mock(return_value=({"status": "completed"}, 200))
- monkeypatch.setattr(api, "_import_dsl", import_dsl)
- account = _account()
- with app.test_request_context(
- "/console/api/apps/imports", method="POST", json={"mode": "yaml-content", "yaml_content": "app: {}"}
- ):
- result = unwrap(api.post)(api, account)
- assert result == ({"status": "completed"}, 200)
- assert import_dsl.call_args.args == (
- import_module.AppImportPayload(mode="yaml-content", yaml_content="app: {}"),
- account,
- )
+ with app.test_request_context("/console/api/apps/imports", method="POST", json=json, data=data):
+ return cast(tuple[dict[str, object], int], unwrap(api.post)(api, imports.context))
+
+
+def test_existing_import_route_dispatches_json_without_changing_payload(app: Flask, imports: Imports) -> None:
+ data, status = _post(app, imports, json={"mode": "yaml-content", "yaml_content": "app: {}"})
+ assert status == 200
+ assert data["status"] == "completed"
+ assert [params.model_dump() for params in imports.dsl_calls] == [
+ AppImportParams(mode="yaml-content", yaml_content="app: {}").model_dump()
+ ]
+ assert imports.agent_calls == []
@pytest.mark.parametrize(
@@ -79,164 +143,103 @@ def test_existing_import_route_dispatches_json_without_changing_payload(
" https://example.com/agent.IFPKG?token=secret#download ",
],
)
-def test_package_url_uses_agent_import(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], url: str
-) -> None:
- config_overrides(RBAC_ENABLED=False)
- importer = Mock()
- fetch = _mock_download(monkeypatch)
- importer.import_package.return_value = RosterAgentPackageImportResult(
- app_id="app-1", agent_id="agent-1", warnings=[]
- )
- monkeypatch.setattr(import_module, "RosterAgentPackageImporter", lambda: importer)
- api = import_module.AppImportApi()
- import_dsl = Mock()
- monkeypatch.setattr(api, "_import_dsl", import_dsl)
- account = _account()
- with app.test_request_context(
- "/console/api/apps/imports", method="POST", json={"mode": "yaml-url", "yaml_url": url}
- ):
- data, status = unwrap(api.post)(api, account)
+def test_package_url_uses_agent_import(app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, url: str) -> None:
+ fetched = _mock_download(monkeypatch)
+ data, status = _post(app, imports, json={"mode": "yaml-url", "yaml_url": url})
assert status == 200
assert data["app_mode"] == "agent"
assert data["status"] == "completed"
- fetch.assert_called_once()
- assert importer.import_package.call_args.kwargs["tenant_id"] == "tenant-1"
- assert importer.import_package.call_args.kwargs["account"] is account
- import_dsl.assert_not_called()
+ assert len(fetched) == 1
+ assert imports.dsl_calls == []
+ (call,) = imports.agent_calls
+ assert call.tenant_id == imports.context.active_workspace_id
+ assert call.account.id == imports.context.account_id
+ assert call.account.is_admin_or_owner is True
@pytest.mark.parametrize(
"url", ["https://example.com/app.yaml", "https://example.com/download", "https://example.com/agent.ifpkg"]
)
def test_yaml_url_keeps_dsl_import_without_package_retry(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], url: str
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, url: str
) -> None:
- config_overrides(RBAC_ENABLED=False)
- fetch = _mock_download(monkeypatch, b"app: {}")
- api = import_module.AppImportApi()
- import_dsl = Mock(return_value=({"status": "failed", "error": "Missing app data"}, 400))
- import_package = Mock()
- monkeypatch.setattr(api, "_import_dsl", import_dsl)
- monkeypatch.setattr(api, "_import_package", import_package)
- with app.test_request_context(
- "/console/api/apps/imports",
- method="POST",
- json={"mode": "yaml-url", "yaml_url": url, "app_id": "existing", "name": "Renamed"},
- ):
- result = unwrap(api.post)(api, _account())
- assert result[1] == 400
- assert import_dsl.call_args.args[0] == import_module.AppImportPayload(
- mode="yaml-content", yaml_content="app: {}", app_id="existing", name="Renamed"
+ imports.status = ImportStatus.FAILED
+ fetched = _mock_download(monkeypatch, b"app: {}")
+ _, status = _post(app, imports, json={"mode": "yaml-url", "yaml_url": url, "app_id": "existing", "name": "Renamed"})
+ assert status == 400
+ assert (
+ imports.dsl_calls[0].model_dump()
+ == AppImportParams(mode="yaml-content", yaml_content="app: {}", app_id="existing", name="Renamed").model_dump()
)
- fetch.assert_called_once()
- import_package.assert_not_called()
+ assert len(fetched) == 1
+ assert imports.agent_calls == []
def test_url_without_any_import_permission_does_not_download(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None]
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None]
) -> None:
config_overrides(RBAC_ENABLED=True)
- _mock_download(monkeypatch)
- account = _account()
- monkeypatch.setattr("controllers.common.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
- monkeypatch.setattr("controllers.common.rbac.checks.RBACService.CheckAccess.check", lambda *_args, **_kwargs: False)
- fetch = _mock_download(monkeypatch)
- api = import_module.AppImportApi()
- with app.test_request_context(
- "/console/api/apps/imports",
- method="POST",
- json={"mode": "yaml-url", "yaml_url": "https://example.com/download"},
- ):
- with pytest.raises(Forbidden):
- unwrap(api.post)(api, account)
- fetch.assert_not_called()
+ monkeypatch.setattr(
+ "services.app.console_gateway.rbac_service.RBACService.CheckAccess.check", lambda *_a, **_k: False
+ )
+ fetched = _mock_download(monkeypatch)
+ with pytest.raises(Forbidden):
+ _post(app, imports, json={"mode": "yaml-url", "yaml_url": "https://example.com/download"})
+ assert fetched == []
@pytest.mark.parametrize("is_yaml", [False, True])
def test_url_quota_is_enforced_after_content_detection(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], is_yaml: bool
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], is_yaml: bool
) -> None:
- config_overrides(RBAC_ENABLED=False, DEPLOYMENT_EDITION="CLOUD")
- account = _account()
- monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
- features = Mock()
- features.apps = SimpleNamespace(size=1, limit=1)
- monkeypatch.setattr("controllers.console.wraps.FeatureService.get_features", lambda *_args, **_kwargs: features)
+ config_overrides(DEPLOYMENT_EDITION="CLOUD")
+ features = FeatureModel(apps=LimitationModel(size=1, limit=1))
+ monkeypatch.setattr("services.app.console_gateway.FeatureService.get_features", lambda *_a, **_k: features)
_mock_download(monkeypatch, b"app: {}" if is_yaml else _roster_archive().getvalue())
- importer = Mock()
- importer.import_package.return_value = RosterAgentPackageImportResult(
- app_id="app-1", agent_id="agent-1", warnings=[]
- )
- monkeypatch.setattr(import_module, "RosterAgentPackageImporter", lambda: importer)
- api = import_module.AppImportApi()
- with app.test_request_context(
- "/console/api/apps/imports",
- method="POST",
- json={"mode": "yaml-url", "yaml_url": "https://example.com/download"},
- ):
- if is_yaml:
- with pytest.raises(Forbidden, match="number of apps"):
- unwrap(api.post)(api, account)
- importer.import_package.assert_not_called()
- else:
- data, status = unwrap(api.post)(api, account)
- assert status == 200
- assert data["app_mode"] == "agent"
+ if is_yaml:
+ with pytest.raises(Forbidden, match="number of apps"):
+ _post(app, imports, json={"mode": "yaml-url", "yaml_url": "https://example.com/download"})
+ assert imports.agent_calls == []
+ assert imports.dsl_calls == []
+ else:
+ data, status = _post(app, imports, json={"mode": "yaml-url", "yaml_url": "https://example.com/download"})
+ assert status == 200
+ assert data["app_mode"] == "agent"
def test_url_rejects_content_that_is_neither_yaml_nor_package(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None]
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch
) -> None:
- config_overrides(RBAC_ENABLED=False)
- fetch = _mock_download(monkeypatch, b"[invalid")
- api = import_module.AppImportApi()
- with app.test_request_context(
- "/console/api/apps/imports",
- method="POST",
- json={"mode": "yaml-url", "yaml_url": "https://example.com/download"},
- ):
- with pytest.raises(InvalidRosterAgentPackageError):
- unwrap(api.post)(api, _account())
- fetch.assert_called_once()
+ fetched = _mock_download(monkeypatch, b"[invalid")
+ with pytest.raises(InvalidRosterAgentPackageError):
+ _post(app, imports, json={"mode": "yaml-url", "yaml_url": "https://example.com/download"})
+ assert len(fetched) == 1
@pytest.mark.parametrize("has_warning", [False, True])
def test_existing_import_route_accepts_package_and_preserves_import_response(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], has_warning: bool
+ app: Flask, imports: Imports, has_warning: bool
) -> None:
- config_overrides(RBAC_ENABLED=False)
- account = _account()
- warnings = (
+ imports.warnings = (
[DslImportWarning(code="agent_skill_missing", path="skills.s_000001", message="Missing Skill")]
if has_warning
else []
)
- import_package = Mock(
- return_value=RosterAgentPackageImportResult(app_id="app-1", agent_id="agent-1", warnings=warnings)
- )
- monkeypatch.setattr(
- import_module, "RosterAgentPackageImporter", lambda: SimpleNamespace(import_package=import_package)
- )
- api = import_module.AppImportApi()
- with app.test_request_context(
- "/console/api/apps/imports", method="POST", data={"file": (_roster_archive(), "agent.ifpkg")}
- ):
- data, status = unwrap(api.post)(api, account)
- assert import_package.call_args.kwargs["source"].read() == _roster_archive().getvalue()
+ data, status = _post(app, imports, data={"file": (_roster_archive(), "agent.ifpkg")})
assert status == 200
assert data["app_id"] == "app-1"
assert data["app_mode"] == "agent"
assert data["status"] == ("completed-with-warnings" if has_warning else "completed")
- assert data["warnings"] == [warning.model_dump(mode="json") for warning in warnings]
+ assert data["warnings"] == [warning.model_dump(mode="json") for warning in imports.warnings]
assert data["id"]
- assert import_package.call_args.kwargs["tenant_id"] == "tenant-1"
+ assert imports.agent_calls[0].content == _roster_archive().getvalue()
@pytest.mark.parametrize("from_url", [False, True])
@pytest.mark.parametrize("denied", [RBACPermission.AGENT_CREATE, RBACPermission.AGENT_IMPORT_EXPORT_DSL])
def test_package_import_checks_agent_permissions_before_materializing_resources(
app: Flask,
+ imports: Imports,
monkeypatch: pytest.MonkeyPatch,
config_overrides: Callable[..., None],
denied: RBACPermission,
@@ -244,206 +247,81 @@ def test_package_import_checks_agent_permissions_before_materializing_resources(
) -> None:
config_overrides(RBAC_ENABLED=True)
_mock_download(monkeypatch)
- account = _account()
- monkeypatch.setattr("controllers.common.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
- scenes = []
+ scenes: list[RBACPermission] = []
- def check(*_args, **kwargs: object) -> bool:
- scenes.append(kwargs["scene"])
- return kwargs["scene"] != denied
+ def check(*_args: object, scene: RBACPermission, **_kwargs: object) -> bool:
+ scenes.append(scene)
+ return scene != denied
- monkeypatch.setattr("controllers.common.rbac.checks.RBACService.CheckAccess.check", check)
- importer = Mock()
- monkeypatch.setattr(import_module, "RosterAgentPackageImporter", importer)
- api = import_module.AppImportApi()
- request_kwargs = (
+ monkeypatch.setattr("services.app.console_gateway.rbac_service.RBACService.CheckAccess.check", check)
+ kwargs: dict[str, dict[str, object]] = (
{"json": {"mode": "yaml-url", "yaml_url": "https://example.com/agent.ifpkg"}}
if from_url
else {"data": {"file": (_roster_archive(), "agent.ifpkg")}}
)
- with app.test_request_context("/console/api/apps/imports", method="POST", **request_kwargs):
- with pytest.raises(Forbidden):
- unwrap(api.post)(api, account)
+ with pytest.raises(Forbidden):
+ _post(app, imports, **kwargs)
assert denied in scenes
if not from_url:
assert RBACPermission.APP_IMPORT_EXPORT_DSL not in scenes
- importer.assert_not_called()
+ assert imports.agent_calls == []
@pytest.mark.parametrize("from_url", [False, True])
def test_package_import_rejects_overwrite(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], from_url: bool
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, from_url: bool
) -> None:
- config_overrides(RBAC_ENABLED=False)
_mock_download(monkeypatch)
- api = import_module.AppImportApi()
- request_kwargs = (
+ kwargs: dict[str, dict[str, object]] = (
{"json": {"mode": "yaml-url", "yaml_url": "https://example.com/agent.ifpkg", "app_id": "existing"}}
if from_url
else {"data": {"app_id": "existing", "file": (_roster_archive(), "agent.ifpkg")}}
)
- with app.test_request_context("/console/api/apps/imports", method="POST", **request_kwargs):
- with pytest.raises(InvalidRosterAgentPackageError, match="overwriting"):
- unwrap(api.post)(api, _account())
-
-
[email protected]("query", [{}, {"format": "ifpkg"}])
-def test_existing_export_route_returns_ifpkg_for_agent(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], query: dict[str, str]
-) -> None:
- config_overrides(DEPLOYMENT_EDITION=DeploymentEdition.CLOUD)
- get_plan = Mock(return_value=CloudPlan.SANDBOX)
- monkeypatch.setattr(app_module.FeatureService, "get_workspace_plan", get_plan)
- model = App(id="app-1", tenant_id="tenant-1", mode=AppMode.AGENT)
- monkeypatch.setattr(App, "bound_agent_id_with_session", lambda _self, **_kwargs: "agent-1")
- monkeypatch.setattr(app_module, "db", SimpleNamespace(session=lambda: object()))
- archive = io.BytesIO(b"package")
- close = Mock()
- export = Mock(return_value=SimpleNamespace(archive=archive, filename="agent.ifpkg", close=close))
- monkeypatch.setattr(app_module, "RosterAgentPackageExporter", lambda: SimpleNamespace(export=export))
- with app.test_request_context("/console/api/apps/app-1/export", query_string=query):
- response = unwrap(app_module.AppExportApi.get)(
- app_module.AppExportApi(), app_module.AppExportQuery.model_validate(query), model
- )
- response.direct_passthrough = False
- assert response.get_data() == b"package"
- assert response.mimetype == "application/zip"
- assert "agent.ifpkg" in response.headers["Content-Disposition"]
- response.close()
- export.assert_called_once_with(tenant_id="tenant-1", agent_id="agent-1", version_id=None)
- get_plan.assert_not_called()
- close.assert_called_once_with()
-
-
- "mode", [AppMode.WORKFLOW, AppMode.ADVANCED_CHAT, AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT]
-)
[email protected]("query", [{}, {"format": "ifpkg"}])
-def test_default_export_packages_ordinary_app_dsl(
- app: Flask, monkeypatch: pytest.MonkeyPatch, mode: AppMode, query: dict[str, str]
-) -> None:
- model = App(id="app-1", tenant_id="tenant-1", mode=mode, name="My App")
- dsl = f"kind: app\nversion: 0.7.0\napp:\n mode: {mode}\n"
- export = Mock(return_value=yaml.safe_load(dsl))
- session = object()
- monkeypatch.setattr(app_module, "db", SimpleNamespace(session=lambda: session))
- monkeypatch.setattr(app_module.AppDslService, "export_data", export)
- with app.test_request_context():
- response = unwrap(app_module.AppExportApi.get)(
- app_module.AppExportApi(),
- app_module.AppExportQuery.model_validate({**query, "include_secret": True, "workflow_id": "revision-1"}),
- model,
- )
- response.direct_passthrough = False
- assert response.mimetype == "application/zip"
- assert "my-app.ifpkg" in response.headers["Content-Disposition"]
- prepared = AppPackageService().read_package(io.BytesIO(response.get_data()))
- assert prepared is not None
- with prepared:
- assert yaml.safe_load(prepared.dsl) == yaml.safe_load(dsl)
- response.close()
- export.assert_called_once_with(
- app_model=model, session=ANY, include_secret=True, workflow_id="revision-1", resource_exporter=ANY
- )
+ with pytest.raises(InvalidRosterAgentPackageError, match="overwriting"):
+ _post(app, imports, **kwargs)
@pytest.mark.parametrize("from_url", [False, True])
@pytest.mark.parametrize("app_id", [None, "existing"])
[email protected]("status", [200, 202, 400])
[email protected]("status", [ImportStatus.COMPLETED, ImportStatus.PENDING, ImportStatus.FAILED])
def test_ordinary_package_import_uses_dsl_permissions_and_confirmation(
app: Flask,
+ imports: Imports,
monkeypatch: pytest.MonkeyPatch,
- config_overrides: Callable[..., None],
app_id: str | None,
- status: int,
+ status: ImportStatus,
from_url: bool,
) -> None:
- config_overrides(RBAC_ENABLED=False)
- account = _account()
- api = import_module.AppImportApi()
+ imports.status = status
dsl = "kind: app\nversion: 99.0.0\napp:\n mode: workflow\n"
- import_dsl = Mock(return_value=({"status": "pending"}, status))
- monkeypatch.setattr(api, "_import_dsl", import_dsl)
- agent_import = Mock()
- monkeypatch.setattr(api, "_import_agent_package", agent_import)
with AppPackageService().export(dsl=dsl, name="Workflow") as package:
- form = {"file": (package.archive, "workflow.ifpkg"), "name": "Renamed"}
+ form: dict[str, object] = {"file": (package.archive, "workflow.ifpkg"), "name": "Renamed"}
if app_id:
form["app_id"] = app_id
if from_url:
_mock_download(monkeypatch, package.archive.read())
- with app.test_request_context(
- method="POST",
+ data, code = _post(
+ app,
+ imports,
json={
"mode": "yaml-url",
"yaml_url": "https://example.com/workflow.ifpkg",
"name": "Renamed",
"app_id": app_id,
},
- ):
- assert unwrap(api.post)(api, account) == ({"status": "pending"}, status)
+ )
else:
- with app.test_request_context(method="POST", data=form):
- assert unwrap(api.post)(api, account) == ({"status": "pending"}, status)
- import_dsl.assert_called_once_with(
- import_module.AppImportPayload(mode="yaml-content", yaml_content=dsl, name="Renamed", app_id=app_id),
- account,
- package=ANY,
+ data, code = _post(app, imports, data=form)
+ assert code == {ImportStatus.FAILED: 400, ImportStatus.PENDING: 202}.get(status, 200)
+ assert len(imports.packages) == 1
+ assert imports.packages[0].archive.closed
+ assert data["status"] == status
+ assert len(imports.dsl_calls) == 1
+ assert (
+ imports.dsl_calls[0].model_dump()
+ == AppImportParams(mode="yaml-content", yaml_content=dsl, name="Renamed", app_id=app_id).model_dump()
)
- assert import_dsl.call_args.kwargs["package"].archive.closed
- agent_import.assert_not_called()
-
-
[email protected]("export_format", [None, "ifpkg", "yaml"])
- ("edition", "plan", "allowed"),
- [
- (DeploymentEdition.CLOUD, CloudPlan.SANDBOX, False),
- (DeploymentEdition.CLOUD, CloudPlan.PROFESSIONAL, True),
- (DeploymentEdition.CLOUD, CloudPlan.TEAM, True),
- (DeploymentEdition.COMMUNITY, CloudPlan.SANDBOX, True),
- (DeploymentEdition.ENTERPRISE, CloudPlan.SANDBOX, True),
- ],
-)
-def test_version_export_requires_cloud_paid_plan(
- app: Flask,
- monkeypatch: pytest.MonkeyPatch,
- config_overrides: Callable[..., None],
- export_format: str | None,
- edition: DeploymentEdition,
- plan: CloudPlan,
- allowed: bool,
-) -> None:
- config_overrides(DEPLOYMENT_EDITION=edition)
- get_plan = Mock(return_value=plan)
- monkeypatch.setattr(app_module.FeatureService, "get_workspace_plan", get_plan)
- model = App(id="app-1", tenant_id="tenant-1", mode=AppMode.AGENT)
- monkeypatch.setattr(App, "bound_agent_id_with_session", lambda _self, **_kwargs: "agent-1")
- monkeypatch.setattr(app_module, "db", SimpleNamespace(session=lambda: object()))
- export = Mock(return_value=SimpleNamespace(archive=io.BytesIO(b"package"), filename="agent.ifpkg", close=Mock()))
- monkeypatch.setattr(app_module, "RosterAgentPackageExporter", lambda: SimpleNamespace(export=export))
- export_dsl = Mock(return_value="app: {}")
- monkeypatch.setattr(app_module.AppDslService, "export_dsl", export_dsl)
- version_id = "11111111-1111-4111-8111-111111111111"
- query = app_module.AppExportQuery.model_validate({"format": export_format, "version_id": version_id})
- with app.test_request_context("/console/api/apps/app-1/export"):
- if not allowed:
- with pytest.raises(Forbidden, match="paid plan"):
- unwrap(app_module.AppExportApi.get)(app_module.AppExportApi(), query, model)
- export.assert_not_called()
- export_dsl.assert_not_called()
- else:
- response = unwrap(app_module.AppExportApi.get)(app_module.AppExportApi(), query, model)
- if export_format == "yaml":
- assert response == {"data": "app: {}"}
- assert export_dsl.call_args.kwargs["version_id"] == UUID(version_id)
- else:
- export.assert_called_once_with(tenant_id="tenant-1", agent_id="agent-1", version_id=UUID(version_id))
- response.close()
- if edition == DeploymentEdition.CLOUD:
- get_plan.assert_called_once_with("tenant-1")
- else:
- get_plan.assert_not_called()
+ assert imports.agent_calls == []
def test_export_query_rejects_conflicting_version_selectors() -> None:
@@ -453,67 +331,17 @@ def test_export_query_rejects_conflicting_version_selectors() -> None:
)
-def test_version_export_rejects_non_agent_apps() -> None:
- query = app_module.AppExportQuery.model_validate({"version_id": "11111111-1111-4111-8111-111111111111"})
- with pytest.raises(BadRequest):
- unwrap(app_module.AppExportApi.get)(
- app_module.AppExportApi(), query, App(id="app-1", tenant_id="tenant-1", mode=AppMode.WORKFLOW)
- )
-
-
- ("mode", "query"),
- [(AppMode.AGENT, {"format": "yaml"}), (AppMode.WORKFLOW, {"format": "yaml"})],
-)
-def test_yaml_export_remains_available(monkeypatch: pytest.MonkeyPatch, mode: AppMode, query: dict[str, str]) -> None:
- model = App(id="app-1", tenant_id="tenant-1", mode=mode)
- monkeypatch.setattr(app_module, "db", SimpleNamespace(session=lambda: object()))
- monkeypatch.setattr(app_module.AppDslService, "export_dsl", lambda **_kwargs: "app: {}")
- assert unwrap(app_module.AppExportApi.get)(
- app_module.AppExportApi(), app_module.AppExportQuery.model_validate(query), model
- ) == {"data": "app: {}"}
-
-
-def test_ordinary_package_import_checks_app_permission(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None]
-) -> None:
- config_overrides(RBAC_ENABLED=True)
- account = _account()
- monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
- monkeypatch.setattr("controllers.common.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
- check = Mock(return_value=False)
- monkeypatch.setattr("controllers.common.rbac.checks.RBACService.CheckAccess.check", check)
- service = Mock()
- monkeypatch.setattr(import_module, "AppDslService", service)
- with AppPackageService().export(dsl="kind: app\napp: {mode: workflow}\n", name="Workflow") as package:
- with app.test_request_context(method="POST", data={"file": (package.archive, "workflow.ifpkg")}):
- api = import_module.AppImportApi()
- with pytest.raises(Forbidden):
- unwrap(api.post)(api, account)
- assert check.call_args.kwargs["scene"] == RBACPermission.APP_IMPORT_EXPORT_DSL
- service.assert_not_called()
-
-
-def test_ordinary_package_import_cannot_bypass_app_quota(
- app: Flask, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None]
[email protected]("quota", [False, True])
+def test_ordinary_package_import_checks_permission_and_quota(
+ app: Flask, imports: Imports, monkeypatch: pytest.MonkeyPatch, config_overrides: Callable[..., None], quota: bool
) -> None:
- config_overrides(DEPLOYMENT_EDITION="CLOUD", RBAC_ENABLED=False)
- account = _account()
- monkeypatch.setattr("controllers.console.wraps.current_account_with_tenant", lambda: (account, "tenant-1"))
+ config_overrides(RBAC_ENABLED=not quota, DEPLOYMENT_EDITION="CLOUD" if quota else "COMMUNITY")
monkeypatch.setattr(
- "controllers.console.wraps.FeatureService.get_features",
- lambda *_args, **_kwargs: SimpleNamespace(
- members=None,
- apps=SimpleNamespace(limit=1, size=1),
- documents_upload_quota=None,
- annotation_quota_limit=None,
- ),
+ "services.app.console_gateway.rbac_service.RBACService.CheckAccess.check", lambda *_a, **_k: False
)
- service = Mock()
- monkeypatch.setattr(import_module, "AppDslService", service)
+ features = FeatureModel(apps=LimitationModel(size=1, limit=1))
+ monkeypatch.setattr("services.app.console_gateway.FeatureService.get_features", lambda *_a, **_k: features)
with AppPackageService().export(dsl="kind: app\napp: {mode: workflow}\n", name="Workflow") as package:
- with app.test_request_context(method="POST", data={"file": (package.archive, "workflow.ifpkg")}):
- api = import_module.AppImportApi()
- with pytest.raises(Forbidden):
- unwrap(api.post)(api, account)
- service.assert_not_called()
+ with pytest.raises(Forbidden):
+ _post(app, imports, data={"file": (package.archive, "workflow.ifpkg")})
+ assert imports.dsl_calls == []
diff --git a/api/tests/unit_tests/controllers/console/datasets/test_datasets.py b/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
index 1e6bcd66095..ac2383009f5 100644
--- a/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
+++ b/api/tests/unit_tests/controllers/console/datasets/test_datasets.py
@@ -4,7 +4,7 @@ from collections.abc import Callable
from contextlib import ExitStack
from inspect import unwrap
from types import SimpleNamespace
-from unittest.mock import ANY, MagicMock, PropertyMock, call, patch
+from unittest.mock import ANY, MagicMock, PropertyMock, patch
import pytest
from flask import Flask
@@ -54,12 +54,15 @@ from machinery.context import RequestContext
from models.account import Account, Tenant, TenantAccountRole
from models.dataset import AppDatasetJoin, Dataset, DatasetPermission, DatasetQuery, Document, DocumentSegment
from models.enums import CreatorUserRole, DataSourceType, DocumentCreatedFrom, IndexingStatus, SegmentStatus
-from models.model import ApiToken, App, AppMode, DatasetApiTokenBinding, IconType, UploadFile
+from models.model import ApiToken, AppMode, DatasetApiTokenBinding, IconType, UploadFile
from services.dataset_ref_service import DatasetRef
from services.dataset_service import DatasetPermissionService, DatasetService
from services.enterprise import rbac_service as enterprise_rbac_service
+from services.entities.app_entities import AppRecord
from tests.unit_tests.controllers.rbac_introspection import rbac_checks
+pytestmark = pytest.mark.usefixtures("app_query_services")
+
@pytest.fixture(autouse=True)
def dataset_model_property_defaults():
@@ -132,24 +135,21 @@ def make_account(role: TenantAccountRole = TenantAccountRole.EDITOR) -> Account:
return account
-def make_related_app(**overrides) -> App:
+def make_related_app(**overrides) -> AppRecord:
base = {
"id": "app-1",
- "tenant_id": "tenant-1",
"name": "App",
"description": "desc",
- "mode": AppMode.CHAT,
+ "mode_compatible_with_agent": AppMode.CHAT,
"icon_type": IconType.EMOJI,
"icon": "🤖",
"icon_background": "#fff",
- "app_model_config_id": None,
- "workflow_id": None,
"enable_site": False,
"enable_api": False,
"created_by": "account-1",
}
base.update(overrides)
- return App(**base)
+ return AppRecord(**base)
def test_dataset_delete_requires_dataset_delete_permission() -> None:
@@ -1319,15 +1319,9 @@ class TestDatasetRelatedAppListApi(_UsesSQLiteSession):
patch("controllers.console.datasets.datasets.DatasetService.check_dataset_permission", return_value=None),
patch("controllers.console.datasets.datasets.DatasetService.get_related_apps", return_value=[join1, join2]),
patch(
- "controllers.console.datasets.datasets.AppService.get_app_by_id",
- side_effect=[app1, app2],
- ) as get_app_by_id,
- patch.object(
- App,
- "mode_compatible_with_agent_with_session",
- autospec=True,
- side_effect=lambda app_model, *, session: str(app_model.mode),
- ) as compatible_mode,
+ "services.app.query_service.AppQueryService.related_apps",
+ return_value=[app1, app2],
+ ) as related_apps,
):
response, status = method(api, session, make_account(), "dataset-1")
assert status == 200
@@ -1354,8 +1348,7 @@ class TestDatasetRelatedAppListApi(_UsesSQLiteSession):
"icon_url": None,
},
]
- assert compatible_mode.call_args_list == [call(app1, session=session), call(app2, session=session)]
- assert get_app_by_id.call_args_list == [call("app-1", session), call("app-2", session)]
+ related_apps.assert_called_once_with(dataset.tenant_id, ["app-1", "app-2"])
def test_get_dataset_not_found(self, app: Flask):
api = DatasetRelatedAppListApi()
@@ -1396,8 +1389,8 @@ class TestDatasetRelatedAppListApi(_UsesSQLiteSession):
patch("controllers.console.datasets.datasets.DatasetService.check_dataset_permission", return_value=None),
patch("controllers.console.datasets.datasets.DatasetService.get_related_apps", return_value=[join1, join2]),
patch(
- "controllers.console.datasets.datasets.AppService.get_app_by_id",
- side_effect=[app1, None],
+ "services.app.query_service.AppQueryService.related_apps",
+ return_value=[app1],
),
):
response, status = method(api, session, make_account(), "dataset-1")
diff --git a/api/tests/unit_tests/controllers/console/workspace/test_snippets.py b/api/tests/unit_tests/controllers/console/workspace/test_snippets.py
index 1ceba157337..aae1f7a381e 100644
--- a/api/tests/unit_tests/controllers/console/workspace/test_snippets.py
+++ b/api/tests/unit_tests/controllers/console/workspace/test_snippets.py
@@ -85,7 +85,10 @@ def test_snippet_list_query_ignores_indexed_values(app: Flask):
assert query.creators is None
-def test_list_snippets_returns_pagination(app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session):
[email protected]("app_query_services")
+def test_list_snippets_returns_pagination(
+ application_tags, app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
+):
snippets = [_snippet()]
tag_id = "11111111-1111-1111-1111-111111111111"
get_snippets = Mock(return_value=(snippets, 1, False))
@@ -133,6 +136,7 @@ def test_list_snippets_returns_pagination(app: Flask, monkeypatch: pytest.Monkey
is_published=None,
creators=["account-2"],
tag_ids=[tag_id],
+ tags=application_tags,
)
@@ -420,6 +424,7 @@ def _persisted_name(session: Session) -> str | None:
return stored.name if stored else None
[email protected]("app_query_services")
def test_delete_snippet_delegates_to_service(app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session):
snippet = _snippet()
user = _account()
@@ -441,6 +446,7 @@ def test_delete_snippet_delegates_to_service(app: Flask, monkeypatch: pytest.Mon
assert isinstance(delete_snippet.call_args.kwargs["snippet"], CustomizedSnippet)
[email protected]("app_query_services")
def test_export_snippet_returns_yaml_attachment(app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session):
snippet = _snippet(name="Snippet One")
export_snippet_dsl = Mock(return_value="version: 0.1.0\nkind: snippet\n")
@@ -467,6 +473,7 @@ def test_export_snippet_returns_yaml_attachment(app: Flask, monkeypatch: pytest.
export_snippet_dsl.assert_called_once_with(snippet=snippet, include_secret=True, workflow_id="workflow-1")
[email protected]("app_query_services")
def test_export_snippet_raises_not_found_for_missing_workflow(
app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
@@ -490,6 +497,7 @@ def test_export_snippet_raises_not_found_for_missing_workflow(
handler(api, sqlite_session, "tenant-1", snippet_id="snippet-1")
[email protected]("app_query_services")
def test_import_snippet_returns_202_for_pending_confirmation(
app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
@@ -519,6 +527,7 @@ def test_import_snippet_returns_202_for_pending_confirmation(
import_snippet.assert_called_once()
[email protected]("app_query_services")
def test_import_snippet_returns_400_for_failed_import(
app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
@@ -547,6 +556,7 @@ def test_import_snippet_returns_400_for_failed_import(
assert response["error"] == "Invalid DSL"
[email protected]("app_query_services")
def test_import_confirm_returns_200_for_completed_import(
app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
@@ -586,6 +596,7 @@ def test_check_dependencies_raises_when_snippet_missing(
handler(api, sqlite_session, "tenant-1", snippet_id="snippet-1")
[email protected]("app_query_services")
def test_check_dependencies_returns_dependency_result(
app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
):
diff --git a/api/tests/unit_tests/controllers/inner_api/app/test_dsl.py b/api/tests/unit_tests/controllers/inner_api/app/test_dsl.py
index 309ad2647d2..f7f33f0ef7c 100644
--- a/api/tests/unit_tests/controllers/inner_api/app/test_dsl.py
+++ b/api/tests/unit_tests/controllers/inner_api/app/test_dsl.py
@@ -1,13 +1,12 @@
"""Unit tests for inner_api app DSL import/export endpoints.
-Tests Pydantic model validation, endpoint handler logic, and the
-_get_active_account helper. Auth/setup decorators are tested separately
+Tests Pydantic model validation and endpoint handler logic. Auth/setup decorators are tested separately
in test_auth_wraps.py; handler tests use inspect.unwrap() to bypass them.
"""
import inspect
from types import SimpleNamespace
-from unittest.mock import MagicMock, patch
+from unittest.mock import patch
from uuid import uuid4
import pytest
@@ -23,12 +22,12 @@ from controllers.inner_api.app.dsl import (
EnterpriseAppDSLExport,
EnterpriseAppDSLImport,
InnerAppDSLImportPayload,
- _get_active_account,
)
from models import Account, App, Tenant, TenantAccountJoin
from models.account import AccountStatus, TenantAccountRole
from models.model import AppMode, IconType
-from services.app_dsl_service import Import, ImportStatus
+from services.app_dsl_service import AppDslService
+from services.entities.dsl_entities import Import, ImportStatus
from services.errors.app import IsDraftWorkflowError, WorkflowNotFoundError
from tests.unit_tests.config_override import config_overrides_context
@@ -104,151 +103,104 @@ class TestInnerAppDSLImportPayload:
assert "creator_email" in str(exc_info.value)
-class TestGetActiveAccount:
- """Test the _get_active_account helper function."""
-
- def test_returns_active_account(self, sqlite_session: Session):
- account = Account(name="Active", email="[email protected]", status=AccountStatus.ACTIVE)
- sqlite_session.add(account)
- sqlite_session.commit()
-
- with patch.object(dsl_module.db, "session", sqlite_session):
- result = _get_active_account("[email protected]")
-
- assert result is account
-
- def test_returns_none_for_inactive_account(self, sqlite_session: Session):
- account = Account(name="Banned", email="[email protected]", status=AccountStatus.BANNED)
- sqlite_session.add(account)
- sqlite_session.commit()
-
- with patch.object(dsl_module.db, "session", sqlite_session):
- result = _get_active_account("[email protected]")
-
- assert result is None
-
- def test_returns_none_for_nonexistent_email(self, sqlite_session: Session):
- with patch.object(dsl_module.db, "session", sqlite_session):
- result = _get_active_account("[email protected]")
-
- assert result is None
-
-
[email protected]("app_query_services")
class TestEnterpriseAppDSLImport:
- """Test EnterpriseAppDSLImport endpoint handler logic.
-
- Uses inspect.unwrap() to bypass auth/setup decorators.
- """
+ """Exercise the composed import path with real account and membership reads."""
+
+ @pytest.mark.parametrize(
+ ("import_status", "http_status", "transaction"),
+ [
+ (ImportStatus.COMPLETED, 200, "commit"),
+ (ImportStatus.PENDING, 202, "commit"),
+ (ImportStatus.FAILED, 400, "rollback"),
+ ],
+ )
+ def test_import_releases_lookup_connections_and_finishes_transaction(
+ self,
+ app: Flask,
+ sqlite_session: Session,
+ sqlite_engine: Engine,
+ monkeypatch: pytest.MonkeyPatch,
+ import_status: ImportStatus,
+ http_status: int,
+ transaction: str,
+ ):
+ account = _persist_account(sqlite_session)
+ account_id = account.id
+ sqlite_session.close()
+ connections: set[object] = set()
+ transactions: list[str] = []
- @pytest.fixture
- def api_instance(self):
- return EnterpriseAppDSLImport()
+ def checkout(connection: object, *_args: object) -> None:
+ connections.add(connection)
- @pytest.fixture
- def _mock_import_deps(self, sqlite_engine: Engine):
- """Bind the handler Session to SQLite and isolate the DSL service boundary."""
- self._transaction_events: list[str] = []
+ def checkin(connection: object, *_args: object) -> None:
+ connections.discard(connection)
- def on_commit(session: Session) -> None:
+ def committed(session: Session) -> None:
if session.get_bind() is sqlite_engine:
- self._transaction_events.append("commit")
+ transactions.append("commit")
- def on_rollback(session: Session) -> None:
+ def rolled_back(session: Session) -> None:
if session.get_bind() is sqlite_engine:
- self._transaction_events.append("rollback")
-
- event.listen(Session, "after_commit", on_commit)
- event.listen(Session, "after_rollback", on_rollback)
- with (
- patch.object(dsl_module, "db", SimpleNamespace(engine=sqlite_engine)),
- patch("controllers.inner_api.app.dsl.AppDslService") as mock_dsl_cls,
- ):
- self._mock_dsl = MagicMock()
- mock_dsl_cls.return_value = self._mock_dsl
- yield
- event.remove(Session, "after_commit", on_commit)
- event.remove(Session, "after_rollback", on_rollback)
-
- def _make_import_result(self, status: ImportStatus, **kwargs) -> Import:
- result = Import(
- id="import-id",
- status=status,
- app_id=kwargs.get("app_id", "app-123"),
- app_mode=kwargs.get("app_mode", "workflow"),
- )
- return result
-
- @pytest.mark.usefixtures("_mock_import_deps")
- @patch("controllers.inner_api.app.dsl._get_active_account")
- def test_import_success_returns_200(self, mock_get_account, api_instance, app: Flask, sqlite_session: Session):
- account = _persist_account(sqlite_session)
- self._transaction_events.clear()
- mock_get_account.return_value = account
- self._mock_dsl.import_app.return_value = self._make_import_result(ImportStatus.COMPLETED)
-
- unwrapped = inspect.unwrap(api_instance.post)
- payload = {
- "yaml_content": "version: 0.6.0\n",
- "creator_email": "[email protected]",
- }
- with app.test_request_context(json=payload):
- result = unwrapped(api_instance, InnerAppDSLImportPayload.model_validate(payload), workspace_id="ws-123")
-
- body, status_code = result
- assert status_code == 200
- assert body["status"] == "completed"
- assert account.current_tenant_id == "ws-123"
- assert self._mock_dsl.import_app.call_args.kwargs["account"] is account
- assert self._transaction_events == ["commit"]
-
- @pytest.mark.usefixtures("_mock_import_deps")
- @patch("controllers.inner_api.app.dsl._get_active_account")
- def test_import_pending_returns_202(self, mock_get_account, api_instance, app: Flask, sqlite_session: Session):
- mock_get_account.return_value = _persist_account(sqlite_session)
- self._transaction_events.clear()
- self._mock_dsl.import_app.return_value = self._make_import_result(ImportStatus.PENDING)
-
- unwrapped = inspect.unwrap(api_instance.post)
- payload = {"yaml_content": "test", "creator_email": "[email protected]"}
- with app.test_request_context(json=payload):
- body, status_code = unwrapped(
- api_instance, InnerAppDSLImportPayload.model_validate(payload), workspace_id="ws-123"
+ transactions.append("rollback")
+
+ def import_app(service: AppDslService, *, account: Account, **kwargs: object) -> Import:
+ assert not connections
+ assert account.id == account_id
+ assert account.current_tenant_id == "ws-123"
+ assert kwargs["yaml_content"] == "version: 0.6.0\n"
+ # Open a real write transaction to verify the adapter's completion policy.
+ service._session.add(
+ App(tenant_id="ws-123", name="imported", mode=AppMode.WORKFLOW, enable_site=False, enable_api=False)
)
-
- assert status_code == 202
- assert body["status"] == "pending"
- assert self._transaction_events == ["commit"]
-
- @pytest.mark.usefixtures("_mock_import_deps")
- @patch("controllers.inner_api.app.dsl._get_active_account")
- def test_import_failed_returns_400(self, mock_get_account, api_instance, app: Flask, sqlite_session: Session):
- mock_get_account.return_value = _persist_account(sqlite_session)
- self._transaction_events.clear()
- self._mock_dsl.import_app.return_value = self._make_import_result(ImportStatus.FAILED)
-
- unwrapped = inspect.unwrap(api_instance.post)
- payload = {"yaml_content": "test", "creator_email": "[email protected]"}
- with app.test_request_context(json=payload):
- body, status_code = unwrapped(
- api_instance, InnerAppDSLImportPayload.model_validate(payload), workspace_id="ws-123"
+ service._session.flush()
+ return Import(id="import-id", status=import_status, app_id="app-123", app_mode="workflow")
+
+ monkeypatch.setattr(AppDslService, "import_app", import_app)
+ listeners = [
+ (sqlite_engine, "checkout", checkout),
+ (sqlite_engine, "checkin", checkin),
+ (Session, "after_commit", committed),
+ (Session, "after_rollback", rolled_back),
+ ]
+ for target, name, callback in listeners:
+ event.listen(target, name, callback)
+ try:
+ payload = InnerAppDSLImportPayload(yaml_content="version: 0.6.0\n", creator_email="[email protected]")
+ with app.test_request_context():
+ body, status = inspect.unwrap(EnterpriseAppDSLImport.post)(
+ EnterpriseAppDSLImport(), payload, workspace_id="ws-123"
+ )
+ assert status == http_status
+ assert body["status"] == import_status
+ assert transactions == [transaction]
+ assert not connections
+ finally:
+ for target, name, callback in listeners:
+ event.remove(target, name, callback)
+
+ @pytest.mark.parametrize("creator_email", ["[email protected]", "[email protected]", "[email protected]"])
+ def test_missing_or_inactive_creator_returns_404(
+ self,
+ app: Flask,
+ sqlite_session: Session,
+ creator_email: str,
+ ):
+ sqlite_session.add_all(
+ [
+ Account(name="Banned", email="[email protected]", status=AccountStatus.BANNED),
+ Account(name="Active", email="[email protected]", status=AccountStatus.ACTIVE),
+ ]
+ )
+ sqlite_session.commit()
+ payload = InnerAppDSLImportPayload(yaml_content="test", creator_email=creator_email)
+ with app.test_request_context():
+ body, status = inspect.unwrap(EnterpriseAppDSLImport.post)(
+ EnterpriseAppDSLImport(), payload, workspace_id="ws-123"
)
-
- assert status_code == 400
- assert body["status"] == "failed"
- assert self._transaction_events == ["rollback"]
-
- @patch("controllers.inner_api.app.dsl._get_active_account")
- def test_import_account_not_found_returns_404(self, mock_get_account, api_instance, app: Flask):
- mock_get_account.return_value = None
-
- unwrapped = inspect.unwrap(api_instance.post)
- payload = {"yaml_content": "test", "creator_email": "[email protected]"}
- with app.test_request_context(json=payload):
- result = unwrapped(api_instance, InnerAppDSLImportPayload.model_validate(payload), workspace_id="ws-123")
-
- body, status_code = result
- assert status_code == 404
- assert "[email protected]" in body["message"]
+ assert status == 404
+ assert creator_email in body["message"]
class TestEnterpriseAppDSLExport:
diff --git a/api/tests/unit_tests/controllers/openapi/auth/test_pipelines.py b/api/tests/unit_tests/controllers/openapi/auth/test_pipelines.py
index 8b306667ce8..0616895adad 100644
--- a/api/tests/unit_tests/controllers/openapi/auth/test_pipelines.py
+++ b/api/tests/unit_tests/controllers/openapi/auth/test_pipelines.py
@@ -6,6 +6,8 @@ from unittest.mock import patch
import pytest
from flask import Flask
+from sqlalchemy import event
+from sqlalchemy.engine import Engine
from sqlalchemy.orm import Session
from werkzeug.exceptions import Forbidden, Unauthorized
@@ -31,12 +33,15 @@ from controllers.openapi.auth.spec import CatalogMeta, EndpointSpec, Kind
from controllers.openapi.auth.subjects import _SUBJECT_CLASSES, AccountSubject, Subject
from enums import DeploymentEdition
from libs.oauth_bearer import AuthContext, try_get_auth_ctx
+from machinery.context import RequestContext
from services.account_service import AccountService, TenantService
from services.app_service import AppService
from services.enterprise.enterprise_service import WebAppAccessMode
from ._world import (
+ ACCOUNT_ID,
APP_ID,
+ TENANT_ID,
account_subject,
make_account,
make_app,
@@ -251,6 +256,69 @@ def test_every_registrable_subject_has_a_pipeline() -> None:
assert set(_SUBJECT_CLASSES.values()) == set(_PIPELINES)
[email protected]("handler_raises", [False, True])
+def test_account_context_releases_admission_connection_before_handler(
+ app: Flask,
+ sqlite_session: Session,
+ sqlite_engine: Engine,
+ monkeypatch: pytest.MonkeyPatch,
+ handler_raises: bool,
+) -> None:
+ persist(sqlite_session, make_app(), make_tenant(), make_account(), make_membership())
+ monkeypatch.setattr(MOUNT, lambda _user: None)
+ subject = account_subject()
+ connections: set[object] = set()
+ checkouts: list[object] = []
+
+ def checkout(connection: object, *_args: object) -> None:
+ connections.add(connection)
+ checkouts.append(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ connections.discard(connection)
+
+ def call(*, ctx: RequestContext) -> str:
+ assert isinstance(ctx, RequestContext)
+ assert (ctx.account_id, ctx.active_workspace_id) == (ACCOUNT_ID, TENANT_ID)
+ assert checkouts
+ assert not connections
+ assert not sqlite_session.in_transaction()
+ assert try_get_auth_ctx() == subject.auth
+ if handler_raises:
+ raise RuntimeError("import failed")
+ return "imported"
+
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+
+ def run() -> str:
+ return AccountPipeline().run(
+ subject=subject,
+ auth=subject.auth,
+ spec=EndpointSpec(
+ account_context=True,
+ requirements=(CheckAppApiEnabled(), CheckWorkspaceMember()),
+ catalog=CatalogMeta(op="test.account_context", kind=Kind.OBJECT, summary="test"),
+ ),
+ ctx=make_ctx(sqlite_session, subject, app_id=APP_ID),
+ session=sqlite_session,
+ call=call,
+ )
+
+ try:
+ with app.test_request_context(headers=_current_catalog(app)):
+ if handler_raises:
+ with pytest.raises(RuntimeError, match="import failed"):
+ run()
+ else:
+ assert run() == "imported"
+ assert not connections
+ assert try_get_auth_ctx() is None
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
def test_every_pipeline_checks_the_catalog_before_anything_else() -> None:
"""Fixed first and in the first band, so nothing a route declares below
`Rank.FIRST` - and nothing that mints a row - runs on a stale catalog.
diff --git a/api/tests/unit_tests/controllers/openapi/test_app_dsl.py b/api/tests/unit_tests/controllers/openapi/test_app_dsl.py
index f6c010091bf..709b4f76651 100644
--- a/api/tests/unit_tests/controllers/openapi/test_app_dsl.py
+++ b/api/tests/unit_tests/controllers/openapi/test_app_dsl.py
@@ -1,22 +1,18 @@
from collections.abc import Callable
-from types import SimpleNamespace
from typing import Protocol, cast
-from unittest.mock import Mock
import pytest
from flask import Flask
-from sqlalchemy.engine import Engine
from werkzeug.exceptions import Forbidden
-from controllers.openapi import app_dsl as app_dsl_module
from controllers.openapi._contract import op_of
from controllers.openapi._models import AppDslImportPayload, AppDslImportResponse, Hint
from controllers.openapi.app_dsl import AppDslImportApi, AppDslImportConfirmApi
from controllers.openapi.auth.spec import EndpointSpec
-from models import Account
-from services.app_dsl_service import Import
-from services.entities.dsl_entities import ImportStatus
+from machinery.context import RequestContext
+from services.entities.dsl_entities import Import, ImportStatus
from services.errors.account import NoPermissionError
+from tests.unit_tests.controllers.conftest import ControllerTestServices
class _EndpointView(Protocol):
@@ -43,21 +39,22 @@ class _EndpointView(Protocol):
],
)
def test_permission_denial_maps_to_forbidden(
+ app_query_services: ControllerTestServices,
app: Flask,
monkeypatch: pytest.MonkeyPatch,
- sqlite_engine: Engine,
api: AppDslImportApi | AppDslImportConfirmApi,
kwargs: dict[str, object],
) -> None:
- service = Mock()
- service.import_app.side_effect = NoPermissionError("denied")
- service.confirm_import.side_effect = NoPermissionError("denied")
- monkeypatch.setattr(app_dsl_module, "AppDslService", Mock(return_value=service))
- monkeypatch.setattr(app_dsl_module, "db", SimpleNamespace(engine=sqlite_engine))
+ def denied(*_args: object, **_kwargs: object) -> None:
+ raise NoPermissionError("denied")
+
+ monkeypatch.setattr(app_query_services.apps.imports, "import_app", denied)
+ monkeypatch.setattr(app_query_services.apps.imports, "confirm_import", denied)
+ context = RequestContext("request-1", None, "account-1", "workspace-1")
with app.test_request_context("/openapi/v1/workspaces/workspace-1/apps/imports", method="POST"):
with pytest.raises(Forbidden, match="denied") as exc_info:
- cast(_EndpointView, api.post).__handler__(api, SimpleNamespace(account=Mock(spec=Account)), **kwargs)
+ cast(_EndpointView, api.post).__handler__(api, context, **kwargs)
assert isinstance(exc_info.value.__cause__, NoPermissionError)
@@ -81,18 +78,20 @@ def test_permission_denial_maps_to_forbidden(
],
)
def test_import_hints_a_confirm_only_while_pending(
- app: Flask, monkeypatch: pytest.MonkeyPatch, sqlite_engine: Engine, result: Import, status: int, hints: list[Hint]
+ app_query_services: ControllerTestServices,
+ app: Flask,
+ monkeypatch: pytest.MonkeyPatch,
+ result: Import,
+ status: int,
+ hints: list[Hint],
) -> None:
- service = Mock()
- service.import_app.return_value = result
- monkeypatch.setattr(app_dsl_module, "AppDslService", Mock(return_value=service))
- monkeypatch.setattr(app_dsl_module, "db", SimpleNamespace(engine=sqlite_engine))
+ monkeypatch.setattr(app_query_services.apps.imports, "import_app", lambda *_args, **_kwargs: result)
api = AppDslImportApi()
with app.test_request_context("/openapi/v1/workspaces/workspace-1/apps/imports", method="POST"):
response, code = cast(_EndpointView, api.post).__handler__(
api,
- SimpleNamespace(account=Mock(spec=Account)),
+ RequestContext("request-1", None, "account-1", "workspace-1"),
workspace_id="workspace-1",
body=AppDslImportPayload(mode="yaml-content", yaml_content="app: {}"),
)
diff --git a/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_apis.py b/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_apis.py
index 89da1671549..30aa4c5b66a 100644
--- a/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_apis.py
+++ b/api/tests/unit_tests/controllers/service_api/dataset/test_dataset_apis.py
@@ -189,6 +189,7 @@ def assert_dataset_detail_shape(response: dict[str, object], *, with_partial_mem
# ---------------------------------------------------------------------------
[email protected]("app_query_services")
class TestDatasetListApiGet:
"""Test suite for DatasetListApi.get() endpoint."""
diff --git a/api/tests/unit_tests/controllers/web/test_web_login.py b/api/tests/unit_tests/controllers/web/test_web_login.py
index b1adb66f2a9..3974ccfa223 100644
--- a/api/tests/unit_tests/controllers/web/test_web_login.py
+++ b/api/tests/unit_tests/controllers/web/test_web_login.py
@@ -18,7 +18,10 @@ from models.account import Account
from models.model import DifySetup
from services.entities.auth_audit_entities import LoginFailureReason
-pytestmark = pytest.mark.parametrize("sqlite_session", [(DifySetup,)], indirect=True)
+pytestmark = [
+ pytest.mark.parametrize("sqlite_session", [(DifySetup,)], indirect=True),
+ pytest.mark.usefixtures("app_query_services"),
+]
def encode_code(code: str) -> str:
@@ -253,8 +256,10 @@ class TestLoginStatusApi:
@patch("controllers.web.login.decode_jwt_token")
@patch("controllers.web.login.PassportService")
- @patch("controllers.web.login.WebAppAuthService.is_app_require_permission_check", return_value=False)
- @patch("controllers.web.login.AppService.get_app_id_by_code", return_value="app-1")
+ @patch(
+ "services.webapp_access_query_service.WebAppAccessQueryService.requires_permission_check", return_value=False
+ )
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.get_app_id_by_code", return_value="app-1")
@patch("controllers.web.login.extract_webapp_access_token", return_value="tok")
def test_public_app_user_logged_in(
self,
@@ -275,8 +280,8 @@ class TestLoginStatusApi:
@patch("controllers.web.login.decode_jwt_token", side_effect=Exception("bad"))
@patch("controllers.web.login.PassportService")
- @patch("controllers.web.login.WebAppAuthService.is_app_require_permission_check", return_value=True)
- @patch("controllers.web.login.AppService.get_app_id_by_code", return_value="app-1")
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.requires_permission_check", return_value=True)
+ @patch("services.webapp_access_query_service.WebAppAccessQueryService.get_app_id_by_code", return_value="app-1")
@patch("controllers.web.login.extract_webapp_access_token", return_value="tok")
def test_private_app_passport_fails(
self,
@@ -304,3 +309,13 @@ class TestLogoutApi:
assert response.get_json() == {"result": "success"}
mock_clear.assert_called_once()
+
+
+def test_unknown_web_app_code_returns_http_not_found(app: Flask) -> None:
+ from flask_restx import Api
+
+ api = Api(app)
+ api.add_resource(LoginStatusApi, "/web/login/status")
+ response = app.test_client().get("/web/login/status?app_code=does-not-exist")
+ assert response.status_code == 404
+ assert response.get_json()["code"] == "app_not_found"
diff --git a/api/tests/unit_tests/controllers/web/test_wraps.py b/api/tests/unit_tests/controllers/web/test_wraps.py
index b3c35d70aa3..638eeadc3b1 100644
--- a/api/tests/unit_tests/controllers/web/test_wraps.py
+++ b/api/tests/unit_tests/controllers/web/test_wraps.py
@@ -105,3 +105,26 @@ def test_decode_jwt_token_uses_shared_session_factory(sqlite_session: Session) -
assert result_app.id == app_model.id
assert result_end_user.id == end_user.id
+
+
[email protected]("app_query_services")
[email protected]("token", [None, "expired-token"])
+def test_web_auth_rejects_unknown_app_code_with_http_not_found(app, monkeypatch, token):
+ from controllers.web import wraps
+ from libs.external_api import ExternalApi
+
+ class ProtectedApi(wraps.WebApiResource):
+ def get(self, _app, _user):
+ pytest.fail("An unknown WebApp must not reach the protected resource")
+
+ def reject_token(_self, _token):
+ raise Unauthorized("Authentication has expired.")
+
+ monkeypatch.setattr(wraps.SystemFeatureService, "is_webapp_auth_enabled", staticmethod(lambda: True))
+ monkeypatch.setattr(wraps, "extract_webapp_passport", lambda _code, _request: token)
+ monkeypatch.setattr(wraps.PassportService, "verify", reject_token)
+ api = ExternalApi(app)
+ api.add_resource(ProtectedApi, "/protected")
+ response = app.test_client().get("/protected", headers={"X-App-Code": "does-not-exist"})
+ assert response.status_code == 404
+ assert response.get_json()["code"] == "app_not_found"
diff --git a/api/tests/unit_tests/core/ops/test_ops_trace_manager.py b/api/tests/unit_tests/core/ops/test_ops_trace_manager.py
index 5d0d0847578..ba456261407 100644
--- a/api/tests/unit_tests/core/ops/test_ops_trace_manager.py
+++ b/api/tests/unit_tests/core/ops/test_ops_trace_manager.py
@@ -10,7 +10,7 @@ from collections.abc import Iterator
from datetime import datetime, timedelta
from decimal import Decimal
from types import SimpleNamespace
-from unittest.mock import MagicMock, PropertyMock, patch
+from unittest.mock import PropertyMock, patch
from uuid import UUID
import pytest
@@ -467,29 +467,6 @@ def test_message_config_lookup_uses_real_conversation_and_model_config(database:
assert OpsTraceManager.get_app_config_through_message_id("missing") is None
-def test_update_and_get_app_tracing_config_persist_state(
- trace_environment: None, database: Session, monkeypatch: pytest.MonkeyPatch
-) -> None:
- monkeypatch.setattr(module, "provider_config_map", FakeProviderMap({"langfuse": PROVIDER_ENTRY}))
- app = _app(database)
- assert OpsTraceManager.get_app_tracing_config(app.id, database) == {
- "enabled": False,
- "tracing_provider": None,
- }
- OpsTraceManager.update_app_tracing_config(app.id, True, "langfuse")
- database.expire_all()
- assert OpsTraceManager.get_app_tracing_config(app.id, database) == {
- "enabled": True,
- "tracing_provider": "langfuse",
- }
- with pytest.raises(ValueError, match="Invalid tracing provider"):
- OpsTraceManager.update_app_tracing_config(app.id, True, "missing")
- with pytest.raises(ValueError, match="App not found"):
- OpsTraceManager.update_app_tracing_config("missing", False, None)
- with pytest.raises(ValueError, match="App not found"):
- OpsTraceManager.get_app_tracing_config("missing", database)
-
-
@pytest.mark.parametrize("module_name", ["dify_trace_weave", "wandb"])
def test_provider_loader_identifies_missing_optional_dependency(
monkeypatch: pytest.MonkeyPatch, module_name: str
@@ -527,37 +504,6 @@ def test_provider_loader_preserves_import_errors_in_installed_packages(failure:
assert caught.value is failure
[email protected]("provider", ["weave", None])
-def test_disable_tracing_does_not_load_provider(
- database: Session, monkeypatch: pytest.MonkeyPatch, provider: str | None
-) -> None:
- app = _app(database, tracing=json.dumps({"enabled": True, "tracing_provider": "weave"}))
- providers = MagicMock()
- monkeypatch.setattr(module, "provider_config_map", providers)
-
- OpsTraceManager.update_app_tracing_config(app.id, False, provider)
-
- database.expire_all()
- assert OpsTraceManager.get_app_tracing_config(app.id, database) == {
- "enabled": False,
- "tracing_provider": provider,
- }
- providers.__getitem__.assert_not_called()
-
-
-def test_enable_tracing_requires_provider_dependencies(database: Session, monkeypatch: pytest.MonkeyPatch) -> None:
- app = _app(database)
- providers = MagicMock()
- providers.__getitem__.side_effect = TraceProviderNotInstalledError("weave", "wandb")
- monkeypatch.setattr(module, "provider_config_map", providers)
-
- with pytest.raises(TraceProviderNotInstalledError):
- OpsTraceManager.update_app_tracing_config(app.id, True, "weave")
-
- database.expire_all()
- assert app.tracing is None
-
-
def test_message_trace_reads_real_conversation_app_and_message_file(
trace_environment: None,
database: Session,
diff --git a/api/tests/unit_tests/events/test_app_event_signals.py b/api/tests/unit_tests/events/test_app_event_signals.py
index f0ce7014b50..7519487a808 100644
--- a/api/tests/unit_tests/events/test_app_event_signals.py
+++ b/api/tests/unit_tests/events/test_app_event_signals.py
@@ -1,5 +1,5 @@
import json
-from collections.abc import Iterator
+from collections.abc import Callable, Iterator
from unittest.mock import patch
from uuid import uuid4
@@ -7,12 +7,15 @@ import pytest
from sqlalchemy import event, select
from sqlalchemy.orm import Session
-from events.app_event import app_was_deleted, app_was_updated
+from events.app_event import app_was_created, app_was_deleted, app_was_updated
+from events.event_handlers.create_installed_app_when_app_created import handle as create_installed_app
+from events.event_handlers.create_site_record_when_app_created import handle as create_site
+from machinery.context import RequestContext
from models.account import Account
from models.agent import Agent, AgentWorkspace
from models.dataset import AppDatasetJoin
from models.model import App, AppMode, AppModelConfig, IconType, InstalledApp, Site
-from services.app_service import AppService
+from services.entities.app_entities import AppEvent, UpdateAppParams
@pytest.fixture
@@ -54,8 +57,8 @@ def app_model(sqlite_session: Session, account: Account) -> App:
return app
-def _make_collector(target: list[App]):
- def handler(sender: App, **_kwargs: object) -> None:
+def _make_collector[T](target: list[T]) -> Callable[..., None]:
+ def handler(sender: T, **_kwargs: object) -> None:
target.append(sender)
return handler
@@ -64,51 +67,64 @@ def _make_collector(target: list[App]):
@pytest.mark.parametrize("sqlite_session", [(App, Account, Agent, AgentWorkspace)], indirect=True)
@pytest.mark.usefixtures("_mock_deps")
class TestAppWasDeletedSignal:
- def test_sends_signal(self, app_model: App, sqlite_session: Session) -> None:
- received: list[App] = []
+ def test_sends_signal(self, app_services, app_model: App, sqlite_session: Session) -> None:
+ received: list[AppEvent] = []
handler = _make_collector(received)
app_was_deleted.connect(handler)
try:
- AppService().delete_app(app_model, session=sqlite_session)
+ app_services.console.delete(RequestContext("req", None, "test-actor", app_model.tenant_id), app_model.id)
finally:
app_was_deleted.disconnect(handler)
- assert received == [app_model]
- assert sqlite_session.get(App, app_model.id) is None
+ assert received == [AppEvent(app_model.id, app_model.tenant_id, str(app_model.mode))]
+ app_id = app_model.id
+ sqlite_session.expunge_all()
+ assert sqlite_session.get(App, app_id) is None
- def test_signal_fires_before_db_delete(self, app_model: App, sqlite_session: Session) -> None:
+ def test_signal_fires_after_db_commit(
+ self, sqlite_session_factory, app_services, app_model: App, sqlite_session: Session
+ ) -> None:
call_order: list[str] = []
- def signal_handler(_sender: App, **_kwargs: object) -> None:
+ def signal_handler(_sender: AppEvent, **_kwargs: object) -> None:
call_order.append("signal")
def before_flush(session: Session, *_args: object) -> None:
- if app_model in session.deleted:
+ if any(isinstance(row, App) and row.id == app_model.id for row in session.deleted):
call_order.append("db_delete")
app_was_deleted.connect(signal_handler)
- event.listen(sqlite_session, "before_flush", before_flush)
+ event.listen(sqlite_session_factory, "before_flush", before_flush)
+
+ def after_commit(_session: Session) -> None:
+ call_order.append("commit")
+
+ event.listen(sqlite_session_factory, "after_commit", after_commit)
try:
- AppService().delete_app(app_model, session=sqlite_session)
+ app_services.console.delete(RequestContext("req", None, "test-actor", app_model.tenant_id), app_model.id)
finally:
- event.remove(sqlite_session, "before_flush", before_flush)
+ event.remove(sqlite_session_factory, "before_flush", before_flush)
+ event.remove(sqlite_session_factory, "after_commit", after_commit)
app_was_deleted.disconnect(signal_handler)
- assert call_order == ["signal", "db_delete"]
- assert sqlite_session.get(App, app_model.id) is None
+ assert call_order == ["db_delete", "commit", "signal"]
+ app_id = app_model.id
+ sqlite_session.expunge_all()
+ assert sqlite_session.get(App, app_id) is None
@pytest.mark.parametrize("sqlite_session", [(App, Account)], indirect=True)
class TestAppWasUpdatedSignal:
- def test_update_app(self, app_model: App, account: Account, sqlite_session: Session) -> None:
+ def test_update_app(self, app_services, app_model: App, account: Account, sqlite_session: Session) -> None:
received: list[App] = []
handler = _make_collector(received)
app_was_updated.connect(handler)
- with patch("services.app_service.current_user", account):
- try:
- AppService().update_app(
- app_model,
+ try:
+ app_services.console.update(
+ RequestContext("req", None, account.id, app_model.tenant_id),
+ app_model.id,
+ UpdateAppParams.model_validate(
{
"name": "New",
"description": "Desc",
@@ -117,103 +133,51 @@ class TestAppWasUpdatedSignal:
"icon_background": "#fff",
"use_icon_as_answer_icon": False,
"max_active_requests": 0,
- },
- session=sqlite_session,
- )
- finally:
- app_was_updated.disconnect(handler)
+ }
+ ),
+ )
+ finally:
+ app_was_updated.disconnect(handler)
+ sqlite_session.expire_all()
persisted = sqlite_session.get(App, app_model.id)
- assert received == [app_model]
+ sqlite_session.expire_all()
+ assert received == [AppEvent(app_model.id, app_model.tenant_id, str(app_model.mode))]
assert persisted is not None
assert persisted.name == "New"
assert persisted.description == "Desc"
assert persisted.updated_by == account.id
- def test_update_app_name(self, app_model: App, account: Account, sqlite_session: Session) -> None:
- received: list[App] = []
- handler = _make_collector(received)
- app_was_updated.connect(handler)
-
- with patch("services.app_service.current_user", account):
- try:
- AppService().update_app_name(app_model, "New Name", session=sqlite_session)
- finally:
- app_was_updated.disconnect(handler)
-
- assert received == [app_model]
- assert sqlite_session.get(App, app_model.id).name == "New Name" # type: ignore[union-attr]
-
- def test_update_app_icon(self, app_model: App, account: Account, sqlite_session: Session) -> None:
- received: list[App] = []
- handler = _make_collector(received)
- app_was_updated.connect(handler)
-
- with patch("services.app_service.current_user", account):
- try:
- AppService().update_app_icon(app_model, "🎉", "#000", session=sqlite_session)
- finally:
- app_was_updated.disconnect(handler)
-
- persisted = sqlite_session.get(App, app_model.id)
- assert received == [app_model]
- assert persisted is not None
- assert (persisted.icon, persisted.icon_background) == ("🎉", "#000")
-
- def test_update_app_site_status_sends_when_changed(
- self, app_model: App, account: Account, sqlite_session: Session
+ def test_update_app_api_status_sends_when_changed(
+ self, app_services, app_model: App, account: Account, sqlite_session: Session
) -> None:
received: list[App] = []
handler = _make_collector(received)
app_was_updated.connect(handler)
- with patch("services.app_service.current_user", account):
- try:
- AppService().update_app_site_status(app_model, True, session=sqlite_session)
- finally:
- app_was_updated.disconnect(handler)
-
- assert received == [app_model]
- assert sqlite_session.get(App, app_model.id).enable_site is True # type: ignore[union-attr]
-
- def test_update_app_site_status_skips_when_unchanged(self, app_model: App, sqlite_session: Session) -> None:
- app_model.enable_site = True
- sqlite_session.commit()
- received: list[App] = []
- handler = _make_collector(received)
- app_was_updated.connect(handler)
try:
- AppService().update_app_site_status(app_model, True, session=sqlite_session)
+ app_services.console.set_api_enabled(
+ RequestContext("req", None, account.id, app_model.tenant_id), app_model.id, True
+ )
finally:
app_was_updated.disconnect(handler)
- assert received == []
- assert sqlite_session.get(App, app_model.id).enable_site is True # type: ignore[union-attr]
-
- def test_update_app_api_status_sends_when_changed(
- self, app_model: App, account: Account, sqlite_session: Session
- ) -> None:
- received: list[App] = []
- handler = _make_collector(received)
- app_was_updated.connect(handler)
-
- with patch("services.app_service.current_user", account):
- try:
- AppService().update_app_api_status(app_model, True, session=sqlite_session)
- finally:
- app_was_updated.disconnect(handler)
-
- assert received == [app_model]
+ sqlite_session.expire_all()
+ assert received == [AppEvent(app_model.id, app_model.tenant_id, str(app_model.mode))]
assert sqlite_session.get(App, app_model.id).enable_api is True # type: ignore[union-attr]
- def test_update_app_api_status_skips_when_unchanged(self, app_model: App, sqlite_session: Session) -> None:
+ def test_update_app_api_status_skips_when_unchanged(
+ self, app_services, app_model: App, sqlite_session: Session
+ ) -> None:
app_model.enable_api = True
sqlite_session.commit()
received: list[App] = []
handler = _make_collector(received)
app_was_updated.connect(handler)
try:
- AppService().update_app_api_status(app_model, True, session=sqlite_session)
+ app_services.console.set_api_enabled(
+ RequestContext("req", None, "test-actor", app_model.tenant_id), app_model.id, True
+ )
finally:
app_was_updated.disconnect(handler)
@@ -229,7 +193,9 @@ class TestAppModelConfigWasUpdatedSignal:
handle(app_model, app_model_config=None)
@pytest.mark.parametrize("sqlite_session", [(App, Account, AppModelConfig, AppDatasetJoin)], indirect=True)
- def test_reuses_provided_session_without_committing(self, app_model: App, sqlite_session: Session) -> None:
+ def test_reuses_provided_session_without_committing(
+ self, sqlite_session_factory, app_model: App, sqlite_session: Session
+ ) -> None:
from events.event_handlers.update_app_dataset_join_when_app_model_config_updated import handle
app_model_config = AppModelConfig(app_id=app_model.id, created_by="user-1", updated_by="user-1")
@@ -251,11 +217,11 @@ class TestAppModelConfigWasUpdatedSignal:
def after_commit(_session: Session) -> None:
commits.append("commit")
- event.listen(sqlite_session, "after_commit", after_commit)
+ event.listen(sqlite_session_factory, "after_commit", after_commit)
try:
handle(app_model, app_model_config=app_model_config, session=sqlite_session)
finally:
- event.remove(sqlite_session, "after_commit", after_commit)
+ event.remove(sqlite_session_factory, "after_commit", after_commit)
added_joins = [row for row in sqlite_session.new if isinstance(row, AppDatasetJoin)]
assert len(added_joins) == 1
@@ -268,6 +234,21 @@ class TestAppModelConfigWasUpdatedSignal:
assert [(row.app_id, row.dataset_id) for row in persisted] == [(app_model.id, "dataset-1")]
+def test_initialized_app_creation_event_dispatches_without_a_session() -> None:
+ results = app_was_created.send(
+ AppEvent("app-id", "tenant-id", AppMode.COMPLETION),
+ created_records_initialized=True,
+ )
+
+ assert {create_installed_app, create_site}.issubset(receiver for receiver, _result in results)
+
+
[email protected]("handler", [create_installed_app, create_site])
+def test_app_creation_record_handlers_require_a_session_for_initialization(handler: Callable[..., None]) -> None:
+ with pytest.raises(TypeError, match="session is required"):
+ handler(AppEvent("app-id", "tenant-id", AppMode.COMPLETION))
+
+
@pytest.mark.parametrize("sqlite_session", [(App, Account, InstalledApp)], indirect=True)
class TestCreateInstalledAppWhenAppCreated:
def test_skips_when_records_were_initialized_transactionally(self, app_model: App, sqlite_session: Session) -> None:
@@ -298,7 +279,9 @@ class TestCreateInstalledAppWhenAppCreated:
).all()
assert installations == [existing]
- def test_adds_missing_installation_without_committing(self, app_model: App, sqlite_session: Session) -> None:
+ def test_adds_missing_installation_without_committing(
+ self, sqlite_session_factory, app_model: App, sqlite_session: Session
+ ) -> None:
from events.event_handlers.create_installed_app_when_app_created import handle
sqlite_session.add(
@@ -314,11 +297,11 @@ class TestCreateInstalledAppWhenAppCreated:
def after_commit(_session: Session) -> None:
commits.append("commit")
- event.listen(sqlite_session, "after_commit", after_commit)
+ event.listen(sqlite_session_factory, "after_commit", after_commit)
try:
handle(app_model, session=sqlite_session)
finally:
- event.remove(sqlite_session, "after_commit", after_commit)
+ event.remove(sqlite_session_factory, "after_commit", after_commit)
installed_app = sqlite_session.scalar(
select(InstalledApp).where(
diff --git a/api/tests/unit_tests/extensions/test_ext_application_services.py b/api/tests/unit_tests/extensions/test_ext_application_services.py
index 71e80d8dd9d..bb8632622a8 100644
--- a/api/tests/unit_tests/extensions/test_ext_application_services.py
+++ b/api/tests/unit_tests/extensions/test_ext_application_services.py
@@ -22,6 +22,7 @@ from core.model_context import get_credit_usage_metadata, use_credit_usage_metad
from core.tools.tool_file_manager import ToolFileManager
from enums import DeploymentEdition, WebAppAccessMode
from extensions import ext_application_services
+from extensions.application_services.app import AppServices
from extensions.ext_database import db
from extensions.ext_redis import RedisClientWrapper
from machinery.context import RequestContext
@@ -85,6 +86,7 @@ from services.account_oauth_adapters import (
RedisOAuthAccountClaimLock,
)
from services.app.api_key_service import AppApiKeyService
+from services.app.creators_platform_gateway import CreatorsPlatformGateway
from services.app_generate_service import AppGenerateService
from services.app_preview_query_service import AppPreviewRef, AppPreviewUnavailableError
from services.app_scoped_end_user_query_service import AppScopedEndUserQueryService
@@ -198,6 +200,11 @@ def test_init_app_registers_services_for_the_current_app(
assert services.app_scoped_end_users.commands._app_scoped_end_users is repository
assert repository._session_factory is sqlite_session_factory
assert isinstance(services.workflow_statistics, WorkflowStatisticQueryService)
+ assert isinstance(services.apps, AppServices)
+ assert services.apps.console._apps is services.apps.queries._apps
+ creators = services.apps.console._creators
+ assert isinstance(creators, CreatorsPlatformGateway)
+ assert creators._oauth is services.oauth_server
def test_build_application_services_preserves_composed_boundaries(
diff --git a/api/tests/unit_tests/repositories/test_console_app_repository.py b/api/tests/unit_tests/repositories/test_console_app_repository.py
new file mode 100644
index 00000000000..8cbaf54a5c7
--- /dev/null
+++ b/api/tests/unit_tests/repositories/test_console_app_repository.py
@@ -0,0 +1,239 @@
+"""Short-session app persistence and tenant visibility regression tests."""
+
+import json
+from collections.abc import Callable
+from uuid import uuid4
+
+import pytest
+from flask import has_request_context
+from sqlalchemy import Engine, event, func, select, text
+from sqlalchemy.orm import Session, sessionmaker
+
+from fields.app_fields import AppDetailWithSite, AppPagination
+from machinery.context import RequestContext
+from models.agent import Agent, AgentScope, AgentSource, AgentStatus
+from models.enums import CustomizeTokenStrategy
+from models.model import App, AppMode, AppModelConfig, AppStar, IconType, Site
+from models.workflow import Workflow, WorkflowType
+from repositories.app.console_repository import ConsoleAppRepository
+from services.app.console_service import ConsoleAppNotFoundError
+from services.entities.app_entities import (
+ AppListParams,
+ AppTraceSettings,
+ StarredAppListParams,
+ UpdateAppParams,
+)
+
+WORKSPACE = str(uuid4())
+ACTOR = str(uuid4())
+CONTEXT = RequestContext("request", "trace", ACTOR, WORKSPACE)
+
+
+def persist_app(session: Session, **changes: object) -> App:
+ values: dict[str, object] = {
+ "id": str(uuid4()),
+ "tenant_id": WORKSPACE,
+ "name": "Example",
+ "mode": AppMode.CHAT,
+ "description": "",
+ "enable_site": True,
+ "enable_api": True,
+ "icon_type": IconType.EMOJI,
+ "icon": "🤖",
+ "icon_background": "#fff",
+ "updated_by": ACTOR,
+ }
+ values.update(changes)
+ app = App(**values)
+ session.add(app)
+ session.commit()
+ return app
+
+
+def repository(sqlite_session_factory: sessionmaker[Session]) -> ConsoleAppRepository:
+ return ConsoleAppRepository(session_factory=sqlite_session_factory)
+
+
+ "operation",
+ [
+ lambda repo, ctx, app_id: repo.get(ctx, app_id),
+ lambda repo, ctx, app_id: repo.rename(ctx, app_id, "Renamed"),
+ lambda repo, ctx, app_id: repo.set_starred(ctx, app_id, True),
+ lambda repo, ctx, app_id: repo.get_trace(ctx, app_id),
+ lambda repo, ctx, app_id: repo.set_trace(ctx, app_id, AppTraceSettings(True, "langfuse")),
+ lambda repo, ctx, app_id: repo.get_reference(ctx, app_id),
+ ],
+)
[email protected]("visibility", ["other_tenant", "disabled", "workflow_only"])
+def test_all_single_app_operations_preserve_visibility(
+ repository: ConsoleAppRepository,
+ sqlite_session: Session,
+ operation: Callable[[ConsoleAppRepository, RequestContext, str], object],
+ visibility: str,
+) -> None:
+ app = persist_app(sqlite_session)
+ if visibility == "other_tenant":
+ context = CONTEXT._replace(active_workspace_id=str(uuid4()))
+ else:
+ context = CONTEXT
+ if visibility == "disabled":
+ sqlite_session.execute(
+ text("UPDATE apps SET status = :status WHERE id = :app_id"), {"status": "disabled", "app_id": app.id}
+ )
+ else:
+ app.mode = AppMode.AGENT
+ sqlite_session.add(
+ Agent(
+ tenant_id=WORKSPACE,
+ name="Hidden",
+ scope=AgentScope.WORKFLOW_ONLY,
+ source=AgentSource.WORKFLOW,
+ status=AgentStatus.ACTIVE,
+ backing_app_id=app.id,
+ )
+ )
+ sqlite_session.commit()
+ with pytest.raises(ConsoleAppNotFoundError):
+ operation(repository, context, app.id)
+ assert sqlite_session.scalar(select(App.id).where(App.id == app.id)) is not None
+ assert sqlite_session.scalar(select(func.count()).select_from(AppStar)) == 0
+
+
+def test_detail_is_serializable_after_repository_session_closes(
+ repository: ConsoleAppRepository,
+ sqlite_session: Session,
+ sqlite_engine: Engine,
+ config_overrides: Callable[..., None],
+) -> None:
+ config_overrides(SERVICE_API_URL="", APP_WEB_URL="")
+ assert not has_request_context()
+ app = persist_app(sqlite_session)
+ config = AppModelConfig(app_id=app.id, model='{"provider":"openai","name":"example"}', pre_prompt="Prompt")
+ site = Site(
+ app_id=app.id,
+ code="site-code",
+ title="Public",
+ default_language="en-US",
+ customize_token_strategy=CustomizeTokenStrategy.NOT_ALLOW,
+ )
+ sqlite_session.add_all([config, site])
+ sqlite_session.flush()
+ app.app_model_config_id = config.id
+ sqlite_session.commit()
+ record = repository.get(CONTEXT, app.id)
+
+ def reject_queries(*_args: object) -> None:
+ raise AssertionError("Serialization must not query the database")
+
+ event.listen(sqlite_engine, "before_cursor_execute", reject_queries)
+ try:
+ data = AppDetailWithSite.model_validate(record, from_attributes=True).model_dump(mode="json")
+ finally:
+ event.remove(sqlite_engine, "before_cursor_execute", reject_queries)
+ assert data["model_config"]["model"] == {"provider": "openai", "name": "example"}
+ assert data["site"]["access_token"] == "site-code"
+ assert data["description"] == ""
+ assert data["api_base_url"] is None
+ assert data["site"]["app_base_url"] is None
+
+
+ "operation",
+ [
+ lambda repo, app_id: repo.rename(CONTEXT, app_id, "Renamed"),
+ lambda repo, app_id: repo.update_icon(CONTEXT, app_id, icon="icon", icon_background="", icon_type=None),
+ lambda repo, app_id: repo.set_site_enabled(CONTEXT, app_id, False),
+ lambda repo, app_id: repo.set_api_enabled(CONTEXT, app_id, False),
+ ],
+)
+def test_detail_writes_do_not_load_unrequested_site_or_tools(
+ repository: ConsoleAppRepository,
+ sqlite_session: Session,
+ monkeypatch: pytest.MonkeyPatch,
+ operation: Callable[[ConsoleAppRepository, str], object],
+) -> None:
+ app = persist_app(sqlite_session)
+
+ def reject_unrequested_data(*_args: object, **_kwargs: object) -> None:
+ raise AssertionError("This response does not require site or plugin tool information")
+
+ monkeypatch.setattr(App, "site_with_session", reject_unrequested_data)
+ monkeypatch.setattr("repositories.app.response.load_app_tool_references", reject_unrequested_data)
+ operation(repository, app.id)
+
+
+def test_star_is_idempotent_and_scoped_to_account(repository: ConsoleAppRepository, sqlite_session: Session) -> None:
+ app = persist_app(sqlite_session)
+ repository.set_starred(CONTEXT, app.id, True)
+ repository.set_starred(CONTEXT, app.id, True)
+ another = CONTEXT._replace(account_id=str(uuid4()))
+ repository.set_starred(another, app.id, True)
+ repository.set_starred(CONTEXT, app.id, False)
+ repository.set_starred(CONTEXT, app.id, False)
+ assert sqlite_session.scalars(select(AppStar.account_id)).all() == [another.account_id]
+ assert repository.list_apps(CONTEXT, StarredAppListParams()).data == []
+ assert repository.list_apps(another, StarredAppListParams()).data[0].is_starred
+
+
+def test_draft_trigger_enrichment_is_tenant_scoped_and_tolerates_bad_graphs(
+ repository: ConsoleAppRepository, sqlite_session: Session
+) -> None:
+ apps = [persist_app(sqlite_session, mode=AppMode.WORKFLOW) for _ in range(3)]
+ for i, app in enumerate(apps):
+ workflow = Workflow(
+ id=str(uuid4()),
+ tenant_id=WORKSPACE if i != 1 else str(uuid4()),
+ app_id=app.id,
+ type=WorkflowType.WORKFLOW,
+ version=Workflow.VERSION_DRAFT,
+ graph="invalid"
+ if i == 2
+ else json.dumps(
+ {
+ "nodes": [
+ {"id": "trigger", "data": {"type": "trigger-schedule"}},
+ ],
+ "edges": [],
+ }
+ ),
+ features="{}",
+ created_by=ACTOR,
+ )
+ sqlite_session.add(workflow)
+ sqlite_session.commit()
+ page = repository.list_apps(CONTEXT, AppListParams())
+ flags = {app.id: app.has_draft_trigger for app in page.data}
+ assert flags == {apps[0].id: True, apps[1].id: False, apps[2].id: False}
+ assert AppPagination.model_validate(page, from_attributes=True).total == 3
+
+
+def test_writes_use_explicit_actor_and_preserve_omitted_icon_type(
+ repository: ConsoleAppRepository, sqlite_session: Session
+) -> None:
+ app = persist_app(sqlite_session, icon_type=IconType.IMAGE)
+ result = repository.update(CONTEXT, app.id, UpdateAppParams(name="Updated"))
+ assert result.icon_type == IconType.IMAGE
+ assert result.updated_by == ACTOR
+ sqlite_session.expire_all()
+ persisted = sqlite_session.get(App, app.id)
+ assert persisted is not None
+ assert persisted.name == "Updated"
+
+
+def test_trace_settings_commit_and_default(repository: ConsoleAppRepository, sqlite_session: Session) -> None:
+ app = persist_app(sqlite_session)
+ assert repository.get_trace(CONTEXT, app.id) == AppTraceSettings()
+ settings = AppTraceSettings(True, "langfuse")
+ repository.set_trace(CONTEXT, app.id, settings)
+ assert repository.get_trace(CONTEXT, app.id) == settings
+ repository.set_trace(CONTEXT, app.id, AppTraceSettings())
+ assert repository.get_trace(CONTEXT, app.id) == AppTraceSettings()
+
+
+def test_trace_settings_preserve_stored_json_validation(
+ repository: ConsoleAppRepository, sqlite_session: Session
+) -> None:
+ app = persist_app(sqlite_session, tracing='{"enabled": "false", "obsolete_field": true}')
+ assert repository.get_trace(CONTEXT, app.id) == AppTraceSettings()
diff --git a/api/tests/unit_tests/repositories/test_tag_repository.py b/api/tests/unit_tests/repositories/test_tag_repository.py
index 684170c8b33..6ac46f55e75 100644
--- a/api/tests/unit_tests/repositories/test_tag_repository.py
+++ b/api/tests/unit_tests/repositories/test_tag_repository.py
@@ -1,5 +1,5 @@
import pytest
-from sqlalchemy import select
+from sqlalchemy import Engine, select
from sqlalchemy.orm import Session, sessionmaker
from models.enums import TagType
@@ -175,3 +175,49 @@ def test_binding_mutations_validate_skill_target(
"account-1",
TagBindingInput(("tag-1",), "missing", "skill"),
)
+
+
+ ("tag_ids", "match_all", "expected"),
+ [
+ ([], False, set()),
+ (["tag-1", "tag-1", "tag-2"], True, {"target-both"}),
+ (["tag-1", "tag-2"], False, {"target-one", "target-both"}),
+ (["tag-1", "missing"], True, set()),
+ (["other-tenant"], False, set()),
+ (["other-type"], False, set()),
+ ],
+)
+def test_target_query_shares_scoped_matching_and_releases_its_session(
+ sqlite_session_factory: sessionmaker[Session],
+ sqlite_engine: Engine,
+ tag_ids: list[str],
+ match_all: bool,
+ expected: set[str],
+) -> None:
+ from sqlalchemy.pool import QueuePool
+
+ from services.tag_application_service import TagApplicationService
+
+ with sqlite_session_factory.begin() as session:
+ session.add_all(
+ [
+ _tag("tag-1", workspace_id="workspace-1", tag_type=TagType.APP, name="First"),
+ _tag("tag-2", workspace_id="workspace-1", tag_type=TagType.APP, name="Second"),
+ _tag("other-tenant", workspace_id="workspace-2", tag_type=TagType.APP, name="Foreign"),
+ _tag("other-type", workspace_id="workspace-1", tag_type=TagType.KNOWLEDGE, name="Knowledge"),
+ ]
+ )
+ session.add_all(
+ [
+ TagBinding(tenant_id="workspace-1", tag_id="tag-1", target_id="target-one", created_by="account-1"),
+ TagBinding(tenant_id="workspace-1", tag_id="tag-1", target_id="target-both", created_by="account-1"),
+ TagBinding(tenant_id="workspace-1", tag_id="tag-2", target_id="target-both", created_by="account-1"),
+ TagBinding(tenant_id="workspace-2", tag_id="tag-1", target_id="foreign", created_by="account-1"),
+ ]
+ )
+ service = TagApplicationService(tags=TagRepository(sqlite_session_factory))
+ result = service.find_target_ids(tenant_id="workspace-1", tag_type="app", tag_ids=tag_ids, match_all=match_all)
+ assert set(result) == expected
+ assert isinstance(sqlite_engine.pool, QueuePool)
+ assert sqlite_engine.pool.checkedout() == 0
diff --git a/api/tests/unit_tests/services/app/test_console_gateway.py b/api/tests/unit_tests/services/app/test_console_gateway.py
new file mode 100644
index 00000000000..12006c3630d
--- /dev/null
+++ b/api/tests/unit_tests/services/app/test_console_gateway.py
@@ -0,0 +1,486 @@
+"""Policy and existing DSL adapters retain their domain-specific behavior."""
+
+from collections.abc import Callable, Generator, Iterator
+from typing import cast
+from uuid import uuid4
+from zipfile import ZipFile
+
+import pytest
+import yaml
+from sqlalchemy import Engine, event, select
+from sqlalchemy.exc import InvalidRequestError
+from sqlalchemy.orm import Session, sessionmaker
+
+from core.plugin.entities.plugin import PluginDependency, PluginInstallation
+from core.plugin.impl.plugin import PluginInstaller
+from enums import CloudPlan, DeploymentEdition
+from extensions.application_services.app import AppServices
+from machinery.context import RequestContext
+from models.account import Account, TenantAccountJoin, TenantAccountRole
+from models.model import App, AppMode, AppModelConfig, IconType
+from models.workflow import Workflow, WorkflowType
+from services.agent.package_resource_exporter import AgentPackageResourceExporter
+from services.agent.roster_package_exporter import RosterAgentPackageExporter
+from services.agent.roster_package_importer import RosterAgentPackageImporter
+from services.agent.roster_service import AgentRosterService
+from services.app.console_gateway import AppTransferGateway, EnterpriseConsoleAppAccess
+from services.app.console_service import ConsoleAppNotFoundError, InvalidAppAccessModesError
+from services.app_dsl_service import AppDslService
+from services.app_package_service import AppPackageService, PreparedAppPackage
+from services.enterprise.enterprise_service import EnterpriseService, WebAppSettings
+from services.entities.app_entities import (
+ AppExportOptions,
+ CopyAppParams,
+)
+from services.entities.dsl_entities import AppDslExportData, AppImportPackage, AppImportParams, Import, ImportStatus
+from services.plugin.dependencies_analysis import DependenciesAnalysisService
+from services.system_feature_service import SystemFeatureService
+from services.workflow_service import WorkflowService
+from tests.unit_tests.model_factories import make_account, make_tenant, make_upload_file
+
+
+def copy_source(sqlite_session_factory: sessionmaker[Session]) -> tuple[RequestContext, str]:
+ actor, workspace, app_id = str(uuid4()), str(uuid4()), str(uuid4())
+ account = make_account(account_id=actor, name="Creator", email=f"{actor}@example.com")
+ tenant = make_tenant(tenant_id=workspace, name="Workspace")
+ with sqlite_session_factory.begin() as session:
+ app = App(id=app_id, tenant_id=workspace, name="Original", mode=AppMode.CHAT, enable_site=True, enable_api=True)
+ config = AppModelConfig(app_id=app_id, model="{}")
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(tenant_id=workspace, account_id=actor, role=TenantAccountRole.OWNER),
+ app,
+ config,
+ ]
+ )
+ session.flush()
+ app.app_model_config_id = config.id
+ return RequestContext("request", None, actor, workspace), app_id
+
+
+def copy_connections(sqlite_engine: Engine) -> Iterator[set[object]]:
+ connections: set[object] = set()
+
+ def checkout(connection: object, *_args: object) -> None:
+ connections.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ connections.remove(connection)
+
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ try:
+ yield connections
+ assert not connections
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
[email protected]("status", list(ImportStatus))
[email protected]("missing_settings", [False, True])
+def test_copy_finishes_transactions_before_external_access(
+ app_services: AppServices,
+ sqlite_session_factory: sessionmaker[Session],
+ sqlite_engine: Engine,
+ copy_source: tuple[RequestContext, str],
+ copy_connections: set[object],
+ monkeypatch: pytest.MonkeyPatch,
+ status: ImportStatus,
+ missing_settings: bool,
+) -> None:
+ context, source_id = copy_source
+ copied_id = str(uuid4())
+ calls: list[str] = []
+ commits: list[Session] = []
+
+ def committed(session: Session) -> None:
+ if session.get_bind() is sqlite_engine:
+ commits.append(session)
+
+ def dependencies(*, tenant_id: str, dependencies: list[str]) -> list[PluginDependency]:
+ assert tenant_id == context.active_workspace_id
+ assert dependencies == []
+ assert not copy_connections, "Export must close its read transaction before resolving plugin metadata"
+ assert commits == [], "A read-only export must not commit"
+ calls.append("plugins")
+ return []
+
+ def persist(dsl: AppDslService, *, account: Account, yaml_content: str, name: str, **_kwargs: object) -> Import:
+ assert not copy_connections
+ assert account.id == context.account_id
+ assert account.current_tenant_id == context.active_workspace_id
+ assert yaml.safe_load(yaml_content)["app"]["name"] == "Original"
+ assert name == "Copy"
+ dsl._session.add(
+ App(
+ id=copied_id,
+ tenant_id=context.active_workspace_id,
+ name=name,
+ mode=AppMode.CHAT,
+ enable_site=True,
+ enable_api=True,
+ )
+ )
+ dsl._session.flush()
+ return Import(id="import-1", status=status, app_id=copied_id)
+
+ def get_access(app_id: str) -> WebAppSettings:
+ assert not copy_connections
+ assert app_id == source_id
+ calls.append("read_access")
+ if missing_settings:
+ raise ValueError("No settings")
+ return WebAppSettings(accessMode="private")
+
+ def set_access(app_id: str, access_mode: str) -> None:
+ assert not copy_connections
+ assert app_id == copied_id
+ assert access_mode == ("public" if missing_settings else "private")
+ with sqlite_session_factory() as session:
+ assert session.get(App, copied_id) is not None
+ calls.append("write_access")
+
+ def permissions(_self: EnterpriseConsoleAppAccess, caller: RequestContext, app_id: str) -> list[str]:
+ assert not copy_connections
+ assert caller == context
+ assert app_id == copied_id
+ calls.append("permissions")
+ return ["app.edit"]
+
+ monkeypatch.setattr(DependenciesAnalysisService, "generate_dependencies", dependencies)
+ monkeypatch.setattr(AppDslService, "import_app", persist)
+ monkeypatch.setattr(SystemFeatureService, "is_webapp_auth_enabled", lambda: True)
+ monkeypatch.setattr(EnterpriseService.WebAppAuth, "get_app_access_mode_by_id", get_access)
+ monkeypatch.setattr(EnterpriseService.WebAppAuth, "update_app_access_mode", set_access)
+ monkeypatch.setattr(EnterpriseConsoleAppAccess, "created_permissions", permissions)
+ event.listen(Session, "after_commit", committed)
+ try:
+ result, copied = app_services.console.copy(context, source_id, CopyAppParams(name="Copy"))
+ finally:
+ event.remove(Session, "after_commit", committed)
+
+ completed = status in {ImportStatus.COMPLETED, ImportStatus.COMPLETED_WITH_WARNINGS}
+ assert result.status == status
+ assert not copy_connections
+ assert len(commits) == int(completed)
+ with sqlite_session_factory() as session:
+ assert (session.get(App, copied_id) is not None) is completed
+ assert calls == (["plugins", "read_access", "write_access", "permissions"] if completed else ["plugins"])
+ if completed:
+ assert copied is not None
+ assert copied.id == copied_id
+ assert copied.permission_keys == ["app.edit"]
+ else:
+ assert copied is None
+
+
+def test_copy_rejects_foreign_import_result_before_external_effects(
+ app_services: AppServices,
+ sqlite_session_factory: sessionmaker[Session],
+ copy_source: tuple[RequestContext, str],
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ context, source_id = copy_source
+ foreign_id = str(uuid4())
+ with sqlite_session_factory.begin() as session:
+ session.add(
+ App(
+ id=foreign_id,
+ tenant_id=str(uuid4()),
+ name="Foreign",
+ mode=AppMode.CHAT,
+ enable_site=True,
+ enable_api=True,
+ )
+ )
+
+ def unexpected_effect(*_args: object, **_kwargs: object) -> None:
+ pytest.fail("A foreign import result must not receive access or permission updates")
+
+ monkeypatch.setattr(DependenciesAnalysisService, "generate_dependencies", lambda **_kwargs: [])
+ monkeypatch.setattr(
+ AppDslService,
+ "import_app",
+ lambda *_args, **_kwargs: Import(id="import-1", status=ImportStatus.COMPLETED, app_id=foreign_id),
+ )
+ monkeypatch.setattr(EnterpriseConsoleAppAccess, "inherit_access", unexpected_effect)
+ monkeypatch.setattr(EnterpriseConsoleAppAccess, "created_permissions", unexpected_effect)
+ with pytest.raises(ConsoleAppNotFoundError):
+ app_services.console.copy(context, source_id, CopyAppParams())
+
+
+ ("edition", "plan", "allowed"),
+ [
+ (DeploymentEdition.CLOUD, CloudPlan.SANDBOX, False),
+ (DeploymentEdition.CLOUD, CloudPlan.PROFESSIONAL, True),
+ (DeploymentEdition.CLOUD, CloudPlan.TEAM, True),
+ (DeploymentEdition.COMMUNITY, CloudPlan.SANDBOX, True),
+ (DeploymentEdition.ENTERPRISE, CloudPlan.SANDBOX, True),
+ ],
+)
+def test_only_cloud_version_export_consults_workspace_plan(
+ monkeypatch: pytest.MonkeyPatch,
+ config_overrides: Callable[..., None],
+ sqlite_session_factory: sessionmaker[Session],
+ edition: DeploymentEdition,
+ plan: CloudPlan,
+ allowed: bool,
+) -> None:
+ config_overrides(DEPLOYMENT_EDITION=edition)
+ calls = []
+
+ def get_plan(workspace_id: str) -> CloudPlan:
+ calls.append(workspace_id)
+ return plan
+
+ monkeypatch.setattr("services.app.console_gateway.FeatureService.get_workspace_plan", get_plan)
+ gateway = EnterpriseConsoleAppAccess(session_factory=sqlite_session_factory)
+ assert gateway.can_export_version("workspace") is allowed
+ assert calls == (["workspace"] if edition == DeploymentEdition.CLOUD else [])
+
+
+def test_access_mode_batch_validates_completeness(
+ monkeypatch: pytest.MonkeyPatch, sqlite_session_factory: sessionmaker[Session]
+) -> None:
+ monkeypatch.setattr("services.app.console_gateway.SystemFeatureService.is_webapp_auth_enabled", lambda: True)
+ monkeypatch.setattr(
+ "services.app.console_gateway.EnterpriseService.WebAppAuth.batch_get_app_access_mode_by_id",
+ lambda **_kwargs: {},
+ )
+ gateway = EnterpriseConsoleAppAccess(session_factory=sqlite_session_factory)
+ with pytest.raises(InvalidAppAccessModesError):
+ gateway.access_modes(["app"])
+
+
+ "mode", [AppMode.WORKFLOW, AppMode.ADVANCED_CHAT, AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT]
+)
+def test_dsl_export_uses_owned_short_session_and_preserves_selectors(sqlite_engine: Engine, mode: AppMode) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ app_id, workspace = str(uuid4()), str(uuid4())
+ with factory.begin() as session:
+ session.add(App(id=app_id, tenant_id=workspace, name="Example", mode=mode, enable_site=True, enable_api=True))
+ calls = []
+ opened = []
+
+ class Dsl:
+ def __init__(self, session: Session) -> None:
+ opened.append(session)
+
+ def load_export_data(self, **kwargs: object) -> AppDslExportData:
+ calls.append(kwargs)
+ assert kwargs["session"] is opened[-1]
+ return AppDslExportData(workspace, {"kind": "app", "app": {"mode": mode}}, [])
+
+ @staticmethod
+ def serialize_export_data(prepared: AppDslExportData) -> str:
+ assert prepared.tenant_id == workspace
+ return f"kind: app\napp: {{mode: {mode}}}"
+
+ gateway = AppTransferGateway(
+ session_factory=factory,
+ dsl_factory=cast(Callable[[Session], AppDslService], Dsl),
+ packages=AppPackageService(),
+ agent_packages=RosterAgentPackageExporter(),
+ agent_importer=RosterAgentPackageImporter(),
+ )
+ context = RequestContext("request", None, "actor", workspace)
+ options = AppExportOptions(include_secret=True, workflow_id="workflow")
+ dsl = gateway.export_dsl(context, app_id, options)
+ exported_app = calls[0]["app_model"]
+ assert isinstance(exported_app, App)
+ assert exported_app.id == app_id
+ assert calls[0]["include_secret"] is True
+ assert calls[0]["workflow_id"] == "workflow"
+ with pytest.raises(InvalidRequestError):
+ opened[0].execute(select(App))
+ with pytest.raises(ConsoleAppNotFoundError):
+ gateway.export_dsl(context._replace(active_workspace_id=str(uuid4())), app_id, options)
+ assert len(calls) == 1
+
+
+ "mode",
+ [AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT, AppMode.WORKFLOW, AppMode.ADVANCED_CHAT, AppMode.AGENT],
+)
[email protected]("remote_fails", [False, True])
+def test_real_dsl_export_releases_connection_before_plugin_request(
+ sqlite_engine: Engine, monkeypatch: pytest.MonkeyPatch, mode: AppMode, remote_fails: bool
+) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ app_id, workspace, actor = str(uuid4()), str(uuid4()), str(uuid4())
+ with factory.begin() as session:
+ app = App(id=app_id, tenant_id=workspace, name="Example", mode=mode, enable_site=True, enable_api=True)
+ session.add(app)
+ session.flush()
+ if mode in {AppMode.WORKFLOW, AppMode.ADVANCED_CHAT}:
+ session.add(
+ Workflow(
+ tenant_id=workspace,
+ app_id=app_id,
+ type=WorkflowType.WORKFLOW,
+ version=Workflow.VERSION_DRAFT,
+ graph='{"nodes":[],"edges":[]}',
+ features="{}",
+ created_by=actor,
+ )
+ )
+ elif mode == AppMode.AGENT:
+ AgentRosterService(session).create_backing_agent_for_app(
+ tenant_id=workspace, account_id=actor, app_id=app_id, name="Example"
+ )
+ else:
+ config = AppModelConfig(app_id=app_id, model='{"provider":"langgenius/openai/openai","name":"example"}')
+ session.add(config)
+ session.flush()
+ app.app_model_config_id = config.id
+
+ workflow_service = WorkflowService(session_maker=factory)
+ monkeypatch.setattr("services.app_dsl_service.WorkflowService", lambda: workflow_service)
+ checked_out: set[object] = set()
+ calls: list[list[str]] = []
+
+ def checkout(connection: object, *_args: object) -> None:
+ checked_out.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ checked_out.remove(connection)
+
+ def fetch_plugins(_self: PluginInstaller, tenant_id: str, plugin_ids: list[str]) -> list[PluginInstallation]:
+ assert tenant_id == workspace
+ assert not checked_out, "Plugin daemon I/O must run after returning the database connection"
+ calls.append(plugin_ids)
+ if remote_fails:
+ raise RuntimeError("Plugin daemon unavailable")
+ return []
+
+ monkeypatch.setattr(PluginInstaller, "fetch_plugin_installation_by_ids", fetch_plugins)
+ gateway = AppTransferGateway(
+ session_factory=factory,
+ dsl_factory=AppDslService,
+ packages=AppPackageService(),
+ agent_packages=RosterAgentPackageExporter(),
+ agent_importer=RosterAgentPackageImporter(),
+ )
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ try:
+ context = RequestContext("request", None, actor, workspace)
+ if remote_fails:
+ with pytest.raises(RuntimeError, match="Plugin daemon unavailable"):
+ gateway.export_dsl(context, app_id, AppExportOptions())
+ else:
+ exported = yaml.safe_load(gateway.export_dsl(context, app_id, AppExportOptions()))
+ assert exported["app"]["mode"] == mode
+ assert exported["dependencies"] == []
+ assert len(calls) == 1
+ assert not checked_out
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
+def test_console_package_export_preserves_icons_without_holding_database_connections(
+ app_services: AppServices,
+ sqlite_session_factory: sessionmaker[Session],
+ copy_source: tuple[RequestContext, str],
+ copy_connections: set[object],
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ context, app_id = copy_source
+ payload = b"packaged icon"
+ upload = make_upload_file(
+ tenant_id=context.active_workspace_id,
+ created_by=context.account_id,
+ key="uploads/icon.png",
+ name="icon.png",
+ extension="png",
+ mime_type="image/png",
+ size=len(payload),
+ )
+ with sqlite_session_factory.begin() as session:
+ app = session.get(App, app_id)
+ assert app is not None
+ app.icon_type = IconType.IMAGE
+ app.icon = upload.id
+ session.add(upload)
+
+ calls: list[str] = []
+
+ class Storage:
+ def load_stream(self, filename: str) -> Generator[bytes, None, None]:
+ assert not copy_connections, "Archive storage I/O must follow closure of both App read sessions"
+ assert filename == upload.key
+ calls.append("storage")
+ yield payload
+
+ def dependencies(*, tenant_id: str, dependencies: list[str]) -> list[PluginDependency]:
+ assert not copy_connections
+ assert tenant_id == context.active_workspace_id
+ assert dependencies == []
+ calls.append("plugins")
+ return []
+
+ monkeypatch.setattr(
+ "services.app_package_service.AgentPackageResourceExporter",
+ lambda: AgentPackageResourceExporter(storage_backend=Storage()),
+ )
+ monkeypatch.setattr(DependenciesAnalysisService, "generate_dependencies", dependencies)
+ exported = app_services.console.export(context, app_id, AppExportOptions())
+ assert not isinstance(exported, str)
+ with exported:
+ with ZipFile(exported.archive) as archive:
+ manifest = yaml.safe_load(archive.read("manifest.yaml"))
+ data = yaml.safe_load(archive.read("app.yaml"))
+ icon = manifest["icons"][0]
+ assert data["app"]["icon"] == icon["id"]
+ assert archive.read(icon["path"]) == payload
+ assert calls == ["plugins", "storage"]
+ with sqlite_session_factory() as session:
+ source = session.get(App, app_id)
+ assert source is not None
+ assert source.icon == upload.id
+
+
[email protected]("status", list(ImportStatus))
+def test_console_package_import_forwards_archive_and_closes_it(
+ app_services: AppServices,
+ copy_source: tuple[RequestContext, str],
+ copy_connections: set[object],
+ monkeypatch: pytest.MonkeyPatch,
+ config_overrides: Callable[..., None],
+ status: ImportStatus,
+) -> None:
+ config_overrides(RBAC_ENABLED=False, DEPLOYMENT_EDITION="COMMUNITY")
+ context, _ = copy_source
+ archives: list[PreparedAppPackage] = []
+ dsl = "kind: app\napp: {mode: chat}\n"
+
+ def import_app(
+ _self: AppDslService,
+ *,
+ account: Account,
+ yaml_content: str,
+ package: AppImportPackage | None,
+ **_kwargs: object,
+ ) -> Import:
+ assert not copy_connections
+ assert account.id == context.account_id
+ assert isinstance(package, PreparedAppPackage)
+ assert package.dsl == yaml_content == dsl
+ assert not package.archive.closed
+ archives.append(package)
+ return Import(id="import-1", status=status)
+
+ monkeypatch.setattr(AppDslService, "import_app", import_app)
+ with AppPackageService().export(dsl=dsl, name="Example") as exported:
+ result = app_services.console.import_app(context, AppImportParams(mode="yaml-content"), source=exported.archive)
+ assert result.status == status
+ assert len(archives) == 1
+ assert archives[0].archive.closed
diff --git a/api/tests/unit_tests/services/app/test_console_service.py b/api/tests/unit_tests/services/app/test_console_service.py
new file mode 100644
index 00000000000..d65164357a0
--- /dev/null
+++ b/api/tests/unit_tests/services/app/test_console_service.py
@@ -0,0 +1,989 @@
+"""Console use cases exercise ports without a request or an ORM session."""
+
+import json
+from collections.abc import Sequence
+from contextlib import AbstractContextManager
+from dataclasses import dataclass, field, replace
+from datetime import datetime
+from io import BytesIO
+from typing import BinaryIO, Literal, cast, override
+from uuid import UUID, uuid4
+
+import pytest
+from sqlalchemy import Engine, event, func, select
+from sqlalchemy.orm import Session, sessionmaker
+
+from core.plugin.impl.plugin import PluginInstaller
+from core.tools.entities.tool_entities import ApiProviderSchemaType
+from core.tools.tool_manager import ToolManager
+from events.app_event import app_was_updated
+from fields.app_fields import AppDetailWithSite
+from graphon.model_runtime.entities.model_entities import ModelType
+from machinery.context import RequestContext
+from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
+from models.agent import Agent, AgentConfigSnapshot, AgentStatus
+from models.agent_config_entities import AgentSoulConfig
+from models.model import App, AppMode, AppModelConfig, IconType, InstalledApp, Site
+from models.provider import TenantDefaultModel
+from models.provider_ids import GenericProviderID
+from models.tools import ApiToolProvider
+from repositories.app.console_repository import ConsoleAppRepository
+from services.agent.errors import AgentAccessNotReadyError
+from services.agent.roster_package_entities import RosterAgentPackageExport
+from services.agent.roster_service import AgentRosterService
+from services.app.console_gateway import AppLifecycleGateway
+from services.app.console_service import (
+ AppExportPaidPlanRequiredError,
+ ConsoleAppNotFoundError,
+ ConsoleApps,
+ ConsoleAppService,
+ CreatorsPlatformDisabledError,
+ InvalidAppExportError,
+)
+from services.entities.app_entities import (
+ AppCreationSettings,
+ AppDeletion,
+ AppExportOptions,
+ AppListParams,
+ AppPage,
+ AppRecord,
+ AppReference,
+ AppTraceSettings,
+ CopyAppParams,
+ CreateAppParams,
+ ImportedAppPackage,
+ RecentAppListItem,
+ StarredAppListParams,
+ UpdateAppParams,
+)
+from services.entities.dsl_entities import (
+ AppImportPackage,
+ AppImportParams,
+ CheckDependenciesResult,
+ Import,
+ ImportStatus,
+)
+from services.model_provider_service import ModelProviderService
+
+CONTEXT = RequestContext("request", "trace", "actor", "workspace")
+RECORD = AppRecord(id="app", name="Example", mode_compatible_with_agent="chat")
+
+
+@dataclass
+class Apps:
+ source: AppReference = AppReference("app", "Example", "chat", None)
+ records: list[AppRecord] = field(default_factory=lambda: [RECORD])
+ calls: list[tuple[object, ...]] = field(default_factory=list)
+
+ def list_apps(self, context: RequestContext, params: AppListParams | StarredAppListParams) -> AppPage:
+ self.calls.append(("list", context, params))
+ return AppPage(params.page, params.limit, len(self.records), False, self.records)
+
+ def recent(self, context: RequestContext, params: AppListParams) -> list[RecentAppListItem]:
+ self.calls.append(("recent", context, params))
+ return [RecentAppListItem("app", "Example", None, None, None, AppMode.CHAT, None, datetime(2026, 1, 1), None)]
+
+ def get(self, context: RequestContext, app_id: str) -> AppRecord:
+ self.calls.append(("get", context, app_id))
+ return RECORD
+
+ def create(self, context: RequestContext, params: CreateAppParams, settings: AppCreationSettings) -> AppRecord:
+ assert settings.app == {"mode": params.mode}
+ self.calls.append(("create", context, params))
+ return RECORD
+
+ def get_reference(self, context: RequestContext, app_id: str) -> AppReference:
+ self.calls.append(("get_reference", context, app_id))
+ return self.source
+
+ def get_trace(self, context: RequestContext, app_id: str) -> AppTraceSettings:
+ self.calls.append(("get_trace", context, app_id))
+ raise ValueError("Stored tracing JSON is malformed")
+
+ def set_trace(self, context: RequestContext, app_id: str, settings: AppTraceSettings) -> None:
+ self.calls.append(("set_trace", context, app_id, settings))
+
+
+@dataclass
+class Permissions:
+ def filter_list(self, params: AppListParams) -> AppListParams:
+ return params.model_copy(update={"accessible_app_ids": ["app"], "include_own_apps": True})
+
+ def keys_for(self, app_ids: list[str]) -> dict[str, list[str]]:
+ return {app_id: ["app.preview"] for app_id in app_ids}
+
+
+@dataclass
+class Access:
+ paid: bool = True
+ calls: list[tuple[object, ...]] = field(default_factory=list)
+
+ def require_import(self, context: RequestContext, kind: Literal["url", "dsl", "agent"]) -> None:
+ del context, kind
+ pytest.fail("Unexpected import admission")
+
+ def imported_permissions(self, context: RequestContext, app_id: str) -> list[str]:
+ del context, app_id
+ pytest.fail("Unexpected import permissions lookup")
+
+ def initialize_import_access(self, app_id: str) -> None:
+ del app_id
+ pytest.fail("Unexpected import access initialization")
+
+ def permissions(self, context: RequestContext, *, app_id: str | None = None) -> Permissions:
+ self.calls.append(("permissions", context, app_id))
+ return Permissions()
+
+ def created_permissions(self, context: RequestContext, app_id: str) -> list[str]:
+ self.calls.append(("created_permissions", context, app_id))
+ return ["app.edit"]
+
+ def initialize_created_app(self, context: RequestContext, app_id: str) -> None:
+ self.calls.append(("initialize", context, app_id))
+
+ def inherit_access(self, source_app_id: str, app_id: str) -> None:
+ self.calls.append(("inherit", source_app_id, app_id))
+
+ def access_modes(self, app_ids: list[str]) -> dict[str, str]:
+ self.calls.append(("modes", app_ids))
+ return dict.fromkeys(app_ids, "private")
+
+ def access_mode(self, app_id: str) -> str | None:
+ del app_id
+ return "private"
+
+ def can_export_version(self, workspace_id: str) -> bool:
+ self.calls.append(("paid", workspace_id))
+ return self.paid
+
+
+@dataclass
+class Transfers:
+ status: ImportStatus = ImportStatus.COMPLETED
+ copied_id: str | None = RECORD.id
+ calls: list[tuple[object, ...]] = field(default_factory=list)
+
+ def download_import(self, url: str) -> AbstractContextManager[BinaryIO]:
+ del url
+ pytest.fail("Unexpected import download")
+
+ def read_import_yaml(self, source: BinaryIO) -> str | None:
+ del source
+ pytest.fail("Unexpected import content detection")
+
+ def read_app_package(self, source: BinaryIO) -> AppImportPackage | None:
+ del source
+ pytest.fail("Unexpected package read")
+
+ def confirm_import(self, context: RequestContext, import_id: str) -> tuple[Import, bool]:
+ del context, import_id
+ pytest.fail("Unexpected import confirmation")
+
+ def import_agent_package(self, context: RequestContext, source: BinaryIO) -> ImportedAppPackage:
+ del context, source
+ pytest.fail("Unexpected Agent package import")
+
+ def check_dependencies(self, context: RequestContext, app_id: str) -> CheckDependenciesResult:
+ del context, app_id
+ pytest.fail("Unexpected dependency check")
+
+ def import_dsl(
+ self,
+ context: RequestContext,
+ params: AppImportParams,
+ *,
+ as_copy: bool = False,
+ package: AppImportPackage | None = None,
+ ) -> Import:
+ assert package is None
+ self.calls.append(("import", context, params, as_copy))
+ return Import(id="import", status=self.status, app_id=self.copied_id)
+
+ def export_dsl(self, context: RequestContext, app_id: str, options: AppExportOptions) -> str:
+ self.calls.append(("dsl", context, app_id, options))
+ return "app: example"
+
+ def export_app_package(
+ self, context: RequestContext, app_id: str, options: AppExportOptions
+ ) -> RosterAgentPackageExport:
+ self.calls.append(("package", context, app_id, options))
+ return RosterAgentPackageExport(archive=BytesIO(b"package"), filename="example.ifpkg", size=7)
+
+ def export_agent_package(
+ self, *, workspace_id: str, agent_id: str, version_id: UUID | None
+ ) -> RosterAgentPackageExport:
+ self.calls.append(("agent", workspace_id, agent_id, version_id))
+ return RosterAgentPackageExport(archive=BytesIO(b"agent"), filename="agent.ifpkg", size=5)
+
+
+@dataclass
+class Creators:
+ enabled: bool = True
+ calls: list[tuple[object, ...]] = field(default_factory=list)
+
+ def require_enabled(self) -> None:
+ if not self.enabled:
+ raise CreatorsPlatformDisabledError
+
+ def upload(self, dsl: str) -> str:
+ self.calls.append(("upload", dsl))
+ return "claim"
+
+ def authorize(self, account_id: str) -> str | None:
+ self.calls.append(("authorize", account_id))
+ return "code"
+
+ def redirect_url(self, claim_code: str, oauth_code: str | None) -> str:
+ self.calls.append(("redirect", claim_code, oauth_code))
+ return "https://creators.example.com"
+
+
+class Tracing:
+ def validate_provider(self, tracing_provider: str) -> None:
+ if tracing_provider != "langfuse":
+ raise ValueError("Invalid tracing provider")
+
+ def require_provider_available(self, tracing_provider: str) -> None:
+ self.validate_provider(tracing_provider)
+
+
+Ports = tuple[ConsoleAppService, Apps, Access, Transfers, Creators]
+
+
+def ports() -> Ports:
+ apps, access, transfers, creators = Apps(), Access(), Transfers(), Creators()
+ service = ConsoleAppService(
+ apps=cast(ConsoleApps, apps),
+ access=access,
+ transfers=transfers,
+ creators=creators,
+ tracing=Tracing(),
+ lifecycle=Lifecycle(),
+ )
+ return service, apps, access, transfers, creators
+
+
+def test_list_applies_visibility_and_enriches_materialized_records(ports: Ports) -> None:
+ service, apps, access, _, _ = ports
+ params = AppListParams(page=2, limit=5)
+ result = service.list_apps(CONTEXT, params)
+ _, context, filtered = apps.calls[0]
+ assert context == CONTEXT
+ assert isinstance(filtered, AppListParams)
+ assert filtered.accessible_app_ids == ["app"]
+ assert filtered.include_own_apps is True
+ assert params.accessible_app_ids is None
+ assert result.page == 2
+ assert result.data[0].permission_keys == ["app.preview"]
+ assert result.data[0].access_mode == "private"
+ assert RECORD.access_mode is None
+ assert access.calls == [("permissions", CONTEXT, None), ("modes", ["app"])]
+
+
+def test_empty_list_skips_external_enrichment(ports: Ports) -> None:
+ service, apps, access, _, _ = ports
+ apps.records = []
+ assert service.list_apps(CONTEXT, AppListParams()).data == []
+ assert access.calls == [("permissions", CONTEXT, None)]
+
+
+def test_starred_list_preserves_existing_visibility_contract(ports: Ports) -> None:
+ service, _, access, _, _ = ports
+ page = service.list_apps(CONTEXT, StarredAppListParams())
+ assert page.data[0].permission_keys == []
+ assert access.calls == [("modes", ["app"])]
+
+
+def test_recent_uses_list_visibility_and_permission_keys(ports: Ports) -> None:
+ service, apps, _, _, _ = ports
+ assert service.recent(CONTEXT, 3)[0].permission_keys == ["app.preview"]
+ params = apps.calls[0][2]
+ assert isinstance(params, AppListParams)
+ assert params.limit == 3
+ assert params.accessible_app_ids == ["app"]
+
+
+def test_detail_and_creation_have_distinct_permission_lookups(ports: Ports) -> None:
+ service, _, access, _, _ = ports
+ assert service.get(CONTEXT, "app").permission_keys == ["app.preview"]
+ assert access.calls == [("permissions", CONTEXT, "app")]
+ access.calls.clear()
+ assert service.create(CONTEXT, CreateAppParams(name="Example", mode="chat")).permission_keys == ["app.edit"]
+ assert access.calls == [("created_permissions", CONTEXT, "app"), ("initialize", CONTEXT, "app")]
+
+
[email protected]("status", [ImportStatus.FAILED, ImportStatus.PENDING])
+def test_copy_pending_or_failure_skips_created_permissions(ports: Ports, status: ImportStatus) -> None:
+ service, apps, access, transfers, _ = ports
+ transfers.status = status
+ result, copied = service.copy(CONTEXT, "app", CopyAppParams())
+ assert result.status == status
+ assert copied is None
+ assert apps.calls == []
+ assert access.calls == []
+
+
+def test_copy_success_requires_materialized_app_and_enriches_permissions(ports: Ports) -> None:
+ service, apps, access, transfers, _ = ports
+ params = CopyAppParams(name="Copy", description="Description", icon_type=IconType.EMOJI, icon="robot")
+ _, copied = service.copy(CONTEXT, "app", params)
+ assert copied is not None
+ assert copied.permission_keys == ["app.edit"]
+ assert access.calls == [("inherit", "app", "app"), ("created_permissions", CONTEXT, "app")]
+ assert apps.calls == [("get", CONTEXT, "app")]
+ assert transfers.calls == [
+ ("dsl", CONTEXT, "app", AppExportOptions(include_secret=True)),
+ (
+ "import",
+ CONTEXT,
+ AppImportParams(mode="yaml-content", yaml_content="app: example", **params.model_dump()),
+ True,
+ ),
+ ]
+ transfers.copied_id = None
+ with pytest.raises(ConsoleAppNotFoundError):
+ service.copy(CONTEXT, "app", CopyAppParams())
+
+
+def test_export_routes_yaml_ordinary_package_and_agent_package(ports: Ports) -> None:
+ service, apps, _, transfers, _ = ports
+ options = AppExportOptions(format="yaml", include_secret=True, workflow_id="workflow")
+ assert service.export(CONTEXT, "app", options) == "app: example"
+ assert transfers.calls[-1] == ("dsl", CONTEXT, "app", options)
+ archive = service.export(CONTEXT, "app", AppExportOptions())
+ assert transfers.calls[-1] == ("package", CONTEXT, "app", AppExportOptions())
+ assert isinstance(archive, RosterAgentPackageExport)
+ archive.close()
+ apps.source = replace(apps.source, mode="agent", bound_agent_id="agent")
+ version = uuid4()
+ archive = service.export(CONTEXT, "app", AppExportOptions(version_id=version))
+ assert transfers.calls[-1] == ("agent", "workspace", "agent", version)
+ assert isinstance(archive, RosterAgentPackageExport)
+ archive.close()
+
+
+def test_export_rejects_invalid_or_unpaid_version_before_exporting(ports: Ports) -> None:
+ service, apps, access, transfers, _ = ports
+ options = AppExportOptions(version_id=uuid4())
+ with pytest.raises(InvalidAppExportError):
+ service.export(CONTEXT, "app", options)
+ apps.source = replace(apps.source, mode="agent", bound_agent_id="agent")
+ access.paid = False
+ with pytest.raises(AppExportPaidPlanRequiredError):
+ service.export(CONTEXT, "app", options)
+ assert transfers.calls == []
+ access.paid = True
+ apps.source = replace(apps.source, bound_agent_id=None)
+ with pytest.raises(ConsoleAppNotFoundError, match="Agent not found"):
+ service.export(CONTEXT, "app", AppExportOptions())
+
+
+def test_publish_orders_upload_authorization_and_redirect_without_secrets(ports: Ports) -> None:
+ service, _, _, transfers, creators = ports
+ assert service.publish(CONTEXT, "app") == "https://creators.example.com"
+ assert transfers.calls == [("dsl", CONTEXT, "app", AppExportOptions(include_secret=False))]
+ assert creators.calls == [("upload", "app: example"), ("authorize", "actor"), ("redirect", "claim", "code")]
+
+
+def test_disabled_creators_has_no_export_or_external_effects(ports: Ports) -> None:
+ service, _, _, transfers, creators = ports
+ creators.enabled = False
+ with pytest.raises(CreatorsPlatformDisabledError):
+ service.publish(CONTEXT, "app")
+ assert transfers.calls == creators.calls == []
+
+
+ ("enabled", "provider"),
+ [
+ pytest.param(False, None, id="disabled-without-provider"),
+ pytest.param(False, "langfuse", id="disabled-with-provider"),
+ pytest.param(True, "langfuse", id="enabled"),
+ pytest.param(True, "invalid", id="invalid"),
+ ],
+)
+def test_trace_update_checks_ownership_and_provider_without_parsing_old_settings(
+ ports: Ports, enabled: bool, provider: str | None
+) -> None:
+ service, apps, _, _, _ = ports
+ settings = AppTraceSettings(enabled, provider)
+ if provider == "invalid":
+ with pytest.raises(ValueError, match="Invalid tracing provider"):
+ service.set_trace(CONTEXT, "app", settings)
+ assert apps.calls == [("get_reference", CONTEXT, "app")]
+ else:
+ service.set_trace(CONTEXT, "app", settings)
+ assert apps.calls == [("get_reference", CONTEXT, "app"), ("set_trace", CONTEXT, "app", settings)]
+
+
+class Lifecycle:
+ def delete(self, context: RequestContext, app_id: str) -> AppDeletion:
+ del context, app_id
+ pytest.fail("Unexpected app deletion")
+
+ def create(self, context: RequestContext, params: CreateAppParams, settings: AppCreationSettings) -> AppRecord:
+ assert context is CONTEXT
+ assert settings.app == {"mode": params.mode}
+ return RECORD
+
+ def prepare_creation(self, context: RequestContext, params: CreateAppParams) -> AppCreationSettings:
+ assert context is CONTEXT
+ return AppCreationSettings({"mode": params.mode}, None)
+
+ def created(self, context: RequestContext, app: AppRecord) -> None:
+ assert context is CONTEXT
+ assert app.id == "app"
+
+ def updated(self, context: RequestContext, app: AppRecord) -> None:
+ assert context is CONTEXT
+ assert app.id == "app"
+
+ def deleted(self, context: RequestContext, deleted: AppDeletion) -> None:
+ assert context is CONTEXT
+ assert deleted.app.id == "app"
+
+ def present(self, context: RequestContext, app: AppRecord, *, mask_credentials: bool = False) -> AppRecord:
+ del mask_credentials
+ assert context is CONTEXT
+ return app
+
+
+ ("provider_name", "expected_model"),
+ [
+ pytest.param(
+ "langgenius/openai/openai",
+ ("langgenius/openai", "langgenius/openai/openai", "gpt-4o"),
+ id="workspace-default",
+ ),
+ pytest.param(None, None, id="no-default"),
+ pytest.param("invalid/provider", None, id="invalid-provider"),
+ ],
+)
+def test_lifecycle_agent_creation_seeds_workspace_default_model(
+ sqlite_engine: Engine,
+ monkeypatch: pytest.MonkeyPatch,
+ provider_name: str | None,
+ expected_model: tuple[str, str, str] | None,
+) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ with factory.begin() as session:
+ account = Account(name="Creator", email=f"{uuid4()}@example.com")
+ tenant = Tenant(name="Workspace")
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(
+ tenant_id=tenant.id,
+ account_id=account.id,
+ current=True,
+ role=TenantAccountRole.OWNER,
+ ),
+ ]
+ )
+ if provider_name is not None:
+ session.add(
+ TenantDefaultModel(
+ tenant_id=tenant.id,
+ model_type=ModelType.LLM,
+ provider_name=provider_name,
+ model_name="gpt-4o",
+ )
+ )
+
+ if provider_name is None:
+ monkeypatch.setattr(
+ ModelProviderService,
+ "get_default_model_selection",
+ lambda *_args, **_kwargs: None,
+ )
+
+ context = RequestContext("request", None, account.id, tenant.id)
+ app = AppLifecycleGateway(session_factory=factory).create(
+ context,
+ CreateAppParams(name="Agent", mode=AppMode.AGENT.value),
+ AppCreationSettings({"enable_site": False, "enable_api": False}, None),
+ )
+
+ with factory() as session:
+ agent = session.scalar(select(Agent).where(Agent.app_id == app.id))
+ assert agent is not None
+ snapshot = session.get(AgentConfigSnapshot, agent.active_config_snapshot_id)
+ assert snapshot is not None
+ model = AgentSoulConfig.model_validate(snapshot.config_snapshot_dict).model
+ if expected_model is None:
+ assert model is None
+ assert agent.active_config_has_model is False
+ else:
+ assert model is not None
+ assert (model.plugin_id, model.model_provider, model.model) == expected_model
+ assert agent.active_config_has_model is True
+
+
[email protected]("failure", [None, "persist", "external"])
[email protected]("mode", [AppMode.WORKFLOW, AppMode.AGENT])
+def test_lifecycle_runs_after_atomic_creation_and_session_close(
+ sqlite_engine: Engine, failure: str | None, mode: AppMode
+) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ with factory.begin() as session:
+ account = Account(name="Creator", email=f"{uuid4()}@example.com")
+ tenant = Tenant(name="Workspace")
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(
+ tenant_id=tenant.id,
+ account_id=account.id,
+ current=True,
+ role=TenantAccountRole.OWNER,
+ ),
+ ]
+ )
+ context = RequestContext("request", None, account.id, tenant.id)
+ effects: list[str] = []
+ checked_out: set[object] = set()
+
+ def checkout(connection: object, *_args: object) -> None:
+ checked_out.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ checked_out.remove(connection)
+
+ def reject_commit(_session: Session) -> None:
+ raise RuntimeError("persist failed")
+
+ class LifecycleProbe(AppLifecycleGateway):
+ @override
+ def prepare_creation(self, context: RequestContext, params: CreateAppParams) -> AppCreationSettings:
+ assert context.account_id == account.id
+ assert not checked_out
+ assert params.mode == mode
+ return AppCreationSettings({"enable_site": True, "enable_api": True}, None)
+
+ @override
+ def present(self, context: RequestContext, app: AppRecord, *, mask_credentials: bool = False) -> AppRecord:
+ assert context.account_id == account.id
+ assert not mask_credentials
+ return app
+
+ @override
+ def created(self, context: RequestContext, app: AppRecord) -> None:
+ assert context.account_id == account.id
+ assert not checked_out
+ with factory() as read:
+ assert read.get(App, app.id) is not None
+ assert read.scalar(select(Site.id).where(Site.app_id == app.id)) is not None
+ assert read.scalar(select(InstalledApp.id).where(InstalledApp.app_id == app.id)) is not None
+ backing_agent = read.scalar(select(Agent).where(Agent.app_id == app.id))
+ assert (backing_agent is not None) == (mode == AppMode.AGENT)
+ effects.append("created")
+ if failure == "external":
+ raise RuntimeError("external failed")
+
+ @override
+ def updated(self, context: RequestContext, app: AppRecord) -> None:
+ assert context.account_id == account.id
+ assert not checked_out
+ with factory() as read:
+ persisted = read.get(App, app.id)
+ assert persisted is not None
+ assert persisted.name == "Renamed"
+ effects.append("updated")
+
+ @override
+ def deleted(self, context: RequestContext, deleted: AppDeletion) -> None:
+ assert context.account_id == account.id
+ assert not checked_out
+ with factory() as read:
+ assert read.get(App, deleted.app.id) is None
+ if mode == AppMode.AGENT:
+ assert (
+ read.scalar(select(Agent.status).where(Agent.app_id == deleted.app.id)) == AgentStatus.ARCHIVED
+ )
+ effects.append("deleted")
+
+ access = Access()
+ service = ConsoleAppService(
+ apps=ConsoleAppRepository(session_factory=factory),
+ access=access,
+ transfers=Transfers(),
+ creators=Creators(),
+ tracing=Tracing(),
+ lifecycle=LifecycleProbe(session_factory=factory),
+ )
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ if failure == "persist":
+ event.listen(factory, "before_commit", reject_commit)
+ try:
+ params = CreateAppParams.model_validate({"name": "Created", "mode": mode})
+ if failure:
+ with pytest.raises(RuntimeError, match=f"{failure} failed"):
+ service.create(context, params)
+ with factory() as read:
+ expected = 0 if failure == "persist" else 1
+ for model in (App, Site, InstalledApp):
+ assert read.scalar(select(func.count()).select_from(model)) == expected
+ assert read.scalar(select(func.count()).select_from(Agent)) == (
+ expected if mode == AppMode.AGENT else 0
+ )
+ assert effects == ([] if failure == "persist" else ["created"])
+ assert access.calls == []
+ else:
+ app = service.create(context, params)
+ service.rename(context, app.id, "Renamed")
+ service.delete(context, app.id)
+ assert effects == ["created", "updated", "deleted"]
+ assert not checked_out
+ finally:
+ if failure == "persist":
+ event.remove(factory, "before_commit", reject_commit)
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
+def test_app_deletion_failure_rolls_back_backing_agent_changes(sqlite_engine: Engine) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ with factory.begin() as session:
+ account = Account(name="Creator", email=f"{uuid4()}@example.com")
+ tenant = Tenant(name="Workspace")
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(
+ tenant_id=tenant.id, account_id=account.id, current=True, role=TenantAccountRole.OWNER
+ ),
+ ]
+ )
+ context = RequestContext("request", None, account.id, tenant.id)
+ gateway = AppLifecycleGateway(session_factory=factory)
+ app = gateway.create(
+ context,
+ CreateAppParams(name="Agent", mode="agent"),
+ AppCreationSettings({"enable_site": False, "enable_api": False}, None),
+ )
+
+ def reject_commit(_session: Session) -> None:
+ raise RuntimeError("commit failed")
+
+ event.listen(factory, "before_commit", reject_commit)
+ try:
+ with pytest.raises(RuntimeError, match="commit failed"):
+ gateway.delete(context, app.id)
+ finally:
+ event.remove(factory, "before_commit", reject_commit)
+
+ with factory() as read:
+ assert read.get(App, app.id) is not None
+ agent = read.scalar(select(Agent).where(Agent.app_id == app.id))
+ assert agent is not None
+ assert agent.status == AgentStatus.ACTIVE
+ assert agent.archived_at is None
+
+
[email protected]("operation", ["get", "update", "create", "copy"])
[email protected]("remote_fails", [False, True])
+def test_detail_tool_enrichment_releases_database_before_plugin_io(
+ sqlite_engine: Engine, monkeypatch: pytest.MonkeyPatch, operation: str, remote_fails: bool
+) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ missing_api = str(uuid4())
+ with factory.begin() as session:
+ account = Account(name="Creator", email=f"{uuid4()}@example.com")
+ tenant = Tenant(name="Workspace")
+ session.add_all(
+ [
+ account,
+ tenant,
+ TenantAccountJoin(
+ tenant_id=tenant.id,
+ account_id=account.id,
+ current=True,
+ role=TenantAccountRole.OWNER,
+ ),
+ ]
+ )
+ providers = [
+ ApiToolProvider(
+ name="API",
+ icon="",
+ schema="{}",
+ schema_type_str=ApiProviderSchemaType.OPENAPI,
+ user_id=account.id,
+ tenant_id=workspace,
+ description="",
+ tools_str="[]",
+ credentials_str="{}",
+ )
+ for workspace in (tenant.id, str(uuid4()))
+ ]
+ session.add_all(providers)
+ tools = [
+ {
+ "provider_type": kind,
+ "provider_id": provider_id,
+ "tool_name": "tool",
+ "tool_parameters": dict[str, str](),
+ }
+ for kind, provider_id in (
+ ("api", providers[0].id),
+ ("api", missing_api),
+ ("api", providers[1].id),
+ ("builtin", "vendor/missing/tool"),
+ ("builtin", "vendor/installed/tool"),
+ ("builtin", "local"),
+ )
+ ]
+ config_values = {"agent_mode": json.dumps({"enabled": False, "tools": tools}), "model": "{}"}
+ app = App(
+ id=str(uuid4()), tenant_id=tenant.id, name="Example", mode=AppMode.CHAT, enable_site=True, enable_api=True
+ )
+ config = AppModelConfig(app_id=app.id, agent_mode=config_values["agent_mode"], model=config_values["model"])
+ session.add_all([app, config])
+ session.flush()
+ app.app_model_config_id = config.id
+ context = RequestContext("request", None, account.id, tenant.id)
+ repository = ConsoleAppRepository(session_factory=factory)
+ checked_out: set[object] = set()
+ remote_calls: list[list[str]] = []
+
+ def checkout(connection: object, *_args: object) -> None:
+ checked_out.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ checked_out.remove(connection)
+
+ def hardcoded(provider: str) -> object:
+ assert not checked_out
+ if provider == "local":
+ return object()
+ raise ValueError("Not a hardcoded provider")
+
+ def check_plugins(_self: PluginInstaller, tenant_id: str, provider_ids: Sequence[GenericProviderID]) -> list[bool]:
+ assert tenant_id == tenant.id
+ assert not checked_out, "Plugin daemon I/O must run after returning the database connection"
+ remote_calls.append([str(provider) for provider in provider_ids])
+ if remote_fails:
+ raise RuntimeError("Plugin daemon unavailable")
+ return [False, True]
+
+ class LifecycleGateway(AppLifecycleGateway):
+ @override
+ def prepare_creation(self, context: RequestContext, params: CreateAppParams) -> AppCreationSettings:
+ assert context.account_id == account.id
+ assert params.mode == "chat"
+ return AppCreationSettings({"enable_site": True, "enable_api": True}, config_values)
+
+ @override
+ def created(self, context: RequestContext, app: AppRecord) -> None:
+ assert context.account_id == account.id
+ assert app.created_by == account.id
+ assert not checked_out
+
+ class CopyTransfer(Transfers):
+ @override
+ def import_dsl(
+ self,
+ context: RequestContext,
+ params: AppImportParams,
+ *,
+ as_copy: bool = False,
+ package: AppImportPackage | None = None,
+ ) -> Import:
+ assert package is None
+ assert params.name is None
+ assert as_copy
+ return Import(id="import", status=ImportStatus.COMPLETED, app_id=app.id)
+
+ service = ConsoleAppService(
+ apps=repository,
+ access=Access(),
+ transfers=CopyTransfer(),
+ creators=Creators(),
+ tracing=Tracing(),
+ lifecycle=LifecycleGateway(session_factory=factory),
+ )
+ monkeypatch.setattr(ToolManager, "get_hardcoded_provider", hardcoded)
+ monkeypatch.setattr(PluginInstaller, "check_tools_existence", check_plugins)
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+
+ def read_result() -> AppRecord:
+ if operation == "get":
+ return service.get(context, app.id)
+ if operation == "update":
+ return service.update(context, app.id, UpdateAppParams(name="Updated"))
+ if operation == "create":
+ return service.create(context, CreateAppParams(name="Created", mode="chat"))
+ _, copied = service.copy(context, app.id, CopyAppParams())
+ assert copied is not None
+ return copied
+
+ try:
+ snapshot = repository.get(context, app.id)
+ assert remote_calls == []
+ assert not checked_out
+ assert [ref.exists for ref in snapshot.tool_references] == [True, False, False, None, None, None]
+ if remote_fails:
+ with pytest.raises(RuntimeError, match="Plugin daemon unavailable"):
+ read_result()
+ with factory() as read:
+ if operation == "update":
+ assert read.scalar(select(App.name).where(App.id == app.id)) == "Updated"
+ if operation == "create":
+ assert read.scalar(select(App.id).where(App.name == "Created")) is not None
+ else:
+ result = read_result()
+ data = AppDetailWithSite.model_validate(result, from_attributes=True).model_dump(mode="json")
+ assert data["deleted_tools"] == [
+ {"type": "api", "provider_id": missing_api, "tool_name": "tool"},
+ {"type": "api", "provider_id": providers[1].id, "tool_name": "tool"},
+ {"type": "builtin", "provider_id": "vendor/missing/tool", "tool_name": "tool"},
+ ]
+ assert "tool_references" not in data
+ assert remote_calls == [["vendor/missing/tool", "vendor/installed/tool"]]
+ assert not checked_out
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
[email protected]("operation", ["rename", "icon", "site"])
[email protected]("commit_fails", [False, True])
+def test_app_mutations_publish_only_after_commit(sqlite_engine: Engine, operation: str, commit_fails: bool) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ context = RequestContext("request", None, str(uuid4()), str(uuid4()))
+ with factory.begin() as session:
+ app = App(
+ tenant_id=context.active_workspace_id,
+ name="Before",
+ mode=AppMode.COMPLETION,
+ icon_type=IconType.IMAGE,
+ icon="old",
+ icon_background="#fff",
+ enable_site=False,
+ enable_api=False,
+ )
+ session.add(app)
+ service = ConsoleAppService(
+ apps=ConsoleAppRepository(session_factory=factory),
+ access=Access(),
+ transfers=Transfers(),
+ creators=Creators(),
+ tracing=Tracing(),
+ lifecycle=AppLifecycleGateway(session_factory=factory),
+ )
+ signals: list[str] = []
+ checked_out: set[object] = set()
+
+ def checkout(connection: object, *_args: object) -> None:
+ checked_out.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ checked_out.remove(connection)
+
+ def after_update(_sender: object) -> None:
+ assert not checked_out
+ with factory() as read:
+ persisted = read.get(App, app.id)
+ assert persisted is not None
+ assert persisted.updated_by == context.account_id
+ assert (persisted.name, persisted.icon, persisted.enable_site) == (
+ "After" if operation == "rename" else "Before",
+ "new" if operation == "icon" else "old",
+ operation == "site",
+ )
+ assert persisted.icon_type == "image"
+ signals.append("updated")
+
+ def reject_commit(_session: Session) -> None:
+ raise RuntimeError("commit failed")
+
+ def update() -> AppRecord:
+ if operation == "rename":
+ return service.rename(context, app.id, "After")
+ if operation == "icon":
+ return service.update_icon(context, app.id, icon="new", icon_background="#000", icon_type=None)
+ return service.set_site_enabled(context, app.id, True)
+
+ app_was_updated.connect(after_update)
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ if commit_fails:
+ event.listen(factory, "before_commit", reject_commit)
+ try:
+ if commit_fails:
+ with pytest.raises(RuntimeError, match="commit failed"):
+ update()
+ with factory() as read:
+ persisted = read.get(App, app.id)
+ assert persisted is not None
+ assert (persisted.name, persisted.icon, persisted.enable_site) == ("Before", "old", False)
+ assert signals == []
+ else:
+ result = update()
+ assert result.updated_by == context.account_id
+ if operation == "site":
+ assert service.set_site_enabled(context, app.id, True).enable_site
+ assert signals == ["updated"]
+ assert not checked_out
+ finally:
+ if commit_fails:
+ event.remove(factory, "before_commit", reject_commit)
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+ app_was_updated.disconnect(after_update)
+
+
[email protected]("surface", ["site", "api"])
+def test_unpublished_agent_cannot_enable_access_through_console_service(sqlite_engine: Engine, surface: str) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False)
+ context = RequestContext("request", None, str(uuid4()), str(uuid4()))
+ with factory.begin() as session:
+ app = App(
+ id=str(uuid4()),
+ tenant_id=context.active_workspace_id,
+ name="Agent",
+ mode=AppMode.AGENT,
+ enable_site=False,
+ enable_api=False,
+ )
+ session.add(app)
+ session.flush()
+ AgentRosterService(session).create_backing_agent_for_app(
+ tenant_id=context.active_workspace_id,
+ account_id=context.account_id,
+ app_id=app.id,
+ name="Agent",
+ )
+ service = ConsoleAppService(
+ apps=ConsoleAppRepository(session_factory=factory),
+ access=Access(),
+ transfers=Transfers(),
+ creators=Creators(),
+ tracing=Tracing(),
+ lifecycle=AppLifecycleGateway(session_factory=factory),
+ )
+ signals: list[object] = []
+
+ def updated(sender: object) -> None:
+ signals.append(sender)
+
+ app_was_updated.connect(updated)
+ set_enabled = service.set_site_enabled if surface == "site" else service.set_api_enabled
+ try:
+ with pytest.raises(AgentAccessNotReadyError):
+ set_enabled(context, app.id, True)
+ assert signals == []
+ with factory() as read:
+ persisted = read.get(App, app.id)
+ assert persisted is not None
+ assert not persisted.enable_site
+ assert not persisted.enable_api
+ finally:
+ app_was_updated.disconnect(updated)
diff --git a/api/tests/unit_tests/services/app/test_creators_platform_gateway.py b/api/tests/unit_tests/services/app/test_creators_platform_gateway.py
new file mode 100644
index 00000000000..e115f0586fa
--- /dev/null
+++ b/api/tests/unit_tests/services/app/test_creators_platform_gateway.py
@@ -0,0 +1,53 @@
+"""Creators admission and OAuth use the configured client and explicit account identity."""
+
+from collections.abc import Callable
+from dataclasses import dataclass, field
+from typing import cast
+from urllib.parse import parse_qs, urlsplit
+
+import pytest
+
+from services.app import creators_platform_gateway as gateway_module
+from services.app.console_service import CreatorsPlatformDisabledError
+from services.entities.oauth_server_entities import OAuthAuthorizationCode
+from services.oauth_server_service import OAuthServerService
+
+
[email protected](autouse=True)
+def creators_url(config_overrides: Callable[..., None]) -> None:
+ config_overrides(CREATORS_PLATFORM_API_URL="https://creators.example.com/")
+
+
+@dataclass
+class OAuth:
+ calls: list[tuple[str, str]] = field(default_factory=list)
+
+ def issue_authorization_code(self, *, client_id: str, account_id: str) -> OAuthAuthorizationCode:
+ self.calls.append((client_id, account_id))
+ return OAuthAuthorizationCode(code="code + &")
+
+
[email protected]("client_id", ["", "client"])
+def test_gateway_uses_configured_oauth_client_and_encodes_redirect(
+ config_overrides: Callable[..., None],
+ client_id: str,
+) -> None:
+ config_overrides(CREATORS_PLATFORM_FEATURES_ENABLED=True, CREATORS_PLATFORM_OAUTH_CLIENT_ID=client_id)
+ oauth = OAuth()
+ gateway = gateway_module.CreatorsPlatformGateway(oauth=cast(OAuthServerService, oauth))
+ gateway.require_enabled()
+ code = gateway.authorize("actor")
+ assert oauth.calls == ([("client", "actor")] if client_id else [])
+ url = urlsplit(gateway.redirect_url("claim + &", code))
+ assert url.path == ""
+ assert parse_qs(url.query) == {
+ "dsl_claim_code": ["claim + &"],
+ **({"oauth_code": ["code + &"]} if client_id else {}),
+ }
+
+
+def test_gateway_rejects_disabled_feature(config_overrides: Callable[..., None]) -> None:
+ config_overrides(CREATORS_PLATFORM_FEATURES_ENABLED=False)
+ gateway = gateway_module.CreatorsPlatformGateway(oauth=cast(OAuthServerService, OAuth()))
+ with pytest.raises(CreatorsPlatformDisabledError):
+ gateway.require_enabled()
diff --git a/api/tests/unit_tests/services/app/test_query_service.py b/api/tests/unit_tests/services/app/test_query_service.py
new file mode 100644
index 00000000000..fbc481a1961
--- /dev/null
+++ b/api/tests/unit_tests/services/app/test_query_service.py
@@ -0,0 +1,92 @@
+"""App query results survive repository closure without ORM or request state."""
+
+from dataclasses import asdict
+from uuid import uuid4
+
+from sqlalchemy import Engine, event
+from sqlalchemy.orm import sessionmaker
+
+from fields.app_fields import AppPagination
+from models.enums import AppStatus
+from models.model import App, AppMode
+from repositories.app.console_repository import ConsoleAppRepository
+from services.app.query_service import AppQueryService
+from services.entities.app_entities import AppListParams, AppRecord, AppSummary
+
+
+def test_queries_return_materialized_data_and_close_their_sessions(sqlite_engine: Engine) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ tenant_id, other_tenant_id, account_id = (str(uuid4()) for _ in range(3))
+ visible_id, disabled_id, foreign_id = (str(uuid4()) for _ in range(3))
+ with factory.begin() as session:
+ session.add_all(
+ [
+ App(
+ id=app_id,
+ tenant_id=workspace,
+ name=name,
+ description=name,
+ mode=AppMode.CHAT,
+ enable_api=enabled,
+ enable_site=False,
+ )
+ for app_id, workspace, name, enabled in (
+ (visible_id, tenant_id, "Visible", True),
+ (disabled_id, tenant_id, "Disabled", False),
+ (foreign_id, other_tenant_id, "Other tenant", True),
+ )
+ ]
+ )
+
+ repository = ConsoleAppRepository(session_factory=factory)
+ service = AppQueryService(apps=repository)
+ connections: set[object] = set()
+ checkouts: list[object] = []
+
+ def checkout(connection: object, *_args: object) -> None:
+ connections.add(connection)
+ checkouts.append(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ connections.remove(connection)
+
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ try:
+ app = service.get_visible_app_by_id(visible_id, tenant_id)
+ assert isinstance(app, AppSummary)
+ assert not connections
+ assert service.get_visible_app_by_id(visible_id, other_tenant_id) is None
+ assert service.get_visible_app_by_id(disabled_id, tenant_id) is None
+ assert service.get_visible_app_by_id(str(uuid4()), tenant_id) is None
+ assert not connections
+
+ visible = service.find_visible_apps_by_ids([visible_id, disabled_id])
+ assert [item.id for item in visible] == [visible_id]
+ assert not connections
+ page = service.get_paginate_apps(
+ account_id, tenant_id, AppListParams(status=AppStatus.NORMAL, openapi_visible=True)
+ )
+ assert page is not None
+ assert [item.id for item in page.items] == [visible_id]
+ assert page.total == 1
+ assert not connections
+
+ related = service.related_apps(tenant_id, [disabled_id, foreign_id, visible_id, str(uuid4())])
+ assert [item.id for item in related] == [disabled_id, visible_id]
+ assert all(isinstance(item, AppRecord) for item in related)
+ assert not connections
+
+ checkout_count = len(checkouts)
+ assert checkout_count > 0
+ assert asdict(app)["name"] == "Visible"
+ assert asdict(page)["items"][0]["tenant_id"] == tenant_id
+ serialized = AppPagination.model_validate(
+ {"page": 1, "limit": 2, "total": 2, "has_more": False, "data": related}
+ ).model_dump(mode="json")
+ assert [item["id"] for item in serialized["data"]] == [disabled_id, visible_id]
+ assert len(checkouts) == checkout_count
+ assert not connections
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
diff --git a/api/tests/unit_tests/services/app/test_response_gateway.py b/api/tests/unit_tests/services/app/test_response_gateway.py
new file mode 100644
index 00000000000..95512bced13
--- /dev/null
+++ b/api/tests/unit_tests/services/app/test_response_gateway.py
@@ -0,0 +1,34 @@
+"""Response gateway behavior at the app service boundary."""
+
+from machinery.context import RequestContext
+from models.model import AppMode
+from services.app.response_gateway import AppResponseGateway
+from services.entities.app_entities import AppRecord
+
+
+def test_mask_record_omits_unverified_tool_parameters_without_mutating_record() -> None:
+ agent_mode = {
+ "enabled": True,
+ "tools": [
+ {
+ "provider_type": "invalid",
+ "provider_id": "provider",
+ "tool_name": "tool",
+ "tool_parameters": {"api_key": "secret"},
+ }
+ ],
+ }
+ app = AppRecord(
+ id="app",
+ name="Agent",
+ mode_compatible_with_agent=AppMode.AGENT_CHAT,
+ app_model_config={"agent_mode": agent_mode},
+ )
+ context = RequestContext("request", None, "account", "tenant")
+
+ masked = AppResponseGateway.mask_record(context, app)
+
+ assert masked is not app
+ assert masked.app_model_config is not None
+ assert masked.app_model_config["agent_mode"]["tools"][0]["tool_parameters"] == {}
+ assert agent_mode["tools"][0]["tool_parameters"] == {"api_key": "secret"}
diff --git a/api/tests/unit_tests/services/plugin/test_oauth_service.py b/api/tests/unit_tests/services/plugin/test_oauth_service.py
index eee65b3a18f..a6d2aafcab7 100644
--- a/api/tests/unit_tests/services/plugin/test_oauth_service.py
+++ b/api/tests/unit_tests/services/plugin/test_oauth_service.py
@@ -7,6 +7,7 @@ with one-time use semantics, and validation error paths.
from __future__ import annotations
import json
+from unittest.mock import patch
import pytest
@@ -88,11 +89,12 @@ class TestUseProxyContext:
stored = {"user_id": "u1", "tenant_id": "t1", "plugin_id": "p1", "provider": "github"}
redis_client.get.return_value = json.dumps(stored).encode()
- result = OAuthProxyService.use_proxy_context("valid-id")
+ with patch("services.plugin.oauth_service.redis_client.delete") as delete:
+ result = OAuthProxyService.use_proxy_context("valid-id")
assert result == stored
expected_key = "oauth_proxy_context:valid-id"
- redis_client.delete.assert_called_once_with(expected_key)
+ delete.assert_called_once_with(expected_key)
def test_returns_context_with_credential_id(self):
from extensions.ext_redis import redis_client
diff --git a/api/tests/unit_tests/services/test_app_dsl_service.py b/api/tests/unit_tests/services/test_app_dsl_service.py
index 82113de917a..60e10a36b85 100644
--- a/api/tests/unit_tests/services/test_app_dsl_service.py
+++ b/api/tests/unit_tests/services/test_app_dsl_service.py
@@ -15,12 +15,10 @@ from models import Account, App, AppMode
from models.model import AppModelConfig, AppModelConfigDict, IconType
from models.workflow import Workflow
from services.agent.dsl_entities import AgentPackage
-from services.app_dsl_service import AppDslService, Import, PendingData
-from services.enterprise.enterprise_service import EnterpriseService
+from services.app_dsl_service import AppDslService, PendingData
from services.entities.dsl_entities import ImportStatus
from services.errors.account import NoPermissionError
from services.errors.app import WorkflowNotFoundError
-from services.system_feature_service import SystemFeatureService
from tests.unit_tests.config_override import apply_config_overrides
from tests.unit_tests.model_factories import make_account, make_app, make_tenant, make_workflow
@@ -91,90 +89,6 @@ def _workflow(
return make_workflow(workflow_id="workflow-1", graph=graph, environment_variables=environment_variables or [])
[email protected]("status", [ImportStatus.FAILED, ImportStatus.PENDING])
-def test_copy_app_rolls_back_incomplete_import(
- sqlite_session: Session, monkeypatch: pytest.MonkeyPatch, status: ImportStatus
-) -> None:
- original = _persist_overwrite_target(sqlite_session)
- service = AppDslService(sqlite_session)
- monkeypatch.setattr(service, "export_dsl", Mock(return_value="dsl"))
-
- def import_app(**_kwargs: object) -> Import:
- original.name = "Uncommitted change"
- sqlite_session.flush()
- return Import(id="import-1", status=status)
-
- monkeypatch.setattr(service, "import_app", import_app)
- auth_enabled = Mock()
- monkeypatch.setattr(SystemFeatureService, "is_webapp_auth_enabled", auth_enabled)
-
- result, copied = service.copy_app(app_model=original, account=_account(tenant_id=_TENANT_ID), tenant_id=_TENANT_ID)
-
- assert result.status == status
- assert copied is None
- assert original.name == "Target"
- auth_enabled.assert_not_called()
-
-
[email protected]("status", [ImportStatus.COMPLETED, ImportStatus.COMPLETED_WITH_WARNINGS])
[email protected]("missing_settings", [False, True])
-def test_copy_app_commits_before_inheriting_access(
- sqlite_session: Session, monkeypatch: pytest.MonkeyPatch, status: ImportStatus, missing_settings: bool
-) -> None:
- original = _persist_overwrite_target(sqlite_session)
- service = AppDslService(sqlite_session)
- monkeypatch.setattr(service, "export_dsl", Mock(return_value="dsl"))
- copied_id = "55555555-5555-4555-8555-555555555555"
-
- def import_app(**_kwargs: object) -> Import:
- sqlite_session.add(_app(app_id=copied_id, tenant_id=_TENANT_ID))
- return Import(id="import-1", status=status, app_id=copied_id)
-
- def get_access_mode(app_id: str) -> SimpleNamespace:
- assert not sqlite_session.in_transaction()
- assert app_id == _OVERWRITE_APP_ID
- if missing_settings:
- raise ValueError("No settings")
- return SimpleNamespace(access_mode="private")
-
- def update_access_mode(app_id: str, access_mode: str) -> None:
- assert not sqlite_session.in_transaction()
- assert app_id == copied_id
- assert access_mode == ("public" if missing_settings else "private")
-
- monkeypatch.setattr(service, "import_app", import_app)
- monkeypatch.setattr(SystemFeatureService, "is_webapp_auth_enabled", lambda: True)
- monkeypatch.setattr(EnterpriseService.WebAppAuth, "get_app_access_mode_by_id", get_access_mode)
- update_access = Mock(side_effect=update_access_mode)
- monkeypatch.setattr(EnterpriseService.WebAppAuth, "update_app_access_mode", update_access)
-
- result, copied = service.copy_app(app_model=original, account=_account(tenant_id=_TENANT_ID), tenant_id=_TENANT_ID)
-
- assert result.status == status
- assert copied is not None
- assert copied.id == copied_id
- update_access.assert_called_once()
-
-
-def test_copy_app_scopes_result_to_current_tenant(sqlite_session: Session, monkeypatch: pytest.MonkeyPatch) -> None:
- original = _persist_overwrite_target(sqlite_session)
- foreign_app = _app(tenant_id="66666666-6666-4666-8666-666666666666", app_id=_OTHER_ACCOUNT_ID)
- sqlite_session.add(foreign_app)
- sqlite_session.commit()
- service = AppDslService(sqlite_session)
- monkeypatch.setattr(service, "export_dsl", Mock(return_value="dsl"))
- monkeypatch.setattr(
- service,
- "import_app",
- Mock(return_value=Import(id="import-1", status=ImportStatus.COMPLETED, app_id=foreign_app.id)),
- )
- monkeypatch.setattr(SystemFeatureService, "is_webapp_auth_enabled", lambda: False)
-
- _, copied = service.copy_app(app_model=original, account=_account(tenant_id=_TENANT_ID), tenant_id=_TENANT_ID)
-
- assert copied is None
-
-
def test_extract_workflow_dependencies_includes_plugin_nodes(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setattr(
"services.app_dsl_service.ToolNodeData.model_validate",
@@ -821,11 +735,13 @@ def test_export_dsl_preserves_envelope_and_mode_specific_content(
"services.app_dsl_service.DependenciesAnalysisService.generate_dependencies", Mock(return_value=[])
)
- def append_workflow(*, export_data: dict[str, object], **_kwargs: object) -> None:
+ def append_workflow(*, export_data: dict[str, object], **_kwargs: object) -> list[str]:
export_data["workflow"] = {"fixture": "workflow"}
+ return []
- def append_model(export_data: dict[str, object], *_args: object, **_kwargs: object) -> None:
+ def append_model(export_data: dict[str, object], *_args: object, **_kwargs: object) -> list[str]:
export_data["model_config"] = {"fixture": "model"}
+ return []
monkeypatch.setattr(AppDslService, "_append_workflow_export_data", Mock(side_effect=append_workflow))
monkeypatch.setattr(AppDslService, "_append_model_config_export_data", Mock(side_effect=append_model))
diff --git a/api/tests/unit_tests/services/test_app_service.py b/api/tests/unit_tests/services/test_app_service.py
index d95ec76547b..5ba1c505aaf 100644
--- a/api/tests/unit_tests/services/test_app_service.py
+++ b/api/tests/unit_tests/services/test_app_service.py
@@ -29,6 +29,7 @@ from models.agent_config_entities import AgentSoulConfig
from models.model import App, AppMode, AppModelConfig, IconType
from models.provider import TenantDefaultModel
from models.workflow import Workflow, WorkflowType
+from repositories.app.console_repository import ConsoleAppRepository
from services.agent.errors import AgentAccessNotReadyError, AgentNameConflictError
from services.app_service import AppListParams, AppService, CreateAppParams
from services.enterprise import rbac_service as enterprise_rbac_service
@@ -387,7 +388,7 @@ class TestCreateAppRBACAccessInitialization:
@pytest.mark.parametrize(
"update_status",
- [AppService.update_app_site_status, AppService.update_app_api_status],
+ [AppService.update_app_api_status],
)
def test_app_status_updates_commit_before_signal(update_status: Callable[..., App], sqlite_session: Session) -> None:
account = _persist_account(sqlite_session)
@@ -407,7 +408,6 @@ def test_app_status_updates_commit_before_signal(update_status: Callable[..., Ap
@pytest.mark.parametrize(
"update_status",
[
- AppService.update_app_site_status,
AppService.update_app_api_status,
],
)
@@ -567,7 +567,7 @@ def test_get_recent_apps_uses_one_tenant_scoped_projection_query(sqlite_session:
event.listen(bind, "before_cursor_execute", record_sql)
try:
- recent_apps = AppService().get_recent_apps(
+ recent_apps = ConsoleAppRepository.get_recent_apps(
account.id,
tenant_id,
AppListParams(limit=2),
diff --git a/api/tests/unit_tests/services/test_app_tracing_config_gateway.py b/api/tests/unit_tests/services/test_app_tracing_config_gateway.py
index e5f1e4deffa..df619b8e4e0 100644
--- a/api/tests/unit_tests/services/test_app_tracing_config_gateway.py
+++ b/api/tests/unit_tests/services/test_app_tracing_config_gateway.py
@@ -56,6 +56,24 @@ def test_validate_provider_does_not_load_optional_dependencies(provider: Tracing
load_provider.assert_not_called()
+def test_require_provider_available_loads_provider_dependencies() -> None:
+ with patch.object(OpsTraceManagerGateway, "_provider_config") as load_provider:
+ OpsTraceManagerGateway().require_provider_available("weave")
+
+ load_provider.assert_called_once_with("weave")
+
+
+def test_require_provider_available_reports_missing_dependency() -> None:
+ unavailable = AppTracingConfigProviderUnavailableError()
+ with (
+ patch.object(OpsTraceManagerGateway, "_provider_config", side_effect=unavailable),
+ pytest.raises(AppTracingConfigProviderUnavailableError) as caught,
+ ):
+ OpsTraceManagerGateway().require_provider_available("weave")
+
+ assert caught.value is unavailable
+
+
@pytest.mark.parametrize("update", [False, True])
def test_prepare_config_reports_missing_provider_dependencies(monkeypatch: pytest.MonkeyPatch, update: bool) -> None:
missing_dependency = TraceProviderNotInstalledError("weave", "wandb")
diff --git a/api/tests/unit_tests/services/test_dataset_service_dataset.py b/api/tests/unit_tests/services/test_dataset_service_dataset.py
index 18a833afb55..da1c3de26ef 100644
--- a/api/tests/unit_tests/services/test_dataset_service_dataset.py
+++ b/api/tests/unit_tests/services/test_dataset_service_dataset.py
@@ -271,7 +271,7 @@ class TestDatasetServiceRetrieval:
assert DatasetService.get_dataset_for_tenant(foreign.id, "tenant-1", session=sqlite_session) is None
def test_get_datasets_applies_rbac_resource_scope_and_maintainer_override(
- self, config_overrides: Callable[..., None], sqlite_session: Session
+ self, application_tags, config_overrides: Callable[..., None], sqlite_session: Session
) -> None:
user = _account(role=TenantAccountRole.NORMAL)
accessible = _dataset(dataset_id="accessible", name="Accessible", maintainer="other")
@@ -297,13 +297,14 @@ class TestDatasetServiceRetrieval:
user=user,
accessible_dataset_ids=[accessible.id],
include_own_datasets=True,
+ tags=application_tags,
)
assert total == 2
assert {dataset.id for dataset in datasets} == {accessible.id, owned.id}
def test_get_datasets_without_user_keeps_only_team_visible_rows(
- self, config_overrides: Callable[..., None], sqlite_session: Session
+ self, application_tags, config_overrides: Callable[..., None], sqlite_session: Session
) -> None:
shared = _dataset(dataset_id="shared", name="Shared", permission=DatasetPermissionEnum.ALL_TEAM)
private = _dataset(dataset_id="private", name="Private", permission=DatasetPermissionEnum.ONLY_ME)
@@ -312,10 +313,7 @@ class TestDatasetServiceRetrieval:
config_overrides(RBAC_ENABLED=False)
datasets, total = DatasetService.get_datasets(
- page=1,
- per_page=20,
- session=sqlite_session,
- tenant_id="tenant-1",
+ page=1, per_page=20, session=sqlite_session, tenant_id="tenant-1", tags=application_tags
)
assert total == 1
@@ -345,24 +343,21 @@ class TestDatasetServiceRetrieval:
assert {dataset.id for dataset in datasets} == {accessible.id, owned.id}
def test_get_datasets_rbac_without_user_returns_no_rows(
- self, config_overrides: Callable[..., None], sqlite_session: Session
+ self, application_tags, config_overrides: Callable[..., None], sqlite_session: Session
) -> None:
sqlite_session.add(_dataset())
sqlite_session.commit()
config_overrides(RBAC_ENABLED=True)
datasets, total = DatasetService.get_datasets(
- page=1,
- per_page=20,
- session=sqlite_session,
- tenant_id="tenant-1",
+ page=1, per_page=20, session=sqlite_session, tenant_id="tenant-1", tags=application_tags
)
assert datasets == []
assert total == 0
def test_get_datasets_rbac_include_all_requires_workspace_permission(
- self, config_overrides: Callable[..., None], sqlite_session: Session
+ self, application_tags, config_overrides: Callable[..., None], sqlite_session: Session
) -> None:
user = _account(role=TenantAccountRole.NORMAL)
sqlite_session.add_all(
@@ -389,6 +384,7 @@ class TestDatasetServiceRetrieval:
tenant_id="tenant-1",
user=user,
include_all=True,
+ tags=application_tags,
)
assert total == 2
diff --git a/api/tests/unit_tests/services/test_snippet_service.py b/api/tests/unit_tests/services/test_snippet_service.py
index 843c1857a81..6414a31f9b0 100644
--- a/api/tests/unit_tests/services/test_snippet_service.py
+++ b/api/tests/unit_tests/services/test_snippet_service.py
@@ -122,19 +122,23 @@ def test_validate_snippet_graph_forbidden_nodes_raises_with_node_details() -> No
def test_get_snippets_returns_empty_when_tag_filter_has_no_targets(
- monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
+ application_tags, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
) -> None:
get_target_ids = Mock(return_value=[])
- monkeypatch.setattr("services.snippet_service.TagService.get_target_ids_by_tag_ids", get_target_ids)
+ monkeypatch.setattr(application_tags, "find_target_ids", get_target_ids)
service = SnippetService.__new__(SnippetService)
- result = service.get_snippets(tenant_id="tenant-1", session=sqlite_session, tag_ids=["tag-1"])
+ result = service.get_snippets(
+ tenant_id="tenant-1", session=sqlite_session, tag_ids=["tag-1"], tags=application_tags
+ )
assert result == ([], 0, False)
- get_target_ids.assert_called_once_with("snippet", "tenant-1", ["tag-1"], sqlite_session, match_all=True)
+ get_target_ids.assert_called_once_with(tag_type="snippet", tenant_id="tenant-1", tag_ids=["tag-1"], match_all=True)
-def test_get_snippets_applies_filters_and_paginates(monkeypatch: pytest.MonkeyPatch, sqlite_session: Session) -> None:
+def test_get_snippets_applies_filters_and_paginates(
+ application_tags, monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
+) -> None:
snippets = []
for index in range(3):
snippet = CustomizedSnippet(
@@ -152,7 +156,8 @@ def test_get_snippets_applies_filters_and_paginates(monkeypatch: pytest.MonkeyPa
service = SnippetService.__new__(SnippetService)
get_target_ids = Mock(return_value=["snippet-1", "snippet-2", "snippet-3"])
monkeypatch.setattr(
- "services.snippet_service.TagService.get_target_ids_by_tag_ids",
+ application_tags,
+ "find_target_ids",
get_target_ids,
)
@@ -165,13 +170,14 @@ def test_get_snippets_applies_filters_and_paginates(monkeypatch: pytest.MonkeyPa
is_published=True,
creators=["account-1"],
tag_ids=["tag-1"],
+ tags=application_tags,
)
assert {snippet.id for snippet in result} <= {snippet.id for snippet in snippets}
assert len(result) == 1
assert total == 3
assert has_more is False
- get_target_ids.assert_called_once_with("snippet", "tenant-1", ["tag-1"], sqlite_session, match_all=True)
+ get_target_ids.assert_called_once_with(tag_type="snippet", tenant_id="tenant-1", tag_ids=["tag-1"], match_all=True)
def test_update_snippet_allows_duplicate_names(sqlite_session: Session) -> None:
diff --git a/api/tests/unit_tests/services/test_webapp_access_query_service.py b/api/tests/unit_tests/services/test_webapp_access_query_service.py
index 096168d7fd4..1f0839f0e37 100644
--- a/api/tests/unit_tests/services/test_webapp_access_query_service.py
+++ b/api/tests/unit_tests/services/test_webapp_access_query_service.py
@@ -3,8 +3,13 @@ from dataclasses import dataclass, field
from unittest.mock import MagicMock, create_autospec
import pytest
+from sqlalchemy import Engine, event
+from sqlalchemy.orm import sessionmaker
from enums import WebAppAccessMode
+from models.enums import CustomizeTokenStrategy
+from models.model import Site
+from repositories.webapp_access_query_repository import WebAppAccessQueryRepository
from services.webapp_access_query_service import (
WebAppAccessAppNotFoundError,
WebAppAccessQuery,
@@ -162,6 +167,62 @@ def test_enabled_auth_delegates_user_permission() -> None:
is_user_allowed_for_app.assert_called_once_with("user-1", "app-1")
[email protected]("missing", [False, True], ids=["found", "missing"])
+def test_app_code_lookup_releases_database_before_access_policy(sqlite_engine: Engine, missing: bool) -> None:
+ factory = sessionmaker(bind=sqlite_engine, expire_on_commit=False, close_resets_only=False)
+ app_id = "11111111-1111-1111-1111-111111111111"
+ with factory.begin() as session:
+ session.add(
+ Site(
+ app_id=app_id,
+ code="site-code",
+ title="Test Site",
+ default_language="en-US",
+ customize_token_strategy=CustomizeTokenStrategy.UUID,
+ )
+ )
+
+ connections: set[object] = set()
+ resolved: list[str] = []
+
+ def checkout(connection: object, *_args: object) -> None:
+ connections.add(connection)
+
+ def checkin(connection: object, *_args: object) -> None:
+ connections.remove(connection)
+
+ def access_mode_for_app(resolved_app_id: str) -> WebAppAccessMode:
+ assert not connections
+ resolved.append(resolved_app_id)
+ return WebAppAccessMode.PRIVATE
+
+ def is_user_allowed_for_app(_user_id: str, _app_id: str) -> bool:
+ raise AssertionError("Resolving access mode must not query user permissions")
+
+ service = WebAppAccessQueryService(
+ access=WebAppAccessQueryRepository(session_factory=factory),
+ webapp_auth_enabled=True,
+ access_mode_for_app=access_mode_for_app,
+ is_user_allowed_for_app=is_user_allowed_for_app,
+ get_access_modes=_unexpected_access_modes,
+ get_user_permissions=_unexpected_user_permissions,
+ )
+ event.listen(sqlite_engine, "checkout", checkout)
+ event.listen(sqlite_engine, "checkin", checkin)
+ try:
+ if missing:
+ with pytest.raises(WebAppAccessAppNotFoundError):
+ service.get_access_mode(app_id="must-not-fallback", app_code="missing-code")
+ assert resolved == []
+ else:
+ assert service.get_access_mode(app_id=None, app_code="site-code") is WebAppAccessMode.PRIVATE
+ assert resolved == [app_id]
+ assert not connections
+ finally:
+ event.remove(sqlite_engine, "checkout", checkout)
+ event.remove(sqlite_engine, "checkin", checkin)
+
+
@dataclass
class _BatchQueries:
access_modes: Mapping[str, WebAppAccessMode] = field(default_factory=dict)
diff --git a/packages/contracts/generated/api/console/apps/orpc.gen.ts b/packages/contracts/generated/api/console/apps/orpc.gen.ts
index d775a9aec11..8df754ae8f6 100644
--- a/packages/contracts/generated/api/console/apps/orpc.gen.ts
+++ b/packages/contracts/generated/api/console/apps/orpc.gen.ts
@@ -516,8 +516,6 @@ export const imports = {
}
/**
- * Return the lightweight app cards needed by the Explore home page
- *
* Get recently modified apps for the home Continue Work section
*/
export const get2 = oc
@@ -527,7 +525,6 @@ export const get2 = oc
method: 'GET',
operationId: 'getAppsRecent',
path: '/apps/recent',
- summary: 'Return the lightweight app cards needed by the Explore home page',
tags: ['console'],
})
.input(z.object({ query: zGetAppsRecentQuery.optional() }))
@@ -1783,8 +1780,6 @@ export const convertToWorkflow = {
}
/**
- * Copy app
- *
* Create a copy of an existing application
*/
export const post22 = oc
@@ -1795,7 +1790,6 @@ export const post22 = oc
operationId: 'postAppsByAppIdCopy',
path: '/apps/{app_id}/copy',
successStatus: 201,
- summary: 'Copy app',
tags: ['console'],
})
.input(z.object({ body: zPostAppsByAppIdCopyBody, params: zPostAppsByAppIdCopyPath }))
@@ -1806,8 +1800,6 @@ export const copy = {
}
/**
- * Export app
- *
* Export application configuration as DSL
*/
export const get31 = oc
@@ -1817,7 +1809,6 @@ export const get31 = oc
method: 'GET',
operationId: 'getAppsByAppIdExport',
path: '/apps/{app_id}/export',
- summary: 'Export app',
tags: ['console'],
})
.input(
@@ -1958,16 +1949,12 @@ export const name = {
post: post26,
}
-/**
- * Publish app to Creators Platform
- */
export const post27 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAppsByAppIdPublishToCreatorsPlatform',
path: '/apps/{app_id}/publish-to-creators-platform',
- summary: 'Publish app to Creators Platform',
tags: ['console'],
})
.input(z.object({ params: zPostAppsByAppIdPublishToCreatorsPlatformPath }))
@@ -2392,8 +2379,6 @@ export const textToAudio = {
}
/**
- * Get app trace
- *
* Get app tracing configuration
*/
export const get44 = oc
@@ -2403,7 +2388,6 @@ export const get44 = oc
method: 'GET',
operationId: 'getAppsByAppIdTrace',
path: '/apps/{app_id}/trace',
- summary: 'Get app trace',
tags: ['console'],
})
.input(z.object({ params: zGetAppsByAppIdTracePath }))
@@ -4401,8 +4385,6 @@ export const workflows3 = {
}
/**
- * Delete app
- *
* Delete application
*/
export const delete15 = oc
@@ -4413,15 +4395,12 @@ export const delete15 = oc
operationId: 'deleteAppsByAppId',
path: '/apps/{app_id}',
successStatus: 204,
- summary: 'Delete app',
tags: ['console'],
})
.input(z.object({ params: zDeleteAppsByAppIdPath }))
.output(zDeleteAppsByAppIdResponse)
/**
- * Get app detail
- *
* Get application details
*/
export const get84 = oc
@@ -4431,15 +4410,12 @@ export const get84 = oc
method: 'GET',
operationId: 'getAppsByAppId',
path: '/apps/{app_id}',
- summary: 'Get app detail',
tags: ['console'],
})
.input(z.object({ params: zGetAppsByAppIdPath }))
.output(zGetAppsByAppIdResponse)
/**
- * Update app
- *
* Update application details
*/
export const put6 = oc
@@ -4449,7 +4425,6 @@ export const put6 = oc
method: 'PUT',
operationId: 'putAppsByAppId',
path: '/apps/{app_id}',
- summary: 'Update app',
tags: ['console'],
})
.input(z.object({ body: zPutAppsByAppIdBody, params: zPutAppsByAppIdPath }))
@@ -4559,8 +4534,6 @@ export const byResourceId = {
}
/**
- * Get app list
- *
* Get list of applications with pagination and filtering
*/
export const get86 = oc
@@ -4570,15 +4543,12 @@ export const get86 = oc
method: 'GET',
operationId: 'getApps',
path: '/apps',
- summary: 'Get app list',
tags: ['console'],
})
.input(z.object({ query: zGetAppsQuery.optional() }))
.output(zGetAppsResponse)
/**
- * Create app
- *
* Create a new application
*/
export const post64 = oc
@@ -4589,7 +4559,6 @@ export const post64 = oc
operationId: 'postApps',
path: '/apps',
successStatus: 201,
- summary: 'Create app',
tags: ['console'],
})
.input(z.object({ body: zPostAppsBody }))