Skip to content

Commit 30772be

Browse files
LitarnusLitarnus
authored
feat(integrations): allow callbacks as integration config (#947)
1 parent 63e1eef commit 30772be

13 files changed

+269
-29
lines changed

‎phpstan-baseline.neon‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ parameters:
6767

6868
-
6969
message: "#^Cannot access offset 'integrations' on mixed\\.$#"
70-
count: 2
70+
count: 1
7171
path: src/DependencyInjection/SentryExtension.php
7272

7373
-
@@ -105,11 +105,6 @@ parameters:
105105
count: 11
106106
path: src/DependencyInjection/SentryExtension.php
107107

108-
-
109-
message: "#^Parameter \\#1 \\$integrations of method Sentry\\\\SentryBundle\\\\DependencyInjection\\\\SentryExtension\\:\\:configureIntegrationsOption\\(\\) expects array\\<string\\>, mixed given\\.$#"
110-
count: 1
111-
path: src/DependencyInjection/SentryExtension.php
112-
113108
-
114109
message: "#^Parameter \\#2 \\$array of function array_map expects array, mixed given\\.$#"
115110
count: 1

‎src/DependencyInjection/Configuration.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ public function getConfigTreeBuilder(): TreeBuilder
6060
->fixXmlConfig('ignore_transaction')
6161
->fixXmlConfig('prefix', 'prefixes')
6262
->children()
63-
->arrayNode('integrations')
64-
->scalarPrototype()->end()
63+
->variableNode('integrations')
64+
->defaultValue([])
6565
->end()
6666
->booleanNode('default_integrations')->end()
6767
->arrayNode('prefixes')

‎src/DependencyInjection/SentryExtension.php‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,17 @@ private function registerConfiguration(ContainerBuilder $container, array $confi
146146
$options['http_client'] = new Reference($options['http_client']);
147147
}
148148

149-
$container->getDefinition(IntegrationConfigurator::class)
150-
->setArgument(0, $this->configureIntegrationsOption($options['integrations'], $config))
151-
->setArgument(1, $config['register_error_handler']);
149+
if (\is_string($options['integrations']) && '' !== $options['integrations']) {
150+
$container->getDefinition(IntegrationConfigurator::class)
151+
->setArgument(0, new Reference($options['integrations']))
152+
->setArgument(1, $config['register_error_handler']);
153+
} else {
154+
$integrations = \is_array($options['integrations']) ? $options['integrations'] : [];
155+
156+
$container->getDefinition(IntegrationConfigurator::class)
157+
->setArgument(0, $this->configureIntegrationsOption($integrations, $config))
158+
->setArgument(1, $config['register_error_handler']);
159+
}
152160
$options['integrations'] = new Reference(IntegrationConfigurator::class);
153161

154162
$container

‎src/Integration/IntegrationConfigurator.php‎

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,52 +21,70 @@ final class IntegrationConfigurator
2121
];
2222

2323
/**
24-
* @var IntegrationInterface[]
24+
* @var IntegrationInterface[]|callable|mixed
2525
*/
26-
private $userIntegrations;
26+
private $userConfig;
2727

2828
/**
2929
* @var bool
3030
*/
3131
private $registerErrorHandler;
3232

3333
/**
34-
* @param IntegrationInterface[] $userIntegrations
34+
* @param IntegrationInterface[]|callable $userConfig Array of integrations or a callable that filters/returns integrations
3535
*/
36-
public function __construct(array $userIntegrations, bool $registerErrorHandler)
36+
public function __construct($userConfig, bool $registerErrorHandler)
3737
{
38-
$this->userIntegrations = $userIntegrations;
38+
$this->userConfig = $userConfig;
3939
$this->registerErrorHandler = $registerErrorHandler;
4040
}
4141

4242
/**
43-
* @see IntegrationRegistry::getIntegrationsToSetup()
44-
*
4543
* @param IntegrationInterface[] $defaultIntegrations
4644
*
4745
* @return IntegrationInterface[]
46+
*
47+
* @see IntegrationRegistry::getIntegrationsToSetup()
4848
*/
4949
public function __invoke(array $defaultIntegrations): array
5050
{
51-
$integrations = [];
52-
53-
$userIntegrationsClasses = array_map('get_class', $this->userIntegrations);
54-
$pickedIntegrationsClasses = [];
55-
51+
$filteredDefaults = [];
5652
foreach ($defaultIntegrations as $defaultIntegration) {
5753
$integrationClassName = \get_class($defaultIntegration);
5854

5955
if (!$this->registerErrorHandler && isset(self::ERROR_HANDLER_INTEGRATIONS[$integrationClassName])) {
6056
continue;
6157
}
6258

59+
$filteredDefaults[] = $defaultIntegration;
60+
}
61+
62+
if (\is_callable($this->userConfig)) {
63+
$result = ($this->userConfig)($filteredDefaults);
64+
65+
if (!\is_array($result)) {
66+
return [];
67+
}
68+
69+
return $result;
70+
}
71+
72+
$integrations = [];
73+
/** @var IntegrationInterface[] $userIntegrations */
74+
$userIntegrations = \is_array($this->userConfig) ? $this->userConfig : [];
75+
$userIntegrationsClasses = array_map('get_class', $userIntegrations);
76+
$pickedIntegrationsClasses = [];
77+
78+
foreach ($filteredDefaults as $defaultIntegration) {
79+
$integrationClassName = \get_class($defaultIntegration);
80+
6381
if (!\in_array($integrationClassName, $userIntegrationsClasses, true) && !isset($pickedIntegrationsClasses[$integrationClassName])) {
6482
$integrations[] = $defaultIntegration;
6583
$pickedIntegrationsClasses[$integrationClassName] = true;
6684
}
6785
}
6886

69-
foreach ($this->userIntegrations as $userIntegration) {
87+
foreach ($userIntegrations as $userIntegration) {
7088
$integrationClassName = \get_class($userIntegration);
7189

7290
if (!isset($pickedIntegrationsClasses[$integrationClassName])) {

‎tests/End2End/App/KernelWithExtraConfig.php‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Sentry\SentryBundle\Tests\End2End\App;
6+
7+
use Symfony\Component\Config\Loader\LoaderInterface;
8+
9+
class KernelWithExtraConfig extends Kernel
10+
{
11+
/**
12+
* @var string[]
13+
*/
14+
private $extraConfigFiles;
15+
16+
/**
17+
* @param string[] $extraConfigFiles
18+
*/
19+
public function __construct(array $extraConfigFiles)
20+
{
21+
parent::__construct('test', true);
22+
$this->extraConfigFiles = $extraConfigFiles;
23+
}
24+
25+
public function registerContainerConfiguration(LoaderInterface $loader): void
26+
{
27+
parent::registerContainerConfiguration($loader);
28+
29+
foreach ($this->extraConfigFiles as $file) {
30+
$loader->load($file);
31+
}
32+
}
33+
}

‎tests/End2End/Fixtures/FactoryCallback.php‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Sentry\SentryBundle\Tests\End2End\Fixtures;
6+
7+
final class FactoryCallback
8+
{
9+
public static function factory(): callable
10+
{
11+
return static function (array $integrations): array {
12+
$integrations[] = new TestIntegrationForFactory();
13+
14+
return $integrations;
15+
};
16+
}
17+
}

‎tests/End2End/Fixtures/InvokableCallback.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Sentry\SentryBundle\Tests\End2End\Fixtures;
6+
7+
use Sentry\Integration\IntegrationInterface;
8+
9+
final class InvokableCallback
10+
{
11+
/**
12+
* @param IntegrationInterface[] $integrations
13+
*
14+
* @return IntegrationInterface[]
15+
*/
16+
public function __invoke(array $integrations): array
17+
{
18+
$integrations[] = new TestIntegrationForInvokable();
19+
20+
return $integrations;
21+
}
22+
}

‎tests/End2End/Fixtures/TestIntegrationForFactory.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Sentry\SentryBundle\Tests\End2End\Fixtures;
6+
7+
class TestIntegrationForFactory implements \Sentry\Integration\IntegrationInterface
8+
{
9+
public function setupOnce(): void
10+
{
11+
}
12+
}

‎tests/End2End/Fixtures/TestIntegrationForInvokable.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Sentry\SentryBundle\Tests\End2End\Fixtures;
6+
7+
class TestIntegrationForInvokable implements \Sentry\Integration\IntegrationInterface
8+
{
9+
public function setupOnce(): void
10+
{
11+
}
12+
}

‎tests/End2End/Fixtures/config_factory.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
services:
2+
Sentry\SentryBundle\Tests\End2End\Fixtures\FactoryCallback:
3+
factory: ['Sentry\SentryBundle\Tests\End2End\Fixtures\FactoryCallback', 'factory']
4+
5+
sentry:
6+
options:
7+
integrations: 'Sentry\SentryBundle\Tests\End2End\Fixtures\FactoryCallback'

0 commit comments

Comments
 (0)