fix: Prevent crashes from View.refresh (#3059)

Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Paillat <paillat@pycord.dev>
Co-authored-by: Lala Sabathil <lala@pycord.dev>

Author: 5 people

CHANGELOG.md

@@ -34,6 +34,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#3178](https://github.com/Pycord-Development/pycord/pull/3178))
 - Fixed a `KeyError` when fetching an app's information or checking for app ownership
   with `is_owner`.
+- Fixed certain scenarios where received components could crash the app.
+  ([#3059](https://github.com/Pycord-Development/pycord/pull/3059))
 
 ### Deprecated
 

discord/abc.py

@@ -1732,7 +1732,7 @@ async def send(
             if view.is_dispatchable():
                 state.store_view(view, ret.id)
             view.message = ret
-            view.refresh(ret.components)
+            view._refresh(ret.components)
 
         if delete_after is not None:
             await ret.delete(delay=delete_after)

discord/interactions.py

@@ -621,8 +621,9 @@ async def edit_original_response(
             previous_allowed_mentions=previous_mentions,
             suppress_embeds=suppress_embeds,
         )
-        if view and self.message:
-            self._state.prevent_view_updates_for(self.message.id)
+        _target = self.message or self._original_response
+        if view and _target:
+            self._state.prevent_view_updates_for(_target.id)
         adapter = async_context.get()
         http = self._state.http
         data = await adapter.edit_original_interaction_response(
@@ -641,7 +642,7 @@ async def edit_original_response(
         message = InteractionMessage(state=state, channel=self.channel, data=data)  # type: ignore
         if view:
             if not view.is_finished():
-                view.refresh(message.components)
+                view._refresh(message.components)
                 if view.is_dispatchable():
                     self._state.store_view(view, message.id)
 
@@ -1308,7 +1309,7 @@ async def edit_message(
             raise InteractionResponded(self._parent)
 
         parent = self._parent
-        msg = parent.message
+        msg = parent.message or parent._original_response
         state = parent._state
         message_id = msg.id if msg else None
         if parent.type not in (InteractionType.component, InteractionType.modal_submit):

discord/message.py

@@ -1918,7 +1918,7 @@ async def edit(
 
         if view and not view.is_finished():
             view.message = message
-            view.refresh(message.components)
+            view._refresh(message.components)
             if view.is_dispatchable():
                 self._state.store_view(view, self.id)
 
@@ -2587,7 +2587,7 @@ async def edit(self, **fields: Any) -> Message | None:
             msg = self._state.create_message(channel=self.channel, data=data)  # type: ignore
             if view and not view.is_finished():
                 view.message = msg
-                view.refresh(msg.components)
+                view._refresh(msg.components)
                 if view.is_dispatchable():
                     self._state.store_view(view, self.id)
             return msg

discord/ui/modal.py

@@ -364,7 +364,7 @@ def remove_item(self, item: InputText) -> Self:
             pass
         return self
 
-    def refresh(self, interaction: Interaction, data: list[ComponentPayload]):
+    def _refresh(self, interaction: Interaction, data: list[ComponentPayload]):
         components = [
             component
             for parent_component in data
@@ -448,7 +448,7 @@ def add_item(self, item: ModalItem) -> Self:
         super().add_item(item)
         return self
 
-    def refresh(self, interaction: Interaction, data: list[ComponentPayload]):
+    def _refresh(self, interaction: Interaction, data: list[ComponentPayload]):
         for component, child in zip(data, self.children):
             child.refresh_from_modal(interaction, component)
 
@@ -520,7 +520,7 @@ async def dispatch(self, user_id: int, custom_id: str, interaction: Interaction)
 
         try:
             components = interaction.data["components"]
-            modal.refresh(interaction, components)
+            modal._refresh(interaction, components)
             await modal.callback(interaction)
             self.remove_modal(modal, user_id)
         except Exception as e:

discord/ui/view.py

@@ -27,6 +27,7 @@
 
 import asyncio
 import contextlib
+import logging
 import os
 import sys
 import time
@@ -83,6 +84,8 @@
     from ..state import ConnectionState
     from ..types.components import Component as ComponentPayload
 
+_log = logging.getLogger(__name__)
+
 V = TypeVar("V", bound="BaseView", covariant=True)
 
 
@@ -756,7 +759,7 @@ def clear_items(self) -> Self:
         self.__weights.clear()
         return self
 
-    def refresh(self, components: list[Component]):
+    def _refresh(self, components: list[Component]):
         # This is pretty hacky at the moment
         old_state: dict[tuple[int, str], ViewItem[V]] = {
             (item.type.value, item.custom_id): item
@@ -935,7 +938,7 @@ def add_item(self, item: ViewItem[V]) -> Self:
         super().add_item(item)
         return self
 
-    def refresh(self, components: list[Component]):
+    def _refresh(self, components: list[Component]):
         # Refreshes view data using discord's values
         # Assumes the components and items are identical
         if not components:
@@ -1039,4 +1042,9 @@ def update_from_message(self, message_id: int, components: list[ComponentPayload
         # pre-req: is_message_tracked == true
         view = self._synced_message_views[message_id]
         components = [_component_factory(d, state=self._state) for d in components]
-        view.refresh(components)
+        try:
+            view._refresh(components)
+        except Exception:
+            _log.exception(
+                f"Failed to refresh View {view} from Message {message_id} due to mismatched state. Items may not have complete data."
+            )

discord/webhook/async_.py

@@ -1940,7 +1940,7 @@ async def send(
             if self.parent and not view.parent:
                 view.parent = self.parent
             if msg:
-                view.refresh(msg.components)
+                view._refresh(msg.components)
             if view.is_dispatchable():
                 self._state.store_view(view, message_id)
 
@@ -2164,7 +2164,7 @@ async def edit_message(
         message = self._create_message(data)
         if view and not view.is_finished():
             view.message = message
-            view.refresh(message.components)
+            view._refresh(message.components)
             if view.is_dispatchable():
                 self._state.store_view(view, message_id)
         return message