[Mailer] [Bridges] Use CPP and add more #[\SensitiveParameter] attributes

OskarStark · nicolas-grekas · commit d75a40dcd417 · 2024-01-02T13:33:22.000+01:00
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpAsyncAwsTransport.php b/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpAsyncAwsTransport.php
@@ -28,12 +28,11 @@
  */
 class SesHttpAsyncAwsTransport extends AbstractTransport
 {
-    protected SesClient $sesClient;
-
-    public function __construct(SesClient $sesClient, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->sesClient = $sesClient;
-
+    public function __construct(
+        protected SesClient $sesClient,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Azure/Transport/AzureApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Azure/Transport/AzureApiTransport.php
@@ -29,36 +29,24 @@ final class AzureApiTransport extends AbstractApiTransport
     private const HOST = '%s.communication.azure.com';
 
     /**
-     * User Access Key from Azure Communication Service (Primary or Secondary key).
+     * @param string $key             User Access Key from Azure Communication Service (Primary or Secondary key)
+     * @param string $resourceName    The endpoint API URL to which to POST emails to Azure https://{acsResourceName}.communication.azure.com/
+     * @param bool   $disableTracking Indicates whether user engagement tracking should be disabled
+     * @param string $apiVersion      The version of API to invoke
      */
-    private string $key;
-
-    /**
-     * The endpoint API URL to which to POST emails to Azure
-     * https://{acsResourceName}.communication.azure.com/.
-     */
-    private string $resourceName;
-
-    /**
-     * The version of API to invoke.
-     */
-    private string $apiVersion;
-
-    /**
-     * Indicates whether user engagement tracking should be disabled.
-     */
-    private bool $disableTracking;
-
-    public function __construct(string $key, string $resourceName, bool $disableTracking = false, string $apiVersion = '2023-03-31', HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        private string $resourceName,
+        private bool $disableTracking = false,
+        private string $apiVersion = '2023-03-31',
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         if (str_contains($resourceName, '.') || str_ends_with($resourceName, '.')) {
             throw new \Exception('Resource name cannot contain or end with a dot.');
         }
 
-        $this->resourceName = $resourceName;
-        $this->key = $key;
-        $this->apiVersion = $apiVersion;
-        $this->disableTracking = $disableTracking;
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Brevo/Transport/BrevoApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Brevo/Transport/BrevoApiTransport.php
@@ -32,12 +32,12 @@
  */
 final class BrevoApiTransport extends AbstractApiTransport
 {
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Infobip/Transport/InfobipApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Infobip/Transport/InfobipApiTransport.php
@@ -41,12 +41,12 @@ final class InfobipApiTransport extends AbstractApiTransport
         'X-Infobip-Track' => 'track',
     ];
 
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/MailPace/Transport/MailPaceApiTransport.php b/src/Symfony/Component/Mailer/Bridge/MailPace/Transport/MailPaceApiTransport.php
@@ -31,12 +31,12 @@ final class MailPaceApiTransport extends AbstractApiTransport
 {
     private const HOST = 'app.mailpace.com/api/v1';
 
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php
@@ -32,12 +32,12 @@ class MandrillApiTransport extends AbstractApiTransport
 {
     private const HOST = 'mandrillapp.com';
 
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillHttpTransport.php
@@ -30,12 +30,13 @@ class MandrillHttpTransport extends AbstractHttpTransport
     use MandrillHeadersTrait;
 
     private const HOST = 'mandrillapp.com';
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
 
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/MailerSend/Transport/MailerSendApiTransport.php b/src/Symfony/Component/Mailer/Bridge/MailerSend/Transport/MailerSendApiTransport.php
@@ -29,12 +29,12 @@
  */
 final class MailerSendApiTransport extends AbstractApiTransport
 {
-    private string $key;
-
-    public function __construct(#[\SensitiveParameter] string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
@@ -33,16 +33,14 @@ class MailgunApiTransport extends AbstractApiTransport
 {
     private const HOST = 'api.%region_dot%mailgun.net';
 
-    private string $key;
-    private string $domain;
-    private ?string $region;
-
-    public function __construct(string $key, string $domain, string $region = null, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-        $this->domain = $domain;
-        $this->region = $region;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        private string $domain,
+        private ?string $region = null,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php
@@ -32,16 +32,14 @@ class MailgunHttpTransport extends AbstractHttpTransport
 
     private const HOST = 'api.%region_dot%mailgun.net';
 
-    private string $key;
-    private string $domain;
-    private ?string $region;
-
-    public function __construct(string $key, string $domain, string $region = null, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-        $this->domain = $domain;
-        $this->region = $region;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        private string $domain,
+        private ?string $region = null,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetApiTransport.php
@@ -51,16 +51,14 @@ class MailjetApiTransport extends AbstractApiTransport
         'X-Mailjet-TrackOpen' => ['TrackOpen', 'string'],
     ];
 
-    private string $privateKey;
-    private string $publicKey;
-    private bool $sandbox;
-
-    public function __construct(string $publicKey, string $privateKey, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null, bool $sandbox = false)
-    {
-        $this->publicKey = $publicKey;
-        $this->privateKey = $privateKey;
-        $this->sandbox = $sandbox;
-
+    public function __construct(
+        private string $publicKey,
+        #[\SensitiveParameter] private string $privateKey,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+        private bool $sandbox = false,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php
@@ -37,18 +37,29 @@ class PostmarkApiTransport extends AbstractApiTransport
 
     private ?EventDispatcherInterface $dispatcher;
 
-    private string $key;
-
     private ?string $messageStream = null;
 
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         $this->dispatcher = $dispatcher;
 
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    /**
+     * @return $this
+     */
+    public function setMessageStream(string $messageStream): static
+    {
+        $this->messageStream = $messageStream;
+
+        return $this;
+    }
+
     public function __toString(): string
     {
         return sprintf('postmark+api://%s', $this->getEndpoint()).($this->messageStream ? '?message_stream='.$this->messageStream : '');
@@ -177,14 +188,4 @@ private function getEndpoint(): ?string
     {
         return ($this->host ?: self::HOST).($this->port ? ':'.$this->port : '');
     }
-
-    /**
-     * @return $this
-     */
-    public function setMessageStream(string $messageStream): static
-    {
-        $this->messageStream = $messageStream;
-
-        return $this;
-    }
 }
diff --git a/src/Symfony/Component/Mailer/Bridge/Scaleway/Transport/ScalewayApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Scaleway/Transport/ScalewayApiTransport.php
@@ -28,16 +28,14 @@ final class ScalewayApiTransport extends AbstractApiTransport
 {
     private const HOST = 'api.scaleway.com';
 
-    private string $projectId;
-    private string $token;
-    private ?string $region;
-
-    public function __construct(string $projectId, string $token, string $region = null, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->projectId = $projectId;
-        $this->token = $token;
-        $this->region = $region;
-
+    public function __construct(
+        private string $projectId,
+        #[\SensitiveParameter] private string $token,
+        private ?string $region = null,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
@@ -34,12 +34,12 @@ class SendgridApiTransport extends AbstractApiTransport
 {
     private const HOST = 'api.sendgrid.com';
 
-    private string $key;
-
-    public function __construct(string $key, HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        #[\SensitiveParameter] private string $key,
+        HttpClientInterface $client = null,
+        EventDispatcherInterface $dispatcher = null,
+        LoggerInterface $logger = null,
+    ) {
         parent::__construct($client, $dispatcher, $logger);
     }
 
