intersect-sdk-common 0.9.3__tar.gz → 0.9.4__tar.gz

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: intersect-sdk-common
-Version: 0.9.3
+Version: 0.9.4
 Summary: Python SDK to interact with INTERSECT
 Keywords: intersect
 Author: Lance Drane, Marshall McDonnell, Seth Hitefield, Andrew Ayres, Gregory Cage, Jesse McGaha, Robert Smith, Gavin Wiggins, Michael Brim, Rick Archibald, Addi Malviya Thakur
@@ -48,5 +48,5 @@ The INTERSECT-SDK MUST follow semantic versioning, and MUST update its semantic
 ```bash
 uv venv .venv
 source .venv/bin/activate
-uv sync --locked --all-extras --all-groups
+uv sync --all-extras --all-groups
 ```

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/README.md

@@ -28,5 +28,5 @@ The INTERSECT-SDK MUST follow semantic versioning, and MUST update its semantic
 ```bash
 uv venv .venv
 source .venv/bin/activate
-uv sync --locked --all-extras --all-groups
+uv sync --all-extras --all-groups
 ```

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/pyproject.toml

@@ -18,7 +18,7 @@ readme = "README.md"
 license = { text = "BSD-3-Clause" }
 requires-python = ">=3.10,<4.0"
 keywords = ["intersect"]
-version = "0.9.3"
+version = "0.9.4"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
@@ -34,13 +34,15 @@ dependencies = [
 ]
 
 [dependency-groups]
-lint = [
+dev = [
     "pre-commit>=3.3.1",
     "ruff==0.12.7",
     "mypy>=1.10.0",
     "codespell>=2.3.0",
+    "pytest>=7.3.2",
+    "pytest-cov>=4.1.0",
+    "httpretty>=1.1.4",
 ]
-test = ["pytest>=7.3.2", "pytest-cov>=4.1.0", "httpretty>=1.1.4"]
 
 [build-system]
 requires = ["uv_build>=0.10.2,<0.11.0"]

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/src/intersect_sdk_common/control_plane/brokers/amqp_client.py

@@ -223,17 +223,22 @@ class AMQPClient(BrokerClient):
         else:
             logger.error('Unable to publish message %s on topic %s', payload, topic)
 
-    def subscribe(self, topic: str, persist: bool) -> None:
+    def subscribe(self, topic: str, persist: bool, queue_name: str) -> None:
         """Subscribe to a topic.
 
         topic: system-of-system hierarchy. In AMQP parlance this gets translated to the routing key.
         persist: If True, we will create an idempotent queue name which should persist
           even on broker or application shutdown. If False, we will allow the server to create a unique
           queue name, and the queue will be destroyed once the associated channel is closed.
+        queue_name: The name of the queue to subscribe to.
         """
         topic = _hierarchy_2_amqp(topic)
         cb = functools.partial(
-            self._create_queue, channel=self._channel_in, topic=topic, persist=persist
+            self._create_queue,
+            channel=self._channel_in,
+            topic=topic,
+            persist=persist,
+            queue_name=queue_name,
         )
         self._connection.ioloop.add_callback_threadsafe(cb)
 

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/src/intersect_sdk_common/control_plane/brokers/broker_client.py

@@ -55,7 +55,7 @@ class BrokerClient(Protocol):
         """
         ...
 
-    def subscribe(self, topic: str, persist: bool) -> None:
+    def subscribe(self, topic: str, persist: bool, queue_name: str) -> None:
         """Subscribe to a topic over the pre-existing connection (via connect()).
 
         This function should ALSO be called by reconnect handlers, and not just directly.
@@ -64,6 +64,7 @@ class BrokerClient(Protocol):
         Args:
             topic: Topic to subscribe to.
             persist: Whether or not the queue subscribed to is intended to be long-lived.
+            queue_name: The name of the queue to subscribe to. Used or ignored depending on the protocol.
         """
         ...
 

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/src/intersect_sdk_common/control_plane/brokers/mqtt_client.py

@@ -35,7 +35,6 @@ _MQTT_MAX_RETRIES = 10
 # this will be a breaking change, so only add it when ready to break
 def _hierarchy_2_mqtt(hierarchy: str) -> str:
     """Take the hierarchy string format saved in the Service and map it to the MQTT topic format. Currently just covers wildcards."""
-    # return hierarchy.replace('#', '+')
     return hierarchy.replace('*', '+')
 
 
@@ -166,12 +165,13 @@ class MQTTClient(BrokerClient):
             resolved_topic, payload, qos=self._max_supported_qos if persist else 0, properties=props
         )
 
-    def subscribe(self, topic: str, persist: bool) -> None:
+    def subscribe(self, topic: str, persist: bool, queue_name: str) -> None:  # noqa: ARG002
         """Subscribe to a topic over the pre-existing connection (via connect()).
 
         Args:
             topic: Topic to subscribe to.
             persist: Determine if the associated message queue of the topic is long-lived (True) or not (False)
+            queue_name: The name of the queue to subscribe to. Ignored with current MQTT implementation.
         """
         resolved_topic = _hierarchy_2_mqtt(topic)
         # NOTE: RabbitMQ only works with QOS of 1 and 0, and seems to convert QOS2 to QOS1
@@ -302,7 +302,7 @@ class MQTTClient(BrokerClient):
 
             self._connected_flag.set()
             for topic, topic_handler in self._control_plane_manager.get_all_subscription_channels():
-                self.subscribe(topic, topic_handler.topic_persist)
+                self.subscribe(topic, topic_handler.topic_persist, topic_handler.queue_name)
         else:
             # This will generally suggest a misconfiguration
             self._connected = False

{intersect_sdk_common-0.9.3 → intersect_sdk_common-0.9.4}/src/intersect_sdk_common/control_plane/control_plane_manager.py

@@ -115,7 +115,7 @@ class ControlPlaneManager:
             topic_handler.queue_name = queue_name
         if self.is_connected():
             for provider in self._control_providers:
-                provider.subscribe(channel, persist)
+                provider.subscribe(channel, persist, queue_name)
 
     def remove_subscription_channel(self, channel: str) -> bool:
         """Stop subscribing to a channel on all configured brokers.

intersect_sdk_common-0.9.4/src/intersect_sdk_common/control_plane/custom_binary_protocol.py

@@ -0,0 +1,77 @@
+"""This module contains the binary specification for an INTERSECT message IF the protocol does not provide any built-in header support. If it does, use the built-in functionality of the protocol.
+
+Some protocols do not have any built-in header support, leaving it up to us to define the binary structure of the message. We want to avoid "chunking" messages into multiple parts, so a message should be guaranteed to include all metadata.
+"""
+
+from intersect_sdk_common import IntersectApplicationError
+
+_HEADER_KV_SEPARATOR = b'\x02'
+"""Indicates end of a header key and start of a header value.
+
+Used because applications should generally assign no special meaning to this byte, and this byte has no reason to appear in header keys or values.
+"""
+_HEADER_VALUE_SEPARATOR = b'\x03'
+"""Indicates end of a header value and start of the next header key.
+
+Used because applications should generally assign no special meaning to this byte, and this byte has no reason to appear in header keys or values.
+"""
+_PAYLOAD_SEPARATOR = b'\x01'
+"""Indicates end of headers and start of the payload.
+
+Used because applications should generally assign no special meaning to this byte, and this byte has no reason to appear in header keys or values.
+"""
+
+_TOTAL_REASONABLE_HEADER_BYTES = 131072
+"""The total number of bytes that should be reasonably expected to be used for header keys, values, and header separators combined. This provides applications with some level of DOS protection.
+
+It is rare in practice for ANY application to use this number of bytes for the total amount of headers, for example http2_max_header_size in NGINX is rarely set above 128KB
+"""
+
+CONTENT_TYPE_HEADER_KEY = 'content_type'
+CONTENT_TYPE_HEADER_KEY_BYTES = CONTENT_TYPE_HEADER_KEY.encode()
+
+
+def create_binary_message(body: bytes, content_type: str, headers: dict[str, str]) -> bytes:
+    """Create a binary message from the body, headers, and content type."""
+    return b''.join(
+        [
+            # content-type 'header' first (this is generally handled separately from other headers in many protocols)
+            CONTENT_TYPE_HEADER_KEY_BYTES,
+            _HEADER_KV_SEPARATOR,
+            content_type.encode(),
+            _HEADER_VALUE_SEPARATOR if len(headers) else b'',
+            # headers
+            _HEADER_VALUE_SEPARATOR.join(
+                _HEADER_KV_SEPARATOR.join([key.encode(), value.encode()])
+                for key, value in headers.items()
+            ),
+            # end of headers
+            _PAYLOAD_SEPARATOR,
+            # body
+            body,
+        ]
+    )
+
+
+def parse_binary_message(message: bytes) -> tuple[bytes, str, dict[str, str]]:
+    """Parse a binary message into its body, content type, and headers."""
+    # IMPORTANT!!! ----- Total length of header keys and values combined should be limited to first several bytes, terminate header search early if headers aren't a reasonable length.
+    payload_sep_location = message.find(_PAYLOAD_SEPARATOR, 0, _TOTAL_REASONABLE_HEADER_BYTES)
+    if payload_sep_location == -1:
+        msg = 'Probable malformed message: no payload separator found in first expected bytes, .'
+        raise IntersectApplicationError(msg)
+    header_string = message[:payload_sep_location]
+    headers = {
+        key.decode(): value.decode()
+        for key, value in (
+            header.split(_HEADER_KV_SEPARATOR)
+            for header in header_string.split(_HEADER_VALUE_SEPARATOR)
+        )
+    }
+    try:
+        content_type = headers.pop(CONTENT_TYPE_HEADER_KEY)
+    except KeyError as e:
+        msg = 'Probable malformed message: no content_type header found in message, discarding it.'
+        raise IntersectApplicationError(msg) from e
+
+    return message[payload_sep_location + 1 :], content_type, headers