fix: stop push timers on disconnect (#469)

Author: filipecabaco

src/RealtimeChannel.ts

@@ -514,8 +514,6 @@ export default class RealtimeChannel {
       this._trigger(CHANNEL_EVENTS.close, 'leave', this._joinRef())
     }
 
-    this.rejoinTimer.reset()
-    // Destroy joinPush to avoid connection timeouts during unscription phase
     this.joinPush.destroy()
 
     return new Promise((resolve) => {
@@ -539,6 +537,16 @@ export default class RealtimeChannel {
       }
     })
   }
+  /**
+   * Teardown the channel.
+   *
+   * Destroys and stops related timers.
+   */
+  teardown() {
+    this.pushBuffer.forEach((push: Push) => push.destroy())
+    this.rejoinTimer && clearTimeout(this.rejoinTimer.timer)
+    this.joinPush.destroy()
+  }
 
   /** @internal */
 

src/RealtimeClient.ts

@@ -17,6 +17,7 @@ import Timer from './lib/timer'
 import { httpEndpointURL } from './lib/transformers'
 import RealtimeChannel from './RealtimeChannel'
 import type { RealtimeChannelOptions } from './RealtimeChannel'
+import Push from './lib/push'
 
 type Fetch = typeof fetch
 
@@ -252,9 +253,11 @@ export default class RealtimeClient {
         this.conn.close()
       }
       this.conn = null
+
       // remove open handles
       this.heartbeatTimer && clearInterval(this.heartbeatTimer)
       this.reconnectTimer.reset()
+      this.channels.forEach((channel) => channel.teardown())
     }
   }
 
@@ -274,6 +277,7 @@ export default class RealtimeClient {
   ): Promise<RealtimeRemoveChannelResponse> {
     const status = await channel.unsubscribe()
     this.channels = this.channels.filter((c) => c._joinRef !== channel._joinRef)
+
     if (this.channels.length === 0) {
       this.disconnect()
     }
@@ -288,8 +292,8 @@ export default class RealtimeClient {
     const values_1 = await Promise.all(
       this.channels.map((channel) => channel.unsubscribe())
     )
-    this.disconnect()
     this.channels = []
+    this.disconnect()
     return values_1
   }
 

test/channel.test.ts

@@ -414,17 +414,15 @@ describe('joinPush', () => {
   }
 
   beforeEach(() => {
+    socket.disconnect()
+    channel.unsubscribe()
+
     channel = socket.channel('topic')
     joinPush = channel.joinPush
 
     channel.subscribe()
   })
 
-  afterEach(() => {
-    socket.disconnect()
-    channel.unsubscribe()
-  })
-
   describe("receives 'ok'", () => {
     beforeEach(() => {
       response = { chan: 'reply' }
@@ -1094,6 +1092,8 @@ describe('leave', () => {
   let socketSpy
 
   beforeEach(() => {
+    socket.disconnect()
+    channel.unsubscribe()
     socket = new RealtimeClient('ws://example.com/socket', {
       timeout: defaultTimeout,
     })
@@ -1105,11 +1105,6 @@ describe('leave', () => {
     channel.joinPush.trigger('ok', {})
   })
 
-  afterEach(() => {
-    socket.disconnect()
-    channel.unsubscribe()
-  })
-
   test('unsubscribes from server events', () => {
     sinon.stub(socket, '_makeRef').callsFake(() => defaultRef)
 
@@ -1124,6 +1119,9 @@ describe('leave', () => {
         join_ref: defaultRef,
       })
     )
+
+    assert.equal(channel.state, CHANNEL_STATES.closed)
+    assert.deepEqual(channel.pushBuffer, [])
   })
 
   test("closes channel on 'ok' from server", () => {