feat: added integration with postmark (#484)

flake.nix

@@ -115,7 +115,7 @@
         module = "github.com/nhost/hasura-auth/go";
         submodule = ".";
 
-        tags = [ "integration" ];
+        tags = [ ];
 
         ldflags = [
           "-X main.Version=${version}"

go/cmd/email.go

@@ -8,11 +8,13 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/nhost/hasura-auth/go/controller"
 	"github.com/nhost/hasura-auth/go/notifications"
+	"github.com/nhost/hasura-auth/go/notifications/postmark"
 	"github.com/urfave/cli/v2"
 )
 
-func getEmailer(cCtx *cli.Context, logger *slog.Logger) (*notifications.Email, error) {
+func getSMTPEmailer(cCtx *cli.Context, logger *slog.Logger) (*notifications.Email, error) {
 	headers := make(map[string]string)
 	if cCtx.String(flagSMTPAPIHedaer) != "" {
 		headers["X-SMTPAPI"] = cCtx.String(flagSMTPAPIHedaer)
@@ -66,3 +68,14 @@ func getEmailer(cCtx *cli.Context, logger *slog.Logger) (*notifications.Email, e
 		templates,
 	), nil
 }
+
+func getEmailer( //nolint:ireturn
+	cCtx *cli.Context,
+	logger *slog.Logger,
+) (controller.Emailer, error) {
+	if cCtx.String(flagSMTPHost) == "postmark" {
+		return postmark.New(cCtx.String(flagSMTPSender), cCtx.String(flagSMTPPassword)), nil
+	}
+
+	return getSMTPEmailer(cCtx, logger)
+}

go/cmd/serve.go

@@ -240,7 +240,7 @@ func CommandServe() *cli.Command { //nolint:funlen,maintidx
 			},
 			&cli.StringFlag{ //nolint: exhaustruct
 				Name:     flagSMTPHost,
-				Usage:    "SMTP Host",
+				Usage:    "SMTP Host. If the host is 'postmark' then the Postmark API will be used. Use AUTH_SMTP_PASS as the server token, other SMTP options are ignored",
 				Category: "smtp",
 				EnvVars:  []string{"AUTH_SMTP_HOST"},
 			},

go/controller/controller.go

@@ -31,6 +31,7 @@ func ptr[T any](x T) *T {
 
 type Emailer interface {
 	SendEmail(
+		ctx context.Context,
 		to string,
 		locale string,
 		templateName notifications.TemplateName,

go/controller/post_signin_passwordless_email.go

@@ -79,6 +79,7 @@ func (ctrl *Controller) PostSigninPasswordlessEmail( //nolint:ireturn
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		string(request.Body.Email),
 		user.Locale,
 		LinkTypePasswordlessEmail,

go/controller/post_signin_passwordless_email_test.go

@@ -73,6 +73,7 @@ func TestPostSigninPasswordlessEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameSigninPasswordless,
@@ -255,6 +256,7 @@ func TestPostSigninPasswordlessEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameSigninPasswordless,
@@ -381,6 +383,7 @@ func TestPostSigninPasswordlessEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"fr",
 					notifications.TemplateNameSigninPasswordless,
@@ -516,6 +519,7 @@ func TestPostSigninPasswordlessEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameSigninPasswordless,

go/controller/post_signup_email_password.go

@@ -95,6 +95,7 @@ func (ctrl *Controller) postSignupEmailPasswordWithEmailVerificationOrUserDisabl
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		email,
 		deptr(options.Locale),
 		LinkTypeEmailVerify,

go/controller/post_signup_email_password_test.go

@@ -965,6 +965,7 @@ func TestPostSignupEmailPassword(t *testing.T) { //nolint:maintidx
 			emailer: func(ctrl *gomock.Controller) *mock.MockEmailer {
 				mock := mock.NewMockEmailer(ctrl)
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,

go/controller/post_signup_webauthn_verify.go

@@ -141,6 +141,7 @@ func (ctrl *Controller) postSignupWebauthnVerifyWithEmailVerificationOrUserDisab
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		webauthnUser.Email,
 		deptr(options.Locale),
 		LinkTypeEmailVerify,

go/controller/post_signup_webauthn_verify_test.go

@@ -386,6 +386,7 @@ func TestPostSignupWebauthnVerify(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,

go/controller/post_user_deanonymize.go

@@ -118,6 +118,7 @@ func (ctrl *Controller) PostUserDeanonymize( //nolint:funlen
 
 	if ticket != "" {
 		if apiError = ctrl.wf.SendEmail(
+			ctx,
 			string(request.Body.Email),
 			*options.Locale,
 			linkType,

go/controller/post_user_deanonymize_test.go

@@ -225,6 +225,7 @@ func TestPostUserDeanonymize(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,
@@ -309,6 +310,7 @@ func TestPostUserDeanonymize(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameSigninPasswordless,

go/controller/post_user_email_change.go

@@ -39,6 +39,7 @@ func (ctrl *Controller) PostUserEmailChange( //nolint:ireturn
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		string(request.Body.NewEmail),
 		updatedUser.Locale,
 		LinkTypeEmailConfirmChange,

go/controller/post_user_email_change_test.go

@@ -90,6 +90,7 @@ func TestPostUserEmailChange(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailConfirmChange,
@@ -252,6 +253,7 @@ func TestPostUserEmailChange(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailConfirmChange,

go/controller/post_user_email_send_verification_email.go

@@ -41,6 +41,7 @@ func (ctrl *Controller) PostUserEmailSendVerificationEmail( //nolint:ireturn
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		user.Email.String,
 		user.Locale,
 		LinkTypeEmailVerify,

go/controller/post_user_email_send_verification_email_test.go

@@ -63,6 +63,7 @@ func TestPostUserEmailSendVerificationEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,
@@ -136,6 +137,7 @@ func TestPostUserEmailSendVerificationEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,
@@ -210,6 +212,7 @@ func TestPostUserEmailSendVerificationEmail(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNameEmailVerify,

go/controller/post_user_password_reset.go

@@ -40,6 +40,7 @@ func (ctrl *Controller) PostUserPasswordReset( //nolint:ireturn
 	}
 
 	if err := ctrl.wf.SendEmail(
+		ctx,
 		string(request.Body.Email),
 		user.Locale,
 		LinkTypePasswordReset,

go/controller/post_user_password_reset_test.go

@@ -58,6 +58,7 @@ func TestPostUserPasswordReset(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNamePasswordReset,
@@ -134,6 +135,7 @@ func TestPostUserPasswordReset(t *testing.T) { //nolint:maintidx
 				mock := mock.NewMockEmailer(ctrl)
 
 				mock.EXPECT().SendEmail(
+					gomock.Any(),
 					"[email protected]",
 					"en",
 					notifications.TemplateNamePasswordReset,

go/controller/workflows.go

@@ -462,6 +462,7 @@ func (wf *Workflows) ChangeEmail(
 }
 
 func (wf *Workflows) SendEmail(
+	ctx context.Context,
 	to string,
 	locale string,
 	linkType LinkType,
@@ -485,6 +486,7 @@ func (wf *Workflows) SendEmail(
 	}
 
 	if err := wf.email.SendEmail(
+		ctx,
 		to,
 		locale,
 		templateName,

go/notifications/email.go

@@ -2,6 +2,7 @@ package notifications
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"net/smtp"
 )
@@ -61,7 +62,7 @@ func (sm *Email) Send(to, subject, contents string, headers map[string]string) e
 }
 
 func (sm *Email) SendEmail(
-	to string, locale string, templateName TemplateName, data TemplateData,
+	_ context.Context, to string, locale string, templateName TemplateName, data TemplateData,
 ) error {
 	body, subject, err := sm.templates.Render(locale, templateName, data)
 	if err != nil {

go/notifications/email_test.go

@@ -1,6 +1,7 @@
 package notifications_test
 
 import (
+	"context"
 	"log/slog"
 	"net/smtp"
 	"testing"
@@ -99,7 +100,11 @@ func TestEmailSendEmailVerify(t *testing.T) {
 			}
 
 			if err := mail.SendEmail(
-				"user@localhost", tc.locale, notifications.TemplateNameEmailVerify, tc.data,
+				context.Background(),
+				"user@localhost",
+				tc.locale,
+				notifications.TemplateNameEmailVerify,
+				tc.data,
 			); err != nil {
 				t.Fatalf("error sending email: %v", err)
 			}