feat: Create alernative factory with options array, raise dependencies

Author: Stephan Wentz

.github/workflows/build.yml

@@ -18,8 +18,8 @@ jobs:
       matrix:
         dependencies: ["lowest", "highest"]
         php-version:
-          - "8.2"
           - "8.3"
+          - "8.4"
 
     steps:
       - name: "Checkout"

.github/workflows/code_coverage.yaml

@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: shivammathur/setup-php@master
       with:
-        php-version: 8.3
+        php-version: 8.4
         coverage: xdebug
     - name: Load dependencies from cache
       id: composer-cache
@@ -23,9 +23,9 @@ jobs:
     - uses: actions/cache@v4
       with:
         path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ runner.os }}-php8.3-composer-${{ hashFiles('**/composer.json') }}
+        key: ${{ runner.os }}-php8.4-composer-${{ hashFiles('**/composer.json') }}
         restore-keys: |
-          ${{ runner.os }}-php8.3-composer-
+          ${{ runner.os }}-php8.4-composer-
 
     - run: composer install --prefer-dist --no-progress --no-suggest
     - run: php vendor/bin/phpunit --coverage-clover build/logs/clover.xml

README.md

@@ -32,6 +32,22 @@ services:
                 foo: bar
             $logger: '@logger'
 
+    # or
+    
+    Sentry\State\HubInterface:
+        factory: ['@Brainbits\MonologSentry\SentryFactory', 'createFromOptions']
+        arguments:
+            $options:
+                dsn: '%env(SENTRY_DSN)%'
+                environment: '%env(SENTRY_ENVIRONMENT)%'
+                inAppInclude: ['%kernel.project_dir%/src']
+                inAppExclude: ['%kernel.cache_dir%', '%kernel.project_dir%/vendor']
+                prefixes: ['%kernel.project_dir%']
+                release: 'web-%app_version%'
+                tags:
+                    foo: bar
+                logger: '@logger'
+
     Controlling\Sentry\Sentry\SentryHandler: ~
 
     Controlling\Sentry\EventListener\SentryConsoleListener: ~
@@ -62,4 +78,4 @@ when@prod:
             sentry_handler:
                 type: service
                 id: 'Brainbits\MonologSentry\SentryHandler'
-```
+```

composer.json

@@ -4,31 +4,30 @@
     "description": "brainbits sentry",
     "license": "proprietary",
     "require": {
-        "php": "^8.2",
+        "php": "^8.3",
         "ext-iconv": "*",
         "bgalati/monolog-sentry-handler": "^2.1",
         "jean85/pretty-package-versions": "^2.0",
         "monolog/monolog": "^3.0",
         "nyholm/psr7": "^1.2.1",
-        "psr/log": "^1.1|^2.0|^3.0",
+        "psr/log": "^3.0",
         "sentry/sentry": "^4.6.1",
-        "symfony/config": "^6.4|^7.0",
-        "symfony/dependency-injection": "^6.4|^7.0",
-        "symfony/http-client": "^6.4|^7.0",
-        "symfony/http-kernel": "^6.4|^7.0",
-        "symfony/yaml": "^6.4|^7.0"
+        "symfony/config": "^7.0",
+        "symfony/dependency-injection": "^7.0",
+        "symfony/http-client": "^7.0",
+        "symfony/http-kernel": "^7.0",
+        "symfony/yaml": "^7.0"
     },
     "require-dev": {
-        "brainbits/phpcs-standard": "^7.0.1",
+        "brainbits/phpcs-standard": "^8.0",
         "ergebnis/phpstan-rules": "^2.2",
         "nyholm/nsa": "^1.3",
-        "phpstan/phpstan": "^1.10.59",
-        "phpstan/phpstan-phpunit": "^1.3.16",
-        "phpunit/phpunit": "^11.0.4",
-        "symfony/console": "^6.4|^7.0.4",
-        "symfony/messenger": "^6.4|^7.0.4",
-        "symfony/security-bundle": "^6.4|^7.0.4",
-        "thecodingmachine/phpstan-strict-rules": "^1.0"
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^12.0",
+        "symfony/console": "^7.0.4",
+        "symfony/messenger": "^7.0.4",
+        "symfony/security-bundle": "^7.0.4"
     },
     "suggest": {
         "symfony/console": "For the console listener",

phpstan.neon.dist

@@ -3,14 +3,12 @@ parameters:
     paths:
         - src
         - tests
-    ignoreErrors:
-        - '#Method Brainbits\\MonologSentry\\SentryFactory::create\(\) has parameter .* with null as default value#'
     inferPrivatePropertyTypeFromConstructor: true
     excludePaths:
-        - src/Kernel.php
-        - src/Sentry/SentryHandler.php
-        - tests/Sentry/SentryHandlerTest.php
+        - src/SentryHandler.php
     ergebnis:
+        noParameterWithNullDefaultValue:
+              enabled: false
         noParameterWithNullableTypeDeclaration:
               enabled: false
         noExtends:
@@ -23,4 +21,3 @@ includes:
     - vendor/ergebnis/phpstan-rules/rules.neon
     - vendor/phpstan/phpstan-phpunit/extension.neon
     - vendor/phpstan/phpstan-phpunit/rules.neon
-    - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon

src/SentryFactory.php

@@ -28,10 +28,10 @@ public function __construct(
     }
 
     /**
-     * @param string[] $inAppInclude
-     * @param string[] $inAppExclude
-     * @param string[] $prefixes
-     * @param mixed[]  $tags
+     * @param string[]             $inAppInclude
+     * @param string[]             $inAppExclude
+     * @param string[]             $prefixes
+     * @param array<string, mixed> $tags
      */
     public function create(
         string|null $dsn,
@@ -42,21 +42,45 @@ public function create(
         array|null $prefixes = null,
         array|null $tags = null,
     ): HubInterface {
-        $clientBuilder = ClientBuilder::create([
-            'dsn' => $dsn ?: null,
-            'environment' => $environment, // I.e.: staging, testing, production, etc.
-            'in_app_include' => $inAppInclude ?? [],
-            'in_app_exclude' => $inAppExclude ?? [],
-            'prefixes' => $prefixes ?? [],
-            'release' => $release,
-            'attach_stacktrace' => false,
-            'default_integrations' => false,
-            'integrations' => [
-                new RequestIntegration(),
-                new EnvironmentIntegration(),
-                new FrameContextifierIntegration($this->logger),
+        return $this->createFromArray(
+            [
+                'dsn' => $dsn ?: null,
+                'environment' => $environment, // I.e.: staging, testing, production, etc.
+                'in_app_include' => $inAppInclude ?? [],
+                'in_app_exclude' => $inAppExclude ?? [],
+                'prefixes' => $prefixes ?? [],
+                'release' => $release,
+                'attach_stacktrace' => false,
+                'default_integrations' => false,
+                'integrations' => [
+                    new RequestIntegration(),
+                    new EnvironmentIntegration(),
+                    new FrameContextifierIntegration($this->logger),
+                ],
             ],
-        ]);
+            $tags,
+        );
+    }
+
+    /**
+     * @param array<string, mixed> $options
+     * @param array<string, mixed> $tags
+     */
+    public function createFromArray(array $options, array|null $tags = null): HubInterface
+    {
+        $options['dsn'] ??= null;
+        $options['in_app_include'] ??= [];
+        $options['in_app_exclude'] ??= [];
+        $options['prefixes'] ??= [];
+        $options['attach_stacktrace'] ??= false;
+        $options['default_integrations'] ??= false;
+        $options['integrations'] ??= [
+            new RequestIntegration(),
+            new EnvironmentIntegration(),
+            new FrameContextifierIntegration($this->logger),
+        ];
+
+        $clientBuilder = ClientBuilder::create($options);
 
         $clientBuilder->setLogger($this->logger);
 

tests/EventListener/HubExpections.php

@@ -30,7 +30,7 @@ private function expectHubIsConfiguredWithValues(
     ): void {
         $hub->expects($this->atLeastOnce())
             ->method('configureScope')
-            ->with($this->callback(function ($closure) use ($propertyName, $value) {
+            ->with($this->callback(function (callable $closure) use ($propertyName, $value) {
                 $scope = new Scope();
                 $closure($scope);
 

tests/SentryFactoryTest.php

@@ -12,7 +12,6 @@
 use Sentry\Client;
 use Sentry\Dsn;
 use Sentry\HttpClient\HttpClient;
-use Sentry\Options;
 use Sentry\SentrySdk;
 use Sentry\State\Layer;
 use Sentry\Transport\HttpTransport;
@@ -103,7 +102,6 @@ public function testMinimalParameters(): void
         self::assertInstanceOf(HttpTransport::class, $transport);
 
         $options = $client->getOptions();
-        self::assertInstanceOf(Options::class, $options);
 
         self::assertNull($options->getDsn());