upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-04-27 09:08:22 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Merge pull request #52981 from nextcloud/perf/dav-preload-search-tags

Browse source 
perf(dav): Preload dav search with tags/favorites
This commit is contained in:
Arthur Schiwon 2025-06-30 18:03:10 +02:00 committed by GitHub
commit ac70e12d10
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 52 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
apps/dav/lib/Connector/Sabre/TagsPlugin.php
View file

@ -94,6 +94,7 @@ class TagsPlugin extends \Sabre\DAV\ServerPlugin {
$this->server = $server;
$this->server->on('propFind', [$this, 'handleGetProperties']);
$this->server->on('propPatch', [$this, 'handleUpdateProperties']);
$this->server->on('preloadProperties', [$this, 'handlePreloadProperties']);
}
/**
@ -149,6 +150,24 @@ class TagsPlugin extends \Sabre\DAV\ServerPlugin {
return null;
}
/**
* Prefetches tags for a list of file IDs and caches the results
*
* @param array $fileIds List of file IDs to prefetch tags for
* @return void
*/
private function prefetchTagsForFileIds(array $fileIds) {
$tags = $this->getTagger()->getTagsForObjects($fileIds);
if ($tags === false) {
// the tags API returns false on error...
$tags = [];
}
foreach ($fileIds as $fileId) {
$this->cachedTags[$fileId] = $tags[$fileId] ?? [];
}
}
/**
* Updates the tags of the given file id
*
@ -199,22 +218,11 @@ class TagsPlugin extends \Sabre\DAV\ServerPlugin {
)) {
// note: pre-fetching only supported for depth <= 1
$folderContent = $node->getChildren();
$fileIds[] = (int)$node->getId();
$fileIds = [(int)$node->getId()];
foreach ($folderContent as $info) {
$fileIds[] = (int)$info->getId();
}
$tags = $this->getTagger()->getTagsForObjects($fileIds);
if ($tags === false) {
// the tags API returns false on error...
$tags = [];
}
$this->cachedTags = $this->cachedTags + $tags;
$emptyFileIds = array_diff($fileIds, array_keys($tags));
// also cache the ones that were not found
foreach ($emptyFileIds as $fileId) {
$this->cachedTags[$fileId] = [];
}
$this->prefetchTagsForFileIds($fileIds);
}
$isFav = null;
@ -270,4 +278,14 @@ class TagsPlugin extends \Sabre\DAV\ServerPlugin {
return 200;
});
}
public function handlePreloadProperties(array $nodes, array $requestProperties): void {
if (
!in_array(self::FAVORITE_PROPERTYNAME, $requestProperties, true) &&
!in_array(self::TAGS_PROPERTYNAME, $requestProperties, true)
) {
return;
}
$this->prefetchTagsForFileIds(array_map(fn ($node) => $node->getId(), $nodes));
}
}

3
apps/dav/lib/Files/FileSearchBackend.php
View file

@ -15,6 +15,7 @@ use OCA\DAV\Connector\Sabre\CachingTree;
use OCA\DAV\Connector\Sabre\Directory;
use OCA\DAV\Connector\Sabre\File;
use OCA\DAV\Connector\Sabre\FilesPlugin;
use OCA\DAV\Connector\Sabre\Server;
use OCA\DAV\Connector\Sabre\TagsPlugin;
use OCP\Files\Cache\ICacheEntry;
use OCP\Files\Folder;
@ -44,6 +45,7 @@ class FileSearchBackend implements ISearchBackend {
public const OPERATOR_LIMIT = 100;
public function __construct(
private Server $server,
private CachingTree $tree,
private IUser $user,
private IRootFolder $rootFolder,
@ -133,6 +135,7 @@ class FileSearchBackend implements ISearchBackend {
* @param string[] $requestProperties
*/
public function preloadPropertyFor(array $nodes, array $requestProperties): void {
$this->server->emit('preloadProperties', [$nodes, $requestProperties]);
}
private function getFolderForPath(?string $path = null): Folder {

1
apps/dav/lib/Server.php
View file

@ -354,6 +354,7 @@ class Server {
\OCP\Server::get(IAppManager::class)
));
$lazySearchBackend->setBackend(new FileSearchBackend(
$this->server,
$this->server->tree,
$user,
\OCP\Server::get(IRootFolder::class),

18
apps/dav/tests/unit/Files/FileSearchBackendTest.php
View file

@ -15,6 +15,7 @@ use OCA\DAV\Connector\Sabre\Directory;
use OCA\DAV\Connector\Sabre\File;
use OCA\DAV\Connector\Sabre\FilesPlugin;
use OCA\DAV\Connector\Sabre\ObjectTree;
use OCA\DAV\Connector\Sabre\Server;
use OCA\DAV\Files\FileSearchBackend;
use OCP\Files\FileInfo;
use OCP\Files\Folder;
@ -36,6 +37,7 @@ use Test\TestCase;
class FileSearchBackendTest extends TestCase {
private ObjectTree&MockObject $tree;
private Server&MockObject $server;
private IUser&MockObject $user;
private IRootFolder&MockObject $rootFolder;
private IManager&MockObject $shareManager;
@ -53,6 +55,7 @@ class FileSearchBackendTest extends TestCase {
->willReturn('test');
$this->tree = $this->createMock(ObjectTree::class);
$this->server = $this->createMock(Server::class);
$this->view = $this->createMock(View::class);
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->shareManager = $this->createMock(IManager::class);
@ -78,7 +81,7 @@ class FileSearchBackendTest extends TestCase {
$filesMetadataManager = $this->createMock(IFilesMetadataManager::class);
$this->search = new FileSearchBackend($this->tree, $this->user, $this->rootFolder, $this->shareManager, $this->view, $filesMetadataManager);
$this->search = new FileSearchBackend($this->server, $this->tree, $this->user, $this->rootFolder, $this->shareManager, $this->view, $filesMetadataManager);
}
public function testSearchFilename(): void {
@ -402,4 +405,17 @@ class FileSearchBackendTest extends TestCase {
$this->expectException(\InvalidArgumentException::class);
$this->search->search($query);
}
public function testPreloadPropertyFor(): void {
$node1 = $this->createMock(File::class);
$node2 = $this->createMock(Directory::class);
$nodes = [$node1, $node2];
$requestProperties = ['{DAV:}getcontenttype', '{DAV:}getlastmodified'];
$this->server->expects($this->once())
->method('emit')
->with('preloadProperties', [$nodes, $requestProperties]);
$this->search->preloadPropertyFor($nodes, $requestProperties);
}
}