friendica/friendica
6
0
Fork 1
mirror of https://github.com/friendica/friendica synced 2024-05-21 04:36:44 +02:00
Code Issues Packages Projects Releases 1 Wiki Activity

Revert Cache delete() behavior to stable version

Browse source
This commit is contained in:
Philipp Holzer 2023-01-11 21:10:59 +01:00
parent eda65296f5
commit fd882abd80
Signed by: nupplaPhil
GPG key ID: 24A7501396EB5432
2 changed files with 58 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
src/Core/Config/ValueObject/Cache.php
View file

@ -87,10 +87,11 @@ class Cache
$keys = array_keys($config[$category]); $keys = array_keys($config[$category]);
foreach ($keys as $key) { foreach ($keys as $key) {
$this->set($category, $key, $config[$category][$key] ?? null, $source); $value = $config[$category][$key];
if (isset($value)) {
$this->set($category, $key, $value, $source);
}
} }
} else {
$this->set($category, null, $config[$category], $source);
} }
} }
} }
@ -149,8 +150,6 @@ class Cache
$data[$category][$key] = $this->config[$category][$key]; $data[$category][$key] = $this->config[$category][$key];
} }
} }
} elseif (is_int($this->source[$category])) {
$data[$category] = null;
} }
} }
@ -160,49 +159,40 @@ class Cache
/** /**
* Sets a value in the config cache. Accepts raw output from the config table * Sets a value in the config cache. Accepts raw output from the config table
* *
* @param string $cat Config category * @param string $cat Config category
* @param ?string $key Config key * @param string $key Config key
* @param ?mixed $value Value to set * @param mixed $value Value to set
* @param int $source The source of the current config key * @param int $source The source of the current config key
* *
* @return bool True, if the value is set * @return bool True, if the value is set
*/ */
public function set(string $cat, string $key = null, $value = null, int $source = self::SOURCE_DEFAULT): bool public function set(string $cat, string $key, $value, int $source = self::SOURCE_DEFAULT): bool
{ {
if (!isset($this->config[$cat]) && $key !== null) { if (!isset($this->config[$cat])) {
$this->config[$cat] = []; $this->config[$cat] = [];
$this->source[$cat] = []; $this->source[$cat] = [];
} }
if ((isset($this->source[$cat][$key]) && $source < $this->source[$cat][$key]) || if (isset($this->source[$cat][$key]) &&
(is_int($this->source[$cat] ?? null) && $source < $this->source[$cat])) { $source < $this->source[$cat][$key]) {
return false; return false;
} }
if ($this->hidePasswordOutput && if ($this->hidePasswordOutput &&
$key == 'password' && $key == 'password' &&
is_string($value)) { is_string($value)) {
$this->setCatKeyValueSource($cat, $key, new HiddenString($value), $source); $this->config[$cat][$key] = new HiddenString((string)$value);
} else if (is_string($value)) { } else if (is_string($value)) {
$this->setCatKeyValueSource($cat, $key, self::toConfigValue($value), $source); $this->config[$cat][$key] = self::toConfigValue($value);
} else { } else {
$this->setCatKeyValueSource($cat, $key, $value, $source); $this->config[$cat][$key] = $value;
} }
$this->source[$cat][$key] = $source;
return true; return true;
} }
private function setCatKeyValueSource(string $cat, string $key = null, $value = null, int $source = self::SOURCE_DEFAULT)
{
if (isset($key)) {
$this->config[$cat][$key] = $value;
$this->source[$cat][$key] = $source;
} else {
$this->config[$cat] = $value;
$this->source[$cat] = $source;
}
}
/** /**
* Formats a DB value to a config value * Formats a DB value to a config value
* - null = The db-value isn't set * - null = The db-value isn't set
@ -214,7 +204,7 @@ class Cache
* *
* @param string|null $value * @param string|null $value
* *
* @return null|array|string * @return mixed
*/ */
public static function toConfigValue(?string $value) public static function toConfigValue(?string $value)
{ {
@ -232,27 +222,24 @@ class Cache
/** /**
* Deletes a value from the config cache. * Deletes a value from the config cache.
* *
* @param string $cat Config category * @param string $cat Config category
* @param ?string $key Config key (if not set, the whole category will get deleted) * @param string $key Config key
* @param int $source The source of the current config key
* *
* @return bool true, if deleted * @return bool true, if deleted
*/ */
public function delete(string $cat, string $key = null, int $source = self::SOURCE_DEFAULT): bool public function delete(string $cat, string $key): bool
{ {
if (isset($this->config[$cat][$key])) { if (isset($this->config[$cat][$key])) {
$this->config[$cat][$key] = null; unset($this->config[$cat][$key]);
$this->source[$cat][$key] = $source; unset($this->source[$cat][$key]);
if (empty(array_filter($this->config[$cat], function($value) { return !is_null($value); }))) { if (count($this->config[$cat]) == 0) {
$this->config[$cat] = null; unset($this->config[$cat]);
$this->source[$cat] = $source; unset($this->source[$cat]);
} }
} elseif (isset($this->config[$cat])) { return true;
$this->config[$cat] = null; } else {
$this->source[$cat] = $source; return false;
} }
return true;
} }
/** /**
@ -283,7 +270,7 @@ class Cache
$keys = array_keys($config[$category]); $keys = array_keys($config[$category]);
foreach ($keys as $key) { foreach ($keys as $key) {
if (!key_exists($key, $this->config[$category] ?? [])) { if (!isset($this->config[$category][$key])) {
$return[$category][$key] = $config[$category][$key]; $return[$category][$key] = $config[$category][$key];
} }
} }

34
tests/src/Core/Config/Cache/CacheTest.php
View file

@ -40,7 +40,6 @@ class CacheTest extends MockedTest
'int' => 235, 'int' => 235,
'dec' => 2.456, 'dec' => 2.456,
'array' => ['1', 2, '3', true, false], 'array' => ['1', 2, '3', true, false],
'null' => null,
], ],
'config' => [ 'config' => [
'a' => 'value', 'a' => 'value',
@ -124,7 +123,7 @@ class CacheTest extends MockedTest
// wrong dataset // wrong dataset
$configCache->load(['system' => 'not_array']); $configCache->load(['system' => 'not_array']);
self::assertEquals(['system' => 'not_array'], $configCache->getAll()); self::assertEquals([], $configCache->getAll());
// incomplete dataset (key is integer ID of the array) // incomplete dataset (key is integer ID of the array)
$configCache = new Cache(); $configCache = new Cache();
@ -209,16 +208,13 @@ class CacheTest extends MockedTest
{ {
$configCache = new Cache($data); $configCache = new Cache($data);
$assertion = [];
foreach ($data as $cat => $values) { foreach ($data as $cat => $values) {
$assertion[$cat] = null;
foreach ($values as $key => $value) { foreach ($values as $key => $value) {
$configCache->delete($cat, $key); $configCache->delete($cat, $key);
} }
} }
self::assertEquals($assertion, $configCache->getAll()); self::assertEmpty($configCache->getAll());
} }
/** /**
@ -554,4 +550,30 @@ class CacheTest extends MockedTest
self::assertEquals('new_value', $newCache->get($category, 'new_key')); self::assertEquals('new_value', $newCache->get($category, 'new_key'));
} }
/**
* Test that keys are removed after a deletion
*
* @dataProvider dataTests
*
*/
public function testDeleteRemovesKey($data)
{
$cache = new Cache();
$cache->load($data, Cache::SOURCE_FILE);
$cache->set('system', 'test', 'overwrite!', Cache::SOURCE_DATA);
self::assertEquals('overwrite!', $cache->get('system', 'test'));
// array should now be removed
$cache->delete('system', 'test');
self::assertArrayNotHasKey('test', $cache->getAll()['system']);
self::assertArrayHasKey('config', $cache->getAll());
self::assertArrayHasKey('a', $cache->getAll()['config']);
// category should now be removed
$cache->delete('config', 'a');
self::assertArrayNotHasKey('config', $cache->getAll());
}
} }