refactor: Modify the cache with a merge method to ensure no important data gets overwritten (#913)

* refactor: add merge method for cache

* refactor: Optimize `_search_iterable`and use a list of tuples instead of a tuple of tuples

* refactor: Do a guild updates in events

* refactor: Add caching to several HTTP methods

* Update interactions/api/http/guild.py

Co-authored-by: Toricane <73972068+Toricane@users.noreply.github.com>

* Update interactions/api/http/channel.py

Co-authored-by: Toricane <73972068+Toricane@users.noreply.github.com>

Co-authored-by: Toricane <73972068+Toricane@users.noreply.github.com>

Author: EepyElvyra

interactions/api/cache.py

@@ -41,6 +41,39 @@ def __repr__(self) -> str:
     def __init__(self) -> None:
         self.values: Dict["Key", _T] = {}
 
+    def merge(self, item: _T, id: Optional["Key"] = None) -> None:
+        """
+        Merges new data of an item into an already present item of the cache
+
+        :param item: The item to merge.
+        :type item: Any
+        :param id: The unique id of the item.
+        :type id: Optional[Union[Snowflake, Tuple[Snowflake, Snowflake]]]
+        """
+        if not self.values.get(id or item.id):
+            return self.add(item, id)
+
+        _id = id or item.id
+        old_item = self.values[_id]
+
+        for attrib in item.__slots__:
+            if getattr(old_item, attrib) and not getattr(item, attrib):
+                continue
+                # we can only assume that discord did not provide it, falsely deleting is worse than not deleting
+            if getattr(old_item, attrib) != getattr(item, attrib):
+                if isinstance(item.attrib, list) and not isinstance(
+                    old_item.attrib, list
+                ):  # could be None
+                    old_item.attrib = []
+                if isinstance(old_item.attrib, list):
+                    for value in item.attrib:
+                        if value not in old_item.attrib:
+                            old_item.attrib.append(value)
+                else:
+                    setattr(old_item, attrib, item.attrib)
+
+        self.values[_id] = old_item
+
     def add(self, item: _T, id: Optional["Key"] = None) -> None:
         """
         Adds a new item to the storage.
@@ -91,10 +124,7 @@ def pop(self, key: "Key", default: _P) -> Union[_T, _P]:
         ...
 
     def pop(self, key: "Key", default: Optional[_P] = None) -> Union[_T, _P, None]:
-        try:
-            return self.values.pop(key)
-        except KeyError:
-            return default
+        return self.values.pop(key, default)
 
     @property
     def view(self) -> List[dict]:

interactions/api/gateway/client.py

@@ -28,6 +28,7 @@
 from ..http.client import HTTPClient
 from ..models.attrs_utils import MISSING
 from ..models.flags import Intents
+from ..models.guild import Guild
 from ..models.member import Member
 from ..models.misc import Snowflake
 from ..models.presence import ClientPresence
@@ -400,7 +401,19 @@ def _dispatch_event(self, event: str, data: dict) -> None:
                     id = getattr(obj, "id", None)
 
                 if "_create" in name or "_add" in name:
-                    _cache.add(obj, id)
+                    _cache.merge(obj, id)
+                    if guild_id := data.get("guild_id") and not isinstance(obj, Guild):
+                        guild = self._http.cache[Guild].get(Snowflake(guild_id))
+                        model_name = model.__name__.lower()
+                        _obj = getattr(guild, f"{model_name}s", None)
+                        if _obj is not None:
+                            if isinstance(_obj, list):
+                                _obj.append(obj)
+                                setattr(guild, f"{model_name}s", _obj)
+                        else:
+                            _obj = [obj]
+                            setattr(guild, f"{model_name}s", _obj)
+                        self._http.cache[Guild].add(guild)
                     self._dispatch.dispatch(f"on_{name}", obj)
 
                 elif "_update" in name and hasattr(obj, "id"):
@@ -415,6 +428,23 @@ def _dispatch_event(self, event: str, data: dict) -> None:
 
                     _cache.add(old_obj, id)
 
+                    if guild_id := data.get("guild_id") and not isinstance(obj, Guild):
+                        guild = self._http.cache[Guild].get(Snowflake(guild_id))
+                        model_name = model.__name__.lower()
+                        _obj = getattr(guild, f"{model_name}s", None)
+                        if _obj is not None:
+                            if isinstance(_obj, list):
+                                for __obj in _obj:
+                                    if __obj.id == obj.id:
+                                        _obj.remove(__obj)
+                                        break
+                                _obj.append(obj)
+                                setattr(guild, f"{model_name}s", _obj)
+                        else:
+                            _obj = [obj]
+                            setattr(guild, f"{model_name}s", _obj)
+                        self._http.cache[Guild].add(guild)
+
                     self._dispatch.dispatch(
                         f"on_{name}", before, old_obj
                     )  # give previously stored and new one
@@ -423,6 +453,19 @@ def _dispatch_event(self, event: str, data: dict) -> None:
                 elif "_remove" in name or "_delete" in name:
                     self._dispatch.dispatch(f"on_raw_{name}", obj)
 
+                    if guild_id := data.get("guild_id") and not isinstance(obj, Guild):
+                        guild = self._http.cache[Guild].get(Snowflake(guild_id))
+                        model_name = model.__name__.lower()
+                        _obj = getattr(guild, f"{model_name}s", None)
+                        if _obj is not None:
+                            if isinstance(_obj, list):
+                                for __obj in _obj:
+                                    if __obj.id == obj.id:
+                                        _obj.remove(__obj)
+                                        break
+                                setattr(guild, f"{model_name}s", _obj)
+                        self._http.cache[Guild].add(guild)
+
                     old_obj = _cache.pop(id)
                     self._dispatch.dispatch(f"on_{name}", old_obj)
 

interactions/api/http/channel.py

@@ -25,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[Channel].add(Channel(**request, _client=self))
+        self.cache[Channel].merge(Channel(**request, _client=self))
 
         return request
 
@@ -87,7 +87,7 @@ async def get_channel_messages(
         if isinstance(request, list):
             for message in request:
                 if message.get("id"):
-                    self.cache[Message].add(Message(**message))
+                    self.cache[Message].merge(Message(**message, _client=self))
 
         return request
 
@@ -108,8 +108,6 @@ async def create_channel(
         request = await self._req.request(
             Route("POST", f"/guilds/{guild_id}/channels"), json=payload, reason=reason
         )
-        if request.get("id"):
-            self.cache[Channel].add(Channel(**request))
 
         return request
 

interactions/api/http/emoji.py

@@ -1,6 +1,8 @@
 from typing import List, Optional
 
 from ...api.cache import Cache
+from ...api.models.guild import Emoji, Guild
+from ...api.models.misc import Snowflake
 from .request import _Request
 from .route import Route
 
@@ -22,7 +24,11 @@ async def get_all_emoji(self, guild_id: int) -> List[dict]:
         :param guild_id: Guild ID snowflake.
         :return: A list of emojis.
         """
-        return await self._req.request(Route("GET", f"/guilds/{guild_id}/emojis"))
+        res = await self._req.request(Route("GET", f"/guilds/{guild_id}/emojis"))
+        self.cache[Guild].get(Snowflake(guild_id)).emojis = [
+            Emoji(**_res, _client=self) for _res in res
+        ]
+        return res
 
     async def get_guild_emoji(self, guild_id: int, emoji_id: int) -> dict:
         """
@@ -32,7 +38,20 @@ async def get_guild_emoji(self, guild_id: int, emoji_id: int) -> dict:
         :param emoji_id: Emoji ID snowflake.
         :return: Emoji object
         """
-        return await self._req.request(Route("GET", f"/guilds/{guild_id}/emojis/{emoji_id}"))
+        res = await self._req.request(Route("GET", f"/guilds/{guild_id}/emojis/{emoji_id}"))
+        emoji = Emoji(**res, _client=self)
+        guild = self.cache[Guild].get(Snowflake(guild_id))
+        if guild.emojis is None:
+            guild.emojis = [emoji]
+        else:
+            for index, _emoji in enumerate(guild.emojis):
+                if _emoji.id == emoji.id:
+                    guild.emojis[index] = emoji
+                    break
+            else:
+                guild.emojis.append(emoji)
+        self.cache[Guild].add(guild)  # yes it should just be overwritten
+        return res
 
     async def create_guild_emoji(
         self, guild_id: int, payload: dict, reason: Optional[str] = None

interactions/api/http/guild.py

@@ -4,7 +4,6 @@
 from ...api.cache import Cache
 from ..models.channel import Channel
 from ..models.guild import Guild
-from ..models.member import Member
 from ..models.role import Role
 from .request import _Request
 from .route import Route
@@ -30,7 +29,7 @@ async def get_self_guilds(self) -> List[dict]:
 
         for guild in request:
             if guild.get("id"):
-                self.cache[Guild].add(Guild(**guild, _client=self))
+                self.cache[Guild].merge(Guild(**guild, _client=self))
 
         return request
 
@@ -45,7 +44,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[Guild].add(Guild(**request, _client=self))
+        self.cache[Guild].merge(Guild(**request, _client=self))
 
         return request
 
@@ -369,7 +368,7 @@ async def get_all_channels(self, guild_id: int) -> List[dict]:
 
         for channel in request:
             if channel.get("id"):
-                self.cache[Channel].add(Channel(**channel, _client=self))
+                self.cache[Channel].merge(Channel(**channel, _client=self))
 
         return request
 
@@ -386,7 +385,7 @@ async def get_all_roles(self, guild_id: int) -> List[dict]:
 
         for role in request:
             if role.get("id"):
-                self.cache[Role].add(Role(**role))
+                self.cache[Role].merge(Role(**role))
 
         return request
 
@@ -404,8 +403,6 @@ async def create_guild_role(
         request = await self._req.request(
             Route("POST", f"/guilds/{guild_id}/roles"), json=payload, reason=reason
         )
-        if request.get("id"):
-            self.cache[Role].add(Role(**request))
 
         return request
 
@@ -588,7 +585,6 @@ async def add_guild_member(
             },
         )
 
-        self.cache[Member].add(Member(**request))
 
         return request
 

interactions/api/http/member.py

@@ -1,6 +1,9 @@
 from typing import List, Optional
 
 from ...api.cache import Cache
+from ...api.models.guild import Guild
+from ...api.models.member import Member
+from ...api.models.misc import Snowflake
 from .request import _Request
 from .route import Route
 
@@ -23,7 +26,7 @@ async def get_member(self, guild_id: int, member_id: int) -> Optional[dict]:
         :param member_id: Member ID snowflake.
         :return: A member object, if any.
         """
-        return await self._req.request(
+        res = await self._req.request(
             Route(
                 "GET",
                 "/guilds/{guild_id}/members/{member_id}",
@@ -32,6 +35,21 @@ async def get_member(self, guild_id: int, member_id: int) -> Optional[dict]:
             )
         )
 
+        member = Member(**res, _client=self)
+        guild = self.cache[Guild].get(Snowflake(guild_id))
+        if guild.members is None:
+            guild.members = [member]
+        else:
+            for index, _member in enumerate(guild.members):
+                if _member.id == member.id:
+                    guild.members[index] = member
+                    break
+            else:
+                guild.members.append(member)
+        self.cache[Guild].add(guild)  # yes it should just be overwritten
+
+        return res
+
     async def get_list_of_members(
         self, guild_id: int, limit: int = 1, after: Optional[int] = None
     ) -> List[dict]:
@@ -47,7 +65,20 @@ async def get_list_of_members(
         if after:
             payload["after"] = after
 
-        return await self._req.request(Route("GET", f"/guilds/{guild_id}/members"), params=payload)
+        res = await self._req.request(Route("GET", f"/guilds/{guild_id}/members"), params=payload)
+        guild = self.cache[Guild].get(Snowflake(guild_id))
+        if guild.members is None:
+            guild.members = [Member(**_res, _client=self) for _res in res]
+        else:
+            for member in [Member(**_res, _client=self) for _res in res]:
+                for index, _member in enumerate(guild.members):
+                    if _member.id == member.id:
+                        guild.members[index] = member
+                        break
+                else:
+                    guild.members.append(member)
+        self.cache[Guild].add(guild)  # yes it should just be overwritten
+        return res
 
     async def search_guild_members(self, guild_id: int, query: str, limit: int = 1) -> List[dict]:
         """

interactions/api/http/message.py

@@ -110,9 +110,11 @@ async def get_message(self, channel_id: int, message_id: int) -> Optional[dict]:
         :param message_id: the id of the message
         :return: message if it exists.
         """
-        return await self._req.request(
-            Route("GET", f"/channels/{channel_id}/messages/{message_id}")
-        )
+        res = await self._req.request(Route("GET", f"/channels/{channel_id}/messages/{message_id}"))
+
+        self.cache[Message].merge(Message(**res, _client=self))
+
+        return res
 
     async def delete_message(
         self, channel_id: int, message_id: int, reason: Optional[str] = None

interactions/api/models/channel.py

@@ -166,6 +166,11 @@ class Channel(ClientSerializerMixin, IDMixin):
     permissions: Optional[str] = field(default=None)
     flags: Optional[int] = field(default=None)
 
+    def __attrs_post_init__(self):  # sourcery skip: last-if-guard
+        if self._client:
+            if not self.recipients:
+                self.recipients = self._client.cache[Channel].get(self.id).recipients
+
     def __repr__(self) -> str:
         return self.name
 

interactions/api/models/guild.py

@@ -345,6 +345,19 @@ def __attrs_post_init__(self):  # sourcery skip: last-if-guard
             if self.members:
                 self._client.cache[Member].update({(self.id, m.id): m for m in self.members})
 
+            if not self.channels:
+                self.channels = self._client.cache[Guild].get(self.id).channels
+            if not self.threads:
+                self.threads = self._client.cache[Guild].get(self.id).threads
+            if not self.roles:
+                self.roles = self._client.cache[Guild].get(self.id).roles
+            if not self.members:
+                self.members = self._client.cache[Guild].get(self.id).members
+            if not self.member_count:
+                self.member_count = self._client.cache[Guild].get(self.id).member_count
+            if not self.presences:
+                self.presences = self._client.cache[Guild].get(self.id).presences
+
     def __repr__(self) -> str:
         return self.name