feat(persistence): add support for location persistence (#2319)

Author: xsahil03x

packages/stream_chat/lib/src/db/chat_persistence_client.dart

@@ -7,6 +7,7 @@ import 'package:stream_chat/src/core/models/channel_state.dart';
 import 'package:stream_chat/src/core/models/draft.dart';
 import 'package:stream_chat/src/core/models/event.dart';
 import 'package:stream_chat/src/core/models/filter.dart';
+import 'package:stream_chat/src/core/models/location.dart';
 import 'package:stream_chat/src/core/models/member.dart';
 import 'package:stream_chat/src/core/models/message.dart';
 import 'package:stream_chat/src/core/models/poll.dart';
@@ -83,6 +84,12 @@ abstract class ChatPersistenceClient {
   /// [parentId] for thread messages.
   Future<Draft?> getDraftMessageByCid(String cid, {String? parentId});
 
+  /// Get stored [Location]s by providing channel [cid]
+  Future<List<Location>> getLocationsByCid(String cid);
+
+  /// Get stored [Location] by providing [messageId]
+  Future<Location?> getLocationByMessageId(String messageId);
+
   /// Get [ChannelState] data by providing channel [cid]
   Future<ChannelState> getChannelStateByCid(
     String cid, {
@@ -168,6 +175,12 @@ abstract class ChatPersistenceClient {
   /// [DraftMessages.parentId].
   Future<void> deleteDraftMessageByCid(String cid, {String? parentId});
 
+  /// Removes locations by channel [cid]
+  Future<void> deleteLocationsByCid(String cid);
+
+  /// Removes locations by message [messageIds]
+  Future<void> deleteLocationsByMessageIds(List<String> messageIds);
+
   /// Updates the message data of a particular channel [cid] with
   /// the new [messages] data
   Future<void> updateMessages(String cid, List<Message> messages) =>
@@ -228,6 +241,9 @@ abstract class ChatPersistenceClient {
   /// Updates the draft messages data with the new [draftMessages] data
   Future<void> updateDraftMessages(List<Draft> draftMessages);
 
+  /// Updates the locations data with the new [locations] data
+  Future<void> updateLocations(List<Location> locations);
+
   /// Deletes all the reactions by [messageIds]
   Future<void> deleteReactionsByMessageId(List<String> messageIds);
 
@@ -292,6 +308,8 @@ abstract class ChatPersistenceClient {
     final drafts = <Draft>[];
     final draftsToDeleteCids = <String>[];
 
+    final locations = <Location>[];
+
     for (final state in channelStates) {
       final channel = state.channel;
       // Continue if channel is not available.
@@ -342,6 +360,11 @@ abstract class ChatPersistenceClient {
         ...?pinnedMessages?.map((it) => it.draft),
       ].nonNulls);
 
+      locations.addAll([
+        ...?messages?.map((it) => it.sharedLocation),
+        ...?pinnedMessages?.map((it) => it.sharedLocation),
+      ].nonNulls);
+
       users.addAll([
         channel.createdBy,
         ...?messages?.map((it) => it.user),
@@ -386,6 +409,7 @@ abstract class ChatPersistenceClient {
       updatePinnedMessageReactions(pinnedReactions),
       updatePollVotes(pollVotes),
       updateDraftMessages(drafts),
+      updateLocations(locations),
     ]);
   }
 

packages/stream_chat/test/src/db/chat_persistence_client_test.dart

@@ -6,6 +6,7 @@ import 'package:stream_chat/src/core/models/draft.dart';
 import 'package:stream_chat/src/core/models/draft_message.dart';
 import 'package:stream_chat/src/core/models/event.dart';
 import 'package:stream_chat/src/core/models/filter.dart';
+import 'package:stream_chat/src/core/models/location.dart';
 import 'package:stream_chat/src/core/models/member.dart';
 import 'package:stream_chat/src/core/models/message.dart';
 import 'package:stream_chat/src/core/models/poll.dart';
@@ -176,6 +177,22 @@ class TestPersistenceClient extends ChatPersistenceClient {
 
   @override
   Future<void> updateDraftMessages(List<Draft> draftMessages) => Future.value();
+
+  @override
+  Future<List<Location>> getLocationsByCid(String cid) async => [];
+
+  @override
+  Future<Location?> getLocationByMessageId(String messageId) async => null;
+
+  @override
+  Future<void> updateLocations(List<Location> locations) => Future.value();
+
+  @override
+  Future<void> deleteLocationsByCid(String cid) => Future.value();
+
+  @override
+  Future<void> deleteLocationsByMessageIds(List<String> messageIds) =>
+      Future.value();
 }
 
 void main() {

packages/stream_chat_persistence/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Upcoming Beta
+
+- Added support for `Location` entity in the database.
+
 ## Upcoming
 
 🐞 Fixed

packages/stream_chat_persistence/lib/src/dao/dao.dart

@@ -2,6 +2,7 @@ export 'channel_dao.dart';
 export 'channel_query_dao.dart';
 export 'connection_event_dao.dart';
 export 'draft_message_dao.dart';
+export 'location_dao.dart';
 export 'member_dao.dart';
 export 'message_dao.dart';
 export 'pinned_message_dao.dart';

packages/stream_chat_persistence/lib/src/dao/draft_message_dao.dart

@@ -18,18 +18,27 @@ class DraftMessageDao extends DatabaseAccessor<DriftChatDatabase>
   final DriftChatDatabase _db;
 
   Future<Draft> _draftFromEntity(DraftMessageEntity entity) async {
-    // We do not want to fetch the draft message of the parent and quoted
-    // message because it will create a circular dependency and will
+    // We do not want to fetch the draft and shared location of the parent and
+    // quoted message because it will create a circular dependency and will
     // result in infinite loop.
     const fetchDraft = false;
+    const fetchSharedLocation = false;
 
     final parentMessage = await switch (entity.parentId) {
-      final id? => _db.messageDao.getMessageById(id, fetchDraft: fetchDraft),
+      final id? => _db.messageDao.getMessageById(
+          id,
+          fetchDraft: fetchDraft,
+          fetchSharedLocation: fetchSharedLocation,
+        ),
       _ => null,
     };
 
     final quotedMessage = await switch (entity.quotedMessageId) {
-      final id? => _db.messageDao.getMessageById(id, fetchDraft: fetchDraft),
+      final id? => _db.messageDao.getMessageById(
+          id,
+          fetchDraft: fetchDraft,
+          fetchSharedLocation: fetchSharedLocation,
+        ),
       _ => null,
     };
 

packages/stream_chat_persistence/lib/src/dao/location_dao.dart

@@ -0,0 +1,83 @@
+// ignore_for_file: join_return_with_assignment
+
+import 'package:drift/drift.dart';
+import 'package:stream_chat/stream_chat.dart';
+import 'package:stream_chat_persistence/src/db/drift_chat_database.dart';
+import 'package:stream_chat_persistence/src/entity/locations.dart';
+import 'package:stream_chat_persistence/src/mapper/mapper.dart';
+
+part 'location_dao.g.dart';
+
+/// The Data Access Object for operations in [Locations] table.
+@DriftAccessor(tables: [Locations])
+class LocationDao extends DatabaseAccessor<DriftChatDatabase>
+    with _$LocationDaoMixin {
+  /// Creates a new location dao instance
+  LocationDao(this._db) : super(_db);
+
+  final DriftChatDatabase _db;
+
+  Future<Location> _locationFromEntity(LocationEntity entity) async {
+    // We do not want to fetch the location of the parent and quoted
+    // message because it will create a circular dependency and will
+    // result in infinite loop.
+    const fetchDraft = false;
+    const fetchSharedLocation = false;
+
+    final channel = await switch (entity.channelCid) {
+      final cid? => db.channelDao.getChannelByCid(cid),
+      _ => null,
+    };
+
+    final message = await switch (entity.messageId) {
+      final id? => _db.messageDao.getMessageById(
+          id,
+          fetchDraft: fetchDraft,
+          fetchSharedLocation: fetchSharedLocation,
+        ),
+      _ => null,
+    };
+
+    return entity.toLocation(
+      channel: channel,
+      message: message,
+    );
+  }
+
+  /// Get all locations for a channel
+  Future<List<Location>> getLocationsByCid(String cid) async {
+    final query = select(locations)..where((tbl) => tbl.channelCid.equals(cid));
+
+    final result = await query.map(_locationFromEntity).get();
+    return Future.wait(result);
+  }
+
+  /// Get location by message ID
+  Future<Location?> getLocationByMessageId(String messageId) async {
+    final query = select(locations) //
+      ..where((tbl) => tbl.messageId.equals(messageId));
+
+    final result = await query.getSingleOrNull();
+    if (result == null) return null;
+
+    return _locationFromEntity(result);
+  }
+
+  /// Update multiple locations
+  Future<void> updateLocations(List<Location> locationList) {
+    return batch(
+      (it) => it.insertAllOnConflictUpdate(
+        locations,
+        locationList.map((it) => it.toEntity()),
+      ),
+    );
+  }
+
+  /// Delete locations by channel ID
+  Future<void> deleteLocationsByCid(String cid) =>
+      (delete(locations)..where((tbl) => tbl.channelCid.equals(cid))).go();
+
+  /// Delete locations by message IDs
+  Future<void> deleteLocationsByMessageIds(List<String> messageIds) =>
+      (delete(locations)..where((tbl) => tbl.messageId.isIn(messageIds))).go();
+}

packages/stream_chat_persistence/lib/src/dao/location_dao.g.dart

@@ -39,6 +39,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
   Future<Message> _messageFromJoinRow(
     TypedResult rows, {
     bool fetchDraft = false,
+    bool fetchSharedLocation = false,
   }) async {
     final userEntity = rows.readTableOrNull(_users);
     final pinnedByEntity = rows.readTableOrNull(_pinnedByUsers);
@@ -67,6 +68,11 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
       _ => null,
     };
 
+    final sharedLocation = await switch (fetchSharedLocation) {
+      true => _db.locationDao.getLocationByMessageId(msgEntity.id),
+      _ => null,
+    };
+
     return msgEntity.toMessage(
       user: userEntity?.toUser(),
       pinnedBy: pinnedByEntity?.toUser(),
@@ -75,6 +81,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
       quotedMessage: quotedMessage,
       poll: poll,
       draft: draft,
+      sharedLocation: sharedLocation,
     );
   }
 
@@ -85,6 +92,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
   Future<Message?> getMessageById(
     String id, {
     bool fetchDraft = true,
+    bool fetchSharedLocation = true,
   }) async {
     final query = select(messages).join([
       leftOuterJoin(_users, messages.userId.equalsExp(_users.id)),
@@ -101,6 +109,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
     return _messageFromJoinRow(
       result,
       fetchDraft: fetchDraft,
+      fetchSharedLocation: fetchSharedLocation,
     );
   }
 
@@ -169,6 +178,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
   Future<List<Message>> getMessagesByCid(
     String cid, {
     bool fetchDraft = true,
+    bool fetchSharedLocation = true,
     PaginationParams? messagePagination,
   }) async {
     final query = select(messages).join([
@@ -190,6 +200,7 @@ class MessageDao extends DatabaseAccessor<DriftChatDatabase>
         (row) => _messageFromJoinRow(
           row,
           fetchDraft: fetchDraft,
+          fetchSharedLocation: fetchSharedLocation,
         ),
       ),
     );

packages/stream_chat_persistence/lib/src/dao/message_dao.dart

@@ -38,6 +38,7 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
   Future<Message> _messageFromJoinRow(
     TypedResult rows, {
     bool fetchDraft = false,
+    bool fetchSharedLocation = false,
   }) async {
     final userEntity = rows.readTableOrNull(_users);
     final pinnedByEntity = rows.readTableOrNull(_pinnedByUsers);
@@ -68,6 +69,11 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
       _ => null,
     };
 
+    final sharedLocation = await switch (fetchSharedLocation) {
+      true => _db.locationDao.getLocationByMessageId(msgEntity.id),
+      _ => null,
+    };
+
     return msgEntity.toMessage(
       user: userEntity?.toUser(),
       pinnedBy: pinnedByEntity?.toUser(),
@@ -76,13 +82,15 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
       quotedMessage: quotedMessage,
       poll: poll,
       draft: draft,
+      sharedLocation: sharedLocation,
     );
   }
 
   /// Returns a single message by matching the [PinnedMessages.id] with [id]
   Future<Message?> getMessageById(
     String id, {
     bool fetchDraft = true,
+    bool fetchSharedLocation = true,
   }) async {
     final query = select(pinnedMessages).join([
       leftOuterJoin(_users, pinnedMessages.userId.equalsExp(_users.id)),
@@ -99,6 +107,7 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
     return _messageFromJoinRow(
       result,
       fetchDraft: fetchDraft,
+      fetchSharedLocation: fetchSharedLocation,
     );
   }
 
@@ -166,6 +175,7 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
   Future<List<Message>> getMessagesByCid(
     String cid, {
     bool fetchDraft = true,
+    bool fetchSharedLocation = true,
     PaginationParams? messagePagination,
   }) async {
     final query = select(pinnedMessages).join([
@@ -188,6 +198,7 @@ class PinnedMessageDao extends DatabaseAccessor<DriftChatDatabase>
         (row) => _messageFromJoinRow(
           row,
           fetchDraft: fetchDraft,
+          fetchSharedLocation: fetchSharedLocation,
         ),
       ),
     );

packages/stream_chat_persistence/lib/src/dao/pinned_message_dao.dart

@@ -13,6 +13,7 @@ part 'drift_chat_database.g.dart';
   tables: [
     Channels,
     DraftMessages,
+    Locations,
     Messages,
     PinnedMessages,
     Polls,
@@ -30,6 +31,7 @@ part 'drift_chat_database.g.dart';
     ChannelDao,
     MessageDao,
     DraftMessageDao,
+    LocationDao,
     PinnedMessageDao,
     PinnedMessageReactionDao,
     MemberDao,
@@ -55,7 +57,7 @@ class DriftChatDatabase extends _$DriftChatDatabase {
 
   // you should bump this number whenever you change or add a table definition.
   @override
-  int get schemaVersion => 22;
+  int get schemaVersion => 1000 + 23;
 
   @override
   MigrationStrategy get migration => MigrationStrategy(