feat: ChannelService.init returns the query result #248

Author: szuperaz

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

@@ -34,8 +34,9 @@ describe('ChannelService', () => {
   let init: (
     c?: Channel[],
     sort?: ChannelSort,
-    options?: ChannelOptions
-  ) => Promise<void>;
+    options?: ChannelOptions,
+    mockChannelQuery?: Function
+  ) => Promise<Channel[]>;
   let user: UserResponse;
   const filters = { type: 'messaging' };
 
@@ -65,16 +66,21 @@ describe('ChannelService', () => {
       ],
     });
     service = TestBed.inject(ChannelService);
-    init = async (
+    init = (
       channels?: Channel[],
       sort?: ChannelSort,
-      options?: ChannelOptions
+      options?: ChannelOptions,
+      mockChannelQuery?: Function
     ) => {
-      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);
     };
   });
 
@@ -122,6 +128,23 @@ 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 reset', async () => {
     await init();
     const messagesSpy = jasmine.createSpy();

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

@@ -392,6 +392,7 @@ export class ChannelService {
    * @param filters
    * @param sort
    * @param options
+   * @returns the list of channels found by the query
    */
   async init(
     filters: ChannelFilters,
@@ -408,10 +409,11 @@ 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();
     this.chatClientService.notification$.subscribe(
       (notification) => void this.handleNotification(notification)
     );
+    return result;
   }
 
   /**
@@ -962,8 +964,10 @@ export class ChannelService {
         this.setAsActiveChannel(channels[0]);
       }
       this.hasMoreChannelsSubject.next(channels.length >= this.options!.limit!);
+      return channels;
     } catch (error) {
       this.channelsSubject.error(error);
+      throw error;
     }
   }