Merge pull request #46 from NHSDigital/mm-mesh-1786-allow-transparent-compression

mesh-1786: allow transparent compression to be set on send message

Author: matt-mercer

mesh_client/__init__.py

@@ -305,6 +305,7 @@ def __init__(  # noqa: C901
         retry_status_force_list: Tuple[int, ...] = (425, 429, 502, 503, 504),
         retry_methods: Tuple[str, ...] = ("HEAD", "GET", "PUT", "POST", "DELETE", "OPTIONS", "TRACE"),
         timeout: Union[int, float] = 10 * 60,
+        application_name: Optional[str] = None,
     ):
         """
         Create a new MeshClient.
@@ -342,6 +343,8 @@ def __init__(  # noqa: C901
         self._close_called = False
 
         self._session = requests.Session()
+        application_name = (application_name or "").strip()
+        self._client_name = f"{application_name};mesh_client" if application_name else "mesh_client"
 
         if isinstance(url, str):
             endpoint_config = try_get_endpoint_from_url(url)
@@ -396,7 +399,7 @@ def __init__(  # noqa: C901
         self._session.headers = {
             "Accept": "application/vnd.mesh.v2+json",
             "User-Agent": (
-                f"mesh_client;{__version__};N/A;{platform.processor() or platform.machine()};"
+                f"{self._client_name};{__version__};N/A;{platform.processor() or platform.machine()};"
                 f"{platform.system()};{platform.release()} {platform.version()}"
             ),
             "Accept-Encoding": "gzip",
@@ -430,7 +433,7 @@ def handshake(self):
         https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api#post-/messageexchange/-mailbox_id-
         """
         headers = {
-            "mex-ClientVersion": f"mesh_client=={__version__}",
+            "mex-ClientVersion": f"{self._client_name}=={__version__}",
             "mex-OSArchitecture": platform.processor() or platform.machine(),
             "mex-OSName": platform.system(),
             "mex-OSVersion": f"{platform.release()} {platform.version()}",
@@ -547,6 +550,7 @@ def send_message(  # noqa: C901
         recipient: str,
         data,
         max_chunk_size: Optional[int] = None,
+        transparent_compress: Optional[bool] = None,
         **kwargs,
     ) -> str:
         """
@@ -577,7 +581,7 @@ def send_message(  # noqa: C901
         client will not attempt to compress or decompress data. Transparent
         compression for sending is enabled as a constructor option.
         """
-        transparent_compress = self._transparent_compress
+        transparent_compress = self._transparent_compress if transparent_compress is None else transparent_compress
 
         def maybe_compressed(maybe_compress: bytes):
             if not transparent_compress:

tests/mesh_sandbox_tests.py

@@ -191,11 +191,13 @@ def test_readlines(alice: MeshClient, bob: MeshClient):
 
 def test_transparent_compression(alice: MeshClient, bob: MeshClient):
     print("Sending")
-    alice._transparent_compress = True
-    message_id = alice.send_message(bob_mailbox, b"Hello Bob Compressed", workflow_id=uuid4().hex)
+    message_id = alice.send_message(
+        bob_mailbox, b"Hello Bob Compressed", workflow_id=uuid4().hex, transparent_compress=True
+    )
     assert bob.list_messages() == [message_id]
     print("Receiving")
     msg = bob.retrieve_message(message_id)
+    assert msg.compressed
     assert msg.read() == b"Hello Bob Compressed"
     assert msg.mex_header("from") == "ALICE"
     msg.acknowledge()