-
Notifications
You must be signed in to change notification settings - Fork 43
Ephemeral messages; _message partial #2543
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
So we're not making the same change in multiple places. Copy the version from realtime-sdk to the partial since it seemed to have been kept more up to date than the partial version. (which is the sort of drift that we can avoid exactly by using partials!)
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this, Simon.
My only comment would be whether you think it's worth using an example other than Chat here? Whilst it's valid to build chat using Pub/Sub, I think we should be highlighting other use cases now that we have Ably Chat.
The main advantage of using a chatroom as an example is it's intuitive and universally understandable. Everyone knows what a chatroom is, and the basic shape of the solution (i.e. a chatroom maps to an ably channel) is so obvious you don't need to say it. Say I instead used an example of using ably for a service discovery layer in a cluster, where an ably channel is used for each 'visibility class', a set of servers which should all be visible to each other and able to discover each other's addresses, where they might enter presence to announce themselves; which might then want to use ephemeral messaging to broadcast how busy/loaded they are minute-to-minute, where you'd want to persist the history of presence changes but don't care about load history. I just needed to use 47 words to achieve what in the other example I achieved by saying "Say you have a chat room". And I would guess a good chunk of people reading the doc wouldn't get it. The chat room is an example that everyone would get instantly. |
Adds docs for ephemeral messages to pub-sub-advanced.
I was going to update the
extras
description in message objects to addephemeral
but was irked by having to make the change in 3 places, which all seemed to have copied and pasted theMessage
types from the message partial instead of just including the partial. (And then inevitably diverged as people only made fixes to one or two of them, which is why partials are good). I couldn't see any reason given in the commit message that did the duplication, so I've taken the liberty of deduplicating (taking the text from the realtime-api version since that seems to have been kept more up to date than the one in hte partial).PUB-1317