fix: Missing unsubscribe in reset, connect returns result

Author: szuperaz

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

@@ -35,12 +35,21 @@ describe('ChatClientService', () => {
 
   it('should disconnect user', async () => {
     const pendingInvitesSpy = jasmine.createSpy();
+    const eventsSpy = jasmine.createSpy();
+    service.events$.subscribe(eventsSpy);
     service.pendingInvites$.subscribe(pendingInvitesSpy);
     pendingInvitesSpy.calls.reset();
+    eventsSpy.calls.reset();
     await service.disconnectUser();
+    const event = {
+      id: 'mockevent',
+      type: 'notification.added_to_channel',
+    } as any as Event;
+    mockChatClient.handleEvent(event.type, event);
 
     expect(mockChatClient.disconnectUser).toHaveBeenCalledWith();
     expect(pendingInvitesSpy).toHaveBeenCalledWith([]);
+    expect(eventsSpy).not.toHaveBeenCalled();
   });
 
   it('should init with user meta data', async () => {

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

@@ -4,6 +4,7 @@ import {
   Channel,
   ChannelFilters,
   ChannelResponse,
+  ConnectAPIResponse,
   OwnUserResponse,
   UserFilters,
   UserResponse,
@@ -60,6 +61,7 @@ export class ChatClientService<
   private pendingInvitesSubject = new BehaviorSubject<
     (ChannelResponse<T> | Channel<T>)[]
   >([]);
+  private subscriptions: { unsubscribe: () => void }[] = [];
 
   constructor(
     private ngZone: NgZone,
@@ -81,12 +83,13 @@ export class ChatClientService<
     apiKey: string,
     userOrId: string | OwnUserResponse<T> | UserResponse<T>,
     userTokenOrProvider: TokenOrProvider
-  ) {
+  ): ConnectAPIResponse<T> {
     this.chatClient = StreamChat.getInstance<T>(apiKey);
     this.chatClient.devToken;
+    let result;
     await this.ngZone.runOutsideAngular(async () => {
       const user = typeof userOrId === 'string' ? { id: userOrId } : userOrId;
-      await this.chatClient.connectUser(user, userTokenOrProvider);
+      result = await this.chatClient.connectUser(user, userTokenOrProvider);
       this.chatClient.setUserAgent(
         `stream-chat-angular-${version}-${this.chatClient.getUserAgent()}`
       );
@@ -98,30 +101,35 @@ export class ChatClientService<
     );
     this.pendingInvitesSubject.next(channels);
     this.appSettingsSubject.next(undefined);
-    this.chatClient.on((e) => {
-      this.updatePendingInvites(e);
-      this.notificationSubject.next({
-        eventType: e.type,
-        event: e,
-      });
-    });
+    this.subscriptions.push(
+      this.chatClient.on((e) => {
+        this.updatePendingInvites(e);
+        this.notificationSubject.next({
+          eventType: e.type,
+          event: e,
+        });
+      })
+    );
     let removeNotification: undefined | Function;
-    this.chatClient.on('connection.changed', (e) => {
-      this.ngZone.run(() => {
-        const isOnline = e.online;
-        if (isOnline) {
-          if (removeNotification) {
-            removeNotification();
+    this.subscriptions.push(
+      this.chatClient.on('connection.changed', (e) => {
+        this.ngZone.run(() => {
+          const isOnline = e.online;
+          if (isOnline) {
+            if (removeNotification) {
+              removeNotification();
+            }
+          } else {
+            removeNotification =
+              this.notificationService.addPermanentNotification(
+                'streamChat.Connection failure, reconnecting now...'
+              );
           }
-        } else {
-          removeNotification =
-            this.notificationService.addPermanentNotification(
-              'streamChat.Connection failure, reconnecting now...'
-            );
-        }
-        this.connectionStateSubject.next(isOnline ? 'online' : 'offline');
-      });
-    });
+          this.connectionStateSubject.next(isOnline ? 'online' : 'offline');
+        });
+      })
+    );
+    return result;
   }
 
   /**
@@ -130,6 +138,7 @@ export class ChatClientService<
   async disconnectUser() {
     this.pendingInvitesSubject.next([]);
     await this.chatClient.disconnectUser();
+    this.subscriptions.forEach((s) => s.unsubscribe());
   }
 
   /**

projects/stream-chat-angular/src/lib/mocks/index.ts

@@ -275,7 +275,7 @@ export type MockStreamChatClient = {
   appSettings$: Subject<AppSettings>;
   user: UserResponse;
   connectUser: jasmine.Spy;
-  on: (name: EventTypes, handler: () => {}) => void;
+  on: (name: EventTypes, handler: () => {}) => { unsubscribe: () => void };
   handleEvent: (name: EventTypes, event: Event) => void;
   flagMessage: jasmine.Spy;
   setUserAgent: jasmine.Spy;
@@ -319,11 +319,15 @@ export const mockStreamChatClient = (): MockStreamChatClient => {
     } else {
       eventHandlers['all'] = name;
     }
+    return {
+      unsubscribe: () =>
+        delete eventHandlers[typeof name === 'string' ? name : 'all'],
+    };
   };
   const handleEvent = (name: EventTypes, event: Event) => {
     if (eventHandlers[name as string]) {
       eventHandlers[name as string](event);
-    } else {
+    } else if (eventHandlers['all']) {
       eventHandlers['all']({ ...event, type: name });
     }
   };