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.

fix(snippets): implement delete for published snippet workflow versions (#41003)

chelsealongd7b153143102
diff --git a/api/controllers/console/snippets/snippet_workflow.py b/api/controllers/console/snippets/snippet_workflow.py
index d1399801a06..0c24cb74fea 100644
--- a/api/controllers/console/snippets/snippet_workflow.py
+++ b/api/controllers/console/snippets/snippet_workflow.py
@@ -60,6 +60,7 @@ from models.snippet import CustomizedSnippet
from services.agent.retirement_service import WorkflowAgentRetirementService
from services.agent.workflow_publish_service import WorkflowAgentPublishService
from services.errors.app import IsDraftWorkflowError, WorkflowHashNotEqualError, WorkflowNotFoundError
+from services.errors.workflow_service import DraftWorkflowDeletionError, WorkflowInUseError
from services.snippet_generate_service import SnippetGenerateService
from services.snippet_service import SnippetService
from tasks.collect_agent_resources_task import enqueue_agent_resource_collection
@@ -480,6 +481,39 @@ class SnippetWorkflowByIdApi(Resource):
response["input_fields"] = snippet.input_fields_list
return response
+ @console_ns.doc("delete_snippet_workflow_by_id")
+ @console_ns.doc(description="Delete a published snippet workflow version")
+ @console_ns.doc(params={"snippet_id": "Snippet ID", "workflow_id": "Workflow ID"})
+ @console_ns.response(204, "Workflow deleted successfully")
+ @console_ns.response(400, "Workflow is in use")
+ @console_ns.response(404, "Workflow not found")
+ @setup_required
+ @login_required
+ @account_initialization_required
+ @get_snippet
+ @edit_permission_required
+ @rbac_permission_required(
+ RBACResourceScope.WORKSPACE, RBACPermission.SNIPPETS_CREATE_AND_MODIFY, resource_required=False
+ )
+ def delete(self, snippet: CustomizedSnippet, workflow_id: str):
+ """Delete a published snippet workflow version."""
+ snippet_service = _snippet_service()
+ with _snippet_session_maker().begin() as session:
+ try:
+ snippet_service.delete_workflow(
+ session=session,
+ snippet=snippet,
+ workflow_id=workflow_id,
+ )
+ except WorkflowInUseError as e:
+ raise BadRequest(str(e))
+ except DraftWorkflowDeletionError as e:
+ raise BadRequest(str(e))
+ except ValueError as e:
+ raise NotFound(str(e))
+
+ return None, 204
+
@console_ns.route("/snippets/<uuid:snippet_id>/workflow-runs")
class SnippetWorkflowRunsApi(Resource):
diff --git a/api/openapi/markdown/console-openapi.md b/api/openapi/markdown/console-openapi.md
index 7911475b641..b639479b2e4 100644
--- a/api/openapi/markdown/console-openapi.md
+++ b/api/openapi/markdown/console-openapi.md
@@ -9130,6 +9130,24 @@ Reset a draft workflow variable to its default value (snippet scope)
| 200 | Workflow published successfully | **application/json**: [WorkflowPublishResponse](#workflowpublishresponse)<br> |
| 400 | No draft workflow found | |
+### [DELETE] /snippets/{snippet_id}/workflows/{workflow_id}
+**Delete a published snippet workflow version**
+
+#### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ------ |
+| snippet_id | path | Snippet ID | Yes | string (uuid) |
+| workflow_id | path | Workflow ID | Yes | string |
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 204 | Workflow deleted successfully |
+| 400 | Workflow is in use |
+| 404 | Workflow not found |
+
### [PATCH] /snippets/{snippet_id}/workflows/{workflow_id}
**Update a published snippet workflow version's display metadata**
diff --git a/api/services/snippet_service.py b/api/services/snippet_service.py
index f34f9789fa5..aebe33f6e2b 100644
--- a/api/services/snippet_service.py
+++ b/api/services/snippet_service.py
@@ -39,6 +39,7 @@ from models.workflow import (
from repositories.factory import DifyAPIRepositoryFactory
from services.agent.retirement_service import WorkflowAgentRetirementService
from services.errors.app import IsDraftWorkflowError, WorkflowHashNotEqualError, WorkflowNotFoundError
+from services.errors.workflow_service import DraftWorkflowDeletionError, WorkflowInUseError
from services.tag_service import TagService
from services.workflow_node_execution_trace_service import (
WorkflowNodeExecutionTrace,
@@ -842,6 +843,53 @@ class SnippetService:
session.add(workflow)
return workflow
+ def delete_workflow(
+ self,
+ *,
+ session: Session,
+ snippet: CustomizedSnippet,
+ workflow_id: str,
+ ) -> bool:
+ """
+ Delete a published snippet workflow version.
+
+ :param session: Database session
+ :param snippet: CustomizedSnippet instance
+ :param workflow_id: Workflow ID
+ :return: True if successful
+ :raises: ValueError if workflow not found
+ :raises: WorkflowInUseError if workflow is the snippet's active version or published as a tool
+ :raises: DraftWorkflowDeletionError if workflow is a draft version
+ """
+ stmt = select(Workflow).where(
+ Workflow.id == workflow_id,
+ Workflow.tenant_id == snippet.tenant_id,
+ Workflow.app_id == snippet.id,
+ self._snippet_kind_filter(),
+ )
+ workflow = session.scalar(stmt)
+ if not workflow:
+ raise ValueError(f"Workflow with ID {workflow_id} not found")
+
+ if workflow.version == Workflow.VERSION_DRAFT:
+ raise DraftWorkflowDeletionError("Cannot delete draft workflow versions")
+
+ if snippet.workflow_id == workflow.id:
+ raise WorkflowInUseError(f"Cannot delete workflow that is currently in use by snippet '{snippet.id}'")
+
+ tool_provider = session.scalar(
+ select(WorkflowToolProvider).where(
+ WorkflowToolProvider.tenant_id == snippet.tenant_id,
+ WorkflowToolProvider.app_id == snippet.id,
+ WorkflowToolProvider.version == workflow.version,
+ )
+ )
+ if tool_provider:
+ raise WorkflowInUseError("Cannot delete workflow that is published as a tool")
+
+ session.delete(workflow)
+ return True
+
# --- Default Block Configs ---
def get_default_block_configs(self) -> list[dict]:
diff --git a/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py b/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py
index b5b2d79411b..06b984799ff 100644
--- a/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py
+++ b/api/tests/unit_tests/controllers/console/snippets/test_snippet_workflow.py
@@ -505,6 +505,70 @@ def test_update_published_snippet_workflow_raises_not_found(
assert snippet.name == "Snippet"
+def test_delete_published_snippet_workflow_succeeds(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
+ snippet = _snippet()
+ delete_workflow = Mock(return_value=True)
+ monkeypatch.setattr(
+ snippet_workflow_module,
+ "SnippetService",
+ lambda: SimpleNamespace(delete_workflow=delete_workflow),
+ )
+
+ api = snippet_workflow_module.SnippetWorkflowByIdApi()
+ handler = unwrap(api.delete)
+
+ with app.test_request_context("/snippets/snippet-1/workflows/workflow-1", method="DELETE"):
+ response, status_code = handler(api, snippet, workflow_id="workflow-1")
+
+ assert status_code == 204
+ assert response is None
+ delete_workflow.assert_called_once()
+ delete_call = delete_workflow.call_args.kwargs
+ assert isinstance(delete_call["session"], Session)
+ assert delete_call["snippet"] is snippet
+ assert delete_call["workflow_id"] == "workflow-1"
+
+
+def test_delete_published_snippet_workflow_raises_not_found(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
+ def delete_missing_workflow(**_kwargs):
+ raise ValueError("Workflow with ID missing-workflow not found")
+
+ monkeypatch.setattr(
+ snippet_workflow_module,
+ "SnippetService",
+ lambda: SimpleNamespace(delete_workflow=Mock(side_effect=delete_missing_workflow)),
+ )
+
+ api = snippet_workflow_module.SnippetWorkflowByIdApi()
+ handler = unwrap(api.delete)
+
+ with app.test_request_context("/snippets/snippet-1/workflows/missing-workflow", method="DELETE"):
+ with pytest.raises(NotFound):
+ handler(api, _snippet(), workflow_id="missing-workflow")
+
+
+def test_delete_published_snippet_workflow_raises_bad_request_when_in_use(
+ app: Flask, monkeypatch: pytest.MonkeyPatch
+) -> None:
+ def delete_active_workflow(**_kwargs):
+ raise snippet_workflow_module.WorkflowInUseError("Cannot delete workflow that is currently in use")
+
+ monkeypatch.setattr(
+ snippet_workflow_module,
+ "SnippetService",
+ lambda: SimpleNamespace(delete_workflow=Mock(side_effect=delete_active_workflow)),
+ )
+
+ api = snippet_workflow_module.SnippetWorkflowByIdApi()
+ handler = unwrap(api.delete)
+
+ with app.test_request_context("/snippets/snippet-1/workflows/workflow-1", method="DELETE"):
+ with pytest.raises(HTTPException) as exc_info:
+ handler(api, _snippet(), workflow_id="workflow-1")
+
+ assert exc_info.value.code == 400
+
+
def test_workflow_run_detail_raises_not_found_when_run_missing(app: Flask, monkeypatch: pytest.MonkeyPatch) -> None:
snippet = _snippet()
monkeypatch.setattr(
diff --git a/api/tests/unit_tests/services/test_snippet_service.py b/api/tests/unit_tests/services/test_snippet_service.py
index 3d22ea54509..b883d7eeb6f 100644
--- a/api/tests/unit_tests/services/test_snippet_service.py
+++ b/api/tests/unit_tests/services/test_snippet_service.py
@@ -28,6 +28,7 @@ from models.workflow import (
WorkflowType,
)
from services.errors.app import IsDraftWorkflowError, WorkflowHashNotEqualError, WorkflowNotFoundError
+from services.errors.workflow_service import DraftWorkflowDeletionError, WorkflowInUseError
from services.snippet_service import SnippetService
@@ -341,6 +342,64 @@ def test_update_workflow_returns_none_when_missing(sqlite_session: Session) -> N
assert result is None
+def test_delete_workflow_removes_published_version(sqlite_session: Session) -> None:
+ service = SnippetService.__new__(SnippetService)
+ workflow = _create_workflow(
+ workflow_id="workflow-1",
+ version="2026-01-01 00:00:00",
+ graph={"nodes": []},
+ features={},
+ )
+ snippet = _snippet(workflow_id="workflow-2")
+ sqlite_session.add_all([snippet, workflow])
+ sqlite_session.flush()
+
+ result = service.delete_workflow(session=sqlite_session, snippet=snippet, workflow_id="workflow-1")
+
+ assert result is True
+ sqlite_session.flush()
+ assert sqlite_session.get(Workflow, "workflow-1") is None
+
+
+def test_delete_workflow_raises_when_missing(sqlite_session: Session) -> None:
+ service = SnippetService.__new__(SnippetService)
+
+ with pytest.raises(ValueError, match="not found"):
+ service.delete_workflow(session=sqlite_session, snippet=_snippet(), workflow_id="missing-workflow")
+
+
+def test_delete_workflow_raises_for_draft_version(sqlite_session: Session) -> None:
+ service = SnippetService.__new__(SnippetService)
+ workflow = _create_workflow(
+ workflow_id="workflow-1",
+ version=Workflow.VERSION_DRAFT,
+ graph={"nodes": []},
+ features={},
+ )
+ snippet = _snippet()
+ sqlite_session.add_all([snippet, workflow])
+ sqlite_session.flush()
+
+ with pytest.raises(DraftWorkflowDeletionError):
+ service.delete_workflow(session=sqlite_session, snippet=snippet, workflow_id="workflow-1")
+
+
+def test_delete_workflow_raises_when_currently_active(sqlite_session: Session) -> None:
+ service = SnippetService.__new__(SnippetService)
+ workflow = _create_workflow(
+ workflow_id="workflow-1",
+ version="2026-01-01 00:00:00",
+ graph={"nodes": []},
+ features={},
+ )
+ snippet = _snippet(workflow_id="workflow-1")
+ sqlite_session.add_all([snippet, workflow])
+ sqlite_session.flush()
+
+ with pytest.raises(WorkflowInUseError):
+ service.delete_workflow(session=sqlite_session, snippet=snippet, workflow_id="workflow-1")
+
+
def test_get_default_block_configs_skips_empty_defaults(monkeypatch: pytest.MonkeyPatch) -> None:
node_with_default = SimpleNamespace(get_default_config=Mock(return_value={"type": "llm"}))
node_without_default = SimpleNamespace(get_default_config=Mock(return_value=None))
diff --git a/packages/contracts/generated/api/console/snippets/orpc.gen.ts b/packages/contracts/generated/api/console/snippets/orpc.gen.ts
index 433d4259def..f4b77908296 100644
--- a/packages/contracts/generated/api/console/snippets/orpc.gen.ts
+++ b/packages/contracts/generated/api/console/snippets/orpc.gen.ts
@@ -3,6 +3,8 @@
import { oc } from '@orpc/contract'
import * as z from 'zod'
import {
+ zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdPath,
+ zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponse,
zDeleteSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesPath,
zDeleteSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesResponse,
zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdPath,
@@ -874,6 +876,25 @@ export const restore = {
post: post12,
}
+/**
+ * Delete a published snippet workflow version
+ *
+ * Delete a published snippet workflow version
+ */
+export const delete4 = oc
+ .route({
+ description: 'Delete a published snippet workflow version',
+ inputStructure: 'detailed',
+ method: 'DELETE',
+ operationId: 'deleteSnippetsBySnippetIdWorkflowsByWorkflowId',
+ path: '/snippets/{snippet_id}/workflows/{workflow_id}',
+ successStatus: 204,
+ summary: 'Delete a published snippet workflow version',
+ tags: ['console'],
+ })
+ .input(z.object({ params: zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdPath }))
+ .output(zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponse)
+
/**
* Update a published snippet workflow version's display metadata
*
@@ -898,6 +919,7 @@ export const patch2 = oc
.output(zPatchSnippetsBySnippetIdWorkflowsByWorkflowIdResponse)
export const byWorkflowId = {
+ delete: delete4,
patch: patch2,
restore,
}
diff --git a/packages/contracts/generated/api/console/snippets/types.gen.ts b/packages/contracts/generated/api/console/snippets/types.gen.ts
index 5dc2a624c1e..da4479f95e4 100644
--- a/packages/contracts/generated/api/console/snippets/types.gen.ts
+++ b/packages/contracts/generated/api/console/snippets/types.gen.ts
@@ -1758,6 +1758,28 @@ export type PostSnippetsBySnippetIdWorkflowsPublishResponses = {
export type PostSnippetsBySnippetIdWorkflowsPublishResponse =
PostSnippetsBySnippetIdWorkflowsPublishResponses[keyof PostSnippetsBySnippetIdWorkflowsPublishResponses]
+export type DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdData = {
+ body?: never
+ path: {
+ snippet_id: string
+ workflow_id: string
+ }
+ query?: never
+ url: '/snippets/{snippet_id}/workflows/{workflow_id}'
+}
+
+export type DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdErrors = {
+ 400: unknown
+ 404: unknown
+}
+
+export type DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponses = {
+ 204: void
+}
+
+export type DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponse =
+ DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponses[keyof DeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponses]
+
export type PatchSnippetsBySnippetIdWorkflowsByWorkflowIdData = {
body: WorkflowUpdatePayload
path: {
diff --git a/packages/contracts/generated/api/console/snippets/zod.gen.ts b/packages/contracts/generated/api/console/snippets/zod.gen.ts
index 994adf7aa0f..65ac302b2ae 100644
--- a/packages/contracts/generated/api/console/snippets/zod.gen.ts
+++ b/packages/contracts/generated/api/console/snippets/zod.gen.ts
@@ -1988,6 +1988,16 @@ export const zPostSnippetsBySnippetIdWorkflowsPublishPath = z.object({
*/
export const zPostSnippetsBySnippetIdWorkflowsPublishResponse = zWorkflowPublishResponse
+export const zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdPath = z.object({
+ snippet_id: z.uuid(),
+ workflow_id: z.string(),
+})
+
+/**
+ * Workflow deleted successfully
+ */
+export const zDeleteSnippetsBySnippetIdWorkflowsByWorkflowIdResponse = z.void()
+
export const zPatchSnippetsBySnippetIdWorkflowsByWorkflowIdBody = zWorkflowUpdatePayload
export const zPatchSnippetsBySnippetIdWorkflowsByWorkflowIdPath = z.object({