bug symfony#39545 [Notifier] [Mattermost] Host is required (OskarStark)

This PR was squashed before being merged into the 5.1 branch.

Discussion
----------

[Notifier] [Mattermost] Host is required

| Q             | A
| ------------- | ---
| Branch?       | 5.1
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | ---
| License       | MIT
| Doc PR        | ---

This bridge is the only one right now which cannot use `default` as host in the DSN, otherwise it would fall back to:
https://github.com/symfony/symfony/blob/090b4256f0032e1309d086b873743b330fd21df1/src/Symfony/Component/Notifier/Transport/AbstractTransport.php#L30

it could also not use:
https://github.com/symfony/symfony/blob/090b4256f0032e1309d086b873743b330fd21df1/src/Symfony/Component/Notifier/Transport/AbstractTransport.php#L83-L86

Based on the [documentation](https://api.mattermost.com/#tag/authentication) you must use your specific url like:
`your-mattermost-url.com/api/v4/...`

Using `localhost` would have weird side-effects.

Can you confirm this @thePanz , as you provided the bridge?

friendly ping @seb37800, you fixed some bugs in this transport

### Todos after merge
* [ ] adjust recipes with new DSN
* [ ] update the docs

Commits
-------

cd5b480 [Notifier] [Mattermost] Host is required

Author: nicolas-grekas

src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostTransport.php

@@ -28,11 +28,13 @@ final class MattermostTransport extends AbstractTransport
 {
     private $token;
     private $channel;
+    private $path;
 
-    public function __construct(string $token, string $channel, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)
+    public function __construct(string $token, string $channel, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, string $path = null)
     {
         $this->token = $token;
         $this->channel = $channel;
+        $this->path = $path;
 
         parent::__construct($client, $dispatcher);
     }
@@ -56,14 +58,15 @@ protected function doSend(MessageInterface $message): void
             throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" (instance of "%s" given).', __CLASS__, ChatMessage::class, get_debug_type($message)));
         }
 
-        $endpoint = sprintf('https://%s/api/v4/posts', $this->getEndpoint());
-
         $options = ($opts = $message->getOptions()) ? $opts->toArray() : [];
         $options['message'] = $message->getSubject();
 
         if (!isset($options['channel_id'])) {
             $options['channel_id'] = $message->getRecipientId() ?: $this->channel;
         }
+
+        $endpoint = sprintf('https://%s/api/v4/posts', $this->getEndpoint());
+
         $response = $this->client->request('POST', $endpoint, [
             'auth_bearer' => $this->token,
             'json' => array_filter($options),
@@ -75,4 +78,9 @@ protected function doSend(MessageInterface $message): void
             throw new TransportException(sprintf('Unable to post the Mattermost message: %s (%s).', $result['message'], $result['id']), $response);
         }
     }
+
+    protected function getEndpoint(): ?string
+    {
+        return rtrim($this->host.($this->port ? ':'.$this->port : '').($this->path ?? ''), '/');
+    }
 }

src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostTransportFactory.php

@@ -32,6 +32,7 @@ public function create(Dsn $dsn): TransportInterface
             throw new UnsupportedSchemeException($dsn, 'mattermost', $this->getSupportedSchemes());
         }
 
+        $path = $dsn->getPath();
         $token = $this->getUser($dsn);
         $channel = $dsn->getOption('channel');
 
@@ -42,7 +43,7 @@ public function create(Dsn $dsn): TransportInterface
         $host = $dsn->getHost();
         $port = $dsn->getPort();
 
-        return (new MattermostTransport($token, $channel, $this->client, $this->dispatcher))->setHost($host)->setPort($port);
+        return (new MattermostTransport($token, $channel, $this->client, $this->dispatcher, $path))->setHost($host)->setPort($port);
     }
 
     protected function getSupportedSchemes(): array

src/Symfony/Component/Notifier/Bridge/Mattermost/README.md

@@ -7,11 +7,13 @@ DSN example
 -----------
 
 ```
-MATTERMOST_DSN=mattermost://ACCESS_TOKEN@default?channel=CHANNEL
+MATTERMOST_DSN=mattermost://ACCESS_TOKEN@HOST/PATH?channel=CHANNEL
 ```
 
 where:
  - `ACCESS_TOKEN` is your Mattermost access token
+ - `HOST` is your Mattermost host
+ - `PATH` is your Mattermost sub-path (optional)
  - `CHANNEL` is your Mattermost channel
 
 Resources

src/Symfony/Component/Notifier/Bridge/Mattermost/Tests/MattermostTransportFactoryTest.php

@@ -31,6 +31,24 @@ public function testCreateWithDsn()
         $this->assertSame('mattermost://host.test?channel=testChannel', (string) $transport);
     }
 
+    public function testCreateWithDsnHostWithSubfolder()
+    {
+        $factory = $this->createFactory();
+
+        $transport = $factory->create(Dsn::fromString('mattermost://[email protected]/sub?channel=testChannel'));
+
+        $this->assertSame('mattermost://example.com/sub?channel=testChannel', (string) $transport);
+    }
+
+    public function testCreateWithDsnHostWithSubfolderWithTrailingSlash()
+    {
+        $factory = $this->createFactory();
+
+        $transport = $factory->create(Dsn::fromString('mattermost://[email protected]/sub/?channel=testChannel'));
+
+        $this->assertSame('mattermost://example.com/sub?channel=testChannel', (string) $transport);
+    }
+
     public function testCreateWithMissingOptionChannelThrowsIncompleteDsnException()
     {
         $factory = $this->createFactory();

src/Symfony/Component/Notifier/Bridge/Mattermost/Tests/MattermostTransportTest.php

@@ -16,6 +16,7 @@
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Message\ChatMessage;
 use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**