add connectWebsocket property to connectUser calls

packages/stream_chat/lib/src/client/client.dart

@@ -220,27 +220,53 @@ class StreamChatClient {
 
   /// Connects the current user, this triggers a connection to the API.
   /// It returns a [Future] that resolves when the connection is setup.
-  Future<Event> connectUser(User user, String token) =>
+  /// Pass [connectWebsocket]: false, if you want to connect to websocket
-      _connectUser(user, token: Token.fromRawValue(token));
+  /// at a later stage or use the client in connection-less mode
+  Future<OwnUser?> connectUser(
+    User user,
+    String token, {
+    bool connectWebsocket = true,
+  }) =>
+      _connectUser(
+        user,
+        token: Token.fromRawValue(token),
+        connectWebsocket: connectWebsocket,
+      );
 
   /// Connects the current user using the [tokenProvider] to fetch the token.
   /// It returns a [Future] that resolves when the connection is setup.
-  Future<Event> connectUserWithProvider(
+  Future<OwnUser?> connectUserWithProvider(
-          User user, TokenProvider tokenProvider) =>
+    User user,
-      _connectUser(user, provider: tokenProvider);
+    TokenProvider tokenProvider, {
+    bool connectWebsocket = true,
+  }) =>
+      _connectUser(
+        user,
+        provider: tokenProvider,
+        connectWebsocket: connectWebsocket,
+      );
 
   /// Connects the current user with an anonymous id, this triggers a connection
   /// to the API. It returns a [Future] that resolves when the connection is
   /// setup.
-  Future<Event> connectAnonymousUser() async {
+  Future<OwnUser?> connectAnonymousUser({
+    bool connectWebsocket = true,
+  }) async {
     final token = Token.anonymous();
     final user = OwnUser(id: token.userId);
-    return _connectUser(user, token: token);
+    return _connectUser(
+      user,
+      token: token,
+      connectWebsocket: connectWebsocket,
+    );
   }
 
   /// Connects the current user as guest, this triggers a connection to the API.
   /// It returns a [Future] that resolves when the connection is setup.
-  Future<Event> connectGuestUser(User user) async {
+  Future<OwnUser?> connectGuestUser(
+    User user, {
+    bool connectWebsocket = true,
+  }) async {
     final userId = user.id;
     final anonymousToken = Token.anonymous(userId: userId);
 
@@ -253,13 +279,18 @@ class StreamChatClient {
     _tokenManager.reset();
 
     final guestUserToken = Token.fromRawValue(guestUser.accessToken);
-    return _connectUser(guestUser.user, token: guestUserToken);
+    return _connectUser(
+      guestUser.user,
+      token: guestUserToken,
+      connectWebsocket: connectWebsocket,
+    );
   }
 
-  Future<Event> _connectUser(
+  Future<OwnUser?> _connectUser(
     User user, {
     Token? token,
     TokenProvider? provider,
+    bool connectWebsocket = true,
   }) async {
     if (_ws.connectionCompleter?.isCompleted == false) {
       throw const StreamChatError(
@@ -268,7 +299,7 @@ class StreamChatClient {
       );
     }
 
-    logger.info('connecting user : ${user.id}');
+    logger.info('setting user : ${user.id}');
 
     await _tokenManager.setTokenOrProvider(
       user.id,
@@ -279,6 +310,10 @@ class StreamChatClient {
     final ownUser = OwnUser.fromUser(user);
     state.user = ownUser;
 
+    if (!connectWebsocket) {
+      return ownUser;
+    }
+
     try {
       if (_originalChatPersistenceClient != null) {
         _chatPersistenceClient = _originalChatPersistenceClient;
@@ -289,7 +324,7 @@ class StreamChatClient {
     } catch (e, stk) {
       if (e is StreamWebSocketError && e.isRetriable) {
         final event = await _chatPersistenceClient?.getConnectionInfo();
-        if (event != null) return event;
+        if (event != null) return event.me;
       }
       logger.severe('error connecting user : ${ownUser.id}', e, stk);
       rethrow;
@@ -297,7 +332,7 @@ class StreamChatClient {
   }
 
   /// Creates a new WebSocket connection with the current user.
-  Future<Event> openConnection() async {
+  Future<OwnUser> openConnection() async {
     assert(
       state.user != null,
       'User is not set on client, '
@@ -327,7 +362,8 @@ class StreamChatClient {
         _ws.connectionStatusStream.skip(1).listen(_connectionStatusHandler);
 
     try {
-      return await _ws.connect(user);
+      await _ws.connect(user);
+      return state.user!;
     } catch (e, stk) {
       logger.severe('error connecting ws', e, stk);
       rethrow;

packages/stream_chat/test/src/api/client_test.dart

@@ -64,9 +64,7 @@ void main() {
 
       final res = await client.connectUser(user, token);
       expect(res, isNotNull);
-      expect(res.type, event.type);
+      expect(res, isSameUserAs(user));
-      expect(res.connectionId, event.connectionId);
-      expect(res.me, isSameUserAs(user));
     });
 
     test('`.connectUserWithProvider` should work fine', () async {
@@ -93,9 +91,7 @@ void main() {
 
       final res = await client.connectUserWithProvider(user, tokenProvider);
       expect(res, isNotNull);
-      expect(res.type, event.type);
+      expect(res, isSameUserAs(user));
-      expect(res.connectionId, event.connectionId);
-      expect(res.me, isSameUserAs(user));
     });
 
     group('`.connectGuestUser`', () {
@@ -127,9 +123,7 @@ void main() {
 
         final res = await client.connectGuestUser(user);
         expect(res, isNotNull);
-        expect(res.type, event.type);
+        expect(res, isSameUserAs(user));
-        expect(res.connectionId, event.connectionId);
-        expect(res.me, isSameUserAs(user));
 
         verify(
           () => api.guest.getGuestUser(any(that: isSameUserAs(user))),
@@ -175,9 +169,6 @@ void main() {
 
       final res = await client.connectAnonymousUser();
       expect(res, isNotNull);
-      expect(res.type, EventType.healthCheck);
-      expect(res.connectionId, 'fake-connection-id');
-      expect(res.me, isNotNull);
     });
 
     group('`.openConnection`', () {
@@ -366,8 +357,7 @@ void main() {
 
         final res = await client.connectUser(user, token);
         expect(res, isNotNull);
-        expect(res.connectionId, 'test-connection-id');
+        expect(res, isSameUserAs(user));
-        expect(res.me?.id, user.id);
 
         verify(persistence.getConnectionInfo).called(1);
         verifyNoMoreInteractions(persistence);
@@ -391,8 +381,7 @@ void main() {
 
         final res = await client.connectUserWithProvider(user, tokenProvider);
         expect(res, isNotNull);
-        expect(res.connectionId, 'test-connection-id');
+        expect(res, isSameUserAs(user));
-        expect(res.me?.id, user.id);
 
         verify(persistence.getConnectionInfo).called(1);
         verifyNoMoreInteractions(persistence);
@@ -420,8 +409,7 @@ void main() {
 
         final res = await client.connectGuestUser(user);
         expect(res, isNotNull);
-        expect(res.connectionId, 'test-connection-id');
+        expect(res, isSameUserAs(user));
-        expect(res.me?.id, user.id);
 
         verify(persistence.getConnectionInfo).called(1);
         verifyNoMoreInteractions(persistence);
@@ -446,8 +434,7 @@ void main() {
 
         final res = await client.connectAnonymousUser();
         expect(res, isNotNull);
-        expect(res.connectionId, 'test-connection-id');
+        expect(res, isSameUserAs(user));
-        expect(res.me?.id, user.id);
 
         verify(persistence.getConnectionInfo).called(1);
         verifyNoMoreInteractions(persistence);

packages/stream_chat_flutter_core/test/stream_chat_core_test.dart

@@ -204,7 +204,8 @@ void main() {
 
         final event = Event(type: EventType.any);
         when(() => mockClient.on()).thenAnswer((_) => Stream.value(event));
-        when(() => mockClient.openConnection()).thenAnswer((_) async => event);
+        when(() => mockClient.openConnection())
+            .thenAnswer((_) async => OwnUser(id: 'test'));
         when(() => mockClient.closeConnection()).thenAnswer((_) async => null);
         when(() => mockClient.wsConnectionStatus)
             .thenReturn(ConnectionStatus.disconnected);
@@ -238,7 +239,8 @@ void main() {
 
         final event = Event();
         when(() => mockClient.on()).thenAnswer((_) => Stream.value(event));
-        when(() => mockClient.openConnection()).thenAnswer((_) async => event);
+        when(() => mockClient.openConnection())
+            .thenAnswer((_) async => OwnUser(id: 'test'));
         when(() => mockClient.closeConnection()).thenAnswer((_) async => null);
         when(() => mockClient.wsConnectionStatus)
             .thenReturn(ConnectionStatus.disconnected);
@@ -327,7 +329,8 @@ void main() {
 
         final event = Event();
         when(() => mockClient.on()).thenAnswer((_) => Stream.value(event));
-        when(() => mockClient.openConnection()).thenAnswer((_) async => event);
+        when(() => mockClient.openConnection())
+            .thenAnswer((_) async => OwnUser(id: 'test'));
         when(() => mockClient.closeConnection()).thenAnswer((_) async => null);
         when(() => mockClient.wsConnectionStatus)
             .thenReturn(ConnectionStatus.disconnected);
@@ -376,7 +379,8 @@ void main() {
 
         final event = Event();
         when(() => mockClient.on()).thenAnswer((_) => Stream.value(event));
-        when(() => mockClient.openConnection()).thenAnswer((_) async => event);
+        when(() => mockClient.openConnection())
+            .thenAnswer((_) async => OwnUser(id: 'test'));
         when(() => mockClient.closeConnection()).thenAnswer((_) async => null);
         when(() => mockClient.wsConnectionStatus)
             .thenReturn(ConnectionStatus.connected);
@@ -402,7 +406,8 @@ void main() {
 
         final event = Event();
         when(() => mockClient.on()).thenAnswer((_) => Stream.value(event));
-        when(() => mockClient.openConnection()).thenAnswer((_) async => event);
+        when(() => mockClient.openConnection())
+            .thenAnswer((_) async => OwnUser(id: 'test'));
         when(() => mockClient.closeConnection()).thenAnswer((_) async => null);
         when(() => mockClient.wsConnectionStatus)
             .thenReturn(ConnectionStatus.disconnected);