polfan-server-js-client 0.1.992 → 0.1.994

package/src/state-tracker/TopicHistoryWindow.ts

@@ -0,0 +1,257 @@
+import {Message, MessageReference, NewMessage, Room, Session, Topic} from "../types/src";
+import {ChatStateTracker} from "./ChatStateTracker";
+import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+
+export enum WindowState {
+    UNINITIALIZED,
+    LATEST,
+    PAST,
+}
+
+export abstract class TraversableRemoteCollection<T> extends ObservableIndexedObjectCollection<T> {
+    /**
+     * Current mode od collection window. To change mode, call one of available fetch methods.
+     */
+    public get state(): WindowState {
+        return this.currentState;
+    }
+
+    /**
+     * Maximum numer of items stored in window.
+     * Null for unlimited.
+     */
+    public limit: number | null = 50;
+
+    private currentState: WindowState = WindowState.UNINITIALIZED;
+    private fetchingState: WindowState = undefined;
+
+    public async resetToLatest(): Promise<void> {
+        this.throwIfFetchingInProgress();
+
+        if (this.currentState === WindowState.LATEST) {
+            return;
+        }
+
+        this.fetchingState = WindowState.LATEST;
+
+        let result;
+
+        try {
+            result = await this.fetchLatestItems();
+        } finally {
+            this.fetchingState = undefined;
+        }
+
+        this.deleteAll();
+        this.addItems(result, 'tail');
+        this.currentState = WindowState.LATEST;
+    }
+
+    public async fetchPrevious(): Promise<void> {
+        this.throwIfFetchingInProgress();
+
+        this.fetchingState = WindowState.PAST;
+
+        let result;
+
+        try {
+            result = await this.fetchItemsBefore();
+        } finally {
+            this.fetchingState = undefined;
+        }
+
+        if (! result) {
+            return  this.resetToLatest();
+        }
+
+        if (result.length) {
+            this.addItems(result, 'head');
+            this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+        }
+    }
+
+    public async fetchNext(): Promise<void> {
+        this.throwIfFetchingInProgress();
+
+        let result;
+
+        try {
+            result = await this.fetchItemsAfter();
+        } finally {
+            this.fetchingState = undefined;
+        }
+
+        if (! result) {
+            await this.resetToLatest();
+            return;
+        }
+
+        if (result.length) {
+            this.addItems(result, 'tail');
+            await this.refreshMode();
+        }
+    }
+
+    protected abstract fetchLatestItems(): Promise<T[]>;
+
+    protected abstract fetchItemsBefore(): Promise<T[] | null>;
+
+    protected abstract fetchItemsAfter(): Promise<T[] | null>;
+
+    protected abstract isLatestItemLoaded(): Promise<boolean>;
+
+    protected async refreshMode(): Promise<void> {
+        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+    }
+
+    private throwIfFetchingInProgress(): void {
+        if (this.fetchingState) {
+            throw new Error(`Items fetching in progress: ${WindowState[this.fetchingState]}`);
+        }
+    }
+
+    private addItems(newItems: T[], to: 'head' | 'tail'): void {
+        let result;
+
+        if (to === 'head') {
+            result = this.trimItemsArrayToLimit([...newItems, ...this.items], 'tail');
+        }
+
+        if (to === 'tail') {
+            result = this.trimItemsArrayToLimit([...this.items, ...newItems], 'head');
+        }
+
+        this.deleteAll();
+        this.set(...result);
+    }
+
+    /**
+     * Return array with messages of count that matching limit.
+     */
+    private trimItemsArrayToLimit(items: T[], from: 'head' | 'tail'): T[] {
+        if (this.limit === null) {
+            return items;
+        }
+
+        if (from === 'head') {
+            return items.slice(-this.limit);
+        }
+
+        if (from === 'tail') {
+            return items.slice(0, this.limit);
+        }
+    }
+}
+
+export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
+    /**
+     * Reexported available window modes enum.
+     */
+    public readonly WindowState: typeof WindowState = WindowState;
+
+    public constructor(
+        private roomId: string,
+        private topicId: string,
+        private tracker: ChatStateTracker,
+    ) {
+        super('id');
+        this.tracker.client.on('Session', ev => this.handleSession(ev));
+        this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
+    }
+
+    /**
+     * For internal use.
+     * @internal
+     */
+    public _setTopicReference(ref: MessageReference): void {
+        const refMessage = this.get(ref.messageId);
+
+        if (refMessage) {
+            // Update referenced topic ID in message
+            this.set({...refMessage, topicRef: ref.topicId});
+        }
+    }
+
+    private async handleNewMessage(ev: NewMessage): Promise<void> {
+        if (
+            [WindowState.LATEST, WindowState.UNINITIALIZED].includes(this.state)
+            && ev.location.roomId === this.roomId
+            && ev.location.topicId === this.topicId
+        ) {
+            this.set(ev.message);
+
+            if (this.state === WindowState.UNINITIALIZED) {
+                await this.refreshMode();
+            }
+        }
+    }
+
+    private handleSession(ev: Session): void {
+        this.resetToLatest();
+    }
+
+    protected async fetchItemsAfter(): Promise<Message[] | null> {
+        const afterId = this.getAt(this.length - 1)?.id;
+
+        if (! afterId) {
+            // If there is no message to refer, fetch latest
+            return null;
+        }
+
+        const result = await this.tracker.client.send('GetMessages', {
+            location: {roomId: this.roomId, topicId: this.topicId},
+            after: afterId,
+        });
+
+        if (result.error) {
+            throw new Error(`Cannot fetch messages: ${result.error.message}`);
+        }
+
+        return result.data.messages;
+    }
+
+    protected async fetchItemsBefore(): Promise<Message[] | null> {
+        const beforeId = this.getAt(0)?.id;
+
+        if (! beforeId) {
+            // If there is no message to refer, fetch latest
+            return null;
+        }
+
+        const result = await this.tracker.client.send('GetMessages', {
+            location: {roomId: this.roomId, topicId: this.topicId},
+            before: beforeId,
+        });
+
+        if (result.error) {
+            throw new Error(`Cannot fetch messages: ${result.error.message}`);
+        }
+
+        return result.data.messages;
+    }
+
+    protected async fetchLatestItems(): Promise<Message[]> {
+        const result = await this.tracker.client.send('GetMessages', {
+            location: {roomId: this.roomId, topicId: this.topicId},
+        });
+
+        if (result.error) {
+            throw new Error(`Cannot fetch messages: ${result.error.message}`);
+        }
+
+        return result.data.messages;
+    }
+
+    private async getTopic(): Promise<Topic | undefined> {
+        return (await this.tracker.rooms.getTopics(this.roomId, [this.topicId])).get(this.topicId);
+    }
+
+    private async getLatestMessageId(): Promise<string | undefined> {
+        return (await this.getTopic())?.lastMessage?.id;
+    }
+
+    protected async isLatestItemLoaded(): Promise<boolean> {
+        const lastMessageId = await this.getLatestMessageId();
+        return lastMessageId ? this.has(lastMessageId) : false;
+    }
+}

package/src/types/src/index.ts

@@ -1,5 +1,5 @@
 import {Envelope} from "./schemes/Envelope";
-import {Message} from "./schemes/Message";
+import {Message, MessageType} from "./schemes/Message";
 import {PermissionOverwritesValue} from "./schemes/PermissionOverwritesValue";
 import {Role} from "./schemes/Role";
 import {Room} from "./schemes/Room";
@@ -85,11 +85,16 @@ import {TopicUnfollowed} from "./schemes/events/TopicUnfollowed";
 import {TopicFollowed} from "./schemes/events/TopicFollowed";
 import {GetFollowedTopics} from "./schemes/commands/GetFollowedTopics";
 import {FollowedTopicUpdated} from "./schemes/events/FollowedTopicUpdated";
+import {GetMessages} from "./schemes/commands/GetMessages";
+import {Messages} from "./schemes/events/Messages";
+import {Topics} from "./schemes/events/Topics";
+import {GetTopics} from "./schemes/commands/GetTopics";
 
 export {
     // objects
     Envelope,
     Message,
+    MessageType,
     Role,
     Room,
     RoomType,
@@ -107,6 +112,7 @@ export {
     // events
     Bye,
     Error,
+    Messages,
     NewMessage,
     NewRole,
     NewRoom,
@@ -145,6 +151,7 @@ export {
     Ok,
     // commands
     AssignRole,
+    GetMessages,
     CreateMessage,
     Ack,
     CreateRole,
@@ -177,4 +184,6 @@ export {
     CreateOwner,
     DeleteOwner,
     GetOwners,
+    Topics,
+    GetTopics,
 };

package/src/types/src/schemes/FollowedTopic.ts

@@ -4,5 +4,4 @@ export interface FollowedTopic {
     location: ChatLocation;
     lastAckMessageId: string | null;
     missed: number | null;
-    missedMoreThan: number | null;
 }

package/src/types/src/schemes/Message.ts

@@ -1,9 +1,16 @@
 import {User} from "./User";
 
+export enum MessageType {
+    Text = 'Text',
+    Join = 'Join',
+    Leave = 'Leave',
+}
+
 export interface Message {
     id: string;
     createdAt: string;
-    author: User;
-    content: string;
+    type: MessageType;
+    user: User;
+    content?: string;
     topicRef: string | null;
 }

package/src/types/src/schemes/commands/GetMessages.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface GetMessages {
+    location: ChatLocation;
+    before?: string;
+    after?: string;
+}

package/src/types/src/schemes/commands/GetTopics.ts

@@ -0,0 +1,4 @@
+export interface GetTopics {
+    roomId: string;
+    topicIds: string[];
+}

package/src/types/src/schemes/events/Messages.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+import {Message} from "../Message";
+
+export interface Messages {
+    location: ChatLocation;
+    messages: Message[];
+}

package/src/types/src/schemes/events/Topics.ts

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+import {Topic} from "../Topic";
+
+export interface Topics {
+    location: ChatLocation;
+    topics: Topic[];
+}

package/tests/history-window.test.ts

@@ -0,0 +1,129 @@
+import {TraversableRemoteCollection, WindowState} from "../src/state-tracker/TopicHistoryWindow";
+
+interface SimpleMessage {
+    id: number;
+}
+
+const messages: SimpleMessage[] = [
+    {id: 0},
+    {id: 1},
+    {id: 2},
+    {id: 3},
+    {id: 4},
+    {id: 5},
+    {id: 6},
+    {id: 7},
+    {id: 8},
+    {id: 9},
+];
+
+class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
+    public constructor() {
+        super('id');
+    }
+
+    protected async fetchItemsAfter(): Promise<SimpleMessage[]> {
+        const after = this.getAt(this.length - 1)?.id;
+        if (after === undefined) {
+            return null;
+        }
+        // Return only 3 items
+        return messages.slice(after + 1, after + 4);
+    }
+
+    protected async fetchItemsBefore(): Promise<SimpleMessage[]> {
+        const before = this.getAt(0)?.id;
+        if (before === undefined) {
+            return null;
+        }
+        return messages.slice(Math.max(before - 3, 0), before);
+    }
+
+    protected async fetchLatestItems(): Promise<SimpleMessage[]> {
+        return messages.slice(-3);
+    }
+
+    protected async isLatestItemLoaded(): Promise<boolean> {
+        return this.has(messages.length - 1);
+    }
+}
+
+test('history window - fresh instance', async () => {
+    const window = new TestableHistoryWindow();
+    expect(window.items).toHaveLength(0);
+    expect(window.limit).toEqual(50);
+    expect(window.state).toEqual(WindowState.UNINITIALIZED);
+});
+
+test('history window - traverse back', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 5;
+
+    await window.fetchPrevious(); // 7,8,9
+
+    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.items).toHaveLength(3);
+    [7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchPrevious(); // 4,5,6,7,8
+
+    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.items).toHaveLength(5);
+    [4,5,6,7,8].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchPrevious(); // 1,2,3,4,5
+    await window.fetchPrevious(); // 0,1,2,3,4
+    await window.fetchPrevious(); // 0,1,2,3,4
+
+    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.items).toHaveLength(5);
+    [0,1,2,3,4].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+});
+
+test('history window - traverse forward', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 5;
+
+    await window.fetchNext();
+
+    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.items).toHaveLength(3);
+    [7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchPrevious(); // [4,5,6,7,8]
+    await window.fetchPrevious(); // [1,2,3,4,5]
+    await window.fetchNext(); // [4,5,6,7,8]
+
+    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.items).toHaveLength(5);
+    [4,5,6,7,8].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchNext();
+    await window.fetchNext();
+    await window.fetchNext(); // move to latest
+
+    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.items).toHaveLength(5);
+    [5,6,7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+});
+
+test('history window - reset to latest', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 5;
+
+    await window.fetchPrevious();
+
+    expect(window.state).toEqual(WindowState.LATEST);
+
+    await window.fetchPrevious();
+    await window.fetchPrevious();
+    await window.fetchPrevious(); // Move to start
+
+    expect(window.state).toEqual(WindowState.PAST);
+
+    await window.resetToLatest();
+
+    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.items).toHaveLength(3);
+    [7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+});

package/build/types/types/dist/index.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/ChatLocation.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Envelope.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/FollowedTopic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Message.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/PermissionOverwritesValue.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Role.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Room.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/RoomMember.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/RoomSummary.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Space.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/SpaceMember.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/Topic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/User.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/UserState.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/Ack.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/AssignRole.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateMessage.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateOwner.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateRole.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateRoom.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateSpace.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/CreateTopic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeassignRole.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeleteOwner.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeleteRole.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeleteRoom.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeleteSpace.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/DeleteTopic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/FollowTopic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetComputedPermissions.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetFollowedTopics.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetOwners.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetPermissionOverwriteTargets.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetPermissionOverwrites.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetRoomMembers.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetSession.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetSpaceMembers.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/GetSpaceRooms.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/JoinRoom.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/JoinSpace.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/LeaveRoom.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/LeaveSpace.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/SetPermissionOverwrites.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/UnfollowTopic.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/UpdateRole.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/UpdateRoom.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/commands/UpdateSpace.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/events/Bye.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/events/ComputedPermissions.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/events/Error.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;

package/build/types/types/dist/schemes/events/FollowedTopicUpdated.d.ts

@@ -1 +0,0 @@
-export const __esModule: boolean;