[CHAT-254] Add chat design pattern for message storage #2245
+212
−14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Srushtika
requested changes
Aug 22, 2024
| - javascript | ||
| --- | ||
|
|
||
| Use of room "history":/chat/rooms/history enables you to retrieve messages stored by Ably from between 72 hours, up to 30 days. In some instances you may wish to store messages for longer than this, or you would prefer to store all messages in your own database. |
There was a problem hiding this comment.
Let's skip the "longer than this" narrative and only keep it about the preference to use their own DB. Perhaps we can add a CTA to raise a feature request if they'd like to enable storage for longer than 30 days.
|
|
||
| The motivation for storing messages externally could be for various reasons, such as: | ||
|
|
||
| * For privacy reasons. |
There was a problem hiding this comment.
Suggested change
| * For privacy reasons. | |
| * For privacy and compliance reasons. |
|
|
||
| * For privacy reasons. | ||
| * The need to analyze the historic data that users send. | ||
| * So that messages are available for moderation, review or audit purposes. |
There was a problem hiding this comment.
I think this is covered in the analyze point above.
| * For privacy reasons. | ||
| * The need to analyze the historic data that users send. | ||
| * So that messages are available for moderation, review or audit purposes. | ||
| * When you require storage longer than 30 days. |
| * So that messages are available for moderation, review or audit purposes. | ||
| * When you require storage longer than 30 days. | ||
|
|
||
| Storing message history outside of Ably can be achieved using "Ably Pub/Sub":/products/channels and its integrations. |
There was a problem hiding this comment.
I think we should say that it can be achieved using the integrations but in the beta stage, those integrations will have to be configured with the channels which are the pub/sub primitives behind chat features in a room.
|
|
||
| The Chat SDK is built upon the functionality provided by "Ably Pub/Sub":/products/channels. The Chat SDK is built so that you don't need to interact with some of the lower-level features provided by Pub/Sub. It is therefore possible to utilize the Pub/Sub SDK to provide functionality to your chat applications that isn't yet available as an abstraction in the Chat SDK. | ||
|
|
||
| You need to understand that a room is based on one or more Pub/Sub "channels":/channels. The number of channels depends on the chat features enabled for that room. For storage purposes, you need to manage the channel for regular chat messages, and the channel for room reactions if you want to store those. |
There was a problem hiding this comment.
Suggested change
| You need to understand that a room is based on one or more Pub/Sub "channels":/channels. The number of channels depends on the chat features enabled for that room. For storage purposes, you need to manage the channel for regular chat messages, and the channel for room reactions if you want to store those. | |
| Behind-the-scenes, a chat room is based on one or more Pub/Sub "channels":/channels. For storage purposes, you may need to access the channel used for regular chat messages, and the channel for room reactions if you want to store those. |
| @@ -0,0 +1,190 @@ | |||
| --- | |||
| title: Message storage | |||
There was a problem hiding this comment.
Given we are talking generally about all integrations, I think we should keep this title generic too. wdyt @m-hulbert?
|
|
||
| Integrations all work on a rule based system, where rules can be configured to run for every message published to a channel. For chat messages, you will need to utilize a function to parse the messages sent to the integration that transforms them into a format suitable to storage in your database. | ||
|
|
||
| h3(#create-rule). Create an integration rule |
There was a problem hiding this comment.
A screenshot might go a long way in this section, wdyt @m-hulbert ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a design pattern for how to store messages outside of Ably in relation to the Chat SDK.