feat!: refactor cache and dispatch cached models in delete/remove/update events

Merge pull request #909 from Catalyst4222/unstable

Author: Catalyst4222

interactions/api/cache.py

@@ -1,88 +1,73 @@
-from collections import OrderedDict
-from typing import Any, List, Optional
+from collections import defaultdict
+from typing import TYPE_CHECKING, Dict, Generic, List, Optional, Tuple, Type, TypeVar, Union
+
+if TYPE_CHECKING:
+    from .models import Snowflake
+
+    Key = TypeVar("Key", Snowflake, Tuple[Snowflake, Snowflake])
 
 __all__ = (
-    "Item",
     "Storage",
     "Cache",
 )
 
+_T = TypeVar("_T")
+_P = TypeVar("_P")
 
-class Item:
-    """
-    A class representing the defined item in a stored dataset.
 
-    :ivar str id: The ID of the item.
-    :ivar Any value: The item itself.
-    :ivar Type type: The ID type representation.
-    """
-
-    __slots__ = ("id", "value", "type")
-
-    def __init__(self, id: str, value: Any) -> None:
-        """
-        :param id: The item's ID.
-        :type id: str
-        :param value: The item itself.
-        :type value: Any
-        """
-        self.id = id
-        self.value = value
-        self.type = type(value)
-
-
-class Storage:
+class Storage(Generic[_T]):
     """
     A class representing a set of items stored as a cache state.
 
-    :ivar List[Item] values: The list of items stored.
+    :ivar Dict[Union[Snowflake, Tuple[Snowflake, Snowflake]], Any] values: The list of items stored.
     """
 
-    __slots__ = "values"
+    __slots__ = ("values",)
 
     def __repr__(self) -> str:
         return f"<{self.__class__.__name__} object containing {len(self.values)} items.>"
 
     def __init__(self) -> None:
-        self.values = OrderedDict()
+        self.values: Dict["Key", _T] = {}
 
-    def add(self, item: Item) -> OrderedDict:
+    def add(self, item: _T, id: Optional["Key"] = None) -> None:
         """
         Adds a new item to the storage.
 
         :param item: The item to add.
-        :type item: Item
-        :return: The new storage.
-        :rtype: OrderedDict
+        :type item: Any
+        :param id: The unique id of the item.
+        :type id: Optional[Union[Snowflake, Tuple[Snowflake, Snowflake]]]
         """
-        self.values.update({item.id: item.value})
-        return self.values
+        self.values[id or item.id] = item
 
-    def get(self, id: str) -> Optional[Item]:
+    def get(self, id: "Key", default: Optional[_P] = None) -> Union[_T, _P]:
         """
         Gets an item from the storage.
 
         :param id: The ID of the item.
-        :type id: str
+        :type id: Union[Snowflake, Tuple[Snowflake, Snowflake]]
+        :param default: The default value to return if the item is not found.
+        :type default: Optional[Any]
         :return: The item from the storage if any.
-        :rtype: Optional[Item]
+        :rtype: Optional[Any]
         """
-        if id in self.values.keys():
-            return self.values[id]
+        return self.values.get(id, default)
 
-    def update(self, item: Item) -> Optional[Item]:
+    def update(self, data: Dict["Key", _T]):
         """
-        Updates an item from the storage.
+        Updates multiple items from the storage.
 
-        :param item: The item to update.
-        :return: The updated item, if stored.
-        :rtype: Optional[Item]
+        :param data: The data to update with.
+        :type data: dict
         """
-        if item.id in self.values.keys():
-            self.values[item.id] = item.value
-            return self.values[
-                id
-            ]  # fetches from cache to see if its saved properly, instead of returning input.
+        self.values.update(data)
+
+    def pop(self, key: "Key", default: Optional[_P] = None) -> Union[_T, _P]:
+        try:
+            return self.values.pop(key)
+        except KeyError:
+            return default
 
     @property
     def view(self) -> List[dict]:
@@ -93,45 +78,32 @@ def view(self) -> List[dict]:
         """
         return [v._json for v in self.values.values()]
 
+    def __getitem__(self, item: "Key") -> _T:
+        return self.values.__getitem__(item)
+
+    def __setitem__(self, key: "Key", value: _T) -> None:
+        return self.values.__setitem__(key, value)
+
+    def __delitem__(self, key: "Key") -> None:
+        return self.values.__delitem__(key)
+
 
 class Cache:
     """
     A class representing the cache.
     This cache collects all of the HTTP requests made for
     the represented instances of the class.
 
-    :ivar Cache dms: The cached Direct Messages.
-    :ivar Cache self_guilds: The cached guilds upon gateway connection.
-    :ivar Cache guilds: The cached guilds after ready.
-    :ivar Cache channels: The cached channels of guilds.
-    :ivar Cache roles: The cached roles of guilds.
-    :ivar Cache members: The cached members of guilds and threads.
-    :ivar Cache messages: The cached messages of DMs and channels.
-    :ivar Cache interactions: The cached interactions upon interaction.
+    :ivar defaultdict[Type, Storage] storages:
     """
 
-    __slots__ = (
-        "dms",
-        "self_guilds",
-        "guilds",
-        "channels",
-        "roles",
-        "members",
-        "messages",
-        "users",
-        "interactions",
-    )
+    __slots__ = "storages"
 
     def __init__(self) -> None:
-        self.dms = Storage()
-        self.self_guilds = Storage()
-        self.guilds = Storage()
-        self.channels = Storage()
-        self.roles = Storage()
-        self.members = Storage()
-        self.messages = Storage()
-        self.users = Storage()
-        self.interactions = Storage()
+        self.storages: defaultdict[Type[_T], Storage[_T]] = defaultdict(Storage)
+
+    def __getitem__(self, item: Type[_T]) -> Storage[_T]:
+        return self.storages[item]
 
 
 ref_cache = Cache()  # noqa

interactions/api/gateway/client.py

@@ -28,11 +28,14 @@
 from ..http.client import HTTPClient
 from ..models.attrs_utils import MISSING
 from ..models.flags import Intents
+from ..models.member import Member
+from ..models.misc import Snowflake
 from ..models.presence import ClientPresence
 from .heartbeat import _Heartbeat
 
 if TYPE_CHECKING:
     from ...client.context import _Context
+    from ..cache import Storage
 
 log = get_logger("gateway")
 
@@ -273,12 +276,11 @@ def _dispatch_event(self, event: str, data: dict) -> None:
         :param data: The data for the event.
         :type data: dict
         """
-        # sourcery no-metrics
+        self._dispatch.dispatch("raw_socket_create", data)
         path: str = "interactions"
         path += ".models" if event == "INTERACTION_CREATE" else ".api.models"
         if event == "INTERACTION_CREATE":
             if data.get("type"):
-                # sourcery skip: dict-assign-update-to-union, extract-method, low-code-quality
                 _context = self.__contextualize(data)
                 _name: str = ""
                 __args: list = [_context]
@@ -386,17 +388,42 @@ def _dispatch_event(self, event: str, data: dict) -> None:
             try:
                 _event_path: list = [section.capitalize() for section in name.split("_")]
                 _name: str = _event_path[0] if len(_event_path) < 3 else "".join(_event_path[:-1])
-                __obj: object = getattr(__import__(path), _name)
+                model = getattr(__import__(path), _name)
+
+                data["_client"] = self._http
+                obj = model(**data)
+                _cache: "Storage" = self._http.cache[model]
+
+                if isinstance(obj, Member):
+                    id = (Snowflake(data["guild_id"]), obj.id)
+                else:
+                    id = getattr(obj, "id", None)
+
+                if "_create" in name or "_add" in name:
+                    _cache.add(obj, id)
+                    self._dispatch.dispatch(f"on_{name}", obj)
 
-                # name in {"_create", "_add"} returns False (tested w message_create)
-                if any(_ in name for _ in {"_create", "_update", "_add", "_remove", "_delete"}):
-                    data["_client"] = self._http
+                elif "_update" in name and hasattr(obj, "id"):
+                    old_obj = self._http.cache[model].get(id)
+                    _cache.add(obj, id)
+                    copy = model(**old_obj._json)
+                    old_obj.update(**obj._json)
+                    self._dispatch.dispatch(
+                        f"on_{name}", copy, old_obj
+                    )  # give previously stored and new one
+                    return
 
-                self._dispatch.dispatch(f"on_{name}", __obj(**data))  # noqa
+                elif "_remove" in name or "_delete" in name:
+                    self._dispatch.dispatch(f"on_raw_{name}", obj)
+
+                    old_obj = _cache.pop(id)
+                    self._dispatch.dispatch(f"on_{name}", old_obj)
+
+                else:
+                    self._dispatch.dispatch(f"on_{name}", obj)
 
             except AttributeError as error:
                 log.fatal(f"An error occured dispatching {name}: {error}")
-        self._dispatch.dispatch("raw_socket_create", data)
 
     def __contextualize(self, data: dict) -> "_Context":
         """

interactions/api/http/channel.py

@@ -1,6 +1,6 @@
 from typing import Dict, List, Optional, Union
 
-from ...api.cache import Cache, Item
+from ...api.cache import Cache
 from ..error import LibraryException
 from ..models.channel import Channel
 from ..models.message import Message
@@ -11,7 +11,6 @@
 
 
 class ChannelRequest:
-
     _req: _Request
     cache: Cache
 
@@ -26,7 +25,7 @@ async def get_channel(self, channel_id: int) -> dict:
         :return: Dictionary of the channel object.
         """
         request = await self._req.request(Route("GET", f"/channels/{channel_id}"))
-        self.cache.channels.add(Item(id=str(channel_id), value=Channel(**request, _client=self)))
+        self.cache[Channel].add(Channel(**request, _client=self))
 
         return request
 
@@ -88,7 +87,7 @@ async def get_channel_messages(
         if isinstance(request, list):
             for message in request:
                 if message.get("id"):
-                    self.cache.messages.add(Item(id=message["id"], value=Message(**message)))
+                    self.cache[Message].add(Message(**message))
 
         return request
 
@@ -110,7 +109,7 @@ async def create_channel(
             Route("POST", f"/guilds/{guild_id}/channels"), json=payload, reason=reason
         )
         if request.get("id"):
-            self.cache.channels.add(Item(id=request["id"], value=Channel(**request)))
+            self.cache[Channel].add(Channel(**request))
 
         return request
 

interactions/api/http/guild.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, List, Optional
 from urllib.parse import quote
 
-from ...api.cache import Cache, Item
+from ...api.cache import Cache
 from ..models.channel import Channel
 from ..models.guild import Guild
 from ..models.member import Member
@@ -30,7 +30,7 @@ async def get_self_guilds(self) -> List[dict]:
 
         for guild in request:
             if guild.get("id"):
-                self.cache.self_guilds.add(Item(id=guild["id"], value=Guild(**guild, _client=self)))
+                self.cache[Guild].add(Guild(**guild, _client=self))
 
         return request
 
@@ -45,7 +45,7 @@ async def get_guild(self, guild_id: int, with_counts: bool = False) -> dict:
         request = await self._req.request(
             Route("GET", f"/guilds/{guild_id}{f'?{with_counts=}' if with_counts else ''}")
         )
-        self.cache.guilds.add(Item(id=str(guild_id), value=Guild(**request, _client=self)))
+        self.cache[Guild].add(Guild(**request, _client=self))
 
         return request
 
@@ -369,9 +369,7 @@ async def get_all_channels(self, guild_id: int) -> List[dict]:
 
         for channel in request:
             if channel.get("id"):
-                self.cache.channels.add(
-                    Item(id=channel["id"], value=Channel(**channel, _client=self))
-                )
+                self.cache[Channel].add(Channel(**channel, _client=self))
 
         return request
 
@@ -388,7 +386,7 @@ async def get_all_roles(self, guild_id: int) -> List[dict]:
 
         for role in request:
             if role.get("id"):
-                self.cache.roles.add(Item(id=role["id"], value=Role(**role)))
+                self.cache[Role].add(Role(**role))
 
         return request
 
@@ -407,7 +405,7 @@ async def create_guild_role(
             Route("POST", f"/guilds/{guild_id}/roles"), json=payload, reason=reason
         )
         if request.get("id"):
-            self.cache.roles.add(Item(id=request["id"], value=Role(**request)))
+            self.cache[Role].add(Role(**request))
 
         return request
 
@@ -590,7 +588,7 @@ async def add_guild_member(
             },
         )
 
-        self.cache.members.add(Item(id=str(user_id), value=Member(**request)))
+        self.cache[Member].add(Member(**request))
 
         return request
 

interactions/api/http/message.py

@@ -2,7 +2,7 @@
 
 from aiohttp import MultipartWriter
 
-from ...api.cache import Cache, Item
+from ...api.cache import Cache
 from ..models.attrs_utils import MISSING
 from ..models.message import Embed, Message, MessageInteraction, Sticker
 from ..models.misc import File, Snowflake
@@ -98,7 +98,7 @@ async def create_message(
             data=data,
         )
         if request.get("id"):
-            self.cache.messages.add(Item(id=request["id"], value=Message(**request, _client=self)))
+            self.cache[Message].add(Message(**request, _client=self))
 
         return request