Title: Add context manager support to `TaskHubGrpcClient` to prevent gRPC channel leaks · Issue #134 · microsoft/durabletask-python · GitHub
Open Graph Title: Add context manager support to `TaskHubGrpcClient` to prevent gRPC channel leaks · Issue #134 · microsoft/durabletask-python
X Title: Add context manager support to `TaskHubGrpcClient` to prevent gRPC channel leaks · Issue #134 · microsoft/durabletask-python
Description: Problem TaskHubGrpcClient has a close() method but does not implement __enter__/__exit__, so it cannot be used as a context manager. This means callers must remember to call close() manually (typically in a try/finally block), but no exi...
Open Graph Description: Problem TaskHubGrpcClient has a close() method but does not implement __enter__/__exit__, so it cannot be used as a context manager. This means callers must remember to call close() manually (typic...
X Description: Problem TaskHubGrpcClient has a close() method but does not implement __enter__/__exit__, so it cannot be used as a context manager. This means callers must remember to call close() manually (typic...
Opengraph URL: https://github.com/microsoft/durabletask-python/issues/134
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add context manager support to `TaskHubGrpcClient` to prevent gRPC channel leaks","articleBody":"## Problem\n\n`TaskHubGrpcClient` has a `close()` method but does not implement `__enter__`/`__exit__`, so it cannot be used as a context manager. This means callers must remember to call `close()` manually (typically in a `try/finally` block), but no existing tests or examples do this — every callsite creates the client and never closes it, leaking the underlying gRPC channel.\n\n`AsyncTaskHubGrpcClient` already has `__aenter__`/`__aexit__`, so there is an asymmetry between the sync and async clients.\n\n## Scope\n\nThis affects ~40+ callsites across the repository:\n\n| File | Unclosed usages |\n|---|---|\n| `tests/durabletask/test_orchestration_e2e.py` | ~21 |\n| `tests/durabletask/entities/test_function_based_entities_e2e.py` | ~10 |\n| `tests/durabletask/entities/test_entity_failure_handling.py` | ~5 |\n| `tests/durabletask/entities/test_class_based_entities_e2e.py` | ~4 |\n| `examples/in_memory_backend_example/test/test_workflows.py` | ~8 |\n| `examples/human_interaction.py` | 1 |\n\n## Proposed Fix\n\n1. Add `__enter__`/`__exit__` to `TaskHubGrpcClient` (mirrors the existing async pattern):\n\n```python\ndef __enter__(self):\n return self\n\ndef __exit__(self, exc_type, exc_val, exc_tb):\n self.close()\n```\n\n2. Update all test and example callsites to use the `with` statement:\n\n```python\n# Before\ntask_hub_client = client.TaskHubGrpcClient(host_address=HOST)\nid = task_hub_client.schedule_new_orchestration(...)\nstate = task_hub_client.wait_for_orchestration_completion(id, timeout=30)\n\n# After\nwith client.TaskHubGrpcClient(host_address=HOST) as task_hub_client:\n id = task_hub_client.schedule_new_orchestration(...)\n state = task_hub_client.wait_for_orchestration_completion(id, timeout=30)\n```\n\nThis also improves the getting-started experience and aligns with the `TaskHubGrpcWorker` pattern already used throughout the codebase.\n\n## Notes\n\n- Adding `__enter__`/`__exit__` is a non-breaking additive change\n- The channel leak is benign in short-lived test processes but is a real concern in long-running applications or test suites that run many tests\n- This issue was surfaced by a reviewer comment on PR #133","author":{"url":"https://github.com/andystaples","@type":"Person","name":"andystaples"},"datePublished":"2026-04-14T17:59:06Z","url":"https://github.com/microsoft/durabletask-python/issues/134"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:d9a45445-0295-8ed5-2c73-366f1d4b8e2c |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9D3C:38CE1B:4059E:56833:6AFE413D |
| html-safe-nonce | 0fdf38613fb4dcda169eeb72d42eaa9dd4fbf2c4b9aab475e5e65ad7a5e0099d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RDNDOjM4Q0UxQjo0MDU5RTo1NjgzMzo2QUZFNDEzRCIsInZpc2l0b3JfaWQiOiI2MTYzMDgxMTU1ODk0NDYwNzMzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 9312f5dcef6d56daf02db27369480bfcf2d79a042329191f7b0c366660c09566 |
| hovercard-subject-tag | issue:4263870751 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/durabletask-python/134/issue_layout |
| twitter:image | https://opengraph.githubassets.com/a91f8044a9589a4f9d61326e6433a8f3691009a7047d0d59ea760831b74add48/microsoft/durabletask-python/issues/134 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/a91f8044a9589a4f9d61326e6433a8f3691009a7047d0d59ea760831b74add48/microsoft/durabletask-python/issues/134 |
| og:image:alt | Problem TaskHubGrpcClient has a close() method but does not implement __enter__/__exit__, so it cannot be used as a context manager. This means callers must remember to call close() manually (typic... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | andystaples |
| hostname | github.com |
| expected-hostname | github.com |
| None | f1a5901e2377b0af2a0b303f9528678f1475d04b9219dca1e993344196eaa07c |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/durabletask-python git https://github.com/microsoft/durabletask-python.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 627664515 |
| octolytics-dimension-repository_nwo | microsoft/durabletask-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 627664515 |
| octolytics-dimension-repository_network_root_nwo | microsoft/durabletask-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | c4447fdce9ed0f33af959d2b6680d0bc18212a6a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width