Merge pull request #7182 from nextcloud/backport/7173/stable24

[stable24] Move message.reactions.self to message.reactionsSelf to not merge different data structures
nextcloud · Apr 20, 2022 · f1ee819 · f1ee819
2 parents 34f3ad1 + 3061fb3
commit f1ee819
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 29 deletions.
diff --git a/docs/chat.md b/docs/chat.md
@@ -51,7 +51,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
         `messageParameters` | array | Message parameters for `message` (see [Rich Object String](https://github.com/nextcloud/server/issues/1706))
         `parent` | array | **Optional:** See `Parent data` below
         `reactions` | array | **Optional:** An array map with relation between reaction emoji and total count of reactions with this emoji
-        `reactions`.`self` | array | **Optional:** When the user reacted the reactions array will have an entry `self` with the list of emojis the user reacted with
+        `reactionsSelf` | array | **Optional:** When the user reacted this is the list of emojis the user reacted with
 
 #### Parent data
 

diff --git a/lib/Controller/ChatController.php b/lib/Controller/ChatController.php
@@ -555,14 +555,14 @@ protected function loadSelfReactions(array $messages, array $commentIdToIndex):
 		// Inject the reactions self into the $messages array
 		foreach ($reactionsById as $messageId => $reactions) {
 			if (isset($messages[$commentIdToIndex[$messageId]])) {
-				$messages[$commentIdToIndex[$messageId]]['reactions']['self'] = $reactions;
+				$messages[$commentIdToIndex[$messageId]]['reactionsSelf'] = $reactions;
 			}
 
 			// Add the self part also to potential parent elements
 			if (isset($parentMap[$messageId])) {
 				foreach ($parentMap[$messageId] as $mid) {
 					if (isset($messages[$commentIdToIndex[$mid]])) {
-						$messages[$commentIdToIndex[$mid]]['parent']['reactions']['self'] = $reactions;
+						$messages[$commentIdToIndex[$mid]]['parent']['reactionsSelf'] = $reactions;
 					}
 				}
 			}

diff --git a/src/components/MessagesList/MessagesGroup/Message/Message.spec.js b/src/components/MessagesList/MessagesGroup/Message/Message.spec.js
@@ -817,10 +817,8 @@ describe('Message.vue', () => {
 			store = new Store(testStoreConfig)
 
 			const messagePropsWithReactions = Object.assign({}, messageProps)
-			messagePropsWithReactions.reactions = {
-				'👍': 1,
-				self: ['👍'],
-			}
+			messagePropsWithReactions.reactions = { '👍': 1 }
+			messagePropsWithReactions.reactionsSelf = ['👍']
 
 			const wrapper = shallowMount(Message, {
 				localVue,
@@ -855,10 +853,8 @@ describe('Message.vue', () => {
 			store = new Store(testStoreConfig)
 
 			const messagePropsWithReactions = Object.assign({}, messageProps)
-			messagePropsWithReactions.reactions = {
-				'❤️': 1,
-				self: ['❤️'],
-			}
+			messagePropsWithReactions.reactions = { '❤️': 1 }
+			messagePropsWithReactions.reactionsSelf = ['❤️']
 
 			const wrapper = shallowMount(Message, {
 				localVue,

diff --git a/src/components/MessagesList/MessagesGroup/Message/Message.vue b/src/components/MessagesList/MessagesGroup/Message/Message.vue
@@ -350,6 +350,11 @@ export default {
 			type: [Array, Object],
 			default: () => { return {} },
 		},
+
+		reactionsSelf: {
+			type: Array,
+			default: () => { return [] },
+		},
 	},
 
 	data() {
@@ -567,12 +572,7 @@ export default {
 		},
 
 		simpleReactions() {
-			const reactions = Object.assign({}, this.messageObject.reactions)
-			if (reactions?.self) {
-				// Remove the self entry for the rendering
-				delete reactions.self
-			}
-			return reactions
+			return this.messageObject.reactions
 		},
 
 		detailedReactions() {
@@ -610,7 +610,7 @@ export default {
 
 	methods: {
 		userHasReacted(reaction) {
-			return this.reactions?.self && this.reactions.self.indexOf(reaction) !== -1
+			return this.reactionsSelf && this.reactionsSelf.indexOf(reaction) !== -1
 		},
 
 		lastReadMessageVisibilityChanged(isVisible) {

diff --git a/src/store/messagesStore.js b/src/store/messagesStore.js
@@ -356,10 +356,10 @@ const mutations = {
 		const reactionCount = state.messages[token][messageId].reactions[reaction] + 1
 		Vue.set(state.messages[token][messageId].reactions, reaction, reactionCount)
 
-		if (!state.messages[token][messageId].reactions.self) {
-			Vue.set(state.messages[token][messageId].reactions, 'self', [reaction])
+		if (!state.messages[token][messageId].reactionsSelf) {
+			Vue.set(state.messages[token][messageId], 'reactionsSelf', [reaction])
 		} else {
-			state.messages[token][messageId].reactions.self.push(reaction)
+			state.messages[token][messageId].reactionsSelf.push(reaction)
 		}
 	},
 
@@ -371,10 +371,10 @@ const mutations = {
 			Vue.delete(state.messages[token][messageId].reactions, reaction)
 		}
 
-		if (state.messages[token][messageId].reactions.self) {
-			const i = state.messages[token][messageId].reactions.self.indexOf(reaction)
+		if (state.messages[token][messageId].reactionsSelf) {
+			const i = state.messages[token][messageId].reactionsSelf.indexOf(reaction)
 			if (i !== -1) {
-				Vue.delete(state.messages[token][messageId].reactions, 'self', i)
+				Vue.delete(state.messages[token][messageId], 'reactionsSelf', i)
 			}
 		}
 	},

diff --git a/tests/integration/features/bootstrap/FeatureContext.php b/tests/integration/features/bootstrap/FeatureContext.php
@@ -1678,6 +1678,7 @@ protected function compareDataResponse(TableNode $formData = null) {
 		$includeParents = in_array('parentMessage', $formData->getRow(0), true);
 		$includeReferenceId = in_array('referenceId', $formData->getRow(0), true);
 		$includeReactions = in_array('reactions', $formData->getRow(0), true);
+		$includeReactionsSelf = in_array('reactionsSelf', $formData->getRow(0), true);
 
 		$count = count($formData->getHash());
 		Assert::assertCount($count, $messages, 'Message count does not match');
@@ -1686,7 +1687,7 @@ protected function compareDataResponse(TableNode $formData = null) {
 				$messages[$i]['messageParameters'] = 'IGNORE';
 			}
 		}
-		Assert::assertEquals($formData->getHash(), array_map(function ($message) use ($includeParents, $includeReferenceId, $includeReactions) {
+		Assert::assertEquals($formData->getHash(), array_map(function ($message) use ($includeParents, $includeReferenceId, $includeReactions, $includeReactionsSelf) {
 			$data = [
 				'room' => self::$tokenToIdentifier[$message['token']],
 				'actorType' => $message['actorType'],
@@ -1706,6 +1707,13 @@ protected function compareDataResponse(TableNode $formData = null) {
 			if ($includeReactions) {
 				$data['reactions'] = json_encode($message['reactions'], JSON_UNESCAPED_UNICODE);
 			}
+			if ($includeReactionsSelf) {
+				if (isset($message['reactionsSelf'])) {
+					$data['reactionsSelf'] = json_encode($message['reactionsSelf'], JSON_UNESCAPED_UNICODE);
+				} else {
+					$data['reactionsSelf'] = null;
+				}
+			}
 			return $data;
 		}, $messages));
 	}

diff --git a/tests/integration/features/reaction/react.feature b/tests/integration/features/reaction/react.feature
@@ -18,16 +18,16 @@ Feature: reaction/react
       | room | users     | participant1 | participant1-displayname | user_added |
       | room | users     | participant1 | participant1-displayname | conversation_created |
     Then user "participant1" sees the following messages in room "room" with 200
-      | room | actorType | actorId      | actorDisplayName         | message   | messageParameters | reactions |
-      | room | users     | participant1 | participant1-displayname | Message 1 | []                | {"👍":1}  |
+      | room | actorType | actorId      | actorDisplayName         | message   | messageParameters | reactions | reactionsSelf |
+      | room | users     | participant1 | participant1-displayname | Message 1 | []                | {"👍":1}  |               |
     And user "participant1" react with "👍" on message "Message 1" to room "room" with 201
       | actorType | actorId      | actorDisplayName         | reaction |
       | users     | participant1 | participant1-displayname | 👍       |
       | users     | participant2 | participant2-displayname | 👍       |
     And user "participant1" react with "🚀" on message "Message 1" to room "room" with 201
     Then user "participant1" sees the following messages in room "room" with 200
-      | room | actorType | actorId      | actorDisplayName         | message   | messageParameters | reactions |
-      | room | users     | participant1 | participant1-displayname | Message 1 | []                | {"👍":2,"🚀":1,"self":["👍","🚀"]} |
+      | room | actorType | actorId      | actorDisplayName         | message   | messageParameters | reactions       | reactionsSelf |
+      | room | users     | participant1 | participant1-displayname | Message 1 | []                | {"👍":2,"🚀":1} | ["👍","🚀"]   |
     Then user "participant1" sees the following system messages in room "room" with 200
       | room | actorType | actorId      | actorDisplayName         | systemMessage |
       | room | users     | participant1 | participant1-displayname | reaction |