Ensure non-empty phone and email in *Message classes

jschaedl · jschaedl · commit d11567f8d37d · 2020-08-07T10:12:34.000+02:00
diff --git a/src/Symfony/Component/Notifier/Message/EmailMessage.php b/src/Symfony/Component/Notifier/Message/EmailMessage.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mime\Email;
 use Symfony\Component\Mime\RawMessage;
+use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Notification\Notification;
 use Symfony\Component\Notifier\Recipient\EmailRecipientInterface;
@@ -37,6 +38,10 @@ public function __construct(RawMessage $message, Envelope $envelope = null)
 
     public static function fromNotification(Notification $notification, EmailRecipientInterface $recipient): self
     {
+        if ('' === $recipient->getEmail()) {
+            throw new InvalidArgumentException(sprintf('"%s" needs an email, it cannot be empty.', static::class));
+        }
+
         if (!class_exists(NotificationEmail::class)) {
             $email = (new Email())
                 ->to($recipient->getEmail())
diff --git a/src/Symfony/Component/Notifier/Message/SmsMessage.php b/src/Symfony/Component/Notifier/Message/SmsMessage.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Notifier\Message;
 
+use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Notification\Notification;
 use Symfony\Component\Notifier\Recipient\SmsRecipientInterface;
 
@@ -27,6 +28,10 @@ final class SmsMessage implements MessageInterface
 
     public function __construct(string $phone, string $subject)
     {
+        if ('' === $phone) {
+            throw new InvalidArgumentException(sprintf('"%s" needs a phone number, it cannot be empty.', static::class));
+        }
+
         $this->subject = $subject;
         $this->phone = $phone;
     }
@@ -41,6 +46,10 @@ public static function fromNotification(Notification $notification, SmsRecipient
      */
     public function phone(string $phone): self
     {
+        if ('' === $phone) {
+            throw new InvalidArgumentException(sprintf('"%s" needs a phone number, it cannot be empty.', static::class));
+        }
+
         $this->phone = $phone;
 
         return $this;
diff --git a/src/Symfony/Component/Notifier/Tests/Message/EmailMessageTest.php b/src/Symfony/Component/Notifier/Tests/Message/EmailMessageTest.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Notifier\Tests\Message;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Notifier\Message\EmailMessage;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\Recipient\Recipient;
+
+/**
+ * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ */
+class EmailMessageTest extends TestCase
+{
+    public function testEnsureNonEmptyEmailOnCreationFromNotification()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('"Symfony\Component\Notifier\Message\EmailMessage" needs an email, it cannot be empty.');
+
+        EmailMessage::fromNotification(new Notification(), new Recipient('', '+3312345678'));
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Tests/Message/SmsMessageTest.php b/src/Symfony/Component/Notifier/Tests/Message/SmsMessageTest.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Notifier\Tests\Message;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Notifier\Message\SmsMessage;
+
+/**
+ * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
+ */
+class SmsMessageTest extends TestCase
+{
+    public function testCanBeConstructed()
+    {
+        $message = new SmsMessage('+3312345678', 'subject');
+
+        $this->assertSame('subject', $message->getSubject());
+        $this->assertSame('+3312345678', $message->getPhone());
+    }
+
+    public function testEnsureNonEmptyPhoneOnConstruction()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('"Symfony\Component\Notifier\Message\SmsMessage" needs a phone number, it cannot be empty.');
+
+        new SmsMessage('', 'subject');
+    }
+
+    public function testSetPhone()
+    {
+        $message = new SmsMessage('+3312345678', 'subject');
+
+        $this->assertSame('+3312345678', $message->getPhone());
+
+        $message->phone('+4912345678');
+
+        $this->assertSame('+4912345678', $message->getPhone());
+    }
+
+    public function testEnsureNonEmptyPhoneOnSet()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('"Symfony\Component\Notifier\Message\SmsMessage" needs a phone number, it cannot be empty.');
+
+        $message = new SmsMessage('+3312345678', 'subject');
+
+        $this->assertSame('+3312345678', $message->getPhone());
+
+        $message->phone('');
+    }
+}
diff --git a/src/Symfony/Component/Notifier/composer.json b/src/Symfony/Component/Notifier/composer.json
@@ -17,7 +17,8 @@
     ],
     "require": {
         "php": ">=7.2.5",
-        "symfony/polyfill-php80": "^1.15"
+        "symfony/polyfill-php80": "^1.15",
+        "psr/log": "~1.0"
     },
     "conflict": {
         "symfony/http-kernel": "<4.4",
