Disconnect all sessions, 2.1.11

Author: Sterling Long

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.11
+
+- `WalletConnectModalService.disconnect` now disconnects all sessions, unless you tell it to only disconnect the current one
+
 ## 2.1.10
 
 - Fixed an issue with disconnect not working properly

lib/constants/constants.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
 class WalletConnectModalConstants {
-  static const WALLETCONNECT_MODAL_VERSION = '2.1.10';
+  static const WALLETCONNECT_MODAL_VERSION = '2.1.11';
 
   static const Key helpPageKey = Key('helpPageKey');
   static const Key qrCodePageKey = Key('qrCodePageKey');

lib/services/walletconnect_modal/i_walletconnect_modal_service.dart

@@ -55,7 +55,9 @@ abstract class IWalletConnectModalService implements ChangeNotifier {
 
   /// Disconnects the session and pairing, if any.
   /// If there is no session, this does nothing.
-  Future<void> disconnect();
+  Future<void> disconnect({
+    bool disconnectAllSessions = true,
+  });
 
   Future<void> launchCurrentWallet();
 

lib/services/walletconnect_modal/walletconnect_modal_service.dart

@@ -262,7 +262,9 @@ class WalletConnectModalService extends ChangeNotifier
   }
 
   @override
-  Future<void> disconnect() async {
+  Future<void> disconnect({
+    bool disconnectAllSessions = true,
+  }) async {
     checkInitialized();
 
     // If we don't have a session, disconnect automatically and notify listeners
@@ -273,31 +275,14 @@ class WalletConnectModalService extends ChangeNotifier
       return;
     }
 
-    // Disconnect both the pairing and session
-    await web3App!.disconnectSession(
-      topic: session!.pairingTopic,
-      // ignore: prefer_const_constructors
-      reason: WalletConnectError(
-        code: 0,
-        message: 'User disconnected',
-      ),
-    );
-    // Disconnecting the session will produce the onSessionDisconnect callback
-    await web3App!.disconnectSession(
-      topic: session!.topic,
-      // ignore: prefer_const_constructors
-      reason: WalletConnectError(
-        code: 0,
-        message: 'User disconnected',
-      ),
-    );
-
-    // As a failsafe (If the session is expired for example), set the session to null and notify listeners
-    if (_session != null) {
-      _isConnected = false;
-      _address = '';
-      _session = null;
-      notifyListeners();
+    // If we want to disconnect all sessions, loop through them and disconnect them
+    if (disconnectAllSessions) {
+      for (final SessionData session in web3App!.sessions.getAll()) {
+        await disconnectSession(session);
+      }
+    } else {
+      // Disconnect the session
+      await disconnectSession(_session!);
     }
   }
 
@@ -442,6 +427,36 @@ class WalletConnectModalService extends ChangeNotifier
 
   ////// Private methods //////
 
+  @protected
+  Future<void> disconnectSession(SessionData toDisconnect) async {
+    // Disconnect both the pairing and session
+    await web3App!.disconnectSession(
+      topic: toDisconnect.pairingTopic,
+      // ignore: prefer_const_constructors
+      reason: WalletConnectError(
+        code: 0,
+        message: 'User disconnected',
+      ),
+    );
+    // Disconnecting the session will produce the onSessionDisconnect callback
+    await web3App!.disconnectSession(
+      topic: toDisconnect.topic,
+      // ignore: prefer_const_constructors
+      reason: WalletConnectError(
+        code: 0,
+        message: 'User disconnected',
+      ),
+    );
+
+    // As a failsafe (If the session is expired for example), set the session to null and notify listeners
+    if (_session != null && session!.topic == toDisconnect.topic) {
+      _isConnected = false;
+      _address = '';
+      _session = null;
+      notifyListeners();
+    }
+  }
+
   @protected
   Redirect? constructRedirect() {
     if (session == null) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: walletconnect_modal_flutter
 description: The WalletConnectModal for WalletConnect built using Flutter.
-version: 2.1.10
+version: 2.1.11
 repository: https://github.com/WalletConnect/WalletConnectModalFlutter
 
 environment:

test/mock_classes.mocks.dart

@@ -403,6 +403,14 @@ class MockExplorerService extends _i1.Mock implements _i13.ExplorerService {
         returnValue: '',
       ) as String);
   @override
+  set previousRecentWallet(String? _previousRecentWallet) => super.noSuchMethod(
+        Invocation.setter(
+          #previousRecentWallet,
+          _previousRecentWallet,
+        ),
+        returnValueForMissingStub: null,
+      );
+  @override
   _i4.Future<void> init() => (super.noSuchMethod(
         Invocation.method(
           #init,
@@ -629,10 +637,12 @@ class MockWalletConnectModalService extends _i1.Mock
         returnValueForMissingStub: _i4.Future<void>.value(),
       ) as _i4.Future<void>);
   @override
-  _i4.Future<void> disconnect() => (super.noSuchMethod(
+  _i4.Future<void> disconnect({bool? disconnectAllSessions = true}) =>
+      (super.noSuchMethod(
         Invocation.method(
           #disconnect,
           [],
+          {#disconnectAllSessions: disconnectAllSessions},
         ),
         returnValue: _i4.Future<void>.value(),
         returnValueForMissingStub: _i4.Future<void>.value(),
@@ -697,6 +707,16 @@ class MockWalletConnectModalService extends _i1.Mock
         returnValue: '',
       ) as String);
   @override
+  _i4.Future<void> disconnectSession(_i6.SessionData? toDisconnect) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #disconnectSession,
+          [toDisconnect],
+        ),
+        returnValue: _i4.Future<void>.value(),
+        returnValueForMissingStub: _i4.Future<void>.value(),
+      ) as _i4.Future<void>);
+  @override
   void registerListeners() => super.noSuchMethod(
         Invocation.method(
           #registerListeners,

test/test_data.dart

@@ -148,3 +148,21 @@ final testSession = SessionData(
   self: connectionMetadata,
   peer: connectionMetadata,
 );
+
+final testSession2 = SessionData(
+  topic: 'x',
+  pairingTopic: 'y',
+  relay: Relay('irn'),
+  expiry: 1,
+  acknowledged: true,
+  controller: 'test',
+  namespaces: {
+    'test': const Namespace(
+      accounts: ['abc'],
+      methods: ['method1'],
+      events: [],
+    ),
+  },
+  self: connectionMetadata,
+  peer: connectionMetadata,
+);

test/walletconnect_modal_service/walletconnect_modal_service_unit_test.dart

@@ -219,9 +219,58 @@ void main() {
         );
       });
 
-      test('calls disconnectSession on web3App', () async {
+      test(
+          'only disconnects the current session, if disconnectAllSessions is false',
+          () async {
         when(sessions.getAll()).thenReturn(
-          [testSession],
+          [testSession, testSession2],
+        );
+
+        await service.init();
+
+        int count = 0;
+        f() {
+          count++;
+        }
+
+        service.addListener(f);
+
+        when(
+          web3App.disconnectSession(
+            topic: anyNamed('topic'),
+            reason: anyNamed('reason'),
+          ),
+        ).thenAnswer((_) async {});
+
+        await service.disconnect(disconnectAllSessions: false);
+
+        verifyInOrder([
+          web3App.disconnectSession(
+            topic: testSession.pairingTopic,
+            reason: anyNamed('reason'),
+          ),
+          web3App.disconnectSession(
+            topic: testSession.topic,
+            reason: anyNamed('reason'),
+          )
+        ]);
+
+        expect(service.isConnected, isFalse);
+        expect(service.session, isNull);
+        expect(service.address, '');
+        expect(count, 1);
+
+        // Should null things out and notify listeners
+        await service.disconnect();
+
+        expect(count, 2);
+
+        service.removeListener(f);
+      });
+
+      test('calls disconnectSession multiple times on web3App', () async {
+        when(sessions.getAll()).thenReturn(
+          [testSession, testSession2],
         );
 
         await service.init();
@@ -250,6 +299,14 @@ void main() {
           web3App.disconnectSession(
             topic: testSession.topic,
             reason: anyNamed('reason'),
+          ),
+          web3App.disconnectSession(
+            topic: testSession2.pairingTopic,
+            reason: anyNamed('reason'),
+          ),
+          web3App.disconnectSession(
+            topic: testSession2.topic,
+            reason: anyNamed('reason'),
           )
         ]);