Merge pull request #249 from GetStream/channel-service-quirks-fix

Channel service quirks fix

Author: szuperaz

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

@@ -34,8 +34,10 @@ describe('ChannelService', () => {
   let init: (
     c?: Channel[],
     sort?: ChannelSort,
-    options?: ChannelOptions
-  ) => Promise<void>;
+    options?: ChannelOptions,
+    mockChannelQuery?: Function,
+    shouldSetActiveChannel?: boolean
+  ) => Promise<Channel[]>;
   let user: UserResponse;
   const filters = { type: 'messaging' };
 
@@ -65,16 +67,22 @@ describe('ChannelService', () => {
       ],
     });
     service = TestBed.inject(ChannelService);
-    init = async (
+    init = (
       channels?: Channel[],
       sort?: ChannelSort,
-      options?: ChannelOptions
+      options?: ChannelOptions,
+      mockChannelQuery?: Function,
+      shouldSetActiveChannel?: boolean
     ) => {
-      mockChatClient.queryChannels.and.returnValue(
-        channels || generateMockChannels()
-      );
+      if (mockChannelQuery) {
+        mockChannelQuery();
+      } else {
+        mockChatClient.queryChannels.and.returnValue(
+          channels || generateMockChannels()
+        );
+      }
 
-      await service.init(filters, sort, options);
+      return service.init(filters, sort, options, shouldSetActiveChannel);
     };
   });
 
@@ -122,6 +130,32 @@ describe('ChannelService', () => {
     });
   });
 
+  it('should return the result of the init', async () => {
+    const expectedResult = generateMockChannels();
+    const result = await init(expectedResult);
+
+    expect(result as any as MockChannel[]).toEqual(expectedResult);
+  });
+
+  it('should return the result of the init - error', async () => {
+    const error = 'there was an error';
+
+    await expectAsync(
+      init(undefined, undefined, undefined, () =>
+        mockChatClient.queryChannels.and.rejectWith(error)
+      )
+    ).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();
@@ -148,6 +182,28 @@ describe('ChannelService', () => {
     expect(latestMessagesSpy).toHaveBeenCalledWith({});
   });
 
+  it('should deselect active channel', async () => {
+    await init();
+    const messagesSpy = jasmine.createSpy();
+    service.activeChannelMessages$.subscribe(messagesSpy);
+    const activeChannelSpy = jasmine.createSpy();
+    service.activeChannel$.subscribe(activeChannelSpy);
+    const messageToQuoteSpy = jasmine.createSpy();
+    service.messageToQuote$.subscribe(messageToQuoteSpy);
+    const latestMessagesSpy = jasmine.createSpy();
+    service.latestMessageDateByUserByChannels$.subscribe(latestMessagesSpy);
+    messagesSpy.calls.reset();
+    activeChannelSpy.calls.reset();
+    messageToQuoteSpy.calls.reset();
+    latestMessagesSpy.calls.reset();
+    service.deselectActiveChannel();
+
+    expect(messagesSpy).toHaveBeenCalledWith([]);
+    expect(activeChannelSpy).toHaveBeenCalledWith(undefined);
+    expect(messageToQuoteSpy).toHaveBeenCalledWith(undefined);
+    expect(latestMessagesSpy).toHaveBeenCalledWith({});
+  });
+
   it('should tell if user #hasMoreChannels$', async () => {
     await init();
     const spy = jasmine.createSpy();

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

@@ -325,6 +325,22 @@ export class ChannelService {
     this.messageToQuoteSubject.next(undefined);
   }
 
+  /**
+   * Deselects the currently active (if any) channel
+   */
+  deselectActiveChannel() {
+    const activeChannel = this.activeChannelSubject.getValue();
+    if (!activeChannel) {
+      return;
+    }
+    this.activeChannelMessagesSubject.next([]);
+    this.activeChannelSubject.next(undefined);
+    this.activeParentMessageIdSubject.next(undefined);
+    this.activeThreadMessagesSubject.next([]);
+    this.latestMessageDateByUserByChannelsSubject.next({});
+    this.selectMessageToQuote(undefined);
+  }
+
   /**
    * Sets the given `message` as an active parent message. If `undefined` is provided, it will deleselect the current parent message.
    * @param message
@@ -392,11 +408,14 @@ export class ChannelService {
    * @param filters
    * @param sort
    * @param options
+   * @param shouldSetActiveChannel Decides if the first channel in the result should be made as an 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 || {
@@ -408,31 +427,27 @@ export class ChannelService {
       message_limit: this.messagePageSize,
     };
     this.sort = sort || { last_message_at: -1, updated_at: -1 };
-    await this.queryChannels();
+    const result = await this.queryChannels(shouldSetActiveChannel);
     this.chatClientService.notification$.subscribe(
       (notification) => void this.handleNotification(notification)
     );
+    return result;
   }
 
   /**
    * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./ChatClientService.mdx/#disconnectuser).
    */
   reset() {
-    this.activeChannelMessagesSubject.next([]);
-    this.activeChannelSubject.next(undefined);
-    this.activeParentMessageIdSubject.next(undefined);
-    this.activeThreadMessagesSubject.next([]);
+    this.deselectActiveChannel();
     this.channelsSubject.next(undefined);
-    this.latestMessageDateByUserByChannelsSubject.next({});
-    this.selectMessageToQuote(undefined);
   }
 
   /**
    * Loads the next page of channels. The page size can be set in the [query option](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript#query-options) object.
    */
   async loadMoreChannels() {
     this.options!.offset = this.channels.length!;
-    await this.queryChannels();
+    await this.queryChannels(false);
   }
 
   /**
@@ -948,7 +963,7 @@ export class ChannelService {
     this.activeChannelSubscriptions = [];
   }
 
-  private async queryChannels() {
+  private async queryChannels(shouldSetActiveChannel: boolean) {
     try {
       const channels = await this.chatClientService.chatClient.queryChannels(
         this.filters!,
@@ -958,12 +973,18 @@ 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!);
+      return channels;
     } catch (error) {
       this.channelsSubject.error(error);
+      throw error;
     }
   }