minor #32608 [Mailer][DX] Improve exception message for unsupported scheme (Koc)

fabpot · fabpot · commit 7dfc97be9f3c · 2019-07-22T11:17:59.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Mailer][DX] Improve exception message for unsupported scheme | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | waiting for Travis | Fixed tickets | - | License | MIT | Doc PR | - This PR improves exception message for unsupported schemes by providing list of available. Throw something like: ` 'The "foo" scheme is not supported for mailer "mailgun". Supported schemes are: "api", "http", "smtp".'` Commits ------- 8c24a53 [Mailer][DX] Improve exception message for unsupported scheme
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Factory/SesTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Amazon/Factory/SesTransportFactory.php
@@ -41,7 +41,7 @@ public function create(Dsn $dsn): TransportInterface
             return new Amazon\Smtp\SesTransport($user, $password, $region, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['api', 'http', 'smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Tests/Factory/SesTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Amazon/Tests/Factory/SesTransportFactoryTest.php
@@ -86,7 +86,10 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'ses', self::USER, self::PASSWORD)];
+        yield [
+            new Dsn('foo', 'ses', self::USER, self::PASSWORD),
+            'The "foo" scheme is not supported for mailer "ses". Supported schemes are: "api", "http", "smtp".',
+        ];
     }
 
     public function incompleteDsnProvider(): iterable
diff --git a/src/Symfony/Component/Mailer/Bridge/Google/Factory/GmailTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Google/Factory/GmailTransportFactory.php
@@ -28,7 +28,7 @@ public function create(Dsn $dsn): TransportInterface
             return new GmailTransport($this->getUser($dsn), $this->getPassword($dsn), $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Google/Tests/Factory/GmailTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Google/Tests/Factory/GmailTransportFactoryTest.php
@@ -38,7 +38,10 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('http', 'gmail', self::USER, self::PASSWORD)];
+        yield [
+            new Dsn('foo', 'gmail', self::USER, self::PASSWORD),
+            'The "foo" scheme is not supported for mailer "gmail". Supported schemes are: "smtp".',
+        ];
     }
 
     public function incompleteDsnProvider(): iterable
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Factory/MandrillTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Factory/MandrillTransportFactory.php
@@ -41,7 +41,7 @@ public function create(Dsn $dsn): TransportInterface
             return new Mailchimp\Smtp\MandrillTransport($user, $password, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['api', 'http', 'smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Tests/Factory/MandrillTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Tests/Factory/MandrillTransportFactoryTest.php
@@ -71,7 +71,10 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'mandrill', self::USER)];
+        yield [
+            new Dsn('foo', 'mandrill', self::USER),
+            'The "foo" scheme is not supported for mailer "mandrill". Supported schemes are: "api", "http", "smtp".',
+        ];
     }
 
     public function incompleteDsnProvider(): iterable
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Factory/MailgunTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Factory/MailgunTransportFactory.php
@@ -41,7 +41,7 @@ public function create(Dsn $dsn): TransportInterface
             return new Mailgun\Smtp\MailgunTransport($user, $password, $region, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['api', 'http', 'smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Factory/MailgunTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Tests/Factory/MailgunTransportFactoryTest.php
@@ -76,7 +76,10 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'mailgun', self::USER, self::PASSWORD)];
+        yield [
+            new Dsn('foo', 'mailgun', self::USER, self::PASSWORD),
+            'The "foo" scheme is not supported for mailer "mailgun". Supported schemes are: "api", "http", "smtp".',
+        ];
     }
 
     public function incompleteDsnProvider(): iterable
diff --git a/src/Symfony/Component/Mailer/Bridge/Postmark/Factory/PostmarkTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Postmark/Factory/PostmarkTransportFactory.php
@@ -35,7 +35,7 @@ public function create(Dsn $dsn): TransportInterface
             return new Postmark\Smtp\PostmarkTransport($user, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['api', 'smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Postmark/Tests/Factory/PostmarkTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Postmark/Tests/Factory/PostmarkTransportFactoryTest.php
@@ -60,7 +60,10 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'postmark', self::USER)];
+        yield [
+            new Dsn('foo', 'postmark', self::USER),
+            'The "foo" scheme is not supported for mailer "postmark". Supported schemes are: "api", "smtp".',
+        ];
     }
 
     public function incompleteDsnProvider(): iterable
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Factory/SendgridTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Factory/SendgridTransportFactory.php
@@ -34,7 +34,7 @@ public function create(Dsn $dsn): TransportInterface
             return new Sendgrid\Smtp\SendgridTransport($key, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['api', 'smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Factory/SendgridTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Factory/SendgridTransportFactoryTest.php
@@ -60,6 +60,9 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'sendgrid', self::USER)];
+        yield [
+            new Dsn('foo', 'sendgrid', self::USER),
+            'The "foo" scheme is not supported for mailer "sendgrid". Supported schemes are: "api", "smtp".',
+        ];
     }
 }
diff --git a/src/Symfony/Component/Mailer/Exception/UnsupportedSchemeException.php b/src/Symfony/Component/Mailer/Exception/UnsupportedSchemeException.php
@@ -18,8 +18,8 @@
  */
 class UnsupportedSchemeException extends LogicException
 {
-    public function __construct(Dsn $dsn)
+    public function __construct(Dsn $dsn, array $supported)
     {
-        parent::__construct(sprintf('The "%s" scheme is not supported for mailer "%s".', $dsn->getScheme(), $dsn->getHost()));
+        parent::__construct(sprintf('The "%s" scheme is not supported for mailer "%s". Supported schemes are: "%s".', $dsn->getScheme(), $dsn->getHost(), implode('", "', $supported)));
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/NullTransportFactoryTest.php b/src/Symfony/Component/Mailer/Tests/Transport/NullTransportFactoryTest.php
@@ -47,6 +47,9 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('foo', 'null')];
+        yield [
+            new Dsn('foo', 'null'),
+            'The "foo" scheme is not supported for mailer "null". Supported schemes are: "smtp".',
+        ];
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportFactoryTest.php b/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportFactoryTest.php
@@ -47,6 +47,9 @@ public function createProvider(): iterable
 
     public function unsupportedSchemeProvider(): iterable
     {
-        yield [new Dsn('http', 'sendmail')];
+        yield [
+            new Dsn('http', 'sendmail'),
+            'The "http" scheme is not supported for mailer "sendmail". Supported schemes are: "smtp".',
+        ];
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/TransportFactoryTestCase.php b/src/Symfony/Component/Mailer/Tests/TransportFactoryTestCase.php
@@ -69,11 +69,15 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void
     /**
      * @dataProvider unsupportedSchemeProvider
      */
-    public function testUnsupportedSchemeException(Dsn $dsn): void
+    public function testUnsupportedSchemeException(Dsn $dsn, string $message = null): void
     {
         $factory = $this->getFactory();
 
         $this->expectException(UnsupportedSchemeException::class);
+        if (null !== $message) {
+            $this->expectExceptionMessage($message);
+        }
+
         $factory->create($dsn);
     }
 
diff --git a/src/Symfony/Component/Mailer/Transport/NullTransportFactory.php b/src/Symfony/Component/Mailer/Transport/NullTransportFactory.php
@@ -24,7 +24,7 @@ public function create(Dsn $dsn): TransportInterface
             return new NullTransport($this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['smtp']);
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/src/Symfony/Component/Mailer/Transport/SendmailTransportFactory.php b/src/Symfony/Component/Mailer/Transport/SendmailTransportFactory.php
@@ -24,7 +24,7 @@ public function create(Dsn $dsn): TransportInterface
             return new SendmailTransport(null, $this->dispatcher, $this->logger);
         }
 
-        throw new UnsupportedSchemeException($dsn);
+        throw new UnsupportedSchemeException($dsn, ['smtp']);
     }
 
     public function supports(Dsn $dsn): bool

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function create(Dsn $dsn): TransportInterface`
`41`	`41`	`return new Amazon\Smtp\SesTransport($user, $password, $region, $this->dispatcher, $this->logger);`
`42`	`42`	`}`
`43`	`43`
`44`		`- throw new UnsupportedSchemeException($dsn);`
	`44`	`+ throw new UnsupportedSchemeException($dsn, ['api', 'http', 'smtp']);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`public function supports(Dsn $dsn): bool`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,10 @@ public function createProvider(): iterable`
`86`	`86`
`87`	`87`	`public function unsupportedSchemeProvider(): iterable`
`88`	`88`	`{`
`89`		`- yield [new Dsn('foo', 'ses', self::USER, self::PASSWORD)];`
	`89`	`+ yield [`
	`90`	`+ new Dsn('foo', 'ses', self::USER, self::PASSWORD),`
	`91`	`+ 'The "foo" scheme is not supported for mailer "ses". Supported schemes are: "api", "http", "smtp".',`
	`92`	`+ ];`
`90`	`93`	`}`
`91`	`94`
`92`	`95`	`public function incompleteDsnProvider(): iterable`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function create(Dsn $dsn): TransportInterface`
`28`	`28`	`return new GmailTransport($this->getUser($dsn), $this->getPassword($dsn), $this->dispatcher, $this->logger);`
`29`	`29`	`}`
`30`	`30`
`31`		`- throw new UnsupportedSchemeException($dsn);`
	`31`	`+ throw new UnsupportedSchemeException($dsn, ['smtp']);`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public function supports(Dsn $dsn): bool`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,10 @@ public function createProvider(): iterable`
`38`	`38`
`39`	`39`	`public function unsupportedSchemeProvider(): iterable`
`40`	`40`	`{`
`41`		`- yield [new Dsn('http', 'gmail', self::USER, self::PASSWORD)];`
	`41`	`+ yield [`
	`42`	`+ new Dsn('foo', 'gmail', self::USER, self::PASSWORD),`
	`43`	`+ 'The "foo" scheme is not supported for mailer "gmail". Supported schemes are: "smtp".',`
	`44`	`+ ];`
`42`	`45`	`}`
`43`	`46`
`44`	`47`	`public function incompleteDsnProvider(): iterable`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,10 @@ public function createProvider(): iterable`
`71`	`71`
`72`	`72`	`public function unsupportedSchemeProvider(): iterable`
`73`	`73`	`{`
`74`		`- yield [new Dsn('foo', 'mandrill', self::USER)];`
	`74`	`+ yield [`
	`75`	`+ new Dsn('foo', 'mandrill', self::USER),`
	`76`	`+ 'The "foo" scheme is not supported for mailer "mandrill". Supported schemes are: "api", "http", "smtp".',`
	`77`	`+ ];`
`75`	`78`	`}`
`76`	`79`
`77`	`80`	`public function incompleteDsnProvider(): iterable`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,10 @@ public function createProvider(): iterable`
`76`	`76`
`77`	`77`	`public function unsupportedSchemeProvider(): iterable`
`78`	`78`	`{`
`79`		`- yield [new Dsn('foo', 'mailgun', self::USER, self::PASSWORD)];`
	`79`	`+ yield [`
	`80`	`+ new Dsn('foo', 'mailgun', self::USER, self::PASSWORD),`
	`81`	`+ 'The "foo" scheme is not supported for mailer "mailgun". Supported schemes are: "api", "http", "smtp".',`
	`82`	`+ ];`
`80`	`83`	`}`
`81`	`84`
`82`	`85`	`public function incompleteDsnProvider(): iterable`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function create(Dsn $dsn): TransportInterface`
`35`	`35`	`return new Postmark\Smtp\PostmarkTransport($user, $this->dispatcher, $this->logger);`
`36`	`36`	`}`
`37`	`37`
`38`		`- throw new UnsupportedSchemeException($dsn);`
	`38`	`+ throw new UnsupportedSchemeException($dsn, ['api', 'smtp']);`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`public function supports(Dsn $dsn): bool`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,10 @@ public function createProvider(): iterable`
`60`	`60`
`61`	`61`	`public function unsupportedSchemeProvider(): iterable`
`62`	`62`	`{`
`63`		`- yield [new Dsn('foo', 'postmark', self::USER)];`
	`63`	`+ yield [`
	`64`	`+ new Dsn('foo', 'postmark', self::USER),`
	`65`	`+ 'The "foo" scheme is not supported for mailer "postmark". Supported schemes are: "api", "smtp".',`
	`66`	`+ ];`
`64`	`67`	`}`
`65`	`68`
`66`	`69`	`public function incompleteDsnProvider(): iterable`