Merge pull request #209 from authorizerdev/feat/send-email-based-on-template

feat: send email based on template

Author: lakhansamani

dashboard/package-lock.json

@@ -62,8 +62,7 @@ interface validatorDataType {
 }
 
 const initTemplateData: emailTemplateDataType = {
-	[EmailTemplateInputDataFields.EVENT_NAME]:
-		emailTemplateEventNames.BASIC_AUTH_SIGNUP,
+	[EmailTemplateInputDataFields.EVENT_NAME]: emailTemplateEventNames.Signup,
 	[EmailTemplateInputDataFields.SUBJECT]: '',
 };
 
@@ -206,10 +205,10 @@ const UpdateEmailTemplate = ({
 		).reduce((acc, varData): any => {
 			if (
 				(templateData[EmailTemplateInputDataFields.EVENT_NAME] !==
-					emailTemplateEventNames.VERIFY_OTP &&
+					emailTemplateEventNames['Verify Otp'] &&
 					varData[1] === emailTemplateVariables.otp) ||
 				(templateData[EmailTemplateInputDataFields.EVENT_NAME] ===
-					emailTemplateEventNames.VERIFY_OTP &&
+					emailTemplateEventNames['Verify Otp'] &&
 					varData[1] === emailTemplateVariables.verification_url)
 			) {
 				return acc;

dashboard/src/components/UpdateEmailTemplateModal.tsx

@@ -94,7 +94,7 @@ interface validatorDataType {
 }
 
 const initWebhookData: webhookDataType = {
-	[WebhookInputDataFields.EVENT_NAME]: webhookEventNames.USER_LOGIN,
+	[WebhookInputDataFields.EVENT_NAME]: webhookEventNames['User login'],
 	[WebhookInputDataFields.ENDPOINT]: '',
 	[WebhookInputDataFields.ENABLED]: true,
 	[WebhookInputDataFields.HEADERS]: [{ ...initHeadersData }],

dashboard/src/components/UpdateWebhookModal.tsx

@@ -183,20 +183,21 @@ export enum UpdateModalViews {
 export const pageLimits: number[] = [5, 10, 15];
 
 export const webhookEventNames = {
-	USER_SIGNUP: 'user.signup',
-	USER_CREATED: 'user.created',
-	USER_LOGIN: 'user.login',
-	USER_DELETED: 'user.deleted',
-	USER_ACCESS_ENABLED: 'user.access_enabled',
-	USER_ACCESS_REVOKED: 'user.access_revoked',
+	'User signup': 'user.signup',
+	'User created': 'user.created',
+	'User login': 'user.login',
+	'User deleted': 'user.deleted',
+	'User access enabled': 'user.access_enabled',
+	'User access revoked': 'user.access_revoked',
 };
 
 export const emailTemplateEventNames = {
-	BASIC_AUTH_SIGNUP: 'basic_auth_signup',
-	MAGIC_LINK_LOGIN: 'magic_link_login',
-	UPDATE_EMAIL: 'update_email',
-	FORGOT_PASSWORD: 'forgot_password',
-	VERIFY_OTP: 'verify_otp',
+	Signup: 'basic_auth_signup',
+	'Magic Link Login': 'magic_link_login',
+	'Update Email': 'update_email',
+	'Forgot Password': 'forgot_password',
+	'Verify Otp': 'verify_otp',
+	'Invite member': 'invite_member',
 };
 
 export enum webhookVerifiedStatus {
@@ -206,27 +207,27 @@ export enum webhookVerifiedStatus {
 }
 
 export const emailTemplateVariables = {
-	'user.id': '{user.id}}',
-	'user.email': '{user.email}}',
-	'user.given_name': '{user.given_name}}',
-	'user.family_name': '{user.family_name}}',
-	'user.signup_methods': '{user.signup_methods}}',
-	'user.email_verified': '{user.email_verified}}',
-	'user.picture': '{user.picture}}',
-	'user.roles': '{user.roles}}',
-	'user.middle_name': '{user.middle_name}}',
-	'user.nickname': '{user.nickname}}',
-	'user.preferred_username': '{user.preferred_username}}',
-	'user.gender': '{user.gender}}',
-	'user.birthdate': '{user.birthdate}}',
-	'user.phone_number': '{user.phone_number}}',
-	'user.phone_number_verified': '{user.phone_number_verified}}',
-	'user.created_at': '{user.created_at}}',
-	'user.updated_at': '{user.updated_at}}',
-	'organization.name': '{organization.name}}',
-	'organization.logo': '{organization.logo}}',
-	verification_url: '{verification_url}}',
-	otp: '{otp}}',
+	'user.id': '{.user.id}}',
+	'user.email': '{.user.email}}',
+	'user.given_name': '{.user.given_name}}',
+	'user.family_name': '{.user.family_name}}',
+	'user.signup_methods': '{.user.signup_methods}}',
+	'user.email_verified': '{.user.email_verified}}',
+	'user.picture': '{.user.picture}}',
+	'user.roles': '{.user.roles}}',
+	'user.middle_name': '{.user.middle_name}}',
+	'user.nickname': '{.user.nickname}}',
+	'user.preferred_username': '{.user.preferred_username}}',
+	'user.gender': '{.user.gender}}',
+	'user.birthdate': '{.user.birthdate}}',
+	'user.phone_number': '{.user.phone_number}}',
+	'user.phone_number_verified': '{.user.phone_number_verified}}',
+	'user.created_at': '{.user.created_at}}',
+	'user.updated_at': '{.user.updated_at}}',
+	'organization.name': '{.organization.name}}',
+	'organization.logo': '{.organization.logo}}',
+	verification_url: '{.verification_url}}',
+	otp: '{.otp}}',
 };
 
 export const webhookPayloadExample: string = `{

dashboard/src/constants.ts

@@ -126,7 +126,7 @@ export const WebhooksDataQuery = `
 export const EmailTemplatesQuery = `
   query getEmailTemplates($params: PaginatedInput!) {
     _email_templates(params: $params) {
-      EmailTemplates {
+      email_templates {
         id
         event_name
         subject

dashboard/src/graphql/queries/index.ts

@@ -40,7 +40,7 @@ import {
 	UpdateModalViews,
 	EmailTemplateInputDataFields,
 } from '../constants';
-import { EmailTemplatesQuery, WebhooksDataQuery } from '../graphql/queries';
+import { EmailTemplatesQuery } from '../graphql/queries';
 import dayjs from 'dayjs';
 import DeleteEmailTemplateModal from '../components/DeleteEmailTemplateModal';
 
@@ -94,7 +94,7 @@ const EmailTemplates = () => {
 			})
 			.toPromise();
 		if (res.data?._email_templates) {
-			const { pagination, EmailTemplates: emailTemplates } =
+			const { pagination, email_templates: emailTemplates } =
 				res.data?._email_templates;
 			const maxPages = getMaxPages(pagination);
 			if (emailTemplates?.length) {

dashboard/src/pages/EmailTemplates.tsx

@@ -9,4 +9,8 @@ const (
 	VerificationTypeUpdateEmail = "update_email"
 	// VerificationTypeForgotPassword is the forgot_password verification type
 	VerificationTypeForgotPassword = "forgot_password"
+	// VerificationTypeInviteMember is the invite_member verification type
+	VerificationTypeInviteMember = "invite_member"
+	// VerificationTypeOTP is the otp verification type
+	VerificationTypeOTP = "otp"
 )

server/constants/verification_types.go

@@ -1,6 +1,7 @@
 package models
 
 import (
+	"encoding/json"
 	"strings"
 
 	"github.com/authorizerdev/authorizer/server/graph/model"
@@ -64,3 +65,10 @@ func (user *User) AsAPIUser() *model.User {
 		UpdatedAt:                refs.NewInt64Ref(user.UpdatedAt),
 	}
 }
+
+func (user *User) ToMap() map[string]interface{} {
+	res := map[string]interface{}{}
+	data, _ := json.Marshal(user) // Convert to a json string
+	json.Unmarshal(data, &res)    // Convert to a map
+	return res
+}

server/db/models/user.go

@@ -2,36 +2,84 @@ package email
 
 import (
 	"bytes"
+	"context"
 	"crypto/tls"
-	"encoding/json"
 	"strconv"
 	"text/template"
 
 	log "github.com/sirupsen/logrus"
 	gomail "gopkg.in/mail.v2"
 
 	"github.com/authorizerdev/authorizer/server/constants"
+	"github.com/authorizerdev/authorizer/server/db"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/authorizerdev/authorizer/server/memorystore"
 )
 
-// addEmailTemplate is used to add html template in email body
-func addEmailTemplate(a string, b map[string]interface{}, templateName string) string {
-	tmpl, err := template.New(templateName).Parse(a)
+func getDefaultTemplate(event string) *model.EmailTemplate {
+	switch event {
+	case constants.VerificationTypeBasicAuthSignup, constants.VerificationTypeMagicLinkLogin:
+		return &model.EmailTemplate{
+			Subject:  emailVerificationSubject,
+			Template: emailVerificationTemplate,
+		}
+	case constants.VerificationTypeForgotPassword:
+		return &model.EmailTemplate{
+			Subject:  forgotPasswordSubject,
+			Template: forgotPasswordTemplate,
+		}
+	case constants.VerificationTypeInviteMember:
+		return &model.EmailTemplate{
+			Subject:  inviteEmailSubject,
+			Template: inviteEmailTemplate,
+		}
+	case constants.VerificationTypeOTP:
+		return &model.EmailTemplate{
+			Subject:  otpEmailSubject,
+			Template: otpEmailTemplate,
+		}
+	default:
+		return nil
+	}
+}
+
+func getEmailTemplate(event string, data map[string]interface{}) (*model.EmailTemplate, error) {
+	ctx := context.Background()
+	tmp, err := db.Provider.GetEmailTemplateByEventName(ctx, event)
+	if err != nil || tmp == nil {
+		tmp = getDefaultTemplate(event)
+	}
+
+	templ, err := template.New(event + "_template.tmpl").Parse(tmp.Template)
 	if err != nil {
-		output, _ := json.Marshal(b)
-		return string(output)
+		return nil, err
 	}
 	buf := &bytes.Buffer{}
-	err = tmpl.Execute(buf, b)
+	err = templ.Execute(buf, data)
+	if err != nil {
+		return nil, err
+	}
+	templateString := buf.String()
+
+	subject, err := template.New(event + "_subject.tmpl").Parse(tmp.Subject)
 	if err != nil {
-		panic(err)
+		return nil, err
 	}
-	s := buf.String()
-	return s
+	buf = &bytes.Buffer{}
+	err = subject.Execute(buf, data)
+	if err != nil {
+		return nil, err
+	}
+	subjectString := buf.String()
+
+	return &model.EmailTemplate{
+		Template: templateString,
+		Subject:  subjectString,
+	}, nil
 }
 
-// SendMail function to send mail
-func SendMail(to []string, Subject, bodyMessage string) error {
+// SendEmail function to send mail
+func SendEmail(to []string, event string, data map[string]interface{}) error {
 	// dont trigger email sending in case of test
 	envKey, err := memorystore.Provider.GetStringStoreEnvVariable(constants.EnvKeyEnv)
 	if err != nil {
@@ -40,6 +88,13 @@ func SendMail(to []string, Subject, bodyMessage string) error {
 	if envKey == constants.TestEnv {
 		return nil
 	}
+
+	tmp, err := getEmailTemplate(event, data)
+	if err != nil {
+		log.Errorf("Failed to get event template: ", err)
+		return err
+	}
+
 	m := gomail.NewMessage()
 	senderEmail, err := memorystore.Provider.GetStringStoreEnvVariable(constants.EnvKeySenderEmail)
 	if err != nil {
@@ -79,8 +134,8 @@ func SendMail(to []string, Subject, bodyMessage string) error {
 
 	m.SetHeader("From", senderEmail)
 	m.SetHeader("To", to...)
-	m.SetHeader("Subject", Subject)
-	m.SetBody("text/html", bodyMessage)
+	m.SetHeader("Subject", tmp.Subject)
+	m.SetBody("text/html", tmp.Template)
 	port, _ := strconv.Atoi(smtpPort)
 	d := gomail.NewDialer(smtpHost, port, smtpUsername, smtpPassword)
 	if !isProd {