Skip to content

fix: use odata api for folder search #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
radu-mocanu merged 1 commit into from
Jun 18, 2025
Merged

fix: use odata api for folder search #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "uipath"
version = "2.0.66"
version = "2.0.67"
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"
Expand Down
6 changes: 4 additions & 2 deletions src/uipath/_services/context_grounding_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,12 +673,14 @@ def _resolve_folder_key(self, folder_key, folder_path):
)

if folder_key is None:
raise ValueError("Folder key or folder path is required")
raise ValueError("ContextGrounding: Failed to resolve folder key")

return folder_key

def _extract_bucket_info(self, index: ContextGroundingIndex) -> Tuple[str, str]:
try:
return index.data_source.bucketName, index.data_source.folder # type: ignore
except AttributeError as e:
raise Exception("Cannot extract bucket data from index") from e
raise Exception(
"ContextGrounding: Cannot extract bucket data from index"
) from e
22 changes: 8 additions & 14 deletions src/uipath/_services/folder_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,19 @@ def retrieve_key(self, *, folder_path: str) -> Optional[str]:
url=spec.endpoint,
params=spec.params,
).json()

return next(
(
item["Key"]
for item in response["PageItems"]
if item["FullyQualifiedName"] == folder_path
),
None,
)
try:
return response["value"][0]["Key"]
except KeyError:
return None

def _retrieve_spec(self, folder_path: str) -> RequestSpec:
folder_name = folder_path.split("/")[-1]
return RequestSpec(
method="GET",
endpoint=Endpoint(
"orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser"
),
endpoint=Endpoint("orchestrator_/odata/Folders"),
params={
"searchText": folder_name,
"take": 1,
"$filter": f"DisplayName eq '{folder_name}'",
"$top": 1,
"$select": "Key",
},
)
30 changes: 12 additions & 18 deletions tests/sdk/services/test_context_grounding_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,12 @@ def test_search(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand All @@ -68,13 +67,12 @@ def test_search(
)

httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand Down Expand Up @@ -132,13 +130,12 @@ async def test_search_async(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand All @@ -162,13 +159,12 @@ async def test_search_async(
)

httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand Down Expand Up @@ -225,13 +221,12 @@ def test_retrieve(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand Down Expand Up @@ -285,13 +280,12 @@ async def test_retrieve_async(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand Down
28 changes: 13 additions & 15 deletions tests/sdk/services/test_folder_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,19 @@ def test_retrieve_key_by_folder_path(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test_folder_path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
)

with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
folder_key = service.retrieve_key_by_folder_path("test-folder-path")
folder_key = service.retrieve_key_by_folder_path("test_folder_path")

assert folder_key == "test-folder-key"

Expand All @@ -52,7 +51,7 @@ def test_retrieve_key_by_folder_path(
assert sent_request.method == "GET"
assert (
sent_request.url
== f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1"
== f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test_folder_path%27&%24top=1&%24select=Key"
)

assert HEADER_USER_AGENT in sent_request.headers
Expand All @@ -71,9 +70,9 @@ def test_retrieve_key_by_folder_path_not_found(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key",
status_code=200,
json={"PageItems": []},
json={},
)

with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
Expand All @@ -88,7 +87,7 @@ def test_retrieve_key_by_folder_path_not_found(
assert sent_request.method == "GET"
assert (
sent_request.url
== f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1"
== f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key"
)

assert HEADER_USER_AGENT in sent_request.headers
Expand All @@ -107,13 +106,12 @@ def test_retrieve_key(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
status_code=200,
json={
"PageItems": [
"value": [
{
"Key": "test-folder-key",
"FullyQualifiedName": "test-folder-path",
}
]
},
Expand All @@ -130,7 +128,7 @@ def test_retrieve_key(
assert sent_request.method == "GET"
assert (
sent_request.url
== f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1"
== f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key"
)

assert HEADER_USER_AGENT in sent_request.headers
Expand All @@ -149,9 +147,9 @@ def test_retrieve_key_not_found(
version: str,
) -> None:
httpx_mock.add_response(
url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1",
url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key",
status_code=200,
json={"PageItems": []},
json={},
)

folder_key = service.retrieve_key_by_folder_path("non-existent-folder")
Expand All @@ -165,7 +163,7 @@ def test_retrieve_key_not_found(
assert sent_request.method == "GET"
assert (
sent_request.url
== f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1"
== f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key"
)

assert HEADER_USER_AGENT in sent_request.headers
Expand Down
2 changes: 1 addition & 1 deletion uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.