Fix dm_channel_ids cache component check (#726)

- Change dm_channel_ids to LimitedCapacityCacheMap

Author: davfsa

hikari/config.py

@@ -450,9 +450,17 @@ class CacheSettings:
     """
 
     max_messages: int = attr.field(default=300)
-    """The max number of messages to store in the cache at once.
+    """The maximum number of messages to store in the cache at once.
 
     This will have no effect if the messages cache is not enabled.
 
     Defaults to `300`.
     """
+
+    max_dm_channel_ids: int = attr.field(default=50)
+    """The maximum number of channel IDs to store in the cache at once.
+
+    This will have no effect if the channel IDs cache is not enabled.
+
+    Defaults to `50`.
+    """

hikari/impl/cache.py

@@ -82,10 +82,10 @@ class CacheImpl(cache.MutableCache):
         "_settings",
     )
 
-    _dm_channel_entries: collections.ExtendedMutableMapping[snowflakes.Snowflake, snowflakes.Snowflake]
     # For the sake of keeping things clean, the annotations are being kept separate from the assignment here.
     _me: typing.Optional[users.OwnUser]
     _emoji_entries: collections.ExtendedMutableMapping[snowflakes.Snowflake, cache_utility.KnownCustomEmojiData]
+    _dm_channel_entries: collections.ExtendedMutableMapping[snowflakes.Snowflake, snowflakes.Snowflake]
     _guild_channel_entries: collections.ExtendedMutableMapping[snowflakes.Snowflake, channels.GuildChannel]
     _guild_entries: collections.ExtendedMutableMapping[snowflakes.Snowflake, cache_utility.GuildRecord]
     _invite_entries: collections.ExtendedMutableMapping[str, cache_utility.InviteData]
@@ -104,7 +104,6 @@ class CacheImpl(cache.MutableCache):
 
     def __init__(self, app: traits.RESTAware, settings: config.CacheSettings) -> None:
         self._app = app
-        self._me = None
         self._settings = settings
         self._create_cache()
 
@@ -113,7 +112,8 @@ def settings(self) -> config.CacheSettings:
         return self._settings
 
     def _create_cache(self) -> None:
-        self._dm_channel_entries = collections.FreezableDict()
+        self._me = None
+        self._dm_channel_entries = collections.LimitedCapacityCacheMap(limit=self._settings.max_dm_channel_ids)
         self._emoji_entries = collections.FreezableDict()
         self._guild_channel_entries = collections.FreezableDict()
         self._guild_entries = collections.FreezableDict()
@@ -142,21 +142,33 @@ def clear(self) -> None:
         self._create_cache()
 
     def clear_dm_channel_ids(self) -> cache.CacheView[snowflakes.Snowflake, snowflakes.Snowflake]:
+        if not self._is_cache_enabled_for(config.CacheComponents.DM_CHANNEL_IDS):
+            return cache_utility.EmptyCacheView()
+
         result = self._dm_channel_entries
-        self._dm_channel_entries = collections.FreezableDict()
+        self._dm_channel_entries = collections.LimitedCapacityCacheMap(limit=self._settings.max_dm_channel_ids)
         return cache_utility.CacheMappingView(result)
 
     def delete_dm_channel_id(
         self, user: snowflakes.SnowflakeishOr[users.PartialUser], /
     ) -> typing.Optional[snowflakes.Snowflake]:
+        if not self._is_cache_enabled_for(config.CacheComponents.DM_CHANNEL_IDS):
+            return None
+
         return self._dm_channel_entries.pop(snowflakes.Snowflake(user), None)
 
     def get_dm_channel_id(
         self, user: snowflakes.SnowflakeishOr[users.PartialUser], /
     ) -> typing.Optional[snowflakes.Snowflake]:
+        if not self._is_cache_enabled_for(config.CacheComponents.DM_CHANNEL_IDS):
+            return None
+
         return self._dm_channel_entries.get(snowflakes.Snowflake(user))
 
     def get_dm_channel_ids_view(self) -> cache.CacheView[snowflakes.Snowflake, snowflakes.Snowflake]:
+        if not self._is_cache_enabled_for(config.CacheComponents.DM_CHANNEL_IDS):
+            return cache_utility.EmptyCacheView()
+
         return cache_utility.CacheMappingView(self._dm_channel_entries.freeze())
 
     def set_dm_channel_id(
@@ -165,9 +177,10 @@ def set_dm_channel_id(
         channel: snowflakes.SnowflakeishOr[channels.PartialChannel],
         /,
     ) -> None:
-        user = snowflakes.Snowflake(user)
-        if self._is_cache_enabled_for(config.CacheComponents.EMOJIS) and user in self._user_entries:
-            self._dm_channel_entries[user] = snowflakes.Snowflake(channel)
+        if not self._is_cache_enabled_for(config.CacheComponents.DM_CHANNEL_IDS):
+            return None
+
+        self._dm_channel_entries[snowflakes.Snowflake(user)] = snowflakes.Snowflake(channel)
 
     def _build_emoji(
         self,

tests/hikari/impl/test_cache.py

@@ -129,18 +129,6 @@ def test_set_dm_channel_id(self, cache_impl):
 
         assert cache_impl._dm_channel_entries == {43123123: 12222}
 
-    def test_set_dm_channel_id_when_user_not_known(self, cache_impl):
-        cache_impl.set_dm_channel_id(StubModel(43123123), StubModel(12222))
-
-        assert cache_impl._dm_channel_entries == {}
-
-    def test_set_dm_channel_id_when_not_enabled(self, cache_impl):
-        cache_impl._user_entries = collections.FreezableDict({43123123: object()})
-        cache_impl._settings.components = 0
-        cache_impl.set_dm_channel_id(StubModel(43123123), StubModel(12222))
-
-        assert cache_impl._dm_channel_entries == {}
-
     def test__build_emoji(self, cache_impl):
         mock_user = mock.MagicMock(users.User)
         emoji_data = cache_utilities.KnownCustomEmojiData(
@@ -2666,6 +2654,11 @@ def test_update_message_for_unknown_partial_message(self, cache_impl):
     @pytest.mark.parametrize(
         ("name", "component", "expected"),
         [
+            ("clear_dm_channel_ids", config.CacheComponents.DM_CHANNEL_IDS, cache_utilities.EmptyCacheView()),
+            ("delete_dm_channel_id", config.CacheComponents.DM_CHANNEL_IDS, None),
+            ("get_dm_channel_id", config.CacheComponents.DM_CHANNEL_IDS, None),
+            ("get_dm_channel_ids_view", config.CacheComponents.DM_CHANNEL_IDS, cache_utilities.EmptyCacheView()),
+            ("set_dm_channel_id", config.CacheComponents.DM_CHANNEL_IDS, None),
             ("clear_emojis", config.CacheComponents.EMOJIS, cache_utilities.EmptyCacheView()),
             ("clear_emojis_for_guild", config.CacheComponents.EMOJIS, cache_utilities.EmptyCacheView()),
             ("clear_guild_channels", config.CacheComponents.GUILD_CHANNELS, cache_utilities.EmptyCacheView()),