Merge pull request #1712 from GetStream/release/v6.9.0

.github/workflows/legacy_version_analyze.yml

@@ -3,7 +3,7 @@ name: legacy_version_analyze
 env:
   # Note: The versions below should be manually updated after a new stable
   # version comes out.
-  flutter_version: "3.7.12"
+  flutter_version: "3.10.6"
 
 on:
   push:

.github/workflows/stream_flutter_workflow.yml

@@ -2,7 +2,7 @@ name: stream_flutter_workflow
 
 env:
   ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
-  flutter_version: "3.10.4"
+  flutter_channel: "stable"
 
 on:
   pull_request:
@@ -37,7 +37,7 @@ jobs:
         uses: subosito/flutter-action@v2
         with:
           cache: true
-          flutter-version: ${{ env.flutter_version }}
+          channel: ${{ env.flutter_channel }}
       - name: "Install Tools"
         run: |
           flutter pub global activate melos

packages/stream_chat/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 6.8.0
+
+🐞 Fixed
+
+- Fixed `Channel.query` not initializing `ChannelState`.
+
+✅ Added
+
+- Added support for `channel.countUnreadMentions()` to get the count of unread messages mentioning the current user on a
+  channel. [#1692](https://github.com/GetStream/stream-chat-flutter/issues/1692)
+
+🔄 Changed
+
+- Updated minimum supported `SDK` version to Dart 3.0
+
 ## 6.7.0
 
 ✅ Added

packages/stream_chat/example/pubspec.yaml

@@ -5,8 +5,8 @@ publish_to: "none"
 version: 1.0.0+1
 
 environment:
-  sdk: '>=2.19.0 <4.0.0'
-  flutter: ">=3.7.0"
+  sdk: ">=3.0.0 <4.0.0"
+  flutter: ">=3.10.0"
 
 dependencies:
   cupertino_icons: ^1.0.5

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

@@ -1339,26 +1339,6 @@ class Channel {
     return _client.markChannelRead(id!, type, messageId: messageId);
   }
 
-  /// Loads the initial channel state and watches for changes.
-  Future<ChannelState> watch({bool presence = false}) async {
-    ChannelState response;
-
-    try {
-      response = await query(watch: true, presence: presence);
-    } catch (error, stackTrace) {
-      if (!_initializedCompleter.isCompleted) {
-        _initializedCompleter.completeError(error, stackTrace);
-      }
-      rethrow;
-    }
-
-    if (state == null) {
-      _initState(response);
-    }
-
-    return response;
-  }
-
   void _initState(ChannelState channelState) {
     state = ChannelClientState(this, channelState);
 
@@ -1370,6 +1350,22 @@ class Channel {
     }
   }
 
+  /// Loads the initial channel state and watches for changes.
+  Future<ChannelState> watch({
+    bool presence = false,
+    PaginationParams? messagesPagination,
+    PaginationParams? membersPagination,
+    PaginationParams? watchersPagination,
+  }) {
+    return query(
+      watch: true,
+      presence: presence,
+      messagesPagination: messagesPagination,
+      membersPagination: membersPagination,
+      watchersPagination: watchersPagination,
+    );
+  }
+
   /// Stop watching the channel.
   Future<EmptyResponse> stopWatching() async {
     _checkInitialized();
@@ -1435,7 +1431,7 @@ class Channel {
       );
 
   /// Creates a new channel.
-  Future<ChannelState> create() async => query(state: false);
+  Future<ChannelState> create() => query(state: false);
 
   /// Query the API, get messages, members or other channel fields.
   ///
@@ -1450,23 +1446,28 @@ class Channel {
     PaginationParams? watchersPagination,
     bool preferOffline = false,
   }) async {
-    if (preferOffline && cid != null) {
-      final updatedState = await _client.chatPersistenceClient
-          ?.getChannelStateByCid(cid!, messagePagination: messagesPagination);
-      if (updatedState != null &&
-          updatedState.messages != null &&
-          updatedState.messages!.isNotEmpty) {
-        if (this.state == null) {
-          _initState(updatedState);
-        } else {
-          this.state?.updateChannelState(updatedState);
+    ChannelState? channelState;
+
+    try {
+      // If we prefer offline, we first try to get the channel state from the
+      // offline storage.
+      if (preferOffline && !watch && cid != null) {
+        final persistenceClient = _client.chatPersistenceClient;
+        if (persistenceClient != null) {
+          final cachedState = await persistenceClient.getChannelStateByCid(
+            cid!,
+            messagePagination: messagesPagination,
+          );
+
+          // If the cached state contains messages, we can use it.
+          if (cachedState.messages?.isNotEmpty == true) {
+            channelState = cachedState;
+          }
         }
-        return updatedState;
       }
-    }
 
-    try {
-      final updatedState = await _client.queryChannel(
+      // If we still don't have the channelState, we try to get it from the API.
+      channelState ??= await _client.queryChannel(
         type,
         channelId: id,
         channelData: _extraData,
@@ -1479,18 +1480,35 @@ class Channel {
       );
 
       if (_id == null) {
-        _id = updatedState.channel!.id;
-        _cid = updatedState.channel!.cid;
+        _id = channelState.channel!.id;
+        _cid = channelState.channel!.cid;
       }
 
-      this.state?.updateChannelState(updatedState);
-      return updatedState;
-    } catch (e) {
-      if (_client.persistenceEnabled) {
-        return _client.chatPersistenceClient!.getChannelStateByCid(
-          cid!,
-          messagePagination: messagesPagination,
-        );
+      // Initialize the channel state if it's not initialized yet.
+      if (this.state == null) {
+        _initState(channelState);
+      } else {
+        // Otherwise, update the channel state.
+        this.state?.updateChannelState(channelState);
+      }
+
+      return channelState;
+    } catch (e, stk) {
+      // If we failed to get the channel state from the API and we were not
+      // supposed to watch the channel, we will try to get the channel state
+      // from the offline storage.
+      if (watch == false) {
+        if (_client.persistenceEnabled) {
+          return _client.chatPersistenceClient!.getChannelStateByCid(
+            cid!,
+            messagePagination: messagesPagination,
+          );
+        }
+      }
+
+      // Otherwise, we will just rethrow the error.
+      if (!_initializedCompleter.isCompleted) {
+        _initializedCompleter.completeError(e, stk);
       }
 
       rethrow;
@@ -2334,6 +2352,26 @@ class ChannelClientState {
         !isThreadMessage;
   }
 
+  /// Counts the number of unread messages mentioning the current user.
+  ///
+  /// **NOTE**: The method relies on the [Channel.messages] list and doesn't do
+  /// any API call. Therefore, the count might be not reliable as it relies on
+  /// the local data.
+  int countUnreadMentions() {
+    final lastRead = currentUserRead?.lastRead;
+    final userId = _channel.client.state.currentUser?.id;
+
+    var count = 0;
+    for (final message in messages) {
+      if (_countMessageAsUnread(message) &&
+          (lastRead == null || message.createdAt.isAfter(lastRead)) &&
+          message.mentionedUsers.any((user) => user.id == userId) == true) {
+        count++;
+      }
+    }
+    return count;
+  }
+
   /// Update threads with updated information about messages.
   void updateThreadInfo(String parentId, List<Message> messages) {
     final newThreads = Map<String, List<Message>>.from(threads);

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

@@ -1696,7 +1696,7 @@ class ClientState {
   void updateUsers(List<User?> userList) {
     final newUsers = {
       ...users,
-      for (var user in userList)
+      for (final user in userList)
         if (user != null) user.id: user,
     };
     _usersController.add(newUsers);

packages/stream_chat/lib/src/ws/timer_helper.dart

@@ -2,7 +2,7 @@ import 'dart:async';
 import 'package:uuid/uuid.dart';
 
 ///
-class TimerHelper {
+mixin class TimerHelper {
   final _uuid = const Uuid();
   late final _timers = <String, Timer>{};
 

packages/stream_chat/lib/version.dart

@@ -3,4 +3,4 @@ import 'package:stream_chat/src/client/client.dart';
 /// Current package version
 /// Used in [StreamChatClient] to build the `x-stream-client` header
 // ignore: constant_identifier_names
-const PACKAGE_VERSION = '6.7.0';
+const PACKAGE_VERSION = '6.8.0';

packages/stream_chat/pubspec.yaml

@@ -1,24 +1,24 @@
 name: stream_chat
 homepage: https://getstream.io/
 description: The official Dart client for Stream Chat, a service for building chat applications.
-version: 6.7.0
+version: 6.8.0
 repository: https://github.com/GetStream/stream-chat-flutter
 issue_tracker: https://github.com/GetStream/stream-chat-flutter/issues
 
 environment:
-  sdk: '>=2.19.0 <4.0.0'
+  sdk: '>=3.0.0 <4.0.0'
 
 dependencies:
-  async: ^2.10.0
-  collection: ^1.17.0
-  dio: ^5.2.1+1
+  async: ^2.11.0
+  collection: ^1.17.1
+  dio: ^5.3.2
   equatable: ^2.0.5
-  freezed_annotation: ^2.2.0
+  freezed_annotation: ^2.4.1
   http_parser: ^4.0.2
-  jose: ^0.3.3
+  jose: ^0.3.4
   json_annotation: ^4.8.1
   logging: ^1.2.0
-  meta: ^1.8.0
+  meta: ^1.9.1
   mime: ^1.0.4
   rate_limiter: ^1.0.0
   rxdart: ^0.27.7
@@ -27,8 +27,8 @@ dependencies:
   web_socket_channel: ^2.4.0
 
 dev_dependencies:
-  build_runner: ^2.3.3
-  freezed: ^2.4.0
-  json_serializable: ^6.6.2
-  mocktail: ^0.3.0
-  test: ^1.24.3
+  build_runner: ^2.4.6
+  freezed: ^2.4.2
+  json_serializable: ^6.7.1
+  mocktail: ^1.0.0
+  test: ^1.24.6

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

@@ -975,7 +975,7 @@ void main() {
         // skipping initial seed event -> {} users
         client.state.usersStream.skip(1),
         emitsInOrder([
-          {for (var user in users) user.id: user},
+          {for (final user in users) user.id: user},
         ]),
       );
 

packages/stream_chat/test/src/core/http/interceptor/additional_headers_interceptor_test.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: invalid_use_of_protected_member
+
 import 'package:dio/dio.dart';
 import 'package:stream_chat/src/core/http/interceptor/additional_headers_interceptor.dart';
 import 'package:stream_chat/stream_chat.dart';

packages/stream_chat/test/src/core/http/interceptor/auth_interceptor_test.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: invalid_use_of_protected_member
+
 import 'package:dio/dio.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:stream_chat/src/core/http/interceptor/auth_interceptor.dart';

packages/stream_chat/test/src/core/http/interceptor/connection_id_interceptor_test.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: invalid_use_of_protected_member
+
 import 'package:dio/dio.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:stream_chat/src/core/http/connection_id_manager.dart';