Merge branch '5.1' into 5.2

nicolas-grekas · nicolas-grekas · commit 26ce5b4c2029 · 2020-12-18T11:35:32.000+01:00
* 5.1:
  [Notifier] [Mattermost] Host is required
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostTransport.php b/src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostTransport.php
@@ -29,11 +29,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);
     }
@@ -57,14 +59,15 @@ protected function doSend(MessageInterface $message): SentMessage
             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),
@@ -88,4 +91,9 @@ protected function getEndpoint(): ?string
     {
         return $this->host.($this->port ? ':'.$this->port : '');
     }
+
+    protected function getEndpoint(): ?string
+    {
+        return rtrim($this->host.($this->port ? ':'.$this->port : '').($this->path ?? ''), '/');
+    }
 }
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostTransportFactory.php b/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
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/README.md b/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
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/Tests/MattermostTransportFactoryTest.php b/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://accessToken@example.com/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://accessToken@example.com/sub/?channel=testChannel'));
+
+        $this->assertSame('mattermost://example.com/sub?channel=testChannel', (string) $transport);
+    }
+
     public function testCreateWithMissingOptionChannelThrowsIncompleteDsnException()
     {
         $factory = $this->createFactory();
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/Tests/MattermostTransportTest.php b/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;
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,13 @@ final class MattermostTransport extends AbstractTransport`
`29`	`29`	`{`
`30`	`30`	`private $token;`
`31`	`31`	`private $channel;`
	`32`	`+ private $path;`
`32`	`33`
`33`		`- public function __construct(string $token, string $channel, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null)`
	`34`	`+ public function __construct(string $token, string $channel, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, string $path = null)`
`34`	`35`	`{`
`35`	`36`	`$this->token = $token;`
`36`	`37`	`$this->channel = $channel;`
	`38`	`+ $this->path = $path;`
`37`	`39`
`38`	`40`	`parent::__construct($client, $dispatcher);`
`39`	`41`	`}`
`@@ -57,14 +59,15 @@ protected function doSend(MessageInterface $message): SentMessage`
`57`	`59`	`throw new LogicException(sprintf('The "%s" transport only supports instances of "%s" (instance of "%s" given).', __CLASS__, ChatMessage::class, get_debug_type($message)));`
`58`	`60`	`}`
`59`	`61`
`60`		`- $endpoint = sprintf('https://%s/api/v4/posts', $this->getEndpoint());`
`61`		`-`
`62`	`62`	`$options = ($opts = $message->getOptions()) ? $opts->toArray() : [];`
`63`	`63`	`$options['message'] = $message->getSubject();`
`64`	`64`
`65`	`65`	`if (!isset($options['channel_id'])) {`
`66`	`66`	`$options['channel_id'] = $message->getRecipientId() ?: $this->channel;`
`67`	`67`	`}`
	`68`	`+`
	`69`	`+ $endpoint = sprintf('https://%s/api/v4/posts', $this->getEndpoint());`
	`70`	`+`
`68`	`71`	`$response = $this->client->request('POST', $endpoint, [`
`69`	`72`	`'auth_bearer' => $this->token,`
`70`	`73`	`'json' => array_filter($options),`
`@@ -88,4 +91,9 @@ protected function getEndpoint(): ?string`
`88`	`91`	`{`
`89`	`92`	`return $this->host.($this->port ? ':'.$this->port : '');`
`90`	`93`	`}`
	`94`	`+`
	`95`	`+ protected function getEndpoint(): ?string`
	`96`	`+ {`
	`97`	`+ return rtrim($this->host.($this->port ? ':'.$this->port : '').($this->path ?? ''), '/');`
	`98`	`+ }`
`91`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public function create(Dsn $dsn): TransportInterface`
`32`	`32`	`throw new UnsupportedSchemeException($dsn, 'mattermost', $this->getSupportedSchemes());`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ $path = $dsn->getPath();`
`35`	`36`	`$token = $this->getUser($dsn);`
`36`	`37`	`$channel = $dsn->getOption('channel');`
`37`	`38`
`@@ -42,7 +43,7 @@ public function create(Dsn $dsn): TransportInterface`
`42`	`43`	`$host = $dsn->getHost();`
`43`	`44`	`$port = $dsn->getPort();`
`44`	`45`
`45`		`- return (new MattermostTransport($token, $channel, $this->client, $this->dispatcher))->setHost($host)->setPort($port);`
	`46`	`+ return (new MattermostTransport($token, $channel, $this->client, $this->dispatcher, $path))->setHost($host)->setPort($port);`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`protected function getSupportedSchemes(): array`