Merge pull request #408 from UiPath/fix/rollback

fix: rollback to FoldersNavigation usage

Author: radu-mocanu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.67"
+version = "2.0.68"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

src/uipath/_services/folder_service.py

@@ -28,25 +28,58 @@ def retrieve_key_by_folder_path(self, folder_path: str) -> Optional[str]:
 
     @traced(name="folder_retrieve_key", run_type="uipath")
     def retrieve_key(self, *, folder_path: str) -> Optional[str]:
-        spec = self._retrieve_spec(folder_path)
-        response = self.request(
-            spec.method,
-            url=spec.endpoint,
-            params=spec.params,
-        ).json()
-        try:
-            return response["value"][0]["Key"]
-        except KeyError:
-            return None
-
-    def _retrieve_spec(self, folder_path: str) -> RequestSpec:
+        """Retrieve the folder key by folder path with pagination support.
+
+        Args:
+            folder_path: The fully qualified folder path to search for.
+
+        Returns:
+            The folder key if found, None otherwise.
+        """
+        skip = 0
+        take = 20
+
+        while True:
+            spec = self._retrieve_spec(folder_path, skip=skip, take=take)
+            response = self.request(
+                spec.method,
+                url=spec.endpoint,
+                params=spec.params,
+            ).json()
+
+            # Search for the folder in current page
+            folder_key = next(
+                (
+                    item["Key"]
+                    for item in response["PageItems"]
+                    if item["FullyQualifiedName"] == folder_path
+                ),
+                None,
+            )
+
+            if folder_key is not None:
+                return folder_key
+
+            page_items = response["PageItems"]
+            if len(page_items) < take:
+                break
+
+            skip += take
+
+        return None
+
+    def _retrieve_spec(
+        self, folder_path: str, *, skip: int = 0, take: int = 20
+    ) -> RequestSpec:
         folder_name = folder_path.split("/")[-1]
         return RequestSpec(
             method="GET",
-            endpoint=Endpoint("orchestrator_/odata/Folders"),
+            endpoint=Endpoint(
+                "orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser"
+            ),
             params={
-                "$filter": f"DisplayName eq '{folder_name}'",
-                "$top": 1,
-                "$select": "Key",
+                "searchText": folder_name,
+                "skip": skip,
+                "take": take,
             },
         )

tests/sdk/services/test_context_grounding_service.py

@@ -38,12 +38,13 @@ def test_search(
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -67,12 +68,13 @@ def test_search(
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -130,12 +132,13 @@ async def test_search_async(
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -159,12 +162,13 @@ async def test_search_async(
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -221,12 +225,13 @@ def test_retrieve(
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -280,17 +285,17 @@ async def test_retrieve_async(
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
+            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&skip=0&take=20",
             status_code=200,
             json={
-                "value": [
+                "PageItems": [
                     {
                         "Key": "test-folder-key",
+                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
         )
-
         httpx_mock.add_response(
             url=f"{base_url}{org}{tenant}/ecs_/v2/indexes?$filter=Name eq 'test-index'&$expand=dataSource",
             status_code=200,