From 38016b3ba3d925431114583e4e8f8acf22f72e18 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Thu, 8 Aug 2019 13:42:14 +0200
Subject: [PATCH] Created delegator factory that injects logger on services
 implementing LoggerAware, and used it for locks factory

---
 config/autoload/locks.global.php              |  4 ++
 .../Logger/LoggerAwareDelegatorFactory.php    | 20 +++++++
 .../LoggerAwareDelegatorFactoryTest.php       | 55 +++++++++++++++++++
 3 files changed, 79 insertions(+)
 create mode 100644 module/Common/src/Logger/LoggerAwareDelegatorFactory.php
 create mode 100644 module/Common/test/Logger/LoggerAwareDelegatorFactoryTest.php

diff --git a/config/autoload/locks.global.php b/config/autoload/locks.global.php
index cbf3a000..be9e7736 100644
--- a/config/autoload/locks.global.php
+++ b/config/autoload/locks.global.php
@@ -3,6 +3,7 @@ declare(strict_types=1);
 
 use Shlinkio\Shlink\Common\Cache\RedisFactory;
 use Shlinkio\Shlink\Common\Lock\RetryLockStoreDelegatorFactory;
+use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
 use Symfony\Component\Lock;
 use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 
@@ -27,6 +28,9 @@ return [
             Lock\Store\RedisStore::class => [
                 RetryLockStoreDelegatorFactory::class,
             ],
+            Lock\Factory::class => [
+                LoggerAwareDelegatorFactory::class,
+            ],
         ],
     ],
 
diff --git a/module/Common/src/Logger/LoggerAwareDelegatorFactory.php b/module/Common/src/Logger/LoggerAwareDelegatorFactory.php
new file mode 100644
index 00000000..8cb04499
--- /dev/null
+++ b/module/Common/src/Logger/LoggerAwareDelegatorFactory.php
@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Common\Logger;
+
+use Psr\Container\ContainerInterface;
+use Psr\Log;
+
+class LoggerAwareDelegatorFactory
+{
+    public function __invoke(ContainerInterface $container, $name, callable $callback)
+    {
+        $instance = $callback();
+        if ($instance instanceof Log\LoggerAwareInterface) {
+            $instance->setLogger($container->get(Log\LoggerInterface::class));
+        }
+
+        return $instance;
+    }
+}
diff --git a/module/Common/test/Logger/LoggerAwareDelegatorFactoryTest.php b/module/Common/test/Logger/LoggerAwareDelegatorFactoryTest.php
new file mode 100644
index 00000000..8723077b
--- /dev/null
+++ b/module/Common/test/Logger/LoggerAwareDelegatorFactoryTest.php
@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\Common\Logger;
+
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+use Psr\Container\ContainerInterface;
+use Psr\Log;
+use Psr\Log\LoggerInterface;
+use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
+use stdClass;
+
+class LoggerAwareDelegatorFactoryTest extends TestCase
+{
+    /** @var LoggerAwareDelegatorFactory */
+    private $delegator;
+    /** @var ObjectProphecy */
+    private $container;
+
+    public function setUp(): void
+    {
+        $this->container = $this->prophesize(ContainerInterface::class);
+        $this->delegator = new LoggerAwareDelegatorFactory();
+    }
+
+    /**
+     * @test
+     * @dataProvider provideInstances
+     */
+    public function injectsLoggerOnInstanceWhenImplementingLoggerAware($instance, int $expectedCalls): void
+    {
+        $callback = function () use ($instance) {
+            return $instance;
+        };
+        $getLogger = $this->container->get(Log\LoggerInterface::class)->willReturn(new Log\NullLogger());
+
+        $result = ($this->delegator)($this->container->reveal(), '', $callback);
+
+        $this->assertSame($instance, $result);
+        $getLogger->shouldHaveBeenCalledTimes($expectedCalls);
+    }
+
+    public function provideInstances(): iterable
+    {
+        yield 'no logger aware' => [new stdClass(), 0];
+        yield 'logger aware' => [new class implements Log\LoggerAwareInterface {
+            public function setLogger(LoggerInterface $logger): void
+            {
+                Assert::assertInstanceOf(Log\NullLogger::class, $logger);
+            }
+        }, 1];
+    }
+}