Add monolog.logger.algolia

composer.json

@@ -41,6 +41,7 @@
         "phpunit/phpunit": "^8.5 || ^9.0",
         "roave/security-advisories": "dev-master",
         "symfony/framework-bundle": "^7.0",
+        "symfony/monolog-bundle": "^3.10",
         "symfony/phpunit-bridge": "^7.0",
         "symfony/proxy-manager-bridge": "*",
         "symfony/yaml": "^7.0"

phpstan.neon.dist

@@ -20,3 +20,4 @@ parameters:
         - '#Class Algolia\\SearchBundle\\Settings\\SettingsManager is neither abstract nor final.#'
         - '#Class Algolia\\SearchBundle\\EventListener\\SearchIndexerSubscriber is neither abstract nor final.#'
         - '#Method Algolia\\SearchBundle\\Model\\Aggregator::normalize\(\) has parameter .* with a nullable type declaration.#'
+        - '#Method Algolia\\SearchBundle\\.*::__construct\(\) has parameter \$logger with a nullable type declaration.#'

src/DependencyInjection/AlgoliaSearchExtension.php

@@ -7,6 +7,7 @@
 use Algolia\SearchBundle\Settings\SettingsManager;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
@@ -70,8 +71,10 @@ public function load(array $configs, ContainerBuilder $container)
                 new Reference($config['serializer']),
                 $engineDefinition,
                 $config,
+                new Reference('logger', ContainerInterface::IGNORE_ON_INVALID_REFERENCE),
             ]
         ));
+        $searchServiceDefinition->addTag('monolog.logger', ['channel' => 'algolia']);
 
         $searchServiceDefinitionForAtomicReindex = (clone $searchServiceDefinition);
         $searchServiceDefinitionForAtomicReindex->replaceArgument(

src/Services/AlgoliaSearchService.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\SearchBundle\Services;
 
+use Algolia\AlgoliaSearch\Algolia;
 use Algolia\AlgoliaSearch\RequestOptions\RequestOptions;
 use Algolia\SearchBundle\Engine;
 use Algolia\SearchBundle\Entity\Aggregator;
@@ -10,6 +11,8 @@
 use Algolia\SearchBundle\SearchService;
 use Algolia\SearchBundle\Util\ClassInfo;
 use Doctrine\Persistence\ObjectManager;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Symfony\Component\Config\Definition\Exception\Exception;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 
@@ -62,15 +65,19 @@ final class AlgoliaSearchService implements SearchService
 
     private $normalizer;
 
+    private LoggerInterface $logger;
+
     /**
      * @param array<string, array|int|string> $configuration
      */
-    public function __construct($normalizer, Engine $engine, array $configuration)
+    public function __construct($normalizer, Engine $engine, array $configuration, ?LoggerInterface $logger = null)
     {
         $this->normalizer       = $normalizer;
         $this->engine           = $engine;
         $this->configuration    = $configuration;
         $this->propertyAccessor = PropertyAccess::createPropertyAccessor();
+        $this->logger           = $logger ?? new NullLogger();
+        Algolia::setLogger($this->logger);
 
         $this->setSearchableEntities();
         $this->setAggregatorsAndEntitiesAggregators();

tests/Kernel.php

@@ -19,6 +19,7 @@ public function registerBundles(): array
             new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
             new \Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
             new \JMS\SerializerBundle\JMSSerializerBundle(),
+            new \Symfony\Bundle\MonologBundle\MonologBundle(),
             new AlgoliaSearchBundle(),
         ];
     }

tests/TestCase/SearchServiceTest.php

@@ -2,13 +2,17 @@
 
 namespace Algolia\SearchBundle\TestCase;
 
+use Algolia\AlgoliaSearch\Algolia;
 use Algolia\SearchBundle\BaseTest;
 use Algolia\SearchBundle\TestApp\Entity\Comment;
 use Algolia\SearchBundle\TestApp\Entity\ContentAggregator;
 use Algolia\SearchBundle\TestApp\Entity\Image;
 use Algolia\SearchBundle\TestApp\Entity\Link;
 use Algolia\SearchBundle\TestApp\Entity\Post;
 use Algolia\SearchBundle\TestApp\Entity\Tag;
+use PHPUnit\Framework\Constraint\IsType;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
 
 class SearchServiceTest extends BaseTest
 {
@@ -211,4 +215,26 @@ public function testShouldNotBeIndexed(): void
         self::assertFalse($this->searchService->shouldBeIndexed($link));
         $this->cleanUp();
     }
+
+    public function testUseLogger(): void
+    {
+        $logger = $this->createMock(LoggerInterface::class);
+
+        self::ensureKernelShutdown();
+        self::getContainer()->set('monolog.logger.algolia', $logger);
+        $this->searchService = $this->get('search.service');
+
+        $this->assertSame($logger, Algolia::getLogger());
+        $logger
+            ->expects($this->atLeastOnce())
+            ->method('log')
+            ->with(
+                LogLevel::DEBUG,
+                new IsType('string'),
+                new IsType('array')
+            )
+        ;
+
+        $this->cleanUp();
+    }
 }