D3Public/loggerFactory
8
0
Fork 0
Code Pull Requests Actions Packages Projects Releases Activity

improve code style

Browse Source
This commit is contained in:
Daniel Seifert 2025-02-12 10:48:01 +01:00
parent 8e697940fb
commit 6338b58570
7 changed files with 48 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/LoggerFactory.php
View File

@ -159,4 +159,4 @@ class LoggerFactory
return OX_BASE_PATH . '/log' . DIRECTORY_SEPARATOR . $fileName;
}
}
}

24
src/ProcessorsTrait.php
View File

@ -23,7 +23,13 @@ use RuntimeException;
trait ProcessorsTrait
{
public function applyProcessors($logger, array $processorFlags): Logger
/**
* @param Logger $logger
* @param array<int|string, string|array<string, string|int>> $processorFlags
*
* @return Logger
*/
public function applyProcessors(Logger $logger, array $processorFlags): Logger
{
$this->applyUidProcessor($processorFlags, $logger);
$this->applyFilterSensitiveProcessor($processorFlags, $logger);
@ -32,11 +38,12 @@ trait ProcessorsTrait
}
/**
* @param array $processorFlags
* @param $logger
* @param array<int|string, string|array<string, string|int>> $processorFlags
* @param Logger $logger
*
* @return void
*/
protected function applyUidProcessor(array $processorFlags, $logger): void
protected function applyUidProcessor(array $processorFlags, Logger $logger): void
{
if (in_array(self::PROCESSOR_UNIQUE_ID, $processorFlags, true) ||
in_array(self::PROCESSOR_UNIQUE_ID, array_keys($processorFlags), true)
@ -46,11 +53,12 @@ trait ProcessorsTrait
}
/**
* @param array $processorFlags
* @param $logger
* @param array<int|string, string|array<string, string|int>> $processorFlags
* @param Logger $logger
*
* @return void
*/
protected function applyFilterSensitiveProcessor(array $processorFlags, $logger): void
protected function applyFilterSensitiveProcessor(array $processorFlags, Logger $logger): void
{
if (in_array(self::PROCESSOR_FILTERSENSITIVE, array_keys($processorFlags), true)) {
$options = $processorFlags[self::PROCESSOR_FILTERSENSITIVE] ?? [];
@ -63,4 +71,4 @@ trait ProcessorsTrait
$logger->pushProcessor(new SensitiveFilterProcessor($searchList));
}
}
}
}

21
src/SensitiveFilterProcessor.php
View File

@ -21,14 +21,26 @@ use Monolog\Processor\ProcessorInterface;
class SensitiveFilterProcessor implements ProcessorInterface
{
public function __construct(protected array $secrets, protected ?string $replacement = null)
protected string $replacement;
/**
* @param string[] $secrets
* @param string|null $replacement
*/
public function __construct(protected array $secrets, ?string $replacement = null)
{
$this->replacement ??= '*****';
$this->replacement = $replacement ?? '*****';
$this->convertStringsToRegex($this->secrets);
}
/**
* @param string[] $search
*
* @return void
*/
protected function convertStringsToRegex(array $search = []): void
{
$searchStrings = [];
array_map(
function ($search) use (&$searchStrings) {
if (!$this->stringIsRegexp($search)) {
@ -61,9 +73,12 @@ class SensitiveFilterProcessor implements ProcessorInterface
$item
);
} elseif (is_array($item)) {
/** @phpstan-ignore argument.type */
$records[$key] = $this($item);
}
}
/** @phpstan-ignore return.type */
return $records;
}
}
}

13
src/SpecialHandlersTrait.php
View File

@ -72,8 +72,9 @@ trait SpecialHandlersTrait
}
/**
* @param array $specialHandlerFlags
* @param array<int|string, string|array<string, string|int>> $specialHandlerFlags
* @param HandlerInterface $handler
*
* @return HandlerInterface
*/
protected function applyBufferHandler(array $specialHandlerFlags, HandlerInterface $handler): HandlerInterface
@ -94,8 +95,9 @@ trait SpecialHandlersTrait
}
/**
* @param array $specialHandlerFlags
* @param array<int|string, string|array<string, string|int>> $specialHandlerFlags
* @param HandlerInterface $handler
*
* @return HandlerInterface
*/
protected function applyLogOnErrorOnlyHandler(array $specialHandlerFlags, HandlerInterface $handler): HandlerInterface
@ -114,8 +116,9 @@ trait SpecialHandlersTrait
}
/**
* @param array $specialHandlerFlags
* @param array<int|string, string|array<string, string|int>> $specialHandlerFlags
* @param HandlerInterface $handler
*
* @return HandlerInterface
*/
protected function applyMakeUniqueHandler(array $specialHandlerFlags, HandlerInterface $handler): HandlerInterface
@ -126,7 +129,7 @@ trait SpecialHandlersTrait
} elseif (in_array(self::SPECIAL_HANDLERS_MAKE_UNIQUE, array_keys($specialHandlerFlags), true)) {
$options = $specialHandlerFlags[self::SPECIAL_HANDLERS_MAKE_UNIQUE];
$handler = $this->makeUnique(
/** @phpstan-ignore argument.type */
/** @phpstan-ignore argument.type */
$handler,
/** @phpstan-ignore argument.type */
$options[self::MAKEUNIQUE_OPTION_LEVEL] ?? Logger::ERROR,
@ -136,4 +139,4 @@ trait SpecialHandlersTrait
}
return $handler;
}
}
}

2
tests/ProcessorsTestTrait.php
View File

@ -132,4 +132,4 @@ trait ProcessorsTestTrait
yield 'misconfiguration' => [[LoggerFactory::PROCESSOR_FILTERSENSITIVE => [LoggerFactory::FILTERSENSITIVE_SECRETS => 'foo']], 0, true];
yield 'no configuration' => [[], 0, false];
}
}
}

6
tests/SensitiveFilterProcessorTest.php
View File

@ -122,7 +122,7 @@ class SensitiveFilterProcessorTest extends ApiTestCase
'subkey3' => [
'subsubkey3' => 'value+password+value+secret1',
],
]
],
];
$expected = [
@ -135,7 +135,7 @@ class SensitiveFilterProcessorTest extends ApiTestCase
'subkey3' => [
'subsubkey3' => 'value+###+value+###',
],
]
],
];
$this->assertSame(
@ -147,4 +147,4 @@ class SensitiveFilterProcessorTest extends ApiTestCase
)
);
}
}
}

2
tests/SpecialHandlersTestTrait.php
View File

@ -243,4 +243,4 @@ trait SpecialHandlersTestTrait
DeduplicationHandler::class,
];
}
}
}