webhooks_redis_service.py

from typing import List, Optional

from redis import RedisCluster

from shared.models.webhook_events.payloads import CloudApiWebhookEventGeneric
from shared.services.redis_service import RedisService
from shared.util.rich_parsing import parse_json_with_error_handling


class WebhooksRedisService(RedisService):
    """
    A service for interacting with Redis to store and retrieve webhook events.
    """

    def __init__(self, redis: RedisCluster) -> None:
        """
        Initialize the WebhooksRedisService with a Redis cluster instance.

        Args:
            redis: A Redis client instance connected to a Redis cluster server.
        """
        super().__init__(redis=redis, logger_name="webhooks.redis")

        self.sse_event_pubsub_channel = "new_sse_event"  # name of pub/sub channel

        self.acapy_redis_prefix = "acapy-record-*"  # redis prefix for ACA-Py events

        self.cloudapi_redis_prefix = "cloudapi"  # redis prefix for CloudAPI events

        self.logger.info("WebhooksRedisService initialised")

    def get_cloudapi_event_redis_key(
        self, wallet_id: str, group_id: Optional[str] = None
    ) -> str:
        """
        Define redis prefix for CloudAPI (transformed) webhook events

        Args:
            wallet_id: The relevant wallet id
            group_id: The group_id to which this wallet_id belongs.
        """
        group_and_wallet_id = f"group:{group_id}:{wallet_id}" if group_id else wallet_id

        return f"{self.cloudapi_redis_prefix}:{group_and_wallet_id}"

    def get_cloudapi_event_redis_key_unknown_group(
        self, wallet_id: str
    ) -> Optional[str]:
        """
        Fetch the redis key for a CloudAPI webhook event

        Args:
            wallet_id: The relevant wallet id
        """
        wildcard_key = f"{self.cloudapi_redis_prefix}:*{wallet_id}"
        self.logger.debug("Fetching redis keys matching pattern: {}", wildcard_key)
        list_keys = self.match_keys(wildcard_key)

        if not list_keys:
            self.logger.debug(
                "No redis keys found matching the pattern for wallet: {}.", wallet_id
            )
            return None

        if len(list_keys) > 1:
            self.logger.warning(
                "More than one redis key found for wallet: {}", wallet_id
            )

        result = list_keys[0].decode()
        self.logger.debug("Returning matched key: {}.", result)
        return result

    def add_cloudapi_webhook_event(
        self,
        event_json: str,
        group_id: Optional[str],
        wallet_id: str,
        timestamp_ns: int,
    ) -> None:
        """
        Add a CloudAPI webhook event JSON string to Redis and publish a notification.

        Args:
            event_json: The JSON string representation of the webhook event.
            group_id: The group_id to which this wallet_id belongs.
            wallet_id: The identifier of the wallet associated with the event.
            timestamp_ns: The timestamp (in nanoseconds) of when the event was saved.
        """
        bound_logger = self.logger.bind(
            body={"wallet_id": wallet_id, "group_id": group_id, "event": event_json}
        )
        bound_logger.trace("Write entry to redis")

        # Use the current timestamp as the score for the sorted set
        redis_key = self.get_cloudapi_event_redis_key(wallet_id, group_id)
        self.redis.zadd(redis_key, {event_json: timestamp_ns})

        group_id = "" if not group_id else group_id  # convert None to ""

        broadcast_message = f"{group_id}:{wallet_id}:{timestamp_ns}"
        # publish that a new event has been added
        bound_logger.trace("Publish message on pubsub channel: {}", broadcast_message)
        self.redis.publish(self.sse_event_pubsub_channel, broadcast_message)

        bound_logger.trace("Successfully wrote entry to redis.")

    def get_json_cloudapi_events_by_wallet(
        self, wallet_id: str, num: Optional[int] = 100
    ) -> List[str]:
        """
        Retrieve all CloudAPI webhook event JSON strings for a specified wallet ID.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            num: The maximum number of events to return. None returns max.

        Returns:
            A list of event JSON strings.
        """
        max = 10000  # Set to some large number to limit maximum number of webhooks returned
        if not num:
            num = max

        bound_logger = self.logger.bind(body={"wallet_id": wallet_id})
        bound_logger.trace("Fetching entries from redis by wallet id")

        redis_key = self.get_cloudapi_event_redis_key_unknown_group(wallet_id)
        if not redis_key:
            bound_logger.debug("No entries found for wallet without matching redis key")
            return []

        # Fetch all entries using the full range of scores
        entries: List[bytes] = self.redis.zrevrangebyscore(
            name=redis_key, max="+inf", min="-inf", start=0, num=num
        )
        entries_str: List[str] = [entry.decode() for entry in entries]

        bound_logger.trace("Successfully fetched redis entries.")
        return entries_str

    def get_cloudapi_events_by_wallet(
        self, wallet_id: str, num: Optional[int] = 100
    ) -> List[CloudApiWebhookEventGeneric]:
        """
        Retrieve all CloudAPI webhook events for a specified wallet ID,
        parsed as CloudApiWebhookEventGeneric objects.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            num: The maximum number of events to return. None returns max allowed.

        Returns:
            A list of CloudApiWebhookEventGeneric instances.
        """
        entries = self.get_json_cloudapi_events_by_wallet(wallet_id, num=num)
        parsed_entries = [
            parse_json_with_error_handling(
                CloudApiWebhookEventGeneric, entry, self.logger
            )
            for entry in entries
        ]
        return parsed_entries

    def get_json_cloudapi_events_by_wallet_and_topic(
        self, wallet_id: str, topic: str, num: Optional[int] = 100
    ) -> List[str]:
        """
        Retrieve all CloudAPI webhook event JSON strings for a specified wallet ID and topic.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            topic: The topic to filter the events by.
            num: The maximum number of events to return. None returns max allowed.

        Returns:
            A list of event JSON strings that match the specified topic.
        """
        # Fetch maximum because we must post-filter to return `num` relevant topic entries
        entries = self.get_json_cloudapi_events_by_wallet(wallet_id, num=None)
        # Filter the json entry for our requested topic without deserializing
        topic_str = f'"topic":"{topic}"'
        filtered_by_topic = [entry for entry in entries if topic_str in entry]
        result = filtered_by_topic[:num] if num else filtered_by_topic
        return result

    def get_cloudapi_events_by_wallet_and_topic(
        self, wallet_id: str, topic: str, num: int = 100
    ) -> List[CloudApiWebhookEventGeneric]:
        """
        Retrieve CloudAPI webhook events for a specified wallet ID and topic,
        parsed as CloudApiWebhookEventGeneric objects.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            topic: The topic to filter the events by.
            num: The max number of events to return.

        Returns:
            A list of CloudApiWebhookEventGeneric instances that match the specified topic.
        """
        # Fetch maximum because we must post-filter to return `num` relevant topic entries
        entries = self.get_cloudapi_events_by_wallet(wallet_id, num=None)
        filtered_by_topic = [entry for entry in entries if topic == entry.topic]
        result = filtered_by_topic[:num] if num else filtered_by_topic
        return result

    def get_json_cloudapi_events_by_timestamp(
        self,
        group_id: str,
        wallet_id: str,
        start_timestamp: float,
        end_timestamp: float = "+inf",
    ) -> List[str]:
        """
        Retrieve all CloudAPI webhook event JSON strings for a specified wallet ID within a timestamp range.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            start_timestamp: The start of the timestamp range.
            end_timestamp: The end of the timestamp range (defaults to "+inf" for no upper limit).

        Returns:
            A list of event JSON strings that fall within the specified timestamp range.
        """
        bound_logger = self.logger.bind(body={"wallet_id": wallet_id})
        bound_logger.debug("Fetching entries from redis by timestamp for wallet")

        redis_key = self.get_cloudapi_event_redis_key(
            wallet_id=wallet_id, group_id=group_id
        )
        if not redis_key:
            bound_logger.debug("No entries found for wallet without matching redis key")
            return []

        entries: List[bytes] = self.redis.zrangebyscore(
            redis_key, min=start_timestamp, max=end_timestamp
        )
        entries_str: List[str] = [entry.decode() for entry in entries]
        bound_logger.trace("Fetched entries: {}", entries_str)
        return entries_str

    def get_cloudapi_events_by_timestamp(
        self, wallet_id: str, start_timestamp: float, end_timestamp: float = "+inf"
    ) -> List[CloudApiWebhookEventGeneric]:
        """
        Retrieve all CloudAPI webhook events for a specified wallet ID within a timestamp range,
        parsed as CloudApiWebhookEventGeneric objects.

        Args:
            wallet_id: The identifier of the wallet for which events are retrieved.
            start_timestamp: The start of the timestamp range.
            end_timestamp: The end of the timestamp range (defaults to "+inf" for no upper limit).

        Returns:
            A list of CloudApiWebhookEventGeneric instances that fall within the specified timestamp range.
        """
        entries = self.get_json_cloudapi_events_by_timestamp(
            wallet_id, start_timestamp, end_timestamp
        )
        parsed_entries = [
            parse_json_with_error_handling(
                CloudApiWebhookEventGeneric, entry, self.logger
            )
            for entry in entries
        ]
        return parsed_entries

    def get_all_cloudapi_wallet_ids(self) -> List[str]:
        """
        Fetch all wallet IDs that have CloudAPI webhook events stored in Redis.
        """
        wallet_ids = set()
        cursor = 0  # Starting cursor value for SCAN
        self.logger.info("Starting SCAN to fetch all wallet IDs.")

        try:
            while True:  # Loop until the cursor returned by SCAN is '0'
                next_cursor, keys = self.redis.scan(
                    cursor=cursor,
                    match=f"{self.cloudapi_redis_prefix}:*",
                    count=10000,
                    target_nodes=RedisCluster.PRIMARIES,
                )
                if keys:
                    wallet_id_batch = set(
                        key.decode("utf-8").split(":")[-1] for key in keys
                    )
                    wallet_ids.update(wallet_id_batch)
                    self.logger.debug(
                        "Fetched {} wallet IDs from Redis. Cursor value: {}",
                        len(wallet_id_batch),
                        cursor,
                    )
                else:
                    self.logger.debug("No wallet IDs found in this batch.")

                if all(c == 0 for c in next_cursor.values()):
                    self.logger.info("Completed SCAN for wallet IDs.")
                    break  # Exit the loop
                cursor += 1
        except Exception:
            self.logger.exception(
                "An exception occurred when fetching wallet_ids from redis. Continuing..."
            )

        self.logger.info("Total wallet IDs fetched: {}.", len(wallet_ids))
        return list(wallet_ids)

    def add_endorsement_event(self, event_json: str, transaction_id: str) -> None:
        """
        Add an endorsement event to bespoke prefix for the endorsement service.

        Args:
            event_json: The JSON string representation of the endorsement event.
        """
        bound_logger = self.logger.bind(body={"transaction_id": transaction_id})
        bound_logger.debug(
            "Write endorsement entry to redis for transaction id: {}", transaction_id
        )

        # Define key for this transaction, using transaction_id to ensure uniqueness
        redis_key = f"{self.endorsement_redis_prefix}:{transaction_id}"
        result = self.set(key=redis_key, value=event_json)

        if result:
            bound_logger.debug("Successfully wrote endorsement entry to redis.")
        else:
            bound_logger.warning("Redis key for this endorsement entry is already set.")

        self.logger.trace("Successfully wrote endorsement entry to redis.")

    def check_wallet_belongs_to_group(self, wallet_id: str, group_id: str) -> bool:
        """
        Return a boolean indicating that the wallet_id belongs to the group_id or not
        """
        self.logger.trace("Checking if wallet belongs to group, based on redis keys")

        wallet_group_key = self.get_cloudapi_event_redis_key(wallet_id, group_id)
        self.logger.debug("Fetching redis keys matching pattern: {}", wallet_group_key)
        list_keys = self.match_keys(wallet_group_key)

        if not list_keys:
            self.logger.debug(
                "No redis keys found matching the pattern: {}.", wallet_group_key
            )
            return False

        if len(list_keys) > 1:
            self.logger.warning(
                "More than one redis key found for pattern: {}", wallet_group_key
            )

        self.logger.debug(
            "Validated that wallet {} belongs to group {}.", wallet_id, group_id
        )
        return True