bug #60588 [Notifier][Clicksend] Fix lack of recipient in case DSN does not have optional LIST_ID param (alifanau)

nicolas-grekas · nicolas-grekas · commit 174c892195fe · 2025-05-30T09:50:54.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Notifier][Clicksend] Fix lack of recipient in case DSN does not have optional LIST_ID param | Q | A | ------------- | --- | Branch? |6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | - | License | MIT This PR fixes an issue in the ClickSend Notifier bridge where a message would fail to send if the DSN does not include the optional `LIST_ID` parameter. According to the [ClickSend API documentation] (https://developers.clicksend.com/docs/messaging/sms/other/send-sms/#request&path=messages/list_id), either the `to` field or a `list_id` must be present. In some cases, the `list_id` may be omitted, and the transport must fall back to the `to` recipient value instead. Also added forwarding the `FROM_EMAIL` value to the request. Because following code in line 78 looks like typo: `$options['from_email'] ?? $this->fromEmail;` Commits ------- 207e2f9 Fix: Lack of recipient in case DSN does not have optional LIST_ID parameter.
diff --git a/src/Symfony/Component/Notifier/Bridge/ClickSend/ClickSendTransport.php b/src/Symfony/Component/Notifier/Bridge/ClickSend/ClickSendTransport.php
@@ -75,13 +75,13 @@ protected function doSend(MessageInterface $message): SentMessage
         $options['from'] = $message->getFrom() ?: $this->from;
         $options['source'] ??= $this->source;
         $options['list_id'] ??= $this->listId;
-        $options['from_email'] ?? $this->fromEmail;
+        $options['from_email'] ??= $this->fromEmail;
 
         if (isset($options['from']) && !preg_match('/^[a-zA-Z0-9\s]{3,11}$/', $options['from']) && !preg_match('/^\+[1-9]\d{1,14}$/', $options['from'])) {
             throw new InvalidArgumentException(sprintf('The "From" number "%s" is not a valid phone number, shortcode, or alphanumeric sender ID.', $options['from']));
         }
 
-        if ($options['list_id'] ?? false) {
+        if (!$options['list_id']) {
             $options['to'] = $message->getPhone();
         }
 
diff --git a/src/Symfony/Component/Notifier/Bridge/ClickSend/Tests/ClickSendTransportTest.php b/src/Symfony/Component/Notifier/Bridge/ClickSend/Tests/ClickSendTransportTest.php
@@ -24,7 +24,7 @@
 
 final class ClickSendTransportTest extends TransportTestCase
 {
-    public static function createTransport(?HttpClientInterface $client = null, string $from = 'test_from', string $source = 'test_source', int $listId = 99, string $fromEmail = 'foo@bar.com'): ClickSendTransport
+    public static function createTransport(?HttpClientInterface $client = null, ?string $from = 'test_from', ?string $source = 'test_source', ?int $listId = 99, ?string $fromEmail = 'foo@bar.com'): ClickSendTransport
     {
         return new ClickSendTransport('test_username', 'test_key', $from, $source, $listId, $fromEmail, $client ?? new MockHttpClient());
     }
@@ -70,13 +70,40 @@ public function testNoInvalidArgumentExceptionIsThrownIfFromIsValid(string $from
             $body = json_decode($options['body'], true);
             self::assertIsArray($body);
             self::assertArrayHasKey('messages', $body);
+            $message = reset($body['messages']);
+            self::assertArrayHasKey('from_email', $message);
+            self::assertArrayHasKey('list_id', $message);
+            self::assertArrayNotHasKey('to', $message);
 
             return $response;
         });
         $transport = $this->createTransport($client, $from);
         $transport->send($message);
     }
 
+    public function testNoInvalidArgumentExceptionIsThrownIfFromIsValidWithoutOptionalParameters()
+    {
+        $message = new SmsMessage('+33612345678', 'Hello!');
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects(self::exactly(2))->method('getStatusCode')->willReturn(200);
+        $response->expects(self::once())->method('getContent')->willReturn('');
+        $client = new MockHttpClient(function (string $method, string $url, array $options) use ($response): ResponseInterface {
+            self::assertSame('POST', $method);
+            self::assertSame('https://rest.clicksend.com/v3/sms/send', $url);
+
+            $body = json_decode($options['body'], true);
+            self::assertIsArray($body);
+            self::assertArrayHasKey('messages', $body);
+            $message = reset($body['messages']);
+            self::assertArrayNotHasKey('list_id', $message);
+            self::assertArrayHasKey('to', $message);
+
+            return $response;
+        });
+        $transport = $this->createTransport($client, null, null, null, null);
+        $transport->send($message);
+    }
+
     public static function toStringProvider(): iterable
     {
         yield ['clicksend://rest.clicksend.com?from=test_from&source=test_source&list_id=99&from_email=foo%40bar.com', self::createTransport()];

Original file line number	Diff line number	Diff line change
`@@ -75,13 +75,13 @@ protected function doSend(MessageInterface $message): SentMessage`
`75`	`75`	`$options['from'] = $message->getFrom() ?: $this->from;`
`76`	`76`	`$options['source'] ??= $this->source;`
`77`	`77`	`$options['list_id'] ??= $this->listId;`
`78`		`- $options['from_email'] ?? $this->fromEmail;`
	`78`	`+ $options['from_email'] ??= $this->fromEmail;`
`79`	`79`
`80`	`80`	`if (isset($options['from']) && !preg_match('/^[a-zA-Z0-9\s]{3,11}$/', $options['from']) && !preg_match('/^\+[1-9]\d{1,14}$/', $options['from'])) {`
`81`	`81`	`throw new InvalidArgumentException(sprintf('The "From" number "%s" is not a valid phone number, shortcode, or alphanumeric sender ID.', $options['from']));`
`82`	`82`	`}`
`83`	`83`
`84`		`- if ($options['list_id'] ?? false) {`
	`84`	`+ if (!$options['list_id']) {`
`85`	`85`	`$options['to'] = $message->getPhone();`
`86`	`86`	`}`
`87`	`87`