reach_commons 0.18.23__tar.gz → 0.18.25__tar.gz

{reach_commons-0.18.23 → reach_commons-0.18.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reach_commons
-Version: 0.18.23
+Version: 0.18.25
 Summary: Reach Commons is a versatile utility library designed to streamline and enhance development workflows within the Reach ecosystem.
 License: MIT
 Author: Engineering

{reach_commons-0.18.23 → reach_commons-0.18.25}/pyproject.toml

@@ -1,7 +1,7 @@
 # isort .; black .; poetry build; poetry publish
 [tool.poetry]
 name = "reach_commons"
-version = "0.18.23"
+version = "0.18.25"
 description = "Reach Commons is a versatile utility library designed to streamline and enhance development workflows within the Reach ecosystem."
 authors = ["Engineering <engineering@getreach.ai>"]
 license = "MIT"

{reach_commons-0.18.23 → reach_commons-0.18.25}/reach_commons/reach_aws/sqs.py

@@ -146,6 +146,99 @@ class SQSClient(BaseSQSClient):
 
         return True
 
+    def get_visible_messages_count(self) -> int:
+        try:
+            resp = self.client.get_queue_attributes(
+                QueueUrl=self.topic_name,
+                AttributeNames=[
+                    "ApproximateNumberOfMessages",
+                    "ApproximateNumberOfMessagesNotVisible",
+                    "ApproximateNumberOfMessagesDelayed",
+                ],
+            )
+            visible = int(resp["Attributes"].get("ApproximateNumberOfMessages", 0))
+            in_flight = int(
+                resp["Attributes"].get("ApproximateNumberOfMessagesNotVisible", 0)
+            )
+            delayed = int(
+                resp["Attributes"].get("ApproximateNumberOfMessagesDelayed", 0)
+            )
+
+            return visible, in_flight, delayed
+        except ClientError as exc:
+            self.logger.error(
+                "error_fetching_queue_attributes, topic_name=%s, error=%s",
+                self.topic_name,
+                str(exc),
+            )
+            # If there's an error, return 0 so as not to block the caller.
+            return 0, 0, 0
+
+    def publish_with_capacity_guard(
+        self,
+        message_data: dict,
+        max_capacity: int,
+        delay_seconds: int = 60,
+        message_attributes: dict = None,
+    ) -> dict:
+        """
+        Attempts to publish a message while enforcing an approximate queue capacity limit.
+
+        Behavior:
+            - If the queue is below `max_capacity`, the message is published normally.
+            - If the queue is at or above `max_capacity`, the message is NOT published.
+
+        Returns a dict with:
+            - posted: bool        -> whether the message was actually published
+            - visible_count: int  -> ApproximateNumberOfMessages at publication time
+            - max_capacity: int   -> the capacity threshold used
+
+        Example:
+            sqs = SQSClient(topic_name="<enviroment>-messages-queue")
+
+            Result = sqs.publish_with_capacity_guard(
+                message_data={"foo": "bar"},
+                max_capacity=100_000,
+                delay_seconds=30,
+                message_attributes={"service_name": "TestClient"},
+            )
+
+            if not Result["posted"]:
+                print("Queue is over capacity:", Result)
+        """
+        (
+            visible_count,
+            in_flight_count,
+            delayed_count,
+        ) = self.get_visible_messages_count()
+
+        if visible_count >= max_capacity:
+            self.logger.warning(
+                "queue_over_capacity, topic_name=%s, visible=%s, max_capacity=%s",
+                self.topic_name,
+                visible_count,
+                max_capacity,
+            )
+            return {
+                "posted": False,
+                "visible_count": visible_count,
+                "max_capacity": max_capacity,
+            }
+
+        self.publish(
+            message_data=message_data,
+            delay_seconds=delay_seconds,
+            message_attributes=message_attributes,
+        )
+
+        return {
+            "posted": True,
+            "visible_count": visible_count,
+            "in_flight_count": in_flight_count,
+            "delayed_count": delayed_count,
+            "max_capacity": max_capacity,
+        }
+
 
 class MessageFilter:
     """