[FEATURE] Envoi de l'email de creation de compte en asynchrone (PIX-15112)

[bpetetot]

🍂 Problème

Quand un utilisateur créé un compte, si Brevo est down, l'envoi de l'email de "Création de compte" bloque l'appel HTTP de création de compte.

🌰 Proposition

La solution prise est de réaliser l'envoi de cet email via un Job afin que l'envoi de cet email soit asynchrone et ne bloque pas l'appel de création de compte. De plus, cela permet de bénéficier des stratégies de retry des jobs en cas d'indisponibilité de Brevo.

Nous profitons de cette modification pour mettre en place de nouvelles conventions autour de la création et l'envoi d'emails via l'API, afin d'étendre cette pratique aux autres emails transactionnels.

Voici les modifications apportées:

1. Ajout d'une factory EmailFactory permettant l'instanciation d'un modèle d'Email.
2. Le modèle Email est une représentation sérialisable des informations nécessaires à l'envoie d'un email.
3. Le modèle Email porte la validation des informations nécessaires (template, from, to, subject...)
4. Ce modèle est utilisé en entrée du emailRepository proposant 2 fonctions:

• sendEmail(email: Email): Envoi un email de façon synchrone.
• sendEmailAsync(email: Email): Envoi un email via un Job asynchrone.

5. emailRepository pourra être utilisé dans tous les use-cases afin d'envoyer un email créé via l'EmailFactory

const emailFactory = new EmailFactory({ app: 'pix-app', locale });
const email = emailFactory.buildEmail({ to: ... });

await emailRepository.sendEmailAsync(email);

🎃 Remarques

Note

Ce type d'architecture permettra:

1. Une migration progressive de tous les envois d'email existants en asynchrone.
2. De faire évoluer facilement la factory (EmailFactory) afin de gérer les modèles de template dans la codebase au lieu de Brevo (et de le faire de manière progressive).

🪵 Pour tester

Important

Il faut désormais lancer les workers en local pour recevoir l'email de création de compte.
npm run start:worker (les logs seront à regarder dedans)

Création de compte utilisateur

Sur Pix.fr:

1. Créer un compte
2. Vérifier que l'email est bien reçu et correctement formaté

Sur Pix.org

1. Créer un compte et changer la langue
2. Vérifier que l'email est bien reçu et correctement formaté

Création de compte utilisateur avec réconciliation

Note

A faire en RA tant que le correctif correspondant n'est pas mergé #10537

1. Rejoindre une campagne SCO sur la RA de Pix App https://app-pr10509.review.pix.fr/campagnes/SCOBADGE1/presentation
2. Cliquer sur le bouton Je commence et remplir le formulaire avec un élève n'ayant pas de méthodes de connexion (ex: Harry Potter 12/12/2012)
3. Sélection Je m'inscris avec mon adresse e-mail et remplir les champs concernées
4. Soumettre le formulaire et vérifier que l'email et bien reçu et correctement formaté !

[pix-bot-github]

Une fois les applications déployées, elles seront accessibles via les liens suivants :

• App (.fr)
• App (.org)
• Orga (.fr)
• Orga (.org)
• Certif (.fr)
• Certif (.org)
• Junior
• Admin
• API
• Audit Logger

Les variables d'environnement seront accessibles via les liens suivants :

• scalingo front
• scalingo api
• scalingo audit-logger

[EmmanuelleBonnemay]

Lu et testé avec succès

[er-lim]

Lu et testé en local pour la partie inscription et en RA sur firefox pour la partie création et réconciliation ✅

Aussi détaillé la procédure pour tester cette partie là 😄