fix(debug): Removed internal constant present in new solr Symfony Debug Panel. Added optional configuration for the value.

Author: Mikolaj Misiurewicz

src/DataCollector/SolrDataCollector.php

@@ -4,6 +4,7 @@
 namespace Markup\NeedleBundle\DataCollector;
 
 use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Solarium\Core\Client\Endpoint as SolariumEndpoint;
 use Solarium\Core\Client\Request as SolariumRequest;
 use Solarium\Core\Client\Response as SolariumResponse;
@@ -56,11 +57,31 @@ class SolrDataCollector extends SolariumPlugin implements DataCollectorInterface
      */
     protected $logger;
 
+    /**
+     * @var string
+     */
+    protected $solrDashboardDomain;
+
+    /**
+     * SolrDataCollector constructor.
+     * @param array|null $options
+     */
+    public function __construct($options = null)
+    {
+        $this->logger = new NullLogger();
+        parent::__construct($options);
+    }
+
     public function setLogger(LoggerInterface $logger): void
     {
         $this->logger = $logger;
     }
 
+    public function setSolrDashboardDomain(string $solrDashboardDomain): void
+    {
+        $this->solrDashboardDomain = $solrDashboardDomain;
+    }
+
     /**
      * Parse the solr queries logged and save for use in debugging activities.
      *
@@ -173,7 +194,7 @@ protected function log(
     ): void {
         $requestUri = str_replace(
             '://localhost:',
-            '://gant-dev-solr.usemarkup.com:',
+            sprintf('://%s:', $this->solrDashboardDomain),
             $endpoint->getBaseUri().$request->getUri()
         );
 

src/DependencyInjection/Configuration.php

@@ -145,6 +145,20 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('solr')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->arrayNode('debug')
+                            ->addDefaultsIfNotSet()
+                            ->children()
+                                ->scalarNode('solr_dashboard_domain')
+                                    ->info('Used in Symfony Profiler to redirect to solr dashboard from the solr debug panel')
+                                    ->defaultValue('localhost')
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end();
 
         return $treeBuilder;

src/DependencyInjection/MarkupNeedleExtension.php

@@ -269,5 +269,8 @@ private function loadBackendSpecificServices(array $config, ContainerBuilder $co
 
         $corpusIndexProvider = $container->getDefinition(CorpusIndexProvider::class);
         $corpusIndexProvider->setArgument('$prefix', $config['elasticsearch']['index_prefix']);
+
+        $definition = $container->findDefinition('solarium.data_collector');
+        $definition->addMethodCall('setSolrDashboardDomain', [$config['solr']['debug']['solr_dashboard_domain']]);
     }
 }

src/Resources/config/services.yml

@@ -170,4 +170,4 @@ services:
             -   name: 'monolog.logger'
                 channel: 'solr'
         calls:
-            - [ 'setLogger', [ '@logger' ] ]
+            - [ 'setLogger', [ '@?logger' ] ]