fix: recipient label should not contain email address

kesselb · backportbot[bot] · commit 66d11a2ffe81 · 2025-02-14T09:55:11.000Z
Signed-off-by: Daniel Kesselberg &lt;mail@danielkesselberg.de&gt;
diff --git a/lib/Service/AutoCompletion/AutoCompleteService.php b/lib/Service/AutoCompletion/AutoCompleteService.php
@@ -55,6 +55,7 @@ public function findMatches(string $userId, string $term): array {
 				'id' => $address->getId(),
 				'label' => $address->getDisplayName(),
 				'email' => $address->getEmail(),
+				'source' => 'collector',
 			];
 		}, $fromCollector);
 
diff --git a/lib/Service/ContactsIntegration.php b/lib/Service/ContactsIntegration.php
@@ -141,9 +141,10 @@ public function getMatchingRecipient(string $userId, string $term): array {
 				$receivers[] = [
 					'id' => $id,
 					// Show full name if possible or fall back to email
-					'label' => (empty($fn) ? $e : "$fn ($e)"),
+					'label' => $fn,
 					'email' => $e,
 					'photo' => $photo,
+					'source' => 'contacts',
 				];
 			}
 		}
diff --git a/lib/Service/GroupsIntegration.php b/lib/Service/GroupsIntegration.php
@@ -66,6 +66,7 @@ public function getMatchingGroups(string $term): array {
 					'label' => $g['name'] . " (" . $gs->getNamespace() . ")",
 					'email' => $gid,
 					'photo' => null,
+					'source' => 'groups',
 				];
 			}
 		}
diff --git a/src/components/Composer.vue b/src/components/Composer.vue
@@ -71,7 +71,7 @@
 						<div class="multiselect__tag multiselect__tag-custom">
 							<ListItemIcon :no-margin="true"
 								:name="option.label"
-								:subname="showEmailAsSubname(option)"
+								:subname="getSubnameForRecipient(option)"
 								:icon-class="!option.id ? 'icon-user' : null"
 								:url="option.photo" />
 						</div>
@@ -127,7 +127,7 @@
 						<div class="multiselect__tag multiselect__tag-custom">
 							<ListItemIcon :no-margin="true"
 								:name="option.label"
-								:subname="showEmailAsSubname(option)"
+								:subname="getSubnameForRecipient(option)"
 								:url="option.photo"
 								:icon-class="!option.id ? 'icon-user' : null" />
 						</div>
@@ -177,7 +177,7 @@
 						<div class="multiselect__tag multiselect__tag-custom">
 							<ListItemIcon :no-margin="true"
 								:name="option.label"
-								:subname="showEmailAsSubname(option)"
+								:subname="getSubnameForRecipient(option)"
 								:url="option.photo"
 								:icon-class="!option.id ? 'icon-user' : null" />
 						</div>
@@ -1376,15 +1376,24 @@ export default {
 		},
 
 		/**
-		 * Use the email address as subname if we have label
+		 * Return the subname for recipient suggestion.
+		 *
+		 * Empty if label and email are the same or
+		 * if the suggestion is a group.
 		 *
 		 * @param {{email: string, label: string}} option
 		 * @return string
 		 */
-		showEmailAsSubname(option) {
-			return (option.label === option.email)
-				? ''
-				: option.email
+		getSubnameForRecipient(option) {
+			if (option.source && option.source === 'groups') {
+				return ''
+			}
+
+			if (option.label === option.email) {
+				return ''
+			}
+
+			return option.email
 		},
 	},
 }
diff --git a/tests/Unit/Service/Autocompletion/AutoCompleteServiceTest.php b/tests/Unit/Service/Autocompletion/AutoCompleteServiceTest.php
@@ -51,8 +51,8 @@ public function testFindMatches() {
 		$term = 'jo';
 
 		$contactsResult = [
-			['id' => 12, 'label' => '"john doe" <john@doe.cz>', 'email' => 'john@doe.cz'],
-			['id' => 13, 'label' => '"joe doe" <joe@doe.se>', 'email' => 'joe@doe.se'],
+			['id' => 12, 'label' => '"john doe" <john@doe.cz>', 'email' => 'john@doe.cz', 'source' => 'contacts'],
+			['id' => 13, 'label' => '"joe doe" <joe@doe.se>', 'email' => 'joe@doe.se', 'source' => 'contacts'],
 		];
 		$john = new CollectedAddress();
 		$john->setId(1234);
@@ -64,7 +64,7 @@ public function testFindMatches() {
 		];
 
 		$groupsResult = [
-			['id' => 20, 'label' => 'Journalists', 'email' => 'Journalists']
+			['id' => 20, 'label' => 'Journalists', 'email' => 'Journalists', 'source' => 'groups']
 		];
 
 		$this->contactsIntegration->expects($this->once())
@@ -86,10 +86,10 @@ public function testFindMatches() {
 		$response = $this->service->findMatches('testuser', $term);
 
 		$expected = [
-			['id' => 12, 'label' => '"john doe" <john@doe.cz>', 'email' => 'john@doe.cz'],
-			['id' => 13, 'label' => '"joe doe" <joe@doe.se>', 'email' => 'joe@doe.se'],
-			['id' => 1234, 'label' => 'John Doe', 'email' => 'john@doe.com'],
-			['id' => 20, 'label' => 'Journalists', 'email' => 'Journalists'],
+			['id' => 12, 'label' => '"john doe" <john@doe.cz>', 'email' => 'john@doe.cz', 'source' => 'contacts'],
+			['id' => 13, 'label' => '"joe doe" <joe@doe.se>', 'email' => 'joe@doe.se', 'source' => 'contacts'],
+			['id' => 1234, 'label' => 'John Doe', 'email' => 'john@doe.com', 'source' => 'collector'],
+			['id' => 20, 'label' => 'Journalists', 'email' => 'Journalists', 'source' => 'groups'],
 		];
 		$this->assertEquals($expected, $response);
 	}
diff --git a/tests/Unit/Service/ContactsIntegrationTest.php b/tests/Unit/Service/ContactsIntegrationTest.php
@@ -103,21 +103,24 @@ public function testGetMatchingRecipient() {
 		$expected = [
 			[
 				'id' => 'jf',
-				'label' => 'Jonathan Frakes (jonathan@frakes.com)',
+				'label' => 'Jonathan Frakes',
 				'email' => 'jonathan@frakes.com',
 				'photo' => null,
+				'source' => 'contacts'
 			],
 			[
 				'id' => 'jd',
-				'label' => 'John Doe (john@doe.info)',
+				'label' => 'John Doe',
 				'email' => 'john@doe.info',
 				'photo' => null,
+				'source' => 'contacts'
 			],
 			[
 				'id' => 'jd',
-				'label' => 'John Doe (doe@john.info)',
+				'label' => 'John Doe',
 				'email' => 'doe@john.info',
 				'photo' => null,
+				'source' => 'contacts'
 			],
 		];
 
@@ -170,21 +173,24 @@ public function testGetMatchingRecipientRestrictedToGroup() {
 		$expected = [
 			[
 				'id' => 'jd',
-				'label' => 'John Doe (john@doe.info)',
+				'label' => 'John Doe',
 				'email' => 'john@doe.info',
 				'photo' => null,
+				'source' => 'contacts'
 			],
 			[
 				'id' => 'jd',
-				'label' => 'John Doe (doe@john.info)',
+				'label' => 'John Doe',
 				'email' => 'doe@john.info',
 				'photo' => null,
+				'source' => 'contacts',
 			],
 			[
 				'id' => 'js',
-				'label' => 'Johann Strauss II (johann@strauss.com)',
+				'label' => 'Johann Strauss II',
 				'email' => 'johann@strauss.com',
 				'photo' => null,
+				'source' => 'contacts',
 			],
 		];
 
@@ -222,9 +228,10 @@ public function testGetMatchingRecipientRestrictedToGroupFullMatchUserId() {
 		$expected = [
 			[
 				'id' => 'jf',
-				'label' => 'Jonathan Frakes (jonathan@frakes.com)',
+				'label' => 'Jonathan Frakes',
 				'email' => 'jonathan@frakes.com',
 				'photo' => null,
+				'source' => 'contacts',
 			],
 		];
 
@@ -262,9 +269,10 @@ public function testGetMatchingRecipientRestrictedToGroupFullMatchFullName() {
 		$expected = [
 			[
 				'id' => 'jf',
-				'label' => 'Jonathan Frakes (jonathan@frakes.com)',
+				'label' => 'Jonathan Frakes',
 				'email' => 'jonathan@frakes.com',
 				'photo' => null,
+				'source' => 'contacts',
 			],
 		];
 
@@ -302,9 +310,10 @@ public function testGetMatchingRecipientRestrictedToGroupFullMatchEmail() {
 		$expected = [
 			[
 				'id' => 'jf',
-				'label' => 'Jonathan Frakes (jonathan@frakes.com)',
+				'label' => 'Jonathan Frakes',
 				'email' => 'jonathan@frakes.com',
 				'photo' => null,
+				'source' => 'contacts',
 			],
 		];
 
diff --git a/tests/Unit/Service/GroupsIntegrationTest.php b/tests/Unit/Service/GroupsIntegrationTest.php
@@ -76,6 +76,7 @@ public function testGetMatchingGroups(): void {
 					'label' => 'first test group (Namespace1)',
 					'email' => 'namespace1:testgroup',
 					'photo' => null,
+					'source' => 'groups',
 				]
 			],
 			$actual

Original file line number	Diff line number	Diff line change
`@@ -141,9 +141,10 @@ public function getMatchingRecipient(string $userId, string $term): array {`
`141`	`141`	`$receivers[] = [`
`142`	`142`	`'id' => $id,`
`143`	`143`	`// Show full name if possible or fall back to email`
`144`		`- 'label' => (empty($fn) ? $e : "$fn ($e)"),`
	`144`	`+ 'label' => $fn,`
`145`	`145`	`'email' => $e,`
`146`	`146`	`'photo' => $photo,`
	`147`	`+ 'source' => 'contacts',`
`147`	`148`	`];`
`148`	`149`	`}`
`149`	`150`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ public function getMatchingGroups(string $term): array {`
`66`	`66`	`'label' => $g['name'] . " (" . $gs->getNamespace() . ")",`
`67`	`67`	`'email' => $gid,`
`68`	`68`	`'photo' => null,`
	`69`	`+ 'source' => 'groups',`
`69`	`70`	`];`
`70`	`71`	`}`
`71`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ public function testGetMatchingGroups(): void {`
`76`	`76`	`'label' => 'first test group (Namespace1)',`
`77`	`77`	`'email' => 'namespace1:testgroup',`
`78`	`78`	`'photo' => null,`
	`79`	`+ 'source' => 'groups',`
`79`	`80`	`]`
`80`	`81`	`],`
`81`	`82`	`$actual`