Add support for message snapshots used in message forwarding #9892

redmvc · 2024-07-22T16:09:55Z

Summary

Message forwarding was introduced on July 18, 2024. Messages now have a new optional parameter, message_snapshots, which is an array of Message Snapshots containing immutable snapshots of a message being forwarded. Such messages will, additionally, always have a reference to the message being forwarded, and that reference will have type = 1.

This PR adds a MessageSnapshot class and a message_snapshots parameter to the Message class. It also adds the type parameter to the MessageReference class, in order to track whether a reference is a reply or a forward.

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

Create enums and class attributes tracking the type of a message reference (default or forward)

Create a class to track a snapshot of a message

Add class MessageSnapshot to classes exported from message.py

Soheab · 2024-07-22T16:14:16Z

Can't this use the existing Message class? With a potential _from_snapshot classmethod

…/discord.py into feature/message_snapshots

redmvc · 2024-07-22T16:15:52Z

Message snapshots don't have all Message information; in particular, they don't have an author.

discord/message.py

discord/enums.py

discord/message.py

Co-authored-by: MCausc78 <[email protected]>

Move MessageReferenceType definition in types/message.py above MessageReference typed dict

owocado

I think that "forwarded" would make more sense here (in context of users reading relevant documentation) instead of "snapshotted".

discord/message.py

Co-authored-by: owocado <[email protected]>

DA-344 · 2024-07-27T19:20:23Z

discord/message.py

@@ -452,6 +455,92 @@ def guild_id(self) -> Optional[int]:
        return self._parent.guild_id


+class MessageSnapshot:


I think this could have a cached_message attribute that, as its name indicates, has the cached message of this snapshot, if found.

Is it ever found? I tested it for a while and none of the forwards I saw had that attribute non-empty

As said, if the message is found in the cache then this would be non-empty. If a user forwards a message the bot has cached then the attribute would be filled, else not.
As forwarding is just referencing a message, this would be almost the same as MessageReference.cached_message

Wait sorry I misunderstood. Yeah that seems like not a bad idea, though I'd need to look into how the cache works exactly

This is a good idea, it shouldn't be a complicated add either. You already pass the connection state as a parameter but you need to bind it to make it into a property.

Rapptz

Thanks for the PR, some minor nits.

Rapptz · 2024-08-28T19:12:19Z

discord/message.py

@@ -452,6 +455,92 @@ def guild_id(self) -> Optional[int]:
        return self._parent.guild_id


+class MessageSnapshot:
+    """Represents a message snapshot attached to a forwarded message.


This needs a .. versionadded:: 2.5 into it.

Rapptz · 2024-08-28T19:13:14Z

discord/message.py

@@ -452,6 +455,92 @@ def guild_id(self) -> Optional[int]:
        return self._parent.guild_id


+class MessageSnapshot:


This is a good idea, it shouldn't be a complicated add either. You already pass the connection state as a parameter but you need to bind it to make it into a property.

Rapptz · 2024-08-28T19:18:06Z

discord/enums.py

@@ -218,6 +218,11 @@ def __str__(self) -> str:
        return self.name


+class MessageReferenceType(Enum):
+    default = 0


This should be called reply with an alias to default. The API docs even call it REPLY and DEFAULT despite not mentioning the former. https://discord.com/developers/docs/resources/message#message-reference-types

Rapptz · 2024-08-28T19:18:21Z

discord/message.py

+    type: :class:`MessageReferenceType`
+        The type of message reference.


Needs a versionadded.

Rapptz · 2024-08-28T19:18:29Z

discord/message.py

+    def __init__(
+        self,
+        *,
+        type: MessageReferenceType,
+        message_id: int,
+        channel_id: int,
+        guild_id: Optional[int] = None,
+        fail_if_not_exists: bool = True,
+    ):


MessageReference is a 'data class' in discord.py which means users can create it, making this a breaking change for those who did since they no longer have a type parameter. You should give it a default value.

Rapptz · 2024-08-28T19:19:12Z

docs/api.rst

+MessageSnapshot
+~~~~~~~~~~~~~~~~~
+
+.. attributetable:: MessageSnapshot
+
+.. autoclass:: MessageSnapshot
+    :members:
+


Since this is an API received object it needs to be in the model section with the constructor hidden.

Puncher1 · 2024-08-31T15:19:19Z

As new PR opened on Discord's side, this is missing following fields in MessageSnapshot: stickers, sticker_items, and components.

redmvc · 2024-09-28T19:04:42Z

Sorry, it's unlikely I'll be able to resume work on this PR anytime soon. If anybody wants to take the code, I encourage it.

Rapptz · 2024-10-09T21:10:46Z

Superseded by #9950

redmvc added 8 commits July 19, 2024 11:55

Create message reference type

6561f74

Create enums and class attributes tracking the type of a message reference (default or forward)

Create MessageSnapshot class

43e0fd2

Create a class to track a snapshot of a message

Store list of message snapshots in message

0c6eb9e

Add MessageSnapshot to exported classes

7b7dd83

Add class MessageSnapshot to classes exported from message.py

Remove trailing spaces

cc10a75

Add MessageSnapshit to api.rst

4c65968

Typo fix

57f5949

Remove incorrect documentation

ea5763b

redmvc added 4 commits July 22, 2024 13:14

Add MessageSnapshot to api.rst

6ed45c1

Typo fix

46d157c

Remove incorrect documentation

aa01eca

Merge branch 'feature/message_snapshots' of https://github.com/redmvc…

6a7933c

…/discord.py into feature/message_snapshots

AbstractUmbra reviewed Jul 22, 2024

View reviewed changes

discord/message.py Outdated Show resolved Hide resolved

discord/message.py Outdated Show resolved Hide resolved

discord/enums.py Show resolved Hide resolved

AbstractUmbra reviewed Jul 22, 2024

View reviewed changes

discord/message.py Outdated Show resolved Hide resolved

discord/message.py Show resolved Hide resolved

redmvc added 2 commits July 22, 2024 13:48

Use MessageReferenceType in MessageReference initialiser

6867dc6

Rename MessageSnapshot's timestamp to created_at

e58f341

MCausc78 reviewed Jul 22, 2024

View reviewed changes

discord/message.py Outdated Show resolved Hide resolved

redmvc and others added 6 commits July 22, 2024 13:58

Create edited_at property in MessageSnapshot

756f6c6

Add missing line break

6459700

Pass 0 to try_enum in MessageReference.with_state()

15b54ff

Co-authored-by: MCausc78 <[email protected]>

Use type directly in MessageReference init

73c6904

Format message.py

bf1762c

Move MessageReferenceType definition

8da22c0

Move MessageReferenceType definition in types/message.py above MessageReference typed dict

owocado reviewed Jul 24, 2024

View reviewed changes

Replace "snapshotted" with "forwarded" in docstrings

3e9abf4

Co-authored-by: owocado <[email protected]>

DA-344 reviewed Jul 27, 2024

View reviewed changes

Rapptz requested changes Aug 28, 2024

View reviewed changes

Rapptz added the pending PR implements an in-progress or explicitly unreleased Discord feature label Aug 31, 2024

DA-344 mentioned this pull request Sep 29, 2024

Message Forwarding #9950

Merged

6 tasks

Rapptz closed this Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for message snapshots used in message forwarding #9892

Add support for message snapshots used in message forwarding #9892

redmvc commented Jul 22, 2024

Soheab commented Jul 22, 2024

redmvc commented Jul 22, 2024

owocado left a comment •

edited

Loading

DA-344 Jul 27, 2024

redmvc Jul 27, 2024

DA-344 Jul 27, 2024 •

edited

Loading

redmvc Jul 27, 2024

Rapptz Aug 28, 2024

Rapptz left a comment

Rapptz Aug 28, 2024

Rapptz Aug 28, 2024

Rapptz Aug 28, 2024

Rapptz Aug 28, 2024

Rapptz Aug 28, 2024

Rapptz Aug 28, 2024

Puncher1 commented Aug 31, 2024

redmvc commented Sep 28, 2024

Rapptz commented Oct 9, 2024 •

edited

Loading

		@@ -452,6 +455,92 @@ def guild_id(self) -> Optional[int]:
		return self._parent.guild_id


		class MessageSnapshot:

		type: :class:`MessageReferenceType`
		The type of message reference.

Add support for message snapshots used in message forwarding #9892

Add support for message snapshots used in message forwarding #9892

Conversation

redmvc commented Jul 22, 2024

Summary

Checklist

Soheab commented Jul 22, 2024

redmvc commented Jul 22, 2024

owocado left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DA-344 Jul 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rapptz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Puncher1 commented Aug 31, 2024

redmvc commented Sep 28, 2024

Rapptz commented Oct 9, 2024 • edited Loading

owocado left a comment •

edited

Loading

DA-344 Jul 27, 2024 •

edited

Loading

Rapptz commented Oct 9, 2024 •

edited

Loading