feat(llc, persistence): add avgResponseTime to User model (#2322)

Author: xsahil03x

packages/stream_chat/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Upcoming
 
+✅ Added
+
+- Added `avgResponseTime` field to the `User` model to track average response time in seconds.
+
 🐞 Fixed
 
 - Fixed `WebSocket` race condition where reconnection could access null user during disconnect.

packages/stream_chat/lib/src/core/models/own_user.dart

@@ -32,6 +32,7 @@ class OwnUser extends User {
     super.teams,
     super.language,
     super.teamsRole,
+    super.avgResponseTime,
   });
 
   /// Create a new instance from json.
@@ -55,6 +56,7 @@ class OwnUser extends User {
         teams: user.teams,
         language: user.language,
         teamsRole: user.teamsRole,
+        avgResponseTime: user.avgResponseTime,
       );
 
   /// Creates a copy of [OwnUser] with specified attributes overridden.
@@ -81,6 +83,7 @@ class OwnUser extends User {
     int? unreadThreads,
     String? language,
     Map<String, String>? teamsRole,
+    int? avgResponseTime,
   }) =>
       OwnUser(
         id: id ?? this.id,
@@ -107,6 +110,7 @@ class OwnUser extends User {
         blockedUserIds: blockedUserIds ?? this.blockedUserIds,
         language: language ?? this.language,
         teamsRole: teamsRole ?? this.teamsRole,
+        avgResponseTime: avgResponseTime ?? this.avgResponseTime,
       );
 
   /// Returns a new [OwnUser] that is a combination of this ownUser
@@ -135,6 +139,7 @@ class OwnUser extends User {
       updatedAt: other.updatedAt,
       language: other.language,
       teamsRole: other.teamsRole,
+      avgResponseTime: other.avgResponseTime,
     );
   }
 

packages/stream_chat/lib/src/core/models/own_user.g.dart

@@ -47,6 +47,7 @@ class User extends Equatable implements ComparableFieldProvider {
     this.teams = const [],
     this.language,
     this.teamsRole,
+    this.avgResponseTime,
   }) :
         // For backwards compatibility, set 'name', 'image' in [extraData].
         extraData = {
@@ -74,6 +75,7 @@ class User extends Equatable implements ComparableFieldProvider {
     'teams',
     'language',
     'teams_role',
+    'avg_response_time',
   ];
 
   /// User id.
@@ -143,6 +145,10 @@ class User extends Equatable implements ComparableFieldProvider {
   @JsonKey(includeIfNull: false)
   final Map< /*Team*/ String, /*Role*/ String>? teamsRole;
 
+  /// The average response time of the user in seconds.
+  @JsonKey(includeToJson: false)
+  final int? avgResponseTime;
+
   /// Map of custom user extraData.
   final Map<String, Object?> extraData;
 
@@ -171,6 +177,7 @@ class User extends Equatable implements ComparableFieldProvider {
     List<String>? teams,
     String? language,
     Map<String, String>? teamsRole,
+    int? avgResponseTime,
   }) =>
       User(
         id: id ?? this.id,
@@ -190,6 +197,7 @@ class User extends Equatable implements ComparableFieldProvider {
         teams: teams ?? this.teams,
         language: language ?? this.language,
         teamsRole: teamsRole ?? this.teamsRole,
+        avgResponseTime: avgResponseTime ?? this.avgResponseTime,
       );
 
   @override
@@ -204,6 +212,7 @@ class User extends Equatable implements ComparableFieldProvider {
         teams,
         language,
         teamsRole,
+        avgResponseTime,
       ];
 
   @override

packages/stream_chat/lib/src/core/models/user.dart

@@ -13,5 +13,7 @@
   "created_at": "2021-08-03 12:39:21.817646",
   "updated_at": "2021-08-04 12:39:21.817646",
   "last_active" : "2021-08-05 12:39:21.817646",
-  "language": "en"
+  "language": "en",
+  "teams_role": {"team-1": "admin", "team-2": "member"},
+  "avg_response_time": 120
 }

packages/stream_chat/lib/src/core/models/user.g.dart

@@ -18,6 +18,8 @@ void main() {
   const online = true;
   const banned = true;
   const teams = ['team-1', 'team-2'];
+  const teamsRole = {'team-1': 'admin', 'team-2': 'member'};
+  const avgResponseTime = 120;
   const createdAtString = '2021-08-03 12:39:21.817646';
   const updatedAtString = '2021-08-04 12:39:21.817646';
   const lastActiveString = '2021-08-05 12:39:21.817646';
@@ -41,6 +43,8 @@ void main() {
       expect(user.updatedAt, DateTime.parse(updatedAtString));
       expect(user.lastActive, DateTime.parse(lastActiveString));
       expect(user.language, 'en');
+      expect(user.teamsRole, teamsRole);
+      expect(user.avgResponseTime, avgResponseTime);
     });
 
     test('should serialize to json correctly', () {
@@ -62,6 +66,8 @@ void main() {
         online: banned,
         teams: const ['team-1', 'team-2'],
         language: 'fr',
+        teamsRole: teamsRole,
+        avgResponseTime: avgResponseTime,
       );
 
       expect(user.toJson(), {
@@ -73,6 +79,7 @@ void main() {
         'extraDataDoubleTest': extraDataDoubleTest,
         'extraDataBoolTest': extraDataBoolTest,
         'language': 'fr',
+        'teams_role': teamsRole,
       });
     });
 
@@ -91,6 +98,8 @@ void main() {
       expect(newUser.updatedAt, user.updatedAt);
       expect(newUser.lastActive, user.lastActive);
       expect(newUser.language, user.language);
+      expect(newUser.teamsRole, user.teamsRole);
+      expect(newUser.avgResponseTime, user.avgResponseTime);
 
       newUser = user.copyWith(
         id: 'test',
@@ -104,6 +113,8 @@ void main() {
         updatedAt: DateTime.parse('2021-05-04 12:39:21.817646'),
         lastActive: DateTime.parse('2021-05-06 12:39:21.817646'),
         language: 'it',
+        teamsRole: {'new-team1': 'admin', 'new-team2': 'member'},
+        avgResponseTime: 60,
       );
 
       expect(newUser.id, 'test');
@@ -118,6 +129,8 @@ void main() {
       expect(newUser.updatedAt, DateTime.parse('2021-05-04 12:39:21.817646'));
       expect(newUser.lastActive, DateTime.parse('2021-05-06 12:39:21.817646'));
       expect(newUser.language, 'it');
+      expect(newUser.teamsRole, {'new-team1': 'admin', 'new-team2': 'member'});
+      expect(newUser.avgResponseTime, 60);
     });
 
     test('name property and extraData manipulation', () {
@@ -202,6 +215,8 @@ void main() {
       expect(user.lastActive, null);
       expect(user.createdAt, null);
       expect(user.updatedAt, null);
+      expect(user.teamsRole, null);
+      expect(user.avgResponseTime, null);
     });
 
     test('default values, parse json', () {
@@ -218,6 +233,8 @@ void main() {
       expect(user.lastActive, null);
       expect(user.createdAt, null);
       expect(user.updatedAt, null);
+      expect(user.teamsRole, null);
+      expect(user.avgResponseTime, null);
     });
 
     group('ComparableFieldProvider', () {
@@ -449,6 +466,8 @@ User createTestUser({
   bool? banned,
   DateTime? lastActive,
   Map<String, Object?>? extraData,
+  Map<String, String>? teamsRole,
+  int? avgResponseTime,
 }) {
   return User(
     id: id,
@@ -457,5 +476,7 @@ User createTestUser({
     banned: banned ?? false,
     lastActive: lastActive,
     extraData: extraData ?? {},
+    teamsRole: teamsRole,
+    avgResponseTime: avgResponseTime,
   );
 }

packages/stream_chat/test/fixtures/user.json

@@ -5,6 +5,10 @@
 - Fixed draft message retrieval logic where channel drafts were incorrectly attached to all messages
   instead of only thread drafts being attached to their respective parent messages.
 
+✅ Added
+
+- Added support for `User.avgResponseTime` field.
+
 ## 9.14.0
 
 - Updated `stream_chat` dependency to [`9.14.0`](https://pub.dev/packages/stream_chat/changelog).

packages/stream_chat/test/src/core/models/user_test.dart

@@ -55,7 +55,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 => 23;
 
   @override
   MigrationStrategy get migration => MigrationStrategy(