feat: Add option to not set active channel after ChannelService init #248

Author: szuperaz

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

@@ -35,7 +35,8 @@ describe('ChannelService', () => {
     c?: Channel[],
     sort?: ChannelSort,
     options?: ChannelOptions,
-    mockChannelQuery?: Function
+    mockChannelQuery?: Function,
+    shouldSetActiveChannel?: boolean
   ) => Promise<Channel[]>;
   let user: UserResponse;
   const filters = { type: 'messaging' };
@@ -70,7 +71,8 @@ describe('ChannelService', () => {
       channels?: Channel[],
       sort?: ChannelSort,
       options?: ChannelOptions,
-      mockChannelQuery?: Function
+      mockChannelQuery?: Function,
+      shouldSetActiveChannel?: boolean
     ) => {
       if (mockChannelQuery) {
         mockChannelQuery();
@@ -80,7 +82,7 @@ describe('ChannelService', () => {
         );
       }
 
-      return service.init(filters, sort, options);
+      return service.init(filters, sort, options, shouldSetActiveChannel);
     };
   });
 
@@ -145,6 +147,15 @@ describe('ChannelService', () => {
     ).toBeRejectedWith(error);
   });
 
+  it('should not set active channel if #shouldSetActiveChannel is false', async () => {
+    const activeChannelSpy = jasmine.createSpy();
+    service.activeChannel$.subscribe(activeChannelSpy);
+    activeChannelSpy.calls.reset();
+    await init(undefined, undefined, undefined, undefined, false);
+
+    expect(activeChannelSpy).not.toHaveBeenCalled();
+  });
+
   it('should reset', async () => {
     await init();
     const messagesSpy = jasmine.createSpy();

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

@@ -392,12 +392,14 @@ export class ChannelService {
    * @param filters
    * @param sort
    * @param options
+   * @param shouldSetActiveChannel Decides if the firs channel in the result should be made as active channel, or no channel should be marked as active
    * @returns the list of channels found by the query
    */
   async init(
     filters: ChannelFilters,
     sort?: ChannelSort,
-    options?: ChannelOptions
+    options?: ChannelOptions,
+    shouldSetActiveChannel: boolean = true
   ) {
     this.filters = filters;
     this.options = options || {
@@ -409,7 +411,7 @@ export class ChannelService {
       message_limit: this.messagePageSize,
     };
     this.sort = sort || { last_message_at: -1, updated_at: -1 };
-    const result = await this.queryChannels();
+    const result = await this.queryChannels(shouldSetActiveChannel);
     this.chatClientService.notification$.subscribe(
       (notification) => void this.handleNotification(notification)
     );
@@ -434,7 +436,7 @@ export class ChannelService {
    */
   async loadMoreChannels() {
     this.options!.offset = this.channels.length!;
-    await this.queryChannels();
+    await this.queryChannels(false);
   }
 
   /**
@@ -950,7 +952,7 @@ export class ChannelService {
     this.activeChannelSubscriptions = [];
   }
 
-  private async queryChannels() {
+  private async queryChannels(shouldSetActiveChannel: boolean) {
     try {
       const channels = await this.chatClientService.chatClient.queryChannels(
         this.filters!,
@@ -960,7 +962,11 @@ export class ChannelService {
       channels.forEach((c) => this.watchForChannelEvents(c));
       const prevChannels = this.channelsSubject.getValue() || [];
       this.channelsSubject.next([...prevChannels, ...channels]);
-      if (channels.length > 0 && !this.activeChannelSubject.getValue()) {
+      if (
+        channels.length > 0 &&
+        !this.activeChannelSubject.getValue() &&
+        shouldSetActiveChannel
+      ) {
         this.setAsActiveChannel(channels[0]);
       }
       this.hasMoreChannelsSubject.next(channels.length >= this.options!.limit!);