symfony · nicolas-grekas · Dec 16, 2022 · Aug 20, 2022
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Allow to update Slack messages
+
 6.0
 ---
 

@@ -21,7 +21,7 @@
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  */
-final class SlackOptions implements MessageOptionsInterface
+class SlackOptions implements MessageOptionsInterface
 {
     private const MAX_BLOCKS = 50;
 

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Bridge\Slack;
+
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Component\Notifier\Message\SentMessage;
+
+/**
+ * @author Maxim Dovydenok <dovydenok.maxim@gmail.com>
+ */
+final class SlackSentMessage extends SentMessage
+{
+    private string $channelId;
+
+    public function __construct(MessageInterface $original, string $transport, string $channelId, string $messageId)
+    {
+        parent::__construct($original, $transport);
+        $this->channelId = $channelId;
+        $this->setMessageId($messageId);
+    }
+
+    public function getChannelId(): string
+    {
+        return $this->channelId;
+    }
+
+    public function getUpdateMessage(string $subject, array $options = []): ChatMessage
+    {
+        return new ChatMessage($subject, new UpdateMessageSlackOptions($this->channelId, $this->getMessageId(), $options));
+    }
+}
@@ -17,7 +17,6 @@
 use Symfony\Component\Notifier\Exception\UnsupportedMessageTypeException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
-use Symfony\Component\Notifier\Message\SentMessage;
 use Symfony\Component\Notifier\Transport\AbstractTransport;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
@@ -63,7 +62,7 @@ public function supports(MessageInterface $message): bool
     /**
      * @see https://api.slack.com/methods/chat.postMessage
      */
-    protected function doSend(MessageInterface $message): SentMessage
+    protected function doSend(MessageInterface $message): SlackSentMessage
     {
         if (!$message instanceof ChatMessage) {
             throw new UnsupportedMessageTypeException(__CLASS__, ChatMessage::class, $message);
@@ -82,7 +81,9 @@ protected function doSend(MessageInterface $message): SentMessage
             $options['channel'] = $message->getRecipientId() ?: $this->chatChannel;
         }
         $options['text'] = $message->getSubject();
-        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/api/chat.postMessage', [
+
+        $apiMethod = $opts instanceof UpdateMessageSlackOptions ? 'chat.update' : 'chat.postMessage';
+        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/api/'.$apiMethod, [
             'json' => array_filter($options),
             'auth_bearer' => $this->accessToken,
             'headers' => [
@@ -107,9 +108,6 @@ protected function doSend(MessageInterface $message): SentMessage
             throw new TransportException(sprintf('Unable to post the Slack message: "%s"%s.', $result['error'], $errors), $response);
         }
 
-        $sentMessage = new SentMessage($message, (string) $this);
-        $sentMessage->setMessageId($result['ts']);
-
-        return $sentMessage;
+        return new SlackSentMessage($message, (string) $this, $result['channel'], $result['ts']);
     }
 }
@@ -13,6 +13,7 @@
 
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\Notifier\Bridge\Slack\SlackOptions;
+use Symfony\Component\Notifier\Bridge\Slack\SlackSentMessage;
 use Symfony\Component\Notifier\Bridge\Slack\SlackTransport;
 use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Exception\LogicException;
@@ -115,7 +116,7 @@ public function testSendWithOptions()
 
         $response->expects($this->once())
             ->method('getContent')
-            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247']));
+            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247', 'channel' => 'C123456']));
 
         $expectedBody = json_encode(['channel' => $channel, 'text' => $message]);
 
@@ -130,6 +131,8 @@ public function testSendWithOptions()
         $sentMessage = $transport->send(new ChatMessage('testMessage'));
 
         $this->assertSame('1503435956.000247', $sentMessage->getMessageId());
+        $this->assertInstanceOf(SlackSentMessage::class, $sentMessage);
+        $this->assertSame('C123456', $sentMessage->getChannelId());
     }
 
     public function testSendWithNotification()
@@ -145,7 +148,7 @@ public function testSendWithNotification()
 
         $response->expects($this->once())
             ->method('getContent')
-            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247']));
+            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247', 'channel' => 'C123456']));
 
         $notification = new Notification($message);
         $chatMessage = ChatMessage::fromNotification($notification);
@@ -223,7 +226,7 @@ public function testSendIncludesContentTypeWithCharset()
 
         $response->expects($this->once())
             ->method('getContent')
-            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247']));
+            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247', 'channel' => 'C123456']));
 
         $client = new MockHttpClient(function (string $method, string $url, array $options = []) use ($response): ResponseInterface {
             $this->assertContains('Content-Type: application/json; charset=utf-8', $options['headers']);
@@ -263,4 +266,39 @@ public function testSendWithErrorsIncluded()
 
         $transport->send(new ChatMessage('testMessage'));
     }
+
+    public function testUpdateMessage()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+
+        $response->expects($this->exactly(2))
+            ->method('getStatusCode')
+            ->willReturn(200);
+
+        $response->expects($this->once())
+            ->method('getContent')
+            ->willReturn(json_encode(['ok' => true, 'ts' => '1503435956.000247', 'channel' => 'C123456']));
+
+        $sentMessage = new SlackSentMessage(new ChatMessage('Hello'), 'slack', 'C123456', '1503435956.000247');
+        $chatMessage = $sentMessage->getUpdateMessage('Hello World');
+
+        $expectedBody = json_encode([
+            'channel' => 'C123456',
+            'ts' => '1503435956.000247',
+            'text' => 'Hello World',
+        ]);
+
+        $client = new MockHttpClient(function (string $method, string $url, array $options = []) use ($response, $expectedBody): ResponseInterface {
+            $this->assertJsonStringEqualsJsonString($expectedBody, $options['body']);
+            $this->assertStringEndsWith('chat.update', $url);
+
+            return $response;
+        });
+
+        $transport = $this->createTransport($client, 'another-channel');
+
+        $sentMessage = $transport->send($chatMessage);
+
+        $this->assertSame('1503435956.000247', $sentMessage->getMessageId());
+    }
 }
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Bridge\Slack;
+
+/**
+ * @author Maxim Dovydenok <dovydenok.maxim@gmail.com>
+ */
+final class UpdateMessageSlackOptions extends SlackOptions
+{
+    public function __construct(string $channelId, string $messageId, array $options = [])
+    {
+        $options['channel'] = $channelId;
+        $options['ts'] = $messageId;
+
+        parent::__construct($options);
+    }
+}