From c8b5562ac58f04eab76cd4c698fce73b170e4288 Mon Sep 17 00:00:00 2001 From: Maxence Lange Date: Thu, 12 Dec 2024 17:37:14 -0100 Subject: [PATCH] fix(lexicon): renaming and minor fixes Signed-off-by: Maxence Lange --- lib/private/AppConfig.php | 8 ++++---- lib/private/Config/UserConfig.php | 10 +++++----- lib/unstable/Config/Lexicon/ConfigLexiconEntry.php | 2 +- .../Config/Lexicon/ConfigLexiconStrictness.php | 10 +++++----- tests/lib/AppConfigTest.php | 4 ---- 5 files changed, 15 insertions(+), 19 deletions(-) diff --git a/lib/private/AppConfig.php b/lib/private/AppConfig.php index bb439218015dd..71c958703e921 100644 --- a/lib/private/AppConfig.php +++ b/lib/private/AppConfig.php @@ -436,7 +436,7 @@ private function getTypedValue( int $type, ): string { $this->assertParams($app, $key, valueType: $type); - if (!$this->compareRegisteredConfigValues($app, $key, $lazy, $type, $default)) { + if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, $default)) { return $default; // returns default if strictness of lexicon is set to WARNING (block and report) } $this->loadConfig($app, $lazy); @@ -730,7 +730,7 @@ private function setTypedValue( int $type, ): bool { $this->assertParams($app, $key); - if (!$this->compareRegisteredConfigValues($app, $key, $lazy, $type)) { + if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type)) { return false; // returns false as database is not updated } $this->loadConfig(null, $lazy); @@ -1573,13 +1573,13 @@ public function clearCachedConfig(): void { } /** - * verify and compare current use of config values with defined lexicon + * match and apply current use of config values with defined lexicon * * @throws AppConfigUnknownKeyException * @throws AppConfigTypeConflictException * @return bool TRUE if everything is fine compared to lexicon or lexicon does not exist */ - private function compareRegisteredConfigValues( + private function matchAndApplyLexiconDefinition( string $app, string $key, bool &$lazy, diff --git a/lib/private/Config/UserConfig.php b/lib/private/Config/UserConfig.php index b2242729d2bfe..78c43fc432158 100644 --- a/lib/private/Config/UserConfig.php +++ b/lib/private/Config/UserConfig.php @@ -711,7 +711,7 @@ private function getTypedValue( ValueType $type, ): string { $this->assertParams($userId, $app, $key); - if (!$this->compareRegisteredConfigValues($app, $key, $lazy, $type, default: $default)) { + if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, default: $default)) { return $default; // returns default if strictness of lexicon is set to WARNING (block and report) } $this->loadConfig($userId, $lazy); @@ -1046,7 +1046,7 @@ private function setTypedValue( ValueType $type, ): bool { $this->assertParams($userId, $app, $key); - if (!$this->compareRegisteredConfigValues($app, $key, $lazy, $type, $flags)) { + if (!$this->matchAndApplyLexiconDefinition($app, $key, $lazy, $type, $flags)) { return false; // returns false as database is not updated } $this->loadConfig($userId, $lazy); @@ -1816,12 +1816,12 @@ private function decryptSensitiveValue(string $userId, string $app, string $key, } /** - * verify and compare current use of config values with defined lexicon + * match and apply current use of config values with defined lexicon * * @throws UnknownKeyException * @throws TypeConflictException */ - private function compareRegisteredConfigValues( + private function matchAndApplyLexiconDefinition( string $app, string $key, bool &$lazy, @@ -1837,7 +1837,7 @@ private function compareRegisteredConfigValues( /** @var ConfigLexiconEntry $configValue */ $configValue = $configDetails['entries'][$key]; if ($type === ValueType::MIXED) { - $type = $configValue->getValueType()->value; // we overwrite if value was requested as mixed + $type = $configValue->getValueType(); // we overwrite if value was requested as mixed } elseif ($configValue->getValueType() !== $type) { throw new TypeConflictException('The user config key ' . $app . '/' . $key . ' is typed incorrectly in relation to the config lexicon'); } diff --git a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php index 68787f9000c6b..e6c6579881dba 100644 --- a/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php +++ b/lib/unstable/Config/Lexicon/ConfigLexiconEntry.php @@ -174,7 +174,7 @@ public function getFlags(): int { * @experimental 31.0.0 */ public function isFlagged(int $flag): bool { - return (bool)($flag & $this->getFlags()); + return (($flag & $this->getFlags()) === $flag); } /** diff --git a/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php b/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php index fda0adb003720..a6490675c8ab3 100644 --- a/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php +++ b/lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php @@ -18,13 +18,13 @@ * * @experimental 31.0.0 */ -enum ConfigLexiconStrictness: int { +enum ConfigLexiconStrictness { /** @experimental 31.0.0 */ - case IGNORE = 0; // fully ignore + case IGNORE; // fully ignore /** @experimental 31.0.0 */ - case NOTICE = 2; // ignore and report + case NOTICE; // ignore and report /** @experimental 31.0.0 */ - case WARNING = 3; // silently block (returns $default) and report + case WARNING; // silently block (returns $default) and report /** @experimental 31.0.0 */ - case EXCEPTION = 5; // block (throws exception) and report + case EXCEPTION; // block (throws exception) and report } diff --git a/tests/lib/AppConfigTest.php b/tests/lib/AppConfigTest.php index 775c9027dd671..518d7909d70c9 100644 --- a/tests/lib/AppConfigTest.php +++ b/tests/lib/AppConfigTest.php @@ -9,7 +9,6 @@ use InvalidArgumentException; use OC\AppConfig; -use OC\AppFramework\Bootstrap\Coordinator; use OCP\Exceptions\AppConfigTypeConflictException; use OCP\Exceptions\AppConfigUnknownKeyException; use OCP\IAppConfig; @@ -29,7 +28,6 @@ class AppConfigTest extends TestCase { protected IDBConnection $connection; private LoggerInterface $logger; private ICrypto $crypto; - private Coordinator $coordinator; private array $originalConfig; @@ -91,7 +89,6 @@ protected function setUp(): void { $this->connection = \OCP\Server::get(IDBConnection::class); $this->logger = \OCP\Server::get(LoggerInterface::class); $this->crypto = \OCP\Server::get(ICrypto::class); - $this->coordinator = \OCP\Server::get(Coordinator::class); // storing current config and emptying the data table $sql = $this->connection->getQueryBuilder(); @@ -182,7 +179,6 @@ private function generateAppConfig(bool $preLoading = true): IAppConfig { $this->connection, $this->logger, $this->crypto, - $this->coordinator ); $msg = ' generateAppConfig() failed to confirm cache status';