test(persistence): add tests for stream chat persistence client

Signed-off-by: Sahil Kumar <[email protected]>

packages/stream_chat_persistence/lib/src/db/moor_chat_database.dart

@@ -6,19 +6,11 @@ import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/converter/converter.dart';
 import 'package:stream_chat_persistence/src/dao/dao.dart';
 import 'package:stream_chat_persistence/src/entity/entity.dart';
-import 'package:stream_chat_persistence/src/db/shared/shared_db.dart';
+
+export 'shared/shared_db.dart';
 
 part 'moor_chat_database.g.dart';
 
-LazyDatabase _openConnection(
-  String userId, {
-  bool logStatements = false,
-}) =>
-    LazyDatabase(() async => SharedDB.constructDatabase(
-          userId,
-          logStatements: logStatements,
-        ));
-
 /// A chat database implemented using moor
 @UseMoor(tables: [
   Channels,
@@ -44,12 +36,9 @@ LazyDatabase _openConnection(
 class MoorChatDatabase extends _$MoorChatDatabase {
   /// Creates a new moor chat database instance
   MoorChatDatabase(
-    this._userId, {
-    logStatements = false,
-  }) : super(_openConnection(
-          _userId,
-          logStatements: logStatements,
-        ));
+    this._userId,
+    QueryExecutor executor,
+  ) : super(executor);
 
   /// Instantiate a new database instance
   MoorChatDatabase.connect(

packages/stream_chat_persistence/lib/src/db/shared/native_db.dart

@@ -14,15 +14,40 @@ import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 /// A Helper class to construct new instances of [MoorChatDatabase] specifically
 /// for native platform applications
 class SharedDB {
-  /// Returns a new instance of [VmDatabase] created using [userId]
-  /// on a regular isolate.
-  ///
-  /// Generally used with [ConnectionMode.regular].
-  static Future<VmDatabase> constructDatabase(
+  /// Returns a new instance of [MoorChatDatabase].
+  static MoorChatDatabase constructDatabase(
     String userId, {
     bool logStatements = false,
-  }) async {
+    ConnectionMode connectionMode = ConnectionMode.regular,
+  }) {
     final dbName = 'db_$userId';
+    if (connectionMode == ConnectionMode.background) {
+      return MoorChatDatabase.connect(
+        userId,
+        DatabaseConnection.delayed(Future(() async {
+          final isolate = await _createMoorIsolate(
+            dbName,
+            logStatements: logStatements,
+          );
+          return isolate.connect();
+        })),
+      );
+    }
+    return MoorChatDatabase(
+      userId,
+      LazyDatabase(
+        () async => _constructDatabase(
+          dbName,
+          logStatements: logStatements,
+        ),
+      ),
+    );
+  }
+
+  static Future<VmDatabase> _constructDatabase(
+    String dbName, {
+    bool logStatements = false,
+  }) async {
     if (Platform.isIOS || Platform.isAndroid) {
       final dir = await getApplicationDocumentsDirectory();
       final path = join(dir.path, '$dbName.sqlite');
@@ -66,27 +91,6 @@ class SharedDB {
 
     return await receivePort.first as MoorIsolate;
   }
-
-  /// Returns a new instance of [MoorChatDatabase] using the factory constructor
-  /// [MoorChatDatabase.connect] created on a background isolate.
-  ///
-  /// Generally used with [ConnectionMode.background].
-  static MoorChatDatabase constructMoorChatDatabase(
-    String userId, {
-    bool logStatements = false,
-  }) {
-    final dbName = 'db_$userId';
-    return MoorChatDatabase.connect(
-      userId,
-      DatabaseConnection.delayed(Future(() async {
-        final isolate = await _createMoorIsolate(
-          dbName,
-          logStatements: logStatements,
-        );
-        return isolate.connect();
-      })),
-    );
-  }
 }
 
 class _IsolateStartRequest {

packages/stream_chat_persistence/lib/src/db/shared/unsupported_db.dart

@@ -1,28 +1,16 @@
-import 'package:moor/backends.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 import 'package:stream_chat_persistence/stream_chat_persistence.dart';
 
 /// A Helper class to construct new instances of [MoorChatDatabase]
 class SharedDB {
-  /// Returns a new instance of database.
-  ///
-  /// Generally used with [ConnectionMode.regular].
-  static Future<DelegatedDatabase> constructDatabase(
+  /// Returns a new instance of [MoorChatDatabase].
+  static MoorChatDatabase constructDatabase(
     String userId, {
     bool logStatements = false,
+    ConnectionMode connectionMode = ConnectionMode.regular,
   }) {
     throw UnsupportedError(
-        'No implementation of the constructDatabase api provided');
-  }
-
-  /// Return a new instance of moor chat database.
-  ///
-  /// Generally used with [ConnectionMode.background].
-  static MoorChatDatabase constructMoorChatDatabase(
-    String userId, {
-    bool logStatements = false,
-  }) {
-    throw UnsupportedError(
-        'No implementation of the constructMoorChatDatabase api provided');
+      'No implementation of the constructDatabase api provided',
+    );
   }
 }

packages/stream_chat_persistence/lib/src/db/shared/web_db.dart

@@ -6,26 +6,14 @@ import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 /// A Helper class to construct new instances of [MoorChatDatabase] specifically
 /// for Web applications
 class SharedDB {
-  /// Returns a new instance of [WebDatabase] created using [userId].
-  ///
-  /// Generally used with [ConnectionMode.regular].
-  static Future<WebDatabase> constructDatabase(
-    String userId, {
-    bool logStatements = false,
-  }) async {
-    final dbName = 'db_$userId';
-    return WebDatabase(dbName, logStatements: logStatements);
-  }
-
-  /// Returns a new instance of [MoorChatDatabase] creating using the
-  /// default constructor.
-  ///
-  /// Generally used with [ConnectionMode.background].
-  static MoorChatDatabase constructMoorChatDatabase(
+  /// Returns a new instance of [MoorChatDatabase].
+  static MoorChatDatabase constructDatabase(
     String userId, {
     bool logStatements = false,
+    ConnectionMode connectionMode = ConnectionMode.regular, // Ignored on web
   }) {
     final dbName = 'db_$userId';
-    return MoorChatDatabase(dbName, logStatements: logStatements);
+    final queryExecutor = WebDatabase(dbName, logStatements: logStatements);
+    return MoorChatDatabase(userId, queryExecutor);
   }
 }

packages/stream_chat_persistence/lib/src/stream_chat_persistence_client.dart

@@ -4,7 +4,6 @@ import 'package:mutex/mutex.dart';
 import 'package:stream_chat/stream_chat.dart';
 
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
-import 'package:stream_chat_persistence/src/db/shared/shared_db.dart';
 
 /// Various connection modes on which [StreamChatPersistenceClient] can work
 enum ConnectionMode {
@@ -15,6 +14,9 @@ enum ConnectionMode {
   background,
 }
 
+/// Signature for a function which provides instance of [MoorChatDatabase]
+typedef DatabaseProvider = MoorChatDatabase Function(String, ConnectionMode);
+
 final _levelEmojiMapper = {
   Level.INFO: 'ℹ️',
   Level.WARNING: '⚠️',
@@ -36,26 +38,6 @@ class StreamChatPersistenceClient extends ChatPersistenceClient {
     _logger.onRecord.listen(logHandlerFunction ?? _defaultLogHandler);
   }
 
-  /// A function that has a parameter of type [LogRecord].
-  /// This is called on every new log record.
-  /// By default the client will use the handler returned by
-  /// [_getDefaultLogHandler].
-  /// Setting it you can handle the log messages directly instead of have them
-  /// written to stdout,
-  /// this is very convenient if you use an error tracking tool or if you want
-  /// to centralize your logs into one facility.
-  ///
-  /// ```dart
-  /// myLogHandlerFunction = (LogRecord record) {
-  ///  // do something with the record (ie. send it to Sentry or Fabric)
-  /// }
-  ///
-  /// final client = StreamChatPersistenceClient(
-  ///   logHandlerFunction: myLogHandlerFunction,
-  /// );
-  ///```
-  LogHandlerFunction logHandlerFunction;
-
   /// [MoorChatDatabase] instance used by this client.
   @visibleForTesting
   MoorChatDatabase db;
@@ -84,24 +66,25 @@ class StreamChatPersistenceClient extends ChatPersistenceClient {
     return ret;
   }
 
+  MoorChatDatabase _defaultDatabaseProvider(
+    String userId,
+    ConnectionMode mode,
+  ) =>
+      SharedDB.constructDatabase(userId, connectionMode: mode);
+
   @override
-  Future<void> connect(String userId) async {
+  Future<void> connect(
+    String userId, {
+    DatabaseProvider databaseProvider, // Used only for testing
+  }) async {
     if (db != null) {
       throw Exception(
         'An instance of StreamChatDatabase is already connected.\n'
         'disconnect the previous instance before connecting again.',
       );
     }
-    switch (_connectionMode) {
-      case ConnectionMode.regular:
-        _logger.info('Connecting on a regular isolate');
-        db = MoorChatDatabase(userId);
-        return;
-      case ConnectionMode.background:
-        _logger.info('Connecting on background isolate');
-        db = SharedDB.constructMoorChatDatabase(userId);
-        return;
-    }
+    db = databaseProvider?.call(userId, _connectionMode) ??
+        _defaultDatabaseProvider(userId, _connectionMode);
   }
 
   @override
@@ -259,9 +242,9 @@ class StreamChatPersistenceClient extends ChatPersistenceClient {
   @override
   Future<void> updateChannelQueries(
     Map<String, dynamic> filter,
-    List<String> cids,
-    bool clearQueryCache,
-  ) =>
+    List<String> cids, {
+    bool clearQueryCache = false,
+  }) =>
       _readProtected(() async {
         _logger.info('updateChannelQueries');
         return db.channelQueryDao.updateChannelQueries(