chore: add folder key helper

Author: radugheo

src/uipath/_services/_folder_helpers.py

@@ -0,0 +1,40 @@
+from typing import Optional
+
+from .folder_service import FolderService
+
+
+def resolve_folder_key(
+    folder_key: Optional[str],
+    folder_path: Optional[str],
+    folders_service: FolderService,
+    context_folder_key: Optional[str] = None,
+    context_folder_path: Optional[str] = None,
+) -> str:
+    """Resolve folder key from provided parameters or instance context.
+
+    Args:
+        folder_key: Optional folder key to use directly
+        folder_path: Optional folder path to resolve to a key
+        folders_service: FolderService instance to resolve folder paths
+        context_folder_key: Optional instance-level folder key fallback
+        context_folder_path: Optional instance-level folder path fallback
+
+    Returns:
+        The resolved folder key
+
+    Raises:
+        ValueError: If folder key cannot be resolved
+    """
+    if folder_key is not None:
+        return folder_key
+
+    if folder_path is not None:
+        return folders_service.retrieve_folder_key(folder_path=folder_path)
+
+    if context_folder_key is not None:
+        return context_folder_key
+
+    if context_folder_path is not None:
+        return folders_service.retrieve_folder_key(folder_path=context_folder_path)
+
+    raise ValueError("Failed to resolve folder key")

src/uipath/_services/context_grounding_service.py

@@ -7,7 +7,12 @@
 from .._config import Config
 from .._execution_context import ExecutionContext
 from .._folder_context import FolderContext
-from .._utils import Endpoint, RequestSpec, header_folder, resource_override
+from .._utils import (
+    Endpoint,
+    RequestSpec,
+    header_folder,
+    resource_override,
+)
 from .._utils.constants import (
     LLMV4_REQUEST,
     ORCHESTRATOR_STORAGE_BUCKET_DATA_SOURCE,
@@ -33,6 +38,7 @@
 from ..models.exceptions import UnsupportedDataSourceException
 from ..tracing import traced
 from ._base_service import BaseService
+from ._folder_helpers import resolve_folder_key
 from .buckets_service import BucketsService
 from .folder_service import FolderService
 
@@ -672,7 +678,13 @@ def _ingest_spec(
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
     ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         return RequestSpec(
             method="POST",
@@ -688,7 +700,13 @@ def _retrieve_spec(
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
     ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         return RequestSpec(
             method="GET",
@@ -726,7 +744,13 @@ def _create_spec(
         Returns:
             RequestSpec for the create index request
         """
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         data_source_dict = self._build_data_source(source)
 
@@ -828,7 +852,13 @@ def _retrieve_by_id_spec(
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
     ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         return RequestSpec(
             method="GET",
@@ -844,7 +874,13 @@ def _delete_by_id_spec(
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
     ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         return RequestSpec(
             method="DELETE",
@@ -862,7 +898,13 @@ def _search_spec(
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
     ) -> RequestSpec:
-        folder_key = self._resolve_folder_key(folder_key, folder_path)
+        folder_key = resolve_folder_key(
+            folder_key,
+            folder_path,
+            self._folders_service,
+            self._folder_key,
+            self._folder_path,
+        )
 
         return RequestSpec(
             method="POST",
@@ -876,22 +918,6 @@ def _search_spec(
             },
         )
 
-    def _resolve_folder_key(self, folder_key, folder_path):
-        if folder_key is None and folder_path is not None:
-            folder_key = self._folders_service.retrieve_key(folder_path=folder_path)
-
-        if folder_key is None and folder_path is None:
-            folder_key = self._folder_key or (
-                self._folders_service.retrieve_key(folder_path=self._folder_path)
-                if self._folder_path
-                else None
-            )
-
-        if folder_key is None:
-            raise ValueError("ContextGrounding: Failed to resolve folder key")
-
-        return folder_key
-
     def _extract_bucket_info(self, index: ContextGroundingIndex) -> Tuple[str, str]:
         """Extract bucket information from the index, validating it's a storage bucket data source.
 

tests/sdk/services/test_context_grounding_service.py

@@ -814,9 +814,10 @@ def test_all_requests_pass_spec_parameters(
         tenant: str,
     ) -> None:
         """Verify that all requests pass spec.method, spec.endpoint, spec.params, and spec.headers correctly."""
-        # Mock folder service to always return the test folder key
-        with patch.object(
-            service._folders_service, "retrieve_key", return_value="test-folder-key"
+        # Mock resolve_folder_key to always return the test folder key
+        with patch(
+            "uipath._services._folder_helpers.resolve_folder_key",
+            return_value="test-folder-key",
         ):
             # Test retrieve method
             with patch.object(service, "request") as mock_request: