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): separate workspace RBAC controllers and application service (#43323)

Byron.wang2f20c7d95800
diff --git a/api/commands/rbac.py b/api/commands/rbac.py
index 0d937152c4d..7af7abb8b27 100644
--- a/api/commands/rbac.py
+++ b/api/commands/rbac.py
@@ -24,11 +24,11 @@ from models import (
TenantAccountJoin,
TenantAccountRole,
)
-from services.enterprise.rbac_service import (
- LegacyAgentRoleMigration,
+from services.enterprise.rbac_service import RBACService
+from services.rbac.contracts import (
+ AgentRoleMigration,
ListOption,
RBACResourceType,
- RBACService,
ReplaceMemberBindings,
ReplaceUserAccessPolicies,
)
@@ -148,7 +148,7 @@ class _AgentAccessBootstrapReason(StrEnum):
def _agent_manage_role_event(
tenant_id: str | None,
- entry: LegacyAgentRoleMigration,
+ entry: AgentRoleMigration,
*,
apply: bool,
kind: _AgentMigrationEventKind,
@@ -239,35 +239,16 @@ def _replace_member_role(
operator_account_id: str,
member_account_id: str,
role_id: str,
- *,
- session: Session,
) -> str:
RBACService.MemberRoles.replace(
tenant_id=tenant_id,
account_id=operator_account_id,
member_account_id=member_account_id,
role_ids=[role_id],
- session=session,
)
return member_account_id
-def _replace_member_role_with_new_session(
- tenant_id: str,
- operator_account_id: str,
- member_account_id: str,
- role_id: str,
-) -> str:
- with session_factory.create_session() as session:
- return _replace_member_role(
- tenant_id=tenant_id,
- operator_account_id=operator_account_id,
- member_account_id=member_account_id,
- role_id=role_id,
- session=session,
- )
-
-
@click.command(
"rbac-migrate-member-roles", help="Migrate legacy workspace member roles into RBAC member-role bindings."
)
@@ -342,21 +323,14 @@ def migrate_member_roles_to_rbac(
if replace_jobs:
if workers == 1:
- with session_factory.create_session() as session:
- for member_account_id, resolved_role_id in replace_jobs:
- _replace_member_role(
- workspace_id,
- owner_account_id,
- member_account_id,
- resolved_role_id,
- session=session,
- )
- migrated_count += 1
+ for member_account_id, resolved_role_id in replace_jobs:
+ _replace_member_role(workspace_id, owner_account_id, member_account_id, resolved_role_id)
+ migrated_count += 1
else:
with ThreadPoolExecutor(max_workers=workers) as executor:
futures = [
executor.submit(
- _replace_member_role_with_new_session,
+ _replace_member_role,
workspace_id,
owner_account_id,
member_account_id,
diff --git a/api/controllers/common/agent_access.py b/api/controllers/common/agent_access.py
index 1f2df6dfb47..21a6091bba9 100644
--- a/api/controllers/common/agent_access.py
+++ b/api/controllers/common/agent_access.py
@@ -2,17 +2,13 @@ from __future__ import annotations
from collections.abc import Sequence
from dataclasses import dataclass
-from typing import TYPE_CHECKING
from sqlalchemy.orm import Session
from services.agent.roster_service import AgentRosterService
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
+from services.rbac.contracts import MyPermissionsResponse
AGENT_LIST_PERMISSION_KEYS: frozenset[str] = frozenset({"agent.acl.preview"})
@@ -54,7 +50,6 @@ def resolve_agent_access_filter(
tenant_id: str,
account_id: str,
*,
- session: Session,
permissions: MyPermissionsResponse | None = None,
) -> AgentAccessFilter:
"""Compute Agent resources visible to an account in a workspace."""
@@ -62,7 +57,6 @@ def resolve_agent_access_filter(
permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
tenant_id,
account_id,
- session=session,
)
whitelist_scope = enterprise_rbac_service.RBACService.AgentAccess.whitelist_resources(tenant_id, account_id)
has_default_preview = has_agent_list_permission(
diff --git a/api/controllers/common/rbac/__init__.py b/api/controllers/common/rbac/__init__.py
index 7ed48814fc5..5e7e38bbc50 100644
--- a/api/controllers/common/rbac/__init__.py
+++ b/api/controllers/common/rbac/__init__.py
@@ -1,3 +1,5 @@
+from flask import request
+
from core.rbac import RBACPermission, RBACResourceScope
from .checks import RBAC_CHECKS_ATTR, RBACCheck, enforce_rbac_checks
@@ -28,4 +30,11 @@ __all__ = [
"ResourceLocator",
"Workspace",
"enforce_rbac_checks",
+ "rbac_language",
]
+
+
+def rbac_language() -> str | None:
+ """Read and normalize the optional RBAC label language from the query string."""
+ value = (request.args.get("language") or "").strip().lower()
+ return value if value in {"en", "ja", "zh"} else None
diff --git a/api/controllers/common/rbac/checks.py b/api/controllers/common/rbac/checks.py
index 5cd1ee74159..ae576d6e606 100644
--- a/api/controllers/common/rbac/checks.py
+++ b/api/controllers/common/rbac/checks.py
@@ -10,11 +10,15 @@ from services.enterprise.rbac_service import RBACService
from .locators import ResourceLocator, Workspace
-__all__ = ["RBAC_CHECKS_ATTR", "RBACCheck", "enforce_rbac_checks"]
+__all__ = ["RBAC_CHECKS_ATTR", "InvalidRBACCheckError", "RBACCheck", "enforce_rbac_checks"]
RBAC_CHECKS_ATTR = "rbac_checks"
+class InvalidRBACCheckError(RuntimeError):
+ """A route declares a permission scene with an incompatible resource locator."""
+
+
@dataclass(frozen=True)
class RBACCheck:
scene: RBACPermission
@@ -24,7 +28,7 @@ class RBACCheck:
if isinstance(self.locator, Workspace) or self.scene.scope is RBACResourceScope.WORKSPACE:
return
if self.locator.scope is not self.scene.scope:
- raise ValueError(
+ raise InvalidRBACCheckError(
f"{self.scene} is a {self.scene.scope} scene but {self.locator!r} locates {self.locator.scope}"
)
diff --git a/api/controllers/common/rbac/locators.py b/api/controllers/common/rbac/locators.py
index 1fde75f517a..12382e62500 100644
--- a/api/controllers/common/rbac/locators.py
+++ b/api/controllers/common/rbac/locators.py
@@ -1,16 +1,14 @@
from collections.abc import Mapping
from dataclasses import dataclass
-from typing import TYPE_CHECKING, Protocol, override, runtime_checkable
+from typing import Protocol, override, runtime_checkable
from flask import g
from werkzeug.exceptions import NotFound
+from controllers.common.errors import InvalidArgumentError
from core.rbac import RBACResourceScope
-from extensions.ext_database import db
-from services.rbac_resource_service import RBACResourceService
-
-if TYPE_CHECKING:
- from models.agent import Agent
+from extensions.ext_application_services import application_services
+from services.entities.app_entities import AppAgentBinding
__all__ = [
"AgentBehindApp",
@@ -46,15 +44,15 @@ class ResourceLocator(Protocol):
def _required(path_args: Mapping[str, object], param: str) -> str:
value = path_args.get(param)
if not value:
- raise ValueError(f"Missing {param} in request path")
+ raise InvalidArgumentError(description=f"Missing {param} in request path")
return str(value)
-def agent_binding(tenant_id: str, app_id: str) -> "Agent | None":
- cache: dict[tuple[str, str], Agent | None] = g.setdefault(_AGENT_BINDING_CACHE_KEY, {})
+def agent_binding(tenant_id: str, app_id: str) -> AppAgentBinding | None:
+ cache: dict[tuple[str, str], AppAgentBinding | None] = g.setdefault(_AGENT_BINDING_CACHE_KEY, {})
key = (tenant_id, app_id)
if key not in cache:
- cache[key] = RBACResourceService.get_app_agent_binding(db.session, tenant_id, app_id)
+ cache[key] = application_services().rbac.queries.get_app_agent_binding(tenant_id, app_id)
return cache[key]
@@ -104,7 +102,7 @@ class PlainApp(_ParamLocator):
return ResourceIdentity(self.scope, app_id)
def owner_id(self, tenant_id: str, identity: ResourceIdentity) -> str | None:
- return RBACResourceService.get_app_maintainer(db.session, tenant_id, identity.id)
+ return application_services().rbac.queries.get_app_maintainer(tenant_id, identity.id)
class AgentBehindApp(_ParamLocator):
@@ -112,10 +110,8 @@ class AgentBehindApp(_ParamLocator):
default_param = "app_id"
def locate(self, tenant_id: str, path_args: Mapping[str, object]) -> ResourceIdentity | None:
- from models.agent import AgentScope
-
binding = agent_binding(tenant_id, _required(path_args, self.param))
- if binding is None or binding.scope == AgentScope.WORKFLOW_ONLY:
+ if binding is None or binding.workflow_only:
return None
return ResourceIdentity(self.scope, binding.id)
@@ -131,7 +127,7 @@ class DatasetId(_ParamLocator):
return ResourceIdentity(self.scope, _required(path_args, self.param))
def owner_id(self, tenant_id: str, identity: ResourceIdentity) -> str | None:
- return RBACResourceService.get_dataset_maintainer(db.session, tenant_id, identity.id)
+ return application_services().rbac.queries.get_dataset_maintainer(tenant_id, identity.id)
class DatasetByDocument(DatasetId):
@@ -140,7 +136,7 @@ class DatasetByDocument(DatasetId):
@override
def locate(self, tenant_id: str, path_args: Mapping[str, object]) -> ResourceIdentity | None:
document_id = _required(path_args, self.param)
- dataset_id = RBACResourceService.get_dataset_id_by_document(db.session, tenant_id, document_id)
+ dataset_id = application_services().rbac.queries.get_dataset_id_by_document(tenant_id, document_id)
if dataset_id is None:
raise NotFound("Document not found")
return ResourceIdentity(self.scope, dataset_id)
@@ -152,7 +148,7 @@ class DatasetByPipeline(DatasetId):
@override
def locate(self, tenant_id: str, path_args: Mapping[str, object]) -> ResourceIdentity | None:
pipeline_id = _required(path_args, self.param)
- dataset_id = RBACResourceService.get_dataset_id_by_pipeline(db.session, tenant_id, pipeline_id)
+ dataset_id = application_services().rbac.queries.get_dataset_id_by_pipeline(tenant_id, pipeline_id)
if dataset_id is None:
raise NotFound("Dataset not found for pipeline")
return ResourceIdentity(self.scope, dataset_id)
diff --git a/api/controllers/console/agent/roster.py b/api/controllers/console/agent/roster.py
index 348abb7568e..58dee5cc944 100644
--- a/api/controllers/console/agent/roster.py
+++ b/api/controllers/console/agent/roster.py
@@ -85,10 +85,10 @@ from services.agent.observability_service import (
)
from services.agent.roster_service import AgentRosterService
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
from services.feature_service import FeatureService
+from services.rbac import contracts as rbac_contracts
from services.system_feature_service import SystemFeatureService
AgentPublicationStatus = Literal["published", "drafts"]
@@ -447,11 +447,10 @@ def _serialize_agent_app_detail(
payload["debug_conversation_message_count"] = message_count
payload["role"] = agent.role or ""
payload["access_ready"] = agent_has_workflow_callable_active_snapshot(session=session, agent=agent)
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
+ permissions = application_services().rbac.members.permissions(
app_model.tenant_id,
current_user.id,
agent_id=agent.id,
- session=session,
)
payload["permission_keys"] = permissions.agent.permission_keys_by_resource_ids([agent.id]).get(agent.id, [])
return AgentAppDetailWithSite.model_validate(payload).model_dump(mode="json", exclude={"bound_agent_id"})
@@ -464,7 +463,7 @@ def _serialize_agent_app_pagination(
tenant_id: str,
current_user: Account,
publication_counts: AgentAppPublicationCounts,
- agent_permissions: enterprise_rbac_service.ResourcePermissionSnapshot,
+ agent_permissions: rbac_contracts.ResourcePermissionSnapshot,
) -> dict:
"""Serialize Agent App lists with roster-shaped items.
@@ -656,16 +655,14 @@ class AgentAppListApi(Resource):
agent_is_published=agent_is_published,
)
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
+ permissions = application_services().rbac.members.permissions(
current_tenant_id,
current_user.id,
- session=session,
)
if dify_config.RBAC_ENABLED:
access_filter = resolve_agent_access_filter(
current_tenant_id,
current_user.id,
- session=session,
permissions=permissions,
)
access_filter.apply_to_app_params(params, tenant_id=current_tenant_id, session=session)
@@ -1103,15 +1100,13 @@ class AgentInviteOptionsApi(Resource):
):
accessible_agent_ids = None
if dify_config.RBAC_ENABLED:
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
+ permissions = application_services().rbac.members.permissions(
tenant_id,
current_user.id,
- session=session,
)
access_filter = resolve_agent_access_filter(
tenant_id,
current_user.id,
- session=session,
permissions=permissions,
)
if access_filter.accessible_agent_ids is not None:
diff --git a/api/controllers/console/app/permission_keys.py b/api/controllers/console/app/permission_keys.py
index be10f904021..e8bf6a67d71 100644
--- a/api/controllers/console/app/permission_keys.py
+++ b/api/controllers/console/app/permission_keys.py
@@ -1,9 +1,9 @@
-from extensions.ext_database import db
-from services.enterprise import rbac_service as enterprise_rbac_service
+from extensions.ext_application_services import application_services
+from services.rbac.contracts import RBACResourceType
def get_app_permission_keys(tenant_id: str, account_id: str | None, app_id: str) -> list[str]:
- permission_keys_map = enterprise_rbac_service.RBACService.AppPermissions.batch_get(
- tenant_id, account_id, [app_id], session=db.session()
+ permission_keys_map = application_services().rbac.members.resource_permissions(
+ tenant_id, account_id, RBACResourceType.APP, [app_id]
)
return permission_keys_map.get(app_id, [])
diff --git a/api/controllers/console/app/workflow.py b/api/controllers/console/app/workflow.py
index 0b0c5860c78..255cc684dd0 100644
--- a/api/controllers/console/app/workflow.py
+++ b/api/controllers/console/app/workflow.py
@@ -1971,10 +1971,10 @@ class WorkflowOnlineUsersApi(Resource):
return {"data": []}
access_filter = None
+ if dify_config.RBAC_ENABLED:
+ access_filter = resolve_app_access_filter(current_tenant_id, current_user.id)
workflow_service = WorkflowService()
with session_factory.create_session() as session:
- if dify_config.RBAC_ENABLED:
- access_filter = resolve_app_access_filter(current_tenant_id, current_user.id, session=session)
app_maintainers = workflow_service.get_tenant_app_maintainers(app_ids, current_tenant_id, session=session)
accessible_app_ids = set(app_maintainers)
diff --git a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
index b6d1f6ff35a..6fc51cb062d 100644
--- a/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
+++ b/api/controllers/console/datasets/rag_pipeline/rag_pipeline_datasets.py
@@ -29,6 +29,7 @@ from services.entities.knowledge_entities.rag_pipeline_entities import IconInfo,
from services.knowledge.dataset_read_service import load_dataset_detail
from services.knowledge.dataset_service import DatasetPermissionService, DatasetService
from services.rag_pipeline.rag_pipeline_dsl_service import RagPipelineDslService
+from services.rbac import contracts as rbac_contracts
class RagPipelineDatasetImportPayload(BaseModel):
@@ -98,12 +99,12 @@ class CreateRagPipelineDatasetApi(Resource):
current_tenant_id,
current_user.id,
dataset_id,
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=False),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=False),
)
enterprise_rbac_service.try_sync_creator_access_policy_member_bindings(
current_tenant_id,
current_user.id,
- enterprise_rbac_service.RBACResourceType.DATASET,
+ rbac_contracts.RBACResourceType.DATASET,
dataset_id,
)
diff --git a/api/controllers/console/workspace/members.py b/api/controllers/console/workspace/members.py
index 9a856fce14b..63827c977b6 100644
--- a/api/controllers/console/workspace/members.py
+++ b/api/controllers/console/workspace/members.py
@@ -10,6 +10,7 @@ from werkzeug.exceptions import Forbidden, NotFound
from configs import dify_config
from controllers.common.fields import SimpleResultDataResponse, SimpleResultResponse, VerificationTokenResponse
+from controllers.common.rbac import rbac_language
from controllers.common.schema import register_enum_models, register_response_schema_models, register_schema_models
from controllers.console import console_ns
from controllers.console.auth.error import (
@@ -142,7 +143,9 @@ class MemberListApi(Resource):
@console_ns.response(HTTPStatus.OK, "Success", console_ns.models[AccountWithRoleListResponse.__name__])
@console_account_admission()
def get(self, request_context: RequestContext):
- members = application_services().workspaces.member_queries.list_current(request_context)
+ members = application_services().workspaces.member_queries.list_current(
+ request_context, language=rbac_language()
+ )
serialized_members = [
{
"id": member.id,
diff --git a/api/controllers/console/workspace/rbac.py b/api/controllers/console/workspace/rbac.py
deleted file mode 100644
index 1ef222fbe81..00000000000
--- a/api/controllers/console/workspace/rbac.py
+++ /dev/null
@@ -1,957 +0,0 @@
-from __future__ import annotations
-
-from collections.abc import Callable, Mapping
-from dataclasses import dataclass
-from typing import Any, Literal
-
-from flask import request
-from flask_restx import Resource
-from pydantic import AliasChoices, BaseModel, ConfigDict, Field, ValidationError, field_validator
-from sqlalchemy import select
-from werkzeug.exceptions import NotFound
-
-from configs import dify_config
-from controllers.common.rbac import RBACCheck, Workspace
-from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models
-from controllers.console import console_ns
-from controllers.console.wraps import RBACPermission, model_validate, rbac_permission_required
-from core.db.session_factory import session_factory
-from enums import DeploymentEdition
-from extensions.ext_database import db
-from libs.login import current_account_with_tenant, login_required
-from models import Account
-from services.enterprise import rbac_service as svc
-from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
-
-
-class _RBACRoleList(svc.Paginated[svc.RBACRole]):
- pass
-
-
-class _RBACRoleAccountList(svc.Paginated[svc.RBACRoleAccount]):
- pass
-
-
-class _AccessPolicyList(svc.Paginated[svc.AccessPolicy]):
- pass
-
-
-class _MembersInRoleList(svc.Paginated[svc.MembersInRole]):
- pass
-
-
-register_response_schema_models(
- console_ns,
- svc.PermissionCatalogResponse,
- svc.RBACRole,
- _RBACRoleList,
- _RBACRoleAccountList,
- _MembersInRoleList,
- svc.AccessPolicy,
- _AccessPolicyList,
- svc.AccessPolicyBindingState,
- svc.MyPermissionsResponse,
- svc.AppAccessMatrix,
- svc.DatasetAccessMatrix,
- svc.AgentAccessMatrix,
- svc.WorkspaceAccessMatrix,
- svc.ResourceWhitelist,
- svc.ResourceWhitelistConfig,
- svc.ResourceUserAccessPoliciesResponse,
- svc.ReplaceUserAccessPoliciesResponse,
- svc.RoleBindingsResponse,
- svc.MemberBindingsResponse,
- svc.MemberRolesResponse,
- svc.AccessMatrixItem,
-)
-
-_LEGACY_ROLE_PERMISSION_KEYS: dict[str, list[str]] = {
- # This is a compatibility projection from the pre-RBAC workspace roles into
- # the 2.0 permission matrix documented in "权限整理2.0". It intentionally
- # models the product-facing role surface for the new RBAC UI instead of the
- # legacy backend's exact hard-authorization checks.
- "owner": [
- *svc._LEGACY_WORKSPACE_OWNER_KEYS,
- *svc._LEGACY_APP_OWNER_KEYS,
- *svc._LEGACY_DATASET_OWNER_KEYS,
- ],
- "admin": [
- *svc._LEGACY_WORKSPACE_ADMIN_KEYS,
- *svc._LEGACY_APP_ADMIN_KEYS,
- *svc._LEGACY_DATASET_ADMIN_KEYS,
- ],
- "editor": [
- *svc._LEGACY_WORKSPACE_EDITOR_KEYS,
- *svc._LEGACY_APP_EDITOR_KEYS,
- *svc._LEGACY_DATASET_EDITOR_KEYS,
- ],
- "normal": [
- *svc._LEGACY_WORKSPACE_NORMAL_KEYS,
- *svc._LEGACY_APP_NORMAL_KEYS,
- ],
- "dataset_operator": [
- *svc._LEGACY_WORKSPACE_DATASET_OPERATOR_KEYS,
- *svc._LEGACY_DATASET_DATASET_OPERATOR_KEYS,
- ],
-}
-
-
-def _current_ids() -> tuple[str, str]:
- """Return ``(tenant_id, account_id)`` for the authenticated user, or
- raise a 404 when no tenant is associated with the session.
- """
-
- user, tenant_id = current_account_with_tenant()
- if not tenant_id:
- raise NotFound("Current workspace not found")
- return tenant_id, user.id
-
-
-def _payload(model: type[BaseModel]) -> Any:
- """Validate the JSON body against ``model`` or raise ``ValidationError``.
-
- ``ValidationError`` bubbles up as HTTP 400 thanks to
- ``controllers/common/helpers.py`` error handling.
- """
- try:
- return model.model_validate(console_ns.payload or {})
- except ValidationError as exc:
- # Re-raise as-is so the upstream error handler renders a 400.
- raise exc
-
-
-def _dump(model: BaseModel) -> dict[str, Any]:
- return model.model_dump(mode="json")
-
-
-def _account_names_by_ids(account_ids: list[str]) -> dict[str, dict[str, str]]:
- ids = sorted({account_id.strip() for account_id in account_ids if account_id and account_id.strip()})
- if not ids:
- return {}
-
- with session_factory.create_session() as session:
- rows = session.execute(
- select(Account.id, Account.name, Account.avatar, Account.email).where(Account.id.in_(ids))
- ).all()
-
- return {
- account_id: {
- "name": name or "",
- "avatar": avatar or "",
- "email": email or "",
- }
- for account_id, name, avatar, email in rows
- }
-
-
-def _hydrate_access_matrix_account_names(items: list[svc.AccessMatrixItem]) -> None:
- account_ids: list[str] = []
- for item in items:
- for account in item.accounts:
- account_id = account.account_id
- if account_id and not account.account_name:
- account_ids.append(account_id)
-
- account_names = _account_names_by_ids(account_ids)
- if not account_names:
- return
-
- for item in items:
- for account in item.accounts:
- account_id = str(account.account_id or "").strip()
- if account_id and not account.account_name:
- account.account_name = account_names.get(account_id, {}).get("name", "")
- account.avatar = account_names.get(account_id, {}).get("avatar", "")
- account.email = account_names.get(account_id, {}).get("email", "")
-
-
-def _hydrate_resource_user_account_names(items: list[svc.ResourceUserAccessPolicies]) -> None:
- account_names = _account_names_by_ids([item.account.account_id for item in items])
- for item in items:
- account_id = item.account.account_id
- if account_id and not item.account.account_name:
- item.account.account_name = account_names.get(account_id, {}).get("name", "")
- item.account.avatar = account_names.get(account_id, {}).get("avatar", "")
- item.account.email = account_names.get(account_id, {}).get("email", "")
-
-
-def _move_resource_maintainer_first(items: list[svc.ResourceUserAccessPolicies], maintainer_id: str | None) -> None:
- if not maintainer_id:
- return
-
- normalized_maintainer_id = str(maintainer_id).strip()
- if not normalized_maintainer_id:
- return
-
- for index, item in enumerate(items):
- account_id = str(item.account.account_id or "").strip()
- if account_id == normalized_maintainer_id:
- if index:
- items.insert(0, items.pop(index))
- return
-
-
-class _PaginationQuery(BaseModel):
- model_config = ConfigDict(extra="ignore")
-
- page_number: int | None = Field(default=None, ge=1, validation_alias=AliasChoices("page", "page_number"))
- results_per_page: int | None = Field(
- default=None, ge=1, le=99999, validation_alias=AliasChoices("limit", "results_per_page")
- )
- reverse: bool | None = None
-
- def to_inner_options(self) -> svc.ListOption:
- return svc.ListOption.model_validate(self.model_dump())
-
-
-class _RolesListQuery(_PaginationQuery):
- include_owner: int = Field(default=0, ge=0, le=1)
-
-
-class CopyRoleParam(BaseModel):
- copy_member: bool = True
-
-
-def _pagination_options() -> svc.ListOption:
- return _PaginationQuery.model_validate(request.args.to_dict(flat=True)).to_inner_options()
-
-
-def _legacy_workspace_roles(
- options: svc.ListOption | None = None, *, include_owner: int = 0, billing_enabled: bool = True
-) -> svc.Paginated[svc.RBACRole]:
- """Return the built-in legacy workspace roles in the RBAC list shape.
-
- This keeps the new `/rbac/roles` endpoint compatible with the original
- Dify role model when enterprise RBAC is disabled.
- """
- legacy_roles = []
- for role_name in ("owner", "admin", "editor", "normal", "dataset_operator"):
- if not dify_config.DATASET_OPERATOR_ENABLED and role_name == "dataset_operator":
- continue
-
- permission_keys = _LEGACY_ROLE_PERMISSION_KEYS[role_name]
- valid_permission_keys = []
- for permission_key in permission_keys:
- if not billing_enabled and "billing" in permission_key:
- continue
- valid_permission_keys.append(permission_key)
-
- legacy_roles.append(
- svc.RBACRole(
- id=role_name,
- tenant_id="",
- type=svc.RBACRoleType.WORKSPACE.value,
- category="global_system_default",
- name=role_name,
- description="",
- is_builtin=True,
- permission_keys=valid_permission_keys,
- role_tag="owner" if role_name == "owner" else "",
- )
- )
-
- if not include_owner:
- legacy_roles = [r for r in legacy_roles if r.name != "owner"]
-
- page_number = options.page_number if options and options.page_number is not None else 1
- results_per_page = (
- options.results_per_page if options and options.results_per_page is not None else len(legacy_roles)
- )
- reverse = options.reverse if options and options.reverse is not None else False
-
- ordered_roles = list(reversed(legacy_roles)) if reverse else legacy_roles
- start = max(page_number - 1, 0) * results_per_page
- end = start + results_per_page
- paged_roles = ordered_roles[start:end]
- total_count = len(legacy_roles)
- total_pages = (total_count + results_per_page - 1) // results_per_page if results_per_page > 0 else 0
-
- return svc.Paginated[svc.RBACRole](
- data=paged_roles,
- pagination=svc.Pagination(
- total_count=total_count,
- per_page=results_per_page,
- current_page=page_number,
- total_pages=total_pages,
- ),
- )
-
-
-@console_ns.route("/workspaces/current/rbac/role-permissions/catalog")
-class RBACWorkspaceCatalogApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.PermissionCatalogResponse.__name__])
- def get(self):
- tenant_id, account_id = _current_ids()
- return _dump(svc.RBACService.Catalog.workspace(tenant_id, account_id))
-
-
-# ---------------------------------------------------------------------------
-# Roles.
-# ---------------------------------------------------------------------------
-
-
-class _RoleUpsertRequest(BaseModel):
- """Accepts the payload sent by the Create/Edit Role dialog."""
-
- name: str
- description: str = ""
- permission_keys: list[str] = []
-
- def to_mutation(self) -> svc.RoleMutation:
- return svc.RoleMutation(
- name=self.name,
- description=self.description,
- permission_keys=list(self.permission_keys),
- )
-
-
-@console_ns.route("/workspaces/current/rbac/roles")
-class RBACRolesApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[_RBACRoleList.__name__])
- @model_validate(_RolesListQuery)
- def get(self, req_data: _RolesListQuery):
- tenant_id, account_id = _current_ids()
- options = req_data.to_inner_options()
- if not dify_config.RBAC_ENABLED:
- result = _legacy_workspace_roles(
- options,
- include_owner=req_data.include_owner,
- billing_enabled=dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD,
- )
- else:
- result = svc.RBACService.Roles.list(
- tenant_id,
- account_id,
- include_owner=req_data.include_owner,
- biiling_enabled=dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD,
- options=options,
- )
-
- return _dump(result)
-
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(201, "Role created", console_ns.models[svc.RBACRole.__name__])
- def post(self):
- tenant_id, account_id = _current_ids()
- request = _payload(_RoleUpsertRequest)
- role = svc.RBACService.Roles.create(tenant_id, account_id, request.to_mutation())
- return _dump(role), 201
-
-
-@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>")
-class RBACRoleItemApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.RBACRole.__name__])
- def get(self, role_id):
- tenant_id, account_id = _current_ids()
- return _dump(
- svc.RBACService.Roles.get(
- tenant_id,
- account_id,
- role_id,
- billing_enabled=dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD,
- )
- )
-
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.RBACRole.__name__])
- def put(self, role_id):
- tenant_id, account_id = _current_ids()
- request = _payload(_RoleUpsertRequest)
- role = svc.RBACService.Roles.update(tenant_id, account_id, str(role_id), request.to_mutation())
- return _dump(role)
-
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.RBACRole.__name__])
- def delete(self, role_id):
- tenant_id, account_id = _current_ids()
- svc.RBACService.Roles.delete(tenant_id, account_id, str(role_id))
- return {"result": "success"}
-
-
-@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>/copy")
-class RBACRoleCopyApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(201, "Role copied", console_ns.models[svc.RBACRole.__name__])
- def post(self, role_id):
- tenant_id, account_id = _current_ids()
- request = _payload(CopyRoleParam)
- role = svc.RBACService.Roles.copy(tenant_id, account_id, str(role_id), copy_member=request.copy_member)
- return _dump(role), 201
-
-
-class _AccessPolicyCreateRequest(BaseModel):
- name: str
- resource_type: svc.RBACResourceType
- description: str = ""
- permission_keys: list[str] = []
-
-
-class _AccessPolicyUpdateRequest(BaseModel):
- name: str
- description: str = ""
- permission_keys: list[str] = []
-
-
-register_schema_models(console_ns, _AccessPolicyCreateRequest, _AccessPolicyUpdateRequest)
-
-
-@console_ns.route("/workspaces/current/rbac/access-policies")
-class RBACAccessPoliciesApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[_AccessPolicyList.__name__])
- def get(self):
- tenant_id, account_id = _current_ids()
- # `resource_type` is exposed as a query argument so the UI can show
- # only app-scoped or only dataset-scoped permission sets.
- resource_type = request.args.get("resource_type") or None
- return _dump(
- svc.RBACService.AccessPolicies.list(
- tenant_id,
- account_id,
- resource_type=resource_type,
- options=_pagination_options(),
- )
- )
-
- @console_ns.expect(console_ns.models[_AccessPolicyCreateRequest.__name__])
- @console_ns.response(201, "Policy created", console_ns.models[svc.AccessPolicy.__name__])
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- def post(self):
- tenant_id, account_id = _current_ids()
- request = _payload(_AccessPolicyCreateRequest)
- policy = svc.RBACService.AccessPolicies.create(
- tenant_id,
- account_id,
- svc.AccessPolicyCreate(
- name=request.name,
- resource_type=request.resource_type,
- description=request.description,
- permission_keys=list(request.permission_keys),
- ),
- )
- return _dump(policy), 201
-
-
-@console_ns.route("/workspaces/current/rbac/access-policies/<uuid:policy_id>")
-class RBACAccessPolicyItemApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.AccessPolicy.__name__])
- def get(self, policy_id):
- tenant_id, account_id = _current_ids()
- return _dump(svc.RBACService.AccessPolicies.get(tenant_id, account_id, str(policy_id)))
-
- @console_ns.expect(console_ns.models[_AccessPolicyUpdateRequest.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.AccessPolicy.__name__])
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- def put(self, policy_id):
- tenant_id, account_id = _current_ids()
- request = _payload(_AccessPolicyUpdateRequest)
- policy = svc.RBACService.AccessPolicies.update(
- tenant_id,
- account_id,
- str(policy_id),
- svc.AccessPolicyUpdate(
- name=request.name,
- description=request.description,
- permission_keys=list(request.permission_keys),
- ),
- )
- return _dump(policy)
-
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.AccessPolicy.__name__])
- def delete(self, policy_id):
- tenant_id, account_id = _current_ids()
- svc.RBACService.AccessPolicies.delete(tenant_id, account_id, str(policy_id))
- return {"result": "success"}
-
-
-@console_ns.route("/workspaces/current/rbac/access-policies/<uuid:policy_id>/copy")
-class RBACAccessPolicyCopyApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(201, "Policy copied", console_ns.models[svc.AccessPolicy.__name__])
- def post(self, policy_id):
- tenant_id, account_id = _current_ids()
- policy = svc.RBACService.AccessPolicies.copy(tenant_id, account_id, str(policy_id))
- return _dump(policy), 201
-
-
-@console_ns.route("/workspaces/current/rbac/access-policy-bindings/<uuid:binding_id>/lock")
-class RBACAccessPolicyBindingLockApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.AccessPolicyBindingState.__name__])
- def put(self, binding_id):
- tenant_id, account_id = _current_ids()
- return _dump(svc.RBACService.AccessPolicyBindings.lock(tenant_id, account_id, str(binding_id)))
-
-
-@console_ns.route("/workspaces/current/rbac/access-policy-bindings/<uuid:binding_id>/unlock")
-class RBACAccessPolicyBindingUnlockApi(Resource):
- @login_required
- @rbac_permission_required(RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace()))
- @console_ns.response(200, "Success", console_ns.models[svc.AccessPolicyBindingState.__name__])
- def put(self, binding_id):
- tenant_id, account_id = _current_ids()
- return _dump(svc.RBACService.AccessPolicyBindings.unlock(tenant_id, account_id, str(binding_id)))
-
-
-class _ResourceAccessScopeRequest(BaseModel):
- automatic_include_workspace_members: bool
-
-
-class _ReplaceBindingsRequest(BaseModel):
- role_ids: list[str] = Field(default_factory=list)
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("role_ids", "account_ids", mode="before")
- @classmethod
- def _coerce_bindings(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class _DeleteMemberBindingsRequest(BaseModel):
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("account_ids", mode="before")
- @classmethod
- def _coerce_account_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class _AccessControlLanguageQuery(BaseModel):
- language: Literal["en", "ja", "zh"] | None = Field(default=None, description="Localized policy label language")
-
-
-class _ResourceUserAccessPoliciesQuery(_PaginationQuery):
- language: Literal["en", "ja", "zh"] | None = Field(default=None, description="Localized policy label language")
-
-
-register_schema_models(
- console_ns,
- _ResourceAccessScopeRequest,
- _ReplaceBindingsRequest,
- _DeleteMemberBindingsRequest,
- _AccessControlLanguageQuery,
- _ResourceUserAccessPoliciesQuery,
- svc.ReplaceUserAccessPolicies,
-)
-
-
-@console_ns.route("/workspaces/current/rbac/my-permissions")
-class RBACMyPermissionsApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.MyPermissionsResponse.__name__])
- def get(self):
- tenant_id, account_id = _current_ids()
- return _dump(
- svc.RBACService.MyPermissions.get(
- tenant_id,
- account_id,
- app_id=request.args.get("app_id") or None,
- dataset_id=request.args.get("dataset_id") or None,
- agent_id=request.args.get("agent_id") or None,
- session=db.session(),
- )
- )
-
-
-type _ResourceAccessClient = (
- type[svc.RBACService.AppAccess] | type[svc.RBACService.DatasetAccess] | type[svc.RBACService.AgentAccess]
-)
-
-
-@dataclass(frozen=True)
-class _ResourceAccessRoutes:
- resource_type: svc.RBACResourceType
- class_prefix: str
- matrix_model: type[BaseModel]
- access: _ResourceAccessClient
- catalog: Callable[[str, str], svc.PermissionCatalogResponse]
- workspace_matrix: Callable[[str, str, svc.ListOption], svc.WorkspaceAccessMatrix]
- workspace_role_bindings: Callable[[str, str, str], svc.RoleBindingsResponse]
- workspace_member_bindings: Callable[[str, str, str], svc.MemberBindingsResponse]
- replace_workspace_bindings: Callable[[str, str, str, svc.ReplaceBindings], svc.AccessMatrixItem]
- maintainer_id: Callable[[str, str], str | None] | None = None
-
- @property
- def url_segment(self) -> str:
- return self.resource_type.route.segment
-
- @property
- def id_param(self) -> str:
- return self.resource_type.route.id_param
-
-
-@dataclass(frozen=True)
-class _ResourceAccessApis:
- catalog: type[Resource]
- matrix: type[Resource]
- whitelist: type[Resource]
- whitelist_config: type[Resource]
- user_access_policies: type[Resource]
- user_access_policy_assignment: type[Resource]
- role_bindings: type[Resource]
- member_bindings: type[Resource]
- workspace_matrix: type[Resource]
- workspace_role_bindings: type[Resource]
- workspace_bindings: type[Resource]
- workspace_member_bindings: type[Resource]
-
-
-_RESOURCE_ACCESS_ROUTES = (
- _ResourceAccessRoutes(
- resource_type=svc.RBACResourceType.APP,
- class_prefix="App",
- matrix_model=svc.AppAccessMatrix,
- access=svc.RBACService.AppAccess,
- catalog=lambda tenant_id, account_id: svc.RBACService.Catalog.app(tenant_id, account_id),
- workspace_matrix=lambda tenant_id, account_id, options: svc.RBACService.WorkspaceAccess.app_matrix(
- tenant_id, account_id, options=options
- ),
- workspace_role_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_app_role_bindings(tenant_id, account_id, policy_id)
- ),
- workspace_member_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_app_member_bindings(tenant_id, account_id, policy_id)
- ),
- replace_workspace_bindings=lambda tenant_id, account_id, policy_id, payload: (
- svc.RBACService.WorkspaceAccess.replace_app_bindings(tenant_id, account_id, policy_id, payload)
- ),
- maintainer_id=lambda tenant_id, resource_id: svc.app_maintainer_id(tenant_id, resource_id),
- ),
- _ResourceAccessRoutes(
- resource_type=svc.RBACResourceType.DATASET,
- class_prefix="Dataset",
- matrix_model=svc.DatasetAccessMatrix,
- access=svc.RBACService.DatasetAccess,
- catalog=lambda tenant_id, account_id: svc.RBACService.Catalog.dataset(tenant_id, account_id),
- workspace_matrix=lambda tenant_id, account_id, options: svc.RBACService.WorkspaceAccess.dataset_matrix(
- tenant_id, account_id, options=options
- ),
- workspace_role_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_dataset_role_bindings(tenant_id, account_id, policy_id)
- ),
- workspace_member_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_dataset_member_bindings(tenant_id, account_id, policy_id)
- ),
- replace_workspace_bindings=lambda tenant_id, account_id, policy_id, payload: (
- svc.RBACService.WorkspaceAccess.replace_dataset_bindings(tenant_id, account_id, policy_id, payload)
- ),
- maintainer_id=lambda tenant_id, resource_id: svc.dataset_maintainer_id(tenant_id, resource_id),
- ),
- _ResourceAccessRoutes(
- resource_type=svc.RBACResourceType.AGENT,
- class_prefix="Agent",
- matrix_model=svc.AgentAccessMatrix,
- access=svc.RBACService.AgentAccess,
- catalog=lambda tenant_id, account_id: svc.RBACService.Catalog.agent(tenant_id, account_id),
- workspace_matrix=lambda tenant_id, account_id, options: svc.RBACService.WorkspaceAccess.agent_matrix(
- tenant_id, account_id, options=options
- ),
- workspace_role_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_agent_role_bindings(tenant_id, account_id, policy_id)
- ),
- workspace_member_bindings=lambda tenant_id, account_id, policy_id: (
- svc.RBACService.WorkspaceAccess.list_agent_member_bindings(tenant_id, account_id, policy_id)
- ),
- replace_workspace_bindings=lambda tenant_id, account_id, policy_id, payload: (
- svc.RBACService.WorkspaceAccess.replace_agent_bindings(tenant_id, account_id, policy_id, payload)
- ),
- ),
-)
-
-
-def _build_resource_access_apis(spec: _ResourceAccessRoutes) -> _ResourceAccessApis:
- id_param = spec.id_param
- resource_prefix = f"/workspaces/current/rbac/{spec.url_segment}/<uuid:{id_param}>"
- workspace_prefix = f"/workspaces/current/rbac/workspace/{spec.url_segment}"
-
- def resource_id(path_params: Mapping[str, object]) -> str:
- return str(path_params[id_param])
-
- def register(resource: type[Resource], name: str, url: str) -> type[Resource]:
- resource.__name__ = name
- resource.__qualname__ = name
- console_ns.route(url)(resource)
- return resource
-
- class CatalogApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.PermissionCatalogResponse.__name__])
- def get(self):
- tenant_id, account_id = _current_ids()
- return _dump(spec.catalog(tenant_id, account_id))
-
- class MatrixApi(Resource):
- @login_required
- @console_ns.doc(params=query_params_from_model(_AccessControlLanguageQuery))
- @console_ns.response(200, "Success", console_ns.models[spec.matrix_model.__name__])
- def get(self, **path_params):
- tenant_id, account_id = _current_ids()
- result = spec.access.matrix(tenant_id, account_id, resource_id(path_params))
- _hydrate_access_matrix_account_names(result.items)
- return _dump(result)
-
- class WhitelistApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.ResourceWhitelist.__name__])
- def get(self, **path_params):
- tenant_id, account_id = _current_ids()
- return _dump(spec.access.whitelist(tenant_id, account_id, resource_id(path_params)))
-
- @login_required
- @console_ns.expect(console_ns.models[_ResourceAccessScopeRequest.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.ResourceWhitelist.__name__])
- def put(self, **path_params):
- tenant_id, account_id = _current_ids()
- target_id = resource_id(path_params)
- scope = _payload(_ResourceAccessScopeRequest)
- result = spec.access.replace_whitelist(
- tenant_id,
- account_id,
- target_id,
- svc.ReplaceMemberBindings(
- automatic_include_workspace_members=scope.automatic_include_workspace_members
- ),
- )
- if scope.automatic_include_workspace_members:
- initialize_created_app_rbac_access_task.delay(tenant_id, account_id, **{id_param: target_id})
- return _dump(result)
-
- class WhitelistConfigApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.ResourceWhitelistConfig.__name__])
- def get(self, **path_params):
- tenant_id, account_id = _current_ids()
- return _dump(spec.access.whitelist_config(tenant_id, account_id, resource_id(path_params)))
-
- class UserAccessPoliciesApi(Resource):
- @login_required
- @console_ns.doc(params=query_params_from_model(_ResourceUserAccessPoliciesQuery))
- @console_ns.response(200, "Success", console_ns.models[svc.ResourceUserAccessPoliciesResponse.__name__])
- def get(self, **path_params):
- tenant_id, account_id = _current_ids()
- target_id = resource_id(path_params)
- options = _pagination_options()
- result = spec.access.user_access_policies(tenant_id, account_id, target_id, options=options)
- maintainer_id = spec.maintainer_id(tenant_id, target_id) if spec.maintainer_id else None
- _move_resource_maintainer_first(result.data, maintainer_id)
- _hydrate_resource_user_account_names(result.data)
- return _dump(result)
-
- class UserAccessPolicyAssignmentApi(Resource):
- @login_required
- @console_ns.expect(console_ns.models[svc.ReplaceUserAccessPolicies.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.ReplaceUserAccessPoliciesResponse.__name__])
- def put(self, target_account_id, **path_params):
- tenant_id, account_id = _current_ids()
- payload = _payload(svc.ReplaceUserAccessPolicies)
- return _dump(
- spec.access.replace_user_access_policies(
- tenant_id,
- account_id,
- resource_id(path_params),
- str(target_account_id),
- payload,
- )
- )
-
- class RoleBindingsApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.RoleBindingsResponse.__name__])
- def get(self, policy_id, **path_params):
- tenant_id, account_id = _current_ids()
- return _dump(
- spec.access.list_role_bindings(tenant_id, account_id, resource_id(path_params), str(policy_id))
- )
-
- class MemberBindingsApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.MemberBindingsResponse.__name__])
- def get(self, policy_id, **path_params):
- tenant_id, account_id = _current_ids()
- return _dump(
- spec.access.list_member_bindings(tenant_id, account_id, resource_id(path_params), str(policy_id))
- )
-
- @login_required
- @console_ns.expect(console_ns.models[_DeleteMemberBindingsRequest.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.MemberBindingsResponse.__name__])
- def delete(self, policy_id, **path_params):
- tenant_id, account_id = _current_ids()
- body = _payload(_DeleteMemberBindingsRequest)
- spec.access.delete_member_bindings(
- tenant_id,
- account_id,
- resource_id(path_params),
- str(policy_id),
- svc.DeleteMemberBindings(account_ids=body.account_ids),
- )
- return {"result": "success"}
-
- class WorkspaceMatrixApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.WorkspaceAccessMatrix.__name__])
- def get(self):
- tenant_id, account_id = _current_ids()
- result = spec.workspace_matrix(tenant_id, account_id, _pagination_options())
- _hydrate_access_matrix_account_names(result.items)
- return _dump(result)
-
- class WorkspaceRoleBindingsApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.RoleBindingsResponse.__name__])
- def get(self, policy_id):
- tenant_id, account_id = _current_ids()
- return _dump(spec.workspace_role_bindings(tenant_id, account_id, str(policy_id)))
-
- class WorkspaceBindingsApi(Resource):
- @login_required
- @console_ns.expect(console_ns.models[_ReplaceBindingsRequest.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.AccessMatrixItem.__name__])
- def put(self, policy_id):
- tenant_id, account_id = _current_ids()
- body = _payload(_ReplaceBindingsRequest)
- return _dump(
- spec.replace_workspace_bindings(
- tenant_id,
- account_id,
- str(policy_id),
- svc.ReplaceBindings(role_ids=list(body.role_ids), account_ids=list(body.account_ids)),
- )
- )
-
- class WorkspaceMemberBindingsApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.MemberBindingsResponse.__name__])
- def get(self, policy_id):
- tenant_id, account_id = _current_ids()
- return _dump(spec.workspace_member_bindings(tenant_id, account_id, str(policy_id)))
-
- prefix = spec.class_prefix
- return _ResourceAccessApis(
- catalog=register(
- CatalogApi,
- f"RBAC{prefix}CatalogApi",
- f"/workspaces/current/rbac/role-permissions/catalog/{spec.resource_type.value}",
- ),
- matrix=register(MatrixApi, f"RBAC{prefix}MatrixApi", f"{resource_prefix}/access-policy"),
- whitelist=register(WhitelistApi, f"RBAC{prefix}WhitelistApi", f"{resource_prefix}/whitelist"),
- whitelist_config=register(
- WhitelistConfigApi, f"RBAC{prefix}WhitelistConfigApi", f"{resource_prefix}/whitelist_config"
- ),
- user_access_policies=register(
- UserAccessPoliciesApi, f"RBAC{prefix}UserAccessPoliciesApi", f"{resource_prefix}/user-access-policies"
- ),
- user_access_policy_assignment=register(
- UserAccessPolicyAssignmentApi,
- f"RBAC{prefix}UserAccessPolicyAssignmentApi",
- f"{resource_prefix}/users/<uuid:target_account_id>/access-policies",
- ),
- role_bindings=register(
- RoleBindingsApi,
- f"RBAC{prefix}RoleBindingsApi",
- f"{resource_prefix}/access-policies/<uuid:policy_id>/role-bindings",
- ),
- member_bindings=register(
- MemberBindingsApi,
- f"RBAC{prefix}MemberBindingsApi",
- f"{resource_prefix}/access-policies/<string:policy_id>/member-bindings",
- ),
- workspace_matrix=register(
- WorkspaceMatrixApi, f"RBACWorkspace{prefix}MatrixApi", f"{workspace_prefix}/access-policy"
- ),
- workspace_role_bindings=register(
- WorkspaceRoleBindingsApi,
- f"RBACWorkspace{prefix}RoleBindingsApi",
- f"{workspace_prefix}/access-policies/<uuid:policy_id>/role-bindings",
- ),
- workspace_bindings=register(
- WorkspaceBindingsApi,
- f"RBACWorkspace{prefix}BindingsApi",
- f"{workspace_prefix}/access-policies/<uuid:policy_id>/bindings",
- ),
- workspace_member_bindings=register(
- WorkspaceMemberBindingsApi,
- f"RBACWorkspace{prefix}MemberBindingsApi",
- f"{workspace_prefix}/access-policies/<uuid:policy_id>/member-bindings",
- ),
- )
-
-
-_RESOURCE_ACCESS_APIS = {spec.resource_type: _build_resource_access_apis(spec) for spec in _RESOURCE_ACCESS_ROUTES}
-
-
-# ---------------------------------------------------------------------------
-# Member ↔ role bindings (Settings > Members > Assign roles).
-# ---------------------------------------------------------------------------
-
-
-class _ReplaceMemberRolesRequest(BaseModel):
- role_ids: list[str] = []
-
- @field_validator("role_ids", mode="before")
- @classmethod
- def _coerce_role_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-register_schema_models(console_ns, _ReplaceMemberRolesRequest)
-
-
-@console_ns.route("/workspaces/current/rbac/members/<uuid:member_id>/rbac-roles")
-class RBACMemberRolesApi(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[svc.MemberRolesResponse.__name__])
- def get(self, member_id):
- tenant_id, account_id = _current_ids()
- return _dump(svc.RBACService.MemberRoles.get(tenant_id, account_id, str(member_id), session=db.session()))
-
- @login_required
- @console_ns.expect(console_ns.models[_ReplaceMemberRolesRequest.__name__])
- @console_ns.response(200, "Success", console_ns.models[svc.MemberRolesResponse.__name__])
- def put(self, member_id):
- tenant_id, account_id = _current_ids()
- request = _payload(_ReplaceMemberRolesRequest)
- return _dump(
- svc.RBACService.MemberRoles.replace(
- tenant_id,
- account_id,
- str(member_id),
- role_ids=list(request.role_ids),
- session=db.session(),
- )
- )
-
-
-@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>/members")
-class ListMembersByRole(Resource):
- @login_required
- @console_ns.response(200, "Success", console_ns.models[_MembersInRoleList.__name__])
- def get(self, role_id):
- tenant_id, account_id = _current_ids()
- return _dump(
- svc.RBACService.Roles.list_members_by_role(tenant_id, role_id=role_id, options=_pagination_options())
- )
diff --git a/api/controllers/console/workspace/rbac/__init__.py b/api/controllers/console/workspace/rbac/__init__.py
new file mode 100644
index 00000000000..ae5f6fea0aa
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/__init__.py
@@ -0,0 +1,5 @@
+"""Register workspace RBAC endpoints by use case."""
+
+from controllers.console.workspace.rbac import members, policies, resources, roles
+
+__all__ = ["members", "policies", "resources", "roles"]
diff --git a/api/controllers/console/workspace/rbac/members.py b/api/controllers/console/workspace/rbac/members.py
new file mode 100644
index 00000000000..223070778e6
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/members.py
@@ -0,0 +1,76 @@
+"""Console RBAC members endpoints."""
+
+from flask import request
+from flask_restx import Resource
+from werkzeug.exceptions import Forbidden
+
+from controllers.common.errors import InvalidArgumentError
+from controllers.common.rbac import rbac_language
+from controllers.console import console_ns
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.workspace.rbac.schemas import (
+ _ReplaceMemberRolesRequest,
+)
+from extensions.ext_application_services import application_services
+from libs.helper import dump_response
+from machinery.context import RequestContext
+from services.account_errors import AccountNotFoundError
+from services.errors.base import NoPermissionError
+from services.errors.workspace import (
+ CannotOperateSelfError,
+ InvalidWorkspaceMemberRoleError,
+ MemberNotInTenantError,
+ RoleAlreadyAssignedError,
+)
+from services.rbac import contracts as dto
+
+
+@console_ns.route("/workspaces/current/rbac/my-permissions")
+class RBACMyPermissionsApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.MyPermissionsResponse.__name__])
+ def get(self, context: RequestContext):
+ return dump_response(
+ dto.MyPermissionsResponse,
+ application_services().rbac.members.permissions(
+ context.active_workspace_id,
+ context.account_id,
+ app_id=request.args.get("app_id") or None,
+ dataset_id=request.args.get("dataset_id") or None,
+ agent_id=request.args.get("agent_id") or None,
+ language=rbac_language(),
+ ),
+ )
+
+
+@console_ns.route("/workspaces/current/rbac/members/<uuid:member_id>/rbac-roles")
+class RBACMemberRolesApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.MemberRolesResponse.__name__])
+ def get(self, context: RequestContext, member_id):
+ return dump_response(
+ dto.MemberRolesResponse,
+ application_services().rbac.members.get(context, str(member_id), language=rbac_language()),
+ )
+
+ @console_account_admission()
+ @console_ns.expect(console_ns.models[_ReplaceMemberRolesRequest.__name__])
+ @console_ns.response(200, "Success", console_ns.models[dto.MemberRolesResponse.__name__])
+ def put(self, context: RequestContext, member_id):
+ request = _ReplaceMemberRolesRequest.model_validate(console_ns.payload or {})
+ try:
+ result = application_services().rbac.members.replace(
+ context, str(member_id), role_ids=list(request.role_ids), language=rbac_language()
+ )
+ except NoPermissionError as error:
+ raise Forbidden(str(error)) from error
+ except AccountNotFoundError as error:
+ raise InvalidArgumentError(description="Member not in tenant.") from error
+ except (
+ CannotOperateSelfError,
+ InvalidWorkspaceMemberRoleError,
+ MemberNotInTenantError,
+ RoleAlreadyAssignedError,
+ ) as error:
+ raise InvalidArgumentError(description=str(error)) from error
+ return dump_response(dto.MemberRolesResponse, result)
diff --git a/api/controllers/console/workspace/rbac/policies.py b/api/controllers/console/workspace/rbac/policies.py
new file mode 100644
index 00000000000..4d393f872c0
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/policies.py
@@ -0,0 +1,114 @@
+"""Console RBAC policies endpoints."""
+
+from flask import request
+from flask_restx import Resource
+
+from controllers.common.fields import SimpleResultResponse
+from controllers.common.rbac import RBACCheck, Workspace, rbac_language
+from controllers.console import console_ns
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.workspace.rbac.schemas import (
+ _AccessPolicyCreateRequest,
+ _AccessPolicyList,
+ _AccessPolicyUpdateRequest,
+ pagination_options,
+)
+from controllers.console.wraps import RBACPermission
+from extensions.ext_application_services import application_services
+from libs.helper import dump_response
+from machinery.context import RequestContext
+from services.rbac import contracts as dto
+
+
+@console_ns.route("/workspaces/current/rbac/access-policies")
+class RBACAccessPoliciesApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[_AccessPolicyList.__name__])
+ def get(self, context: RequestContext):
+ resource_type = request.args.get("resource_type") or None
+ return dump_response(
+ _AccessPolicyList,
+ application_services().rbac.policies.list(
+ context, resource_type=resource_type, options=pagination_options(), language=rbac_language()
+ ),
+ )
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.expect(console_ns.models[_AccessPolicyCreateRequest.__name__])
+ @console_ns.response(201, "Policy created", console_ns.models[dto.AccessPolicy.__name__])
+ def post(self, context: RequestContext):
+ request = _AccessPolicyCreateRequest.model_validate(console_ns.payload or {})
+ policy = application_services().rbac.policies.create(
+ context,
+ dto.AccessPolicyCreate(
+ name=request.name,
+ resource_type=request.resource_type,
+ description=request.description,
+ permission_keys=list(request.permission_keys),
+ ),
+ language=rbac_language(),
+ )
+ return (dump_response(dto.AccessPolicy, policy), 201)
+
+
+@console_ns.route("/workspaces/current/rbac/access-policies/<uuid:policy_id>")
+class RBACAccessPolicyItemApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[dto.AccessPolicy.__name__])
+ def get(self, context: RequestContext, policy_id):
+ return dump_response(
+ dto.AccessPolicy,
+ application_services().rbac.policies.get(context, str(policy_id), language=rbac_language()),
+ )
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.expect(console_ns.models[_AccessPolicyUpdateRequest.__name__])
+ @console_ns.response(200, "Success", console_ns.models[dto.AccessPolicy.__name__])
+ def put(self, context: RequestContext, policy_id):
+ request = _AccessPolicyUpdateRequest.model_validate(console_ns.payload or {})
+ policy = application_services().rbac.policies.update(
+ context,
+ str(policy_id),
+ dto.AccessPolicyUpdate(
+ name=request.name, description=request.description, permission_keys=list(request.permission_keys)
+ ),
+ language=rbac_language(),
+ )
+ return dump_response(dto.AccessPolicy, policy)
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
+ def delete(self, context: RequestContext, policy_id):
+ application_services().rbac.policies.delete(context, str(policy_id), language=rbac_language())
+ return dump_response(SimpleResultResponse, {"result": "success"})
+
+
+@console_ns.route("/workspaces/current/rbac/access-policies/<uuid:policy_id>/copy")
+class RBACAccessPolicyCopyApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(201, "Policy copied", console_ns.models[dto.AccessPolicy.__name__])
+ def post(self, context: RequestContext, policy_id):
+ policy = application_services().rbac.policies.copy(context, str(policy_id), language=rbac_language())
+ return (dump_response(dto.AccessPolicy, policy), 201)
+
+
+@console_ns.route("/workspaces/current/rbac/access-policy-bindings/<uuid:binding_id>/lock")
+class RBACAccessPolicyBindingLockApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[dto.AccessPolicyBindingState.__name__])
+ def put(self, context: RequestContext, binding_id):
+ return dump_response(
+ dto.AccessPolicyBindingState,
+ application_services().rbac.policies.lock(context, str(binding_id), language=rbac_language()),
+ )
+
+
+@console_ns.route("/workspaces/current/rbac/access-policy-bindings/<uuid:binding_id>/unlock")
+class RBACAccessPolicyBindingUnlockApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[dto.AccessPolicyBindingState.__name__])
+ def put(self, context: RequestContext, binding_id):
+ return dump_response(
+ dto.AccessPolicyBindingState,
+ application_services().rbac.policies.unlock(context, str(binding_id), language=rbac_language()),
+ )
diff --git a/api/controllers/console/workspace/rbac/resources.py b/api/controllers/console/workspace/rbac/resources.py
new file mode 100644
index 00000000000..963d58261e1
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/resources.py
@@ -0,0 +1,304 @@
+"""Console RBAC resources endpoints."""
+
+from collections.abc import Mapping
+from dataclasses import dataclass
+
+from flask_restx import Resource
+from pydantic import BaseModel
+
+from controllers.common.fields import SimpleResultResponse
+from controllers.common.rbac import rbac_language
+from controllers.common.schema import query_params_from_model
+from controllers.console import console_ns
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.workspace.rbac.schemas import (
+ _AccessControlLanguageQuery,
+ _DeleteMemberBindingsRequest,
+ _ReplaceBindingsRequest,
+ _ResourceAccessScopeRequest,
+ _ResourceUserAccessPoliciesQuery,
+ pagination_options,
+)
+from extensions.ext_application_services import application_services
+from libs.helper import dump_response
+from machinery.context import RequestContext
+from services.rbac import contracts as dto
+
+
+@dataclass(frozen=True)
+class _ResourceAccessRoutes:
+ resource_type: dto.RBACResourceType
+ class_prefix: str
+ matrix_model: type[BaseModel]
+
+ @property
+ def url_segment(self) -> str:
+ return self.resource_type.route.segment
+
+ @property
+ def id_param(self) -> str:
+ return self.resource_type.route.id_param
+
+
+@dataclass(frozen=True)
+class _ResourceAccessApis:
+ catalog: type[Resource]
+ matrix: type[Resource]
+ whitelist: type[Resource]
+ whitelist_config: type[Resource]
+ user_access_policies: type[Resource]
+ user_access_policy_assignment: type[Resource]
+ role_bindings: type[Resource]
+ member_bindings: type[Resource]
+ workspace_matrix: type[Resource]
+ workspace_role_bindings: type[Resource]
+ workspace_bindings: type[Resource]
+ workspace_member_bindings: type[Resource]
+
+
+_RESOURCE_ACCESS_ROUTES = (
+ _ResourceAccessRoutes(dto.RBACResourceType.APP, "App", dto.AppAccessMatrix),
+ _ResourceAccessRoutes(dto.RBACResourceType.DATASET, "Dataset", dto.DatasetAccessMatrix),
+ _ResourceAccessRoutes(dto.RBACResourceType.AGENT, "Agent", dto.AgentAccessMatrix),
+)
+
+
+def _build_resource_access_apis(spec: _ResourceAccessRoutes) -> _ResourceAccessApis:
+ id_param = spec.id_param
+ resource_prefix = f"/workspaces/current/rbac/{spec.url_segment}/<uuid:{id_param}>"
+ workspace_prefix = f"/workspaces/current/rbac/workspace/{spec.url_segment}"
+
+ def resource_id(path_params: Mapping[str, object]) -> str:
+ return str(path_params[id_param])
+
+ def register(resource: type[Resource], name: str, url: str) -> type[Resource]:
+ resource.__name__ = name
+ resource.__qualname__ = name
+ console_ns.route(url)(resource)
+ return resource
+
+ class CatalogApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.PermissionCatalogResponse.__name__])
+ def get(self, context: RequestContext):
+ return dump_response(
+ dto.PermissionCatalogResponse,
+ application_services().rbac.resources.catalog(context, spec.resource_type, language=rbac_language()),
+ )
+
+ class MatrixApi(Resource):
+ @console_account_admission()
+ @console_ns.doc(params=query_params_from_model(_AccessControlLanguageQuery))
+ @console_ns.response(200, "Success", console_ns.models[spec.matrix_model.__name__])
+ def get(self, context: RequestContext, **path_params):
+ result = application_services().rbac.resources.matrix(
+ context, spec.resource_type, resource_id(path_params), language=rbac_language()
+ )
+ return dump_response(spec.matrix_model, result)
+
+ class WhitelistApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.ResourceWhitelist.__name__])
+ def get(self, context: RequestContext, **path_params):
+ return dump_response(
+ dto.ResourceWhitelist,
+ application_services().rbac.resources.whitelist(
+ context, spec.resource_type, resource_id(path_params), language=rbac_language()
+ ),
+ )
+
+ @console_account_admission()
+ @console_ns.expect(console_ns.models[_ResourceAccessScopeRequest.__name__])
+ @console_ns.response(200, "Success", console_ns.models[dto.ResourceWhitelist.__name__])
+ def put(self, context: RequestContext, **path_params):
+ target_id = resource_id(path_params)
+ scope = _ResourceAccessScopeRequest.model_validate(console_ns.payload or {})
+ result = application_services().rbac.resources.replace_whitelist(
+ context,
+ spec.resource_type,
+ target_id,
+ dto.ReplaceMemberBindings(
+ automatic_include_workspace_members=scope.automatic_include_workspace_members
+ ),
+ language=rbac_language(),
+ )
+ return dump_response(dto.ResourceWhitelist, result)
+
+ class WhitelistConfigApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.ResourceWhitelistConfig.__name__])
+ def get(self, context: RequestContext, **path_params):
+ return dump_response(
+ dto.ResourceWhitelistConfig,
+ application_services().rbac.resources.whitelist_config(
+ context, spec.resource_type, resource_id(path_params), language=rbac_language()
+ ),
+ )
+
+ class UserAccessPoliciesApi(Resource):
+ @console_account_admission()
+ @console_ns.doc(params=query_params_from_model(_ResourceUserAccessPoliciesQuery))
+ @console_ns.response(200, "Success", console_ns.models[dto.ResourceUserAccessPoliciesResponse.__name__])
+ def get(self, context: RequestContext, **path_params):
+ target_id = resource_id(path_params)
+ options = pagination_options()
+ result = application_services().rbac.resources.user_access_policies(
+ context, spec.resource_type, target_id, options=options, language=rbac_language()
+ )
+ return dump_response(dto.ResourceUserAccessPoliciesResponse, result)
+
+ class UserAccessPolicyAssignmentApi(Resource):
+ @console_account_admission()
+ @console_ns.expect(console_ns.models[dto.ReplaceUserAccessPolicies.__name__])
+ @console_ns.response(200, "Success", console_ns.models[dto.ReplaceUserAccessPoliciesResponse.__name__])
+ def put(self, context: RequestContext, target_account_id, **path_params):
+ payload = dto.ReplaceUserAccessPolicies.model_validate(console_ns.payload or {})
+ return dump_response(
+ dto.ReplaceUserAccessPoliciesResponse,
+ application_services().rbac.resources.replace_user_access_policies(
+ context,
+ spec.resource_type,
+ resource_id(path_params),
+ str(target_account_id),
+ payload,
+ language=rbac_language(),
+ ),
+ )
+
+ class RoleBindingsApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.RoleBindingsResponse.__name__])
+ def get(self, context: RequestContext, policy_id, **path_params):
+ return dump_response(
+ dto.RoleBindingsResponse,
+ application_services().rbac.resources.list_role_bindings(
+ context, spec.resource_type, resource_id(path_params), str(policy_id), language=rbac_language()
+ ),
+ )
+
+ class MemberBindingsApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.MemberBindingsResponse.__name__])
+ def get(self, context: RequestContext, policy_id, **path_params):
+ return dump_response(
+ dto.MemberBindingsResponse,
+ application_services().rbac.resources.list_member_bindings(
+ context, spec.resource_type, resource_id(path_params), str(policy_id), language=rbac_language()
+ ),
+ )
+
+ @console_account_admission()
+ @console_ns.expect(console_ns.models[_DeleteMemberBindingsRequest.__name__])
+ @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
+ def delete(self, context: RequestContext, policy_id, **path_params):
+ body = _DeleteMemberBindingsRequest.model_validate(console_ns.payload or {})
+ application_services().rbac.resources.delete_member_bindings(
+ context,
+ spec.resource_type,
+ resource_id(path_params),
+ str(policy_id),
+ dto.DeleteMemberBindings(account_ids=body.account_ids),
+ language=rbac_language(),
+ )
+ return dump_response(SimpleResultResponse, {"result": "success"})
+
+ class WorkspaceMatrixApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.WorkspaceAccessMatrix.__name__])
+ def get(self, context: RequestContext):
+ result = application_services().rbac.resources.workspace_matrix(
+ context, spec.resource_type, pagination_options(), language=rbac_language()
+ )
+ return dump_response(dto.WorkspaceAccessMatrix, result)
+
+ class WorkspaceRoleBindingsApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.RoleBindingsResponse.__name__])
+ def get(self, context: RequestContext, policy_id):
+ return dump_response(
+ dto.RoleBindingsResponse,
+ application_services().rbac.resources.workspace_role_bindings(
+ context, spec.resource_type, str(policy_id), language=rbac_language()
+ ),
+ )
+
+ class WorkspaceBindingsApi(Resource):
+ @console_account_admission()
+ @console_ns.expect(console_ns.models[_ReplaceBindingsRequest.__name__])
+ @console_ns.response(200, "Success", console_ns.models[dto.AccessMatrixItem.__name__])
+ def put(self, context: RequestContext, policy_id):
+ body = _ReplaceBindingsRequest.model_validate(console_ns.payload or {})
+ return dump_response(
+ dto.AccessMatrixItem,
+ application_services().rbac.resources.replace_workspace_bindings(
+ context,
+ spec.resource_type,
+ str(policy_id),
+ dto.ReplaceBindings(role_ids=list(body.role_ids), account_ids=list(body.account_ids)),
+ language=rbac_language(),
+ ),
+ )
+
+ class WorkspaceMemberBindingsApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.MemberBindingsResponse.__name__])
+ def get(self, context: RequestContext, policy_id):
+ return dump_response(
+ dto.MemberBindingsResponse,
+ application_services().rbac.resources.workspace_member_bindings(
+ context, spec.resource_type, str(policy_id), language=rbac_language()
+ ),
+ )
+
+ prefix = spec.class_prefix
+ return _ResourceAccessApis(
+ catalog=register(
+ CatalogApi,
+ f"RBAC{prefix}CatalogApi",
+ f"/workspaces/current/rbac/role-permissions/catalog/{spec.resource_type.value}",
+ ),
+ matrix=register(MatrixApi, f"RBAC{prefix}MatrixApi", f"{resource_prefix}/access-policy"),
+ whitelist=register(WhitelistApi, f"RBAC{prefix}WhitelistApi", f"{resource_prefix}/whitelist"),
+ whitelist_config=register(
+ WhitelistConfigApi, f"RBAC{prefix}WhitelistConfigApi", f"{resource_prefix}/whitelist_config"
+ ),
+ user_access_policies=register(
+ UserAccessPoliciesApi, f"RBAC{prefix}UserAccessPoliciesApi", f"{resource_prefix}/user-access-policies"
+ ),
+ user_access_policy_assignment=register(
+ UserAccessPolicyAssignmentApi,
+ f"RBAC{prefix}UserAccessPolicyAssignmentApi",
+ f"{resource_prefix}/users/<uuid:target_account_id>/access-policies",
+ ),
+ role_bindings=register(
+ RoleBindingsApi,
+ f"RBAC{prefix}RoleBindingsApi",
+ f"{resource_prefix}/access-policies/<uuid:policy_id>/role-bindings",
+ ),
+ member_bindings=register(
+ MemberBindingsApi,
+ f"RBAC{prefix}MemberBindingsApi",
+ f"{resource_prefix}/access-policies/<string:policy_id>/member-bindings",
+ ),
+ workspace_matrix=register(
+ WorkspaceMatrixApi, f"RBACWorkspace{prefix}MatrixApi", f"{workspace_prefix}/access-policy"
+ ),
+ workspace_role_bindings=register(
+ WorkspaceRoleBindingsApi,
+ f"RBACWorkspace{prefix}RoleBindingsApi",
+ f"{workspace_prefix}/access-policies/<uuid:policy_id>/role-bindings",
+ ),
+ workspace_bindings=register(
+ WorkspaceBindingsApi,
+ f"RBACWorkspace{prefix}BindingsApi",
+ f"{workspace_prefix}/access-policies/<uuid:policy_id>/bindings",
+ ),
+ workspace_member_bindings=register(
+ WorkspaceMemberBindingsApi,
+ f"RBACWorkspace{prefix}MemberBindingsApi",
+ f"{workspace_prefix}/access-policies/<uuid:policy_id>/member-bindings",
+ ),
+ )
+
+
+_RESOURCE_ACCESS_APIS = {spec.resource_type: _build_resource_access_apis(spec) for spec in _RESOURCE_ACCESS_ROUTES}
diff --git a/api/controllers/console/workspace/rbac/roles.py b/api/controllers/console/workspace/rbac/roles.py
new file mode 100644
index 00000000000..955d06836c7
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/roles.py
@@ -0,0 +1,101 @@
+"""Console RBAC roles endpoints."""
+
+from flask import request
+from flask_restx import Resource
+
+from controllers.common.fields import SimpleResultResponse
+from controllers.common.rbac import RBACCheck, Workspace, rbac_language
+from controllers.console import console_ns
+from controllers.console.flask_admission import console_account_admission
+from controllers.console.workspace.rbac.schemas import (
+ CopyRoleParam,
+ _MembersInRoleList,
+ _RBACRoleList,
+ _RolesListQuery,
+ _RoleUpsertRequest,
+ pagination_options,
+)
+from controllers.console.wraps import RBACPermission
+from extensions.ext_application_services import application_services
+from libs.helper import dump_response
+from machinery.context import RequestContext
+from services.rbac import contracts as dto
+
+
+@console_ns.route("/workspaces/current/rbac/role-permissions/catalog")
+class RBACWorkspaceCatalogApi(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[dto.PermissionCatalogResponse.__name__])
+ def get(self, context: RequestContext):
+ return dump_response(
+ dto.PermissionCatalogResponse, application_services().rbac.roles.catalog(context, language=rbac_language())
+ )
+
+
+@console_ns.route("/workspaces/current/rbac/roles")
+class RBACRolesApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[_RBACRoleList.__name__])
+ def get(self, context: RequestContext):
+ req_data = _RolesListQuery.model_validate(request.args.to_dict(flat=True))
+ result = application_services().rbac.roles.list(
+ context, options=req_data.to_inner_options(), include_owner=req_data.include_owner, language=rbac_language()
+ )
+ return dump_response(_RBACRoleList, result)
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(201, "Role created", console_ns.models[dto.RBACRole.__name__])
+ def post(self, context: RequestContext):
+ request = _RoleUpsertRequest.model_validate(console_ns.payload or {})
+ role = application_services().rbac.roles.create(context, request.to_mutation(), language=rbac_language())
+ return (dump_response(dto.RBACRole, role), 201)
+
+
+@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>")
+class RBACRoleItemApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[dto.RBACRole.__name__])
+ def get(self, context: RequestContext, role_id):
+ return dump_response(
+ dto.RBACRole, application_services().rbac.roles.get(context, str(role_id), language=rbac_language())
+ )
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[dto.RBACRole.__name__])
+ def put(self, context: RequestContext, role_id):
+ request = _RoleUpsertRequest.model_validate(console_ns.payload or {})
+ role = application_services().rbac.roles.update(
+ context, str(role_id), request.to_mutation(), language=rbac_language()
+ )
+ return dump_response(dto.RBACRole, role)
+
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(200, "Success", console_ns.models[SimpleResultResponse.__name__])
+ def delete(self, context: RequestContext, role_id):
+ application_services().rbac.roles.delete(context, str(role_id), language=rbac_language())
+ return dump_response(SimpleResultResponse, {"result": "success"})
+
+
+@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>/copy")
+class RBACRoleCopyApi(Resource):
+ @console_account_admission(rbac_checks=[RBACCheck(RBACPermission.WORKSPACE_ROLE_MANAGE, Workspace())])
+ @console_ns.response(201, "Role copied", console_ns.models[dto.RBACRole.__name__])
+ def post(self, context: RequestContext, role_id):
+ request = CopyRoleParam.model_validate(console_ns.payload or {})
+ role = application_services().rbac.roles.copy(
+ context, str(role_id), copy_member=request.copy_member, language=rbac_language()
+ )
+ return (dump_response(dto.RBACRole, role), 201)
+
+
+@console_ns.route("/workspaces/current/rbac/roles/<uuid:role_id>/members")
+class ListMembersByRole(Resource):
+ @console_account_admission()
+ @console_ns.response(200, "Success", console_ns.models[_MembersInRoleList.__name__])
+ def get(self, context: RequestContext, role_id):
+ return dump_response(
+ _MembersInRoleList,
+ application_services().rbac.roles.list_members_by_role(
+ context, role_id=str(role_id), options=pagination_options(), language=rbac_language()
+ ),
+ )
diff --git a/api/controllers/console/workspace/rbac/schemas.py b/api/controllers/console/workspace/rbac/schemas.py
new file mode 100644
index 00000000000..d276aaaacf1
--- /dev/null
+++ b/api/controllers/console/workspace/rbac/schemas.py
@@ -0,0 +1,163 @@
+"""HTTP payloads, pagination aliases and response schemas for workspace RBAC."""
+
+from typing import Any, Literal
+
+from flask import request
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, field_validator
+
+from controllers.common.schema import register_response_schema_models, register_schema_models
+from controllers.console import console_ns
+from services.rbac import contracts as dto
+
+
+class _RBACRoleList(dto.Paginated[dto.RBACRole]):
+ pass
+
+
+class _AccessPolicyList(dto.Paginated[dto.AccessPolicy]):
+ pass
+
+
+class _MembersInRoleList(dto.Paginated[dto.MembersInRole]):
+ pass
+
+
+register_response_schema_models(
+ console_ns,
+ dto.PermissionCatalogResponse,
+ dto.RBACRole,
+ _RBACRoleList,
+ _MembersInRoleList,
+ dto.AccessPolicy,
+ _AccessPolicyList,
+ dto.AccessPolicyBindingState,
+ dto.MyPermissionsResponse,
+ dto.AppAccessMatrix,
+ dto.DatasetAccessMatrix,
+ dto.AgentAccessMatrix,
+ dto.WorkspaceAccessMatrix,
+ dto.ResourceWhitelist,
+ dto.ResourceWhitelistConfig,
+ dto.ResourceUserAccessPoliciesResponse,
+ dto.ReplaceUserAccessPoliciesResponse,
+ dto.RoleBindingsResponse,
+ dto.MemberBindingsResponse,
+ dto.MemberRolesResponse,
+ dto.AccessMatrixItem,
+)
+
+
+class _PaginationQuery(BaseModel):
+ model_config = ConfigDict(extra="ignore")
+
+ page_number: int | None = Field(default=None, ge=1, validation_alias=AliasChoices("page", "page_number"))
+ results_per_page: int | None = Field(
+ default=None, ge=1, le=99999, validation_alias=AliasChoices("limit", "results_per_page")
+ )
+ reverse: bool | None = None
+
+ def to_inner_options(self) -> dto.ListOption:
+ return dto.ListOption.model_validate(self.model_dump())
+
+
+class _RolesListQuery(_PaginationQuery):
+ include_owner: int = Field(default=0, ge=0, le=1)
+
+
+class CopyRoleParam(BaseModel):
+ copy_member: bool = True
+
+
+class _RoleUpsertRequest(BaseModel):
+ """Accepts the payload sent by the Create/Edit Role dialog."""
+
+ name: str
+ description: str = ""
+ permission_keys: list[str] = []
+
+ def to_mutation(self) -> dto.RoleMutation:
+ return dto.RoleMutation(
+ name=self.name,
+ description=self.description,
+ permission_keys=list(self.permission_keys),
+ )
+
+
+class _AccessPolicyCreateRequest(BaseModel):
+ name: str
+ resource_type: dto.RBACResourceType
+ description: str = ""
+ permission_keys: list[str] = []
+
+
+class _AccessPolicyUpdateRequest(BaseModel):
+ name: str
+ description: str = ""
+ permission_keys: list[str] = []
+
+
+register_schema_models(console_ns, _AccessPolicyCreateRequest, _AccessPolicyUpdateRequest)
+
+
+class _ResourceAccessScopeRequest(BaseModel):
+ automatic_include_workspace_members: bool
+
+
+class _ReplaceBindingsRequest(BaseModel):
+ role_ids: list[str] = Field(default_factory=list)
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("role_ids", "account_ids", mode="before")
+ @classmethod
+ def _coerce_bindings(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class _DeleteMemberBindingsRequest(BaseModel):
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("account_ids", mode="before")
+ @classmethod
+ def _coerce_account_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class _AccessControlLanguageQuery(BaseModel):
+ language: Literal["en", "ja", "zh"] | None = Field(default=None, description="Localized policy label language")
+
+
+class _ResourceUserAccessPoliciesQuery(_PaginationQuery):
+ language: Literal["en", "ja", "zh"] | None = Field(default=None, description="Localized policy label language")
+
+
+register_schema_models(
+ console_ns,
+ _ResourceAccessScopeRequest,
+ _ReplaceBindingsRequest,
+ _DeleteMemberBindingsRequest,
+ _AccessControlLanguageQuery,
+ _ResourceUserAccessPoliciesQuery,
+ dto.ReplaceUserAccessPolicies,
+)
+
+
+class _ReplaceMemberRolesRequest(BaseModel):
+ role_ids: list[str] = []
+
+ @field_validator("role_ids", mode="before")
+ @classmethod
+ def _coerce_role_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+register_schema_models(console_ns, _ReplaceMemberRolesRequest)
+
+
+def pagination_options() -> dto.ListOption:
+ return _PaginationQuery.model_validate(request.args.to_dict(flat=True)).to_inner_options()
diff --git a/api/controllers/openapi/apps.py b/api/controllers/openapi/apps.py
index 0b264cc5dbc..e395ffe8ee8 100644
--- a/api/controllers/openapi/apps.py
+++ b/api/controllers/openapi/apps.py
@@ -165,7 +165,7 @@ class AppListApi(Resource):
parsed_uuid = None
access_filter = (
- resolve_app_access_filter(workspace_id, account_id, session=ctx.session)
+ resolve_app_access_filter(workspace_id, account_id)
if dify_config.RBAC_ENABLED and isinstance(ctx.subject, AccountSubject)
else AppAccessFilter.unrestricted()
)
diff --git a/api/controllers/service_api/dataset/dataset.py b/api/controllers/service_api/dataset/dataset.py
index 79cbdae4e49..b721afaafc0 100644
--- a/api/controllers/service_api/dataset/dataset.py
+++ b/api/controllers/service_api/dataset/dataset.py
@@ -56,6 +56,7 @@ from services.knowledge.entities.knowledge_entities import (
RetrievalModel,
SummaryIndexSetting,
)
+from services.rbac import contracts as rbac_contracts
from services.tag_service import (
SaveTagPayload,
TagBindingCreatePayload,
@@ -560,7 +561,7 @@ class DatasetListApi(DatasetApiResource):
tenant_id,
current_user.id,
dataset.id,
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=False),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=False),
)
return _dump_service_dataset_detail(load_dataset_detail(dataset, session=session)), 200
diff --git a/api/extensions/application_services/app.py b/api/extensions/application_services/app.py
index 0ac0bc7edef..cc63859dadf 100644
--- a/api/extensions/application_services/app.py
+++ b/api/extensions/application_services/app.py
@@ -20,6 +20,7 @@ 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
+from services.rbac.members import MemberService
from services.recommended_app_package_service import RecommendedAppPackageService
@@ -35,8 +36,9 @@ def build_app_services(
database_client: sessionmaker[Session],
oauth: OAuthServerService,
recommended_packages: RecommendedAppPackageService,
+ repository: ConsoleAppRepository,
+ rbac_members: MemberService,
) -> AppServices:
- repository = ConsoleAppRepository(session_factory=database_client)
transfers = AppTransferGateway(
session_factory=database_client,
dsl_factory=AppDslService,
@@ -49,7 +51,7 @@ def build_app_services(
imports=AppImportService(accounts=SQLAlchemyAccountRepository(database_client), definitions=transfers),
console=ConsoleAppService(
apps=repository,
- access=EnterpriseConsoleAppAccess(session_factory=database_client),
+ access=EnterpriseConsoleAppAccess(members=rbac_members),
transfers=transfers,
creators=CreatorsPlatformGateway(oauth=oauth),
tracing=OpsTraceManagerGateway(),
diff --git a/api/extensions/application_services/knowledge.py b/api/extensions/application_services/knowledge.py
index 91733434af4..70fbfff8057 100644
--- a/api/extensions/application_services/knowledge.py
+++ b/api/extensions/application_services/knowledge.py
@@ -50,6 +50,7 @@ from services.knowledge.segments.adapters import (
)
from services.knowledge.segments.application import DatasetSegmentApplicationService
from services.knowledge.segments.indexing import SegmentIndexingGateway
+from services.rbac.members import MemberService
from services.tag_application_service import TagTargetQuery
from tasks.batch_create_segment_to_index_task import batch_create_segment_to_index_task
from tasks.delete_segment_from_index_task import delete_segment_from_index_task
@@ -93,6 +94,7 @@ def build_knowledge_services(
redis: RedisSegmentClient,
tags: TagTargetQuery,
app_queries: AppQueryService,
+ rbac_members: MemberService,
) -> KnowledgeServices:
"""Build the dataset-controller knowledge use cases."""
@@ -126,7 +128,9 @@ def build_knowledge_services(
),
datasets=DatasetApplicationService(
dataset_access=dataset_access,
- operations=SQLAlchemyDatasetOperations(session_factory=database_client, tags=tags, app_queries=app_queries),
+ operations=SQLAlchemyDatasetOperations(
+ session_factory=database_client, tags=tags, app_queries=app_queries, members=rbac_members
+ ),
rbac_enabled=dify_config.RBAC_ENABLED,
service_api_url=dify_config.SERVICE_API_URL,
vector_store=dify_config.VECTOR_STORE,
@@ -134,7 +138,7 @@ def build_knowledge_services(
),
external=ExternalKnowledgeApplicationService(
dataset_access=dataset_access,
- operations=SQLAlchemyExternalKnowledgeOperations(session_factory=database_client),
+ operations=SQLAlchemyExternalKnowledgeOperations(session_factory=database_client, members=rbac_members),
),
documents=DatasetDocumentApplicationService(
dataset_access=dataset_access,
diff --git a/api/extensions/application_services/rbac.py b/api/extensions/application_services/rbac.py
new file mode 100644
index 00000000000..1893821b8bf
--- /dev/null
+++ b/api/extensions/application_services/rbac.py
@@ -0,0 +1,71 @@
+"""Compose RBAC use cases with the existing workspace, app and dataset repositories."""
+
+from dataclasses import dataclass
+
+from repositories.app.console_repository import ConsoleAppRepository
+from repositories.knowledge.dataset_repository import SQLAlchemyDatasetRepository
+from repositories.workspace.workspace_repository import WorkspaceRepository
+from services.enterprise import rbac_service as enterprise
+from services.rbac.gateways import (
+ CeleryAccessInitializer,
+ DeploymentRBACSettings,
+ EnterpriseResourceAccessClients,
+)
+from services.rbac.members import MemberService
+from services.rbac.policies import PolicyService
+from services.rbac.resource_queries import ResourceQueryService
+from services.rbac.resources import ResourceAccessService
+from services.rbac.roles import RoleService
+from services.workspace.member_service import WorkspaceMemberService
+
+
+@dataclass(frozen=True, slots=True)
+class RBACServices:
+ roles: RoleService
+ policies: PolicyService
+ members: MemberService
+ resources: ResourceAccessService
+ queries: ResourceQueryService
+
+
+def build_rbac_services(
+ *,
+ workspaces: WorkspaceRepository,
+ workspace_members: WorkspaceMemberService,
+ apps: ConsoleAppRepository,
+ datasets: SQLAlchemyDatasetRepository,
+) -> RBACServices:
+ settings = DeploymentRBACSettings()
+ return RBACServices(
+ queries=ResourceQueryService(apps=apps, datasets=datasets),
+ roles=RoleService(
+ roles=enterprise.RBACService.Roles, catalog=enterprise.RBACService.Catalog, settings=settings
+ ),
+ policies=PolicyService(
+ policies=enterprise.RBACService.AccessPolicies, bindings=enterprise.RBACService.AccessPolicyBindings
+ ),
+ members=MemberService(
+ members=workspaces,
+ workspace_roles=workspace_members,
+ roles=enterprise.RBACService.MemberRoles,
+ permissions=enterprise.RBACService.MyPermissions,
+ apps=enterprise.RBACService.AppPermissions,
+ datasets=enterprise.RBACService.DatasetPermissions,
+ settings=settings,
+ ),
+ resources=ResourceAccessService(
+ clients=EnterpriseResourceAccessClients(
+ apps=enterprise._APP_ACCESS,
+ datasets=enterprise._DATASET_ACCESS,
+ agents=enterprise._AGENT_ACCESS,
+ workspace_apps=enterprise._WORKSPACE_APP_ACCESS,
+ workspace_datasets=enterprise._WORKSPACE_DATASET_ACCESS,
+ workspace_agents=enterprise._WORKSPACE_AGENT_ACCESS,
+ catalogs=enterprise.RBACService.Catalog,
+ ),
+ members=workspaces,
+ apps=apps,
+ datasets=datasets,
+ initializer=CeleryAccessInitializer(),
+ ),
+ )
diff --git a/api/extensions/application_services/workspace.py b/api/extensions/application_services/workspace.py
index 3a9f0b9b894..fb78b00bbb9 100644
--- a/api/extensions/application_services/workspace.py
+++ b/api/extensions/application_services/workspace.py
@@ -2,8 +2,6 @@
from dataclasses import dataclass
-from sqlalchemy.orm import Session, sessionmaker
-
from extensions.ext_redis import RedisClientWrapper
from repositories.account.repository import SQLAlchemyAccountRepository
from repositories.workspace.workspace_repository import WorkspaceRepository
@@ -46,7 +44,6 @@ class WorkspaceServices:
def build_workspace_membership_services(
*,
- database_client: sessionmaker[Session],
workspaces: WorkspaceRepository,
accounts: SQLAlchemyAccountRepository,
) -> tuple[WorkspaceMemberService, WorkspaceProvisioningService]:
@@ -54,12 +51,12 @@ def build_workspace_membership_services(
members = WorkspaceMemberService(
workspaces=workspaces,
accounts=accounts,
- access=DeploymentWorkspaceMemberAccessGateway(session_factory=database_client),
+ access=DeploymentWorkspaceMemberAccessGateway(),
)
provisioning = WorkspaceProvisioningService(
owners=accounts,
provisioning=workspaces,
- effects=WorkspaceProvisioningEffectsGateway(session_factory=database_client),
+ effects=WorkspaceProvisioningEffectsGateway(),
policies=DeploymentWorkspaceCreationPolicy(),
memberships=workspaces,
members=members,
diff --git a/api/extensions/ext_application_services.py b/api/extensions/ext_application_services.py
index 9efd1e762f3..f9f951159d2 100644
--- a/api/extensions/ext_application_services.py
+++ b/api/extensions/ext_application_services.py
@@ -35,6 +35,7 @@ from extensions.application_services.knowledge import (
build_dataset_api_key_service,
build_knowledge_services,
)
+from extensions.application_services.rbac import RBACServices, build_rbac_services
from extensions.application_services.resource_access_token import build_resource_access_token_service
from extensions.application_services.trial_app import TrialAppServices, build_trial_app_services
from extensions.application_services.workspace import (
@@ -51,6 +52,7 @@ from repositories.account.repository import SQLAlchemyAccountRepository
from repositories.account_activation_repository import SQLAlchemyAccountActivationRepository
from repositories.account_integration_repository import SQLAlchemyAccountIntegrationRepository
from repositories.api_based_extension_repository import APIBasedExtensionRepository
+from repositories.app.console_repository import ConsoleAppRepository
from repositories.app.mcp_server_repository import AppMCPServerRepository
from repositories.app.site_command_repository import AppSiteCommandRepository
from repositories.app.tracing_config_repository import SQLAlchemyAppTracingConfigRepository
@@ -242,6 +244,7 @@ class AppScopedEndUserServices:
@dataclass(frozen=True, slots=True)
class ApplicationServices:
+ rbac: RBACServices
agent_apps: AgentAppServices
advanced_prompt_templates: AdvancedPromptTemplateService
api_based_extensions: APIBasedExtensionApplicationService
@@ -409,6 +412,10 @@ def build_application_services(
builtin=builtin_catalog,
)
workspace_repository = WorkspaceRepository(session_factory=database_client)
+ workspace_members, workspace_provisioning = build_workspace_membership_services(
+ workspaces=workspace_repository,
+ accounts=accounts,
+ )
recommended_app_queries = RecommendedAppQueryService(
catalog=recommended_app_catalog,
trial_apps=trial_apps,
@@ -431,10 +438,19 @@ def build_application_services(
providers=datasource_credentials.providers,
)
oauth_server = _build_oauth_server_service(database_client=database_client, redis=redis)
+ console_apps = ConsoleAppRepository(session_factory=database_client)
+ rbac = build_rbac_services(
+ workspaces=workspace_repository,
+ workspace_members=workspace_members,
+ apps=console_apps,
+ datasets=dataset_dependencies.datasets,
+ )
apps = build_app_services(
database_client=database_client,
oauth=oauth_server,
recommended_packages=recommended_app_packages,
+ repository=console_apps,
+ rbac_members=rbac.members,
)
tags = TagApplicationService(tags=TagRepository(session_factory=database_client))
knowledge = build_knowledge_services(
@@ -448,6 +464,7 @@ def build_application_services(
redis=redis,
tags=tags,
app_queries=apps.queries,
+ rbac_members=rbac.members,
)
app_scoped_end_user_repository = AppScopedEndUserRepo(session_factory=database_client)
file_service = FileService(session_factory=database_client)
@@ -468,11 +485,6 @@ def build_application_services(
workflow_node_execution_repository = DifyAPIRepositoryFactory.create_api_workflow_node_execution_repository(
session_maker=database_client
)
- workspace_members, workspace_provisioning = build_workspace_membership_services(
- database_client=database_client,
- workspaces=workspace_repository,
- accounts=accounts,
- )
account_services = build_account_services(
database_client=database_client,
deployment_edition=deployment_edition,
@@ -496,6 +508,7 @@ def build_application_services(
invitation_tokens=invitation_tokens,
)
return ApplicationServices(
+ rbac=rbac,
accounts=account_services,
apps=apps,
credential_queries=CredentialQueryRepository(session_factory=database_client),
diff --git a/api/openapi/markdown/console-openapi.md b/api/openapi/markdown/console-openapi.md
index 178dd5cbb22..50264af47c2 100644
--- a/api/openapi/markdown/console-openapi.md
+++ b/api/openapi/markdown/console-openapi.md
@@ -11309,9 +11309,9 @@ Update a plugin endpoint
### [GET] /workspaces/current/rbac/access-policies
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [_AccessPolicyList](#_accesspolicylist)<br> |
### [POST] /workspaces/current/rbac/access-policies
#### Request Body
@@ -11335,9 +11335,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/rbac/access-policies/{policy_id}
#### Parameters
@@ -11348,9 +11348,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [AccessPolicy](#accesspolicy)<br> |
### [PUT] /workspaces/current/rbac/access-policies/{policy_id}
#### Parameters
@@ -11380,9 +11380,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Policy copied | **application/json**: [AccessPolicy](#accesspolicy)<br> |
### [PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/lock
#### Parameters
@@ -11393,9 +11393,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [AccessPolicyBindingState](#accesspolicybindingstate)<br> |
### [PUT] /workspaces/current/rbac/access-policy-bindings/{binding_id}/unlock
#### Parameters
@@ -11406,9 +11406,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [AccessPolicyBindingState](#accesspolicybindingstate)<br> |
### [DELETE] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
#### Parameters
@@ -11428,7 +11428,7 @@ Update a plugin endpoint
| Code | Description | Schema |
| ---- | ----------- | ------ |
-| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
+| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/rbac/agents/{agent_id}/access-policies/{policy_id}/member-bindings
#### Parameters
@@ -11572,7 +11572,7 @@ Update a plugin endpoint
| Code | Description | Schema |
| ---- | ----------- | ------ |
-| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
+| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/rbac/apps/{app_id}/access-policies/{policy_id}/member-bindings
#### Parameters
@@ -11716,7 +11716,7 @@ Update a plugin endpoint
| Code | Description | Schema |
| ---- | ----------- | ------ |
-| 200 | Success | **application/json**: [MemberBindingsResponse](#memberbindingsresponse)<br> |
+| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/rbac/datasets/{dataset_id}/access-policies/{policy_id}/member-bindings
#### Parameters
@@ -11912,16 +11912,16 @@ Update a plugin endpoint
### [GET] /workspaces/current/rbac/roles
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [_RBACRoleList](#_rbacrolelist)<br> |
### [POST] /workspaces/current/rbac/roles
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Role created | **application/json**: [RBACRole](#rbacrole)<br> |
### [DELETE] /workspaces/current/rbac/roles/{role_id}
#### Parameters
@@ -11932,9 +11932,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [SimpleResultResponse](#simpleresultresponse)<br> |
### [GET] /workspaces/current/rbac/roles/{role_id}
#### Parameters
@@ -11945,9 +11945,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [RBACRole](#rbacrole)<br> |
### [PUT] /workspaces/current/rbac/roles/{role_id}
#### Parameters
@@ -11958,9 +11958,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Success | **application/json**: [RBACRole](#rbacrole)<br> |
### [POST] /workspaces/current/rbac/roles/{role_id}/copy
#### Parameters
@@ -11971,9 +11971,9 @@ Update a plugin endpoint
#### Responses
-| Code | Description |
-| ---- | ----------- |
-| 200 | Success |
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 201 | Role copied | **application/json**: [RBACRole](#rbacrole)<br> |
### [GET] /workspaces/current/rbac/roles/{role_id}/members
#### Parameters
@@ -26481,13 +26481,6 @@ Workflow tool configuration
| data | [ [MembersInRole](#membersinrole) ] | | No |
| pagination | [Pagination](#pagination) | | No |
-#### _RBACRoleAccountList
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [RBACRoleAccount](#rbacroleaccount) ] | | No |
-| pagination | [Pagination](#pagination) | | No |
-
#### _RBACRoleList
| Name | Type | Description | Required |
diff --git a/api/repositories/app/console_repository.py b/api/repositories/app/console_repository.py
index 07f4fcfc01f..9b7a01d366e 100644
--- a/api/repositories/app/console_repository.py
+++ b/api/repositories/app/console_repository.py
@@ -51,6 +51,7 @@ 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,
+ AppAgentBinding,
AppChange,
AppCreationSettings,
AppDeletion,
@@ -117,6 +118,21 @@ class ConsoleAppRepository(ConsoleApps, AppQueryStore):
def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
self._session_factory = session_factory
+ def get_agent_binding(self, workspace_id: str, app_id: str) -> AppAgentBinding | None:
+ with self._session_factory() as session:
+ app = session.scalar(select(App).where(App.id == app_id, App.tenant_id == workspace_id))
+ if app is None:
+ return None
+ binding = app.agent_app_binding_with_session(session=session, include_archived=True)
+ return AppAgentBinding(binding.id, binding.scope == AgentScope.WORKFLOW_ONLY) if binding else None
+
+ def get_maintainer_id(self, workspace_id: str, resource_id: str, *, normal_only: bool = False) -> str | None:
+ statement = select(App.maintainer).where(App.id == resource_id, App.tenant_id == workspace_id)
+ if normal_only:
+ statement = statement.where(App.status == AppStatus.NORMAL)
+ with self._session_factory() as session:
+ return session.scalar(statement)
+
@override
def find_visible_app(self, app_id: str, tenant_id: str) -> AppSummary | None:
with self._session_factory() as session:
diff --git a/api/repositories/knowledge/dataset_read_repository.py b/api/repositories/knowledge/dataset_read_repository.py
index a690eee798c..c7e2c8a5f43 100644
--- a/api/repositories/knowledge/dataset_read_repository.py
+++ b/api/repositories/knowledge/dataset_read_repository.py
@@ -11,7 +11,7 @@ from dataclasses import dataclass, field
from typing import Any
import sqlalchemy as sa
-from sqlalchemy import func, select, tuple_
+from sqlalchemy import Select, func, select, tuple_
from sqlalchemy.orm import Session, scoped_session
from core.app.file_access import DatabaseFileAccessController
@@ -570,9 +570,11 @@ def get_pipeline_template_creator_name(template: PipelineCustomizedTemplate, ses
def get_pipeline_dataset(pipeline: Pipeline, session: Session | scoped_session) -> Dataset | None:
- return session.scalar(
- select(Dataset).where(Dataset.pipeline_id == pipeline.id, Dataset.tenant_id == pipeline.tenant_id)
- )
+ return session.scalar(pipeline_dataset_query(pipeline.tenant_id, pipeline.id))
+
+
+def pipeline_dataset_query(workspace_id: str, pipeline_id: str) -> Select[tuple[Dataset]]:
+ return select(Dataset).where(Dataset.pipeline_id == pipeline_id, Dataset.tenant_id == workspace_id)
@dataclass(frozen=True)
diff --git a/api/repositories/knowledge/dataset_repository.py b/api/repositories/knowledge/dataset_repository.py
index 447b4d8a4e8..83698ae635a 100644
--- a/api/repositories/knowledge/dataset_repository.py
+++ b/api/repositories/knowledge/dataset_repository.py
@@ -4,6 +4,7 @@ from sqlalchemy import and_, exists, literal, select
from sqlalchemy.orm import Session, sessionmaker
from models.dataset import Dataset, DatasetPermission, Document
+from repositories.knowledge.dataset_read_repository import pipeline_dataset_query
from services.knowledge.dataset_access import DatasetAccessRecord, DatasetAccessSnapshot
from services.knowledge.indexing.estimate import DatasetEstimateRecord
from services.knowledge.resource_scope import DatasetRef
@@ -45,6 +46,26 @@ class SQLAlchemyDatasetRepository:
def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
self._session_factory = session_factory
+ def get_maintainer_id(self, workspace_id: str, resource_id: str) -> str | None:
+ with self._session_factory() as session:
+ return session.scalar(
+ select(Dataset.maintainer).where(Dataset.id == resource_id, Dataset.tenant_id == workspace_id)
+ )
+
+ def get_dataset_id_by_document(self, workspace_id: str, document_id: str) -> str | None:
+ with self._session_factory() as session:
+ return session.scalar(
+ select(Dataset.id)
+ .join(Document, Document.dataset_id == Dataset.id)
+ .where(
+ Dataset.tenant_id == workspace_id, Document.tenant_id == workspace_id, Document.id == document_id
+ )
+ )
+
+ def get_dataset_id_by_pipeline(self, workspace_id: str, pipeline_id: str) -> str | None:
+ with self._session_factory() as session:
+ return session.scalar(pipeline_dataset_query(workspace_id, pipeline_id).with_only_columns(Dataset.id))
+
def get_estimate_record(self, dataset_ref: DatasetRef) -> DatasetEstimateRecord | None:
with self._session_factory() as session:
dataset = _get_dataset(session, dataset_ref)
diff --git a/api/repositories/workspace/workspace_repository.py b/api/repositories/workspace/workspace_repository.py
index 4c5639e8dec..a0cf0095cb5 100644
--- a/api/repositories/workspace/workspace_repository.py
+++ b/api/repositories/workspace/workspace_repository.py
@@ -67,14 +67,7 @@ class WorkspaceRepository(
def get_account_role(self, *, account_id: str, tenant_id: str) -> str | None:
"""Read the current membership role without loading or mutating an Account."""
- stmt = (
- select(TenantAccountJoin.role)
- .where(TenantAccountJoin.account_id == account_id, TenantAccountJoin.tenant_id == tenant_id)
- .limit(1)
- )
- with self._session_factory() as session:
- role = session.scalar(stmt)
- return role.value if role is not None else None
+ return self.get_legacy_role(workspace_id=tenant_id, account_id=account_id)
def provision(
self,
@@ -391,7 +384,7 @@ class WorkspaceRepository(
@override
def list_for_workspace(
- self, workspace_id: str, *, role: TenantAccountRole | None = None
+ self, workspace_id: str, *, role: TenantAccountRole | None = None, account_ids: Sequence[str] | None = None
) -> tuple[WorkspaceMemberRecord, ...]:
"""Read membership snapshots without retaining a Session during role resolution."""
stmt = (
@@ -412,6 +405,10 @@ class WorkspaceRepository(
)
if role is not None:
stmt = stmt.where(TenantAccountJoin.role == role)
+ if account_ids is not None:
+ if not account_ids:
+ return ()
+ stmt = stmt.where(Account.id.in_(account_ids))
with self._session_factory() as session:
return tuple(
diff --git a/api/services/app/access.py b/api/services/app/access.py
index 2fc44d0e6d6..a37793bf051 100644
--- a/api/services/app/access.py
+++ b/api/services/app/access.py
@@ -2,15 +2,10 @@ from __future__ import annotations
from collections.abc import Sequence
from dataclasses import dataclass
-from typing import TYPE_CHECKING
-
-from sqlalchemy.orm import Session
from services.enterprise import rbac_service as enterprise_rbac_service
-
-if TYPE_CHECKING:
- from services.enterprise.rbac_service import MyPermissionsResponse
- from services.entities.app_entities import AppListBaseParams
+from services.entities.app_entities import AppListBaseParams
+from services.rbac.contracts import MyPermissionsResponse
# Permission keys (dot-notation, from MyPermissionsResponse) that grant
# list/preview access to an app. Keep this the single source of truth for both
@@ -69,7 +64,6 @@ def resolve_app_access_filter(
tenant_id: str,
account_id: str,
*,
- session: Session,
permissions: MyPermissionsResponse | None = None,
) -> AppAccessFilter:
"""Compute the RBAC app-access filter for ``account_id`` in ``tenant_id``.
@@ -79,7 +73,10 @@ def resolve_app_access_filter(
inner-API round trip; otherwise it is fetched here.
"""
if permissions is None:
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(tenant_id, account_id, session=session)
+ permissions = enterprise_rbac_service.RBACService.MyPermissions.get(
+ tenant_id,
+ account_id,
+ )
whitelist_scope = enterprise_rbac_service.RBACService.AppAccess.whitelist_resources(tenant_id, account_id)
can_manage_own_apps = _MANAGE_OWN_APPS_PERMISSION_KEY in permissions.workspace.permission_keys
diff --git a/api/services/app/console_gateway.py b/api/services/app/console_gateway.py
index 519d9a7d682..824ed46dc50 100644
--- a/api/services/app/console_gateway.py
+++ b/api/services/app/console_gateway.py
@@ -63,6 +63,8 @@ from services.entities.dsl_entities import (
)
from services.errors.base import NoPermissionError
from services.feature_service import FeatureService
+from services.rbac import contracts as rbac_contracts
+from services.rbac.members import MemberService
from services.recommended_app_package_service import RecommendedAppPackageService
from services.system_feature_service import SystemFeatureService
from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
@@ -70,7 +72,7 @@ from tasks.initialize_created_app_rbac_access_task import initialize_created_app
@dataclass(frozen=True)
class ConsoleAppPermissions(AppPermissions):
- snapshot: rbac_service.MyPermissionsResponse
+ snapshot: rbac_contracts.MyPermissionsResponse
access_filter: AppAccessFilter
@override
@@ -130,37 +132,24 @@ class EnterpriseConsoleAppAccess(ConsoleAppAccess):
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
+ def __init__(self, *, members: MemberService) -> None:
+ self._members = members
@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,
+ permissions = self._members.permissions(context.active_workspace_id, context.account_id, app_id=app_id)
+ 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, permissions=permissions
)
- 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,
- )
+ keys = self._members.resource_permissions(
+ context.active_workspace_id, context.account_id, rbac_contracts.RBACResourceType.APP, [app_id]
+ )
return keys.get(app_id, [])
@override
@@ -170,7 +159,7 @@ class EnterpriseConsoleAppAccess(ConsoleAppAccess):
context.active_workspace_id,
context.account_id,
app_id,
- rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=True),
)
initialize_created_app_rbac_access_task.delay(
context.active_workspace_id, context.account_id, app_id=app_id
diff --git a/api/services/app_service.py b/api/services/app_service.py
index 466c38cf4d6..8203df815e9 100644
--- a/api/services/app_service.py
+++ b/api/services/app_service.py
@@ -64,6 +64,7 @@ from services.entities.app_entities import (
)
from services.model_provider.service import ModelProviderService
from services.openapi.visibility import apply_openapi_gate, is_openapi_visible
+from services.rbac import contracts as rbac_contracts
from services.rbac_agent_access_service import initialize_agent_rbac_access
from services.system_feature_service import SystemFeatureService
from services.tag_service import TagService
@@ -85,7 +86,7 @@ def _initialize_created_app_access(created: _CreatedApp) -> None:
enterprise_rbac_service.try_sync_creator_access_policy_member_bindings(
created.tenant_id,
created.creator_account_id,
- enterprise_rbac_service.RBACResourceType.APP,
+ rbac_contracts.RBACResourceType.APP,
created.app_id,
)
diff --git a/api/services/enterprise/rbac_service.py b/api/services/enterprise/rbac_service.py
index 0edeb9485af..818f825ce29 100644
--- a/api/services/enterprise/rbac_service.py
+++ b/api/services/enterprise/rbac_service.py
@@ -2,888 +2,61 @@ from __future__ import annotations
import logging
from collections.abc import Sequence
-from dataclasses import dataclass
-from enum import StrEnum
-from typing import Any, TypeVar
-
-from flask import has_request_context, request
-from pydantic import AliasChoices, BaseModel, ConfigDict, Field, field_validator
-from sqlalchemy import select
-from sqlalchemy.exc import SQLAlchemyError
-from sqlalchemy.orm import Session
+from typing import Any
from configs import dify_config
-from core.db.session_factory import session_factory
-from models import App, Dataset, TenantAccountJoin, TenantAccountRole
from services.enterprise.base import EnterpriseRequest
+from services.rbac.contracts import (
+ AccessMatrixItem,
+ AccessPolicy,
+ AccessPolicyBindingState,
+ AccessPolicyCreate,
+ AccessPolicyMemberBinding,
+ AccessPolicyUpdate,
+ AgentAccessMatrix,
+ AgentMigrationReport,
+ AppAccessMatrix,
+ AppendAgentWhitelistMembersBatchItem,
+ AppendAppWhitelistMembersBatchItem,
+ AppendDatasetWhitelistMembersBatchItem,
+ ConfiguredAgentIDs,
+ DatasetAccessMatrix,
+ DeleteMemberBindings,
+ ListOption,
+ MemberBindingsResponse,
+ MemberRolesResponse,
+ MembersInRole,
+ MyPermissionsResponse,
+ Paginated,
+ Pagination,
+ PermissionCatalogResponse,
+ RBACResourceType,
+ RBACRole,
+ RBACRoleAccount,
+ ReplaceBindings,
+ ReplaceMemberBindings,
+ ReplaceUserAccessPolicies,
+ ReplaceUserAccessPoliciesResponse,
+ ResourceUserAccessPoliciesResponse,
+ ResourceWhitelist,
+ ResourceWhitelistConfig,
+ ResourceWhitelistConfigResource,
+ ResourceWhitelistConfigsResponse,
+ ResourceWhitelistResources,
+ RoleBindingsResponse,
+ RoleMutation,
+ WorkspaceAccessMatrix,
+ _RBACModel,
+ _ResourceAccessRoute,
+ _ResourceWhitelistConfigSnapshot,
+)
-T = TypeVar("T")
logger = logging.getLogger(__name__)
-def app_maintainer_id(tenant_id: str, app_id: str) -> str | None:
- with session_factory.create_session() as session:
- return session.scalar(select(App.maintainer).where(App.id == app_id, App.tenant_id == tenant_id))
-
-
-def dataset_maintainer_id(tenant_id: str, dataset_id: str) -> str | None:
- with session_factory.create_session() as session:
- return session.scalar(
- select(Dataset.maintainer).where(Dataset.id == dataset_id, Dataset.tenant_id == tenant_id)
- )
-
-
-class _RBACModel(BaseModel):
- model_config = ConfigDict(populate_by_name=True, extra="ignore")
-
-
-class Pagination(_RBACModel):
- total_count: int = 0
- per_page: int = 0
- current_page: int = 0
- total_pages: int = 0
-
-
-class Paginated[T](_RBACModel):
- data: list[T] = Field(default_factory=list)
- pagination: Pagination | None = None
-
-
-class MembersInRole(_RBACModel):
- account_id: str = ""
- account_name: str = ""
-
-
-@dataclass(frozen=True)
-class _ResourceAccessRoute:
- segment: str
- id_param: str
-
-
-class RBACResourceType(StrEnum):
- """Resource types understood by access policies."""
-
- APP = "app"
- DATASET = "dataset"
- AGENT = "agent"
-
- @property
- def route(self) -> _ResourceAccessRoute:
- routes = {
- RBACResourceType.APP: _ResourceAccessRoute("apps", "app_id"),
- RBACResourceType.DATASET: _ResourceAccessRoute("datasets", "dataset_id"),
- RBACResourceType.AGENT: _ResourceAccessRoute("agents", "agent_id"),
- }
- return routes[self]
-
-
-class RBACRoleType(StrEnum):
- """The only concrete role type after the access-policy refactor."""
-
- WORKSPACE = "workspace"
-
-
-class PermissionCatalogItem(_RBACModel):
- key: str
- name: str
- description: str = ""
-
-
-class PermissionCatalogGroup(_RBACModel):
- group_key: str
- group_name: str
- description: str = ""
- permissions: list[PermissionCatalogItem] = Field(default_factory=list)
-
-
-class PermissionCatalogResponse(_RBACModel):
- groups: list[PermissionCatalogGroup] = Field(default_factory=list)
-
-
-class RBACRole(_RBACModel):
- id: str
- tenant_id: str | None = None
- type: str
- category: str = ""
- name: str
- description: str = ""
- is_builtin: bool = False
- permission_keys: list[str] = Field(default_factory=list)
- role_tag: str = ""
-
- @field_validator("permission_keys", mode="before")
- @classmethod
- def _coerce_permission_keys(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class RBACRoleAccount(_RBACModel):
- account_id: str
- account_name: str = ""
- email: str = ""
- avatar: str = ""
-
-
-class MemberRoleSummary(_RBACModel):
- id: str
- name: str
-
-
-class ResourcePermissionKeys(_RBACModel):
- resource_id: str
- permission_keys: list[str] = Field(default_factory=list)
-
-
-class ResourcePermissionKeysBatchResponse(_RBACModel):
- data: list[ResourcePermissionKeys] = Field(default_factory=list)
-
-
-class AccessPolicy(_RBACModel):
- id: str
- tenant_id: str = ""
- resource_type: str
- policy_key: str = ""
- name: str
- description: str = ""
- permission_keys: list[str] = Field(default_factory=list)
- is_builtin: bool = False
- category: str = ""
- created_at: int = 0
- updated_at: int = 0
-
- @field_validator("permission_keys", mode="before")
- @classmethod
- def _coerce_permission_keys(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class AccessPolicyRoleBinding(_RBACModel):
- id: str
- tenant_id: str = ""
- access_policy_id: str
- resource_type: str
- resource_id: str = ""
- role_id: str
- role_name: str = ""
- created_at: int = 0
-
-
-class AccessPolicyMemberBinding(_RBACModel):
- id: str
- tenant_id: str = ""
- access_policy_id: str
- resource_type: str
- resource_id: str = ""
- account_id: str
- account_name: str = ""
- created_at: int = 0
-
-
-class AccessPolicyBindingState(_RBACModel):
- binding_id: str
- is_locked: bool = False
-
-
-class AccessPolicyRole(BaseModel):
- role_id: str
- role_name: str
- binding_id: str
- is_locked: bool = False
- role_tag: str = ""
-
-
-class AccessPolicyAccount(BaseModel):
- account_id: str
- account_name: str
- binding_id: str
- is_locked: bool = False
- avatar: str = ""
- email: str = ""
-
-
-class AccessMatrixItem(_RBACModel):
- policy: AccessPolicy | None = None
- roles: list[AccessPolicyRole] = Field(default_factory=list)
- accounts: list[AccessPolicyAccount] = Field(default_factory=list)
-
- @field_validator("roles", "accounts", mode="before")
- @classmethod
- def _coerce_empty_lists(cls, value: Any) -> list[dict[str, Any]]:
- if value is None:
- return []
- return value
-
-
-class AppAccessMatrix(_RBACModel):
- app_id: str = Field(default="", validation_alias=AliasChoices("app_id", "resource_id"))
- items: list[AccessMatrixItem] = Field(default_factory=list)
-
-
-class DatasetAccessMatrix(_RBACModel):
- dataset_id: str = Field(default="", validation_alias=AliasChoices("dataset_id", "resource_id"))
- items: list[AccessMatrixItem] = Field(default_factory=list)
-
-
-class AgentAccessMatrix(_RBACModel):
- agent_id: str = Field(default="", validation_alias=AliasChoices("agent_id", "resource_id"))
- items: list[AccessMatrixItem] = Field(default_factory=list)
-
-
-class WorkspaceAccessMatrix(_RBACModel):
- items: list[AccessMatrixItem] = Field(default_factory=list)
- pagination: Pagination | None = None
-
-
-class RoleBindingsResponse(_RBACModel):
- data: list[AccessPolicyRoleBinding] = Field(default_factory=list)
-
-
-class MemberBindingsResponse(_RBACModel):
- data: list[AccessPolicyMemberBinding] = Field(default_factory=list)
-
-
-class ResourceWhitelist(_RBACModel):
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("account_ids", mode="before")
- @classmethod
- def _coerce_account_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ResourceWhitelistConfig(_RBACModel):
- automatic_include_workspace_members: bool
-
-
-class ResourceWhitelistConfigResource(_RBACModel):
- resource_type: RBACResourceType
- resource_id: str
-
-
-class ResourceWhitelistConfigItem(_RBACModel):
- resource_type: RBACResourceType
- resource_id: str
- automatic_include_workspace_members: bool = False
- account_ids: list[str] = Field(default_factory=list)
- rbac_whitelist_scope: str | None = Field(
- default=None, validation_alias=AliasChoices("rbac_whitelist_scope", "scope")
- )
-
- @field_validator("account_ids", mode="before")
- @classmethod
- def _coerce_account_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ResourceWhitelistConfigsResponse(_RBACModel):
- data: list[ResourceWhitelistConfigItem] = Field(default_factory=list)
-
-
-class _LegacyResourceWhitelistConfig(_RBACModel):
- """RBAC service's pre-toggle whitelist payload, used only by data migrations."""
-
- account_ids: list[str] = Field(default_factory=list)
- rbac_whitelist_scope: str | None = Field(
- default=None, validation_alias=AliasChoices("rbac_whitelist_scope", "scope")
- )
-
- @field_validator("account_ids", mode="before")
- @classmethod
- def _coerce_account_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class LegacyAgentRoleMigration(_RBACModel):
- role_id: str
- role_name: str = ""
- added_keys: list[str] = Field(default_factory=list)
- removed_keys: list[str] = Field(default_factory=list)
- bound_policies: list[str] = Field(default_factory=list)
- skipped: str = ""
-
-
-class LegacyAgentMigrationReport(_RBACModel):
- roles: list[LegacyAgentRoleMigration] = Field(default_factory=list)
- role_templates: list[LegacyAgentRoleMigration] = Field(default_factory=list)
-
-
-class ConfiguredAgentIDs(_RBACModel):
- configured_agent_ids: list[str] = Field(default_factory=list)
-
-
-class ResourceWhitelistResources(_RBACModel):
- unrestricted: bool = False
- resource_ids: list[str] = Field(default_factory=list)
-
- @field_validator("resource_ids", mode="before")
- @classmethod
- def _coerce_resource_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ResourceUserAccessPolicies(_RBACModel):
- account: RBACRoleAccount
- roles: list[RBACRole] = Field(default_factory=list)
- access_policies: list[AccessPolicy] = Field(default_factory=list)
-
- @field_validator("access_policies", "roles", mode="before")
- @classmethod
- def _coerce_none_to_list(cls, value: Any) -> Any:
- if value is None:
- return []
- return value
-
-
-class ResourceUserAccessPoliciesResponse(_RBACModel):
- data: list[ResourceUserAccessPolicies] = Field(default_factory=list)
- pagination: Pagination | None = None
-
-
-class ReplaceUserAccessPolicies(_RBACModel):
- access_policy_ids: list[str] = Field(default_factory=list)
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("access_policy_ids", mode="before")
- @classmethod
- def _coerce_access_policy_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ReplaceUserAccessPoliciesResponse(_RBACModel):
- access_policies: list[AccessPolicy] = Field(default_factory=list)
-
-
-class AppendAppWhitelistMembersBatchItem(_RBACModel):
- app_id: str
- account_ids: list[str] = Field(default_factory=list)
- policy_id: str
-
-
-class AppendDatasetWhitelistMembersBatchItem(_RBACModel):
- dataset_id: str
- account_ids: list[str] = Field(default_factory=list)
- policy_id: str
-
-
-class AppendAgentWhitelistMembersBatchItem(_RBACModel):
- agent_id: str
- account_ids: list[str] = Field(default_factory=list)
- policy_id: str
-
-
-class MemberRolesResponse(_RBACModel):
- account_id: str
- roles: list[RBACRole] = Field(default_factory=list)
-
-
-class MemberRolesBatchResponse(_RBACModel):
- data: list[MemberRolesResponse] = Field(default_factory=list)
-
-
-class WorkspacePermissionSnapshot(_RBACModel):
- permission_keys: list[str] = Field(default_factory=list)
-
-
-class ResourcePermissionSnapshot(_RBACModel):
- default_permission_keys: list[str] = Field(default_factory=list)
- overrides: list[ResourcePermissionKeys] = Field(default_factory=list)
-
- def permission_keys_by_resource_ids(self, resource_ids: list[str]) -> dict[str, list[str]]:
- result = {str(resource_id): list(self.default_permission_keys) for resource_id in resource_ids}
- for override in self.overrides:
- resource_id = str(override.resource_id)
- if resource_id in result:
- result[resource_id] = list(override.permission_keys)
- return result
-
-
-class MyPermissionsResponse(_RBACModel):
- workspace: WorkspacePermissionSnapshot = Field(default_factory=WorkspacePermissionSnapshot)
- app: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
- dataset: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
- agent: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
-
- def resource_snapshot(self, resource_type: RBACResourceType) -> ResourcePermissionSnapshot:
- return {
- RBACResourceType.APP: self.app,
- RBACResourceType.DATASET: self.dataset,
- RBACResourceType.AGENT: self.agent,
- }[resource_type]
-
-
-# Fallback permission snapshots for legacy Dify tenant roles when external RBAC is disabled.
-# Keep these keys aligned with langgenius/rbac's built-in workspace roles and access policies.
-_LEGACY_WORKSPACE_OWNER_KEYS: list[str] = [
- "skill.view",
- "skill.edit",
- "skill.publish",
- "skill.delete",
- "workspace.member.manage",
- "workspace.role.manage",
- "data_source.manage",
- "api_extension.manage",
- "customization.manage",
- "plugin.install",
- "plugin.plugin_preferences",
- "plugin.model_config",
- "plugin.delete",
- "plugin.debug",
- "credential.use",
- "credential.create",
- "credential.manage",
- "app.acl.preview",
- "app_library.access",
- "app.create_and_management",
- "app.tag.manage",
- "dataset.acl.preview",
- "dataset.create_and_management",
- "dataset.tag.manage",
- "dataset.external.connect",
- "dataset.api_key.manage",
- "snippets.create_and_modify",
- "snippets.management",
- "tool.manage",
- "mcp.manage",
- "agent.create",
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_WORKSPACE_ADMIN_KEYS: list[str] = [
- "skill.view",
- "skill.edit",
- "skill.publish",
- "skill.delete",
- "workspace.member.manage",
- "workspace.role.manage",
- "data_source.manage",
- "api_extension.manage",
- "customization.manage",
- "plugin.install",
- "plugin.plugin_preferences",
- "plugin.model_config",
- "plugin.delete",
- "plugin.debug",
- "credential.use",
- "credential.create",
- "credential.manage",
- "app_library.access",
- "app.create_and_management",
- "app.tag.manage",
- "dataset.create_and_management",
- "dataset.tag.manage",
- "dataset.external.connect",
- "dataset.api_key.manage",
- "snippets.create_and_modify",
- "snippets.management",
- "tool.manage",
- "mcp.manage",
- "agent.create",
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_WORKSPACE_EDITOR_KEYS: list[str] = [
- "skill.view",
- "skill.edit",
- "skill.publish",
- "skill.delete",
- "api_extension.manage",
- "plugin.install",
- "credential.use",
- "app_library.access",
- "app.create_and_management",
- "app.tag.manage",
- "dataset.create_and_management",
- "dataset.tag.manage",
- "dataset.external.connect",
- "snippets.create_and_modify",
- "tool.manage",
- "agent.create",
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_WORKSPACE_NORMAL_KEYS: list[str] = [
- "skill.view",
- "api_extension.manage",
- "plugin.install",
- "credential.use",
- "app_library.access",
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_WORKSPACE_DATASET_OPERATOR_KEYS: list[str] = [
- "skill.view",
- "plugin.install",
- "dataset.create_and_management",
- "dataset.external.connect",
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_APP_OWNER_KEYS: list[str] = [
- "app.acl.preview",
- "app.acl.view_layout",
- "app.acl.test_and_run",
- "app.acl.edit",
- "app.acl.import_export_dsl",
- "app.acl.delete",
- "app.acl.release_and_version",
- "app.acl.monitor",
- "app.acl.access_config",
- "app.acl.tracing_config",
- "app.acl.log_and_annotation",
- "app.acl.access_point_manage",
- "app.acl.access_point_view",
-]
-
-_LEGACY_APP_ADMIN_KEYS: list[str] = [
- "app.acl.preview",
- "app.acl.view_layout",
- "app.acl.test_and_run",
- "app.acl.edit",
- "app.acl.import_export_dsl",
- "app.acl.delete",
- "app.acl.release_and_version",
- "app.acl.monitor",
- "app.acl.access_config",
- "app.acl.access_config",
- "app.acl.tracing_config",
- "app.acl.log_and_annotation",
- "app.acl.access_point_manage",
- "app.acl.access_point_view",
-]
-
-_LEGACY_APP_EDITOR_KEYS: list[str] = [
- "app.acl.preview",
- "app.acl.view_layout",
- "app.acl.test_and_run",
- "app.acl.edit",
- "app.acl.import_export_dsl",
- "app.acl.delete",
- "app.acl.release_and_version",
- "app.acl.monitor",
- "app.acl.log_and_annotation",
- "app.acl.access_config",
- "app.acl.access_point_manage",
- "app.acl.access_point_view",
-]
-
-_LEGACY_APP_NORMAL_KEYS: list[str] = [
- "app.acl.monitor",
- "app.acl.access_point_view",
-]
-
-_LEGACY_APP_DATASET_OPERATOR_KEYS: list[str] = [
- "app.acl.access_point_view",
-]
-
-_LEGACY_DATASET_OWNER_KEYS: list[str] = [
- "dataset.acl.preview",
- "dataset.acl.readonly",
- "dataset.acl.edit",
- "dataset.acl.import_export_dsl",
- "dataset.acl.pipeline_test",
- "dataset.acl.document_download",
- "dataset.acl.retrieval_recall",
- "dataset.acl.use",
- "dataset.acl.delete_file",
- "dataset.acl.pipeline_release",
- "dataset.acl.delete",
- "dataset.acl.access_config",
- "dataset.api_key.manage",
-]
-
-_LEGACY_DATASET_ADMIN_KEYS: list[str] = [
- "dataset.acl.preview",
- "dataset.acl.readonly",
- "dataset.acl.edit",
- "dataset.acl.import_export_dsl",
- "dataset.acl.pipeline_test",
- "dataset.acl.document_download",
- "dataset.acl.retrieval_recall",
- "dataset.acl.use",
- "dataset.acl.delete_file",
- "dataset.acl.pipeline_release",
- "dataset.acl.delete",
- "dataset.acl.access_config",
- "dataset.api_key.manage",
-]
-
-_LEGACY_DATASET_EDITOR_KEYS: list[str] = [
- "dataset.acl.preview",
- "dataset.acl.readonly",
- "dataset.acl.edit",
- "dataset.acl.import_export_dsl",
- "dataset.acl.pipeline_test",
- "dataset.acl.document_download",
- "dataset.acl.retrieval_recall",
- "dataset.acl.use",
- "dataset.acl.delete_file",
- "dataset.acl.pipeline_release",
-]
-
-_LEGACY_DATASET_DATASET_OPERATOR_KEYS: list[str] = [
- "dataset.acl.readonly",
- "dataset.acl.edit",
- "dataset.acl.import_export_dsl",
- "dataset.acl.pipeline_test",
- "dataset.acl.document_download",
- "dataset.acl.retrieval_recall",
- "dataset.acl.use",
- "dataset.acl.delete_file",
- "dataset.acl.pipeline_release",
-]
-
-_LEGACY_AGENT_FULL_ACCESS_KEYS: list[str] = [
- "agent.acl.preview",
- "agent.acl.edit",
- "agent.acl.test_and_run",
- "agent.acl.release_and_version",
- "agent.acl.access_point_view",
- "agent.acl.access_point_manage",
- "agent.acl.log_manage",
- "agent.acl.monitor",
- "agent.acl.access_config",
- "agent.acl.import_export_dsl",
- "agent.acl.delete",
-]
-
-_LEGACY_AGENT_PREVIEW_KEYS: list[str] = [
- "agent.acl.preview",
- "agent.acl.access_point_view",
-]
-
-_LEGACY_MY_PERMISSIONS: dict[TenantAccountRole, dict[str, list[str]]] = {
- TenantAccountRole.OWNER: {
- "workspace": _LEGACY_WORKSPACE_OWNER_KEYS,
- "app": _LEGACY_APP_OWNER_KEYS,
- "dataset": _LEGACY_DATASET_OWNER_KEYS,
- "agent": _LEGACY_AGENT_FULL_ACCESS_KEYS,
- },
- TenantAccountRole.ADMIN: {
- "workspace": _LEGACY_WORKSPACE_ADMIN_KEYS,
- "app": _LEGACY_APP_ADMIN_KEYS,
- "dataset": _LEGACY_DATASET_ADMIN_KEYS,
- "agent": _LEGACY_AGENT_FULL_ACCESS_KEYS,
- },
- TenantAccountRole.EDITOR: {
- "workspace": _LEGACY_WORKSPACE_EDITOR_KEYS,
- "app": _LEGACY_APP_EDITOR_KEYS,
- "dataset": _LEGACY_DATASET_EDITOR_KEYS,
- "agent": _LEGACY_AGENT_FULL_ACCESS_KEYS,
- },
- TenantAccountRole.NORMAL: {
- "workspace": _LEGACY_WORKSPACE_NORMAL_KEYS,
- "app": _LEGACY_APP_NORMAL_KEYS,
- "agent": _LEGACY_AGENT_PREVIEW_KEYS,
- },
- TenantAccountRole.DATASET_OPERATOR: {
- "workspace": _LEGACY_WORKSPACE_DATASET_OPERATOR_KEYS,
- "app": _LEGACY_APP_DATASET_OPERATOR_KEYS,
- "dataset": _LEGACY_DATASET_DATASET_OPERATOR_KEYS,
- "agent": _LEGACY_AGENT_PREVIEW_KEYS,
- },
-}
-
-
-def _legacy_role_permission_keys(role: TenantAccountRole) -> list[str]:
- permissions = _LEGACY_MY_PERMISSIONS.get(role, {})
- return list(
- dict.fromkeys(
- [
- *permissions.get("workspace", []),
- *permissions.get("app", []),
- *permissions.get("dataset", []),
- *permissions.get("agent", []),
- ]
- )
- )
-
-
-def _legacy_member_roles_response(
- tenant_id: str, member_account_id: str, role: TenantAccountRole | str | None
-) -> MemberRolesResponse:
- if not role:
- return MemberRolesResponse(account_id=member_account_id, roles=[])
-
- tenant_role = TenantAccountRole(role)
- role_value = tenant_role.value
- return MemberRolesResponse(
- account_id=member_account_id,
- roles=[
- RBACRole(
- id=role_value,
- name=role_value,
- description="",
- is_builtin=True,
- type="",
- permission_keys=_legacy_role_permission_keys(tenant_role),
- role_tag="owner" if tenant_role == TenantAccountRole.OWNER else role_value,
- tenant_id=tenant_id,
- )
- ],
- )
-
-
-def _legacy_my_permissions(tenant_id: str, account_id: str | None, *, session: Session) -> MyPermissionsResponse:
- if not account_id:
- return MyPermissionsResponse()
-
- try:
- role = session.scalar(
- select(TenantAccountJoin.role).where(
- TenantAccountJoin.tenant_id == tenant_id,
- TenantAccountJoin.account_id == account_id,
- )
- )
- if not role:
- return MyPermissionsResponse()
-
- try:
- tenant_role = TenantAccountRole(role)
- except ValueError:
- return MyPermissionsResponse()
- except SQLAlchemyError:
- return MyPermissionsResponse()
-
- permissions = _LEGACY_MY_PERMISSIONS.get(tenant_role, {})
- return MyPermissionsResponse(
- workspace=WorkspacePermissionSnapshot(permission_keys=list(permissions.get("workspace", []))),
- app=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("app", []))),
- dataset=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("dataset", []))),
- agent=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("agent", []))),
- )
-
-
-def _legacy_resource_permission_keys_batch(
- tenant_id: str,
- account_id: str | None,
- resource_ids: list[str],
- resource_type: RBACResourceType,
- *,
- session: Session,
-) -> dict[str, list[str]]:
- snapshot = _legacy_my_permissions(tenant_id, account_id, session=session)
- permission_keys = snapshot.resource_snapshot(resource_type).default_permission_keys
- return {str(resource_id): list(permission_keys) for resource_id in resource_ids}
-
-
-# ---------- Mutation request models ----------
-
-
-class RoleMutation(_RBACModel):
- """Payload shared by role create & update.
-
- ``type`` defaults to ``workspace`` because that is the only concrete role
- type supported by the enterprise backend today (see biz.RBACRoleType).
- """
-
- name: str
- description: str = ""
- permission_keys: list[str] = Field(default_factory=list)
- type: RBACRoleType = RBACRoleType.WORKSPACE
-
-
-class AccessPolicyCreate(_RBACModel):
- name: str
- resource_type: RBACResourceType
- description: str = ""
- permission_keys: list[str] = Field(default_factory=list)
-
-
-class AccessPolicyUpdate(_RBACModel):
- name: str
- description: str = ""
- permission_keys: list[str] = Field(default_factory=list)
-
-
-class ReplaceRoleBindings(_RBACModel):
- role_ids: list[str] = Field(default_factory=list)
-
- @field_validator("role_ids", mode="before")
- @classmethod
- def _coerce_role_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ReplaceMemberBindings(_RBACModel):
- automatic_include_workspace_members: bool = Field(default=False)
-
-
-class DeleteMemberBindings(_RBACModel):
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("account_ids", mode="before")
- @classmethod
- def _coerce_account_ids(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ReplaceBindings(_RBACModel):
- role_ids: list[str] = Field(default_factory=list)
- account_ids: list[str] = Field(default_factory=list)
-
- @field_validator("role_ids", "account_ids", mode="before")
- @classmethod
- def _coerce_bindings(cls, value: Any) -> list[str]:
- if value is None:
- return []
- return value
-
-
-class ListOption(_RBACModel):
- page_number: int | None = None
- results_per_page: int | None = None
- reverse: bool | None = None
-
- def to_params(self, extra: dict[str, Any] | None = None) -> dict[str, Any]:
- params: dict[str, Any] = {}
- if self.page_number is not None:
- params["page_number"] = self.page_number
- if self.results_per_page is not None:
- params["results_per_page"] = self.results_per_page
- if self.reverse is not None:
- # httpx renders `True` as the string "True"; we want the inner
- # handler to match on the lowercase form it compares against.
- params["reverse"] = "true" if self.reverse else "false"
- if extra:
- params.update({k: v for k, v in extra.items() if v is not None})
- return params
-
-
_INNER_PREFIX = "/rbac"
-def _request_language_param() -> str | None:
- if not has_request_context():
- return None
- language = (request.args.get("language") or "").strip().lower()
- if language in {"en", "ja", "zh"}:
- return language
- return None
-
-
def _inner_call(
method: str,
endpoint: str,
@@ -892,14 +65,9 @@ def _inner_call(
account_id: str | None = None,
json: Any | None = None,
params: dict[str, Any] | None = None,
+ language: str | None = None,
) -> Any:
- """Thin wrapper around `EnterpriseRequest.send_inner_rbac_request`.
-
- Kept as a module-level helper (rather than a nested-class method) so that
- unit tests can monkey-patch this single entry point instead of every
- individual `Roles.*`, `AccessPolicies.*`, … method.
- """
- language = _request_language_param()
+ """Send an Enterprise request with localization supplied by the caller."""
if language and (not params or "language" not in params):
params = dict(params or {})
params["language"] = language
@@ -967,12 +135,11 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
params["policy_id"] = policy_id
return params
- def whitelist_resources(self, tenant_id: str, account_id: str | None) -> ResourceWhitelistResources:
+ def whitelist_resources(
+ self, tenant_id: str, account_id: str | None, *, language: str | None = None
+ ) -> ResourceWhitelistResources:
data = _inner_call(
- "GET",
- self._path("whitelist/resources"),
- tenant_id=tenant_id,
- account_id=account_id,
+ "GET", self._path("whitelist/resources"), tenant_id=tenant_id, account_id=account_id, language=language
)
return ResourceWhitelistResources.model_validate(data or {})
@@ -983,6 +150,7 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
resource_id: str,
*,
options: ListOption | None = None,
+ language: str | None = None,
) -> ResourceUserAccessPoliciesResponse:
params = (options or ListOption()).to_params({self._route.id_param: resource_id})
data = _inner_call(
@@ -991,6 +159,7 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
tenant_id=tenant_id,
account_id=account_id,
params=params,
+ language=language,
)
return ResourceUserAccessPoliciesResponse.model_validate(data or {})
@@ -1001,6 +170,8 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
resource_id: str,
target_account_id: str | None,
payload: ReplaceUserAccessPolicies,
+ *,
+ language: str | None = None,
) -> ReplaceUserAccessPoliciesResponse:
params = self._params(resource_id)
params["account_id"] = target_account_id
@@ -1011,40 +182,48 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
account_id=account_id,
params=params,
json=payload.model_dump(mode="json", exclude_unset=self._replace_user_policies_exclude_unset),
+ language=language,
)
return ReplaceUserAccessPoliciesResponse.model_validate(data or {})
- def whitelist(self, tenant_id: str, account_id: str | None, resource_id: str) -> ResourceWhitelist:
+ def whitelist(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> ResourceWhitelist:
data = _inner_call(
"GET",
self._path("whitelist"),
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id),
+ language=language,
)
return ResourceWhitelist.model_validate(data or {})
- def whitelist_config(self, tenant_id: str, account_id: str | None, resource_id: str) -> ResourceWhitelistConfig:
+ def whitelist_config(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> ResourceWhitelistConfig:
data = _inner_call(
"GET",
self._path("whitelist"),
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id),
+ language=language,
)
return ResourceWhitelistConfig.model_validate(data or {})
def legacy_whitelist_config(
- self, tenant_id: str, account_id: str | None, resource_id: str
- ) -> _LegacyResourceWhitelistConfig:
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> _ResourceWhitelistConfigSnapshot:
data = _inner_call(
"GET",
self._path("whitelist"),
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id),
+ language=language,
)
- return _LegacyResourceWhitelistConfig.model_validate(data or {})
+ return _ResourceWhitelistConfigSnapshot.model_validate(data or {})
def replace_whitelist(
self,
@@ -1052,6 +231,8 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
account_id: str | None,
resource_id: str,
payload: ReplaceMemberBindings,
+ *,
+ language: str | None = None,
) -> ResourceWhitelist:
data = _inner_call(
"PUT",
@@ -1060,14 +241,12 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
account_id=account_id,
params=self._params(resource_id),
json=payload.model_dump(mode="json"),
+ language=language,
)
return ResourceWhitelist.model_validate(data or {})
def append_whitelist_members_batch(
- self,
- tenant_id: str,
- account_id: str | None,
- data: Sequence[_RBACModel],
+ self, tenant_id: str, account_id: str | None, data: Sequence[_RBACModel], *, language: str | None = None
) -> None:
_inner_call(
"POST",
@@ -1075,24 +254,24 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
tenant_id=tenant_id,
account_id=account_id,
json={"data": [item.model_dump(mode="json") for item in data]},
+ language=language,
)
- def matrix(self, tenant_id: str, account_id: str | None, resource_id: str) -> MatrixT:
+ def matrix(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> MatrixT:
data = _inner_call(
"GET",
self._path("access-policy"),
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id),
+ language=language,
)
return self._matrix_model.model_validate(data or {})
def list_role_bindings(
- self,
- tenant_id: str,
- account_id: str | None,
- resource_id: str,
- policy_id: str,
+ self, tenant_id: str, account_id: str | None, resource_id: str, policy_id: str, *, language: str | None = None
) -> RoleBindingsResponse:
data = _inner_call(
"GET",
@@ -1100,33 +279,12 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id, policy_id),
- )
- return RoleBindingsResponse.model_validate(data or {})
-
- def replace_role_bindings(
- self,
- tenant_id: str,
- account_id: str | None,
- resource_id: str,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- data = _inner_call(
- "PUT",
- self._path("access-policy/role-bindings"),
- tenant_id=tenant_id,
- account_id=account_id,
- params=self._params(resource_id, policy_id),
- json=payload.model_dump(mode="json"),
+ language=language,
)
return RoleBindingsResponse.model_validate(data or {})
def list_member_bindings(
- self,
- tenant_id: str,
- account_id: str | None,
- resource_id: str,
- policy_id: str,
+ self, tenant_id: str, account_id: str | None, resource_id: str, policy_id: str, *, language: str | None = None
) -> MemberBindingsResponse:
data = _inner_call(
"GET",
@@ -1134,6 +292,7 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
tenant_id=tenant_id,
account_id=account_id,
params=self._params(resource_id, policy_id),
+ language=language,
)
return MemberBindingsResponse.model_validate(data or {})
@@ -1144,6 +303,8 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
resource_id: str,
policy_id: str,
payload: DeleteMemberBindings,
+ *,
+ language: str | None = None,
) -> None:
_inner_call(
"DELETE",
@@ -1152,26 +313,9 @@ class _ResourceAccessClient[MatrixT: _RBACModel]:
account_id=account_id,
params=self._params(resource_id, policy_id),
json=payload.model_dump(mode="json"),
+ language=language,
)
- def replace_bindings(
- self,
- tenant_id: str,
- account_id: str | None,
- resource_id: str,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- data = _inner_call(
- "PUT",
- self._path("access-policy/bindings"),
- tenant_id=tenant_id,
- account_id=account_id,
- params=self._params(resource_id, policy_id),
- json=payload.model_dump(mode="json"),
- )
- return AccessMatrixItem.model_validate(data or {})
-
class _WorkspaceAccessClient:
def __init__(self, route: _ResourceAccessRoute) -> None:
@@ -1186,6 +330,7 @@ class _WorkspaceAccessClient:
account_id: str | None = None,
*,
options: ListOption | None = None,
+ language: str | None = None,
) -> WorkspaceAccessMatrix:
data = _inner_call(
"GET",
@@ -1193,43 +338,33 @@ class _WorkspaceAccessClient:
tenant_id=tenant_id,
account_id=account_id,
params=(options or ListOption()).to_params() or None,
+ language=language,
)
return WorkspaceAccessMatrix.model_validate(data or {})
- def list_role_bindings(self, tenant_id: str, account_id: str | None, policy_id: str) -> RoleBindingsResponse:
- data = _inner_call(
- "GET",
- self._path("access-policy/role-bindings"),
- tenant_id=tenant_id,
- account_id=account_id,
- params={"policy_id": policy_id},
- )
- return RoleBindingsResponse.model_validate(data or {})
-
- def replace_role_bindings(
- self,
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceRoleBindings,
+ def list_role_bindings(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
) -> RoleBindingsResponse:
data = _inner_call(
- "PUT",
+ "GET",
self._path("access-policy/role-bindings"),
tenant_id=tenant_id,
account_id=account_id,
params={"policy_id": policy_id},
- json=payload.model_dump(mode="json"),
+ language=language,
)
return RoleBindingsResponse.model_validate(data or {})
- def list_member_bindings(self, tenant_id: str, account_id: str | None, policy_id: str) -> MemberBindingsResponse:
+ def list_member_bindings(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> MemberBindingsResponse:
data = _inner_call(
"GET",
self._path("access-policy/member-bindings"),
tenant_id=tenant_id,
account_id=account_id,
params={"policy_id": policy_id},
+ language=language,
)
return MemberBindingsResponse.model_validate(data or {})
@@ -1239,6 +374,8 @@ class _WorkspaceAccessClient:
account_id: str | None,
policy_id: str,
payload: ReplaceBindings,
+ *,
+ language: str | None = None,
) -> AccessMatrixItem:
data = _inner_call(
"PUT",
@@ -1247,6 +384,7 @@ class _WorkspaceAccessClient:
account_id=account_id,
params={"policy_id": policy_id},
json=payload.model_dump(mode="json"),
+ language=language,
)
return AccessMatrixItem.model_validate(data or {})
@@ -1262,13 +400,14 @@ _WORKSPACE_AGENT_ACCESS = _WorkspaceAccessClient(RBACResourceType.AGENT.route)
def _resource_permission_catalog(
- resource_type: RBACResourceType, tenant_id: str, account_id: str | None
+ resource_type: RBACResourceType, tenant_id: str, account_id: str | None, *, language: str | None = None
) -> PermissionCatalogResponse:
data = _inner_call(
"GET",
f"{_INNER_PREFIX}/role-permissions/catalog/{resource_type.value}",
tenant_id=tenant_id,
account_id=account_id,
+ language=language,
)
return PermissionCatalogResponse.model_validate(data or {})
@@ -1286,26 +425,35 @@ class RBACService:
# ------------------------------------------------------------------
class Catalog:
@staticmethod
- def workspace(tenant_id: str, account_id: str | None = None) -> PermissionCatalogResponse:
+ def workspace(
+ tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse:
data = _inner_call(
"GET",
f"{_INNER_PREFIX}/role-permissions/catalog",
tenant_id=tenant_id,
account_id=account_id,
+ language=language,
)
return PermissionCatalogResponse.model_validate(data or {})
@staticmethod
- def app(tenant_id: str, account_id: str | None = None) -> PermissionCatalogResponse:
- return _resource_permission_catalog(RBACResourceType.APP, tenant_id, account_id)
+ def app(
+ tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse:
+ return _resource_permission_catalog(RBACResourceType.APP, tenant_id, account_id, language=language)
@staticmethod
- def dataset(tenant_id: str, account_id: str | None = None) -> PermissionCatalogResponse:
- return _resource_permission_catalog(RBACResourceType.DATASET, tenant_id, account_id)
+ def dataset(
+ tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse:
+ return _resource_permission_catalog(RBACResourceType.DATASET, tenant_id, account_id, language=language)
@staticmethod
- def agent(tenant_id: str, account_id: str | None = None) -> PermissionCatalogResponse:
- return _resource_permission_catalog(RBACResourceType.AGENT, tenant_id, account_id)
+ def agent(
+ tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse:
+ return _resource_permission_catalog(RBACResourceType.AGENT, tenant_id, account_id, language=language)
# ------------------------------------------------------------------
# Role CRUD (Settings > Permissions).
@@ -1319,6 +467,7 @@ class RBACService:
biiling_enabled: bool | None = None,
*,
options: ListOption | None = None,
+ language: str | None = None,
) -> Paginated[RBACRole]:
params = (options or ListOption()).to_params(
{"include_owner": include_owner, "biiling_enabled": biiling_enabled}
@@ -1330,6 +479,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
params=params or None,
+ language=language,
)
data = data or {}
return Paginated[RBACRole](
@@ -1343,13 +493,11 @@ class RBACService:
role_id: str | None = None,
*,
options: ListOption | None = None,
+ language: str | None = None,
) -> Paginated[MembersInRole]:
params = (options or ListOption()).to_params({"role_id": role_id})
data = _inner_call(
- "GET",
- f"{_INNER_PREFIX}/roles/members",
- tenant_id=tenant_id,
- params=params or None,
+ "GET", f"{_INNER_PREFIX}/roles/members", tenant_id=tenant_id, params=params or None, language=language
)
data = data or {}
return Paginated[MembersInRole](
@@ -1358,29 +506,42 @@ class RBACService:
)
@staticmethod
- def get(tenant_id: str, account_id: str | None, role_id: str, billing_enabled: bool = True) -> RBACRole:
+ def get(
+ tenant_id: str,
+ account_id: str | None,
+ role_id: str,
+ billing_enabled: bool = True,
+ *,
+ language: str | None = None,
+ ) -> RBACRole:
data = _inner_call(
"GET",
f"{_INNER_PREFIX}/roles/item",
tenant_id=tenant_id,
account_id=account_id,
params={"id": role_id, "billing_enabled": billing_enabled},
+ language=language,
)
return RBACRole.model_validate(data or {})
@staticmethod
- def create(tenant_id: str, account_id: str | None, payload: RoleMutation) -> RBACRole:
+ def create(
+ tenant_id: str, account_id: str | None, payload: RoleMutation, *, language: str | None = None
+ ) -> RBACRole:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/roles",
tenant_id=tenant_id,
account_id=account_id,
json=payload.model_dump(mode="json"),
+ language=language,
)
return RBACRole.model_validate(data or {})
@staticmethod
- def update(tenant_id: str, account_id: str | None, role_id: str, payload: RoleMutation) -> RBACRole:
+ def update(
+ tenant_id: str, account_id: str | None, role_id: str, payload: RoleMutation, *, language: str | None = None
+ ) -> RBACRole:
data = _inner_call(
"PUT",
f"{_INNER_PREFIX}/roles/item",
@@ -1388,21 +549,30 @@ class RBACService:
account_id=account_id,
params={"id": role_id},
json=payload.model_dump(mode="json"),
+ language=language,
)
return RBACRole.model_validate(data or {})
@staticmethod
- def delete(tenant_id: str, account_id: str | None, role_id: str) -> None:
+ def delete(tenant_id: str, account_id: str | None, role_id: str, *, language: str | None = None) -> None:
_inner_call(
"DELETE",
f"{_INNER_PREFIX}/roles/item",
tenant_id=tenant_id,
account_id=account_id,
params={"id": role_id},
+ language=language,
)
@staticmethod
- def copy(tenant_id: str, account_id: str | None, role_id: str, copy_member: bool = True) -> RBACRole:
+ def copy(
+ tenant_id: str,
+ account_id: str | None,
+ role_id: str,
+ copy_member: bool = True,
+ *,
+ language: str | None = None,
+ ) -> RBACRole:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/roles/copy",
@@ -1410,6 +580,7 @@ class RBACService:
account_id=account_id,
json={"copy_member": copy_member},
params={"id": role_id},
+ language=language,
)
return RBACRole.model_validate(data or {})
@@ -1421,6 +592,7 @@ class RBACService:
role_id: str,
*,
options: ListOption | None = None,
+ language: str | None = None,
) -> Paginated[RBACRoleAccount]:
params = (options or ListOption()).to_params({"role_id": role_id})
data = _inner_call(
@@ -1429,6 +601,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
params=params,
+ language=language,
)
data = data or {}
return Paginated[RBACRoleAccount](
@@ -1447,6 +620,7 @@ class RBACService:
*,
resource_type: RBACResourceType | str | None = None,
options: ListOption | None = None,
+ language: str | None = None,
) -> Paginated[AccessPolicy]:
extra: dict[str, Any] = {}
if resource_type is not None:
@@ -1460,6 +634,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
params=params or None,
+ language=language,
)
data = data or {}
return Paginated[AccessPolicy](
@@ -1468,24 +643,28 @@ class RBACService:
)
@staticmethod
- def get(tenant_id: str, account_id: str | None, policy_id: str) -> AccessPolicy:
+ def get(tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None) -> AccessPolicy:
data = _inner_call(
"GET",
f"{_INNER_PREFIX}/access-policies/item",
tenant_id=tenant_id,
account_id=account_id,
params={"id": policy_id},
+ language=language,
)
return AccessPolicy.model_validate(data or {})
@staticmethod
- def create(tenant_id: str, account_id: str | None, payload: AccessPolicyCreate) -> AccessPolicy:
+ def create(
+ tenant_id: str, account_id: str | None, payload: AccessPolicyCreate, *, language: str | None = None
+ ) -> AccessPolicy:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/access-policies",
tenant_id=tenant_id,
account_id=account_id,
json=payload.model_dump(mode="json"),
+ language=language,
)
return AccessPolicy.model_validate(data or {})
@@ -1495,6 +674,8 @@ class RBACService:
account_id: str | None,
policy_id: str,
payload: AccessPolicyUpdate,
+ *,
+ language: str | None = None,
) -> AccessPolicy:
data = _inner_call(
"PUT",
@@ -1503,28 +684,33 @@ class RBACService:
account_id=account_id,
params={"id": policy_id},
json=payload.model_dump(mode="json"),
+ language=language,
)
return AccessPolicy.model_validate(data or {})
@staticmethod
- def copy(tenant_id: str, account_id: str | None, policy_id: str) -> AccessPolicy:
+ def copy(
+ tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> AccessPolicy:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/access-policies/copy",
tenant_id=tenant_id,
account_id=account_id,
params={"id": policy_id},
+ language=language,
)
return AccessPolicy.model_validate(data or {})
@staticmethod
- def delete(tenant_id: str, account_id: str | None, policy_id: str) -> None:
+ def delete(tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None) -> None:
_inner_call(
"DELETE",
f"{_INNER_PREFIX}/access-policies/item",
tenant_id=tenant_id,
account_id=account_id,
params={"id": policy_id},
+ language=language,
)
@staticmethod
@@ -1534,6 +720,7 @@ class RBACService:
*,
resource_type: RBACResourceType | str,
resource_id: str,
+ language: str | None = None,
) -> Sequence[AccessPolicyMemberBinding]:
params = _resource_id_params(resource_type, resource_id)
data = _inner_call(
@@ -1542,6 +729,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
params=params,
+ language=language,
)
items: list[Any] = []
if isinstance(data, dict):
@@ -1553,24 +741,30 @@ class RBACService:
# ------------------------------------------------------------------
class AccessPolicyBindings:
@staticmethod
- def lock(tenant_id: str, account_id: str | None, binding_id: str) -> AccessPolicyBindingState:
+ def lock(
+ tenant_id: str, account_id: str | None, binding_id: str, *, language: str | None = None
+ ) -> AccessPolicyBindingState:
data = _inner_call(
"PUT",
f"{_INNER_PREFIX}/access-policy-bindings/lock",
tenant_id=tenant_id,
account_id=account_id,
json={"binding_id": binding_id},
+ language=language,
)
return AccessPolicyBindingState.model_validate(data or {})
@staticmethod
- def unlock(tenant_id: str, account_id: str | None, binding_id: str) -> AccessPolicyBindingState:
+ def unlock(
+ tenant_id: str, account_id: str | None, binding_id: str, *, language: str | None = None
+ ) -> AccessPolicyBindingState:
data = _inner_call(
"PUT",
f"{_INNER_PREFIX}/access-policy-bindings/unlock",
tenant_id=tenant_id,
account_id=account_id,
json={"binding_id": binding_id},
+ language=language,
)
return AccessPolicyBindingState.model_validate(data or {})
@@ -1583,6 +777,8 @@ class RBACService:
tenant_id: str,
account_id: str | None,
resources: Sequence[ResourceWhitelistConfigResource],
+ *,
+ language: str | None = None,
) -> ResourceWhitelistConfigsResponse:
data = _inner_call(
"POST",
@@ -1590,6 +786,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
json={"resources": [resource.model_dump(mode="json") for resource in resources]},
+ language=language,
)
return ResourceWhitelistConfigsResponse.model_validate(data or {})
@@ -1598,18 +795,10 @@ class RBACService:
# ------------------------------------------------------------------
class AppAccess:
@staticmethod
- def whitelist_resources(tenant_id: str, account_id: str | None) -> ResourceWhitelistResources:
- return _APP_ACCESS.whitelist_resources(tenant_id, account_id)
-
- @staticmethod
- def user_access_policies(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- *,
- options: ListOption | None = None,
- ) -> ResourceUserAccessPoliciesResponse:
- return _APP_ACCESS.user_access_policies(tenant_id, account_id, app_id, options=options)
+ def whitelist_resources(
+ tenant_id: str, account_id: str | None, *, language: str | None = None
+ ) -> ResourceWhitelistResources:
+ return _APP_ACCESS.whitelist_resources(tenant_id, account_id, language=language)
@staticmethod
def replace_user_access_policies(
@@ -1618,22 +807,18 @@ class RBACService:
app_id: str,
target_account_id: str | None,
payload: ReplaceUserAccessPolicies,
+ *,
+ language: str | None = None,
) -> ReplaceUserAccessPoliciesResponse:
- return _APP_ACCESS.replace_user_access_policies(tenant_id, account_id, app_id, target_account_id, payload)
-
- @staticmethod
- def whitelist(tenant_id: str, account_id: str | None, app_id: str) -> ResourceWhitelist:
- return _APP_ACCESS.whitelist(tenant_id, account_id, app_id)
-
- @staticmethod
- def whitelist_config(tenant_id: str, account_id: str | None, app_id: str) -> ResourceWhitelistConfig:
- return _APP_ACCESS.whitelist_config(tenant_id, account_id, app_id)
+ return _APP_ACCESS.replace_user_access_policies(
+ tenant_id, account_id, app_id, target_account_id, payload, language=language
+ )
@staticmethod
def legacy_whitelist_config(
- tenant_id: str, account_id: str | None, app_id: str
- ) -> _LegacyResourceWhitelistConfig:
- return _APP_ACCESS.legacy_whitelist_config(tenant_id, account_id, app_id)
+ tenant_id: str, account_id: str | None, app_id: str, *, language: str | None = None
+ ) -> _ResourceWhitelistConfigSnapshot:
+ return _APP_ACCESS.legacy_whitelist_config(tenant_id, account_id, app_id, language=language)
@staticmethod
def replace_whitelist(
@@ -1641,86 +826,30 @@ class RBACService:
account_id: str | None,
app_id: str,
payload: ReplaceMemberBindings,
+ *,
+ language: str | None = None,
) -> ResourceWhitelist:
- return _APP_ACCESS.replace_whitelist(tenant_id, account_id, app_id, payload)
+ return _APP_ACCESS.replace_whitelist(tenant_id, account_id, app_id, payload, language=language)
@staticmethod
def append_whitelist_members_batch(
tenant_id: str,
account_id: str | None,
data: Sequence[AppendAppWhitelistMembersBatchItem],
+ *,
+ language: str | None = None,
) -> None:
- _APP_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data)
-
- @staticmethod
- def matrix(tenant_id: str, account_id: str | None, app_id: str) -> AppAccessMatrix:
- return _APP_ACCESS.matrix(tenant_id, account_id, app_id)
-
- @staticmethod
- def list_role_bindings(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _APP_ACCESS.list_role_bindings(tenant_id, account_id, app_id, policy_id)
-
- @staticmethod
- def replace_role_bindings(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _APP_ACCESS.replace_role_bindings(tenant_id, account_id, app_id, policy_id, payload)
-
- @staticmethod
- def list_member_bindings(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _APP_ACCESS.list_member_bindings(tenant_id, account_id, app_id, policy_id)
-
- @staticmethod
- def delete_member_bindings(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- policy_id: str,
- payload: DeleteMemberBindings,
- ) -> None:
- _APP_ACCESS.delete_member_bindings(tenant_id, account_id, app_id, policy_id, payload)
-
- @staticmethod
- def replace_bindings(
- tenant_id: str,
- account_id: str | None,
- app_id: str,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _APP_ACCESS.replace_bindings(tenant_id, account_id, app_id, policy_id, payload)
+ _APP_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data, language=language)
# ------------------------------------------------------------------
# Per-dataset access (screenshot 1: Knowledge Base Access Config).
# ------------------------------------------------------------------
class DatasetAccess:
@staticmethod
- def whitelist_resources(tenant_id: str, account_id: str | None) -> ResourceWhitelistResources:
- return _DATASET_ACCESS.whitelist_resources(tenant_id, account_id)
-
- @staticmethod
- def user_access_policies(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- *,
- options: ListOption | None = None,
- ) -> ResourceUserAccessPoliciesResponse:
- return _DATASET_ACCESS.user_access_policies(tenant_id, account_id, dataset_id, options=options)
+ def whitelist_resources(
+ tenant_id: str, account_id: str | None, *, language: str | None = None
+ ) -> ResourceWhitelistResources:
+ return _DATASET_ACCESS.whitelist_resources(tenant_id, account_id, language=language)
@staticmethod
def replace_user_access_policies(
@@ -1729,24 +858,18 @@ class RBACService:
dataset_id: str,
target_account_id: str | None,
payload: ReplaceUserAccessPolicies,
+ *,
+ language: str | None = None,
) -> ReplaceUserAccessPoliciesResponse:
return _DATASET_ACCESS.replace_user_access_policies(
- tenant_id, account_id, dataset_id, target_account_id, payload
+ tenant_id, account_id, dataset_id, target_account_id, payload, language=language
)
- @staticmethod
- def whitelist(tenant_id: str, account_id: str | None, dataset_id: str) -> ResourceWhitelist:
- return _DATASET_ACCESS.whitelist(tenant_id, account_id, dataset_id)
-
- @staticmethod
- def whitelist_config(tenant_id: str, account_id: str | None, dataset_id: str) -> ResourceWhitelistConfig:
- return _DATASET_ACCESS.whitelist_config(tenant_id, account_id, dataset_id)
-
@staticmethod
def legacy_whitelist_config(
- tenant_id: str, account_id: str | None, dataset_id: str
- ) -> _LegacyResourceWhitelistConfig:
- return _DATASET_ACCESS.legacy_whitelist_config(tenant_id, account_id, dataset_id)
+ tenant_id: str, account_id: str | None, dataset_id: str, *, language: str | None = None
+ ) -> _ResourceWhitelistConfigSnapshot:
+ return _DATASET_ACCESS.legacy_whitelist_config(tenant_id, account_id, dataset_id, language=language)
@staticmethod
def replace_whitelist(
@@ -1754,83 +877,27 @@ class RBACService:
account_id: str | None,
dataset_id: str,
payload: ReplaceMemberBindings,
+ *,
+ language: str | None = None,
) -> ResourceWhitelist:
- return _DATASET_ACCESS.replace_whitelist(tenant_id, account_id, dataset_id, payload)
+ return _DATASET_ACCESS.replace_whitelist(tenant_id, account_id, dataset_id, payload, language=language)
@staticmethod
def append_whitelist_members_batch(
tenant_id: str,
account_id: str | None,
data: Sequence[AppendDatasetWhitelistMembersBatchItem],
+ *,
+ language: str | None = None,
) -> None:
- _DATASET_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data)
-
- @staticmethod
- def matrix(tenant_id: str, account_id: str | None, dataset_id: str) -> DatasetAccessMatrix:
- return _DATASET_ACCESS.matrix(tenant_id, account_id, dataset_id)
-
- @staticmethod
- def list_role_bindings(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _DATASET_ACCESS.list_role_bindings(tenant_id, account_id, dataset_id, policy_id)
-
- @staticmethod
- def replace_role_bindings(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _DATASET_ACCESS.replace_role_bindings(tenant_id, account_id, dataset_id, policy_id, payload)
-
- @staticmethod
- def list_member_bindings(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _DATASET_ACCESS.list_member_bindings(tenant_id, account_id, dataset_id, policy_id)
-
- @staticmethod
- def delete_member_bindings(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- policy_id: str,
- payload: DeleteMemberBindings,
- ) -> None:
- _DATASET_ACCESS.delete_member_bindings(tenant_id, account_id, dataset_id, policy_id, payload)
-
- @staticmethod
- def replace_bindings(
- tenant_id: str,
- account_id: str | None,
- dataset_id: str,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _DATASET_ACCESS.replace_bindings(tenant_id, account_id, dataset_id, policy_id, payload)
+ _DATASET_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data, language=language)
class AgentAccess:
@staticmethod
- def whitelist_resources(tenant_id: str, account_id: str | None) -> ResourceWhitelistResources:
- return _AGENT_ACCESS.whitelist_resources(tenant_id, account_id)
-
- @staticmethod
- def user_access_policies(
- tenant_id: str,
- account_id: str | None,
- agent_id: str,
- *,
- options: ListOption | None = None,
- ) -> ResourceUserAccessPoliciesResponse:
- return _AGENT_ACCESS.user_access_policies(tenant_id, account_id, agent_id, options=options)
+ def whitelist_resources(
+ tenant_id: str, account_id: str | None, *, language: str | None = None
+ ) -> ResourceWhitelistResources:
+ return _AGENT_ACCESS.whitelist_resources(tenant_id, account_id, language=language)
@staticmethod
def replace_user_access_policies(
@@ -1839,24 +906,18 @@ class RBACService:
agent_id: str,
target_account_id: str | None,
payload: ReplaceUserAccessPolicies,
+ *,
+ language: str | None = None,
) -> ReplaceUserAccessPoliciesResponse:
return _AGENT_ACCESS.replace_user_access_policies(
- tenant_id, account_id, agent_id, target_account_id, payload
+ tenant_id, account_id, agent_id, target_account_id, payload, language=language
)
- @staticmethod
- def whitelist(tenant_id: str, account_id: str | None, agent_id: str) -> ResourceWhitelist:
- return _AGENT_ACCESS.whitelist(tenant_id, account_id, agent_id)
-
- @staticmethod
- def whitelist_config(tenant_id: str, account_id: str | None, agent_id: str) -> ResourceWhitelistConfig:
- return _AGENT_ACCESS.whitelist_config(tenant_id, account_id, agent_id)
-
@staticmethod
def legacy_whitelist_config(
- tenant_id: str, account_id: str | None, agent_id: str
- ) -> _LegacyResourceWhitelistConfig:
- return _AGENT_ACCESS.legacy_whitelist_config(tenant_id, account_id, agent_id)
+ tenant_id: str, account_id: str | None, agent_id: str, *, language: str | None = None
+ ) -> _ResourceWhitelistConfigSnapshot:
+ return _AGENT_ACCESS.legacy_whitelist_config(tenant_id, account_id, agent_id, language=language)
@staticmethod
def replace_whitelist(
@@ -1864,231 +925,45 @@ class RBACService:
account_id: str | None,
agent_id: str,
payload: ReplaceMemberBindings,
+ *,
+ language: str | None = None,
) -> ResourceWhitelist:
- return _AGENT_ACCESS.replace_whitelist(tenant_id, account_id, agent_id, payload)
+ return _AGENT_ACCESS.replace_whitelist(tenant_id, account_id, agent_id, payload, language=language)
@staticmethod
def append_whitelist_members_batch(
tenant_id: str,
account_id: str | None,
data: Sequence[AppendAgentWhitelistMembersBatchItem],
+ *,
+ language: str | None = None,
) -> None:
- _AGENT_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data)
-
- @staticmethod
- def matrix(tenant_id: str, account_id: str | None, agent_id: str) -> AgentAccessMatrix:
- return _AGENT_ACCESS.matrix(tenant_id, account_id, agent_id)
+ _AGENT_ACCESS.append_whitelist_members_batch(tenant_id, account_id, data, language=language)
- @staticmethod
- def list_role_bindings(
- tenant_id: str,
- account_id: str | None,
- agent_id: str,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _AGENT_ACCESS.list_role_bindings(tenant_id, account_id, agent_id, policy_id)
-
- @staticmethod
- def replace_role_bindings(
- tenant_id: str,
- account_id: str | None,
- agent_id: str,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _AGENT_ACCESS.replace_role_bindings(tenant_id, account_id, agent_id, policy_id, payload)
-
- @staticmethod
- def list_member_bindings(
- tenant_id: str,
- account_id: str | None,
- agent_id: str,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _AGENT_ACCESS.list_member_bindings(tenant_id, account_id, agent_id, policy_id)
-
- @staticmethod
- def delete_member_bindings(
- tenant_id: str,
- account_id: str | None,
- agent_id: str,
- policy_id: str,
- payload: DeleteMemberBindings,
- ) -> None:
- _AGENT_ACCESS.delete_member_bindings(tenant_id, account_id, agent_id, policy_id, payload)
+ class MemberRoles:
+ """Remote member-role bindings. Local membership belongs to WorkspaceRepository."""
@staticmethod
- def replace_bindings(
+ def get(
tenant_id: str,
account_id: str | None,
- agent_id: str,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _AGENT_ACCESS.replace_bindings(tenant_id, account_id, agent_id, policy_id, payload)
-
- # ------------------------------------------------------------------
- # Workspace-level access (screenshot 2: Settings > Access Rules).
- # ------------------------------------------------------------------
- class WorkspaceAccess:
- @staticmethod
- def app_matrix(
- tenant_id: str,
- account_id: str | None = None,
- *,
- options: ListOption | None = None,
- ) -> WorkspaceAccessMatrix:
- return _WORKSPACE_APP_ACCESS.matrix(tenant_id, account_id, options=options)
-
- @staticmethod
- def dataset_matrix(
- tenant_id: str,
- account_id: str | None = None,
- *,
- options: ListOption | None = None,
- ) -> WorkspaceAccessMatrix:
- return _WORKSPACE_DATASET_ACCESS.matrix(tenant_id, account_id, options=options)
-
- @staticmethod
- def agent_matrix(
- tenant_id: str,
- account_id: str | None = None,
+ member_account_id: str,
*,
- options: ListOption | None = None,
- ) -> WorkspaceAccessMatrix:
- return _WORKSPACE_AGENT_ACCESS.matrix(tenant_id, account_id, options=options)
-
- @staticmethod
- def list_app_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_APP_ACCESS.list_role_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_app_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_APP_ACCESS.replace_role_bindings(tenant_id, account_id, policy_id, payload)
-
- @staticmethod
- def list_app_member_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _WORKSPACE_APP_ACCESS.list_member_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_app_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _WORKSPACE_APP_ACCESS.replace_bindings(tenant_id, account_id, policy_id, payload)
-
- @staticmethod
- def list_dataset_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_DATASET_ACCESS.list_role_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_dataset_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_DATASET_ACCESS.replace_role_bindings(tenant_id, account_id, policy_id, payload)
-
- @staticmethod
- def list_dataset_member_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _WORKSPACE_DATASET_ACCESS.list_member_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_dataset_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _WORKSPACE_DATASET_ACCESS.replace_bindings(tenant_id, account_id, policy_id, payload)
-
- @staticmethod
- def list_agent_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_AGENT_ACCESS.list_role_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_agent_role_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceRoleBindings,
- ) -> RoleBindingsResponse:
- return _WORKSPACE_AGENT_ACCESS.replace_role_bindings(tenant_id, account_id, policy_id, payload)
-
- @staticmethod
- def list_agent_member_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- ) -> MemberBindingsResponse:
- return _WORKSPACE_AGENT_ACCESS.list_member_bindings(tenant_id, account_id, policy_id)
-
- @staticmethod
- def replace_agent_bindings(
- tenant_id: str,
- account_id: str | None,
- policy_id: str,
- payload: ReplaceBindings,
- ) -> AccessMatrixItem:
- return _WORKSPACE_AGENT_ACCESS.replace_bindings(tenant_id, account_id, policy_id, payload)
-
- class MemberRoles:
- @staticmethod
- def get(
- tenant_id: str, account_id: str | None, member_account_id: str, *, session: Session
+ language: str | None = None,
) -> MemberRolesResponse:
- if dify_config.RBAC_ENABLED:
- data = _inner_call(
- "GET",
- f"{_INNER_PREFIX}/members/rbac-roles",
- tenant_id=tenant_id,
- account_id=account_id,
- params={"account_id": member_account_id},
- )
- rst = MemberRolesResponse.model_validate(data or {})
- return rst
- else:
- role = session.scalar(
- select(TenantAccountJoin.role).where(
- TenantAccountJoin.tenant_id == tenant_id,
- TenantAccountJoin.account_id == member_account_id,
- )
- )
- return _legacy_member_roles_response(tenant_id, member_account_id, role)
+ data = _inner_call(
+ "GET",
+ f"{_INNER_PREFIX}/members/rbac-roles",
+ tenant_id=tenant_id,
+ account_id=account_id,
+ params={"account_id": member_account_id},
+ language=language,
+ )
+ return MemberRolesResponse.model_validate(data or {})
@staticmethod
def batch_get(
- tenant_id: str,
- account_id: str | None,
- member_account_ids: list[str],
+ tenant_id: str, account_id: str | None, member_account_ids: list[str], *, language: str | None = None
) -> list[MemberRolesResponse]:
data = _inner_call(
"POST",
@@ -2096,6 +971,7 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
json={"member_ids": member_account_ids},
+ language=language,
)
items = []
if isinstance(data, dict):
@@ -2113,37 +989,8 @@ class RBACService:
member_account_id: str,
role_ids: list[str],
*,
- session: Session,
+ language: str | None = None,
) -> MemberRolesResponse:
- if not dify_config.RBAC_ENABLED:
- if len(role_ids) != 1:
- raise ValueError("Legacy workspace member role update requires exactly one role.")
-
- tenant_role = TenantAccountRole(role_ids[0])
- target_member_join = session.scalar(
- select(TenantAccountJoin).where(
- TenantAccountJoin.tenant_id == tenant_id,
- TenantAccountJoin.account_id == member_account_id,
- )
- )
- if not target_member_join:
- raise ValueError("Member not in tenant.")
-
- if tenant_role == TenantAccountRole.OWNER:
- current_owner_join = session.scalar(
- select(TenantAccountJoin).where(
- TenantAccountJoin.tenant_id == tenant_id,
- TenantAccountJoin.role == TenantAccountRole.OWNER,
- )
- )
- if current_owner_join and current_owner_join.account_id != member_account_id:
- current_owner_join.role = TenantAccountRole.NORMAL
-
- target_member_join.role = tenant_role
- session.commit()
-
- return _legacy_member_roles_response(tenant_id, member_account_id, tenant_role)
-
data = _inner_call(
"PUT",
f"{_INNER_PREFIX}/members/rbac-roles",
@@ -2151,38 +998,46 @@ class RBACService:
account_id=account_id,
params={"account_id": member_account_id},
json={"role_ids": role_ids},
+ language=language,
)
return MemberRolesResponse.model_validate(data or {})
@staticmethod
- def delete_rbac_bindings(tenant_id: str, account_id: str):
+ def delete_rbac_bindings(tenant_id: str, account_id: str, *, language: str | None = None):
data = _inner_call(
"DELETE",
f"{_INNER_PREFIX}/members/rbac-bindings",
tenant_id=tenant_id,
account_id=account_id,
params={"account_id": account_id},
+ language=language,
)
return data
class Migrations:
@staticmethod
- def migrate_agent_manage_roles(tenant_id: str, *, apply: bool) -> LegacyAgentMigrationReport:
+ def migrate_agent_manage_roles(
+ tenant_id: str, *, apply: bool, language: str | None = None
+ ) -> AgentMigrationReport:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/migrations/agent-manage-roles",
tenant_id=tenant_id,
json={"apply": apply},
+ language=language,
)
- return LegacyAgentMigrationReport.model_validate(data or {})
+ return AgentMigrationReport.model_validate(data or {})
@staticmethod
- def list_configured_agent_ids(tenant_id: str, agent_ids: list[str]) -> list[str]:
+ def list_configured_agent_ids(
+ tenant_id: str, agent_ids: list[str], *, language: str | None = None
+ ) -> list[str]:
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/migrations/agent-access-state",
tenant_id=tenant_id,
json={"agent_ids": agent_ids},
+ language=language,
)
return ConfiguredAgentIDs.model_validate(data or {}).configured_agent_ids
@@ -2197,6 +1052,7 @@ class RBACService:
scene: str,
resource_type: str | None = None,
resource_id: str | None = None,
+ language: str | None = None,
) -> bool:
"""Return ``True`` if the account is allowed, ``False`` otherwise."""
if not dify_config.RBAC_ENABLED:
@@ -2218,30 +1074,24 @@ class RBACService:
tenant_id=tenant_id,
account_id=account_id,
json=payload,
+ language=language,
)
return bool(data.get("allowed", False))
class AppPermissions:
@staticmethod
def batch_get(
- tenant_id: str,
- account_id: str | None,
- app_ids: list[str],
- *,
- session: Session,
+ tenant_id: str, account_id: str | None, app_ids: list[str], *, language: str | None = None
) -> dict[str, list[str]]:
if not app_ids:
return {}
- if not dify_config.RBAC_ENABLED:
- return _legacy_resource_permission_keys_batch(
- tenant_id, account_id, app_ids, RBACResourceType.APP, session=session
- )
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/apps/permission-keys/batch",
tenant_id=tenant_id,
account_id=account_id,
json={"app_ids": app_ids},
+ language=language,
)
return _parse_resource_permission_keys_batch(data, resource_id_key="app_id")
@@ -2252,20 +1102,17 @@ class RBACService:
account_id: str | None,
dataset_ids: list[str],
*,
- session: Session,
+ language: str | None = None,
) -> dict[str, list[str]]:
if not dataset_ids:
return {}
- if not dify_config.RBAC_ENABLED:
- return _legacy_resource_permission_keys_batch(
- tenant_id, account_id, dataset_ids, RBACResourceType.DATASET, session=session
- )
data = _inner_call(
"POST",
f"{_INNER_PREFIX}/datasets/permission-keys/batch",
tenant_id=tenant_id,
account_id=account_id,
json={"dataset_ids": dataset_ids},
+ language=language,
)
return _parse_resource_permission_keys_batch(data, resource_id_key="dataset_id")
@@ -2278,11 +1125,8 @@ class RBACService:
app_id: str | None = None,
dataset_id: str | None = None,
agent_id: str | None = None,
- session: Session,
+ language: str | None = None,
) -> MyPermissionsResponse:
- if not dify_config.RBAC_ENABLED:
- return _legacy_my_permissions(tenant_id, account_id, session=session)
-
data = _inner_call(
"GET",
f"{_INNER_PREFIX}/my-permissions",
@@ -2298,6 +1142,7 @@ class RBACService:
if v is not None
}
or None,
+ language=language,
)
return MyPermissionsResponse.model_validate(data or {})
diff --git a/api/services/entities/app_entities.py b/api/services/entities/app_entities.py
index 5d65893bd83..d67ed4f3433 100644
--- a/api/services/entities/app_entities.py
+++ b/api/services/entities/app_entities.py
@@ -176,6 +176,14 @@ class AppExportOptions:
version_id: UUID | None = None
+@dataclass(frozen=True, slots=True)
+class AppAgentBinding:
+ """Authorization binding materialized before the repository closes its Session."""
+
+ id: str
+ workflow_only: bool
+
+
@dataclass(frozen=True, slots=True)
class AppReference:
id: str
diff --git a/api/services/knowledge/dataset_service.py b/api/services/knowledge/dataset_service.py
index 8db28330d63..3923bd789d9 100644
--- a/api/services/knowledge/dataset_service.py
+++ b/api/services/knowledge/dataset_service.py
@@ -102,6 +102,7 @@ from services.knowledge.segments.application import (
validate_segment_values,
)
from services.rag_pipeline.rag_pipeline import RagPipelineService
+from services.rbac import contracts as rbac_contracts
from services.tag_application_service import TagTargetQuery
from tasks.add_document_to_index_task import add_document_to_index_task
from tasks.batch_clean_document_task import batch_clean_document_task
@@ -130,11 +131,11 @@ class AutoDisableLogsDict(TypedDict):
class DatasetService:
@staticmethod
- def _can_manage_all_datasets(tenant_id: str, account_id: str, *, session: Session) -> bool:
+ def _can_manage_all_datasets(tenant_id: str, account_id: str) -> bool:
if not dify_config.RBAC_ENABLED:
return False
- permissions = enterprise_rbac_service.RBACService.MyPermissions.get(tenant_id, account_id, session=session)
+ permissions = enterprise_rbac_service.RBACService.MyPermissions.get(tenant_id, account_id)
workspace_permission_keys = getattr(getattr(permissions, "workspace", None), "permission_keys", []) or []
return "dataset.create_and_management" in workspace_permission_keys
@@ -153,7 +154,7 @@ class DatasetService:
*,
tags: TagTargetQuery,
):
- """Return visible datasets for a tenant, using the injected session for auxiliary permission lookups."""
+ """Return visible datasets for a tenant using the injected read session."""
query = select(Dataset).where(Dataset.tenant_id == tenant_id).order_by(Dataset.created_at.desc(), Dataset.id)
if dify_config.RBAC_ENABLED and accessible_dataset_ids is not None:
@@ -179,9 +180,7 @@ class DatasetService:
return [], 0
else:
if dify_config.RBAC_ENABLED:
- can_manage_all_datasets = DatasetService._can_manage_all_datasets(
- str(tenant_id), str(user.id), session=session
- )
+ can_manage_all_datasets = DatasetService._can_manage_all_datasets(str(tenant_id), str(user.id))
should_show_all_datasets = include_all and can_manage_all_datasets
else:
should_show_all_datasets = user.current_role == TenantAccountRole.OWNER and include_all
@@ -384,7 +383,7 @@ class DatasetService:
enterprise_rbac_service.try_sync_creator_access_policy_member_bindings(
tenant_id,
account.id,
- enterprise_rbac_service.RBACResourceType.DATASET,
+ rbac_contracts.RBACResourceType.DATASET,
dataset.id,
)
return dataset
diff --git a/api/services/knowledge/datasets/adapters.py b/api/services/knowledge/datasets/adapters.py
index c23f453abf8..985373cbba3 100644
--- a/api/services/knowledge/datasets/adapters.py
+++ b/api/services/knowledge/datasets/adapters.py
@@ -28,6 +28,8 @@ from services.knowledge.datasets.application import (
)
from services.knowledge.entities.datasets import DatasetDetailRecord, DatasetPage
from services.knowledge.resource_scope import DatasetRef
+from services.rbac import contracts as rbac_contracts
+from services.rbac.members import MemberService
from services.tag_application_service import TagTargetQuery
@@ -80,17 +82,20 @@ def _status(document: Document, counts: tuple[int, int] | None = None) -> dict[s
class SQLAlchemyDatasetOperations:
def __init__(
- self, *, session_factory: sessionmaker[Session], tags: TagTargetQuery, app_queries: AppQueryService
+ self,
+ *,
+ session_factory: sessionmaker[Session],
+ tags: TagTargetQuery,
+ app_queries: AppQueryService,
+ members: MemberService,
) -> None:
self._sessions = session_factory
self._tags = tags
self._app_queries = app_queries
+ self._members_service = members
def visibility(self, context: RequestContext) -> DatasetVisibility:
- with self._sessions() as session:
- permissions = rbac_service.RBACService.MyPermissions.get(
- context.active_workspace_id, context.account_id, session=session
- )
+ permissions = self._members_service.permissions(context.active_workspace_id, context.account_id)
scope = (
rbac_service.RBACService.DatasetAccess.whitelist_resources(context.active_workspace_id, context.account_id)
if dify_config.RBAC_ENABLED
@@ -162,11 +167,10 @@ class SQLAlchemyDatasetOperations:
"limit": limit,
}
- @staticmethod
- def _detail(session: Session, context: RequestContext, dataset: Dataset) -> DatasetDetailRecord:
+ def _detail(self, session: Session, context: RequestContext, dataset: Dataset) -> DatasetDetailRecord:
result = load_dataset_detail(dataset, session=session)
- permissions = rbac_service.RBACService.DatasetPermissions.batch_get(
- context.active_workspace_id, context.account_id, [dataset.id], session=session
+ permissions = self._members_service.resource_permissions(
+ context.active_workspace_id, context.account_id, rbac_contracts.RBACResourceType.DATASET, [dataset.id]
)
result["permission_keys"] = permissions.get(dataset.id, [])
return result
@@ -175,8 +179,8 @@ class SQLAlchemyDatasetOperations:
with self._sessions() as session:
dataset = require_dataset(session, ref)
result = load_dataset_detail(dataset, session=session)
- permissions = rbac_service.RBACService.MyPermissions.get(
- context.active_workspace_id, context.account_id, dataset_id=ref.dataset_id, session=session
+ permissions = self._members_service.permissions(
+ context.active_workspace_id, context.account_id, dataset_id=ref.dataset_id
)
result["permission_keys"] = permissions.dataset.permission_keys_by_resource_ids([dataset.id]).get(
dataset.id, []
@@ -202,7 +206,7 @@ class SQLAlchemyDatasetOperations:
context.active_workspace_id,
context.account_id,
dataset_id,
- rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=False),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=False),
)
return result
diff --git a/api/services/knowledge/documents/adapters.py b/api/services/knowledge/documents/adapters.py
index 567cb2627b6..e61a702bcf0 100644
--- a/api/services/knowledge/documents/adapters.py
+++ b/api/services/knowledge/documents/adapters.py
@@ -59,6 +59,7 @@ from services.knowledge.entities.document_creation import DocumentCreationDatase
from services.knowledge.entities.knowledge_entities import KnowledgeConfig
from services.knowledge.resource_scope import DatasetRef, DocumentRef
from services.knowledge.summaries.adapters import SummaryIndexAdapter
+from services.rbac import contracts as rbac_contracts
from services.vector_space_admission_service import get_vector_space_admission_error_fields
from tasks.generate_summary_index_task import generate_summary_index_task
@@ -463,12 +464,12 @@ class SQLAlchemyDocumentOperations:
context.active_workspace_id,
context.account_id,
dataset_id,
- rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=False),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=False),
)
rbac_service.try_sync_creator_access_policy_member_bindings(
context.active_workspace_id,
context.account_id,
- rbac_service.RBACResourceType.DATASET,
+ rbac_contracts.RBACResourceType.DATASET,
dataset_id,
)
return result
diff --git a/api/services/knowledge/external/adapters.py b/api/services/knowledge/external/adapters.py
index 3add04e9425..e4bc85d624d 100644
--- a/api/services/knowledge/external/adapters.py
+++ b/api/services/knowledge/external/adapters.py
@@ -15,7 +15,6 @@ from repositories.knowledge.dataset_read_repository import (
get_external_api_bindings_batch,
get_external_api_dataset_bindings,
)
-from services.enterprise import rbac_service
from services.entities.external_knowledge_entities.external_knowledge_entities import ExternalDatasetCreatePayload
from services.hit_testing_service import HitTestingService
from services.knowledge.dataset_read_service import load_dataset_detail
@@ -24,11 +23,14 @@ from services.knowledge.entities.datasets import DatasetDetailRecord
from services.knowledge.external.application import ExternalTemplateNotFoundError
from services.knowledge.external.service import ExternalDatasetService
from services.knowledge.resource_scope import DatasetRef
+from services.rbac.contracts import RBACResourceType
+from services.rbac.members import MemberService
class SQLAlchemyExternalKnowledgeOperations:
- def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
+ def __init__(self, *, session_factory: sessionmaker[Session], members: MemberService) -> None:
self._sessions = session_factory
+ self._members = members
@staticmethod
def _template(session: Session, workspace_id: str, template_id: str) -> ExternalKnowledgeApis:
@@ -106,8 +108,8 @@ class SQLAlchemyExternalKnowledgeOperations:
dataset = ExternalDatasetService.create_external_dataset(
context.active_workspace_id, context.account_id, payload, session=session
)
- permissions = rbac_service.RBACService.DatasetPermissions.batch_get(
- context.active_workspace_id, context.account_id, [dataset.id], session=session
+ permissions = self._members.resource_permissions(
+ context.active_workspace_id, context.account_id, RBACResourceType.DATASET, [dataset.id]
)
result = load_dataset_detail(dataset, session=session)
result["permission_keys"] = permissions.get(dataset.id, [])
diff --git a/api/services/knowledge/external/service.py b/api/services/knowledge/external/service.py
index 8d7d5855800..722ebb2e752 100644
--- a/api/services/knowledge/external/service.py
+++ b/api/services/knowledge/external/service.py
@@ -27,6 +27,7 @@ from services.entities.external_knowledge_entities.external_knowledge_entities i
)
from services.errors.dataset import DatasetNameDuplicateError
from services.errors.knowledge_retrieval import ExternalKnowledgeRetrievalError
+from services.rbac import contracts as rbac_contracts
class ExternalDatasetService:
@@ -333,7 +334,7 @@ class ExternalDatasetService:
enterprise_rbac_service.try_sync_creator_access_policy_member_bindings(
tenant_id,
user_id,
- enterprise_rbac_service.RBACResourceType.DATASET,
+ rbac_contracts.RBACResourceType.DATASET,
dataset.id,
)
diff --git a/api/services/rbac/__init__.py b/api/services/rbac/__init__.py
new file mode 100644
index 00000000000..df94301dd97
--- /dev/null
+++ b/api/services/rbac/__init__.py
@@ -0,0 +1 @@
+"""Workspace RBAC contracts and application use cases."""
diff --git a/api/services/rbac/builtin.py b/api/services/rbac/builtin.py
new file mode 100644
index 00000000000..ab9e7ec723a
--- /dev/null
+++ b/api/services/rbac/builtin.py
@@ -0,0 +1,426 @@
+"""Permission projections for the built-in workspace roles."""
+
+from enums.account import TenantAccountRole
+from services.rbac.contracts import (
+ ListOption,
+ MemberRolesResponse,
+ MyPermissionsResponse,
+ Paginated,
+ Pagination,
+ RBACRole,
+ RBACRoleType,
+ ResourcePermissionSnapshot,
+ WorkspacePermissionSnapshot,
+)
+
+# Fallback permission snapshots for legacy Dify tenant roles when external RBAC is disabled.
+# Keep these keys aligned with langgenius/rbac's built-in workspace roles and access policies.
+_BUILTIN_WORKSPACE_OWNER_KEYS: list[str] = [
+ "skill.view",
+ "skill.edit",
+ "skill.publish",
+ "skill.delete",
+ "workspace.member.manage",
+ "workspace.role.manage",
+ "data_source.manage",
+ "api_extension.manage",
+ "customization.manage",
+ "plugin.install",
+ "plugin.plugin_preferences",
+ "plugin.model_config",
+ "plugin.delete",
+ "plugin.debug",
+ "credential.use",
+ "credential.create",
+ "credential.manage",
+ "app.acl.preview",
+ "app_library.access",
+ "app.create_and_management",
+ "app.tag.manage",
+ "dataset.acl.preview",
+ "dataset.create_and_management",
+ "dataset.tag.manage",
+ "dataset.external.connect",
+ "dataset.api_key.manage",
+ "snippets.create_and_modify",
+ "snippets.management",
+ "tool.manage",
+ "mcp.manage",
+ "agent.create",
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_WORKSPACE_ADMIN_KEYS: list[str] = [
+ "skill.view",
+ "skill.edit",
+ "skill.publish",
+ "skill.delete",
+ "workspace.member.manage",
+ "workspace.role.manage",
+ "data_source.manage",
+ "api_extension.manage",
+ "customization.manage",
+ "plugin.install",
+ "plugin.plugin_preferences",
+ "plugin.model_config",
+ "plugin.delete",
+ "plugin.debug",
+ "credential.use",
+ "credential.create",
+ "credential.manage",
+ "app_library.access",
+ "app.create_and_management",
+ "app.tag.manage",
+ "dataset.create_and_management",
+ "dataset.tag.manage",
+ "dataset.external.connect",
+ "dataset.api_key.manage",
+ "snippets.create_and_modify",
+ "snippets.management",
+ "tool.manage",
+ "mcp.manage",
+ "agent.create",
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_WORKSPACE_EDITOR_KEYS: list[str] = [
+ "skill.view",
+ "skill.edit",
+ "skill.publish",
+ "skill.delete",
+ "api_extension.manage",
+ "plugin.install",
+ "credential.use",
+ "app_library.access",
+ "app.create_and_management",
+ "app.tag.manage",
+ "dataset.create_and_management",
+ "dataset.tag.manage",
+ "dataset.external.connect",
+ "snippets.create_and_modify",
+ "tool.manage",
+ "agent.create",
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_WORKSPACE_NORMAL_KEYS: list[str] = [
+ "skill.view",
+ "api_extension.manage",
+ "plugin.install",
+ "credential.use",
+ "app_library.access",
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_WORKSPACE_DATASET_OPERATOR_KEYS: list[str] = [
+ "skill.view",
+ "plugin.install",
+ "dataset.create_and_management",
+ "dataset.external.connect",
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_APP_OWNER_KEYS: list[str] = [
+ "app.acl.preview",
+ "app.acl.view_layout",
+ "app.acl.test_and_run",
+ "app.acl.edit",
+ "app.acl.import_export_dsl",
+ "app.acl.delete",
+ "app.acl.release_and_version",
+ "app.acl.monitor",
+ "app.acl.access_config",
+ "app.acl.tracing_config",
+ "app.acl.log_and_annotation",
+ "app.acl.access_point_manage",
+ "app.acl.access_point_view",
+]
+
+_BUILTIN_APP_ADMIN_KEYS: list[str] = [
+ "app.acl.preview",
+ "app.acl.view_layout",
+ "app.acl.test_and_run",
+ "app.acl.edit",
+ "app.acl.import_export_dsl",
+ "app.acl.delete",
+ "app.acl.release_and_version",
+ "app.acl.monitor",
+ "app.acl.access_config",
+ "app.acl.access_config",
+ "app.acl.tracing_config",
+ "app.acl.log_and_annotation",
+ "app.acl.access_point_manage",
+ "app.acl.access_point_view",
+]
+
+_BUILTIN_APP_EDITOR_KEYS: list[str] = [
+ "app.acl.preview",
+ "app.acl.view_layout",
+ "app.acl.test_and_run",
+ "app.acl.edit",
+ "app.acl.import_export_dsl",
+ "app.acl.delete",
+ "app.acl.release_and_version",
+ "app.acl.monitor",
+ "app.acl.log_and_annotation",
+ "app.acl.access_config",
+ "app.acl.access_point_manage",
+ "app.acl.access_point_view",
+]
+
+_BUILTIN_APP_NORMAL_KEYS: list[str] = [
+ "app.acl.monitor",
+ "app.acl.access_point_view",
+]
+
+_BUILTIN_APP_DATASET_OPERATOR_KEYS: list[str] = [
+ "app.acl.access_point_view",
+]
+
+_BUILTIN_DATASET_OWNER_KEYS: list[str] = [
+ "dataset.acl.preview",
+ "dataset.acl.readonly",
+ "dataset.acl.edit",
+ "dataset.acl.import_export_dsl",
+ "dataset.acl.pipeline_test",
+ "dataset.acl.document_download",
+ "dataset.acl.retrieval_recall",
+ "dataset.acl.use",
+ "dataset.acl.delete_file",
+ "dataset.acl.pipeline_release",
+ "dataset.acl.delete",
+ "dataset.acl.access_config",
+ "dataset.api_key.manage",
+]
+
+_BUILTIN_DATASET_ADMIN_KEYS: list[str] = [
+ "dataset.acl.preview",
+ "dataset.acl.readonly",
+ "dataset.acl.edit",
+ "dataset.acl.import_export_dsl",
+ "dataset.acl.pipeline_test",
+ "dataset.acl.document_download",
+ "dataset.acl.retrieval_recall",
+ "dataset.acl.use",
+ "dataset.acl.delete_file",
+ "dataset.acl.pipeline_release",
+ "dataset.acl.delete",
+ "dataset.acl.access_config",
+ "dataset.api_key.manage",
+]
+
+_BUILTIN_DATASET_EDITOR_KEYS: list[str] = [
+ "dataset.acl.preview",
+ "dataset.acl.readonly",
+ "dataset.acl.edit",
+ "dataset.acl.import_export_dsl",
+ "dataset.acl.pipeline_test",
+ "dataset.acl.document_download",
+ "dataset.acl.retrieval_recall",
+ "dataset.acl.use",
+ "dataset.acl.delete_file",
+ "dataset.acl.pipeline_release",
+]
+
+_BUILTIN_DATASET_DATASET_OPERATOR_KEYS: list[str] = [
+ "dataset.acl.readonly",
+ "dataset.acl.edit",
+ "dataset.acl.import_export_dsl",
+ "dataset.acl.pipeline_test",
+ "dataset.acl.document_download",
+ "dataset.acl.retrieval_recall",
+ "dataset.acl.use",
+ "dataset.acl.delete_file",
+ "dataset.acl.pipeline_release",
+]
+
+_BUILTIN_AGENT_FULL_ACCESS_KEYS: list[str] = [
+ "agent.acl.preview",
+ "agent.acl.edit",
+ "agent.acl.test_and_run",
+ "agent.acl.release_and_version",
+ "agent.acl.access_point_view",
+ "agent.acl.access_point_manage",
+ "agent.acl.log_manage",
+ "agent.acl.monitor",
+ "agent.acl.access_config",
+ "agent.acl.import_export_dsl",
+ "agent.acl.delete",
+]
+
+_BUILTIN_AGENT_PREVIEW_KEYS: list[str] = [
+ "agent.acl.preview",
+ "agent.acl.access_point_view",
+]
+
+_BUILTIN_MY_PERMISSIONS: dict[TenantAccountRole, dict[str, list[str]]] = {
+ TenantAccountRole.OWNER: {
+ "workspace": _BUILTIN_WORKSPACE_OWNER_KEYS,
+ "app": _BUILTIN_APP_OWNER_KEYS,
+ "dataset": _BUILTIN_DATASET_OWNER_KEYS,
+ "agent": _BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ },
+ TenantAccountRole.ADMIN: {
+ "workspace": _BUILTIN_WORKSPACE_ADMIN_KEYS,
+ "app": _BUILTIN_APP_ADMIN_KEYS,
+ "dataset": _BUILTIN_DATASET_ADMIN_KEYS,
+ "agent": _BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ },
+ TenantAccountRole.EDITOR: {
+ "workspace": _BUILTIN_WORKSPACE_EDITOR_KEYS,
+ "app": _BUILTIN_APP_EDITOR_KEYS,
+ "dataset": _BUILTIN_DATASET_EDITOR_KEYS,
+ "agent": _BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ },
+ TenantAccountRole.NORMAL: {
+ "workspace": _BUILTIN_WORKSPACE_NORMAL_KEYS,
+ "app": _BUILTIN_APP_NORMAL_KEYS,
+ "agent": _BUILTIN_AGENT_PREVIEW_KEYS,
+ },
+ TenantAccountRole.DATASET_OPERATOR: {
+ "workspace": _BUILTIN_WORKSPACE_DATASET_OPERATOR_KEYS,
+ "app": _BUILTIN_APP_DATASET_OPERATOR_KEYS,
+ "dataset": _BUILTIN_DATASET_DATASET_OPERATOR_KEYS,
+ "agent": _BUILTIN_AGENT_PREVIEW_KEYS,
+ },
+}
+
+
+def builtin_role_permission_keys(role: TenantAccountRole) -> list[str]:
+ permissions = _BUILTIN_MY_PERMISSIONS.get(role, {})
+ return list(
+ dict.fromkeys(
+ [
+ *permissions.get("workspace", []),
+ *permissions.get("app", []),
+ *permissions.get("dataset", []),
+ *permissions.get("agent", []),
+ ]
+ )
+ )
+
+
+def builtin_member_roles(
+ tenant_id: str, member_account_id: str, role: TenantAccountRole | str | None
+) -> MemberRolesResponse:
+ if not role:
+ return MemberRolesResponse(account_id=member_account_id, roles=[])
+
+ tenant_role = TenantAccountRole(role)
+ role_value = tenant_role.value
+ return MemberRolesResponse(
+ account_id=member_account_id,
+ roles=[
+ RBACRole(
+ id=role_value,
+ name=role_value,
+ description="",
+ is_builtin=True,
+ type="",
+ permission_keys=builtin_role_permission_keys(tenant_role),
+ role_tag="owner" if tenant_role == TenantAccountRole.OWNER else role_value,
+ tenant_id=tenant_id,
+ )
+ ],
+ )
+
+
+def builtin_permissions(role: TenantAccountRole | str | None) -> MyPermissionsResponse:
+ try:
+ permissions = _BUILTIN_MY_PERMISSIONS.get(TenantAccountRole(role), {}) if role else {}
+ except ValueError:
+ permissions = {}
+ return MyPermissionsResponse(
+ workspace=WorkspacePermissionSnapshot(permission_keys=list(permissions.get("workspace", []))),
+ app=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("app", []))),
+ dataset=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("dataset", []))),
+ agent=ResourcePermissionSnapshot(default_permission_keys=list(permissions.get("agent", []))),
+ )
+
+
+_BUILTIN_ROLE_PERMISSION_KEYS: dict[str, list[str]] = {
+ # This is a compatibility projection from the pre-RBAC workspace roles into
+ # the 2.0 permission matrix documented in "权限整理2.0". It intentionally
+ # models the product-facing role surface for the new RBAC UI instead of the
+ # legacy backend's exact hard-authorization checks.
+ "owner": [
+ *_BUILTIN_WORKSPACE_OWNER_KEYS,
+ *_BUILTIN_APP_OWNER_KEYS,
+ *_BUILTIN_DATASET_OWNER_KEYS,
+ ],
+ "admin": [
+ *_BUILTIN_WORKSPACE_ADMIN_KEYS,
+ *_BUILTIN_APP_ADMIN_KEYS,
+ *_BUILTIN_DATASET_ADMIN_KEYS,
+ ],
+ "editor": [
+ *_BUILTIN_WORKSPACE_EDITOR_KEYS,
+ *_BUILTIN_APP_EDITOR_KEYS,
+ *_BUILTIN_DATASET_EDITOR_KEYS,
+ ],
+ "normal": [
+ *_BUILTIN_WORKSPACE_NORMAL_KEYS,
+ *_BUILTIN_APP_NORMAL_KEYS,
+ ],
+ "dataset_operator": [
+ *_BUILTIN_WORKSPACE_DATASET_OPERATOR_KEYS,
+ *_BUILTIN_DATASET_DATASET_OPERATOR_KEYS,
+ ],
+}
+
+
+def builtin_workspace_roles(
+ options: ListOption, *, include_owner: int, dataset_operator_enabled: bool
+) -> Paginated[RBACRole]:
+ """Return the built-in legacy workspace roles in the RBAC list shape.
+
+ This keeps the new `/rbac/roles` endpoint compatible with the original
+ Dify role model when enterprise RBAC is disabled.
+ """
+ legacy_roles = []
+ for role_name in ("owner", "admin", "editor", "normal", "dataset_operator"):
+ if not dataset_operator_enabled and role_name == "dataset_operator":
+ continue
+
+ legacy_roles.append(
+ RBACRole(
+ id=role_name,
+ tenant_id="",
+ type=RBACRoleType.WORKSPACE.value,
+ category="global_system_default",
+ name=role_name,
+ description="",
+ is_builtin=True,
+ permission_keys=list(_BUILTIN_ROLE_PERMISSION_KEYS[role_name]),
+ role_tag="owner" if role_name == "owner" else "",
+ )
+ )
+
+ if not include_owner:
+ legacy_roles = [r for r in legacy_roles if r.name != "owner"]
+
+ page_number = options.page_number if options.page_number is not None else 1
+ results_per_page = options.results_per_page if options.results_per_page is not None else len(legacy_roles)
+ reverse = options.reverse if options.reverse is not None else False
+
+ ordered_roles = list(reversed(legacy_roles)) if reverse else legacy_roles
+ start = max(page_number - 1, 0) * results_per_page
+ end = start + results_per_page
+ paged_roles = ordered_roles[start:end]
+ total_count = len(legacy_roles)
+ total_pages = (total_count + results_per_page - 1) // results_per_page if results_per_page > 0 else 0
+
+ return Paginated[RBACRole](
+ data=paged_roles,
+ pagination=Pagination(
+ total_count=total_count,
+ per_page=results_per_page,
+ current_page=page_number,
+ total_pages=total_pages,
+ ),
+ )
diff --git a/api/services/rbac/contracts.py b/api/services/rbac/contracts.py
new file mode 100644
index 00000000000..4a298d0a630
--- /dev/null
+++ b/api/services/rbac/contracts.py
@@ -0,0 +1,461 @@
+"""RBAC data shared by applications and gateways, independent of their implementations."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Any
+
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, field_validator
+
+
+class _RBACModel(BaseModel):
+ model_config = ConfigDict(populate_by_name=True, extra="ignore")
+
+
+class Pagination(_RBACModel):
+ total_count: int = 0
+ per_page: int = 0
+ current_page: int = 0
+ total_pages: int = 0
+
+
+class Paginated[T](_RBACModel):
+ data: list[T] = Field(default_factory=list)
+ pagination: Pagination | None = None
+
+
+class MembersInRole(_RBACModel):
+ account_id: str = ""
+ account_name: str = ""
+
+
+@dataclass(frozen=True)
+class _ResourceAccessRoute:
+ segment: str
+ id_param: str
+
+
+class RBACResourceType(StrEnum):
+ """Resource types understood by access policies."""
+
+ APP = "app"
+ DATASET = "dataset"
+ AGENT = "agent"
+
+ @property
+ def route(self) -> _ResourceAccessRoute:
+ routes = {
+ RBACResourceType.APP: _ResourceAccessRoute("apps", "app_id"),
+ RBACResourceType.DATASET: _ResourceAccessRoute("datasets", "dataset_id"),
+ RBACResourceType.AGENT: _ResourceAccessRoute("agents", "agent_id"),
+ }
+ return routes[self]
+
+
+class RBACRoleType(StrEnum):
+ """The only concrete role type after the access-policy refactor."""
+
+ WORKSPACE = "workspace"
+
+
+class PermissionCatalogItem(_RBACModel):
+ key: str
+ name: str
+ description: str = ""
+
+
+class PermissionCatalogGroup(_RBACModel):
+ group_key: str
+ group_name: str
+ description: str = ""
+ permissions: list[PermissionCatalogItem] = Field(default_factory=list)
+
+
+class PermissionCatalogResponse(_RBACModel):
+ groups: list[PermissionCatalogGroup] = Field(default_factory=list)
+
+
+class RBACRole(_RBACModel):
+ id: str
+ tenant_id: str | None = None
+ type: str
+ category: str = ""
+ name: str
+ description: str = ""
+ is_builtin: bool = False
+ permission_keys: list[str] = Field(default_factory=list)
+ role_tag: str = ""
+
+ @field_validator("permission_keys", mode="before")
+ @classmethod
+ def _coerce_permission_keys(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class RBACRoleAccount(_RBACModel):
+ account_id: str
+ account_name: str = ""
+ email: str = ""
+ avatar: str = ""
+
+
+class ResourcePermissionKeys(_RBACModel):
+ resource_id: str
+ permission_keys: list[str] = Field(default_factory=list)
+
+
+class AccessPolicy(_RBACModel):
+ id: str
+ tenant_id: str = ""
+ resource_type: str
+ policy_key: str = ""
+ name: str
+ description: str = ""
+ permission_keys: list[str] = Field(default_factory=list)
+ is_builtin: bool = False
+ category: str = ""
+ created_at: int = 0
+ updated_at: int = 0
+
+ @field_validator("permission_keys", mode="before")
+ @classmethod
+ def _coerce_permission_keys(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class AccessPolicyRoleBinding(_RBACModel):
+ id: str
+ tenant_id: str = ""
+ access_policy_id: str
+ resource_type: str
+ resource_id: str = ""
+ role_id: str
+ role_name: str = ""
+ created_at: int = 0
+
+
+class AccessPolicyMemberBinding(_RBACModel):
+ id: str
+ tenant_id: str = ""
+ access_policy_id: str
+ resource_type: str
+ resource_id: str = ""
+ account_id: str
+ account_name: str = ""
+ created_at: int = 0
+
+
+class AccessPolicyBindingState(_RBACModel):
+ binding_id: str
+ is_locked: bool = False
+
+
+class AccessPolicyRole(BaseModel):
+ role_id: str
+ role_name: str
+ binding_id: str
+ is_locked: bool = False
+ role_tag: str = ""
+
+
+class AccessPolicyAccount(BaseModel):
+ account_id: str
+ account_name: str
+ binding_id: str
+ is_locked: bool = False
+ avatar: str = ""
+ email: str = ""
+
+
+class AccessMatrixItem(_RBACModel):
+ policy: AccessPolicy | None = None
+ roles: list[AccessPolicyRole] = Field(default_factory=list)
+ accounts: list[AccessPolicyAccount] = Field(default_factory=list)
+
+ @field_validator("roles", "accounts", mode="before")
+ @classmethod
+ def _coerce_empty_lists(cls, value: Any) -> list[dict[str, Any]]:
+ if value is None:
+ return []
+ return value
+
+
+class AppAccessMatrix(_RBACModel):
+ app_id: str = Field(default="", validation_alias=AliasChoices("app_id", "resource_id"))
+ items: list[AccessMatrixItem] = Field(default_factory=list)
+
+
+class DatasetAccessMatrix(_RBACModel):
+ dataset_id: str = Field(default="", validation_alias=AliasChoices("dataset_id", "resource_id"))
+ items: list[AccessMatrixItem] = Field(default_factory=list)
+
+
+class AgentAccessMatrix(_RBACModel):
+ agent_id: str = Field(default="", validation_alias=AliasChoices("agent_id", "resource_id"))
+ items: list[AccessMatrixItem] = Field(default_factory=list)
+
+
+class WorkspaceAccessMatrix(_RBACModel):
+ items: list[AccessMatrixItem] = Field(default_factory=list)
+ pagination: Pagination | None = None
+
+
+class RoleBindingsResponse(_RBACModel):
+ data: list[AccessPolicyRoleBinding] = Field(default_factory=list)
+
+
+class MemberBindingsResponse(_RBACModel):
+ data: list[AccessPolicyMemberBinding] = Field(default_factory=list)
+
+
+class ResourceWhitelist(_RBACModel):
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("account_ids", mode="before")
+ @classmethod
+ def _coerce_account_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ResourceWhitelistConfig(_RBACModel):
+ automatic_include_workspace_members: bool
+
+
+class ResourceWhitelistConfigResource(_RBACModel):
+ resource_type: RBACResourceType
+ resource_id: str
+
+
+class ResourceWhitelistConfigItem(_RBACModel):
+ resource_type: RBACResourceType
+ resource_id: str
+ automatic_include_workspace_members: bool = False
+ account_ids: list[str] = Field(default_factory=list)
+ rbac_whitelist_scope: str | None = Field(
+ default=None, validation_alias=AliasChoices("rbac_whitelist_scope", "scope")
+ )
+
+ @field_validator("account_ids", mode="before")
+ @classmethod
+ def _coerce_account_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ResourceWhitelistConfigsResponse(_RBACModel):
+ data: list[ResourceWhitelistConfigItem] = Field(default_factory=list)
+
+
+class _ResourceWhitelistConfigSnapshot(_RBACModel):
+ """RBAC service's pre-toggle whitelist payload, used only by data migrations."""
+
+ account_ids: list[str] = Field(default_factory=list)
+ rbac_whitelist_scope: str | None = Field(
+ default=None, validation_alias=AliasChoices("rbac_whitelist_scope", "scope")
+ )
+
+ @field_validator("account_ids", mode="before")
+ @classmethod
+ def _coerce_account_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class AgentRoleMigration(_RBACModel):
+ role_id: str
+ role_name: str = ""
+ added_keys: list[str] = Field(default_factory=list)
+ removed_keys: list[str] = Field(default_factory=list)
+ bound_policies: list[str] = Field(default_factory=list)
+ skipped: str = ""
+
+
+class AgentMigrationReport(_RBACModel):
+ roles: list[AgentRoleMigration] = Field(default_factory=list)
+ role_templates: list[AgentRoleMigration] = Field(default_factory=list)
+
+
+class ConfiguredAgentIDs(_RBACModel):
+ configured_agent_ids: list[str] = Field(default_factory=list)
+
+
+class ResourceWhitelistResources(_RBACModel):
+ unrestricted: bool = False
+ resource_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("resource_ids", mode="before")
+ @classmethod
+ def _coerce_resource_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ResourceUserAccessPolicies(_RBACModel):
+ account: RBACRoleAccount
+ roles: list[RBACRole] = Field(default_factory=list)
+ access_policies: list[AccessPolicy] = Field(default_factory=list)
+
+ @field_validator("access_policies", "roles", mode="before")
+ @classmethod
+ def _coerce_none_to_list(cls, value: Any) -> Any:
+ if value is None:
+ return []
+ return value
+
+
+class ResourceUserAccessPoliciesResponse(_RBACModel):
+ data: list[ResourceUserAccessPolicies] = Field(default_factory=list)
+ pagination: Pagination | None = None
+
+
+class ReplaceUserAccessPolicies(_RBACModel):
+ access_policy_ids: list[str] = Field(default_factory=list)
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("access_policy_ids", mode="before")
+ @classmethod
+ def _coerce_access_policy_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ReplaceUserAccessPoliciesResponse(_RBACModel):
+ access_policies: list[AccessPolicy] = Field(default_factory=list)
+
+
+class AppendAppWhitelistMembersBatchItem(_RBACModel):
+ app_id: str
+ account_ids: list[str] = Field(default_factory=list)
+ policy_id: str
+
+
+class AppendDatasetWhitelistMembersBatchItem(_RBACModel):
+ dataset_id: str
+ account_ids: list[str] = Field(default_factory=list)
+ policy_id: str
+
+
+class AppendAgentWhitelistMembersBatchItem(_RBACModel):
+ agent_id: str
+ account_ids: list[str] = Field(default_factory=list)
+ policy_id: str
+
+
+class MemberRolesResponse(_RBACModel):
+ account_id: str
+ roles: list[RBACRole] = Field(default_factory=list)
+
+
+class WorkspacePermissionSnapshot(_RBACModel):
+ permission_keys: list[str] = Field(default_factory=list)
+
+
+class ResourcePermissionSnapshot(_RBACModel):
+ default_permission_keys: list[str] = Field(default_factory=list)
+ overrides: list[ResourcePermissionKeys] = Field(default_factory=list)
+
+ def permission_keys_by_resource_ids(self, resource_ids: list[str]) -> dict[str, list[str]]:
+ result = {str(resource_id): list(self.default_permission_keys) for resource_id in resource_ids}
+ for override in self.overrides:
+ resource_id = str(override.resource_id)
+ if resource_id in result:
+ result[resource_id] = list(override.permission_keys)
+ return result
+
+
+class MyPermissionsResponse(_RBACModel):
+ workspace: WorkspacePermissionSnapshot = Field(default_factory=WorkspacePermissionSnapshot)
+ app: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
+ dataset: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
+ agent: ResourcePermissionSnapshot = Field(default_factory=ResourcePermissionSnapshot)
+
+ def resource_snapshot(self, resource_type: RBACResourceType) -> ResourcePermissionSnapshot:
+ return {
+ RBACResourceType.APP: self.app,
+ RBACResourceType.DATASET: self.dataset,
+ RBACResourceType.AGENT: self.agent,
+ }[resource_type]
+
+
+class RoleMutation(_RBACModel):
+ """Payload shared by role create & update.
+
+ ``type`` defaults to ``workspace`` because that is the only concrete role
+ type supported by the enterprise backend today (see biz.RBACRoleType).
+ """
+
+ name: str
+ description: str = ""
+ permission_keys: list[str] = Field(default_factory=list)
+ type: RBACRoleType = RBACRoleType.WORKSPACE
+
+
+class AccessPolicyCreate(_RBACModel):
+ name: str
+ resource_type: RBACResourceType
+ description: str = ""
+ permission_keys: list[str] = Field(default_factory=list)
+
+
+class AccessPolicyUpdate(_RBACModel):
+ name: str
+ description: str = ""
+ permission_keys: list[str] = Field(default_factory=list)
+
+
+class ReplaceMemberBindings(_RBACModel):
+ automatic_include_workspace_members: bool = Field(default=False)
+
+
+class DeleteMemberBindings(_RBACModel):
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("account_ids", mode="before")
+ @classmethod
+ def _coerce_account_ids(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ReplaceBindings(_RBACModel):
+ role_ids: list[str] = Field(default_factory=list)
+ account_ids: list[str] = Field(default_factory=list)
+
+ @field_validator("role_ids", "account_ids", mode="before")
+ @classmethod
+ def _coerce_bindings(cls, value: Any) -> list[str]:
+ if value is None:
+ return []
+ return value
+
+
+class ListOption(_RBACModel):
+ page_number: int | None = None
+ results_per_page: int | None = None
+ reverse: bool | None = None
+
+ def to_params(self, extra: dict[str, Any] | None = None) -> dict[str, Any]:
+ params: dict[str, Any] = {}
+ if self.page_number is not None:
+ params["page_number"] = self.page_number
+ if self.results_per_page is not None:
+ params["results_per_page"] = self.results_per_page
+ if self.reverse is not None:
+ # httpx renders `True` as the string "True"; we want the inner
+ # handler to match on the lowercase form it compares against.
+ params["reverse"] = "true" if self.reverse else "false"
+ if extra:
+ params.update({k: v for k, v in extra.items() if v is not None})
+ return params
diff --git a/api/services/rbac/gateways.py b/api/services/rbac/gateways.py
new file mode 100644
index 00000000000..6dd6305ed63
--- /dev/null
+++ b/api/services/rbac/gateways.py
@@ -0,0 +1,67 @@
+"""Deployment, Enterprise and task adapters for workspace RBAC."""
+
+from configs import dify_config
+from enums import DeploymentEdition
+from services.rbac import contracts as dto
+from services.rbac.ports import CatalogGateway, ResourceAccessGateway, WorkspaceAccessGateway
+from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
+
+
+class DeploymentRBACSettings:
+ @property
+ def enabled(self) -> bool:
+ return dify_config.RBAC_ENABLED
+
+ @property
+ def billing_enabled(self) -> bool:
+ return dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD
+
+ @property
+ def dataset_operator_enabled(self) -> bool:
+ return dify_config.DATASET_OPERATOR_ENABLED
+
+
+class EnterpriseResourceAccessClients:
+ def __init__(
+ self,
+ *,
+ apps: ResourceAccessGateway,
+ datasets: ResourceAccessGateway,
+ agents: ResourceAccessGateway,
+ workspace_apps: WorkspaceAccessGateway,
+ workspace_datasets: WorkspaceAccessGateway,
+ workspace_agents: WorkspaceAccessGateway,
+ catalogs: CatalogGateway,
+ ) -> None:
+ self._resources = {
+ dto.RBACResourceType.APP: apps,
+ dto.RBACResourceType.DATASET: datasets,
+ dto.RBACResourceType.AGENT: agents,
+ }
+ self._workspaces = {
+ dto.RBACResourceType.APP: workspace_apps,
+ dto.RBACResourceType.DATASET: workspace_datasets,
+ dto.RBACResourceType.AGENT: workspace_agents,
+ }
+ self._catalogs = catalogs
+
+ def resource(self, kind: dto.RBACResourceType) -> ResourceAccessGateway:
+ return self._resources[kind]
+
+ def workspace(self, kind: dto.RBACResourceType) -> WorkspaceAccessGateway:
+ return self._workspaces[kind]
+
+ def catalog(
+ self, kind: dto.RBACResourceType, tenant_id: str, account_id: str, *, language: str | None
+ ) -> dto.PermissionCatalogResponse:
+ catalog = {
+ dto.RBACResourceType.APP: self._catalogs.app,
+ dto.RBACResourceType.DATASET: self._catalogs.dataset,
+ dto.RBACResourceType.AGENT: self._catalogs.agent,
+ }[kind]
+ return catalog(tenant_id, account_id, language=language)
+
+
+class CeleryAccessInitializer:
+ def initialize(self, tenant_id: str, account_id: str, kind: dto.RBACResourceType, resource_id: str) -> None:
+ initialize_created_app_rbac_access_task.delay(tenant_id, account_id, **{kind.route.id_param: resource_id})
diff --git a/api/services/rbac/members.py b/api/services/rbac/members.py
new file mode 100644
index 00000000000..75ec7b8d04f
--- /dev/null
+++ b/api/services/rbac/members.py
@@ -0,0 +1,90 @@
+"""Member role assignment and permission snapshots without attached ORM state."""
+
+from typing import Literal
+
+from enums.account import TenantAccountRole
+from machinery.context import RequestContext
+from services.errors.workspace import InvalidWorkspaceMemberRoleError
+from services.rbac.builtin import builtin_member_roles, builtin_permissions
+from services.rbac.contracts import MemberRolesResponse, MyPermissionsResponse, RBACResourceType
+from services.rbac.ports import (
+ MemberRolesGateway,
+ PermissionsGateway,
+ RBACMembers,
+ RBACSettings,
+ ResourcePermissionsGateway,
+ WorkspaceMemberRoles,
+)
+
+
+class MemberService:
+ def __init__(
+ self,
+ *,
+ members: RBACMembers,
+ workspace_roles: WorkspaceMemberRoles,
+ roles: MemberRolesGateway,
+ permissions: PermissionsGateway,
+ apps: ResourcePermissionsGateway,
+ datasets: ResourcePermissionsGateway,
+ settings: RBACSettings,
+ ) -> None:
+ self._members = members
+ self._workspace_roles = workspace_roles
+ self._roles = roles
+ self._permissions = permissions
+ self._resource_permissions = {RBACResourceType.APP: apps, RBACResourceType.DATASET: datasets}
+ self._settings = settings
+
+ def get(self, context: RequestContext, member_id: str, *, language: str | None) -> MemberRolesResponse:
+ if self._settings.enabled:
+ return self._roles.get(context.active_workspace_id, context.account_id, member_id, language=language)
+ role = self._members.member_role(context.active_workspace_id, member_id)
+ return builtin_member_roles(context.active_workspace_id, member_id, role)
+
+ def replace(
+ self, context: RequestContext, member_id: str, role_ids: list[str], *, language: str | None
+ ) -> MemberRolesResponse:
+ if self._settings.enabled:
+ return self._roles.replace(
+ context.active_workspace_id, context.account_id, member_id, role_ids, language=language
+ )
+ if len(role_ids) != 1:
+ raise InvalidWorkspaceMemberRoleError("Workspace member role update requires exactly one role.")
+ self._workspace_roles.update_role(context.active_workspace_id, member_id, role_ids[0], context.account_id)
+ return builtin_member_roles(context.active_workspace_id, member_id, TenantAccountRole(role_ids[0]))
+
+ def permissions(
+ self,
+ workspace_id: str,
+ account_id: str | None,
+ *,
+ app_id: str | None = None,
+ dataset_id: str | None = None,
+ agent_id: str | None = None,
+ language: str | None = None,
+ ) -> MyPermissionsResponse:
+ if self._settings.enabled:
+ return self._permissions.get(
+ workspace_id,
+ account_id,
+ app_id=app_id,
+ dataset_id=dataset_id,
+ agent_id=agent_id,
+ language=language,
+ )
+ return builtin_permissions(self._members.member_role(workspace_id, account_id))
+
+ def resource_permissions(
+ self,
+ workspace_id: str,
+ account_id: str | None,
+ kind: Literal[RBACResourceType.APP, RBACResourceType.DATASET],
+ resource_ids: list[str],
+ ) -> dict[str, list[str]]:
+ if not resource_ids:
+ return {}
+ if self._settings.enabled:
+ return self._resource_permissions[kind].batch_get(workspace_id, account_id, resource_ids)
+ keys = self.permissions(workspace_id, account_id).resource_snapshot(kind).default_permission_keys
+ return {resource_id: list(keys) for resource_id in resource_ids}
diff --git a/api/services/rbac/policies.py b/api/services/rbac/policies.py
new file mode 100644
index 00000000000..4ec9223994e
--- /dev/null
+++ b/api/services/rbac/policies.py
@@ -0,0 +1,60 @@
+"""Access policy administration."""
+
+from machinery.context import RequestContext
+from services.rbac.contracts import (
+ AccessPolicy,
+ AccessPolicyBindingState,
+ AccessPolicyCreate,
+ AccessPolicyUpdate,
+ ListOption,
+ Paginated,
+ RBACResourceType,
+)
+from services.rbac.ports import PoliciesGateway, PolicyBindingsGateway
+
+
+class PolicyService:
+ def __init__(self, *, policies: PoliciesGateway, bindings: PolicyBindingsGateway) -> None:
+ self._policies = policies
+ self._bindings = bindings
+
+ def list(
+ self,
+ context: RequestContext,
+ *,
+ resource_type: RBACResourceType | str | None,
+ options: ListOption,
+ language: str | None,
+ ) -> Paginated[AccessPolicy]:
+ return self._policies.list(
+ context.active_workspace_id,
+ context.account_id,
+ resource_type=resource_type,
+ options=options,
+ language=language,
+ )
+
+ def get(self, context: RequestContext, policy_id: str, *, language: str | None) -> AccessPolicy:
+ return self._policies.get(context.active_workspace_id, context.account_id, policy_id, language=language)
+
+ def create(self, context: RequestContext, payload: AccessPolicyCreate, *, language: str | None) -> AccessPolicy:
+ return self._policies.create(context.active_workspace_id, context.account_id, payload, language=language)
+
+ def update(
+ self, context: RequestContext, policy_id: str, payload: AccessPolicyUpdate, *, language: str | None
+ ) -> AccessPolicy:
+ return self._policies.update(
+ context.active_workspace_id, context.account_id, policy_id, payload, language=language
+ )
+
+ def delete(self, context: RequestContext, policy_id: str, *, language: str | None) -> None:
+ return self._policies.delete(context.active_workspace_id, context.account_id, policy_id, language=language)
+
+ def copy(self, context: RequestContext, policy_id: str, *, language: str | None) -> AccessPolicy:
+ return self._policies.copy(context.active_workspace_id, context.account_id, policy_id, language=language)
+
+ def lock(self, context: RequestContext, binding_id: str, *, language: str | None) -> AccessPolicyBindingState:
+ return self._bindings.lock(context.active_workspace_id, context.account_id, binding_id, language=language)
+
+ def unlock(self, context: RequestContext, binding_id: str, *, language: str | None) -> AccessPolicyBindingState:
+ return self._bindings.unlock(context.active_workspace_id, context.account_id, binding_id, language=language)
diff --git a/api/services/rbac/ports.py b/api/services/rbac/ports.py
new file mode 100644
index 00000000000..2031e91f9b7
--- /dev/null
+++ b/api/services/rbac/ports.py
@@ -0,0 +1,330 @@
+"""Ports required by the RBAC use cases; implementations live in gateways and repositories."""
+
+from collections.abc import Sequence
+from typing import Protocol
+
+from enums.account import TenantAccountRole
+from services.rbac.contracts import (
+ AccessMatrixItem,
+ AccessPolicy,
+ AccessPolicyBindingState,
+ AccessPolicyCreate,
+ AccessPolicyUpdate,
+ AgentAccessMatrix,
+ AppAccessMatrix,
+ DatasetAccessMatrix,
+ DeleteMemberBindings,
+ ListOption,
+ MemberBindingsResponse,
+ MemberRolesResponse,
+ MembersInRole,
+ MyPermissionsResponse,
+ Paginated,
+ PermissionCatalogResponse,
+ RBACResourceType,
+ RBACRole,
+ ReplaceBindings,
+ ReplaceMemberBindings,
+ ReplaceUserAccessPolicies,
+ ReplaceUserAccessPoliciesResponse,
+ ResourceUserAccessPoliciesResponse,
+ ResourceWhitelist,
+ ResourceWhitelistConfig,
+ RoleBindingsResponse,
+ RoleMutation,
+ WorkspaceAccessMatrix,
+)
+from services.workspace.contracts import WorkspaceMemberRecord
+
+
+class RolesGateway(Protocol):
+ def list(
+ self,
+ tenant_id: str,
+ account_id: str | None = None,
+ include_owner: int | None = None,
+ biiling_enabled: bool | None = None,
+ *,
+ options: ListOption | None = None,
+ language: str | None = None,
+ ) -> Paginated[RBACRole]: ...
+
+ def list_members_by_role(
+ self,
+ tenant_id: str,
+ role_id: str | None = None,
+ *,
+ options: ListOption | None = None,
+ language: str | None = None,
+ ) -> Paginated[MembersInRole]: ...
+
+ def get(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ role_id: str,
+ billing_enabled: bool = True,
+ *,
+ language: str | None = None,
+ ) -> RBACRole: ...
+
+ def create(
+ self, tenant_id: str, account_id: str | None, payload: RoleMutation, *, language: str | None = None
+ ) -> RBACRole: ...
+
+ def update(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ role_id: str,
+ payload: RoleMutation,
+ *,
+ language: str | None = None,
+ ) -> RBACRole: ...
+
+ def delete(self, tenant_id: str, account_id: str | None, role_id: str, *, language: str | None = None) -> None: ...
+
+ def copy(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ role_id: str,
+ copy_member: bool = True,
+ *,
+ language: str | None = None,
+ ) -> RBACRole: ...
+
+
+class PoliciesGateway(Protocol):
+ def list(
+ self,
+ tenant_id: str,
+ account_id: str | None = None,
+ *,
+ resource_type: RBACResourceType | str | None = None,
+ options: ListOption | None = None,
+ language: str | None = None,
+ ) -> Paginated[AccessPolicy]: ...
+
+ def get(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> AccessPolicy: ...
+
+ def create(
+ self, tenant_id: str, account_id: str | None, payload: AccessPolicyCreate, *, language: str | None = None
+ ) -> AccessPolicy: ...
+
+ def update(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ policy_id: str,
+ payload: AccessPolicyUpdate,
+ *,
+ language: str | None = None,
+ ) -> AccessPolicy: ...
+
+ def copy(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> AccessPolicy: ...
+
+ def delete(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> None: ...
+
+
+class PolicyBindingsGateway(Protocol):
+ def lock(
+ self, tenant_id: str, account_id: str | None, binding_id: str, *, language: str | None = None
+ ) -> AccessPolicyBindingState: ...
+
+ def unlock(
+ self, tenant_id: str, account_id: str | None, binding_id: str, *, language: str | None = None
+ ) -> AccessPolicyBindingState: ...
+
+
+class CatalogGateway(Protocol):
+ def workspace(
+ self, tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse: ...
+
+ def app(
+ self, tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse: ...
+
+ def dataset(
+ self, tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse: ...
+
+ def agent(
+ self, tenant_id: str, account_id: str | None = None, *, language: str | None = None
+ ) -> PermissionCatalogResponse: ...
+
+
+class ResourceAccessGateway(Protocol):
+ def user_access_policies(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ resource_id: str,
+ *,
+ options: ListOption | None = None,
+ language: str | None = None,
+ ) -> ResourceUserAccessPoliciesResponse: ...
+
+ def replace_user_access_policies(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ resource_id: str,
+ target_account_id: str | None,
+ payload: ReplaceUserAccessPolicies,
+ *,
+ language: str | None = None,
+ ) -> ReplaceUserAccessPoliciesResponse: ...
+
+ def whitelist(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> ResourceWhitelist: ...
+
+ def whitelist_config(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> ResourceWhitelistConfig: ...
+
+ def replace_whitelist(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ resource_id: str,
+ payload: ReplaceMemberBindings,
+ *,
+ language: str | None = None,
+ ) -> ResourceWhitelist: ...
+
+ def matrix(
+ self, tenant_id: str, account_id: str | None, resource_id: str, *, language: str | None = None
+ ) -> AppAccessMatrix | DatasetAccessMatrix | AgentAccessMatrix: ...
+
+ def list_role_bindings(
+ self, tenant_id: str, account_id: str | None, resource_id: str, policy_id: str, *, language: str | None = None
+ ) -> RoleBindingsResponse: ...
+
+ def list_member_bindings(
+ self, tenant_id: str, account_id: str | None, resource_id: str, policy_id: str, *, language: str | None = None
+ ) -> MemberBindingsResponse: ...
+
+ def delete_member_bindings(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ resource_id: str,
+ policy_id: str,
+ payload: DeleteMemberBindings,
+ *,
+ language: str | None = None,
+ ) -> None: ...
+
+
+class WorkspaceAccessGateway(Protocol):
+ def matrix(
+ self,
+ tenant_id: str,
+ account_id: str | None = None,
+ *,
+ options: ListOption | None = None,
+ language: str | None = None,
+ ) -> WorkspaceAccessMatrix: ...
+
+ def list_role_bindings(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> RoleBindingsResponse: ...
+
+ def list_member_bindings(
+ self, tenant_id: str, account_id: str | None, policy_id: str, *, language: str | None = None
+ ) -> MemberBindingsResponse: ...
+
+ def replace_bindings(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ policy_id: str,
+ payload: ReplaceBindings,
+ *,
+ language: str | None = None,
+ ) -> AccessMatrixItem: ...
+
+
+class RBACSettings(Protocol):
+ @property
+ def enabled(self) -> bool: ...
+ @property
+ def billing_enabled(self) -> bool: ...
+ @property
+ def dataset_operator_enabled(self) -> bool: ...
+
+
+class ResourceAccessClients(Protocol):
+ def resource(self, kind: RBACResourceType) -> ResourceAccessGateway: ...
+ def workspace(self, kind: RBACResourceType) -> WorkspaceAccessGateway: ...
+ def catalog(
+ self, kind: RBACResourceType, tenant_id: str, account_id: str, *, language: str | None
+ ) -> PermissionCatalogResponse: ...
+
+
+class RBACMembers(Protocol):
+ def member_role(self, workspace_id: str, account_id: str | None) -> TenantAccountRole | None: ...
+ def list_for_workspace(
+ self, workspace_id: str, *, account_ids: Sequence[str]
+ ) -> Sequence[WorkspaceMemberRecord]: ...
+
+
+class WorkspaceMemberRoles(Protocol):
+ def update_role(self, workspace_id: str, member_id: str, new_role: str, operator_id: str) -> None: ...
+
+
+class ResourceMaintainers(Protocol):
+ def get_maintainer_id(self, workspace_id: str, resource_id: str) -> str | None: ...
+
+
+class AccessInitializer(Protocol):
+ def initialize(self, tenant_id: str, account_id: str, kind: RBACResourceType, resource_id: str) -> None: ...
+
+
+class MemberRolesGateway(Protocol):
+ def get(
+ self, tenant_id: str, account_id: str | None, member_account_id: str, *, language: str | None = None
+ ) -> MemberRolesResponse: ...
+ def replace(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ member_account_id: str,
+ role_ids: list[str],
+ *,
+ language: str | None = None,
+ ) -> MemberRolesResponse: ...
+
+
+class PermissionsGateway(Protocol):
+ def get(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ *,
+ app_id: str | None = None,
+ dataset_id: str | None = None,
+ agent_id: str | None = None,
+ language: str | None = None,
+ ) -> MyPermissionsResponse: ...
+
+
+class ResourcePermissionsGateway(Protocol):
+ def batch_get(
+ self,
+ tenant_id: str,
+ account_id: str | None,
+ resource_ids: list[str],
+ /,
+ *,
+ language: str | None = None,
+ ) -> dict[str, list[str]]: ...
diff --git a/api/services/rbac/resource_queries.py b/api/services/rbac/resource_queries.py
new file mode 100644
index 00000000000..0af199414f9
--- /dev/null
+++ b/api/services/rbac/resource_queries.py
@@ -0,0 +1,39 @@
+"""Tenant-owned resource references used to resolve authorization targets."""
+
+from typing import Protocol
+
+from services.entities.app_entities import AppAgentBinding
+from services.rbac.ports import ResourceMaintainers
+
+
+class AppResourceQueries(Protocol):
+ def get_agent_binding(self, workspace_id: str, app_id: str) -> AppAgentBinding | None: ...
+
+ def get_maintainer_id(self, workspace_id: str, resource_id: str, *, normal_only: bool = False) -> str | None: ...
+
+
+class DatasetResourceQueries(ResourceMaintainers, Protocol):
+ def get_dataset_id_by_document(self, workspace_id: str, document_id: str) -> str | None: ...
+
+ def get_dataset_id_by_pipeline(self, workspace_id: str, pipeline_id: str) -> str | None: ...
+
+
+class ResourceQueryService:
+ def __init__(self, *, apps: AppResourceQueries, datasets: DatasetResourceQueries) -> None:
+ self._apps = apps
+ self._datasets = datasets
+
+ def get_app_agent_binding(self, workspace_id: str, app_id: str) -> AppAgentBinding | None:
+ return self._apps.get_agent_binding(workspace_id, app_id)
+
+ def get_app_maintainer(self, workspace_id: str, app_id: str) -> str | None:
+ return self._apps.get_maintainer_id(workspace_id, app_id, normal_only=True)
+
+ def get_dataset_maintainer(self, workspace_id: str, dataset_id: str) -> str | None:
+ return self._datasets.get_maintainer_id(workspace_id, dataset_id)
+
+ def get_dataset_id_by_document(self, workspace_id: str, document_id: str) -> str | None:
+ return self._datasets.get_dataset_id_by_document(workspace_id, document_id)
+
+ def get_dataset_id_by_pipeline(self, workspace_id: str, pipeline_id: str) -> str | None:
+ return self._datasets.get_dataset_id_by_pipeline(workspace_id, pipeline_id)
diff --git a/api/services/rbac/resources.py b/api/services/rbac/resources.py
new file mode 100644
index 00000000000..1c51d3553c6
--- /dev/null
+++ b/api/services/rbac/resources.py
@@ -0,0 +1,200 @@
+"""Resource access use cases shared by apps, datasets and agents."""
+
+from collections.abc import Sequence
+
+from machinery.context import RequestContext
+from services.rbac import contracts as dto
+from services.rbac.ports import AccessInitializer, RBACMembers, ResourceAccessClients, ResourceMaintainers
+
+
+class ResourceAccessService:
+ def __init__(
+ self,
+ *,
+ clients: ResourceAccessClients,
+ members: RBACMembers,
+ apps: ResourceMaintainers,
+ datasets: ResourceMaintainers,
+ initializer: AccessInitializer,
+ ) -> None:
+ self._clients = clients
+ self._members = members
+ self._apps = apps
+ self._datasets = datasets
+ self._initializer = initializer
+
+ def catalog(
+ self, context: RequestContext, kind: dto.RBACResourceType, *, language: str | None
+ ) -> dto.PermissionCatalogResponse:
+ return self._clients.catalog(kind, context.active_workspace_id, context.account_id, language=language)
+
+ def matrix(
+ self, context: RequestContext, kind: dto.RBACResourceType, resource_id: str, *, language: str | None
+ ) -> dto.AppAccessMatrix | dto.DatasetAccessMatrix | dto.AgentAccessMatrix:
+ result = self._clients.resource(kind).matrix(
+ context.active_workspace_id, context.account_id, resource_id, language=language
+ )
+ self._hydrate_accounts(context, [account for item in result.items for account in item.accounts])
+ return result
+
+ def whitelist(
+ self, context: RequestContext, kind: dto.RBACResourceType, resource_id: str, *, language: str | None
+ ) -> dto.ResourceWhitelist:
+ return self._clients.resource(kind).whitelist(
+ context.active_workspace_id, context.account_id, resource_id, language=language
+ )
+
+ def replace_whitelist(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ payload: dto.ReplaceMemberBindings,
+ *,
+ language: str | None,
+ ) -> dto.ResourceWhitelist:
+ result = self._clients.resource(kind).replace_whitelist(
+ context.active_workspace_id, context.account_id, resource_id, payload, language=language
+ )
+ if payload.automatic_include_workspace_members:
+ self._initializer.initialize(context.active_workspace_id, context.account_id, kind, resource_id)
+ return result
+
+ def whitelist_config(
+ self, context: RequestContext, kind: dto.RBACResourceType, resource_id: str, *, language: str | None
+ ) -> dto.ResourceWhitelistConfig:
+ return self._clients.resource(kind).whitelist_config(
+ context.active_workspace_id, context.account_id, resource_id, language=language
+ )
+
+ def user_access_policies(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ *,
+ options: dto.ListOption,
+ language: str | None,
+ ) -> dto.ResourceUserAccessPoliciesResponse:
+ result = self._clients.resource(kind).user_access_policies(
+ context.active_workspace_id, context.account_id, resource_id, options=options, language=language
+ )
+ maintainer_id = None
+ if kind == dto.RBACResourceType.APP:
+ maintainer_id = self._apps.get_maintainer_id(context.active_workspace_id, resource_id)
+ elif kind == dto.RBACResourceType.DATASET:
+ maintainer_id = self._datasets.get_maintainer_id(context.active_workspace_id, resource_id)
+ if maintainer_id and maintainer_id.strip():
+ for index, item in enumerate(result.data):
+ if item.account.account_id.strip() == maintainer_id.strip():
+ result.data.insert(0, result.data.pop(index))
+ break
+ self._hydrate_accounts(context, [item.account for item in result.data])
+ return result
+
+ def replace_user_access_policies(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ target_account_id: str,
+ payload: dto.ReplaceUserAccessPolicies,
+ *,
+ language: str | None,
+ ) -> dto.ReplaceUserAccessPoliciesResponse:
+ return self._clients.resource(kind).replace_user_access_policies(
+ context.active_workspace_id, context.account_id, resource_id, target_account_id, payload, language=language
+ )
+
+ def list_role_bindings(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ policy_id: str,
+ *,
+ language: str | None,
+ ) -> dto.RoleBindingsResponse:
+ return self._clients.resource(kind).list_role_bindings(
+ context.active_workspace_id, context.account_id, resource_id, policy_id, language=language
+ )
+
+ def list_member_bindings(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ policy_id: str,
+ *,
+ language: str | None,
+ ) -> dto.MemberBindingsResponse:
+ return self._clients.resource(kind).list_member_bindings(
+ context.active_workspace_id, context.account_id, resource_id, policy_id, language=language
+ )
+
+ def delete_member_bindings(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ resource_id: str,
+ policy_id: str,
+ payload: dto.DeleteMemberBindings,
+ *,
+ language: str | None,
+ ) -> None:
+ self._clients.resource(kind).delete_member_bindings(
+ context.active_workspace_id, context.account_id, resource_id, policy_id, payload, language=language
+ )
+
+ def workspace_matrix(
+ self, context: RequestContext, kind: dto.RBACResourceType, options: dto.ListOption, *, language: str | None
+ ) -> dto.WorkspaceAccessMatrix:
+ result = self._clients.workspace(kind).matrix(
+ context.active_workspace_id, context.account_id, options=options, language=language
+ )
+ self._hydrate_accounts(context, [account for item in result.items for account in item.accounts])
+ return result
+
+ def workspace_role_bindings(
+ self, context: RequestContext, kind: dto.RBACResourceType, policy_id: str, *, language: str | None
+ ) -> dto.RoleBindingsResponse:
+ return self._clients.workspace(kind).list_role_bindings(
+ context.active_workspace_id, context.account_id, policy_id, language=language
+ )
+
+ def workspace_member_bindings(
+ self, context: RequestContext, kind: dto.RBACResourceType, policy_id: str, *, language: str | None
+ ) -> dto.MemberBindingsResponse:
+ return self._clients.workspace(kind).list_member_bindings(
+ context.active_workspace_id, context.account_id, policy_id, language=language
+ )
+
+ def replace_workspace_bindings(
+ self,
+ context: RequestContext,
+ kind: dto.RBACResourceType,
+ policy_id: str,
+ payload: dto.ReplaceBindings,
+ *,
+ language: str | None,
+ ) -> dto.AccessMatrixItem:
+ return self._clients.workspace(kind).replace_bindings(
+ context.active_workspace_id, context.account_id, policy_id, payload, language=language
+ )
+
+ def _hydrate_accounts(
+ self, context: RequestContext, accounts: Sequence[dto.AccessPolicyAccount | dto.RBACRoleAccount]
+ ) -> None:
+ ids = sorted({account.account_id.strip() for account in accounts if account.account_id.strip()})
+ if not ids:
+ return
+ records = {
+ member.id: member
+ for member in self._members.list_for_workspace(context.active_workspace_id, account_ids=ids)
+ }
+ for account in accounts:
+ if member := records.get(account.account_id.strip()):
+ if not account.account_name:
+ account.account_name = member.name
+ account.avatar = member.avatar or ""
+ account.email = member.email
diff --git a/api/services/rbac/roles.py b/api/services/rbac/roles.py
new file mode 100644
index 00000000000..1bfd0b076e5
--- /dev/null
+++ b/api/services/rbac/roles.py
@@ -0,0 +1,76 @@
+"""Workspace role administration and built-in role projection."""
+
+from machinery.context import RequestContext
+from services.rbac.builtin import builtin_workspace_roles
+from services.rbac.contracts import (
+ ListOption,
+ MembersInRole,
+ Paginated,
+ PermissionCatalogResponse,
+ RBACRole,
+ RoleMutation,
+)
+from services.rbac.ports import CatalogGateway, RBACSettings, RolesGateway
+
+
+class RoleService:
+ def __init__(self, *, roles: RolesGateway, catalog: CatalogGateway, settings: RBACSettings) -> None:
+ self._roles = roles
+ self._catalog = catalog
+ self._settings = settings
+
+ def catalog(self, context: RequestContext, *, language: str | None) -> PermissionCatalogResponse:
+ return self._catalog.workspace(context.active_workspace_id, context.account_id, language=language)
+
+ def list(
+ self, context: RequestContext, *, options: ListOption, include_owner: int, language: str | None
+ ) -> Paginated[RBACRole]:
+ if not self._settings.enabled:
+ return builtin_workspace_roles(
+ options,
+ include_owner=include_owner,
+ dataset_operator_enabled=self._settings.dataset_operator_enabled,
+ )
+ return self._roles.list(
+ context.active_workspace_id,
+ context.account_id,
+ options=options,
+ include_owner=include_owner,
+ biiling_enabled=self._settings.billing_enabled,
+ language=language,
+ )
+
+ def get(self, context: RequestContext, role_id: str, *, language: str | None) -> RBACRole:
+ return self._roles.get(
+ context.active_workspace_id,
+ context.account_id,
+ role_id,
+ billing_enabled=self._settings.billing_enabled,
+ language=language,
+ )
+
+ def create(self, context: RequestContext, payload: RoleMutation, *, language: str | None) -> RBACRole:
+ return self._roles.create(context.active_workspace_id, context.account_id, payload, language=language)
+
+ def update(self, context: RequestContext, role_id: str, payload: RoleMutation, *, language: str | None) -> RBACRole:
+ return self._roles.update(context.active_workspace_id, context.account_id, role_id, payload, language=language)
+
+ def delete(self, context: RequestContext, role_id: str, *, language: str | None) -> None:
+ return self._roles.delete(context.active_workspace_id, context.account_id, role_id, language=language)
+
+ def copy(self, context: RequestContext, role_id: str, copy_member: bool, *, language: str | None) -> RBACRole:
+ return self._roles.copy(
+ context.active_workspace_id, context.account_id, role_id, copy_member, language=language
+ )
+
+ def list_members_by_role(
+ self,
+ context: RequestContext,
+ role_id: str,
+ *,
+ options: ListOption,
+ language: str | None,
+ ) -> Paginated[MembersInRole]:
+ return self._roles.list_members_by_role(
+ context.active_workspace_id, role_id, options=options, language=language
+ )
diff --git a/api/services/rbac_agent_access_service.py b/api/services/rbac_agent_access_service.py
index 4540c587c53..901331fa629 100644
--- a/api/services/rbac_agent_access_service.py
+++ b/api/services/rbac_agent_access_service.py
@@ -2,6 +2,7 @@ import logging
from configs import dify_config
from services.enterprise import rbac_service as enterprise_rbac_service
+from services.rbac import contracts as rbac_contracts
from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
logger = logging.getLogger(__name__)
@@ -16,14 +17,14 @@ def initialize_agent_rbac_access(*, tenant_id: str, agent_id: str, creator_accou
enterprise_rbac_service.RBACService.AccessPolicies.sync_creator_access_policy_member_bindings(
tenant_id,
creator_account_id,
- resource_type=enterprise_rbac_service.RBACResourceType.AGENT,
+ resource_type=rbac_contracts.RBACResourceType.AGENT,
resource_id=agent_id,
)
enterprise_rbac_service.RBACService.AgentAccess.replace_whitelist(
tenant_id,
creator_account_id,
agent_id,
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=True),
)
except Exception:
logger.warning(
diff --git a/api/services/rbac_resource_service.py b/api/services/rbac_resource_service.py
deleted file mode 100644
index 65026008267..00000000000
--- a/api/services/rbac_resource_service.py
+++ /dev/null
@@ -1,49 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from sqlalchemy import select
-from sqlalchemy.orm import Session, scoped_session
-
-from models.dataset import Dataset, Document
-from models.model import App
-
-if TYPE_CHECKING:
- from models.agent import Agent
-
-
-class RBACResourceService:
- @staticmethod
- def get_app_agent_binding(session: Session | scoped_session, tenant_id: str, app_id: str) -> Agent | None:
- app_model = session.scalar(select(App).where(App.id == app_id, App.tenant_id == tenant_id))
- if app_model is None:
- return None
- return app_model.agent_app_binding_with_session(session=session, include_archived=True)
-
- @staticmethod
- def get_app_maintainer(session: Session | scoped_session, tenant_id: str, app_id: str) -> str | None:
- return session.scalar(
- select(App.maintainer).where(App.id == app_id, App.tenant_id == tenant_id, App.status == "normal")
- )
-
- @staticmethod
- def get_dataset_maintainer(session: Session | scoped_session, tenant_id: str, dataset_id: str) -> str | None:
- return session.scalar(
- select(Dataset.maintainer).where(Dataset.id == dataset_id, Dataset.tenant_id == tenant_id)
- )
-
- @staticmethod
- def get_dataset_id_by_document(session: Session | scoped_session, tenant_id: str, document_id: str) -> str | None:
- dataset_id = session.scalar(
- select(Dataset.id)
- .join(Document, Document.dataset_id == Dataset.id)
- .where(Dataset.tenant_id == tenant_id, Document.tenant_id == tenant_id, Document.id == document_id)
- )
- return None if dataset_id is None else str(dataset_id)
-
- @staticmethod
- def get_dataset_id_by_pipeline(session: Session | scoped_session, tenant_id: str, pipeline_id: str) -> str | None:
- dataset_id = session.scalar(
- select(Dataset.id).where(Dataset.pipeline_id == pipeline_id, Dataset.tenant_id == tenant_id)
- )
- return dataset_id
diff --git a/api/services/workspace/gateways.py b/api/services/workspace/gateways.py
index 50ea3f5c551..65ed036df32 100644
--- a/api/services/workspace/gateways.py
+++ b/api/services/workspace/gateways.py
@@ -7,7 +7,6 @@ from contextlib import AbstractContextManager
from typing import Literal, override
from uuid import uuid4
-from sqlalchemy.orm import Session, sessionmaker
from werkzeug.exceptions import Forbidden
from configs import dify_config
@@ -32,7 +31,7 @@ from services.billing_service import BillingService
from services.credit_pool_service import CreditPoolBalance, CreditPoolService
from services.enterprise import rbac_service as enterprise_rbac_service
from services.enterprise.enterprise_service import EnterpriseService
-from services.enterprise.rbac_service import ListOption, RBACService
+from services.enterprise.rbac_service import RBACService
from services.entities.account_activation_entities import InvitationToken
from services.entities.account_entities import AccountSnapshot
from services.errors.base import NoPermissionError
@@ -45,6 +44,7 @@ from services.errors.workspace import (
from services.feature_service import FeatureService
from services.file_service import FileService
from services.plugin.plugin_auto_upgrade_service import PluginAutoUpgradeService
+from services.rbac.contracts import ListOption
from services.system_feature_service import SystemFeatureService
from services.workspace.contracts import (
CreatedWorkspace,
@@ -200,9 +200,6 @@ class WorkspaceInvitationGateway:
class DeploymentWorkspaceMemberAccessGateway:
- def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
- self._session_factory = session_factory
-
def ensure_role_enabled(self, role: str) -> None:
_ensure_role_enabled(role)
@@ -211,17 +208,14 @@ class DeploymentWorkspaceMemberAccessGateway:
return dify_config.RBAC_ENABLED
def permission_keys(self, workspace_id: str, actor_id: str) -> set[str]:
- with self._session_factory() as session:
- permissions = RBACService.MyPermissions.get(workspace_id, actor_id, session=session)
- return set(permissions.workspace.permission_keys)
+ permissions = RBACService.MyPermissions.get(workspace_id, actor_id)
+ return set(permissions.workspace.permission_keys)
def is_owner(self, workspace_id: str, actor_id: str, member_id: str) -> bool:
- with self._session_factory() as session:
- roles = RBACService.MemberRoles.get(workspace_id, actor_id, member_id, session=session).roles
- return any(
- role.is_builtin and role.category == "global_system_default" and role.role_tag == "owner"
- for role in roles
- )
+ roles = RBACService.MemberRoles.get(workspace_id, actor_id, member_id).roles
+ return any(
+ role.is_builtin and role.category == "global_system_default" and role.role_tag == "owner" for role in roles
+ )
@staticmethod
def _role_id(workspace_id: str, actor_id: str, tag: str) -> str:
@@ -245,15 +239,12 @@ class DeploymentWorkspaceMemberAccessGateway:
return members[0].account_id
def assign_role(self, workspace_id: str, actor_id: str, member_id: str, role_id: str) -> None:
- with self._session_factory() as session:
- RBACService.MemberRoles.replace(
- tenant_id=workspace_id,
- account_id=actor_id,
- member_account_id=member_id,
- role_ids=[role_id],
- session=session,
- )
- session.commit()
+ RBACService.MemberRoles.replace(
+ tenant_id=workspace_id,
+ account_id=actor_id,
+ member_account_id=member_id,
+ role_ids=[role_id],
+ )
def change_role(self, workspace_id: str, actor_id: str, member_id: str, role: TenantAccountRole) -> None:
if not TenantAccountRole.is_non_owner_role(role):
@@ -264,25 +255,21 @@ class DeploymentWorkspaceMemberAccessGateway:
owner_role_id = self._role_id(workspace_id, actor_id, "owner")
old_owner_id = self.owner_id(workspace_id, actor_id)
no_access_id = self._role_id(workspace_id, actor_id, "no_access")
- # With RBAC enabled these calls update the enterprise service, not the local
- # Session. Complete both before the repository commits local owner changes.
- with self._session_factory() as session:
- current = RBACService.MemberRoles.get(workspace_id, actor_id, old_owner_id, session=session).roles
- remaining = [str(item.id) for item in current if str(item.id) != owner_role_id]
- RBACService.MemberRoles.replace(
- tenant_id=workspace_id,
- account_id=actor_id,
- member_account_id=old_owner_id,
- role_ids=remaining or [no_access_id],
- session=session,
- )
- RBACService.MemberRoles.replace(
- tenant_id=workspace_id,
- account_id=actor_id,
- member_account_id=member_id,
- role_ids=[owner_role_id],
- session=session,
- )
+ # Complete the remote role changes before the repository commits local ownership.
+ current = RBACService.MemberRoles.get(workspace_id, actor_id, old_owner_id).roles
+ remaining = [str(item.id) for item in current if str(item.id) != owner_role_id]
+ RBACService.MemberRoles.replace(
+ tenant_id=workspace_id,
+ account_id=actor_id,
+ member_account_id=old_owner_id,
+ role_ids=remaining or [no_access_id],
+ )
+ RBACService.MemberRoles.replace(
+ tenant_id=workspace_id,
+ account_id=actor_id,
+ member_account_id=member_id,
+ role_ids=[owner_role_id],
+ )
def membership_changed(self, membership: WorkspaceMemberWrite, operator_account_id: str | None) -> None:
if dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD:
@@ -442,6 +429,8 @@ class DeploymentWorkspaceMemberRoleResolver(WorkspaceMemberRoleResolver):
workspace_id: str,
actor_account_id: str,
subjects: Sequence[WorkspaceMemberRoleSubject],
+ *,
+ language: str | None = None,
) -> Mapping[str, Sequence[WorkspaceMemberRole]]:
role_subjects = tuple(subjects)
if not role_subjects:
@@ -457,6 +446,7 @@ class DeploymentWorkspaceMemberRoleResolver(WorkspaceMemberRoleResolver):
workspace_id,
actor_account_id,
[subject.account_id for subject in role_subjects],
+ language=language,
)
return {
item.account_id: tuple(WorkspaceMemberRole(id=role.id, name=role.name) for role in item.roles)
@@ -467,9 +457,6 @@ class DeploymentWorkspaceMemberRoleResolver(WorkspaceMemberRoleResolver):
class WorkspaceProvisioningEffectsGateway:
"""Prepare external resources and publish committed workspace creation."""
- def __init__(self, *, session_factory: sessionmaker[Session]) -> None:
- self._session_factory = session_factory
-
def prepare(self, name: str) -> WorkspaceCreation:
workspace_id = str(uuid4())
return WorkspaceCreation(
@@ -488,16 +475,12 @@ class WorkspaceProvisioningEffectsGateway:
if not dify_config.RBAC_ENABLED:
return
role_id = DeploymentWorkspaceMemberAccessGateway._role_id(workspace_id, account_id, "owner")
- # RBAC uses the enterprise API here. Its shared signature requires a
- # Session, but this call does not perform local database queries.
- with self._session_factory() as session:
- RBACService.MemberRoles.replace(
- tenant_id=workspace_id,
- account_id=account_id,
- member_account_id=account_id,
- role_ids=[role_id],
- session=session,
- )
+ RBACService.MemberRoles.replace(
+ tenant_id=workspace_id,
+ account_id=account_id,
+ member_account_id=account_id,
+ role_ids=[role_id],
+ )
def created(self, workspace: CreatedWorkspace, *, owner_id: str | None) -> None:
if owner_id is not None and dify_config.DEPLOYMENT_EDITION == DeploymentEdition.CLOUD:
diff --git a/api/services/workspace/member_service.py b/api/services/workspace/member_service.py
index e766c47796d..24b1d46c918 100644
--- a/api/services/workspace/member_service.py
+++ b/api/services/workspace/member_service.py
@@ -54,6 +54,8 @@ class WorkspaceMemberRoleResolver(Protocol):
workspace_id: str,
actor_account_id: str,
subjects: Sequence[WorkspaceMemberRoleSubject],
+ *,
+ language: str | None = None,
) -> Mapping[str, Sequence[WorkspaceMemberRole]]: ...
@@ -78,7 +80,9 @@ class WorkspaceMemberQueryService:
start = (page - 1) * limit
return WorkspaceMemberPage(members=records[start : start + limit], total=len(records))
- def list_current(self, context: RequestContext) -> tuple[WorkspaceMemberSummary, ...]:
+ def list_current(
+ self, context: RequestContext, *, language: str | None = None
+ ) -> tuple[WorkspaceMemberSummary, ...]:
workspace_id = context.active_workspace_id
records = tuple(self._members.list_for_workspace(workspace_id))
@@ -88,7 +92,7 @@ class WorkspaceMemberQueryService:
# The repository closes its read Session before role resolution
# performs enterprise I/O.
- roles_by_member = self._roles.resolve_many(workspace_id, context.account_id, role_subjects)
+ roles_by_member = self._roles.resolve_many(workspace_id, context.account_id, role_subjects, language=language)
return tuple(
WorkspaceMemberSummary(
diff --git a/api/tasks/initialize_created_app_rbac_access_task.py b/api/tasks/initialize_created_app_rbac_access_task.py
index 2a51e576699..605d62e3ea7 100644
--- a/api/tasks/initialize_created_app_rbac_access_task.py
+++ b/api/tasks/initialize_created_app_rbac_access_task.py
@@ -11,6 +11,7 @@ from configs import dify_config
from extensions.ext_database import db
from models import Agent, App, Dataset, TenantAccountJoin, TenantAccountRole
from services.enterprise import rbac_service as enterprise_rbac_service
+from services.rbac import contracts as rbac_contracts
logger = logging.getLogger(__name__)
@@ -32,13 +33,13 @@ def _owner_account_id(tenant_id: str) -> str | None:
@dataclass(frozen=True)
class _WhitelistResourceKind[ItemT]:
- resource_type: enterprise_rbac_service.RBACResourceType
+ resource_type: rbac_contracts.RBACResourceType
model: type[App] | type[Dataset] | type[Agent]
build_item: Callable[[str, str], ItemT]
append_members: Callable[[str, str | None, Sequence[ItemT]], None]
replace_user_access_policies: Callable[
- [str, str, str, enterprise_rbac_service.ReplaceUserAccessPolicies],
- enterprise_rbac_service.ReplaceUserAccessPoliciesResponse,
+ [str, str, str, rbac_contracts.ReplaceUserAccessPolicies],
+ rbac_contracts.ReplaceUserAccessPoliciesResponse,
]
def iter_id_batches(self, tenant_id: str, batch_size: int) -> Iterator[list[str]]:
@@ -68,9 +69,9 @@ class _WhitelistResourceKind[ItemT]:
_WHITELIST_RESOURCE_KINDS = (
_WhitelistResourceKind(
- resource_type=enterprise_rbac_service.RBACResourceType.APP,
+ resource_type=rbac_contracts.RBACResourceType.APP,
model=App,
- build_item=lambda app_id, member: enterprise_rbac_service.AppendAppWhitelistMembersBatchItem(
+ build_item=lambda app_id, member: rbac_contracts.AppendAppWhitelistMembersBatchItem(
app_id=app_id, account_ids=[member], policy_id=APP_RBAC_DEFAULT_ACCESS_POLICY_ID
),
append_members=lambda tenant_id, account_id, data: (
@@ -89,9 +90,9 @@ _WHITELIST_RESOURCE_KINDS = (
),
),
_WhitelistResourceKind(
- resource_type=enterprise_rbac_service.RBACResourceType.DATASET,
+ resource_type=rbac_contracts.RBACResourceType.DATASET,
model=Dataset,
- build_item=lambda dataset_id, member: enterprise_rbac_service.AppendDatasetWhitelistMembersBatchItem(
+ build_item=lambda dataset_id, member: rbac_contracts.AppendDatasetWhitelistMembersBatchItem(
dataset_id=dataset_id, account_ids=[member], policy_id=APP_RBAC_DEFAULT_ACCESS_POLICY_ID
),
append_members=lambda tenant_id, account_id, data: (
@@ -110,9 +111,9 @@ _WHITELIST_RESOURCE_KINDS = (
),
),
_WhitelistResourceKind(
- resource_type=enterprise_rbac_service.RBACResourceType.AGENT,
+ resource_type=rbac_contracts.RBACResourceType.AGENT,
model=Agent,
- build_item=lambda agent_id, member: enterprise_rbac_service.AppendAgentWhitelistMembersBatchItem(
+ build_item=lambda agent_id, member: rbac_contracts.AppendAgentWhitelistMembersBatchItem(
agent_id=agent_id, account_ids=[member], policy_id=APP_RBAC_DEFAULT_ACCESS_POLICY_ID
),
append_members=lambda tenant_id, account_id, data: (
@@ -137,11 +138,11 @@ _WHITELIST_RESOURCE_KIND_BY_TYPE = {kind.resource_type: kind for kind in _WHITEL
def _iter_resource_config_batches(
tenant_id: str,
batch_size: int,
-) -> Iterator[list[enterprise_rbac_service.ResourceWhitelistConfigResource]]:
+) -> Iterator[list[rbac_contracts.ResourceWhitelistConfigResource]]:
for kind in _WHITELIST_RESOURCE_KINDS:
for ids in kind.iter_id_batches(tenant_id, batch_size):
yield [
- enterprise_rbac_service.ResourceWhitelistConfigResource(
+ rbac_contracts.ResourceWhitelistConfigResource(
resource_type=kind.resource_type, resource_id=resource_id
)
for resource_id in ids
@@ -154,7 +155,7 @@ def _chunks[T](items: list[T], chunk_size: int) -> Iterator[list[T]]:
def _resolve_target_resource(
- resource_ids: dict[enterprise_rbac_service.RBACResourceType, str | None],
+ resource_ids: dict[rbac_contracts.RBACResourceType, str | None],
) -> tuple[_WhitelistResourceKind, str]:
provided = [(resource_type, rid) for resource_type, rid in resource_ids.items() if rid is not None]
if len(provided) != 1:
@@ -184,9 +185,9 @@ def initialize_created_app_rbac_access_task(
kind, resource_id = _resolve_target_resource(
{
- enterprise_rbac_service.RBACResourceType.APP: app_id,
- enterprise_rbac_service.RBACResourceType.DATASET: dataset_id,
- enterprise_rbac_service.RBACResourceType.AGENT: agent_id,
+ rbac_contracts.RBACResourceType.APP: app_id,
+ rbac_contracts.RBACResourceType.DATASET: dataset_id,
+ rbac_contracts.RBACResourceType.AGENT: agent_id,
}
)
@@ -201,7 +202,7 @@ def initialize_created_app_rbac_access_task(
tenant_id,
account_id,
resource_id,
- enterprise_rbac_service.ReplaceUserAccessPolicies(
+ rbac_contracts.ReplaceUserAccessPolicies(
access_policy_ids=[APP_RBAC_DEFAULT_ACCESS_POLICY_ID],
account_ids=list(account_ids),
),
@@ -238,7 +239,7 @@ def sync_joined_workspace_member_rbac_access_task(
)
return
- auto_included: dict[enterprise_rbac_service.RBACResourceType, list[str]] = {
+ auto_included: dict[rbac_contracts.RBACResourceType, list[str]] = {
kind.resource_type: [] for kind in _WHITELIST_RESOURCE_KINDS
}
for resources in _iter_resource_config_batches(tenant_id, APP_RBAC_RESOURCE_CONFIG_BATCH_SIZE):
diff --git a/api/tests/unit_tests/account_domain.py b/api/tests/unit_tests/account_domain.py
index a508c591cf0..752f5e7cc83 100644
--- a/api/tests/unit_tests/account_domain.py
+++ b/api/tests/unit_tests/account_domain.py
@@ -54,7 +54,7 @@ def build_account_domain(session_factory: sessionmaker[Session]) -> AccountDomai
provisioning = WorkspaceProvisioningService(
owners=repository,
provisioning=workspaces,
- effects=WorkspaceProvisioningEffectsGateway(session_factory=session_factory),
+ effects=WorkspaceProvisioningEffectsGateway(),
policies=policy,
memberships=workspaces,
members=members,
diff --git a/api/tests/unit_tests/commands/test_rbac_agent_migration.py b/api/tests/unit_tests/commands/test_rbac_agent_migration.py
index c09c48855ca..81e929c7f7d 100644
--- a/api/tests/unit_tests/commands/test_rbac_agent_migration.py
+++ b/api/tests/unit_tests/commands/test_rbac_agent_migration.py
@@ -1,22 +1,16 @@
+"""Exercise migration queries against SQLite and the shared RBAC transport fake."""
+
import json
-from collections.abc import Iterator
-from contextlib import ExitStack
-from dataclasses import dataclass, field
-from unittest.mock import MagicMock, patch
import pytest
-from click.testing import CliRunner, Result
-
-from commands.rbac import migrate_agent_permissions_to_rbac
-from services.enterprise.rbac_service import (
- LegacyAgentMigrationReport,
- LegacyAgentRoleMigration,
- MemberRolesResponse,
- RBACRole,
- _LegacyResourceWhitelistConfig,
-)
+from click.testing import CliRunner
-MODULE = "commands.rbac"
+from commands import rbac
+from enums.account import TenantAccountRole
+from models import TenantAccountJoin
+from models.agent import Agent, AgentScope, AgentSource
+from tests.unit_tests.model_factories import make_tenant
+from tests.unit_tests.rbac_fakes import RBACDomain
def _events(output: str) -> list[dict[str, object]]:
@@ -24,207 +18,114 @@ def _events(output: str) -> list[dict[str, object]]:
@pytest.fixture(autouse=True)
-def _no_agents() -> Iterator[None]:
- with patch(f"{MODULE}._iter_agent_row_batches", return_value=iter(())):
- yield
-
-
-def _roles() -> list[LegacyAgentRoleMigration]:
- return [
- LegacyAgentRoleMigration(
- role_id="r1",
- role_name="ops",
- added_keys=["agent.create"],
- removed_keys=["agent.manage"],
- bound_policies=["agent.full_access"],
- ),
- LegacyAgentRoleMigration(role_id="r2", role_name="stuck", skipped="policy row missing"),
- ]
+def migration_database(monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain) -> None:
+ monkeypatch.setattr(rbac.session_factory, "create_session", rbac_domain.sessions)
+
+def test_apply_flag_writes_and_reports_applied(rbac_domain: RBACDomain) -> None:
+ with rbac_domain.sessions.begin() as session:
+ session.add_all([make_tenant(tenant_id="t1"), make_tenant(tenant_id="t2")])
+ rbac_domain.transport.response = {"roles": [{"role_id": "r1", "role_name": "ops", "added_keys": ["agent.create"]}]}
-def test_apply_flag_writes_and_reports_applied() -> None:
- with (
- patch(f"{MODULE}._iter_tenant_ids", return_value=iter(["t1", "t2"])),
- patch(
- f"{MODULE}.RBACService.Migrations.migrate_agent_manage_roles",
- return_value=LegacyAgentMigrationReport(roles=_roles()[:1]),
- ) as migrate,
- ):
- result = CliRunner().invoke(migrate_agent_permissions_to_rbac, ["--apply"])
+ result = CliRunner().invoke(rbac.migrate_agent_permissions_to_rbac, ["--apply"])
assert result.exit_code == 0, result.output
- assert migrate.call_count == 2
- assert all(call.kwargs == {"apply": True} for call in migrate.call_args_list)
+ assert len(rbac_domain.transport.requests) == 2
+ for request in rbac_domain.transport.requests:
+ assert (request.method, request.endpoint) == ("POST", "/rbac/migrations/agent-manage-roles")
+ assert request.json == {"apply": True}
events = _events(result.output)
- assert [e["event"] for e in events] == ["agent_manage_role_migration_applied"] * 2
- assert {e["tenant_id"] for e in events} == {"t1", "t2"}
+ assert [event["event"] for event in events] == ["agent_manage_role_migration_applied"] * 2
+ assert {event["tenant_id"] for event in events} == {"t1", "t2"}
assert "changed" in result.output
-def _whitelist_config(
- scope: str | None = "all",
- account_ids: list[str] | None = None,
-) -> _LegacyResourceWhitelistConfig:
- return _LegacyResourceWhitelistConfig(rbac_whitelist_scope=scope, account_ids=account_ids or [])
-
-
-@dataclass
-class _AgentPhaseMocks:
- agent_whitelist_config: MagicMock
- app_whitelist_config: MagicMock
- replace_whitelist: MagicMock
- replace_user_access_policies: MagicMock
- sync_creator_bindings: MagicMock
- owner_account_id: MagicMock
- member_batches: MagicMock
- write_order: MagicMock
-
-
-@dataclass
-class _AgentPhaseSetup:
- agents: list[tuple[str, str | None, str | None]]
- configured_agent_ids: list[str] = field(default_factory=list)
- agent_configs: list[_LegacyResourceWhitelistConfig] | None = None
- app_config: _LegacyResourceWhitelistConfig = field(default_factory=_whitelist_config)
- workspace_members: list[str] = field(default_factory=lambda: ["m1", "m2", "m3"])
- protected_members: list[str] = field(default_factory=list)
- owner_account_id: str = "owner-1"
-
-
-def _run_agent_phase(args: list[str], setup: _AgentPhaseSetup) -> tuple[Result, _AgentPhaseMocks]:
- def _member_batches(_tenant_id: str, batch_size: int) -> Iterator[list[str]]:
- for start in range(0, len(setup.workspace_members), batch_size):
- yield setup.workspace_members[start : start + batch_size]
-
- with ExitStack() as stack:
- stack.enter_context(patch(f"{MODULE}._iter_tenant_ids", return_value=iter(["t1"])))
- stack.enter_context(
- patch(
- f"{MODULE}.RBACService.Migrations.migrate_agent_manage_roles",
- return_value=LegacyAgentMigrationReport(),
+def _seed_agent(domain: RBACDomain) -> None:
+ with domain.sessions.begin() as session:
+ session.add(make_tenant(tenant_id="t1"))
+ session.add(
+ Agent(
+ id="ag1",
+ tenant_id="t1",
+ name="Agent",
+ scope=AgentScope.ROSTER,
+ source=AgentSource.ROSTER,
+ created_by="c1",
)
)
- stack.enter_context(patch(f"{MODULE}._iter_agent_row_batches", return_value=iter([setup.agents])))
- stack.enter_context(
- patch(
- f"{MODULE}.RBACService.Migrations.list_configured_agent_ids",
- return_value=setup.configured_agent_ids,
- )
- )
- agent_whitelist_config = stack.enter_context(patch(f"{MODULE}.RBACService.AgentAccess.legacy_whitelist_config"))
- if setup.agent_configs is None:
- agent_whitelist_config.return_value = _whitelist_config()
- else:
- agent_whitelist_config.side_effect = setup.agent_configs
- mocks = _AgentPhaseMocks(
- agent_whitelist_config=agent_whitelist_config,
- app_whitelist_config=stack.enter_context(
- patch(f"{MODULE}.RBACService.AppAccess.legacy_whitelist_config", return_value=setup.app_config)
- ),
- replace_whitelist=stack.enter_context(patch(f"{MODULE}.RBACService.AgentAccess.replace_whitelist")),
- replace_user_access_policies=stack.enter_context(
- patch(f"{MODULE}.RBACService.AgentAccess.replace_user_access_policies")
- ),
- sync_creator_bindings=stack.enter_context(
- patch(f"{MODULE}.RBACService.AccessPolicies.sync_creator_access_policy_member_bindings")
- ),
- owner_account_id=stack.enter_context(
- patch(f"{MODULE}._owner_account_id", return_value=setup.owner_account_id)
- ),
- member_batches=stack.enter_context(
- patch(f"{MODULE}._workspace_member_account_id_batches", side_effect=_member_batches)
- ),
- write_order=MagicMock(),
- )
-
- def _member_roles(
- *, tenant_id: str, account_id: str | None, member_account_ids: list[str]
- ) -> list[MemberRolesResponse]:
- del tenant_id, account_id
- return [
- MemberRolesResponse(
- account_id=account_id,
- roles=[
- RBACRole(
- id=f"role-{account_id}",
- type="workspace",
- category="global_system_default",
- name=account_id,
- is_builtin=True,
- role_tag="owner" if account_id == "owner-1" else "admin",
- )
- ],
- )
- for account_id in member_account_ids
- if account_id in setup.protected_members
- ]
-
- stack.enter_context(patch(f"{MODULE}.RBACService.MemberRoles.batch_get", side_effect=_member_roles))
- mocks.write_order.attach_mock(mocks.replace_user_access_policies, "seed_members")
- mocks.write_order.attach_mock(mocks.sync_creator_bindings, "sync_creator")
- mocks.write_order.attach_mock(mocks.replace_whitelist, "replace_whitelist")
- result = CliRunner().invoke(migrate_agent_permissions_to_rbac, args)
- return result, mocks
-
-
-def _write_order(mocks: _AgentPhaseMocks) -> list[str]:
- return [name for name, _, _ in mocks.write_order.mock_calls]
-
-
-def test_agent_bootstrap_apply_writes_whitelist_member_batches_and_creator_sync() -> None:
- result, mocks = _run_agent_phase(
- ["--apply", "--member-batch-size", "2"],
- _AgentPhaseSetup(
- agents=[("ag1", "c1", None)],
- workspace_members=["owner-1", "m1", "admin-1", "m2", "m3"],
- protected_members=["owner-1", "admin-1"],
- ),
- )
+ for index, account_id in enumerate(("owner-1", "m1", "admin-1", "m2", "m3")):
+ membership = TenantAccountJoin(tenant_id="t1", account_id=account_id, role=TenantAccountRole.NORMAL)
+ membership.id = f"membership-{index}"
+ session.add(membership)
+ session.add(TenantAccountJoin(tenant_id="other", account_id="foreign", role=TenantAccountRole.NORMAL))
+ domain.transport.responses["/rbac/agents/whitelist"] = {"rbac_whitelist_scope": "all"}
+ # Remote RBAC bindings protect administrators even when the local role is normal.
+ domain.transport.responses["/rbac/members/rbac-roles/batch"] = {
+ f"{role_tag}-1": [
+ {
+ "id": f"role-{role_tag}",
+ "type": "workspace",
+ "category": "global_system_default",
+ "name": role_tag,
+ "is_builtin": True,
+ "role_tag": role_tag,
+ }
+ ]
+ for role_tag in ("owner", "admin")
+ }
+
+
+def test_agent_bootstrap_apply_writes_whitelist_member_batches_and_creator_sync(rbac_domain: RBACDomain) -> None:
+ _seed_agent(rbac_domain)
+
+ result = CliRunner().invoke(rbac.migrate_agent_permissions_to_rbac, ["--apply", "--member-batch-size", "2"])
assert result.exit_code == 0, result.output
- assert [e["event"] for e in _events(result.output)] == ["agent_access_bootstrap_applied"]
+ assert [event["event"] for event in _events(result.output)] == ["agent_access_bootstrap_applied"]
assert _events(result.output)[0]["dry_run"] is False
-
- mocks.replace_whitelist.assert_called_once()
- assert mocks.replace_whitelist.call_args.kwargs["agent_id"] == "ag1"
- assert mocks.replace_whitelist.call_args.kwargs["account_id"] == "c1"
- assert mocks.replace_whitelist.call_args.kwargs["payload"].automatic_include_workspace_members is True
-
- mocks.member_batches.assert_called_once_with("t1", 2)
- assert mocks.replace_user_access_policies.call_count == 3
- calls = mocks.replace_user_access_policies.call_args_list
- assert [call.kwargs["payload"].account_ids for call in calls] == [["m1"], ["m2"], ["m3"]]
- assert all(call.kwargs["payload"].access_policy_ids == ["default"] for call in calls)
- assert all(call.kwargs["target_account_id"] is None for call in calls)
-
- mocks.sync_creator_bindings.assert_called_once()
- assert mocks.sync_creator_bindings.call_args.kwargs["resource_id"] == "ag1"
- assert mocks.sync_creator_bindings.call_args.kwargs["account_id"] == "c1"
+ role_queries = [
+ request for request in rbac_domain.transport.requests if request.endpoint == "/rbac/members/rbac-roles/batch"
+ ]
+ assert [request.json for request in role_queries] == [
+ {"member_ids": ["owner-1", "m1"]},
+ {"member_ids": ["admin-1", "m2"]},
+ {"member_ids": ["m3"]},
+ ]
+ for request in role_queries:
+ assert (request.method, request.tenant_id, request.account_id) == ("POST", "t1", "c1")
+ writes = [request for request in rbac_domain.transport.requests if request.method == "PUT"]
+ assert [request.endpoint for request in writes] == [
+ "/rbac/agents/user-access-policies",
+ "/rbac/agents/user-access-policies",
+ "/rbac/agents/user-access-policies",
+ "/rbac/access-policies/creator-member-bindings",
+ "/rbac/agents/whitelist",
+ ]
+ first, second, third, creator, whitelist = writes
+ for request in writes:
+ assert (request.tenant_id, request.account_id) == ("t1", "c1")
+ for request, account_ids in ((first, ["m1"]), (second, ["m2"]), (third, ["m3"])):
+ assert request.params == {"agent_id": "ag1", "account_id": None}
+ assert request.json == {"account_ids": account_ids, "access_policy_ids": ["default"]}
+ assert creator.params == {"resource_type": "agent", "agent_id": "ag1"}
+ assert whitelist.params == {"agent_id": "ag1"}
+ assert whitelist.json == {"automatic_include_workspace_members": True}
assert "1 agent(s) changed, 0 already initialised" in result.output
- assert _write_order(mocks) == [
- "seed_members",
- "seed_members",
- "seed_members",
- "sync_creator",
- "replace_whitelist",
- ]
+def test_agent_bootstrap_is_idempotent_on_a_second_apply(rbac_domain: RBACDomain) -> None:
+ _seed_agent(rbac_domain)
+ first = CliRunner().invoke(rbac.migrate_agent_permissions_to_rbac, ["--apply"])
+ assert first.exit_code == 0, first.output
+ assert any(request.method == "PUT" for request in rbac_domain.transport.requests)
+ rbac_domain.transport.requests.clear()
+ rbac_domain.transport.responses["/rbac/migrations/agent-access-state"] = {"configured_agent_ids": ["ag1"]}
-def test_agent_bootstrap_is_idempotent_on_a_second_apply() -> None:
- result, mocks = _run_agent_phase(
- ["--apply"],
- _AgentPhaseSetup(
- agents=[("ag1", "c1", None), ("ag2", "c2", None)],
- configured_agent_ids=["ag1", "ag2"],
- ),
- )
+ result = CliRunner().invoke(rbac.migrate_agent_permissions_to_rbac, ["--apply"])
assert result.exit_code == 0, result.output
events = _events(result.output)
- assert [e["event"] for e in events] == ["agent_access_bootstrap_skipped"] * 2
- assert {e["reason"] for e in events} == {"already_initialized"}
- mocks.replace_whitelist.assert_not_called()
- mocks.sync_creator_bindings.assert_not_called()
- mocks.replace_user_access_policies.assert_not_called()
- assert "0 agent(s) changed, 2 already initialised" in result.output
+ assert [event["event"] for event in events] == ["agent_access_bootstrap_skipped"]
+ assert events[0]["reason"] == "already_initialized"
+ assert not any(request.method == "PUT" for request in rbac_domain.transport.requests)
+ assert "0 agent(s) changed, 1 already initialised" in result.output
diff --git a/api/tests/unit_tests/commands/test_rbac_member_migration.py b/api/tests/unit_tests/commands/test_rbac_member_migration.py
new file mode 100644
index 00000000000..693a0b9b0d1
--- /dev/null
+++ b/api/tests/unit_tests/commands/test_rbac_member_migration.py
@@ -0,0 +1,44 @@
+from collections.abc import Iterator
+
+import pytest
+from click.testing import CliRunner
+
+from commands import rbac
+from tests.unit_tests.rbac_fakes import RBACDomain
+
+
[email protected]("workers", [1, 2])
+def test_member_migration_uses_shared_remote_adapter_without_write_sessions(
+ monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain, workers: int
+) -> None:
+ def batches(
+ tenant_id: str | None, *, db_batch_size: int, api_batch_size: int
+ ) -> Iterator[tuple[str, str, list[tuple[str, str]]]]:
+ assert tenant_id is None
+ assert db_batch_size > 0
+ assert api_batch_size > 0
+ yield "workspace", "owner", [("first", "editor"), ("second", "normal")]
+
+ def unexpected_session() -> None:
+ raise AssertionError("A remote role replacement must not open a database session")
+
+ monkeypatch.setattr(rbac, "_iter_tenant_member_batches", batches)
+ monkeypatch.setattr(
+ rbac, "_resolve_builtin_role_ids", lambda *_args: {"editor": "role-editor", "normal": "role-normal"}
+ )
+ monkeypatch.setattr(rbac.RBACService.MemberRoles, "batch_get", lambda **_kwargs: [])
+ monkeypatch.setattr(rbac.session_factory, "create_session", unexpected_session)
+ rbac_domain.transport.response = {"account_id": "member", "roles": []}
+
+ result = CliRunner().invoke(rbac.migrate_member_roles_to_rbac, ["--workers", str(workers)])
+
+ assert result.exit_code == 0, result.output
+ sent = rbac_domain.transport.requests
+ assert len(sent) == 2
+ for request in sent:
+ assert (request.method, request.endpoint) == ("PUT", "/rbac/members/rbac-roles")
+ assert (request.tenant_id, request.account_id) == ("workspace", "owner")
+ assert request.params is not None
+ expected_role = "role-editor" if request.params["account_id"] == "first" else "role-normal"
+ assert request.json == {"role_ids": [expected_role]}
+ assert {request.params["account_id"] for request in sent if request.params} == {"first", "second"}
diff --git a/api/tests/unit_tests/conftest.py b/api/tests/unit_tests/conftest.py
index faf5c36cbdd..9edfb9e779d 100644
--- a/api/tests/unit_tests/conftest.py
+++ b/api/tests/unit_tests/conftest.py
@@ -51,6 +51,7 @@ from extensions import ext_redis
from models.account import Account, Tenant, TenantAccountJoin, TenantAccountRole
from models.base import TypeBase
from tests.unit_tests.config_override import apply_config_overrides
+from tests.unit_tests.rbac_fakes import RBACDomain, build_rbac_domain
if TYPE_CHECKING:
from extensions.application_services.app import AppServices
@@ -339,16 +340,24 @@ def account_application_services(
@pytest.fixture
-def app_services(sqlite_session_factory: sessionmaker[Session]) -> AppServices:
+def rbac_domain(sqlite_session_factory: sessionmaker[Session], monkeypatch: pytest.MonkeyPatch) -> RBACDomain:
+ return build_rbac_domain(sqlite_session_factory, monkeypatch)
+
+
+def app_services(sqlite_session_factory: sessionmaker[Session], rbac_domain: RBACDomain) -> AppServices:
from unittest.mock import Mock
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
+ from repositories.app.console_repository import ConsoleAppRepository
from services.recommended_app_package_service import RecommendedAppPackageService
return build_app_services(
database_client=sqlite_session_factory,
+ repository=ConsoleAppRepository(session_factory=sqlite_session_factory),
+ rbac_members=rbac_domain.rbac.members,
oauth=_build_oauth_server_service(database_client=sqlite_session_factory, redis=redis_client),
recommended_packages=RecommendedAppPackageService(sources=Mock(), exporter=Mock()),
)
diff --git a/api/tests/unit_tests/controllers/common/test_agent_access.py b/api/tests/unit_tests/controllers/common/test_agent_access.py
index 33857fe03af..567693d6a82 100644
--- a/api/tests/unit_tests/controllers/common/test_agent_access.py
+++ b/api/tests/unit_tests/controllers/common/test_agent_access.py
@@ -13,7 +13,7 @@ from controllers.common.agent_access import (
)
from models.agent import Agent, AgentKind, AgentScope, AgentSource, AgentStatus
from services.app_service import AppListParams
-from services.enterprise.rbac_service import (
+from services.rbac.contracts import (
MyPermissionsResponse,
ResourcePermissionKeys,
ResourcePermissionSnapshot,
@@ -121,13 +121,12 @@ class TestResolveAgentAccessFilter:
lambda _tenant_id, _account_id: whitelist,
)
- def test_default_preview_is_unrestricted(self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session) -> None:
+ def test_default_preview_is_unrestricted(self, monkeypatch: pytest.MonkeyPatch) -> None:
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=True))
access_filter = resolve_agent_access_filter(
"tenant-1",
"account-1",
- session=unbound_session,
permissions=_permissions(agent_default_keys=["agent.acl.preview"]),
)
@@ -136,14 +135,12 @@ class TestResolveAgentAccessFilter:
def test_collects_preview_overrides_without_default_preview(
self,
monkeypatch: pytest.MonkeyPatch,
- unbound_session: Session,
) -> None:
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=True))
access_filter = resolve_agent_access_filter(
"tenant-1",
"account-1",
- session=unbound_session,
permissions=_permissions(
agent_overrides=[
ResourcePermissionKeys(
@@ -163,7 +160,6 @@ class TestResolveAgentAccessFilter:
def test_restricted_whitelist_is_the_visibility_boundary(
self,
monkeypatch: pytest.MonkeyPatch,
- unbound_session: Session,
) -> None:
self._patch_whitelist(
monkeypatch,
@@ -173,7 +169,6 @@ class TestResolveAgentAccessFilter:
access_filter = resolve_agent_access_filter(
"tenant-1",
"account-1",
- session=unbound_session,
permissions=_permissions(workspace_keys=["agent.acl.preview"]),
)
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 1a1d85ec098..8ffd9dc4de8 100644
--- a/api/tests/unit_tests/controllers/common/test_app_access.py
+++ b/api/tests/unit_tests/controllers/common/test_app_access.py
@@ -3,7 +3,6 @@
from __future__ import annotations
import pytest
-from sqlalchemy.orm import Session
from services.app.access import (
APP_LIST_PERMISSION_KEYS,
@@ -11,14 +10,14 @@ from services.app.access import (
has_app_list_permission,
resolve_app_access_filter,
)
-from services.enterprise.rbac_service import (
+from services.entities.app_entities import AppListParams
+from services.rbac.contracts import (
MyPermissionsResponse,
ResourcePermissionKeys,
ResourcePermissionSnapshot,
ResourceWhitelistResources,
WorkspacePermissionSnapshot,
)
-from services.entities.app_entities import AppListParams
_RBAC_MODULE = "services.app.access.enterprise_rbac_service"
@@ -105,31 +104,27 @@ class TestResolveAppAccessFilter:
lambda tenant_id, account_id: whitelist,
)
- def test_default_preview_is_unrestricted(self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session):
+ def test_default_preview_is_unrestricted(self, monkeypatch: pytest.MonkeyPatch):
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=True))
permissions = _permissions(app_default_keys=["app.preview"])
- flt = resolve_app_access_filter("tenant-1", "acc-1", session=unbound_session, permissions=permissions)
+ flt = resolve_app_access_filter("tenant-1", "acc-1", permissions=permissions)
assert flt.accessible_app_ids is None
assert flt.can_manage_own_apps is False
- def test_restricted_whitelist_overrides_default_preview(
- self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
- ):
+ def test_restricted_whitelist_overrides_default_preview(self, monkeypatch: pytest.MonkeyPatch):
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=False, resource_ids=["app-9"]))
permissions = _permissions(
workspace_keys=["app.full_access", "app.create_and_management"],
)
- flt = resolve_app_access_filter("tenant-1", "acc-1", session=unbound_session, permissions=permissions)
+ flt = resolve_app_access_filter("tenant-1", "acc-1", permissions=permissions)
assert flt.accessible_app_ids == {"app-9"}
assert flt.can_manage_own_apps is False
- def test_override_apps_collected_without_default_preview(
- self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
- ):
+ def test_override_apps_collected_without_default_preview(self, monkeypatch: pytest.MonkeyPatch):
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=True))
permissions = _permissions(
app_overrides=[
@@ -138,29 +133,26 @@ class TestResolveAppAccessFilter:
],
)
- flt = resolve_app_access_filter("tenant-1", "acc-1", session=unbound_session, permissions=permissions)
+ flt = resolve_app_access_filter("tenant-1", "acc-1", permissions=permissions)
assert flt.accessible_app_ids == {"app-1"}
- def test_restricted_whitelist_ignores_override_apps(
- self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
- ):
+ def test_restricted_whitelist_ignores_override_apps(self, monkeypatch: pytest.MonkeyPatch):
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=False, resource_ids=["app-5"]))
permissions = _permissions(
app_overrides=[ResourcePermissionKeys(resource_id="app-1", permission_keys=["app.acl.preview"])],
)
- flt = resolve_app_access_filter("tenant-1", "acc-1", session=unbound_session, permissions=permissions)
+ flt = resolve_app_access_filter("tenant-1", "acc-1", permissions=permissions)
assert flt.accessible_app_ids == {"app-5"}
- def test_fetches_permissions_when_not_supplied(self, monkeypatch: pytest.MonkeyPatch, unbound_session: Session):
+ def test_fetches_permissions_when_not_supplied(self, monkeypatch: pytest.MonkeyPatch):
self._patch_whitelist(monkeypatch, ResourceWhitelistResources(unrestricted=False, resource_ids=[]))
- session = unbound_session
captured: dict[str, object] = {}
- def get_permissions(tenant_id: str, account_id: str, *, session: object):
- captured.update(tenant_id=tenant_id, account_id=account_id, session=session)
+ def get_permissions(tenant_id: str, account_id: str):
+ captured.update(tenant_id=tenant_id, account_id=account_id)
return _permissions(workspace_keys=["app.create_and_management"])
monkeypatch.setattr(
@@ -168,8 +160,11 @@ class TestResolveAppAccessFilter:
get_permissions,
)
- flt = resolve_app_access_filter("tenant-1", "acc-1", session=session)
+ flt = resolve_app_access_filter(
+ "tenant-1",
+ "acc-1",
+ )
assert flt.accessible_app_ids == set()
assert flt.can_manage_own_apps is False
- assert captured == {"tenant_id": "tenant-1", "account_id": "acc-1", "session": session}
+ assert captured == {"tenant_id": "tenant-1", "account_id": "acc-1"}
diff --git a/api/tests/unit_tests/controllers/common/test_rbac_locators.py b/api/tests/unit_tests/controllers/common/test_rbac_locators.py
new file mode 100644
index 00000000000..84bcdaf2234
--- /dev/null
+++ b/api/tests/unit_tests/controllers/common/test_rbac_locators.py
@@ -0,0 +1,146 @@
+"""HTTP resource resolution uses composed queries and request-local snapshots."""
+
+import pytest
+from flask import Flask
+from sqlalchemy import Engine, event, text
+from werkzeug.exceptions import NotFound
+
+from controllers.common.errors import InvalidArgumentError
+from controllers.common.rbac import locators
+from core.rbac import RBACResourceScope
+from models.agent import Agent, AgentScope, AgentSource, AgentStatus
+from models.model import AppMode
+from tests.unit_tests.model_factories import make_app, make_dataset, make_document
+from tests.unit_tests.rbac_fakes import RBACDomain
+
+
[email protected](autouse=True)
+def services(monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain) -> None:
+ monkeypatch.setattr(locators, "application_services", lambda: rbac_domain)
+
+
+ "locator",
+ [
+ locators.PlainApp(),
+ locators.AgentBehindApp(),
+ locators.AgentId(),
+ locators.DatasetId(),
+ locators.DatasetByDocument(),
+ locators.DatasetByPipeline(),
+ ],
+)
+def test_missing_resource_parameter_is_an_explicit_input_error(locator: locators.ResourceLocator) -> None:
+ with pytest.raises(InvalidArgumentError, match="Missing .* in request path") as raised:
+ locator.locate("workspace", {})
+ assert raised.value.code == 400
+ assert raised.value.error_code == "invalid_param"
+
+
[email protected]("scope", [AgentScope.ROSTER, AgentScope.WORKFLOW_ONLY])
[email protected]("status", [AgentStatus.ACTIVE, AgentStatus.ARCHIVED])
+def test_agent_app_resolution_preserves_scope_and_archived_bindings(
+ app: Flask, rbac_domain: RBACDomain, scope: AgentScope, status: AgentStatus
+) -> None:
+ with rbac_domain.sessions.begin() as session:
+ session.add(make_app(app_id="app", tenant_id="workspace", mode=AppMode.AGENT))
+ session.add(
+ Agent(
+ id="agent",
+ tenant_id="workspace",
+ name="Agent",
+ scope=scope,
+ source=AgentSource.AGENT_APP if scope == AgentScope.ROSTER else AgentSource.WORKFLOW,
+ app_id="app" if scope == AgentScope.ROSTER else "workflow",
+ backing_app_id="app" if scope == AgentScope.WORKFLOW_ONLY else None,
+ status=status,
+ )
+ )
+
+ with app.test_request_context():
+ assert locators.PlainApp().locate("workspace", {"app_id": "app"}) is None
+ assert locators.AgentBehindApp().locate("workspace", {"app_id": "app"}) == (
+ locators.ResourceIdentity(RBACResourceScope.AGENT, "agent") if scope == AgentScope.ROSTER else None
+ )
+
+
+def test_binding_cache_is_tenant_scoped_and_expires_with_request(
+ app: Flask, rbac_domain: RBACDomain, sqlite_engine: Engine
+) -> None:
+ with rbac_domain.sessions.begin() as session:
+ session.add(make_app(app_id="app", tenant_id="workspace", mode=AppMode.AGENT))
+ queries: list[str] = []
+
+ def record_query(
+ _connection: object, _cursor: object, statement: str, _parameters: object, _context: object, _executemany: bool
+ ) -> None:
+ queries.append(statement)
+
+ event.listen(sqlite_engine, "before_cursor_execute", record_query)
+ try:
+ with app.app_context(), app.test_request_context():
+ assert locators.agent_binding("workspace", "app") is None
+ reads = len(queries)
+ assert reads > 0
+ assert locators.agent_binding("workspace", "app") is None
+ assert len(queries) == reads
+ assert locators.agent_binding("other-workspace", "app") is None
+ assert len(queries) > reads
+
+ with rbac_domain.sessions.begin() as session:
+ session.add(
+ Agent(
+ id="agent",
+ tenant_id="workspace",
+ name="Agent",
+ scope=AgentScope.ROSTER,
+ source=AgentSource.AGENT_APP,
+ app_id="app",
+ status=AgentStatus.ACTIVE,
+ )
+ )
+ with app.app_context(), app.test_request_context():
+ binding = locators.agent_binding("workspace", "app")
+ assert binding is not None
+ assert binding.id == "agent"
+ assert locators.agent_binding("other-workspace", "app") is None
+ finally:
+ event.remove(sqlite_engine, "before_cursor_execute", record_query)
+
+
[email protected]("normal", [True, False])
+def test_app_owner_resolution_preserves_normal_app_requirement(
+ app: Flask, rbac_domain: RBACDomain, normal: bool
+) -> None:
+ with rbac_domain.sessions.begin() as session:
+ session.add(make_app(app_id="app", tenant_id="workspace", maintainer="owner"))
+ if not normal:
+ session.flush()
+ session.execute(text("UPDATE apps SET status = 'disabled' WHERE id = 'app'"))
+ with app.test_request_context():
+ locator = locators.PlainApp()
+ identity = locators.ResourceIdentity(RBACResourceScope.APP, "app")
+ assert locator.owner_id("workspace", identity) == ("owner" if normal else None)
+ assert locator.owner_id("other-workspace", identity) is None
+
+
[email protected]("locator", [locators.DatasetByDocument(), locators.DatasetByPipeline()])
+def test_nested_dataset_resolution_checks_ownership_and_maps_missing_resources(
+ app: Flask, rbac_domain: RBACDomain, locator: locators.DatasetByDocument | locators.DatasetByPipeline
+) -> None:
+ with rbac_domain.sessions.begin() as session:
+ dataset = make_dataset(dataset_id="dataset", tenant_id="workspace", maintainer="owner")
+ dataset.pipeline_id = "pipeline"
+ session.add(dataset)
+ session.add(make_document(document_id="document", dataset_id="dataset", tenant_id="workspace"))
+ args = {"document_id": "document", "pipeline_id": "pipeline"}
+ with app.test_request_context():
+ identity = locator.locate("workspace", args)
+ assert identity is not None
+ assert identity == locators.ResourceIdentity(RBACResourceScope.DATASET, "dataset")
+ assert locator.owner_id("workspace", identity) == "owner"
+ assert locator.owner_id("other-workspace", identity) is None
+ with pytest.raises(NotFound):
+ locator.locate("other-workspace", args)
+ with pytest.raises(NotFound):
+ locator.locate("workspace", {"document_id": "missing", "pipeline_id": "missing"})
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 2b492eb798e..2e2eae45a68 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
@@ -68,6 +68,7 @@ from models.agent import Agent, AgentConfigDraftType, AgentScope, AgentSource, A
from models.enums import ApiTokenType, ConversationFromSource, CustomizeTokenStrategy, TagType
from models.model import ApiToken, App, AppMode, Conversation, IconType, Message, Site, Tag, TagBinding
from services.agent.observability_service import AgentLogQueryParams, AgentStatisticsQueryParams
+from services.enterprise.rbac_service import RBACService
from services.entities.agent_entities import (
ComposerSavePayload,
ComposerSaveStrategy,
@@ -78,6 +79,12 @@ from services.entities.agent_entities import (
from services.entities.app_entities import AgentAppPublicationCounts, AppListParams, CreateAppParams
from tests.unit_tests.config_override import apply_config_overrides
from tests.unit_tests.model_factories import make_account
+from tests.unit_tests.rbac_fakes import RBACDomain
+
+
[email protected](autouse=True)
+def rbac_services(monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain) -> None:
+ monkeypatch.setattr(roster_controller, "application_services", lambda: rbac_domain)
def _persist_conversation_message(
@@ -343,10 +350,10 @@ def test_agent_app_list_and_create_use_agent_route(
]
)
sqlite_session.flush()
- permissions = roster_controller.enterprise_rbac_service.MyPermissionsResponse(
- agent=roster_controller.enterprise_rbac_service.ResourcePermissionSnapshot(
+ permissions = roster_controller.rbac_contracts.MyPermissionsResponse(
+ agent=roster_controller.rbac_contracts.ResourcePermissionSnapshot(
overrides=[
- roster_controller.enterprise_rbac_service.ResourcePermissionKeys(
+ roster_controller.rbac_contracts.ResourcePermissionKeys(
resource_id="agent-list",
permission_keys=["agent.acl.preview"],
)
@@ -360,7 +367,7 @@ def test_agent_app_list_and_create_use_agent_route(
params.accessible_app_ids = ["app-list"]
monkeypatch.setattr(
- roster_controller.enterprise_rbac_service.RBACService.MyPermissions,
+ RBACService.MyPermissions,
"get",
lambda *_args, **_kwargs: permissions,
)
@@ -642,11 +649,12 @@ def test_agent_app_detail_update_delete_resolve_app_from_agent_id(
"agent_has_workflow_callable_active_snapshot",
lambda **_kwargs: False,
)
+ apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
monkeypatch.setattr(
- roster_controller.enterprise_rbac_service.RBACService.MyPermissions,
+ RBACService.MyPermissions,
"get",
- lambda *_args, **_kwargs: roster_controller.enterprise_rbac_service.MyPermissionsResponse(
- agent=roster_controller.enterprise_rbac_service.ResourcePermissionSnapshot(
+ lambda *_args, **_kwargs: roster_controller.rbac_contracts.MyPermissionsResponse(
+ agent=roster_controller.rbac_contracts.ResourcePermissionSnapshot(
default_permission_keys=["agent.acl.preview"]
)
),
@@ -1096,10 +1104,10 @@ def test_invite_options_get_applies_resource_visibility(
monkeypatch: pytest.MonkeyPatch,
) -> None:
captured: dict[str, object] = {}
- permissions = roster_controller.enterprise_rbac_service.MyPermissionsResponse()
+ permissions = roster_controller.rbac_contracts.MyPermissionsResponse()
monkeypatch.setattr(
- roster_controller.enterprise_rbac_service.RBACService.MyPermissions,
+ RBACService.MyPermissions,
"get",
lambda *_args, **_kwargs: permissions,
)
diff --git a/api/tests/unit_tests/controllers/console/app/test_message_suggested_questions.py b/api/tests/unit_tests/controllers/console/app/test_message_suggested_questions.py
index 4ba13562a30..44014ae4964 100644
--- a/api/tests/unit_tests/controllers/console/app/test_message_suggested_questions.py
+++ b/api/tests/unit_tests/controllers/console/app/test_message_suggested_questions.py
@@ -22,6 +22,7 @@ from core.errors.error import ModelCurrentlyNotSupportError, ProviderTokenNotIni
from core.model_manager import ModelInstance
from core.ops.ops_trace_manager import TraceTask
from extensions.application_services.app import AppServices
+from extensions.application_services.rbac import RBACServices
from extensions.ext_database import db
from graphon.model_runtime.entities.llm_entities import LLMResult, LLMUsage
from graphon.model_runtime.entities.message_entities import AssistantPromptMessage, PromptMessage
@@ -59,6 +60,7 @@ from services.message_suggested_questions_service import (
)
from tests.unit_tests.config_override import apply_config_overrides
from tests.unit_tests.model_factories import make_account, make_app, make_conversation, make_message
+from tests.unit_tests.rbac_fakes import RBACDomain
@dataclass
@@ -92,6 +94,7 @@ class _Services:
apps: AppServices
agent_apps: _Agents
message_suggested_questions: MessageSuggestedQuestions
+ rbac: RBACServices
@dataclass
@@ -177,6 +180,7 @@ def harness(
sqlite_engine: Engine,
sqlite_session_factory: sessionmaker[Session],
app_services: AppServices,
+ rbac_domain: RBACDomain,
) -> Iterator[_Harness]:
target = make_app(app_id=str(uuid4()), tenant_id=str(uuid4()))
account = make_account(account_id=str(uuid4()))
@@ -240,6 +244,7 @@ def harness(
app_services,
_Agents(AgentAppAccessService(references=AgentAppRepository(session_factory=sqlite_session_factory))),
MessageSuggestedQuestionsRuntime(session_factory=sqlite_session_factory),
+ rbac_domain.rbac,
)
flask_app.extensions["application_services"] = services
api = ExternalApi(flask_app)
diff --git a/api/tests/unit_tests/controllers/console/app/test_workflow.py b/api/tests/unit_tests/controllers/console/app/test_workflow.py
index b17728697cc..a74e12c3f3a 100644
--- a/api/tests/unit_tests/controllers/console/app/test_workflow.py
+++ b/api/tests/unit_tests/controllers/console/app/test_workflow.py
@@ -23,6 +23,7 @@ from graphon.variables.variables import RAGPipelineVariable
from models.account import Account
from models.model import App, AppMode
from models.workflow import Workflow, WorkflowType
+from services.app.access import AppAccessFilter
from tests.unit_tests.config_override import apply_config_overrides
@@ -1100,27 +1101,36 @@ def test_trigger_run_loads_draft_with_request_session(
get_draft_workflow.assert_called_once_with(app_model, session=session)
-def test_workflow_online_users_filters_inaccessible_workflow(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
+def test_workflow_online_users_filters_inaccessible_workflow(
+ app: Flask, monkeypatch: pytest.MonkeyPatch, unbound_session: Session
+) -> None:
app_id_1 = "11111111-1111-1111-1111-111111111111"
app_id_2 = "22222222-2222-2222-2222-222222222222"
signed_avatar_url = "https://files.example.com/signed/avatar-1"
- sign_avatar = Mock(return_value=signed_avatar_url)
- get_tenant_app_maintainers = Mock(return_value={app_id_1: "owner-1", app_id_2: "owner-2"})
- monkeypatch.setattr(
- workflow_module,
- "WorkflowService",
- lambda: SimpleNamespace(get_tenant_app_maintainers=get_tenant_app_maintainers),
- )
- access_filter = SimpleNamespace(is_app_accessible=lambda app_id, _maintainer, _account_id: app_id == app_id_1)
- resolve_access = Mock(return_value=access_filter)
+ signed_ids: list[str] = []
+ queries: list[tuple[list[str], str, Session]] = []
+ actors: list[tuple[str, str]] = []
+
+ def sign_avatar(file_id: str) -> str:
+ signed_ids.append(file_id)
+ return signed_avatar_url
+
+ class WorkflowQueries:
+ def get_tenant_app_maintainers(self, app_ids: list[str], tenant_id: str, *, session: Session) -> dict[str, str]:
+ queries.append((app_ids, tenant_id, session))
+ return {app_id_1: "owner-1", app_id_2: "owner-2"}
+
+ def resolve_access(tenant_id: str, account_id: str) -> AppAccessFilter:
+ actors.append((tenant_id, account_id))
+ return AppAccessFilter(accessible_app_ids={app_id_1}, can_manage_own_apps=False)
+
+ monkeypatch.setattr(workflow_module, "WorkflowService", WorkflowQueries)
monkeypatch.setattr(workflow_module, "resolve_app_access_filter", resolve_access)
apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
monkeypatch.setattr(workflow_module.file_helpers, "get_signed_file_url", sign_avatar)
- short_session = Mock()
- monkeypatch.setattr(workflow_module.session_factory, "create_session", lambda: nullcontext(short_session))
+ monkeypatch.setattr(workflow_module.session_factory, "create_session", lambda: nullcontext(unbound_session))
- redis_pipeline = Mock()
- redis_pipeline.execute.return_value = [
+ redis_result = [
{
b"sid-1": json.dumps(
{
@@ -1154,8 +1164,23 @@ def test_workflow_online_users_filters_inaccessible_workflow(app: Flask, monkeyp
),
}
]
- redis_pipeline_factory = Mock(return_value=redis_pipeline)
- monkeypatch.setattr(workflow_module.redis_client, "pipeline", redis_pipeline_factory)
+ redis_keys: list[str] = []
+ pipeline_transactions: list[bool] = []
+ executions: list[bool] = []
+
+ class PresencePipeline:
+ def hgetall(self, key: str) -> None:
+ redis_keys.append(key)
+
+ def execute(self) -> list[dict[bytes, str]]:
+ executions.append(True)
+ return redis_result
+
+ def pipeline(*, transaction: bool) -> PresencePipeline:
+ pipeline_transactions.append(transaction)
+ return PresencePipeline()
+
+ monkeypatch.setattr(workflow_module.redis_client, "pipeline", pipeline)
api = workflow_module.WorkflowOnlineUsersApi()
handler = inspect.unwrap(api.post)
@@ -1166,7 +1191,9 @@ def test_workflow_online_users_filters_inaccessible_workflow(app: Flask, monkeyp
json={"app_ids": [app_id_1, app_id_2]},
):
args = workflow_module.WorkflowOnlineUsersPayload.model_validate({"app_ids": [app_id_1, app_id_2]})
- response = handler(api, args, "tenant-1", SimpleNamespace(id="account-1"))
+ actor = _account()
+ actor.id = "account-1"
+ response = handler(api, args, "tenant-1", actor)
assert response == {
"data": [
@@ -1187,15 +1214,12 @@ def test_workflow_online_users_filters_inaccessible_workflow(app: Flask, monkeyp
}
]
}
- redis_pipeline_factory.assert_called_once_with(transaction=False)
- redis_pipeline.hgetall.assert_called_once_with(f"{workflow_module.WORKFLOW_ONLINE_USERS_PREFIX}{app_id_1}")
- redis_pipeline.execute.assert_called_once_with()
- sign_avatar.assert_called_once_with("avatar-file-id")
- get_tenant_app_maintainers.assert_called_once()
- resolve_access.assert_called_once()
- assert get_tenant_app_maintainers.call_args.args == ([app_id_1, app_id_2], "tenant-1")
- assert resolve_access.call_args.args == ("tenant-1", "account-1")
- assert get_tenant_app_maintainers.call_args.kwargs["session"] is resolve_access.call_args.kwargs["session"]
+ assert pipeline_transactions == [False]
+ assert redis_keys == [f"{workflow_module.WORKFLOW_ONLINE_USERS_PREFIX}{app_id_1}"]
+ assert executions == [True]
+ assert signed_ids == ["avatar-file-id"]
+ assert queries == [([app_id_1, app_id_2], "tenant-1", unbound_session)]
+ assert actors == [("tenant-1", "account-1")]
def test_workflow_online_users_batches_redis_reads(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
diff --git a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
index e3177ff5365..34762805286 100644
--- a/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
+++ b/api/tests/unit_tests/controllers/console/datasets/rag_pipeline/test_rag_pipeline_datasets.py
@@ -18,8 +18,8 @@ from controllers.console.datasets.rag_pipeline.rag_pipeline_datasets import (
RagPipelineDatasetImportPayload,
)
from models.account import Account, TenantAccountRole
-from services.enterprise import rbac_service as enterprise_rbac_service
from services.entities.dsl_entities import ImportStatus
+from services.rbac import contracts as rbac_contracts
from tests.unit_tests.config_override import config_overrides_context
from tests.unit_tests.model_factories import make_account
@@ -122,9 +122,7 @@ class TestCreateRagPipelineDatasetApi:
assert status == 201
assert sync_creator.called, "RAG pipeline create must sync the creator's own access"
- sync_creator.assert_called_once_with(
- "tenant-1", user.id, enterprise_rbac_service.RBACResourceType.DATASET, "ds-1"
- )
+ sync_creator.assert_called_once_with("tenant-1", user.id, rbac_contracts.RBACResourceType.DATASET, "ds-1")
assert response["dataset_id"] == "ds-1"
def test_post_forbidden_non_editor(self, app: Flask) -> None:
diff --git a/api/tests/unit_tests/controllers/console/workspace/test_members.py b/api/tests/unit_tests/controllers/console/workspace/test_members.py
index d542d8c7322..e1925b11db1 100644
--- a/api/tests/unit_tests/controllers/console/workspace/test_members.py
+++ b/api/tests/unit_tests/controllers/console/workspace/test_members.py
@@ -1,9 +1,10 @@
from collections.abc import Callable
from datetime import datetime
from http import HTTPStatus
+from importlib import import_module
from inspect import unwrap
from typing import NamedTuple, override
-from unittest.mock import Mock, create_autospec, patch
+from unittest.mock import Mock, create_autospec
import pytest
from flask import Flask
@@ -60,10 +61,14 @@ class _RecordingWorkspaceMemberQueryService(WorkspaceMemberQueryService):
def __init__(self, result: tuple[WorkspaceMemberSummary, ...]) -> None:
self._result = result
self.contexts: list[RequestContext] = []
+ self.languages: list[str | None] = []
@override
- def list_current(self, context: RequestContext) -> tuple[WorkspaceMemberSummary, ...]:
+ def list_current(
+ self, context: RequestContext, *, language: str | None = None
+ ) -> tuple[WorkspaceMemberSummary, ...]:
self.contexts.append(context)
+ self.languages.append(language)
return self._result
@@ -76,7 +81,10 @@ class _ApplicationServicesStub(NamedTuple):
class TestMemberListApi:
- def test_get_passes_context_and_serializes_application_result(self, app: Flask) -> None:
+ @pytest.mark.parametrize(("language", "expected"), [("", None), (" JA ", "ja"), ("unknown", None)])
+ def test_get_passes_context_and_serializes_application_result(
+ self, app: Flask, monkeypatch: pytest.MonkeyPatch, language: str, expected: str | None
+ ) -> None:
api = MemberListApi()
method = unwrap(api.get)
request_context = RequestContext(
@@ -107,13 +115,12 @@ class TestMemberListApi:
)
application_services_stub = _ApplicationServicesStub(_WorkspaceServicesStub(workspace_member_queries))
- with (
- app.test_request_context("/"),
- patch(
- "controllers.console.workspace.members.application_services",
- return_value=application_services_stub,
- ),
- ):
+ monkeypatch.setattr(
+ import_module("controllers.console.workspace.members"),
+ "application_services",
+ lambda: application_services_stub,
+ )
+ with app.test_request_context("/", query_string={"language": language}):
result, status = method(api, request_context=request_context)
assert status == HTTPStatus.OK
@@ -138,6 +145,7 @@ class TestMemberListApi:
]
}
assert workspace_member_queries.contexts == [request_context]
+ assert workspace_member_queries.languages == [expected]
@pytest.fixture
diff --git a/api/tests/unit_tests/controllers/console/workspace/test_rbac.py b/api/tests/unit_tests/controllers/console/workspace/test_rbac.py
index 3bbfe1e281c..0d9e785e108 100644
--- a/api/tests/unit_tests/controllers/console/workspace/test_rbac.py
+++ b/api/tests/unit_tests/controllers/console/workspace/test_rbac.py
@@ -1,170 +1,45 @@
-"""Controller tests for ``controllers.console.workspace.rbac``.
-
-The controllers here are thin: almost every non-trivial behaviour lives in
-``services.enterprise.rbac_service`` (covered by its own suite). These tests
-therefore focus on the Flask-layer concerns the service layer cannot exercise:
-
-* ``_current_ids`` raises 404 when the session has no tenant.
-* The pydantic request models accept / reject bodies as expected.
-
-We explicitly avoid "happy-path" integration tests through the full
-decorator stack — those belong in e2e tests where a real Dify session is
-available — to keep this suite fast and resilient to ancillary auth wiring
-changes.
-"""
-
-from __future__ import annotations
+"""RBAC transport tests use real services, SQLite and an explicit Enterprise transport fake."""
import inspect
-from unittest.mock import patch
+from collections.abc import Callable
+from uuid import UUID
import pytest
from flask import Flask
+from flask_restx import Resource
from pydantic import ValidationError
-from werkzeug.exceptions import Forbidden, NotFound
-
-from configs import dify_config
-from controllers.console.workspace import rbac as rbac_mod
-from controllers.console.workspace.rbac import _RolesListQuery
+from sqlalchemy import select
+from sqlalchemy.orm import Session, sessionmaker
+from werkzeug.exceptions import Forbidden
+
+from controllers.common.errors import InvalidArgumentError
+from controllers.common.rbac import rbac_language
+from controllers.console import flask_admission, wraps
+from controllers.console.workspace.rbac import members, policies, roles, schemas
from enums import DeploymentEdition
-from models import Account
-from tests.unit_tests.model_factories import make_account
-
-
-def app():
- flask_app = Flask(__name__)
- flask_app.config["TESTING"] = True
- return flask_app
-
-
[email protected](autouse=True)
-def _rbac_config(config_overrides) -> None:
- config_overrides(
- DEPLOYMENT_EDITION=DeploymentEdition.ENTERPRISE,
- RBAC_ENABLED=True,
- LOGIN_DISABLED=True,
- )
-
+from enums.account import TenantAccountRole
+from libs.external_api import ExternalApi
+from libs.login import AccountWithTenant
+from machinery.context import RequestContext
+from models.account import Account, AccountStatus, TenantAccountJoin
+from services.rbac import contracts as dto
+from tests.unit_tests.model_factories import make_account, make_tenant
+from tests.unit_tests.rbac_fakes import RBACDomain, build_rbac_domain
-def _account() -> Account:
- return make_account(account_id="acct-1", name="RBAC User", email="[email protected]")
+CONTEXT = RequestContext("request", "trace", "actor", "tenant")
-class TestCurrentIds:
- def test_rejects_missing_tenant(self):
- with patch("controllers.console.workspace.rbac.current_account_with_tenant") as mock_user:
- mock_user.return_value = (_account(), None)
- with pytest.raises(NotFound):
- rbac_mod._current_ids()
-
- def test_returns_tuple(self):
- with patch("controllers.console.workspace.rbac.current_account_with_tenant") as mock_user:
- mock_user.return_value = (_account(), "tenant-1")
- assert rbac_mod._current_ids() == ("tenant-1", "acct-1")
-
-
-class TestMyPermissions:
- def test_returns_app_deploy_permission(self, app):
- permissions = rbac_mod.svc.MyPermissionsResponse(
- app=rbac_mod.svc.ResourcePermissionSnapshot(
- default_permission_keys=["app.acl.deploy"],
- )
- )
- with (
- app.test_request_context("/workspaces/current/rbac/my-permissions"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch(
- "controllers.console.workspace.rbac.svc.RBACService.MyPermissions.get",
- return_value=permissions,
- ) as mock_get,
- ):
- response = inspect.unwrap(rbac_mod.RBACMyPermissionsApi.get)(rbac_mod.RBACMyPermissionsApi())
-
- assert response["app"]["default_permission_keys"] == ["app.acl.deploy"]
- mock_get.assert_called_once()
-
- def test_forwards_agent_id_query_param(self, app):
- permissions = rbac_mod.svc.MyPermissionsResponse(
- agent=rbac_mod.svc.ResourcePermissionSnapshot(
- default_permission_keys=["agent.acl.preview"],
- )
- )
- with (
- app.test_request_context("/workspaces/current/rbac/my-permissions?agent_id=agent-1"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch(
- "controllers.console.workspace.rbac.svc.RBACService.MyPermissions.get",
- return_value=permissions,
- ) as mock_get,
- ):
- response = inspect.unwrap(rbac_mod.RBACMyPermissionsApi.get)(rbac_mod.RBACMyPermissionsApi())
-
- assert mock_get.call_args.kwargs["agent_id"] == "agent-1"
- assert response["agent"]["default_permission_keys"] == ["agent.acl.preview"]
-
-
-class TestAccessMatrixAccountNames:
- def test_hydrates_missing_account_names(self):
- items = [
- rbac_mod.svc.AccessMatrixItem(
- accounts=[
- {"account_id": "acct-1", "account_name": "Alice", "binding_id": "binding-1"},
- {"account_id": "acct-2", "account_name": "", "binding_id": "binding-2"},
- ]
- )
- ]
-
- with patch(
- "controllers.console.workspace.rbac._account_names_by_ids",
- return_value={"acct-2": {"name": "Bob", "avatar": "ava"}},
- ) as mock_names:
- rbac_mod._hydrate_access_matrix_account_names(items)
-
- mock_names.assert_called_once_with(["acct-2"])
- assert items[0].accounts[0].account_id == "acct-1"
- assert items[0].accounts[0].account_name == "Alice"
- assert items[0].accounts[1].account_id == "acct-2"
- assert items[0].accounts[1].account_name == "Bob"
- assert items[0].accounts[1].avatar == "ava"
-
- def test_hydrates_resource_user_account_names(self):
- items = [
- rbac_mod.svc.ResourceUserAccessPolicies(
- account={"account_id": "acct-1", "account_name": ""},
- roles=[],
- access_policies=[],
- )
- ]
-
- with patch(
- "controllers.console.workspace.rbac._account_names_by_ids",
- return_value={"acct-1": {"name": "Alice", "avatar": ""}},
- ):
- rbac_mod._hydrate_resource_user_account_names(items)
-
- assert items[0].account.account_name == "Alice"
-
- def test_moves_resource_maintainer_to_first_position(self):
- items = [
- rbac_mod.svc.ResourceUserAccessPolicies(account={"account_id": "acct-2"}),
- rbac_mod.svc.ResourceUserAccessPolicies(account={"account_id": "acct-maintainer"}),
- rbac_mod.svc.ResourceUserAccessPolicies(account={"account_id": "acct-3"}),
- ]
-
- rbac_mod._move_resource_maintainer_first(items, "acct-maintainer")
-
- assert [item.account.account_id for item in items] == ["acct-maintainer", "acct-2", "acct-3"]
-
- def test_keeps_resource_user_order_when_maintainer_is_not_on_page(self):
- items = [
- rbac_mod.svc.ResourceUserAccessPolicies(account={"account_id": "acct-2"}),
- rbac_mod.svc.ResourceUserAccessPolicies(account={"account_id": "acct-3"}),
- ]
-
- rbac_mod._move_resource_maintainer_first(items, "acct-maintainer")
-
- assert [item.account.account_id for item in items] == ["acct-2", "acct-3"]
+def domain(
+ monkeypatch: pytest.MonkeyPatch,
+ sqlite_session_factory: sessionmaker[Session],
+ config_overrides: Callable[..., None],
+) -> RBACDomain:
+ config_overrides(DEPLOYMENT_EDITION=DeploymentEdition.CLOUD, RBAC_ENABLED=True, LOGIN_DISABLED=True)
+ domain = build_rbac_domain(sqlite_session_factory, monkeypatch)
+ for module in (roles, policies, members):
+ monkeypatch.setattr(module, "application_services", lambda: domain)
+ return domain
class TestPydanticModels:
@@ -173,12 +48,12 @@ class TestPydanticModels:
missing required fields) — trivial `str` fields are not worth asserting.
"""
- def test_role_upsert_requires_name(self):
+ def test_role_upsert_requires_name(self) -> None:
with pytest.raises(ValidationError):
- rbac_mod._RoleUpsertRequest.model_validate({})
+ schemas._RoleUpsertRequest.model_validate({})
- def test_role_upsert_to_mutation_preserves_fields(self):
- payload = rbac_mod._RoleUpsertRequest.model_validate(
+ def test_role_upsert_to_mutation_preserves_fields(self) -> None:
+ payload = schemas._RoleUpsertRequest.model_validate(
{
"name": "Owner",
"description": "full access",
@@ -189,8 +64,8 @@ class TestPydanticModels:
assert mutation.description == "full access"
assert mutation.permission_keys == ["workspace.member.manage"]
- def test_access_policy_create_parses_resource_type_enum(self):
- parsed = rbac_mod._AccessPolicyCreateRequest.model_validate(
+ def test_access_policy_create_parses_resource_type_enum(self) -> None:
+ parsed = schemas._AccessPolicyCreateRequest.model_validate(
{
"name": "Full access",
"resource_type": "app",
@@ -198,262 +73,199 @@ class TestPydanticModels:
"permission_keys": [],
}
)
- assert parsed.resource_type is rbac_mod.svc.RBACResourceType.APP
+ assert parsed.resource_type is dto.RBACResourceType.APP
- def test_access_policy_create_rejects_unknown_resource_type(self):
+ def test_access_policy_create_rejects_unknown_resource_type(self) -> None:
with pytest.raises(ValidationError):
- rbac_mod._AccessPolicyCreateRequest.model_validate({"name": "bad", "resource_type": "unknown"})
+ schemas._AccessPolicyCreateRequest.model_validate({"name": "bad", "resource_type": "unknown"})
- def test_resource_access_scope_requires_automatic_include_workspace_members(self):
+ def test_resource_access_scope_requires_automatic_include_workspace_members(self) -> None:
with pytest.raises(ValidationError):
- rbac_mod._ResourceAccessScopeRequest.model_validate({})
+ schemas._ResourceAccessScopeRequest.model_validate({})
- def test_resource_access_scope_accepts_automatic_include_workspace_members(self):
- parsed = rbac_mod._ResourceAccessScopeRequest.model_validate({"automatic_include_workspace_members": True})
+ def test_resource_access_scope_accepts_automatic_include_workspace_members(self) -> None:
+ parsed = schemas._ResourceAccessScopeRequest.model_validate({"automatic_include_workspace_members": True})
assert parsed.automatic_include_workspace_members is True
- def test_replace_bindings_keeps_role_binding_contract(self):
- parsed = rbac_mod._ReplaceBindingsRequest.model_validate({"role_ids": None})
+ def test_replace_bindings_keeps_role_binding_contract(self) -> None:
+ parsed = schemas._ReplaceBindingsRequest.model_validate({"role_ids": None})
assert parsed.role_ids == []
- def test_replace_member_roles_coerce_null_list(self):
- parsed = rbac_mod._ReplaceMemberRolesRequest.model_validate({"role_ids": None})
+ def test_replace_member_roles_coerce_null_list(self) -> None:
+ parsed = schemas._ReplaceMemberRolesRequest.model_validate({"role_ids": None})
assert parsed.role_ids == []
- def test_pagination_query_accepts_page_and_limit_aliases(self):
- parsed = rbac_mod._PaginationQuery.model_validate({"page": 3, "limit": 25, "reverse": True})
+ def test_pagination_query_accepts_page_and_limit_aliases(self) -> None:
+ parsed = schemas._PaginationQuery.model_validate({"page": 3, "limit": 25, "reverse": True})
assert parsed.page_number == 3
assert parsed.results_per_page == 25
assert parsed.reverse is True
- def test_pagination_query_accepts_legacy_inner_names(self):
- parsed = rbac_mod._PaginationQuery.model_validate({"page_number": 4, "results_per_page": 30, "reverse": False})
+ def test_pagination_query_accepts_legacy_inner_names(self) -> None:
+ parsed = schemas._PaginationQuery.model_validate({"page_number": 4, "results_per_page": 30, "reverse": False})
assert parsed.page_number == 4
assert parsed.results_per_page == 30
assert parsed.reverse is False
-class TestPaginationMapping:
- def test_roles_get_returns_legacy_compatible_roles_when_rbac_disabled(self, app, config_overrides):
- config_overrides(RBAC_ENABLED=False)
- with (
- app.test_request_context("/workspaces/current/rbac/roles?page=1&limit=2&include_owner=1"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.list") as mock_list,
- ):
- response = inspect.unwrap(rbac_mod.RBACRolesApi.get)(
- rbac_mod.RBACRolesApi(),
- _RolesListQuery.model_validate({"page": 1, "limit": 2, "include_owner": 1}),
- )
-
- owner_permission_keys = rbac_mod._LEGACY_ROLE_PERMISSION_KEYS["owner"]
- valid_owner_permission_keys = []
- for permission_key in owner_permission_keys:
- if dify_config.DEPLOYMENT_EDITION != DeploymentEdition.CLOUD and "billing" in permission_key:
- continue
- valid_owner_permission_keys.append(permission_key)
-
- admin_permission_keys = rbac_mod._LEGACY_ROLE_PERMISSION_KEYS["admin"]
- valid_admin_permission_keys = []
- for permission_key in admin_permission_keys:
- if dify_config.DEPLOYMENT_EDITION != DeploymentEdition.CLOUD and "billing" in permission_key:
- continue
- valid_admin_permission_keys.append(permission_key)
-
- assert response["data"] == [
- {
- "id": "owner",
- "tenant_id": "",
- "type": "workspace",
- "category": "global_system_default",
- "name": "owner",
- "description": "",
- "is_builtin": True,
- "permission_keys": valid_owner_permission_keys,
- "role_tag": "owner",
- },
- {
- "id": "admin",
- "tenant_id": "",
- "type": "workspace",
- "category": "global_system_default",
- "name": "admin",
- "description": "",
- "is_builtin": True,
- "permission_keys": valid_admin_permission_keys,
- "role_tag": "",
- },
- ]
- assert response["pagination"] == {
- "total_count": 4,
- "per_page": 2,
- "current_page": 1,
- "total_pages": 2,
- }
- mock_list.assert_not_called()
-
- def test_roles_get_filters_out_owner_when_include_owner_is_zero(self, app, config_overrides):
- config_overrides(RBAC_ENABLED=False)
- with (
- app.test_request_context("/workspaces/current/rbac/roles?include_owner=0"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.list"),
- ):
- response = inspect.unwrap(rbac_mod.RBACRolesApi.get)(rbac_mod.RBACRolesApi(), _RolesListQuery())
-
- names = [r["name"] for r in response["data"]]
- assert "owner" not in names
-
- def test_roles_get_keeps_owner_when_include_owner_is_one(self, app, config_overrides):
- config_overrides(RBAC_ENABLED=False)
- with (
- app.test_request_context("/workspaces/current/rbac/roles?include_owner=1"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.list"),
- ):
- response = inspect.unwrap(rbac_mod.RBACRolesApi.get)(
- rbac_mod.RBACRolesApi(),
- _RolesListQuery.model_validate({"include_owner": 1}),
- )
-
- names = [r["name"] for r in response["data"]]
- assert "owner" in names
-
- def test_roles_get_filters_out_owner_by_default(self, app, config_overrides):
- config_overrides(RBAC_ENABLED=False)
- with (
- app.test_request_context("/workspaces/current/rbac/roles"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.list"),
- ):
- response = inspect.unwrap(rbac_mod.RBACRolesApi.get)(rbac_mod.RBACRolesApi(), _RolesListQuery())
-
- names = [r["name"] for r in response["data"]]
- assert "owner" not in names
-
- def test_roles_get_forwards_outer_pagination_params(self, app):
- with (
- app.test_request_context("/workspaces/current/rbac/roles?page=2&limit=50&reverse=true&include_owner=1"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.list") as mock_list,
- patch("controllers.console.workspace.rbac._dump", return_value={}),
- ):
- inspect.unwrap(rbac_mod.RBACRolesApi.get)(
- rbac_mod.RBACRolesApi(),
- _RolesListQuery.model_validate({"page": 2, "limit": 50, "reverse": True, "include_owner": 1}),
- )
-
- _, kwargs = mock_list.call_args
- options = kwargs["options"]
- assert options.page_number == 2
- assert options.results_per_page == 50
- assert options.reverse is True
-
-
-class TestPaginationForwarding:
- def test_access_policies_get_forwards_outer_pagination_params(self, app):
- with (
- app.test_request_context(
- "/workspaces/current/rbac/access-policies?resource_type=app&page=3&limit=25&reverse=false"
- ),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.AccessPolicies.list") as mock_list,
- patch("controllers.console.workspace.rbac._dump", return_value={}),
- ):
- inspect.unwrap(rbac_mod.RBACAccessPoliciesApi.get)(rbac_mod.RBACAccessPoliciesApi())
-
- _, kwargs = mock_list.call_args
- assert kwargs["resource_type"] == "app"
- options = kwargs["options"]
- assert options.page_number == 3
- assert options.results_per_page == 25
- assert options.reverse is False
-
-
-class TestAccessPolicyBindingLockUnlock:
- def test_lock_forwards_binding_id(self, app):
- with (
- app.test_request_context("/workspaces/current/rbac/access-policy-bindings/binding-1/lock", method="PUT"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.AccessPolicyBindings.lock") as mock_lock,
- patch("controllers.console.workspace.rbac._dump", return_value={}),
- ):
- inspect.unwrap(rbac_mod.RBACAccessPolicyBindingLockApi.put)(
- rbac_mod.RBACAccessPolicyBindingLockApi(), "binding-1"
- )
-
- mock_lock.assert_called_once_with("tenant-1", "acct-1", "binding-1")
-
- def test_unlock_forwards_binding_id(self, app):
- with (
- app.test_request_context("/workspaces/current/rbac/access-policy-bindings/binding-1/unlock", method="PUT"),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.AccessPolicyBindings.unlock") as mock_unlock,
- patch("controllers.console.workspace.rbac._dump", return_value={}),
- ):
- inspect.unwrap(rbac_mod.RBACAccessPolicyBindingUnlockApi.put)(
- rbac_mod.RBACAccessPolicyBindingUnlockApi(), "binding-1"
- )
-
- mock_unlock.assert_called_once_with("tenant-1", "acct-1", "binding-1")
-
-
-class TestRoleCopy:
- def test_role_copy_forwards_path_id(self, app):
- with (
- app.test_request_context("/workspaces/current/rbac/roles/role-1/copy", method="POST", json={}),
- patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-1")),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.copy") as mock_copy,
- patch("controllers.console.workspace.rbac._dump", return_value={}),
- ):
- inspect.unwrap(rbac_mod.RBACRoleCopyApi.post)(rbac_mod.RBACRoleCopyApi(), "role-1")
-
- mock_copy.assert_called_once_with("tenant-1", "acct-1", "role-1", copy_member=True)
-
-
-class TestWorkspaceRbacGuards:
- def test_role_create_requires_workspace_role_manage(self, app):
- with (
- app.test_request_context(
- "/workspaces/current/rbac/roles",
- method="POST",
- json={"name": "test_role", "permission_keys": []},
- ),
- patch(
- "controllers.common.wraps.current_account_with_tenant",
- return_value=(_account(), "tenant-1"),
- ),
- patch("controllers.common.rbac.checks.RBACService.CheckAccess.check", return_value=False),
- patch("controllers.console.workspace.rbac.svc.RBACService.Roles.create") as mock_create,
- ):
- with pytest.raises(Forbidden):
- rbac_mod.RBACRolesApi().post()
-
- mock_create.assert_not_called()
-
- def test_access_policy_create_requires_workspace_role_manage(self, app):
- with (
- app.test_request_context(
- "/workspaces/current/rbac/access-policies",
- method="POST",
- json={"name": "full_access", "resource_type": "app", "permission_keys": []},
- ),
- patch(
- "controllers.common.wraps.current_account_with_tenant",
- return_value=(_account(), "tenant-1"),
- ),
- patch("controllers.common.rbac.checks.RBACService.CheckAccess.check", return_value=False),
- patch("controllers.console.workspace.rbac.svc.RBACService.AccessPolicies.create") as mock_create,
- ):
- with pytest.raises(Forbidden):
- rbac_mod.RBACAccessPoliciesApi().post()
-
- mock_create.assert_not_called()
-
-
-class TestDumpHelper:
- def test_dump_returns_plain_dict(self):
- role = rbac_mod.svc.RBACRole(id="role-1", type="workspace", name="Owner")
- dumped = rbac_mod._dump(role)
- assert isinstance(dumped, dict)
- assert "role_id" not in dumped
+def test_role_query_aliases_and_context_are_forwarded(app: Flask, domain: RBACDomain) -> None:
+ domain.transport.response = {"data": []}
+ with app.test_request_context("/?page=2&limit=25&reverse=true&include_owner=1&language=ZH"):
+ result = inspect.unwrap(roles.RBACRolesApi.get)(roles.RBACRolesApi(), CONTEXT)
+ assert result == {"data": [], "pagination": None}
+ sent = domain.transport.only_request
+ assert (sent.tenant_id, sent.account_id) == ("tenant", "actor")
+ assert sent.params == {
+ "page_number": 2,
+ "results_per_page": 25,
+ "reverse": "true",
+ "include_owner": 1,
+ "language": "zh",
+ "biiling_enabled": True,
+ "dataset_operator_enabled": False,
+ }
+
+
+def test_invalid_pagination_does_not_reach_application(app: Flask, domain: RBACDomain) -> None:
+ with app.test_request_context("/?page=0"), pytest.raises(ValidationError):
+ inspect.unwrap(roles.RBACRolesApi.get)(roles.RBACRolesApi(), CONTEXT)
+ assert not domain.transport.requests
+
+
+ ("member_id", "role_ids", "message"),
+ [
+ ("missing", ["editor"], "Member not in tenant."),
+ ("foreign", ["editor"], "Member not in tenant."),
+ ("member", [], "Workspace member role update requires exactly one role."),
+ ("member", ["unknown"], ""),
+ ("member", ["dataset_operator"], ""),
+ ("actor", ["owner"], "Cannot operate self."),
+ ("member", ["normal"], "The provided role is already assigned to the member."),
+ ],
+)
+def test_member_role_errors_keep_invalid_param_contract(
+ domain: RBACDomain,
+ config_overrides: Callable[..., None],
+ member_id: str,
+ role_ids: list[str],
+ message: str,
+) -> None:
+ config_overrides(RBAC_ENABLED=False, DATASET_OPERATOR_ENABLED=False)
+ with domain.sessions.begin() as session:
+ session.add(make_tenant(tenant_id="tenant"))
+ for account_id in ("actor", "member", "foreign"):
+ session.add(make_account(account_id=account_id, email=f"{account_id}@example.com"))
+ session.add_all(
+ [
+ TenantAccountJoin(tenant_id="tenant", account_id="actor", role=TenantAccountRole.OWNER),
+ TenantAccountJoin(tenant_id="tenant", account_id="member", role=TenantAccountRole.NORMAL),
+ ]
+ )
+ error_app = Flask(__name__)
+ api = ExternalApi(error_app)
+
+ class MemberRoleEndpoint(Resource):
+ def put(self, member_id: str) -> dict[str, object]:
+ return inspect.unwrap(members.RBACMemberRolesApi.put)(members.RBACMemberRolesApi(), CONTEXT, member_id)
+
+ api.add_resource(MemberRoleEndpoint, "/members/<member_id>/rbac-roles")
+ response = error_app.test_client().put(f"/members/{member_id}/rbac-roles", json={"role_ids": role_ids})
+ assert response.status_code == 400
+ assert response.get_json() == {"code": "invalid_param", "message": message, "status": 400}
+ assert not domain.transport.requests
+
+
+ ("member_id", "role", "error"),
+ [("actor", "owner", InvalidArgumentError), ("member", "owner", Forbidden), ("owner", "normal", Forbidden)],
+)
+def test_member_role_endpoint_rejects_privilege_escalation(
+ app: Flask,
+ domain: RBACDomain,
+ config_overrides: Callable[..., None],
+ member_id: str,
+ role: str,
+ error: type[Exception],
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ original = {"actor": TenantAccountRole.NORMAL, "owner": TenantAccountRole.OWNER, "member": TenantAccountRole.NORMAL}
+ with domain.sessions.begin() as session:
+ session.add(make_tenant(tenant_id="tenant"))
+ for account_id, assigned_role in original.items():
+ session.add(make_account(account_id=account_id, email=f"{account_id}@example.com"))
+ session.add(TenantAccountJoin(tenant_id="tenant", account_id=account_id, role=assigned_role))
+ with app.test_request_context("/", method="PUT", json={"role_ids": [role]}), pytest.raises(error):
+ inspect.unwrap(members.RBACMemberRolesApi.put)(members.RBACMemberRolesApi(), CONTEXT, member_id)
+ with domain.sessions() as session:
+ assigned = dict(session.execute(select(TenantAccountJoin.account_id, TenantAccountJoin.role)).tuples().all())
+ assert assigned == original
+ assert not domain.transport.requests
+
+
+def test_role_copy_normalizes_uuid_and_applies_payload_default(app: Flask, domain: RBACDomain) -> None:
+ role_id = UUID("00000000-0000-0000-0000-000000000001")
+ domain.transport.response = {"id": "copy", "type": "workspace", "name": "Copy"}
+ with app.test_request_context("/", method="POST", json={}):
+ result, status = inspect.unwrap(roles.RBACRoleCopyApi.post)(roles.RBACRoleCopyApi(), CONTEXT, role_id)
+ assert status == 201
+ assert result["id"] == "copy"
+ assert domain.transport.only_request.params == {"id": str(role_id)}
+ assert domain.transport.only_request.json == {"copy_member": True}
+
+
+def test_policy_query_and_permissions_keep_resource_selectors(app: Flask, domain: RBACDomain) -> None:
+ domain.transport.response = {"data": []}
+ with app.test_request_context("/?resource_type=agent&page=3&limit=25&reverse=false"):
+ inspect.unwrap(policies.RBACAccessPoliciesApi.get)(policies.RBACAccessPoliciesApi(), CONTEXT)
+ assert domain.transport.only_request.params == {
+ "resource_type": "agent",
+ "page_number": 3,
+ "results_per_page": 25,
+ "reverse": "false",
+ }
+ domain.transport.requests.clear()
+ domain.transport.response = {"agent": {"default_permission_keys": ["agent.acl.preview"]}}
+ with app.test_request_context("/?agent_id=agent-1"):
+ result = inspect.unwrap(members.RBACMyPermissionsApi.get)(members.RBACMyPermissionsApi(), CONTEXT)
+ assert result["agent"]["default_permission_keys"] == ["agent.acl.preview"]
+ assert domain.transport.only_request.params == {"agent_id": "agent-1"}
+
+
+ "controller", [policies.RBACAccessPolicyBindingLockApi, policies.RBACAccessPolicyBindingUnlockApi]
+)
+def test_policy_binding_state_serialization(
+ app: Flask,
+ domain: RBACDomain,
+ controller: type[policies.RBACAccessPolicyBindingLockApi] | type[policies.RBACAccessPolicyBindingUnlockApi],
+) -> None:
+ locked = controller is policies.RBACAccessPolicyBindingLockApi
+ domain.transport.response = {"binding_id": "binding", "is_locked": locked}
+ with app.test_request_context("/", method="PUT"):
+ result = inspect.unwrap(controller.put)(controller(), CONTEXT, "binding")
+ assert result == {"binding_id": "binding", "is_locked": locked}
+ assert domain.transport.only_request.json == {"binding_id": "binding"}
+
+
[email protected]("controller", [roles.RBACRolesApi, policies.RBACAccessPoliciesApi])
+def test_role_administration_denied_before_application(
+ app: Flask,
+ domain: RBACDomain,
+ controller: type[roles.RBACRolesApi] | type[policies.RBACAccessPoliciesApi],
+ monkeypatch: pytest.MonkeyPatch,
+) -> None:
+ account = Account(name="User", email="[email protected]", status=AccountStatus.ACTIVE)
+ identity = AccountWithTenant(account, "tenant")
+ monkeypatch.setattr(flask_admission, "current_account_with_tenant", lambda: identity)
+ monkeypatch.setattr(wraps, "current_account_with_tenant", lambda: identity)
+ domain.transport.response = {"allowed": False}
+ with app.test_request_context("/", method="POST", json={}), pytest.raises(Forbidden):
+ controller().post()
+ assert domain.transport.only_request.endpoint == "/rbac/check-access"
+
+
[email protected](("value", "expected"), [(" EN ", "en"), ("ja", "ja"), ("zh", "zh"), ("fr", None), ("", None)])
+def test_language_normalization_is_owned_by_transport(app: Flask, value: str, expected: str | None) -> None:
+ with app.test_request_context(query_string={"language": value}):
+ assert rbac_language() == expected
diff --git a/api/tests/unit_tests/controllers/console/workspace/test_rbac_resource_access_routes.py b/api/tests/unit_tests/controllers/console/workspace/test_rbac_resource_access_routes.py
index f5c593603b6..c717d9b061e 100644
--- a/api/tests/unit_tests/controllers/console/workspace/test_rbac_resource_access_routes.py
+++ b/api/tests/unit_tests/controllers/console/workspace/test_rbac_resource_access_routes.py
@@ -9,29 +9,31 @@ methods) and which inner-API client each handler reaches for.
from __future__ import annotations
import inspect
-from collections.abc import Callable, Generator
-from unittest.mock import MagicMock, patch
+from collections.abc import Callable
import pytest
from flask import Flask
+from sqlalchemy.orm import Session, sessionmaker
from controllers.console import console_ns
-from controllers.console.workspace import rbac as rbac_mod
+from controllers.console.workspace.rbac import resources as rbac_mod
from enums import DeploymentEdition
-from services.enterprise import rbac_service as svc
+from machinery.context import RequestContext
+from services.rbac import contracts as rbac_contracts
+from tests.unit_tests.rbac_fakes import Initialization, RBACDomain, build_rbac_domain
RESOURCE_ID = {
- svc.RBACResourceType.APP: "app-1",
- svc.RBACResourceType.DATASET: "dataset-1",
- svc.RBACResourceType.AGENT: "agent-1",
+ rbac_contracts.RBACResourceType.APP: "app-1",
+ rbac_contracts.RBACResourceType.DATASET: "dataset-1",
+ rbac_contracts.RBACResourceType.AGENT: "agent-1",
}
# The URL segment and path parameter of each resource kind, spelled out here instead of read
# back from the same enum the controller builds its URLs from, so a rename fails this test.
RESOURCE_URL_PARTS = {
- svc.RBACResourceType.APP: ("apps", "app_id"),
- svc.RBACResourceType.DATASET: ("datasets", "dataset_id"),
- svc.RBACResourceType.AGENT: ("agents", "agent_id"),
+ rbac_contracts.RBACResourceType.APP: ("apps", "app_id"),
+ rbac_contracts.RBACResourceType.DATASET: ("datasets", "dataset_id"),
+ rbac_contracts.RBACResourceType.AGENT: ("agents", "agent_id"),
}
@@ -74,12 +76,6 @@ def resource_id(spec: rbac_mod._ResourceAccessRoutes) -> str:
return RESOURCE_ID[spec.resource_type]
[email protected](autouse=True)
-def _patched_current_ids() -> Generator[None]:
- with patch("controllers.console.workspace.rbac._current_ids", return_value=("tenant-1", "acct-actor")):
- yield
-
-
def _expected_routes(spec: rbac_mod._ResourceAccessRoutes) -> dict[str, tuple[str, set[str]]]:
resource = f"/workspaces/current/rbac/{_segment(spec)}/<uuid:{_id_param(spec)}>"
workspace = f"/workspaces/current/rbac/workspace/{_segment(spec)}"
@@ -133,35 +129,44 @@ def test_every_resource_kind_registers_the_same_twelve_routes(spec: rbac_mod._Re
assert set(resource.methods or ()) == methods
[email protected]("automatic_include_workspace_members", [True, False])
-def test_whitelist_put_queues_the_seed_task_only_when_auto_including(
+def domain(sqlite_session_factory: sessionmaker[Session], monkeypatch: pytest.MonkeyPatch) -> RBACDomain:
+ domain = build_rbac_domain(sqlite_session_factory, monkeypatch)
+ monkeypatch.setattr(rbac_mod, "application_services", lambda: domain)
+ return domain
+
+
+def test_resource_route_forwards_context_kind_and_language(
app: Flask,
apis: rbac_mod._ResourceAccessApis,
spec: rbac_mod._ResourceAccessRoutes,
resource_id: str,
- automatic_include_workspace_members: bool,
+ domain: RBACDomain,
) -> None:
- replace = MagicMock(
- return_value=svc.ResourceWhitelist(
- automatic_include_workspace_members=automatic_include_workspace_members,
+ domain.transport.response = {"items": []}
+ context = RequestContext("request", "trace", "actor", "tenant")
+ with app.test_request_context("/?language=ja"):
+ result = inspect.unwrap(vars(apis.matrix)["get"])(apis.matrix(), context, **{_id_param(spec): resource_id})
+ assert result["items"] == []
+ sent = domain.transport.only_request
+ assert (sent.tenant_id, sent.account_id) == ("tenant", "actor")
+ assert sent.endpoint == f"/rbac/{_segment(spec)}/access-policy"
+ assert sent.params == {_id_param(spec): resource_id, "language": "ja"}
+
+
+def test_resource_whitelist_parses_body_and_returns_response(
+ app: Flask,
+ apis: rbac_mod._ResourceAccessApis,
+ spec: rbac_mod._ResourceAccessRoutes,
+ resource_id: str,
+ domain: RBACDomain,
+) -> None:
+ domain.transport.response = {"account_ids": ["member"]}
+ context = RequestContext("request", "trace", "actor", "tenant")
+ with app.test_request_context("/", method="PUT", json={"automatic_include_workspace_members": True}):
+ result = inspect.unwrap(vars(apis.whitelist)["put"])(
+ apis.whitelist(), context, **{_id_param(spec): resource_id}
)
- )
- with (
- app.test_request_context(
- f"/{_segment(spec)}/{resource_id}/whitelist",
- method="PUT",
- json={"automatic_include_workspace_members": automatic_include_workspace_members},
- ),
- patch.object(spec.access, "replace_whitelist", replace),
- patch("controllers.console.workspace.rbac.initialize_created_app_rbac_access_task") as seed_task,
- ):
- inspect.unwrap(vars(apis.whitelist)["put"])(apis.whitelist(), **{_id_param(spec): resource_id})
-
- tenant_id, actor_id, target_id, payload = replace.call_args.args
- assert (tenant_id, actor_id, target_id) == ("tenant-1", "acct-actor", resource_id)
- assert payload.automatic_include_workspace_members is automatic_include_workspace_members
-
- if automatic_include_workspace_members:
- seed_task.delay.assert_called_once_with("tenant-1", "acct-actor", **{_id_param(spec): resource_id})
- else:
- seed_task.delay.assert_not_called()
+ assert result == {"account_ids": ["member"]}
+ assert domain.transport.only_request.json == {"automatic_include_workspace_members": True}
+ assert domain.tasks.queued == [Initialization("tenant", "actor", {_id_param(spec): resource_id})]
diff --git a/api/tests/unit_tests/controllers/openapi/test_auth_matrix.py b/api/tests/unit_tests/controllers/openapi/test_auth_matrix.py
index c5e9fbddcc3..4c159223980 100644
--- a/api/tests/unit_tests/controllers/openapi/test_auth_matrix.py
+++ b/api/tests/unit_tests/controllers/openapi/test_auth_matrix.py
@@ -95,6 +95,7 @@ from controllers.openapi.auth.spec import EndpointSpec
from controllers.openapi.auth.subjects import AccountSubject, ExternalSsoSubject, ResourceAccessSubject
from controllers.openapi.human_input_form import CheckFormSurface
from enums import DeploymentEdition, WebAppAccessMode
+from extensions.ext_application_services import ApplicationServices
from libs.oauth_bearer import BearerAuthenticator, ResolvedRow, sha256_hex
from models.account import Account, AccountStatus, Tenant, TenantAccountJoin, TenantAccountRole
from models.enums import EndUserType
@@ -102,7 +103,6 @@ from models.model import App, EndUser
from models.oauth import OAuthAccessToken
from services.enterprise.enterprise_service import EnterpriseService
from services.entities.feature_entities import LicenseStatus, SystemFeatureModel
-from services.rbac_resource_service import RBACResourceService
from services.system_feature_service import SystemFeatureService
from tests.unit_tests.config_override import apply_config_overrides
@@ -853,9 +853,12 @@ def _matrix_app() -> Flask:
@pytest.fixture
-def matrix_app(_matrix_app: Flask, monkeypatch: pytest.MonkeyPatch) -> Iterator[Flask]:
+def matrix_app(
+ _matrix_app: Flask, monkeypatch: pytest.MonkeyPatch, account_application_services: ApplicationServices
+) -> Iterator[Flask]:
"""Keep rate-limit overrides and the admission probe scoped to each case."""
+ monkeypatch.setitem(_matrix_app.extensions, "application_services", account_application_services)
monkeypatch.setattr(
rate_limit_module,
"LIMIT_BEARER_PER_TOKEN",
@@ -1118,8 +1121,6 @@ def _run_case(
side_effect=_end_user,
)
)
- stack.enter_context(patch.object(RBACResourceService, "get_app_agent_binding", return_value=None))
- stack.enter_context(patch.object(RBACResourceService, "get_app_maintainer", return_value=None))
stack.enter_context(
patch(
"services.enterprise.rbac_service.RBACService.CheckAccess.check",
diff --git a/api/tests/unit_tests/controllers/test_rbac_access_policy_schema.py b/api/tests/unit_tests/controllers/test_rbac_access_policy_schema.py
index 5bde17c71e7..46b96d7db4c 100644
--- a/api/tests/unit_tests/controllers/test_rbac_access_policy_schema.py
+++ b/api/tests/unit_tests/controllers/test_rbac_access_policy_schema.py
@@ -1,9 +1,24 @@
"""Access-policy writes must expose typed bodies through the RBAC decorators."""
import json
-from typing import cast
+from collections.abc import Callable
+from inspect import unwrap
+from typing import Protocol, cast
+from uuid import UUID
import pytest
+from flask import Flask
+from jsonschema import Draft202012Validator
+from sqlalchemy.orm import Session, sessionmaker
+
+from controllers.console.workspace.rbac import policies, resources, roles
+from machinery.context import RequestContext
+from services.rbac.contracts import RBACResourceType
+from tests.unit_tests.rbac_fakes import build_rbac_domain
+
+
+class _DeleteResource(Protocol):
+ delete: Callable[..., dict[str, object]]
def _object_at(root: dict[str, object], *keys: str) -> dict[str, object]:
@@ -45,3 +60,46 @@ def test_access_policy_write_contracts(
assert _object_at(properties, "permission_keys", "items")["type"] == "string"
response = _object_at(operation, "responses", status, "content", "application/json", "schema")
assert response["$ref"] == "#/components/schemas/AccessPolicy"
+
+
[email protected]("target", ["roles", "access-policies", "apps", "datasets", "agents"])
+def test_delete_response_matches_exported_schema(
+ console_schema: dict[str, object],
+ app: Flask,
+ monkeypatch: pytest.MonkeyPatch,
+ sqlite_session_factory: sessionmaker[Session],
+ target: str,
+) -> None:
+ domain = build_rbac_domain(sqlite_session_factory, monkeypatch)
+ context = RequestContext("request", None, "actor", "workspace")
+ item_id = UUID("00000000-0000-0000-0000-000000000001")
+ if target == "roles":
+ module = roles
+ resource = roles.RBACRoleItemApi()
+ path = "/workspaces/current/rbac/roles/{role_id}"
+ path_params = {"role_id": item_id}
+ elif target == "access-policies":
+ module = policies
+ resource = policies.RBACAccessPolicyItemApi()
+ path = "/workspaces/current/rbac/access-policies/{policy_id}"
+ path_params = {"policy_id": item_id}
+ else:
+ module = resources
+ kind = RBACResourceType(target[:-1])
+ resource = resources._RESOURCE_ACCESS_APIS[kind].member_bindings()
+ path = (
+ f"/workspaces/current/rbac/{target}/{{{kind.route.id_param}}}/access-policies/{{policy_id}}/member-bindings"
+ )
+ path_params = {kind.route.id_param: item_id, "policy_id": item_id}
+ monkeypatch.setattr(module, "application_services", lambda: domain)
+ delete = cast(_DeleteResource, resource).delete
+ with app.test_request_context(method="DELETE", json={"account_ids": ["member"]}):
+ response = unwrap(delete)(resource, context, **path_params)
+
+ assert response == {"result": "success"}
+ schema = _object_at(
+ console_schema, "paths", path, "delete", "responses", "200", "content", "application/json", "schema"
+ )
+ assert schema["$ref"] == "#/components/schemas/SimpleResultResponse"
+ Draft202012Validator({**schema, "components": console_schema["components"]}).validate(response)
+ assert domain.transport.only_request.method == "DELETE"
diff --git a/api/tests/unit_tests/controllers/test_rbac_route_resource_contract.py b/api/tests/unit_tests/controllers/test_rbac_route_resource_contract.py
index 60a21436242..48a31eb05d3 100644
--- a/api/tests/unit_tests/controllers/test_rbac_route_resource_contract.py
+++ b/api/tests/unit_tests/controllers/test_rbac_route_resource_contract.py
@@ -17,9 +17,12 @@ from __future__ import annotations
from collections.abc import Iterator
+import pytest
+
import controllers.console # noqa: F401 -- importing the package registers every console route
import controllers.openapi # noqa: F401 -- same for the user-scoped OpenAPI routes
-from controllers.common.rbac import RBAC_CHECKS_ATTR, RBACCheck
+from controllers.common.rbac import RBAC_CHECKS_ATTR, DatasetId, RBACCheck, RBACPermission
+from controllers.common.rbac.checks import InvalidRBACCheckError
from controllers.console import console_ns
from controllers.openapi import openapi_ns
@@ -29,6 +32,12 @@ HTTP_METHODS = ("delete", "get", "head", "options", "patch", "post", "put")
KNOWN_VIOLATIONS: set[tuple[str, str]] = set()
+
+def test_mismatched_permission_scope_is_a_configuration_error() -> None:
+ with pytest.raises(InvalidRBACCheckError, match="locates dataset"):
+ RBACCheck(RBACPermission.APP_DELETE, DatasetId())
+
+
# The generated access-permission endpoints, spelled out here so this guard fails loudly if
# the factory stops registering them (or renames a URL) rather than silently checking less.
RBAC_ACCESS_RESOURCE_PARTS = (("apps", "app_id"), ("datasets", "dataset_id"), ("agents", "agent_id"))
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 c2acd4fe0e4..4b20278d464 100644
--- a/api/tests/unit_tests/extensions/test_ext_application_services.py
+++ b/api/tests/unit_tests/extensions/test_ext_application_services.py
@@ -91,6 +91,7 @@ from services.account_avatar_file_gateway import SQLAlchemyAccountAvatarFileGate
from services.api_based_extension_adapters import APIBasedExtensionPingProbe, WorkspaceTokenCipher
from services.api_based_extension_application_service import APIBasedExtensionApplicationService
from services.app.api_key_service import AppApiKeyService
+from services.app.console_gateway import EnterpriseConsoleAppAccess
from services.app.creators_platform_gateway import CreatorsPlatformGateway
from services.app_generate_service import AppGenerateService
from services.app_preview_query_service import AppPreviewRef, AppPreviewUnavailableError
@@ -122,9 +123,11 @@ from services.installed_app_generation_adapters import AppGenerateServiceRuntime
from services.installed_app_generation_service import InstalledAppGenerationService
from services.knowledge.api_key_service import DatasetApiKeyService
from services.knowledge.dataset_access import DatasetAccessService
+from services.knowledge.datasets.adapters import SQLAlchemyDatasetOperations
from services.knowledge.datasets.application import DatasetApplicationService
from services.knowledge.document_sync import DocumentSyncApplicationService
from services.knowledge.documents.application import DatasetDocumentApplicationService
+from services.knowledge.external.adapters import SQLAlchemyExternalKnowledgeOperations
from services.knowledge.external.application import ExternalKnowledgeApplicationService
from services.knowledge.indexing.adapters.estimate import IndexingEstimateAdapter, SQLAlchemyProcessRuleReader
from services.knowledge.indexing.adapters.sources import NotionSourceResolver
@@ -285,6 +288,25 @@ def test_build_application_services_preserves_composed_boundaries(
assert services.trial_apps.generation._usage is trial_apps
assert services.recommended_app_queries._trial_apps is trial_apps
+ assert services.rbac.resources._apps is services.apps.console._apps
+ assert services.rbac.queries._apps is services.rbac.resources._apps
+ assert services.rbac.queries._datasets is services.rbac.resources._datasets
+ dataset_access = services.knowledge.datasets._dataset_access
+ assert isinstance(dataset_access, DatasetAccessService)
+ assert services.rbac.resources._datasets is dataset_access._datasets
+ assert services.rbac.members._members is services.rbac.resources._members
+ assert services.rbac.members._members is services.workspaces.members._workspaces
+ assert services.rbac.members._workspace_roles is services.workspaces.members
+ app_access = services.apps.console._access
+ assert isinstance(app_access, EnterpriseConsoleAppAccess)
+ assert app_access._members is services.rbac.members
+ dataset_operations = services.knowledge.datasets._operations
+ assert isinstance(dataset_operations, SQLAlchemyDatasetOperations)
+ assert dataset_operations._members_service is services.rbac.members
+ external_operations = services.knowledge.external._operations
+ assert isinstance(external_operations, SQLAlchemyExternalKnowledgeOperations)
+ assert external_operations._members is services.rbac.members
+
@pytest.mark.parametrize(
("deployment_edition", "setup_completed"),
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 802cbd7bacf..f581ab1a0bd 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -127,7 +127,6 @@ project-excludes = [
"controllers/console/workspace/test_model_providers.py",
"controllers/console/workspace/test_models.py",
"controllers/console/workspace/test_plugin.py",
- "controllers/console/workspace/test_rbac.py",
"controllers/console/workspace/test_snippets.py",
"controllers/console/workspace/test_tool_providers.py",
"controllers/files/test_upload_file_delivery.py",
@@ -728,7 +727,6 @@ project-excludes = [
"services/enterprise/test_account_deletion_sync.py",
"services/enterprise/test_app_permitted_service.py",
"services/enterprise/test_plugin_manager_service.py",
- "services/enterprise/test_rbac_service.py",
"services/enterprise/test_traceparent_propagation.py",
"services/hit_service.py",
"services/plugin/conftest.py",
diff --git a/api/tests/unit_tests/rbac_fakes.py b/api/tests/unit_tests/rbac_fakes.py
new file mode 100644
index 00000000000..a3c281610b1
--- /dev/null
+++ b/api/tests/unit_tests/rbac_fakes.py
@@ -0,0 +1,101 @@
+"""Explicit RBAC transport and task fakes for exercising real application services."""
+
+from dataclasses import dataclass, field
+
+import pytest
+from pydantic import JsonValue
+from sqlalchemy.orm import Session, sessionmaker
+
+from extensions.application_services.rbac import RBACServices, build_rbac_services
+from extensions.application_services.workspace import build_workspace_membership_services
+from repositories.account.repository import SQLAlchemyAccountRepository
+from repositories.app.console_repository import ConsoleAppRepository
+from repositories.knowledge.dataset_repository import SQLAlchemyDatasetRepository
+from repositories.workspace.workspace_repository import WorkspaceRepository
+from services.enterprise.base import EnterpriseRequest
+from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
+
+
+@dataclass(frozen=True)
+class RecordedRequest:
+ method: str
+ endpoint: str
+ tenant_id: str
+ account_id: str | None
+ json: dict[str, object] | None
+ params: dict[str, object] | None
+ timeout: float
+
+
+@dataclass
+class RBACTransport:
+ response: JsonValue = None
+ failure: Exception | None = None
+ requests: list[RecordedRequest] = field(default_factory=list)
+ responses: dict[str, JsonValue] = field(default_factory=dict)
+
+ def send(
+ self,
+ method: str,
+ endpoint: str,
+ *,
+ tenant_id: str,
+ account_id: str | None,
+ json: dict[str, object] | None,
+ params: dict[str, object] | None,
+ timeout: float,
+ ) -> JsonValue:
+ self.requests.append(RecordedRequest(method, endpoint, tenant_id, account_id, json, params, timeout))
+ if self.failure:
+ raise self.failure
+ return self.responses.get(endpoint, self.response)
+
+ @property
+ def only_request(self) -> RecordedRequest:
+ assert len(self.requests) == 1
+ return self.requests[0]
+
+
+@dataclass(frozen=True)
+class Initialization:
+ tenant_id: str
+ account_id: str
+ resources: dict[str, str]
+
+
+@dataclass
+class AccessTasks:
+ queued: list[Initialization] = field(default_factory=list)
+
+ def delay(self, tenant_id: str, account_id: str, **resources: str) -> None:
+ self.queued.append(Initialization(tenant_id, account_id, resources))
+
+
+@dataclass
+class RBACDomain:
+ rbac: RBACServices
+ transport: RBACTransport
+ tasks: AccessTasks
+ sessions: sessionmaker[Session]
+
+
+def build_rbac_domain(sessions: sessionmaker[Session], monkeypatch: pytest.MonkeyPatch) -> RBACDomain:
+ transport = RBACTransport()
+ tasks = AccessTasks()
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ monkeypatch.setattr(initialize_created_app_rbac_access_task, "delay", tasks.delay)
+ workspaces = WorkspaceRepository(sessions)
+ members, _ = build_workspace_membership_services(
+ workspaces=workspaces, accounts=SQLAlchemyAccountRepository(sessions)
+ )
+ return RBACDomain(
+ rbac=build_rbac_services(
+ workspaces=workspaces,
+ workspace_members=members,
+ apps=ConsoleAppRepository(session_factory=sessions),
+ datasets=SQLAlchemyDatasetRepository(session_factory=sessions),
+ ),
+ transport=transport,
+ tasks=tasks,
+ sessions=sessions,
+ )
diff --git a/api/tests/unit_tests/repositories/knowledge/test_dataset_repository.py b/api/tests/unit_tests/repositories/knowledge/test_dataset_repository.py
index 42564cad1ad..109f9deb9ca 100644
--- a/api/tests/unit_tests/repositories/knowledge/test_dataset_repository.py
+++ b/api/tests/unit_tests/repositories/knowledge/test_dataset_repository.py
@@ -26,6 +26,15 @@ def _dataset(
)
+def test_rbac_maintainer_lookup_requires_owning_workspace(sqlite_session_factory: sessionmaker[Session]) -> None:
+ with sqlite_session_factory.begin() as session:
+ session.add(_dataset("dataset", "workspace"))
+ repository = SQLAlchemyDatasetRepository(session_factory=sqlite_session_factory)
+ assert repository.get_maintainer_id("workspace", "dataset") == "account-1"
+ assert repository.get_maintainer_id("other-workspace", "dataset") is None
+ assert repository.get_maintainer_id("workspace", "missing") is None
+
+
def test_estimate_record_and_access_snapshot_are_separate_and_tenant_scoped(
sqlite_session_factory: sessionmaker[Session],
) -> None:
diff --git a/api/tests/unit_tests/repositories/test_console_app_repository.py b/api/tests/unit_tests/repositories/test_console_app_repository.py
index 7b59bec673d..1b4f66f6276 100644
--- a/api/tests/unit_tests/repositories/test_console_app_repository.py
+++ b/api/tests/unit_tests/repositories/test_console_app_repository.py
@@ -55,6 +55,27 @@ def repository(sqlite_session_factory: sessionmaker[Session]) -> ConsoleAppRepos
return ConsoleAppRepository(session_factory=sqlite_session_factory)
+def test_rbac_maintainer_lookup_requires_owning_workspace(
+ repository: ConsoleAppRepository, sqlite_session: Session
+) -> None:
+ app = persist_app(sqlite_session, maintainer=ACTOR)
+ assert repository.get_maintainer_id(WORKSPACE, app.id) == ACTOR
+ assert repository.get_maintainer_id("other-workspace", app.id) is None
+ assert repository.get_maintainer_id(WORKSPACE, "missing") is None
+
+
[email protected]("normal", [True, False])
+def test_authorization_maintainer_requires_normal_app(
+ repository: ConsoleAppRepository, sqlite_session: Session, normal: bool
+) -> None:
+ app = persist_app(sqlite_session, maintainer=ACTOR)
+ if not normal:
+ sqlite_session.execute(text("UPDATE apps SET status = 'disabled' WHERE id = :id"), {"id": app.id})
+ sqlite_session.commit()
+ assert repository.get_maintainer_id(WORKSPACE, app.id) == ACTOR
+ assert repository.get_maintainer_id(WORKSPACE, app.id, normal_only=True) == (ACTOR if normal else None)
+
+
@pytest.mark.parametrize(
"operation",
[
diff --git a/api/tests/unit_tests/repositories/workspace/test_workspace_members.py b/api/tests/unit_tests/repositories/workspace/test_workspace_members.py
index 090e5008ac2..3982ecedd2d 100644
--- a/api/tests/unit_tests/repositories/workspace/test_workspace_members.py
+++ b/api/tests/unit_tests/repositories/workspace/test_workspace_members.py
@@ -36,6 +36,20 @@ def make_tenant(tenant_id: str) -> Tenant:
return tenant
+def test_rbac_profile_batch_filters_requested_ids_and_workspace(sqlite_session_factory: sessionmaker[Session]) -> None:
+ with sqlite_session_factory.begin() as session:
+ session.add_all([make_tenant("workspace"), make_tenant("other")])
+ for account_id, workspace in [("member", "workspace"), ("unrequested", "workspace"), ("foreign", "other")]:
+ session.add(make_account(account_id, status=AccountStatus.ACTIVE, created_at=datetime(2026, 1, 1)))
+ session.add(TenantAccountJoin(tenant_id=workspace, account_id=account_id, role=TenantAccountRole.NORMAL))
+
+ repository = WorkspaceRepository(sqlite_session_factory)
+ members = repository.list_for_workspace("workspace", account_ids=["member", "foreign", "missing"])
+ assert [member.id for member in members] == ["member"]
+ assert members[0].email == "[email protected]"
+ assert repository.list_for_workspace("workspace", account_ids=[]) == ()
+
+
def test_list_for_workspace_uses_join_membership_and_preserves_account_lifecycle(
sqlite_session_factory: sessionmaker[Session],
) -> None:
@@ -182,9 +196,15 @@ def test_member_queries_observe_committed_roles_and_release_session_before_role_
class RoleResolver:
def resolve_many(
- self, workspace_id: str, actor_account_id: str, subjects: Sequence[WorkspaceMemberRoleSubject]
+ self,
+ workspace_id: str,
+ actor_account_id: str,
+ subjects: Sequence[WorkspaceMemberRoleSubject],
+ *,
+ language: str | None = None,
) -> Mapping[str, Sequence[WorkspaceMemberRole]]:
assert not checked_out
+ assert language is None
assert (workspace_id, actor_account_id) == ("workspace", "actor")
assert subjects == (WorkspaceMemberRoleSubject("member", "editor"),)
return {"member": (WorkspaceMemberRole("editor", "Editor"),)}
diff --git a/api/tests/unit_tests/services/app/test_console_gateway.py b/api/tests/unit_tests/services/app/test_console_gateway.py
index efa75607e71..0006a88816b 100644
--- a/api/tests/unit_tests/services/app/test_console_gateway.py
+++ b/api/tests/unit_tests/services/app/test_console_gateway.py
@@ -39,6 +39,7 @@ from services.recommended_app_package_service import RecommendedAppPackageServic
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
+from tests.unit_tests.rbac_fakes import RBACDomain
@pytest.fixture
@@ -229,7 +230,7 @@ def test_copy_rejects_foreign_import_result_before_external_effects(
def test_only_cloud_version_export_consults_workspace_plan(
monkeypatch: pytest.MonkeyPatch,
config_overrides: Callable[..., None],
- sqlite_session_factory: sessionmaker[Session],
+ rbac_domain: RBACDomain,
edition: DeploymentEdition,
plan: CloudPlan,
allowed: bool,
@@ -242,20 +243,18 @@ def test_only_cloud_version_export_consults_workspace_plan(
return plan
monkeypatch.setattr("services.app.console_gateway.FeatureService.get_workspace_plan", get_plan)
- gateway = EnterpriseConsoleAppAccess(session_factory=sqlite_session_factory)
+ gateway = EnterpriseConsoleAppAccess(members=rbac_domain.rbac.members)
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:
+def test_access_mode_batch_validates_completeness(monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain) -> 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)
+ gateway = EnterpriseConsoleAppAccess(members=rbac_domain.rbac.members)
with pytest.raises(InvalidAppAccessModesError):
gateway.access_modes(["app"])
diff --git a/api/tests/unit_tests/services/enterprise/test_rbac_agent_access.py b/api/tests/unit_tests/services/enterprise/test_rbac_agent_access.py
index 28fabd201eb..462ce742a09 100644
--- a/api/tests/unit_tests/services/enterprise/test_rbac_agent_access.py
+++ b/api/tests/unit_tests/services/enterprise/test_rbac_agent_access.py
@@ -1,22 +1,21 @@
"""Unit tests for the agent-flavoured RBAC inner-API client.
-`RBACService.AgentAccess`, the agent methods on `RBACService.WorkspaceAccess` and
-`RBACService.Catalog.agent` are all built from one generic resource-access client.
-These tests monkeypatch `_inner_call` and assert the HTTP method, the exact endpoint,
+The resource-access clients injected into the application services share one
+implementation across apps, datasets and agents.
+These tests replace the Enterprise transport and assert the HTTP method, the exact endpoint,
the query/body keys and the returned model for every operation.
"""
from __future__ import annotations
-from collections.abc import Callable, Iterator
-from types import SimpleNamespace
-from unittest.mock import MagicMock, patch
+from collections.abc import Callable
import pytest
from services.enterprise import rbac_service as svc
-
-MODULE = "services.enterprise.rbac_service"
+from services.enterprise.base import EnterpriseRequest
+from services.rbac import contracts as rbac_contracts
+from tests.unit_tests.rbac_fakes import RBACTransport, RecordedRequest
TENANT = "tenant-1"
ACTOR = "acct-1"
@@ -25,23 +24,14 @@ POLICY = "policy-1"
@pytest.fixture
-def inner_call() -> Iterator[MagicMock]:
- with patch(f"{MODULE}._inner_call") as call:
- call.return_value = {"automatic_include_workspace_members": True}
- yield call
+def transport(monkeypatch: pytest.MonkeyPatch) -> RBACTransport:
+ transport = RBACTransport(response={"automatic_include_workspace_members": True})
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ return transport
-def _last(call: MagicMock) -> SimpleNamespace:
- call.assert_called_once()
- args, kwargs = call.call_args
- return SimpleNamespace(
- method=args[0],
- endpoint=args[1],
- tenant_id=kwargs.get("tenant_id"),
- account_id=kwargs.get("account_id"),
- json=kwargs.get("json"),
- params=kwargs.get("params"),
- )
+def _last(transport: RBACTransport) -> RecordedRequest:
+ return transport.only_request
_AGENT_CASES: list[tuple[str, str, str, Callable[[], object]]] = [
@@ -49,143 +39,123 @@ _AGENT_CASES: list[tuple[str, str, str, Callable[[], object]]] = [
"whitelist_resources",
"GET",
"/rbac/agents/whitelist/resources",
- lambda: svc.RBACService.AgentAccess.whitelist_resources(TENANT, ACTOR),
+ lambda: svc._AGENT_ACCESS.whitelist_resources(TENANT, ACTOR),
),
(
"user_access_policies",
"GET",
"/rbac/agents/user-access-policies",
- lambda: svc.RBACService.AgentAccess.user_access_policies(TENANT, ACTOR, agent_id=AGENT),
+ lambda: svc._AGENT_ACCESS.user_access_policies(TENANT, ACTOR, resource_id=AGENT),
),
(
"replace_user_access_policies",
"PUT",
"/rbac/agents/user-access-policies",
- lambda: svc.RBACService.AgentAccess.replace_user_access_policies(
+ lambda: svc._AGENT_ACCESS.replace_user_access_policies(
TENANT,
ACTOR,
- agent_id=AGENT,
+ resource_id=AGENT,
target_account_id="member-1",
- payload=svc.ReplaceUserAccessPolicies(access_policy_ids=[POLICY], account_ids=["member-1"]),
+ payload=rbac_contracts.ReplaceUserAccessPolicies(access_policy_ids=[POLICY], account_ids=["member-1"]),
),
),
(
"whitelist",
"GET",
"/rbac/agents/whitelist",
- lambda: svc.RBACService.AgentAccess.whitelist(TENANT, ACTOR, agent_id=AGENT),
+ lambda: svc._AGENT_ACCESS.whitelist(TENANT, ACTOR, resource_id=AGENT),
),
(
"whitelist_config",
"GET",
"/rbac/agents/whitelist",
- lambda: svc.RBACService.AgentAccess.whitelist_config(TENANT, ACTOR, agent_id=AGENT),
+ lambda: svc._AGENT_ACCESS.whitelist_config(TENANT, ACTOR, resource_id=AGENT),
),
(
"legacy_whitelist_config",
"GET",
"/rbac/agents/whitelist",
- lambda: svc.RBACService.AgentAccess.legacy_whitelist_config(TENANT, ACTOR, agent_id=AGENT),
+ lambda: svc._AGENT_ACCESS.legacy_whitelist_config(TENANT, ACTOR, resource_id=AGENT),
),
(
"replace_whitelist",
"PUT",
"/rbac/agents/whitelist",
- lambda: svc.RBACService.AgentAccess.replace_whitelist(
+ lambda: svc._AGENT_ACCESS.replace_whitelist(
TENANT,
ACTOR,
- agent_id=AGENT,
- payload=svc.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ resource_id=AGENT,
+ payload=rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=True),
),
),
(
"append_whitelist_members_batch",
"POST",
"/rbac/agents/whitelist/members/batch",
- lambda: svc.RBACService.AgentAccess.append_whitelist_members_batch(
+ lambda: svc._AGENT_ACCESS.append_whitelist_members_batch(
tenant_id=TENANT,
account_id=ACTOR,
- data=[svc.AppendAgentWhitelistMembersBatchItem(agent_id=AGENT, account_ids=["member-1"], policy_id=POLICY)],
+ data=[
+ rbac_contracts.AppendAgentWhitelistMembersBatchItem(
+ agent_id=AGENT, account_ids=["member-1"], policy_id=POLICY
+ )
+ ],
),
),
(
"matrix",
"GET",
"/rbac/agents/access-policy",
- lambda: svc.RBACService.AgentAccess.matrix(TENANT, ACTOR, agent_id=AGENT),
+ lambda: svc._AGENT_ACCESS.matrix(TENANT, ACTOR, resource_id=AGENT),
),
(
"list_role_bindings",
"GET",
"/rbac/agents/access-policy/role-bindings",
- lambda: svc.RBACService.AgentAccess.list_role_bindings(TENANT, ACTOR, agent_id=AGENT, policy_id=POLICY),
- ),
- (
- "replace_role_bindings",
- "PUT",
- "/rbac/agents/access-policy/role-bindings",
- lambda: svc.RBACService.AgentAccess.replace_role_bindings(
- TENANT, ACTOR, agent_id=AGENT, policy_id=POLICY, payload=svc.ReplaceRoleBindings(role_ids=["role-1"])
- ),
+ lambda: svc._AGENT_ACCESS.list_role_bindings(TENANT, ACTOR, resource_id=AGENT, policy_id=POLICY),
),
(
"list_member_bindings",
"GET",
"/rbac/agents/access-policy/member-bindings",
- lambda: svc.RBACService.AgentAccess.list_member_bindings(TENANT, ACTOR, agent_id=AGENT, policy_id=POLICY),
+ lambda: svc._AGENT_ACCESS.list_member_bindings(TENANT, ACTOR, resource_id=AGENT, policy_id=POLICY),
),
(
"delete_member_bindings",
"DELETE",
"/rbac/agents/access-policy/member-bindings",
- lambda: svc.RBACService.AgentAccess.delete_member_bindings(
- TENANT, ACTOR, agent_id=AGENT, policy_id=POLICY, payload=svc.DeleteMemberBindings(account_ids=["member-1"])
- ),
- ),
- (
- "replace_bindings",
- "PUT",
- "/rbac/agents/access-policy/bindings",
- lambda: svc.RBACService.AgentAccess.replace_bindings(
+ lambda: svc._AGENT_ACCESS.delete_member_bindings(
TENANT,
ACTOR,
- agent_id=AGENT,
+ resource_id=AGENT,
policy_id=POLICY,
- payload=svc.ReplaceBindings(role_ids=["role-1"], account_ids=["member-1"]),
+ payload=rbac_contracts.DeleteMemberBindings(account_ids=["member-1"]),
),
),
(
"workspace.agent_matrix",
"GET",
"/rbac/workspace/agents/access-policy",
- lambda: svc.RBACService.WorkspaceAccess.agent_matrix(TENANT, ACTOR),
+ lambda: svc._WORKSPACE_AGENT_ACCESS.matrix(TENANT, ACTOR),
),
(
"workspace.list_agent_role_bindings",
"GET",
"/rbac/workspace/agents/access-policy/role-bindings",
- lambda: svc.RBACService.WorkspaceAccess.list_agent_role_bindings(TENANT, ACTOR, POLICY),
- ),
- (
- "workspace.replace_agent_role_bindings",
- "PUT",
- "/rbac/workspace/agents/access-policy/role-bindings",
- lambda: svc.RBACService.WorkspaceAccess.replace_agent_role_bindings(
- TENANT, ACTOR, POLICY, svc.ReplaceRoleBindings(role_ids=["role-1"])
- ),
+ lambda: svc._WORKSPACE_AGENT_ACCESS.list_role_bindings(TENANT, ACTOR, POLICY),
),
(
"workspace.list_agent_member_bindings",
"GET",
"/rbac/workspace/agents/access-policy/member-bindings",
- lambda: svc.RBACService.WorkspaceAccess.list_agent_member_bindings(TENANT, ACTOR, POLICY),
+ lambda: svc._WORKSPACE_AGENT_ACCESS.list_member_bindings(TENANT, ACTOR, POLICY),
),
(
"workspace.replace_agent_bindings",
"PUT",
"/rbac/workspace/agents/access-policy/bindings",
- lambda: svc.RBACService.WorkspaceAccess.replace_agent_bindings(
- TENANT, ACTOR, POLICY, svc.ReplaceBindings(role_ids=["role-1"], account_ids=["member-1"])
+ lambda: svc._WORKSPACE_AGENT_ACCESS.replace_bindings(
+ TENANT, ACTOR, POLICY, rbac_contracts.ReplaceBindings(role_ids=["role-1"], account_ids=["member-1"])
),
),
(
@@ -203,11 +173,11 @@ _AGENT_CASES: list[tuple[str, str, str, Callable[[], object]]] = [
ids=[case[0] for case in _AGENT_CASES],
)
def test_agent_operations_hit_the_agent_route(
- inner_call: MagicMock, method: str, endpoint: str, invoke: Callable[[], object]
+ transport: RBACTransport, method: str, endpoint: str, invoke: Callable[[], object]
) -> None:
invoke()
- call = _last(inner_call)
+ call = _last(transport)
assert call.method == method
assert call.endpoint == endpoint
assert "/apps/" not in call.endpoint
@@ -224,33 +194,33 @@ def test_agent_operations_hit_the_agent_route(
_PARITY_CASES: list[tuple[str, Callable[[], object], Callable[[], object]]] = [
(
"whitelist_resources",
- lambda: svc.RBACService.AppAccess.whitelist_resources(TENANT, ACTOR),
- lambda: svc.RBACService.AgentAccess.whitelist_resources(TENANT, ACTOR),
+ lambda: svc._APP_ACCESS.whitelist_resources(TENANT, ACTOR),
+ lambda: svc._AGENT_ACCESS.whitelist_resources(TENANT, ACTOR),
),
(
"whitelist",
- lambda: svc.RBACService.AppAccess.whitelist(TENANT, ACTOR, "res-1"),
- lambda: svc.RBACService.AgentAccess.whitelist(TENANT, ACTOR, agent_id="res-1"),
+ lambda: svc._APP_ACCESS.whitelist(TENANT, ACTOR, "res-1"),
+ lambda: svc._AGENT_ACCESS.whitelist(TENANT, ACTOR, resource_id="res-1"),
),
(
"user_access_policies",
- lambda: svc.RBACService.AppAccess.user_access_policies(TENANT, ACTOR, "res-1"),
- lambda: svc.RBACService.AgentAccess.user_access_policies(TENANT, ACTOR, agent_id="res-1"),
+ lambda: svc._APP_ACCESS.user_access_policies(TENANT, ACTOR, "res-1"),
+ lambda: svc._AGENT_ACCESS.user_access_policies(TENANT, ACTOR, resource_id="res-1"),
),
(
"matrix",
- lambda: svc.RBACService.AppAccess.matrix(TENANT, ACTOR, "res-1"),
- lambda: svc.RBACService.AgentAccess.matrix(TENANT, ACTOR, agent_id="res-1"),
+ lambda: svc._APP_ACCESS.matrix(TENANT, ACTOR, "res-1"),
+ lambda: svc._AGENT_ACCESS.matrix(TENANT, ACTOR, resource_id="res-1"),
),
(
"list_role_bindings",
- lambda: svc.RBACService.AppAccess.list_role_bindings(TENANT, ACTOR, "res-1", POLICY),
- lambda: svc.RBACService.AgentAccess.list_role_bindings(TENANT, ACTOR, agent_id="res-1", policy_id=POLICY),
+ lambda: svc._APP_ACCESS.list_role_bindings(TENANT, ACTOR, "res-1", POLICY),
+ lambda: svc._AGENT_ACCESS.list_role_bindings(TENANT, ACTOR, resource_id="res-1", policy_id=POLICY),
),
(
"list_member_bindings",
- lambda: svc.RBACService.AppAccess.list_member_bindings(TENANT, ACTOR, "res-1", POLICY),
- lambda: svc.RBACService.AgentAccess.list_member_bindings(TENANT, ACTOR, agent_id="res-1", policy_id=POLICY),
+ lambda: svc._APP_ACCESS.list_member_bindings(TENANT, ACTOR, "res-1", POLICY),
+ lambda: svc._AGENT_ACCESS.list_member_bindings(TENANT, ACTOR, resource_id="res-1", policy_id=POLICY),
),
]
@@ -261,15 +231,15 @@ _PARITY_CASES: list[tuple[str, Callable[[], object], Callable[[], object]]] = [
ids=[case[0] for case in _PARITY_CASES],
)
def test_same_path_and_param_shape_modulo_segment(
- inner_call: MagicMock,
+ transport: RBACTransport,
app_call: Callable[[], object],
agent_call: Callable[[], object],
) -> None:
app_call()
- app = _last(inner_call)
- inner_call.reset_mock()
+ app = _last(transport)
+ transport.requests.clear()
agent_call()
- agent = _last(inner_call)
+ agent = _last(transport)
assert app.endpoint.replace("/apps/", "/agents/") == agent.endpoint
assert app.method == agent.method
diff --git a/api/tests/unit_tests/services/enterprise/test_rbac_service.py b/api/tests/unit_tests/services/enterprise/test_rbac_service.py
index 1d76cc79ff2..b38f0e5ae9b 100644
--- a/api/tests/unit_tests/services/enterprise/test_rbac_service.py
+++ b/api/tests/unit_tests/services/enterprise/test_rbac_service.py
@@ -2,46 +2,40 @@
Most enterprise RBAC methods turn a single ``EnterpriseRequest.send_inner_rbac_request``
call into a pydantic response model. Rather than spinning up an HTTP server, these tests
-monkeypatch that helper and assert on the request arguments and response shape. The legacy
-fallbacks use SQLite to verify their database reads and committed role updates.
+replace that helper and assert on the request arguments and response shape.
+Local membership tests live at the application service boundary.
"""
from __future__ import annotations
-from types import SimpleNamespace
-from unittest.mock import MagicMock, patch
+from collections.abc import Callable
import pytest
-from flask import Flask
-from sqlalchemy import select
-from sqlalchemy.orm import Session
-from models import TenantAccountJoin
from services.enterprise import rbac_service as svc
-
-MODULE = "services.enterprise.rbac_service"
+from services.enterprise.base import EnterpriseRequest
+from services.rbac import contracts as rbac_contracts
+from tests.unit_tests.rbac_fakes import RBACTransport, RecordedRequest
@pytest.fixture
-def mock_send():
- with patch(f"{MODULE}.EnterpriseRequest.send_inner_rbac_request") as send:
- yield send
+def transport(monkeypatch: pytest.MonkeyPatch) -> RBACTransport:
+ transport = RBACTransport()
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ return transport
-def _call_args(send: MagicMock) -> SimpleNamespace:
- """Return the most recent (method, endpoint, kwargs) sent to the mock."""
- send.assert_called_once()
- args, kwargs = send.call_args
- return SimpleNamespace(method=args[0], endpoint=args[1], **kwargs)
+def _call_args(transport: RBACTransport) -> RecordedRequest:
+ return transport.only_request
class TestCatalog:
- def test_workspace_catalog(self, mock_send: MagicMock):
- mock_send.return_value = {"groups": [{"group_key": "workspace", "group_name": "工作空间", "permissions": []}]}
+ def test_workspace_catalog(self, transport: RBACTransport) -> None:
+ transport.response = {"groups": [{"group_key": "workspace", "group_name": "工作空间", "permissions": []}]}
out = svc.RBACService.Catalog.workspace("tenant-1", account_id="acct-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/role-permissions/catalog"
assert call.tenant_id == "tenant-1"
@@ -51,20 +45,20 @@ class TestCatalog:
assert len(out.groups) == 1
assert out.groups[0].group_key == "workspace"
- def test_app_catalog_endpoint(self, mock_send: MagicMock):
- mock_send.return_value = {"groups": []}
+ def test_app_catalog_endpoint(self, transport: RBACTransport) -> None:
+ transport.response = {"groups": []}
svc.RBACService.Catalog.app("tenant-1")
- assert mock_send.call_args.args[1] == "/rbac/role-permissions/catalog/app"
+ assert transport.only_request.endpoint == "/rbac/role-permissions/catalog/app"
- def test_dataset_catalog_endpoint(self, mock_send: MagicMock):
- mock_send.return_value = {"groups": []}
+ def test_dataset_catalog_endpoint(self, transport: RBACTransport) -> None:
+ transport.response = {"groups": []}
svc.RBACService.Catalog.dataset("tenant-1")
- assert mock_send.call_args.args[1] == "/rbac/role-permissions/catalog/dataset"
+ assert transport.only_request.endpoint == "/rbac/role-permissions/catalog/dataset"
class TestRoles:
- def test_list_forwards_pagination_options(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_list_forwards_pagination_options(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"id": "role-1",
@@ -81,10 +75,10 @@ class TestRoles:
out = svc.RBACService.Roles.list(
"tenant-1",
"acct-1",
- options=svc.ListOption(page_number=2, results_per_page=50, reverse=True),
+ options=rbac_contracts.ListOption(page_number=2, results_per_page=50, reverse=True),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/roles"
assert call.params == {
@@ -96,20 +90,20 @@ class TestRoles:
assert out.pagination
assert out.pagination.total_count == 1
- def test_list_omits_params_when_default(self, mock_send: MagicMock):
- mock_send.return_value = {"data": [], "pagination": None}
+ def test_list_omits_params_when_default(self, transport: RBACTransport) -> None:
+ transport.response = {"data": [], "pagination": None}
svc.RBACService.Roles.list("tenant-1")
- assert _call_args(mock_send).params is not None
+ assert _call_args(transport).params is not None
- def test_list_forwards_include_owner(self, mock_send: MagicMock):
- mock_send.return_value = {"data": [], "pagination": None}
+ def test_list_forwards_include_owner(self, transport: RBACTransport) -> None:
+ transport.response = {"data": [], "pagination": None}
svc.RBACService.Roles.list("tenant-1", include_owner=1)
- assert _call_args(mock_send).params == {"dataset_operator_enabled": False, "include_owner": 1}
+ assert _call_args(transport).params == {"dataset_operator_enabled": False, "include_owner": 1}
- def test_list_coerces_null_permission_keys(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_list_coerces_null_permission_keys(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"id": "role-1",
@@ -127,16 +121,16 @@ class TestRoles:
assert out.data[0].permission_keys == []
- def test_get_passes_id_query_param(self, mock_send: MagicMock):
- mock_send.return_value = {"id": "role-1", "type": "workspace", "name": "Owner"}
+ def test_get_passes_id_query_param(self, transport: RBACTransport) -> None:
+ transport.response = {"id": "role-1", "type": "workspace", "name": "Owner"}
svc.RBACService.Roles.get("tenant-1", "acct-1", "role-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/roles/item"
assert call.params == {"billing_enabled": True, "id": "role-1"}
- def test_members_forwards_role_id_and_pagination(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_members_forwards_role_id_and_pagination(self, transport: RBACTransport) -> None:
+ transport.response = {
"role_id": "role-1",
"data": [{"account_id": "acct-2", "account_name": "Alice"}],
"pagination": {"total_count": 1, "per_page": 20, "current_page": 1, "total_pages": 1},
@@ -146,10 +140,10 @@ class TestRoles:
"tenant-1",
"acct-1",
"role-1",
- options=svc.ListOption(page_number=1, results_per_page=20),
+ options=rbac_contracts.ListOption(page_number=1, results_per_page=20),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/roles/members"
assert call.params == {"page_number": 1, "results_per_page": 20, "role_id": "role-1"}
@@ -158,12 +152,14 @@ class TestRoles:
assert out.pagination is not None
assert out.pagination.total_count == 1
- def test_create_sends_body(self, mock_send: MagicMock):
- mock_send.return_value = {"id": "role-1", "type": "workspace", "name": "Owner"}
- payload = svc.RoleMutation(name="Owner", description="full access", permission_keys=["workspace.member.manage"])
+ def test_create_sends_body(self, transport: RBACTransport) -> None:
+ transport.response = {"id": "role-1", "type": "workspace", "name": "Owner"}
+ payload = rbac_contracts.RoleMutation(
+ name="Owner", description="full access", permission_keys=["workspace.member.manage"]
+ )
svc.RBACService.Roles.create("tenant-1", "acct-1", payload)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/roles"
assert call.json == {
@@ -173,32 +169,32 @@ class TestRoles:
"type": "workspace",
}
- def test_update_sends_id_param_and_body(self, mock_send: MagicMock):
- mock_send.return_value = {"id": "role-1", "type": "workspace", "name": "Owner"}
- payload = svc.RoleMutation(name="Owner", permission_keys=["x"])
+ def test_update_sends_id_param_and_body(self, transport: RBACTransport) -> None:
+ transport.response = {"id": "role-1", "type": "workspace", "name": "Owner"}
+ payload = rbac_contracts.RoleMutation(name="Owner", permission_keys=["x"])
svc.RBACService.Roles.update("tenant-1", "acct-1", "role-1", payload)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/roles/item"
assert call.params == {"id": "role-1"}
assert call.json == {"name": "Owner", "description": "", "permission_keys": ["x"], "type": "workspace"}
- def test_delete_uses_delete_method(self, mock_send: MagicMock):
- mock_send.return_value = {"message": "success"}
+ def test_delete_uses_delete_method(self, transport: RBACTransport) -> None:
+ transport.response = {"message": "success"}
svc.RBACService.Roles.delete("tenant-1", None, "role-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "DELETE"
assert call.endpoint == "/rbac/roles/item"
assert call.params == {"id": "role-1"}
assert call.account_id is None
- def test_copy_sends_post_with_id_param(self, mock_send: MagicMock):
- mock_send.return_value = {"id": "role-1-copy", "type": "workspace", "name": "Owner copy"}
+ def test_copy_sends_post_with_id_param(self, transport: RBACTransport) -> None:
+ transport.response = {"id": "role-1-copy", "type": "workspace", "name": "Owner copy"}
svc.RBACService.Roles.copy("tenant-1", "acct-1", "role-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/roles/copy"
assert call.params == {"id": "role-1"}
@@ -206,24 +202,24 @@ class TestRoles:
class TestAccessPolicyBindings:
- def test_lock_sends_put_with_binding_id(self, mock_send: MagicMock):
- mock_send.return_value = {"binding_id": "binding-1", "is_locked": True}
+ def test_lock_sends_put_with_binding_id(self, transport: RBACTransport) -> None:
+ transport.response = {"binding_id": "binding-1", "is_locked": True}
out = svc.RBACService.AccessPolicyBindings.lock("tenant-1", "acct-1", "binding-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/access-policy-bindings/lock"
assert call.json == {"binding_id": "binding-1"}
assert out.binding_id == "binding-1"
assert out.is_locked is True
- def test_unlock_sends_put_with_binding_id(self, mock_send: MagicMock):
- mock_send.return_value = {"binding_id": "binding-1", "is_locked": False}
+ def test_unlock_sends_put_with_binding_id(self, transport: RBACTransport) -> None:
+ transport.response = {"binding_id": "binding-1", "is_locked": False}
out = svc.RBACService.AccessPolicyBindings.unlock("tenant-1", "acct-1", "binding-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/access-policy-bindings/unlock"
assert call.json == {"binding_id": "binding-1"}
@@ -232,39 +228,39 @@ class TestAccessPolicyBindings:
class TestAccessPolicies:
- def test_list_filters_by_resource_type(self, mock_send: MagicMock):
- mock_send.return_value = {"data": [], "pagination": None}
+ def test_list_filters_by_resource_type(self, transport: RBACTransport) -> None:
+ transport.response = {"data": [], "pagination": None}
svc.RBACService.AccessPolicies.list(
"tenant-1",
"acct-1",
- resource_type=svc.RBACResourceType.APP,
- options=svc.ListOption(page_number=1),
+ resource_type=rbac_contracts.RBACResourceType.APP,
+ options=rbac_contracts.ListOption(page_number=1),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.endpoint == "/rbac/access-policies"
assert call.params == {"page_number": 1, "resource_type": "app"}
- def test_copy_sends_post_with_id_param(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_copy_sends_post_with_id_param(self, transport: RBACTransport) -> None:
+ transport.response = {
"id": "policy-1-copy",
"resource_type": "app",
"name": "Full access copy",
}
svc.RBACService.AccessPolicies.copy("tenant-1", "acct-1", "policy-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/access-policies/copy"
assert call.params == {"id": "policy-1"}
- def test_create_serialises_resource_type_enum(self, mock_send: MagicMock):
- mock_send.return_value = {"id": "policy-1", "resource_type": "dataset", "name": "KB only"}
- payload = svc.AccessPolicyCreate(
+ def test_create_serialises_resource_type_enum(self, transport: RBACTransport) -> None:
+ transport.response = {"id": "policy-1", "resource_type": "dataset", "name": "KB only"}
+ payload = rbac_contracts.AccessPolicyCreate(
name="KB only",
- resource_type=svc.RBACResourceType.DATASET,
+ resource_type=rbac_contracts.RBACResourceType.DATASET,
permission_keys=["dataset.acl.readonly"],
)
svc.RBACService.AccessPolicies.create("tenant-1", "acct-1", payload)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.json == {
"name": "KB only",
@@ -275,8 +271,8 @@ class TestAccessPolicies:
class TestResourceAccess:
- def test_resource_whitelist_configs_batch_get(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_resource_whitelist_configs_batch_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"resource_type": "app",
@@ -299,15 +295,17 @@ class TestResourceAccess:
"tenant-1",
"acct-actor",
[
- svc.ResourceWhitelistConfigResource(resource_type=svc.RBACResourceType.APP, resource_id="app-1"),
- svc.ResourceWhitelistConfigResource(
- resource_type=svc.RBACResourceType.DATASET,
+ rbac_contracts.ResourceWhitelistConfigResource(
+ resource_type=rbac_contracts.RBACResourceType.APP, resource_id="app-1"
+ ),
+ rbac_contracts.ResourceWhitelistConfigResource(
+ resource_type=rbac_contracts.RBACResourceType.DATASET,
resource_id="dataset-1",
),
],
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/whitelist/configs"
assert call.json == {
@@ -321,31 +319,31 @@ class TestResourceAccess:
assert out.data[0].rbac_whitelist_scope == "all"
assert out.data[1].account_ids == []
- def test_app_whitelist_resources(self, mock_send: MagicMock):
- mock_send.return_value = {"unrestricted": True, "resource_ids": ["app-1", "app-2"]}
+ def test_app_whitelist_resources(self, transport: RBACTransport) -> None:
+ transport.response = {"unrestricted": True, "resource_ids": ["app-1", "app-2"]}
- out = svc.RBACService.AppAccess.whitelist_resources("tenant-1", "acct-1")
+ out = svc._APP_ACCESS.whitelist_resources("tenant-1", "acct-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/apps/whitelist/resources"
assert call.params is None
assert out.unrestricted is True
assert out.resource_ids == ["app-1", "app-2"]
- def test_dataset_whitelist_resources(self, mock_send: MagicMock):
- mock_send.return_value = {"resource_ids": ["dataset-1"]}
+ def test_dataset_whitelist_resources(self, transport: RBACTransport) -> None:
+ transport.response = {"resource_ids": ["dataset-1"]}
- out = svc.RBACService.DatasetAccess.whitelist_resources("tenant-1", "acct-1")
+ out = svc._DATASET_ACCESS.whitelist_resources("tenant-1", "acct-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/whitelist/resources"
assert call.params is None
assert out.resource_ids == ["dataset-1"]
- def test_app_user_access_policies(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_app_user_access_policies(self, transport: RBACTransport) -> None:
+ transport.response = {
"scope": "specific",
"pagination": {"total_count": 1, "per_page": 10, "current_page": 2, "total_pages": 3},
"data": [
@@ -370,14 +368,14 @@ class TestResourceAccess:
],
}
- out = svc.RBACService.AppAccess.user_access_policies(
+ out = svc._APP_ACCESS.user_access_policies(
"tenant-1",
"acct-1",
"app-1",
- options=svc.ListOption(page_number=2, results_per_page=10, reverse=False),
+ options=rbac_contracts.ListOption(page_number=2, results_per_page=10, reverse=False),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/apps/user-access-policies"
assert call.params == {
@@ -393,21 +391,21 @@ class TestResourceAccess:
assert out.pagination.current_page == 2
assert "scope" not in out.model_dump(mode="json")
- def test_dataset_user_access_policies_forwards_pagination(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_dataset_user_access_policies_forwards_pagination(self, transport: RBACTransport) -> None:
+ transport.response = {
"scope": "specific",
"data": [],
"pagination": {"total_count": 0, "per_page": 20, "current_page": 1, "total_pages": 0},
}
- out = svc.RBACService.DatasetAccess.user_access_policies(
+ out = svc._DATASET_ACCESS.user_access_policies(
"tenant-1",
"acct-1",
"dataset-1",
- options=svc.ListOption(page_number=1, results_per_page=20, reverse=True),
+ options=rbac_contracts.ListOption(page_number=1, results_per_page=20, reverse=True),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/user-access-policies"
assert call.params == {
@@ -419,31 +417,29 @@ class TestResourceAccess:
assert out.pagination
assert out.pagination.per_page == 20
- def test_dataset_replace_user_access_policies(self, mock_send: MagicMock):
- mock_send.return_value = {
- "access_policies": [{"id": "policy-1", "resource_type": "dataset", "name": "Can edit"}]
- }
- payload = svc.ReplaceUserAccessPolicies(access_policy_ids=["policy-1"])
+ def test_dataset_replace_user_access_policies(self, transport: RBACTransport) -> None:
+ transport.response = {"access_policies": [{"id": "policy-1", "resource_type": "dataset", "name": "Can edit"}]}
+ payload = rbac_contracts.ReplaceUserAccessPolicies(access_policy_ids=["policy-1"])
- out = svc.RBACService.DatasetAccess.replace_user_access_policies(
+ out = svc._DATASET_ACCESS.replace_user_access_policies(
"tenant-1", "acct-actor", "dataset-1", "acct-target", payload
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/datasets/user-access-policies"
assert call.params == {"dataset_id": "dataset-1", "account_id": "acct-target"}
assert call.json == {"access_policy_ids": ["policy-1"]}
assert out.access_policies[0].id == "policy-1"
- def test_app_append_whitelist_members_batch(self, mock_send: MagicMock):
- mock_send.return_value = None
+ def test_app_append_whitelist_members_batch(self, transport: RBACTransport) -> None:
+ transport.response = None
- svc.RBACService.AppAccess.append_whitelist_members_batch(
+ svc._APP_ACCESS.append_whitelist_members_batch(
"tenant-1",
"acct-actor",
[
- svc.AppendAppWhitelistMembersBatchItem(
+ rbac_contracts.AppendAppWhitelistMembersBatchItem(
app_id="app-1",
account_ids=["acct-1", "acct-2"],
policy_id="policy-1",
@@ -451,21 +447,21 @@ class TestResourceAccess:
],
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/apps/whitelist/members/batch"
assert call.json == {
"data": [{"app_id": "app-1", "account_ids": ["acct-1", "acct-2"], "policy_id": "policy-1"}]
}
- def test_dataset_append_whitelist_members_batch(self, mock_send: MagicMock):
- mock_send.return_value = None
+ def test_dataset_append_whitelist_members_batch(self, transport: RBACTransport) -> None:
+ transport.response = None
- svc.RBACService.DatasetAccess.append_whitelist_members_batch(
+ svc._DATASET_ACCESS.append_whitelist_members_batch(
"tenant-1",
"acct-actor",
[
- svc.AppendDatasetWhitelistMembersBatchItem(
+ rbac_contracts.AppendDatasetWhitelistMembersBatchItem(
dataset_id="dataset-1",
account_ids=["acct-1", "acct-2"],
policy_id="policy-1",
@@ -473,89 +469,91 @@ class TestResourceAccess:
],
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/datasets/whitelist/members/batch"
assert call.json == {
"data": [{"dataset_id": "dataset-1", "account_ids": ["acct-1", "acct-2"], "policy_id": "policy-1"}]
}
- def test_dataset_whitelist(self, mock_send: MagicMock):
- mock_send.return_value = {"account_ids": ["acct-2"], "automatic_include_workspace_members": False}
+ def test_dataset_whitelist(self, transport: RBACTransport) -> None:
+ transport.response = {"account_ids": ["acct-2"], "automatic_include_workspace_members": False}
- out = svc.RBACService.DatasetAccess.whitelist("tenant-1", "acct-1", "dataset-1")
+ out = svc._DATASET_ACCESS.whitelist("tenant-1", "acct-1", "dataset-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/whitelist"
assert call.params == {"dataset_id": "dataset-1"}
assert out.account_ids == ["acct-2"]
- def test_app_whitelist_config(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_app_whitelist_config(self, transport: RBACTransport) -> None:
+ transport.response = {
"account_ids": ["acct-1"],
"automatic_include_workspace_members": True,
}
- out = svc.RBACService.AppAccess.whitelist_config("tenant-1", "acct-1", "app-1")
+ out = svc._APP_ACCESS.whitelist_config("tenant-1", "acct-1", "app-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/apps/whitelist"
assert call.params == {"app_id": "app-1"}
assert out.model_dump(mode="json") == {"automatic_include_workspace_members": True}
- def test_dataset_whitelist_config(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_dataset_whitelist_config(self, transport: RBACTransport) -> None:
+ transport.response = {
"account_ids": ["acct-1"],
"automatic_include_workspace_members": False,
"scope": "specific",
}
- out = svc.RBACService.DatasetAccess.whitelist_config("tenant-1", "acct-1", "dataset-1")
+ out = svc._DATASET_ACCESS.whitelist_config("tenant-1", "acct-1", "dataset-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/whitelist"
assert call.params == {"dataset_id": "dataset-1"}
assert out.model_dump(mode="json") == {"automatic_include_workspace_members": False}
- def test_dataset_legacy_whitelist_config_reads_old_scope_without_public_dump(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_dataset_legacy_whitelist_config_reads_old_scope_without_public_dump(
+ self, transport: RBACTransport
+ ) -> None:
+ transport.response = {
"account_ids": ["acct-1"],
"automatic_include_workspace_members": False,
"scope": "specific",
}
- out = svc.RBACService.DatasetAccess.legacy_whitelist_config("tenant-1", "acct-1", "dataset-1")
+ out = svc._DATASET_ACCESS.legacy_whitelist_config("tenant-1", "acct-1", "dataset-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/whitelist"
assert call.params == {"dataset_id": "dataset-1"}
assert out.account_ids == ["acct-1"]
assert out.rbac_whitelist_scope == "specific"
- def test_app_matrix(self, mock_send: MagicMock):
- mock_send.return_value = {"resource_id": "app-1", "items": []}
- out = svc.RBACService.AppAccess.matrix("tenant-1", "acct-1", "app-1")
- call = _call_args(mock_send)
+ def test_app_matrix(self, transport: RBACTransport) -> None:
+ transport.response = {"resource_id": "app-1", "items": []}
+ out = svc._APP_ACCESS.matrix("tenant-1", "acct-1", "app-1")
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/apps/access-policy"
assert call.params == {"app_id": "app-1"}
assert out.app_id == "app-1"
- def test_dataset_matrix(self, mock_send: MagicMock):
- mock_send.return_value = {"resource_id": "dataset-1", "items": []}
- out = svc.RBACService.DatasetAccess.matrix("tenant-1", "acct-1", "dataset-1")
- call = _call_args(mock_send)
+ def test_dataset_matrix(self, transport: RBACTransport) -> None:
+ transport.response = {"resource_id": "dataset-1", "items": []}
+ out = svc._DATASET_ACCESS.matrix("tenant-1", "acct-1", "dataset-1")
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/datasets/access-policy"
assert call.params == {"dataset_id": "dataset-1"}
assert out.dataset_id == "dataset-1"
- def test_app_role_bindings_preserve_role_name(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_app_role_bindings_preserve_role_name(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"id": "binding-1",
@@ -569,12 +567,12 @@ class TestResourceAccess:
]
}
- out = svc.RBACService.AppAccess.list_role_bindings("tenant-1", "acct-1", "app-1", "policy-1")
+ out = svc._APP_ACCESS.list_role_bindings("tenant-1", "acct-1", "app-1", "policy-1")
assert out.data[0].role_name == "Owner"
- def test_app_member_bindings_preserve_account_name(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_app_member_bindings_preserve_account_name(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"id": "binding-1",
@@ -588,45 +586,25 @@ class TestResourceAccess:
]
}
- out = svc.RBACService.AppAccess.list_member_bindings("tenant-1", "acct-1", "app-1", "policy-1")
+ out = svc._APP_ACCESS.list_member_bindings("tenant-1", "acct-1", "app-1", "policy-1")
assert out.data[0].account_name == "Alice"
- def test_app_delete_member_bindings_uses_delete_method(self, mock_send: MagicMock):
- mock_send.return_value = None
- payload = svc.DeleteMemberBindings(account_ids=["acct-2", "acct-3"])
- svc.RBACService.AppAccess.delete_member_bindings("tenant-1", "acct-1", "app-1", "policy-1", payload)
- call = _call_args(mock_send)
+ def test_app_delete_member_bindings_uses_delete_method(self, transport: RBACTransport) -> None:
+ transport.response = None
+ payload = rbac_contracts.DeleteMemberBindings(account_ids=["acct-2", "acct-3"])
+ svc._APP_ACCESS.delete_member_bindings("tenant-1", "acct-1", "app-1", "policy-1", payload)
+ call = _call_args(transport)
assert call.method == "DELETE"
assert call.endpoint == "/rbac/apps/access-policy/member-bindings"
assert call.params == {"app_id": "app-1", "policy_id": "policy-1"}
assert call.json == {"account_ids": ["acct-2", "acct-3"]}
- def test_app_replace_bindings(self, mock_send: MagicMock):
- mock_send.return_value = {"data": []}
- payload = svc.ReplaceBindings(role_ids=["workspace.owner"], account_ids=["acct-2"])
- svc.RBACService.AppAccess.replace_bindings("tenant-1", "acct-1", "app-1", "policy-1", payload)
- call = _call_args(mock_send)
- assert call.method == "PUT"
- assert call.endpoint == "/rbac/apps/access-policy/bindings"
- assert call.params == {"app_id": "app-1", "policy_id": "policy-1"}
- assert call.json == {"role_ids": ["workspace.owner"], "account_ids": ["acct-2"]}
-
- def test_dataset_replace_bindings(self, mock_send: MagicMock):
- mock_send.return_value = {"data": []}
- payload = svc.ReplaceBindings(role_ids=["workspace.editor"], account_ids=["acct-2"])
- svc.RBACService.DatasetAccess.replace_bindings("tenant-1", "acct-1", "ds-1", "policy-1", payload)
- call = _call_args(mock_send)
- assert call.method == "PUT"
- assert call.endpoint == "/rbac/datasets/access-policy/bindings"
- assert call.params == {"dataset_id": "ds-1", "policy_id": "policy-1"}
- assert call.json == {"role_ids": ["workspace.editor"], "account_ids": ["acct-2"]}
-
- def test_dataset_delete_member_bindings_uses_delete_method(self, mock_send: MagicMock):
- mock_send.return_value = None
- payload = svc.DeleteMemberBindings(account_ids=["acct-2"])
- svc.RBACService.DatasetAccess.delete_member_bindings("tenant-1", "acct-1", "ds-1", "policy-1", payload)
- call = _call_args(mock_send)
+ def test_dataset_delete_member_bindings_uses_delete_method(self, transport: RBACTransport) -> None:
+ transport.response = None
+ payload = rbac_contracts.DeleteMemberBindings(account_ids=["acct-2"])
+ svc._DATASET_ACCESS.delete_member_bindings("tenant-1", "acct-1", "ds-1", "policy-1", payload)
+ call = _call_args(transport)
assert call.method == "DELETE"
assert call.endpoint == "/rbac/datasets/access-policy/member-bindings"
assert call.params == {"dataset_id": "ds-1", "policy_id": "policy-1"}
@@ -634,32 +612,32 @@ class TestResourceAccess:
class TestWorkspaceAccess:
- def test_app_matrix(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_app_matrix(self, transport: RBACTransport) -> None:
+ transport.response = {
"items": [],
"pagination": {"total_count": 1, "per_page": 20, "current_page": 2, "total_pages": 1},
}
- out = svc.RBACService.WorkspaceAccess.app_matrix(
+ out = svc._WORKSPACE_APP_ACCESS.matrix(
"tenant-1",
- options=svc.ListOption(page_number=2, results_per_page=20),
+ options=rbac_contracts.ListOption(page_number=2, results_per_page=20),
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/workspace/apps/access-policy"
assert call.params == {"page_number": 2, "results_per_page": 20}
assert out.pagination
assert out.pagination.current_page == 2
- def test_dataset_matrix(self, mock_send: MagicMock):
- mock_send.return_value = {"items": []}
- svc.RBACService.WorkspaceAccess.dataset_matrix("tenant-1")
- call = _call_args(mock_send)
+ def test_dataset_matrix(self, transport: RBACTransport) -> None:
+ transport.response = {"items": []}
+ svc._WORKSPACE_DATASET_ACCESS.matrix("tenant-1")
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/workspace/datasets/access-policy"
assert call.params is None
- def test_workspace_matrix_coerces_null_bindings(self, mock_send: MagicMock):
- mock_send.return_value = {
+ def test_workspace_matrix_coerces_null_bindings(self, transport: RBACTransport) -> None:
+ transport.response = {
"items": [
{
"policy": {
@@ -674,52 +652,49 @@ class TestWorkspaceAccess:
"pagination": None,
}
- out = svc.RBACService.WorkspaceAccess.app_matrix("tenant-1")
+ out = svc._WORKSPACE_APP_ACCESS.matrix("tenant-1")
assert out.items[0].roles == []
assert out.items[0].accounts == []
- def test_workspace_app_replace_bindings(self, mock_send: MagicMock):
- mock_send.return_value = {"data": []}
- payload = svc.ReplaceBindings(role_ids=["workspace.editor"], account_ids=["acct-2"])
- svc.RBACService.WorkspaceAccess.replace_app_bindings("tenant-1", "acct-1", "policy-1", payload)
- call = _call_args(mock_send)
+ def test_workspace_app_replace_bindings(self, transport: RBACTransport) -> None:
+ transport.response = {"data": []}
+ payload = rbac_contracts.ReplaceBindings(role_ids=["workspace.editor"], account_ids=["acct-2"])
+ svc._WORKSPACE_APP_ACCESS.replace_bindings("tenant-1", "acct-1", "policy-1", payload)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/workspace/apps/access-policy/bindings"
assert call.params == {"policy_id": "policy-1"}
assert call.json == {"role_ids": ["workspace.editor"], "account_ids": ["acct-2"]}
- def test_workspace_dataset_replace_bindings(self, mock_send: MagicMock):
- mock_send.return_value = {"data": []}
- payload = svc.ReplaceBindings(role_ids=["workspace.editor"], account_ids=["acct-2"])
- svc.RBACService.WorkspaceAccess.replace_dataset_bindings("tenant-1", "acct-1", "policy-1", payload)
- call = _call_args(mock_send)
+ def test_workspace_dataset_replace_bindings(self, transport: RBACTransport) -> None:
+ transport.response = {"data": []}
+ payload = rbac_contracts.ReplaceBindings(role_ids=["workspace.editor"], account_ids=["acct-2"])
+ svc._WORKSPACE_DATASET_ACCESS.replace_bindings("tenant-1", "acct-1", "policy-1", payload)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/workspace/datasets/access-policy/bindings"
assert call.params == {"policy_id": "policy-1"}
assert call.json == {"role_ids": ["workspace.editor"], "account_ids": ["acct-2"]}
- def test_workspace_app_matrix_forwards_language_query_param(self, mock_send: MagicMock):
- mock_send.return_value = {"items": [], "pagination": None}
- app = Flask(__name__)
- with app.test_request_context("/?language=en"):
- svc.RBACService.WorkspaceAccess.app_matrix("tenant-1")
+ def test_workspace_app_matrix_forwards_explicit_language(self, transport: RBACTransport) -> None:
+ transport.response = {"items": [], "pagination": None}
+ svc._WORKSPACE_APP_ACCESS.matrix("tenant-1", language="en")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.params == {"language": "en"}
[email protected]("sqlite_session", [(TenantAccountJoin,)], indirect=True)
class TestMyPermissions:
@pytest.fixture(autouse=True)
- def _rbac_enabled(self, config_overrides) -> None:
+ def _rbac_enabled(self, config_overrides: Callable[..., None]) -> None:
config_overrides(RBAC_ENABLED=True)
- def test_resource_snapshot_maps_defaults_and_overrides(self, sqlite_session: Session):
- snapshot = svc.ResourcePermissionSnapshot(
+ def test_resource_snapshot_maps_defaults_and_overrides(self) -> None:
+ snapshot = rbac_contracts.ResourcePermissionSnapshot(
default_permission_keys=["app.acl.view_layout"],
overrides=[
- svc.ResourcePermissionKeys(
+ rbac_contracts.ResourcePermissionKeys(
resource_id="app-2",
permission_keys=["app.acl.view_layout", "app.acl.edit"],
)
@@ -731,146 +706,24 @@ class TestMyPermissions:
"app-2": ["app.acl.view_layout", "app.acl.edit"],
}
- def test_get_without_payload_uses_get(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_get_without_payload_uses_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"workspace": {"permission_keys": ["workspace.member.manage"]},
"app": {"default_permission_keys": ["app.acl.view_layout", "app.acl.test_and_run"], "overrides": []},
"dataset": {"default_permission_keys": [], "overrides": []},
}
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", session=sqlite_session)
+ out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/my-permissions"
assert call.json is None
assert call.params is None
assert out.workspace.permission_keys == ["workspace.member.manage"]
- @pytest.mark.parametrize(
- ("role", "workspace_keys", "app_keys", "dataset_keys", "agent_keys"),
- [
- (
- "owner",
- svc._LEGACY_WORKSPACE_OWNER_KEYS,
- svc._LEGACY_APP_OWNER_KEYS,
- svc._LEGACY_DATASET_OWNER_KEYS,
- svc._LEGACY_AGENT_FULL_ACCESS_KEYS,
- ),
- (
- "admin",
- svc._LEGACY_WORKSPACE_ADMIN_KEYS,
- svc._LEGACY_APP_ADMIN_KEYS,
- svc._LEGACY_DATASET_ADMIN_KEYS,
- svc._LEGACY_AGENT_FULL_ACCESS_KEYS,
- ),
- (
- "editor",
- svc._LEGACY_WORKSPACE_EDITOR_KEYS,
- svc._LEGACY_APP_EDITOR_KEYS,
- svc._LEGACY_DATASET_EDITOR_KEYS,
- svc._LEGACY_AGENT_FULL_ACCESS_KEYS,
- ),
- (
- "normal",
- svc._LEGACY_WORKSPACE_NORMAL_KEYS,
- svc._LEGACY_APP_NORMAL_KEYS,
- [],
- svc._LEGACY_AGENT_PREVIEW_KEYS,
- ),
- (
- "dataset_operator",
- svc._LEGACY_WORKSPACE_DATASET_OPERATOR_KEYS,
- svc._LEGACY_APP_DATASET_OPERATOR_KEYS,
- svc._LEGACY_DATASET_DATASET_OPERATOR_KEYS,
- svc._LEGACY_AGENT_PREVIEW_KEYS,
- ),
- ],
- )
- def test_get_uses_legacy_role_permissions_when_rbac_disabled(
- self,
- mock_send: MagicMock,
- role: str,
- workspace_keys: list[str],
- app_keys: list[str],
- dataset_keys: list[str],
- agent_keys: list[str],
- sqlite_session: Session,
- config_overrides,
- ):
- config_overrides(RBAC_ENABLED=False)
- sqlite_session.add(
- TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=svc.TenantAccountRole(role))
- )
- sqlite_session.commit()
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", session=sqlite_session)
-
- mock_send.assert_not_called()
- assert out.workspace.permission_keys == workspace_keys
- assert len(out.workspace.permission_keys) == len(set(out.workspace.permission_keys))
- assert out.app.default_permission_keys == app_keys
- assert out.dataset.default_permission_keys == dataset_keys
- assert out.agent.default_permission_keys == agent_keys
- assert out.app.overrides == []
- assert out.dataset.overrides == []
- assert out.agent.overrides == []
- if role == "owner":
- assert "snippets.management" in out.workspace.permission_keys
- assert "app.acl.preview" in out.workspace.permission_keys
- assert "dataset.acl.preview" in out.workspace.permission_keys
- assert "app.acl.preview" in out.app.default_permission_keys
- assert "dataset.acl.preview" in out.dataset.default_permission_keys
- assert not any(key.startswith("billing.") for key in out.workspace.permission_keys)
- if role == "editor":
- assert "app.acl.log_and_annotation" in out.app.default_permission_keys
- assert "app.acl.deploy" not in out.app.default_permission_keys
-
- @pytest.mark.parametrize(
- ("role", "expected_snippet_keys"),
- [
- ("owner", {"snippets.create_and_modify", "snippets.management"}),
- ("admin", {"snippets.create_and_modify", "snippets.management"}),
- ("editor", {"snippets.create_and_modify"}),
- ("normal", set()),
- ("dataset_operator", set()),
- ],
- )
- def test_get_uses_legacy_snippet_permissions_when_rbac_disabled(
- self,
- mock_send: MagicMock,
- role: str,
- expected_snippet_keys: set[str],
- sqlite_session: Session,
- config_overrides,
- ):
- config_overrides(RBAC_ENABLED=False)
- sqlite_session.add(
- TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=svc.TenantAccountRole(role))
- )
- sqlite_session.commit()
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", session=sqlite_session)
-
- actual_snippet_keys = {
- permission_key for permission_key in out.workspace.permission_keys if permission_key.startswith("snippets.")
- }
-
- mock_send.assert_not_called()
- assert actual_snippet_keys == expected_snippet_keys
-
- def test_get_returns_empty_when_role_missing_and_rbac_disabled(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", session=sqlite_session)
-
- mock_send.assert_not_called()
- assert out.workspace.permission_keys == []
- assert out.app.default_permission_keys == []
- assert out.dataset.default_permission_keys == []
- assert out.agent.default_permission_keys == []
-
- def test_get_with_single_resource_filters(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_get_with_single_resource_filters(self, transport: RBACTransport) -> None:
+ transport.response = {
"workspace": {"permission_keys": []},
"app": {
"default_permission_keys": [],
@@ -879,16 +732,16 @@ class TestMyPermissions:
"dataset": {"default_permission_keys": [], "overrides": []},
}
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", app_id="app-1", session=sqlite_session)
+ out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", app_id="app-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/my-permissions"
assert call.params == {"app_id": "app-1"}
assert out.app.overrides[0].resource_id == "app-1"
- def test_get_forwards_agent_id_and_parses_agent_snapshot(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_get_forwards_agent_id_and_parses_agent_snapshot(self, transport: RBACTransport) -> None:
+ transport.response = {
"workspace": {"permission_keys": []},
"app": {"default_permission_keys": [], "overrides": []},
"dataset": {"default_permission_keys": [], "overrides": []},
@@ -898,9 +751,9 @@ class TestMyPermissions:
},
}
- out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", agent_id="agent-1", session=sqlite_session)
+ out = svc.RBACService.MyPermissions.get("tenant-1", "acct-1", agent_id="agent-1")
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/my-permissions"
assert call.params == {"agent_id": "agent-1"}
@@ -909,14 +762,13 @@ class TestMyPermissions:
assert out.agent.overrides[0].permission_keys == ["agent.acl.edit"]
[email protected]("sqlite_session", [(TenantAccountJoin,)], indirect=True)
class TestMemberRoles:
@pytest.fixture(autouse=True)
- def _rbac_enabled(self, config_overrides) -> None:
+ def _rbac_enabled(self, config_overrides: Callable[..., None]) -> None:
config_overrides(RBAC_ENABLED=True)
- def test_get(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"account_id": "acct-2",
"roles": [
{
@@ -926,114 +778,30 @@ class TestMemberRoles:
}
],
}
- out = svc.RBACService.MemberRoles.get("tenant-1", "acct-1", "acct-2", session=sqlite_session)
- call = _call_args(mock_send)
+ out = svc.RBACService.MemberRoles.get("tenant-1", "acct-1", "acct-2")
+ call = _call_args(transport)
assert call.method == "GET"
assert call.endpoint == "/rbac/members/rbac-roles"
assert call.params == {"account_id": "acct-2"}
assert out.account_id == "acct-2"
assert out.roles[0].name == "Member"
- def test_get_legacy_role_includes_permission_keys(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- sqlite_session.add(
- TenantAccountJoin(tenant_id="tenant-1", account_id="acct-2", role=svc.TenantAccountRole.EDITOR)
- )
- sqlite_session.commit()
-
- out = svc.RBACService.MemberRoles.get("tenant-1", "acct-1", "acct-2", session=sqlite_session)
-
- mock_send.assert_not_called()
- assert out.account_id == "acct-2"
- assert out.roles[0].name == "editor"
- assert out.roles[0].permission_keys == list(
- dict.fromkeys(
- [
- *svc._LEGACY_WORKSPACE_EDITOR_KEYS,
- *svc._LEGACY_APP_EDITOR_KEYS,
- *svc._LEGACY_DATASET_EDITOR_KEYS,
- *svc._LEGACY_AGENT_FULL_ACCESS_KEYS,
- ]
- )
- )
- assert "snippets.create_and_modify" in out.roles[0].permission_keys
- assert "app.acl.preview" in out.roles[0].permission_keys
- assert "dataset.acl.preview" in out.roles[0].permission_keys
- assert "app.acl.deploy" not in out.roles[0].permission_keys
-
- def test_replace(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {"account_id": "acct-2", "roles": []}
+ def test_replace(self, transport: RBACTransport) -> None:
+ transport.response = {"account_id": "acct-2", "roles": []}
svc.RBACService.MemberRoles.replace(
"tenant-1",
"acct-1",
"acct-2",
role_ids=["workspace.owner", "workspace.editor"],
- session=sqlite_session,
)
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "PUT"
assert call.endpoint == "/rbac/members/rbac-roles"
assert call.params == {"account_id": "acct-2"}
assert call.json == {"role_ids": ["workspace.owner", "workspace.editor"]}
- def test_replace_commits_legacy_join_role_when_rbac_disabled(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- target_join = TenantAccountJoin(tenant_id="tenant-1", account_id="acct-2", role=svc.TenantAccountRole.NORMAL)
- sqlite_session.add(target_join)
- sqlite_session.commit()
- target_join_id = target_join.id
- engine = sqlite_session.get_bind()
-
- out = svc.RBACService.MemberRoles.replace(
- "tenant-1", "acct-1", "acct-2", role_ids=["editor"], session=sqlite_session
- )
-
- mock_send.assert_not_called()
- # Closing the writer rolls back any uncommitted update and prevents its identity map
- # from satisfying the verification query.
- sqlite_session.close()
- with Session(engine) as verification_session:
- persisted_join = verification_session.scalar(
- select(TenantAccountJoin).where(TenantAccountJoin.id == target_join_id)
- )
- assert persisted_join is not None
- assert persisted_join.role == svc.TenantAccountRole.EDITOR
- assert out.account_id == "acct-2"
- assert out.roles[0].id == "editor"
- assert "app.acl.preview" in out.roles[0].permission_keys
-
- def test_replace_legacy_owner_demotes_current_owner_when_rbac_disabled(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- target_join = TenantAccountJoin(tenant_id="tenant-1", account_id="acct-2", role=svc.TenantAccountRole.NORMAL)
- owner_join = TenantAccountJoin(tenant_id="tenant-1", account_id="acct-owner", role=svc.TenantAccountRole.OWNER)
- sqlite_session.add_all([target_join, owner_join])
- sqlite_session.commit()
-
- out = svc.RBACService.MemberRoles.replace(
- "tenant-1", "acct-1", "acct-2", role_ids=["owner"], session=sqlite_session
- )
-
- mock_send.assert_not_called()
- persisted_joins = {
- join.account_id: join.role
- for join in sqlite_session.scalars(
- select(TenantAccountJoin).where(TenantAccountJoin.tenant_id == "tenant-1")
- )
- }
- assert persisted_joins == {
- "acct-2": svc.TenantAccountRole.OWNER,
- "acct-owner": svc.TenantAccountRole.NORMAL,
- }
- assert out.roles[0].id == "owner"
-
- def test_batch_get(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_batch_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"acct-2": [
{"id": "role-1", "name": "Admin", "type": "workspace"},
{"id": "role-2", "name": "Editor", "type": "workspace"},
@@ -1043,7 +811,7 @@ class TestMemberRoles:
out = svc.RBACService.MemberRoles.batch_get("tenant-1", "acct-1", ["acct-2", "acct-3"])
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/members/rbac-roles/batch"
assert call.json == {"member_ids": ["acct-2", "acct-3"]}
@@ -1053,14 +821,13 @@ class TestMemberRoles:
assert out[1].roles == []
[email protected]("sqlite_session", [(TenantAccountJoin,)], indirect=True)
class TestResourcePermissions:
@pytest.fixture(autouse=True)
- def _rbac_enabled(self, config_overrides) -> None:
+ def _rbac_enabled(self, config_overrides: Callable[..., None]) -> None:
config_overrides(RBAC_ENABLED=True)
- def test_app_permissions_batch_get(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_app_permissions_batch_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{
"resource_id": "app-1",
@@ -1070,9 +837,9 @@ class TestResourcePermissions:
]
}
- out = svc.RBACService.AppPermissions.batch_get("tenant-1", "acct-1", ["app-1", "app-2"], session=sqlite_session)
+ out = svc.RBACService.AppPermissions.batch_get("tenant-1", "acct-1", ["app-1", "app-2"])
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/apps/permission-keys/batch"
assert call.json == {"app_ids": ["app-1", "app-2"]}
@@ -1081,36 +848,17 @@ class TestResourcePermissions:
"app-2": [],
}
- def test_app_permissions_batch_get_uses_legacy_role_permissions_when_rbac_disabled(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- sqlite_session.add(
- TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=svc.TenantAccountRole.EDITOR)
- )
- sqlite_session.commit()
- out = svc.RBACService.AppPermissions.batch_get("tenant-1", "acct-1", ["app-1", "app-2"], session=sqlite_session)
-
- mock_send.assert_not_called()
- assert out == {
- "app-1": svc._LEGACY_APP_EDITOR_KEYS,
- "app-2": svc._LEGACY_APP_EDITOR_KEYS,
- }
- assert all("app.acl.deploy" not in permission_keys for permission_keys in out.values())
-
- def test_dataset_permissions_batch_get(self, mock_send: MagicMock, sqlite_session: Session):
- mock_send.return_value = {
+ def test_dataset_permissions_batch_get(self, transport: RBACTransport) -> None:
+ transport.response = {
"data": [
{"resource_id": "ds-1", "permission_keys": ["dataset.acl.readonly"]},
{"resource_id": "ds-2", "permission_keys": ["dataset.acl.edit"]},
]
}
- out = svc.RBACService.DatasetPermissions.batch_get(
- "tenant-1", "acct-1", ["ds-1", "ds-2"], session=sqlite_session
- )
+ out = svc.RBACService.DatasetPermissions.batch_get("tenant-1", "acct-1", ["ds-1", "ds-2"])
- call = _call_args(mock_send)
+ call = _call_args(transport)
assert call.method == "POST"
assert call.endpoint == "/rbac/datasets/permission-keys/batch"
assert call.json == {"dataset_ids": ["ds-1", "ds-2"]}
@@ -1119,52 +867,17 @@ class TestResourcePermissions:
"ds-2": ["dataset.acl.edit"],
}
- def test_dataset_permissions_batch_get_uses_legacy_role_permissions_when_rbac_disabled(
- self, mock_send: MagicMock, sqlite_session: Session, config_overrides
- ):
- config_overrides(RBAC_ENABLED=False)
- sqlite_session.add(
- TenantAccountJoin(
- tenant_id="tenant-1",
- account_id="acct-1",
- role=svc.TenantAccountRole.DATASET_OPERATOR,
- )
- )
- sqlite_session.commit()
- out = svc.RBACService.DatasetPermissions.batch_get(
- "tenant-1", "acct-1", ["ds-1", "ds-2"], session=sqlite_session
- )
-
- mock_send.assert_not_called()
- assert out == {
- "ds-1": svc._LEGACY_DATASET_DATASET_OPERATOR_KEYS,
- "ds-2": svc._LEGACY_DATASET_DATASET_OPERATOR_KEYS,
- }
-
class TestListOption:
- def test_empty_produces_empty_params(self):
- assert svc.ListOption().to_params() == {}
+ def test_empty_produces_empty_params(self) -> None:
+ assert rbac_contracts.ListOption().to_params() == {}
- def test_reverse_serialises_as_lowercase_bool(self):
- assert svc.ListOption(reverse=False).to_params()["reverse"] == "false"
- assert svc.ListOption(reverse=True).to_params()["reverse"] == "true"
+ def test_reverse_serialises_as_lowercase_bool(self) -> None:
+ assert rbac_contracts.ListOption(reverse=False).to_params()["reverse"] == "false"
+ assert rbac_contracts.ListOption(reverse=True).to_params()["reverse"] == "true"
- def test_extra_overrides_merge(self):
- assert svc.ListOption(page_number=1).to_params({"resource_type": "app", "skip": None}) == {
+ def test_extra_overrides_merge(self) -> None:
+ assert rbac_contracts.ListOption(page_number=1).to_params({"resource_type": "app", "skip": None}) == {
"page_number": 1,
"resource_type": "app",
}
-
-
-class TestLegacyAgentKeys:
- def test_legacy_workspace_keys_no_longer_carry_agent_manage(self):
- for keys in (
- svc._LEGACY_WORKSPACE_OWNER_KEYS,
- svc._LEGACY_WORKSPACE_ADMIN_KEYS,
- svc._LEGACY_WORKSPACE_EDITOR_KEYS,
- svc._LEGACY_WORKSPACE_NORMAL_KEYS,
- svc._LEGACY_WORKSPACE_DATASET_OPERATOR_KEYS,
- ):
- assert "agent.manage" not in keys
- assert {"agent.acl.preview", "agent.acl.access_point_view"} <= set(keys)
diff --git a/api/tests/unit_tests/services/knowledge/test_dataset_adapters.py b/api/tests/unit_tests/services/knowledge/test_dataset_adapters.py
index 06d1eb39524..dce7c1d5242 100644
--- a/api/tests/unit_tests/services/knowledge/test_dataset_adapters.py
+++ b/api/tests/unit_tests/services/knowledge/test_dataset_adapters.py
@@ -1,4 +1,4 @@
-from collections.abc import Callable, Iterator
+from collections.abc import Callable
from unittest.mock import patch
import pytest
@@ -31,8 +31,10 @@ from services.knowledge.documents.adapters import SQLAlchemyDocumentOperations
from services.knowledge.entities.document_creation import DocumentIndexingJobs
from services.knowledge.entities.knowledge_entities import KnowledgeConfig
from services.knowledge.resource_scope import DatasetRef
+from services.rbac import contracts as rbac_contracts
from services.tag_application_service import CreateTagInput, TagApplicationService, TagBindingInput
from tests.unit_tests.config_override import apply_config_overrides
+from tests.unit_tests.rbac_fakes import RBACDomain
CONTEXT = RequestContext("request", None, "actor", "tenant")
REF = DatasetRef("tenant", "dataset")
@@ -77,7 +79,8 @@ def operations(
monkeypatch: pytest.MonkeyPatch,
application_tags: TagApplicationService,
app_services: AppServices,
-) -> Iterator[SQLAlchemyDatasetOperations]:
+ rbac_domain: RBACDomain,
+) -> SQLAlchemyDatasetOperations:
apply_config_overrides(monkeypatch, RBAC_ENABLED=False)
with sqlite_session_factory.begin() as session:
tenant = Tenant(name="Workspace")
@@ -93,16 +96,12 @@ def operations(
dataset(id="foreign", tenant_id="other", name="Foreign"),
]
)
- with (
- patch.object(rbac_service.RBACService.MyPermissions, "get", return_value=rbac_service.MyPermissionsResponse()),
- patch.object(
- rbac_service.RBACService.DatasetPermissions, "batch_get", return_value={"dataset": ["dataset.preview"]}
- ),
- patch.object(rbac_service, "try_sync_creator_access_policy_member_bindings"),
- ):
- yield SQLAlchemyDatasetOperations(
- session_factory=sqlite_session_factory, tags=application_tags, app_queries=app_services.queries
- )
+ return SQLAlchemyDatasetOperations(
+ session_factory=sqlite_session_factory,
+ tags=application_tags,
+ app_queries=app_services.queries,
+ members=rbac_domain.rbac.members,
+ )
def test_listing_materializes_page_and_owner_scoped_partial_members(
@@ -274,7 +273,7 @@ def test_created_dataset_initializes_rbac_access(
CONTEXT.active_workspace_id,
CONTEXT.account_id,
dataset_id,
- rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=False),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=False),
)
else:
replace_whitelist.assert_not_called()
@@ -283,7 +282,7 @@ def test_created_dataset_initializes_rbac_access(
sync_creator.assert_called_once_with(
CONTEXT.active_workspace_id,
CONTEXT.account_id,
- rbac_service.RBACResourceType.DATASET,
+ rbac_contracts.RBACResourceType.DATASET,
dataset_id,
)
else:
diff --git a/api/tests/unit_tests/services/knowledge/test_external_adapters.py b/api/tests/unit_tests/services/knowledge/test_external_adapters.py
index dc70a8baccd..c50a2e878a6 100644
--- a/api/tests/unit_tests/services/knowledge/test_external_adapters.py
+++ b/api/tests/unit_tests/services/knowledge/test_external_adapters.py
@@ -17,13 +17,16 @@ from services.knowledge.dataset_access import DatasetNotFoundError
from services.knowledge.external.adapters import SQLAlchemyExternalKnowledgeOperations
from services.knowledge.external.application import ExternalTemplateNotFoundError
from services.knowledge.resource_scope import DatasetRef
+from tests.unit_tests.rbac_fakes import RBACDomain
CONTEXT = RequestContext("request", None, "actor", "tenant")
REF = DatasetRef("tenant", "dataset")
@pytest.fixture
-def operations(sqlite_session_factory: sessionmaker[Session]) -> SQLAlchemyExternalKnowledgeOperations:
+def operations(
+ sqlite_session_factory: sessionmaker[Session], rbac_domain: RBACDomain
+) -> SQLAlchemyExternalKnowledgeOperations:
with sqlite_session_factory.begin() as session:
for workspace, template_id, dataset_id in [
("tenant", "template", "dataset"),
@@ -53,7 +56,9 @@ def operations(sqlite_session_factory: sessionmaker[Session]) -> SQLAlchemyExter
),
]
)
- return SQLAlchemyExternalKnowledgeOperations(session_factory=sqlite_session_factory)
+ return SQLAlchemyExternalKnowledgeOperations(
+ session_factory=sqlite_session_factory, members=rbac_domain.rbac.members
+ )
@pytest.fixture
diff --git a/api/tests/unit_tests/services/rbac/test_application.py b/api/tests/unit_tests/services/rbac/test_application.py
new file mode 100644
index 00000000000..e07567c999d
--- /dev/null
+++ b/api/tests/unit_tests/services/rbac/test_application.py
@@ -0,0 +1,291 @@
+"""RBAC use cases exercise real repositories and explicit transport/task fakes."""
+
+from collections.abc import Callable
+
+import pytest
+from sqlalchemy import select
+from sqlalchemy.orm import Session, sessionmaker
+
+from enums import DeploymentEdition
+from enums.account import TenantAccountRole
+from machinery.context import RequestContext
+from models import Dataset, TenantAccountJoin
+from services.errors.base import NoPermissionError
+from services.errors.workspace import CannotOperateSelfError, InvalidWorkspaceMemberRoleError, RoleAlreadyAssignedError
+from services.rbac import contracts as dto
+from tests.unit_tests.model_factories import make_account, make_app, make_tenant
+from tests.unit_tests.rbac_fakes import Initialization, RBACDomain, build_rbac_domain
+
+CONTEXT = RequestContext("request", "trace", "actor", "workspace")
+
+
+def domain(
+ sqlite_session_factory: sessionmaker[Session],
+ monkeypatch: pytest.MonkeyPatch,
+ config_overrides: Callable[..., None],
+) -> RBACDomain:
+ config_overrides(RBAC_ENABLED=True, DEPLOYMENT_EDITION=DeploymentEdition.ENTERPRISE)
+ return build_rbac_domain(sqlite_session_factory, monkeypatch)
+
+
+def add_members(domain: RBACDomain, roles: dict[str, TenantAccountRole]) -> None:
+ with domain.sessions.begin() as session:
+ session.add(make_tenant(tenant_id="workspace"))
+ for account_id, role in roles.items():
+ account = make_account(account_id=account_id, name="Resolved name", email=f"{account_id}@example.com")
+ account.avatar = "avatar"
+ session.add(account)
+ session.add(TenantAccountJoin(tenant_id="workspace", account_id=account_id, role=role))
+
+
[email protected]("billing", [True, False])
[email protected]("dataset_operator", [True, False])
+def test_builtin_roles_keep_filters_owner_projection_and_pagination(
+ domain: RBACDomain, config_overrides: Callable[..., None], billing: bool, dataset_operator: bool
+) -> None:
+ config_overrides(
+ RBAC_ENABLED=False,
+ DEPLOYMENT_EDITION=DeploymentEdition.CLOUD if billing else DeploymentEdition.ENTERPRISE,
+ DATASET_OPERATOR_ENABLED=dataset_operator,
+ )
+ service = domain.rbac.roles
+ complete = service.list(CONTEXT, options=dto.ListOption(), include_owner=1, language=None)
+ assert [role.name for role in complete.data] == ["owner", "admin", "editor", "normal"] + (
+ ["dataset_operator"] if dataset_operator else []
+ )
+ assert complete.data[0].role_tag == "owner"
+ assert "workspace.role.manage" in complete.data[0].permission_keys
+ page = service.list(
+ CONTEXT, options=dto.ListOption(page_number=2, results_per_page=2, reverse=True), include_owner=0, language=None
+ )
+ assert [role.id for role in page.data] == [role.id for role in reversed(complete.data[1:])][2:4]
+ assert page.pagination is not None
+ assert page.pagination.total_count == 3 + int(dataset_operator)
+ assert page.pagination.current_page == 2
+ assert not domain.transport.requests
+
+
+def test_enterprise_roles_receive_identity_billing_and_language(
+ domain: RBACDomain, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(DEPLOYMENT_EDITION=DeploymentEdition.CLOUD)
+ domain.transport.response = {"data": []}
+ domain.rbac.roles.list(
+ CONTEXT, options=dto.ListOption(page_number=3, results_per_page=10), include_owner=1, language="ja"
+ )
+ sent = domain.transport.only_request
+ assert (sent.tenant_id, sent.account_id) == ("workspace", "actor")
+ assert sent.params == {
+ "page_number": 3,
+ "results_per_page": 10,
+ "include_owner": 1,
+ "biiling_enabled": True,
+ "language": "ja",
+ "dataset_operator_enabled": False,
+ }
+
+
[email protected]("role", [None, TenantAccountRole.EDITOR, TenantAccountRole.OWNER])
+def test_builtin_member_and_permission_snapshots_share_membership(
+ domain: RBACDomain, config_overrides: Callable[..., None], role: TenantAccountRole | None
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ if role:
+ add_members(domain, {"actor": role})
+ result = domain.rbac.members.get(CONTEXT, "actor", language=None)
+ assert [item.id for item in result.roles] == ([role.value] if role else [])
+ permissions = domain.rbac.members.permissions(
+ CONTEXT.active_workspace_id, CONTEXT.account_id, app_id=None, dataset_id=None, agent_id=None, language=None
+ )
+ assert bool(permissions.app.default_permission_keys) is bool(role)
+ assert not domain.transport.requests
+
+
[email protected]("roles", [[], ["admin", "editor"], ["unknown"]])
+def test_invalid_builtin_role_assignments_never_write(
+ domain: RBACDomain, config_overrides: Callable[..., None], roles: list[str]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ add_members(domain, {"member": TenantAccountRole.NORMAL})
+ with pytest.raises(InvalidWorkspaceMemberRoleError):
+ domain.rbac.members.replace(CONTEXT, "member", roles, language=None)
+ with domain.sessions() as session:
+ assert session.scalar(select(TenantAccountJoin.role)) == TenantAccountRole.NORMAL
+ assert not domain.transport.requests
+
+
+def test_builtin_owner_replacement_commits_both_memberships(
+ domain: RBACDomain, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ add_members(domain, {"actor": TenantAccountRole.OWNER, "member": TenantAccountRole.NORMAL})
+ result = domain.rbac.members.replace(CONTEXT, "member", ["owner"], language=None)
+ assert result.roles[0].id == "owner"
+ with domain.sessions() as session:
+ assigned = dict(session.execute(select(TenantAccountJoin.account_id, TenantAccountJoin.role)).tuples().all())
+ assert assigned == {"actor": TenantAccountRole.NORMAL, "member": TenantAccountRole.OWNER}
+ assert not domain.transport.requests
+
+
+ ("actor_role", "member_id", "new_role", "error"),
+ [
+ (None, "member", "owner", NoPermissionError),
+ (TenantAccountRole.NORMAL, "actor", "owner", CannotOperateSelfError),
+ (TenantAccountRole.NORMAL, "member", "owner", NoPermissionError),
+ (TenantAccountRole.NORMAL, "member", "admin", NoPermissionError),
+ (TenantAccountRole.EDITOR, "member", "admin", NoPermissionError),
+ (TenantAccountRole.ADMIN, "member", "owner", NoPermissionError),
+ (TenantAccountRole.ADMIN, "owner", "normal", NoPermissionError),
+ (TenantAccountRole.ADMIN, "member", "dataset_operator", InvalidWorkspaceMemberRoleError),
+ (TenantAccountRole.ADMIN, "member", "normal", RoleAlreadyAssignedError),
+ ],
+)
+def test_builtin_role_changes_enforce_workspace_policy_without_writing(
+ domain: RBACDomain,
+ config_overrides: Callable[..., None],
+ actor_role: TenantAccountRole | None,
+ member_id: str,
+ new_role: str,
+ error: type[Exception],
+) -> None:
+ config_overrides(RBAC_ENABLED=False, DATASET_OPERATOR_ENABLED=False)
+ original = {"owner": TenantAccountRole.OWNER, "member": TenantAccountRole.NORMAL}
+ if actor_role is not None:
+ original["actor"] = actor_role
+ add_members(domain, original)
+ with pytest.raises(error):
+ domain.rbac.members.replace(CONTEXT, member_id, [new_role], language=None)
+ with domain.sessions() as session:
+ assigned = dict(session.execute(select(TenantAccountJoin.account_id, TenantAccountJoin.role)).tuples().all())
+ assert assigned == original
+ assert not domain.transport.requests
+
+
[email protected]("actor_role", [TenantAccountRole.OWNER, TenantAccountRole.ADMIN])
[email protected]("new_role", [TenantAccountRole.EDITOR, TenantAccountRole.DATASET_OPERATOR])
+def test_builtin_role_changes_allow_authorized_operators(
+ domain: RBACDomain,
+ config_overrides: Callable[..., None],
+ actor_role: TenantAccountRole,
+ new_role: TenantAccountRole,
+) -> None:
+ config_overrides(RBAC_ENABLED=False, DATASET_OPERATOR_ENABLED=True)
+ add_members(domain, {"actor": actor_role, "member": TenantAccountRole.NORMAL})
+ result = domain.rbac.members.replace(CONTEXT, "member", [new_role.value], language=None)
+ assert result.roles[0].id == new_role.value
+ with domain.sessions() as session:
+ assigned = dict(session.execute(select(TenantAccountJoin.account_id, TenantAccountJoin.role)).tuples().all())
+ assert assigned == {"actor": actor_role, "member": new_role}
+ assert not domain.transport.requests
+
+
+def test_enterprise_member_use_cases_keep_assignment_and_resource_filters(domain: RBACDomain) -> None:
+ domain.transport.response = {"account_id": "member", "roles": []}
+ domain.rbac.members.get(CONTEXT, "member", language="en")
+ domain.rbac.members.replace(CONTEXT, "member", ["custom-role"], language="en")
+ domain.rbac.members.permissions(
+ CONTEXT.active_workspace_id, CONTEXT.account_id, app_id="app", dataset_id=None, agent_id=None, language="en"
+ )
+ get, replace, permissions = domain.transport.requests
+ assert get.params == {"account_id": "member", "language": "en"}
+ assert replace.json == {"role_ids": ["custom-role"]}
+ assert permissions.params == {"app_id": "app", "language": "en"}
+ with domain.sessions() as session:
+ assert session.scalar(select(TenantAccountJoin)) is None
+
+
+ ("kind", "id_param"),
+ [
+ (dto.RBACResourceType.APP, "app_id"),
+ (dto.RBACResourceType.DATASET, "dataset_id"),
+ (dto.RBACResourceType.AGENT, "agent_id"),
+ ],
+)
[email protected]("automatic", [True, False])
+def test_successful_whitelist_update_initializes_only_automatic_scope(
+ domain: RBACDomain, kind: dto.RBACResourceType, id_param: str, automatic: bool
+) -> None:
+ domain.transport.response = {"account_ids": ["member"]}
+ result = domain.rbac.resources.replace_whitelist(
+ CONTEXT,
+ kind,
+ "resource",
+ dto.ReplaceMemberBindings(automatic_include_workspace_members=automatic),
+ language=None,
+ )
+ assert result.account_ids == ["member"]
+ assert domain.tasks.queued == ([Initialization("workspace", "actor", {id_param: "resource"})] if automatic else [])
+
+
+def test_failed_whitelist_update_never_dispatches(domain: RBACDomain) -> None:
+ domain.transport.failure = ValueError("denied")
+ with pytest.raises(ValueError, match="denied"):
+ domain.rbac.resources.replace_whitelist(
+ CONTEXT,
+ dto.RBACResourceType.APP,
+ "app",
+ dto.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ language=None,
+ )
+ assert not domain.tasks.queued
+
+
[email protected]("kind", list(dto.RBACResourceType))
[email protected]("maintainer_on_page", [True, False])
+def test_resource_maintainer_order_is_stable_and_page_local(
+ domain: RBACDomain, kind: dto.RBACResourceType, maintainer_on_page: bool
+) -> None:
+ with domain.sessions.begin() as session:
+ if kind == dto.RBACResourceType.APP:
+ session.add(make_app(app_id="resource", tenant_id="workspace", maintainer="maintainer"))
+ elif kind == dto.RBACResourceType.DATASET:
+ session.add(
+ Dataset(
+ id="resource",
+ tenant_id="workspace",
+ name="Dataset",
+ created_by="maintainer",
+ maintainer="maintainer",
+ )
+ )
+ ids = ["member", "maintainer" if maintainer_on_page else "other", "last"]
+ domain.transport.response = {"data": [{"account": {"account_id": account_id}} for account_id in ids]}
+ result = domain.rbac.resources.user_access_policies(
+ CONTEXT, kind, "resource", options=dto.ListOption(), language="zh"
+ )
+ assert [item.account.account_id for item in result.data] == (
+ ["maintainer", "member", "last"] if maintainer_on_page and kind != dto.RBACResourceType.AGENT else ids
+ )
+
+
[email protected]("workspace_matrix", [True, False])
+def test_account_hydration_is_tenant_scoped_and_preserves_names(domain: RBACDomain, workspace_matrix: bool) -> None:
+ add_members(domain, {"known": TenantAccountRole.NORMAL})
+ with domain.sessions.begin() as session:
+ session.add(make_tenant(tenant_id="other"))
+ session.add(make_account(account_id="foreign", name="Foreign", email="[email protected]"))
+ session.add(TenantAccountJoin(tenant_id="other", account_id="foreign", role=TenantAccountRole.NORMAL))
+ domain.transport.response = {
+ "items": [
+ {
+ "accounts": [
+ {"account_id": " known ", "account_name": "Provided name", "binding_id": "1"},
+ {"account_id": "known", "account_name": "", "binding_id": "2"},
+ {"account_id": "foreign", "account_name": "", "binding_id": "3"},
+ ]
+ }
+ ]
+ }
+ if workspace_matrix:
+ result = domain.rbac.resources.workspace_matrix(
+ CONTEXT, dto.RBACResourceType.APP, dto.ListOption(), language=None
+ )
+ else:
+ result = domain.rbac.resources.matrix(CONTEXT, dto.RBACResourceType.APP, "app", language=None)
+ first, second, foreign = result.items[0].accounts
+ assert (first.account_name, first.avatar, first.email) == ("Provided name", "avatar", "[email protected]")
+ assert (second.account_name, second.avatar, second.email) == ("Resolved name", "avatar", "[email protected]")
+ assert (foreign.account_name, foreign.email) == ("", "")
diff --git a/api/tests/unit_tests/services/rbac/test_builtin.py b/api/tests/unit_tests/services/rbac/test_builtin.py
new file mode 100644
index 00000000000..696df002124
--- /dev/null
+++ b/api/tests/unit_tests/services/rbac/test_builtin.py
@@ -0,0 +1,16 @@
+"""Built-in role projections keep the supported permission vocabulary."""
+
+from services.rbac import builtin
+
+
+class TestBuiltinAgentKeys:
+ def test_builtin_workspace_keys_no_longer_carry_agent_manage(self) -> None:
+ for keys in (
+ builtin._BUILTIN_WORKSPACE_OWNER_KEYS,
+ builtin._BUILTIN_WORKSPACE_ADMIN_KEYS,
+ builtin._BUILTIN_WORKSPACE_EDITOR_KEYS,
+ builtin._BUILTIN_WORKSPACE_NORMAL_KEYS,
+ builtin._BUILTIN_WORKSPACE_DATASET_OPERATOR_KEYS,
+ ):
+ assert "agent.manage" not in keys
+ assert {"agent.acl.preview", "agent.acl.access_point_view"} <= set(keys)
diff --git a/api/tests/unit_tests/services/rbac/test_gateways.py b/api/tests/unit_tests/services/rbac/test_gateways.py
new file mode 100644
index 00000000000..7df5a893df5
--- /dev/null
+++ b/api/tests/unit_tests/services/rbac/test_gateways.py
@@ -0,0 +1,25 @@
+import pytest
+
+from services.enterprise.base import EnterpriseRequest
+from services.enterprise.rbac_service import RBACService
+from tests.unit_tests.rbac_fakes import RBACTransport
+
+
+def test_membership_gateway_sends_identity_language_and_assignment(monkeypatch: pytest.MonkeyPatch) -> None:
+ transport = RBACTransport(response={"account_id": "member", "roles": []})
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ result = RBACService.MemberRoles.replace("workspace", "actor", "member", ["role"], language="zh")
+ assert result.account_id == "member"
+ sent = transport.only_request
+ assert (sent.method, sent.endpoint) == ("PUT", "/rbac/members/rbac-roles")
+ assert (sent.tenant_id, sent.account_id) == ("workspace", "actor")
+ assert sent.params == {"account_id": "member", "language": "zh"}
+ assert sent.json == {"role_ids": ["role"]}
+
+
+def test_permission_gateway_excludes_absent_resource_selectors(monkeypatch: pytest.MonkeyPatch) -> None:
+ transport = RBACTransport(response={})
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ RBACService.MyPermissions.get("workspace", "actor", app_id=None, dataset_id=None, agent_id="agent", language=None)
+ assert transport.only_request.endpoint == "/rbac/my-permissions"
+ assert transport.only_request.params == {"agent_id": "agent"}
diff --git a/api/tests/unit_tests/services/rbac/test_member_permissions.py b/api/tests/unit_tests/services/rbac/test_member_permissions.py
new file mode 100644
index 00000000000..9e02bf45fa5
--- /dev/null
+++ b/api/tests/unit_tests/services/rbac/test_member_permissions.py
@@ -0,0 +1,240 @@
+"""Built-in permission projections and membership writes use the shared repository."""
+
+from collections.abc import Callable
+
+import pytest
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+from enums.account import TenantAccountRole
+from machinery.context import RequestContext
+from models import TenantAccountJoin
+from services.rbac import builtin
+from services.rbac import contracts as rbac_contracts
+from tests.unit_tests.model_factories import make_account, make_tenant
+from tests.unit_tests.rbac_fakes import RBACDomain
+
+CONTEXT = RequestContext("request", None, "acct-1", "tenant-1")
+
+
+ ("role", "workspace_keys", "app_keys", "dataset_keys", "agent_keys"),
+ [
+ (
+ "owner",
+ builtin._BUILTIN_WORKSPACE_OWNER_KEYS,
+ builtin._BUILTIN_APP_OWNER_KEYS,
+ builtin._BUILTIN_DATASET_OWNER_KEYS,
+ builtin._BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ ),
+ (
+ "admin",
+ builtin._BUILTIN_WORKSPACE_ADMIN_KEYS,
+ builtin._BUILTIN_APP_ADMIN_KEYS,
+ builtin._BUILTIN_DATASET_ADMIN_KEYS,
+ builtin._BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ ),
+ (
+ "editor",
+ builtin._BUILTIN_WORKSPACE_EDITOR_KEYS,
+ builtin._BUILTIN_APP_EDITOR_KEYS,
+ builtin._BUILTIN_DATASET_EDITOR_KEYS,
+ builtin._BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ ),
+ (
+ "normal",
+ builtin._BUILTIN_WORKSPACE_NORMAL_KEYS,
+ builtin._BUILTIN_APP_NORMAL_KEYS,
+ [],
+ builtin._BUILTIN_AGENT_PREVIEW_KEYS,
+ ),
+ (
+ "dataset_operator",
+ builtin._BUILTIN_WORKSPACE_DATASET_OPERATOR_KEYS,
+ builtin._BUILTIN_APP_DATASET_OPERATOR_KEYS,
+ builtin._BUILTIN_DATASET_DATASET_OPERATOR_KEYS,
+ builtin._BUILTIN_AGENT_PREVIEW_KEYS,
+ ),
+ ],
+)
+def test_get_uses_builtin_role_permissions_when_rbac_disabled(
+ rbac_domain: RBACDomain,
+ role: str,
+ workspace_keys: list[str],
+ app_keys: list[str],
+ dataset_keys: list[str],
+ agent_keys: list[str],
+ sqlite_session: Session,
+ config_overrides: Callable[..., None],
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add(TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=TenantAccountRole(role)))
+ sqlite_session.commit()
+ out = rbac_domain.rbac.members.permissions("tenant-1", "acct-1")
+
+ assert not rbac_domain.transport.requests
+ assert out.workspace.permission_keys == workspace_keys
+ assert len(out.workspace.permission_keys) == len(set(out.workspace.permission_keys))
+ assert out.app.default_permission_keys == app_keys
+ assert out.dataset.default_permission_keys == dataset_keys
+ assert out.agent.default_permission_keys == agent_keys
+ assert out.app.overrides == []
+ assert out.dataset.overrides == []
+ assert out.agent.overrides == []
+ if role == "owner":
+ assert "snippets.management" in out.workspace.permission_keys
+ assert "app.acl.preview" in out.workspace.permission_keys
+ assert "dataset.acl.preview" in out.workspace.permission_keys
+ assert "app.acl.preview" in out.app.default_permission_keys
+ assert "dataset.acl.preview" in out.dataset.default_permission_keys
+ assert not any(key.startswith("billing.") for key in out.workspace.permission_keys)
+ if role == "editor":
+ assert "app.acl.log_and_annotation" in out.app.default_permission_keys
+ assert "app.acl.deploy" not in out.app.default_permission_keys
+
+
+ ("role", "expected_snippet_keys"),
+ [
+ ("owner", {"snippets.create_and_modify", "snippets.management"}),
+ ("admin", {"snippets.create_and_modify", "snippets.management"}),
+ ("editor", {"snippets.create_and_modify"}),
+ ("normal", set()),
+ ("dataset_operator", set()),
+ ],
+)
+def test_get_uses_builtin_snippet_permissions_when_rbac_disabled(
+ rbac_domain: RBACDomain,
+ role: str,
+ expected_snippet_keys: set[str],
+ sqlite_session: Session,
+ config_overrides: Callable[..., None],
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add(TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=TenantAccountRole(role)))
+ sqlite_session.commit()
+ out = rbac_domain.rbac.members.permissions("tenant-1", "acct-1")
+
+ actual_snippet_keys = {
+ permission_key for permission_key in out.workspace.permission_keys if permission_key.startswith("snippets.")
+ }
+
+ assert not rbac_domain.transport.requests
+ assert actual_snippet_keys == expected_snippet_keys
+
+
+def test_get_returns_empty_when_role_missing_and_rbac_disabled(
+ rbac_domain: RBACDomain, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ out = rbac_domain.rbac.members.permissions("tenant-1", "acct-1")
+
+ assert not rbac_domain.transport.requests
+ assert out.workspace.permission_keys == []
+ assert out.app.default_permission_keys == []
+ assert out.dataset.default_permission_keys == []
+ assert out.agent.default_permission_keys == []
+
+
+def test_get_builtin_role_includes_permission_keys(
+ rbac_domain: RBACDomain, sqlite_session: Session, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add(TenantAccountJoin(tenant_id="tenant-1", account_id="acct-2", role=TenantAccountRole.EDITOR))
+ sqlite_session.commit()
+
+ out = rbac_domain.rbac.members.get(CONTEXT, "acct-2", language=None)
+
+ assert not rbac_domain.transport.requests
+ assert out.account_id == "acct-2"
+ assert out.roles[0].name == "editor"
+ assert out.roles[0].permission_keys == list(
+ dict.fromkeys(
+ [
+ *builtin._BUILTIN_WORKSPACE_EDITOR_KEYS,
+ *builtin._BUILTIN_APP_EDITOR_KEYS,
+ *builtin._BUILTIN_DATASET_EDITOR_KEYS,
+ *builtin._BUILTIN_AGENT_FULL_ACCESS_KEYS,
+ ]
+ )
+ )
+ assert "snippets.create_and_modify" in out.roles[0].permission_keys
+ assert "app.acl.preview" in out.roles[0].permission_keys
+ assert "dataset.acl.preview" in out.roles[0].permission_keys
+ assert "app.acl.deploy" not in out.roles[0].permission_keys
+
+
+def test_replace_commits_builtin_join_role_when_rbac_disabled(
+ rbac_domain: RBACDomain, sqlite_session: Session, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add_all(
+ [
+ make_tenant(tenant_id="tenant-1"),
+ make_account(account_id="acct-1", email="[email protected]"),
+ make_account(account_id="acct-2", email="[email protected]"),
+ TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=TenantAccountRole.OWNER),
+ ]
+ )
+ target_join = TenantAccountJoin(tenant_id="tenant-1", account_id="acct-2", role=TenantAccountRole.NORMAL)
+ sqlite_session.add(target_join)
+ sqlite_session.commit()
+ target_join_id = target_join.id
+ engine = sqlite_session.get_bind()
+
+ out = rbac_domain.rbac.members.replace(CONTEXT, "acct-2", role_ids=["editor"], language=None)
+
+ assert not rbac_domain.transport.requests
+ # Closing the writer rolls back any uncommitted update and prevents its identity map
+ # from satisfying the verification query.
+ sqlite_session.close()
+ with Session(engine) as verification_session:
+ persisted_join = verification_session.scalar(
+ select(TenantAccountJoin).where(TenantAccountJoin.id == target_join_id)
+ )
+ assert persisted_join is not None
+ assert persisted_join.role == TenantAccountRole.EDITOR
+ assert out.account_id == "acct-2"
+ assert out.roles[0].id == "editor"
+ assert "app.acl.preview" in out.roles[0].permission_keys
+
+
+def test_app_permissions_batch_get_uses_builtin_role_permissions_when_rbac_disabled(
+ rbac_domain: RBACDomain, sqlite_session: Session, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add(TenantAccountJoin(tenant_id="tenant-1", account_id="acct-1", role=TenantAccountRole.EDITOR))
+ sqlite_session.commit()
+ out = rbac_domain.rbac.members.resource_permissions(
+ "tenant-1", "acct-1", rbac_contracts.RBACResourceType.APP, ["app-1", "app-2"]
+ )
+
+ assert not rbac_domain.transport.requests
+ assert out == {
+ "app-1": builtin._BUILTIN_APP_EDITOR_KEYS,
+ "app-2": builtin._BUILTIN_APP_EDITOR_KEYS,
+ }
+ assert all("app.acl.deploy" not in permission_keys for permission_keys in out.values())
+
+
+def test_dataset_permissions_batch_get_uses_builtin_role_permissions_when_rbac_disabled(
+ rbac_domain: RBACDomain, sqlite_session: Session, config_overrides: Callable[..., None]
+) -> None:
+ config_overrides(RBAC_ENABLED=False)
+ sqlite_session.add(
+ TenantAccountJoin(
+ tenant_id="tenant-1",
+ account_id="acct-1",
+ role=TenantAccountRole.DATASET_OPERATOR,
+ )
+ )
+ sqlite_session.commit()
+ out = rbac_domain.rbac.members.resource_permissions(
+ "tenant-1", "acct-1", rbac_contracts.RBACResourceType.DATASET, ["ds-1", "ds-2"]
+ )
+
+ assert not rbac_domain.transport.requests
+ assert out == {
+ "ds-1": builtin._BUILTIN_DATASET_DATASET_OPERATOR_KEYS,
+ "ds-2": builtin._BUILTIN_DATASET_DATASET_OPERATOR_KEYS,
+ }
diff --git a/api/tests/unit_tests/services/rbac/test_resource_queries.py b/api/tests/unit_tests/services/rbac/test_resource_queries.py
new file mode 100644
index 00000000000..3f08d48323d
--- /dev/null
+++ b/api/tests/unit_tests/services/rbac/test_resource_queries.py
@@ -0,0 +1,175 @@
+"""Authorization references use the composed repositories and detached snapshots."""
+
+import pytest
+from sqlalchemy.orm import Session
+
+from models.agent import Agent, AgentKind, AgentScope, AgentSource, AgentStatus
+from models.model import AppMode
+from services.entities.app_entities import AppAgentBinding
+from services.rbac.resource_queries import ResourceQueryService
+from tests.unit_tests.model_factories import make_app, make_dataset, make_document
+from tests.unit_tests.rbac_fakes import RBACDomain
+
+
+def queries(rbac_domain: RBACDomain) -> ResourceQueryService:
+ return rbac_domain.rbac.queries
+
+
+TENANT_ID = "tenant-1"
+OTHER_TENANT_ID = "tenant-2"
+
+
+def _agent(*, agent_id: str, app_id: str, status: AgentStatus = AgentStatus.ACTIVE) -> Agent:
+ return Agent(
+ id=agent_id,
+ tenant_id=TENANT_ID,
+ name=agent_id,
+ description="",
+ role="",
+ agent_kind=AgentKind.DIFY_AGENT,
+ scope=AgentScope.ROSTER,
+ source=AgentSource.AGENT_APP,
+ app_id=app_id,
+ status=status,
+ created_by="account-1",
+ updated_by="account-1",
+ )
+
+
+class TestGetAppAgentBinding:
+ def test_does_not_resolve_an_agent_from_another_tenant(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ agent = _agent(agent_id="agent-1", app_id="app-1")
+ agent.tenant_id = OTHER_TENANT_ID
+ sqlite_session.add_all([make_app(app_id="app-1", mode=AppMode.AGENT), agent])
+ sqlite_session.commit()
+
+ assert queries.get_app_agent_binding(TENANT_ID, "app-1") is None
+
+ def test_returns_workflow_binding_snapshot_after_session_closes(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ agent = _agent(agent_id="agent-1", app_id="workflow-app")
+ agent.scope = AgentScope.WORKFLOW_ONLY
+ agent.source = AgentSource.WORKFLOW
+ agent.backing_app_id = "app-1"
+ sqlite_session.add_all([make_app(app_id="app-1", mode=AppMode.AGENT), agent])
+ sqlite_session.commit()
+
+ assert queries.get_app_agent_binding(TENANT_ID, "app-1") == AppAgentBinding("agent-1", workflow_only=True)
+
+ def test_returns_none_when_the_app_belongs_to_another_tenant(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add(make_app(app_id="app-1", tenant_id=OTHER_TENANT_ID, mode=AppMode.AGENT))
+ sqlite_session.commit()
+
+ assert queries.get_app_agent_binding(TENANT_ID, "app-1") is None
+
+ def test_returns_none_for_an_app_that_is_not_an_agent_app(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add_all([make_app(app_id="app-1"), _agent(agent_id="agent-1", app_id="app-1")])
+ sqlite_session.commit()
+
+ assert queries.get_app_agent_binding(TENANT_ID, "app-1") is None
+
+ def test_returns_the_bound_agent_including_archived_ones(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add_all(
+ [
+ make_app(app_id="app-1", mode=AppMode.AGENT),
+ _agent(agent_id="agent-1", app_id="app-1", status=AgentStatus.ARCHIVED),
+ ]
+ )
+ sqlite_session.commit()
+
+ binding = queries.get_app_agent_binding(TENANT_ID, "app-1")
+
+ assert binding is not None
+ assert binding == AppAgentBinding(id="agent-1", workflow_only=False)
+
+
+class TestGetAppMaintainer:
+ def test_returns_the_maintainer_of_an_app_in_the_tenant(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add(make_app(app_id="app-1", maintainer="account-1"))
+ sqlite_session.commit()
+
+ assert queries.get_app_maintainer(TENANT_ID, "app-1") == "account-1"
+
+ def test_does_not_leak_across_tenants(self, sqlite_session: Session, queries: ResourceQueryService) -> None:
+ sqlite_session.add(make_app(app_id="app-1", tenant_id=OTHER_TENANT_ID, maintainer="account-1"))
+ sqlite_session.commit()
+
+ assert queries.get_app_maintainer(TENANT_ID, "app-1") is None
+
+
+class TestGetDatasetMaintainer:
+ def test_returns_the_maintainer_of_a_dataset_in_the_tenant(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add(make_dataset(dataset_id="dataset-1", maintainer="account-2"))
+ sqlite_session.commit()
+
+ assert queries.get_dataset_maintainer(TENANT_ID, "dataset-1") == "account-2"
+
+ def test_does_not_leak_across_tenants(self, sqlite_session: Session, queries: ResourceQueryService) -> None:
+ sqlite_session.add(make_dataset(dataset_id="dataset-1", tenant_id=OTHER_TENANT_ID, maintainer="account-2"))
+ sqlite_session.commit()
+
+ assert queries.get_dataset_maintainer(TENANT_ID, "dataset-1") is None
+
+
+class TestGetDatasetIdByPipeline:
+ def test_returns_the_dataset_id_for_the_pipeline(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add(make_dataset(dataset_id="dataset-1", pipeline_id="pipeline-1"))
+ sqlite_session.commit()
+
+ assert queries.get_dataset_id_by_pipeline(TENANT_ID, "pipeline-1") == "dataset-1"
+
+ def test_returns_none_when_no_dataset_in_the_tenant_uses_the_pipeline(
+ self, sqlite_session: Session, queries: ResourceQueryService
+ ) -> None:
+ sqlite_session.add(make_dataset(dataset_id="dataset-1", tenant_id=OTHER_TENANT_ID, pipeline_id="pipeline-1"))
+ sqlite_session.commit()
+
+ assert queries.get_dataset_id_by_pipeline(TENANT_ID, "pipeline-1") is None
+
+
+class TestGetDatasetIdByDocument:
+ @pytest.mark.parametrize(
+ ("dataset_tenant", "document_tenant", "expected"),
+ [
+ (TENANT_ID, TENANT_ID, "dataset-1"),
+ (OTHER_TENANT_ID, OTHER_TENANT_ID, None),
+ (OTHER_TENANT_ID, TENANT_ID, None),
+ (TENANT_ID, OTHER_TENANT_ID, None),
+ ],
+ )
+ def test_scopes_both_dataset_and_document(
+ self,
+ sqlite_session: Session,
+ queries: ResourceQueryService,
+ dataset_tenant: str,
+ document_tenant: str,
+ expected: str | None,
+ ) -> None:
+ sqlite_session.add_all(
+ [
+ make_dataset(dataset_id="dataset-1", tenant_id=dataset_tenant),
+ make_document(document_id="doc-1", dataset_id="dataset-1", tenant_id=document_tenant),
+ ]
+ )
+ sqlite_session.commit()
+
+ assert queries.get_dataset_id_by_document(TENANT_ID, "doc-1") == expected
+
+ def test_missing_document(self, queries: ResourceQueryService) -> None:
+ assert queries.get_dataset_id_by_document(TENANT_ID, "missing") is None
diff --git a/api/tests/unit_tests/services/test_app_service.py b/api/tests/unit_tests/services/test_app_service.py
index 82b66199de5..10bb7013173 100644
--- a/api/tests/unit_tests/services/test_app_service.py
+++ b/api/tests/unit_tests/services/test_app_service.py
@@ -32,7 +32,7 @@ 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, AppResponseView, AppService, CreateAppParams
-from services.enterprise import rbac_service as enterprise_rbac_service
+from services.rbac import contracts as rbac_contracts
def _persist_account(session: Session) -> Account:
@@ -384,13 +384,13 @@ class TestCreateAppRBACAccessInitialization:
account.current_tenant_id,
account.id,
agent.id,
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
+ rbac_contracts.ReplaceMemberBindings(automatic_include_workspace_members=True),
)
seed_task.assert_called_once_with(account.current_tenant_id, account.id, agent_id=agent.id)
creator_sync.assert_called_once_with(
account.current_tenant_id,
account.id,
- resource_type=enterprise_rbac_service.RBACResourceType.AGENT,
+ resource_type=rbac_contracts.RBACResourceType.AGENT,
resource_id=agent.id,
)
app_creator_sync.assert_not_called()
diff --git a/api/tests/unit_tests/services/test_rbac_agent_access_service.py b/api/tests/unit_tests/services/test_rbac_agent_access_service.py
index 92cd40fa5ff..e9da8e7aa7a 100644
--- a/api/tests/unit_tests/services/test_rbac_agent_access_service.py
+++ b/api/tests/unit_tests/services/test_rbac_agent_access_service.py
@@ -1,56 +1,36 @@
"""Unit tests for the RBAC bootstrap applied to a newly created agent."""
-from __future__ import annotations
-
-from collections.abc import Callable, Iterator
-from unittest.mock import MagicMock, patch
+from collections.abc import Callable
import pytest
from services import rbac_agent_access_service
-from services.enterprise import rbac_service as enterprise_rbac_service
-
-MODULE = "services.rbac_agent_access_service"
+from tests.unit_tests.rbac_fakes import Initialization, RBACDomain
-TENANT = "tenant-1"
-AGENT = "agent-1"
-CREATOR = "account-1"
-
-def rbac_calls(config_overrides: Callable[..., None]) -> Iterator[MagicMock]:
+def test_initialize_agent_rbac_access_seeds_scope_members_and_creator_policy(
+ rbac_domain: RBACDomain, config_overrides: Callable[..., None], monkeypatch: pytest.MonkeyPatch
+) -> None:
config_overrides(RBAC_ENABLED=True)
- recorder = MagicMock()
- with (
- patch(f"{MODULE}.enterprise_rbac_service.RBACService.AgentAccess.replace_whitelist") as replace_whitelist,
- patch(f"{MODULE}.initialize_created_app_rbac_access_task.delay") as seed_task,
- patch(
- f"{MODULE}.enterprise_rbac_service.RBACService.AccessPolicies.sync_creator_access_policy_member_bindings"
- ) as creator_sync,
- ):
- recorder.attach_mock(replace_whitelist, "replace_whitelist")
- recorder.attach_mock(seed_task, "seed_task")
- recorder.attach_mock(creator_sync, "creator_sync")
- yield recorder
+ def enqueue(tenant_id: str, account_id: str, **resources: str) -> None:
+ # The task must be queued before any remote writes.
+ assert not rbac_domain.transport.requests
+ rbac_domain.tasks.delay(tenant_id, account_id, **resources)
-def test_initialize_agent_rbac_access_seeds_scope_members_and_creator_policy(
- rbac_calls: MagicMock,
-) -> None:
- rbac_agent_access_service.initialize_agent_rbac_access(tenant_id=TENANT, agent_id=AGENT, creator_account_id=CREATOR)
+ monkeypatch.setattr(rbac_agent_access_service.initialize_created_app_rbac_access_task, "delay", enqueue)
- rbac_calls.replace_whitelist.assert_called_once_with(
- TENANT,
- CREATOR,
- AGENT,
- enterprise_rbac_service.ReplaceMemberBindings(automatic_include_workspace_members=True),
- )
- rbac_calls.seed_task.assert_called_once_with(TENANT, CREATOR, agent_id=AGENT)
- rbac_calls.creator_sync.assert_called_once_with(
- TENANT,
- CREATOR,
- resource_type=enterprise_rbac_service.RBACResourceType.AGENT,
- resource_id=AGENT,
+ rbac_agent_access_service.initialize_agent_rbac_access(
+ tenant_id="tenant-1", agent_id="agent-1", creator_account_id="account-1"
)
- assert [call[0] for call in rbac_calls.mock_calls] == ["seed_task", "creator_sync", "replace_whitelist"]
+ assert rbac_domain.tasks.queued == [Initialization("tenant-1", "account-1", {"agent_id": "agent-1"})]
+ creator, whitelist = rbac_domain.transport.requests
+ assert creator.endpoint == "/rbac/access-policies/creator-member-bindings"
+ assert whitelist.endpoint == "/rbac/agents/whitelist"
+ for request in (creator, whitelist):
+ assert request.method == "PUT"
+ assert (request.tenant_id, request.account_id) == ("tenant-1", "account-1")
+ assert creator.params == {"resource_type": "agent", "agent_id": "agent-1"}
+ assert whitelist.params == {"agent_id": "agent-1"}
+ assert whitelist.json == {"automatic_include_workspace_members": True}
diff --git a/api/tests/unit_tests/services/test_rbac_resource_service.py b/api/tests/unit_tests/services/test_rbac_resource_service.py
deleted file mode 100644
index a11eddcbd9b..00000000000
--- a/api/tests/unit_tests/services/test_rbac_resource_service.py
+++ /dev/null
@@ -1,164 +0,0 @@
-"""RBACResourceService reads through the session its caller passes in (#37403)."""
-
-import pytest
-from sqlalchemy.orm import Session
-
-from models.agent import Agent, AgentKind, AgentScope, AgentSource, AgentStatus
-from models.dataset import Dataset
-from models.model import App, AppMode
-from services.rbac_resource_service import RBACResourceService
-from tests.unit_tests.model_factories import make_document
-
-TENANT_ID = "tenant-1"
-OTHER_TENANT_ID = "tenant-2"
-
-
-def _app(
- *,
- app_id: str,
- tenant_id: str = TENANT_ID,
- mode: AppMode = AppMode.CHAT,
- maintainer: str | None = None,
-) -> App:
- return App(
- id=app_id,
- tenant_id=tenant_id,
- name=f"App {app_id}",
- description="",
- mode=mode,
- enable_site=True,
- enable_api=True,
- max_active_requests=0,
- maintainer=maintainer,
- )
-
-
-def _agent(*, agent_id: str, app_id: str, status: AgentStatus = AgentStatus.ACTIVE) -> Agent:
- return Agent(
- id=agent_id,
- tenant_id=TENANT_ID,
- name=agent_id,
- description="",
- role="",
- agent_kind=AgentKind.DIFY_AGENT,
- scope=AgentScope.ROSTER,
- source=AgentSource.AGENT_APP,
- app_id=app_id,
- status=status,
- created_by="account-1",
- updated_by="account-1",
- )
-
-
-def _dataset(
- *,
- dataset_id: str,
- tenant_id: str = TENANT_ID,
- maintainer: str | None = None,
- pipeline_id: str | None = None,
-) -> Dataset:
- return Dataset(
- id=dataset_id,
- tenant_id=tenant_id,
- name=f"Dataset {dataset_id}",
- created_by="account-1",
- maintainer=maintainer,
- pipeline_id=pipeline_id,
- )
-
-
-class TestGetAppAgentBinding:
- def test_returns_none_when_the_app_belongs_to_another_tenant(self, sqlite_session: Session) -> None:
- sqlite_session.add(_app(app_id="app-1", tenant_id=OTHER_TENANT_ID, mode=AppMode.AGENT))
- sqlite_session.flush()
-
- assert RBACResourceService.get_app_agent_binding(sqlite_session, TENANT_ID, "app-1") is None
-
- def test_returns_none_for_an_app_that_is_not_an_agent_app(self, sqlite_session: Session) -> None:
- sqlite_session.add_all([_app(app_id="app-1"), _agent(agent_id="agent-1", app_id="app-1")])
- sqlite_session.flush()
-
- assert RBACResourceService.get_app_agent_binding(sqlite_session, TENANT_ID, "app-1") is None
-
- def test_returns_the_bound_agent_including_archived_ones(self, sqlite_session: Session) -> None:
- sqlite_session.add_all(
- [
- _app(app_id="app-1", mode=AppMode.AGENT),
- _agent(agent_id="agent-1", app_id="app-1", status=AgentStatus.ARCHIVED),
- ]
- )
- sqlite_session.flush()
-
- binding = RBACResourceService.get_app_agent_binding(sqlite_session, TENANT_ID, "app-1")
-
- assert binding is not None
- assert binding.id == "agent-1"
-
-
-class TestGetAppMaintainer:
- def test_returns_the_maintainer_of_an_app_in_the_tenant(self, sqlite_session: Session) -> None:
- sqlite_session.add(_app(app_id="app-1", maintainer="account-1"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_app_maintainer(sqlite_session, TENANT_ID, "app-1") == "account-1"
-
- def test_does_not_leak_across_tenants(self, sqlite_session: Session) -> None:
- sqlite_session.add(_app(app_id="app-1", tenant_id=OTHER_TENANT_ID, maintainer="account-1"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_app_maintainer(sqlite_session, TENANT_ID, "app-1") is None
-
-
-class TestGetDatasetMaintainer:
- def test_returns_the_maintainer_of_a_dataset_in_the_tenant(self, sqlite_session: Session) -> None:
- sqlite_session.add(_dataset(dataset_id="dataset-1", maintainer="account-2"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_dataset_maintainer(sqlite_session, TENANT_ID, "dataset-1") == "account-2"
-
- def test_does_not_leak_across_tenants(self, sqlite_session: Session) -> None:
- sqlite_session.add(_dataset(dataset_id="dataset-1", tenant_id=OTHER_TENANT_ID, maintainer="account-2"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_dataset_maintainer(sqlite_session, TENANT_ID, "dataset-1") is None
-
-
-class TestGetDatasetIdByPipeline:
- def test_returns_the_dataset_id_for_the_pipeline(self, sqlite_session: Session) -> None:
- sqlite_session.add(_dataset(dataset_id="dataset-1", pipeline_id="pipeline-1"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_dataset_id_by_pipeline(sqlite_session, TENANT_ID, "pipeline-1") == "dataset-1"
-
- def test_returns_none_when_no_dataset_in_the_tenant_uses_the_pipeline(self, sqlite_session: Session) -> None:
- sqlite_session.add(_dataset(dataset_id="dataset-1", tenant_id=OTHER_TENANT_ID, pipeline_id="pipeline-1"))
- sqlite_session.flush()
-
- assert RBACResourceService.get_dataset_id_by_pipeline(sqlite_session, TENANT_ID, "pipeline-1") is None
-
-
-class TestGetDatasetIdByDocument:
- @pytest.mark.parametrize(
- ("dataset_tenant", "document_tenant", "expected"),
- [
- (TENANT_ID, TENANT_ID, "dataset-1"),
- (OTHER_TENANT_ID, OTHER_TENANT_ID, None),
- (OTHER_TENANT_ID, TENANT_ID, None),
- (TENANT_ID, OTHER_TENANT_ID, None),
- ],
- )
- def test_scopes_both_dataset_and_document(
- self, sqlite_session: Session, dataset_tenant: str, document_tenant: str, expected: str | None
- ) -> None:
- sqlite_session.add_all(
- [
- _dataset(dataset_id="dataset-1", tenant_id=dataset_tenant),
- make_document(document_id="doc-1", dataset_id="dataset-1", tenant_id=document_tenant),
- ]
- )
- sqlite_session.flush()
-
- assert RBACResourceService.get_dataset_id_by_document(sqlite_session, TENANT_ID, "doc-1") == expected
-
- def test_missing_document(self, sqlite_session: Session) -> None:
- assert RBACResourceService.get_dataset_id_by_document(sqlite_session, TENANT_ID, "missing") is None
diff --git a/api/tests/unit_tests/services/workspace/test_member_service.py b/api/tests/unit_tests/services/workspace/test_member_service.py
index 4fe45beb59c..ddb97bafb76 100644
--- a/api/tests/unit_tests/services/workspace/test_member_service.py
+++ b/api/tests/unit_tests/services/workspace/test_member_service.py
@@ -2,6 +2,7 @@
from collections.abc import Callable
from contextlib import nullcontext
+from dataclasses import dataclass, field
from unittest.mock import Mock, create_autospec
import pytest
@@ -16,7 +17,7 @@ from models.dataset import Dataset
from models.model import App
from services.account.adapters import RedisInvitationTokenStore
from services.account_errors import AccountNotFoundError
-from services.enterprise.rbac_service import MemberRolesResponse, Paginated, RBACRole, RBACService
+from services.enterprise.rbac_service import RBACService
from services.entities.account_entities import AccountSnapshot
from services.entities.feature_entities import FeatureModel, LicenseLimitationModel, LicenseModel
from services.errors.base import NoPermissionError
@@ -34,6 +35,7 @@ from services.errors.workspace import (
WorkspaceNotFoundError,
)
from services.feature_service import FeatureService
+from services.rbac.contracts import MemberRolesResponse, Paginated, RBACRole
from services.system_feature_service import SystemFeatureService
from services.workspace.contracts import OwnerTransferToken
from services.workspace.gateways import (
@@ -165,15 +167,12 @@ def test_unchanged_role_does_not_sync(account_domain: AccountDomain, members: tu
@pytest.mark.parametrize("role", ["invalid", "dataset_operator"])
def test_role_policy_prevents_persistence_and_rbac_changes(
account_domain: AccountDomain,
- sqlite_session_factory: sessionmaker[Session],
members: tuple[str, str, str],
config_overrides: Callable[..., None],
role: str,
) -> None:
config_overrides(DATASET_OPERATOR_ENABLED=False)
- account_domain.access.ensure_role_enabled.side_effect = DeploymentWorkspaceMemberAccessGateway(
- session_factory=sqlite_session_factory
- ).ensure_role_enabled
+ account_domain.access.ensure_role_enabled.side_effect = DeploymentWorkspaceMemberAccessGateway().ensure_role_enabled
workspace_id, owner_id, member_id = members
with pytest.raises(InvalidWorkspaceMemberRoleError):
@@ -525,15 +524,41 @@ def test_rbac_transfer_failure_leaves_local_owner_unchanged(
assert account_domain.members.get_role(workspace_id, member_id) == TenantAccountRole.NORMAL
+@dataclass(frozen=True)
+class RoleAssignment:
+ tenant_id: str
+ account_id: str | None
+ member_account_id: str
+ role_ids: list[str]
+
+
+@dataclass
+class RecordedRoleAssignments:
+ calls: list[RoleAssignment] = field(default_factory=list)
+ failure: Exception | None = None
+ on_apply: Callable[..., None] | None = None
+
+ def __call__(
+ self, *, tenant_id: str, account_id: str | None, member_account_id: str, role_ids: list[str]
+ ) -> MemberRolesResponse:
+ self.calls.append(RoleAssignment(tenant_id, account_id, member_account_id, list(role_ids)))
+ if self.failure:
+ raise self.failure
+ if self.on_apply:
+ self.on_apply(
+ tenant_id=tenant_id, account_id=account_id, member_account_id=member_account_id, role_ids=role_ids
+ )
+ return MemberRolesResponse(account_id=member_account_id)
+
+
@pytest.fixture
def rbac_access(
- sqlite_session_factory: sessionmaker[Session],
monkeypatch: pytest.MonkeyPatch,
config_overrides: Callable[..., None],
members: tuple[str, str, str],
-) -> tuple[DeploymentWorkspaceMemberAccessGateway, Mock]:
+) -> tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments]:
config_overrides(RBAC_ENABLED=True, DATASET_OPERATOR_ENABLED=True)
- gateway = DeploymentWorkspaceMemberAccessGateway(session_factory=sqlite_session_factory)
+ gateway = DeploymentWorkspaceMemberAccessGateway()
roles = [
RBACRole(id=f"role-{tag}", name=tag, type="", category="global_system_default", role_tag=tag, is_builtin=True)
for tag in [*(role.value for role in TenantAccountRole), "no_access"]
@@ -541,17 +566,15 @@ def rbac_access(
_, owner_id, _ = members
roles_by_tag = {role.role_tag: role for role in roles}
- def get_roles(
- tenant_id: str, account_id: str | None, member_account_id: str, *, session: Session
- ) -> MemberRolesResponse:
- del tenant_id, account_id, session
+ def get_roles(tenant_id: str, account_id: str | None, member_account_id: str) -> MemberRolesResponse:
+ del tenant_id, account_id
tag = "owner" if member_account_id == owner_id else "normal"
return MemberRolesResponse(account_id=member_account_id, roles=[roles_by_tag[tag]])
- monkeypatch.setattr(RBACService.Roles, "list", Mock(return_value=Paginated[RBACRole](data=roles)))
+ monkeypatch.setattr(RBACService.Roles, "list", lambda *_args, **_kwargs: Paginated[RBACRole](data=roles))
monkeypatch.setattr(RBACService.MemberRoles, "get", get_roles)
monkeypatch.setattr(gateway, "permission_keys", lambda _workspace_id, _actor_id: {"workspace.role.manage"})
- replace = create_autospec(RBACService.MemberRoles.replace, instance=True)
+ replace = RecordedRoleAssignments()
monkeypatch.setattr(RBACService.MemberRoles, "replace", replace)
return gateway, replace
@@ -571,7 +594,7 @@ def test_rbac_invitation_assigns_requested_role(
account_domain: AccountDomain,
members: tuple[str, str, str],
sqlite_session: Session,
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
monkeypatch: pytest.MonkeyPatch,
status: AccountStatus | None,
already_joined: bool,
@@ -590,7 +613,11 @@ def test_rbac_invitation_assigns_requested_role(
sqlite_session.commit()
access, replace = rbac_access
monkeypatch.setattr(access, "permission_keys", lambda _workspace, _actor: {"workspace.member.manage"})
- sync = create_autospec(sync_joined_workspace_member_rbac_access_task.delay, instance=True)
+ synced_members: list[tuple[str, str, str | None]] = []
+
+ def sync(tenant_id: str, member_account_id: str, operator_account_id: str | None = None) -> None:
+ synced_members.append((tenant_id, member_account_id, operator_account_id))
+
monkeypatch.setattr(sync_joined_workspace_member_rbac_access_task, "delay", sync)
member_service = WorkspaceMemberService(
workspaces=account_domain.workspaces, accounts=account_domain.repository, access=access
@@ -614,22 +641,22 @@ def test_rbac_invitation_assigns_requested_role(
assert invited is not None
assert member_service.get_role(workspace_id, invited.id) == TenantAccountRole.NORMAL
if status == AccountStatus.ACTIVE and already_joined:
- replace.assert_not_called()
+ assert replace.calls == []
else:
- assignments = [item.kwargs for item in replace.call_args_list if item.kwargs["tenant_id"] == workspace_id]
+ assignments = [item for item in replace.calls if item.tenant_id == workspace_id]
assert len(assignments) == 1
- assert assignments[0]["account_id"] == owner_id
- assert assignments[0]["member_account_id"] == invited.id
- assert assignments[0]["role_ids"] == ["custom-role-id"]
+ assert assignments[0].account_id == owner_id
+ assert assignments[0].member_account_id == invited.id
+ assert assignments[0].role_ids == ["custom-role-id"]
if status is None:
# Registration also provisions the invitee's own workspace.
- assert replace.call_count == 2
- personal_workspace = replace.call_args_list[0].kwargs
- assert personal_workspace["tenant_id"] != workspace_id
- assert personal_workspace["member_account_id"] == invited.id
- assert personal_workspace["role_ids"] == ["role-owner"]
+ assert len(replace.calls) == 2
+ personal_workspace = replace.calls[0]
+ assert personal_workspace.tenant_id != workspace_id
+ assert personal_workspace.member_account_id == invited.id
+ assert personal_workspace.role_ids == ["role-owner"]
else:
- replace.assert_called_once()
+ assert len(replace.calls) == 1
if status == AccountStatus.ACTIVE:
assert results[0].status == "already_member"
account_domain.delivery.create.assert_not_called()
@@ -644,7 +671,9 @@ def test_rbac_invitation_assigns_requested_role(
account_domain.delivery.send.assert_called_once_with(
language="en-US", email=email, token="invitation-token", inviter_name="Owner", workspace_name="Workspace"
)
- assert sync.call_count == int(status == AccountStatus.ACTIVE and not already_joined)
+ assert synced_members == (
+ [(workspace_id, invited.id, owner_id)] if status == AccountStatus.ACTIVE and not already_joined else []
+ )
@pytest.mark.parametrize(
@@ -659,7 +688,7 @@ def test_rbac_role_managers_cannot_demote_owner(
account_domain: AccountDomain,
members: tuple[str, str, str],
sqlite_session: Session,
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
operator_role: TenantAccountRole,
new_role: TenantAccountRole,
) -> None:
@@ -676,7 +705,7 @@ def test_rbac_role_managers_cannot_demote_owner(
with pytest.raises(NoPermissionError):
service.update_role(workspace_id, owner_id, new_role.value, operator_id)
- replace.assert_not_called()
+ assert replace.calls == []
assert service.get_role(workspace_id, owner_id) == TenantAccountRole.OWNER
assert service.get_role(workspace_id, operator_id) == operator_role
@@ -716,7 +745,7 @@ def test_rbac_normal_role_manager_can_update_another_non_owner(
account_domain: AccountDomain,
members: tuple[str, str, str],
sqlite_session: Session,
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
) -> None:
workspace_id, owner_id, operator_id = members
target = Account(name="Target", email="[email protected]")
@@ -731,9 +760,9 @@ def test_rbac_normal_role_manager_can_update_another_non_owner(
service.update_role(workspace_id, target.id, "editor", operator_id)
- replace.assert_called_once()
- assert replace.call_args.kwargs["member_account_id"] == target.id
- assert replace.call_args.kwargs["role_ids"] == ["role-editor"]
+ assert len(replace.calls) == 1
+ assert replace.calls[0].member_account_id == target.id
+ assert replace.calls[0].role_ids == ["role-editor"]
assert service.get_role(workspace_id, target.id) == TenantAccountRole.EDITOR
assert service.get_role(workspace_id, owner_id) == TenantAccountRole.OWNER
@@ -747,7 +776,7 @@ def test_rbac_role_update_assigns_requested_role_and_synchronizes_membership(
account_domain: AccountDomain,
members: tuple[str, str, str],
sqlite_session: Session,
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
role: TenantAccountRole,
remote_fails: bool,
) -> None:
@@ -762,15 +791,15 @@ def test_rbac_role_update_assigns_requested_role_and_synchronizes_membership(
workspaces=account_domain.workspaces, accounts=account_domain.repository, access=gateway
)
if remote_fails:
- replace.side_effect = RuntimeError("RBAC unavailable")
+ replace.failure = RuntimeError("RBAC unavailable")
with pytest.raises(RuntimeError, match="RBAC unavailable"):
service.update_role(workspace_id, member_id, role.value, owner_id)
else:
service.update_role(workspace_id, member_id, role.value, owner_id)
- replace.assert_called_once()
- assert replace.call_args.kwargs["role_ids"] == [f"role-{role.value}"]
- assert replace.call_args.kwargs["member_account_id"] == member_id
+ assert len(replace.calls) == 1
+ assert replace.calls[0].role_ids == [f"role-{role.value}"]
+ assert replace.calls[0].member_account_id == member_id
assert service.get_role(workspace_id, member_id) == (previous if remote_fails else role)
assert service.get_role(workspace_id, owner_id) == TenantAccountRole.OWNER
@@ -778,7 +807,7 @@ def test_rbac_role_update_assigns_requested_role_and_synchronizes_membership(
def test_rbac_owner_transfer_preserves_other_roles_and_updates_both_memberships(
account_domain: AccountDomain,
members: tuple[str, str, str],
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
monkeypatch: pytest.MonkeyPatch,
) -> None:
workspace_id, owner_id, member_id = members
@@ -799,10 +828,8 @@ def test_rbac_owner_transfer_preserves_other_roles_and_updates_both_memberships(
],
)
- def get_roles(
- tenant_id: str, account_id: str | None, member_account_id: str, *, session: Session
- ) -> MemberRolesResponse:
- del tenant_id, account_id, session
+ def get_roles(tenant_id: str, account_id: str | None, member_account_id: str) -> MemberRolesResponse:
+ del tenant_id, account_id
return current_roles if member_account_id == owner_id else MemberRolesResponse(account_id=member_account_id)
monkeypatch.setattr(RBACService.MemberRoles, "get", get_roles)
@@ -812,7 +839,7 @@ def test_rbac_owner_transfer_preserves_other_roles_and_updates_both_memberships(
service.update_role(workspace_id, member_id, "owner", owner_id)
- assert [(call.kwargs["member_account_id"], call.kwargs["role_ids"]) for call in replace.call_args_list] == [
+ assert [(call.member_account_id, call.role_ids) for call in replace.calls] == [
(owner_id, ["custom"]),
(member_id, ["role-owner"]),
]
@@ -826,7 +853,7 @@ def test_rbac_owner_is_protected_after_local_transfer_commit_fails(
members: tuple[str, str, str],
sqlite_session: Session,
sqlite_session_factory: sessionmaker[Session],
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
monkeypatch: pytest.MonkeyPatch,
operation: str,
) -> None:
@@ -847,16 +874,12 @@ def test_rbac_owner_is_protected_after_local_transfer_commit_fails(
remote_roles = {old_owner_id: [owner_role, custom_role], new_owner_id: [], third_member.id: []}
roles_by_id = {role.id: role for role in [owner_role, custom_role]}
- def get_roles(
- tenant_id: str, account_id: str | None, member_account_id: str, *, session: Session
- ) -> MemberRolesResponse:
- del tenant_id, account_id, session
+ def get_roles(tenant_id: str, account_id: str | None, member_account_id: str) -> MemberRolesResponse:
+ del tenant_id, account_id
return MemberRolesResponse(account_id=member_account_id, roles=remote_roles[member_account_id])
- def replace_roles(
- *, tenant_id: str, account_id: str, member_account_id: str, role_ids: list[str], session: Session
- ) -> None:
- del tenant_id, account_id, session
+ def replace_roles(*, tenant_id: str, account_id: str, member_account_id: str, role_ids: list[str]) -> None:
+ del tenant_id, account_id
remote_roles[member_account_id] = [
roles_by_id.get(role_id, RBACRole(id=role_id, name=role_id, type="")) for role_id in role_ids
]
@@ -873,7 +896,7 @@ def test_rbac_owner_is_protected_after_local_transfer_commit_fails(
member_id for member_id, roles in remote_roles.items() if owner_role in roles
),
)
- replace.side_effect = replace_roles
+ replace.on_apply = replace_roles
service = WorkspaceMemberService(
workspaces=account_domain.workspaces, accounts=account_domain.repository, access=gateway
)
@@ -889,13 +912,13 @@ def test_rbac_owner_is_protected_after_local_transfer_commit_fails(
assert remote_roles[new_owner_id] == [owner_role]
assert service.get_role(workspace_id, old_owner_id) == TenantAccountRole.OWNER
assert service.get_role(workspace_id, new_owner_id) == TenantAccountRole.NORMAL
- replace.reset_mock()
+ replace.calls.clear()
target_id, role = (new_owner_id, "editor") if operation == "demote_new_owner" else (third_member.id, "owner")
with pytest.raises(NoPermissionError):
service.update_role(workspace_id, target_id, role, old_owner_id)
- replace.assert_not_called()
+ assert replace.calls == []
assert remote_roles[old_owner_id] == [custom_role]
assert remote_roles[new_owner_id] == [owner_role]
assert remote_roles[third_member.id] == []
@@ -908,17 +931,15 @@ def test_rbac_owner_is_protected_after_local_transfer_commit_fails(
def test_rbac_owner_lookup_failure_prevents_role_changes(
account_domain: AccountDomain,
members: tuple[str, str, str],
- rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, Mock],
+ rbac_access: tuple[DeploymentWorkspaceMemberAccessGateway, RecordedRoleAssignments],
monkeypatch: pytest.MonkeyPatch,
new_role: str,
) -> None:
workspace_id, owner_id, member_id = members
gateway, replace = rbac_access
- def get_roles(
- tenant_id: str, account_id: str | None, member_account_id: str, *, session: Session
- ) -> MemberRolesResponse:
- del tenant_id, account_id, session
+ def get_roles(tenant_id: str, account_id: str | None, member_account_id: str) -> MemberRolesResponse:
+ del tenant_id, account_id
if new_role == "editor" or member_account_id == owner_id:
raise RuntimeError("RBAC unavailable")
return MemberRolesResponse(account_id=member_account_id)
@@ -931,6 +952,6 @@ def test_rbac_owner_lookup_failure_prevents_role_changes(
with pytest.raises(RuntimeError, match="RBAC unavailable"):
service.update_role(workspace_id, member_id, new_role, owner_id)
- replace.assert_not_called()
+ assert replace.calls == []
assert service.get_role(workspace_id, owner_id) == TenantAccountRole.OWNER
assert service.get_role(workspace_id, member_id) == TenantAccountRole.NORMAL
diff --git a/api/tests/unit_tests/services/workspace/test_workspace_member_query_service.py b/api/tests/unit_tests/services/workspace/test_workspace_member_query_service.py
index 5f4ca7da8f0..d142750f4d4 100644
--- a/api/tests/unit_tests/services/workspace/test_workspace_member_query_service.py
+++ b/api/tests/unit_tests/services/workspace/test_workspace_member_query_service.py
@@ -61,14 +61,18 @@ class RecordingRoleResolver:
def __init__(self, roles: Mapping[str, Sequence[WorkspaceMemberRole]]) -> None:
self.roles = roles
self.calls: list[tuple[str, str, tuple[WorkspaceMemberRoleSubject, ...]]] = []
+ self.languages: list[str | None] = []
def resolve_many(
self,
workspace_id: str,
actor_account_id: str,
subjects: Sequence[WorkspaceMemberRoleSubject],
+ *,
+ language: str | None = None,
) -> Mapping[str, Sequence[WorkspaceMemberRole]]:
self.calls.append((workspace_id, actor_account_id, tuple(subjects)))
+ self.languages.append(language)
return self.roles
@@ -78,8 +82,10 @@ class FailingRoleResolver:
workspace_id: str,
actor_account_id: str,
subjects: Sequence[WorkspaceMemberRoleSubject],
+ *,
+ language: str | None = None,
) -> Mapping[str, Sequence[WorkspaceMemberRole]]:
- del workspace_id, actor_account_id, subjects
+ del workspace_id, actor_account_id, subjects, language
raise RoleResolutionError
@@ -87,7 +93,8 @@ class RoleResolutionError(Exception):
pass
-def test_list_current_projects_members_and_merges_roles_by_account_id() -> None:
[email protected]("language", [None, "ja"])
+def test_list_current_projects_members_and_merges_roles_by_account_id(language: str | None) -> None:
active = make_member("active", legacy_role="owner")
pending = make_member("pending", status="pending")
members = RecordingMemberQuery([active, pending])
@@ -101,7 +108,7 @@ def test_list_current_projects_members_and_merges_roles_by_account_id() -> None:
)
service = WorkspaceMemberQueryService(members=members, roles=roles)
- result = service.list_current(make_context())
+ result = service.list_current(make_context(), language=language)
by_id = {member.id: member for member in result}
assert set(by_id) == {"active", "pending"}
@@ -123,6 +130,7 @@ def test_list_current_projects_members_and_merges_roles_by_account_id() -> None:
assert by_id["pending"].status == "pending"
assert by_id["pending"].roles == ()
assert members.workspace_ids == ["workspace-1"]
+ assert roles.languages == [language]
assert roles.calls == [
(
"workspace-1",
diff --git a/api/tests/unit_tests/services/workspace/test_workspace_member_role_resolver.py b/api/tests/unit_tests/services/workspace/test_workspace_member_role_resolver.py
index d955a251694..17e7e896ca8 100644
--- a/api/tests/unit_tests/services/workspace/test_workspace_member_role_resolver.py
+++ b/api/tests/unit_tests/services/workspace/test_workspace_member_role_resolver.py
@@ -1,11 +1,11 @@
-from types import SimpleNamespace
-from unittest.mock import MagicMock
+from collections.abc import Callable
import pytest
-from services.enterprise.rbac_service import MemberRolesResponse, RBACRole
-from services.workspace import gateways
+from services.enterprise.base import EnterpriseRequest
from services.workspace.contracts import WorkspaceMemberRole, WorkspaceMemberRoleSubject
+from services.workspace.gateways import DeploymentWorkspaceMemberRoleResolver
+from tests.unit_tests.rbac_fakes import RBACTransport
def make_subject(account_id: str, *, legacy_role: str = "normal") -> WorkspaceMemberRoleSubject:
@@ -13,74 +13,45 @@ def make_subject(account_id: str, *, legacy_role: str = "normal") -> WorkspaceMe
@pytest.fixture
-def batch_get(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
- batch_get = MagicMock()
- monkeypatch.setattr(
- gateways.enterprise_rbac_service.RBACService.MemberRoles,
- "batch_get",
- batch_get,
- )
- return batch_get
-
-
-def configure_rbac(monkeypatch: pytest.MonkeyPatch, *, enabled: bool) -> None:
- monkeypatch.setattr(
- gateways,
- "dify_config",
- SimpleNamespace(RBAC_ENABLED=enabled),
- )
+def transport(monkeypatch: pytest.MonkeyPatch) -> RBACTransport:
+ transport = RBACTransport()
+ monkeypatch.setattr(EnterpriseRequest, "send_inner_rbac_request", transport.send)
+ return transport
-def test_legacy_mode_projects_join_roles_without_enterprise_call(
- monkeypatch: pytest.MonkeyPatch,
- batch_get: MagicMock,
+def test_builtin_mode_projects_join_roles_without_enterprise_call(
+ config_overrides: Callable[..., None], transport: RBACTransport
) -> None:
- configure_rbac(monkeypatch, enabled=False)
- owner = make_subject("owner", legacy_role="owner")
- member = make_subject("member")
+ config_overrides(RBAC_ENABLED=False)
- result = gateways.DeploymentWorkspaceMemberRoleResolver().resolve_many(
- "workspace-1",
- "actor-1",
- [owner, member],
+ result = DeploymentWorkspaceMemberRoleResolver().resolve_many(
+ "workspace-1", "actor-1", [make_subject("owner", legacy_role="owner"), make_subject("member")]
)
assert result == {
"owner": (WorkspaceMemberRole(id="owner", name="owner"),),
"member": (WorkspaceMemberRole(id="normal", name="normal"),),
}
- batch_get.assert_not_called()
+ assert transport.requests == []
-def test_rbac_mode_maps_batch_response_without_legacy_fallback(
- monkeypatch: pytest.MonkeyPatch,
- batch_get: MagicMock,
[email protected]("language", [None, "ja"])
+def test_rbac_mode_maps_batch_response_without_builtin_fallback(
+ config_overrides: Callable[..., None], transport: RBACTransport, language: str | None
) -> None:
- configure_rbac(monkeypatch, enabled=True)
- owner = make_subject("owner", legacy_role="owner")
- omitted = make_subject("omitted", legacy_role="admin")
- batch_get.return_value = [
- MemberRolesResponse(
- account_id=owner.account_id,
- roles=[
- RBACRole(
- id="workspace.owner",
- name="Owner",
- type="builtin",
- ),
- RBACRole(
- id="workspace.editor",
- name="Editor",
- type="builtin",
- ),
- ],
- )
- ]
+ config_overrides(RBAC_ENABLED=True)
+ transport.response = {
+ "owner": [
+ {"id": "workspace.owner", "name": "Owner", "type": "builtin"},
+ {"id": "workspace.editor", "name": "Editor", "type": "builtin"},
+ ]
+ }
- result = gateways.DeploymentWorkspaceMemberRoleResolver().resolve_many(
+ result = DeploymentWorkspaceMemberRoleResolver().resolve_many(
"workspace-1",
"actor-1",
- [owner, omitted],
+ [make_subject("owner", legacy_role="owner"), make_subject("omitted", legacy_role="admin")],
+ language=language,
)
assert result == {
@@ -89,39 +60,28 @@ def test_rbac_mode_maps_batch_response_without_legacy_fallback(
WorkspaceMemberRole(id="workspace.editor", name="Editor"),
)
}
- assert "omitted" not in result
- batch_get.assert_called_once_with("workspace-1", "actor-1", ["owner", "omitted"])
+ sent = transport.only_request
+ assert (sent.method, sent.endpoint) == ("POST", "/rbac/members/rbac-roles/batch")
+ assert (sent.tenant_id, sent.account_id) == ("workspace-1", "actor-1")
+ assert sent.json == {"member_ids": ["owner", "omitted"]}
+ assert sent.params == ({"language": language} if language else None)
-def test_rbac_failure_propagates(
- monkeypatch: pytest.MonkeyPatch,
- batch_get: MagicMock,
-) -> None:
- configure_rbac(monkeypatch, enabled=True)
- batch_get.side_effect = RoleResolutionError("enterprise unavailable")
+def test_rbac_failure_propagates(config_overrides: Callable[..., None], transport: RBACTransport) -> None:
+ config_overrides(RBAC_ENABLED=True)
+ transport.failure = RoleResolutionError("enterprise unavailable")
with pytest.raises(RoleResolutionError, match="enterprise unavailable"):
- gateways.DeploymentWorkspaceMemberRoleResolver().resolve_many(
- "workspace-1",
- "actor-1",
- [make_subject("member-1")],
- )
+ DeploymentWorkspaceMemberRoleResolver().resolve_many("workspace-1", "actor-1", [make_subject("member-1")])
def test_empty_member_list_skips_enterprise_call(
- monkeypatch: pytest.MonkeyPatch,
- batch_get: MagicMock,
+ config_overrides: Callable[..., None], transport: RBACTransport
) -> None:
- configure_rbac(monkeypatch, enabled=True)
-
- result = gateways.DeploymentWorkspaceMemberRoleResolver().resolve_many(
- "workspace-1",
- "actor-1",
- [],
- )
+ config_overrides(RBAC_ENABLED=True)
- assert result == {}
- batch_get.assert_not_called()
+ assert DeploymentWorkspaceMemberRoleResolver().resolve_many("workspace-1", "actor-1", []) == {}
+ assert transport.requests == []
class RoleResolutionError(Exception):
diff --git a/api/tests/unit_tests/services/workspace/test_workspace_provisioning.py b/api/tests/unit_tests/services/workspace/test_workspace_provisioning.py
index 2249ac52874..2c010d5f277 100644
--- a/api/tests/unit_tests/services/workspace/test_workspace_provisioning.py
+++ b/api/tests/unit_tests/services/workspace/test_workspace_provisioning.py
@@ -138,7 +138,7 @@ def gateway(
return _service(
owners=SQLAlchemyAccountRepository(sqlite_session_factory),
provisioning=WorkspaceRepository(sqlite_session_factory),
- effects=WorkspaceProvisioningEffectsGateway(session_factory=sqlite_session_factory),
+ effects=WorkspaceProvisioningEffectsGateway(),
), signal
diff --git a/api/tests/unit_tests/tasks/test_initialize_created_app_rbac_access_task.py b/api/tests/unit_tests/tasks/test_initialize_created_app_rbac_access_task.py
index deae098c009..5a1e78317e1 100644
--- a/api/tests/unit_tests/tasks/test_initialize_created_app_rbac_access_task.py
+++ b/api/tests/unit_tests/tasks/test_initialize_created_app_rbac_access_task.py
@@ -1,217 +1,164 @@
-from unittest.mock import MagicMock
+"""Task behavior with real workspace queries and an explicit RBAC transport."""
+
+from collections.abc import Callable, Iterator
+from typing import Protocol, cast
import pytest
from flask import Flask
-from extensions.ext_application_services import ApplicationServices, application_services
-from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
-from tests.unit_tests.config_override import apply_config_overrides
+import tasks.initialize_created_app_rbac_access_task as task_module
+from enums import DeploymentEdition
+from enums.account import TenantAccountRole
+from extensions.ext_application_services import build_application_services
+from extensions.ext_redis import redis_client
+from models import TenantAccountJoin
+from services.rbac import contracts as dto
+from tasks.initialize_created_app_rbac_access_task import (
+ initialize_created_app_rbac_access_task,
+ sync_joined_workspace_member_rbac_access_task,
+)
+from tests.unit_tests.rbac_fakes import RBACDomain
+
-APP_RBAC_QUEUE = "app_rbac"
+class _TaskWithQueue(Protocol):
+ queue: str
-def test_initialize_created_app_rbac_access_task_uses_rbac_queue():
- assert initialize_created_app_rbac_access_task.queue == APP_RBAC_QUEUE
[email protected](autouse=True)
+def workspace_services(
+ monkeypatch: pytest.MonkeyPatch,
+ app: Flask,
+ rbac_domain: RBACDomain,
+ config_overrides: Callable[..., None],
+) -> None:
+ config_overrides(RBAC_ENABLED=True)
+ services = build_application_services(
+ database_client=rbac_domain.sessions,
+ deployment_edition=DeploymentEdition.COMMUNITY,
+ initialization_password="",
+ redis=redis_client,
+ )
+ monkeypatch.setitem(app.extensions, "application_services", services)
-def test_sync_joined_workspace_member_rbac_access_task_uses_rbac_queue():
- from tasks.initialize_created_app_rbac_access_task import sync_joined_workspace_member_rbac_access_task
+def _seed_members(domain: RBACDomain, members: tuple[str, ...]) -> None:
+ with domain.sessions.begin() as session:
+ for account_id in members:
+ membership = TenantAccountJoin(tenant_id="tenant-1", account_id=account_id, role=TenantAccountRole.NORMAL)
+ membership.id = account_id
+ session.add(membership)
+ session.add(TenantAccountJoin(tenant_id="other", account_id="foreign", role=TenantAccountRole.NORMAL))
- assert sync_joined_workspace_member_rbac_access_task.queue == APP_RBAC_QUEUE
+def test_initialize_created_app_rbac_access_task_uses_rbac_queue() -> None:
+ task = cast(_TaskWithQueue, initialize_created_app_rbac_access_task)
+ assert task.queue == "app_rbac"
-def test_initialize_created_app_rbac_access_task_batches_workspace_members(monkeypatch: pytest.MonkeyPatch):
- import tasks.initialize_created_app_rbac_access_task as task_module
- from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- monkeypatch.setattr(
- application_services().workspaces.management,
- "iter_member_account_id_batches",
- lambda tenant_id, batch_size: iter([("acct-1", "acct-2"), ("acct-3",)]),
- )
- replace_whitelist = MagicMock()
- replace_user_access_policies = MagicMock()
- monkeypatch.setattr(
- task_module.enterprise_rbac_service.RBACService.AppAccess,
- "replace_whitelist",
- replace_whitelist,
- )
- monkeypatch.setattr(
- task_module.enterprise_rbac_service.RBACService.AppAccess,
- "replace_user_access_policies",
- replace_user_access_policies,
- )
+def test_sync_joined_workspace_member_rbac_access_task_uses_rbac_queue() -> None:
+ task = cast(_TaskWithQueue, sync_joined_workspace_member_rbac_access_task)
+ assert task.queue == "app_rbac"
+
+
+def test_initialize_created_app_rbac_access_task_batches_workspace_members(
+ monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain
+) -> None:
+ _seed_members(rbac_domain, ("acct-1", "acct-2", "acct-3"))
+ monkeypatch.setattr(task_module, "APP_RBAC_ACCOUNT_POLICY_BATCH_SIZE", 2)
initialize_created_app_rbac_access_task.run("tenant-1", "actor-1", "app-1")
- replace_whitelist.assert_not_called()
- assert replace_user_access_policies.call_count == 2
- assert replace_user_access_policies.call_args_list[0].kwargs["payload"].account_ids == ["acct-1", "acct-2"]
- assert replace_user_access_policies.call_args_list[1].kwargs["payload"].account_ids == ["acct-3"]
- for call in replace_user_access_policies.call_args_list:
- assert call.kwargs["payload"].access_policy_ids == [task_module.APP_RBAC_DEFAULT_ACCESS_POLICY_ID]
-
-
- ("id_kwarg", "resource_id", "access_class"),
- [
- ("app_id", "app-1", "AppAccess"),
- ("dataset_id", "dataset-1", "DatasetAccess"),
- ("agent_id", "agent-1", "AgentAccess"),
- ],
-)
+ first, second = rbac_domain.transport.requests
+ for request, account_ids in ((first, ["acct-1", "acct-2"]), (second, ["acct-3"])):
+ assert request.method == "PUT"
+ assert request.endpoint == "/rbac/apps/user-access-policies"
+ assert (request.tenant_id, request.account_id) == ("tenant-1", "actor-1")
+ assert request.params == {"app_id": "app-1", "account_id": None}
+ assert request.json == {
+ "account_ids": account_ids,
+ "access_policy_ids": [task_module.APP_RBAC_DEFAULT_ACCESS_POLICY_ID],
+ }
+
+
[email protected]("kind", ["app", "dataset", "agent"])
def test_initialize_created_app_rbac_access_task_targets_the_resource_that_was_passed(
- monkeypatch: pytest.MonkeyPatch, id_kwarg: str, resource_id: str, access_class: str
-):
- import tasks.initialize_created_app_rbac_access_task as task_module
-
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- monkeypatch.setattr(
- application_services().workspaces.management,
- "iter_member_account_id_batches",
- lambda tenant_id, batch_size: iter([("acct-1",)]),
- )
- rbac_service = task_module.enterprise_rbac_service.RBACService
- access_clients = {
- "AppAccess": rbac_service.AppAccess,
- "DatasetAccess": rbac_service.DatasetAccess,
- "AgentAccess": rbac_service.AgentAccess,
- }
- replace_calls = {}
- for name, client in access_clients.items():
- replace_calls[name] = MagicMock()
- monkeypatch.setattr(client, "replace_user_access_policies", replace_calls[name])
-
- initialize_created_app_rbac_access_task.run("tenant-1", "actor-1", **{id_kwarg: resource_id})
-
- for name, mock in replace_calls.items():
- if name != access_class:
- mock.assert_not_called()
-
- called = replace_calls[access_class]
- called.assert_called_once()
- assert called.call_args.kwargs[id_kwarg] == resource_id
- assert called.call_args.kwargs["target_account_id"] is None
- assert called.call_args.kwargs["payload"].account_ids == ["acct-1"]
-
-
-def test_initialize_created_app_rbac_access_task_retries_on_failure(monkeypatch: pytest.MonkeyPatch):
- import tasks.initialize_created_app_rbac_access_task as task_module
- from tasks.initialize_created_app_rbac_access_task import initialize_created_app_rbac_access_task
-
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- monkeypatch.setattr(
- application_services().workspaces.management,
- "iter_member_account_id_batches",
- lambda tenant_id, batch_size: iter([("acct-1",)]),
- )
- monkeypatch.setattr(
- task_module.enterprise_rbac_service.RBACService.AppAccess,
- "replace_user_access_policies",
- MagicMock(side_effect=ConnectionError("RBAC unavailable")),
- )
- retry = MagicMock(return_value=RuntimeError("retry requested"))
+ rbac_domain: RBACDomain, kind: str
+) -> None:
+ _seed_members(rbac_domain, ("acct-1",))
+ resource_id = f"{kind}-1"
+
+ initialize_created_app_rbac_access_task.run("tenant-1", "actor-1", **{f"{kind}_id": resource_id})
+
+ request = rbac_domain.transport.only_request
+ assert (request.method, request.endpoint) == ("PUT", f"/rbac/{kind}s/user-access-policies")
+ assert (request.tenant_id, request.account_id) == ("tenant-1", "actor-1")
+ assert request.params == {f"{kind}_id": resource_id, "account_id": None}
+ assert request.json == {"account_ids": ["acct-1"], "access_policy_ids": ["default"]}
+
+
+def test_initialize_created_app_rbac_access_task_retries_on_failure(
+ monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain
+) -> None:
+ _seed_members(rbac_domain, ("acct-1",))
+ failure = ConnectionError("RBAC unavailable")
+ rbac_domain.transport.failure = failure
+ retries: list[Exception] = []
+
+ def retry(*, exc: Exception) -> RuntimeError:
+ retries.append(exc)
+ return RuntimeError("retry requested")
+
monkeypatch.setattr(initialize_created_app_rbac_access_task, "retry", retry)
with pytest.raises(RuntimeError, match="retry requested"):
initialize_created_app_rbac_access_task.run("tenant-1", "actor-1", "app-1")
- retry.assert_called_once()
- assert isinstance(retry.call_args.kwargs["exc"], ConnectionError)
+ assert retries == [failure]
+ assert rbac_domain.transport.only_request.endpoint == "/rbac/apps/user-access-policies"
def test_sync_joined_workspace_member_rbac_access_task_appends_auto_included_resources(
- monkeypatch: pytest.MonkeyPatch,
-):
- import tasks.initialize_created_app_rbac_access_task as task_module
- from tasks.initialize_created_app_rbac_access_task import sync_joined_workspace_member_rbac_access_task
-
- rbac = task_module.enterprise_rbac_service
+ monkeypatch: pytest.MonkeyPatch, rbac_domain: RBACDomain
+) -> None:
resources = [
- rbac.ResourceWhitelistConfigResource(resource_type=rbac.RBACResourceType.APP, resource_id="app-1"),
- rbac.ResourceWhitelistConfigResource(resource_type=rbac.RBACResourceType.DATASET, resource_id="dataset-1"),
- rbac.ResourceWhitelistConfigResource(resource_type=rbac.RBACResourceType.APP, resource_id="app-2"),
- rbac.ResourceWhitelistConfigResource(resource_type=rbac.RBACResourceType.AGENT, resource_id="agent-1"),
- rbac.ResourceWhitelistConfigResource(resource_type=rbac.RBACResourceType.AGENT, resource_id="agent-2"),
+ dto.ResourceWhitelistConfigResource(resource_type=kind, resource_id=resource_id)
+ for kind, resource_id in (
+ (dto.RBACResourceType.APP, "app-1"),
+ (dto.RBACResourceType.DATASET, "dataset-1"),
+ (dto.RBACResourceType.APP, "app-2"),
+ (dto.RBACResourceType.AGENT, "agent-1"),
+ (dto.RBACResourceType.AGENT, "agent-2"),
+ )
]
- configs = rbac.ResourceWhitelistConfigsResponse(
+
+ def resource_batches(tenant_id: str, batch_size: int) -> Iterator[list[dto.ResourceWhitelistConfigResource]]:
+ assert tenant_id == "tenant-1"
+ assert batch_size == task_module.APP_RBAC_RESOURCE_CONFIG_BATCH_SIZE
+ yield resources
+
+ configs = dto.ResourceWhitelistConfigsResponse(
data=[
- rbac.ResourceWhitelistConfigItem(
- resource_type=rbac.RBACResourceType.APP,
- resource_id="app-1",
- automatic_include_workspace_members=True,
- ),
- rbac.ResourceWhitelistConfigItem(
- resource_type=rbac.RBACResourceType.DATASET,
- resource_id="dataset-1",
- automatic_include_workspace_members=True,
- ),
- rbac.ResourceWhitelistConfigItem(
- resource_type=rbac.RBACResourceType.APP,
- resource_id="app-2",
- automatic_include_workspace_members=False,
- ),
- rbac.ResourceWhitelistConfigItem(
- resource_type=rbac.RBACResourceType.AGENT,
- resource_id="agent-1",
- automatic_include_workspace_members=True,
- ),
- rbac.ResourceWhitelistConfigItem(
- resource_type=rbac.RBACResourceType.AGENT,
- resource_id="agent-2",
- automatic_include_workspace_members=False,
- ),
+ dto.ResourceWhitelistConfigItem(
+ resource_type=resource.resource_type,
+ resource_id=resource.resource_id,
+ automatic_include_workspace_members=resource.resource_id.endswith("-1"),
+ )
+ for resource in resources
]
)
- batch_get = MagicMock(return_value=configs)
- app_append = MagicMock()
- dataset_append = MagicMock()
- agent_append = MagicMock()
-
- apply_config_overrides(monkeypatch, RBAC_ENABLED=True)
- monkeypatch.setattr(task_module, "_iter_resource_config_batches", lambda tenant_id, batch_size: iter([resources]))
- monkeypatch.setattr(rbac.RBACService.ResourceWhitelistConfigs, "batch_get", batch_get)
- monkeypatch.setattr(rbac.RBACService.AppAccess, "append_whitelist_members_batch", app_append)
- monkeypatch.setattr(rbac.RBACService.DatasetAccess, "append_whitelist_members_batch", dataset_append)
- monkeypatch.setattr(rbac.RBACService.AgentAccess, "append_whitelist_members_batch", agent_append)
+ rbac_domain.transport.responses["/rbac/whitelist/configs"] = configs.model_dump(mode="json")
+ monkeypatch.setattr(task_module, "_iter_resource_config_batches", resource_batches)
sync_joined_workspace_member_rbac_access_task.run("tenant-1", "member-1", "actor-1")
- batch_get.assert_called_once_with(
- tenant_id="tenant-1",
- account_id="actor-1",
- resources=resources,
- )
- app_append.assert_called_once()
- app_call = app_append.call_args.kwargs
- assert app_call["tenant_id"] == "tenant-1"
- assert app_call["account_id"] == "actor-1"
- assert len(app_call["data"]) == 1
- assert app_call["data"][0].app_id == "app-1"
- assert app_call["data"][0].account_ids == ["member-1"]
- assert app_call["data"][0].policy_id == task_module.APP_RBAC_DEFAULT_ACCESS_POLICY_ID
-
- dataset_append.assert_called_once()
- dataset_call = dataset_append.call_args.kwargs
- assert dataset_call["tenant_id"] == "tenant-1"
- assert dataset_call["account_id"] == "actor-1"
- assert len(dataset_call["data"]) == 1
- assert dataset_call["data"][0].dataset_id == "dataset-1"
- assert dataset_call["data"][0].account_ids == ["member-1"]
- assert dataset_call["data"][0].policy_id == task_module.APP_RBAC_DEFAULT_ACCESS_POLICY_ID
-
- agent_append.assert_called_once()
- agent_call = agent_append.call_args.kwargs
- assert agent_call["tenant_id"] == "tenant-1"
- assert agent_call["account_id"] == "actor-1"
- assert [item.agent_id for item in agent_call["data"]] == ["agent-1"]
- assert agent_call["data"][0].account_ids == ["member-1"]
- assert agent_call["data"][0].policy_id == task_module.APP_RBAC_DEFAULT_ACCESS_POLICY_ID
-
-
[email protected](autouse=True)
-def _account_services(
- monkeypatch: pytest.MonkeyPatch, app: Flask, account_application_services: ApplicationServices
-) -> None:
- monkeypatch.setitem(app.extensions, "application_services", account_application_services)
+ lookup, *appends = rbac_domain.transport.requests
+ assert (lookup.method, lookup.endpoint) == ("POST", "/rbac/whitelist/configs")
+ assert lookup.json == {"resources": [resource.model_dump(mode="json") for resource in resources]}
+ assert len(appends) == 3
+ for kind, request in zip(("app", "dataset", "agent"), appends, strict=True):
+ assert (request.method, request.endpoint) == ("POST", f"/rbac/{kind}s/whitelist/members/batch")
+ assert request.json == {
+ "data": [{f"{kind}_id": f"{kind}-1", "account_ids": ["member-1"], "policy_id": "default"}]
+ }
+ for request in (lookup, *appends):
+ assert (request.tenant_id, request.account_id) == ("tenant-1", "actor-1")
diff --git a/packages/contracts/generated/api/console/workspaces/orpc.gen.ts b/packages/contracts/generated/api/console/workspaces/orpc.gen.ts
index 76beec5a5fd..aa9d18d795f 100644
--- a/packages/contracts/generated/api/console/workspaces/orpc.gen.ts
+++ b/packages/contracts/generated/api/console/workspaces/orpc.gen.ts
@@ -2303,6 +2303,7 @@ export const post44 = oc
method: 'POST',
operationId: 'postWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopy',
path: '/workspaces/current/rbac/access-policies/{policy_id}/copy',
+ successStatus: 201,
tags: ['console'],
})
.input(z.object({ params: zPostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyPath }))
@@ -3131,6 +3132,7 @@ export const post46 = oc
method: 'POST',
operationId: 'postWorkspacesCurrentRbacRolesByRoleIdCopy',
path: '/workspaces/current/rbac/roles/{role_id}/copy',
+ successStatus: 201,
tags: ['console'],
})
.input(z.object({ params: zPostWorkspacesCurrentRbacRolesByRoleIdCopyPath }))
@@ -3212,6 +3214,7 @@ export const post47 = oc
method: 'POST',
operationId: 'postWorkspacesCurrentRbacRoles',
path: '/workspaces/current/rbac/roles',
+ successStatus: 201,
tags: ['console'],
})
.output(zPostWorkspacesCurrentRbacRolesResponse)
diff --git a/packages/contracts/generated/api/console/workspaces/types.gen.ts b/packages/contracts/generated/api/console/workspaces/types.gen.ts
index 4db1ebc6d91..3b0ea2b6d3e 100644
--- a/packages/contracts/generated/api/console/workspaces/types.gen.ts
+++ b/packages/contracts/generated/api/console/workspaces/types.gen.ts
@@ -527,6 +527,11 @@ export type PluginCategoryListResponse = {
plugins: Array<PluginCategoryInstalledPluginResponse>
}
+export type AccessPolicyList = {
+ data?: Array<AccessPolicy>
+ pagination?: Pagination | null
+}
+
export type AccessPolicyCreateRequest = {
description?: string
name: string
@@ -554,6 +559,11 @@ export type AccessPolicyUpdateRequest = {
permission_keys?: Array<string>
}
+export type AccessPolicyBindingState = {
+ binding_id: string
+ is_locked?: boolean
+}
+
export type DeleteMemberBindingsRequest = {
account_ids?: Array<string>
}
@@ -627,6 +637,23 @@ export type PermissionCatalogResponse = {
groups?: Array<PermissionCatalogGroup>
}
+export type RbacRoleList = {
+ data?: Array<RbacRole>
+ pagination?: Pagination | null
+}
+
+export type RbacRole = {
+ category?: string
+ description?: string
+ id: string
+ is_builtin?: boolean
+ name: string
+ permission_keys?: Array<string>
+ role_tag?: string
+ tenant_id?: string | null
+ type: string
+}
+
export type MembersInRoleList = {
data?: Array<MembersInRole>
pagination?: Pagination | null
@@ -1693,6 +1720,13 @@ export type PluginCategoryInstalledPluginResponse = {
version: string
}
+export type Pagination = {
+ current_page?: number
+ per_page?: number
+ total_count?: number
+ total_pages?: number
+}
+
export type RbacResourceType = 'agent' | 'app' | 'dataset'
export type AccessPolicyMemberBinding = {
@@ -1723,25 +1757,6 @@ export type ResourceUserAccessPolicies = {
roles?: Array<RbacRole>
}
-export type Pagination = {
- current_page?: number
- per_page?: number
- total_count?: number
- total_pages?: number
-}
-
-export type RbacRole = {
- category?: string
- description?: string
- id: string
- is_builtin?: boolean
- name: string
- permission_keys?: Array<string>
- role_tag?: string
- tenant_id?: string | null
- type: string
-}
-
export type ResourcePermissionSnapshot = {
default_permission_keys?: Array<string>
overrides?: Array<ResourcePermissionKeys>
@@ -4452,9 +4467,7 @@ export type GetWorkspacesCurrentRbacAccessPoliciesData = {
}
export type GetWorkspacesCurrentRbacAccessPoliciesResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: AccessPolicyList
}
export type GetWorkspacesCurrentRbacAccessPoliciesResponse =
@@ -4484,9 +4497,7 @@ export type DeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdData = {
}
export type DeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: SimpleResultResponse
}
export type DeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse =
@@ -4502,9 +4513,7 @@ export type GetWorkspacesCurrentRbacAccessPoliciesByPolicyIdData = {
}
export type GetWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: AccessPolicy
}
export type GetWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse =
@@ -4536,9 +4545,7 @@ export type PostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyData = {
}
export type PostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyResponses = {
- 200: {
- [key: string]: unknown
- }
+ 201: AccessPolicy
}
export type PostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyResponse =
@@ -4554,9 +4561,7 @@ export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockData = {
}
export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: AccessPolicyBindingState
}
export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockResponse =
@@ -4572,9 +4577,7 @@ export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockData =
}
export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: AccessPolicyBindingState
}
export type PutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockResponse =
@@ -4592,7 +4595,7 @@ export type DeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMe
export type DeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsResponses =
{
- 200: MemberBindingsResponse
+ 200: SimpleResultResponse
}
export type DeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsResponse =
@@ -4749,7 +4752,7 @@ export type DeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMember
export type DeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsResponses =
{
- 200: MemberBindingsResponse
+ 200: SimpleResultResponse
}
export type DeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsResponse =
@@ -4906,7 +4909,7 @@ export type DeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicy
export type DeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsResponses =
{
- 200: MemberBindingsResponse
+ 200: SimpleResultResponse
}
export type DeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsResponse =
@@ -5164,9 +5167,7 @@ export type GetWorkspacesCurrentRbacRolesData = {
}
export type GetWorkspacesCurrentRbacRolesResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: RbacRoleList
}
export type GetWorkspacesCurrentRbacRolesResponse =
@@ -5180,9 +5181,7 @@ export type PostWorkspacesCurrentRbacRolesData = {
}
export type PostWorkspacesCurrentRbacRolesResponses = {
- 200: {
- [key: string]: unknown
- }
+ 201: RbacRole
}
export type PostWorkspacesCurrentRbacRolesResponse =
@@ -5198,9 +5197,7 @@ export type DeleteWorkspacesCurrentRbacRolesByRoleIdData = {
}
export type DeleteWorkspacesCurrentRbacRolesByRoleIdResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: SimpleResultResponse
}
export type DeleteWorkspacesCurrentRbacRolesByRoleIdResponse =
@@ -5216,9 +5213,7 @@ export type GetWorkspacesCurrentRbacRolesByRoleIdData = {
}
export type GetWorkspacesCurrentRbacRolesByRoleIdResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: RbacRole
}
export type GetWorkspacesCurrentRbacRolesByRoleIdResponse =
@@ -5234,9 +5229,7 @@ export type PutWorkspacesCurrentRbacRolesByRoleIdData = {
}
export type PutWorkspacesCurrentRbacRolesByRoleIdResponses = {
- 200: {
- [key: string]: unknown
- }
+ 200: RbacRole
}
export type PutWorkspacesCurrentRbacRolesByRoleIdResponse =
@@ -5252,9 +5245,7 @@ export type PostWorkspacesCurrentRbacRolesByRoleIdCopyData = {
}
export type PostWorkspacesCurrentRbacRolesByRoleIdCopyResponses = {
- 200: {
- [key: string]: unknown
- }
+ 201: RbacRole
}
export type PostWorkspacesCurrentRbacRolesByRoleIdCopyResponse =
diff --git a/packages/contracts/generated/api/console/workspaces/zod.gen.ts b/packages/contracts/generated/api/console/workspaces/zod.gen.ts
index f21f6696403..e66b1d499b4 100644
--- a/packages/contracts/generated/api/console/workspaces/zod.gen.ts
+++ b/packages/contracts/generated/api/console/workspaces/zod.gen.ts
@@ -396,6 +396,14 @@ export const zAccessPolicyUpdateRequest = z.object({
permission_keys: z.array(z.string()).optional().default([]),
})
+/**
+ * AccessPolicyBindingState
+ */
+export const zAccessPolicyBindingState = z.object({
+ binding_id: z.string(),
+ is_locked: z.boolean().optional().default(false),
+})
+
/**
* _DeleteMemberBindingsRequest
*/
@@ -446,6 +454,29 @@ export const zReplaceMemberRolesRequest = z.object({
role_ids: z.array(z.string()).optional().default([]),
})
+/**
+ * RBACRole
+ */
+export const zRbacRole = z.object({
+ category: z.string().optional().default(''),
+ description: z.string().optional().default(''),
+ id: z.string(),
+ is_builtin: z.boolean().optional().default(false),
+ name: z.string(),
+ permission_keys: z.array(z.string()).optional(),
+ role_tag: z.string().optional().default(''),
+ tenant_id: z.string().nullish(),
+ type: z.string(),
+})
+
+/**
+ * MemberRolesResponse
+ */
+export const zMemberRolesResponse = z.object({
+ account_id: z.string(),
+ roles: z.array(zRbacRole).optional(),
+})
+
/**
* _ReplaceBindingsRequest
*/
@@ -1230,6 +1261,32 @@ export const zPluginPermissionResponse = z.object({
install_permission: zTenantPluginInstallPermission,
})
+/**
+ * Pagination
+ */
+export const zPagination = z.object({
+ current_page: z.int().optional().default(0),
+ per_page: z.int().optional().default(0),
+ total_count: z.int().optional().default(0),
+ total_pages: z.int().optional().default(0),
+})
+
+/**
+ * _AccessPolicyList
+ */
+export const zAccessPolicyList = z.object({
+ data: z.array(zAccessPolicy).optional(),
+ pagination: zPagination.nullish(),
+})
+
+/**
+ * _RBACRoleList
+ */
+export const zRbacRoleList = z.object({
+ data: z.array(zRbacRole).optional(),
+ pagination: zPagination.nullish(),
+})
+
/**
* RBACResourceType
*
@@ -1289,39 +1346,6 @@ export const zRoleBindingsResponse = z.object({
data: z.array(zAccessPolicyRoleBinding).optional(),
})
-/**
- * Pagination
- */
-export const zPagination = z.object({
- current_page: z.int().optional().default(0),
- per_page: z.int().optional().default(0),
- total_count: z.int().optional().default(0),
- total_pages: z.int().optional().default(0),
-})
-
-/**
- * RBACRole
- */
-export const zRbacRole = z.object({
- category: z.string().optional().default(''),
- description: z.string().optional().default(''),
- id: z.string(),
- is_builtin: z.boolean().optional().default(false),
- name: z.string(),
- permission_keys: z.array(z.string()).optional(),
- role_tag: z.string().optional().default(''),
- tenant_id: z.string().nullish(),
- type: z.string(),
-})
-
-/**
- * MemberRolesResponse
- */
-export const zMemberRolesResponse = z.object({
- account_id: z.string(),
- roles: z.array(zRbacRole).optional(),
-})
-
/**
* WorkspacePermissionSnapshot
*/
@@ -4954,7 +4978,7 @@ export const zGetWorkspacesCurrentPluginByCategoryListResponse = zPluginCategory
/**
* Success
*/
-export const zGetWorkspacesCurrentRbacAccessPoliciesResponse = z.record(z.string(), z.unknown())
+export const zGetWorkspacesCurrentRbacAccessPoliciesResponse = zAccessPolicyList
export const zPostWorkspacesCurrentRbacAccessPoliciesBody = zAccessPolicyCreateRequest
@@ -4970,10 +4994,7 @@ export const zDeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdPath = z.object
/**
* Success
*/
-export const zDeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse = z.record(
- z.string(),
- z.unknown(),
-)
+export const zDeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse = zSimpleResultResponse
export const zGetWorkspacesCurrentRbacAccessPoliciesByPolicyIdPath = z.object({
policy_id: z.uuid(),
@@ -4982,10 +5003,7 @@ export const zGetWorkspacesCurrentRbacAccessPoliciesByPolicyIdPath = z.object({
/**
* Success
*/
-export const zGetWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse = z.record(
- z.string(),
- z.unknown(),
-)
+export const zGetWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse = zAccessPolicy
export const zPutWorkspacesCurrentRbacAccessPoliciesByPolicyIdBody = zAccessPolicyUpdateRequest
@@ -5003,12 +5021,9 @@ export const zPostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyPath = z.obje
})
/**
- * Success
+ * Policy copied
*/
-export const zPostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyResponse = z.record(
- z.string(),
- z.unknown(),
-)
+export const zPostWorkspacesCurrentRbacAccessPoliciesByPolicyIdCopyResponse = zAccessPolicy
export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockPath = z.object({
binding_id: z.uuid(),
@@ -5017,10 +5032,8 @@ export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockPath =
/**
* Success
*/
-export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockResponse = z.record(
- z.string(),
- z.unknown(),
-)
+export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdLockResponse =
+ zAccessPolicyBindingState
export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockPath = z.object({
binding_id: z.uuid(),
@@ -5029,10 +5042,8 @@ export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockPath
/**
* Success
*/
-export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockResponse = z.record(
- z.string(),
- z.unknown(),
-)
+export const zPutWorkspacesCurrentRbacAccessPolicyBindingsByBindingIdUnlockResponse =
+ zAccessPolicyBindingState
export const zDeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsBody =
zDeleteMemberBindingsRequest
@@ -5047,7 +5058,7 @@ export const zDeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyId
* Success
*/
export const zDeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsResponse =
- zMemberBindingsResponse
+ zSimpleResultResponse
export const zGetWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsPath =
z.object({
@@ -5161,7 +5172,7 @@ export const zDeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemb
* Success
*/
export const zDeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsResponse =
- zMemberBindingsResponse
+ zSimpleResultResponse
export const zGetWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsPath =
z.object({
@@ -5274,7 +5285,7 @@ export const zDeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPoli
* Success
*/
export const zDeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsResponse =
- zMemberBindingsResponse
+ zSimpleResultResponse
export const zGetWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsPath =
z.object({
@@ -5425,12 +5436,12 @@ export const zGetWorkspacesCurrentRbacRolePermissionsCatalogDatasetResponse =
/**
* Success
*/
-export const zGetWorkspacesCurrentRbacRolesResponse = z.record(z.string(), z.unknown())
+export const zGetWorkspacesCurrentRbacRolesResponse = zRbacRoleList
/**
- * Success
+ * Role created
*/
-export const zPostWorkspacesCurrentRbacRolesResponse = z.record(z.string(), z.unknown())
+export const zPostWorkspacesCurrentRbacRolesResponse = zRbacRole
export const zDeleteWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
role_id: z.uuid(),
@@ -5439,7 +5450,7 @@ export const zDeleteWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
/**
* Success
*/
-export const zDeleteWorkspacesCurrentRbacRolesByRoleIdResponse = z.record(z.string(), z.unknown())
+export const zDeleteWorkspacesCurrentRbacRolesByRoleIdResponse = zSimpleResultResponse
export const zGetWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
role_id: z.uuid(),
@@ -5448,7 +5459,7 @@ export const zGetWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
/**
* Success
*/
-export const zGetWorkspacesCurrentRbacRolesByRoleIdResponse = z.record(z.string(), z.unknown())
+export const zGetWorkspacesCurrentRbacRolesByRoleIdResponse = zRbacRole
export const zPutWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
role_id: z.uuid(),
@@ -5457,16 +5468,16 @@ export const zPutWorkspacesCurrentRbacRolesByRoleIdPath = z.object({
/**
* Success
*/
-export const zPutWorkspacesCurrentRbacRolesByRoleIdResponse = z.record(z.string(), z.unknown())
+export const zPutWorkspacesCurrentRbacRolesByRoleIdResponse = zRbacRole
export const zPostWorkspacesCurrentRbacRolesByRoleIdCopyPath = z.object({
role_id: z.uuid(),
})
/**
- * Success
+ * Role copied
*/
-export const zPostWorkspacesCurrentRbacRolesByRoleIdCopyResponse = z.record(z.string(), z.unknown())
+export const zPostWorkspacesCurrentRbacRolesByRoleIdCopyResponse = zRbacRole
export const zGetWorkspacesCurrentRbacRolesByRoleIdMembersPath = z.object({
role_id: z.uuid(),
diff --git a/packages/contracts/rbac-response.test.ts b/packages/contracts/rbac-response.test.ts
new file mode 100644
index 00000000000..1cdbfa50c1e
--- /dev/null
+++ b/packages/contracts/rbac-response.test.ts
@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vite-plus/test'
+import {
+ zDeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse,
+ zDeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ zDeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ zDeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ zDeleteWorkspacesCurrentRbacRolesByRoleIdResponse,
+} from './generated/api/console/workspaces/zod.gen.ts'
+
+describe('generated RBAC delete responses', () => {
+ it.each([
+ ['role', zDeleteWorkspacesCurrentRbacRolesByRoleIdResponse],
+ ['policy', zDeleteWorkspacesCurrentRbacAccessPoliciesByPolicyIdResponse],
+ [
+ 'agent member binding',
+ zDeleteWorkspacesCurrentRbacAgentsByAgentIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ ],
+ [
+ 'app member binding',
+ zDeleteWorkspacesCurrentRbacAppsByAppIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ ],
+ [
+ 'dataset member binding',
+ zDeleteWorkspacesCurrentRbacDatasetsByDatasetIdAccessPoliciesByPolicyIdMemberBindingsResponse,
+ ],
+ ])('validates the %s success payload', (_name, response) => {
+ expect(response.parse({ result: 'success' })).toEqual({ result: 'success' })
+ expect(response.safeParse({}).success).toBe(false)
+ })
+})
diff --git a/web/features/home/home-content/__tests__/home-content.spec.tsx b/web/features/home/home-content/__tests__/home-content.spec.tsx
index 2dedc7f0940..05ac7f68c6c 100644
--- a/web/features/home/home-content/__tests__/home-content.spec.tsx
+++ b/web/features/home/home-content/__tests__/home-content.spec.tsx
@@ -13,7 +13,7 @@ import type { DeploymentEdition } from '@dify/contracts/api/console/system-featu
import type { ReactNode } from 'react'
import type { CreateAppModalProps } from '@/app/components/explore/create-app-modal'
import type { StepByStepTourSessionState } from '@/app/components/step-by-step-tour/types'
-import { act, fireEvent, screen, waitFor } from '@testing-library/react'
+import { fireEvent, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { createStore, Provider as JotaiProvider, useSetAtom } from 'jotai'
import { queryClientAtom } from 'jotai-tanstack-query'
@@ -838,7 +838,8 @@ describe('HomeContent', () => {
).not.toBeInTheDocument()
})
- it('should render learn dify templates without badges or template metadata', () => {
+ it('should render learn dify templates without badges or template metadata', async () => {
+ vi.useRealTimers()
mockExploreData = {
categories: ['Writing'],
allList: [createApp()],
@@ -846,7 +847,9 @@ describe('HomeContent', () => {
renderHomeContent()
- const learnDifyHeading = screen.getByRole('heading', { name: 'explore.learnDify.title' })
+ const learnDifyHeading = await screen.findByRole('heading', {
+ name: 'explore.learnDify.title',
+ })
expect(learnDifyHeading).toBeInTheDocument()
expect(learnDifyHeading.closest('section')).toHaveAttribute(
'data-step-by-step-tour-target',
@@ -878,6 +881,7 @@ describe('HomeContent', () => {
})
it('should collapse learn dify and persist hidden state when hide is clicked', async () => {
+ vi.useRealTimers()
mockExploreData = {
categories: ['Writing'],
allList: [createApp()],
@@ -885,21 +889,16 @@ describe('HomeContent', () => {
renderHomeContent()
- fireEvent.click(screen.getByRole('button', { name: 'explore.learnDify.hide' }))
-
- const learnDifySection = screen
- .getByRole('heading', { name: 'explore.learnDify.title' })
- .closest('section')
- expect(learnDifySection).toHaveClass('z-50', 'opacity-20')
- expect(learnDifySection).toHaveStyle({ transform: 'scale(0.08)' })
+ const hideButton = await screen.findByRole('button', { name: 'explore.learnDify.hide' })
+ const user = userEvent.setup()
+ await user.click(hideButton)
- await act(async () => {
- await vi.advanceTimersByTimeAsync(800)
+ await waitFor(() => {
+ expect(
+ screen.queryByRole('heading', { name: 'explore.learnDify.title' }),
+ ).not.toBeInTheDocument()
})
- expect(
- screen.queryByRole('heading', { name: 'explore.learnDify.title' }),
- ).not.toBeInTheDocument()
expect(localStorage.getItem(LEARN_DIFY_HIDDEN_STORAGE_KEY)).toBe('true')
})
})