fix(api): fix fail branch functionality for WorkflowTool
#15966
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, `WorkflowTool._invoke` raised an exception of type `Exception` when the invoked tool encountered an error. This exception was not properly caught by the caller, resulting in the API returning an `internal server error` to the user. This commit replaces the generic `Exception` with a specific `ToolInvokeError` and ensures it is caught during message transformation in the `ToolNode`. This converts the tool invocation failure into a `NodeRunResult` event with a `FAILED` status, enabling the `GraphEngine` to correctly execute the fail branch logic for error handling.
dosubot
bot
added
size:L
- Add a test case to verify `ToolNode` correctly catches `ToolInvokeError` during message transformation - Add a test case to ensure `WorkflowTool` properly throws `ToolInvokeError` when workflow execution fails
QuantumGhost
force-pushed
the
fix/workflow-tool-on-failure/try-catch-approach
branch
from
1780f91 to
b0fdcd6
Compare
QuantumGhost
deleted the
fix/workflow-tool-on-failure/try-catch-approach
branch
parambharat
pushed a commit
to parambharat/dify
that referenced
this pull request
Mar 31, 2025
No Sign up for free
to join this conversation on GitHub.
Already have an account?
No Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Previously,
WorkflowTool._invokeraised an exception of typeExceptionwhen the invoked tool encountered an error. This exceptionwas not properly caught by the caller, resulting in the API returning
an
internal server errorto the user.This commit replaces the generic
Exceptionwith a specificToolInvokeErrorand ensures it is caught during message transformationin the
ToolNode. This converts the tool invocation failure into aNodeRunResultevent with a
FAILEDstatus, enabling theGraphEngineto correctly executethe fail branch logic for error handling.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Closes #15252.
Screenshots
Checklist
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods