Remove SlackWebhook transport and replace default one

birkof · birkof · commit 152e869f84a0 · 2020-03-13T21:25:43.000+02:00
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransport.php b/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransport.php
@@ -21,30 +21,41 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ * @author Daniel Stancu <birkof@birkof.ro>
  *
  * @internal
  *
- * @experimental in 5.0
+ * @experimental in 5.1
  */
 final class SlackTransport extends AbstractTransport
 {
-    protected const HOST = 'slack.com';
+    protected const HOST = 'hooks.slack.com';
 
-    private $accessToken;
-    private $chatChannel;
+    protected $client;
+    private $path;
+    private $channel;
+    private $username;
 
-    public function __construct(string $accessToken, string $channel = null, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
+    public function __construct(string $path, string $channel, string $username, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
     {
-        $this->accessToken = $accessToken;
-        $this->chatChannel = $channel;
+        $this->path = $path;
+        $this->channel = $channel;
+        $this->username = $username;
         $this->client = $client;
 
         parent::__construct($client, $dispatcher);
     }
 
     public function __toString(): string
     {
-        return sprintf('%s://%s?channel=%s', SlackTransportFactory::SCHEME, $this->getEndpoint(), $this->chatChannel);
+        return sprintf(
+            '%s://%s/%s?channel=%s&username=%s&',
+            SlackTransportFactory::SCHEME,
+            $this->getEndpoint(),
+            $this->path,
+            $this->channel,
+            $this->username
+        );
     }
 
     public function supports(MessageInterface $message): bool
@@ -53,7 +64,9 @@ public function supports(MessageInterface $message): bool
     }
 
     /**
-     * @see https://api.slack.com/methods/chat.postMessage
+     * Sending messages using Incoming Webhooks.
+     *
+     * @see https://api.slack.com/messaging/webhooks
      */
     protected function doSend(MessageInterface $message): void
     {
@@ -69,22 +82,25 @@ protected function doSend(MessageInterface $message): void
         }
 
         $options = $opts ? $opts->toArray() : [];
-        $options['token'] = $this->accessToken;
         if (!isset($options['channel'])) {
-            $options['channel'] = $message->getRecipientId() ?: $this->chatChannel;
+            $options['channel'] = $message->getRecipientId() ?: $this->channel;
         }
+        $options['username'] = $options['username'] ?? $this->username;
         $options['text'] = $message->getSubject();
-        $response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/api/chat.postMessage', [
-            'body' => array_filter($options),
-        ]);
+
+        $response = $this->client->request(
+            'POST',
+            sprintf(
+                '%s://%s/%s',
+                'https',
+                $this->getEndpoint(),
+                $this->path
+            ),
+            ['json' => array_filter($options)]
+        );
 
         if (200 !== $response->getStatusCode()) {
             throw new TransportException(sprintf('Unable to post the Slack message: %s.', $response->getContent(false)), $response);
         }
-
-        $result = $response->toArray(false);
-        if (!$result['ok']) {
-            throw new TransportException(sprintf('Unable to post the Slack message: %s.', $result['error']), $response);
-        }
     }
 }
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransportFactory.php b/src/Symfony/Component/Notifier/Bridge/Slack/SlackTransportFactory.php
@@ -24,7 +24,6 @@
 final class SlackTransportFactory extends AbstractTransportFactory
 {
     public const SCHEME = 'slack';
-    public const SCHEME_WEBHOOK = 'slack+webhook';
 
     /**
      * @return SlackTransport
@@ -33,27 +32,21 @@ public function create(Dsn $dsn): TransportInterface
     {
         $scheme = $dsn->getScheme();
         $channel = $dsn->getOption('channel');
+        $username = $dsn->getOption('username');
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
         $port = $dsn->getPort();
 
         if (self::SCHEME === $scheme) {
-            $accessToken = $this->getUser($dsn);
+            $path = ltrim($dsn->getPath(), '/');
 
-            return (new SlackTransport($accessToken, $channel, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
-        }
-
-        if (self::SCHEME_WEBHOOK === $scheme) {
-            $webhookPath = ltrim($dsn->getPath(), '/');
-            $username = $dsn->getOption('username');
-
-            return (new SlackWebhookTransport($webhookPath, $channel, $username, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
+            return (new SlackTransport($path, $channel, $username, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
         }
 
         throw new UnsupportedSchemeException($dsn, 'slack', $this->getSupportedSchemes());
     }
 
     protected function getSupportedSchemes(): array
     {
-        return ['slack', 'slack+webhook'];
+        return ['slack'];
     }
 }
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/SlackWebhookTransport.php b/src/Symfony/Component/Notifier/Bridge/Slack/SlackWebhookTransport.php

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`	`final class SlackTransportFactory extends AbstractTransportFactory`
`25`	`25`	`{`
`26`	`26`	`public const SCHEME = 'slack';`
`27`		`- public const SCHEME_WEBHOOK = 'slack+webhook';`
`28`	`27`
`29`	`28`	`/**`
`30`	`29`	`* @return SlackTransport`
`@@ -33,27 +32,21 @@ public function create(Dsn $dsn): TransportInterface`
`33`	`32`	`{`
`34`	`33`	`$scheme = $dsn->getScheme();`
`35`	`34`	`$channel = $dsn->getOption('channel');`
	`35`	`+ $username = $dsn->getOption('username');`
`36`	`36`	`$host = 'default' === $dsn->getHost() ? null : $dsn->getHost();`
`37`	`37`	`$port = $dsn->getPort();`
`38`	`38`
`39`	`39`	`if (self::SCHEME === $scheme) {`
`40`		`- $accessToken = $this->getUser($dsn);`
	`40`	`+ $path = ltrim($dsn->getPath(), '/');`
`41`	`41`
`42`		`- return (new SlackTransport($accessToken, $channel, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
`43`		`- }`
`44`		`-`
`45`		`- if (self::SCHEME_WEBHOOK === $scheme) {`
`46`		`- $webhookPath = ltrim($dsn->getPath(), '/');`
`47`		`- $username = $dsn->getOption('username');`
`48`		`-`
`49`		`- return (new SlackWebhookTransport($webhookPath, $channel, $username, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
	`42`	`+ return (new SlackTransport($path, $channel, $username, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
`50`	`43`	`}`
`51`	`44`
`52`	`45`	`throw new UnsupportedSchemeException($dsn, 'slack', $this->getSupportedSchemes());`
`53`	`46`	`}`
`54`	`47`
`55`	`48`	`protected function getSupportedSchemes(): array`
`56`	`49`	`{`
`57`		`- return ['slack', 'slack+webhook'];`
	`50`	`+ return ['slack'];`
`58`	`51`	`}`
`59`	`52`	`}`