Skip to content
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

Jump to bottom

fix(appconfig): format app values #44644

Merged
merged 2 commits into from
Apr 17, 2024
Merged

fix(appconfig): format app values #44644

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
cc813fe
fix(appconfig): format app values
ArtificialOwl Apr 4, 2024
97e59b1
fix(appconfig): only convert single entry on searchValues()
ArtificialOwl Apr 4, 2024
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
72 changes: 63 additions & 9 deletions lib/private/AppConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,16 +211,17 @@ public function isLazy(string $app, string $key): bool {
* @param string $prefix config keys prefix to search
* @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE}
*
* @return array<string, string> [configKey => configValue]
* @return array<string, string|int|float|bool|array> [configKey => configValue]
* @since 29.0.0
*/
public function getAllValues(string $app, string $prefix = '', bool $filtered = false): array {
$this->assertParams($app, $prefix);
// if we want to filter values, we need to get sensitivity
$this->loadConfigAll();
// array_merge() will remove numeric keys (here config keys), so addition arrays instead
$values = $this->formatAppValues($app, ($this->fastCache[$app] ?? []) + ($this->lazyCache[$app] ?? []));
$values = array_filter(
(($this->fastCache[$app] ?? []) + ($this->lazyCache[$app] ?? [])),
$values,
function (string $key) use ($prefix): bool {
return str_starts_with($key, $prefix); // filter values based on $prefix
}, ARRAY_FILTER_USE_KEY
Expand Down Expand Up @@ -253,14 +254,14 @@ function (string $key) use ($prefix): bool {
*
* @param string $key config key
* @param bool $lazy search within lazy loaded config
* @param int|null $typedAs enforce type for the returned values ({@see self::VALUE_STRING} and others)
*
* @return array<string, string> [appId => configValue]
* @return array<string, string|int|float|bool|array> [appId => configValue]
* @since 29.0.0
*/
public function searchValues(string $key, bool $lazy = false): array {
public function searchValues(string $key, bool $lazy = false, ?int $typedAs = null): array {
$this->assertParams('', $key, true);
$this->loadConfig($lazy);
$values = [];

/** @var array<array-key, array<array-key, mixed>> $cache */
if ($lazy) {
Expand All @@ -269,9 +270,10 @@ public function searchValues(string $key, bool $lazy = false): array {
$cache = $this->fastCache;
}

$values = [];
foreach (array_keys($cache) as $app) {
if (isset($cache[$app][$key])) {
$values[$app] = $cache[$app][$key];
$values[$app] = $this->convertTypedValue($cache[$app][$key], $typedAs ?? $this->getValueType((string)$app, $key, $lazy));
}
}

Expand Down Expand Up @@ -510,9 +512,9 @@ private function getTypedValue(
* @see VALUE_BOOL
* @see VALUE_ARRAY
*/
public function getValueType(string $app, string $key): int {
public function getValueType(string $app, string $key, ?bool $lazy = null): int {
$this->assertParams($app, $key);
$this->loadConfigAll();
$this->loadConfig($lazy);

if (!isset($this->valueTypes[$app][$key])) {
throw new AppConfigUnknownKeyException('unknown config key');
Expand Down Expand Up @@ -1369,7 +1371,7 @@ public function getValues($app, $key) {

$key = ($key === false) ? '' : $key;
if (!$app) {
return $this->searchValues($key);
return $this->searchValues($key, false, self::VALUE_MIXED);
} else {
return $this->getAllValues($app, $key);
}
Expand All @@ -1387,6 +1389,58 @@ public function getFilteredValues($app) {
return $this->getAllValues($app, filtered: true);
}


/**
* **Warning:** avoid default NULL value for $lazy as this will
* load all lazy values from the database
*
* @param string $app
* @param array<string, string> $values ['key' => 'value']
* @param bool|null $lazy
*
* @return array<string, string|int|float|bool|array>
*/
private function formatAppValues(string $app, array $values, ?bool $lazy = null): array {
foreach($values as $key => $value) {
try {
$type = $this->getValueType($app, $key, $lazy);
} catch (AppConfigUnknownKeyException $e) {
continue;
}

$values[$key] = $this->convertTypedValue($value, $type);
}

return $values;
}

/**
* convert string value to the expected type
*
* @param string $value
* @param int $type
*
* @return string|int|float|bool|array
*/
private function convertTypedValue(string $value, int $type): string|int|float|bool|array {
switch ($type) {
case self::VALUE_INT:
return (int)$value;
case self::VALUE_FLOAT:
return (float)$value;
case self::VALUE_BOOL:
return in_array(strtolower($value), ['1', 'true', 'yes', 'on']);
case self::VALUE_ARRAY:
try {
return json_decode($value, true, flags: JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
// ignoreable
}
break;
}
return $value;
}

/**
* @param string $app
*
Expand Down
2 changes: 1 addition & 1 deletion lib/private/AppFramework/Services/AppConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public function isLazy(string $key): bool {
* @param string $key config keys prefix to search
* @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE}
*
* @return array<string, string> [configKey => configValue]
* @return array<string, string|int|float|bool|array> [configKey => configValue]
* @since 29.0.0
*/
public function getAllAppValues(string $key = '', bool $filtered = false): array {
Expand Down
2 changes: 1 addition & 1 deletion lib/public/AppFramework/Services/IAppConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function isLazy(string $key): bool;
* @param string $key config keys prefix to search, can be empty.
* @param bool $filtered filter sensitive config values
*
* @return array<string, string> [configKey => configValue]
* @return array<string, string|int|float|bool|array> [configKey => configValue]
* @since 29.0.0
*/
public function getAllAppValues(string $key = '', bool $filtered = false): array;
Expand Down
9 changes: 6 additions & 3 deletions lib/public/IAppConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ public function isLazy(string $app, string $key): bool;
* @param string $prefix config keys prefix to search, can be empty.
* @param bool $filtered filter sensitive config values
*
* @return array<string, string> [configKey => configValue]
* @return array<string, string|int|float|bool|array> [configKey => configValue]
* @since 29.0.0
*/
public function getAllValues(string $app, string $prefix = '', bool $filtered = false): array;
Expand All @@ -151,11 +151,12 @@ public function getAllValues(string $app, string $prefix = '', bool $filtered =
*
* @param string $key config key
* @param bool $lazy search within lazy loaded config
* @param int|null $typedAs enforce type for the returned values {@see self::VALUE_STRING} and others
*
* @return array<string, string|int|float|bool|array> [appId => configValue]
* @since 29.0.0
*/
public function searchValues(string $key, bool $lazy = false): array;
public function searchValues(string $key, bool $lazy = false, ?int $typedAs = null): array;

/**
* Get config value assigned to a config key.
Expand Down Expand Up @@ -261,9 +262,11 @@ public function getValueArray(string $app, string $key, array $default = [], boo
* returns the type of config value
*
* **WARNING:** ignore lazy filtering, all config values are loaded from database
* unless lazy is set to false
*
* @param string $app id of the app
* @param string $key config key
* @param bool|null $lazy
*
* @return int
* @throws AppConfigUnknownKeyException
Expand All @@ -274,7 +277,7 @@ public function getValueArray(string $app, string $key, array $default = [], boo
* @see VALUE_BOOL
* @see VALUE_ARRAY
*/
public function getValueType(string $app, string $key): int;
public function getValueType(string $app, string $key, ?bool $lazy = null): int;

/**
* Store a config key and its value in database
Expand Down
15 changes: 15 additions & 0 deletions tests/lib/AppConfigTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,21 @@ public function testIsLazyOnUnknownAppThrowsException(): void {
$config->isLazy('unknown-app', 'inexistant-key');
}

public function testGetAllValues(): void {
$config = $this->generateAppConfig();
$this->assertEquals(
[
'array' => ['test' => 1],
'bool' => true,
'float' => 3.14,
'int' => 42,
'mixed' => 'mix',
'string' => 'value',
],
$config->getAllValues('typed')
);
}

public function testGetAllValuesWithEmptyApp(): void {
$config = $this->generateAppConfig();
$this->expectException(InvalidArgumentException::class);
Expand Down
Loading