feat: Make it possible to pause read events #267

Author: szuperaz

projects/stream-chat-angular/src/lib/channel.service.spec.ts

@@ -352,6 +352,23 @@ describe('ChannelService', () => {
     expect(activeChannel.markRead).toHaveBeenCalledWith();
   });
 
+  it('should pause read events', async () => {
+    await init();
+    service.shouldMarkActiveChannelAsRead = false;
+    let activeChannel!: Channel<DefaultStreamChatGenerics>;
+    service.activeChannel$.subscribe((c) => (activeChannel = c!));
+    const newMessage = mockMessage();
+    activeChannel.state.messages.push(newMessage);
+    spyOn(activeChannel, 'markRead');
+    (activeChannel as MockChannel).handleEvent('message.new', newMessage);
+
+    expect(activeChannel.markRead).not.toHaveBeenCalledWith();
+
+    service.setAsActiveChannel(activeChannel);
+
+    expect(activeChannel.markRead).not.toHaveBeenCalledWith();
+  });
+
   it(`shouldn't make "markRead" call, if user dosen't have 'read-events' capability`, async () => {
     await init();
     let activeChannel!: Channel<DefaultStreamChatGenerics>;

projects/stream-chat-angular/src/lib/channel.service.ts

@@ -224,6 +224,10 @@ export class ChannelService<
     url: string,
     channel: Channel<T>
   ) => Promise<void>;
+  /**
+   * If set to false, read events won't be sent as new messages are received
+   */
+  shouldMarkActiveChannelAsRead = true;
   private channelsSubject = new BehaviorSubject<Channel<T>[] | undefined>(
     undefined
   );
@@ -357,7 +361,7 @@ export class ChannelService<
     channel.state.messages.forEach((m) => {
       m.readBy = getReadBy(m, channel);
     });
-    if (this.canSendReadEvents) {
+    if (this.canSendReadEvents && this.shouldMarkActiveChannelAsRead) {
       void channel.markRead();
     }
     this.activeChannelMessagesSubject.next([...channel.state.messages]);
@@ -873,7 +877,7 @@ export class ChannelService<
                 ...channel.state.messages,
               ]);
           this.activeChannel$.pipe(first()).subscribe((c) => {
-            if (this.canSendReadEvents) {
+            if (this.canSendReadEvents && this.shouldMarkActiveChannelAsRead) {
               void c?.markRead();
             }
           });