polfan-server-js-client 0.1.97 → 0.1.99

package/build/types/state-tracker/MessagesManager.d.ts

@@ -6,22 +6,35 @@ export declare class MessagesManager {
     private tracker;
     private readonly list;
     private readonly followedTopics;
+    private readonly followedTopicsPromises;
     constructor(tracker: ChatStateTracker);
     /**
      * Get collection of the messages written in topic.
      */
     get(location: ChatLocation): Promise<ObservableIndexedObjectCollection<Message> | undefined>;
     /**
-     * Cache ack reports for all joined rooms in a space and fetch them in bulk if necessary.
-     * Then you can get the reports using getRoomFollowedTopics().
+     * Cache followed topics for all joined rooms in a space and fetch them in bulk if necessary.
+     * Then you can get them using getRoomFollowedTopics().
      * @see getRoomFollowedTopics
      */
     cacheSpaceFollowedTopic(spaceId: string): Promise<void>;
     /**
-     * Get ack reports for the given room. Undefined if you are not in the room.
-     * @param roomId
+     * Get ack reports for the given room.
+     * @return Undefined if you are not in the room, collection otherwise.
      */
     getRoomFollowedTopics(roomId: string): Promise<ObservableIndexedObjectCollection<FollowedTopic> | undefined>;
+    /**
+     * Batch acknowledge all missed messages from any topics in given room.
+     */
+    ackRoomFollowedTopics(roomId: string): Promise<void>;
+    /**
+     * Calculate missed messages from any topic in given room.
+     * @return Undefined if you are not in room, stats object otherwise.
+     */
+    calculateRoomMissedMessages(roomId: string): Promise<{
+        missed: number;
+        missedMore: boolean;
+    } | undefined>;
     /**
      * For internal use. If you want to delete the message, execute a proper command on client object.
      * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.1.97",
+  "version": "0.1.99",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",

package/src/state-tracker/MessagesManager.ts

@@ -16,6 +16,7 @@ import {
     IndexedCollection,
     ObservableIndexedObjectCollection
 } from "../IndexedObjectCollection";
+import {PromiseRegistry} from "./AsyncUtils";
 
 export const getCombinedId = (location: ChatLocation) => (location.roomId ?? '') + (location.topicId ?? '');
 
@@ -23,6 +24,7 @@ export class MessagesManager {
     // Temporary not lazy loaded; server must implement GetTopicMessages command.
     private readonly list = new IndexedCollection<string, ObservableIndexedObjectCollection<Message>>();
     private readonly followedTopics = new IndexedCollection<string, ObservableIndexedObjectCollection<FollowedTopic>>();
+    private readonly followedTopicsPromises = new PromiseRegistry();
 
     public constructor(private tracker: ChatStateTracker) {
         this.tracker.client.on('Session', ev => this.handleSession(ev));
@@ -45,8 +47,8 @@ export class MessagesManager {
     }
 
     /**
-     * Cache ack reports for all joined rooms in a space and fetch them in bulk if necessary.
-     * Then you can get the reports using getRoomFollowedTopics().
+     * Cache followed topics for all joined rooms in a space and fetch them in bulk if necessary.
+     * Then you can get them using getRoomFollowedTopics().
      * @see getRoomFollowedTopics
      */
     public async cacheSpaceFollowedTopic(spaceId: string): Promise<void> {
@@ -65,8 +67,8 @@ export class MessagesManager {
     }
 
     /**
-     * Get ack reports for the given room. Undefined if you are not in the room.
-     * @param roomId
+     * Get ack reports for the given room.
+     * @return Undefined if you are not in the room, collection otherwise.
      */
     public async getRoomFollowedTopics(roomId: string): Promise<ObservableIndexedObjectCollection<FollowedTopic> | undefined> {
         if (! (await this.tracker.rooms.get()).has(roomId)) {
@@ -74,18 +76,64 @@ export class MessagesManager {
         }
 
         if (! this.followedTopics.has(roomId)) {
-            const result = await this.tracker.client.send('GetFollowedTopics', {location: {roomId}});
+            if (this.followedTopicsPromises.notExist(roomId)) {
+                this.followedTopicsPromises.registerByFunction(async () => {
+                    const result = await this.tracker.client.send('GetFollowedTopics', {location: {roomId}});
 
-            if (result.error) {
-                throw result.error;
+                    if (result.error) {
+                        throw result.error;
+                    }
+
+                    this.setFollowedTopicsArray(result.data.followedTopics);
+                }, roomId);
             }
 
-            this.setFollowedTopicsArray(result.data.followedTopics);
+            await this.followedTopicsPromises.get(roomId);
         }
 
         return this.followedTopics.get(roomId);
     }
 
+    /**
+     * Batch acknowledge all missed messages from any topics in given room.
+     */
+    public async ackRoomFollowedTopics(roomId: string): Promise<void> {
+        const collection = await this.getRoomFollowedTopics(roomId);
+
+        if (! collection) {
+            return;
+        }
+
+        for (const followedTopic of collection.items) {
+            if (followedTopic.missed) {
+                await this.tracker.client.send('Ack', {location: followedTopic.location});
+            }
+        }
+    }
+
+    /**
+     * Calculate missed messages from any topic in given room.
+     * @return Undefined if you are not in room, stats object otherwise.
+     */
+    public async calculateRoomMissedMessages(roomId: string): Promise<{missed: number, missedMore: boolean} | undefined> {
+        const collection = await this.getRoomFollowedTopics(roomId);
+
+        if (! collection) {
+            return undefined;
+        }
+
+        let missed: number = 0, missedMore: boolean = false;
+
+        for (const followedTopic of collection.items) {
+            missed += followedTopic.missed ?? followedTopic.missedMoreThan ?? 0;
+            if (followedTopic.missedMoreThan) {
+                missedMore = true;
+            }
+        }
+
+        return {missed, missedMore};
+    }
+
     /**
      * For internal use. If you want to delete the message, execute a proper command on client object.
      * @internal