fix(platform): close service http clients (#1826)

Author: radu-mocanu

packages/uipath-platform/pyproject.toml

@@ -1,10 +1,11 @@
 [project]
 name = "uipath-platform"
-version = "0.2.12"
+version = "0.2.13"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
 dependencies = [
+  "anyio>=4.0.0",
   "httpx>=0.28.1",
   "tenacity>=9.0.0",
   "truststore>=0.10.1",

packages/uipath-platform/src/uipath/platform/common/_base_service.py

@@ -3,6 +3,7 @@
 from logging import getLogger
 from typing import Any, Literal, Union
 
+from anyio import to_thread
 from httpx import (
     URL,
     AsyncClient,
@@ -171,6 +172,18 @@ def __init__(
 
         super().__init__()
 
+    async def aclose(self) -> None:
+        """Close the HTTP clients owned by this service.
+
+        The asynchronous client is closed by the active async backend. Closing the
+        synchronous client can block while its transport is torn down, so that work
+        runs in a backend-neutral worker thread.
+        """
+        try:
+            await self._client_async.aclose()
+        finally:
+            await to_thread.run_sync(self._client.close)
+
     @retry(
         retry=(
             retry_if_exception(is_retryable_platform_exception)

packages/uipath-platform/src/uipath/platform/entities/_entities_service.py

@@ -112,6 +112,19 @@ def __init__(
             folders_service=folders_service,
         )
 
+    async def aclose(self) -> None:
+        """Close this facade and the services it creates."""
+        try:
+            await self._schema.aclose()
+        finally:
+            try:
+                await self._data.aclose()
+            finally:
+                try:
+                    await self._ontology.aclose()
+                finally:
+                    await super().aclose()
+
     # ------------------------------------------------------------------
     # Schema operations — delegate to EntitySchemaService
     # ------------------------------------------------------------------

packages/uipath-platform/src/uipath/platform/orchestrator/_buckets_service.py

@@ -5,6 +5,7 @@
 from typing import Any, Dict, Optional, Union
 
 import httpx
+from anyio import to_thread
 from uipath.core.tracing import traced
 
 from ..common._base_service import BaseService
@@ -37,6 +38,16 @@ def __init__(
         self.custom_client = httpx.Client(**get_httpx_client_kwargs())
         self.custom_client_async = httpx.AsyncClient(**get_httpx_client_kwargs())
 
+    async def aclose(self) -> None:
+        """Close the additional HTTP clients used for bucket transfers."""
+        try:
+            await self.custom_client_async.aclose()
+        finally:
+            try:
+                await to_thread.run_sync(self.custom_client.close)
+            finally:
+                await super().aclose()
+
     @traced(name="buckets_list", run_type="uipath")
     def list(
         self,

packages/uipath-platform/src/uipath/platform/orchestrator/_jobs_service.py

@@ -43,6 +43,13 @@ def __init__(
         self._temp_dir = os.path.join(tempfile.gettempdir(), TEMP_ATTACHMENTS_FOLDER)
         os.makedirs(self._temp_dir, exist_ok=True)
 
+    async def aclose(self) -> None:
+        """Close this service and the attachment service it owns."""
+        try:
+            await self._attachments_service.aclose()
+        finally:
+            await super().aclose()
+
     @overload
     def resume(self, *, inbox_id: str, payload: Any) -> None: ...
 

packages/uipath-platform/tests/services/test_base_service.py

@@ -18,6 +18,14 @@ class TestBaseService:
     def test_init_base_service(self, service: BaseService):
         assert service is not None
 
+    @pytest.mark.parametrize("anyio_backend", ["asyncio", "trio"])
+    @pytest.mark.anyio
+    async def test_aclose_closes_owned_http_clients(self, service: BaseService):
+        await service.aclose()
+
+        assert service._client.is_closed
+        assert service._client_async.is_closed
+
     def test_base_service_default_headers(self, service: BaseService, secret: str):
         assert service.default_headers == {
             "Accept": "application/json",

packages/uipath-platform/tests/services/test_buckets_service.py

@@ -27,6 +27,18 @@ def temp_file(tmp_path):
 
 
 class TestBucketsService:
+    @pytest.mark.parametrize("anyio_backend", ["asyncio", "trio"])
+    @pytest.mark.anyio
+    async def test_aclose_closes_all_owned_http_clients(
+        self, service: BucketsService
+    ) -> None:
+        await service.aclose()
+
+        assert service._client.is_closed
+        assert service._client_async.is_closed
+        assert service.custom_client.is_closed
+        assert service.custom_client_async.is_closed
+
     class TestRetrieve:
         def test_retrieve_by_key(
             self,

packages/uipath-platform/tests/services/test_entities_service.py

@@ -55,6 +55,20 @@ def record_schema_optional(request):
 
 
 class TestEntitiesService:
+    @pytest.mark.parametrize("anyio_backend", ["asyncio", "trio"])
+    @pytest.mark.anyio
+    async def test_aclose_closes_owned_services(self, service: EntitiesService):
+        await service.aclose()
+
+        assert service._client.is_closed
+        assert service._client_async.is_closed
+        assert service._schema._client.is_closed
+        assert service._schema._client_async.is_closed
+        assert service._data._client.is_closed
+        assert service._data._client_async.is_closed
+        assert service._ontology._client.is_closed
+        assert service._ontology._client_async.is_closed
+
     def test_query_entity_records_has_datafabric_error_mapping(self) -> None:
         assert (
             EntitiesService.query_entity_records.__uipath_datafabric_method__  # type: ignore[attr-defined]

packages/uipath-platform/tests/services/test_jobs_service.py

@@ -101,6 +101,15 @@ def local_attachment_file(
 
 
 class TestJobsService:
+    @pytest.mark.anyio
+    async def test_aclose_closes_owned_services(self, service: JobsService):
+        await service.aclose()
+
+        assert service._client.is_closed
+        assert service._client_async.is_closed
+        assert service._attachments_service._client.is_closed
+        assert service._attachments_service._client_async.is_closed
+
     def test_retrieve(
         self,
         httpx_mock: HTTPXMock,