Custom collection names (#33)

* Custom collection names

* Fixes after PR

Co-authored-by: Alex Demchenko <[email protected]>

Author: Voidozzer

lib/flutter_firebase_chat_core.dart

@@ -1,4 +1,5 @@
 library flutter_firebase_chat_core;
 
 export 'src/firebase_chat_core.dart';
+export 'src/firebase_chat_core_config.dart';
 export 'src/util.dart';

lib/src/firebase_chat_core.dart

@@ -1,6 +1,7 @@
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:firebase_auth/firebase_auth.dart';
 import 'package:flutter_chat_types/flutter_chat_types.dart' as types;
+import 'firebase_chat_core_config.dart';
 import 'util.dart';
 
 /// Provides access to Firebase chat data. Singleton, use
@@ -12,6 +13,13 @@ class FirebaseChatCore {
     });
   }
 
+  /// Config to set custom names for rooms and users collections. Also
+  /// see [FirebaseChatCoreConfig].
+  FirebaseChatCoreConfig config = const FirebaseChatCoreConfig(
+    'rooms',
+    'users',
+  );
+
   /// Current logged in user in Firebase. Does not update automatically.
   /// Use [FirebaseAuth.authStateChanges] to listen to the state changes.
   User? firebaseUser = FirebaseAuth.instance.currentUser;
@@ -20,6 +28,12 @@ class FirebaseChatCore {
   static final FirebaseChatCore instance =
       FirebaseChatCore._privateConstructor();
 
+  /// Sets custom config to change default names for rooms
+  /// and users collcetions. Also see [FirebaseChatCoreConfig].
+  void setConfig(FirebaseChatCoreConfig firebaseChatCoreConfig) {
+    config = firebaseChatCoreConfig;
+  }
+
   /// Creates a chat group room with [users]. Creator is automatically
   /// added to the group. [name] is required and will be used as
   /// a group name. Add an optional [imageUrl] that will be a group avatar
@@ -32,10 +46,16 @@ class FirebaseChatCore {
   }) async {
     if (firebaseUser == null) return Future.error('User does not exist');
 
-    final currentUser = await fetchUser(firebaseUser!.uid);
+    final currentUser = await fetchUser(
+      firebaseUser!.uid,
+      config.usersCollectionName,
+    );
+
     final roomUsers = [types.User.fromJson(currentUser)] + users;
 
-    final room = await FirebaseFirestore.instance.collection('rooms').add({
+    final room = await FirebaseFirestore.instance
+        .collection(config.roomsCollectionName)
+        .add({
       'createdAt': FieldValue.serverTimestamp(),
       'imageUrl': imageUrl,
       'metadata': metadata,
@@ -73,11 +93,12 @@ class FirebaseChatCore {
     if (fu == null) return Future.error('User does not exist');
 
     final query = await FirebaseFirestore.instance
-        .collection('rooms')
+        .collection(config.roomsCollectionName)
         .where('userIds', arrayContains: fu.uid)
         .get();
 
-    final rooms = await processRoomsQuery(fu, query);
+    final rooms =
+        await processRoomsQuery(fu, query, config.usersCollectionName);
 
     try {
       return rooms.firstWhere((room) {
@@ -91,10 +112,16 @@ class FirebaseChatCore {
       // Create a new room instead
     }
 
-    final currentUser = await fetchUser(fu.uid);
+    final currentUser = await fetchUser(
+      fu.uid,
+      config.usersCollectionName,
+    );
+
     final users = [types.User.fromJson(currentUser), otherUser];
 
-    final room = await FirebaseFirestore.instance.collection('rooms').add({
+    final room = await FirebaseFirestore.instance
+        .collection(config.roomsCollectionName)
+        .add({
       'createdAt': FieldValue.serverTimestamp(),
       'imageUrl': null,
       'metadata': metadata,
@@ -116,7 +143,10 @@ class FirebaseChatCore {
   /// Creates [types.User] in Firebase to store name and avatar used on
   /// rooms list
   Future<void> createUserInFirestore(types.User user) async {
-    await FirebaseFirestore.instance.collection('users').doc(user.id).set({
+    await FirebaseFirestore.instance
+        .collection(config.usersCollectionName)
+        .doc(user.id)
+        .set({
       'createdAt': FieldValue.serverTimestamp(),
       'firstName': user.firstName,
       'imageUrl': user.imageUrl,
@@ -130,13 +160,16 @@ class FirebaseChatCore {
 
   /// Removes [types.User] from `users` collection in Firebase
   Future<void> deleteUserFromFirestore(String userId) async {
-    await FirebaseFirestore.instance.collection('users').doc(userId).delete();
+    await FirebaseFirestore.instance
+        .collection(config.usersCollectionName)
+        .doc(userId)
+        .delete();
   }
 
   /// Returns a stream of messages from Firebase for a given room
   Stream<List<types.Message>> messages(types.Room room) {
     return FirebaseFirestore.instance
-        .collection('rooms/${room.id}/messages')
+        .collection('${config.roomsCollectionName}/${room.id}/messages')
         .orderBy('createdAt', descending: true)
         .snapshots()
         .map(
@@ -169,10 +202,12 @@ class FirebaseChatCore {
     if (fu == null) return const Stream.empty();
 
     return FirebaseFirestore.instance
-        .collection('rooms')
+        .collection(config.roomsCollectionName)
         .doc(roomId)
         .snapshots()
-        .asyncMap((doc) => processRoomDocument(doc, fu));
+        .asyncMap(
+          (doc) => processRoomDocument(doc, fu, config.usersCollectionName),
+        );
   }
 
   /// Returns a stream of rooms from Firebase. Only rooms where current
@@ -192,16 +227,20 @@ class FirebaseChatCore {
 
     final collection = orderByUpdatedAt
         ? FirebaseFirestore.instance
-            .collection('rooms')
+            .collection(config.roomsCollectionName)
             .where('userIds', arrayContains: fu.uid)
             .orderBy('updatedAt', descending: true)
         : FirebaseFirestore.instance
-            .collection('rooms')
+            .collection(config.roomsCollectionName)
             .where('userIds', arrayContains: fu.uid);
 
-    return collection
-        .snapshots()
-        .asyncMap((query) => processRoomsQuery(fu, query));
+    return collection.snapshots().asyncMap(
+          (query) => processRoomsQuery(
+            fu,
+            query,
+            config.usersCollectionName,
+          ),
+        );
   }
 
   /// Sends a message to the Firestore. Accepts any partial message and a
@@ -246,7 +285,7 @@ class FirebaseChatCore {
       messageMap['updatedAt'] = FieldValue.serverTimestamp();
 
       await FirebaseFirestore.instance
-          .collection('rooms/$roomId/messages')
+          .collection('${config.roomsCollectionName}/$roomId/messages')
           .add(messageMap);
     }
   }
@@ -264,15 +303,18 @@ class FirebaseChatCore {
     messageMap['updatedAt'] = FieldValue.serverTimestamp();
 
     await FirebaseFirestore.instance
-        .collection('rooms/$roomId/messages')
+        .collection('${config.roomsCollectionName}/$roomId/messages')
         .doc(message.id)
         .update(messageMap);
   }
 
   /// Returns a stream of all users from Firebase
   Stream<List<types.User>> users() {
     if (firebaseUser == null) return const Stream.empty();
-    return FirebaseFirestore.instance.collection('users').snapshots().map(
+    return FirebaseFirestore.instance
+        .collection(config.usersCollectionName)
+        .snapshots()
+        .map(
           (snapshot) => snapshot.docs.fold<List<types.User>>(
             [],
             (previousValue, doc) {

lib/src/firebase_chat_core_config.dart

@@ -0,0 +1,20 @@
+import 'package:meta/meta.dart';
+
+/// Class that represents the chat config. Can be used for setting custom names
+/// for rooms and users collections. Call [FirebaseChatCore.instance.setConfig]
+/// before doing anything else with [FirebaseChatCore.instance] if you want to
+/// change the default collection names. When using custom names don't forget
+/// to update your security rules and indexes.
+@immutable
+class FirebaseChatCoreConfig {
+  const FirebaseChatCoreConfig(
+    this.roomsCollectionName,
+    this.usersCollectionName,
+  );
+
+  /// Property to set rooms collection name
+  final String roomsCollectionName;
+
+  /// Property to set users collection name
+  final String usersCollectionName;
+}

lib/src/util.dart

@@ -19,9 +19,15 @@ extension RoomTypeToShortString on types.RoomType {
 }
 
 /// Fetches user from Firebase and returns a promise
-Future<Map<String, dynamic>> fetchUser(String userId, {String? role}) async {
-  final doc =
-      await FirebaseFirestore.instance.collection('users').doc(userId).get();
+Future<Map<String, dynamic>> fetchUser(
+  String userId,
+  String usersCollectionName, {
+  String? role,
+}) async {
+  final doc = await FirebaseFirestore.instance
+      .collection(usersCollectionName)
+      .doc(userId)
+      .get();
 
   final data = doc.data()!;
 
@@ -39,9 +45,14 @@ Future<Map<String, dynamic>> fetchUser(String userId, {String? role}) async {
 Future<List<types.Room>> processRoomsQuery(
   User firebaseUser,
   QuerySnapshot<Map<String, dynamic>> query,
+  String usersCollectionName,
 ) async {
   final futures = query.docs.map(
-    (doc) => processRoomDocument(doc, firebaseUser),
+    (doc) => processRoomDocument(
+      doc,
+      firebaseUser,
+      usersCollectionName,
+    ),
   );
 
   return await Future.wait(futures);
@@ -51,6 +62,7 @@ Future<List<types.Room>> processRoomsQuery(
 Future<types.Room> processRoomDocument(
   DocumentSnapshot<Map<String, dynamic>> doc,
   User firebaseUser,
+  String usersCollectionName,
 ) async {
   final data = doc.data()!;
 
@@ -68,6 +80,7 @@ Future<types.Room> processRoomDocument(
     userIds.map(
       (userId) => fetchUser(
         userId as String,
+        usersCollectionName,
         role: userRoles?[userId] as String?,
       ),
     ),