|
| 1 | +import json |
| 2 | +import logging |
| 3 | +import os |
| 4 | + |
| 5 | +import boto3 |
| 6 | +from botocore.exceptions import ClientError |
| 7 | + |
| 8 | +from retry.base_storage import BaseStorage |
| 9 | +from settings import DD_SQS_QUEUE_URL |
| 10 | + |
| 11 | +logger = logging.getLogger(__name__) |
| 12 | +logger.setLevel(logging.getLevelName(os.environ.get("DD_LOG_LEVEL", "INFO").upper())) |
| 13 | + |
| 14 | +# SQS max message size is 256KB; use 240KB to leave room for attributes/overhead |
| 15 | +SQS_MAX_CHUNK_BYTES = 240 * 1024 |
| 16 | +SQS_MAX_MESSAGES_PER_RECEIVE = 10 |
| 17 | +SQS_MAX_POLL_ITERATIONS = 10 |
| 18 | + |
| 19 | + |
| 20 | +class SQSStorage(BaseStorage): |
| 21 | + def __init__(self, function_prefix): |
| 22 | + self.queue_url = DD_SQS_QUEUE_URL |
| 23 | + self.sqs_client = boto3.client("sqs") |
| 24 | + self.function_prefix = function_prefix |
| 25 | + |
| 26 | + def get_data(self, prefix): |
| 27 | + """Poll SQS for messages matching prefix and function_prefix. |
| 28 | +
|
| 29 | + Returns {receipt_handle: data} for matching messages. |
| 30 | + Non-matching messages are released immediately by resetting their |
| 31 | + visibility timeout to 0. |
| 32 | + """ |
| 33 | + key_data = {} |
| 34 | + |
| 35 | + for _ in range(SQS_MAX_POLL_ITERATIONS): |
| 36 | + try: |
| 37 | + response = self.sqs_client.receive_message( |
| 38 | + QueueUrl=self.queue_url, |
| 39 | + MaxNumberOfMessages=SQS_MAX_MESSAGES_PER_RECEIVE, |
| 40 | + MessageAttributeNames=["retry_prefix", "function_prefix"], |
| 41 | + WaitTimeSeconds=0, |
| 42 | + ) |
| 43 | + except ClientError as e: |
| 44 | + logger.error(f"Failed to receive SQS messages: {e}") |
| 45 | + break |
| 46 | + |
| 47 | + messages = response.get("Messages", []) |
| 48 | + if not messages: |
| 49 | + break |
| 50 | + |
| 51 | + for message in messages: |
| 52 | + receipt_handle = message["ReceiptHandle"] |
| 53 | + msg_retry_prefix = self._get_message_attr(message, "retry_prefix") |
| 54 | + msg_function_prefix = self._get_message_attr(message, "function_prefix") |
| 55 | + |
| 56 | + if ( |
| 57 | + msg_retry_prefix != str(prefix) |
| 58 | + or msg_function_prefix != self.function_prefix |
| 59 | + ): |
| 60 | + self._release_message(receipt_handle) |
| 61 | + continue |
| 62 | + |
| 63 | + data = self._deserialize(message["Body"]) |
| 64 | + if data is not None: |
| 65 | + key_data[receipt_handle] = data |
| 66 | + |
| 67 | + if logger.isEnabledFor(logging.DEBUG): |
| 68 | + logger.debug( |
| 69 | + f"Found {len(key_data)} SQS retry messages for prefix {prefix}" |
| 70 | + ) |
| 71 | + |
| 72 | + return key_data |
| 73 | + |
| 74 | + def store_data(self, prefix, data): |
| 75 | + """Store data as one or more SQS messages, chunking to stay under the size limit.""" |
| 76 | + if logger.isEnabledFor(logging.DEBUG): |
| 77 | + logger.debug(f"Storing retry data to SQS for prefix {prefix}") |
| 78 | + |
| 79 | + chunks = self._chunk_data(data) |
| 80 | + for chunk in chunks: |
| 81 | + serialized = self._serialize(chunk) |
| 82 | + try: |
| 83 | + self.sqs_client.send_message( |
| 84 | + QueueUrl=self.queue_url, |
| 85 | + MessageBody=serialized, |
| 86 | + MessageAttributes={ |
| 87 | + "retry_prefix": { |
| 88 | + "DataType": "String", |
| 89 | + "StringValue": str(prefix), |
| 90 | + }, |
| 91 | + "function_prefix": { |
| 92 | + "DataType": "String", |
| 93 | + "StringValue": self.function_prefix, |
| 94 | + }, |
| 95 | + }, |
| 96 | + ) |
| 97 | + except ClientError as e: |
| 98 | + logger.error(f"Failed to send SQS message for prefix {prefix}: {e}") |
| 99 | + |
| 100 | + def delete_data(self, key): |
| 101 | + """Delete a message by receipt handle. Idempotent — logs and swallows errors.""" |
| 102 | + try: |
| 103 | + self.sqs_client.delete_message( |
| 104 | + QueueUrl=self.queue_url, |
| 105 | + ReceiptHandle=key, |
| 106 | + ) |
| 107 | + except ClientError as e: |
| 108 | + logger.error(f"Failed to delete SQS message (receipt={key}): {e}") |
| 109 | + |
| 110 | + def _release_message(self, receipt_handle): |
| 111 | + """Make a non-matching message immediately visible to other consumers.""" |
| 112 | + try: |
| 113 | + self.sqs_client.change_message_visibility( |
| 114 | + QueueUrl=self.queue_url, |
| 115 | + ReceiptHandle=receipt_handle, |
| 116 | + VisibilityTimeout=0, |
| 117 | + ) |
| 118 | + except ClientError as e: |
| 119 | + logger.error(f"Failed to release SQS message: {e}") |
| 120 | + |
| 121 | + @staticmethod |
| 122 | + def _get_message_attr(message, attr_name): |
| 123 | + """Extract a string attribute value from an SQS message.""" |
| 124 | + attrs = message.get("MessageAttributes", {}) |
| 125 | + return attrs.get(attr_name, {}).get("StringValue") |
| 126 | + |
| 127 | + def _chunk_data(self, data): |
| 128 | + """Split a list of items into chunks that each fit under SQS_MAX_CHUNK_BYTES.""" |
| 129 | + if not isinstance(data, list): |
| 130 | + return [data] |
| 131 | + |
| 132 | + chunks = [] |
| 133 | + current_chunk = [] |
| 134 | + current_size = 2 # account for JSON array brackets "[]" |
| 135 | + |
| 136 | + for item in data: |
| 137 | + item_json = json.dumps(item, ensure_ascii=False) |
| 138 | + item_size = len(item_json.encode("UTF-8")) |
| 139 | + # +1 for the comma separator between items |
| 140 | + separator_size = 1 if current_chunk else 0 |
| 141 | + |
| 142 | + if current_size + separator_size + item_size > SQS_MAX_CHUNK_BYTES: |
| 143 | + if current_chunk: |
| 144 | + chunks.append(current_chunk) |
| 145 | + if 2 + item_size > SQS_MAX_CHUNK_BYTES: |
| 146 | + logger.warning( |
| 147 | + f"Single item exceeds SQS message size limit " |
| 148 | + f"({item_size} bytes > {SQS_MAX_CHUNK_BYTES} bytes). " |
| 149 | + f"SQS send will fail for this chunk." |
| 150 | + ) |
| 151 | + current_chunk = [item] |
| 152 | + current_size = 2 + item_size |
| 153 | + else: |
| 154 | + current_chunk.append(item) |
| 155 | + current_size += separator_size + item_size |
| 156 | + |
| 157 | + if current_chunk: |
| 158 | + chunks.append(current_chunk) |
| 159 | + |
| 160 | + return chunks or [data] |
| 161 | + |
| 162 | + def _serialize(self, data): |
| 163 | + return json.dumps(data, ensure_ascii=False) |
| 164 | + |
| 165 | + def _deserialize(self, data): |
| 166 | + try: |
| 167 | + return json.loads(data) |
| 168 | + except (json.JSONDecodeError, TypeError) as e: |
| 169 | + logger.error(f"Failed to deserialize SQS message body: {e}") |
| 170 | + return None |
0 commit comments