feat(sharing): allow email-based labels for lookup results by n-iv · Pull Request #60375 · nextcloud/server

n-iv · 2026-05-14T10:08:30Z

Summary

Adds an opt-in system config flag shareapi_lookup_label_show_email that, when set to true, makes the LookupPlugin compose suggestion labels with the user's email (from the lookup server response) instead of the federation ID.

Default behavior is strictly preserved when the flag is absent or false.

Motivation

In Global Scale deployments, federation IDs are sharded across nodes (e.g. user@node05.example.org) and do not carry human-readable signal. When the sharing dialog shows two accounts of the same person who happens to be hosted on different nodes, users see:

Jane Doe (jdoe@node05.example.org)
Jane Doe (janedoe1@node10.example.org)

The node suffix is implementation detail and does not help the user pick. The email, which the lookup server already exposes in its response, is far more discriminating.

With the flag enabled, the same suggestions become:

Jane Doe (jane.doe@site-a.example)
Jane Doe (jane.doe@site-b.example)

Behavior

Flag absent or false: identical to current master.
Flag true and email present in lookup response: label uses Name (email) or email if no name.
Flag true and email missing: graceful fallback to Name (federationId) or federationId.

Tests

Updated all existing tests in LookupPluginTest to account for the new config read (exactly(3) instead of exactly(2) on getSystemValueBool).
Added testSearchWithEmailLabel covering the new path with the flag enabled and an email present in the lookup response.

When the new system config 'shareapi_lookup_label_show_email' is set to true, the LookupPlugin composes suggestion labels with the user's email (from the lookup server response) instead of the federation ID. Default behavior is strictly preserved when the flag is absent or false. Motivation: in Global Scale deployments, federation IDs carry sharded identity that is not human-readable (e.g. 'user@node05.example.org'). Operators can opt-in to email-based labels to improve UX without affecting other deployments. Signed-off-by: niv <nicolas.varlot@ac-versailles.fr>

Copilot

Pull request overview

This PR adds an opt-in system configuration flag (shareapi_lookup_label_show_email) to change how lookup-server share suggestions are labeled in Global Scale setups: when enabled and the lookup response contains an email, the suggestion label shows Name (email) instead of Name (federationId), while keeping the federation ID as the actual share target.

Changes:

Read new system config flag shareapi_lookup_label_show_email in LookupPlugin and use lookup-response email for the suggestion label when enabled.
Update existing LookupPluginTest expectations for the additional config read.
Add a new unit test covering the “email label” path when the flag is enabled and email is present.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
lib/private/Collaboration/Collaborators/LookupPlugin.php	Adds config-driven logic to compose lookup suggestion labels using email when available.
tests/lib/Collaboration/Collaborators/LookupPluginTest.php	Updates mocks for the new config read and adds a new test for the email-label behavior.

Comments suppressed due to low confidence (1)

lib/private/Collaboration/Collaborators/LookupPlugin.php:47

This config read happens even when Global Scale is disabled (the method returns early right after), so it adds an unnecessary system-config lookup on every non-GS search call. Consider moving the shareapi_lookup_label_show_email read to after the !$isGlobalScaleEnabled early-return to avoid extra work in the common non-GS case.

		$isGlobalScaleEnabled = $this->config->getSystemValueBool('gs.enabled', false);
		$isLookupServerEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no') === 'yes';
		$hasInternetConnection = $this->config->getSystemValueBool('has_internet_connection', true);
		$showFederatedEmail = $this->config->getSystemValueBool('shareapi_lookup_label_show_email', false);

		// If case of Global Scale we always search the lookup server
		// TODO: Reconsider using the lookup server for non-global scale
		// if (!$isGlobalScaleEnabled && (!$isLookupServerEnabled || !$hasInternetConnection || $disableLookupServer)) {
		if (!$isGlobalScaleEnabled) {
			return false;

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

 		$isGlobalScaleEnabled = $this->config->getSystemValueBool('gs.enabled', false);
 		$isLookupServerEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no') === 'yes';
 		$hasInternetConnection = $this->config->getSystemValueBool('has_internet_connection', true);
+		$showFederatedEmail = $this->config->getSystemValueBool('shareapi_lookup_label_show_email', false);


+				$email = $lookup['email']['value'] ?? '';
+
+				if ($showFederatedEmail && !empty($email)) {
+					$label = empty($name) ? $email : $name . ' (' . $email . ')';
+				} else {
+					$label = empty($name) ? $lookup['federationId'] : $name . ' (' . $lookup['federationId'] . ')';
+				}


+			->willReturn(json_encode($resultBody));
+		$client = $this->createMock(IClient::class);
+		$client->expects($this->once())
+			->method('get')


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nicolas Varlot <nicolas.varlot@ac-versailles.fr>

- rename variable $showFederatedEmail to $showEmailInLabel for clarity - add testSearchWithEmailLabelFallbackWhenEmailMissing covering the fallback path when flag is enabled but lookup response has no email - tighten HTTP expectation in testSearchWithEmailLabel to validate the requested URL Signed-off-by: niv <nicolas.varlot@ac-versailles.fr>

provokateurin · 2026-05-19T09:05:48Z

+				if ($showEmailInLabel && !empty($email)) {
+					$label = empty($name) ? $email : $name . ' (' . $email . ')';
+				} else {
+					$label = empty($name) ? $lookup['federationId'] : $name . ' (' . $lookup['federationId'] . ')';
+				}


Suggested change

if ($showEmailInLabel && !empty($email)) {

$label = empty($name) ? $email : $name . ' (' . $email . ')';

} else {

$label = empty($name) ? $lookup['federationId'] : $name . ' (' . $lookup['federationId'] . ')';

}

if ($showEmailInLabel && $email !== '') {

$id = $email;

} else {

$id = $lookup['federationId'];

}

$label = $name === '' ? $id : $name . ' (' . $id . ')';

provokateurin · 2026-05-19T09:06:55Z

 		$this->assertFalse($moreResults);
 	}

+	public function testSearchWithEmailLabel(): void {


Please collapse the tests into a single one and use a data provider to change the flag value and the expected outcome.

susnux · 2026-05-19T09:06:45Z

+		// System config flag: shareapi_lookup_label_show_email
+		// Controls whether email addresses from federated lookup results are shown in share dialog labels.
+		// Defaults to false to avoid exposing email addresses unnecessarily. Enabling this may reveal
+		// users' email addresses to people using the share dialog and should therefore be considered carefully.
+		$showEmailInLabel = $this->config->getSystemValueBool('shareapi_lookup_label_show_email', false);


Similar to the other configs we have for shareapi_ this should reside in the app config of core instead.

Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de> Signed-off-by: Nicolas Varlot <nicolas.varlot@ac-versailles.fr>

Copilot AI review requested due to automatic review settings May 14, 2026 10:08

n-iv requested a review from a team as a code owner May 14, 2026 10:08

n-iv requested review from CarlSchwan, come-nc, icewind1991 and leftybournes and removed request for a team May 14, 2026 10:08

Copilot started reviewing on behalf of n-iv May 14, 2026 10:09 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

n-iv and others added 2 commits May 14, 2026 12:26

added comments

ebe93dd

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nicolas Varlot <nicolas.varlot@ac-versailles.fr>

susnux added 3. to review Waiting for reviews feature: sharing AI assisted enhancement labels May 19, 2026

susnux added this to the Nextcloud 35 milestone May 19, 2026

provokateurin requested changes May 19, 2026

View reviewed changes

susnux reviewed May 19, 2026

View reviewed changes

Update lib/private/Collaboration/Collaborators/LookupPlugin.php

a29083c

Co-authored-by: Ferdinand Thiessen <opensource@fthiessen.de> Signed-off-by: Nicolas Varlot <nicolas.varlot@ac-versailles.fr>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(sharing): allow email-based labels for lookup results#60375

feat(sharing): allow email-based labels for lookup results#60375
n-iv wants to merge 4 commits into
nextcloud:masterfrom
n-iv:feat/lookup-label-show-email

n-iv commented May 14, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

provokateurin May 19, 2026

Uh oh!

provokateurin May 19, 2026

Uh oh!

susnux May 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

n-iv commented May 14, 2026

Summary

Motivation

Behavior

Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

provokateurin May 19, 2026

Choose a reason for hiding this comment

Uh oh!

provokateurin May 19, 2026

Choose a reason for hiding this comment

Uh oh!

susnux May 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants