Fixed on_comment event dispatching multiple times for a single comment (#619)

Author: ricer0ll

docs/extensions/annotations.py

@@ -80,7 +80,7 @@ def visit_any(self, t: types.AnyType) -> Any:
         return Any
 
     def visit_overloaded(self, t: types.Overloaded) -> GenericAlias:
-        return Union[self.collect_types(t.items)]
+        return Union[self.collect_types(t.items)]  # noqa: UP007
 
     def visit_callable_type(self, t: types.CallableType) -> GenericAlias:
         return Callable[list(self.collect_types(t.arg_types)), self.collect_types([t.ret_type])[0]]
@@ -116,7 +116,7 @@ def visit_union_type(self, t: types.UnionType) -> Any:
             return t.items[0]
         if all(isinstance(arg, LiteralGenericAlias) for arg in t.items):
             return Literal[tuple(t.__args__[0] for t in self.collect_types(t.items))]
-        return Union[self.collect_types(t.items)]
+        return Union[self.collect_types(t.items)]  # noqa: UP007
 
     def visit_type_alias_type(self, t: types.TypeAliasType) -> Any:
         return t.expand_all_if_possible().accept(self) if not t.is_recursive else self.get(t.alias.fullname)

steam/client.py

@@ -101,6 +101,7 @@ class ClientKwargs(TypedDict, total=False):
     connector: aiohttp.BaseConnector | None
     intents: Intents
     max_messages: int | None
+    max_comments: int | None
     app: App | None
     apps: list[App]
     state: PersonaState
@@ -133,6 +134,8 @@ class Client:
         The intents you wish to start the client with.
     max_messages
         The maximum number of messages to store in the internal cache, default is 1000.
+    max_comments
+        the maximum number of comments to store in the internal cache, default is 10000.
     app
         An app to set your status as on connect. This will take precedence over any apps set using ``apps`` as your
         current status.

steam/ext/csgo/protobufs/cstrike.py

@@ -253,7 +253,7 @@ async def fetch_manifest(
                 else:
                     err = e
         if sys.version_info >= (3, 11):
-            raise ExceptionGroup("No manifest found with id and depot_id supplied", errs)
+            raise ExceptionGroup("No manifest found with id and depot_id supplied", errs)  # noqa: F821
         else:
             raise err
 

steam/package.py

@@ -196,6 +196,9 @@ def __init__(self, client: Client, **kwargs: Unpack[ClientKwargs]):
         self.handled_wallet = asyncio.Event()
         self.intents: Final = kwargs.get("intents", Intents.Safe)
         self.max_messages: int | None = kwargs.get("max_messages", 1000)
+        self.max_comments: int = kwargs.get("max_comments", 10000)
+        self._process_comment_lock: asyncio.Lock = asyncio.Lock()
+        self._processed_comment_ids: set[int] = set()
 
         app = kwargs.get("app")
         apps = kwargs.get("apps")
@@ -2387,7 +2390,15 @@ async def handle_notifications(self, msg: notifications.GetSteamNotificationsRes
                             log.info("Unknown commentable type %d", type)
                             continue
                     try:
-                        self.dispatch("comment", await commentable.fetch_comment(int(body["cgid"])))
+                        comment = await commentable.fetch_comment(int(body["cgid"]))
+                        async with self._process_comment_lock:  # prevents multiple dispatch for a single comment
+                            if comment.id in self._processed_comment_ids:
+                                log.debug("Ignoring processed comment: %s", comment.id)
+                                continue
+                            if len(self._processed_comment_ids) > self.max_comments:
+                                self._processed_comment_ids.pop()
+                            self._processed_comment_ids.add(comment.id)
+                        self.dispatch("comment", comment)
                     except (WSException, KeyError):
                         log.info("Failed to fetch comment %s", notification, exc_info=True)
                 case 9:  # trade, this is only going to happen at startup