polfan-server-js-client 0.1.994 → 0.1.995

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

@@ -2,9 +2,23 @@ import { Message, MessageReference } from "../types/src";
 import { ChatStateTracker } from "./ChatStateTracker";
 import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
 export declare enum WindowState {
-    UNINITIALIZED = 0,
-    LATEST = 1,
-    PAST = 2
+    /**
+     * No messages exist in the history window.
+     */
+    EMPTY = 0,
+    /**
+     * The latest messages (those received live) are available in the history window, history has not been fetched.
+     */
+    LATEST_LIVE = 1,
+    /**
+     * The latest messages has been fetched and are available in the history window.
+     */
+    LATEST_FETCHED = 2,
+    /**
+     * The historical messages have been fetched and are available in the history window.
+     * Latest messages are not available and will not be available.
+     */
+    PAST_FETCHED = 3
 }
 export declare abstract class TraversableRemoteCollection<T> extends ObservableIndexedObjectCollection<T> {
     /**
@@ -25,7 +39,8 @@ export declare abstract class TraversableRemoteCollection<T> extends ObservableI
     protected abstract fetchItemsBefore(): Promise<T[] | null>;
     protected abstract fetchItemsAfter(): Promise<T[] | null>;
     protected abstract isLatestItemLoaded(): Promise<boolean>;
-    protected refreshMode(): Promise<void>;
+    protected refreshFetchedState(): Promise<void>;
+    protected refreshLiveState(): void;
     private throwIfFetchingInProgress;
     private addItems;
     /**

package/package.json

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

package/src/state-tracker/TopicHistoryWindow.ts

@@ -1,11 +1,28 @@
-import {Message, MessageReference, NewMessage, Room, Session, Topic} from "../types/src";
+import {Message, MessageReference, NewMessage, Session, Topic} from "../types/src";
 import {ChatStateTracker} from "./ChatStateTracker";
 import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 
 export enum WindowState {
-    UNINITIALIZED,
-    LATEST,
-    PAST,
+    /**
+     * No messages exist in the history window.
+     */
+    EMPTY,
+
+    /**
+     * The latest messages (those received live) are available in the history window, history has not been fetched.
+     */
+    LATEST_LIVE,
+
+    /**
+     * The latest messages has been fetched and are available in the history window.
+     */
+    LATEST_FETCHED,
+
+    /**
+     * The historical messages have been fetched and are available in the history window.
+     * Latest messages are not available and will not be available.
+     */
+    PAST_FETCHED,
 }
 
 export abstract class TraversableRemoteCollection<T> extends ObservableIndexedObjectCollection<T> {
@@ -22,17 +39,17 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
      */
     public limit: number | null = 50;
 
-    private currentState: WindowState = WindowState.UNINITIALIZED;
+    private currentState: WindowState = WindowState.EMPTY;
     private fetchingState: WindowState = undefined;
 
     public async resetToLatest(): Promise<void> {
         this.throwIfFetchingInProgress();
 
-        if (this.currentState === WindowState.LATEST) {
+        if (this.currentState === WindowState.LATEST_FETCHED) {
             return;
         }
 
-        this.fetchingState = WindowState.LATEST;
+        this.fetchingState = WindowState.LATEST_FETCHED;
 
         let result;
 
@@ -44,13 +61,13 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         this.deleteAll();
         this.addItems(result, 'tail');
-        this.currentState = WindowState.LATEST;
+        this.currentState = WindowState.LATEST_FETCHED;
     }
 
     public async fetchPrevious(): Promise<void> {
         this.throwIfFetchingInProgress();
 
-        this.fetchingState = WindowState.PAST;
+        this.fetchingState = WindowState.PAST_FETCHED;
 
         let result;
 
@@ -66,7 +83,7 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         if (result.length) {
             this.addItems(result, 'head');
-            this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+            await this.refreshFetchedState();
         }
     }
 
@@ -88,7 +105,7 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         if (result.length) {
             this.addItems(result, 'tail');
-            await this.refreshMode();
+            await this.refreshFetchedState();
         }
     }
 
@@ -100,8 +117,14 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
     protected abstract isLatestItemLoaded(): Promise<boolean>;
 
-    protected async refreshMode(): Promise<void> {
-        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+    protected async refreshFetchedState(): Promise<void> {
+        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST_FETCHED : WindowState.PAST_FETCHED;
+    }
+
+    protected refreshLiveState(): void {
+        if (this.currentState === WindowState.EMPTY && this.length) {
+            this.currentState = WindowState.LATEST_LIVE;
+        }
     }
 
     private throwIfFetchingInProgress(): void {
@@ -174,15 +197,12 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
 
     private async handleNewMessage(ev: NewMessage): Promise<void> {
         if (
-            [WindowState.LATEST, WindowState.UNINITIALIZED].includes(this.state)
+            [WindowState.LATEST_FETCHED, WindowState.LATEST_LIVE, WindowState.EMPTY].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();
-            }
+            this.refreshLiveState();
         }
     }
 
@@ -252,6 +272,6 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
 
     protected async isLatestItemLoaded(): Promise<boolean> {
         const lastMessageId = await this.getLatestMessageId();
-        return lastMessageId ? this.has(lastMessageId) : false;
+        return lastMessageId ? this.has(lastMessageId) : true;
     }
 }

package/tests/history-window.test.ts

@@ -22,6 +22,11 @@ class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
         super('id');
     }
 
+    public simulateNewMessageReceived(): void {
+        this.set(messages[messages.length - 1]);
+        this.refreshLiveState();
+    }
+
     protected async fetchItemsAfter(): Promise<SimpleMessage[]> {
         const after = this.getAt(this.length - 1)?.id;
         if (after === undefined) {
@@ -52,7 +57,26 @@ 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 - states change', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 5;
+
+    expect(window.state).toEqual(WindowState.EMPTY);
+
+    window.simulateNewMessageReceived(); // [9]
+
+    expect(window.state).toEqual(WindowState.LATEST_LIVE);
+
+    await window.fetchPrevious(); // [6,7,8,9]
+    await window.fetchPrevious(); // [3,4,5,6,7]
+
+    expect(window.state).toEqual(WindowState.PAST_FETCHED);
+
+    await window.resetToLatest(); // [5,6,7,8,9]
+
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
 });
 
 test('history window - traverse back', async () => {
@@ -61,13 +85,13 @@ test('history window - traverse back', async () => {
 
     await window.fetchPrevious(); // 7,8,9
 
-    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
     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.state).toEqual(WindowState.PAST_FETCHED);
     expect(window.items).toHaveLength(5);
     [4,5,6,7,8].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 
@@ -75,7 +99,7 @@ test('history window - traverse back', async () => {
     await window.fetchPrevious(); // 0,1,2,3,4
     await window.fetchPrevious(); // 0,1,2,3,4
 
-    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.state).toEqual(WindowState.PAST_FETCHED);
     expect(window.items).toHaveLength(5);
     [0,1,2,3,4].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 });
@@ -86,7 +110,7 @@ test('history window - traverse forward', async () => {
 
     await window.fetchNext();
 
-    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
     expect(window.items).toHaveLength(3);
     [7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 
@@ -94,7 +118,7 @@ test('history window - traverse forward', async () => {
     await window.fetchPrevious(); // [1,2,3,4,5]
     await window.fetchNext(); // [4,5,6,7,8]
 
-    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.state).toEqual(WindowState.PAST_FETCHED);
     expect(window.items).toHaveLength(5);
     [4,5,6,7,8].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 
@@ -102,7 +126,7 @@ test('history window - traverse forward', async () => {
     await window.fetchNext();
     await window.fetchNext(); // move to latest
 
-    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
     expect(window.items).toHaveLength(5);
     [5,6,7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 });
@@ -113,17 +137,17 @@ test('history window - reset to latest', async () => {
 
     await window.fetchPrevious();
 
-    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
 
     await window.fetchPrevious();
     await window.fetchPrevious();
     await window.fetchPrevious(); // Move to start
 
-    expect(window.state).toEqual(WindowState.PAST);
+    expect(window.state).toEqual(WindowState.PAST_FETCHED);
 
     await window.resetToLatest();
 
-    expect(window.state).toEqual(WindowState.LATEST);
+    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
     expect(window.items).toHaveLength(3);
     [7,8,9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 });