> Symfony 7 > Mailer y Webhook con Mailtrap
Login to bookmark this video
19.

El Componente Webhook para Eventos de Email

|

Share this awesome video!

|

En Mailtrap, cuando enviamos correos electrónicos en producción, recordemos que podemos comprobar cada correo: si fue enviado, entregado, abierto, rebotado (¡lo cual es importante!) y más. Mailtrap nos permite establecer una URL de webhook para que nos envíe información sobre estos eventos.

Componentes Webhook y RemoteEvent

Como bonus, ¡descubrimos dos nuevos componentes de Symfony! Busca tu terminal e instálalos:

composer require webhook remote-event

El componente webhook nos proporciona una única ruta a la que enviar todos los webhooks. Analiza los datos que se nos envían -llamados carga útil-, los convierte en un objeto de evento remoto y los envía a un consumidor. Puedes pensar en los eventos remotos como algo similar a los eventos Symfony. En lugar de que tu aplicación envíe un evento, lo hace un servicio de terceros, de ahí lo de evento remoto. Y en lugar de oyentes de eventos, decimos que los eventos remotos tienen consumidores.

Ejecuta

git status

para ver qué ha añadido la receta: config/routes/webhook.yaml. Eso añade el controlador webhook. Comprueba la ruta con:

symfony console debug:route webhook

Comprueba la primera. La ruta es /webhook/{type}. Así que ahora tenemos que configurar algún tipo.

los webhooks de terceros -como los de Mailtrap o los de un procesador de pagos o un sistema de alertas de Supernova- pueden enviarnos cargas útiles muy diferentes, por lo que normalmente necesitamos crear nuestros propios analizadores y eventos remotos. Dado que los eventos de correo electrónico son bastante estándar, Symfony proporciona algunos eventos remotos out-of-the-box para ellos: MailerDeliveryEvent y MailerEngagementEvent. Algunos puentes de correo, incluido el puente Mailtrap que estamos utilizando, proporcionan analizadores para cada carga útil de webhook del servicio para crear estos objetos. Sólo tenemos que configurarlo.

Configuración del analizador sintáctico Mailtrap

En config/packages/, crea un archivo webhook.yaml. Añade framework,webhook, routing, mailtrap (este es el tipo utilizado en la URL), y luego service. Para averiguar el id de servicio del analizador Mailtrap, ve a la documentación de Symfony Webhook. Busca el id de servicio del analizador Mailtrap, cópialo... y pégalo aquí:

6 lines | config/packages/webhook.yaml
framework:
webhook:
routing:
mailtrap:
service: mailer.webhook.request_parser.mailtrap

EmailEventConsumer

Ahora necesitamos un consumidor. Crea una nueva clase llamada EmailEventConsumeren el espacio de nombres App\Webhook. Esto necesita implementarConsumerInterface desde RemoteEvent Añade el método consume() necesario. Para decirle a Symfony qué tipo de webhook queremos que consuma, añade el atributo #[AsRemoteEventConsumer] con mailtrap:

22 lines | src/Webhook/EmailEventConsumer.php
// ... lines 1 - 10
#[AsRemoteEventConsumer('mailtrap')]
class EmailEventConsumer implements ConsumerInterface
{
// ... lines 14 - 16
public function consume(RemoteEvent $event): void
{
// ... line 19
}
}

Sobre consume(), añade un docblock para ayudar a nuestro IDE:@param MailerDeliveryEvent|MailerEngagementEvent $event:

22 lines | src/Webhook/EmailEventConsumer.php
// ... lines 1 - 11
class EmailEventConsumer implements ConsumerInterface
{
/**
* @param MailerDeliveryEvent|MailerEngagementEvent $event
*/
public function consume(RemoteEvent $event): void
{
// ... line 19
}
}

Estos son los eventos remotos de correo genéricos que proporciona Symfony. Dentro, escribe $event-> para ver los métodos disponibles.

En una aplicación real, aquí sería donde harías algo con estos eventos como guardarlos en la base de datos o notificar a un administrador si un correo electrónico rebota. En realidad, si un correo electrónico rebota varias veces, puede que quieras actualizar algo para evitar que se vuelva a intentar, ya que esto puede perjudicar la fiabilidad de tu correo electrónico. Pero para nuestros propósitos, basta con dump($event):

22 lines | src/Webhook/EmailEventConsumer.php
// ... lines 1 - 11
class EmailEventConsumer implements ConsumerInterface
{
// ... lines 14 - 16
public function consume(RemoteEvent $event): void
{
dump($event);
}
}

Consumidores asíncronos

Una última cosa: el controlador webhook envía el evento remoto al consumidor a través de Symfony Messenger, dentro de una clase de mensaje llamada ConsumeRemoteEventMessage.

Para manejar esto de forma asíncrona y mantener rápidas las respuestas de tu webhook, enconfig/packages/messenger.yaml, bajo routing, añadeSymfony\Component\RemoteEvent\Messenger\ConsumeRemoteEventMessage y envíalo a nuestro transporte async:

25 lines | config/packages/messenger.yaml
framework:
messenger:
// ... lines 3 - 11
routing:
// ... lines 13 - 15
'Symfony\Component\RemoteEvent\Messenger\ConsumeRemoteEventMessage': async
// ... lines 17 - 25

¡Vale! Estamos listos para hacer una demostración de este webhook. ¡Eso a continuación!