From fa55928ea3978e96bf1cc21f3759f5607f3ef503 Mon Sep 17 00:00:00 2001 From: Philipp Date: Sat, 23 Oct 2021 12:26:06 +0200 Subject: [PATCH] Replace own VoidLogger with PSR-Standard NullLogger() --- src/Core/Logger/Factory/Logger.php | 14 +- src/Core/Logger/Type/VoidLogger.php | 159 ------------------ .../AutomaticInstallationConsoleTest.php | 4 +- .../Factory/FriendSuggestTest.php | 8 +- tests/src/Core/Logger/VoidLoggerTest.php | 52 ------ .../ProfileField/Entity/ProfileFieldTest.php | 6 +- .../TwoFactor/Factory/TrustedBrowserTest.php | 8 +- 7 files changed, 20 insertions(+), 231 deletions(-) delete mode 100644 src/Core/Logger/Type/VoidLogger.php delete mode 100644 tests/src/Core/Logger/VoidLoggerTest.php diff --git a/src/Core/Logger/Factory/Logger.php b/src/Core/Logger/Factory/Logger.php index 4ca4f050a..204835ffd 100644 --- a/src/Core/Logger/Factory/Logger.php +++ b/src/Core/Logger/Factory/Logger.php @@ -32,11 +32,11 @@ use Friendica\Core\Logger\Type\Monolog\IntrospectionProcessor; use Friendica\Core\Logger\Type\ProfilerLogger; use Friendica\Core\Logger\Type\StreamLogger; use Friendica\Core\Logger\Type\SyslogLogger; -use Friendica\Core\Logger\Type\VoidLogger; use Friendica\Util\Profiler; use Monolog; use Psr\Log\LoggerInterface; use Psr\Log\LogLevel; +use Psr\Log\NullLogger; /** * A logger factory @@ -78,7 +78,7 @@ class Logger public function create(Database $database, IManageConfigValues $config, Profiler $profiler, FileSystem $fileSystem): LoggerInterface { if (empty($config->get('system', 'debugging', false))) { - $logger = new VoidLogger(); + $logger = new NullLogger(); $database->setLogger($logger); return $logger; } @@ -107,7 +107,7 @@ class Logger } catch (\Throwable $e) { // No Logger .. /// @todo isn't it possible to give the admin any hint about this wrong configuration? - $logger = new VoidLogger(); + $logger = new NullLogger(); } } break; @@ -118,7 +118,7 @@ class Logger } catch (\Throwable $e) { // No logger ... /// @todo isn't it possible to give the admin any hint about this wrong configuration? - $logger = new VoidLogger(); + $logger = new NullLogger(); } break; @@ -132,11 +132,11 @@ class Logger } catch (\Throwable $t) { // No logger ... /// @todo isn't it possible to give the admin any hint about this wrong configuration? - $logger = new VoidLogger(); + $logger = new NullLogger(); } } else { /// @todo isn't it possible to give the admin any hint about this wrong configuration? - $logger = new VoidLogger(); + $logger = new NullLogger(); } break; } @@ -175,7 +175,7 @@ class Logger if ((!isset($developerIp) || !$debugging) && (!is_file($stream) || is_writable($stream))) { - return new VoidLogger(); + return new NullLogger(); } $loggerTimeZone = new \DateTimeZone('UTC'); diff --git a/src/Core/Logger/Type/VoidLogger.php b/src/Core/Logger/Type/VoidLogger.php deleted file mode 100644 index 5cd2cac86..000000000 --- a/src/Core/Logger/Type/VoidLogger.php +++ /dev/null @@ -1,159 +0,0 @@ -. - * - */ - -namespace Friendica\Core\Logger\Type; - -use Psr\Log\LoggerInterface; - -/** - * A Logger instance to not log - */ -class VoidLogger implements LoggerInterface -{ - /** - * System is unusable. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function emergency($message, array $context = array()) - { - return; - } - - /** - * Action must be taken immediately. - * - * Example: Entire website down, database unavailable, etc. This should - * trigger the SMS alerts and wake you up. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function alert($message, array $context = array()) - { - return; - } - - /** - * Critical conditions. - * - * Example: Application component unavailable, unexpected exception. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function critical($message, array $context = array()) - { - return; - } - - /** - * Runtime errors that do not require immediate action but should typically - * be logged and monitored. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function error($message, array $context = array()) - { - return; - } - - /** - * Exceptional occurrences that are not errors. - * - * Example: Use of deprecated APIs, poor use of an API, undesirable things - * that are not necessarily wrong. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function warning($message, array $context = array()) - { - return; - } - - /** - * Normal but significant events. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function notice($message, array $context = array()) - { - return; - } - - /** - * Interesting events. - * - * Example: User logs in, SQL logs. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function info($message, array $context = array()) - { - return; - } - - /** - * Detailed debug information. - * - * @param string $message - * @param array $context - * - * @return void - */ - public function debug($message, array $context = array()) - { - return; - } - - /** - * Logs with an arbitrary level. - * - * @param mixed $level - * @param string $message - * @param array $context - * - * @return void - */ - public function log($level, $message, array $context = array()) - { - return; - } -} diff --git a/tests/src/Console/AutomaticInstallationConsoleTest.php b/tests/src/Console/AutomaticInstallationConsoleTest.php index 3f4f8c03c..1fc307a68 100644 --- a/tests/src/Console/AutomaticInstallationConsoleTest.php +++ b/tests/src/Console/AutomaticInstallationConsoleTest.php @@ -32,11 +32,11 @@ use Friendica\Database\Database; use Friendica\DI; use Friendica\Test\Util\RendererMockTrait; use Friendica\Test\Util\VFSTrait; -use Friendica\Core\Logger\Type\VoidLogger; use Mockery; use Mockery\MockInterface; use org\bovigo\vfs\vfsStream; use org\bovigo\vfs\vfsStreamFile; +use Psr\Log\NullLogger; class AutomaticInstallationConsoleTest extends ConsoleTest { @@ -117,7 +117,7 @@ class AutomaticInstallationConsoleTest extends ConsoleTest }); $this->mode->shouldReceive('isInstall')->andReturn(true); - Logger::init(new VoidLogger()); + Logger::init(new NullLogger()); } /** diff --git a/tests/src/Contact/FriendSuggest/Factory/FriendSuggestTest.php b/tests/src/Contact/FriendSuggest/Factory/FriendSuggestTest.php index 969107316..62b90b1cc 100644 --- a/tests/src/Contact/FriendSuggest/Factory/FriendSuggestTest.php +++ b/tests/src/Contact/FriendSuggest/Factory/FriendSuggestTest.php @@ -5,7 +5,7 @@ namespace Friendica\Test\src\Contact\FriendSuggest\Factory; use Friendica\Contact\FriendSuggest\Factory\FriendSuggest; use Friendica\Contact\FriendSuggest\Entity; use Friendica\Test\MockedTest; -use Friendica\Core\Logger\Type\VoidLogger; +use Psr\Log\NullLogger; class FriendSuggestTest extends MockedTest { @@ -91,7 +91,7 @@ class FriendSuggestTest extends MockedTest public function testCreateNew() { - $factory = new FriendSuggest(new VoidLogger()); + $factory = new FriendSuggest(new NullLogger()); $this->assertFriendSuggest( $factory->createNew(12, 13), @@ -106,14 +106,14 @@ class FriendSuggestTest extends MockedTest */ public function testCreateFromTableRow(array $input, Entity\FriendSuggest $assertion) { - $factory = new FriendSuggest(new VoidLogger()); + $factory = new FriendSuggest(new NullLogger()); $this->assertFriendSuggest($factory->createFromTableRow($input), $assertion); } public function testCreateEmpty() { - $factory = new FriendSuggest(new VoidLogger()); + $factory = new FriendSuggest(new NullLogger()); $this->assertFriendSuggest($factory->createEmpty(66), new Entity\FriendSuggest(0, 0, '', '', '', '', '', new \DateTime('now', new \DateTimeZone('UTC')), 66 diff --git a/tests/src/Core/Logger/VoidLoggerTest.php b/tests/src/Core/Logger/VoidLoggerTest.php deleted file mode 100644 index a2134ce71..000000000 --- a/tests/src/Core/Logger/VoidLoggerTest.php +++ /dev/null @@ -1,52 +0,0 @@ -. - * - */ - -namespace Friendica\Test\src\Core\Logger; - -use Friendica\Test\MockedTest; -use Friendica\Core\Logger\Type\VoidLogger; -use Psr\Log\LogLevel; - -class VoidLoggerTest extends MockedTest -{ - use LoggerDataTrait; - - /** - * Test if the profiler is profiling data - * @dataProvider dataTests - * @doesNotPerformAssertions - */ - public function testNormal($function, $message, array $context) - { - $logger = new VoidLogger(); - $logger->$function($message, $context); - } - - /** - * Test the log() function - * @doesNotPerformAssertions - */ - public function testProfilingLog() - { - $logger = new VoidLogger(); - $logger->log(LogLevel::WARNING, 'test', ['a' => 'context']); - } -} diff --git a/tests/src/Profile/ProfileField/Entity/ProfileFieldTest.php b/tests/src/Profile/ProfileField/Entity/ProfileFieldTest.php index 6e054428d..9e89c9c54 100644 --- a/tests/src/Profile/ProfileField/Entity/ProfileFieldTest.php +++ b/tests/src/Profile/ProfileField/Entity/ProfileFieldTest.php @@ -11,8 +11,8 @@ use Friendica\Security\PermissionSet\Factory\PermissionSet as PermissionSetFacto use Friendica\Test\MockedTest; use Friendica\Util\ACLFormatter; use Friendica\Util\DateTimeFormat; -use Friendica\Core\Logger\Type\VoidLogger; use Mockery\MockInterface; +use Psr\Log\NullLogger; class ProfileFieldTest extends MockedTest { @@ -28,8 +28,8 @@ class ProfileFieldTest extends MockedTest parent::setUp(); $this->permissionSetRepository = \Mockery::mock(PermissionSetRepository::class); - $this->permissionSetFactory = new PermissionSetFactory(new VoidLogger(), new ACLFormatter()); - $this->profileFieldFactory = new ProfileFieldFactory(new VoidLogger(), $this->permissionSetFactory); + $this->permissionSetFactory = new PermissionSetFactory(new NullLogger(), new ACLFormatter()); + $this->profileFieldFactory = new ProfileFieldFactory(new NullLogger(), $this->permissionSetFactory); } public function dataEntity() diff --git a/tests/src/Security/TwoFactor/Factory/TrustedBrowserTest.php b/tests/src/Security/TwoFactor/Factory/TrustedBrowserTest.php index e27445d32..ca29e13a1 100644 --- a/tests/src/Security/TwoFactor/Factory/TrustedBrowserTest.php +++ b/tests/src/Security/TwoFactor/Factory/TrustedBrowserTest.php @@ -5,14 +5,14 @@ namespace Friendica\Test\src\Security\TwoFactor\Factory; use Friendica\Security\TwoFactor\Factory\TrustedBrowser; use Friendica\Test\MockedTest; use Friendica\Util\DateTimeFormat; -use Friendica\Core\Logger\Type\VoidLogger; use Friendica\Util\Strings; +use Psr\Log\NullLogger; class TrustedBrowserTest extends MockedTest { public function testCreateFromTableRowSuccess() { - $factory = new TrustedBrowser(new VoidLogger()); + $factory = new TrustedBrowser(new NullLogger()); $row = [ 'cookie_hash' => Strings::getRandomHex(), @@ -31,7 +31,7 @@ class TrustedBrowserTest extends MockedTest { $this->expectException(\TypeError::class); - $factory = new TrustedBrowser(new VoidLogger()); + $factory = new TrustedBrowser(new NullLogger()); $row = [ 'cookie_hash' => null, @@ -48,7 +48,7 @@ class TrustedBrowserTest extends MockedTest public function testCreateForUserWithUserAgent() { - $factory = new TrustedBrowser(new VoidLogger()); + $factory = new TrustedBrowser(new NullLogger()); $uid = 42; $userAgent = 'PHPUnit';