Merge pull request #10 from superlistapp/fix/dev-11757-stateerror-bad-state-cannot-reconnect-a-disposed-socket

[part of DEV-11757] Makes failed heartbeat not attempt to reconnect after ConnectionManager is closed or disposed

Author: kpsroka

.github/workflows/test.yaml

@@ -45,4 +45,4 @@ jobs:
           dart analyze test/
 
       - name: Run tests
-        run: dart run test
+        run: dart run test --concurrency=1

lib/src/socket.dart

@@ -448,7 +448,9 @@ class PhoenixSocket {
       return false;
     } catch (error, stackTrace) {
       _logger.warning('Heartbeat message failed', error, stackTrace);
-      _reconnect(heartbeatTimedOut, reason: 'Heartbeat timed out');
+      if (!_disposed && _connectionManager != null) {
+        _reconnect(heartbeatTimedOut, reason: 'Heartbeat timed out');
+      }
       return false;
     }
   }
@@ -569,7 +571,6 @@ class PhoenixSocket {
     if (_isOpen) {
       _triggerChannelExceptions(PhoenixException(socketError: errorEvent));
     }
-    // _connectionManager?.reconnect(internalServerError, reason: 'Error on socket: ${errorEvent.error}');
   }
 
   void _onSocketClosed(PhoenixSocketCloseEvent closeEvent) {

test/socket_integration_test.dart

@@ -3,10 +3,20 @@ import 'dart:async';
 import 'package:phoenix_socket/phoenix_socket.dart';
 import 'package:test/test.dart';
 
+import 'helpers/proxy.dart';
+
 void main() {
   const addr = 'ws://localhost:4001/socket/websocket';
 
   group('PhoenixSocket', () {
+    setUp(() async {
+      await prepareProxy();
+    });
+
+    tearDown(() async {
+      await destroyProxy();
+    });
+
     test('can connect to a running Phoenix server', () async {
       final socket = PhoenixSocket(addr);
 
@@ -121,5 +131,26 @@ void main() {
 
       expect(errCount, 3);
     });
+
+    test('heartbeat failure does not reconnect after disposal', () async {
+      final socket = PhoenixSocket(
+        addr,
+        socketOptions: PhoenixSocketOptions(
+          heartbeat: Duration(milliseconds: 1),
+        ),
+      );
+
+      await socket.connect();
+
+      await socket.openStream.first;
+
+      // Prevent next heartbeat from getting a reply.
+      await haltProxy();
+
+      socket.dispose();
+
+      await Future.delayed(Duration(milliseconds: 1));
+      // The test will fail with unhandled exception if reconnection attempt is made
+    });
   });
 }