Skip to content

fix(carddav): make paginated contact searches deterministic #62287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshtrichards wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(carddav): make paginated contact searches deterministic #62287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50d71e4
fix(carddav): make limited contact searches deterministic
joshtrichards Jul 17, 2026
f5aafff
test(carddav): cover deterministic paginated contact searches
joshtrichards Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions apps/dav/lib/CardDAV/CardDavBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1207,13 +1207,16 @@ public function searchPrincipalUri(string $principalUri,
* } $options
* @return array
*/
private function searchByAddressBookIds(array $addressBookIds,
private function searchByAddressBookIds(
array $addressBookIds,
string $pattern,
array $searchProperties,
array $options = []): array {
array $options = [],
): array {
if (empty($addressBookIds)) {
return [];
}

$escapePattern = !\array_key_exists('escape_like_param', $options) || $options['escape_like_param'] !== false;
$useWildcards = !\array_key_exists('wildcard', $options) || $options['wildcard'] !== false;

Expand Down Expand Up @@ -1254,6 +1257,9 @@ private function searchByAddressBookIds(array $addressBookIds,
$query2->andWhere($query2->expr()->ilike('cp.value', $query2->createNamedParameter('%' . $this->db->escapeLikeParameter($pattern) . '%')));
}
}
if (isset($options['limit']) || isset($options['offset'])) {
$query2->orderBy('cp.cardid', 'ASC');
}
if (isset($options['limit'])) {
$query2->setMaxResults($options['limit']);
}
Expand Down Expand Up @@ -1300,6 +1306,10 @@ private function searchByAddressBookIds(array $addressBookIds,
->from($this->dbCardsTable, 'c')
->where($query->expr()->in('c.id', $query->createParameter('matches')));

if (isset($options['limit']) || isset($options['offset'])) {
$query->orderBy('c.id', 'ASC');
}

foreach (array_chunk($matches, IQueryBuilder::MAX_IN_PARAMETERS) as $matchesChunk) {
$query->setParameter('matches', $matchesChunk, IQueryBuilder::PARAM_INT_ARRAY);
$result = $query->executeQuery();
Expand Down
102 changes: 61 additions & 41 deletions apps/dav/tests/unit/CardDAV/CardDavBackendTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,52 @@ public function testGetCardIdFailed(): void {

#[\PHPUnit\Framework\Attributes\DataProvider(methodName: 'dataTestSearch')]
public function testSearch(string $pattern, array $properties, array $options, array $expectedUris, array $expectedNeedles): void {
$this->seedSearchCards();

$result = $this->backend->search(0, $pattern, $properties, $options);

$this->assertCount(count($expectedUris), $result);

$actualUris = array_map(static fn (array $row): string => $row['uri'], $result);
sort($actualUris);
$expectedSortedUris = $expectedUris;
sort($expectedSortedUris);

$this->assertSame($expectedSortedUris, $actualUris, 'Search returned unexpected URIs');

$expectedByUri = array_combine($expectedUris, $expectedNeedles);
$this->assertIsArray($expectedByUri);

foreach ($result as $row) {
$this->assertArrayHasKey($row['uri'], $expectedByUri, 'Unexpected URI in search result');
$this->assertNotFalse(
strpos($row['carddata'], $expectedByUri[$row['uri']]),
'Returned carddata does not contain expected fragment for ' . $row['uri']
);
}
}

public function testSearchPaginationUsesCardIdOrder(): void {
$this->seedSearchCards();

$firstPage = $this->backend->search(0, 'john', ['FN'], [
'limit' => 1,
'offset' => 0,
]);
$secondPage = $this->backend->search(0, 'john', ['FN'], [
'limit' => 1,
'offset' => 1,
]);
$twoResults = $this->backend->search(0, 'john', ['FN'], [
'limit' => 2,
]);

self::assertSame(['uri0'], array_column($firstPage, 'uri'));
self::assertSame(['uri1'], array_column($secondPage, 'uri'));
self::assertSame(['uri0', 'uri1'], array_column($twoResults, 'uri'));
}

private function seedSearchCards(): void {
$vCards = [];

$vCards[0] = new VCard();
Expand All @@ -702,16 +748,14 @@ public function testSearch(string $pattern, array $properties, array $options, a
$query = $this->db->getQueryBuilder();
for ($i = 0; $i < 3; $i++) {
$query->insert($this->dbCardsTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'carddata' => $query->createNamedParameter($vCards[$i]->serialize(), IQueryBuilder::PARAM_LOB),
'uri' => $query->createNamedParameter('uri' . $i),
'lastmodified' => $query->createNamedParameter(time()),
'etag' => $query->createNamedParameter('etag' . $i),
'size' => $query->createNamedParameter(120),
]
);
->values([
'addressbookid' => $query->createNamedParameter(0),
'carddata' => $query->createNamedParameter($vCards[$i]->serialize(), IQueryBuilder::PARAM_LOB),
'uri' => $query->createNamedParameter('uri' . $i),
'lastmodified' => $query->createNamedParameter(time()),
'etag' => $query->createNamedParameter('etag' . $i),
'size' => $query->createNamedParameter(120),
]);
$query->executeStatement();
$vCardIds[] = $query->getLastInsertId();
}
Expand All @@ -727,39 +771,15 @@ public function testSearch(string $pattern, array $properties, array $options, a
foreach ($propertyRows as [$cardId, $name, $value]) {
$query = $this->db->getQueryBuilder();
$query->insert($this->dbCardsPropertiesTable)
->values(
[
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($cardId),
'name' => $query->createNamedParameter($name),
'value' => $query->createNamedParameter($value),
'preferred' => $query->createNamedParameter(0),
]
);
->values([
'addressbookid' => $query->createNamedParameter(0),
'cardid' => $query->createNamedParameter($cardId),
'name' => $query->createNamedParameter($name),
'value' => $query->createNamedParameter($value),
'preferred' => $query->createNamedParameter(0),
]);
$query->executeStatement();
}

$result = $this->backend->search(0, $pattern, $properties, $options);

$this->assertCount(count($expectedUris), $result);

$actualUris = array_map(static fn (array $row): string => $row['uri'], $result);
sort($actualUris);
$expectedSortedUris = $expectedUris;
sort($expectedSortedUris);

$this->assertSame($expectedSortedUris, $actualUris, 'Search returned unexpected URIs');

$expectedByUri = array_combine($expectedUris, $expectedNeedles);
$this->assertIsArray($expectedByUri);

foreach ($result as $row) {
$this->assertArrayHasKey($row['uri'], $expectedByUri, 'Unexpected URI in search result');
$this->assertNotFalse(
strpos($row['carddata'], $expectedByUri[$row['uri']]),
'Returned carddata does not contain expected fragment for ' . $row['uri']
);
}
}

public static function dataTestSearch(): array {
Expand Down
Loading