[Notifier] [FakeSms] Allow missing optional dependency

bschoch-schwarz · bschoch-schwarz · commit e5bcf6e194fb · 2022-12-08T12:34:17.000+01:00
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsTransportFactory.php
@@ -13,6 +13,7 @@
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Notifier\Exception\MissingFactoryDependencyException;
 use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
 use Symfony\Component\Notifier\Transport\AbstractTransportFactory;
 use Symfony\Component\Notifier\Transport\Dsn;
@@ -24,10 +25,10 @@
  */
 final class FakeSmsTransportFactory extends AbstractTransportFactory
 {
-    private MailerInterface $mailer;
-    private LoggerInterface $logger;
+    private ?MailerInterface $mailer;
+    private ?LoggerInterface $logger;
 
-    public function __construct(MailerInterface $mailer, LoggerInterface $logger)
+    public function __construct(MailerInterface $mailer = null, LoggerInterface $logger = null)
     {
         parent::__construct();
 
@@ -40,6 +41,10 @@ public function create(Dsn $dsn): FakeSmsEmailTransport|FakeSmsLoggerTransport
         $scheme = $dsn->getScheme();
 
         if ('fakesms+email' === $scheme) {
+            if ($this->mailer === null) {
+                throw new MissingFactoryDependencyException($scheme, MailerInterface::class);
+            }
+
             $mailerTransport = $dsn->getHost();
             $to = $dsn->getRequiredOption('to');
             $from = $dsn->getRequiredOption('from');
@@ -48,6 +53,10 @@ public function create(Dsn $dsn): FakeSmsEmailTransport|FakeSmsLoggerTransport
         }
 
         if ('fakesms+logger' === $scheme) {
+            if ($this->logger === null) {
+                throw new MissingFactoryDependencyException($scheme, LoggerInterface::class);
+            }
+
             return new FakeSmsLoggerTransport($this->logger);
         }
 
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsTransportFactoryTest.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsTransportFactoryTest.php
@@ -14,10 +14,35 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Notifier\Bridge\FakeSms\FakeSmsTransportFactory;
+use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Test\TransportFactoryTestCase;
+use Symfony\Component\Notifier\Transport\Dsn;
 
 final class FakeSmsTransportFactoryTest extends TransportFactoryTestCase
 {
+    /**
+     * @dataProvider missingRequiredDependencyProvider
+     */
+    public function testMissingRequiredDependency(?MailerInterface $mailer, ?LoggerInterface $logger, string $dsn, string $message)
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage($message);
+
+        $factory = new FakeSmsTransportFactory($mailer, $logger);
+        $factory->create(new Dsn($dsn));
+    }
+
+    /**
+     * @dataProvider missingOptionalDependencyProvider
+     */
+    public function testMissingOptionalDependency(?MailerInterface $mailer, ?LoggerInterface $logger, string $dsn)
+    {
+        $factory = new FakeSmsTransportFactory($mailer, $logger);
+        $transport = $factory->create(new Dsn($dsn));
+
+        $this->assertSame($dsn, (string) $transport);
+    }
+
     public function createFactory(): FakeSmsTransportFactory
     {
         return new FakeSmsTransportFactory($this->createMock(MailerInterface::class), $this->createMock(LoggerInterface::class));
@@ -63,4 +88,35 @@ public function unsupportedSchemeProvider(): iterable
     {
         yield ['somethingElse://default?to=recipient@email.net&from=sender@email.net'];
     }
+
+    public function missingRequiredDependencyProvider(): iterable
+    {
+        $exceptionMessage = 'Cannot create a transport for scheme "%s" without providing an implementation of "%s".';
+        yield 'missing mailer' => [
+            null,
+            $this->createMock(LoggerInterface::class),
+            'fakesms+email://default?to=recipient@email.net&from=sender@email.net',
+            sprintf($exceptionMessage, 'fakesms+email', MailerInterface::class),
+        ];
+        yield 'missing logger' => [
+            $this->createMock(MailerInterface::class),
+            null,
+            'fakesms+logger://default',
+            sprintf($exceptionMessage, 'fakesms+logger', LoggerInterface::class),
+        ];
+    }
+
+    public function missingOptionalDependencyProvider(): iterable
+    {
+        yield 'missing logger' => [
+            $this->createMock(MailerInterface::class),
+            null,
+            'fakesms+email://default?to=recipient@email.net&from=sender@email.net',
+        ];
+        yield 'missing mailer' => [
+            null,
+            $this->createMock(LoggerInterface::class),
+            'fakesms+logger://default',
+        ];
+    }
 }
diff --git a/src/Symfony/Component/Notifier/Exception/MissingFactoryDependencyException.php b/src/Symfony/Component/Notifier/Exception/MissingFactoryDependencyException.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Exception;
+
+/**
+ * @author Benjamin Schoch <benschoch@gmail.com>
+ */
+class MissingFactoryDependencyException extends LogicException
+{
+    public function __construct(string $scheme, string $missingType, \Throwable $previous = null)
+    {
+        $message = sprintf(
+            'Cannot create a transport for scheme "%s" without providing an implementation of "%s".',
+            $scheme,
+            $missingType
+        );
+
+        parent::__construct($message, 0, $previous);
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Transport/TransportFactoryInterface.php b/src/Symfony/Component/Notifier/Transport/TransportFactoryInterface.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Notifier\Transport;
 
 use Symfony\Component\Notifier\Exception\IncompleteDsnException;
+use Symfony\Component\Notifier\Exception\MissingFactoryDependencyException;
 use Symfony\Component\Notifier\Exception\MissingRequiredOptionException;
 use Symfony\Component\Notifier\Exception\UnsupportedSchemeException;
 
@@ -24,6 +25,7 @@ interface TransportFactoryInterface
      * @throws UnsupportedSchemeException
      * @throws IncompleteDsnException
      * @throws MissingRequiredOptionException
+     * @throws MissingFactoryDependencyException
      */
     public function create(Dsn $dsn): TransportInterface;
 
