feat: support tags and idempotency keys (#104)

Author: juliomrqz

src/Transport/ResendTransportFactory.php

@@ -6,6 +6,7 @@
 use Resend\Contracts\Client;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\Exception\TransportException;
+use Symfony\Component\Mailer\Header\MetadataHeader;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mailer\Transport\AbstractTransport;
 use Symfony\Component\Mime\Address;
@@ -33,15 +34,28 @@ protected function doSend(SentMessage $message): void
         $envelope = $message->getEnvelope();
 
         $headers = [];
-        $headersToBypass = ['from', 'to', 'cc', 'bcc', 'subject', 'content-type', 'sender', 'reply-to'];
+        $tags = [];
+        $headersToBypass = ['from', 'to', 'cc', 'bcc', 'subject', 'content-type', 'sender', 'reply-to', 'resend-idempotency-key'];
         foreach ($email->getHeaders()->all() as $name => $header) {
+            if ($header instanceof MetadataHeader) {
+                $tags[] = ['name' => $header->getKey(), 'value' => $header->getValue()];
+
+                continue;
+            }
+
             if (in_array($name, $headersToBypass, true)) {
                 continue;
             }
 
             $headers[$header->getName()] = $header->getBodyAsString();
         }
 
+        $options = [];
+
+        if ($email->getHeaders()->has('Resend-Idempotency-Key')) {
+            $options['idempotency_key'] = $email->getHeaders()->get('Resend-Idempotency-Key')->getBodyAsString();
+        }
+
         try {
             $result = $this->resend->emails->send([
                 'bcc' => $this->stringifyAddresses($email->getBcc()),
@@ -51,10 +65,11 @@ protected function doSend(SentMessage $message): void
                 'html' => $email->getHtmlBody(),
                 'reply_to' => $this->stringifyAddresses($email->getReplyTo()),
                 'subject' => $email->getSubject(),
+                'tags' => $tags,
                 'text' => $email->getTextBody(),
                 'to' => $this->stringifyAddresses($this->getRecipients($email, $envelope)),
                 'attachments' => $this->getAttachments($email),
-            ]);
+            ], $options);
         } catch (Exception $exception) {
             throw new TransportException(
                 sprintf('Request to the Resend API failed. Reason: %s', $exception->getMessage()),

tests/Transport/ResendTransportFactory.php

@@ -7,6 +7,7 @@
 use Resend\Laravel\Transport\ResendTransportFactory;
 use Resend\Service\Email as EmailService;
 use Symfony\Component\Mailer\Exception\TransportException;
+use Symfony\Component\Mailer\Header\MetadataHeader;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email as SymfonyEmail;
 
@@ -61,7 +62,7 @@
                 $arg['cc'] === ['cc@example.com'] &&
                 $arg['bcc'] === ['bcc@example.com'] &&
                 $arg['reply_to'] === ['reply-to@example.com'];
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -88,7 +89,7 @@
         ->with(Mockery::on(function ($arg) {
             return $arg['from'] === 'from@example.com' &&
                 $arg['to'] === ['"Acme" <to@example.com>', '"Acme Sales" <sales@example.com>'];
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -114,7 +115,7 @@
                 $arg['to'] === ['"Acme" <to@example.com>'] &&
                 $arg['subject'] === 'Test Subject' &&
                 array_key_exists('X-Entity-Ref-ID', $arg['headers']);
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -151,7 +152,7 @@
                 $arg['attachments'][0]['filename'] === 'lorem-ipsum.txt' &&
                 $arg['attachments'][0]['content'] === 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQWVuZWFuIG51bmMgYXVndWUsIGNvbnNlY3RldHVyIGlkIG5lcXVlIGVnZXQsIHZhcml1cyBkaWduaXNzaW0gZGlhbS4=' &&
                 $arg['attachments'][0]['content_type'] === 'text/plain';
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -190,7 +191,7 @@
                 $arg['attachments'][0]['content'] === 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQWVuZWFuIG51bmMgYXVndWUsIGNvbnNlY3RldHVyIGlkIG5lcXVlIGVnZXQsIHZhcml1cyBkaWduaXNzaW0gZGlhbS4=' &&
                 $arg['attachments'][0]['content_id'] === 'lorem-ipsum.txt' &&
                 $arg['attachments'][0]['content_type'] === 'text/plain';
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -228,7 +229,7 @@
                 $arg['attachments'][0]['content_type'] === 'text/calendar' &&
                 $arg['attachments'][0]['content'] === $calendarContent &&
                 $arg['attachments'][0]['filename'] === 'invite.ics';
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $this->transporter->send($email);
@@ -268,7 +269,7 @@
             return $arg['from'] === 'from@example.com' &&
                 $arg['to'] === ['"Acme" <to@example.com>'] &&
                 $arg['subject'] === 'Test Subject';
-        }))
+        }), Mockery::type('array'))
         ->andReturn($apiResponse);
 
     $message = $this->transporter->send($email);
@@ -286,3 +287,63 @@
         ->getValue()
     )->toBe('49a3999c-0ce1-4ea6-ab68-afcd6dc2e794');
 });
+
+it('can send with tags', function () {
+    $email = (new SymfonyEmail())
+        ->from('from@example.com')
+        ->to(new Address('to@example.com', 'Acme'))
+        ->subject('Test Subject')
+        ->text('Test plain text body');
+    $email->getHeaders()->add(new MetadataHeader('category', 'confirm_email'));
+    $email->getHeaders()->add(new MetadataHeader('customer_id', '123'));
+
+    $apiResponse = new Email([
+        'id' => '49a3999c-0ce1-4ea6-ab68-afcd6dc2e794',
+    ]);
+
+    $this->client->emails
+        ->shouldReceive('send')
+        ->once()
+        ->with(Mockery::on(function ($arg) {
+            return $arg['from'] === 'from@example.com' &&
+                $arg['to'] === ['"Acme" <to@example.com>'] &&
+                $arg['subject'] === 'Test Subject' &&
+                $arg['tags'] === [
+                    ['name' => 'category', 'value' => 'confirm_email'],
+                    ['name' => 'customer_id', 'value' => '123'],
+                ] &&
+                ! array_key_exists('X-Metadata-category', $arg['headers']) &&
+                ! array_key_exists('X-Metadata-customer_id', $arg['headers']);
+        }), Mockery::type('array'))
+        ->andReturn($apiResponse);
+
+    $this->transporter->send($email);
+});
+
+it('can send with idempotency key', function () {
+    $email = (new SymfonyEmail())
+        ->from('from@example.com')
+        ->to(new Address('to@example.com', 'Acme'))
+        ->subject('Test Subject')
+        ->text('Test plain text body');
+    $email->getHeaders()->addTextHeader('Resend-Idempotency-Key', 'welcome-user/123456789');
+
+    $apiResponse = new Email([
+        'id' => '49a3999c-0ce1-4ea6-ab68-afcd6dc2e794',
+    ]);
+
+    $this->client->emails
+        ->shouldReceive('send')
+        ->once()
+        ->with(Mockery::on(function ($arg) {
+            return $arg['from'] === 'from@example.com' &&
+                $arg['to'] === ['"Acme" <to@example.com>'] &&
+                $arg['subject'] === 'Test Subject' &&
+                ! array_key_exists('Resend-Idempotency-Key', $arg['headers']);
+        }), Mockery::on(function ($options) {
+            return $options === ['idempotency_key' => 'welcome-user/123456789'];
+        }))
+        ->andReturn($apiResponse);
+
+    $this->transporter->send($email);
+});