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(chatflow): cancel watchdog on workflow terminal events (#45029)

zyssyz12378e7fce2ae8c
diff --git a/api/core/app/apps/message_based_app_queue_manager.py b/api/core/app/apps/message_based_app_queue_manager.py
index 548b00eab42..3330497a9bd 100644
--- a/api/core/app/apps/message_based_app_queue_manager.py
+++ b/api/core/app/apps/message_based_app_queue_manager.py
@@ -11,7 +11,10 @@ from core.app.entities.queue_entities import (
QueueErrorEvent,
QueueMessageEndEvent,
QueueStopEvent,
+ QueueWorkflowFailedEvent,
+ QueueWorkflowPartialSuccessEvent,
QueueWorkflowPausedEvent,
+ QueueWorkflowSucceededEvent,
)
from models.model import AppMode
@@ -47,7 +50,14 @@ class MessageBasedAppQueueManager(AppQueueManager):
if isinstance(event, QueueWorkflowPausedEvent):
self.stop_listen(execution_state=AppExecutionState.PAUSED)
elif isinstance(
- event, QueueStopEvent | QueueErrorEvent | QueueMessageEndEvent | QueueAdvancedChatMessageEndEvent
+ event,
+ QueueStopEvent
+ | QueueErrorEvent
+ | QueueMessageEndEvent
+ | QueueAdvancedChatMessageEndEvent
+ | QueueWorkflowSucceededEvent
+ | QueueWorkflowPartialSuccessEvent
+ | QueueWorkflowFailedEvent,
):
execution_state = (
AppExecutionState.PAUSED
diff --git a/api/tests/unit_tests/core/app/apps/test_message_based_app_queue_manager.py b/api/tests/unit_tests/core/app/apps/test_message_based_app_queue_manager.py
index a421aac081f..ad838b1abc5 100644
--- a/api/tests/unit_tests/core/app/apps/test_message_based_app_queue_manager.py
+++ b/api/tests/unit_tests/core/app/apps/test_message_based_app_queue_manager.py
@@ -1,3 +1,5 @@
+import threading
+from collections.abc import Iterator
from unittest.mock import Mock, patch
import pytest
@@ -8,15 +10,91 @@ from core.app.apps.execution_coordinator import AppExecutionState
from core.app.apps.message_based_app_queue_manager import MessageBasedAppQueueManager
from core.app.entities.app_invoke_entities import InvokeFrom
from core.app.entities.queue_entities import (
+ AppQueueEvent,
QueueAdvancedChatMessageEndEvent,
QueueErrorEvent,
QueueMessageEndEvent,
QueueStopEvent,
+ QueueWorkflowFailedEvent,
+ QueueWorkflowPartialSuccessEvent,
QueueWorkflowPausedEvent,
+ QueueWorkflowStartedEvent,
+ QueueWorkflowSucceededEvent,
)
+def chatflow_manager() -> Iterator[MessageBasedAppQueueManager]:
+ manager = MessageBasedAppQueueManager(
+ task_id="t1",
+ user_id="u1",
+ invoke_from=InvokeFrom.DEBUGGER,
+ conversation_id="c1",
+ app_mode="advanced-chat",
+ message_id="m1",
+ )
+ try:
+ yield manager
+ finally:
+ watchdog = manager._execution_coordinator._watchdog
+ if watchdog is not None:
+ watchdog.cancel()
+ watchdog.join(timeout=1)
+
+
class TestMessageBasedAppQueueManager:
+ @pytest.mark.parametrize(
+ "event",
+ [
+ QueueWorkflowSucceededEvent(outputs={"answer": "done"}),
+ QueueWorkflowPartialSuccessEvent(exceptions_count=1),
+ QueueWorkflowFailedEvent(error="node failed", exceptions_count=1),
+ ],
+ ids=["succeeded", "partial-success", "failed"],
+ )
+ def test_workflow_terminal_event_cancels_watchdog_and_finishes_listener(
+ self, chatflow_manager: MessageBasedAppQueueManager, event: AppQueueEvent
+ ) -> None:
+ manager = chatflow_manager
+ manager.publish(QueueWorkflowStartedEvent(), PublishFrom.APPLICATION_MANAGER)
+ listener = manager.listen()
+ assert isinstance(next(listener).event, QueueWorkflowStartedEvent)
+ watchdog = manager._execution_coordinator._watchdog
+ assert isinstance(watchdog, threading.Timer)
+ assert watchdog.is_alive()
+ assert not watchdog.finished.is_set()
+
+ manager.publish(event, PublishFrom.APPLICATION_MANAGER)
+
+ assert manager.execution_state is AppExecutionState.TERMINAL
+ assert manager._execution_coordinator._watchdog is None
+ assert watchdog.finished.is_set()
+ watchdog.join(timeout=1)
+ assert not watchdog.is_alive()
+ assert [message.event for message in listener] == [event]
+ assert manager._q.empty()
+
+ def test_workflow_start_and_response_detach_keep_execution_running(
+ self, chatflow_manager: MessageBasedAppQueueManager
+ ) -> None:
+ manager = chatflow_manager
+ manager.publish(QueueWorkflowStartedEvent(), PublishFrom.APPLICATION_MANAGER)
+ listener = manager.listen()
+
+ assert isinstance(next(listener).event, QueueWorkflowStartedEvent)
+ assert manager.execution_state is AppExecutionState.RUNNING
+ watchdog = manager._execution_coordinator._watchdog
+ assert isinstance(watchdog, threading.Timer)
+ assert watchdog.is_alive()
+ assert not watchdog.finished.is_set()
+
+ listener.close()
+
+ assert manager.execution_state is AppExecutionState.RUNNING
+ assert manager._execution_coordinator._watchdog is watchdog
+ assert watchdog.is_alive()
+ assert not watchdog.finished.is_set()
+
def test_publish_stops_on_terminal_events(self) -> None:
with patch("core.app.apps.base_app_queue_manager.redis_client") as mock_redis:
mock_redis.setex.return_value = True
@@ -89,30 +167,34 @@ class TestMessageBasedAppQueueManager:
manager.stop_listen.assert_called_once_with(execution_state=AppExecutionState.PAUSED)
- def test_pause_state_is_preserved_when_advanced_chat_message_ends(self) -> None:
+ def test_pause_state_is_preserved_when_advanced_chat_message_ends(
+ self, chatflow_manager: MessageBasedAppQueueManager
+ ) -> None:
+ manager = chatflow_manager
with (
- patch("core.app.apps.base_app_queue_manager.redis_client") as queue_redis,
patch("core.app.apps.execution_coordinator.redis_client") as execution_redis,
patch("core.app.apps.execution_coordinator.send_abort_command") as send_abort_command,
):
- queue_redis.get.return_value = None
- manager = MessageBasedAppQueueManager(
- task_id="t1",
- user_id="u1",
- invoke_from=InvokeFrom.DEBUGGER,
- conversation_id="c1",
- app_mode="advanced-chat",
- message_id="m1",
- )
+ manager.publish(QueueWorkflowStartedEvent(), PublishFrom.APPLICATION_MANAGER)
+ listener = manager.listen()
+ assert isinstance(next(listener).event, QueueWorkflowStartedEvent)
+ watchdog = manager._execution_coordinator._watchdog
+ assert isinstance(watchdog, threading.Timer)
+ assert watchdog.is_alive()
+ assert not watchdog.finished.is_set()
manager.publish(
QueueWorkflowPausedEvent(reasons=[], outputs={}, paused_nodes=["human-input"]),
PublishFrom.APPLICATION_MANAGER,
)
manager.publish(QueueAdvancedChatMessageEndEvent(), PublishFrom.TASK_PIPELINE)
- messages = list(manager.listen())
+ messages = list(listener)
assert isinstance(messages[0].event, QueueWorkflowPausedEvent)
assert manager.execution_state is AppExecutionState.PAUSED
+ assert manager._execution_coordinator._watchdog is None
+ assert watchdog.finished.is_set()
+ watchdog.join(timeout=1)
+ assert not watchdog.is_alive()
execution_redis.setex.assert_not_called()
send_abort_command.assert_not_called()