appmesh 1.5.7__py3-none-any.whl → 1.5.8__py3-none-any.whl

appmesh/http_client.py

@@ -1209,7 +1209,7 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         else:
             raise TypeError(f"Invalid timeout type: {str(timeout)}")
 
-    def run_task(self, app_name: str, data: str) -> str:
+    def run_task(self, app_name: str, data: str, timeout: int = 300) -> str:
         """Client send an invocation message to a running App Mesh application and wait for result.
 
         This method posts the provided `data` to the App Mesh service which will
@@ -1218,11 +1218,18 @@ class AppMeshClient(metaclass=abc.ABCMeta):
         Args:
             app_name (str): Name of the target application (as registered in App Mesh).
             data (str): Payload to deliver to the application. Typically a string.
+            timeout (int): Maximum time in seconds to wait for a response from the application. Defaults to 60 seconds.
 
         Returns:
             str: The HTTP response body returned by the remote application/service.
         """
-        resp = self._request_http(AppMeshClient.Method.POST, path=f"/appmesh/app/{app_name}/task", body=data)
+        path = f"/appmesh/app/{app_name}/task"
+        resp = self._request_http(
+            AppMeshClient.Method.POST,
+            path=path,
+            body=data,
+            query={"timeout": str(timeout)},
+        )
         if resp.status_code != HTTPStatus.OK:
             raise Exception(resp.text)
 

appmesh/http_server.py

@@ -2,11 +2,15 @@
 # pylint: disable=line-too-long,broad-exception-raised,broad-exception-caught,import-outside-toplevel,protected-access
 
 import abc
+import logging
 import os
 import time
+from typing import Optional, Tuple
 from http import HTTPStatus
 from .http_client import AppMeshClient
 
+logger = logging.getLogger(__name__)
+
 
 class AppMeshServer(metaclass=abc.ABCMeta):
     """
@@ -21,17 +25,27 @@ class AppMeshServer(metaclass=abc.ABCMeta):
         - task_return(): return results to the invoking client
 
     Example:
-        server = AppMeshServer()
-        payload = server.task_fetch()
-        server.task_return(result)
+        context = appmesh.AppMeshServer()
+        payload = context.task_fetch()
+        result = do_something_with(payload)
+        context.task_return(result)
     """
 
     def __init__(
         self,
         rest_url: str = "https://127.0.0.1:6060",
         rest_ssl_verify=AppMeshClient.DEFAULT_SSL_CA_CERT_PATH if os.path.exists(AppMeshClient.DEFAULT_SSL_CA_CERT_PATH) else False,
-        rest_ssl_client_cert=(AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH, AppMeshClient.DEFAULT_SSL_CLIENT_KEY_PATH) if os.path.exists(AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH) else None,
-        rest_timeout=(60, 300),
+        rest_ssl_client_cert=(
+            (
+                AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH,
+                AppMeshClient.DEFAULT_SSL_CLIENT_KEY_PATH,
+            )
+            if os.path.exists(AppMeshClient.DEFAULT_SSL_CLIENT_CERT_PATH)
+            else None
+        ),
+        rest_timeout: Tuple[float, float] = (60, 300),
+        *,
+        logger_: Optional[logging.Logger] = None,
     ):
         """Initialize an App Mesh HTTP client for interacting with the App Mesh server via secure HTTPS.
 
@@ -39,29 +53,41 @@ class AppMeshServer(metaclass=abc.ABCMeta):
             follows the same parameters as `AppMeshClient`.
         """
         self._client = AppMeshClient(rest_url, rest_ssl_verify, rest_ssl_client_cert, rest_timeout)
+        self._logger = logger_ or logger
+
+    @staticmethod
+    def _get_runtime_env() -> Tuple[str, str]:
+        """Read and validate required runtime environment variables."""
+        process_id = os.getenv("APP_MESH_PROCESS_ID")
+        app_name = os.getenv("APP_MESH_APPLICATION_NAME")
+        if not process_id:
+            raise Exception("Missing environment variable: APP_MESH_PROCESS_ID. This must be set by App Mesh service.")
+        if not app_name:
+            raise Exception("Missing environment variable: APP_MESH_APPLICATION_NAME. This must be set by App Mesh service.")
+        return process_id, app_name
 
     def task_fetch(self) -> str:
-        """Fetch invocation data in the currently running App Mesh application process.
+        """Fetch task data in the currently running App Mesh application process.
 
-        This helper is intended to be called by an application process running from App Mesh
-        to obtain the payload that a client pushed to it. It reads two required
-        environment variables set by the runtime:
+        Used by App Mesh application process to obtain the payload from App Mesh service
+        that a client pushed to it.
 
-        - APP_MESH_PROCESS_ID: the process UUID for this invocation
-        - APP_MESH_APPLICATION_NAME: the application name
 
         Returns:
             str: The payload provided by the client as returned by the service.
         """
-        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
-        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
+        process_id, app_name = self._get_runtime_env()
+        path = f"/appmesh/app/{app_name}/task"
+
         while True:
             resp = self._client._request_http(
                 AppMeshClient.Method.GET,
-                path=f"/appmesh/app/{app_name}/task",
-                query={"process_uuid": process_uuid},
+                path=path,
+                query={"process_uuid": process_id},
             )
+
             if resp.status_code != HTTPStatus.OK:
+                self._logger.warning(f"task_fetch failed with status {resp.status_code}: {resp.text}, retrying...")
                 time.sleep(0.1)
                 continue
 
@@ -70,20 +96,23 @@ class AppMeshServer(metaclass=abc.ABCMeta):
     def task_return(self, result: str) -> None:
         """Return the result of a server-side invocation back to the original client.
 
-        The method posts the `result` associated with the current process UUID so
-        the invoking client can retrieve it. The same environment variables used by
-        `task_fetch` are required to identify the target process.
+        Used by App Mesh application process to posts the `result` to App Mesh service
+        after processed payload data so the invoking client can retrieve it.
 
         Args:
             result (str): Result payload to be delivered back to the client.
         """
-        process_uuid = os.environ["APP_MESH_PROCESS_ID"]
-        app_name = os.environ["APP_MESH_APPLICATION_NAME"]
+        process_id, app_name = self._get_runtime_env()
+        path = f"/appmesh/app/{app_name}/task"
+
         resp = self._client._request_http(
             AppMeshClient.Method.PUT,
-            path=f"/appmesh/app/{app_name}/task",
-            query={"process_uuid": process_uuid},
+            path=path,
+            query={"process_uuid": process_id},
             body=result,
         )
+
         if resp.status_code != HTTPStatus.OK:
-            raise Exception(resp.text)
+            msg = f"task_return failed with status {resp.status_code}: {resp.text}"
+            self._logger.error(msg)
+            raise Exception(msg)

appmesh/tcp_server.py

@@ -2,32 +2,34 @@
 # pylint: disable=line-too-long,broad-exception-raised,broad-exception-caught,import-outside-toplevel,protected-access
 
 import os
+import logging
+from typing import Optional, Tuple
 from .http_client import AppMeshClient
 from .tcp_client import AppMeshClientTCP
 from .http_server import AppMeshServer
 
+logger = logging.getLogger(__name__)
+
 
 class AppMeshServerTCP(AppMeshServer):
     """
-    Server SDK for interacting with the local App Mesh service over TCP.
-
-    Attributes:
-        - Inherits all attributes from `AppMeshServer`.
-
-    Methods:
-        - Inherits all methods from `AppMeshServer`.
+    Server SDK for interacting with the local App Mesh service over TCP (TLS).
     """
 
     def __init__(
         self,
         rest_ssl_verify=AppMeshClient.DEFAULT_SSL_CA_CERT_PATH if os.path.exists(AppMeshClient.DEFAULT_SSL_CA_CERT_PATH) else False,
         rest_ssl_client_cert=None,
-        tcp_address=("localhost", 6059),
+        tcp_address: Tuple[str, int] = ("localhost", 6059),
+        *,
+        logger_: Optional[logging.Logger] = None,
     ):
         """Construct an App Mesh server TCP object to communicate securely with an App Mesh server over TLS.
 
         Args:
             follows the same parameters as `AppMeshClientTCP`.
         """
+        # Deliberately avoid calling super().__init__ to inject a TCP client while keeping the same public API.
         object.__init__(self)
         self._client = AppMeshClientTCP(rest_ssl_verify=rest_ssl_verify, rest_ssl_client_cert=rest_ssl_client_cert, tcp_address=tcp_address)
+        self._logger = logger_ or logger

{appmesh-1.5.7.dist-info → appmesh-1.5.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appmesh
-Version: 1.5.7
+Version: 1.5.8
 Summary: Client SDK for App Mesh
 Home-page: https://github.com/laoshanxi/app-mesh
 Author: laoshanxi

{appmesh-1.5.7.dist-info → appmesh-1.5.8.dist-info}/RECORD

@@ -3,13 +3,13 @@ appmesh/app.py,sha256=9Q-SOOej-MH13BU5Dv2iTa-p-sECCJQp6ZX9DjWWmwE,10526
 appmesh/app_output.py,sha256=JK_TMKgjvaw4n_ys_vmN5S4MyWVZpmD7NlKz_UyMIM8,1015
 appmesh/app_run.py,sha256=9ISKGZ3k3kkbQvSsPfRfkOLqD9xhbqNOM7ork9F4w9c,1712
 appmesh/appmesh_client.py,sha256=0ltkqHZUq094gKneYmC0bEZCP0X9kHTp9fccKdWFWP0,339
-appmesh/http_client.py,sha256=G_T0VDnGf1_CNMYaHHmjfZ_XgMDyC21GBE0zgn4Bh3s,57185
-appmesh/http_server.py,sha256=u4oGtZr8e1AnDvmiyN-6pX-nUpzDK24di0mSl6gJgL0,3467
+appmesh/http_client.py,sha256=j7OIHiRKeFs8o4zTT-tOcCwaYfeACzL86lmz1E2UP_M,57437
+appmesh/http_server.py,sha256=HOE6DMzmo6FR16aSUQjSDLua_Q8o8807MNhPaAt-abs,4264
 appmesh/tcp_client.py,sha256=yi0n2NpBBCA-JHYWQPPE_1euE7Oz6JHBe1op7lypTXY,10999
 appmesh/tcp_messages.py,sha256=w1Kehz_aX4X2CYAUsy9mFVJRhxnLQwwc6L58W4YkQqs,969
-appmesh/tcp_server.py,sha256=c6lNM8OgYUVREs7gn2okt57PYOEfqcUuExCtL4D-xbE,1166
+appmesh/tcp_server.py,sha256=42YW3-hU82AwhE32DF4Gn6GucSg5qNJavP7xGSrpBVc,1353
 appmesh/tcp_transport.py,sha256=-XDTQbsKL3yCbguHeW2jNqXpYgnCyHsH4rwcaJ46AS8,8645
-appmesh-1.5.7.dist-info/METADATA,sha256=dFSkl2YjZYHYZop6QQ6X-T94zLmut_nJqJwt0vrK4CQ,11768
-appmesh-1.5.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-appmesh-1.5.7.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
-appmesh-1.5.7.dist-info/RECORD,,
+appmesh-1.5.8.dist-info/METADATA,sha256=iSbvWio_TfOfwA-xXU4ZsSWENhl-FDoAUkJrSZRyaz4,11768
+appmesh-1.5.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+appmesh-1.5.8.dist-info/top_level.txt,sha256=-y0MNQOGJxUzLdHZ6E_Rfv5_LNCkV-GTmOBME_b6pg8,8
+appmesh-1.5.8.dist-info/RECORD,,