fix(appconfig): format app values

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange 2024-04-04 00:20:35 -01:00
parent b5c1766d33
commit cc813fec23
3 changed files with 66 additions and 5 deletions

View file

@ -219,8 +219,9 @@ class AppConfig implements IAppConfig {
// 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
@ -271,7 +272,8 @@ class AppConfig implements IAppConfig {
foreach (array_keys($cache) as $app) {
if (isset($cache[$app][$key])) {
$values[$app] = $cache[$app][$key];
$appCache = $this->formatAppValues((string)$app, $cache[$app], $lazy);
$values[$app] = $appCache[$key];
}
}
@ -510,9 +512,9 @@ class AppConfig implements IAppConfig {
* @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');
@ -1387,6 +1389,48 @@ class AppConfig implements IAppConfig {
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 $values
* @param bool|null $lazy
*
* @return 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;
}
switch ($type) {
case self::VALUE_INT:
$values[$key] = (int)$value;
break;
case self::VALUE_FLOAT:
$values[$key] = (float)$value;
break;
case self::VALUE_BOOL:
$values[$key] = in_array(strtolower($value), ['1', 'true', 'yes', 'on']);
break;
case self::VALUE_ARRAY:
try {
$values[$key] = json_decode($value, true, flags: JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
// ignoreable
}
break;
}
}
return $values;
}
/**
* @param string $app
*

View file

@ -261,9 +261,11 @@ interface IAppConfig {
* 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
@ -274,7 +276,7 @@ interface IAppConfig {
* @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

View file

@ -386,6 +386,21 @@ class AppConfigTest extends TestCase {
$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);