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.

18.2 KB
Raw Blame
import logging
from http import HTTPStatus
from urllib.parse import quote
from uuid import UUID

from flask import Response, request
from flask_restx import Resource
from sqlalchemy.orm import Session
from werkzeug.exceptions import BadRequest, NotFound

from controllers.common.errors import InvalidArgumentError
from controllers.common.fields import TextFileResponse
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.app.wraps import with_session
from controllers.console.snippets.payloads import (
    CreateSnippetPayload,
    SnippetExportQuery,
    SnippetImportPayload,
    SnippetListQuery,
    UpdateSnippetPayload,
)
from controllers.console.wraps import (
    RBACPermission,
    account_initialization_required,
    edit_permission_required,
    model_validate,
    rbac_permission_required,
    setup_required,
    with_current_tenant_id,
    with_current_user,
)
from core.db.session_factory import session_factory
from core.plugin.entities.plugin import PluginDependency
from extensions.ext_application_services import application_services
from fields.base import ResponseModel
from fields.snippet_fields import (
    SnippetListItemResponse,
    SnippetPaginationResponse,
    SnippetResponse,
    snippet_list_item_responses,
    snippet_response,
)
from libs.helper import dump_response
from libs.login import login_required
from models import Account
from models.snippet import SnippetType
from services.entities.dsl_entities import DslImportWarning
from services.snippet_dsl_service import ImportStatus, SnippetDslService
from services.snippet_service import SnippetService

logger = logging.getLogger(__name__)


class SnippetImportResponse(ResponseModel):
    id: str
    status: ImportStatus
    snippet_id: str | None
    current_dsl_version: str
    imported_dsl_version: str
    error: str
    warnings: list[DslImportWarning]


class SnippetDependencyCheckResponse(ResponseModel):
    leaked_dependencies: list[PluginDependency]


class SnippetUseCountResponse(ResponseModel):
    result: str
    use_count: int


def _snippet_service(session: Session | None = None) -> SnippetService:
    if session is not None:
        return SnippetService(session=session)
    return SnippetService(session_factory.get_session_maker())


def _snippet_list_query_from_request() -> SnippetListQuery:
    query_data: dict[str, str | list[str]] = dict(request.args.to_dict())
    query_data["tag_ids"] = request.args.getlist("tag_ids")

    creator_ids = request.args.getlist("creators") or request.args.getlist("creator_ids")
    if creator_ids:
        query_data["creators"] = creator_ids

    return SnippetListQuery.model_validate(query_data)


# Register Pydantic models with Swagger
register_schema_models(
    console_ns,
    SnippetListQuery,
    CreateSnippetPayload,
    UpdateSnippetPayload,
    SnippetImportPayload,
    SnippetExportQuery,
)
register_response_schema_models(
    console_ns,
    TextFileResponse,
    SnippetImportResponse,
    SnippetDependencyCheckResponse,
    SnippetUseCountResponse,
    SnippetListItemResponse,
    SnippetResponse,
    SnippetPaginationResponse,
)


@console_ns.route("/workspaces/current/customized-snippets")
class CustomizedSnippetsApi(Resource):
    @console_ns.doc("list_customized_snippets")
    @console_ns.doc(params=query_params_from_model(SnippetListQuery))
    @console_ns.response(
        HTTPStatus.OK, "Snippets retrieved successfully", console_ns.models[SnippetPaginationResponse.__name__]
    )
    @setup_required
    @login_required
    @account_initialization_required
    @with_current_tenant_id
    @with_session(write=False)
    def get(self, session: Session, current_tenant_id: str):
        """List customized snippets with pagination and search."""
        query = _snippet_list_query_from_request()

        snippet_service = _snippet_service(session)
        snippets, total, has_more = snippet_service.get_snippets(
            tenant_id=current_tenant_id,
            session=session,
            page=query.page,
            limit=query.limit,
            keyword=query.keyword,
            is_published=query.is_published,
            creators=query.creators,
            tag_ids=query.tag_ids,
            tags=application_services().tags,
        )

        return dump_response(
            SnippetPaginationResponse,
            {
                "data": snippet_list_item_responses(snippets, session=session),
                "page": query.page,
                "limit": query.limit,
                "total": total,
                "has_more": has_more,
            },
        ), HTTPStatus.OK

    @console_ns.doc("create_customized_snippet")
    @console_ns.expect(console_ns.models.get(CreateSnippetPayload.__name__))
    @console_ns.response(201, "Snippet created successfully", console_ns.models[SnippetResponse.__name__])
    @console_ns.response(400, "Invalid request")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_user
    @with_current_tenant_id
    @with_session
    @model_validate(CreateSnippetPayload)
    def post(
        self,
        req_data: CreateSnippetPayload,
        session: Session,
        current_tenant_id: str,
        current_user: Account,
    ):
        """Create a new customized snippet."""
        try:
            snippet_type = SnippetType(req_data.type)
        except ValueError:
            snippet_type = SnippetType.NODE

        try:
            if req_data.graph is not None:
                SnippetService.validate_snippet_graph_forbidden_nodes(req_data.graph)

            snippet_service = _snippet_service(session)
            snippet = snippet_service.create_snippet(
                tenant_id=current_tenant_id,
                name=req_data.name,
                description=req_data.description,
                snippet_type=snippet_type,
                icon_info=req_data.icon_info.model_dump() if req_data.icon_info else None,
                input_fields=[f.model_dump() for f in req_data.input_fields] if req_data.input_fields else None,
                account=current_user,
            )
        except ValueError as e:
            raise InvalidArgumentError(str(e)) from e

        return dump_response(SnippetResponse, snippet_response(snippet, session=session)), 201


@console_ns.route("/workspaces/current/customized-snippets/<uuid:snippet_id>")
class CustomizedSnippetDetailApi(Resource):
    @console_ns.doc("get_customized_snippet")
    @console_ns.response(200, "Snippet retrieved successfully", console_ns.models[SnippetResponse.__name__])
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @with_current_tenant_id
    @with_session(write=False)
    def get(self, session: Session, current_tenant_id: str, snippet_id: UUID):
        """Get customized snippet details."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=str(snippet_id),
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        return dump_response(SnippetResponse, snippet_response(snippet, session=session)), 200

    @console_ns.doc("update_customized_snippet")
    @console_ns.expect(console_ns.models.get(UpdateSnippetPayload.__name__))
    @console_ns.response(200, "Snippet updated successfully", console_ns.models[SnippetResponse.__name__])
    @console_ns.response(400, "Invalid request")
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_user
    @with_current_tenant_id
    @with_session
    @model_validate(UpdateSnippetPayload)
    def patch(
        self,
        req_data: UpdateSnippetPayload,
        session: Session,
        current_tenant_id: str,
        current_user: Account,
        snippet_id: str,
    ):
        """Update customized snippet."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=snippet_id,
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        update_data = req_data.model_dump(exclude_unset=True)

        if "icon_info" in update_data and update_data["icon_info"] is not None:
            update_data["icon_info"] = req_data.icon_info.model_dump() if req_data.icon_info else None

        if not update_data:
            raise InvalidArgumentError("No valid fields to update")

        try:
            snippet = session.merge(snippet)
            snippet = SnippetService.update_snippet(
                session=session,
                snippet=snippet,
                account_id=current_user.id,
                data=update_data,
            )
            session.commit()
        except ValueError as e:
            # Raise rather than return: `with_session` commits on a normal return, so returning here
            # would persist whatever the update wrote before it rejected the payload. Raising routes
            # through the decorator's rollback. Status stays 400 and `message` is unchanged; the body
            # picks up the standard error envelope, as on every other BadRequest in the console API.
            raise BadRequest(str(e)) from e

        return dump_response(SnippetResponse, snippet_response(snippet, session=session)), 200

    @console_ns.doc("delete_customized_snippet")
    @console_ns.response(204, "Snippet deleted successfully")
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_MANAGE, Workspace()))
    @with_current_user
    @with_current_tenant_id
    @with_session
    def delete(self, session: Session, current_tenant_id: str, current_user: Account, snippet_id: str):
        """Delete customized snippet."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=snippet_id,
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        SnippetService.delete_snippet(
            session=session,
            snippet=snippet,
            account_id=current_user.id,
        )

        return "", 204


@console_ns.route("/workspaces/current/customized-snippets/<uuid:snippet_id>/export")
class CustomizedSnippetExportApi(Resource):
    @console_ns.doc("export_customized_snippet")
    @console_ns.doc(description="Export snippet configuration as DSL")
    @console_ns.doc(params={"snippet_id": "Snippet ID to export"})
    @console_ns.doc(params=query_params_from_model(SnippetExportQuery))
    @console_ns.response(200, "Snippet exported successfully", console_ns.models[TextFileResponse.__name__])
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_tenant_id
    @with_session(write=False)
    def get(self, session: Session, current_tenant_id: str, snippet_id: str):
        """Export snippet as DSL."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=snippet_id,
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        # Get include_secret parameter
        query = SnippetExportQuery.model_validate(request.args.to_dict())

        export_service = SnippetDslService(session)
        try:
            result = export_service.export_snippet_dsl(
                snippet=snippet,
                include_secret=query.include_secret == "true",
                workflow_id=query.workflow_id,
            )
        except ValueError as exc:
            raise NotFound(str(exc)) from exc

        # Set filename with .snippet extension
        filename = f"{snippet.name}.snippet"
        encoded_filename = quote(filename)

        response = Response(
            result,
            mimetype="application/x-yaml",
        )
        response.headers["Content-Disposition"] = f"attachment; filename*=UTF-8''{encoded_filename}"
        response.headers["Content-Type"] = "application/x-yaml"

        return response


@console_ns.route("/workspaces/current/customized-snippets/imports")
class CustomizedSnippetImportApi(Resource):
    @console_ns.doc("import_customized_snippet")
    @console_ns.doc(description="Import snippet from DSL")
    @console_ns.expect(console_ns.models.get(SnippetImportPayload.__name__))
    @console_ns.response(200, "Snippet imported successfully", console_ns.models[SnippetImportResponse.__name__])
    @console_ns.response(202, "Import pending confirmation", console_ns.models[SnippetImportResponse.__name__])
    @console_ns.response(400, "Import failed", console_ns.models[SnippetImportResponse.__name__])
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_user
    @with_session
    @model_validate(SnippetImportPayload)
    def post(self, req_data: SnippetImportPayload, session: Session, current_user: Account):
        """Import snippet from DSL."""
        import_service = SnippetDslService(session)
        result = import_service.import_snippet(
            account=current_user,
            import_mode=req_data.mode,
            yaml_content=req_data.yaml_content,
            yaml_url=req_data.yaml_url,
            snippet_id=req_data.snippet_id,
            name=req_data.name,
            description=req_data.description,
        )

        # Return appropriate status code based on result
        status = result.status
        if status == ImportStatus.FAILED:
            return result.model_dump(mode="json"), 400
        elif status == ImportStatus.PENDING:
            return result.model_dump(mode="json"), 202
        return result.model_dump(mode="json"), 200


@console_ns.route("/workspaces/current/customized-snippets/imports/<string:import_id>/confirm")
class CustomizedSnippetImportConfirmApi(Resource):
    @console_ns.doc("confirm_snippet_import")
    @console_ns.doc(description="Confirm a pending snippet import")
    @console_ns.doc(params={"import_id": "Import ID to confirm"})
    @console_ns.response(200, "Import confirmed successfully", console_ns.models[SnippetImportResponse.__name__])
    @console_ns.response(400, "Import failed", console_ns.models[SnippetImportResponse.__name__])
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_user
    @with_session
    def post(self, session: Session, current_user: Account, import_id: str):
        """Confirm a pending snippet import."""
        import_service = SnippetDslService(session)
        result = import_service.confirm_import(import_id=import_id, account=current_user)

        if result.status == ImportStatus.FAILED:
            return result.model_dump(mode="json"), 400
        return result.model_dump(mode="json"), 200


@console_ns.route("/workspaces/current/customized-snippets/<uuid:snippet_id>/check-dependencies")
class CustomizedSnippetCheckDependenciesApi(Resource):
    @console_ns.doc("check_snippet_dependencies")
    @console_ns.doc(description="Check dependencies for a snippet")
    @console_ns.doc(params={"snippet_id": "Snippet ID"})
    @console_ns.response(
        200,
        "Dependencies checked successfully",
        console_ns.models[SnippetDependencyCheckResponse.__name__],
    )
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @rbac_permission_required(RBACCheck(RBACPermission.SNIPPETS_CREATE_AND_MODIFY, Workspace()))
    @with_current_tenant_id
    @with_session(write=False)
    def get(self, session: Session, current_tenant_id: str, snippet_id: str):
        """Check dependencies for a snippet."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=snippet_id,
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        import_service = SnippetDslService(session)
        result = import_service.check_dependencies(snippet=snippet)

        return result.model_dump(mode="json"), 200


@console_ns.route("/workspaces/current/customized-snippets/<uuid:snippet_id>/use-count/increment")
class CustomizedSnippetUseCountIncrementApi(Resource):
    @console_ns.doc("increment_snippet_use_count")
    @console_ns.doc(description="Increment snippet use count by 1")
    @console_ns.doc(params={"snippet_id": "Snippet ID"})
    @console_ns.response(200, "Use count incremented successfully", console_ns.models[SnippetUseCountResponse.__name__])
    @console_ns.response(404, "Snippet not found")
    @setup_required
    @login_required
    @account_initialization_required
    @edit_permission_required
    @with_current_tenant_id
    @with_session
    def post(self, session: Session, current_tenant_id: str, snippet_id: str):
        """Increment snippet use count when it is inserted into a workflow."""
        snippet_service = _snippet_service(session)
        snippet = snippet_service.get_snippet_by_id(
            snippet_id=snippet_id,
            tenant_id=current_tenant_id,
        )

        if not snippet:
            raise NotFound("Snippet not found")

        SnippetService.increment_use_count(session=session, snippet=snippet)
        session.flush()

        return {"result": "success", "use_count": snippet.use_count}, 200