fix: apply DAPR_API_TIMEOUT_SECONDS to workflow gRPC connections#954
Open
fix: apply DAPR_API_TIMEOUT_SECONDS to workflow gRPC connections#954
Conversation
The workflow extension's gRPC connections (DaprWorkflowClient, async DaprWorkflowClient, and WorkflowRuntime) were not respecting the DAPR_API_TIMEOUT_SECONDS environment variable, unlike the core SDK's DaprGrpcClient which applies it via a timeout interceptor. Pass DaprClientTimeoutInterceptor (sync) and DaprClientTimeoutInterceptorAsync (async) to the durabletask TaskHubGrpcClient, AsyncTaskHubGrpcClient, and TaskHubGrpcWorker so that workflow gRPC calls get the configured default timeout. Signed-off-by: Fabian Martinez <fabian@diagrid.io> Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR ensures workflow-related gRPC connections (workflow client, async workflow client, and workflow runtime worker) respect the global DAPR_API_TIMEOUT_SECONDS default by adding the SDK’s timeout interceptor to the underlying durabletask gRPC channels.
Changes:
- Add
DaprClientTimeoutInterceptorto the durabletask worker channel inWorkflowRuntime, while preserving user-provided interceptors. - Add
DaprClientTimeoutInterceptorto the syncDaprWorkflowClientdurabletask channel. - Add
DaprClientTimeoutInterceptorAsyncto the asyncDaprWorkflowClientdurabletask channel.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| ext/dapr-ext-workflow/dapr/ext/workflow/workflow_runtime.py | Prepends timeout interceptor and merges it with any user-provided interceptors for the worker channel. |
| ext/dapr-ext-workflow/dapr/ext/workflow/dapr_workflow_client.py | Adds timeout interceptor to the durabletask sync workflow client channel. |
| ext/dapr-ext-workflow/dapr/ext/workflow/aio/dapr_workflow_client.py | Adds timeout interceptor to the durabletask async workflow client channel. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
69
to
76
| self.__obj = client.TaskHubGrpcClient( | ||
| host_address=uri.endpoint, | ||
| metadata=metadata, | ||
| secure_channel=uri.tls, | ||
| log_handler=options.log_handler, | ||
| log_formatter=options.log_formatter, | ||
| interceptors=[DaprClientTimeoutInterceptor()], | ||
| ) |
Comment on lines
66
to
73
| self.__obj = aioclient.AsyncTaskHubGrpcClient( | ||
| host_address=uri.endpoint, | ||
| metadata=metadata, | ||
| secure_channel=uri.tls, | ||
| log_handler=options.log_handler, | ||
| log_formatter=options.log_formatter, | ||
| interceptors=[DaprClientTimeoutInterceptorAsync()], | ||
| ) |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #954 +/- ##
==========================================
+ Coverage 86.63% 89.08% +2.45%
==========================================
Files 84 103 +19
Lines 4473 7347 +2874
==========================================
+ Hits 3875 6545 +2670
- Misses 598 802 +204 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Fabian Martinez <46371672+famarting@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
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
DaprWorkflowClient, asyncDaprWorkflowClient,WorkflowRuntime) were not respectingDAPR_API_TIMEOUT_SECONDSDaprClientTimeoutInterceptor/DaprClientTimeoutInterceptorAsyncto the durabletask client and worker gRPC channelsWorkflowRuntimeare preserved alongside the timeout interceptorTest plan
DAPR_API_TIMEOUT_SECONDSset to a custom value that workflow gRPC calls respect ittimeout_in_secondsonwait_for_workflow_completion) still take precedence