Merge pull request #147 from sendbird/v4.5.2

Add 4.5.2.

Author: sf-tyler-jeong

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v4.5.2 (Sep 15, 2025)
+
+### Improvements
+- Fixed a bug where the failed `FileMessage` does not load on iOS when restarting the app
+- Fixed a bug regarding offline login
+- Updated regarding statistics
+
 ## v4.5.1 (Jul 24, 2025)
 
 ### Improvements

README.md

@@ -50,7 +50,7 @@ Before installing Sendbird Chat SDK, you need to create a Sendbird application o
 
 ```yaml
 dependencies:
-  sendbird_chat_sdk: ^4.5.1
+  sendbird_chat_sdk: ^4.5.2
 ```
 
 - Run `flutter pub get` command in your project directory.

lib/src/internal/db/db.dart

@@ -337,6 +337,20 @@ class DB {
     );
   }
 
+  Future<FileMessage?> getFailedFileMessage({
+    required ChannelType channelType,
+    required String channelUrl,
+    required String requestId,
+  }) async {
+    return await CChannelMessage.getFailedFileMessage(
+      _chat,
+      _isar,
+      channelType,
+      channelUrl,
+      requestId,
+    );
+  }
+
   Future<void> removeFailedMessages({
     required ChannelType channelType,
     required String channelUrl,

lib/src/internal/db/schema/message/meta/c_channel_message.dart

@@ -342,6 +342,33 @@ class CChannelMessage {
     return messages;
   }
 
+  static Future<FileMessage?> getFailedFileMessage(
+    Chat chat,
+    Isar isar,
+    ChannelType channelType,
+    String channelUrl,
+    String requestId,
+  ) async {
+    final cChannelMessages = await isar.cChannelMessages
+        .where()
+        .channelTypeChannelUrlEqualTo(channelType, channelUrl)
+        .filter()
+        .sendingStatusEqualTo(SendingStatus.failed)
+        .findAll();
+
+    FileMessage? fileMessage;
+    for (final cChannelMessage in cChannelMessages) {
+      final message = await cChannelMessage.toChannelMessage(chat, isar);
+      if (message != null && message.message is FileMessage) {
+        if ((message.message as FileMessage).requestId == requestId) {
+          fileMessage = message.message as FileMessage;
+          break;
+        }
+      }
+    }
+    return fileMessage;
+  }
+
   static Future<void> removeFailedMessages(
     Chat chat,
     Isar isar,

lib/src/internal/main/chat/chat.dart

@@ -18,6 +18,7 @@ import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/db_manager.dart
 import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/device_token_manager.dart';
 import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/event_dispatcher.dart';
 import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/event_manager.dart';
+import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/file_cache_manager.dart';
 import 'package:sendbird_chat_sdk/src/internal/main/chat_manager/session_manager.dart';
 import 'package:sendbird_chat_sdk/src/internal/main/logger/sendbird_logger.dart';
 import 'package:sendbird_chat_sdk/src/internal/main/model/delivery_status.dart';
@@ -53,7 +54,6 @@ import 'package:sendbird_chat_sdk/src/internal/network/http/http_client/request/
 import 'package:sendbird_chat_sdk/src/internal/network/http/http_client/request/user/preference/user_snooze_request.dart';
 import 'package:sendbird_chat_sdk/src/internal/network/http/http_client/request/user/push/user_push_register_request.dart';
 import 'package:sendbird_chat_sdk/src/internal/network/http/http_client/request/user/push/user_push_unregister_request.dart';
-import 'package:sendbird_chat_sdk/src/public/main/params/channel/feed_channel_total_unread_message_count_params.dart';
 import 'package:universal_io/io.dart';
 
 part 'chat_auth.dart';
@@ -66,7 +66,7 @@ part 'chat_notifications.dart';
 part 'chat_push.dart';
 part 'chat_user.dart';
 
-const sdkVersion = '4.5.1';
+const sdkVersion = '4.5.2';
 
 // Internal implementation for main class. Do not directly access this class.
 class Chat with WidgetsBindingObserver {
@@ -124,6 +124,7 @@ class Chat with WidgetsBindingObserver {
   late StatManager statManager;
   late DBManager dbManager;
   late DeviceTokenManager deviceTokenManager;
+  late FileCacheManager fileCacheManager;
 
   final int chatId;
 
@@ -148,6 +149,7 @@ class Chat with WidgetsBindingObserver {
     collectionManager = CollectionManager(chat: this);
     dbManager = DBManager(chat: this);
     deviceTokenManager = DeviceTokenManager();
+    fileCacheManager = FileCacheManager(chat: this);
 
     _listenConnectivityChangedEvent();
   }

lib/src/internal/main/chat_manager/connection_manager.dart

@@ -135,6 +135,8 @@ class ConnectionManager {
   }) async {
     sbLog.i(StackTrace.current, 'userId: $userId');
 
+    chat.connectionManager.changeState(ConnectingState(chat: chat));
+
     setLoginInfo(
       fromWebSocket: true,
       userId: userId,
@@ -259,10 +261,12 @@ class ConnectionManager {
       'clear: $clear, logout: $logout, userId: ${chat.chatContext.currentUserId}',
     );
 
-    if (chat.chatContext.loginCompleter != null &&
-        !chat.chatContext.loginCompleter!.isCompleted) {
-      chat.chatContext.loginCompleter
-          ?.completeError(ConnectionCanceledException());
+    if (chat.dbManager.isEnabled() == false) {
+      if (chat.chatContext.loginCompleter != null &&
+          !chat.chatContext.loginCompleter!.isCompleted) {
+        chat.chatContext.loginCompleter
+            ?.completeError(ConnectionCanceledException());
+      }
     }
 
     if (isReconnecting()) {
@@ -496,8 +500,6 @@ class ConnectionManager {
         await disconnect(logout: false);
         await reconnect(reset: true);
       }
-    } else {
-      throw WebSocketFailedException(message: e.toString());
     }
   }
 
@@ -519,6 +521,7 @@ class ConnectionManager {
       'SB-User-Agent': _sbUserAgentHeader,
       'SB-SDK-USER-AGENT': _sbSdkUserAgentHeader,
       'SendBird': _sendbirdHeader,
+      'Connection': 'keep-alive',
     };
   }
 

lib/src/internal/main/chat_manager/db_manager.dart

@@ -124,6 +124,8 @@ class DBManager {
     if (preDbVersion == null || _dbVersion > preDbVersion) {
       await clear();
       await prefs.setInt(_dbVersionKey, _dbVersion);
+    } else {
+      _chat.fileCacheManager.removeOldCachedFilesForIOS(); // Async
     }
   }
 
@@ -167,6 +169,7 @@ class DBManager {
       try {
         sbLog.d(StackTrace.current);
         await _db.clear();
+        await _chat.fileCacheManager.clearCacheForIOS();
       } catch (e) {
         sbLog.e(StackTrace.current, e.toString());
       }
@@ -508,6 +511,57 @@ class DBManager {
     return [];
   }
 
+  Future<FileMessage?> getFailedFileMessage({
+    required ChannelType channelType,
+    required String channelUrl,
+    required String requestId,
+  }) async {
+    if (isEnabled()) {
+      return await _db.getFailedFileMessage(
+        channelType: channelType,
+        channelUrl: channelUrl,
+        requestId: requestId,
+      );
+    }
+    return null;
+  }
+
+  Future<void> removeOldFailedMessages(
+    List<String> filePathList,
+  ) async {
+    if (isEnabled()) {
+      final channels = await getGroupChannels(query: GroupChannelListQuery());
+      for (final channel in channels) {
+        final failedMessages = await getFailedMessages(
+          channelType: ChannelType.group,
+          channelUrl: channel.channelUrl,
+        );
+
+        List<BaseMessage> messagesToRemove = [];
+
+        for (final message in failedMessages) {
+          if (message is FileMessage) {
+            for (final filePath in filePathList) {
+              if (message.messageCreateParams?.fileInfo.file?.path ==
+                  filePath) {
+                messagesToRemove.add(message);
+                break;
+              }
+            }
+          }
+        }
+
+        if (messagesToRemove.isNotEmpty) {
+          await removeFailedMessages(
+            channelType: ChannelType.group,
+            channelUrl: channel.channelUrl,
+            messages: messagesToRemove,
+          );
+        }
+      }
+    }
+  }
+
   Future<void> removeFailedMessages({
     required ChannelType channelType,
     required String channelUrl,
@@ -523,6 +577,15 @@ class DBManager {
         channelUrl: channelUrl,
         messages: failedMessages,
       );
+
+      for (final message in failedMessages) {
+        if (message is FileMessage) {
+          await _chat.fileCacheManager.removeCachedFileForIOS(
+            requestId: message.requestId,
+            file: message.messageCreateParams?.fileInfo.file,
+          );
+        }
+      }
     }
 
     // Event
@@ -551,6 +614,7 @@ class DBManager {
         channelType: channelType,
         channelUrl: channelUrl,
       );
+      await _chat.fileCacheManager.clearCacheForIOS();
     }
 
     // Event

lib/src/internal/main/chat_manager/file_cache_manager.dart

@@ -0,0 +1,139 @@
+// Copyright (c) 2025 Sendbird, Inc. All rights reserved.
+
+import 'dart:io';
+
+import 'package:path_provider/path_provider.dart';
+import 'package:sendbird_chat_sdk/sendbird_chat_sdk.dart';
+import 'package:sendbird_chat_sdk/src/internal/main/chat/chat.dart';
+
+import '../logger/sendbird_logger.dart';
+
+class FileCacheManager {
+  static const String _folderName = 'sendbird_chat_file_cache';
+
+  final Chat _chat;
+  int retentionMinutes = 3 * 24 * 60; // 3 days
+
+  FileCacheManager({required Chat chat}) : _chat = chat;
+
+  bool _isForIOSCaching() {
+    return Platform.isIOS && _chat.chatContext.options.useCollectionCaching;
+  }
+
+  Future<Directory> _getCacheDir() async {
+    final appSupportDir = await getApplicationSupportDirectory();
+    final cacheDir = Directory('${appSupportDir.path}/$_folderName');
+    if (!cacheDir.existsSync()) {
+      cacheDir.createSync();
+    }
+    return cacheDir;
+  }
+
+  Future<String> _getCachedFilePath({
+    required String requestId,
+    required File file,
+  }) async {
+    final cacheDir = await _getCacheDir();
+    String cachedFilePath =
+        '${cacheDir.path}/${requestId}_${file.path.split('/').last}';
+    return cachedFilePath;
+  }
+
+  Future<void> copyFileForIOS({
+    required GroupChannel channel,
+    required String? requestId,
+    required File? originalFile,
+  }) async {
+    if (_isForIOSCaching() && requestId != null && originalFile != null) {
+      try {
+        final cachedFilePath = await _getCachedFilePath(
+          requestId: requestId,
+          file: originalFile,
+        );
+        File cachedFile = File(cachedFilePath);
+        if (cachedFile.existsSync()) {
+          cachedFile.deleteSync();
+        }
+        cachedFile = await originalFile.copy(cachedFilePath);
+
+        final failedFileMessage = await _chat.dbManager.getFailedFileMessage(
+          channelType: ChannelType.group,
+          channelUrl: channel.channelUrl,
+          requestId: requestId,
+        );
+
+        if (failedFileMessage != null) {
+          failedFileMessage.file = cachedFile;
+          failedFileMessage.messageCreateParams?.fileInfo.file = cachedFile;
+
+          await _chat.dbManager.upsertMessages([failedFileMessage]);
+        }
+      } catch (e) {
+        sbLog.e(StackTrace.current, 'Failed to write cache file for iOS: $e');
+      }
+    }
+  }
+
+  Future<void> removeCachedFileForIOS({
+    required String? requestId,
+    required File? file,
+  }) async {
+    if (_isForIOSCaching() && requestId != null && file != null) {
+      try {
+        final cachedFilePath = await _getCachedFilePath(
+          requestId: requestId,
+          file: file,
+        );
+        final cachedFile = File(cachedFilePath);
+        if (cachedFile.existsSync()) {
+          cachedFile.deleteSync();
+        }
+      } catch (e) {
+        sbLog.e(StackTrace.current, 'Failed to delete cache file for iOS: $e');
+      }
+    }
+  }
+
+  Future<void> removeOldCachedFilesForIOS() async {
+    if (_isForIOSCaching()) {
+      try {
+        final cacheDir = await _getCacheDir();
+        List<String> filePathList = [];
+        final now = DateTime.now();
+
+        for (final fileEntity in cacheDir.listSync()) {
+          if (fileEntity is File) {
+            final stat = await fileEntity.stat();
+            if (now.difference(stat.accessed).inMinutes > retentionMinutes) {
+              filePathList.add(fileEntity.path);
+            }
+          }
+        }
+
+        if (filePathList.isNotEmpty) {
+          try {
+            await _chat.dbManager.removeOldFailedMessages(filePathList);
+          } catch (e) {
+            sbLog.e(StackTrace.current,
+                'Failed to remove failed messages with old cache files: $e');
+          }
+        }
+      } catch (e) {
+        sbLog.e(StackTrace.current, 'Failed to clean old cache files: $e');
+      }
+    }
+  }
+
+  Future<void> clearCacheForIOS() async {
+    if (_isForIOSCaching()) {
+      try {
+        final cacheDir = await _getCacheDir();
+        if (cacheDir.existsSync()) {
+          cacheDir.deleteSync(recursive: true);
+        }
+      } catch (e) {
+        sbLog.e(StackTrace.current, 'Failed to clear cache for iOS: $e');
+      }
+    }
+  }
+}