polfan-server-js-client 0.2.86 → 0.2.87

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

@@ -30,6 +30,7 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
         current: WindowState;
         ongoing?: WindowState;
         limit: number | null;
+        retainRatio: number;
         fetchLimit: number;
         lastFetchCount: number;
         oldestId: string | null;
@@ -43,15 +44,23 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
      */
     set fetchLimit(value: number);
     /**
-     * Maximum numer of items stored in window.
+     * Maximum number of items stored in window (High Watermark).
      * Null for unlimited.
      */
     get limit(): number | null;
     /**
-     * Maximum numer of items stored in window.
+     * Maximum number of items stored in window (High Watermark).
      * Null for unlimited.
      */
     set limit(value: number | null);
+    /**
+     * Percentage of limit to keep when trimming.
+     */
+    get retainRatio(): number;
+    /**
+     * Percentage of limit to keep when trimming.
+     */
+    set retainRatio(value: number);
     get hasLatest(): boolean;
     get hasOldest(): boolean;
     abstract createMirror(): TraversableRemoteCollection<ItemT, EventMapT>;
@@ -65,7 +74,7 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
     protected refreshFetchedState(): Promise<void>;
     protected addItems(newItems: ItemT[], to: 'head' | 'tail'): void;
     /**
-     * Return array with messages of count that matching limit.
+     * Return array with messages trimmed using High/Low Watermark strategy.
      */
     private trimItemsArrayToLimit;
 }

package/package.json

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

package/src/state-tracker/TopicHistoryWindow.ts

@@ -40,14 +40,16 @@ export abstract class TraversableRemoteCollection<
     protected internalState: {
         current: WindowState,
         ongoing?: WindowState,
-        limit: number | null,
+        limit: number | null, // Acts as High Watermark
+        retainRatio: number, // Percentage of limit to keep when trimming
         fetchLimit: number,
         lastFetchCount: number,
         oldestId: string | null,
     } = {
         current: WindowState.LIVE,
         ongoing: undefined,
-        limit: 50,
+        limit: 1000,
+        retainRatio: 1,
         fetchLimit: 50,
         lastFetchCount: 0,
         oldestId: null,
@@ -68,7 +70,7 @@ export abstract class TraversableRemoteCollection<
     }
 
     /**
-     * Maximum numer of items stored in window.
+     * Maximum number of items stored in window (High Watermark).
      * Null for unlimited.
      */
     public get limit(): number | null {
@@ -76,13 +78,27 @@ export abstract class TraversableRemoteCollection<
     }
 
     /**
-     * Maximum numer of items stored in window.
+     * Maximum number of items stored in window (High Watermark).
      * Null for unlimited.
      */
     public set limit(value: number | null) {
         this.internalState.limit = value;
     }
 
+    /**
+     * Percentage of limit to keep when trimming.
+     */
+    public get retainRatio(): number {
+        return this.internalState.retainRatio;
+    }
+
+    /**
+     * Percentage of limit to keep when trimming.
+     */
+    public set retainRatio(value: number) {
+        this.internalState.retainRatio = value;
+    }
+
     public get hasLatest(): boolean {
         return [WindowState.LATEST, WindowState.LIVE].includes(this.state);
     }
@@ -111,7 +127,7 @@ export abstract class TraversableRemoteCollection<
             this.internalState.ongoing = undefined;
         }
 
-        this.deleteAll();
+        this._items.deleteAll(); // Directly call deleteAll to prevent event emit.
         this.addItems(result, 'tail');
         this.internalState.current = WindowState.LATEST;
     }
@@ -205,25 +221,31 @@ export abstract class TraversableRemoteCollection<
             result = this.trimItemsArrayToLimit([...this.items, ...newItems], 'head');
         }
 
-        this.deleteAll();
+        this._items.deleteAll(); // Directly call deleteAll to prevent event emit.
         this.set(...result);
     }
 
     /**
-     * Return array with messages of count that matching limit.
+     * Return array with messages trimmed using High/Low Watermark strategy.
      */
     private trimItemsArrayToLimit(items: ItemT[], from: 'head' | 'tail'): ItemT[] {
-        if (this.limit === null) {
+        const highWatermark = this.limit;
+
+        if (highWatermark === null || items.length <= highWatermark) {
             return items;
         }
 
+        const lowWatermark = Math.floor(highWatermark * this.internalState.retainRatio);
+
         if (from === 'head') {
-            return items.slice(-this.limit);
+            return items.slice(-lowWatermark);
         }
 
         if (from === 'tail') {
-            return items.slice(0, this.limit);
+            return items.slice(0, lowWatermark);
         }
+
+        return items;
     }
 }
 

package/tests/history-window.test.ts

@@ -69,7 +69,8 @@ class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
 test('history window - fresh instance', async () => {
     const window = new TestableHistoryWindow();
     expect(window.items).toHaveLength(0);
-    expect(window.limit).toEqual(50);
+    expect(window.limit).toEqual(1000);
+    expect(window.retainRatio).toEqual(1);
 });
 
 test('history window - states change', async () => {
@@ -251,3 +252,36 @@ test('history window - hasOldest false when in LATEST and length == fetchLimit',
     expect(window.fetchLimit).toEqual(3);
     expect(window.hasOldest).toBeFalsy();
 });
+
+test('history window - high/low watermark limit (retainRatio)', async () => {
+    const window = new TestableHistoryWindow();
+    window.limit = 6; // High Watermark
+    window.retainRatio = 0.5; // Low Watermark target = 6 * 0.5 = 3
+    window.fetchLimit = 3;
+
+    await window.resetToLatest(); // [7, 8, 9]
+
+    expect(window.items).toHaveLength(3);
+
+    await window.fetchPrevious(); // [4, 5, 6] added to 'head' -> [4, 5, 6, 7, 8, 9]
+
+    expect(window.items).toHaveLength(6);
+    [4, 5, 6, 7, 8, 9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchPrevious(); // [1, 2, 3] added to 'head' -> [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+    expect(window.items).toHaveLength(3);
+    [1, 2, 3].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+    expect(window.state).toEqual(WindowState.PAST);
+
+    await window.fetchNext(); // [4, 5, 6] added to 'tail' -> [1, 2, 3, 4, 5, 6]
+
+    expect(window.items).toHaveLength(6);
+    [1, 2, 3, 4, 5, 6].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+
+    await window.fetchNext(); // [7, 8, 9] added to 'tail' -> [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+    expect(window.items).toHaveLength(3);
+    [7, 8, 9].forEach(id => expect(window.items.map(item => item.id)).toContain(id));
+    expect(window.state).toEqual(WindowState.LATEST);
+});