refactor: reference platform constants instead of hardcoded strings (#1747)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: vldcmp-uipath

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.1.82"
+version = "0.1.83"
 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/chat/_llm_gateway_service.py

@@ -27,6 +27,7 @@
 from ..common._endpoints_manager import EndpointManager
 from ..common._execution_context import UiPathExecutionContext
 from ..common._models import Endpoint
+from ..common.constants import HEADER_AGENTHUB_CONFIG
 from .llm_gateway import (
     ChatCompletion,
     SpecificToolChoice,
@@ -59,7 +60,7 @@ def _build_llm_headers(
         "X-UiPath-LlmGateway-RequestingFeature": requesting_feature,
     }
     if agenthub_config:
-        headers["X-UiPath-AgentHub-Config"] = agenthub_config
+        headers[HEADER_AGENTHUB_CONFIG] = agenthub_config
     if action_id:
         headers["X-UiPath-LlmGateway-ActionId"] = action_id
     return headers

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

@@ -15,6 +15,7 @@
 import os
 
 from ._config import UiPathConfig
+from .constants import HEADER_INTERNAL_ACCOUNT_ID, HEADER_INTERNAL_TENANT_ID
 
 
 def resolve_service_url(endpoint_path: str) -> str | None:
@@ -57,8 +58,8 @@ def inject_routing_headers(headers: dict[str, str]) -> None:
     """
     tenant_id = UiPathConfig.tenant_id
     if tenant_id:
-        headers["X-UiPath-Internal-TenantId"] = tenant_id
+        headers[HEADER_INTERNAL_TENANT_ID] = tenant_id
 
     organization_id = UiPathConfig.organization_id
     if organization_id:
-        headers["X-UiPath-Internal-AccountId"] = organization_id
+        headers[HEADER_INTERNAL_ACCOUNT_ID] = organization_id

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

@@ -15,6 +15,17 @@
 from pydantic import BaseModel, ConfigDict, Field
 from uipath.core.serialization import serialize_json
 
+from .constants import (
+    ENV_FOLDER_KEY,
+    ENV_JOB_KEY,
+    ENV_ORGANIZATION_ID,
+    ENV_PROCESS_KEY,
+    ENV_TENANT_ID,
+    ENV_UIPATH_PROCESS_UUID,
+    ENV_UIPATH_PROCESS_VERSION,
+    ENV_UIPATH_TRACE_ID,
+)
+
 logger = logging.getLogger(__name__)
 
 
@@ -201,25 +212,25 @@ class UiPathSpan:
     # serializer, and even null fails for the required OrganizationId/FolderKey.
     # In the platform runtime these are always set to real GUIDs.
     organization_id: Optional[str] = field(
-        default_factory=lambda: env.get("UIPATH_ORGANIZATION_ID") or None
+        default_factory=lambda: env.get(ENV_ORGANIZATION_ID) or None
     )
     tenant_id: Optional[str] = field(
-        default_factory=lambda: env.get("UIPATH_TENANT_ID") or None
+        default_factory=lambda: env.get(ENV_TENANT_ID) or None
     )
     expiry_time_utc: Optional[str] = None
     folder_key: Optional[str] = field(
-        default_factory=lambda: env.get("UIPATH_FOLDER_KEY") or None
+        default_factory=lambda: env.get(ENV_FOLDER_KEY) or None
     )
     source: SpanSource = SpanSource.CODED_AGENTS
     span_type: str = "Coded Agents"
     process_key: Optional[str] = field(
-        default_factory=lambda: env.get("UIPATH_PROCESS_UUID")
+        default_factory=lambda: env.get(ENV_UIPATH_PROCESS_UUID)
     )
     reference_id: Optional[str] = field(
         default_factory=lambda: env.get("TRACE_REFERENCE_ID")
     )
 
-    job_key: Optional[str] = field(default_factory=lambda: env.get("UIPATH_JOB_KEY"))
+    job_key: Optional[str] = field(default_factory=lambda: env.get(ENV_JOB_KEY))
 
     # Top-level fields for internal tracing schema
     execution_type: Optional[ExecutionType] = None
@@ -341,7 +352,7 @@ def otel_span_to_uipath_span(
         span_id = format(span_context.span_id, "016x")
 
         # Override trace_id if custom or env var provided (supports both UUID and hex format)
-        trace_id_override = custom_trace_id or os.environ.get("UIPATH_TRACE_ID")
+        trace_id_override = custom_trace_id or os.environ.get(ENV_UIPATH_TRACE_ID)
         if trace_id_override:
             trace_id = _SpanUtils.normalize_trace_id(trace_id_override)
 
@@ -420,8 +431,8 @@ def otel_span_to_uipath_span(
 
         # Add process context attributes from environment variables
         for env_key, attr_key in (
-            ("UIPATH_PROCESS_KEY", "agentName"),
-            ("UIPATH_PROCESS_VERSION", "agentVersion"),
+            (ENV_PROCESS_KEY, "agentName"),
+            (ENV_UIPATH_PROCESS_VERSION, "agentVersion"),
         ):
             value = env.get(env_key)
             if value:

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

@@ -4,6 +4,10 @@
     inject_routing_headers,
     resolve_service_url,
 )
+from uipath.platform.common.constants import (
+    HEADER_INTERNAL_ACCOUNT_ID,
+    HEADER_INTERNAL_TENANT_ID,
+)
 
 
 class TestResolveServiceUrl:
@@ -68,16 +72,16 @@ def test_injects_tenant_and_org(self, monkeypatch: pytest.MonkeyPatch) -> None:
         monkeypatch.setenv("UIPATH_ORGANIZATION_ID", "org-456")
         headers: dict[str, str] = {}
         inject_routing_headers(headers)
-        assert headers["X-UiPath-Internal-TenantId"] == "tenant-123"
-        assert headers["X-UiPath-Internal-AccountId"] == "org-456"
+        assert headers[HEADER_INTERNAL_TENANT_ID] == "tenant-123"
+        assert headers[HEADER_INTERNAL_ACCOUNT_ID] == "org-456"
 
     def test_skips_missing_env_vars(self, monkeypatch: pytest.MonkeyPatch) -> None:
         monkeypatch.delenv("UIPATH_TENANT_ID", raising=False)
         monkeypatch.delenv("UIPATH_ORGANIZATION_ID", raising=False)
         headers: dict[str, str] = {}
         inject_routing_headers(headers)
-        assert "X-UiPath-Internal-TenantId" not in headers
-        assert "X-UiPath-Internal-AccountId" not in headers
+        assert HEADER_INTERNAL_TENANT_ID not in headers
+        assert HEADER_INTERNAL_ACCOUNT_ID not in headers
 
     def test_does_not_overwrite_existing_headers(
         self, monkeypatch: pytest.MonkeyPatch
@@ -87,4 +91,4 @@ def test_does_not_overwrite_existing_headers(
         headers: dict[str, str] = {"X-Custom": "keep-me"}
         inject_routing_headers(headers)
         assert headers["X-Custom"] == "keep-me"
-        assert headers["X-UiPath-Internal-TenantId"] == "tenant-123"
+        assert headers[HEADER_INTERNAL_TENANT_ID] == "tenant-123"

packages/uipath-platform/uv.lock

@@ -1,13 +1,13 @@
 [project]
 name = "uipath"
-version = "2.11.16"
+version = "2.11.17"
 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.11"
 dependencies = [
   "uipath-core>=0.5.26, <0.6.0",
   "uipath-runtime>=0.11.5, <0.12.0",
-  "uipath-platform>=0.1.82, <0.2.0",
+  "uipath-platform>=0.1.83, <0.2.0",
   "click>=8.3.1",
   "httpx>=0.28.1",
   "pyjwt>=2.10.1",

packages/uipath/pyproject.toml

@@ -9,6 +9,12 @@
 from uipath._cli._utils._console import ConsoleLogger
 from uipath._utils._auth import update_env_file
 from uipath.platform.common import ExternalApplicationService, TokenData
+from uipath.platform.common.constants import (
+    ENV_BASE_URL,
+    ENV_ORGANIZATION_ID,
+    ENV_TENANT_ID,
+    ENV_UIPATH_ACCESS_TOKEN,
+)
 
 from ._utils import update_auth_file
 
@@ -61,17 +67,17 @@ async def _authenticate_client_credentials(self):
             )
 
         env_vars = {
-            "UIPATH_ACCESS_TOKEN": token_data.access_token,
-            "UIPATH_URL": external_app_service._base_url,
-            "UIPATH_ORGANIZATION_ID": get_parsed_token_data(token_data).get("prt_id"),
+            ENV_UIPATH_ACCESS_TOKEN: token_data.access_token,
+            ENV_BASE_URL: external_app_service._base_url,
+            ENV_ORGANIZATION_ID: get_parsed_token_data(token_data).get("prt_id"),
         }
 
         if tenant_name:
             self._tenant = tenant_name
             auth_session = AuthSession(self._domain)
             auth_session.update_token_data(token_data)
             tenant_info = await auth_session.resolve_tenant_info(self._tenant)
-            env_vars["UIPATH_TENANT_ID"] = tenant_info["tenant_id"]
+            env_vars[ENV_TENANT_ID] = tenant_info["tenant_id"]
         else:
             self._console.warning("Could not extract tenant from --base-url.")
         update_env_file(env_vars)
@@ -90,10 +96,10 @@ async def _authenticate_authorization_code(self) -> None:
 
         update_env_file(
             {
-                "UIPATH_ACCESS_TOKEN": token_data.access_token,
-                "UIPATH_URL": uipath_url,
-                "UIPATH_TENANT_ID": tenant_info["tenant_id"],
-                "UIPATH_ORGANIZATION_ID": tenant_info["organization_id"],
+                ENV_UIPATH_ACCESS_TOKEN: token_data.access_token,
+                ENV_BASE_URL: uipath_url,
+                ENV_TENANT_ID: tenant_info["tenant_id"],
+                ENV_ORGANIZATION_ID: tenant_info["organization_id"],
             }
         )
 
@@ -110,9 +116,9 @@ async def _authenticate_authorization_code(self) -> None:
 
     async def _can_reuse_existing_token(self, auth_session: AuthSession) -> bool:
         if (
-            os.getenv("UIPATH_URL")
-            and os.getenv("UIPATH_TENANT_ID")
-            and os.getenv("UIPATH_ORGANIZATION_ID")
+            os.getenv(ENV_BASE_URL)
+            and os.getenv(ENV_TENANT_ID)
+            and os.getenv(ENV_ORGANIZATION_ID)
         ):
             try:
                 await auth_session.ensure_valid_token()

packages/uipath/src/uipath/_cli/_auth/_auth_service.py

@@ -3,6 +3,7 @@
 import click
 
 from uipath.platform.common import TokenData
+from uipath.platform.common.constants import ENV_UIPATH_ACCESS_TOKEN
 from uipath.platform.identity import IdentityService
 from uipath.platform.portal import (
     PortalService as PlatformPortalService,
@@ -95,7 +96,7 @@ async def ensure_valid_token(self):
         def finalize(token_data: TokenData):
             self.update_token_data(token_data)
             update_auth_file(token_data)
-            update_env_file({"UIPATH_ACCESS_TOKEN": token_data.access_token})
+            update_env_file({ENV_UIPATH_ACCESS_TOKEN: token_data.access_token})
 
         if exp is not None and float(exp) > time.time():
             finalize(auth_data)

packages/uipath/src/uipath/_cli/_auth/_auth_session.py

@@ -2,6 +2,7 @@
 from typing import Tuple
 from urllib.parse import urlparse
 
+from ...platform.common.constants import ENV_BASE_URL
 from .._utils._console import ConsoleLogger
 
 console = ConsoleLogger()
@@ -26,7 +27,7 @@ def resolve_domain(base_url: str | None, environment: str | None) -> str:
             return domain
 
     if environment is None:
-        uipath_url = os.getenv("UIPATH_URL")
+        uipath_url = os.getenv(ENV_BASE_URL)
         if uipath_url:
             parsed = urlparse(uipath_url)
             if parsed.scheme and parsed.netloc: