feat: filter app schemas by folder key (#1424)

Author: radu-mocanu

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.0.23"
+version = "0.0.24"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-platform/src/uipath/platform/action_center/_tasks_service.py

@@ -1,7 +1,7 @@
 import asyncio
 import os
 import uuid
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional
 
 from uipath.core.tracing import traced
 
@@ -395,12 +395,12 @@ async def create_async(
         Raises:
             Exception: If neither app_name nor app_key is provided for app-specific actions
         """
-        app_folder_path = app_folder_path if app_folder_path else self._folder_path
-
         (key, action_schema) = (
             (app_key, None)
             if app_key
-            else await self._get_app_key_and_schema_async(app_name, app_folder_path)
+            else await self._get_app_key_and_schema_async(
+                app_name, app_folder_path, app_folder_key
+            )
         )
         spec = _create_spec(
             title=title,
@@ -481,12 +481,10 @@ def create(
         Raises:
             Exception: If neither app_name nor app_key is provided for app-specific actions
         """
-        app_folder_path = app_folder_path if app_folder_path else self._folder_path
-
         (key, action_schema) = (
             (app_key, None)
             if app_key
-            else self._get_app_key_and_schema(app_name, app_folder_path)
+            else self._get_app_key_and_schema(app_name, app_folder_path, app_folder_key)
         )
         spec = _create_spec(
             title=title,
@@ -588,8 +586,11 @@ async def retrieve_async(
         return Task.model_validate(response.json())
 
     async def _get_app_key_and_schema_async(
-        self, app_name: Optional[str], app_folder_path: Optional[str]
-    ) -> Tuple[str, Optional[TaskSchema]]:
+        self,
+        app_name: str | None,
+        app_folder_path: str | None,
+        app_folder_key: str | None,
+    ) -> tuple[str, TaskSchema | None]:
         if not app_name:
             raise Exception("appName or appKey is required")
         spec = _retrieve_app_key_spec(app_name=app_name)
@@ -603,7 +604,7 @@ async def _get_app_key_and_schema_async(
         )
         try:
             deployed_app = self._extract_deployed_app(
-                response.json()["deployed"], app_folder_path
+                response.json()["deployed"], app_name, app_folder_path, app_folder_key
             )
             action_schema = deployed_app["actionSchema"]
             deployed_app_key = deployed_app["systemName"]
@@ -624,8 +625,11 @@ async def _get_app_key_and_schema_async(
             raise Exception("Failed to deserialize action schema") from KeyError
 
     def _get_app_key_and_schema(
-        self, app_name: Optional[str], app_folder_path: Optional[str]
-    ) -> Tuple[str, Optional[TaskSchema]]:
+        self,
+        app_name: str | None,
+        app_folder_path: str | None,
+        app_folder_key: str | None,
+    ) -> tuple[str, TaskSchema | None]:
         if not app_name:
             raise Exception("appName or appKey is required")
 
@@ -641,7 +645,7 @@ def _get_app_key_and_schema(
 
         try:
             deployed_app = self._extract_deployed_app(
-                response.json()["deployed"], app_folder_path
+                response.json()["deployed"], app_name, app_folder_path, app_folder_key
             )
             action_schema = deployed_app["actionSchema"]
             deployed_app_key = deployed_app["systemName"]
@@ -661,27 +665,45 @@ def _get_app_key_and_schema(
         except KeyError:
             raise Exception("Failed to deserialize action schema") from KeyError
 
-    # should be removed after folder filtering support is added on apps API
     def _extract_deployed_app(
-        self, deployed_apps: List[Dict[str, Any]], app_folder_path: Optional[str]
-    ) -> Dict[str, Any]:
-        if len(deployed_apps) > 1 and not app_folder_path:
-            raise Exception("Multiple app schemas found")
-        try:
-            if app_folder_path:
-                return next(
-                    app
-                    for app in deployed_apps
-                    if app["deploymentFolder"]["fullyQualifiedName"] == app_folder_path
-                )
-            else:
+        self,
+        deployed_apps: list[dict[str, Any]],
+        app_name: str,
+        app_folder_path: str | None,
+        app_folder_key: str | None,
+    ) -> dict[str, Any]:
+        # try extracting the requested app schema. folder path has priority over folder key
+        filtered_apps_by_name = [
+            app for app in deployed_apps if app["deploymentTitle"] == app_name
+        ]
+        if len(filtered_apps_by_name) < 1:
+            raise Exception(f"App '{app_name}' was not found in the current tenant")
+
+        # priority: app_folder_path -> app_folder_key -> self._folder_path -> self._folder_key
+        candidates = [
+            (app_folder_path, "fullyQualifiedName", "fully qualified name"),
+            (app_folder_key, "key", "identifier"),
+            (self._folder_path, "fullyQualifiedName", "fully qualified name"),
+            (self._folder_key, "key", "identifier"),
+        ]
+
+        for value, field, label in candidates:
+            if not value:
+                continue
+            try:
                 return next(
                     app
-                    for app in deployed_apps
-                    if app["deploymentFolder"]["key"] == self._folder_key
+                    for app in filtered_apps_by_name
+                    if app["deploymentFolder"][field] == value
                 )
-        except StopIteration:
-            raise KeyError from StopIteration
+            except StopIteration:
+                raise Exception(
+                    f"App '{app_name}' was not found in folder with {label} '{value}'"
+                ) from StopIteration
+
+        raise Exception(
+            f"App '{app_name}' was found but no folder key or folder path was provided to select a deployment"
+        )
 
     @property
     def custom_headers(self) -> Dict[str, str]: