Fix sync client Configuration (#341)

Author: IgorChvyrov-sm

src/conductor/client/configuration/configuration.py

@@ -4,7 +4,9 @@
 
 import logging
 import os
+import re
 import time
+import warnings
 from typing import Optional, Dict, Union
 
 from conductor.shared.configuration.settings.authentication_settings import (
@@ -113,7 +115,13 @@ def __init__(
         if server_api_url is not None:
             self.host = server_api_url
         elif base_url is not None:
-            self.host = base_url + "/api"
+            if re.search(r'/api(/|$)', base_url):
+                warnings.warn(
+                    "'base_url' been passed with '/api' path. Consider using 'server_api_url' instead"
+                )
+            else:
+                base_url += "/api"
+            self.host = base_url
         else:
             self.host = os.getenv("CONDUCTOR_SERVER_URL")
 
@@ -131,9 +139,7 @@ def __init__(
             key = os.getenv("CONDUCTOR_AUTH_KEY")
             secret = os.getenv("CONDUCTOR_AUTH_SECRET")
             if key is not None and secret is not None:
-                self.authentication_settings = AuthenticationSettings(
-                    key_id=key, key_secret=secret
-                )
+                self.authentication_settings = AuthenticationSettings(key_id=key, key_secret=secret)
             else:
                 self.authentication_settings = None
 

src/conductor/client/http/models/__init__.py

@@ -257,6 +257,9 @@
 from conductor.client.http.models.start_workflow import StartWorkflow
 from conductor.shared.http.enums.idempotency_strategy import IdempotencyStrategy
 from conductor.client.http.models.task_result_status import TaskResultStatus
+from conductor.client.http.models.task_details import TaskDetails
+from conductor.client.http.models.terminate_workflow import TerminateWorkflow
+from conductor.client.http.models.update_workflow_variables import UpdateWorkflowVariables
 
 __all__ = [  # noqa: RUF022
     "Action",
@@ -403,4 +406,7 @@
     "StateChangeEventType",
     "StateChangeConfig",
     "TaskResultStatus",
+    "TaskDetails",
+    "TerminateWorkflow",
+    "UpdateWorkflowVariables",
 ]

tests/unit/configuration/test_configuration.py

@@ -1,4 +1,5 @@
 import base64
+import warnings
 import json
 
 from conductor.client.configuration.configuration import Configuration
@@ -34,6 +35,54 @@ def test_initialization_with_basic_auth_server_api_url():
     }
 
 
+def test_base_url_with_api_path():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://domain.com/api")
+        assert len(w) == 1
+        assert "base_url' been passed with '/api' path" in str(w[0].message)
+        assert configuration.host == "https://domain.com/api"
+
+
+def test_base_url_with_api_path_and_version():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://domain.com/api/v1")
+        assert len(w) == 1
+        assert "base_url' been passed with '/api' path" in str(w[0].message)
+        assert configuration.host == "https://domain.com/api/v1"
+
+
+def test_base_url_with_api_subdomain_no_warning():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://api.domain.com")
+        assert len(w) == 0
+        assert configuration.host == "https://api.domain.com/api"
+
+
+def test_valid_base_url_no_warning():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://domain.com")
+        assert len(w) == 0
+        assert configuration.host == "https://domain.com/api"
+
+
+def test_base_url_with_port_no_warning():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://domain.com:8080")
+        assert len(w) == 0
+        assert configuration.host == "https://domain.com:8080/api"
+
+
+def test_base_url_with_api_subdomain_and_port_no_warning():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        configuration = Configuration(base_url="https://api.domain.com:8080")
+        assert len(w) == 0
+        assert configuration.host == "https://api.domain.com:8080/api"
 def test_ssl_ca_cert_initialization():
     configuration = Configuration(
         base_url="https://internal.conductor.dev", ssl_ca_cert="/path/to/ca-cert.pem"