polfan-server-js-client 0.1.995 → 0.1.996

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

@@ -2,23 +2,24 @@ import { Message, MessageReference } from "../types/src";
 import { ChatStateTracker } from "./ChatStateTracker";
 import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
 export declare enum WindowState {
-    /**
-     * 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,
+    LIVE = 0,
     /**
      * The latest messages has been fetched and are available in the history window.
      */
-    LATEST_FETCHED = 2,
+    LATEST = 1,
     /**
      * 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
+    PAST = 2,
+    /**
+     * The oldest messages have been fetched and are available in the history window.
+     * Next attempts to fetch previous messages will result with no-op.
+     */
+    OLDEST = 3
 }
 export declare abstract class TraversableRemoteCollection<T> extends ObservableIndexedObjectCollection<T> {
     /**
@@ -40,9 +41,8 @@ export declare abstract class TraversableRemoteCollection<T> extends ObservableI
     protected abstract fetchItemsAfter(): Promise<T[] | null>;
     protected abstract isLatestItemLoaded(): Promise<boolean>;
     protected refreshFetchedState(): Promise<void>;
-    protected refreshLiveState(): void;
+    protected addItems(newItems: T[], to: 'head' | 'tail'): void;
     private throwIfFetchingInProgress;
-    private addItems;
     /**
      * Return array with messages of count that matching limit.
      */

package/package.json

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

package/src/state-tracker/TopicHistoryWindow.ts

@@ -3,26 +3,27 @@ import {ChatStateTracker} from "./ChatStateTracker";
 import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 
 export enum WindowState {
-    /**
-     * 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,
+    LIVE,
 
     /**
      * The latest messages has been fetched and are available in the history window.
      */
-    LATEST_FETCHED,
+    LATEST,
 
     /**
      * 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,
+    PAST,
+
+    /**
+     * The oldest messages have been fetched and are available in the history window.
+     * Next attempts to fetch previous messages will result with no-op.
+     */
+    OLDEST,
 }
 
 export abstract class TraversableRemoteCollection<T> extends ObservableIndexedObjectCollection<T> {
@@ -39,17 +40,17 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
      */
     public limit: number | null = 50;
 
-    private currentState: WindowState = WindowState.EMPTY;
+    private currentState: WindowState = WindowState.LIVE;
     private fetchingState: WindowState = undefined;
 
     public async resetToLatest(): Promise<void> {
         this.throwIfFetchingInProgress();
 
-        if (this.currentState === WindowState.LATEST_FETCHED) {
+        if (this.currentState === WindowState.LATEST) {
             return;
         }
 
-        this.fetchingState = WindowState.LATEST_FETCHED;
+        this.fetchingState = WindowState.LATEST;
 
         let result;
 
@@ -61,13 +62,17 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         this.deleteAll();
         this.addItems(result, 'tail');
-        this.currentState = WindowState.LATEST_FETCHED;
+        this.currentState = WindowState.LATEST;
     }
 
     public async fetchPrevious(): Promise<void> {
+        if (this.state === WindowState.OLDEST) {
+            return;
+        }
+
         this.throwIfFetchingInProgress();
 
-        this.fetchingState = WindowState.PAST_FETCHED;
+        this.fetchingState = WindowState.PAST;
 
         let result;
 
@@ -78,18 +83,23 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
         }
 
         if (! result) {
-            return  this.resetToLatest();
+            return this.resetToLatest();
         }
 
-        if (result.length) {
-            this.addItems(result, 'head');
-            await this.refreshFetchedState();
+        if (! result.length) {
+            this.currentState = WindowState.OLDEST;
+            return;
         }
+
+        this.addItems(result, 'head');
+        await this.refreshFetchedState();
     }
 
     public async fetchNext(): Promise<void> {
         this.throwIfFetchingInProgress();
 
+        this.fetchingState = WindowState.PAST;
+
         let result;
 
         try {
@@ -118,22 +128,10 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
     protected abstract isLatestItemLoaded(): Promise<boolean>;
 
     protected async refreshFetchedState(): Promise<void> {
-        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST_FETCHED : WindowState.PAST_FETCHED;
+        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
     }
 
-    protected refreshLiveState(): void {
-        if (this.currentState === WindowState.EMPTY && this.length) {
-            this.currentState = WindowState.LATEST_LIVE;
-        }
-    }
-
-    private throwIfFetchingInProgress(): void {
-        if (this.fetchingState) {
-            throw new Error(`Items fetching in progress: ${WindowState[this.fetchingState]}`);
-        }
-    }
-
-    private addItems(newItems: T[], to: 'head' | 'tail'): void {
+    protected addItems(newItems: T[], to: 'head' | 'tail'): void {
         let result;
 
         if (to === 'head') {
@@ -148,6 +146,12 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
         this.set(...result);
     }
 
+    private throwIfFetchingInProgress(): void {
+        if (this.fetchingState) {
+            throw new Error(`Items fetching in progress: ${WindowState[this.fetchingState]}`);
+        }
+    }
+
     /**
      * Return array with messages of count that matching limit.
      */
@@ -197,12 +201,11 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
 
     private async handleNewMessage(ev: NewMessage): Promise<void> {
         if (
-            [WindowState.LATEST_FETCHED, WindowState.LATEST_LIVE, WindowState.EMPTY].includes(this.state)
+            [WindowState.LATEST, WindowState.LIVE].includes(this.state)
             && ev.location.roomId === this.roomId
             && ev.location.topicId === this.topicId
         ) {
-            this.set(ev.message);
-            this.refreshLiveState();
+            this.addItems([ev.message], 'tail');
         }
     }
 

package/tests/history-window.test.ts

@@ -23,8 +23,17 @@ class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
     }
 
     public simulateNewMessageReceived(): void {
-        this.set(messages[messages.length - 1]);
-        this.refreshLiveState();
+        if ([WindowState.LATEST, WindowState.LIVE].includes(this.state)) {
+            const lastId = this.getAt(this.length - 1)?.id;
+
+            const messageToAdd = lastId
+                ? this.getAt(lastId + 1)
+                : messages[messages.length - 1];
+
+            if (messageToAdd) {
+                this.addItems([messageToAdd], 'tail');
+            }
+        }
     }
 
     protected async fetchItemsAfter(): Promise<SimpleMessage[]> {
@@ -63,20 +72,25 @@ test('history window - states change', async () => {
     const window = new TestableHistoryWindow();
     window.limit = 5;
 
-    expect(window.state).toEqual(WindowState.EMPTY);
+    expect(window.state).toEqual(WindowState.LIVE);
 
     window.simulateNewMessageReceived(); // [9]
 
-    expect(window.state).toEqual(WindowState.LATEST_LIVE);
+    expect(window.state).toEqual(WindowState.LIVE);
 
     await window.fetchPrevious(); // [6,7,8,9]
     await window.fetchPrevious(); // [3,4,5,6,7]
 
-    expect(window.state).toEqual(WindowState.PAST_FETCHED);
+    expect(window.state).toEqual(WindowState.PAST);
+
+    await window.fetchPrevious(); // [0,1,2,3,4]
+    await window.fetchPrevious(); // [0,1,2,3,4]
 
-    await window.resetToLatest(); // [5,6,7,8,9]
+    expect(window.state).toEqual(WindowState.OLDEST);
 
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
+    await window.resetToLatest(); // [7,8,9]
+
+    expect(window.state).toEqual(WindowState.LATEST);
 });
 
 test('history window - traverse back', async () => {
@@ -85,13 +99,13 @@ test('history window - traverse back', async () => {
 
     await window.fetchPrevious(); // 7,8,9
 
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
+    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_FETCHED);
+    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));
 
@@ -99,7 +113,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_FETCHED);
+    expect(window.state).toEqual(WindowState.OLDEST);
     expect(window.items).toHaveLength(5);
     [0,1,2,3,4].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
 });
@@ -108,9 +122,9 @@ test('history window - traverse forward', async () => {
     const window = new TestableHistoryWindow();
     window.limit = 5;
 
-    await window.fetchNext();
+    await window.fetchNext(); // [7,8,9]
 
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
+    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));
 
@@ -118,7 +132,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_FETCHED);
+    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));
 
@@ -126,7 +140,7 @@ test('history window - traverse forward', async () => {
     await window.fetchNext();
     await window.fetchNext(); // move to latest
 
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
+    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));
 });
@@ -135,19 +149,43 @@ test('history window - reset to latest', async () => {
     const window = new TestableHistoryWindow();
     window.limit = 5;
 
-    await window.fetchPrevious();
-
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
-
-    await window.fetchPrevious();
-    await window.fetchPrevious();
-    await window.fetchPrevious(); // Move to start
+    await window.fetchPrevious(); // [7,8,9]
+    await window.fetchPrevious(); // [4,5,6,7,8]
+    await window.fetchPrevious(); // [1,2,3,4,5]
 
-    expect(window.state).toEqual(WindowState.PAST_FETCHED);
+    expect(window.state).toEqual(WindowState.PAST);
 
     await window.resetToLatest();
 
-    expect(window.state).toEqual(WindowState.LATEST_FETCHED);
+    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));
 });
+
+test('history window - trim messages window to limit', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 5;
+
+    expect(window.items).toHaveLength(0);
+
+    await window.fetchPrevious(); // [7,8,9]
+
+    expect(window.items).toHaveLength(3);
+
+    await window.fetchPrevious(); // [4,5,6,7,8]
+
+    expect(window.items).toHaveLength(5);
+
+    await window.fetchNext(); // [5,6,7,8,9]
+
+    expect(window.items).toHaveLength(5);
+
+    await window.fetchPrevious(); // [2,3,4,5,6]
+
+    expect(window.items).toHaveLength(5);
+
+    window.simulateNewMessageReceived();
+    window.simulateNewMessageReceived();
+
+    expect(window.items).toHaveLength(5);
+});