fix: support SmsMessage with 'from' set

petski · petski · commit cc6c14f8605b · 2024-10-13T12:34:18.000+02:00
Fixes `Error Email does not comply with addr-spec of RFC 2822` See: #58535
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsEmailTransport.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsEmailTransport.php
@@ -54,7 +54,7 @@ public function supports(MessageInterface $message): bool
     }
 
     /**
-     * @param MessageInterface|SmsMessage $message
+     * @param MessageInterface $message
      *
      * @throws TransportExceptionInterface
      */
@@ -64,10 +64,12 @@ protected function doSend(MessageInterface $message): SentMessage
             throw new UnsupportedMessageTypeException(__CLASS__, SmsMessage::class, $message);
         }
 
+        \assert($message instanceof SmsMessage); // to keep psalm happy
+
         $email = (new Email())
-            ->from($message->getFrom() ?: $this->from)
+            ->from($this->from)
             ->to($this->to)
-            ->subject(sprintf('New SMS on phone number: %s', $message->getPhone()))
+            ->subject('New SMS to phone number ' . $message->getPhone() . ($message->getFrom() ? ' from ' . $message->getFrom() : ''))
             ->html($message->getSubject())
             ->text($message->getSubject());
 
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsLoggerTransport.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/FakeSmsLoggerTransport.php
@@ -55,7 +55,7 @@ protected function doSend(MessageInterface $message): SentMessage
             throw new UnsupportedMessageTypeException(__CLASS__, SmsMessage::class, $message);
         }
 
-        $this->logger->info(sprintf('New SMS on phone number: %s', $message->getPhone()));
+        $this->logger->info('New SMS to phone number ' . $message->getPhone() . ($message->getFrom() ? ' from ' . $message->getFrom() : ''));
 
         return new SentMessage($message, (string) $this);
     }
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsEmailTransportTest.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsEmailTransportTest.php
@@ -70,7 +70,30 @@ public function testSendWithDefaultTransport()
         $this->assertInstanceOf(Email::class, $sentEmail);
         $this->assertSame($to, $sentEmail->getTo()[0]->getEncodedAddress());
         $this->assertSame($from, $sentEmail->getFrom()[0]->getEncodedAddress());
-        $this->assertSame(sprintf('New SMS on phone number: %s', $phone), $sentEmail->getSubject());
+        $this->assertSame(\sprintf('New SMS to phone number %s', $phone), $sentEmail->getSubject());
+        $this->assertSame($subject, $sentEmail->getTextBody());
+        $this->assertFalse($sentEmail->getHeaders()->has('X-Transport'));
+    }
+
+    public function testSendWithFrom()
+    {
+        $transportName = null;
+
+        $message = new SmsMessage($phone = '0611223344', $subject = 'Hello!', $fromPhone = '0655667788');
+
+        $mailer = new DummyMailer();
+
+        $transport = (new FakeSmsEmailTransport($mailer, $to = 'recipient@email.net', $from = 'sender@email.net'));
+        $transport->setHost($transportName);
+
+        $transport->send($message);
+
+        /** @var Email $sentEmail */
+        $sentEmail = $mailer->getSentEmail();
+        $this->assertInstanceOf(Email::class, $sentEmail);
+        $this->assertSame($to, $sentEmail->getTo()[0]->getEncodedAddress());
+        $this->assertSame($from, $sentEmail->getFrom()[0]->getEncodedAddress());
+        $this->assertSame(\sprintf('New SMS to phone number %s from %s', $phone, $fromPhone), $sentEmail->getSubject());
         $this->assertSame($subject, $sentEmail->getTextBody());
         $this->assertFalse($sentEmail->getHeaders()->has('X-Transport'));
     }
@@ -93,7 +116,7 @@ public function testSendWithCustomTransport()
         $this->assertInstanceOf(Email::class, $sentEmail);
         $this->assertSame($to, $sentEmail->getTo()[0]->getEncodedAddress());
         $this->assertSame($from, $sentEmail->getFrom()[0]->getEncodedAddress());
-        $this->assertSame(sprintf('New SMS on phone number: %s', $phone), $sentEmail->getSubject());
+        $this->assertSame(\sprintf('New SMS to phone number %s', $phone), $sentEmail->getSubject());
         $this->assertSame($subject, $sentEmail->getTextBody());
         $this->assertTrue($sentEmail->getHeaders()->has('X-Transport'));
         $this->assertSame($transportName, $sentEmail->getHeaders()->get('X-Transport')->getBody());
diff --git a/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsLoggerTransportTest.php b/src/Symfony/Component/Notifier/Bridge/FakeSms/Tests/FakeSmsLoggerTransportTest.php
@@ -61,7 +61,7 @@ public function testSendWithDefaultTransport()
         $this->assertNotEmpty($logs);
 
         $log = $logs[0];
-        $this->assertSame(sprintf('New SMS on phone number: %s', $phone), $log['message']);
+        $this->assertSame(\sprintf('New SMS to phone number %s', $phone), $log['message']);
         $this->assertSame('info', $log['level']);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ protected function doSend(MessageInterface $message): SentMessage`
`55`	`55`	`throw new UnsupportedMessageTypeException(__CLASS__, SmsMessage::class, $message);`
`56`	`56`	`}`
`57`	`57`
`58`		`- $this->logger->info(sprintf('New SMS on phone number: %s', $message->getPhone()));`
	`58`	`+ $this->logger->info('New SMS to phone number ' . $message->getPhone() . ($message->getFrom() ? ' from ' . $message->getFrom() : ''));`
`59`	`59`
`60`	`60`	`return new SentMessage($message, (string) $this);`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function testSendWithDefaultTransport()`
`61`	`61`	`$this->assertNotEmpty($logs);`
`62`	`62`
`63`	`63`	`$log = $logs[0];`
`64`		`- $this->assertSame(sprintf('New SMS on phone number: %s', $phone), $log['message']);`
	`64`	`+ $this->assertSame(\sprintf('New SMS to phone number %s', $phone), $log['message']);`
`65`	`65`	`$this->assertSame('info', $log['level']);`
`66`	`66`	`}`
`67`	`67`	`}`