polfan-server-js-client 0.1.36 → 0.1.38

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

@@ -0,0 +1,14 @@
+export declare class DeferredTask {
+    readonly promise: Promise<void>;
+    resolve: () => void;
+    constructor();
+}
+export declare class PromiseRegistry {
+    private promises;
+    register<T = any>(promise: Promise<T>, key: string): void;
+    registerByFunction(fn: () => Promise<any>, key: string): void;
+    get<T = any>(key: string): Promise<T> | undefined;
+    has(key: string): boolean;
+    notExist(key: string): boolean;
+    forget(...keys: string[]): void;
+}

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

@@ -5,6 +5,7 @@ import { Permission } from "../Permission";
 export declare class PermissionsManager extends EventTarget {
     private tracker;
     private readonly overwrites;
+    private readonly overwritesPromises;
     constructor(tracker: ChatStateTracker);
     getOverwrites(layer: PermissionOverwrites['layer'], layerId: PermissionOverwrites['layerId'], target: PermissionOverwrites['target'], targetId: PermissionOverwrites['targetId']): Promise<PermissionOverwrites | undefined>;
     on(eventName: 'change', handler: EventHandler<any>): this;
@@ -14,6 +15,14 @@ export declare class PermissionsManager extends EventTarget {
     }>;
     calculatePermissions(spaceId?: string, roomId?: string, topicId?: string): Promise<number>;
     private handlePermissionOverwrites;
+    private handleSpaceDeleted;
+    private handleRoomDeleted;
+    private handleTopicDeleted;
+    private handleRoleDeleted;
+    /**
+     * @return Matched and deleted ids
+     */
+    private deleteOverwritesByIdPrefix;
     private collectRoleOverwrites;
     private resolveOverwritesFromRolesByOrder;
     private resolveOverwritesHierarchy;

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

@@ -9,6 +9,7 @@ export declare class RoomsManager {
     private readonly topics;
     private readonly members;
     private readonly deferredSession;
+    private readonly membersPromises;
     constructor(tracker: ChatStateTracker);
     /**
      * Get collection of room members.
@@ -26,22 +27,17 @@ export declare class RoomsManager {
      * Get collection of room topics.
      */
     getTopics(roomId: string): Promise<ObservableIndexedObjectCollection<Topic> | undefined>;
-    /**
-     * For internal use. If you want to leave the room, execute a proper command on client object.
-     * @internal
-     */
-    _delete(...roomIds: string[]): void;
-    /**
-     * For internal use. If you want to leave the room, execute a proper command on client object.
-     * @internal
-     */
-    _deleteBySpaceId(spaceId: string): void;
+    private deleteRoom;
+    private deleteRoomsBySpaceId;
     private handleSpaceMemberUpdated;
+    private handleSpaceMemberLeft;
     private handleRoomMemberUpdated;
+    private handleSpaceDeleted;
     private handleTopicDeleted;
     private handleNewTopic;
     private addJoinedRoomTopics;
     private handleRoomJoined;
+    private handleRoomDeleted;
     private addJoinedRooms;
     private handleRoomLeft;
     private handleRoomMemberJoined;

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

@@ -8,6 +8,8 @@ export declare class SpacesManager {
     private readonly rooms;
     private readonly members;
     private readonly deferredSession;
+    private readonly roomsPromises;
+    private readonly membersPromises;
     constructor(tracker: ChatStateTracker);
     /**
      * Get collection of all the spaces you are in.
@@ -36,7 +38,6 @@ export declare class SpacesManager {
     private handleSpaceDeleted;
     private handleSpaceJoined;
     private addJoinedSpaces;
-    private handleSpaceLeft;
     private handleSpaceMemberJoined;
     private handleSpaceMemberLeft;
     private handleSpaceMembers;

package/package.json

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

package/src/state-tracker/AsyncUtils.ts

@@ -0,0 +1,38 @@
+import {IndexedCollection} from "../IndexedObjectCollection";
+
+export class DeferredTask {
+    public readonly promise: Promise<void>;
+    public resolve: () => void;
+
+    public constructor() {
+        this.promise = new Promise<void>((resolve) => this.resolve = resolve);
+    }
+}
+
+export class PromiseRegistry {
+    private promises = new IndexedCollection<string, Promise<any>>();
+
+    public register<T = any>(promise: Promise<T>, key: string): void {
+        this.promises.set([key, promise]);
+    }
+
+    public registerByFunction(fn: () => Promise<any>, key: string): void {
+        this.register(fn(), key);
+    }
+
+    public get<T = any>(key: string): Promise<T> | undefined {
+        return this.promises.get(key);
+    }
+
+    public has(key: string): boolean {
+        return this.promises.has(key);
+    }
+
+    public notExist(key: string): boolean {
+        return ! this.has(key);
+    }
+
+    public forget(...keys: string[]): void {
+        this.promises.delete(...keys);
+    }
+}

package/src/state-tracker/ChatStateTracker.ts

@@ -3,7 +3,7 @@ import {Session, User} from "pserv-ts-types";
 import {RoomsManager} from "./RoomsManager";
 import {SpacesManager} from "./SpacesManager";
 import {PermissionsManager} from "./PermissionsManager";
-import {DeferredTask} from "./DeferredTask";
+import {DeferredTask} from "./AsyncUtils";
 
 export class ChatStateTracker {
     /**

package/src/state-tracker/PermissionsManager.ts

@@ -2,19 +2,19 @@ import {ChatStateTracker} from "./ChatStateTracker";
 import {
     PermissionOverwrites,
     PermissionOverwritesChanged,
-    PermissionOverwritesValue,
-    Role
+    PermissionOverwritesValue, RoleDeleted, RoomDeleted, RoomLeft, SpaceDeleted, SpaceLeft, TopicDeleted,
 } from "pserv-ts-types";
 import {EventHandler, EventTarget} from "../EventTarget";
 import {IndexedCollection} from "../IndexedObjectCollection";
 import {Permission} from "../Permission";
+import {PromiseRegistry} from "./AsyncUtils";
 
 const getOvId = (
     layer: PermissionOverwrites['layer'],
     layerId: PermissionOverwrites['layerId'],
-    target: PermissionOverwrites['target'],
-    targetId: PermissionOverwrites['targetId'],
-) => layer + (layerId ?? '') + target + targetId;
+    target?: PermissionOverwrites['target'],
+    targetId?: PermissionOverwrites['targetId'],
+) => layer + (layerId ?? '') + (target ?? '') + (targetId ?? '');
 
 const getOvIdByObject = (overwrites: PermissionOverwrites | PermissionOverwritesChanged): string => getOvId(
     overwrites.layer, overwrites.layerId, overwrites.target, overwrites.targetId
@@ -22,11 +22,18 @@ const getOvIdByObject = (overwrites: PermissionOverwrites | PermissionOverwrites
 
 export class PermissionsManager extends EventTarget {
     private readonly overwrites = new IndexedCollection<string, PermissionOverwrites>();
+    private readonly overwritesPromises = new PromiseRegistry();
 
     public constructor(private tracker: ChatStateTracker) {
         super();
         this.tracker.client.on('PermissionOverwrites', ev => this.handlePermissionOverwrites(ev));
         this.tracker.client.on('PermissionOverwritesChanged', ev => this.handlePermissionOverwrites(ev));
+        this.tracker.client.on('SpaceDeleted', ev => this.handleSpaceDeleted(ev));
+        this.tracker.client.on('SpaceLeft', ev => this.handleSpaceDeleted(ev));
+        this.tracker.client.on('RoomDeleted', ev => this.handleRoomDeleted(ev));
+        this.tracker.client.on('RoomLeft', ev => this.handleRoomDeleted(ev));
+        this.tracker.client.on('TopicDeleted', ev => this.handleTopicDeleted(ev));
+        this.tracker.client.on('RoleDeleted', ev => this.handleRoleDeleted(ev));
     }
 
     public async getOverwrites(
@@ -37,16 +44,21 @@ export class PermissionsManager extends EventTarget {
     ): Promise<PermissionOverwrites | undefined> {
         const id = getOvId(layer, layerId, target, targetId);
 
-        if (this.overwrites.has(id)) {
-            return this.overwrites.get(id);
+        if (this.overwritesPromises.notExist(id)) {
+            this.overwritesPromises.registerByFunction(async () => {
+                const result = await this.tracker.client.send(
+                    'GetPermissionOverwrites',
+                    {layer, layerId, target, targetId},
+                );
+                if (result.error) {
+                    throw result.error;
+                }
+                this.handlePermissionOverwrites(result.data);
+            }, id);
         }
 
-        const result = await this.tracker.client.send(
-            'GetPermissionOverwrites',
-            {layer, layerId, target, targetId},
-        );
-
-        return result.error ? null : result.data;
+        await this.overwritesPromises.get(id);
+        return this.overwrites.get(id);
     }
 
     public on(eventName: 'change', handler: EventHandler<any>): this {
@@ -113,11 +125,46 @@ export class PermissionsManager extends EventTarget {
         return this.resolveOverwritesHierarchy(await Promise.all(promises));
     }
 
-    private handlePermissionOverwrites(ev: PermissionOverwritesChanged | PermissionOverwrites) {
+    private handlePermissionOverwrites(ev: PermissionOverwritesChanged | PermissionOverwrites): void {
         this.overwrites.set([getOvIdByObject(ev), ev]);
         this.emit('change');
     }
 
+    private handleSpaceDeleted(ev: SpaceDeleted | SpaceLeft): void {
+        const ids = this.deleteOverwritesByIdPrefix(getOvId('Space', ev.id));
+        this.overwritesPromises.forget(...ids);
+    }
+
+    private handleRoomDeleted(ev: RoomDeleted | RoomLeft): void {
+        const ids = this.deleteOverwritesByIdPrefix(getOvId('Room', ev.id));
+        this.overwritesPromises.forget(...ids);
+    }
+
+    private handleTopicDeleted(ev: TopicDeleted): void {
+        const ids = this.deleteOverwritesByIdPrefix(getOvId('Topic', ev.id));
+        this.overwritesPromises.forget(...ids);
+    }
+
+    private handleRoleDeleted(ev: RoleDeleted): void {
+        const ids = this.deleteOverwritesByIdPrefix(getOvId('Space', ev.spaceId, 'Role', ev.id));
+        this.overwritesPromises.forget(...ids);
+    }
+
+    /**
+     * @return Matched and deleted ids
+     */
+    private deleteOverwritesByIdPrefix(prefix: string): string[] {
+        const ids: string[] = [];
+        this.overwrites.items.forEach((overwrites) => {
+            const id = getOvIdByObject(overwrites);
+            if (id.startsWith(prefix)) {
+                ids.push(id);
+                this.overwrites.delete(id);
+            }
+        });
+        return ids;
+    }
+
     private async collectRoleOverwrites(
         spaceId: string,
         layer: PermissionOverwrites['layer'],

package/src/state-tracker/RoomsManager.ts

@@ -1,17 +1,17 @@
 import {IndexedCollection, ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 import {
     NewTopic,
-    Room,
+    Room, RoomDeleted,
     RoomJoined, RoomLeft,
     RoomMember, RoomMemberJoined, RoomMemberLeft, RoomMembers,
-    RoomMemberUpdated, Session,
+    RoomMemberUpdated, Session, SpaceDeleted, SpaceMemberLeft,
     SpaceMemberUpdated,
     Topic,
     TopicDeleted,
     UserChanged,
 } from "pserv-ts-types";
 import {ChatStateTracker} from "./ChatStateTracker";
-import {DeferredTask} from "./DeferredTask";
+import {DeferredTask, PromiseRegistry} from "./AsyncUtils";
 import {MessagesManager} from "./MessagesManager";
 
 export class RoomsManager {
@@ -21,6 +21,7 @@ export class RoomsManager {
     private readonly topics = new IndexedCollection<string, ObservableIndexedObjectCollection<Topic>>();
     private readonly members = new IndexedCollection<string, ObservableIndexedObjectCollection<RoomMember>>();
     private readonly deferredSession = new DeferredTask();
+    private readonly membersPromises = new PromiseRegistry();
 
     public constructor(private tracker: ChatStateTracker) {
         this.messages = new MessagesManager(tracker);
@@ -29,11 +30,14 @@ export class RoomsManager {
         this.tracker.client.on('TopicDeleted', ev => this.handleTopicDeleted(ev));
         this.tracker.client.on('RoomJoined', ev => this.handleRoomJoined(ev));
         this.tracker.client.on('RoomLeft', ev => this.handleRoomLeft(ev));
+        this.tracker.client.on('RoomDeleted', ev => this.handleRoomDeleted(ev));
         this.tracker.client.on('RoomMemberJoined', ev => this.handleRoomMemberJoined(ev));
         this.tracker.client.on('RoomMemberLeft', ev => this.handleRoomMemberLeft(ev));
         this.tracker.client.on('RoomMembers', ev => this.handleRoomMembers(ev));
         this.tracker.client.on('RoomMemberUpdated', ev => this.handleRoomMemberUpdated(ev));
+        this.tracker.client.on('SpaceMemberLeft', ev => this.handleSpaceMemberLeft(ev));
         this.tracker.client.on('SpaceMemberUpdated', ev => this.handleSpaceMemberUpdated(ev));
+        this.tracker.client.on('SpaceDeleted', ev => this.handleSpaceDeleted(ev));
         this.tracker.client.on('UserChanged', ev => this.handleUserChanged(ev));
         this.tracker.client.on('Session', ev => this.handleSession(ev));
     }
@@ -42,16 +46,17 @@ export class RoomsManager {
      * Get collection of room members.
      */
     public async getMembers(roomId: string): Promise<ObservableIndexedObjectCollection<RoomMember> | undefined> {
-        if (! this.members.has(roomId)) {
-            const result = await this.tracker.client.send('GetRoomMembers', {id: roomId});
-
-            if (result.error) {
-                throw result.error;
-            }
-
-            this.handleRoomMembers(result.data);
+        if (this.membersPromises.notExist(roomId)) {
+            this.membersPromises.registerByFunction(async () => {
+                const result = await this.tracker.client.send('GetRoomMembers', {id: roomId});
+                if (result.error) {
+                    throw result.error;
+                }
+                this.handleRoomMembers(result.data);
+            }, roomId);
         }
 
+        await this.membersPromises.get(roomId);
         return this.members.get(roomId);
     }
 
@@ -86,13 +91,10 @@ export class RoomsManager {
         return this.topics.get(roomId);
     }
 
-    /**
-     * For internal use. If you want to leave the room, execute a proper command on client object.
-     * @internal
-     */
-    public _delete(...roomIds: string[]): void {
+    private deleteRoom(...roomIds: string[]): void {
         this.list.delete(...roomIds);
         this.members.delete(...roomIds);
+        this.membersPromises.forget(...roomIds);
 
         for (const roomId of roomIds) {
             const topicIds: string[] = this.topics.get(roomId)?.map(topic => topic.id) ?? [];
@@ -102,12 +104,8 @@ export class RoomsManager {
         this.topics.delete(...roomIds);
     }
 
-    /**
-     * For internal use. If you want to leave the room, execute a proper command on client object.
-     * @internal
-     */
-    public _deleteBySpaceId(spaceId: string): void {
-        this._delete(
+    private deleteRoomsBySpaceId(spaceId: string): void {
+        this.deleteRoom(
             ...this.list.findBy('spaceId', spaceId).map(room => room.id)
         );
     }
@@ -132,6 +130,10 @@ export class RoomsManager {
         }
     }
 
+    private handleSpaceMemberLeft(ev: SpaceMemberLeft): void {
+        this.deleteRoomsBySpaceId(ev.spaceId);
+    }
+
     private handleRoomMemberUpdated(ev: RoomMemberUpdated): void {
         if (! this.members.has(ev.roomId)) {
             // We do not track member list for this room.
@@ -152,6 +154,10 @@ export class RoomsManager {
         members.set(newMember);
     }
 
+    private handleSpaceDeleted(ev: SpaceDeleted): void {
+        this.deleteRoomsBySpaceId(ev.id);
+    }
+
     private handleTopicDeleted(ev: TopicDeleted): void {
         const collection = this.topics.get(ev.roomId);
         collection.delete(ev.id);
@@ -177,6 +183,10 @@ export class RoomsManager {
         this.addJoinedRooms(ev.room);
     }
 
+    private handleRoomDeleted(ev: RoomDeleted): void {
+        this.deleteRoom(ev.id);
+    }
+
     private addJoinedRooms(...rooms: Room[]): void {
         for (const room of rooms) {
             this.addJoinedRoomTopics(room.id, ...room.topics);
@@ -185,7 +195,7 @@ export class RoomsManager {
     }
 
     private handleRoomLeft(ev: RoomLeft): void {
-        this._delete(ev.id);
+        this.deleteRoom(ev.id);
     }
 
     private handleRoomMemberJoined(ev: RoomMemberJoined): void {

package/src/state-tracker/SpacesManager.ts

@@ -10,7 +10,7 @@ import {
     SpaceDeleted, SpaceJoined, SpaceLeft,
     SpaceMember, SpaceMemberJoined, SpaceMemberLeft, SpaceMembers, SpaceMemberUpdated, SpaceRooms, UserChanged
 } from "pserv-ts-types";
-import {DeferredTask} from "./DeferredTask";
+import {DeferredTask, PromiseRegistry} from "./AsyncUtils";
 import {reorderRolesOnPriorityUpdate} from "./functions";
 
 export class SpacesManager {
@@ -19,13 +19,15 @@ export class SpacesManager {
     private readonly rooms = new IndexedCollection<string, ObservableIndexedObjectCollection<RoomSummary>>();
     private readonly members = new IndexedCollection<string, ObservableIndexedObjectCollection<SpaceMember>>();
     private readonly deferredSession = new DeferredTask();
+    private readonly roomsPromises = new PromiseRegistry();
+    private readonly membersPromises = new PromiseRegistry();
 
     public constructor(private tracker: ChatStateTracker) {
         this.tracker.client.on('NewRoom', ev => this.handleNewRoom(ev));
         this.tracker.client.on('RoomDeleted', ev => this.handleRoomDeleted(ev));
         this.tracker.client.on('SpaceDeleted', ev => this.handleSpaceDeleted(ev));
         this.tracker.client.on('SpaceJoined', ev => this.handleSpaceJoined(ev));
-        this.tracker.client.on('SpaceLeft', ev => this.handleSpaceLeft(ev));
+        this.tracker.client.on('SpaceLeft', ev => this.handleSpaceDeleted(ev));
         this.tracker.client.on('SpaceMemberJoined', ev => this.handleSpaceMemberJoined(ev));
         this.tracker.client.on('SpaceMemberLeft', ev => this.handleSpaceMemberLeft(ev));
         this.tracker.client.on('SpaceMembers', ev => this.handleSpaceMembers(ev));
@@ -58,16 +60,17 @@ export class SpacesManager {
      * Get collection of the all available rooms inside given space.
      */
     public async getRooms(spaceId: string): Promise<ObservableIndexedObjectCollection<RoomSummary> | undefined> {
-        if (! this.rooms.has(spaceId)) {
-            const result = await this.tracker.client.send('GetSpaceRooms', {id: spaceId});
-
-            if (result.error) {
-                throw result.error;
-            }
-
-            this.handleSpaceRooms(result.data);
+        if (this.roomsPromises.notExist(spaceId)) {
+            this.roomsPromises.registerByFunction(async () => {
+                const result = await this.tracker.client.send('GetSpaceRooms', {id: spaceId});
+                if (result.error) {
+                    throw result.error;
+                }
+                this.handleSpaceRooms(result.data);
+            }, spaceId);
         }
 
+        await this.roomsPromises.get(spaceId);
         return this.rooms.get(spaceId);
     }
 
@@ -75,16 +78,17 @@ export class SpacesManager {
      * Get collection of space members.
      */
     public async getMembers(spaceId: string): Promise<ObservableIndexedObjectCollection<SpaceMember> | undefined> {
-        if (! this.members.has(spaceId)) {
-            const result = await this.tracker.client.send('GetSpaceMembers', {id: spaceId});
-
-            if (result.error) {
-                throw result.error;
-            }
-
-            this.handleSpaceMembers(result.data);
+        if (this.membersPromises.notExist(spaceId)) {
+            this.membersPromises.registerByFunction(async () => {
+                const result = await this.tracker.client.send('GetSpaceMembers', {id: spaceId});
+                if (result.error) {
+                    throw result.error;
+                }
+                this.handleSpaceMembers(result.data);
+            }, spaceId);
         }
 
+        await this.membersPromises.get(spaceId);
         return this.members.get(spaceId);
     }
 
@@ -117,8 +121,6 @@ export class SpacesManager {
         if (ev.spaceId) {
             this.rooms.get(ev.spaceId).delete(ev.id);
         }
-
-        this.tracker.rooms._delete(ev.id);
     }
 
     private handleRoleDeleted(ev: RoleDeleted): void {
@@ -127,11 +129,12 @@ export class SpacesManager {
         this.list.get(ev.spaceId).roles = collection.items;
     }
 
-    private handleSpaceDeleted(ev: SpaceDeleted): void {
-        this.tracker.rooms._deleteBySpaceId(ev.id);
+    private handleSpaceDeleted(ev: SpaceDeleted | SpaceLeft): void {
         this.roles.delete(ev.id);
         this.members.delete(ev.id);
+        this.membersPromises.forget(ev.id);
         this.rooms.delete(ev.id);
+        this.roomsPromises.forget(ev.id);
         this.list.delete(ev.id);
     }
 
@@ -147,10 +150,6 @@ export class SpacesManager {
         this.list.set(...spaces);
     }
 
-    private handleSpaceLeft(ev: SpaceLeft): void {
-        this.handleSpaceDeleted(ev);
-    }
-
     private handleSpaceMemberJoined(ev: SpaceMemberJoined): void {
         if (this.members.has(ev.spaceId)) {
             this.members.get(ev.spaceId).set(ev.member);

package/tests/async-utils.test.ts

@@ -0,0 +1,30 @@
+import {PromiseRegistry} from "../src/state-tracker/AsyncUtils";
+
+test('promise registry - limit the calling of async process', async () => {
+    const pr = new PromiseRegistry();
+    let generationCount = 0;
+
+    async function generateResult() {
+        return ++generationCount;
+    }
+
+    async function getResult() {
+        const resultKey = 'test';
+
+        if (pr.notExist('test')) {
+            pr.registerByFunction(generateResult, resultKey);
+        }
+
+        await pr.get(resultKey);
+        return generationCount;
+    }
+
+    const call1 = await getResult();
+    expect(call1).toBe(1);
+    const call2 = await getResult();
+    expect(call2).toBe(1);
+    const call3 = await getResult();
+    expect(call3).toBe(1);
+
+    expect(generationCount).toBe(1);
+});

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

@@ -1,5 +0,0 @@
-export declare class DeferredTask {
-    readonly promise: Promise<void>;
-    resolve: () => void;
-    constructor();
-}

package/src/state-tracker/DeferredTask.ts

@@ -1,8 +0,0 @@
-export class DeferredTask {
-    public readonly promise: Promise<void>;
-    public resolve: () => void;
-
-    public constructor() {
-        this.promise = new Promise<void>(resolve => this.resolve = resolve);
-    }
-}