mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-08-01 02:46:02 +00:00
* feat(skills): per-user skill isolation (#2905) Implement user-scoped skill storage that isolates custom skills between users while sharing public skills globally. Key changes: - Add UserScopedSkillStorage class for per-user custom skill directories - Introduce get_or_new_user_skill_storage() factory with user_id context - Auth middleware sets effective_user_id for request-scoped storage - Agent/prompt/middleware now use user-scoped storage and prompt cache - Sandbox mounts user-scoped skill directories for search/read tools - Add validate_skill_file_path() to SkillStorage for path security - Migration script supports --all-users bulk migration - Frontend: add editable field to Skill type, error check in enableSkill - All skill categories can be toggled (custom skills default to enabled) - Update skill-creator SKILL.md with isolation-aware instructions Tests: - Add test_user_scoped_skill_storage.py (new) - Update all existing skill tests for user-scoped storage - Update sandbox, client, and router tests * fix(skills): address second-round PR review feedback (#3889) - P1-1: restrict legacy skill mount to users without custom skills - P1-2: fail-closed for _is_disabled_skill_path (OSError → return True) - P2-1: AND-merge global extensions_config skill disabled state - P2-2: atomic write for _skill_states.json (mkstemp + replace) - P2-3: normalize X-DeerFlow-Owner-User-Id in trusted boundary - P2-4: LRU-bounded _enabled_skills_by_config_cache (OrderedDict, maxsize=256) - P2-5: clear global prompt cache on PUBLIC skill toggle - P2-6: invalidate skill caches on client.update_skill * fix(tests): correct tool policy test after merge * fix(skills): use DEFAULT_SKILLS_CONTAINER_PATH in UserScopedSkillStorage The "/mnt/skills" literal in UserScopedSkillStorage.__init__ triggers test_skill_container_path_defaults::test_mnt_skills_literal_is_owned_by_skill_constants_module on CI. Migrate the default to the existing deerflow.constants constant, matching the pattern already used by LocalSkillStorage, SkillStorage, and the durable/tool_error middlewares. --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
429 lines
21 KiB
Python
429 lines
21 KiB
Python
import asyncio
|
|
import json
|
|
import logging
|
|
from pathlib import Path
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, Request
|
|
from pydantic import BaseModel, Field
|
|
|
|
from app.gateway.deps import get_config, require_admin_user
|
|
from app.gateway.path_utils import resolve_thread_virtual_path
|
|
from deerflow.agents.lead_agent.prompt import clear_skills_system_prompt_cache, refresh_user_skills_system_prompt_cache_async
|
|
from deerflow.config.app_config import AppConfig
|
|
from deerflow.config.extensions_config import ExtensionsConfig, SkillStateConfig, get_extensions_config, reload_extensions_config
|
|
from deerflow.runtime.user_context import get_effective_user_id
|
|
from deerflow.skills import Skill
|
|
from deerflow.skills.installer import SkillAlreadyExistsError
|
|
from deerflow.skills.security_scanner import scan_skill_content
|
|
from deerflow.skills.storage import SkillStorage, get_or_new_user_skill_storage
|
|
from deerflow.skills.types import SKILL_MD_FILE, SkillCategory
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
router = APIRouter(prefix="/api", tags=["skills"])
|
|
|
|
_ADMIN_REQUIRED_DETAIL = "Admin privileges required to manage skills."
|
|
|
|
|
|
class SkillResponse(BaseModel):
|
|
"""Response model for skill information."""
|
|
|
|
name: str = Field(..., description="Name of the skill")
|
|
description: str = Field(..., description="Description of what the skill does")
|
|
license: str | None = Field(None, description="License information")
|
|
category: SkillCategory = Field(..., description="Category of the skill (public, custom, or legacy)")
|
|
enabled: bool = Field(default=True, description="Whether this skill is enabled")
|
|
editable: bool = Field(default=False, description="Whether this skill can be edited/deleted (true only for custom)")
|
|
|
|
|
|
class SkillsListResponse(BaseModel):
|
|
"""Response model for listing all skills."""
|
|
|
|
skills: list[SkillResponse]
|
|
|
|
|
|
class SkillUpdateRequest(BaseModel):
|
|
"""Request model for updating a skill."""
|
|
|
|
enabled: bool = Field(..., description="Whether to enable or disable the skill")
|
|
|
|
|
|
class SkillInstallRequest(BaseModel):
|
|
"""Request model for installing a skill from a .skill file."""
|
|
|
|
thread_id: str = Field(..., description="The thread ID where the .skill file is located")
|
|
path: str = Field(..., description="Virtual path to the .skill file (e.g., mnt/user-data/outputs/my-skill.skill)")
|
|
|
|
|
|
class SkillInstallResponse(BaseModel):
|
|
"""Response model for skill installation."""
|
|
|
|
success: bool = Field(..., description="Whether the installation was successful")
|
|
skill_name: str = Field(..., description="Name of the installed skill")
|
|
message: str = Field(..., description="Installation result message")
|
|
|
|
|
|
class CustomSkillContentResponse(SkillResponse):
|
|
content: str = Field(..., description="Raw SKILL.md content")
|
|
|
|
|
|
class CustomSkillUpdateRequest(BaseModel):
|
|
content: str = Field(..., description="Replacement SKILL.md content")
|
|
|
|
|
|
class CustomSkillHistoryResponse(BaseModel):
|
|
history: list[dict]
|
|
|
|
|
|
class SkillRollbackRequest(BaseModel):
|
|
history_index: int = Field(default=-1, description="History entry index to restore from, defaulting to the latest change.")
|
|
|
|
|
|
def _skill_to_response(skill: Skill) -> SkillResponse:
|
|
"""Convert a Skill object to a SkillResponse."""
|
|
return SkillResponse(
|
|
name=skill.name,
|
|
description=skill.description,
|
|
license=skill.license,
|
|
category=skill.category,
|
|
enabled=skill.enabled,
|
|
editable=skill.category == SkillCategory.CUSTOM,
|
|
)
|
|
|
|
|
|
def _get_user_skill_storage(config: AppConfig) -> SkillStorage:
|
|
"""Return a user-scoped skill storage for custom skill operations.
|
|
|
|
Uses the effective user_id from the request context (set by auth middleware).
|
|
For public skill reads, the global singleton storage is still used.
|
|
"""
|
|
return get_or_new_user_skill_storage(get_effective_user_id(), app_config=config)
|
|
|
|
|
|
@router.get(
|
|
"/skills",
|
|
response_model=SkillsListResponse,
|
|
summary="List All Skills",
|
|
description="Retrieve a list of all available skills from both public and custom directories.",
|
|
)
|
|
async def list_skills(config: AppConfig = Depends(get_config)) -> SkillsListResponse:
|
|
try:
|
|
# Use user-scoped storage: loads public (global) + custom (user-level + fallback)
|
|
skills = _get_user_skill_storage(config).load_skills(enabled_only=False)
|
|
return SkillsListResponse(skills=[_skill_to_response(skill) for skill in skills])
|
|
except Exception as e:
|
|
logger.error(f"Failed to load skills: {e}", exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to load skills: {str(e)}")
|
|
|
|
|
|
@router.post(
|
|
"/skills/install",
|
|
response_model=SkillInstallResponse,
|
|
summary="Install Skill",
|
|
description="Install a skill from a .skill file (ZIP archive) located in the thread's user-data directory.",
|
|
)
|
|
async def install_skill(request: Request, body: SkillInstallRequest, config: AppConfig = Depends(get_config)) -> SkillInstallResponse:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
skill_file_path = resolve_thread_virtual_path(body.thread_id, body.path)
|
|
result = await _get_user_skill_storage(config).ainstall_skill_from_archive(skill_file_path)
|
|
await refresh_user_skills_system_prompt_cache_async(get_effective_user_id())
|
|
return SkillInstallResponse(**result)
|
|
except FileNotFoundError as e:
|
|
raise HTTPException(status_code=404, detail=str(e))
|
|
except SkillAlreadyExistsError as e:
|
|
raise HTTPException(status_code=409, detail=str(e))
|
|
except ValueError as e:
|
|
raise HTTPException(status_code=400, detail=str(e))
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Failed to install skill: {e}", exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to install skill: {str(e)}")
|
|
|
|
|
|
@router.get("/skills/custom", response_model=SkillsListResponse, summary="List Custom Skills")
|
|
async def list_custom_skills(config: AppConfig = Depends(get_config)) -> SkillsListResponse:
|
|
"""List only user-owned custom skills (SkillCategory.CUSTOM).
|
|
|
|
Legacy shared skills (SkillCategory.LEGACY) are NOT included here —
|
|
they are read-only and appear in the full ``list_skills`` endpoint.
|
|
The frontend should use ``list_skills`` to display all available
|
|
skills including legacy ones.
|
|
"""
|
|
try:
|
|
skills = [skill for skill in _get_user_skill_storage(config).load_skills(enabled_only=False) if skill.category == SkillCategory.CUSTOM]
|
|
return SkillsListResponse(skills=[_skill_to_response(skill) for skill in skills])
|
|
except Exception as e:
|
|
logger.error("Failed to list custom skills: %s", e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to list custom skills: {str(e)}")
|
|
|
|
|
|
@router.get("/skills/custom/{skill_name}", response_model=CustomSkillContentResponse, summary="Get Custom Skill Content")
|
|
async def get_custom_skill(skill_name: str, request: Request, config: AppConfig = Depends(get_config)) -> CustomSkillContentResponse:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
return await _read_custom_skill_response(skill_name, config)
|
|
|
|
|
|
async def _read_custom_skill_response(skill_name: str, config: AppConfig) -> CustomSkillContentResponse:
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
storage = _get_user_skill_storage(config)
|
|
skills = storage.load_skills(enabled_only=False)
|
|
skill = next((s for s in skills if s.name == skill_name and s.category == SkillCategory.CUSTOM), None)
|
|
if skill is None:
|
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
|
return CustomSkillContentResponse(**_skill_to_response(skill).model_dump(), content=storage.read_custom_skill(skill_name))
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error("Failed to get custom skill %s: %s", skill_name, e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to get custom skill: {str(e)}")
|
|
|
|
|
|
@router.put("/skills/custom/{skill_name}", response_model=CustomSkillContentResponse, summary="Edit Custom Skill")
|
|
async def update_custom_skill(skill_name: str, body: CustomSkillUpdateRequest, request: Request, config: AppConfig = Depends(get_config)) -> CustomSkillContentResponse:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
storage = _get_user_skill_storage(config)
|
|
storage.ensure_custom_skill_is_editable(skill_name)
|
|
storage.validate_skill_markdown_content(skill_name, body.content)
|
|
scan = await scan_skill_content(body.content, executable=False, location=f"{skill_name}/{SKILL_MD_FILE}", app_config=config)
|
|
if scan.decision == "block":
|
|
raise HTTPException(status_code=400, detail=f"Security scan blocked the edit: {scan.reason}")
|
|
prev_content = storage.read_custom_skill(skill_name)
|
|
storage.write_custom_skill(skill_name, SKILL_MD_FILE, body.content)
|
|
storage.append_history(
|
|
skill_name,
|
|
{
|
|
"action": "human_edit",
|
|
"author": "human",
|
|
"thread_id": None,
|
|
"file_path": SKILL_MD_FILE,
|
|
"prev_content": prev_content,
|
|
"new_content": body.content,
|
|
"scanner": {"decision": scan.decision, "reason": scan.reason},
|
|
},
|
|
)
|
|
await refresh_user_skills_system_prompt_cache_async(get_effective_user_id())
|
|
return await _read_custom_skill_response(skill_name, config)
|
|
except HTTPException:
|
|
raise
|
|
except FileNotFoundError as e:
|
|
raise HTTPException(status_code=404, detail=str(e))
|
|
except ValueError as e:
|
|
raise HTTPException(status_code=400, detail=str(e))
|
|
except Exception as e:
|
|
logger.error("Failed to update custom skill %s: %s", skill_name, e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to update custom skill: {str(e)}")
|
|
|
|
|
|
@router.delete("/skills/custom/{skill_name}", summary="Delete Custom Skill")
|
|
async def delete_custom_skill(skill_name: str, request: Request, config: AppConfig = Depends(get_config)) -> dict[str, bool]:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
storage = _get_user_skill_storage(config)
|
|
storage.delete_custom_skill(
|
|
skill_name,
|
|
history_meta={
|
|
"action": "human_delete",
|
|
"author": "human",
|
|
"thread_id": None,
|
|
"file_path": SKILL_MD_FILE,
|
|
"prev_content": None,
|
|
"new_content": None,
|
|
"scanner": {"decision": "allow", "reason": "Deletion requested."},
|
|
},
|
|
)
|
|
await refresh_user_skills_system_prompt_cache_async(get_effective_user_id())
|
|
return {"success": True}
|
|
except FileNotFoundError as e:
|
|
raise HTTPException(status_code=404, detail=str(e))
|
|
except ValueError as e:
|
|
raise HTTPException(status_code=400, detail=str(e))
|
|
except Exception as e:
|
|
logger.error("Failed to delete custom skill %s: %s", skill_name, e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to delete custom skill: {str(e)}")
|
|
|
|
|
|
@router.get("/skills/custom/{skill_name}/history", response_model=CustomSkillHistoryResponse, summary="Get Custom Skill History")
|
|
async def get_custom_skill_history(skill_name: str, request: Request, config: AppConfig = Depends(get_config)) -> CustomSkillHistoryResponse:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
storage = _get_user_skill_storage(config)
|
|
if not storage.custom_skill_exists(skill_name) and not storage.get_skill_history_file(skill_name).exists():
|
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
|
return CustomSkillHistoryResponse(history=storage.read_history(skill_name))
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error("Failed to read history for %s: %s", skill_name, e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to read history: {str(e)}")
|
|
|
|
|
|
@router.post("/skills/custom/{skill_name}/rollback", response_model=CustomSkillContentResponse, summary="Rollback Custom Skill")
|
|
async def rollback_custom_skill(skill_name: str, body: SkillRollbackRequest, request: Request, config: AppConfig = Depends(get_config)) -> CustomSkillContentResponse:
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
storage = _get_user_skill_storage(config)
|
|
if not storage.custom_skill_exists(skill_name) and not storage.get_skill_history_file(skill_name).exists():
|
|
raise HTTPException(status_code=404, detail=f"Custom skill '{skill_name}' not found")
|
|
history = storage.read_history(skill_name)
|
|
if not history:
|
|
raise HTTPException(status_code=400, detail=f"Custom skill '{skill_name}' has no history")
|
|
record = history[body.history_index]
|
|
target_content = record.get("prev_content")
|
|
if target_content is None:
|
|
raise HTTPException(status_code=400, detail="Selected history entry has no previous content to roll back to")
|
|
storage.validate_skill_markdown_content(skill_name, target_content)
|
|
scan = await scan_skill_content(target_content, executable=False, location=f"{skill_name}/{SKILL_MD_FILE}", app_config=config)
|
|
skill_file = storage.get_custom_skill_file(skill_name)
|
|
current_content = skill_file.read_text(encoding="utf-8") if skill_file.exists() else None
|
|
history_entry = {
|
|
"action": "rollback",
|
|
"author": "human",
|
|
"thread_id": None,
|
|
"file_path": SKILL_MD_FILE,
|
|
"prev_content": current_content,
|
|
"new_content": target_content,
|
|
"rollback_from_ts": record.get("ts"),
|
|
"scanner": {"decision": scan.decision, "reason": scan.reason},
|
|
}
|
|
if scan.decision == "block":
|
|
storage.append_history(skill_name, history_entry)
|
|
raise HTTPException(status_code=400, detail=f"Rollback blocked by security scanner: {scan.reason}")
|
|
storage.write_custom_skill(skill_name, SKILL_MD_FILE, target_content)
|
|
storage.append_history(skill_name, history_entry)
|
|
await refresh_user_skills_system_prompt_cache_async(get_effective_user_id())
|
|
return await _read_custom_skill_response(skill_name, config)
|
|
except HTTPException:
|
|
raise
|
|
except IndexError:
|
|
raise HTTPException(status_code=400, detail="history_index is out of range")
|
|
except FileNotFoundError as e:
|
|
raise HTTPException(status_code=404, detail=str(e))
|
|
except ValueError as e:
|
|
raise HTTPException(status_code=400, detail=str(e))
|
|
except Exception as e:
|
|
logger.error("Failed to roll back custom skill %s: %s", skill_name, e, exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to roll back custom skill: {str(e)}")
|
|
|
|
|
|
@router.get(
|
|
"/skills/{skill_name}",
|
|
response_model=SkillResponse,
|
|
summary="Get Skill Details",
|
|
description="Retrieve detailed information about a specific skill by its name.",
|
|
)
|
|
async def get_skill(skill_name: str, config: AppConfig = Depends(get_config)) -> SkillResponse:
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
skills = _get_user_skill_storage(config).load_skills(enabled_only=False)
|
|
skill = next((s for s in skills if s.name == skill_name), None)
|
|
|
|
if skill is None:
|
|
raise HTTPException(status_code=404, detail=f"Skill '{skill_name}' not found")
|
|
|
|
return _skill_to_response(skill)
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Failed to get skill {skill_name}: {e}", exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to get skill: {str(e)}")
|
|
|
|
|
|
@router.put(
|
|
"/skills/{skill_name}",
|
|
response_model=SkillResponse,
|
|
summary="Update Skill",
|
|
description="Update a skill's enabled status by modifying the extensions_config.json file.",
|
|
)
|
|
async def update_skill(skill_name: str, body: SkillUpdateRequest, request: Request, config: AppConfig = Depends(get_config)) -> SkillResponse:
|
|
# Enabling/disabling a skill writes the shared extensions_config.json and
|
|
# refreshes the system prompt for every tenant, so it is a global mutation
|
|
# (there is no per-user skill state). Guard it as admin-only like the other
|
|
# global config writes, matching the MCP router.
|
|
await require_admin_user(request, detail=_ADMIN_REQUIRED_DETAIL)
|
|
try:
|
|
skill_name = skill_name.replace("\r\n", "").replace("\n", "")
|
|
storage = _get_user_skill_storage(config)
|
|
skills = storage.load_skills(enabled_only=False)
|
|
skill = next((s for s in skills if s.name == skill_name), None)
|
|
|
|
if skill is None:
|
|
raise HTTPException(status_code=404, detail=f"Skill '{skill_name}' not found")
|
|
|
|
# PUBLIC skills → global extensions_config.json (shared state).
|
|
# CUSTOM / LEGACY skills → per-user _skill_states.json (isolated state)
|
|
# so that two users with same-named custom skills can toggle independently.
|
|
if skill.category == SkillCategory.PUBLIC:
|
|
config_path = ExtensionsConfig.resolve_config_path()
|
|
if config_path is None:
|
|
config_path = Path.cwd().parent / "extensions_config.json"
|
|
logger.info(f"No existing extensions config found. Creating new config at: {config_path}")
|
|
|
|
extensions_config = get_extensions_config()
|
|
extensions_config.skills[skill_name] = SkillStateConfig(enabled=body.enabled)
|
|
|
|
config_data = {
|
|
"mcpServers": {name: server.model_dump() for name, server in extensions_config.mcp_servers.items()},
|
|
"skills": {name: {"enabled": skill_config.enabled} for name, skill_config in extensions_config.skills.items()},
|
|
}
|
|
|
|
with open(config_path, "w", encoding="utf-8") as f:
|
|
json.dump(config_data, f, indent=2)
|
|
|
|
logger.info(f"Skills configuration updated and saved to: {config_path}")
|
|
reload_extensions_config()
|
|
else:
|
|
# CUSTOM / LEGACY: write per-user state
|
|
from deerflow.skills.storage.user_scoped_skill_storage import UserScopedSkillStorage
|
|
|
|
if isinstance(storage, UserScopedSkillStorage):
|
|
storage.set_skill_enabled_state(skill_name, body.enabled)
|
|
else:
|
|
# Fallback for non-user-scoped storage (unlikely in practice)
|
|
config_path = ExtensionsConfig.resolve_config_path()
|
|
if config_path is None:
|
|
config_path = Path.cwd().parent / "extensions_config.json"
|
|
extensions_config = get_extensions_config()
|
|
extensions_config.skills[skill_name] = SkillStateConfig(enabled=body.enabled)
|
|
config_data = {
|
|
"mcpServers": {name: server.model_dump() for name, server in extensions_config.mcp_servers.items()},
|
|
"skills": {name: {"enabled": skill_config.enabled} for name, skill_config in extensions_config.skills.items()},
|
|
}
|
|
with open(config_path, "w", encoding="utf-8") as f:
|
|
json.dump(config_data, f, indent=2)
|
|
reload_extensions_config()
|
|
|
|
# PUBLIC skill enabled state lives in the global extensions_config.json
|
|
# and affects every user, so the prompt cache for ALL users must be
|
|
# invalidated. CUSTOM/LEGACY skill state is per-user so only that
|
|
# user's cache needs to be dropped.
|
|
if skill.category == SkillCategory.PUBLIC:
|
|
# clear_skills_system_prompt_cache is sync; run it in a worker
|
|
# thread to avoid blocking the event loop. The lock inside it is
|
|
# cheap, but the async drop also keeps the test mock surface
|
|
# consistent (tests patch the async variant).
|
|
await asyncio.to_thread(clear_skills_system_prompt_cache)
|
|
else:
|
|
await refresh_user_skills_system_prompt_cache_async(get_effective_user_id())
|
|
|
|
skills = _get_user_skill_storage(config).load_skills(enabled_only=False)
|
|
updated_skill = next((s for s in skills if s.name == skill_name), None)
|
|
|
|
if updated_skill is None:
|
|
raise HTTPException(status_code=500, detail=f"Failed to reload skill '{skill_name}' after update")
|
|
|
|
logger.info(f"Skill '{skill_name}' enabled status updated to {body.enabled}")
|
|
return _skill_to_response(updated_skill)
|
|
|
|
except HTTPException:
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Failed to update skill {skill_name}: {e}", exc_info=True)
|
|
raise HTTPException(status_code=500, detail=f"Failed to update skill: {str(e)}")
|