Merge pull request #902 from GetStream/feat/reaction_score

feat(llc): Exposed score as a param for sendReaction function in client & channel

packages/stream_chat/CHANGELOG.md

@@ -1,9 +1,12 @@
 ## Upcoming
 
+✅ Added
+
+- You can now pass `score` to `client.sendReaction` and `channel.sendReaction` functions
+
 🐞 Fixed
 
 - [[#890]](https://github.com/GetStream/stream-chat-flutter/pull/890). Fixed Reactions not updating on thread messages. Thanks [bstolinski](https://github.com/bstolinski).
-- 
 ## 3.4.0
 
 🐞 Fixed

packages/stream_chat/lib/src/client/channel.dart

@@ -811,6 +811,7 @@ class Channel {
   Future<SendReactionResponse> sendReaction(
     Message message,
     String type, {
+    int score = 1,
     Map<String, Object?> extraData = const {},
     bool enforceUnique = false,
   }) async {
@@ -829,7 +830,7 @@ class Channel {
       createdAt: now,
       type: type,
       user: user,
-      score: 1,
+      score: score,
       extraData: extraData,
     );
 
@@ -866,6 +867,7 @@ class Channel {
       final reactionResp = await _client.sendReaction(
         messageId,
         type,
+        score: score,
         extraData: extraData,
         enforceUnique: enforceUnique,
       );

packages/stream_chat/lib/src/client/client.dart

@@ -1157,15 +1157,22 @@ class StreamChatClient {
   Future<SendReactionResponse> sendReaction(
     String messageId,
     String reactionType, {
+    int score = 1,
     Map<String, Object?> extraData = const {},
     bool enforceUnique = false,
-  }) =>
-      _chatApi.message.sendReaction(
-        messageId,
-        reactionType,
-        extraData: extraData,
-        enforceUnique: enforceUnique,
-      );
+  }) {
+    final _extraData = {
+      'score': score,
+      ...extraData,
+    };
+
+    return _chatApi.message.sendReaction(
+      messageId,
+      reactionType,
+      extraData: _extraData,
+      enforceUnique: enforceUnique,
+    );
+  }
 
   /// Delete a [reactionType] from this [messageId]
   Future<EmptyResponse> deleteReaction(

packages/stream_chat/test/src/client/channel_test.dart

@@ -1116,6 +1116,135 @@ void main() {
         verify(() => client.sendReaction(message.id, type)).called(1);
       });
 
+      test('should work fine with score passed explicitly', () async {
+        const type = 'test-reaction-type';
+        final message = Message(id: 'test-message-id');
+
+        const score = 5;
+        final reaction = Reaction(
+          type: type,
+          messageId: message.id,
+          score: score,
+        );
+
+        when(() => client.sendReaction(
+              message.id,
+              type,
+              score: score,
+            )).thenAnswer(
+          (_) async => SendReactionResponse()
+            ..message = message
+            ..reaction = reaction,
+        );
+
+        expectLater(
+          // skipping first seed message list -> [] messages
+          channel.state?.messagesStream.skip(1),
+          emitsInOrder([
+            [
+              isSameMessageAs(
+                message.copyWith(
+                  status: MessageSendingStatus.sent,
+                  reactionCounts: {type: 1},
+                  reactionScores: {type: score},
+                  latestReactions: [reaction],
+                  ownReactions: [reaction],
+                ),
+                matchReactions: true,
+                matchSendingStatus: true,
+              ),
+            ],
+          ]),
+        );
+
+        final res = await channel.sendReaction(
+          message,
+          type,
+          score: score,
+        );
+
+        expect(res, isNotNull);
+        expect(res.reaction.type, type);
+        expect(res.reaction.messageId, message.id);
+        expect(res.reaction.score, score);
+
+        verify(() => client.sendReaction(
+              message.id,
+              type,
+              score: score,
+            )).called(1);
+      });
+
+      test('should work fine with score passed explicitly and in extraData',
+          () async {
+        const type = 'test-reaction-type';
+        final message = Message(id: 'test-message-id');
+
+        const score = 5;
+        const extraDataScore = 3;
+        const extraData = {
+          'score': extraDataScore,
+        };
+        final reaction = Reaction(
+          type: type,
+          messageId: message.id,
+          score: extraDataScore,
+        );
+
+        when(() => client.sendReaction(
+              message.id,
+              type,
+              score: score,
+              extraData: extraData,
+            )).thenAnswer(
+          (_) async => SendReactionResponse()
+            ..message = message
+            ..reaction = reaction,
+        );
+
+        expectLater(
+          // skipping first seed message list -> [] messages
+          channel.state?.messagesStream.skip(1),
+          emitsInOrder([
+            [
+              isSameMessageAs(
+                message.copyWith(
+                  status: MessageSendingStatus.sent,
+                  reactionCounts: {type: 1},
+                  reactionScores: {type: extraDataScore},
+                  latestReactions: [reaction],
+                  ownReactions: [reaction],
+                ),
+                matchReactions: true,
+                matchSendingStatus: true,
+              ),
+            ],
+          ]),
+        );
+
+        final res = await channel.sendReaction(
+          message,
+          type,
+          score: score,
+          extraData: extraData,
+        );
+
+        expect(res, isNotNull);
+        expect(res.reaction.type, type);
+        expect(res.reaction.messageId, message.id);
+        expect(
+          res.reaction.score,
+          extraDataScore,
+        );
+
+        verify(() => client.sendReaction(
+              message.id,
+              type,
+              score: score,
+              extraData: extraData,
+            )).called(1);
+      });
+
       test(
         'should restore previous message if `client.sendReaction` throws',
         () async {

packages/stream_chat/test/src/client/client_test.dart

@@ -1956,23 +1956,109 @@ void main() {
       verifyNoMoreInteractions(api.channel);
     });
 
-    test('`.sendReaction`', () async {
-      const messageId = 'test-message-id';
-      const reactionType = 'like';
+    group('`.sendReaction`', () {
+      test('`.sendReaction with default params`', () async {
+        const messageId = 'test-message-id';
+        const reactionType = 'like';
+        const extraData = {'score': 1};
 
-      when(() => api.message.sendReaction(messageId, reactionType))
-          .thenAnswer((_) async => SendReactionResponse()
-            ..message = Message(id: messageId)
-            ..reaction = Reaction(type: reactionType, messageId: messageId));
+        when(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).thenAnswer((_) async => SendReactionResponse()
+          ..message = Message(id: messageId)
+          ..reaction = Reaction(type: reactionType, messageId: messageId));
 
-      final res = await client.sendReaction(messageId, reactionType);
-      expect(res, isNotNull);
-      expect(res.message.id, messageId);
-      expect(res.reaction.type, reactionType);
-      expect(res.reaction.messageId, messageId);
+        final res = await client.sendReaction(messageId, reactionType);
+        expect(res, isNotNull);
+        expect(res.message.id, messageId);
+        expect(res.reaction.type, reactionType);
+        expect(res.reaction.messageId, messageId);
 
-      verify(() => api.message.sendReaction(messageId, reactionType)).called(1);
-      verifyNoMoreInteractions(api.message);
+        verify(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).called(1);
+        verifyNoMoreInteractions(api.message);
+      });
+
+      test('`.sendReaction with score`', () async {
+        const messageId = 'test-message-id';
+        const reactionType = 'like';
+        const score = 3;
+        const extraData = {'score': score};
+
+        when(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).thenAnswer((_) async => SendReactionResponse()
+          ..message = Message(id: messageId)
+          ..reaction = Reaction(
+            type: reactionType,
+            messageId: messageId,
+            score: score,
+          ));
+
+        final res = await client.sendReaction(
+          messageId,
+          reactionType,
+          score: score,
+        );
+        expect(res, isNotNull);
+        expect(res.message.id, messageId);
+        expect(res.reaction.type, reactionType);
+        expect(res.reaction.messageId, messageId);
+        expect(res.reaction.score, score);
+
+        verify(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).called(1);
+        verifyNoMoreInteractions(api.message);
+      });
+
+      test('`.sendReaction with score passed in extradata also`', () async {
+        const messageId = 'test-message-id';
+        const reactionType = 'like';
+        const score = 3;
+        const extraDataScore = 5;
+        const extraData = {'score': extraDataScore};
+
+        when(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).thenAnswer((_) async => SendReactionResponse()
+          ..message = Message(id: messageId)
+          ..reaction = Reaction(
+            type: reactionType,
+            messageId: messageId,
+            score: extraDataScore,
+          ));
+
+        final res = await client.sendReaction(
+          messageId,
+          reactionType,
+          score: score,
+          extraData: extraData,
+        );
+        expect(res, isNotNull);
+        expect(res.message.id, messageId);
+        expect(res.reaction.type, reactionType);
+        expect(res.reaction.messageId, messageId);
+        expect(res.reaction.score, extraDataScore);
+
+        verify(() => api.message.sendReaction(
+              messageId,
+              reactionType,
+              extraData: extraData,
+            )).called(1);
+        verifyNoMoreInteractions(api.message);
+      });
     });
 
     test('`.deleteReaction`', () async {