[Notifier] unsupported options exception

raphael-geffroy · fabpot · commit 27dfb8c1ecb5 · 2024-12-18T09:31:59.000+01:00
diff --git a/src/Symfony/Component/Notifier/Bridge/GoIp/GoIpTransport.php b/src/Symfony/Component/Notifier/Bridge/GoIp/GoIpTransport.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SentMessage;
 use Symfony\Component\Notifier\Message\SmsMessage;
@@ -63,7 +64,7 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         if (($options = $message->getOptions()) && !$options instanceof GoIpOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports an instance of the "%s" as an option class.', __CLASS__, GoIpOptions::class));
+            throw new UnsupportedOptionsException(__CLASS__, GoIpOptions::class, $options);
         }
 
         if ('' !== $message->getFrom()) {
diff --git a/src/Symfony/Component/Notifier/Bridge/GoIp/composer.json b/src/Symfony/Component/Notifier/Bridge/GoIp/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/Symfony/Component/Notifier/Bridge/GoogleChat/GoogleChatTransport.php b/src/Symfony/Component/Notifier/Bridge/GoogleChat/GoogleChatTransport.php
@@ -12,9 +12,9 @@
 namespace Symfony\Component\Notifier\Bridge\GoogleChat;
 
 use Symfony\Component\HttpClient\Exception\JsonException;
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SentMessage;
@@ -74,7 +74,7 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         if (($options = $message->getOptions()) && !$options instanceof GoogleChatOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports instances of "%s" for options.', __CLASS__, GoogleChatOptions::class));
+            throw new UnsupportedOptionsException(__CLASS__, GoogleChatOptions::class, $options);
         }
 
         if (!$options) {
diff --git a/src/Symfony/Component/Notifier/Bridge/GoogleChat/Tests/GoogleChatTransportTest.php b/src/Symfony/Component/Notifier/Bridge/GoogleChat/Tests/GoogleChatTransportTest.php
@@ -14,8 +14,8 @@
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\Notifier\Bridge\GoogleChat\GoogleChatOptions;
 use Symfony\Component\Notifier\Bridge\GoogleChat\GoogleChatTransport;
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageOptionsInterface;
 use Symfony\Component\Notifier\Message\SmsMessage;
@@ -159,14 +159,15 @@ public function testSendWithNotification()
 
     public function testSendWithInvalidOptions()
     {
-        $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('The "'.GoogleChatTransport::class.'" transport only supports instances of "'.GoogleChatOptions::class.'" for options.');
+        $options = $this->createMock(MessageOptionsInterface::class);
+        $this->expectException(UnsupportedOptionsException::class);
+        $this->expectExceptionMessage(\sprintf('The "%s" transport only supports instances of "%s" for options (instance of "%s" given).', GoogleChatTransport::class, GoogleChatOptions::class, get_debug_type($options)));
 
         $client = new MockHttpClient(fn (string $method, string $url, array $options = []): ResponseInterface => $this->createMock(ResponseInterface::class));
 
         $transport = self::createTransport($client);
 
-        $transport->send(new ChatMessage('testMessage', $this->createMock(MessageOptionsInterface::class)));
+        $transport->send(new ChatMessage('testMessage', $options));
     }
 
     public function testSendWith200ResponseButNotOk()
diff --git a/src/Symfony/Component/Notifier/Bridge/GoogleChat/composer.json b/src/Symfony/Component/Notifier/Bridge/GoogleChat/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\GoogleChat\\": "" },
diff --git a/src/Symfony/Component/Notifier/Bridge/JoliNotif/JoliNotifTransport.php b/src/Symfony/Component/Notifier/Bridge/JoliNotif/JoliNotifTransport.php
@@ -13,9 +13,9 @@
 
 use Joli\JoliNotif\DefaultNotifier as JoliNotifier;
 use Joli\JoliNotif\Notification as JoliNotification;
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\RuntimeException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\DesktopMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SentMessage;
@@ -51,7 +51,7 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         if (($options = $message->getOptions()) && !$options instanceof JoliNotifOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports an instance of the "%s" as an option class.', __CLASS__, JoliNotifOptions::class));
+            throw new UnsupportedOptionsException(__CLASS__, JoliNotifOptions::class, $options);
         }
 
         $joliNotification = $this->buildJoliNotificationObject($message, $options);
diff --git a/src/Symfony/Component/Notifier/Bridge/JoliNotif/composer.json b/src/Symfony/Component/Notifier/Bridge/JoliNotif/composer.json
@@ -24,7 +24,7 @@
         "php": ">=8.2",
         "jolicode/jolinotif": "^2.7.2|^3.0",
         "symfony/http-client": "^7.2",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/Symfony/Component/Notifier/Bridge/LinkedIn/LinkedInTransport.php b/src/Symfony/Component/Notifier/Bridge/LinkedIn/LinkedInTransport.php
@@ -12,9 +12,9 @@
 namespace Symfony\Component\Notifier\Bridge\LinkedIn;
 
 use Symfony\Component\Notifier\Bridge\LinkedIn\Share\AuthorShare;
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SentMessage;
@@ -61,7 +61,7 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         if (($options = $message->getOptions()) && !$options instanceof LinkedInOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports instances of "%s" for options.', __CLASS__, LinkedInOptions::class));
+            throw new UnsupportedOptionsException(__CLASS__, LinkedInOptions::class, $options);
         }
 
         if (!$options && $notification = $message->getNotification()) {
diff --git a/src/Symfony/Component/Notifier/Bridge/LinkedIn/composer.json b/src/Symfony/Component/Notifier/Bridge/LinkedIn/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\LinkedIn\\": "" },
diff --git a/src/Symfony/Component/Notifier/Bridge/Mercure/MercureTransport.php b/src/Symfony/Component/Notifier/Bridge/Mercure/MercureTransport.php
@@ -15,9 +15,9 @@
 use Symfony\Component\Mercure\Exception\RuntimeException as MercureRuntimeException;
 use Symfony\Component\Mercure\HubInterface;
 use Symfony\Component\Mercure\Update;
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\RuntimeException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SentMessage;
@@ -67,7 +67,7 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         if (($options = $message->getOptions()) && !$options instanceof MercureOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports instances of "%s" for options.', __CLASS__, MercureOptions::class));
+            throw new UnsupportedOptionsException(__CLASS__, MercureOptions::class, $options);
         }
 
         $options ??= new MercureOptions($this->topics);
diff --git a/src/Symfony/Component/Notifier/Bridge/Mercure/composer.json b/src/Symfony/Component/Notifier/Bridge/Mercure/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/mercure": "^0.5.2|^0.6",
-        "symfony/notifier": "^7.2",
+        "symfony/notifier": "^7.3",
         "symfony/service-contracts": "^2.5|^3"
     },
     "autoload": {
diff --git a/src/Symfony/Component/Notifier/Bridge/Ntfy/NtfyTransport.php b/src/Symfony/Component/Notifier/Bridge/Ntfy/NtfyTransport.php
@@ -11,9 +11,9 @@
 
 namespace Symfony\Component\Notifier\Bridge\Ntfy;
 
-use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Exception\TransportException;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;
 use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\PushMessage;
 use Symfony\Component\Notifier\Message\SentMessage;
@@ -65,8 +65,8 @@ protected function doSend(MessageInterface $message): SentMessage
             throw new UnsupportedMessageTypeException(__CLASS__, PushMessage::class, $message);
         }
 
-        if ($message->getOptions() && !$message->getOptions() instanceof NtfyOptions) {
-            throw new LogicException(\sprintf('The "%s" transport only supports instances of "%s" for options.', __CLASS__, NtfyOptions::class));
+        if (($options = $message->getOptions()) && !$message->getOptions() instanceof NtfyOptions) {
+            throw new UnsupportedOptionsException(__CLASS__, NtfyOptions::class, $options);
         }
 
         if (!($opts = $message->getOptions()) && $notification = $message->getNotification()) {
diff --git a/src/Symfony/Component/Notifier/Bridge/Ntfy/composer.json b/src/Symfony/Component/Notifier/Bridge/Ntfy/composer.json
@@ -19,7 +19,7 @@
         "php": ">=8.2",
         "symfony/clock": "^6.4|^7.0",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\Ntfy\\": "" },
diff --git a/src/Symfony/Component/Notifier/Exception/UnsupportedOptionsException.php b/src/Symfony/Component/Notifier/Exception/UnsupportedOptionsException.php
@@ -0,0 +1,25 @@
+<?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;
+
+use Symfony\Component\Notifier\Message\MessageOptionsInterface;
+
+/**
+ * @author Raphaël Geffroy <raphael@geffroy.dev>
+ */
+class UnsupportedOptionsException extends LogicException
+{
+    public function __construct(string $transport, string $supported, MessageOptionsInterface $given)
+    {
+        parent::__construct(\sprintf('The "%s" transport only supports instances of "%s" for options (instance of "%s" given).', $transport, $supported, get_debug_type($given)));
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Symfony\Component\Notifier\Exception\LogicException;`
`15`	`15`	`use Symfony\Component\Notifier\Exception\TransportException;`
`16`	`16`	`use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;`
	`17`	`+use Symfony\Component\Notifier\Exception\UnsupportedOptionsException;`
`17`	`18`	`use Symfony\Component\Notifier\Message\MessageInterface;`
`18`	`19`	`use Symfony\Component\Notifier\Message\SentMessage;`
`19`	`20`	`use Symfony\Component\Notifier\Message\SmsMessage;`
`@@ -63,7 +64,7 @@ protected function doSend(MessageInterface $message): SentMessage`
`63`	`64`	`}`
`64`	`65`
`65`	`66`	`if (($options = $message->getOptions()) && !$options instanceof GoIpOptions) {`
`66`		`- throw new LogicException(\sprintf('The "%s" transport only supports an instance of the "%s" as an option class.', __CLASS__, GoIpOptions::class));`
	`67`	`+ throw new UnsupportedOptionsException(__CLASS__, GoIpOptions::class, $options);`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`if ('' !== $message->getFrom()) {`