Change cursors batch time formula on presence update (#333)

ably · Sep 18, 2024 · 12467dd · 12467dd
1 parent 50d8899
commit 12467dd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/Cursors.test.ts b/src/Cursors.test.ts
@@ -116,7 +116,7 @@ describe('Cursors', () => {
       vi.spyOn(channel.presence, 'get').mockImplementation(createPresenceCount(2));
       await cursors['onPresenceUpdate']();
       expect(batching.shouldSend).toBeTruthy();
-      expect(batching.batchTime).toEqual(50);
+      expect(batching.batchTime).toEqual(25);
     });
 
     it<CursorsTestContext>('batchTime is updated when multiple people are present', async ({
@@ -126,7 +126,7 @@ describe('Cursors', () => {
     }) => {
       vi.spyOn(channel.presence, 'get').mockImplementation(createPresenceCount(2));
       await cursors['onPresenceUpdate']();
-      expect(batching.batchTime).toEqual(50);
+      expect(batching.batchTime).toEqual(25);
     });
 
     describe('pushCursorPosition', () => {

diff --git a/src/Cursors.ts b/src/Cursors.ts
@@ -105,7 +105,11 @@ export default class Cursors extends EventEmitter<CursorsEventMap> {
     const channel = this.getChannel();
     const cursorsMembers = await channel.presence.get();
     this.cursorBatching.setShouldSend(cursorsMembers.length > 1);
-    this.cursorBatching.setBatchTime(cursorsMembers.length * this.options.outboundBatchInterval);
+    /**
+     * Since server-side batching is automically enabled for cursors channels, we can now adjust the client-side batching interval more granularly.
+     * E.g. multiply the configured outboundBatchInterval by groups of 100 members instead of the total number of members.
+     */
+    this.cursorBatching.setBatchTime(Math.ceil(cursorsMembers.length / 100) * this.options.outboundBatchInterval);
   }
 
   private isUnsubscribed() {