Merge pull request #17 from andrew-demb/name-generator-suggestion

allflame · web-flow · commit b90f1cd7e58f · 2021-06-29T12:29:25.000+03:00
Name generator suggestions
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ You can configure custom name generators based on regular expression pattern, wh
 
 Configuration for this feature looks like key-value list, where key - regexp pattern, value - custom name generator DI service id (see details below).
 
-Name generator should implement an 'TODO' interface.
+Name generator should implement an `Jaeger\Symfony\Name\Generator\NameGeneratorInterface` interface.
 As a custom name generator you can specify a full DI service id, or just the suffix if your name generator service is named as `jaeger.name.generator.*`.
 Keys are considered body of the regular expression pattern, do not put any modifiers (e.g. `/i`, `/g`) or slashes; `route` of the request or `name` of the command should match to use alternative generator.
 Expressions are checked top to bottom, if no match is found, default generator will be used
diff --git a/src/Bridge/HandlerFlushListener.php b/src/Bridge/HandlerFlushListener.php
@@ -18,9 +18,9 @@ public function __construct(BackgroundSpanHandler $backgroundHandler, GlobalSpan
         $this->globalHandler = $globalHandler;
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
-        return [TerminateEvent::class => ['onTerminate', -16384],];
+        return [TerminateEvent::class => ['onTerminate', -16384]];
     }
 
     public function onTerminate()
diff --git a/src/Context/Extractor/ContextExtractorChain.php b/src/Context/Extractor/ContextExtractorChain.php
@@ -25,7 +25,10 @@ public function extract(): ?SpanContext
     {
         $queue = clone $this->queue;
         while (false === $queue->isEmpty()) {
-            if (null !== ($context = $queue->extract()->extract())) {
+            /** @var ContextExtractorInterface $extractor */
+            $extractor = $queue->extract();
+            $context = $extractor->extract();
+            if (null !== $context) {
                 return $context;
             }
         }
diff --git a/src/Debug/Extractor/DebugExtractorChain.php b/src/Debug/Extractor/DebugExtractorChain.php
@@ -23,7 +23,10 @@ public function getDebug(): string
     {
         $queue = clone $this->queue;
         while (false === $queue->isEmpty()) {
-            if ('' !== ($debugId = $queue->extract()->getDebug())) {
+            /** @var DebugExtractorInterface $extractor */
+            $extractor = $queue->extract();
+            $debugId = $extractor->getDebug();
+            if ('' !== $debugId) {
                 return $debugId;
             }
         }
diff --git a/src/DependencyInjection/CodecRegistryCompilerPass.php b/src/DependencyInjection/CodecRegistryCompilerPass.php
@@ -9,7 +9,7 @@
 
 class CodecRegistryCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.codec.registry')) {
             throw new \RuntimeException(
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -33,11 +33,11 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->children()
                         ->integerNode('max_length')->defaultValue(64)->end()
                         ->arrayNode('command')
-                            ->useAttributeAsKey('name')
+                            ->useAttributeAsKey('pattern')
                             ->scalarPrototype()->end()
                         ->end()
                         ->arrayNode('request')
-                            ->useAttributeAsKey('name')
+                            ->useAttributeAsKey('pattern')
                             ->scalarPrototype()->end()
                         ->end()
                     ->end()
diff --git a/src/DependencyInjection/ContextExtractorChainCompilerPass.php b/src/DependencyInjection/ContextExtractorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class ContextExtractorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.context.extractor.chain')) {
             throw new \RuntimeException(
diff --git a/src/DependencyInjection/DebugExtractorChainCompilerPass.php b/src/DependencyInjection/DebugExtractorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class DebugExtractorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.debug.extractor.chain')) {
             throw new \RuntimeException(
diff --git a/src/DependencyInjection/JaegerExtension.php b/src/DependencyInjection/JaegerExtension.php
@@ -11,13 +11,14 @@
 
 class JaegerExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader(
             $container,
             new FileLocator(__DIR__ . '/../Resources')
         );
         $loader->load('services.yml');
+
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
@@ -31,35 +32,35 @@ public function load(array $configs, ContainerBuilder $container)
                 $loader->load('shorten.yml');
                 $container->setParameter('jaeger.name.max_length', $config['name_generator']['max_length']);
             }
-            foreach ($config['name_generator']['request'] as $item => $customGeneratorId) {
-                $regexp = \sprintf('/%s/', $item);
+
+            foreach ($config['name_generator']['request'] as $pattern => $customGeneratorId) {
+                $regexp = \sprintf('/%s/', $pattern);
+
                 $shortenedGeneratorId = \sprintf('jaeger.name.generator.%s', $customGeneratorId);
                 if ($container->has($shortenedGeneratorId)) {
-                    $container->getDefinition('jaeger.name.generator.request')->addMethodCall(
-                        'add',
-                        [$regexp, new Reference($shortenedGeneratorId)]
-                    );
-                } else {
-                    $container->getDefinition('jaeger.name.generator.request')->addMethodCall(
+                    $customGeneratorId = $shortenedGeneratorId;
+                }
+
+                $container->getDefinition('jaeger.name.generator.request')
+                    ->addMethodCall(
                         'add',
                         [$regexp, new Reference($customGeneratorId)]
                     );
-                }
             }
+
             foreach ($config['name_generator']['command'] as $pattern => $customGeneratorId) {
-                $regexp = \sprintf('/%s/', $item);
+                $regexp = \sprintf('/%s/', $pattern);
+
                 $shortenedGeneratorId = \sprintf('jaeger.name.generator.%s', $customGeneratorId);
                 if ($container->has($shortenedGeneratorId)) {
-                    $container->getDefinition('jaeger.name.generator.command')->addMethodCall(
-                        'add',
-                        [$regexp, new Reference($shortenedGeneratorId)]
-                    );
-                } else {
-                    $container->getDefinition('jaeger.name.generator.command')->addMethodCall(
+                    $customGeneratorId = $shortenedGeneratorId;
+                }
+
+                $container->getDefinition('jaeger.name.generator.command')
+                    ->addMethodCall(
                         'add',
                         [$regexp, new Reference($customGeneratorId)]
                     );
-                }
             }
         }
     }
diff --git a/src/DependencyInjection/NameGeneratorChainCompilerPass.php b/src/DependencyInjection/NameGeneratorChainCompilerPass.php
@@ -9,7 +9,7 @@
 
 class NameGeneratorChainCompilerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('jaeger.name.generator.chain')) {
             throw new \RuntimeException(
diff --git a/src/JaegerBundle.php b/src/JaegerBundle.php
@@ -12,7 +12,7 @@
 
 class JaegerBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
         $container
diff --git a/src/Name/Generator/CommandNameGenerator.php b/src/Name/Generator/CommandNameGenerator.php
@@ -9,10 +9,16 @@
 
 class CommandNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
 {
+    /**
+     * @var NameGeneratorInterface[] Key - regexp, value - name generator
+     */
     private array $generators;
 
-    private string $name;
+    private string $name = '';
 
+    /**
+     * @param NameGeneratorInterface[] $generators Key - regexp, value - name generator
+     */
     public function __construct(array $generators = [])
     {
         $this->generators = $generators;
@@ -36,10 +42,11 @@ public static function getSubscribedEvents(): array
 
     public function onCommand(ConsoleCommandEvent $event): void
     {
-        if (null === $event->getCommand()) {
+        if (null === $command = $event->getCommand()) {
             return;
         }
-        $this->name = (string)$event->getCommand()->getName();
+
+        $this->name = (string)$command->getName();
     }
 
     public function onTerminate(): CommandNameGenerator
diff --git a/src/Name/Generator/ControllerNameGenerator.php b/src/Name/Generator/ControllerNameGenerator.php
@@ -9,7 +9,7 @@
 
 class ControllerNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
 {
-    private string $controller;
+    private string $controller = '';
 
     public static function getSubscribedEvents(): array
     {
diff --git a/src/Name/Generator/DefaultNameGenerator.php b/src/Name/Generator/DefaultNameGenerator.php
@@ -26,22 +26,24 @@ public static function getSubscribedEvents(): array
 
     public function onCommand(ConsoleCommandEvent $event): void
     {
-        if (null === $event->getCommand()) {
+        if (null === $command = $event->getCommand()) {
             return;
         }
 
-        $this->name = (string)$event->getCommand()->getName();
+        $this->name = (string)$command->getName();
     }
 
     public function onRequest(RequestEvent $event): void
     {
         $request = $event->getRequest();
-        if (null !== ($fragment = $request->attributes->get('is_fragment'))) {
-            $this->name = ($controller = $request->attributes->get('_controller', null))
+        if (null !== $request->attributes->get('is_fragment')) {
+            $this->name = (null !== $controller = $request->attributes->get('_controller', null))
                 ? sprintf('fragment.%s', $controller)
                 : 'fragment';
+
             return;
         }
+
         $this->name = $request->attributes->get('_route', $request->getRequestUri());
     }
 
diff --git a/src/Name/Generator/NameGeneratorChain.php b/src/Name/Generator/NameGeneratorChain.php
@@ -25,7 +25,7 @@ public function generate(): string
         while (false === $queue->isEmpty()) {
             /** @var NameGeneratorInterface $generator */
             $generator = $queue->extract();
-            $name = $generator->generate()
+            $name = $generator->generate();
             if ('' !== $name) {
                 return $name;
             }
diff --git a/src/Name/Generator/RequestNameGenerator.php b/src/Name/Generator/RequestNameGenerator.php
@@ -9,10 +9,16 @@
 
 class RequestNameGenerator implements NameGeneratorInterface, EventSubscriberInterface
 {
+    /**
+     * @var NameGeneratorInterface[] Key - regexp, value - name generator
+     */
     private array $generators;
 
-    private string $route;
+    private string $route = '';
 
+    /**
+     * @param NameGeneratorInterface[] $generators Key - regexp, value - name generator
+     */
     public function __construct(array $generators = [])
     {
         $this->generators = $generators;

Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,9 @@ public function __construct(BackgroundSpanHandler $backgroundHandler, GlobalSpan`
`18`	`18`	`$this->globalHandler = $globalHandler;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public static function getSubscribedEvents()`
	`21`	`+ public static function getSubscribedEvents(): array`
`22`	`22`	`{`
`23`		`- return [TerminateEvent::class => ['onTerminate', -16384],];`
	`23`	`+ return [TerminateEvent::class => ['onTerminate', -16384]];`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public function onTerminate()`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,10 @@ public function extract(): ?SpanContext`
`25`	`25`	`{`
`26`	`26`	`$queue = clone $this->queue;`
`27`	`27`	`while (false === $queue->isEmpty()) {`
`28`		`- if (null !== ($context = $queue->extract()->extract())) {`
	`28`	`+ /** @var ContextExtractorInterface $extractor */`
	`29`	`+ $extractor = $queue->extract();`
	`30`	`+ $context = $extractor->extract();`
	`31`	`+ if (null !== $context) {`
`29`	`32`	`return $context;`
`30`	`33`	`}`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,10 @@ public function getDebug(): string`
`23`	`23`	`{`
`24`	`24`	`$queue = clone $this->queue;`
`25`	`25`	`while (false === $queue->isEmpty()) {`
`26`		`- if ('' !== ($debugId = $queue->extract()->getDebug())) {`
	`26`	`+ /** @var DebugExtractorInterface $extractor */`
	`27`	`+ $extractor = $queue->extract();`
	`28`	`+ $debugId = $extractor->getDebug();`
	`29`	`+ if ('' !== $debugId) {`
`27`	`30`	`return $debugId;`
`28`	`31`	`}`
`29`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class CodecRegistryCompilerPass implements CompilerPassInterface`
`11`	`11`	`{`
`12`		`- public function process(ContainerBuilder $container)`
	`12`	`+ public function process(ContainerBuilder $container): void`
`13`	`13`	`{`
`14`	`14`	`if (false === $container->hasDefinition('jaeger.codec.registry')) {`
`15`	`15`	`throw new \RuntimeException(`