bug #59611 [Mailer][Notifier] Fix channel parameter value to fixed value for Mailer and Notifier Sweego Transports (welcoMattic)

fabpot · fabpot · commit 90103f10dcbc · 2025-01-25T08:59:19.000+01:00
This PR was merged into the 7.2 branch. Discussion ---------- [Mailer][Notifier] Fix channel parameter value to fixed value for Mailer and Notifier Sweego Transports | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Issues | Fix #...  | License | MIT Sweego made a change on their API: the `channel` parameter in body is now mandatory with no default value (their documentation does not reflect this yet, but `@pydubreucq` reach me directly for this change). As the fix is surgical and does not require backward compatibility layer, I guess we can pass it as bug fix. WDYT `@OskarStark`? Commits ------- c24fd12 fix(sweego): Fix channel parameter value to fixed value for Mailer and Notifier Transports
diff --git a/src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Transport/SweegoApiTransportTest.php b/src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Transport/SweegoApiTransportTest.php
@@ -110,6 +110,9 @@ public function testSend()
             $this->assertSame('https://api.sweego.io:8984/send', $url);
             $this->assertStringContainsString('Accept: */*', $options['headers'][2] ?? $options['request_headers'][1]);
 
+            $payload = json_decode($options['body'], true);
+            $this->assertSame('email', $payload['channel']);
+
             return new JsonMockResponse(['transaction_id' => 'foobar'], [
                 'http_code' => 200,
             ]);
diff --git a/src/Symfony/Component/Mailer/Bridge/Sweego/Transport/SweegoApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sweego/Transport/SweegoApiTransport.php
@@ -90,6 +90,7 @@ private function getPayload(Email $email, Envelope $envelope): array
             'from' => $this->formatAddress($envelope->getSender()),
             'subject' => $email->getSubject(),
             'campaign-type' => 'transac',
+            'channel' => 'email',
         ];
 
         if ($email->getTextBody()) {
diff --git a/src/Symfony/Component/Notifier/Bridge/Sweego/Tests/SweegoTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Sweego/Tests/SweegoTransportTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Notifier\Bridge\Sweego\Tests;
 
 use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpClient\Response\JsonMockResponse;
 use Symfony\Component\Notifier\Bridge\Sweego\SweegoTransport;
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
 use Symfony\Component\Notifier\Message\ChatMessage;
@@ -68,4 +69,22 @@ public function testSendWithInvalidMessageType()
         $message = $this->createMock(MessageInterface::class);
         $transport->send($message);
     }
+
+    public function testSendSmsMessage()
+    {
+        $client = new MockHttpClient(function ($method, $url, $options) {
+            $this->assertSame('POST', $method);
+            $this->assertSame('https://api.sweego.io/send', $url);
+
+            $body = json_decode($options['body'], true);
+            $this->assertSame('sms', $body['channel']);
+
+            return new JsonMockResponse(['swg_uids' => ['123']]);
+        });
+
+        $transport = self::createTransport($client);
+        $sentMessage = $transport->send(new SmsMessage('0611223344', 'Hello!'));
+
+        $this->assertSame('123', $sentMessage->getMessageId());
+    }
 }
