From 3b66b9679daba421d74dc945bc101195c042180a Mon Sep 17 00:00:00 2001 From: Alexandre Allier Date: Fri, 23 Aug 2024 15:36:42 +0200 Subject: [PATCH] bump: EB-0 Upgrade dependencies --- .../CompilerPass/HttpClientPass.php | 2 +- DependencyInjection/Configuration.php | 41 +++++++++---------- EventSubscriber/TracingEventSubscriber.php | 10 +++-- .../Formatter/TokenCollectionFormatter.php | 4 +- .../ContentDataModifier/AddJiraLink.php | 6 +-- .../AddKibanaTokenFilterLinks.php | 4 +- .../AddClassLineContextTest.php | 5 ++- .../ContentDataModifier/AddJiraLinkTest.php | 5 ++- .../AddKibanaTokenFilterLinksTest.php | 5 ++- ...odesHttpExceptionExclusionStrategyTest.php | 9 ++-- .../Handler/IgnoreDeprecationHandlerTest.php | 5 ++- composer.json | 1 + phpunit.xml.dist | 20 +++------ 13 files changed, 58 insertions(+), 59 deletions(-) diff --git a/DependencyInjection/CompilerPass/HttpClientPass.php b/DependencyInjection/CompilerPass/HttpClientPass.php index 3a45c51..cc1a9ac 100644 --- a/DependencyInjection/CompilerPass/HttpClientPass.php +++ b/DependencyInjection/CompilerPass/HttpClientPass.php @@ -20,7 +20,7 @@ */ class HttpClientPass implements CompilerPassInterface { - private const DECORATOR_PRIORITY = 5; + private const int DECORATOR_PRIORITY = 5; public function process(ContainerBuilder $container): void { diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php index 1464cf6..5a7fb25 100644 --- a/DependencyInjection/Configuration.php +++ b/DependencyInjection/Configuration.php @@ -4,7 +4,7 @@ namespace ETSGlobal\LogBundle\DependencyInjection; -use Monolog\Logger; +use Monolog\Level; use Symfony\Component\Config\Definition\Builder\TreeBuilder; use Symfony\Component\Config\Definition\ConfigurationInterface; use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException; @@ -15,16 +15,16 @@ /** @internal */ final class Configuration implements ConfigurationInterface { - private const DEFAULT_APP_NAME = 'default'; + private const string DEFAULT_APP_NAME = 'default'; // phpcs:ignore Generic.Files.LineLength.TooLong - private const DEFAULT_LOG_FORMAT = "[%%datetime%%][%%token_collection%%] %%channel%%.%%level_name%%: %%message%% %%context%% %%extra%%\n"; - private const DEFAULT_SLACK_CHANNEL = '#random'; - private const DEFAULT_SLACK_ICON_EMOJI = ':warning'; - private const DEFAULT_HTTP_EXCEPTIONS_LEVELS = [ - BadRequestHttpException::class => Logger::WARNING, - AccessDeniedHttpException::class => Logger::WARNING, - NotFoundHttpException::class => Logger::WARNING, - UnauthorizedHttpException::class => Logger::WARNING, + private const string DEFAULT_LOG_FORMAT = "[%%datetime%%][%%token_collection%%] %%channel%%.%%level_name%%: %%message%% %%context%% %%extra%%\n"; + private const string DEFAULT_SLACK_CHANNEL = '#random'; + private const string DEFAULT_SLACK_ICON_EMOJI = ':warning'; + private const array DEFAULT_HTTP_EXCEPTIONS_LEVELS = [ + BadRequestHttpException::class => Level::Warning->value, + AccessDeniedHttpException::class => Level::Warning->value, + NotFoundHttpException::class => Level::Warning->value, + UnauthorizedHttpException::class => Level::Warning->value, ]; public function getConfigTreeBuilder(): TreeBuilder @@ -41,14 +41,14 @@ public function getConfigTreeBuilder(): TreeBuilder ->defaultValue(self::DEFAULT_HTTP_EXCEPTIONS_LEVELS) ->useAttributeAsKey('name') ->prototype('enum')->values([ - Logger::DEBUG, - Logger::INFO, - Logger::NOTICE, - Logger::WARNING, - Logger::ERROR, - Logger::CRITICAL, - Logger::ALERT, - Logger::EMERGENCY, + Level::Debug->value, + Level::Info->value, + Level::Notice->value, + Level::Warning->value, + Level::Error->value, + Level::Critical->value, + Level::Alert->value, + Level::Emergency->value, ])->end() ->end() ->arrayNode('custom_exceptions_levels') @@ -62,13 +62,12 @@ public function getConfigTreeBuilder(): TreeBuilder ->scalarNode('token')->cannotBeEmpty()->defaultValue('')->end() ->scalarNode('channel')->cannotBeEmpty()->defaultValue(self::DEFAULT_SLACK_CHANNEL)->end() ->scalarNode('icon_emoji')->cannotBeEmpty()->defaultValue(self::DEFAULT_SLACK_ICON_EMOJI)->end() - ->scalarNode('log_level')->cannotBeEmpty()->defaultValue(Logger::ERROR)->end() + ->scalarNode('log_level')->cannotBeEmpty()->defaultValue(Level::Error->value)->end() ->scalarNode('jira_url')->cannotBeEmpty()->defaultValue('')->end() ->scalarNode('kibana_url')->cannotBeEmpty()->defaultValue('')->end() ->end() ->end() - ->end() - ; + ->end(); return $treeBuilder; } diff --git a/EventSubscriber/TracingEventSubscriber.php b/EventSubscriber/TracingEventSubscriber.php index b3798ce..821c3ec 100644 --- a/EventSubscriber/TracingEventSubscriber.php +++ b/EventSubscriber/TracingEventSubscriber.php @@ -18,11 +18,13 @@ /** @internal */ final class TracingEventSubscriber implements EventSubscriberInterface { - private const HIGHEST_PRIORITY = 512; - private const LOWEST_PRIORITY = -512; + private const int HIGHEST_PRIORITY = 512; + private const int LOWEST_PRIORITY = -512; - public function __construct(private TokenCollection $tokenCollection, private HttpFoundation $httpFoundation) - { + public function __construct( + private readonly TokenCollection $tokenCollection, + private readonly HttpFoundation $httpFoundation, + ) { } public function onKernelRequest(RequestEvent $event): void diff --git a/Monolog/Formatter/TokenCollectionFormatter.php b/Monolog/Formatter/TokenCollectionFormatter.php index f89d1f2..96a5d91 100644 --- a/Monolog/Formatter/TokenCollectionFormatter.php +++ b/Monolog/Formatter/TokenCollectionFormatter.php @@ -13,8 +13,8 @@ final class TokenCollectionFormatter extends LineFormatter { public function __construct( - private TokenCollection $tokenCollection, - private ?string $originalFormat = null, + private readonly TokenCollection $tokenCollection, + private readonly ?string $originalFormat = null, ?string $dateFormat = null, bool $allowInlineLineBreaks = false, bool $ignoreEmptyContextAndExtra = false, diff --git a/Monolog/Handler/ContentDataModifier/AddJiraLink.php b/Monolog/Handler/ContentDataModifier/AddJiraLink.php index 09318ed..4585c9f 100644 --- a/Monolog/Handler/ContentDataModifier/AddJiraLink.php +++ b/Monolog/Handler/ContentDataModifier/AddJiraLink.php @@ -7,16 +7,16 @@ /** @internal */ final class AddJiraLink implements ContentDataModifierInterface { - private const JIRA_PATH = '/secure/CreateIssue.jspa'; + private const string JIRA_PATH = '/secure/CreateIssue.jspa'; - private const URI_PARAMS = [ + private const array URI_PARAMS = [ 'pid=10631', // Project ID 'issueType=1', // Bug 'summary=%1$s', // Replaced by log message 'description=%1$s', // Replaced by log message ]; - public function __construct(private string $jiraUrl) + public function __construct(private readonly string $jiraUrl) { } diff --git a/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinks.php b/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinks.php index 5252238..167ed90 100644 --- a/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinks.php +++ b/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinks.php @@ -10,9 +10,9 @@ final class AddKibanaTokenFilterLinks implements ContentDataModifierInterface { // phpcs:disable Generic.Files.LineLength.TooLong - private const KIBANA_URI_PATTERN = '#/?_g=(filters:!(),time:(from:now-24h,to:now))&_a=(columns:!(_source),filters:!((\'$state\':(store:appState),meta:(alias:!n,disabled:!f,key:%1$s,negate:!f,params:(query:%2$s),type:phrase),query:(match_phrase:(%1$s:%2$s)))),interval:auto,query:(language:kuery,query:\'\'),sort:!())'; + private const string KIBANA_URI_PATTERN = '#/?_g=(filters:!(),time:(from:now-24h,to:now))&_a=(columns:!(_source),filters:!((\'$state\':(store:appState),meta:(alias:!n,disabled:!f,key:%1$s,negate:!f,params:(query:%2$s),type:phrase),query:(match_phrase:(%1$s:%2$s)))),interval:auto,query:(language:kuery,query:\'\'),sort:!())'; - public function __construct(private string $kibanaUrl, private TokenCollection $tokenCollection) + public function __construct(private readonly string $kibanaUrl, private readonly TokenCollection $tokenCollection) { } diff --git a/Tests/Monolog/Handler/ContentDataModifier/AddClassLineContextTest.php b/Tests/Monolog/Handler/ContentDataModifier/AddClassLineContextTest.php index 022c062..0aec5c0 100644 --- a/Tests/Monolog/Handler/ContentDataModifier/AddClassLineContextTest.php +++ b/Tests/Monolog/Handler/ContentDataModifier/AddClassLineContextTest.php @@ -5,6 +5,7 @@ namespace Tests\ETSGlobal\LogBundle\Monolog\Handler\ContentDataModifier; use ETSGlobal\LogBundle\Monolog\Handler\ContentDataModifier\AddClassLineContext; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; /** @internal */ @@ -17,7 +18,7 @@ protected function setUp(): void $this->modifier = new AddClassLineContext(); } - /** @dataProvider modifyDataProvider */ + #[DataProvider('modifyDataProvider')] public function testAddsClassLineToAttachements(array $record, array $expectedContentData): void { $contentData = []; @@ -27,7 +28,7 @@ public function testAddsClassLineToAttachements(array $record, array $expectedCo $this->assertEquals($expectedContentData, $contentData); } - public function modifyDataProvider(): array + public static function modifyDataProvider(): array { return [ [ diff --git a/Tests/Monolog/Handler/ContentDataModifier/AddJiraLinkTest.php b/Tests/Monolog/Handler/ContentDataModifier/AddJiraLinkTest.php index 793a6bf..4579680 100644 --- a/Tests/Monolog/Handler/ContentDataModifier/AddJiraLinkTest.php +++ b/Tests/Monolog/Handler/ContentDataModifier/AddJiraLinkTest.php @@ -5,6 +5,7 @@ namespace Tests\ETSGlobal\LogBundle\Monolog\Handler\ContentDataModifier; use ETSGlobal\LogBundle\Monolog\Handler\ContentDataModifier\AddJiraLink; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; /** @internal */ @@ -17,7 +18,7 @@ protected function setUp(): void $this->modifier = new AddJiraLink('https://example.jira.com'); } - /** @dataProvider modifyDataProvider */ + #[DataProvider('modifyDataProvider')] public function testAddsJiraLink(array $record, array $expectedContentData): void { $contentData = []; @@ -27,7 +28,7 @@ public function testAddsJiraLink(array $record, array $expectedContentData): voi $this->assertEquals($expectedContentData, $contentData); } - public function modifyDataProvider(): array + public static function modifyDataProvider(): array { // phpcs:disable Generic.Files.LineLength.TooLong return [ diff --git a/Tests/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinksTest.php b/Tests/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinksTest.php index 66cd7ec..93b6190 100644 --- a/Tests/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinksTest.php +++ b/Tests/Monolog/Handler/ContentDataModifier/AddKibanaTokenFilterLinksTest.php @@ -6,6 +6,7 @@ use ETSGlobal\LogBundle\Monolog\Handler\ContentDataModifier\AddKibanaTokenFilterLinks; use ETSGlobal\LogBundle\Tracing\TokenCollection; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; /** @internal */ @@ -25,7 +26,7 @@ protected function setUp(): void ); } - /** @dataProvider modifyDataProvider */ + #[DataProvider('modifyDataProvider')] public function testAddsTokensToContents(array $record, array $tokens, array $expectedContentData): void { $contentData = []; @@ -39,7 +40,7 @@ public function testAddsTokensToContents(array $record, array $tokens, array $ex $this->assertEquals($expectedContentData, $contentData); } - public function modifyDataProvider(): array + public static function modifyDataProvider(): array { // phpcs:disable Generic.Files.LineLength.TooLong return [ diff --git a/Tests/Monolog/Handler/ExclusionStrategy/StatusCodesHttpExceptionExclusionStrategyTest.php b/Tests/Monolog/Handler/ExclusionStrategy/StatusCodesHttpExceptionExclusionStrategyTest.php index e4d148d..857c9bb 100644 --- a/Tests/Monolog/Handler/ExclusionStrategy/StatusCodesHttpExceptionExclusionStrategyTest.php +++ b/Tests/Monolog/Handler/ExclusionStrategy/StatusCodesHttpExceptionExclusionStrategyTest.php @@ -7,6 +7,7 @@ use ETSGlobal\LogBundle\Monolog\Handler\ExclusionStrategy\StatusCodesHttpExceptionExclusionStrategy; use Monolog\Logger; use Monolog\LogRecord; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; use Symfony\Component\HttpKernel\Exception\BadRequestHttpException; use Symfony\Component\HttpKernel\Exception\ConflictHttpException; @@ -56,7 +57,7 @@ public function testDoesNotExcludeRecordWhenInvalidException(): void ); } - public function exceptionProvider(): array + public static function exceptionProvider(): array { return [ [new ConflictHttpException()], @@ -64,7 +65,7 @@ public function exceptionProvider(): array ]; } - /** @dataProvider exceptionProvider */ + #[DataProvider('exceptionProvider')] public function testDoesNotExcludeRecordsWhenStatusCodesNotExcluded(\Throwable $exception): void { $this->assertFalse( @@ -81,7 +82,7 @@ public function testDoesNotExcludeRecordsWhenStatusCodesNotExcluded(\Throwable $ ); } - public function excludedExceptionProvider(): array + public static function excludedExceptionProvider(): array { return [ [new BadRequestHttpException()], @@ -89,7 +90,7 @@ public function excludedExceptionProvider(): array ]; } - /** @dataProvider excludedExceptionProvider */ + #[DataProvider('excludedExceptionProvider')] public function testExcludesRecordsWhenExcludedExceptionCodes(\Throwable $exception): void { $this->assertTrue( diff --git a/Tests/Monolog/Handler/IgnoreDeprecationHandlerTest.php b/Tests/Monolog/Handler/IgnoreDeprecationHandlerTest.php index aa1b18a..4bad0dc 100644 --- a/Tests/Monolog/Handler/IgnoreDeprecationHandlerTest.php +++ b/Tests/Monolog/Handler/IgnoreDeprecationHandlerTest.php @@ -7,11 +7,12 @@ use ETSGlobal\LogBundle\Monolog\Handler\IgnoreDeprecationHandler; use Monolog\Logger; use Monolog\LogRecord; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; class IgnoreDeprecationHandlerTest extends TestCase { - public function provideData(): array + public static function provideData(): array { return [ [ @@ -50,7 +51,7 @@ public function provideData(): array ]; } - /** @dataProvider provideData */ + #[DataProvider('provideData')] public function testHandle(LogRecord $record, bool $expected): void { $handler = new IgnoreDeprecationHandler(); diff --git a/composer.json b/composer.json index 0b9665a..456f7e5 100644 --- a/composer.json +++ b/composer.json @@ -6,6 +6,7 @@ "require": { "php": "^8.3", "ext-json": "*", + "graylog2/gelf-php": "^2.0", "symfony/config": "^7.0", "symfony/console": "^7.0", "symfony/dependency-injection": "^7.0", diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 8629daf..0e4cd0b 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,16 +1,6 @@ - - - - . - - + @@ -19,7 +9,9 @@ Tests - - - + + + . + +