VladPolskiy/nextcloud-server
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-07-24 12:19:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(appconfig): add searchKeys()

Browse Source 
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange
2025-07-18 13:16:39 -01:00
parent c4b11e8a6d
commit 20b908cf3f
3 changed files with 67 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
lib/private/AppConfig.php
View File

@ -95,8 +95,9 @@ class AppConfig implements IAppConfig {
* @inheritDoc * @inheritDoc
* *
* @param string $app id of the app * @param string $app id of the app
*
* @return list<string> list of stored config keys * @return list<string> list of stored config keys
* @see searchKeys to not load lazy config keys
*
* @since 29.0.0 * @since 29.0.0
*/ */
public function getKeys(string $app): array { public function getKeys(string $app): array {
@ -108,6 +109,32 @@ class AppConfig implements IAppConfig {
return array_values(array_unique($keys)); return array_values(array_unique($keys));
} }
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $prefix returns only keys starting with this value
* @param bool $lazy TRUE to search in lazy config keys
* @return list<string> list of stored config keys
* @since 32.0.0
*/
public function searchKeys(string $app, string $prefix = '', bool $lazy = false): array {
$this->assertParams($app);
$this->loadConfig($app, $lazy);
if ($lazy) {
$keys = array_keys($this->lazyCache[$app] ?? []);
} else {
$keys = array_keys($this->fastCache[$app] ?? []);
}
if ($prefix !== '') {
$keys = array_filter($keys, static fn (string $key): bool => str_starts_with($key, $prefix));
}
sort($keys);
return array_values(array_unique($keys));
}
/** /**
* @inheritDoc * @inheritDoc
* *

16
lib/public/IAppConfig.php
View File

@ -65,12 +65,26 @@ interface IAppConfig {
* **WARNING:** ignore lazy filtering, all config values are loaded from database * **WARNING:** ignore lazy filtering, all config values are loaded from database
* *
* @param string $app id of the app * @param string $app id of the app
*
* @return list<string> list of stored config keys * @return list<string> list of stored config keys
* @see searchKeys to avoid loading lazy config keys
*
* @since 29.0.0 * @since 29.0.0
*/ */
public function getKeys(string $app): array; public function getKeys(string $app): array;
/**
* Returns list of keys stored in database, related to an app.
* Please note that the values are not returned.
*
* @param string $app id of the app
* @param string $prefix returns only keys starting with this value
* @param bool $lazy TRUE to search in lazy config keys
*
* @return list<string> list of stored config keys
* @since 32.0.0
*/
public function searchKeys(string $app, string $prefix = '', bool $lazy = false): array;
/** /**
* Check if a key exists in the list of stored config values. * Check if a key exists in the list of stored config values.
* *

24
tests/lib/AppConfigTest.php
View File

@ -47,6 +47,13 @@ class AppConfigTest extends TestCase {
'deletethis' => ['deletethis', 'deletethis'], 'deletethis' => ['deletethis', 'deletethis'],
'key' => ['key', 'value'] 'key' => ['key', 'value']
], ],
'searchtest' => [
'search_key1' => ['search_key1', 'key1', IAppConfig::VALUE_STRING],
'search_key2' => ['search_key2', 'key2', IAppConfig::VALUE_STRING],
'search_key3' => ['search_key3', 'key3', IAppConfig::VALUE_STRING],
'searchnot_key4' => ['searchnot_key4', 'key4', IAppConfig::VALUE_STRING],
'search_key5_lazy' => ['search_key5_lazy', 'key5', IAppConfig::VALUE_STRING, true],
],
'someapp' => [ 'someapp' => [
'key' => ['key', 'value'], 'key' => ['key', 'value'],
'otherkey' => ['otherkey', 'othervalue'] 'otherkey' => ['otherkey', 'othervalue']
@ -1454,6 +1461,23 @@ class AppConfigTest extends TestCase {
$this->assertConfigValueNotEquals('testapp', $key, $secret); $this->assertConfigValueNotEquals('testapp', $key, $secret);
} }
public function testSearchKeyNoLazyLoading(): void {
$appConfig = $this->generateAppConfig();
$appConfig->searchKeys('searchtest', 'search_');
$status = $appConfig->statusCache();
$this->assertFalse($status['lazyLoaded'], 'searchKeys() loaded lazy config');
}
public function testSearchKeyFast(): void {
$appConfig = $this->generateAppConfig();
$this->assertEquals(['search_key1', 'search_key2', 'search_key3'], $appConfig->searchKeys('searchtest', 'search_'));
}
public function testSearchKeyLazy(): void {
$appConfig = $this->generateAppConfig();
$this->assertEquals(['search_key5_lazy'], $appConfig->searchKeys('searchtest', 'search_', true));
}
protected function loadConfigValueFromDatabase(string $app, string $key): string|false { protected function loadConfigValueFromDatabase(string $app, string $key): string|false {
$sql = $this->connection->getQueryBuilder(); $sql = $this->connection->getQueryBuilder();
$sql->select('configvalue') $sql->select('configvalue')