[Notifier] Add Esendex message ID to SentMessage object

The Esendex API request returns a unique message ID for each SMS sent. This commit simply extracts the message ID and adds it to the returned SentMessage object.
symfony · fabpot · Aug 26, 2021 · Aug 26, 2021 · Aug 26, 2021 · 3489e448bb2e3dee71cc9692b61a4d6e1d72ba13
commit 3489e448bb2e3dee71cc9692b61a4d6e1d72ba13
@@ -1,6 +1,8 @@
 CHANGELOG
 =========

+ * Add returned message ID to `SentMessage`
- * Add returned message ID to `SentMessage`
+5.4
+---
+
+ * Add returned message ID to `SentMessage`
- * Add returned message ID to `SentMessage`
+5.4
+---
+
+ * Add returned message ID to `SentMessage`
+
 5.3
 ---


@@ -69,6 +69,9 @@ protected function doSend(MessageInterface $message): SentMessage

        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/v1.0/messagedispatcher', [
            'auth_basic' => sprintf('%s:%s', $this->email, $this->password),
+            'headers' => [
+                'Accept' => 'application/json',
+            ],
            'json' => [
                'accountreference' => $this->accountReference,
                'messages' => [$messageData],
@@ -82,7 +85,15 @@ protected function doSend(MessageInterface $message): SentMessage
        }

        if (200 === $statusCode) {
-            return new SentMessage($message, (string) $this);
+            $result = $response->toArray();
+            $sentMessage = new SentMessage($message, (string) $this);
+
+            $messageId = $result['batch']['messageheaders'][0]['id'] ?? null;
+            if ($messageId) {
+                $sentMessage->setMessageId($messageId);
+            }
+
+            return $sentMessage;
        }

        $message = sprintf('Unable to send the SMS: error %d.', $statusCode);

@@ -19,6 +19,7 @@
 use Symfony\Component\Notifier\Message\SmsMessage;
 use Symfony\Component\Notifier\Test\TransportTestCase;
 use Symfony\Component\Notifier\Transport\TransportInterface;
+use Symfony\Component\Uid\Uuid;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;

@@ -88,4 +89,26 @@ public function testSendWithErrorResponseContainingDetailsThrowsTransportExcepti

        $transport->send(new SmsMessage('phone', 'testMessage'));
    }
+
+    public function testSendWithSuccessfulResponseDispatchesMessageEvent()
+    {
+        $messageId = Uuid::v4()->toRfc4122();
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects($this->exactly(2))
+            ->method('getStatusCode')
+            ->willReturn(200);
+        $response->expects($this->once())
+            ->method('getContent')
+            ->willReturn(json_encode(['batch' => ['messageheaders' => [['id' => $messageId]]]]));
+
+        $client = new MockHttpClient(static function () use ($response): ResponseInterface {
+            return $response;
+        });
+
+        $transport = $this->createTransport($client);
+
+        $sentMessage = $transport->send(new SmsMessage('phone', 'testMessage'));
+
+        $this->assertSame($messageId, $sentMessage->getMessageId());
+    }
 }