Managing Internal State
How to manage your app's internal state, here is the recipe!
It's a common need to manage internal state in your app. Storing app's state in the memory inside of an app is not recommended at all because a Rocket.Chat server can have several instances and each server has its own instance of an app. If the data, such as confirmation for context, stored in the memory between the different instances then the problem occrurs. There're 2 approaches here suggested to be applied to solve the problem above.
Persistence APIs (Recommended)
There's IPersistence interface provided for creating/updating records in the persistence storage and IPersistenceRead interface provided for reading records. In the exmaple below, we'll teach you how to manage your app's internal state using persistence APIs.
Assuming that we're creating an app which records how many messages on the server sent, we can write a PostMessageSent event handler like bellow:
1
public async executePostMessageSent(message: IMessage, read: IRead, http: IHttp, persistence: IPersistence, modify: IModify): Promise<void> {
2
const association = new RocketChatAssociationRecord(RocketChatAssociationModel.MISC, 'message-count');
3
const persis = read.getPersistenceReader();
4
try {
5
let count = 0;
6
const record = await persis.readByAssociation(association);
7
if (record?.count) count = record.count;
8
​
9
await persistence.createWithAssociation({ count: ++count || 0 }, association);
10
​
11
console.log(`Message Sent Count: ${ count }`)
12
} catch (err) {
13
return this.getLogger().error(err);
14
}
15
}
Copied!
Here, the internal state is "count" but not the count variable whose data stored in the memory. We use the temporary variable "count" for storing the number of messages sent retrieving from the persistence. Every time the handler executePostMessageSent called, we increase the count by 1 and then store it back to the persistence storage.
In this way, even in a cluster environment, your app inside each Rocket.Chat instance can share data from a single data source - Rocket.Chat persistence storage and maintain data consistency.
Message customFields
Besides Persistence APIs,
customFields is a public way of storing data related to a message. You can attach some custom "attributes" (called customFields) to a message by creating/modifying the message. You should only use the customFields if you're ok with potentially having them read and overwritten by someone else!Last modified 1mo ago
Export as PDF
Copy link
Edit on GitHub